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