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         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 805
 806         /* Syntaxes */
 807         Syntax          *si_syn_directoryString;
 808         Syntax          *si_syn_distinguishedName;
 809         Syntax          *si_syn_integer;
 810         Syntax          *si_syn_octetString;
 811 };
 812
 813 typedef struct slap_attr_assertion {
 814         AttributeDescription    *aa_desc;
 815         struct berval aa_value;
 816 } AttributeAssertion;
 817
 818 typedef struct slap_ss_assertion {
 819         AttributeDescription    *sa_desc;
 820         struct berval           sa_initial;
 821         struct berval           *sa_any;
 822         struct berval           sa_final;
 823 } SubstringsAssertion;
 824
 825 typedef struct slap_mr_assertion {
 826         MatchingRule            *ma_rule;       /* optional */
 827         struct berval           ma_rule_text;  /* optional */
 828         AttributeDescription    *ma_desc;       /* optional */
 829         int                                             ma_dnattrs; /* boolean */
 830         struct berval           ma_value;       /* required */
 831 } MatchingRuleAssertion;
 832
 833 /*
 834  * represents a search filter
 835  */
 836 typedef struct slap_filter {
 837         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 838 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 839 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 840 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 841
 842         union f_un_u {
 843                 /* precomputed result */
 844                 ber_int_t f_un_result;
 845
 846                 /* DN */
 847                 struct berval *f_un_dn;
 848
 849                 /* present */
 850                 AttributeDescription *f_un_desc;
 851
 852                 /* simple value assertion */
 853                 AttributeAssertion *f_un_ava;
 854
 855                 /* substring assertion */
 856                 SubstringsAssertion *f_un_ssa;
 857
 858                 /* matching rule assertion */
 859                 MatchingRuleAssertion *f_un_mra;
 860
 861 #define f_dn                    f_un.f_un_dn
 862 #define f_desc                  f_un.f_un_desc
 863 #define f_ava                   f_un.f_un_ava
 864 #define f_av_desc               f_un.f_un_ava->aa_desc
 865 #define f_av_value              f_un.f_un_ava->aa_value
 866 #define f_sub                   f_un.f_un_ssa
 867 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 868 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 869 #define f_sub_any               f_un.f_un_ssa->sa_any
 870 #define f_sub_final             f_un.f_un_ssa->sa_final
 871 #define f_mra                   f_un.f_un_mra
 872 #define f_mr_rule               f_un.f_un_mra->ma_rule
 873 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 874 #define f_mr_desc               f_un.f_un_mra->ma_desc
 875 #define f_mr_value              f_un.f_un_mra->ma_value
 876 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 877
 878                 /* and, or, not */
 879                 struct slap_filter *f_un_complex;
 880         } f_un;
 881
 882 #define f_result        f_un.f_un_result
 883 #define f_and           f_un.f_un_complex
 884 #define f_or            f_un.f_un_complex
 885 #define f_not           f_un.f_un_complex
 886 #define f_list          f_un.f_un_complex
 887
 888         struct slap_filter      *f_next;
 889 } Filter;
 890
 891 /* compare routines can return undefined */
 892 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 893
 894 typedef struct slap_valuesreturnfilter {
 895         ber_tag_t       vrf_choice;
 896
 897         union vrf_un_u {
 898                 /* precomputed result */
 899                 ber_int_t vrf_un_result;
 900
 901                 /* DN */
 902                 char *vrf_un_dn;
 903
 904                 /* present */
 905                 AttributeDescription *vrf_un_desc;
 906
 907                 /* simple value assertion */
 908                 AttributeAssertion *vrf_un_ava;
 909
 910                 /* substring assertion */
 911                 SubstringsAssertion *vrf_un_ssa;
 912
 913                 /* matching rule assertion */
 914                 MatchingRuleAssertion *vrf_un_mra;
 915
 916 #define vrf_result              vrf_un.vrf_un_result
 917 #define vrf_dn                  vrf_un.vrf_un_dn
 918 #define vrf_desc                vrf_un.vrf_un_desc
 919 #define vrf_ava                 vrf_un.vrf_un_ava
 920 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
 921 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
 922 #define vrf_ssa                 vrf_un.vrf_un_ssa
 923 #define vrf_sub                 vrf_un.vrf_un_ssa
 924 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
 925 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
 926 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
 927 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
 928 #define vrf_mra                 vrf_un.vrf_un_mra
 929 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
 930 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
 931 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
 932 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
 933 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
 934
 935
 936         } vrf_un;
 937
 938         struct slap_valuesreturnfilter  *vrf_next;
 939 } ValuesReturnFilter;
 940
 941 /*
 942  * represents an attribute (description + values)
 943  */
 944 typedef struct slap_attr {
 945         AttributeDescription *a_desc;
 946         BerVarray       a_vals;         /* preserved values */
 947         BerVarray       a_nvals;        /* normalized values */
 948         struct slap_attr *a_next;
 949         unsigned a_flags;
 950 #define SLAP_ATTR_IXADD         0x1U
 951 #define SLAP_ATTR_IXDEL         0x2U
 952 } Attribute;
 953
 954
 955 /*
 956  * the id used in the indexes to refer to an entry
 957  */
 958 typedef unsigned long   ID;
 959 #define NOID    ((ID)~0)
 960
 961 /*
 962  * represents an entry in core
 963  */
 964 typedef struct slap_entry {
 965         /*
 966          * The ID field should only be changed before entry is
 967          * inserted into a cache.  The ID value is backend
 968          * specific.
 969          */
 970         ID              e_id;
 971
 972         struct berval e_name;   /* name (DN) of this entry */
 973         struct berval e_nname;  /* normalized name (DN) of this entry */
 974
 975         /* for migration purposes */
 976 #define e_dn e_name.bv_val
 977 #define e_ndn e_nname.bv_val
 978
 979         Attribute       *e_attrs;       /* list of attributes + values */
 980
 981         slap_mask_t     e_ocflags;
 982
 983         struct berval   e_bv;           /* For entry_encode/entry_decode */
 984
 985         /* for use by the backend for any purpose */
 986         void*   e_private;
 987 } Entry;
 988
 989 /*
 990  * A list of LDAPMods
 991  */
 992 typedef struct slap_mod {
 993         int sm_op;
 994         AttributeDescription *sm_desc;
 995         struct berval sm_type;
 996         BerVarray sm_values;
 997 #define sm_bvalues sm_values
 998         BerVarray sm_nvalues;
 999 } Modification;
