git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

   1 /* slap.h - stand alone ldap server include file */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #ifndef _SLAP_H_
   9 #define _SLAP_H_
  10
  11 #include "ldap_defaults.h"
  12
  13 #include <stdio.h>
  14 #include <ac/stdlib.h>
  15
  16 #include <sys/types.h>
  17 #include <ac/syslog.h>
  18 #include <ac/regex.h>
  19 #include <ac/signal.h>
  20 #include <ac/socket.h>
  21 #include <ac/time.h>
  22 #include <ac/param.h>
  23
  24 #include "avl.h"
  25
  26 #ifndef ldap_debug
  27 #define ldap_debug slap_debug
  28 #endif
  29
  30 #include "ldap_log.h"
  31
  32 #include <ldap.h>
  33 #include <ldap_schema.h>
  34
  35 #include "ldap_pvt_thread.h"
  36 #include "ldap_queue.h"
  37
  38 #ifdef LDAP_DEVEL
  39 #define SLAP_EXTENDED_SCHEMA 1
  40 #define LDAP_CACHING
  41 #endif
  42
  43 LDAP_BEGIN_DECL
  44 /*
  45  * SLAPD Memory allocation macros
  46  *
  47  * Unlike ch_*() routines, these routines do not assert() upon
  48  * allocation error.  They are intended to be used instead of
  49  * ch_*() routines where the caller has implemented proper
  50  * checking for and handling of allocation errors.
  51  *
  52  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  53  */
  54 #define SLAP_MALLOC(s)      ber_memalloc((s))
  55 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  56 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  57 #define SLAP_FREE(p)        ber_memfree((p))
  58 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  59 #define SLAP_STRDUP(s)      ber_strdup((s))
  60 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  61
  62 #ifdef f_next
  63 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  64 #endif
  65
  66 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  67 #define SLAPD_ANONYMOUS "cn=anonymous"
  68
  69 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  70  * This is a value used internally by the backends. It is needed to allow
  71  * adding values that already exist without getting an error as required by
  72  * modrdn when the new rdn was already an attribute value itself.
  73  */
  74 #define SLAP_MOD_SOFTADD        0x1000
  75
  76 #define MAXREMATCHES (100)
  77
  78 #define SLAP_MAX_WORKER_THREADS         (16)
  79
  80 #ifdef LDAP_SYNCREPL
  81 #define SLAP_MAX_SYNCREPL_THREADS       (8)
  82 #endif
  83
  84 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
  85 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
  86
  87 #define SLAP_CONN_MAX_PENDING_DEFAULT   100
  88 #define SLAP_CONN_MAX_PENDING_AUTH      1000
  89
  90 #define SLAP_TEXT_BUFLEN (256)
  91
  92 /* psuedo error code indicating abandoned operation */
  93 #define SLAPD_ABANDON (-1)
  94
  95 /* psuedo error code indicating disconnect */
  96 #define SLAPD_DISCONNECT (-2)
  97
  98
  99 /* We assume "C" locale, that is US-ASCII */
 100 #define ASCII_SPACE(c)  ( (c) == ' ' )
 101 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
 102 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
 103 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
 104 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
 105 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
 106 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
 107
 108 #define SLAP_NIBBLE(c) ((c)&0x0f)
 109 #define SLAP_ESCAPE_CHAR ('\\')
 110 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 111 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 112
 113 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 114         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 115
 116 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 117 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
 118 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 119 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 120 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 121
 122 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 123 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 124 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 125 #define OID_SEPARATOR(c)        ( (c) == '.' )
 126 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 127
 128 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 129 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
 130
 131 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
 132 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 133
 134 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 135
 136 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 137         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 138         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 139         (c) == '?' || (c) == ' ' || (c) == '=' )
 140 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 141
 142 /* must match in schema_init.c */
 143 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 144 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 145 #define SLAPD_GROUP_ATTR                "member"
 146 #define SLAPD_GROUP_CLASS               "groupOfNames"
 147 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 148 #define SLAPD_ROLE_CLASS                "organizationalRole"
 149
 150 #ifdef SLAPD_ACI_ENABLED
 151 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 152 #endif
 153
 154 /* change this to "OpenLDAPset" */
 155 #define SLAPD_ACI_SET_ATTR              "template"
 156
 157 #define SLAPD_TOP_OID                   "2.5.6.0"
 158
 159 LDAP_SLAPD_V (int) slap_debug;
 160
 161 typedef unsigned long slap_mask_t;
 162
 163 /* Security Strength Factor */
 164 typedef unsigned slap_ssf_t;
 165
 166 typedef struct slap_ssf_set {
 167         slap_ssf_t sss_ssf;
 168         slap_ssf_t sss_transport;
 169         slap_ssf_t sss_tls;
 170         slap_ssf_t sss_sasl;
 171         slap_ssf_t sss_update_ssf;
 172         slap_ssf_t sss_update_transport;
 173         slap_ssf_t sss_update_tls;
 174         slap_ssf_t sss_update_sasl;
 175         slap_ssf_t sss_simple_bind;
 176 } slap_ssf_set_t;
 177
 178 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
 179 #define SLAP_GETDN_AUTHCID 2
 180 #define SLAP_GETDN_AUTHZID 4
 181
 182 /*
 183  * Index types
 184  */
 185 #define SLAP_INDEX_TYPE           0x00FFUL
 186 #define SLAP_INDEX_UNDEFINED      0x0001UL
 187 #define SLAP_INDEX_PRESENT        0x0002UL
 188 #define SLAP_INDEX_EQUALITY       0x0004UL
 189 #define SLAP_INDEX_APPROX         0x0008UL
 190 #define SLAP_INDEX_SUBSTR         0x0010UL
 191 #define SLAP_INDEX_EXTENDED               0x0020UL
 192
 193 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 194
 195 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 196
 197 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 198
 199 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 200 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 201 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 202 #define SLAP_INDEX_SUBSTR_DEFAULT \
 203         ( SLAP_INDEX_SUBSTR \
 204         | SLAP_INDEX_SUBSTR_INITIAL \
 205         | SLAP_INDEX_SUBSTR_ANY \
 206         | SLAP_INDEX_SUBSTR_FINAL )
 207
 208 #define SLAP_INDEX_SUBSTR_MINLEN        2
 209 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 210 #define SLAP_INDEX_SUBSTR_STEP  2
 211
 212 #define SLAP_INDEX_FLAGS         0xF000UL
 213 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 214 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
 215
 216 /*
 217  * there is a single index for each attribute.  these prefixes ensure
 218  * that there is no collision among keys.
 219  */
 220 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 221 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 222 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 223 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 224 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 225 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 226
 227 #define SLAP_SYNTAX_MATCHINGRULES_OID    "1.3.6.1.4.1.1466.115.121.1.30"
 228 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID   "1.3.6.1.4.1.1466.115.121.1.3"
 229 #define SLAP_SYNTAX_OBJECTCLASSES_OID    "1.3.6.1.4.1.1466.115.121.1.37"
 230 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
 231 #define SLAP_SYNTAX_CONTENTRULE_OID              "1.3.6.1.4.1.1466.115.121.1.16"
 232
 233 #ifdef LDAP_CLIENT_UPDATE
 234 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
 235 #endif /* LDAP_CLIENT_UPDATE */
 236
 237 /*
 238  * represents schema information for a database
 239  */
 240 #define SLAP_SCHERR_OUTOFMEM                    1
 241 #define SLAP_SCHERR_CLASS_NOT_FOUND             2
 242 #define SLAP_SCHERR_CLASS_BAD_USAGE             3
 243 #define SLAP_SCHERR_CLASS_BAD_SUP               4
 244 #define SLAP_SCHERR_CLASS_DUP                   5
 245 #define SLAP_SCHERR_ATTR_NOT_FOUND              6
 246 #define SLAP_SCHERR_ATTR_BAD_MR                 7
 247 #define SLAP_SCHERR_ATTR_BAD_USAGE              8
 248 #define SLAP_SCHERR_ATTR_BAD_SUP                9
 249 #define SLAP_SCHERR_ATTR_INCOMPLETE             10
 250 #define SLAP_SCHERR_ATTR_DUP                    11
 251 #define SLAP_SCHERR_MR_NOT_FOUND                12
 252 #define SLAP_SCHERR_MR_INCOMPLETE               13
 253 #define SLAP_SCHERR_MR_DUP                              14
 254 #define SLAP_SCHERR_SYN_NOT_FOUND               15
 255 #define SLAP_SCHERR_SYN_DUP                             16
 256 #define SLAP_SCHERR_NO_NAME                             17
 257 #define SLAP_SCHERR_NOT_SUPPORTED               18
 258 #define SLAP_SCHERR_BAD_DESCR                   19
 259 #define SLAP_SCHERR_OIDM                                20
 260 #define SLAP_SCHERR_CR_DUP                              21
 261 #define SLAP_SCHERR_CR_BAD_STRUCT               22
 262 #define SLAP_SCHERR_CR_BAD_AUX                  23
 263 #define SLAP_SCHERR_CR_BAD_AT                   24
 264 #define SLAP_SCHERR_LAST                                SLAP_SCHERR_CR_BAD_AT
 265
 266 typedef union slap_sockaddr {
 267         struct sockaddr sa_addr;
 268         struct sockaddr_in sa_in_addr;
 269 #ifdef LDAP_PF_INET6
 270         struct sockaddr_storage sa_storage;
 271         struct sockaddr_in6 sa_in6_addr;
 272 #endif
 273 #ifdef LDAP_PF_LOCAL
 274         struct sockaddr_un sa_un_addr;
 275 #endif
 276 } Sockaddr;
 277
 278 #ifdef LDAP_PF_INET6
 279 extern int slap_inet4or6;
 280 #endif
 281
 282 typedef struct slap_oid_macro {
 283         struct berval som_oid;
 284         char **som_names;
 285         LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
 286 } OidMacro;
 287
 288 /* forward declarations */
 289 struct slap_syntax;
 290 struct slap_matching_rule;
 291
 292 typedef int slap_syntax_validate_func LDAP_P((
 293         struct slap_syntax *syntax,
 294         struct berval * in));
 295
 296 typedef int slap_syntax_transform_func LDAP_P((
 297         struct slap_syntax *syntax,
 298         struct berval * in,
 299         struct berval * out,
 300         void *memctx));
 301
 302 typedef struct slap_syntax {
 303         LDAPSyntax                      ssyn_syn;
 304 #define ssyn_oid                ssyn_syn.syn_oid
 305 #define ssyn_desc               ssyn_syn.syn_desc
 306 #define ssyn_extensions         ssyn_syn.syn_extensions
 307         /*
 308          * Note: the former
 309         ber_len_t       ssyn_oidlen;
 310          * has been replaced by a struct berval that uses the value
 311          * provided by ssyn_syn.syn_oid; a macro that expands to
 312          * the bv_len field of the berval is provided for backward
 313          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 314          */
 315         struct berval   ssyn_bvoid;
 316 #define ssyn_oidlen     ssyn_bvoid.bv_len
 317
 318         unsigned int ssyn_flags;
 319
 320 #define SLAP_SYNTAX_NONE        0x0000U
 321 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 322 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 323 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 324 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 325
 326         slap_syntax_validate_func       *ssyn_validate;
 327         slap_syntax_transform_func      *ssyn_pretty;
 328
 329 #ifdef SLAPD_BINARY_CONVERSION
 330         /* convert to and from binary */
 331         slap_syntax_transform_func      *ssyn_ber2str;
 332         slap_syntax_transform_func      *ssyn_str2ber;
 333 #endif
 334
 335         LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
 336 } Syntax;
 337
 338 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 339 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 340 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 341 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 342 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 343
 344 typedef struct slap_syntax_defs_rec {
 345         char *sd_desc;
 346         int sd_flags;
 347         slap_syntax_validate_func *sd_validate;
 348         slap_syntax_transform_func *sd_pretty;
 349 #ifdef SLAPD_BINARY_CONVERSION
 350         slap_syntax_transform_func *sd_ber2str;
 351         slap_syntax_transform_func *sd_str2ber;
 352 #endif
 353 } slap_syntax_defs_rec;
 354
 355 /* X -> Y Converter */
 356 typedef int slap_mr_convert_func LDAP_P((
 357         struct berval * in,
 358         struct berval * out,
 359         void *memctx ));
 360
 361 /* Normalizer */
 362 typedef int slap_mr_normalize_func LDAP_P((
 363         slap_mask_t use,
 364         struct slap_syntax *syntax, /* NULL if in is asserted value */
 365         struct slap_matching_rule *mr,
 366         struct berval * in,
 367         struct berval * out,
 368         void *memctx ));
 369
 370 /* Match (compare) function */
 371 typedef int slap_mr_match_func LDAP_P((
 372         int *match,
 373         slap_mask_t use,
 374         struct slap_syntax *syntax,     /* syntax of stored value */
 375         struct slap_matching_rule *mr,
 376         struct berval * value,
 377         void * assertValue ));
 378
 379 /* Index generation function */
 380 typedef int slap_mr_indexer_func LDAP_P((
 381         slap_mask_t use,
 382         slap_mask_t mask,
 383         struct slap_syntax *syntax,     /* syntax of stored value */
 384         struct slap_matching_rule *mr,
 385         struct berval *prefix,
 386         BerVarray values,
 387         BerVarray *keys,
 388         void *memctx ));
 389
 390 /* Filter index function */
 391 typedef int slap_mr_filter_func LDAP_P((
 392         slap_mask_t use,
 393         slap_mask_t mask,
 394         struct slap_syntax *syntax,     /* syntax of stored value */
 395         struct slap_matching_rule *mr,
 396         struct berval *prefix,
 397         void * assertValue,
 398         BerVarray *keys,
 399         void *memctx ));
 400
 401 typedef struct slap_matching_rule_use MatchingRuleUse;
 402
 403 typedef struct slap_matching_rule {
 404         LDAPMatchingRule                smr_mrule;
 405         MatchingRuleUse                 *smr_mru;
 406         /* RFC2252 string representation */
 407         struct berval                   smr_str;
 408         /*
 409          * Note: the former
 410          *                      ber_len_t       smr_oidlen;
 411          * has been replaced by a struct berval that uses the value
 412          * provided by smr_mrule.mr_oid; a macro that expands to
 413          * the bv_len field of the berval is provided for backward
 414          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 415          */
 416         struct berval                   smr_bvoid;
 417 #define smr_oidlen                      smr_bvoid.bv_len
 418
 419         slap_mask_t                             smr_usage;
 420
 421 #define SLAP_MR_HIDE                    0x8000U
 422
 423 #define SLAP_MR_TYPE_MASK               0xF000U
 424 #define SLAP_MR_SUBTYPE_MASK    0x0F00U
 425 #define SLAP_MR_USAGE                   0x00FFU
 426
 427 #define SLAP_MR_NONE                    0x0000U
 428 #define SLAP_MR_EQUALITY                0x1000U
 429 #define SLAP_MR_ORDERING                0x2000U
 430 #define SLAP_MR_SUBSTR                  0x4000U
 431 #define SLAP_MR_EXT                             0x8000U /* implicitly extensible */
 432
 433 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0100U )
 434
 435 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0100U )
 436 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0200U )
 437 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0400U )
 438
 439
 440 /*
 441  * The asserted value, depending on the particular usage,
 442  * is expected to conform to either the assertion syntax
 443  * or the attribute syntax.   In some cases, the syntax of
 444  * the value is known.  If so, these flags indicate which
 445  * syntax the value is expected to conform to.  If not,
 446  * neither of these flags is set (until the syntax of the
 447  * provided value is determined).  If the value is of the
 448  * attribute syntax, the flag is changed once a value of
 449  * the assertion syntax is derived from the provided value.
 450  */
 451 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX       0x0001U
 452 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX       0x0002U
 453
 454 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
 455         ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
 456 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
 457         ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
 458
 459 /* either or both the asserted value or attribute value
 460  * may be provided in normalized form
 461  */
 462 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH         0x0010U
 463 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH        0x0020U
 464
 465 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 466         (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
 467 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
 468         ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 469
 470 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
 471         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 472                 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
 473 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 474         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 475                 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 476
 477 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
 478         ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
 479 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
 480         ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
 481
 482         Syntax                                  *smr_syntax;
 483         slap_mr_convert_func    *smr_convert;
 484         slap_mr_normalize_func  *smr_normalize;
 485         slap_mr_match_func              *smr_match;
 486         slap_mr_indexer_func    *smr_indexer;
 487         slap_mr_filter_func             *smr_filter;
 488
 489         /*
 490          * null terminated array of syntaxes compatible with this syntax
 491          * note: when MS_EXT is set, this MUST NOT contain the assertion
 492          * syntax of the rule.  When MS_EXT is not set, it MAY.
 493          */
 494         Syntax                                  **smr_compat_syntaxes;
 495
 496         /*
 497          * For equality rules, refers to an associated approximate rule.
 498          * For non-equality rules, refers to an associated equality rule.
 499          */
 500         struct slap_matching_rule       *smr_associated;
 501
 502 #define SLAP_MR_ASSOCIATED(mr,amr)      (((mr) == (amr)) || \
 503         ((mr)->smr_associated == (amr)))
 504
 505         LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
 506
 507 #define smr_oid                         smr_mrule.mr_oid
 508 #define smr_names                       smr_mrule.mr_names
 509 #define smr_desc                        smr_mrule.mr_desc
 510 #define smr_obsolete            smr_mrule.mr_obsolete
 511 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 512 #define smr_extensions          smr_mrule.mr_extensions
 513 } MatchingRule;
 514
 515 struct slap_matching_rule_use {
 516         LDAPMatchingRuleUse             smru_mruleuse;
 517         MatchingRule                    *smru_mr;
 518         /* RFC2252 string representation */
 519         struct berval                   smru_str;
 520
 521         LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
 522
 523 #define smru_oid                        smru_mruleuse.mru_oid
 524 #define smru_names                      smru_mruleuse.mru_names
 525 #define smru_desc                       smru_mruleuse.mru_desc
 526 #define smru_obsolete                   smru_mruleuse.mru_obsolete
 527 #define smru_applies_oids               smru_mruleuse.mru_applies_oids
 528
 529 #define smru_usage                      smru_mr->smr_usage
 530 } /* MatchingRuleUse */ ;
 531
 532 typedef struct slap_mrule_defs_rec {
 533         char *                                          mrd_desc;
 534         slap_mask_t                                     mrd_usage;
 535         char **                                         mrd_compat_syntaxes;
 536         slap_mr_convert_func *          mrd_convert;
 537         slap_mr_normalize_func *        mrd_normalize;
 538         slap_mr_match_func *            mrd_match;
 539         slap_mr_indexer_func *          mrd_indexer;
 540         slap_mr_filter_func *           mrd_filter;
 541
 542         /* For equality rule, this may refer to an associated approximate rule */
 543         /* For non-equality rule, this may refer to an associated equality rule */
 544         char *                                          mrd_associated;
 545 } slap_mrule_defs_rec;
 546
 547 struct slap_backend_db;
 548 struct slap_entry;
 549 struct slap_attr;
 550
 551 typedef int (AttributeTypeSchemaCheckFN)(
 552         struct slap_backend_db *be,
 553         struct slap_entry *e,
 554         struct slap_attr *attr,
 555         const char** text,
 556         char *textbuf, size_t textlen );
 557
 558 typedef struct slap_attribute_type {
 559         LDAPAttributeType               sat_atype;
 560         struct berval                   sat_cname;
 561         struct slap_attribute_type      *sat_sup;
 562         struct slap_attribute_type      **sat_subtypes;
 563         MatchingRule                    *sat_equality;
 564         MatchingRule                    *sat_approx;
 565         MatchingRule                    *sat_ordering;
 566         MatchingRule                    *sat_substr;
 567         Syntax                                  *sat_syntax;
 568
 569         AttributeTypeSchemaCheckFN      *sat_check;
 570
 571 #define SLAP_AT_NONE            0x0000U
 572 #define SLAP_AT_ABSTRACT        0x0100U /* cannot be instantiated */
 573 #define SLAP_AT_FINAL           0x0200U /* cannot be subtyped */
 574 #define SLAP_AT_HIDE            0x8000U /* hide attribute */
 575         slap_mask_t                                     sat_flags;
 576
 577         LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
 578
 579 #define sat_oid                         sat_atype.at_oid
 580 #define sat_names                       sat_atype.at_names
 581 #define sat_desc                        sat_atype.at_desc
 582 #define sat_obsolete            sat_atype.at_obsolete
 583 #define sat_sup_oid                     sat_atype.at_sup_oid
 584 #define sat_equality_oid        sat_atype.at_equality_oid
 585 #define sat_ordering_oid        sat_atype.at_ordering_oid
 586 #define sat_substr_oid          sat_atype.at_substr_oid
 587 #define sat_syntax_oid          sat_atype.at_syntax_oid
 588 #define sat_single_value        sat_atype.at_single_value
 589 #define sat_collective          sat_atype.at_collective
 590 #define sat_no_user_mod         sat_atype.at_no_user_mod
 591 #define sat_usage                       sat_atype.at_usage
 592 #define sat_extensions          sat_atype.at_extensions
 593
 594         struct slap_attr_desc           *sat_ad;
 595         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 596 } AttributeType;
 597
 598 #define is_at_operational(at)   ((at)->sat_usage)
 599 #define is_at_single_value(at)  ((at)->sat_single_value)
 600 #define is_at_collective(at)    ((at)->sat_collective)
 601 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 602 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 603
 604 struct slap_object_class;
 605
 606 typedef int (ObjectClassSchemaCheckFN)(
 607         struct slap_backend_db *be,
 608         struct slap_entry *e,
 609         struct slap_object_class *oc,
 610         const char** text,
 611         char *textbuf, size_t textlen );
 612
 613 typedef struct slap_object_class {
 614         LDAPObjectClass                 soc_oclass;
 615         struct berval                   soc_cname;
 616         struct slap_object_class        **soc_sups;
 617         AttributeType                           **soc_required;
 618         AttributeType                           **soc_allowed;
 619         ObjectClassSchemaCheckFN        *soc_check;
 620         slap_mask_t                                     soc_flags;
 621 #define soc_oid                         soc_oclass.oc_oid
 622 #define soc_names                       soc_oclass.oc_names
 623 #define soc_desc                        soc_oclass.oc_desc
 624 #define soc_obsolete            soc_oclass.oc_obsolete
 625 #define soc_sup_oids            soc_oclass.oc_sup_oids
 626 #define soc_kind                        soc_oclass.oc_kind
 627 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 628 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 629 #define soc_extensions          soc_oclass.oc_extensions
 630
 631         LDAP_SLIST_ENTRY(slap_object_class) soc_next;
 632 } ObjectClass;
 633
 634 #define SLAP_OC_ALIAS           0x0001
 635 #define SLAP_OC_REFERRAL        0x0002
 636 #define SLAP_OC_SUBENTRY        0x0004
 637 #define SLAP_OC_DYNAMICOBJECT   0x0008
 638 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 639 #define SLAP_OC__MASK           0x001F
 640 #define SLAP_OC__END            0x0020
 641 #define SLAP_OC_OPERATIONAL     0x4000
 642 #define SLAP_OC_HIDE            0x8000
 643
 644 /*
 645  * DIT content rule
 646  */
 647 typedef struct slap_content_rule {
 648         LDAPContentRule         scr_crule;
 649         ObjectClass                     *scr_sclass;
 650         ObjectClass                     **scr_auxiliaries;      /* optional */
 651         AttributeType           **scr_required;         /* optional */
 652         AttributeType           **scr_allowed;          /* optional */
 653         AttributeType           **scr_precluded;        /* optional */
 654 #define scr_oid                         scr_crule.cr_oid
 655 #define scr_names                       scr_crule.cr_names
 656 #define scr_desc                        scr_crule.cr_desc
 657 #define scr_obsolete            scr_crule.cr_obsolete
 658 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
 659 #define scr_at_oids_must        scr_crule.cr_at_oids_must
 660 #define scr_at_oids_may         scr_crule.cr_at_oids_may
 661 #define scr_at_oids_not         scr_crule.cr_at_oids_not
 662
 663         LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
 664 } ContentRule;
 665
 666 /* Represents a recognized attribute description ( type + options ). */
 667 typedef struct slap_attr_desc {
 668         struct slap_attr_desc *ad_next;
 669         AttributeType *ad_type;         /* attribute type, must be specified */
 670         struct berval ad_cname;         /* canonical name, must be specified */
 671         struct berval ad_tags;          /* empty if no tagging options */
 672         unsigned ad_flags;
 673 #define SLAP_DESC_NONE                  0x00U
 674 #define SLAP_DESC_BINARY                0x01U
 675 #define SLAP_DESC_TAG_RANGE             0x80U
 676 } AttributeDescription;
 677
 678 typedef struct slap_attr_name {
 679         struct berval an_name;
 680         AttributeDescription *an_desc;
 681         ObjectClass *an_oc;
 682 } AttributeName;
 683
 684 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
 685 #define slap_ad_is_tag_range(ad)        \
 686         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
 687 #define slap_ad_is_binary(ad)           \
 688         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 689
 690 /*
 691  * pointers to schema elements used internally
 692  */
 693 struct slap_internal_schema {
 694         /* objectClass */
 695         ObjectClass *si_oc_top;
 696         ObjectClass *si_oc_extensibleObject;
 697         ObjectClass *si_oc_alias;
 698         ObjectClass *si_oc_referral;
 699         ObjectClass *si_oc_rootdse;
 700         ObjectClass *si_oc_subentry;
 701         ObjectClass *si_oc_subschema;
 702         ObjectClass *si_oc_collectiveAttributeSubentry;
 703         ObjectClass *si_oc_dynamicObject;
 704
 705 #ifdef LDAP_SYNCREPL
 706         ObjectClass *si_oc_glue;
 707         ObjectClass *si_oc_syncConsumerSubentry;
 708         ObjectClass *si_oc_syncProviderSubentry;
 709 #endif
 710
 711         /* objectClass attribute descriptions */
 712         AttributeDescription *si_ad_objectClass;
 713
 714         /* operational attribute descriptions */
 715         AttributeDescription *si_ad_structuralObjectClass;
 716         AttributeDescription *si_ad_creatorsName;
 717         AttributeDescription *si_ad_createTimestamp;
 718         AttributeDescription *si_ad_modifiersName;
 719         AttributeDescription *si_ad_modifyTimestamp;
 720         AttributeDescription *si_ad_hasSubordinates;
 721         AttributeDescription *si_ad_subschemaSubentry;
 722         AttributeDescription *si_ad_collectiveSubentries;
 723         AttributeDescription *si_ad_collectiveExclusions;
 724         AttributeDescription *si_ad_entryUUID;
 725         AttributeDescription *si_ad_entryCSN;
 726         AttributeDescription *si_ad_namingCSN;
 727         AttributeDescription *si_ad_superiorUUID;
 728
 729 #ifdef LDAP_CACHING
 730         /* LDAP cache specific operational attribute */
 731         AttributeDescription *si_ad_queryid;
 732 #endif /* LDAP_CACHING */
 733
 734 #ifdef LDAP_SYNCREPL
 735         AttributeDescription *si_ad_dseType;
 736         AttributeDescription *si_ad_syncreplCookie;
 737 #endif
 738
 739         /* root DSE attribute descriptions */
 740         AttributeDescription *si_ad_altServer;
 741         AttributeDescription *si_ad_namingContexts;
 742         AttributeDescription *si_ad_supportedControl;
 743         AttributeDescription *si_ad_supportedExtension;
 744         AttributeDescription *si_ad_supportedLDAPVersion;
 745         AttributeDescription *si_ad_supportedSASLMechanisms;
 746         AttributeDescription *si_ad_supportedFeatures;
 747         AttributeDescription *si_ad_monitorContext;
 748         AttributeDescription *si_ad_vendorName;
 749         AttributeDescription *si_ad_vendorVersion;
 750
 751         /* subentry attribute descriptions */
 752         AttributeDescription *si_ad_administrativeRole;
 753         AttributeDescription *si_ad_subtreeSpecification;
 754
 755         /* subschema subentry attribute descriptions */
 756         AttributeDescription *si_ad_ditStructureRules;
 757         AttributeDescription *si_ad_ditContentRules;
 758         AttributeDescription *si_ad_nameForms;
 759         AttributeDescription *si_ad_objectClasses;
 760         AttributeDescription *si_ad_attributeTypes;
 761         AttributeDescription *si_ad_ldapSyntaxes;
 762         AttributeDescription *si_ad_matchingRules;
 763         AttributeDescription *si_ad_matchingRuleUse;
 764
 765         /* Aliases & Referrals */
 766         AttributeDescription *si_ad_aliasedObjectName;
 767         AttributeDescription *si_ad_ref;
 768
 769         /* Access Control Internals */
 770         AttributeDescription *si_ad_entry;
 771         AttributeDescription *si_ad_children;
 772         AttributeDescription *si_ad_saslAuthzTo;
 773         AttributeDescription *si_ad_saslAuthzFrom;
 774 #ifdef SLAPD_ACI_ENABLED
 775         AttributeDescription *si_ad_aci;
 776 #endif
 777
 778         /* dynamic entries */
 779         AttributeDescription *si_ad_entryTtl;
 780         AttributeDescription *si_ad_dynamicSubtrees;
 781
 782         /* Other attributes descriptions */
 783         AttributeDescription *si_ad_distinguishedName;
 784         AttributeDescription *si_ad_name;
 785         AttributeDescription *si_ad_cn;
 786         AttributeDescription *si_ad_userPassword;
 787 #ifdef SLAPD_AUTHPASSWD
 788         AttributeDescription *si_ad_authPassword;
 789 #endif
 790 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 791         AttributeDescription *si_ad_krbName;
 792 #endif
 793
 794         /* Undefined Attribute Type */
 795         AttributeType   *si_at_undefined;
 796
 797         /* Matching Rules */
 798         MatchingRule    *si_mr_distinguishedNameMatch;
 799         MatchingRule    *si_mr_caseExactMatch;
 800         MatchingRule    *si_mr_caseExactSubstringsMatch;
 801         MatchingRule    *si_mr_caseExactIA5Match;
 802         MatchingRule    *si_mr_integerMatch;
 803         MatchingRule    *si_mr_integerFirstComponentMatch;
 804
 805         /* Syntaxes */
 806         Syntax          *si_syn_directoryString;
 807         Syntax          *si_syn_distinguishedName;
 808         Syntax          *si_syn_integer;
 809         Syntax          *si_syn_octetString;
 810 };
 811
 812 typedef struct slap_attr_assertion {
 813         AttributeDescription    *aa_desc;
 814         struct berval aa_value;
 815 } AttributeAssertion;
 816
 817 typedef struct slap_ss_assertion {
 818         AttributeDescription    *sa_desc;
 819         struct berval           sa_initial;
 820         struct berval           *sa_any;
 821         struct berval           sa_final;
 822 } SubstringsAssertion;
 823
 824 typedef struct slap_mr_assertion {
 825         MatchingRule            *ma_rule;       /* optional */
 826         struct berval           ma_rule_text;  /* optional */
 827         AttributeDescription    *ma_desc;       /* optional */
 828         int                                             ma_dnattrs; /* boolean */
 829         struct berval           ma_value;       /* required */
 830 } MatchingRuleAssertion;
 831
 832 /*
 833  * represents a search filter
 834  */
 835 typedef struct slap_filter {
 836         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 837 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 838 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 839 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 840
 841         union f_un_u {
 842                 /* precomputed result */
 843                 ber_int_t f_un_result;
 844
 845                 /* DN */
 846                 struct berval *f_un_dn;
 847
 848                 /* present */
 849                 AttributeDescription *f_un_desc;
 850
 851                 /* simple value assertion */
 852                 AttributeAssertion *f_un_ava;
 853
 854                 /* substring assertion */
 855                 SubstringsAssertion *f_un_ssa;
 856
 857                 /* matching rule assertion */
 858                 MatchingRuleAssertion *f_un_mra;
 859
 860 #define f_dn                    f_un.f_un_dn
 861 #define f_desc                  f_un.f_un_desc
 862 #define f_ava                   f_un.f_un_ava
 863 #define f_av_desc               f_un.f_un_ava->aa_desc
 864 #define f_av_value              f_un.f_un_ava->aa_value
 865 #define f_sub                   f_un.f_un_ssa
 866 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 867 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 868 #define f_sub_any               f_un.f_un_ssa->sa_any
 869 #define f_sub_final             f_un.f_un_ssa->sa_final
 870 #define f_mra                   f_un.f_un_mra
 871 #define f_mr_rule               f_un.f_un_mra->ma_rule
 872 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 873 #define f_mr_desc               f_un.f_un_mra->ma_desc
 874 #define f_mr_value              f_un.f_un_mra->ma_value
 875 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 876
 877                 /* and, or, not */
 878                 struct slap_filter *f_un_complex;
 879         } f_un;
 880
 881 #define f_result        f_un.f_un_result
 882 #define f_and           f_un.f_un_complex
 883 #define f_or            f_un.f_un_complex
 884 #define f_not           f_un.f_un_complex
 885 #define f_list          f_un.f_un_complex
 886
 887         struct slap_filter      *f_next;
 888 } Filter;
 889
 890 /* compare routines can return undefined */
 891 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 892
 893 typedef struct slap_valuesreturnfilter {
 894         ber_tag_t       vrf_choice;
 895
 896         union vrf_un_u {
 897                 /* precomputed result */
 898                 ber_int_t vrf_un_result;
 899
 900                 /* DN */
 901                 char *vrf_un_dn;
 902
 903                 /* present */
 904                 AttributeDescription *vrf_un_desc;
 905
 906                 /* simple value assertion */
 907                 AttributeAssertion *vrf_un_ava;
 908
 909                 /* substring assertion */
 910                 SubstringsAssertion *vrf_un_ssa;
 911
 912                 /* matching rule assertion */
 913                 MatchingRuleAssertion *vrf_un_mra;
 914
 915 #define vrf_result              vrf_un.vrf_un_result
 916 #define vrf_dn                  vrf_un.vrf_un_dn
 917 #define vrf_desc                vrf_un.vrf_un_desc
 918 #define vrf_ava                 vrf_un.vrf_un_ava
 919 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
 920 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
 921 #define vrf_ssa                 vrf_un.vrf_un_ssa
 922 #define vrf_sub                 vrf_un.vrf_un_ssa
 923 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
 924 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
 925 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
 926 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
 927 #define vrf_mra                 vrf_un.vrf_un_mra
 928 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
 929 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
 930 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
 931 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
 932 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
 933
 934
 935         } vrf_un;
 936
 937         struct slap_valuesreturnfilter  *vrf_next;
 938 } ValuesReturnFilter;
 939
 940 /*
 941  * represents an attribute (description + values)
 942  */
 943 typedef struct slap_attr {
 944         AttributeDescription *a_desc;
 945         BerVarray       a_vals;         /* preserved values */
 946         BerVarray       a_nvals;        /* normalized values */
 947         struct slap_attr *a_next;
 948         unsigned a_flags;
 949 #define SLAP_ATTR_IXADD         0x1U
 950 #define SLAP_ATTR_IXDEL         0x2U
 951 } Attribute;
 952
 953
 954 /*
 955  * the id used in the indexes to refer to an entry
 956  */
 957 typedef unsigned long   ID;
 958 #define NOID    ((ID)~0)
 959
 960 /*
 961  * represents an entry in core
 962  */
 963 typedef struct slap_entry {
 964         /*
 965          * The ID field should only be changed before entry is
 966          * inserted into a cache.  The ID value is backend
 967          * specific.
 968          */
 969         ID              e_id;
 970
 971         struct berval e_name;   /* name (DN) of this entry */
 972         struct berval e_nname;  /* normalized name (DN) of this entry */
 973
 974         /* for migration purposes */
 975 #define e_dn e_name.bv_val
 976 #define e_ndn e_nname.bv_val
 977
 978         Attribute       *e_attrs;       /* list of attributes + values */
 979
 980         slap_mask_t     e_ocflags;
 981
 982         struct berval   e_bv;           /* For entry_encode/entry_decode */
 983
 984         /* for use by the backend for any purpose */
 985         void*   e_private;
 986 } Entry;
 987
 988 /*
 989  * A list of LDAPMods
 990  */
 991 typedef struct slap_mod {
 992         int sm_op;
 993         AttributeDescription *sm_desc;
 994         struct berval sm_type;
 995         BerVarray sm_values;
 996 #define sm_bvalues sm_values
 997         BerVarray sm_nvalues;
 998 } Modification;
 999
