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