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