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

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