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-2005 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.h"
  56 #include "ldap_pvt_thread.h"
  57 #include "ldap_queue.h"
  58
  59 LDAP_BEGIN_DECL
  60
  61
  62 #ifdef LDAP_DEVEL
  63 #define SLAP_LIGHTWEIGHT_DISPATCHER /* experimental slapd architecture */
  64 #define SLAP_MULTI_CONN_ARRAY
  65 #ifdef LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL
  66 #define SLAP_SEM_LOAD_CONTROL
  67 #endif /* LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL */
  68
  69 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
  70 #define SLAP_ACL_HONOR_MANAGE   /* not yet implemented */
  71 #define SLAP_DYNACL
  72 #define SLAP_OVERLAY_ACCESS
  73 #define LDAP_COMP_MATCH
  74 #define LDAP_DYNAMIC_OBJECTS
  75 #define LDAP_SYNC_TIMESTAMP
  76 #define LDAP_COLLECTIVE_ATTRIBUTES
  77 #define SLAPD_CONF_UNKNOWN_BAILOUT
  78 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
  79
  80 #define SLAP_ORDERED_PRETTYNORM
  81 #define SLAP_AUTHZ_SYNTAX
  82
  83 #ifdef ENABLE_REWRITE
  84 #define SLAP_AUTH_REWRITE       1 /* use librewrite for sasl-regexp */
  85 #endif
  86 #endif
  87
  88 #if defined(LDAP_SLAPI) && !defined(SLAP_OVERLAY_ACCESS)
  89 #define SLAP_OVERLAY_ACCESS
  90 #endif
  91
  92 /*
  93  * ITS#3705: bail out if unknown config directives appear in slapd.conf
  94  */
  95 #ifdef SLAPD_CONF_UNKNOWN_BAILOUT
  96 #define SLAPD_CONF_UNKNOWN_IGNORED      ""
  97 #define SLAPD_DEBUG_CONFIG_ERROR        LDAP_DEBUG_ANY
  98 #else /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
  99 #define SLAPD_CONF_UNKNOWN_IGNORED      " (ignored)"
 100 #define SLAPD_DEBUG_CONFIG_ERROR        LDAP_DEBUG_CONFIG
 101 #endif /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
 102
 103 /*
 104  * SLAPD Memory allocation macros
 105  *
 106  * Unlike ch_*() routines, these routines do not assert() upon
 107  * allocation error.  They are intended to be used instead of
 108  * ch_*() routines where the caller has implemented proper
 109  * checking for and handling of allocation errors.
 110  *
 111  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
 112  */
 113 #define SLAP_MALLOC(s)      ber_memalloc((s))
 114 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
 115 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
 116 #define SLAP_FREE(p)        ber_memfree((p))
 117 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
 118 #define SLAP_STRDUP(s)      ber_strdup((s))
 119 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
 120
 121 #ifdef f_next
 122 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
 123 #endif
 124
 125 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
 126 #define SLAPD_ANONYMOUS ""
 127
 128 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
 129  * This is a value used internally by the backends. It is needed to allow
 130  * adding values that already exist without getting an error as required by
 131  * modrdn when the new rdn was already an attribute value itself.
 132  */
 133 #define SLAP_MOD_SOFTADD        0x1000
 134
 135 #define MAXREMATCHES (100)
 136
 137 #define SLAP_MAX_WORKER_THREADS         (16)
 138
 139 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
 140 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
 141
 142 #define SLAP_CONN_MAX_PENDING_DEFAULT   100
 143 #define SLAP_CONN_MAX_PENDING_AUTH      1000
 144
 145 #define SLAP_TEXT_BUFLEN (256)
 146
 147 /* psuedo error code indicating abandoned operation */
 148 #define SLAPD_ABANDON (-1024)
 149
 150 /* psuedo error code indicating disconnect */
 151 #define SLAPD_DISCONNECT (-1025)
 152
 153 /* unknown config file directive */
 154 #define SLAP_CONF_UNKNOWN (-1026)
 155
 156 /* We assume "C" locale, that is US-ASCII */
 157 #define ASCII_SPACE(c)  ( (c) == ' ' )
 158 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
 159 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
 160 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
 161 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
 162 #define ASCII_HEXLOWER(c)       ( (c) >= 'a' && (c) <= 'f' )
 163 #define ASCII_HEXUPPER(c)       ( (c) >= 'A' && (c) <= 'F' )
 164 #define ASCII_HEX(c)    ( ASCII_DIGIT(c) || \
 165         ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
 166 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
 167 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
 168
 169 #define SLAP_NIBBLE(c) ((c)&0x0f)
 170 #define SLAP_ESCAPE_CHAR ('\\')
 171 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 172 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 173
 174 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 175         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 176
 177 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 178 /* NOTE: for consistency, this macro must only operate
 179  * on normalized/pretty DN, such that ';' is never used
 180  * as RDN separator, and all occurrences of ';' must be escaped */
 181 #define DN_SEPARATOR(c) ((c) == ',')
 182 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 183 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 184 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 185
 186 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 187 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 188 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 189 #define OID_SEPARATOR(c)        ( (c) == '.' )
 190 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 191
 192 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 193 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
 194
 195 #define AD_LEADCHAR(c)  ( ATTR_LEADCHAR(c) )
 196 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 197
 198 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 199
 200 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 201         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 202         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 203         (c) == '?' || (c) == ' ' || (c) == '=' )
 204 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 205
 206 /* must match in schema_init.c */
 207 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 208 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 209 #define SLAPD_INTEGER_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.27"
 210 #define SLAPD_GROUP_ATTR                "member"
 211 #define SLAPD_GROUP_CLASS               "groupOfNames"
 212 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 213 #define SLAPD_ROLE_CLASS                "organizationalRole"
 214
 215 #ifdef SLAPD_ACI_ENABLED
 216 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 217 #endif /* SLAPD_ACI_ENABLED */
 218
 219 /* change this to "OpenLDAPset" */
 220 #define SLAPD_ACI_SET_ATTR              "template"
 221
 222 #define SLAPD_TOP_OID                   "2.5.6.0"
 223
 224 LDAP_SLAPD_V (int) slap_debug;
 225
 226 typedef unsigned long slap_mask_t;
 227
 228 /* Security Strength Factor */
 229 typedef unsigned slap_ssf_t;
 230
 231 typedef struct slap_ssf_set {
 232         slap_ssf_t sss_ssf;
 233         slap_ssf_t sss_transport;
 234         slap_ssf_t sss_tls;
 235         slap_ssf_t sss_sasl;
 236         slap_ssf_t sss_update_ssf;
 237         slap_ssf_t sss_update_transport;
 238         slap_ssf_t sss_update_tls;
 239         slap_ssf_t sss_update_sasl;
 240         slap_ssf_t sss_simple_bind;
 241 } slap_ssf_set_t;
 242
 243 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
 244 #define SLAP_GETDN_AUTHCID 2
 245 #define SLAP_GETDN_AUTHZID 4
 246
 247 /*
 248  * Index types
 249  */
 250 #define SLAP_INDEX_TYPE           0x00FFUL
 251 #define SLAP_INDEX_UNDEFINED      0x0001UL
 252 #define SLAP_INDEX_PRESENT        0x0002UL
 253 #define SLAP_INDEX_EQUALITY       0x0004UL
 254 #define SLAP_INDEX_APPROX         0x0008UL
 255 #define SLAP_INDEX_SUBSTR         0x0010UL
 256 #define SLAP_INDEX_EXTENDED               0x0020UL
 257
 258 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 259
 260 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 261
 262 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 263
 264 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 265 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 266 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 267 #define SLAP_INDEX_SUBSTR_DEFAULT \
 268         ( SLAP_INDEX_SUBSTR \
 269         | SLAP_INDEX_SUBSTR_INITIAL \
 270         | SLAP_INDEX_SUBSTR_ANY \
 271         | SLAP_INDEX_SUBSTR_FINAL )
 272
 273 /* defaults for initial/final substring indices */
 274 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT     2
 275 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT     4
 276
 277 /* defaults for any substring indices */
 278 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT               4
 279 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT              2
 280
 281 #define SLAP_INDEX_FLAGS         0xF000UL
 282 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 283 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
 284
 285 /*
 286  * there is a single index for each attribute.  these prefixes ensure
 287  * that there is no collision among keys.
 288  */
 289 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 290 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 291 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 292 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 293 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 294 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 295
 296 #define SLAP_SYNTAX_MATCHINGRULES_OID    "1.3.6.1.4.1.1466.115.121.1.30"
 297 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID   "1.3.6.1.4.1.1466.115.121.1.3"
 298 #define SLAP_SYNTAX_OBJECTCLASSES_OID    "1.3.6.1.4.1.1466.115.121.1.37"
 299 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
 300 #define SLAP_SYNTAX_CONTENTRULE_OID              "1.3.6.1.4.1.1466.115.121.1.16"
 301
 302 /*
 303  * represents schema information for a database
 304  */
 305 enum {
 306         SLAP_SCHERR_OUTOFMEM = 1,
 307         SLAP_SCHERR_CLASS_NOT_FOUND,
 308         SLAP_SCHERR_CLASS_BAD_USAGE,
 309         SLAP_SCHERR_CLASS_BAD_SUP,
 310         SLAP_SCHERR_CLASS_DUP,
 311         SLAP_SCHERR_CLASS_INCONSISTENT,
 312         SLAP_SCHERR_ATTR_NOT_FOUND,
 313         SLAP_SCHERR_ATTR_BAD_MR,
 314         SLAP_SCHERR_ATTR_BAD_USAGE,
 315         SLAP_SCHERR_ATTR_BAD_SUP,
 316         SLAP_SCHERR_ATTR_INCOMPLETE,
 317         SLAP_SCHERR_ATTR_DUP,
 318         SLAP_SCHERR_ATTR_INCONSISTENT,
 319         SLAP_SCHERR_MR_NOT_FOUND,
 320         SLAP_SCHERR_MR_INCOMPLETE,
 321         SLAP_SCHERR_MR_DUP,
 322         SLAP_SCHERR_SYN_NOT_FOUND,
 323         SLAP_SCHERR_SYN_DUP,
 324         SLAP_SCHERR_NO_NAME,
 325         SLAP_SCHERR_NOT_SUPPORTED,
 326         SLAP_SCHERR_BAD_DESCR,
 327         SLAP_SCHERR_OIDM,
 328         SLAP_SCHERR_CR_DUP,
 329         SLAP_SCHERR_CR_BAD_STRUCT,
 330         SLAP_SCHERR_CR_BAD_AUX,
 331         SLAP_SCHERR_CR_BAD_AT,
 332
 333         SLAP_SCHERR_LAST
 334 };
 335
 336 typedef union slap_sockaddr {
 337         struct sockaddr sa_addr;
 338         struct sockaddr_in sa_in_addr;
 339 #ifdef LDAP_PF_INET6
 340         struct sockaddr_storage sa_storage;
 341         struct sockaddr_in6 sa_in6_addr;
 342 #endif
 343 #ifdef LDAP_PF_LOCAL
 344         struct sockaddr_un sa_un_addr;
 345 #endif
 346 } Sockaddr;
 347
 348 #ifdef LDAP_PF_INET6
 349 extern int slap_inet4or6;
 350 #endif
 351
 352 typedef struct slap_oid_macro {
 353         struct berval som_oid;
 354         BerVarray som_names;
 355         BerVarray som_subs;
 356 #define SLAP_OM_HARDCODE        0x10000U        /* This is hardcoded schema */
 357         int som_flags;
 358         LDAP_STAILQ_ENTRY(slap_oid_macro) som_next;
 359 } OidMacro;
 360
 361 /* forward declarations */
 362 struct slap_syntax;
 363 struct slap_matching_rule;
 364
 365 typedef int slap_syntax_validate_func LDAP_P((
 366         struct slap_syntax *syntax,
 367         struct berval * in));
 368
 369 typedef int slap_syntax_transform_func LDAP_P((
 370         struct slap_syntax *syntax,
 371         struct berval * in,
 372         struct berval * out,
 373         void *memctx));
 374
 375 #ifdef LDAP_COMP_MATCH
 376 typedef void* slap_component_transform_func LDAP_P((
 377         struct berval * in ));
 378 struct ComponentDesc;
 379 #endif
 380
 381 typedef struct slap_syntax {
 382         LDAPSyntax                      ssyn_syn;
 383 #define ssyn_oid                ssyn_syn.syn_oid
 384 #define ssyn_desc               ssyn_syn.syn_desc
 385 #define ssyn_extensions ssyn_syn.syn_extensions
 386         /*
 387          * Note: the former
 388         ber_len_t       ssyn_oidlen;
 389          * has been replaced by a struct berval that uses the value
 390          * provided by ssyn_syn.syn_oid; a macro that expands to
 391          * the bv_len field of the berval is provided for backward
 392          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 393          */
 394         struct berval   ssyn_bvoid;
 395 #define ssyn_oidlen     ssyn_bvoid.bv_len
 396
 397         unsigned int ssyn_flags;
 398
 399 #define SLAP_SYNTAX_NONE        0x0000U
 400 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 401 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 402 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 403 #ifdef LDAP_DEVEL
 404 #define SLAP_SYNTAX_HIDE        0x0000U /* publish everything */
 405 #else
 406 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 407 #endif
 408
 409         slap_syntax_validate_func       *ssyn_validate;
 410         slap_syntax_transform_func      *ssyn_pretty;
 411
 412 #ifdef SLAPD_BINARY_CONVERSION
 413         /* convert to and from binary */
 414         slap_syntax_transform_func      *ssyn_ber2str;
 415         slap_syntax_transform_func      *ssyn_str2ber;
 416 #endif
 417 #ifdef LDAP_COMP_MATCH
 418         slap_component_transform_func *ssyn_attr2comp;
 419         struct ComponentDesc* ssync_comp_syntax;
 420 #endif
 421
 422         LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
 423 } Syntax;
 424
 425 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 426 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 427 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 428 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 429 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 430
 431 typedef struct slap_syntax_defs_rec {
 432         char *sd_desc;
 433         int sd_flags;
 434         slap_syntax_validate_func *sd_validate;
 435         slap_syntax_transform_func *sd_pretty;
 436 #ifdef SLAPD_BINARY_CONVERSION
 437         slap_syntax_transform_func *sd_ber2str;
 438         slap_syntax_transform_func *sd_str2ber;
 439 #endif
 440 } slap_syntax_defs_rec;
 441
 442 /* X -> Y Converter */
 443 typedef int slap_mr_convert_func LDAP_P((
 444         struct berval * in,
 445         struct berval * out,
 446         void *memctx ));
 447
 448 /* Normalizer */
 449 typedef int slap_mr_normalize_func LDAP_P((
 450         slap_mask_t use,
 451         struct slap_syntax *syntax, /* NULL if in is asserted value */
 452         struct slap_matching_rule *mr,
 453         struct berval * in,
 454         struct berval * out,
 455         void *memctx ));
 456
 457 /* Match (compare) function */
 458 typedef int slap_mr_match_func LDAP_P((
 459         int *match,
 460         slap_mask_t use,
 461         struct slap_syntax *syntax,     /* syntax of stored value */
 462         struct slap_matching_rule *mr,
 463         struct berval * value,
 464         void * assertValue ));
 465
 466 /* Index generation function */
 467 typedef int slap_mr_indexer_func LDAP_P((
 468         slap_mask_t use,
 469         slap_mask_t mask,
 470         struct slap_syntax *syntax,     /* syntax of stored value */
 471         struct slap_matching_rule *mr,
 472         struct berval *prefix,
 473         BerVarray values,
 474         BerVarray *keys,
 475         void *memctx ));
 476
 477 /* Filter index function */
 478 typedef int slap_mr_filter_func LDAP_P((
 479         slap_mask_t use,
 480         slap_mask_t mask,
 481         struct slap_syntax *syntax,     /* syntax of stored value */
 482         struct slap_matching_rule *mr,
 483         struct berval *prefix,
 484         void * assertValue,
 485         BerVarray *keys,
 486         void *memctx ));
 487
 488 typedef struct slap_matching_rule_use MatchingRuleUse;
 489
 490 typedef struct slap_matching_rule {
 491         LDAPMatchingRule                smr_mrule;
 492         MatchingRuleUse                 *smr_mru;
 493         /* RFC2252 string representation */
 494         struct berval                   smr_str;
 495         /*
 496          * Note: the former
 497          *                      ber_len_t       smr_oidlen;
 498          * has been replaced by a struct berval that uses the value
 499          * provided by smr_mrule.mr_oid; a macro that expands to
 500          * the bv_len field of the berval is provided for backward
 501          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 502          */
 503         struct berval                   smr_bvoid;
 504 #define smr_oidlen                      smr_bvoid.bv_len
 505
 506         slap_mask_t                             smr_usage;
 507
 508 #ifdef LDAP_DEVEL
 509 #define SLAP_MR_HIDE                    0x0000U
 510 #else
 511 #define SLAP_MR_HIDE                    0x8000U
 512 #endif
 513
 514 #define SLAP_MR_TYPE_MASK               0x0F00U
 515 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 516 #define SLAP_MR_USAGE                   0x000FU
 517
 518 #define SLAP_MR_NONE                    0x0000U
 519 #define SLAP_MR_EQUALITY                0x0100U
 520 #define SLAP_MR_ORDERING                0x0200U
 521 #define SLAP_MR_SUBSTR                  0x0400U
 522 #define SLAP_MR_EXT                             0x0800U /* implicitly extensible */
 523 #define SLAP_MR_ORDERED_INDEX   0x1000U
 524 #ifdef LDAP_COMP_MATCH
 525 #define SLAP_MR_COMPONENT               0x2000U
 526 #endif
 527
 528 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 529
 530 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 531 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 532 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 533
 534
 535 /*
 536  * The asserted value, depending on the particular usage,
 537  * is expected to conform to either the assertion syntax
 538  * or the attribute syntax.   In some cases, the syntax of
 539  * the value is known.  If so, these flags indicate which
 540  * syntax the value is expected to conform to.  If not,
 541  * neither of these flags is set (until the syntax of the
 542  * provided value is determined).  If the value is of the
 543  * attribute syntax, the flag is changed once a value of
 544  * the assertion syntax is derived from the provided value.
 545  */
 546 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX       0x0001U
 547 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX       0x0002U
 548 #define SLAP_MR_VALUE_OF_SYNTAX                         0x0003U
 549
 550 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
 551         ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
 552 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
 553         ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
 554 #ifdef LDAP_DEBUG
 555 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
 556         ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
 557 #else
 558 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage )     (1)
 559 #endif
 560
 561 /* either or both the asserted value or attribute value
 562  * may be provided in normalized form
 563  */
 564 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH         0x0004U
 565 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH        0x0008U
 566
 567 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 568         (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
 569 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
 570         ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 571
 572 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
 573         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 574                 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
 575 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 576         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 577                 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 578
 579 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
 580         ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
 581 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
 582         ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
 583
 584         Syntax                                  *smr_syntax;
 585         slap_mr_convert_func    *smr_convert;
 586         slap_mr_normalize_func  *smr_normalize;
 587         slap_mr_match_func              *smr_match;
 588         slap_mr_indexer_func    *smr_indexer;
 589         slap_mr_filter_func             *smr_filter;
 590
 591         /*
 592          * null terminated array of syntaxes compatible with this syntax
 593          * note: when MS_EXT is set, this MUST NOT contain the assertion
 594          * syntax of the rule.  When MS_EXT is not set, it MAY.
 595          */
 596         Syntax                                  **smr_compat_syntaxes;
 597
 598         /*
 599          * For equality rules, refers to an associated approximate rule.
 600          * For non-equality rules, refers to an associated equality rule.
 601          */
 602         struct slap_matching_rule       *smr_associated;
 603
 604 #define SLAP_MR_ASSOCIATED(mr,amr)      \
 605         (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
 606
 607         LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
 608
 609 #define smr_oid                         smr_mrule.mr_oid
 610 #define smr_names                       smr_mrule.mr_names
 611 #define smr_desc                        smr_mrule.mr_desc
 612 #define smr_obsolete            smr_mrule.mr_obsolete
 613 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 614 #define smr_extensions          smr_mrule.mr_extensions
 615 } MatchingRule;
 616
 617 struct slap_matching_rule_use {
 618         LDAPMatchingRuleUse             smru_mruleuse;
 619         MatchingRule                    *smru_mr;
 620         /* RFC2252 string representation */
 621         struct berval                   smru_str;
 622
 623         LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
 624
 625 #define smru_oid                        smru_mruleuse.mru_oid
 626 #define smru_names                      smru_mruleuse.mru_names
 627 #define smru_desc                       smru_mruleuse.mru_desc
 628 #define smru_obsolete                   smru_mruleuse.mru_obsolete
 629 #define smru_applies_oids               smru_mruleuse.mru_applies_oids
 630
 631 #define smru_usage                      smru_mr->smr_usage
 632 } /* MatchingRuleUse */ ;
 633
 634 typedef struct slap_mrule_defs_rec {
 635         char *                                          mrd_desc;
 636         slap_mask_t                                     mrd_usage;
 637         char **                                         mrd_compat_syntaxes;
 638         slap_mr_convert_func *          mrd_convert;
 639         slap_mr_normalize_func *        mrd_normalize;
 640         slap_mr_match_func *            mrd_match;
 641         slap_mr_indexer_func *          mrd_indexer;
 642         slap_mr_filter_func *           mrd_filter;
 643
 644         /* For equality rule, this may refer to an associated approximate rule */
 645         /* For non-equality rule, this may refer to an associated equality rule */
 646         char *                                          mrd_associated;
 647 } slap_mrule_defs_rec;
 648
 649 struct slap_backend_db;
 650 struct slap_entry;
 651 struct slap_attr;
 652
 653 typedef int (AttributeTypeSchemaCheckFN)(
 654         struct slap_backend_db *be,
 655         struct slap_entry *e,
 656         struct slap_attr *attr,
 657         const char** text,
 658         char *textbuf, size_t textlen );
 659
 660 typedef struct slap_attribute_type {
 661         LDAPAttributeType               sat_atype;
 662         struct berval                   sat_cname;
 663         struct slap_attribute_type      *sat_sup;
 664         struct slap_attribute_type      **sat_subtypes;
 665         MatchingRule                    *sat_equality;
 666         MatchingRule                    *sat_approx;
 667         MatchingRule                    *sat_ordering;
 668         MatchingRule                    *sat_substr;
 669         Syntax                                  *sat_syntax;
 670
 671         AttributeTypeSchemaCheckFN      *sat_check;
 672         char                                    *sat_oidmacro;
 673
 674 #define SLAP_AT_NONE                    0x0000U
 675 #define SLAP_AT_ABSTRACT                0x0100U /* cannot be instantiated */
 676 #define SLAP_AT_FINAL                   0x0200U /* cannot be subtyped */
 677 #ifdef LDAP_DEVEL
 678 #define SLAP_AT_HIDE                    0x0000U /* publish everything */
 679 #else
 680 #define SLAP_AT_HIDE                    0x8000U /* hide attribute */
 681 #endif
 682 #define SLAP_AT_DYNAMIC                 0x0400U /* dynamically generated */
 683
 684 #define SLAP_AT_MANAGEABLE              0x0800U /* no-user-mod can be by-passed */
 685
 686 #define SLAP_AT_ORDERED_VAL             0x0001U /* values are ordered */
 687 #define SLAP_AT_ORDERED_SIB             0x0002U /* siblings are ordered */
 688 #define SLAP_AT_ORDERED                 0x0003U /* value has order index */
 689
 690 #define SLAP_AT_HARDCODE        0x10000U        /* hardcoded schema */
 691
 692         slap_mask_t                                     sat_flags;
 693
 694         LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
 695
 696 #define sat_oid                         sat_atype.at_oid
 697 #define sat_names                       sat_atype.at_names
 698 #define sat_desc                        sat_atype.at_desc
 699 #define sat_obsolete            sat_atype.at_obsolete
 700 #define sat_sup_oid                     sat_atype.at_sup_oid
 701 #define sat_equality_oid        sat_atype.at_equality_oid
 702 #define sat_ordering_oid        sat_atype.at_ordering_oid
 703 #define sat_substr_oid          sat_atype.at_substr_oid
 704 #define sat_syntax_oid          sat_atype.at_syntax_oid
 705 #define sat_single_value        sat_atype.at_single_value
 706 #define sat_collective          sat_atype.at_collective
 707 #define sat_no_user_mod         sat_atype.at_no_user_mod
 708 #define sat_usage                       sat_atype.at_usage
 709 #define sat_extensions          sat_atype.at_extensions
 710
 711         struct slap_attr_desc           *sat_ad;
 712         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 713 } AttributeType;
 714
 715 #define is_at_operational(at)   ((at)->sat_usage)
 716 #define is_at_single_value(at)  ((at)->sat_single_value)
 717 #define is_at_collective(at)    ((at)->sat_collective)
 718 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 719 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 720
 721 struct slap_object_class;
 722
 723 typedef int (ObjectClassSchemaCheckFN)(
 724         struct slap_backend_db *be,
 725         struct slap_entry *e,
 726         struct slap_object_class *oc,
 727         const char** text,
 728         char *textbuf, size_t textlen );
 729
 730 typedef struct slap_object_class {
 731         LDAPObjectClass                 soc_oclass;
 732         struct berval                   soc_cname;
 733         struct slap_object_class        **soc_sups;
 734         AttributeType                           **soc_required;
 735         AttributeType                           **soc_allowed;
 736         ObjectClassSchemaCheckFN        *soc_check;
 737         char                                    *soc_oidmacro;
 738         slap_mask_t                                     soc_flags;
 739 #define soc_oid                         soc_oclass.oc_oid
 740 #define soc_names                       soc_oclass.oc_names
 741 #define soc_desc                        soc_oclass.oc_desc
 742 #define soc_obsolete            soc_oclass.oc_obsolete
 743 #define soc_sup_oids            soc_oclass.oc_sup_oids
 744 #define soc_kind                        soc_oclass.oc_kind
 745 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 746 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 747 #define soc_extensions          soc_oclass.oc_extensions
 748
 749         LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
 750 } ObjectClass;
 751
 752 #define SLAP_OCF_SET_FLAGS      0x1
 753 #define SLAP_OCF_CHECK_SUP      0x2
 754 #define SLAP_OCF_MASK           (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
 755
 756 #define SLAP_OC_ALIAS           0x0001
 757 #define SLAP_OC_REFERRAL        0x0002
 758 #define SLAP_OC_SUBENTRY        0x0004
 759 #define SLAP_OC_DYNAMICOBJECT   0x0008
 760 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 761 #define SLAP_OC_GLUE            0x0020
 762 #define SLAP_OC_SYNCPROVIDERSUBENTRY            0x0040
 763 #define SLAP_OC_SYNCCONSUMERSUBENTRY            0x0080
 764 #define SLAP_OC__MASK           0x00FF
 765 #define SLAP_OC__END            0x0100
 766 #define SLAP_OC_OPERATIONAL     0x4000
 767 #ifdef LDAP_DEVEL
 768 #define SLAP_OC_HIDE            0x0000
 769 #else
 770 #define SLAP_OC_HIDE            0x8000
 771 #endif
 772 #define SLAP_OC_HARDCODE        0x10000U        /* This is hardcoded schema */
 773
 774 /*
 775  * DIT content rule
 776  */
 777 typedef struct slap_content_rule {
 778         LDAPContentRule         scr_crule;
 779         ObjectClass                     *scr_sclass;
 780         ObjectClass                     **scr_auxiliaries;      /* optional */
 781         AttributeType           **scr_required;         /* optional */
 782         AttributeType           **scr_allowed;          /* optional */
 783         AttributeType           **scr_precluded;        /* optional */
 784 #define scr_oid                         scr_crule.cr_oid
 785 #define scr_names                       scr_crule.cr_names
 786 #define scr_desc                        scr_crule.cr_desc
 787 #define scr_obsolete            scr_crule.cr_obsolete
 788 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
 789 #define scr_at_oids_must        scr_crule.cr_at_oids_must
 790 #define scr_at_oids_may         scr_crule.cr_at_oids_may
 791 #define scr_at_oids_not         scr_crule.cr_at_oids_not
 792
 793         char                            *scr_oidmacro;
 794 #define         SLAP_CR_HARDCODE        0x10000U
 795         int     scr_flags;
 796
 797         LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
 798 } ContentRule;
 799
 800 /* Represents a recognized attribute description ( type + options ). */
 801 typedef struct slap_attr_desc {
 802         struct slap_attr_desc *ad_next;
 803         AttributeType *ad_type;         /* attribute type, must be specified */
 804         struct berval ad_cname;         /* canonical name, must be specified */
 805         struct berval ad_tags;          /* empty if no tagging options */
 806         unsigned ad_flags;
 807 #define SLAP_DESC_NONE                  0x00U
 808 #define SLAP_DESC_BINARY                0x01U
 809 #define SLAP_DESC_TAG_RANGE             0x80U
 810 } AttributeDescription;
 811
 812 /* flags to slap_*2undef_ad to register undefined (0, the default)
 813  * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
 814  * SLAP_AD_NOINSERT is to lookup without insert */
 815 #define SLAP_AD_UNDEF                   0x00U
 816 #define SLAP_AD_PROXIED                 0x01U
 817 #define SLAP_AD_NOINSERT                0x02U
 818
 819 typedef struct slap_attr_name {
 820         struct berval an_name;
 821         AttributeDescription *an_desc;
 822         int an_oc_exclude;
 823         ObjectClass *an_oc;
 824 } AttributeName;
 825
 826 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
 827 #define slap_ad_is_tag_range(ad)        \
 828         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
 829 #define slap_ad_is_binary(ad)           \
 830         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 831
 832 /*
 833  * pointers to schema elements used internally
 834  */
 835 struct slap_internal_schema {
 836         /* objectClass */
 837         ObjectClass *si_oc_top;
 838         ObjectClass *si_oc_extensibleObject;
 839         ObjectClass *si_oc_alias;
 840         ObjectClass *si_oc_referral;
 841         ObjectClass *si_oc_rootdse;
 842         ObjectClass *si_oc_subentry;
 843         ObjectClass *si_oc_subschema;
 844         ObjectClass *si_oc_collectiveAttributeSubentry;
 845         ObjectClass *si_oc_dynamicObject;
 846
 847         ObjectClass *si_oc_glue;
 848         ObjectClass *si_oc_syncConsumerSubentry;
 849         ObjectClass *si_oc_syncProviderSubentry;
 850
 851         /* objectClass attribute descriptions */
 852         AttributeDescription *si_ad_objectClass;
 853
 854         /* operational attribute descriptions */
 855         AttributeDescription *si_ad_structuralObjectClass;
 856         AttributeDescription *si_ad_creatorsName;
 857         AttributeDescription *si_ad_createTimestamp;
 858         AttributeDescription *si_ad_modifiersName;
 859         AttributeDescription *si_ad_modifyTimestamp;
 860         AttributeDescription *si_ad_hasSubordinates;
 861         AttributeDescription *si_ad_subschemaSubentry;
 862         AttributeDescription *si_ad_collectiveSubentries;
 863         AttributeDescription *si_ad_collectiveExclusions;
 864         AttributeDescription *si_ad_entryDN;
 865         AttributeDescription *si_ad_entryUUID;
 866         AttributeDescription *si_ad_entryCSN;
 867         AttributeDescription *si_ad_namingCSN;
 868
 869         AttributeDescription *si_ad_dseType;
 870         AttributeDescription *si_ad_syncreplCookie;
 871         AttributeDescription *si_ad_syncTimestamp;
 872         AttributeDescription *si_ad_contextCSN;
 873
 874         /* root DSE attribute descriptions */
 875         AttributeDescription *si_ad_altServer;
 876         AttributeDescription *si_ad_namingContexts;
 877         AttributeDescription *si_ad_supportedControl;
 878         AttributeDescription *si_ad_supportedExtension;
 879         AttributeDescription *si_ad_supportedLDAPVersion;
 880         AttributeDescription *si_ad_supportedSASLMechanisms;
 881         AttributeDescription *si_ad_supportedFeatures;
 882         AttributeDescription *si_ad_monitorContext;
 883         AttributeDescription *si_ad_vendorName;
 884         AttributeDescription *si_ad_vendorVersion;
 885         AttributeDescription *si_ad_configContext;
 886
 887         /* subentry attribute descriptions */
 888         AttributeDescription *si_ad_administrativeRole;
 889         AttributeDescription *si_ad_subtreeSpecification;
 890
 891         /* subschema subentry attribute descriptions */
 892         AttributeDescription *si_ad_attributeTypes;
 893         AttributeDescription *si_ad_ditContentRules;
 894         AttributeDescription *si_ad_ditStructureRules;
 895         AttributeDescription *si_ad_ldapSyntaxes;
 896         AttributeDescription *si_ad_matchingRules;
 897         AttributeDescription *si_ad_matchingRuleUse;
 898         AttributeDescription *si_ad_nameForms;
 899         AttributeDescription *si_ad_objectClasses;
 900
 901         /* Aliases & Referrals */
 902         AttributeDescription *si_ad_aliasedObjectName;
 903         AttributeDescription *si_ad_ref;
 904
 905         /* Access Control Internals */
 906         AttributeDescription *si_ad_entry;
 907         AttributeDescription *si_ad_children;
 908         AttributeDescription *si_ad_saslAuthzTo;
 909         AttributeDescription *si_ad_saslAuthzFrom;
 910
 911         /* dynamic entries */
 912         AttributeDescription *si_ad_entryTtl;
 913         AttributeDescription *si_ad_dynamicSubtrees;
 914
 915         /* Other attributes descriptions */
 916         AttributeDescription *si_ad_distinguishedName;
 917         AttributeDescription *si_ad_name;
 918         AttributeDescription *si_ad_cn;
 919         AttributeDescription *si_ad_uid;
 920         AttributeDescription *si_ad_uidNumber;
 921         AttributeDescription *si_ad_gidNumber;
 922         AttributeDescription *si_ad_userPassword;
 923         AttributeDescription *si_ad_labeledURI;
 924 #ifdef SLAPD_AUTHPASSWD
 925         AttributeDescription *si_ad_authPassword;
 926         AttributeDescription *si_ad_authPasswordSchemes;
 927 #endif
 928 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 929         AttributeDescription *si_ad_krbName;
 930 #endif
 931         AttributeDescription *si_ad_description;
 932         AttributeDescription *si_ad_seeAlso;
 933
 934         /* Undefined Attribute Type */
 935         AttributeType   *si_at_undefined;
 936
 937         /* "Proxied" Attribute Type */
 938         AttributeType   *si_at_proxied;
 939
 940         /* Matching Rules */
 941         MatchingRule    *si_mr_distinguishedNameMatch;
 942         MatchingRule    *si_mr_dnSubtreeMatch;
 943         MatchingRule    *si_mr_dnOneLevelMatch;
 944         MatchingRule    *si_mr_dnSubordinateMatch;
 945         MatchingRule    *si_mr_dnSuperiorMatch;
 946         MatchingRule    *si_mr_caseExactMatch;
 947         MatchingRule    *si_mr_caseExactSubstringsMatch;
 948         MatchingRule    *si_mr_caseExactIA5Match;
 949         MatchingRule    *si_mr_integerMatch;
 950         MatchingRule    *si_mr_integerFirstComponentMatch;
 951         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 952
 953         /* Syntaxes */
 954         Syntax          *si_syn_directoryString;
 955         Syntax          *si_syn_distinguishedName;
 956         Syntax          *si_syn_integer;
 957         Syntax          *si_syn_octetString;
 958
 959         /* Schema Syntaxes */
 960         Syntax          *si_syn_attributeTypeDesc;
 961         Syntax          *si_syn_ditContentRuleDesc;
 962         Syntax          *si_syn_ditStructureRuleDesc;
 963         Syntax          *si_syn_ldapSyntaxDesc;
 964         Syntax          *si_syn_matchingRuleDesc;
 965         Syntax          *si_syn_matchingRuleUseDesc;
 966         Syntax          *si_syn_nameFormDesc;
 967         Syntax          *si_syn_objectClassDesc;
 968 };
 969
 970 typedef struct slap_attr_assertion {
 971         AttributeDescription    *aa_desc;
 972         struct berval aa_value;
 973 #ifdef LDAP_COMP_MATCH
 974         struct slap_component_filter *aa_cf;/* for attribute aliasing */
 975 #endif
 976 } AttributeAssertion;
 977
 978 typedef struct slap_ss_assertion {
 979         AttributeDescription    *sa_desc;
 980         struct berval           sa_initial;
 981         struct berval           *sa_any;
 982         struct berval           sa_final;
 983 } SubstringsAssertion;
 984
 985 #ifdef LDAP_COMP_MATCH
 986 struct slap_component_filter;
 987 #endif
 988
 989 typedef struct slap_mr_assertion {
 990         MatchingRule            *ma_rule;       /* optional */
 991         struct berval           ma_rule_text;  /* optional */
 992         AttributeDescription    *ma_desc;       /* optional */
 993         int                                             ma_dnattrs; /* boolean */
 994         struct berval           ma_value;       /* required */
 995 #ifdef LDAP_COMP_MATCH
 996         struct slap_component_filter* ma_cf; /* component filter */
 997 #endif
 998 } MatchingRuleAssertion;
 999
1000 /*
1001  * represents a search filter
1002  */
1003 typedef struct slap_filter {
1004         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
1005 #define SLAPD_FILTER_COMPUTED           ((ber_tag_t) -1)
1006 #define SLAPD_FILTER_DN_ONE                     ((ber_tag_t) -2)
1007 #define SLAPD_FILTER_DN_SUBTREE         ((ber_tag_t) -3)
1008 #define SLAPD_FILTER_DN_CHILDREN        ((ber_tag_t) -4)
1009
1010         union f_un_u {
1011                 /* precomputed result */
1012                 ber_int_t f_un_result;
1013
1014                 /* DN */
1015                 struct berval *f_un_dn;
1016
1017                 /* present */
1018                 AttributeDescription *f_un_desc;
1019
1020                 /* simple value assertion */
1021                 AttributeAssertion *f_un_ava;
1022
1023                 /* substring assertion */
1024                 SubstringsAssertion *f_un_ssa;
1025
1026                 /* matching rule assertion */
1027                 MatchingRuleAssertion *f_un_mra;
1028
1029 #define f_dn                    f_un.f_un_dn
1030 #define f_desc                  f_un.f_un_desc
1031 #define f_ava                   f_un.f_un_ava
1032 #define f_av_desc               f_un.f_un_ava->aa_desc
1033 #define f_av_value              f_un.f_un_ava->aa_value
1034 #define f_sub                   f_un.f_un_ssa
1035 #define f_sub_desc              f_un.f_un_ssa->sa_desc
1036 #define f_sub_initial   f_un.f_un_ssa->sa_initial
1037 #define f_sub_any               f_un.f_un_ssa->sa_any
1038 #define f_sub_final             f_un.f_un_ssa->sa_final
1039 #define f_mra                   f_un.f_un_mra
1040 #define f_mr_rule               f_un.f_un_mra->ma_rule
1041 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
1042 #define f_mr_desc               f_un.f_un_mra->ma_desc
1043 #define f_mr_value              f_un.f_un_mra->ma_value
1044 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
1045
1046                 /* and, or, not */
1047                 struct slap_filter *f_un_complex;
1048         } f_un;
1049
1050 #define f_result        f_un.f_un_result
1051 #define f_and           f_un.f_un_complex
1052 #define f_or            f_un.f_un_complex
1053 #define f_not           f_un.f_un_complex
1054 #define f_list          f_un.f_un_complex
1055
1056         struct slap_filter      *f_next;
1057 } Filter;
1058
1059 /* compare routines can return undefined */
1060 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1061
1062 typedef struct slap_valuesreturnfilter {
1063         ber_tag_t       vrf_choice;
1064
1065         union vrf_un_u {
1066                 /* precomputed result */
1067                 ber_int_t vrf_un_result;
1068
1069                 /* DN */
1070                 char *vrf_un_dn;
1071
1072                 /* present */
1073                 AttributeDescription *vrf_un_desc;
1074
1075                 /* simple value assertion */
1076                 AttributeAssertion *vrf_un_ava;
1077
1078                 /* substring assertion */
1079                 SubstringsAssertion *vrf_un_ssa;
1080
1081                 /* matching rule assertion */
1082                 MatchingRuleAssertion *vrf_un_mra;
1083
1084 #define vrf_result              vrf_un.vrf_un_result
1085 #define vrf_dn                  vrf_un.vrf_un_dn
1086 #define vrf_desc                vrf_un.vrf_un_desc
1087 #define vrf_ava                 vrf_un.vrf_un_ava
1088 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
1089 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
1090 #define vrf_ssa                 vrf_un.vrf_un_ssa
1091 #define vrf_sub                 vrf_un.vrf_un_ssa
1092 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
1093 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1094 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
1095 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
1096 #define vrf_mra                 vrf_un.vrf_un_mra
1097 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
1098 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
1099 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
1100 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
1101 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
1102
1103
1104         } vrf_un;
1105
1106         struct slap_valuesreturnfilter  *vrf_next;
1107 } ValuesReturnFilter;
1108
1109 #ifdef LDAP_COMP_MATCH
1110 struct slap_component_syntax_info;
1111 typedef struct  slap_component_data {
1112         void* cd_mem_op;/* nibble memory handler */
1113         struct slap_component_syntax_info** cd_tree;/* component tree */
1114 } ComponentData;
1115 #endif
1116
1117 /*
1118  * represents an attribute (description + values)
1119  */
1120 typedef struct slap_attr {
1121         AttributeDescription *a_desc;
1122         BerVarray       a_vals;         /* preserved values */
1123         BerVarray       a_nvals;        /* normalized values */
1124 #ifdef LDAP_COMP_MATCH
1125         ComponentData   *a_comp_data; /* component values */
1126 #endif
1127         struct slap_attr *a_next;
1128         unsigned a_flags;
1129 #define SLAP_ATTR_IXADD         0x1U
1130 #define SLAP_ATTR_IXDEL         0x2U
1131 } Attribute;
1132
1133
1134 /*
1135  * the id used in the indexes to refer to an entry
1136  */
1137 typedef unsigned long   ID;
1138 #define NOID    ((ID)~0)
1139
1140 /*
1141  * represents an entry in core
1142  */
1143 typedef struct slap_entry {
1144         /*
1145          * The ID field should only be changed before entry is
1146          * inserted into a cache.  The ID value is backend
1147          * specific.
1148          */
1149         ID              e_id;
1150
1151         struct berval e_name;   /* name (DN) of this entry */
1152         struct berval e_nname;  /* normalized name (DN) of this entry */
1153
1154         /* for migration purposes */
1155 #define e_dn e_name.bv_val
1156 #define e_ndn e_nname.bv_val
1157
1158         Attribute       *e_attrs;       /* list of attributes + values */
1159
1160         slap_mask_t     e_ocflags;
1161
1162         struct berval   e_bv;           /* For entry_encode/entry_decode */
1163
1164         /* for use by the backend for any purpose */
1165         void*   e_private;
1166 } Entry;
1167
1168 /*
1169  * A list of LDAPMods
1170  */
1171 typedef struct slap_mod {
1172         short sm_op;
1173         short sm_flags;
1174 /* Set for internal mods, will bypass ACL checks. Only needed when
1175  * running as non-root user, for user modifiable attributes.
1176  */
1177 #define SLAP_MOD_INTERNAL       0x01
1178 #define SLAP_MOD_MANAGING       0x02
1179
1180         AttributeDescription *sm_desc;
1181         struct berval sm_type;
1182         BerVarray sm_values;
1183         BerVarray sm_nvalues;
1184 } Modification;
1185
1186 typedef struct slap_mod_list {
1187         Modification sml_mod;
1188 #define sml_op          sml_mod.sm_op
1189 #define sml_flags       sml_mod.sm_flags
1190 #define sml_desc        sml_mod.sm_desc
1191 #define sml_type        sml_mod.sm_type
1192 #define sml_values      sml_mod.sm_values
1193 #define sml_nvalues     sml_mod.sm_nvalues
1194         struct slap_mod_list *sml_next;
1195 } Modifications;
1196
1197 typedef struct slap_ldap_modlist {
1198         LDAPMod ml_mod;
1199         struct slap_ldap_modlist *ml_next;
1200 #define ml_op           ml_mod.mod_op
1201 #define ml_type         ml_mod.mod_type
1202 #define ml_values       ml_mod.mod_values
1203 } LDAPModList;
1204
1205 /*
1206  * represents an access control list
1207  */
1208 typedef enum slap_access_e {
1209         ACL_INVALID_ACCESS = -1,
1210         ACL_NONE = 0,
1211         ACL_DISCLOSE,
1212         ACL_AUTH,
1213         ACL_COMPARE,
1214         ACL_SEARCH,
1215         ACL_READ,
1216         ACL_WRITE,
1217         ACL_MANAGE,
1218
1219         /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1220         ACL_LAST,
1221
1222         /* ACL level mask and modifiers */
1223         ACL_LEVEL_MASK = 0x000f,
1224         ACL_QUALIFIER1 = 0x0100,
1225         ACL_QUALIFIER2 = 0x0200,
1226         ACL_QUALIFIER3 = 0x0400,
1227         ACL_QUALIFIER4 = 0x0800,
1228         ACL_QUALIFIER_MASK = 0x0f00,
1229
1230         /* write granularity */
1231         ACL_WADD = ACL_WRITE|ACL_QUALIFIER1,
1232         ACL_WDEL = ACL_WRITE|ACL_QUALIFIER2
1233 } slap_access_t;
1234
1235 typedef enum slap_control_e {
1236         ACL_INVALID_CONTROL     = 0,
1237         ACL_STOP,
1238         ACL_CONTINUE,
1239         ACL_BREAK
1240 } slap_control_t;
1241
1242 typedef enum slap_style_e {
1243         ACL_STYLE_REGEX = 0,
1244         ACL_STYLE_EXPAND,
1245         ACL_STYLE_BASE,
1246         ACL_STYLE_ONE,
1247         ACL_STYLE_SUBTREE,
1248         ACL_STYLE_CHILDREN,
1249         ACL_STYLE_LEVEL,
1250         ACL_STYLE_ATTROF,
1251         ACL_STYLE_ANONYMOUS,
1252         ACL_STYLE_USERS,
1253         ACL_STYLE_SELF,
1254         ACL_STYLE_IP,
1255         ACL_STYLE_PATH
1256 } slap_style_t;
1257
1258 typedef struct slap_authz_info {
1259         ber_tag_t       sai_method;                     /* LDAP_AUTH_* from <ldap.h> */
1260         struct berval   sai_mech;               /* SASL Mechanism */
1261         struct berval   sai_dn;                 /* DN for reporting purposes */
1262         struct berval   sai_ndn;                /* Normalized DN */
1263
1264         /* Security Strength Factors */
1265         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1266         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1267         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1268         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1269 } AuthorizationInformation;
1270
1271
1272 #ifdef SLAP_DYNACL
1273 struct slap_op;
1274
1275 /*
1276  * "dynamic" ACL infrastructure (for ACIs and more)
1277  */
1278 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1279         const char *opts, slap_style_t, const char *, void **privp ));
1280 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1281 typedef int (slap_dynacl_mask) LDAP_P((
1282                 void                    *priv,
1283                 struct slap_op          *op,
1284                 Entry                   *e,
1285                 AttributeDescription    *desc,
1286                 struct berval           *val,
1287                 int                     nmatch,
1288                 regmatch_t              *matches,
1289                 slap_access_t           *grant,
1290                 slap_access_t           *deny ));
1291 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1292
1293 typedef struct slap_dynacl_t {
1294         char                    *da_name;
1295         slap_dynacl_parse       *da_parse;
1296         slap_dynacl_unparse     *da_unparse;
1297         slap_dynacl_mask        *da_mask;
1298         slap_dynacl_destroy     *da_destroy;
1299
1300         void                    *da_private;
1301         struct slap_dynacl_t    *da_next;
1302 } slap_dynacl_t;
1303 #endif /* SLAP_DYNACL */
1304
1305 /* the DN portion of the "by" part */
1306 typedef struct slap_dn_access {
1307         /* DN pattern */
1308         AuthorizationInformation        a_dnauthz;
1309 #define a_pat                   a_dnauthz.sai_dn
1310
1311         slap_style_t            a_style;
1312         int                     a_level;
1313         int                     a_self_level;
1314         AttributeDescription    *a_at;
1315         int                     a_self;
1316         int                     a_expand;
1317 } slap_dn_access;
1318
1319 /* the "by" part */
1320 typedef struct slap_access {
1321         slap_control_t a_type;
1322
1323 /* strip qualifiers */
1324 #define ACL_LEVEL(p)                    ((p) & ACL_LEVEL_MASK)
1325 #define ACL_QUALIFIERS(p)               ((p) & ~ACL_LEVEL_MASK)
1326
1327 #define ACL_ACCESS2PRIV(access)         ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1328
1329 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1330 #define ACL_PRIV_DISCLOSE               ACL_ACCESS2PRIV( ACL_DISCLOSE )
1331 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1332 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1333 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1334 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1335 #define ACL_PRIV_WADD                   ACL_ACCESS2PRIV( ACL_WADD )
1336 #define ACL_PRIV_WDEL                   ACL_ACCESS2PRIV( ACL_WDEL )
1337 #define ACL_PRIV_WRITE                  ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1338 #define ACL_PRIV_MANAGE                 ACL_ACCESS2PRIV( ACL_MANAGE )
1339
1340 /* NOTE: always use the highest level; current: 0x00ffUL */
1341 #define ACL_PRIV_MASK                   ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1342
1343 /* priv flags */
1344 #define ACL_PRIV_LEVEL                  0x1000UL
1345 #define ACL_PRIV_ADDITIVE               0x2000UL
1346 #define ACL_PRIV_SUBSTRACTIVE           0x4000UL
1347
1348 /* invalid privs */
1349 #define ACL_PRIV_INVALID                0x0UL
1350
1351 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1352 #define ACL_PRIV_ASSIGN(m,p)            do { (m)  =  (p); } while(0)
1353 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1354 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1355
1356 #define ACL_INIT(m)                     ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1357 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1358
1359 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1360
1361 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1362
1363 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1364 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1365 #define ACL_IS_SUBTRACTIVE(m)           ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1366
1367 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1368 #define ACL_LVL_DISCLOSE                (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1369 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1370 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1371 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1372 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1373 #define ACL_LVL_WADD                    (ACL_PRIV_WADD|ACL_LVL_READ)
1374 #define ACL_LVL_WDEL                    (ACL_PRIV_WDEL|ACL_LVL_READ)
1375 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1376 #define ACL_LVL_MANAGE                  (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1377
1378 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1379 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1380 #define ACL_LVL_IS_DISCLOSE(m)          ACL_LVL((m),ACL_LVL_DISCLOSE)
1381 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1382 #define ACL_LVL_IS_COMPARE(m)           ACL_LVL((m),ACL_LVL_COMPARE)
1383 #define ACL_LVL_IS_SEARCH(m)            ACL_LVL((m),ACL_LVL_SEARCH)
1384 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1385 #define ACL_LVL_IS_WADD(m)              ACL_LVL((m),ACL_LVL_WADD)
1386 #define ACL_LVL_IS_WDEL(m)              ACL_LVL((m),ACL_LVL_WDEL)
1387 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1388 #define ACL_LVL_IS_MANAGE(m)            ACL_LVL((m),ACL_LVL_MANAGE)
1389
1390 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1391 #define ACL_LVL_ASSIGN_DISCLOSE(m)      ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1392 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1393 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1394 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1395 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1396 #define ACL_LVL_ASSIGN_WADD(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1397 #define ACL_LVL_ASSIGN_WDEL(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1398 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1399 #define ACL_LVL_ASSIGN_MANAGE(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1400
1401         slap_mask_t     a_access_mask;
1402
1403         /* DN pattern */
1404         slap_dn_access          a_dn;
1405 #define a_dn_pat                a_dn.a_dnauthz.sai_dn
1406 #define a_dn_at                 a_dn.a_at
1407 #define a_dn_self               a_dn.a_self
1408
1409         /* real DN pattern */
1410         slap_dn_access          a_realdn;
1411 #define a_realdn_pat            a_realdn.a_dnauthz.sai_dn
1412 #define a_realdn_at             a_realdn.a_at
1413 #define a_realdn_self           a_realdn.a_self
1414
1415         /* used for ssf stuff
1416          * NOTE: the ssf stuff in a_realdn is ignored */
1417 #define a_authz                 a_dn.a_dnauthz
1418
1419         /* connection related stuff */
1420         slap_style_t a_peername_style;
1421         struct berval   a_peername_pat;
1422         unsigned long   a_peername_addr,
1423                         a_peername_mask;
1424         int             a_peername_port;
1425
1426         slap_style_t a_sockname_style;
1427         struct berval   a_sockname_pat;
1428
1429         slap_style_t a_domain_style;
1430         struct berval   a_domain_pat;
1431         int             a_domain_expand;
1432
1433         slap_style_t a_sockurl_style;
1434         struct berval   a_sockurl_pat;
1435         slap_style_t a_set_style;
1436         struct berval   a_set_pat;
1437
1438 #ifdef SLAP_DYNACL
1439         slap_dynacl_t           *a_dynacl;
1440 #else /* ! SLAP_DYNACL */
1441 #ifdef SLAPD_ACI_ENABLED
1442         /* NOTE: ACIs have been moved under the "dynacl" interface,
1443          * which is currently built only when LDAP_DEVEL is defined.
1444          *
1445          * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1446          * is required to enable ACI support.
1447          */
1448         AttributeDescription    *a_aci_at;
1449 #endif /* SLAPD_ACI_ENABLED */
1450 #endif /* SLAP_DYNACL */
1451
1452         /* ACL Groups */
1453         slap_style_t a_group_style;
1454         struct berval   a_group_pat;
1455         ObjectClass                             *a_group_oc;
1456         AttributeDescription    *a_group_at;
1457
1458         struct slap_access      *a_next;
1459 } Access;
1460
1461 /* the "to" part */
1462 typedef struct slap_acl {
1463         /* "to" part: the entries this acl applies to */
1464         Filter          *acl_filter;
1465         slap_style_t acl_dn_style;
1466         regex_t         acl_dn_re;
1467         struct berval   acl_dn_pat;
1468         AttributeName   *acl_attrs;
1469         MatchingRule    *acl_attrval_mr;
1470         slap_style_t    acl_attrval_style;
1471         regex_t         acl_attrval_re;
1472         struct berval   acl_attrval;
1473
1474         /* "by" part: list of who has what access to the entries */
1475         Access  *acl_access;
1476
1477         struct slap_acl *acl_next;
1478 } AccessControl;
1479
1480 typedef struct slap_acl_state {
1481         unsigned as_recorded;
1482 #define ACL_STATE_NOT_RECORDED                  0x0
1483 #define ACL_STATE_RECORDED_VD                   0x1
1484 #define ACL_STATE_RECORDED_NV                   0x2
1485 #define ACL_STATE_RECORDED                              0x3
1486
1487         /* Access state */
1488         AccessControl *as_vd_acl;
1489         AccessControl *as_vi_acl;
1490         slap_mask_t as_vd_acl_mask;
1491         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1492         int as_vd_acl_count;
1493
1494         Access *as_vd_access;
1495         int as_vd_access_count;
1496
1497         int as_result;
1498         AttributeDescription *as_vd_ad;
1499 } AccessControlState;
1500 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1501         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1502
1503 #ifdef SLAPD_ACI_ENABLED
1504 typedef enum slap_aci_scope_t {
1505         SLAP_ACI_SCOPE_ENTRY            = 0x1,
1506         SLAP_ACI_SCOPE_CHILDREN         = 0x2,
1507         SLAP_ACI_SCOPE_SUBTREE          = ( SLAP_ACI_SCOPE_ENTRY | SLAP_ACI_SCOPE_CHILDREN )
1508 } slap_aci_scope_t;
1509 #endif /* SLAPD_ACI_ENABLED */
1510
1511 /*
1512  * Backend-info
1513  * represents a backend
1514  */
1515
1516 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1517 typedef struct slap_backend_db BackendDB;               /* per backend database */
1518 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1519 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1520
1521 LDAP_SLAPD_V (int) nBackendInfo;
1522 LDAP_SLAPD_V (int) nBackendDB;
1523 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1524 LDAP_SLAPD_V (slap_be_head) backendDB;
1525 LDAP_SLAPD_V (BackendDB *) frontendDB;
1526
1527 LDAP_SLAPD_V (int) slapMode;
1528 #define SLAP_UNDEFINED_MODE     0x0000
1529 #define SLAP_SERVER_MODE        0x0001
1530 #define SLAP_TOOL_MODE          0x0002
1531 #define SLAP_MODE                       0x0003
1532
1533 #define SLAP_TRUNCATE_MODE      0x0100
1534 #define SLAP_TOOL_READMAIN      0x0200
1535 #define SLAP_TOOL_READONLY      0x0400
1536 #define SLAP_TOOL_QUICK         0x0800
1537
1538 #define SB_TLS_DEFAULT          (-1)
1539 #define SB_TLS_OFF              0
1540 #define SB_TLS_ON               1
1541 #define SB_TLS_CRITICAL         2
1542
1543 typedef struct slap_bindconf {
1544         struct berval sb_uri;
1545         int sb_tls;
1546         int sb_method;
1547         struct berval sb_binddn;
1548         struct berval sb_cred;
1549         struct berval sb_saslmech;
1550         char *sb_secprops;
1551         struct berval sb_realm;
1552         struct berval sb_authcId;
1553         struct berval sb_authzId;
1554 } slap_bindconf;
1555
1556 struct slap_replica_info {
1557         const char *ri_host;            /* points to host part of uri */
1558         BerVarray ri_nsuffix;           /* array of suffixes this replica accepts */
1559         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1560         int ri_exclude;                         /* 1 => exclude ri_attrs */
1561         slap_bindconf ri_bindconf;      /* for back-config */
1562 };
1563
1564 typedef struct slap_verbmasks {
1565         struct berval word;
1566         const slap_mask_t mask;
1567 } slap_verbmasks;
1568
1569 typedef struct slap_cf_aux_table {
1570         struct berval key;
1571         int off;
1572         char type;
1573         char quote;
1574         slap_verbmasks *aux;
1575 } slap_cf_aux_table;
1576
1577 #define SLAP_LIMIT_TIME 1
1578 #define SLAP_LIMIT_SIZE 2
1579
1580 struct slap_limits_set {
1581         /* time limits */
1582         int     lms_t_soft;
1583         int     lms_t_hard;
1584
1585         /* size limits */
1586         int     lms_s_soft;
1587         int     lms_s_hard;
1588         int     lms_s_unchecked;
1589         int     lms_s_pr;
1590         int     lms_s_pr_hide;
1591         int     lms_s_pr_total;
1592 };
1593
1594 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1595 #define SLAP_NO_LIMIT                   -1
1596 #define SLAP_MAX_LIMIT                  2147483647
1597
1598 struct slap_limits {
1599         unsigned                lm_flags;       /* type of pattern */
1600 #define SLAP_LIMITS_UNDEFINED           0x0000U
1601 #define SLAP_LIMITS_EXACT               0x0001U
1602 #define SLAP_LIMITS_BASE                SLAP_LIMITS_EXACT
1603 #define SLAP_LIMITS_ONE                 0x0002U
1604 #define SLAP_LIMITS_SUBTREE             0x0003U
1605 #define SLAP_LIMITS_CHILDREN            0x0004U
1606 #define SLAP_LIMITS_REGEX               0x0005U
1607 #define SLAP_LIMITS_ANONYMOUS           0x0006U
1608 #define SLAP_LIMITS_USERS               0x0007U
1609 #define SLAP_LIMITS_ANY                 0x0008U
1610 #define SLAP_LIMITS_MASK                0x000FU
1611
1612 #define SLAP_LIMITS_TYPE_DN             0x0000U
1613 #define SLAP_LIMITS_TYPE_GROUP          0x0010U
1614 #define SLAP_LIMITS_TYPE_MASK           0x00F0U
1615
1616         regex_t                 lm_regex;       /* regex data for REGEX */
1617
1618         /*
1619          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1620          * pattern for REGEX; NULL for ANONYMOUS, USERS
1621          */
1622         struct berval           lm_pat;
1623
1624         /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1625          * lm_group_oc is objectClass and lm_group_at is attributeType
1626          * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1627          * can only be SLAP_LIMITS_EXACT */
1628         ObjectClass             *lm_group_oc;
1629         AttributeDescription    *lm_group_ad;
1630
1631         struct slap_limits_set  lm_limits;
1632 };
1633
1634 /* temporary aliases */
1635 typedef BackendDB Backend;
1636 #define nbackends nBackendDB
1637 #define backends backendDB
1638
1639 /*
1640  * syncinfo structure for syncrepl
1641  */
1642
1643 struct syncinfo_s;
1644
1645 #define SLAP_SYNC_RID_SIZE      3
1646 #define SLAP_SYNCUUID_SET_SIZE 256
1647
1648 #define SLAP_SYNC_UPDATE_MSGID  1
1649
1650 struct sync_cookie {
1651         struct berval ctxcsn;
1652         struct berval octet_str;
1653         long rid;
1654         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1655 };
1656
1657 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1658
1659 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1660
1661 #ifndef SLAP_MAX_CIDS
1662 #define SLAP_MAX_CIDS   32      /* Maximum number of supported controls */
1663 #endif
1664
1665 struct ConfigOCs;       /* config.h */
1666
1667 struct slap_backend_db {
1668         BackendInfo     *bd_info;       /* pointer to shared backend info */
1669
1670         /* fields in this structure (and routines acting on this structure)
1671            should be renamed from be_ to bd_ */
1672
1673         /* BackendInfo accessors */
1674 #define         be_config       bd_info->bi_db_config
1675 #define         be_type         bd_info->bi_type
1676
1677 #define         be_bind         bd_info->bi_op_bind
1678 #define         be_unbind       bd_info->bi_op_unbind
1679 #define         be_add          bd_info->bi_op_add
1680 #define         be_compare      bd_info->bi_op_compare
1681 #define         be_delete       bd_info->bi_op_delete
1682 #define         be_modify       bd_info->bi_op_modify
1683 #define         be_modrdn       bd_info->bi_op_modrdn
1684 #define         be_search       bd_info->bi_op_search
1685 #define         be_abandon      bd_info->bi_op_abandon
1686 #define         be_cancel       bd_info->bi_op_cancel
1687
1688 #define         be_extended     bd_info->bi_extended
1689
1690 #define         be_chk_referrals        bd_info->bi_chk_referrals
1691 #define         be_chk_controls         bd_info->bi_chk_controls
1692 #define         be_fetch        bd_info->bi_entry_get_rw
1693 #define         be_release      bd_info->bi_entry_release_rw
1694 #define         be_group        bd_info->bi_acl_group
1695 #define         be_attribute    bd_info->bi_acl_attribute
1696 #define         be_operational  bd_info->bi_operational
1697
1698 /*
1699  * define to honor hasSubordinates operational attribute in search filters
1700  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1701  * is fixed).
1702  */
1703 #define         be_has_subordinates bd_info->bi_has_subordinates
1704
1705 #define         be_connection_init      bd_info->bi_connection_init
1706 #define         be_connection_destroy   bd_info->bi_connection_destroy
1707
1708 #ifdef SLAPD_TOOLS
1709 #define         be_entry_open bd_info->bi_tool_entry_open
1710 #define         be_entry_close bd_info->bi_tool_entry_close
1711 #define         be_entry_first bd_info->bi_tool_entry_first
1712 #define         be_entry_next bd_info->bi_tool_entry_next
1713 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1714 #define         be_entry_get bd_info->bi_tool_entry_get
1715 #define         be_entry_put bd_info->bi_tool_entry_put
1716 #define         be_sync bd_info->bi_tool_sync
1717 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1718 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1719 #define         be_entry_modify bd_info->bi_tool_entry_modify
1720 #endif
1721
1722         /* supported controls */
1723         /* note: set to 0 if the database does not support the control;
1724          * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1725         char            be_ctrls[SLAP_MAX_CIDS + 1];
1726
1727 /* Database flags */
1728 #define SLAP_DBFLAG_NOLASTMOD           0x0001U
1729 #define SLAP_DBFLAG_NO_SCHEMA_CHECK     0x0002U
1730 #define SLAP_DBFLAG_GLUE_INSTANCE       0x0010U /* a glue backend */
1731 #define SLAP_DBFLAG_GLUE_SUBORDINATE    0x0020U /* child of a glue hierarchy */
1732 #define SLAP_DBFLAG_GLUE_LINKED         0x0040U /* child is connected to parent */
1733 #define SLAP_DBFLAG_GLUE_ADVERTISE      0x0080U /* advertise in rootDSE */
1734 #define SLAP_DBFLAG_OVERLAY             0x0100U /* this db struct is an overlay */
1735 #define SLAP_DBFLAG_GLOBAL_OVERLAY      0x0200U /* this db struct is a global overlay */
1736 #define SLAP_DBFLAG_SHADOW              0x8000U /* a shadow */
1737 #define SLAP_DBFLAG_SYNC_SHADOW         0x1000U /* a sync shadow */
1738 #define SLAP_DBFLAG_SLURP_SHADOW        0x2000U /* a slurp shadow */
1739         slap_mask_t     be_flags;
1740 #define SLAP_DBFLAGS(be)                        ((be)->be_flags)
1741 #define SLAP_NOLASTMOD(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1742 #define SLAP_LASTMOD(be)                        (!SLAP_NOLASTMOD(be))
1743 #define SLAP_ISOVERLAY(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1744 #define SLAP_ISGLOBALOVERLAY(be)                (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1745 #define SLAP_NO_SCHEMA_CHECK(be)        \
1746         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1747 #define SLAP_GLUE_INSTANCE(be)          \
1748         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1749 #define SLAP_GLUE_SUBORDINATE(be)       \
1750         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1751 #define SLAP_GLUE_LINKED(be)            \
1752         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1753 #define SLAP_GLUE_ADVERTISE(be) \
1754         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1755 #define SLAP_SHADOW(be)                         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1756 #define SLAP_SYNC_SHADOW(be)                    (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1757 #define SLAP_SLURP_SHADOW(be)                   (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1758
1759         slap_mask_t     be_restrictops;         /* restriction operations */
1760 #define SLAP_RESTRICT_OP_ADD            0x0001U
1761 #define SLAP_RESTRICT_OP_BIND           0x0002U
1762 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1763 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1764 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1765 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1766 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1767 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1768 #define SLAP_RESTRICT_OP_MASK           0x00FFU
1769
1770 #define SLAP_RESTRICT_READONLY          0x80000000U
1771
1772 #define SLAP_RESTRICT_EXOP_START_TLS            0x0100U
1773 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD        0x0200U
1774 #define SLAP_RESTRICT_EXOP_WHOAMI               0x0400U
1775 #define SLAP_RESTRICT_EXOP_CANCEL               0x0800U
1776 #define SLAP_RESTRICT_EXOP_MASK                 0xFF00U
1777
1778 #define SLAP_RESTRICT_OP_READS  \
1779         ( SLAP_RESTRICT_OP_COMPARE      \
1780         | SLAP_RESTRICT_OP_SEARCH )
1781 #define SLAP_RESTRICT_OP_WRITES \
1782         ( SLAP_RESTRICT_OP_ADD    \
1783         | SLAP_RESTRICT_OP_DELETE \
1784         | SLAP_RESTRICT_OP_MODIFY \
1785         | SLAP_RESTRICT_OP_RENAME )
1786 #define SLAP_RESTRICT_OP_ALL \
1787         ( SLAP_RESTRICT_OP_READS \
1788         | SLAP_RESTRICT_OP_WRITES \
1789         | SLAP_RESTRICT_OP_BIND \
1790         | SLAP_RESTRICT_OP_EXTENDED )
1791
1792 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1793 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1794 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1795
1796 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1797
1798 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1799 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1800 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1801
1802 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1803 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1804
1805 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1806
1807         slap_mask_t     be_requires;    /* pre-operation requirements */
1808 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1809 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1810 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1811 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1812 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1813
1814         /* Required Security Strength Factor */
1815         slap_ssf_set_t be_ssf_set;
1816
1817         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1818         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1819         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1820         struct berval be_schemandn;     /* normalized subschema DN */
1821         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1822         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1823         struct berval be_rootpw;        /* the magic "root" password for this db        */
1824         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1825 #define be_sizelimit    be_def_limit.lms_s_soft
1826 #define be_timelimit    be_def_limit.lms_t_soft
1827         struct slap_limits_set be_def_limit; /* default limits */
1828         struct slap_limits **be_limits; /* regex-based size and time limits */
1829         AccessControl *be_acl;  /* access control list for this backend    */
1830         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1831
1832         /* Replica Information */
1833         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1834         char    *be_replogfile; /* replication log file (in master)        */
1835         char    *be_replica_argsfile; /* per-replog replica args file */
1836         char    *be_replica_pidfile; /* per-replog replica pid file */
1837         int     be_replicationinterval; /* per-replog replicationinterval */
1838         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1839         BerVarray       be_update_refs; /* where to refer modifying clients to */
1840         struct          be_pcl  *be_pending_csn_list;
1841         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1842         ldap_pvt_thread_mutex_t                                 *be_pcl_mutexp;
1843         struct syncinfo_s                                               *be_syncinfo; /* For syncrepl */
1844
1845         void    *be_pb;         /* Netscape plugin */
1846         struct ConfigOCs *be_cf_ocs;
1847
1848         void    *be_private;    /* anything the backend database needs     */
1849         LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1850 };
1851
1852 struct slap_conn;
1853 struct slap_op;
1854
1855 /* Backend function typedefs */
1856 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1857 typedef BI_bi_func BI_init;
1858 typedef BI_bi_func BI_open;
1859 typedef BI_bi_func BI_close;
1860 typedef BI_bi_func BI_destroy;
1861 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1862         const char *fname, int lineno,
1863         int argc, char **argv));
1864
1865 typedef int (BI_db_func) LDAP_P((Backend *bd));
1866 typedef BI_db_func BI_db_init;
1867 typedef BI_db_func BI_db_open;
1868 typedef BI_db_func BI_db_close;
1869 typedef BI_db_func BI_db_destroy;
1870 typedef int (BI_db_config) LDAP_P((Backend *bd,
1871         const char *fname, int lineno,
1872         int argc, char **argv));
1873
1874 typedef struct req_bind_s {
1875         int rb_method;
1876         struct berval rb_cred;
1877         struct berval rb_edn;
1878         slap_ssf_t rb_ssf;
1879         struct berval rb_tmp_mech;      /* FIXME: temporary */
1880 } req_bind_s;
1881
1882 typedef struct req_search_s {
1883         int rs_scope;
1884         int rs_deref;
1885         int rs_slimit;
1886         int rs_tlimit;
1887         /* NULL means be_isroot evaluated to TRUE */
1888         struct slap_limits_set *rs_limit;
1889         int rs_attrsonly;
1890         AttributeName *rs_attrs;
1891         Filter *rs_filter;
1892         struct berval rs_filterstr;
1893 } req_search_s;
1894
1895 typedef struct req_compare_s {
1896         AttributeAssertion *rs_ava;
1897 } req_compare_s;
1898
1899 typedef struct req_modify_s {
1900         Modifications *rs_modlist;
1901         int rs_increment;               /* FIXME: temporary */
1902 } req_modify_s;
1903
1904 typedef struct req_modrdn_s {
1905         struct berval rs_newrdn;
1906         struct berval rs_nnewrdn;
1907         struct berval *rs_newSup;
1908         struct berval *rs_nnewSup;
1909         int rs_deleteoldrdn;
1910 } req_modrdn_s;
1911
1912 typedef struct req_add_s {
1913         Entry *rs_e;
1914         Modifications *rs_modlist;      /* FIXME: temporary */
1915 } req_add_s;
1916
1917 typedef struct req_abandon_s {
1918         ber_int_t rs_msgid;
1919 } req_abandon_s;
1920
1921 #ifdef LDAP_DEVEL
1922 #define SLAP_EXOP_HIDE 0x0000
1923 #else
1924 #define SLAP_EXOP_HIDE 0x8000
1925 #endif
1926 #define SLAP_EXOP_WRITES 0x0001         /* Exop does writes */
1927
1928 typedef struct req_extended_s {
1929         struct berval rs_reqoid;
1930         int rs_flags;
1931         struct berval *rs_reqdata;
1932 } req_extended_s;
1933
1934 typedef struct req_pwdexop_s {
1935         struct req_extended_s rs_extended;
1936         struct berval rs_old;
1937         struct berval rs_new;
1938         Modifications *rs_mods;
1939         Modifications **rs_modtail;
1940 } req_pwdexop_s;
1941
1942 typedef enum slap_reply_e {
1943         REP_RESULT,
1944         REP_SASL,
1945         REP_EXTENDED,
1946         REP_SEARCH,
1947         REP_SEARCHREF,
1948         REP_INTERMEDIATE
1949 } slap_reply_t;
1950
1951 typedef struct rep_sasl_s {
1952         struct berval *r_sasldata;
1953 } rep_sasl_s;
1954
1955 typedef struct rep_extended_s {
1956         const char *r_rspoid;
1957         struct berval *r_rspdata;
1958 } rep_extended_s;
1959
1960 typedef struct rep_search_s {
1961         Entry *r_entry;
1962         slap_mask_t r_attr_flags;
1963 #define SLAP_ATTRS_UNDEFINED    (0x00U)
1964 #define SLAP_OPATTRS_NO                 (0x01U)
1965 #define SLAP_OPATTRS_YES                (0x02U)
1966 #define SLAP_USERATTRS_NO               (0x10U)
1967 #define SLAP_USERATTRS_YES              (0x20U)
1968 #define SLAP_OPATTRS_MASK(f)    ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1969 #define SLAP_OPATTRS(f)                 (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1970 #define SLAP_USERATTRS_MASK(f)  ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1971 #define SLAP_USERATTRS(f)               \
1972         (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1973
1974         Attribute *r_operational_attrs;
1975         AttributeName *r_attrs;
1976         int r_nentries;
1977         BerVarray r_v2ref;
1978 } rep_search_s;
1979
1980 typedef struct slap_rep {
1981         slap_reply_t sr_type;
1982         ber_tag_t sr_tag;
1983         ber_int_t sr_msgid;
1984         ber_int_t sr_err;
1985         const char *sr_matched;
1986         const char *sr_text;
1987         BerVarray sr_ref;
1988         LDAPControl **sr_ctrls;
1989         union sr_u {
1990                 rep_sasl_s sru_sasl;
1991                 rep_extended_s sru_extended;
1992                 rep_search_s sru_search;
1993         } sr_un;
1994         slap_mask_t sr_flags;
1995 #define REP_ENTRY_MODIFIABLE    0x0001U
1996 #define REP_ENTRY_MUSTBEFREED   0x0002U
1997 #define REP_ENTRY_MUSTRELEASE   0x0004U
1998 #define REP_MATCHED_MUSTBEFREED 0x0010U
1999 #define REP_REF_MUSTBEFREED             0x0020U
2000 } SlapReply;
2001
2002 /* short hands for response members */
2003 #define sr_attrs sr_un.sru_search.r_attrs
2004 #define sr_entry sr_un.sru_search.r_entry
2005 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2006 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2007 #define sr_v2ref sr_un.sru_search.r_v2ref
2008 #define sr_nentries sr_un.sru_search.r_nentries
2009 #define sr_rspoid sr_un.sru_extended.r_rspoid
2010 #define sr_rspdata sr_un.sru_extended.r_rspdata
2011 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2012
2013 typedef int (BI_op_func) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2014 typedef BI_op_func BI_op_bind;
2015 typedef BI_op_func BI_op_unbind;
2016 typedef BI_op_func BI_op_search;
2017 typedef BI_op_func BI_op_compare;
2018 typedef BI_op_func BI_op_modify;
2019 typedef BI_op_func BI_op_modrdn;
2020 typedef BI_op_func BI_op_add;
2021 typedef BI_op_func BI_op_delete;
2022 typedef BI_op_func BI_op_abandon;
2023 typedef BI_op_func BI_op_cancel;
2024 typedef BI_op_func BI_op_extended;
2025 typedef BI_op_func BI_chk_referrals;
2026 typedef BI_op_func BI_chk_controls;
2027 typedef int (BI_entry_release_rw)
2028         LDAP_P(( struct slap_op *op, Entry *e, int rw ));
2029 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
2030         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2031 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2032 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
2033         Entry *e, int *hasSubs ));
2034 #ifdef SLAP_OVERLAY_ACCESS
2035 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
2036         AttributeDescription *desc, struct berval *val, slap_access_t access,
2037         AccessControlState *state, slap_mask_t *maskp ));
2038 typedef int (BI_acl_group) LDAP_P(( struct slap_op *op, Entry *target,
2039         struct berval *gr_ndn, struct berval *op_ndn,
2040         ObjectClass *group_oc, AttributeDescription *group_at ));
2041 typedef int (BI_acl_attribute) LDAP_P(( struct slap_op *op, Entry *target,
2042         struct berval *entry_ndn, AttributeDescription *entry_at,
2043         BerVarray *vals, slap_access_t access ));
2044 #endif /* SLAP_OVERLAY_ACCESS */
2045
2046 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, struct slap_conn *c ));
2047 typedef BI_conn_func BI_connection_init;
2048 typedef BI_conn_func BI_connection_destroy;
2049
2050 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2051 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2052 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2053 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2054 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2055 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2056         struct berval *text ));
2057 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
2058 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2059 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2060 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
2061 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2062         struct berval *text ));
2063
2064 struct slap_backend_info {
2065         char    *bi_type; /* type of backend */
2066
2067         /*
2068          * per backend type routines:
2069          * bi_init: called to allocate a backend_info structure,
2070          *              called once BEFORE configuration file is read.
2071          *              bi_init() initializes this structure hence is
2072          *              called directly from be_initialize()
2073          * bi_config: called per 'backend' specific option
2074          *              all such options must before any 'database' options
2075          *              bi_config() is called only from read_config()
2076          * bi_open: called to open each database, called
2077          *              once AFTER configuration file is read but
2078          *              BEFORE any bi_db_open() calls.
2079          *              bi_open() is called from backend_startup()
2080          * bi_close: called to close each database, called
2081          *              once during shutdown after all bi_db_close calls.
2082          *              bi_close() is called from backend_shutdown()
2083          * bi_destroy: called to destroy each database, called
2084          *              once during shutdown after all bi_db_destroy calls.
2085          *              bi_destory() is called from backend_destroy()
2086          */
2087         BI_init *bi_init;
2088         BI_config       *bi_config;
2089         BI_open *bi_open;
2090         BI_close        *bi_close;
2091         BI_destroy      *bi_destroy;
2092
2093         /*
2094          * per database routines:
2095          * bi_db_init: called to initialize each database,
2096          *      called upon reading 'database <type>'
2097          *      called only from backend_db_init()
2098          * bi_db_config: called to configure each database,
2099          *  called per database to handle per database options
2100          *      called only from read_config()
2101          * bi_db_open: called to open each database
2102          *      called once per database immediately AFTER bi_open()
2103          *      calls but before daemon startup.
2104          *  called only by backend_startup()
2105          * bi_db_close: called to close each database
2106          *      called once per database during shutdown but BEFORE
2107          *  any bi_close call.
2108          *  called only by backend_shutdown()
2109          * bi_db_destroy: called to destroy each database
2110          *  called once per database during shutdown AFTER all
2111          *  bi_close calls but before bi_destory calls.
2112          *  called only by backend_destory()
2113          */
2114         BI_db_init      *bi_db_init;
2115         BI_db_config    *bi_db_config;
2116         BI_db_open      *bi_db_open;
2117         BI_db_close     *bi_db_close;
2118         BI_db_destroy   *bi_db_destroy;
2119
2120         /* LDAP Operations Handling Routines */
2121         BI_op_bind      *bi_op_bind;
2122         BI_op_unbind    *bi_op_unbind;
2123         BI_op_search    *bi_op_search;
2124         BI_op_compare   *bi_op_compare;
2125         BI_op_modify    *bi_op_modify;
2126         BI_op_modrdn    *bi_op_modrdn;
2127         BI_op_add       *bi_op_add;
2128         BI_op_delete    *bi_op_delete;
2129         BI_op_abandon   *bi_op_abandon;
2130         BI_op_cancel    *bi_op_cancel;
2131
2132         /* Extended Operations Helper */
2133         BI_op_extended  *bi_extended;
2134
2135         /* Auxilary Functions */
2136         BI_operational          *bi_operational;
2137         BI_chk_referrals        *bi_chk_referrals;
2138         BI_chk_controls         *bi_chk_controls;
2139         BI_entry_get_rw         *bi_entry_get_rw;
2140         BI_entry_release_rw     *bi_entry_release_rw;
2141
2142         BI_has_subordinates     *bi_has_subordinates;
2143 #ifdef SLAP_OVERLAY_ACCESS
2144         BI_access_allowed       *bi_access_allowed;
2145         BI_acl_group            *bi_acl_group;
2146         BI_acl_attribute        *bi_acl_attribute;
2147 #endif /* SLAP_OVERLAY_ACCESS */
2148
2149         BI_connection_init      *bi_connection_init;
2150         BI_connection_destroy   *bi_connection_destroy;
2151
2152         /* hooks for slap tools */
2153         BI_tool_entry_open      *bi_tool_entry_open;
2154         BI_tool_entry_close     *bi_tool_entry_close;
2155         BI_tool_entry_first     *bi_tool_entry_first;
2156         BI_tool_entry_next      *bi_tool_entry_next;
2157         BI_tool_entry_get       *bi_tool_entry_get;
2158         BI_tool_entry_put       *bi_tool_entry_put;
2159         BI_tool_entry_reindex   *bi_tool_entry_reindex;
2160         BI_tool_sync            *bi_tool_sync;
2161         BI_tool_dn2id_get       *bi_tool_dn2id_get;
2162         BI_tool_id2entry_get    *bi_tool_id2entry_get;
2163         BI_tool_entry_modify    *bi_tool_entry_modify;
2164
2165 #define SLAP_INDEX_ADD_OP               0x0001
2166 #define SLAP_INDEX_DELETE_OP    0x0002
2167
2168         slap_mask_t     bi_flags; /* backend flags */
2169 #define SLAP_BFLAG_MONITOR                      0x0001U /* a monitor backend */
2170 #define SLAP_BFLAG_CONFIG                       0x0002U /* a config backend */
2171 #define SLAP_BFLAG_FRONTEND                     0x0004U /* the frontendDB */
2172 #define SLAP_BFLAG_NOLASTMODCMD         0x0010U
2173 #define SLAP_BFLAG_INCREMENT            0x0100U
2174 #define SLAP_BFLAG_ALIASES                      0x1000U
2175 #define SLAP_BFLAG_REFERRALS            0x2000U
2176 #define SLAP_BFLAG_SUBENTRIES           0x4000U
2177 #define SLAP_BFLAG_DYNAMIC                      0x8000U
2178
2179 #define SLAP_BFLAGS(be)         ((be)->bd_info->bi_flags)
2180 #define SLAP_MONITOR(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2181 #define SLAP_CONFIG(be)         (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2182 #define SLAP_FRONTEND(be)       (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2183 #define SLAP_INCREMENT(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2184 #define SLAP_ALIASES(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2185 #define SLAP_REFERRALS(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2186 #define SLAP_SUBENTRIES(be)     (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2187 #define SLAP_DYNAMIC(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2188 #define SLAP_NOLASTMODCMD(be)   (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2189 #define SLAP_LASTMODCMD(be)     (!SLAP_NOLASTMODCMD(be))
2190
2191         char    **bi_controls;          /* supported controls */
2192         char    bi_ctrls[SLAP_MAX_CIDS + 1];
2193
2194         unsigned int bi_nDB;    /* number of databases of this type */
2195         struct ConfigOCs *bi_cf_ocs;
2196         char    **bi_obsolete_names;
2197         void    *bi_private;    /* anything the backend type needs */
2198         LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2199 };
2200
2201 #define c_authtype      c_authz.sai_method
2202 #define c_authmech      c_authz.sai_mech
2203 #define c_dn            c_authz.sai_dn
2204 #define c_ndn           c_authz.sai_ndn
2205 #define c_ssf                   c_authz.sai_ssf
2206 #define c_transport_ssf c_authz.sai_transport_ssf
2207 #define c_tls_ssf               c_authz.sai_tls_ssf
2208 #define c_sasl_ssf              c_authz.sai_sasl_ssf
2209
2210 #define o_authtype      o_authz.sai_method
2211 #define o_authmech      o_authz.sai_mech
2212 #define o_dn            o_authz.sai_dn
2213 #define o_ndn           o_authz.sai_ndn
2214 #define o_ssf                   o_authz.sai_ssf
2215 #define o_transport_ssf o_authz.sai_transport_ssf
2216 #define o_tls_ssf               o_authz.sai_tls_ssf
2217 #define o_sasl_ssf              o_authz.sai_sasl_ssf
2218
2219 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2220
2221 typedef struct slap_callback {
2222         struct slap_callback *sc_next;
2223         slap_response *sc_response;
2224         slap_response *sc_cleanup;
2225         void *sc_private;
2226 } slap_callback;
2227
2228 struct slap_overinfo;
2229
2230 typedef enum slap_operation_e {
2231         op_bind = 0,
2232         op_unbind,
2233         op_search,
2234         op_compare,
2235         op_modify,
2236         op_modrdn,
2237         op_add,
2238         op_delete,
2239         op_abandon,
2240         op_cancel,
2241         op_extended,
2242         op_aux_operational,
2243         op_aux_chk_referrals,
2244         op_aux_chk_controls,
2245         op_last
2246 } slap_operation_t;
2247
2248 typedef struct slap_overinst {
2249         BackendInfo on_bi;
2250         slap_response *on_response;
2251         struct slap_overinfo *on_info;
2252         struct slap_overinst *on_next;
2253 } slap_overinst;
2254
2255 typedef struct slap_overinfo {
2256         BackendInfo oi_bi;
2257         BackendInfo *oi_orig;
2258         BackendDB       *oi_origdb;
2259         struct slap_overinst *oi_list;
2260 } slap_overinfo;
2261
2262 /* Should successive callbacks in a chain be processed? */
2263 #define SLAP_CB_FREEME          0x04000
2264 #define SLAP_CB_CONTINUE        0x08000
2265
2266 /*
2267  * Paged Results state
2268  */
2269 typedef unsigned long PagedResultsCookie;
2270 typedef struct slap_paged_state {
2271         Backend *ps_be;
2272         ber_int_t ps_size;
2273         PagedResultsCookie ps_cookie;
2274         int ps_count;
2275 } PagedResultsState;
2276
2277 struct slap_csn_entry {
2278         struct berval ce_csn;
2279         unsigned long ce_opid;
2280         unsigned long ce_connid;
2281 #define SLAP_CSN_PENDING        1
2282 #define SLAP_CSN_COMMIT         2
2283         long ce_state;
2284         LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2285 };
2286
2287 /*
2288  * Caches the result of a backend_group check for ACL evaluation
2289  */
2290 typedef struct slap_gacl {
2291         struct slap_gacl *ga_next;
2292         Backend *ga_be;
2293         ObjectClass *ga_oc;
2294         AttributeDescription *ga_at;
2295         int ga_res;
2296         ber_len_t ga_len;
2297         char ga_ndn[1];
2298 } GroupAssertion;
2299
2300 struct slap_control_ids {
2301         int sc_LDAPsync;
2302         int sc_assert;
2303         int sc_domainScope;
2304         int sc_dontUseCopy;
2305         int sc_manageDIT;
2306         int sc_manageDSAit;
2307         int sc_modifyIncrement;
2308         int sc_noOp;
2309         int sc_pagedResults;
2310         int sc_permissiveModify;
2311         int sc_postRead;
2312         int sc_preRead;
2313         int sc_proxyAuthz;
2314         int sc_searchOptions;
2315 #ifdef LDAP_DEVEL
2316         int sc_sortedResults;
2317 #endif
2318         int sc_subentries;
2319         int sc_treeDelete;
2320         int sc_valuesReturnFilter;
2321 };
2322
2323 /*
2324  * represents an operation pending from an ldap client
2325  */
2326 typedef struct slap_op_header {
2327         unsigned long oh_opid;  /* id of this operation */
2328         unsigned long oh_connid; /* id of conn initiating this op */
2329         struct slap_conn *oh_conn;      /* connection spawning this op */
2330
2331         ber_int_t       oh_msgid;       /* msgid of the request */
2332         ber_int_t       oh_protocol;    /* version of the LDAP protocol used by client */
2333
2334         ldap_pvt_thread_t       oh_tid; /* thread handling this op */
2335
2336         void    *oh_threadctx;          /* thread pool thread context */
2337         void    *oh_tmpmemctx;          /* slab malloc context */
2338         BerMemoryFunctions *oh_tmpmfuncs;
2339
2340         char            oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2341
2342 #ifdef LDAP_SLAPI
2343         void    *oh_extensions;         /* NS-SLAPI plugin */
2344 #endif
2345 } Opheader;
2346
2347 typedef struct slap_op {
2348         Opheader *o_hdr;
2349
2350 #define o_opid o_hdr->oh_opid
2351 #define o_connid o_hdr->oh_connid
2352 #define o_conn o_hdr->oh_conn
2353 #define o_msgid o_hdr->oh_msgid
2354 #define o_protocol o_hdr->oh_protocol
2355 #define o_tid o_hdr->oh_tid
2356 #define o_threadctx o_hdr->oh_threadctx
2357 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2358 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2359
2360 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2361 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2362 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2363 #define o_tmpfree       o_tmpmfuncs->bmf_free
2364
2365 #define o_log_prefix o_hdr->oh_log_prefix
2366
2367         ber_tag_t       o_tag;          /* tag of the request */
2368         time_t          o_time;         /* time op was initiated */
2369         int                     o_tincr;        /* counter for multiple ops with same o_time */
2370
2371         BackendDB       *o_bd;  /* backend DB processing this op */
2372         struct berval   o_req_dn;       /* DN of target of request */
2373         struct berval   o_req_ndn;
2374
2375         union o_req_u {
2376                 req_add_s oq_add;
2377                 req_bind_s oq_bind;
2378                 req_compare_s oq_compare;
2379                 req_modify_s oq_modify;
2380                 req_modrdn_s oq_modrdn;
2381                 req_search_s oq_search;
2382                 req_abandon_s oq_abandon;
2383                 req_abandon_s oq_cancel;
2384                 req_extended_s oq_extended;
2385                 req_pwdexop_s oq_pwdexop;
2386         } o_request;
2387
2388 /* short hands for union members */
2389 #define oq_add o_request.oq_add
2390 #define oq_bind o_request.oq_bind
2391 #define oq_compare o_request.oq_compare
2392 #define oq_modify o_request.oq_modify
2393 #define oq_modrdn o_request.oq_modrdn
2394 #define oq_search o_request.oq_search
2395 #define oq_abandon o_request.oq_abandon
2396 #define oq_cancel o_request.oq_cancel
2397 #define oq_extended o_request.oq_extended
2398 #define oq_pwdexop o_request.oq_pwdexop
2399
2400 /* short hands for inner request members */
2401 #define orb_method oq_bind.rb_method
2402 #define orb_cred oq_bind.rb_cred
2403 #define orb_edn oq_bind.rb_edn
2404 #define orb_ssf oq_bind.rb_ssf
2405 #define orb_tmp_mech oq_bind.rb_tmp_mech
2406
2407 #define ors_scope oq_search.rs_scope
2408 #define ors_deref oq_search.rs_deref
2409 #define ors_slimit oq_search.rs_slimit
2410 #define ors_tlimit oq_search.rs_tlimit
2411 #define ors_limit oq_search.rs_limit
2412 #define ors_attrsonly oq_search.rs_attrsonly
2413 #define ors_attrs oq_search.rs_attrs
2414 #define ors_filter oq_search.rs_filter
2415 #define ors_filterstr oq_search.rs_filterstr
2416
2417 #define orr_newrdn oq_modrdn.rs_newrdn
2418 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2419 #define orr_newSup oq_modrdn.rs_newSup
2420 #define orr_nnewSup oq_modrdn.rs_nnewSup
2421 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2422
2423 #define orc_ava oq_compare.rs_ava
2424 #define ora_e oq_add.rs_e
2425 #define ora_modlist oq_add.rs_modlist
2426 #define orn_msgid oq_abandon.rs_msgid
2427 #define orm_modlist oq_modify.rs_modlist
2428 #define orm_increment oq_modify.rs_increment
2429
2430 #define ore_reqoid oq_extended.rs_reqoid
2431 #define ore_flags oq_extended.rs_flags
2432 #define ore_reqdata oq_extended.rs_reqdata
2433         volatile sig_atomic_t o_abandon;        /* abandon flag */
2434         volatile sig_atomic_t o_cancel;         /* cancel flag */
2435 #define SLAP_CANCEL_NONE                                0x00
2436 #define SLAP_CANCEL_REQ                                 0x01
2437 #define SLAP_CANCEL_ACK                                 0x02
2438 #define SLAP_CANCEL_DONE                                0x03
2439
2440         GroupAssertion *o_groups;
2441         char o_do_not_cache;    /* don't cache groups from this op */
2442         char o_is_auth_check;   /* authorization in progress */
2443
2444         char o_nocaching;
2445         char o_delete_glue_parent;
2446         char o_no_schema_check;
2447 #define get_no_schema_check(op)                 ((op)->o_no_schema_check)
2448
2449 #define SLAP_CONTROL_NONE       0
2450 #define SLAP_CONTROL_IGNORED    1
2451 #define SLAP_CONTROL_NONCRITICAL 2
2452 #define SLAP_CONTROL_CRITICAL   3
2453 #define SLAP_CONTROL_MASK       3
2454
2455 /* spare bits for simple flags */
2456 #define SLAP_CONTROL_SHIFT      4       /* shift to reach data bits */
2457 #define SLAP_CONTROL_DATA0      0x10
2458 #define SLAP_CONTROL_DATA1      0x20
2459 #define SLAP_CONTROL_DATA2      0x40
2460 #define SLAP_CONTROL_DATA3      0x80
2461
2462
2463 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2464
2465         char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2466         void **o_controls;              /* per-control state */
2467
2468 #define o_dontUseCopy                   o_ctrlflag[slap_cids.sc_dontUseCopy]
2469 #define get_dontUseCopy(op)             _SCM((op)->o_dontUseCopy)
2470
2471 #define o_managedit                             o_ctrlflag[slap_cids.sc_manageDIT]
2472 #define get_manageDIT(op)               _SCM((op)->o_managedit)
2473
2474 #define o_managedsait   o_ctrlflag[slap_cids.sc_manageDSAit]
2475 #define get_manageDSAit(op)                             _SCM((op)->o_managedsait)
2476
2477 #define o_noop  o_ctrlflag[slap_cids.sc_noOp]
2478 #define o_proxy_authz   o_ctrlflag[slap_cids.sc_proxyAuthz]
2479 #define o_subentries    o_ctrlflag[slap_cids.sc_subentries]
2480
2481 #define get_subentries(op)                              _SCM((op)->o_subentries)
2482 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2483
2484 #define set_subentries_visibility(op)   ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2485 #define get_subentries_visibility(op)   (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2486
2487 #define o_assert        o_ctrlflag[slap_cids.sc_assert]
2488 #define get_assert(op)                                  ((int)(op)->o_assert)
2489 #define o_assertion     o_controls[slap_cids.sc_assert]
2490 #define get_assertion(op)                               ((op)->o_assertion)
2491
2492 #define o_valuesreturnfilter    o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2493 #define o_vrFilter      o_controls[slap_cids.sc_valuesReturnFilter]
2494
2495 #define o_permissive_modify     o_ctrlflag[slap_cids.sc_permissiveModify]
2496 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
2497
2498 #define o_domain_scope  o_ctrlflag[slap_cids.sc_domainScope]
2499 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
2500
2501 #define o_tree_delete   o_ctrlflag[slap_cids.sc_treeDelete]
2502 #define get_treeDelete(op)                              ((int)(op)->o_tree_delete)
2503
2504 #define o_preread       o_ctrlflag[slap_cids.sc_preRead]
2505 #define o_postread      o_ctrlflag[slap_cids.sc_postRead]
2506
2507 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2508 #define o_postread_attrs        o_controls[slap_cids.sc_postRead]
2509
2510 #define o_pagedresults  o_ctrlflag[slap_cids.sc_pagedResults]
2511 #define o_pagedresults_state    o_controls[slap_cids.sc_pagedResults]
2512 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2513
2514 #ifdef LDAP_DEVEL
2515 #define o_sortedresults         o_ctrlflag[slap_cids.sc_sortedResults]
2516 #endif
2517
2518 #define o_sync                  o_ctrlflag[slap_cids.sc_LDAPsync]
2519
2520         AuthorizationInformation o_authz;
2521
2522         BerElement      *o_ber;         /* ber of the request */
2523         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2524         slap_callback *o_callback;      /* callback pointers */
2525         LDAPControl     **o_ctrls;       /* controls */
2526         struct berval o_csn;
2527
2528         void    *o_private;     /* anything the backend needs */
2529
2530         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2531
2532 } Operation;
2533 #define OPERATION_BUFFER_SIZE   ( sizeof(Operation) + sizeof(Opheader) + \
2534         SLAP_MAX_CIDS*sizeof(void *) )
2535
2536 typedef LBER_ALIGNED_BUFFER(operation_buffer_u,OPERATION_BUFFER_SIZE)
2537         OperationBuffer;
2538
2539 #define send_ldap_error( op, rs, err, text ) do { \
2540                 (rs)->sr_err = err; (rs)->sr_text = text; \
2541                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2542         } while (0)
2543 #define send_ldap_discon( op, rs, err, text ) do { \
2544                 (rs)->sr_err = err; (rs)->sr_text = text; \
2545                 send_ldap_disconnect( op, rs ); \
2546         } while (0)
2547
2548 typedef void (SEND_LDAP_RESULT)(
2549         struct slap_op *op, struct slap_rep *rs);
2550 typedef int (SEND_SEARCH_ENTRY)(
2551         struct slap_op *op, struct slap_rep *rs);
2552 typedef int (SEND_SEARCH_REFERENCE)(
2553         struct slap_op *op, struct slap_rep *rs);
2554 typedef void (SEND_LDAP_EXTENDED)(
2555         struct slap_op *op, struct slap_rep *rs);
2556 typedef void (SEND_LDAP_INTERMEDIATE)(
2557         struct slap_op *op, struct slap_rep *rs);
2558
2559 #define send_ldap_result( op, rs ) \
2560         ((op)->o_conn->c_send_ldap_result)( op, rs )
2561 #define send_search_entry( op, rs ) \
2562         ((op)->o_conn->c_send_search_entry)( op, rs )
2563 #define send_search_reference( op, rs ) \
2564         ((op)->o_conn->c_send_search_reference)( op, rs )
2565 #define send_ldap_extended( op, rs ) \
2566         ((op)->o_conn->c_send_ldap_extended)( op, rs )
2567 #define send_ldap_intermediate( op, rs ) \
2568         ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2569
2570 typedef struct slap_listener Listener;
2571
2572 /*
2573  * represents a connection from an ldap client
2574  */
2575 typedef struct slap_conn {
2576         int                     c_struct_state; /* structure management state */
2577         int                     c_conn_state;   /* connection state */
2578         int                     c_conn_idx;             /* slot in connections array */
2579         const char      *c_close_reason; /* why connection is closing */
2580
2581         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2582         Sockbuf         *c_sb;                  /* ber connection stuff           */
2583
2584         /* only can be changed by connect_init */
2585         time_t          c_starttime;    /* when the connection was opened */
2586         time_t          c_activitytime; /* when the connection was last used */
2587         unsigned long           c_connid;       /* id of this connection for stats*/
2588
2589         struct berval   c_peer_domain;  /* DNS name of client */
2590         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2591         Listener        *c_listener;
2592 #define c_listener_url c_listener->sl_url       /* listener URL */
2593 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2594
2595         /* only can be changed by binding thread */
2596         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2597         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2598         struct berval   c_sasl_dn;      /* temporary storage */
2599         struct berval   c_sasl_authz_dn;        /* SASL proxy authz */
2600
2601         /* authorization backend */
2602         Backend *c_authz_backend;
2603         void    *c_authz_cookie;
2604 #define SLAP_IS_AUTHZ_BACKEND( op )     \
2605         ( (op)->o_bd != NULL \
2606                 && (op)->o_bd->be_private != NULL \
2607                 && (op)->o_conn != NULL \
2608                 && (op)->o_conn->c_authz_backend != NULL \
2609                 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2610                         || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2611
2612         AuthorizationInformation c_authz;
2613
2614         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2615
2616         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2617         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2618
2619         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2620         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2621
2622         BerElement      *c_currentber;  /* ber we're attempting to read */
2623         int             c_writewaiter;  /* true if writer is waiting */
2624
2625 #define CONN_IS_TLS     1
2626 #define CONN_IS_UDP     2
2627 #define CONN_IS_CLIENT  3
2628
2629 #ifdef LDAP_CONNECTIONLESS
2630         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2631 #endif
2632 #ifdef HAVE_TLS
2633         int     c_is_tls;               /* true if this LDAP over raw TLS */
2634         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2635 #endif
2636         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2637         int     c_sasl_done;            /* SASL completed once */
2638         void    *c_sasl_authctx;        /* SASL authentication context */
2639         void    *c_sasl_sockctx;        /* SASL security layer context */
2640         void    *c_sasl_extra;          /* SASL session extra stuff */
2641         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2642
2643         PagedResultsState c_pagedresults_state; /* paged result state */
2644
2645         long    c_n_ops_received;       /* num of ops received (next op_id) */
2646         long    c_n_ops_executing;      /* num of ops currently executing */
2647         long    c_n_ops_pending;        /* num of ops pending execution */
2648         long    c_n_ops_completed;      /* num of ops completed */
2649
2650         long    c_n_get;                /* num of get calls */
2651         long    c_n_read;               /* num of read calls */
2652         long    c_n_write;              /* num of write calls */
2653
2654         void    *c_pb;                  /* Netscape plugin */
2655         void    *c_extensions;          /* Netscape plugin */
2656
2657         /*
2658          * Client connection handling
2659          */
2660         ldap_pvt_thread_start_t *c_clientfunc;
2661         void    *c_clientarg;
2662
2663         /*
2664          * These are the "callbacks" that are available for back-ends to
2665          * supply data back to connected clients that are connected
2666          * through the "front-end".
2667          */
2668         SEND_LDAP_RESULT *c_send_ldap_result;
2669         SEND_SEARCH_ENTRY *c_send_search_entry;
2670         SEND_SEARCH_REFERENCE *c_send_search_reference;
2671         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2672         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2673 } Connection;
2674
2675 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2676 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2677         do { \
2678                 if ( ldap_debug & (level) ) \
2679                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2680                 if ( ldap_syslog & (level) ) \
2681                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2682                                 (arg2), (arg3) ); \
2683         } while (0)
2684 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2685 #elif defined(LDAP_DEBUG)
2686 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2687         do { \
2688                 if ( ldap_debug & (level) ) \
2689                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2690         } while (0)
2691 #define StatslogTest( level ) (ldap_debug & (level))
2692 #else
2693 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2694 #define StatslogTest( level ) (0)
2695 #endif
2696
2697 /*
2698  * listener; need to access it from monitor backend
2699  */
2700 struct slap_listener {
2701         struct berval sl_url;
2702         struct berval sl_name;
2703         mode_t  sl_perms;
2704 #ifdef HAVE_TLS
2705         int             sl_is_tls;
2706 #endif
2707 #ifdef LDAP_CONNECTIONLESS
2708         int     sl_is_udp;              /* UDP listener is also data port */
2709 #endif
2710         int     sl_mute;        /* Listener is temporarily disabled due to emfile */
2711 #ifdef SLAP_LIGHTWEIGHT_DISPATCHER
2712         int     sl_busy;        /* Listener is busy (accept thread activated) */
2713 #endif
2714         ber_socket_t sl_sd;
2715         Sockaddr sl_sa;
2716 #define sl_addr sl_sa.sa_in_addr
2717 };
2718
2719 /*
2720  * Operation indices
2721  */
2722 enum {
2723         SLAP_OP_BIND = 0,
2724         SLAP_OP_UNBIND,
2725         SLAP_OP_ADD,
2726         SLAP_OP_DELETE,
2727         SLAP_OP_MODRDN,
2728         SLAP_OP_MODIFY,
2729         SLAP_OP_COMPARE,
2730         SLAP_OP_SEARCH,
2731         SLAP_OP_ABANDON,
2732         SLAP_OP_EXTENDED,
2733         SLAP_OP_LAST
2734 };
2735
2736 typedef struct slap_counters_t {
2737         ldap_pvt_thread_mutex_t sc_sent_mutex;
2738         ldap_pvt_mp_t           sc_bytes;
2739         ldap_pvt_mp_t           sc_pdu;
2740         ldap_pvt_mp_t           sc_entries;
2741         ldap_pvt_mp_t           sc_refs;
2742
2743         ldap_pvt_thread_mutex_t sc_ops_mutex;
2744         ldap_pvt_mp_t           sc_ops_completed;
2745         ldap_pvt_mp_t           sc_ops_initiated;
2746 #ifdef SLAPD_MONITOR
2747         ldap_pvt_mp_t           sc_ops_completed_[SLAP_OP_LAST];
2748         ldap_pvt_mp_t           sc_ops_initiated_[SLAP_OP_LAST];
2749 #endif /* SLAPD_MONITOR */
2750 } slap_counters_t;
2751
2752 /*
2753  * Better know these all around slapd
2754  */
2755 #define SLAP_LDAPDN_PRETTY 0x1
2756 #define SLAP_LDAPDN_MAXLEN 8192
2757
2758 /* number of response controls supported */
2759 #define SLAP_MAX_RESPONSE_CONTROLS   6
2760
2761 #ifdef LDAP_DEVEL
2762 #define SLAP_CTRL_HIDE                          0x00000000U
2763 #else
2764 #define SLAP_CTRL_HIDE                          0x80000000U
2765 #endif
2766
2767 #define SLAP_CTRL_REQUIRES_ROOT         0x40000000U /* for ManageDIT */
2768
2769 #define SLAP_CTRL_GLOBAL                        0x00800000U
2770 #define SLAP_CTRL_GLOBAL_SEARCH         0x00010000U     /* for NOOP */
2771
2772 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2773 #define SLAP_CTRL_ABANDON                       0x00000001U
2774 #define SLAP_CTRL_ADD                           0x00002002U
2775 #define SLAP_CTRL_BIND                          0x00000004U
2776 #define SLAP_CTRL_COMPARE                       0x00001008U
2777 #define SLAP_CTRL_DELETE                        0x00002010U
2778 #define SLAP_CTRL_MODIFY                        0x00002020U
2779 #define SLAP_CTRL_RENAME                        0x00002040U
2780 #define SLAP_CTRL_SEARCH                        0x00001080U
2781 #define SLAP_CTRL_UNBIND                        0x00000100U
2782
2783 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2784 #define SLAP_CTRL_UPDATE \
2785         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2786 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2787
2788 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2789         Operation *op,
2790         SlapReply *rs,
2791         LDAPControl *ctrl ));
2792
2793 #define SLAP_SLAB_SIZE  (1024*1024)
2794 #define SLAP_SLAB_STACK 1
2795 #define SLAP_SLAB_SOBLOCK 64
2796
2797 #define SLAP_ZONE_ALLOC 1
2798 #undef SLAP_ZONE_ALLOC
2799
2800 #ifdef LDAP_COMP_MATCH
2801 /*
2802  * Extensible Filter Definition
2803  *
2804  * MatchingRuleAssertion := SEQUENCE {
2805  *      matchingRule    [1] MatchingRuleId OPTIONAL,
2806  *      type            [2] AttributeDescription OPTIONAL,
2807  *      matchValue      [3] AssertionValue,
2808  *      dnAttributes    [4] BOOLEAN DEFAULT FALSE }
2809  *
2810  * Following ComponentFilter is contained in matchValue
2811  *
2812  * ComponentAssertion ::= SEQUENCE {
2813  *      component               ComponentReference (SIZE(1..MAX)) OPTIONAL
2814  *      useDefaultValues        BOOLEAN DEFAULT TRUE,
2815  *      rule                    MATCHING-RULE.&id,
2816  *      value                   MATCHING-RULE.&AssertionType }
2817  *
2818  * ComponentFilter ::= CHOICE {
2819  *      item    [0] ComponentAssertion,
2820  *      and     [1] SEQUENCE OF ComponentFilter,
2821  *      or      [2] SEQUENCE OF ComponentFilter,
2822  *      not     [3] ComponentFilter }
2823  */
2824
2825 #define LDAP_COMPREF_IDENTIFIER         ((ber_tag_t) 0x80U)
2826 #define LDAP_COMPREF_FROM_BEGINNING     ((ber_tag_t) 0x81U)
2827 #define LDAP_COMPREF_COUNT              ((ber_tag_t) 0x82U)
2828 #define LDAP_COMPREF_FROM_END           ((ber_tag_t) 0x83U)
2829 #define LDAP_COMPREF_CONTENT            ((ber_tag_t) 0x84U)
2830 #define LDAP_COMPREF_SELECT             ((ber_tag_t) 0x85U)
2831 #define LDAP_COMPREF_ALL                ((ber_tag_t) 0x86U)
2832 #define LDAP_COMPREF_DEFINED            ((ber_tag_t) 0x87U)
2833 #define LDAP_COMPREF_UNDEFINED          ((ber_tag_t) 0x88U)
2834
2835 #define LDAP_COMP_FILTER_AND            ((ber_tag_t) 0xa0U)
2836 #define LDAP_COMP_FILTER_OR             ((ber_tag_t) 0xa1U)
2837 #define LDAP_COMP_FILTER_NOT            ((ber_tag_t) 0xa2U)
2838 #define LDAP_COMP_FILTER_ITEM           ((ber_tag_t) 0xa3U)
2839 #define LDAP_COMP_FILTER_UNDEFINED      ((ber_tag_t) 0xa4U)
2840
2841 typedef struct slap_component_id {
2842         int     ci_type;
2843         struct slap_component_id *ci_next;
2844
2845         union comp_id_value{
2846                 BerValue        ci_identifier;
2847                 ber_int_t       ci_from_beginning;
2848                 ber_int_t       ci_count;
2849                 ber_int_t       ci_from_end;
2850                 ber_int_t       ci_content;
2851                 BerValue        ci_select_value;
2852                 char            ci_all;
2853         } ci_val;
2854 } ComponentId;
2855
2856 typedef struct slap_component_reference {
2857         ComponentId     *cr_list;
2858         ComponentId     *cr_curr;
2859         struct berval   cr_string;
2860         int cr_len;
2861         /* Component Indexing */
2862         int             cr_asn_type_id;
2863         slap_mask_t     cr_indexmask;
2864         AttributeDescription* cr_ad;
2865         BerVarray       cr_nvals;
2866         struct slap_component_reference* cr_next;
2867 } ComponentReference;
2868
2869 typedef struct slap_component_assertion {
2870         ComponentReference      *ca_comp_ref;
2871         ber_int_t               ca_use_def;
2872         MatchingRule            *ca_ma_rule;
2873         struct berval           ca_ma_value;
2874         ComponentData           ca_comp_data; /* componentized assertion */
2875         struct slap_component_filter    *ca_cf;
2876         MatchingRuleAssertion   *ca_mra;
2877 } ComponentAssertion;
2878
2879 typedef struct slap_component_filter {
2880         ber_tag_t cf_choice;
2881         union cf_un_u {
2882                 ber_int_t cf_un_result;
2883                 ComponentAssertion *cf_un_ca;
2884                 struct slap_component_filter *cf_un_complex;
2885         } cf_un;
2886
2887 #define cf_ca           cf_un.cf_un_ca
2888 #define cf_result       cf_un.cf_un_result
2889 #define cf_and          cf_un.cf_un_complex
2890 #define cf_or           cf_un.cf_un_complex
2891 #define cf_not          cf_un.cf_un_complex
2892 #define cf_any          cf_un.cf_un_complex
2893
2894         struct slap_component_filter *cf_next;
2895 } ComponentFilter;
2896
2897 typedef struct slap_component_assertion_value {
2898         char* cav_buf;
2899         char* cav_ptr;
2900         char* cav_end;
2901 } ComponentAssertionValue;
2902
2903 typedef int encoder_func LDAP_P((
2904         void* b,
2905         void* comp));
2906
2907 struct slap_component_syntax_info;
2908
2909 typedef int gser_decoder_func LDAP_P((
2910         void* mem_op,
2911         void* b,
2912         struct slap_component_syntax_info** comp_syn_info,
2913         int* len,
2914         int mode));
2915
2916 typedef int comp_free_func LDAP_P((
2917         void* b));
2918
2919 typedef int ber_decoder_func LDAP_P((
2920         void* mem_op,
2921         void* b,
2922         int tag,
2923         int elmtLen,
2924         struct slap_component_syntax_info* comp_syn_info,
2925         int* len,
2926         int mode));
2927
2928 typedef int ber_tag_decoder_func LDAP_P((
2929         void* mem_op,
2930         void* b,
2931         struct slap_component_syntax_info* comp_syn_info,
2932         int* len,
2933         int mode));
2934
2935 typedef void* extract_component_from_id_func LDAP_P((
2936         void* mem_op,
2937         ComponentReference* cr,
2938         void* comp ));
2939
2940 typedef void* convert_attr_to_comp_func LDAP_P ((
2941         Attribute* a,
2942         Syntax* syn,
2943         struct berval* bv ));
2944
2945 typedef void* alloc_nibble_func LDAP_P ((
2946         int initial_size,
2947         int increment_size ));
2948
2949 typedef void free_nibble_func LDAP_P ((
2950         void* nm ));
2951
2952 struct slap_component_syntax_info;
2953 typedef void convert_assert_to_comp_func LDAP_P ((
2954         void *mem_op,
2955         struct slap_component_syntax_info* csi_attr,
2956         struct berval* bv,
2957         struct slap_component_syntax_info** csi,
2958         int* len,
2959         int mode ));
2960
2961 typedef int convert_asn_to_ldap_func LDAP_P ((
2962         struct slap_component_syntax_info* csi,
2963         struct berval *bv ));
2964
2965 typedef void free_component_func LDAP_P ((
2966         void* mem_op));
2967
2968 typedef int test_component_func LDAP_P ((
2969         void* attr_mem_op,
2970         void* assert_mem_op,
2971         struct slap_component_syntax_info* csi,
2972         struct slap_component_assertion* ca));
2973
2974 typedef void* test_membership_func LDAP_P ((
2975         void* in ));
2976
2977 typedef void* get_component_info_func LDAP_P ((
2978         int in ));
2979
2980 struct slap_component_syntax_info;
2981
2982 typedef int component_encoder_func LDAP_P ((
2983         void* mem_op,
2984         struct slap_component_syntax_info* csi,
2985         struct berval* nvals ));
2986
2987 typedef int allcomponent_matching_func LDAP_P((
2988         char* oid,
2989         struct slap_component_syntax_info* comp1,
2990         struct slap_component_syntax_info* comp));
2991
2992 typedef struct slap_component_desc {
2993         /* Don't change the order of following four fields */
2994         int             cd_tag;
2995         AttributeType   *cd_comp_type;
2996         struct berval   cd_ad_type;/* ad_type, ad_cname */
2997         struct berval   cd_ad_cname;/* ad_type, ad_cname */
2998         unsigned        cd_flags; /*ad_flags*/
2999         int             cd_type;
3000         int             cd_type_id;
3001         encoder_func            *cd_ldap_encoder;
3002         encoder_func            *cd_gser_encoder;
3003         encoder_func            *cd_ber_encoder;
3004         gser_decoder_func       *cd_gser_decoder;
3005         ber_decoder_func        *cd_ber_decoder;
3006         comp_free_func          *cd_free;
3007         extract_component_from_id_func*  cd_extract_i;
3008         allcomponent_matching_func      *cd_all_match;
3009 } ComponentDesc;
3010
3011 typedef struct slap_component_syntax_info {
3012         Syntax* csi_syntax;
3013         ComponentDesc* csi_comp_desc;
3014 } ComponentSyntaxInfo;
3015
3016 #endif
3017
3018 /* slab heap data structures */
3019
3020 struct slab_object {
3021     void *so_ptr;
3022         int so_blockhead;
3023     LDAP_LIST_ENTRY(slab_object) so_link;
3024 };
3025
3026 struct slab_heap {
3027     void *sh_base;
3028     void *sh_last;
3029     void *sh_end;
3030         int sh_stack;
3031         int sh_maxorder;
3032     unsigned char **sh_map;
3033     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3034         LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3035 };
3036
3037 #ifdef SLAP_ZONE_ALLOC
3038 #define SLAP_ZONE_SIZE 0x80000          /* 512KB */
3039 #define SLAP_ZONE_SHIFT 19
3040 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3041 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3042 #define SLAP_ZONE_DELTA 0x800000        /* 8MB */
3043 #define SLAP_ZONE_ZOBLOCK 256
3044
3045 struct zone_object {
3046         void *zo_ptr;
3047         int zo_siz;
3048         int zo_idx;
3049         int zo_blockhead;
3050         LDAP_LIST_ENTRY(zone_object) zo_link;
3051 };
3052
3053 struct zone_latency_history {
3054         double zlh_latency;
3055         LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3056 };
3057
3058 struct zone_heap {
3059         int zh_fd;
3060         int zh_zonesize;
3061         int zh_zoneorder;
3062         int zh_numzones;
3063         int zh_maxzones;
3064         int zh_deltazones;
3065         void **zh_zones;
3066         ldap_pvt_thread_rdwr_t *zh_znlock;
3067         Avlnode *zh_zonetree;
3068         unsigned char ***zh_maps;
3069         int *zh_seqno;
3070         LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3071         LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3072         ldap_pvt_thread_mutex_t zh_mutex;
3073         ldap_pvt_thread_rdwr_t zh_lock;
3074         double zh_ema_latency;
3075         unsigned long zh_ema_samples;
3076         LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3077                                 zh_latency_history_queue;
3078         int zh_latency_history_qlen;
3079         int zh_latency_jump;
3080         int zh_swapping;
3081 };
3082 #endif
3083
3084 #define SLAP_BACKEND_INIT_MODULE(b) \
3085         static BackendInfo bi;  \
3086         int \
3087         init_module( int argc, char *argv[] ) \
3088         { \
3089                 bi.bi_type = #b ; \
3090                 bi.bi_init = b ## _back_initialize; \
3091                 backend_add( &bi ); \
3092                 return 0; \
3093         }
3094
3095 typedef int (OV_init)(void);
3096 typedef struct slap_oinit_t {
3097         const char      *ov_type;
3098         OV_init         *ov_init;
3099 } OverlayInit;
3100
3101 LDAP_END_DECL
3102
3103 #include "proto-slap.h"
3104
3105 #endif /* _SLAP_H_ */