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