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