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

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