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