1000 typedef struct slap_mod_list {
1001         Modification sml_mod;
1002 #define sml_op          sml_mod.sm_op
1003 #define sml_desc        sml_mod.sm_desc
1004 #define sml_type        sml_mod.sm_type
1005 #define sml_bvalues     sml_mod.sm_values
1006 #define sml_values      sml_mod.sm_values
1007 #define sml_nvalues     sml_mod.sm_nvalues
1008         struct slap_mod_list *sml_next;
1009 } Modifications;
1010
1011 typedef struct slap_ldap_modlist {
1012         LDAPMod ml_mod;
1013         struct slap_ldap_modlist *ml_next;
1014 #define ml_op           ml_mod.mod_op
1015 #define ml_type         ml_mod.mod_type
1016 #define ml_values       ml_mod.mod_values
1017 #define ml_bvalues      ml_mod.mod_values
1018 } LDAPModList;
1019
1020 /*
1021  * represents an access control list
1022  */
1023 typedef enum slap_access_e {
1024         ACL_INVALID_ACCESS = -1,
1025         ACL_NONE = 0,
1026         ACL_AUTH,
1027         ACL_COMPARE,
1028         ACL_SEARCH,
1029         ACL_READ,
1030         ACL_WRITE
1031 } slap_access_t;
1032
1033 typedef enum slap_control_e {
1034         ACL_INVALID_CONTROL     = 0,
1035         ACL_STOP,
1036         ACL_CONTINUE,
1037         ACL_BREAK
1038 } slap_control_t;
1039
1040 typedef enum slap_style_e {
1041         ACL_STYLE_REGEX = 0,
1042         ACL_STYLE_BASE,
1043         ACL_STYLE_ONE,
1044         ACL_STYLE_SUBTREE,
1045         ACL_STYLE_CHILDREN,
1046         ACL_STYLE_ATTROF,
1047
1048         /* alternate names */
1049         ACL_STYLE_EXACT = ACL_STYLE_BASE
1050 } slap_style_t;
1051
1052 typedef struct slap_authz_info {
1053         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
1054         struct berval   sai_mech;               /* SASL Mechanism */
1055         struct berval   sai_dn;                 /* DN for reporting purposes */
1056         struct berval   sai_ndn;                /* Normalized DN */
1057
1058         /* Security Strength Factors */
1059         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1060         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1061         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1062         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1063 } AuthorizationInformation;
1064
1065 /* the "by" part */
1066 typedef struct slap_access {
1067         slap_control_t a_type;
1068
1069 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1070
1071 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1072 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1073 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1074 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1075 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1076 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
1077
1078 #define ACL_PRIV_MASK                   0x00ffUL
1079
1080 /* priv flags */
1081 #define ACL_PRIV_LEVEL                  0x1000UL
1082 #define ACL_PRIV_ADDITIVE               0x2000UL
1083 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
1084
1085 /* invalid privs */
1086 #define ACL_PRIV_INVALID                0x0UL
1087
1088 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1089 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
1090 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1091 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1092
1093 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1094 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1095
1096 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1097
1098 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1099
1100 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1101 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1102 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1103
1104 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1105 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
1106 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1107 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1108 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1109 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1110
1111 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1112 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1113 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1114 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
1115 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
1116 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1117 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1118
1119 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1120 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1121 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1122 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1123 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1124 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1125
1126         slap_mask_t     a_access_mask;
1127
1128         AuthorizationInformation        a_authz;
1129 #define a_dn_pat        a_authz.sai_dn
1130
1131         slap_style_t a_dn_style;
1132         AttributeDescription    *a_dn_at;
1133         int                     a_dn_self;
1134         int                     a_dn_expand;
1135
1136         slap_style_t a_peername_style;
1137         struct berval   a_peername_pat;
1138         slap_style_t a_sockname_style;
1139         struct berval   a_sockname_pat;
1140
1141         slap_style_t a_domain_style;
1142         struct berval   a_domain_pat;
1143         int             a_domain_expand;
1144
1145         slap_style_t a_sockurl_style;
1146         struct berval   a_sockurl_pat;
1147         slap_style_t a_set_style;
1148         struct berval   a_set_pat;
1149
1150 #ifdef SLAPD_ACI_ENABLED
1151         AttributeDescription    *a_aci_at;
1152 #endif
1153
1154         /* ACL Groups */
1155         slap_style_t a_group_style;
1156         struct berval   a_group_pat;
1157         ObjectClass                             *a_group_oc;
1158         AttributeDescription    *a_group_at;
1159
1160         struct slap_access      *a_next;
1161 } Access;
1162
1163 /* the "to" part */
1164 typedef struct slap_acl {
1165         /* "to" part: the entries this acl applies to */
1166         Filter          *acl_filter;
1167         slap_style_t acl_dn_style;
1168         regex_t         acl_dn_re;
1169         struct berval   acl_dn_pat;
1170         AttributeName   *acl_attrs;
1171
1172         /* "by" part: list of who has what access to the entries */
1173         Access  *acl_access;
1174
1175         struct slap_acl *acl_next;
1176 } AccessControl;
1177
1178 typedef struct slap_acl_state {
1179         unsigned as_recorded;
1180 #define ACL_STATE_NOT_RECORDED                  0x0
1181 #define ACL_STATE_RECORDED_VD                   0x1
1182 #define ACL_STATE_RECORDED_NV                   0x2
1183 #define ACL_STATE_RECORDED                              0x3
1184
1185         /* Access state */
1186         AccessControl *as_vd_acl;
1187         AccessControl *as_vi_acl;
1188         slap_mask_t as_vd_acl_mask;
1189         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1190         int as_vd_acl_count;
1191
1192         Access *as_vd_access;
1193         int as_vd_access_count;
1194
1195         int as_result;
1196         AttributeDescription *as_vd_ad;
1197 } AccessControlState;
1198 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1199         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1200
1201 /*
1202  * Backend-info
1203  * represents a backend
1204  */
1205
1206 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1207 typedef struct slap_backend_db BackendDB;               /* per backend database */
1208
1209 LDAP_SLAPD_V (int) nBackendInfo;
1210 LDAP_SLAPD_V (int) nBackendDB;
1211 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1212 LDAP_SLAPD_V (BackendDB *) backendDB;
1213
1214 LDAP_SLAPD_V (int) slapMode;
1215 #define SLAP_UNDEFINED_MODE     0x0000
1216 #define SLAP_SERVER_MODE        0x0001
1217 #define SLAP_TOOL_MODE          0x0002
1218 #define SLAP_MODE                       0x0003
1219
1220 #define SLAP_TRUNCATE_MODE      0x0100
1221
1222 struct slap_replica_info {
1223         char *ri_host;                          /* supersedes be_replica */
1224         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1225         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1226         int ri_exclude;                 /* 1 => exclude ri_attrs */
1227 };
1228
1229 struct slap_limits_set {
1230         /* time limits */
1231         int     lms_t_soft;
1232         int     lms_t_hard;
1233
1234         /* size limits */
1235         int     lms_s_soft;
1236         int     lms_s_hard;
1237         int     lms_s_unchecked;
1238         int     lms_s_pr;
1239         int     lms_s_pr_hide;
1240 };
1241
1242 struct slap_limits {
1243         int     lm_type;        /* type of pattern */
1244 #define SLAP_LIMITS_UNDEFINED   0x0000
1245 #define SLAP_LIMITS_EXACT       0x0001
1246 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1247 #define SLAP_LIMITS_ONE         0x0002
1248 #define SLAP_LIMITS_SUBTREE     0x0003
1249 #define SLAP_LIMITS_CHILDREN    0x0004
1250 #define SLAP_LIMITS_REGEX       0x0005
1251 #define SLAP_LIMITS_ANONYMOUS   0x0006
1252 #define SLAP_LIMITS_USERS       0x0007
1253 #define SLAP_LIMITS_ANY         0x0008
1254         regex_t lm_dn_regex;            /* regex data for REGEX */
1255
1256         /*
1257          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1258          * pattern for REGEX; NULL for ANONYMOUS, USERS
1259          */
1260         struct berval lm_dn_pat;
1261
1262         struct slap_limits_set  lm_limits;
1263 };
1264
1265 /* temporary aliases */
1266 typedef BackendDB Backend;
1267 #define nbackends nBackendDB
1268 #define backends backendDB
1269
1270 #ifdef LDAP_SYNCREPL
1271  /*
1272   * syncinfo structure for syncrepl
1273   */
1274 typedef struct syncinfo_s {
1275         struct slap_conn *conn;
1276         struct slap_backend_db *be;
1277         struct slap_entry *e;
1278         void            *ctx;
1279         int             id;
1280         char            *masteruri;
1281         char            *mastername;
1282         int             masterport;
1283         int             type;
1284         char            *binddn;
1285         int             bindmethod;
1286         char            *passwd;
1287         char            *secprops;
1288         char            *realm;
1289         char            *authcId;
1290         char            *authzId;
1291         char            *srvtab;
1292         char            *saslmech;
1293         int             interval;
1294         char            *base;
1295         int             scope;
1296         int             deref;
1297         int             slimit;
1298         int             tlimit;
1299         Filter          *filter;
1300         char            *filterstr;
1301         char            **attrs;
1302         int             attrsonly;
1303 #define LASTMOD_REQ             0
1304 #define LASTMOD_GEN             1
1305 #define LASTMOD_NO              2
1306         int             lastmod;
1307         /* TLS flags */
1308 #define TLS_OFF                 0
1309 #define TLS_ON                  1
1310 #define TLS_CRITICAL            2
1311         int             tls;
1312         int             found;
1313         struct berval   *syncUUID;
1314         struct berval   *syncCookie;
1315         Avlnode         *presentlist;
1316 } syncinfo_t;
1317
1318 #define IDSTR           "id"
1319 #define MASTERSTR       "master"
1320 #define SUFFIXSTR       "suffix"
1321 #define BINDDNSTR       "binddn"
1322 #define BINDMETHSTR     "bindmethod"
1323 #define SIMPLESTR       "simple"
1324 #define SASLSTR         "sasl"
1325 #define CREDSTR         "credentials"
1326 #define OLDAUTHCSTR     "bindprincipal"
1327 #define AUTHCSTR        "authcID"
1328 #define AUTHZSTR        "authzID"
1329 #define SRVTABSTR       "srvtab"
1330 #define SASLMECHSTR     "saslmech"
1331 #define REALMSTR        "realm"
1332 #define SECPROPSSTR     "secprops"
1333 #define TLSSTR          "tls"
1334 #define TLSCRITICALSTR  "critical"
1335
1336 #define FILTERSTR       "filter"
1337 #define SEARCHBASESTR   "searchbase"
1338 #define SCOPESTR        "scope"
1339 #define ATTRSSTR        "attrs"
1340 #define ATTRSONLYSTR    "attrsonly"
1341 #define TYPESTR         "type"
1342 #define INTERVALSTR     "interval"
1343 #define COOKIESTR       "cookie"
1344 #define LASTMODSTR      "lastmod"
1345 #define LMREQSTR        "req"
1346 #define LMGENSTR        "gen"
1347 #define LMNOSTR         "no"
1348
1349 #endif /* LDAP_SYNCREPL */
1350
1351 struct slap_backend_db {
1352         BackendInfo     *bd_info;       /* pointer to shared backend info */
1353
1354         /* BackendInfo accessors */
1355 #define         be_config       bd_info->bi_db_config
1356 #define         be_type         bd_info->bi_type
1357
1358 #define         be_bind         bd_info->bi_op_bind
1359 #define         be_unbind       bd_info->bi_op_unbind
1360 #define         be_add          bd_info->bi_op_add
1361 #define         be_compare      bd_info->bi_op_compare
1362 #define         be_delete       bd_info->bi_op_delete
1363 #define         be_modify       bd_info->bi_op_modify
1364 #define         be_modrdn       bd_info->bi_op_modrdn
1365 #define         be_search       bd_info->bi_op_search
1366 #define         be_abandon      bd_info->bi_op_abandon
1367 #define         be_cancel       bd_info->bi_op_cancel
1368
1369 #define         be_extended     bd_info->bi_extended
1370
1371 #define         be_fetch        bd_info->bi_entry_get_rw
1372 #define         be_release      bd_info->bi_entry_release_rw
1373 #define         be_chk_referrals        bd_info->bi_chk_referrals
1374 #define         be_group        bd_info->bi_acl_group
1375 #define         be_attribute    bd_info->bi_acl_attribute
1376 #define         be_operational  bd_info->bi_operational
1377
1378 /*
1379  * define to honor hasSubordinates operational attribute in search filters
1380  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1381  * is fixed).
1382  */
1383 #define         be_has_subordinates bd_info->bi_has_subordinates
1384
1385 #define         be_controls     bd_info->bi_controls
1386
1387 #define         be_connection_init      bd_info->bi_connection_init
1388 #define         be_connection_destroy   bd_info->bi_connection_destroy
1389
1390 #ifdef SLAPD_TOOLS
1391 #define         be_entry_open bd_info->bi_tool_entry_open
1392 #define         be_entry_close bd_info->bi_tool_entry_close
1393 #define         be_entry_first bd_info->bi_tool_entry_first
1394 #define         be_entry_next bd_info->bi_tool_entry_next
1395 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1396 #define         be_entry_get bd_info->bi_tool_entry_get
1397 #define         be_entry_put bd_info->bi_tool_entry_put
1398 #define         be_sync bd_info->bi_tool_sync
1399 #endif
1400
1401 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1402 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1403 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1404 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1405 #define SLAP_BFLAG_ALIASES              0x0100U
1406 #define SLAP_BFLAG_REFERRALS    0x0200U
1407 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1408 #define SLAP_BFLAG_MONITOR              0x1000U
1409 #define SLAP_BFLAG_DYNAMIC              0x2000U
1410         slap_mask_t     be_flags;
1411 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1412 #define SLAP_GLUE_INSTANCE(be)  ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1413 #define SLAP_GLUE_SUBORDINATE(be) \
1414         ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1415 #define SLAP_GLUE_LINKED(be)    ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1416 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1417 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1418 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1419 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1420 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1421
1422         slap_mask_t     be_restrictops;         /* restriction operations */
1423 #define SLAP_RESTRICT_OP_ADD            0x0001U
1424 #define SLAP_RESTRICT_OP_BIND           0x0002U
1425 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1426 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1427 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1428 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1429 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1430 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1431
1432 #define SLAP_RESTRICT_OP_READS  \
1433         ( SLAP_RESTRICT_OP_COMPARE      \
1434         | SLAP_RESTRICT_OP_SEARCH )
1435 #define SLAP_RESTRICT_OP_WRITES \
1436         ( SLAP_RESTRICT_OP_ADD    \
1437         | SLAP_RESTRICT_OP_DELETE \
1438         | SLAP_RESTRICT_OP_MODIFY \
1439         | SLAP_RESTRICT_OP_RENAME )
1440
1441 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1442 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1443 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1444
1445 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1446
1447 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1448 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1449 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1450                                                                         0x0004U /* unprotected simple auth */
1451 #define SLAP_DISALLOW_BIND_KRBV4        0x0008U /* Kerberos V4 authentication */
1452
1453 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1454 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1455
1456 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1457
1458         slap_mask_t     be_requires;    /* pre-operation requirements */
1459 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1460 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1461 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1462 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1463 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1464
1465         /* Required Security Strength Factor */
1466         slap_ssf_set_t be_ssf_set;
1467
1468         /* these should be renamed from be_ to bd_ */
1469         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1470         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1471         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1472         struct berval be_schemandn;     /* normalized subschema DN */
1473         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1474         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1475         struct berval be_rootpw;        /* the magic "root" password for this db        */
1476         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1477 #define be_sizelimit    be_def_limit.lms_s_soft
1478 #define be_timelimit    be_def_limit.lms_t_soft
1479         struct slap_limits_set be_def_limit; /* default limits */
1480         struct slap_limits **be_limits; /* regex-based size and time limits */
1481         AccessControl *be_acl;  /* access control list for this backend    */
1482         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1483         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1484         char    *be_replogfile; /* replication log file (in master)        */
1485         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1486         BerVarray       be_update_refs; /* where to refer modifying clients to */
1487         char    *be_realm;
1488         void    *be_private;    /* anything the backend database needs     */
1489
1490         void    *be_pb;         /* Netscape plugin */
1491 #ifdef LDAP_SYNCREPL
1492         syncinfo_t      *syncinfo;      /* For syncrepl */
1493 #endif
1494 };
1495
1496 struct slap_conn;
1497 struct slap_op;
1498
1499 /* Backend function typedefs */
1500 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1501 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1502         const char *fname, int lineno,
1503         int argc, char **argv));
1504 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1505 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1506 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1507
1508 typedef int (BI_db_init) LDAP_P((Backend *bd));
1509 typedef int (BI_db_config) LDAP_P((Backend *bd,
1510         const char *fname, int lineno,
1511         int argc, char **argv));
1512 typedef int (BI_db_open) LDAP_P((Backend *bd));
1513 typedef int (BI_db_close) LDAP_P((Backend *bd));
1514 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1515
1516 typedef struct req_bind_s {
1517         int rb_method;
1518         struct berval rb_cred;
1519         struct berval rb_edn;
1520         slap_ssf_t rb_ssf;
1521 } req_bind_s;
1522
1523 typedef struct req_search_s {
1524         int rs_scope;
1525         int rs_deref;
1526         int rs_slimit;
1527         int rs_tlimit;
1528         int rs_attrsonly;
1529         AttributeName *rs_attrs;
1530         Filter *rs_filter;
1531         struct berval rs_filterstr;
1532 } req_search_s;
1533
1534 typedef struct req_compare_s {
1535         AttributeAssertion *rs_ava;
1536 } req_compare_s;
1537
1538 typedef struct req_modify_s {
1539         Modifications *rs_modlist;
1540 } req_modify_s;
1541
1542 typedef struct req_modrdn_s {
1543         struct berval rs_newrdn;
1544         struct berval rs_nnewrdn;
1545         struct berval *rs_newSup;
1546         struct berval *rs_nnewSup;
1547         int rs_deleteoldrdn;
1548 } req_modrdn_s;
1549
1550 typedef struct req_add_s {
1551         Entry *rs_e;
1552 } req_add_s;
1553
1554 typedef struct req_abandon_s {
1555         ber_int_t rs_msgid;
1556 } req_abandon_s;
1557
1558 typedef struct req_extended_s {
1559         struct berval rs_reqoid;
1560         struct berval *rs_reqdata;
1561 } req_extended_s;
1562
1563 typedef enum slap_reply_e {
1564         REP_RESULT,
1565         REP_SASL,
1566         REP_EXTENDED,
1567         REP_SEARCH,
1568         REP_SEARCHREF
1569 } slap_reply_t;
1570
1571 typedef struct rep_sasl_s {
1572         struct berval *r_sasldata;
1573 } rep_sasl_s;
1574
1575 typedef struct rep_extended_s {
1576         const char *r_rspoid;
1577         struct berval *r_rspdata;
1578 } rep_extended_s;
1579
1580 typedef struct rep_search_s {
1581         Entry *r_entry;
1582         AttributeName *r_attrs;
1583         int r_nentries;
1584         BerVarray r_v2ref;
1585 } rep_search_s;
1586
1587 typedef struct slap_rep {
1588         slap_reply_t sr_type;
1589         ber_tag_t sr_tag;
1590         ber_int_t sr_msgid;
1591         ber_int_t sr_err;
1592         const char *sr_matched;
1593         const char *sr_text;
1594         BerVarray sr_ref;
1595         LDAPControl **sr_ctrls;
1596         union sr_u {
1597                 rep_sasl_s sru_sasl;
1598                 rep_extended_s sru_extended;
1599                 rep_search_s sru_search;
1600         } sr_un;
1601 } SlapReply;
1602
1603 /* short hands for response members */
1604 #define sr_attrs sr_un.sru_search.r_attrs
1605 #define sr_entry sr_un.sru_search.r_entry
1606 #define sr_v2ref sr_un.sru_search.r_v2ref
1607 #define sr_nentries sr_un.sru_search.r_nentries
1608 #define sr_rspoid sr_un.sru_extended.r_rspoid
1609 #define sr_rspdata sr_un.sru_extended.r_rspdata
1610 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1611
1612 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1613 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1614 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1615 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1616 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1617 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1618 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1619 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1620 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1621 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1622 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1623 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1624 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1625         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1626 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1627 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1628 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1629
1630 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1631                 struct slap_conn *c));
1632 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1633                 struct slap_conn *c));
1634
1635 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1636 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1637 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1638 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1639 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1640 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1641                         struct berval *text ));
1642 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1643 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1644
1645 struct slap_backend_info {
1646         char    *bi_type; /* type of backend */
1647
1648         /*
1649          * per backend type routines:
1650          * bi_init: called to allocate a backend_info structure,
1651          *              called once BEFORE configuration file is read.
1652          *              bi_init() initializes this structure hence is
1653          *              called directly from be_initialize()
1654          * bi_config: called per 'backend' specific option
1655          *              all such options must before any 'database' options
1656          *              bi_config() is called only from read_config()
1657          * bi_open: called to open each database, called
1658          *              once AFTER configuration file is read but
1659          *              BEFORE any bi_db_open() calls.
1660          *              bi_open() is called from backend_startup()
1661          * bi_close: called to close each database, called
1662          *              once during shutdown after all bi_db_close calls.
1663          *              bi_close() is called from backend_shutdown()
1664          * bi_destroy: called to destroy each database, called
1665          *              once during shutdown after all bi_db_destroy calls.
1666          *              bi_destory() is called from backend_destroy()
1667          */
1668         BI_init *bi_init;
1669         BI_config       *bi_config;
1670         BI_open *bi_open;
1671         BI_close        *bi_close;
1672         BI_destroy      *bi_destroy;
1673
1674         /*
1675          * per database routines:
1676          * bi_db_init: called to initialize each database,
1677          *      called upon reading 'database <type>'
1678          *      called only from backend_db_init()
1679          * bi_db_config: called to configure each database,
1680          *  called per database to handle per database options
1681          *      called only from read_config()
1682          * bi_db_open: called to open each database
1683          *      called once per database immediately AFTER bi_open()
1684          *      calls but before daemon startup.
1685          *  called only by backend_startup()
1686          * bi_db_close: called to close each database
1687          *      called once per database during shutdown but BEFORE
1688          *  any bi_close call.
1689          *  called only by backend_shutdown()
1690          * bi_db_destroy: called to destroy each database
1691          *  called once per database during shutdown AFTER all
1692          *  bi_close calls but before bi_destory calls.
1693          *  called only by backend_destory()
1694          */
1695         BI_db_init      *bi_db_init;
1696         BI_db_config    *bi_db_config;
1697         BI_db_open      *bi_db_open;
1698         BI_db_close     *bi_db_close;
1699         BI_db_destroy   *bi_db_destroy;
1700
1701         /* LDAP Operations Handling Routines */
1702         BI_op_bind      *bi_op_bind;
1703         BI_op_unbind    *bi_op_unbind;
1704         BI_op_search    *bi_op_search;
1705         BI_op_compare   *bi_op_compare;
1706         BI_op_modify    *bi_op_modify;
1707         BI_op_modrdn    *bi_op_modrdn;
1708         BI_op_add       *bi_op_add;
1709         BI_op_delete    *bi_op_delete;
1710         BI_op_abandon   *bi_op_abandon;
1711         BI_op_cancel    *bi_op_cancel;
1712
1713         /* Extended Operations Helper */
1714         BI_op_extended  *bi_extended;
1715
1716         /* Auxilary Functions */
1717         BI_entry_get_rw         *bi_entry_get_rw;
1718         BI_entry_release_rw     *bi_entry_release_rw;
1719         BI_chk_referrals        *bi_chk_referrals;
1720
1721         BI_operational  *bi_operational;
1722         BI_has_subordinates     *bi_has_subordinates;
1723
1724         BI_connection_init      *bi_connection_init;
1725         BI_connection_destroy   *bi_connection_destroy;
1726
1727         /* hooks for slap tools */
1728         BI_tool_entry_open      *bi_tool_entry_open;
1729         BI_tool_entry_close     *bi_tool_entry_close;
1730         BI_tool_entry_first     *bi_tool_entry_first;
1731         BI_tool_entry_next      *bi_tool_entry_next;
1732         BI_tool_entry_get       *bi_tool_entry_get;
1733         BI_tool_entry_put       *bi_tool_entry_put;
1734         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1735         BI_tool_sync            *bi_tool_sync;
1736
1737 #define SLAP_INDEX_ADD_OP               0x0001
1738 #define SLAP_INDEX_DELETE_OP    0x0002
1739
1740         char **bi_controls;             /* supported controls */
1741
1742         unsigned int bi_nDB;    /* number of databases of this type */
1743         void    *bi_private;    /* anything the backend type needs */
1744 };
1745
1746 #define c_authtype      c_authz.sai_method
1747 #define c_authmech      c_authz.sai_mech
1748 #define c_dn            c_authz.sai_dn
1749 #define c_ndn           c_authz.sai_ndn
1750 #define c_ssf                   c_authz.sai_ssf
1751 #define c_transport_ssf c_authz.sai_transport_ssf
1752 #define c_tls_ssf               c_authz.sai_tls_ssf
1753 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1754
1755 #define o_authtype      o_authz.sai_method
1756 #define o_authmech      o_authz.sai_mech
1757 #define o_dn            o_authz.sai_dn
1758 #define o_ndn           o_authz.sai_ndn
1759 #define o_ssf                   o_authz.sai_ssf
1760 #define o_transport_ssf o_authz.sai_transport_ssf
1761 #define o_tls_ssf               o_authz.sai_tls_ssf
1762 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1763
1764 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1765
1766 typedef struct slap_callback {
1767         slap_response *sc_response;
1768         void *sc_private;
1769 } slap_callback;
1770
1771 /*
1772  * Paged Results state
1773  */
1774 typedef unsigned long PagedResultsCookie;
1775 typedef struct slap_paged_state {
1776         Backend *ps_be;
1777         PagedResultsCookie ps_cookie;
1778         ID ps_id;
1779 } PagedResultsState;
1780
1781
1782 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1783 #define LDAP_PSEARCH_BY_ADD             0x01
1784 #define LDAP_PSEARCH_BY_DELETE          0x02
1785 #define LDAP_PSEARCH_BY_PREMODIFY       0x03
1786 #define LDAP_PSEARCH_BY_MODIFY          0x04
1787 #define LDAP_PSEARCH_BY_SCOPEOUT        0x05
1788
1789 struct psid_entry {
1790         struct slap_op *ps_op;
1791         LDAP_LIST_ENTRY(psid_entry) ps_link;
1792 };
1793 #endif
1794
1795
1796 /*
1797  * represents an operation pending from an ldap client
1798  */
1799 typedef struct slap_op {
1800         unsigned long o_opid;   /* id of this operation */
1801         unsigned long o_connid; /* id of conn initiating this op */
1802         struct slap_conn *o_conn;       /* connection spawning this op */
1803         BackendDB       *o_bd;  /* backend DB processing this op */
1804
1805         ber_int_t       o_msgid;        /* msgid of the request */
1806         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1807         ber_tag_t       o_tag;          /* tag of the request */
1808         time_t          o_time;         /* time op was initiated */
1809
1810         struct berval   o_req_dn;       /* DN of target of request */
1811         struct berval   o_req_ndn;
1812
1813         union o_req_u {
1814                 req_add_s oq_add;
1815                 req_bind_s oq_bind;
1816                 req_compare_s oq_compare;
1817                 req_modify_s oq_modify;
1818                 req_modrdn_s oq_modrdn;
1819                 req_search_s oq_search;
1820                 req_abandon_s oq_abandon;
1821                 req_abandon_s oq_cancel;
1822                 req_extended_s oq_extended;
1823         } o_request;
1824
1825 /* short hands for union members */
1826 #define oq_add o_request.oq_add
1827 #define oq_bind o_request.oq_bind
1828 #define oq_compare o_request.oq_compare
1829 #define oq_modify o_request.oq_modify
1830 #define oq_modrdn o_request.oq_modrdn
1831 #define oq_search o_request.oq_search
1832 #define oq_abandon o_request.oq_abandon
1833 #define oq_cancel o_request.oq_cancel
1834 #define oq_extended o_request.oq_extended
1835
1836 /* short hands for inner request members */
1837 #define orb_method oq_bind.rb_method
1838 #define orb_cred oq_bind.rb_cred
1839 #define orb_edn oq_bind.rb_edn
1840 #define orb_ssf oq_bind.rb_ssf
1841
1842 #define ors_scope oq_search.rs_scope
1843 #define ors_deref oq_search.rs_deref
1844 #define ors_slimit oq_search.rs_slimit
1845 #define ors_tlimit oq_search.rs_tlimit
1846 #define ors_attrsonly oq_search.rs_attrsonly
1847 #define ors_attrs oq_search.rs_attrs
1848 #define ors_filter oq_search.rs_filter
1849 #define ors_filterstr oq_search.rs_filterstr
1850
1851 #define orr_newrdn oq_modrdn.rs_newrdn
1852 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1853 #define orr_newSup oq_modrdn.rs_newSup
1854 #define orr_nnewSup oq_modrdn.rs_nnewSup
1855 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1856
1857 #define orc_ava oq_compare.rs_ava
1858 #define ora_e oq_add.rs_e
1859 #define orn_msgid oq_abandon.rs_msgid
1860 #define orm_modlist oq_modify.rs_modlist
1861
1862 #define ore_reqoid oq_extended.rs_reqoid
1863 #define ore_reqdata oq_extended.rs_reqdata
1864
1865         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1866
1867         volatile sig_atomic_t o_abandon;        /* abandon flag */
1868         volatile sig_atomic_t o_cancel;         /* cancel flag */
1869 #define SLAP_CANCEL_NONE                                0x00
1870 #define SLAP_CANCEL_REQ                                 0x01
1871 #define SLAP_CANCEL_ACK                                 0x02
1872 #define SLAP_CANCEL_DONE                                0x03
1873
1874         char o_do_not_cache;    /* don't cache from this op */
1875         char o_is_auth_check;   /* authorization in progress */
1876
1877 #define SLAP_NO_CONTROL 0
1878 #define SLAP_NONCRITICAL_CONTROL 1
1879 #define SLAP_CRITICAL_CONTROL 2
1880         char o_managedsait;
1881 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1882
1883         char o_noop;
1884         char o_proxy_authz;
1885
1886         char o_subentries;
1887 #define get_subentries(op)                              ((int)(op)->o_subentries)
1888         char o_subentries_visibility;
1889 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1890
1891         char o_valuesreturnfilter;
1892
1893 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1894         char o_permissive_modify;
1895 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
1896 #else
1897 #define get_permissiveModify(op)                (0)
1898 #endif
1899
1900 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1901         char o_domain_scope;
1902 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
1903 #else
1904 #define get_domainScope(op)                             (0)
1905 #endif
1906
1907 #ifdef LDAP_CONTROL_PAGEDRESULTS
1908         char o_pagedresults;
1909 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
1910         ber_int_t o_pagedresults_size;
1911         PagedResultsState o_pagedresults_state;
1912 #else
1913 #define get_pagedresults(op)                    (0)
1914 #endif
1915
1916 #ifdef LDAP_CLIENT_UPDATE
1917         char o_clientupdate;
1918         char o_clientupdate_type;
1919 #define SLAP_LCUP_NONE                          (0x0)
1920 #define SLAP_LCUP_SYNC                          (0x1)
1921 #define SLAP_LCUP_PERSIST                       (0x2)
1922 #define SLAP_LCUP_SYNC_AND_PERSIST              (0x3)
1923         ber_int_t o_clientupdate_interval;
1924         struct berval o_clientupdate_state;
1925 #endif
1926
1927 #ifdef LDAP_SYNC
1928         char o_sync;
1929         char o_sync_mode;
1930 #define SLAP_SYNC_NONE                          (0x0)
1931 #define SLAP_SYNC_REFRESH                       (0x1)
1932 #define SLAP_SYNC_PERSIST                       (0x2)
1933 #define SLAP_SYNC_REFRESH_AND_PERSIST           (0x3)
1934         struct berval o_sync_state;
1935 #endif
1936
1937 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1938         int o_ps_protocol;
1939         int o_ps_entries;
1940         LDAP_LIST_ENTRY(slap_op) o_ps_link;
1941         LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1942 #endif
1943
1944         AuthorizationInformation o_authz;
1945
1946         BerElement      *o_ber;         /* ber of the request             */
1947 #ifdef LDAP_CONNECTIONLESS
1948         BerElement      *o_res_ber;     /* ber of the reply               */
1949 #endif
1950         slap_callback   *o_callback;    /* callback pointers */
1951         LDAPControl     **o_ctrls;       /* controls */
1952
1953         void    *o_threadctx;           /* thread pool thread context */
1954         void    *o_tmpmemctx;           /* slab malloc context */
1955         BerMemoryFunctions *o_tmpmfuncs;
1956 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
1957 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
1958 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
1959 #define o_tmpfree       o_tmpmfuncs->bmf_free
1960         void    *o_private;     /* anything the backend needs */
1961
1962         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1963         ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1964
1965 #ifdef LDAP_CACHING
1966         char            o_caching_on;
1967 #endif /*LDAP_CACHING */
1968
1969 #ifdef LDAP_SLAPI
1970         void    *o_pb;                  /* NS-SLAPI plugin */
1971 #endif
1972 } Operation;
1973
1974 #define send_ldap_error( op, rs, err, text ) \
1975 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1976 (op->o_conn->c_send_ldap_result)( op, rs ); } while (0)
1977 #define send_ldap_discon( op, rs, err, text ) \
1978 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1979 send_ldap_disconnect( op, rs ); } while (0)
1980 typedef void (SEND_LDAP_RESULT)(struct slap_op *op, struct slap_rep *rs);
1981 typedef int (SEND_SEARCH_ENTRY)(struct slap_op *op, struct slap_rep *rs);
1982 typedef int (SEND_SEARCH_REFERENCE)(struct slap_op *op, struct slap_rep *rs);
1983 typedef void (SEND_LDAP_EXTENDED)(struct slap_op *op, struct slap_rep *rs);
1984 typedef void (SEND_LDAP_INTERMEDIATE_RESP)(struct slap_op *op, struct slap_rep *rs);
1985 #define send_ldap_result( op, rs ) \
1986 (op->o_conn->c_send_ldap_result)( op, rs )
1987 #define send_search_entry( op, rs ) \
1988 (op->o_conn->c_send_search_entry)( op, rs )
1989 #define send_search_reference( op, rs ) \
1990 (op->o_conn->c_send_search_reference)( op, rs )
1991 #define send_ldap_extended( op, rs ) \
1992 (op->o_conn->c_send_ldap_extended)( op, rs )
1993 #define send_ldap_intermediate_resp( op, rs ) \
1994 (op->o_conn->c_send_ldap_intermediate_resp)( op, rs )
1995
1996 /*
1997  * Caches the result of a backend_group check for ACL evaluation
1998  */
1999 typedef struct slap_gacl {
2000         struct slap_gacl *ga_next;
2001         Backend *ga_be;
2002         ObjectClass *ga_oc;
2003         AttributeDescription *ga_at;
2004         int ga_res;
2005         ber_len_t ga_len;
2006         char ga_ndn[1];
2007 } GroupAssertion;
2008
2009 typedef struct slap_listener Listener;
2010
2011 /*
2012  * represents a connection from an ldap client
2013  */
2014 typedef struct slap_conn {
2015         int                     c_struct_state; /* structure management state */
2016         int                     c_conn_state;   /* connection state */
2017
2018         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2019         Sockbuf         *c_sb;                  /* ber connection stuff           */
2020
2021         /* only can be changed by connect_init */
2022         time_t          c_starttime;    /* when the connection was opened */
2023         time_t          c_activitytime; /* when the connection was last used */
2024         unsigned long           c_connid;       /* id of this connection for stats*/
2025
2026         struct berval   c_peer_domain;  /* DNS name of client */
2027         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2028         Listener        *c_listener;
2029 #define c_listener_url c_listener->sl_url       /* listener URL */
2030 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2031
2032         /* only can be changed by binding thread */
2033         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2034         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2035         struct berval   c_sasl_dn;      /* temporary storage */
2036
2037         /* authorization backend */
2038         Backend *c_authz_backend;
2039
2040         AuthorizationInformation c_authz;
2041         GroupAssertion *c_groups;
2042
2043         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2044
2045         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2046         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2047
2048         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2049         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2050
2051         BerElement      *c_currentber;  /* ber we're attempting to read */
2052         int             c_writewaiter;  /* true if writer is waiting */
2053
2054 #ifdef LDAP_CONNECTIONLESS
2055         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2056 #endif
2057 #ifdef HAVE_TLS
2058         int     c_is_tls;               /* true if this LDAP over raw TLS */
2059         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2060 #endif
2061         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2062         void    *c_sasl_context;        /* SASL session context */
2063         void    *c_sasl_extra;          /* SASL session extra stuff */
2064         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2065
2066         PagedResultsState c_pagedresults_state; /* paged result state */
2067
2068         long    c_n_ops_received;       /* num of ops received (next op_id) */
2069         long    c_n_ops_executing;      /* num of ops currently executing */
2070         long    c_n_ops_pending;        /* num of ops pending execution */
2071         long    c_n_ops_completed;      /* num of ops completed */
2072
2073         long    c_n_get;                /* num of get calls */
2074         long    c_n_read;               /* num of read calls */
2075         long    c_n_write;              /* num of write calls */
2076
2077         void    *c_pb;                  /* Netscape plugin */
2078
2079         /*
2080          * These are the "callbacks" that are available for back-ends to
2081          * supply data back to connected clients that are connected
2082          * through the "front-end".
2083          */
2084         SEND_LDAP_RESULT *c_send_ldap_result;
2085         SEND_SEARCH_ENTRY *c_send_search_entry;
2086         SEND_SEARCH_REFERENCE *c_send_search_reference;
2087         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2088 #ifdef LDAP_RES_INTERMEDIATE_RESP
2089         SEND_LDAP_INTERMEDIATE_RESP *c_send_ldap_intermediate_resp;
2090 #endif
2091
2092 } Connection;
2093
2094 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2095 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2096         do { \
2097                 if ( ldap_debug & (level) ) \
2098                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2099                 if ( ldap_syslog & (level) ) \
2100                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2101                                 (arg2), (arg3) ); \
2102         } while (0)
2103 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2104 #elif defined(LDAP_DEBUG)
2105 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2106         do { \
2107                 if ( ldap_debug & (level) ) \
2108                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2109         } while (0)
2110 #define StatslogTest( level ) (ldap_debug & (level))
2111 #else
2112 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2113 #define StatslogTest( level ) (0)
2114 #endif
2115
2116 /*
2117  * listener; need to access it from monitor backend
2118  */
2119 struct slap_listener {
2120         struct berval sl_url;
2121         struct berval sl_name;
2122         mode_t  sl_perms;
2123 #ifdef HAVE_TLS
2124         int             sl_is_tls;
2125 #endif
2126 #ifdef LDAP_CONNECTIONLESS
2127         int     sl_is_udp;              /* UDP listener is also data port */
2128 #endif
2129         ber_socket_t sl_sd;
2130         Sockaddr sl_sa;
2131 #define sl_addr sl_sa.sa_in_addr
2132 };
2133
2134 #ifdef SLAPD_MONITOR
2135 /*
2136  * Operation indices
2137  */
2138 enum {
2139         SLAP_OP_BIND = 0,
2140         SLAP_OP_UNBIND,
2141         SLAP_OP_ADD,
2142         SLAP_OP_DELETE,
2143         SLAP_OP_MODRDN,
2144         SLAP_OP_MODIFY,
2145         SLAP_OP_COMPARE,
2146         SLAP_OP_SEARCH,
2147         SLAP_OP_ABANDON,
2148         SLAP_OP_EXTENDED,
2149         SLAP_OP_LAST
2150 };
2151 #endif /* SLAPD_MONITOR */
2152
2153 /*
2154  * Better know these all around slapd
2155  */
2156 #define SLAP_LDAPDN_PRETTY 0x1
2157 #define SLAP_LDAPDN_MAXLEN 8192
2158
2159 /*
2160  * Macros for LCUP
2161  */
2162 #ifdef LDAP_CLIENT_UPDATE
2163 #define SLAP_LCUP_STATE_UPDATE_TRUE     1
2164 #define SLAP_LCUP_STATE_UPDATE_FALSE    0
2165 #define SLAP_LCUP_ENTRY_DELETED_TRUE    1
2166 #define SLAP_LCUP_ENTRY_DELETED_FALSE   0
2167 #endif /* LDAP_CLIENT_UPDATE */
2168
2169 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2170 #define SLAP_SEARCH_MAX_CTRLS   10
2171 #endif
2172
2173 #define SLAP_CTRL_FRONTEND                      0x80000000U
2174 #define SLAP_CTRL_FRONTEND_SEARCH       0x01000000U     /* for NOOP */
2175
2176 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2177 #define SLAP_CTRL_ABANDON                       0x00000001U
2178 #define SLAP_CTRL_ADD                           0x00002002U
2179 #define SLAP_CTRL_BIND                          0x00000004U
2180 #define SLAP_CTRL_COMPARE                       0x00001008U
2181 #define SLAP_CTRL_DELETE                        0x00002010U
2182 #define SLAP_CTRL_MODIFY                        0x00002020U
2183 #define SLAP_CTRL_RENAME                        0x00002040U
2184 #define SLAP_CTRL_SEARCH                        0x00001080U
2185 #define SLAP_CTRL_UNBIND                        0x00000100U
2186
2187 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2188 #define SLAP_CTRL_UPDATE \
2189         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2190 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2191
2192 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2193         Operation *op,
2194         SlapReply *rs,
2195         LDAPControl *ctrl ));
2196
2197 LDAP_END_DECL
2198
2199 #include "proto-slap.h"
2200
2201 #endif /* _SLAP_H_ */