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

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