1000
1001 typedef struct slap_mod_list {
1002         Modification sml_mod;
1003 #define sml_op          sml_mod.sm_op
1004 #define sml_desc        sml_mod.sm_desc
1005 #define sml_type        sml_mod.sm_type
1006 #define sml_bvalues     sml_mod.sm_values
1007 #define sml_values      sml_mod.sm_values
1008 #define sml_nvalues     sml_mod.sm_nvalues
1009         struct slap_mod_list *sml_next;
1010 } Modifications;
1011
1012 typedef struct slap_ldap_modlist {
1013         LDAPMod ml_mod;
1014         struct slap_ldap_modlist *ml_next;
1015 #define ml_op           ml_mod.mod_op
1016 #define ml_type         ml_mod.mod_type
1017 #define ml_values       ml_mod.mod_values
1018 #define ml_bvalues      ml_mod.mod_values
1019 } LDAPModList;
1020
1021 /*
1022  * represents an access control list
1023  */
1024 typedef enum slap_access_e {
1025         ACL_INVALID_ACCESS = -1,
1026         ACL_NONE = 0,
1027         ACL_AUTH,
1028         ACL_COMPARE,
1029         ACL_SEARCH,
1030         ACL_READ,
1031         ACL_WRITE
1032 } slap_access_t;
1033
1034 typedef enum slap_control_e {
1035         ACL_INVALID_CONTROL     = 0,
1036         ACL_STOP,
1037         ACL_CONTINUE,
1038         ACL_BREAK
1039 } slap_control_t;
1040
1041 typedef enum slap_style_e {
1042         ACL_STYLE_REGEX = 0,
1043         ACL_STYLE_BASE,
1044         ACL_STYLE_ONE,
1045         ACL_STYLE_SUBTREE,
1046         ACL_STYLE_CHILDREN,
1047         ACL_STYLE_ATTROF,
1048
1049         /* alternate names */
1050         ACL_STYLE_EXACT = ACL_STYLE_BASE
1051 } slap_style_t;
1052
1053 typedef struct slap_authz_info {
1054         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
1055         struct berval   sai_mech;               /* SASL Mechanism */
1056         struct berval   sai_dn;                 /* DN for reporting purposes */
1057         struct berval   sai_ndn;                /* Normalized DN */
1058
1059         /* Security Strength Factors */
1060         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1061         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1062         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1063         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1064 } AuthorizationInformation;
1065
1066 /* the "by" part */
1067 typedef struct slap_access {
1068         slap_control_t a_type;
1069
1070 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1071
1072 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1073 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1074 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1075 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1076 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1077 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
1078
1079 #define ACL_PRIV_MASK                   0x00ffUL
1080
1081 /* priv flags */
1082 #define ACL_PRIV_LEVEL                  0x1000UL
1083 #define ACL_PRIV_ADDITIVE               0x2000UL
1084 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
1085
1086 /* invalid privs */
1087 #define ACL_PRIV_INVALID                0x0UL
1088
1089 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1090 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
1091 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1092 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1093
1094 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1095 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1096
1097 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1098
1099 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1100
1101 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1102 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1103 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1104
1105 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1106 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
1107 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1108 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1109 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1110 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1111
1112 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1113 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1114 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1115 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
1116 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
1117 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1118 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1119
1120 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1121 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1122 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1123 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1124 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1125 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1126
1127         slap_mask_t     a_access_mask;
1128
1129         AuthorizationInformation        a_authz;
1130 #define a_dn_pat        a_authz.sai_dn
1131
1132         slap_style_t a_dn_style;
1133         AttributeDescription    *a_dn_at;
1134         int                     a_dn_self;
1135         int                     a_dn_expand;
1136
1137         slap_style_t a_peername_style;
1138         struct berval   a_peername_pat;
1139         slap_style_t a_sockname_style;
1140         struct berval   a_sockname_pat;
1141
1142         slap_style_t a_domain_style;
1143         struct berval   a_domain_pat;
1144         int             a_domain_expand;
1145
1146         slap_style_t a_sockurl_style;
1147         struct berval   a_sockurl_pat;
1148         slap_style_t a_set_style;
1149         struct berval   a_set_pat;
1150
1151 #ifdef SLAPD_ACI_ENABLED
1152         AttributeDescription    *a_aci_at;
1153 #endif
1154
1155         /* ACL Groups */
1156         slap_style_t a_group_style;
1157         struct berval   a_group_pat;
1158         ObjectClass                             *a_group_oc;
1159         AttributeDescription    *a_group_at;
1160
1161         struct slap_access      *a_next;
1162 } Access;
1163
1164 /* the "to" part */
1165 typedef struct slap_acl {
1166         /* "to" part: the entries this acl applies to */
1167         Filter          *acl_filter;
1168         slap_style_t acl_dn_style;
1169         regex_t         acl_dn_re;
1170         struct berval   acl_dn_pat;
1171         AttributeName   *acl_attrs;
1172
1173         /* "by" part: list of who has what access to the entries */
1174         Access  *acl_access;
1175
1176         struct slap_acl *acl_next;
1177 } AccessControl;
1178
1179 typedef struct slap_acl_state {
1180         unsigned as_recorded;
1181 #define ACL_STATE_NOT_RECORDED                  0x0
1182 #define ACL_STATE_RECORDED_VD                   0x1
1183 #define ACL_STATE_RECORDED_NV                   0x2
1184 #define ACL_STATE_RECORDED                              0x3
1185
1186         /* Access state */
1187         AccessControl *as_vd_acl;
1188         AccessControl *as_vi_acl;
1189         slap_mask_t as_vd_acl_mask;
1190         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1191         int as_vd_acl_count;
1192
1193         Access *as_vd_access;
1194         int as_vd_access_count;
1195
1196         int as_result;
1197         AttributeDescription *as_vd_ad;
1198 } AccessControlState;
1199 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1200         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1201
1202 /*
1203  * Backend-info
1204  * represents a backend
1205  */
1206
1207 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1208 typedef struct slap_backend_db BackendDB;               /* per backend database */
1209
1210 LDAP_SLAPD_V (int) nBackendInfo;
1211 LDAP_SLAPD_V (int) nBackendDB;
1212 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1213 LDAP_SLAPD_V (BackendDB *) backendDB;
1214
1215 LDAP_SLAPD_V (int) slapMode;
1216 #define SLAP_UNDEFINED_MODE     0x0000
1217 #define SLAP_SERVER_MODE        0x0001
1218 #define SLAP_TOOL_MODE          0x0002
1219 #define SLAP_MODE                       0x0003
1220
1221 #define SLAP_TRUNCATE_MODE      0x0100
1222
1223 struct slap_replica_info {
1224         char *ri_host;                          /* supersedes be_replica */
1225         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1226         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1227         int ri_exclude;                 /* 1 => exclude ri_attrs */
1228 };
1229
1230 struct slap_limits_set {
1231         /* time limits */
1232         int     lms_t_soft;
1233         int     lms_t_hard;
1234
1235         /* size limits */
1236         int     lms_s_soft;
1237         int     lms_s_hard;
1238         int     lms_s_unchecked;
1239         int     lms_s_pr;
1240         int     lms_s_pr_hide;
1241 };
1242
1243 struct slap_limits {
1244         int     lm_type;        /* type of pattern */
1245 #define SLAP_LIMITS_UNDEFINED   0x0000
1246 #define SLAP_LIMITS_EXACT       0x0001
1247 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1248 #define SLAP_LIMITS_ONE         0x0002
1249 #define SLAP_LIMITS_SUBTREE     0x0003
1250 #define SLAP_LIMITS_CHILDREN    0x0004
1251 #define SLAP_LIMITS_REGEX       0x0005
1252 #define SLAP_LIMITS_ANONYMOUS   0x0006
1253 #define SLAP_LIMITS_USERS       0x0007
1254 #define SLAP_LIMITS_ANY         0x0008
1255         regex_t lm_dn_regex;            /* regex data for REGEX */
1256
1257         /*
1258          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1259          * pattern for REGEX; NULL for ANONYMOUS, USERS
1260          */
1261         struct berval lm_dn_pat;
1262
1263         struct slap_limits_set  lm_limits;
1264 };
1265
1266 /* temporary aliases */
1267 typedef BackendDB Backend;
1268 #define nbackends nBackendDB
1269 #define backends backendDB
1270
1271 #ifdef LDAP_SYNCREPL
1272
1273 struct nonpresent_entry {
1274         struct berval *dn;
1275         struct berval *ndn;
1276         LDAP_LIST_ENTRY(nonpresent_entry) np_link;
1277 };
1278
1279  /*
1280   * syncinfo structure for syncrepl
1281   */
1282 typedef struct syncinfo_s {
1283         struct slap_conn *conn;
1284         struct slap_backend_db *be;
1285         struct slap_entry *e;
1286         void            *ctx;
1287         int             id;
1288         char            *masteruri;
1289         char            *mastername;
1290         int             masterport;
1291         int             type;
1292         char            *binddn;
1293         int             bindmethod;
1294         char            *passwd;
1295         char            *secprops;
1296         char            *realm;
1297         char            *authcId;
1298         char            *authzId;
1299         char            *srvtab;
1300         char            *saslmech;
1301         int             interval;
1302         char            *base;
1303         int             scope;
1304         int             deref;
1305         int             slimit;
1306         int             tlimit;
1307         Filter          *filter;
1308         char            *filterstr;
1309         char            **attrs;
1310         int             attrsonly;
1311 #define LASTMOD_REQ             0
1312 #define LASTMOD_GEN             1
1313 #define LASTMOD_NO              2
1314         int             lastmod;
1315         /* TLS flags */
1316 #define TLS_OFF                 0
1317 #define TLS_ON                  1
1318 #define TLS_CRITICAL            2
1319         int             tls;
1320         int             found;
1321         struct berval   *syncUUID;
1322         struct berval   *syncCookie;
1323         Avlnode         *presentlist;
1324                 LDAP_LIST_HEAD(np, nonpresent_entry) nonpresentlist;
1325 } syncinfo_t;
1326
1327 #define IDSTR           "id"
1328 #define MASTERSTR       "master"
1329 #define SUFFIXSTR       "suffix"
1330 #define BINDDNSTR       "binddn"
1331 #define BINDMETHSTR     "bindmethod"
1332 #define SIMPLESTR       "simple"
1333 #define SASLSTR         "sasl"
1334 #define CREDSTR         "credentials"
1335 #define OLDAUTHCSTR     "bindprincipal"
1336 #define AUTHCSTR        "authcID"
1337 #define AUTHZSTR        "authzID"
1338 #define SRVTABSTR       "srvtab"
1339 #define SASLMECHSTR     "saslmech"
1340 #define REALMSTR        "realm"
1341 #define SECPROPSSTR     "secprops"
1342 #define TLSSTR          "tls"
1343 #define TLSCRITICALSTR  "critical"
1344
1345 #define FILTERSTR       "filter"
1346 #define SEARCHBASESTR   "searchbase"
1347 #define SCOPESTR        "scope"
1348 #define ATTRSSTR        "attrs"
1349 #define ATTRSONLYSTR    "attrsonly"
1350 #define TYPESTR         "type"
1351 #define INTERVALSTR     "interval"
1352 #define COOKIESTR       "cookie"
1353 #define LASTMODSTR      "lastmod"
1354 #define LMREQSTR        "req"
1355 #define LMGENSTR        "gen"
1356 #define LMNOSTR         "no"
1357
1358 #endif /* LDAP_SYNCREPL */
1359
1360 struct slap_backend_db {
1361         BackendInfo     *bd_info;       /* pointer to shared backend info */
1362
1363         /* BackendInfo accessors */
1364 #define         be_config       bd_info->bi_db_config
1365 #define         be_type         bd_info->bi_type
1366
1367 #define         be_bind         bd_info->bi_op_bind
1368 #define         be_unbind       bd_info->bi_op_unbind
1369 #define         be_add          bd_info->bi_op_add
1370 #define         be_compare      bd_info->bi_op_compare
1371 #define         be_delete       bd_info->bi_op_delete
1372 #define         be_modify       bd_info->bi_op_modify
1373 #define         be_modrdn       bd_info->bi_op_modrdn
1374 #define         be_search       bd_info->bi_op_search
1375 #define         be_abandon      bd_info->bi_op_abandon
1376 #define         be_cancel       bd_info->bi_op_cancel
1377
1378 #define         be_extended     bd_info->bi_extended
1379
1380 #define         be_fetch        bd_info->bi_entry_get_rw
1381 #define         be_release      bd_info->bi_entry_release_rw
1382 #define         be_chk_referrals        bd_info->bi_chk_referrals
1383 #define         be_group        bd_info->bi_acl_group
1384 #define         be_attribute    bd_info->bi_acl_attribute
1385 #define         be_operational  bd_info->bi_operational
1386
1387 /*
1388  * define to honor hasSubordinates operational attribute in search filters
1389  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1390  * is fixed).
1391  */
1392 #define         be_has_subordinates bd_info->bi_has_subordinates
1393
1394 #define         be_controls     bd_info->bi_controls
1395
1396 #define         be_connection_init      bd_info->bi_connection_init
1397 #define         be_connection_destroy   bd_info->bi_connection_destroy
1398
1399 #ifdef SLAPD_TOOLS
1400 #define         be_entry_open bd_info->bi_tool_entry_open
1401 #define         be_entry_close bd_info->bi_tool_entry_close
1402 #define         be_entry_first bd_info->bi_tool_entry_first
1403 #define         be_entry_next bd_info->bi_tool_entry_next
1404 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1405 #define         be_entry_get bd_info->bi_tool_entry_get
1406 #define         be_entry_put bd_info->bi_tool_entry_put
1407 #define         be_sync bd_info->bi_tool_sync
1408 #endif
1409
1410 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1411 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1412 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1413 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1414 #define SLAP_BFLAG_ALIASES              0x0100U
1415 #define SLAP_BFLAG_REFERRALS    0x0200U
1416 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1417 #define SLAP_BFLAG_MONITOR              0x1000U
1418 #define SLAP_BFLAG_DYNAMIC              0x2000U
1419         slap_mask_t     be_flags;
1420 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1421 #define SLAP_GLUE_INSTANCE(be)  ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1422 #define SLAP_GLUE_SUBORDINATE(be) \
1423         ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1424 #define SLAP_GLUE_LINKED(be)    ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1425 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1426 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1427 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1428 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1429 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1430
1431         slap_mask_t     be_restrictops;         /* restriction operations */
1432 #define SLAP_RESTRICT_OP_ADD            0x0001U
1433 #define SLAP_RESTRICT_OP_BIND           0x0002U
1434 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1435 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1436 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1437 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1438 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1439 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1440
1441 #define SLAP_RESTRICT_OP_READS  \
1442         ( SLAP_RESTRICT_OP_COMPARE      \
1443         | SLAP_RESTRICT_OP_SEARCH )
1444 #define SLAP_RESTRICT_OP_WRITES \
1445         ( SLAP_RESTRICT_OP_ADD    \
1446         | SLAP_RESTRICT_OP_DELETE \
1447         | SLAP_RESTRICT_OP_MODIFY \
1448         | SLAP_RESTRICT_OP_RENAME )
1449
1450 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1451 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1452 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1453
1454 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1455
1456 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1457 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1458 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1459                                                                         0x0004U /* unprotected simple auth */
1460 #define SLAP_DISALLOW_BIND_KRBV4        0x0008U /* Kerberos V4 authentication */
1461
1462 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1463 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1464
1465 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1466
1467         slap_mask_t     be_requires;    /* pre-operation requirements */
1468 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1469 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1470 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1471 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1472 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1473
1474         /* Required Security Strength Factor */
1475         slap_ssf_set_t be_ssf_set;
1476
1477         /* these should be renamed from be_ to bd_ */
1478         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1479         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1480         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1481         struct berval be_schemandn;     /* normalized subschema DN */
1482         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1483         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1484         struct berval be_rootpw;        /* the magic "root" password for this db        */
1485         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1486 #define be_sizelimit    be_def_limit.lms_s_soft
1487 #define be_timelimit    be_def_limit.lms_t_soft
1488         struct slap_limits_set be_def_limit; /* default limits */
1489         struct slap_limits **be_limits; /* regex-based size and time limits */
1490         AccessControl *be_acl;  /* access control list for this backend    */
1491         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1492         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1493         char    *be_replogfile; /* replication log file (in master)        */
1494         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1495         BerVarray       be_update_refs; /* where to refer modifying clients to */
1496         char    *be_realm;
1497         void    *be_private;    /* anything the backend database needs     */
1498
1499         void    *be_pb;         /* Netscape plugin */
1500 #ifdef LDAP_SYNCREPL
1501         syncinfo_t      *syncinfo;      /* For syncrepl */
1502 #endif
1503 };
1504
1505 struct slap_conn;
1506 struct slap_op;
1507
1508 /* Backend function typedefs */
1509 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1510 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1511         const char *fname, int lineno,
1512         int argc, char **argv));
1513 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1514 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1515 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1516
1517 typedef int (BI_db_init) LDAP_P((Backend *bd));
1518 typedef int (BI_db_config) LDAP_P((Backend *bd,
1519         const char *fname, int lineno,
1520         int argc, char **argv));
1521 typedef int (BI_db_open) LDAP_P((Backend *bd));
1522 typedef int (BI_db_close) LDAP_P((Backend *bd));
1523 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1524
1525 typedef struct req_bind_s {
1526         int rb_method;
1527         struct berval rb_cred;
1528         struct berval rb_edn;
1529         slap_ssf_t rb_ssf;
1530 } req_bind_s;
1531
1532 typedef struct req_search_s {
1533         int rs_scope;
1534         int rs_deref;
1535         int rs_slimit;
1536         int rs_tlimit;
1537         int rs_attrsonly;
1538         AttributeName *rs_attrs;
1539         Filter *rs_filter;
1540         struct berval rs_filterstr;
1541 } req_search_s;
1542
1543 typedef struct req_compare_s {
1544         AttributeAssertion *rs_ava;
1545 } req_compare_s;
1546
1547 typedef struct req_modify_s {
1548         Modifications *rs_modlist;
1549 } req_modify_s;
1550
1551 typedef struct req_modrdn_s {
1552         struct berval rs_newrdn;
1553         struct berval rs_nnewrdn;
1554         struct berval *rs_newSup;
1555         struct berval *rs_nnewSup;
1556         int rs_deleteoldrdn;
1557 } req_modrdn_s;
1558
1559 typedef struct req_add_s {
1560         Entry *rs_e;
1561 } req_add_s;
1562
1563 typedef struct req_abandon_s {
1564         ber_int_t rs_msgid;
1565 } req_abandon_s;
1566
1567 typedef struct req_extended_s {
1568         struct berval rs_reqoid;
1569         struct berval *rs_reqdata;
1570 } req_extended_s;
1571
1572 typedef enum slap_reply_e {
1573         REP_RESULT,
1574         REP_SASL,
1575         REP_EXTENDED,
1576         REP_SEARCH,
1577         REP_SEARCHREF
1578 } slap_reply_t;
1579
1580 typedef struct rep_sasl_s {
1581         struct berval *r_sasldata;
1582 } rep_sasl_s;
1583
1584 typedef struct rep_extended_s {
1585         const char *r_rspoid;
1586         struct berval *r_rspdata;
1587 } rep_extended_s;
1588
1589 typedef struct rep_search_s {
1590         Entry *r_entry;
1591         AttributeName *r_attrs;
1592         int r_nentries;
1593         BerVarray r_v2ref;
1594 } rep_search_s;
1595
1596 typedef struct slap_rep {
1597         slap_reply_t sr_type;
1598         ber_tag_t sr_tag;
1599         ber_int_t sr_msgid;
1600         ber_int_t sr_err;
1601         const char *sr_matched;
1602         const char *sr_text;
1603         BerVarray sr_ref;
1604         LDAPControl **sr_ctrls;
1605         union sr_u {
1606                 rep_sasl_s sru_sasl;
1607                 rep_extended_s sru_extended;
1608                 rep_search_s sru_search;
1609         } sr_un;
1610 } SlapReply;
1611
1612 /* short hands for response members */
1613 #define sr_attrs sr_un.sru_search.r_attrs
1614 #define sr_entry sr_un.sru_search.r_entry
1615 #define sr_v2ref sr_un.sru_search.r_v2ref
1616 #define sr_nentries sr_un.sru_search.r_nentries
1617 #define sr_rspoid sr_un.sru_extended.r_rspoid
1618 #define sr_rspdata sr_un.sru_extended.r_rspdata
1619 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1620
1621 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1622 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1623 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1624 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1625 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1626 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1627 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1628 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1629 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1630 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1631 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1632 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1633 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1634         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1635 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1636 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1637 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1638
1639 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1640                 struct slap_conn *c));
1641 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1642                 struct slap_conn *c));
1643
1644 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1645 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1646 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1647 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1648 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1649 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1650                         struct berval *text ));
1651 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1652 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1653
1654 struct slap_backend_info {
1655         char    *bi_type; /* type of backend */
1656
1657         /*
1658          * per backend type routines:
1659          * bi_init: called to allocate a backend_info structure,
1660          *              called once BEFORE configuration file is read.
1661          *              bi_init() initializes this structure hence is
1662          *              called directly from be_initialize()
1663          * bi_config: called per 'backend' specific option
1664          *              all such options must before any 'database' options
1665          *              bi_config() is called only from read_config()
1666          * bi_open: called to open each database, called
1667          *              once AFTER configuration file is read but
1668          *              BEFORE any bi_db_open() calls.
1669          *              bi_open() is called from backend_startup()
1670          * bi_close: called to close each database, called
1671          *              once during shutdown after all bi_db_close calls.
1672          *              bi_close() is called from backend_shutdown()
1673          * bi_destroy: called to destroy each database, called
1674          *              once during shutdown after all bi_db_destroy calls.
1675          *              bi_destory() is called from backend_destroy()
1676          */
1677         BI_init *bi_init;
1678         BI_config       *bi_config;
1679         BI_open *bi_open;
1680         BI_close        *bi_close;
1681         BI_destroy      *bi_destroy;
1682
1683         /*
1684          * per database routines:
1685          * bi_db_init: called to initialize each database,
1686          *      called upon reading 'database <type>'
1687          *      called only from backend_db_init()
1688          * bi_db_config: called to configure each database,
1689          *  called per database to handle per database options
1690          *      called only from read_config()
1691          * bi_db_open: called to open each database
1692          *      called once per database immediately AFTER bi_open()
1693          *      calls but before daemon startup.
1694          *  called only by backend_startup()
1695          * bi_db_close: called to close each database
1696          *      called once per database during shutdown but BEFORE
1697          *  any bi_close call.
1698          *  called only by backend_shutdown()
1699          * bi_db_destroy: called to destroy each database
1700          *  called once per database during shutdown AFTER all
1701          *  bi_close calls but before bi_destory calls.
1702          *  called only by backend_destory()
1703          */
1704         BI_db_init      *bi_db_init;
1705         BI_db_config    *bi_db_config;
1706         BI_db_open      *bi_db_open;
1707         BI_db_close     *bi_db_close;
1708         BI_db_destroy   *bi_db_destroy;
1709
1710         /* LDAP Operations Handling Routines */
1711         BI_op_bind      *bi_op_bind;
1712         BI_op_unbind    *bi_op_unbind;
1713         BI_op_search    *bi_op_search;
1714         BI_op_compare   *bi_op_compare;
1715         BI_op_modify    *bi_op_modify;
1716         BI_op_modrdn    *bi_op_modrdn;
1717         BI_op_add       *bi_op_add;
1718         BI_op_delete    *bi_op_delete;
1719         BI_op_abandon   *bi_op_abandon;
1720         BI_op_cancel    *bi_op_cancel;
1721
1722         /* Extended Operations Helper */
1723         BI_op_extended  *bi_extended;
1724
1725         /* Auxilary Functions */
1726         BI_entry_get_rw         *bi_entry_get_rw;
1727         BI_entry_release_rw     *bi_entry_release_rw;
1728         BI_chk_referrals        *bi_chk_referrals;
1729
1730         BI_operational  *bi_operational;
1731         BI_has_subordinates     *bi_has_subordinates;
1732
1733         BI_connection_init      *bi_connection_init;
1734         BI_connection_destroy   *bi_connection_destroy;
1735
1736         /* hooks for slap tools */
1737         BI_tool_entry_open      *bi_tool_entry_open;
1738         BI_tool_entry_close     *bi_tool_entry_close;
1739         BI_tool_entry_first     *bi_tool_entry_first;
1740         BI_tool_entry_next      *bi_tool_entry_next;
1741         BI_tool_entry_get       *bi_tool_entry_get;
1742         BI_tool_entry_put       *bi_tool_entry_put;
1743         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1744         BI_tool_sync            *bi_tool_sync;
1745
1746 #define SLAP_INDEX_ADD_OP               0x0001
1747 #define SLAP_INDEX_DELETE_OP    0x0002
1748
1749         char **bi_controls;             /* supported controls */
1750
1751         unsigned int bi_nDB;    /* number of databases of this type */
1752         void    *bi_private;    /* anything the backend type needs */
1753 };
1754
1755 #define c_authtype      c_authz.sai_method
1756 #define c_authmech      c_authz.sai_mech
1757 #define c_dn            c_authz.sai_dn
1758 #define c_ndn           c_authz.sai_ndn
1759 #define c_ssf                   c_authz.sai_ssf
1760 #define c_transport_ssf c_authz.sai_transport_ssf
1761 #define c_tls_ssf               c_authz.sai_tls_ssf
1762 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1763
1764 #define o_authtype      o_authz.sai_method
1765 #define o_authmech      o_authz.sai_mech
1766 #define o_dn            o_authz.sai_dn
1767 #define o_ndn           o_authz.sai_ndn
1768 #define o_ssf                   o_authz.sai_ssf
1769 #define o_transport_ssf o_authz.sai_transport_ssf
1770 #define o_tls_ssf               o_authz.sai_tls_ssf
1771 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1772
1773 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1774
1775 typedef struct slap_callback {
1776         slap_response *sc_response;
1777         void *sc_private;
1778 } slap_callback;
1779
1780 /*
1781  * Paged Results state
1782  */
1783 typedef unsigned long PagedResultsCookie;
1784 typedef struct slap_paged_state {
1785         Backend *ps_be;
1786         PagedResultsCookie ps_cookie;
1787         ID ps_id;
1788 } PagedResultsState;
1789
1790
1791 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1792 #define LDAP_PSEARCH_BY_ADD             0x01
1793 #define LDAP_PSEARCH_BY_DELETE          0x02
1794 #define LDAP_PSEARCH_BY_PREMODIFY       0x03
1795 #define LDAP_PSEARCH_BY_MODIFY          0x04
1796 #define LDAP_PSEARCH_BY_SCOPEOUT        0x05
1797
1798 struct psid_entry {
1799         struct slap_op *ps_op;
1800         LDAP_LIST_ENTRY(psid_entry) ps_link;
1801 };
1802 #endif
1803
1804
1805 /*
1806  * represents an operation pending from an ldap client
1807  */
1808 typedef struct slap_op {
1809         unsigned long o_opid;   /* id of this operation */
1810         unsigned long o_connid; /* id of conn initiating this op */
1811         struct slap_conn *o_conn;       /* connection spawning this op */
1812         BackendDB       *o_bd;  /* backend DB processing this op */
1813
1814         ber_int_t       o_msgid;        /* msgid of the request */
1815         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1816         ber_tag_t       o_tag;          /* tag of the request */
1817         time_t          o_time;         /* time op was initiated */
1818
1819         struct berval   o_req_dn;       /* DN of target of request */
1820         struct berval   o_req_ndn;
1821
1822         union o_req_u {
1823                 req_add_s oq_add;
1824                 req_bind_s oq_bind;
1825                 req_compare_s oq_compare;
1826                 req_modify_s oq_modify;
1827                 req_modrdn_s oq_modrdn;
1828                 req_search_s oq_search;
1829                 req_abandon_s oq_abandon;
1830                 req_abandon_s oq_cancel;
1831                 req_extended_s oq_extended;
1832         } o_request;
1833
1834 /* short hands for union members */
1835 #define oq_add o_request.oq_add
1836 #define oq_bind o_request.oq_bind
1837 #define oq_compare o_request.oq_compare
1838 #define oq_modify o_request.oq_modify
1839 #define oq_modrdn o_request.oq_modrdn
1840 #define oq_search o_request.oq_search
1841 #define oq_abandon o_request.oq_abandon
1842 #define oq_cancel o_request.oq_cancel
1843 #define oq_extended o_request.oq_extended
1844
1845 /* short hands for inner request members */
1846 #define orb_method oq_bind.rb_method
1847 #define orb_cred oq_bind.rb_cred
1848 #define orb_edn oq_bind.rb_edn
1849 #define orb_ssf oq_bind.rb_ssf
1850
1851 #define ors_scope oq_search.rs_scope
1852 #define ors_deref oq_search.rs_deref
1853 #define ors_slimit oq_search.rs_slimit
1854 #define ors_tlimit oq_search.rs_tlimit
1855 #define ors_attrsonly oq_search.rs_attrsonly
1856 #define ors_attrs oq_search.rs_attrs
1857 #define ors_filter oq_search.rs_filter
1858 #define ors_filterstr oq_search.rs_filterstr
1859
1860 #define orr_newrdn oq_modrdn.rs_newrdn
1861 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1862 #define orr_newSup oq_modrdn.rs_newSup
1863 #define orr_nnewSup oq_modrdn.rs_nnewSup
1864 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1865
1866 #define orc_ava oq_compare.rs_ava
1867 #define ora_e oq_add.rs_e
1868 #define orn_msgid oq_abandon.rs_msgid
1869 #define orm_modlist oq_modify.rs_modlist
1870
1871 #define ore_reqoid oq_extended.rs_reqoid
1872 #define ore_reqdata oq_extended.rs_reqdata
1873
1874         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1875
1876         volatile sig_atomic_t o_abandon;        /* abandon flag */
1877         volatile sig_atomic_t o_cancel;         /* cancel flag */
1878 #define SLAP_CANCEL_NONE                                0x00
1879 #define SLAP_CANCEL_REQ                                 0x01
1880 #define SLAP_CANCEL_ACK                                 0x02
1881 #define SLAP_CANCEL_DONE                                0x03
1882
1883         char o_do_not_cache;    /* don't cache from this op */
1884         char o_is_auth_check;   /* authorization in progress */
1885
1886 #define SLAP_NO_CONTROL 0
1887 #define SLAP_NONCRITICAL_CONTROL 1
1888 #define SLAP_CRITICAL_CONTROL 2
1889         char o_managedsait;
1890 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1891
1892         char o_noop;
1893         char o_proxy_authz;
1894
1895         char o_subentries;
1896 #define get_subentries(op)                              ((int)(op)->o_subentries)
1897         char o_subentries_visibility;
1898 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1899
1900         char o_valuesreturnfilter;
1901
1902 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1903         char o_permissive_modify;
1904 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
1905 #else
1906 #define get_permissiveModify(op)                (0)
1907 #endif
1908
1909 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1910         char o_domain_scope;
1911 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
1912 #else
1913 #define get_domainScope(op)                             (0)
1914 #endif
1915
1916 #ifdef LDAP_CONTROL_PAGEDRESULTS
1917         char o_pagedresults;
1918 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
1919         ber_int_t o_pagedresults_size;
1920         PagedResultsState o_pagedresults_state;
1921 #else
1922 #define get_pagedresults(op)                    (0)
1923 #endif
1924
1925 #ifdef LDAP_CLIENT_UPDATE
1926         char o_clientupdate;
1927         char o_clientupdate_type;
1928 #define SLAP_LCUP_NONE                          (0x0)
1929 #define SLAP_LCUP_SYNC                          (0x1)
1930 #define SLAP_LCUP_PERSIST                       (0x2)
1931 #define SLAP_LCUP_SYNC_AND_PERSIST              (0x3)
1932         ber_int_t o_clientupdate_interval;
1933         struct berval o_clientupdate_state;
1934 #endif
1935
1936 #ifdef LDAP_SYNC
1937         char o_sync;
1938         char o_sync_mode;
1939 #define SLAP_SYNC_NONE                          (0x0)
1940 #define SLAP_SYNC_REFRESH                       (0x1)
1941 #define SLAP_SYNC_PERSIST                       (0x2)
1942 #define SLAP_SYNC_REFRESH_AND_PERSIST           (0x3)
1943         struct berval o_sync_state;
1944 #endif
1945
1946 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1947         int o_ps_protocol;
1948         int o_ps_entries;
1949         LDAP_LIST_ENTRY(slap_op) o_ps_link;
1950         LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1951 #endif
1952
1953         AuthorizationInformation o_authz;
1954
1955         BerElement      *o_ber;         /* ber of the request             */
1956 #ifdef LDAP_CONNECTIONLESS
1957         BerElement      *o_res_ber;     /* ber of the reply               */
1958 #endif
1959         slap_callback   *o_callback;    /* callback pointers */
1960         LDAPControl     **o_ctrls;       /* controls */
1961
1962         void    *o_threadctx;           /* thread pool thread context */
1963         void    *o_tmpmemctx;           /* slab malloc context */
1964         BerMemoryFunctions *o_tmpmfuncs;
1965 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
1966 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
1967 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
1968 #define o_tmpfree       o_tmpmfuncs->bmf_free
1969         void    *o_private;     /* anything the backend needs */
1970
1971         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1972         ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1973
1974 #ifdef LDAP_CACHING
1975         char            o_caching_on;
1976 #endif /*LDAP_CACHING */
1977
1978 #ifdef LDAP_SLAPI
1979         void    *o_pb;                  /* NS-SLAPI plugin */
1980 #endif
1981 } Operation;
1982
1983 #define send_ldap_error( op, rs, err, text ) \
1984 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1985 (op->o_conn->c_send_ldap_result)( op, rs ); } while (0)
1986 #define send_ldap_discon( op, rs, err, text ) \
1987 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1988 send_ldap_disconnect( op, rs ); } while (0)
1989 typedef void (SEND_LDAP_RESULT)(struct slap_op *op, struct slap_rep *rs);
1990 typedef int (SEND_SEARCH_ENTRY)(struct slap_op *op, struct slap_rep *rs);
1991 typedef int (SEND_SEARCH_REFERENCE)(struct slap_op *op, struct slap_rep *rs);
1992 typedef void (SEND_LDAP_EXTENDED)(struct slap_op *op, struct slap_rep *rs);
1993 typedef void (SEND_LDAP_INTERMEDIATE_RESP)(struct slap_op *op, struct slap_rep *rs);
1994 #define send_ldap_result( op, rs ) \
1995 (op->o_conn->c_send_ldap_result)( op, rs )
1996 #define send_search_entry( op, rs ) \
1997 (op->o_conn->c_send_search_entry)( op, rs )
1998 #define send_search_reference( op, rs ) \
1999 (op->o_conn->c_send_search_reference)( op, rs )
2000 #define send_ldap_extended( op, rs ) \
2001 (op->o_conn->c_send_ldap_extended)( op, rs )
2002 #define send_ldap_intermediate_resp( op, rs ) \
2003 (op->o_conn->c_send_ldap_intermediate_resp)( op, rs )
2004
2005 /*
2006  * Caches the result of a backend_group check for ACL evaluation
2007  */
2008 typedef struct slap_gacl {
2009         struct slap_gacl *ga_next;
2010         Backend *ga_be;
2011         ObjectClass *ga_oc;
2012         AttributeDescription *ga_at;
2013         int ga_res;
2014         ber_len_t ga_len;
2015         char ga_ndn[1];
2016 } GroupAssertion;
2017
2018 typedef struct slap_listener Listener;
2019
2020 /*
2021  * represents a connection from an ldap client
2022  */
2023 typedef struct slap_conn {
2024         int                     c_struct_state; /* structure management state */
2025         int                     c_conn_state;   /* connection state */
2026
2027         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2028         Sockbuf         *c_sb;                  /* ber connection stuff           */
2029
2030         /* only can be changed by connect_init */
2031         time_t          c_starttime;    /* when the connection was opened */
2032         time_t          c_activitytime; /* when the connection was last used */
2033         unsigned long           c_connid;       /* id of this connection for stats*/
2034
2035         struct berval   c_peer_domain;  /* DNS name of client */
2036         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2037         Listener        *c_listener;
2038 #define c_listener_url c_listener->sl_url       /* listener URL */
2039 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2040
2041         /* only can be changed by binding thread */
2042         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2043         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2044         struct berval   c_sasl_dn;      /* temporary storage */
2045
2046         /* authorization backend */
2047         Backend *c_authz_backend;
2048
2049         AuthorizationInformation c_authz;
2050         GroupAssertion *c_groups;
2051
2052         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2053
2054         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2055         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2056
2057         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2058         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2059
2060         BerElement      *c_currentber;  /* ber we're attempting to read */
2061         int             c_writewaiter;  /* true if writer is waiting */
2062
2063 #ifdef LDAP_CONNECTIONLESS
2064         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2065 #endif
2066 #ifdef HAVE_TLS
2067         int     c_is_tls;               /* true if this LDAP over raw TLS */
2068         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2069 #endif
2070         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2071         int     c_sasl_done;            /* SASL completed once */
2072         void    *c_sasl_authctx;        /* SASL authentication context */
2073         void    *c_sasl_sockctx;        /* SASL security layer context */
2074         void    *c_sasl_extra;          /* SASL session extra stuff */
2075         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2076
2077         PagedResultsState c_pagedresults_state; /* paged result state */
2078
2079         long    c_n_ops_received;       /* num of ops received (next op_id) */
2080         long    c_n_ops_executing;      /* num of ops currently executing */
2081         long    c_n_ops_pending;        /* num of ops pending execution */
2082         long    c_n_ops_completed;      /* num of ops completed */
2083
2084         long    c_n_get;                /* num of get calls */
2085         long    c_n_read;               /* num of read calls */
2086         long    c_n_write;              /* num of write calls */
2087
2088         void    *c_pb;                  /* Netscape plugin */
2089
2090         /*
2091          * These are the "callbacks" that are available for back-ends to
2092          * supply data back to connected clients that are connected
2093          * through the "front-end".
2094          */
2095         SEND_LDAP_RESULT *c_send_ldap_result;
2096         SEND_SEARCH_ENTRY *c_send_search_entry;
2097         SEND_SEARCH_REFERENCE *c_send_search_reference;
2098         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2099 #ifdef LDAP_RES_INTERMEDIATE_RESP
2100         SEND_LDAP_INTERMEDIATE_RESP *c_send_ldap_intermediate_resp;
2101 #endif
2102
2103 } Connection;
2104
2105 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2106 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2107         do { \
2108                 if ( ldap_debug & (level) ) \
2109                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2110                 if ( ldap_syslog & (level) ) \
2111                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2112                                 (arg2), (arg3) ); \
2113         } while (0)
2114 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2115 #elif defined(LDAP_DEBUG)
2116 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2117         do { \
2118                 if ( ldap_debug & (level) ) \
2119                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2120         } while (0)
2121 #define StatslogTest( level ) (ldap_debug & (level))
2122 #else
2123 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2124 #define StatslogTest( level ) (0)
2125 #endif
2126
2127 /*
2128  * listener; need to access it from monitor backend
2129  */
2130 struct slap_listener {
2131         struct berval sl_url;
2132         struct berval sl_name;
2133         mode_t  sl_perms;
2134 #ifdef HAVE_TLS
2135         int             sl_is_tls;
2136 #endif
2137 #ifdef LDAP_CONNECTIONLESS
2138         int     sl_is_udp;              /* UDP listener is also data port */
2139 #endif
2140         ber_socket_t sl_sd;
2141         Sockaddr sl_sa;
2142 #define sl_addr sl_sa.sa_in_addr
2143 };
2144
2145 #ifdef SLAPD_MONITOR
2146 /*
2147  * Operation indices
2148  */
2149 enum {
2150         SLAP_OP_BIND = 0,
2151         SLAP_OP_UNBIND,
2152         SLAP_OP_ADD,
2153         SLAP_OP_DELETE,
2154         SLAP_OP_MODRDN,
2155         SLAP_OP_MODIFY,
2156         SLAP_OP_COMPARE,
2157         SLAP_OP_SEARCH,
2158         SLAP_OP_ABANDON,
2159         SLAP_OP_EXTENDED,
2160         SLAP_OP_LAST
2161 };
2162 #endif /* SLAPD_MONITOR */
2163
2164 /*
2165  * Better know these all around slapd
2166  */
2167 #define SLAP_LDAPDN_PRETTY 0x1
2168 #define SLAP_LDAPDN_MAXLEN 8192
2169
2170 /*
2171  * Macros for LCUP
2172  */
2173 #ifdef LDAP_CLIENT_UPDATE
2174 #define SLAP_LCUP_STATE_UPDATE_TRUE     1
2175 #define SLAP_LCUP_STATE_UPDATE_FALSE    0
2176 #define SLAP_LCUP_ENTRY_DELETED_TRUE    1
2177 #define SLAP_LCUP_ENTRY_DELETED_FALSE   0
2178 #endif /* LDAP_CLIENT_UPDATE */
2179
2180 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2181 #define SLAP_SEARCH_MAX_CTRLS   10
2182 #endif
2183
2184 #define SLAP_CTRL_FRONTEND                      0x80000000U
2185 #define SLAP_CTRL_FRONTEND_SEARCH       0x01000000U     /* for NOOP */
2186
2187 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2188 #define SLAP_CTRL_ABANDON                       0x00000001U
2189 #define SLAP_CTRL_ADD                           0x00002002U
2190 #define SLAP_CTRL_BIND                          0x00000004U
2191 #define SLAP_CTRL_COMPARE                       0x00001008U
2192 #define SLAP_CTRL_DELETE                        0x00002010U
2193 #define SLAP_CTRL_MODIFY                        0x00002020U
2194 #define SLAP_CTRL_RENAME                        0x00002040U
2195 #define SLAP_CTRL_SEARCH                        0x00001080U
2196 #define SLAP_CTRL_UNBIND                        0x00000100U
2197
2198 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2199 #define SLAP_CTRL_UPDATE \
2200         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2201 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2202
2203 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2204         Operation *op,
2205         SlapReply *rs,
2206         LDAPControl *ctrl ));
2207
2208 LDAP_END_DECL
2209
2210 #include "proto-slap.h"
2211
2212 #endif /* _SLAP_H_ */