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