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

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