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

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