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