git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

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