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_uidNumber;
 915         AttributeDescription *si_ad_gidNumber;
 916         AttributeDescription *si_ad_userPassword;
 917         AttributeDescription *si_ad_labeledURI;
 918 #ifdef SLAPD_AUTHPASSWD
 919         AttributeDescription *si_ad_authPassword;
 920         AttributeDescription *si_ad_authPasswordSchemes;
 921 #endif
 922 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 923         AttributeDescription *si_ad_krbName;
 924 #endif
 925         AttributeDescription *si_ad_description;
 926         AttributeDescription *si_ad_seeAlso;
 927
 928         /* Undefined Attribute Type */
 929         AttributeType   *si_at_undefined;
 930
 931         /* "Proxied" Attribute Type */
 932         AttributeType   *si_at_proxied;
 933
 934         /* Matching Rules */
 935         MatchingRule    *si_mr_distinguishedNameMatch;
 936         MatchingRule    *si_mr_dnSubtreeMatch;
 937         MatchingRule    *si_mr_dnOneLevelMatch;
 938         MatchingRule    *si_mr_dnSubordinateMatch;
 939         MatchingRule    *si_mr_dnSuperiorMatch;
 940         MatchingRule    *si_mr_caseExactMatch;
 941         MatchingRule    *si_mr_caseExactSubstringsMatch;
 942         MatchingRule    *si_mr_caseExactIA5Match;
 943         MatchingRule    *si_mr_integerMatch;
 944         MatchingRule    *si_mr_integerFirstComponentMatch;
 945         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 946
 947         /* Syntaxes */
 948         Syntax          *si_syn_directoryString;
 949         Syntax          *si_syn_distinguishedName;
 950         Syntax          *si_syn_integer;
 951         Syntax          *si_syn_octetString;
 952
 953         /* Schema Syntaxes */
 954         Syntax          *si_syn_attributeTypeDesc;
 955         Syntax          *si_syn_ditContentRuleDesc;
 956         Syntax          *si_syn_ditStructureRuleDesc;
 957         Syntax          *si_syn_ldapSyntaxDesc;
 958         Syntax          *si_syn_matchingRuleDesc;
 959         Syntax          *si_syn_matchingRuleUseDesc;
 960         Syntax          *si_syn_nameFormDesc;
 961         Syntax          *si_syn_objectClassDesc;
 962 };
 963
 964 typedef struct slap_attr_assertion {
 965         AttributeDescription    *aa_desc;
 966         struct berval aa_value;
 967 #ifdef LDAP_COMP_MATCH
 968         struct slap_component_filter *aa_cf;/* for attribute aliasing */
 969 #endif
 970 } AttributeAssertion;
 971
 972 typedef struct slap_ss_assertion {
 973         AttributeDescription    *sa_desc;
 974         struct berval           sa_initial;
 975         struct berval           *sa_any;
 976         struct berval           sa_final;
 977 } SubstringsAssertion;
 978
 979 #ifdef LDAP_COMP_MATCH
 980 struct slap_component_filter;
 981 #endif
 982
 983 typedef struct slap_mr_assertion {
 984         MatchingRule            *ma_rule;       /* optional */
 985         struct berval           ma_rule_text;  /* optional */
 986         AttributeDescription    *ma_desc;       /* optional */
 987         int                                             ma_dnattrs; /* boolean */
 988         struct berval           ma_value;       /* required */
 989 #ifdef LDAP_COMP_MATCH
 990         struct slap_component_filter* ma_cf; /* component filter */
 991 #endif
 992 } MatchingRuleAssertion;
 993
 994 /*
 995  * represents a search filter
 996  */
 997 typedef struct slap_filter {
 998         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 999 #define SLAPD_FILTER_COMPUTED           ((ber_tag_t) -1)
1000 #define SLAPD_FILTER_DN_ONE                     ((ber_tag_t) -2)
1001 #define SLAPD_FILTER_DN_SUBTREE         ((ber_tag_t) -3)
1002 #ifdef LDAP_SCOPE_SUBORDINATE
1003 #define SLAPD_FILTER_DN_CHILDREN        ((ber_tag_t) -4)
1004 #endif
1005
1006         union f_un_u {
1007                 /* precomputed result */
1008                 ber_int_t f_un_result;
1009
1010                 /* DN */
1011                 struct berval *f_un_dn;
1012
1013                 /* present */
1014                 AttributeDescription *f_un_desc;
1015
1016                 /* simple value assertion */
1017                 AttributeAssertion *f_un_ava;
1018
1019                 /* substring assertion */
1020                 SubstringsAssertion *f_un_ssa;
1021
1022                 /* matching rule assertion */
1023                 MatchingRuleAssertion *f_un_mra;
1024
1025 #define f_dn                    f_un.f_un_dn
1026 #define f_desc                  f_un.f_un_desc
1027 #define f_ava                   f_un.f_un_ava
1028 #define f_av_desc               f_un.f_un_ava->aa_desc
1029 #define f_av_value              f_un.f_un_ava->aa_value
1030 #define f_sub                   f_un.f_un_ssa
1031 #define f_sub_desc              f_un.f_un_ssa->sa_desc
1032 #define f_sub_initial   f_un.f_un_ssa->sa_initial
1033 #define f_sub_any               f_un.f_un_ssa->sa_any
1034 #define f_sub_final             f_un.f_un_ssa->sa_final
1035 #define f_mra                   f_un.f_un_mra
1036 #define f_mr_rule               f_un.f_un_mra->ma_rule
1037 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
1038 #define f_mr_desc               f_un.f_un_mra->ma_desc
1039 #define f_mr_value              f_un.f_un_mra->ma_value
1040 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
1041
1042                 /* and, or, not */
1043                 struct slap_filter *f_un_complex;
1044         } f_un;
1045
1046 #define f_result        f_un.f_un_result
1047 #define f_and           f_un.f_un_complex
1048 #define f_or            f_un.f_un_complex
1049 #define f_not           f_un.f_un_complex
1050 #define f_list          f_un.f_un_complex
1051
1052         struct slap_filter      *f_next;
1053 } Filter;
1054
1055 /* compare routines can return undefined */
1056 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1057
1058 typedef struct slap_valuesreturnfilter {
1059         ber_tag_t       vrf_choice;
1060
1061         union vrf_un_u {
1062                 /* precomputed result */
1063                 ber_int_t vrf_un_result;
1064
1065                 /* DN */
1066                 char *vrf_un_dn;
1067
1068                 /* present */
1069                 AttributeDescription *vrf_un_desc;
1070
1071                 /* simple value assertion */
1072                 AttributeAssertion *vrf_un_ava;
1073
1074                 /* substring assertion */
1075                 SubstringsAssertion *vrf_un_ssa;
1076
1077                 /* matching rule assertion */
1078                 MatchingRuleAssertion *vrf_un_mra;
1079
1080 #define vrf_result              vrf_un.vrf_un_result
1081 #define vrf_dn                  vrf_un.vrf_un_dn
1082 #define vrf_desc                vrf_un.vrf_un_desc
1083 #define vrf_ava                 vrf_un.vrf_un_ava
1084 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
1085 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
1086 #define vrf_ssa                 vrf_un.vrf_un_ssa
1087 #define vrf_sub                 vrf_un.vrf_un_ssa
1088 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
1089 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1090 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
1091 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
1092 #define vrf_mra                 vrf_un.vrf_un_mra
1093 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
1094 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
1095 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
1096 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
1097 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
1098
1099
1100         } vrf_un;
1101
1102         struct slap_valuesreturnfilter  *vrf_next;
1103 } ValuesReturnFilter;
1104
1105 #ifdef LDAP_COMP_MATCH
1106 struct slap_component_syntax_info;
1107 typedef struct  slap_component_data {
1108         void* cd_mem_op;/* nibble memory handler */
1109         struct slap_component_syntax_info** cd_tree;/* component tree */
1110 } ComponentData;
1111 #endif
1112
1113 /*
1114  * represents an attribute (description + values)
1115  */
1116 typedef struct slap_attr {
1117         AttributeDescription *a_desc;
1118         BerVarray       a_vals;         /* preserved values */
1119         BerVarray       a_nvals;        /* normalized values */
1120 #ifdef LDAP_COMP_MATCH
1121         ComponentData   *a_comp_data; /* component values */
1122 #endif
1123         struct slap_attr *a_next;
1124         unsigned a_flags;
1125 #define SLAP_ATTR_IXADD         0x1U
1126 #define SLAP_ATTR_IXDEL         0x2U
1127 } Attribute;
1128
1129
1130 /*
1131  * the id used in the indexes to refer to an entry
1132  */
1133 typedef unsigned long   ID;
1134 #define NOID    ((ID)~0)
1135
1136 /*
1137  * represents an entry in core
1138  */
1139 typedef struct slap_entry {
1140         /*
1141          * The ID field should only be changed before entry is
1142          * inserted into a cache.  The ID value is backend
1143          * specific.
1144          */
1145         ID              e_id;
1146
1147         struct berval e_name;   /* name (DN) of this entry */
1148         struct berval e_nname;  /* normalized name (DN) of this entry */
1149
1150         /* for migration purposes */
1151 #define e_dn e_name.bv_val
1152 #define e_ndn e_nname.bv_val
1153
1154         Attribute       *e_attrs;       /* list of attributes + values */
1155
1156         slap_mask_t     e_ocflags;
1157
1158         struct berval   e_bv;           /* For entry_encode/entry_decode */
1159
1160         /* for use by the backend for any purpose */
1161         void*   e_private;
1162 } Entry;
1163
1164 /*
1165  * A list of LDAPMods
1166  */
1167 typedef struct slap_mod {
1168         short sm_op;
1169         short sm_flags;
1170 /* Set for internal mods, will bypass ACL checks. Only needed when
1171  * running as non-root user, for user modifiable attributes.
1172  */
1173 #define SLAP_MOD_INTERNAL       0x01
1174 #define SLAP_MOD_MANAGING       0x02
1175
1176         AttributeDescription *sm_desc;
1177         struct berval sm_type;
1178         BerVarray sm_values;
1179         BerVarray sm_nvalues;
1180 } Modification;
1181
1182 typedef struct slap_mod_list {
1183         Modification sml_mod;
1184 #define sml_op          sml_mod.sm_op
1185 #define sml_flags       sml_mod.sm_flags
1186 #define sml_desc        sml_mod.sm_desc
1187 #define sml_type        sml_mod.sm_type
1188 #define sml_values      sml_mod.sm_values
1189 #define sml_nvalues     sml_mod.sm_nvalues
1190         struct slap_mod_list *sml_next;
1191 } Modifications;
1192
1193 typedef struct slap_ldap_modlist {
1194         LDAPMod ml_mod;
1195         struct slap_ldap_modlist *ml_next;
1196 #define ml_op           ml_mod.mod_op
1197 #define ml_type         ml_mod.mod_type
1198 #define ml_values       ml_mod.mod_values
1199 } LDAPModList;
1200
1201 /*
1202  * represents an access control list
1203  */
1204 typedef enum slap_access_e {
1205         ACL_INVALID_ACCESS = -1,
1206         ACL_NONE = 0,
1207         ACL_DISCLOSE,
1208         ACL_AUTH,
1209         ACL_COMPARE,
1210         ACL_SEARCH,
1211         ACL_READ,
1212         ACL_WRITE,
1213         ACL_MANAGE,
1214
1215         /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1216         ACL_LAST,
1217
1218         /* ACL level mask and modifiers */
1219         ACL_LEVEL_MASK = 0x000f,
1220         ACL_QUALIFIER1 = 0x0100,
1221         ACL_QUALIFIER2 = 0x0200,
1222         ACL_QUALIFIER3 = 0x0400,
1223         ACL_QUALIFIER4 = 0x0800,
1224         ACL_QUALIFIER_MASK = 0x0f00,
1225
1226         /* write granularity */
1227         ACL_WADD = ACL_WRITE|ACL_QUALIFIER1,
1228         ACL_WDEL = ACL_WRITE|ACL_QUALIFIER2
1229 } slap_access_t;
1230
1231 typedef enum slap_control_e {
1232         ACL_INVALID_CONTROL     = 0,
1233         ACL_STOP,
1234         ACL_CONTINUE,
1235         ACL_BREAK
1236 } slap_control_t;
1237
1238 typedef enum slap_style_e {
1239         ACL_STYLE_REGEX = 0,
1240         ACL_STYLE_EXPAND,
1241         ACL_STYLE_BASE,
1242         ACL_STYLE_ONE,
1243         ACL_STYLE_SUBTREE,
1244         ACL_STYLE_CHILDREN,
1245         ACL_STYLE_LEVEL,
1246         ACL_STYLE_ATTROF,
1247         ACL_STYLE_ANONYMOUS,
1248         ACL_STYLE_USERS,
1249         ACL_STYLE_SELF,
1250         ACL_STYLE_IP,
1251         ACL_STYLE_PATH
1252 } slap_style_t;
1253
1254 typedef struct slap_authz_info {
1255         ber_tag_t       sai_method;                     /* LDAP_AUTH_* from <ldap.h> */
1256         struct berval   sai_mech;               /* SASL Mechanism */
1257         struct berval   sai_dn;                 /* DN for reporting purposes */
1258         struct berval   sai_ndn;                /* Normalized DN */
1259
1260         /* Security Strength Factors */
1261         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1262         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1263         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1264         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1265 } AuthorizationInformation;
1266
1267
1268 #ifdef SLAP_DYNACL
1269 struct slap_op;
1270
1271 /*
1272  * "dynamic" ACL infrastructure (for ACIs and more)
1273  */
1274 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1275         const char *opts, slap_style_t, const char *, void **privp ));
1276 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1277 typedef int (slap_dynacl_mask) LDAP_P((
1278                 void                    *priv,
1279                 struct slap_op          *op,
1280                 Entry                   *e,
1281                 AttributeDescription    *desc,
1282                 struct berval           *val,
1283                 int                     nmatch,
1284                 regmatch_t              *matches,
1285                 slap_access_t           *grant,
1286                 slap_access_t           *deny ));
1287 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1288
1289 typedef struct slap_dynacl_t {
1290         char                    *da_name;
1291         slap_dynacl_parse       *da_parse;
1292         slap_dynacl_unparse     *da_unparse;
1293         slap_dynacl_mask        *da_mask;
1294         slap_dynacl_destroy     *da_destroy;
1295
1296         void                    *da_private;
1297         struct slap_dynacl_t    *da_next;
1298 } slap_dynacl_t;
1299 #endif /* SLAP_DYNACL */
1300
1301 /* the DN portion of the "by" part */
1302 typedef struct slap_dn_access {
1303         /* DN pattern */
1304         AuthorizationInformation        a_dnauthz;
1305 #define a_pat                   a_dnauthz.sai_dn
1306
1307         slap_style_t            a_style;
1308         int                     a_level;
1309         int                     a_self_level;
1310         AttributeDescription    *a_at;
1311         int                     a_self;
1312         int                     a_expand;
1313 } slap_dn_access;
1314
1315 /* the "by" part */
1316 typedef struct slap_access {
1317         slap_control_t a_type;
1318
1319 /* strip qualifiers */
1320 #define ACL_LEVEL(p)                    ((p) & ACL_LEVEL_MASK)
1321 #define ACL_QUALIFIERS(p)               ((p) & ~ACL_LEVEL_MASK)
1322
1323 #define ACL_ACCESS2PRIV(access)         ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1324
1325 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1326 #define ACL_PRIV_DISCLOSE               ACL_ACCESS2PRIV( ACL_DISCLOSE )
1327 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1328 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1329 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1330 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1331 #define ACL_PRIV_WADD                   ACL_ACCESS2PRIV( ACL_WADD )
1332 #define ACL_PRIV_WDEL                   ACL_ACCESS2PRIV( ACL_WDEL )
1333 #define ACL_PRIV_WRITE                  ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1334 #define ACL_PRIV_MANAGE                 ACL_ACCESS2PRIV( ACL_MANAGE )
1335
1336 /* NOTE: always use the highest level; current: 0x00ffUL */
1337 #define ACL_PRIV_MASK                   ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1338
1339 /* priv flags */
1340 #define ACL_PRIV_LEVEL                  0x1000UL
1341 #define ACL_PRIV_ADDITIVE               0x2000UL
1342 #define ACL_PRIV_SUBSTRACTIVE           0x4000UL
1343
1344 /* invalid privs */
1345 #define ACL_PRIV_INVALID                0x0UL
1346
1347 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1348 #define ACL_PRIV_ASSIGN(m,p)            do { (m)  =  (p); } while(0)
1349 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1350 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1351
1352 #define ACL_INIT(m)                     ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1353 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1354
1355 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1356
1357 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1358
1359 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1360 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1361 #define ACL_IS_SUBTRACTIVE(m)           ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1362
1363 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1364 #define ACL_LVL_DISCLOSE                (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1365 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1366 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1367 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1368 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1369 #define ACL_LVL_WADD                    (ACL_PRIV_WADD|ACL_LVL_READ)
1370 #define ACL_LVL_WDEL                    (ACL_PRIV_WDEL|ACL_LVL_READ)
1371 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1372 #define ACL_LVL_MANAGE                  (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1373
1374 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1375 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1376 #define ACL_LVL_IS_DISCLOSE(m)          ACL_LVL((m),ACL_LVL_DISCLOSE)
1377 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1378 #define ACL_LVL_IS_COMPARE(m)           ACL_LVL((m),ACL_LVL_COMPARE)
1379 #define ACL_LVL_IS_SEARCH(m)            ACL_LVL((m),ACL_LVL_SEARCH)
1380 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1381 #define ACL_LVL_IS_WADD(m)              ACL_LVL((m),ACL_LVL_WADD)
1382 #define ACL_LVL_IS_WDEL(m)              ACL_LVL((m),ACL_LVL_WDEL)
1383 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1384 #define ACL_LVL_IS_MANAGE(m)            ACL_LVL((m),ACL_LVL_MANAGE)
1385
1386 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1387 #define ACL_LVL_ASSIGN_DISCLOSE(m)      ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1388 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1389 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1390 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1391 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1392 #define ACL_LVL_ASSIGN_WADD(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1393 #define ACL_LVL_ASSIGN_WDEL(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1394 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1395 #define ACL_LVL_ASSIGN_MANAGE(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1396
1397         slap_mask_t     a_access_mask;
1398
1399         /* DN pattern */
1400         slap_dn_access          a_dn;
1401 #define a_dn_pat                a_dn.a_dnauthz.sai_dn
1402 #define a_dn_at                 a_dn.a_at
1403 #define a_dn_self               a_dn.a_self
1404
1405         /* real DN pattern */
1406         slap_dn_access          a_realdn;
1407 #define a_realdn_pat            a_realdn.a_dnauthz.sai_dn
1408 #define a_realdn_at             a_realdn.a_at
1409 #define a_realdn_self           a_realdn.a_self
1410
1411         /* used for ssf stuff
1412          * NOTE: the ssf stuff in a_realdn is ignored */
1413 #define a_authz                 a_dn.a_dnauthz
1414
1415         /* connection related stuff */
1416         slap_style_t a_peername_style;
1417         struct berval   a_peername_pat;
1418         unsigned long   a_peername_addr,
1419                         a_peername_mask;
1420         int             a_peername_port;
1421
1422         slap_style_t a_sockname_style;
1423         struct berval   a_sockname_pat;
1424
1425         slap_style_t a_domain_style;
1426         struct berval   a_domain_pat;
1427         int             a_domain_expand;
1428
1429         slap_style_t a_sockurl_style;
1430         struct berval   a_sockurl_pat;
1431         slap_style_t a_set_style;
1432         struct berval   a_set_pat;
1433
1434 #ifdef SLAP_DYNACL
1435         slap_dynacl_t           *a_dynacl;
1436 #else /* ! SLAP_DYNACL */
1437 #ifdef SLAPD_ACI_ENABLED
1438         /* NOTE: ACIs have been moved under the "dynacl" interface,
1439          * which is currently built only when LDAP_DEVEL is defined.
1440          *
1441          * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1442          * is required to enable ACI support.
1443          */
1444         AttributeDescription    *a_aci_at;
1445 #endif /* SLAPD_ACI_ENABLED */
1446 #endif /* SLAP_DYNACL */
1447
1448         /* ACL Groups */
1449         slap_style_t a_group_style;
1450         struct berval   a_group_pat;
1451         ObjectClass                             *a_group_oc;
1452         AttributeDescription    *a_group_at;
1453
1454         struct slap_access      *a_next;
1455 } Access;
1456
1457 /* the "to" part */
1458 typedef struct slap_acl {
1459         /* "to" part: the entries this acl applies to */
1460         Filter          *acl_filter;
1461         slap_style_t acl_dn_style;
1462         regex_t         acl_dn_re;
1463         struct berval   acl_dn_pat;
1464         AttributeName   *acl_attrs;
1465         MatchingRule    *acl_attrval_mr;
1466         slap_style_t    acl_attrval_style;
1467         regex_t         acl_attrval_re;
1468         struct berval   acl_attrval;
1469
1470         /* "by" part: list of who has what access to the entries */
1471         Access  *acl_access;
1472
1473         struct slap_acl *acl_next;
1474 } AccessControl;
1475
1476 typedef struct slap_acl_state {
1477         unsigned as_recorded;
1478 #define ACL_STATE_NOT_RECORDED                  0x0
1479 #define ACL_STATE_RECORDED_VD                   0x1
1480 #define ACL_STATE_RECORDED_NV                   0x2
1481 #define ACL_STATE_RECORDED                              0x3
1482
1483         /* Access state */
1484         AccessControl *as_vd_acl;
1485         AccessControl *as_vi_acl;
1486         slap_mask_t as_vd_acl_mask;
1487         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1488         int as_vd_acl_count;
1489
1490         Access *as_vd_access;
1491         int as_vd_access_count;
1492
1493         int as_result;
1494         AttributeDescription *as_vd_ad;
1495 } AccessControlState;
1496 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1497         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1498
1499 #ifdef SLAPD_ACI_ENABLED
1500 typedef enum slap_aci_scope_t {
1501         SLAP_ACI_SCOPE_ENTRY            = 0x1,
1502         SLAP_ACI_SCOPE_CHILDREN         = 0x2,
1503         SLAP_ACI_SCOPE_SUBTREE          = ( SLAP_ACI_SCOPE_ENTRY | SLAP_ACI_SCOPE_CHILDREN )
1504 } slap_aci_scope_t;
1505 #endif /* SLAPD_ACI_ENABLED */
1506
1507 enum {
1508         ACI_BV_ENTRY,
1509         ACI_BV_CHILDREN,
1510         ACI_BV_ONELEVEL,
1511         ACI_BV_SUBTREE,
1512         ACI_BV_BR_ENTRY,
1513         ACI_BV_BR_ALL,
1514         ACI_BV_ACCESS_ID,
1515 #if 0
1516         ACI_BV_ANONYMOUS        = BER_BVC("anonymous"),
1517 #endif
1518         ACI_BV_PUBLIC,
1519         ACI_BV_USERS,
1520         ACI_BV_SELF,
1521         ACI_BV_DNATTR,
1522         ACI_BV_GROUP,
1523         ACI_BV_ROLE,
1524         ACI_BV_SET,
1525         ACI_BV_SET_REF,
1526         ACI_BV_GRANT,
1527         ACI_BV_DENY,
1528
1529         ACI_BV_IP_EQ,
1530 #ifdef LDAP_PF_LOCAL
1531         ACI_BV_PATH_EQ,
1532 #if 0
1533         ACI_BV_DIRSEP,
1534 #endif
1535 #endif /* LDAP_PF_LOCAL */
1536
1537         ACI_BV_GROUP_CLASS,
1538         ACI_BV_GROUP_ATTR,
1539         ACI_BV_ROLE_CLASS,
1540         ACI_BV_ROLE_ATTR,
1541         ACI_BV_SET_ATTR,
1542
1543         ACI_BV_LAST
1544 };
1545
1546 /*
1547  * Backend-info
1548  * represents a backend
1549  */
1550
1551 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1552 typedef struct slap_backend_db BackendDB;               /* per backend database */
1553 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1554 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1555
1556 LDAP_SLAPD_V (int) nBackendInfo;
1557 LDAP_SLAPD_V (int) nBackendDB;
1558 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1559 LDAP_SLAPD_V (slap_be_head) backendDB;
1560 LDAP_SLAPD_V (BackendDB *) frontendDB;
1561
1562 LDAP_SLAPD_V (int) slapMode;
1563 #define SLAP_UNDEFINED_MODE     0x0000
1564 #define SLAP_SERVER_MODE        0x0001
1565 #define SLAP_TOOL_MODE          0x0002
1566 #define SLAP_MODE                       0x0003
1567
1568 #define SLAP_TRUNCATE_MODE      0x0100
1569 #define SLAP_TOOL_READMAIN      0x0200
1570 #define SLAP_TOOL_READONLY      0x0400
1571 #define SLAP_TOOL_QUICK         0x0800
1572
1573 #define SB_TLS_DEFAULT          (-1)
1574 #define SB_TLS_OFF              0
1575 #define SB_TLS_ON               1
1576 #define SB_TLS_CRITICAL         2
1577
1578 typedef struct slap_bindconf {
1579         int sb_tls;
1580         int sb_method;
1581         struct berval sb_binddn;
1582         struct berval sb_cred;
1583         struct berval sb_saslmech;
1584         char *sb_secprops;
1585         struct berval sb_realm;
1586         struct berval sb_authcId;
1587         struct berval sb_authzId;
1588 } slap_bindconf;
1589
1590 struct slap_replica_info {
1591         const char *ri_uri;                     /* supersedes be_replica */
1592         const char *ri_host;            /* points to host part of uri */
1593         BerVarray ri_nsuffix;           /* array of suffixes this replica accepts */
1594         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1595         int ri_exclude;                         /* 1 => exclude ri_attrs */
1596         slap_bindconf ri_bindconf;      /* for back-config */
1597 };
1598
1599 typedef struct slap_verbmasks {
1600         struct berval word;
1601         const slap_mask_t mask;
1602 } slap_verbmasks;
1603
1604 #define SLAP_LIMIT_TIME 1
1605 #define SLAP_LIMIT_SIZE 2
1606
1607 struct slap_limits_set {
1608         /* time limits */
1609         int     lms_t_soft;
1610         int     lms_t_hard;
1611
1612         /* size limits */
1613         int     lms_s_soft;
1614         int     lms_s_hard;
1615         int     lms_s_unchecked;
1616         int     lms_s_pr;
1617         int     lms_s_pr_hide;
1618         int     lms_s_pr_total;
1619 };
1620
1621 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1622 #define SLAP_NO_LIMIT                   -1
1623 #define SLAP_MAX_LIMIT                  2147483647
1624
1625 struct slap_limits {
1626         unsigned                lm_flags;       /* type of pattern */
1627 #define SLAP_LIMITS_UNDEFINED           0x0000U
1628 #define SLAP_LIMITS_EXACT               0x0001U
1629 #define SLAP_LIMITS_BASE                SLAP_LIMITS_EXACT
1630 #define SLAP_LIMITS_ONE                 0x0002U
1631 #define SLAP_LIMITS_SUBTREE             0x0003U
1632 #define SLAP_LIMITS_CHILDREN            0x0004U
1633 #define SLAP_LIMITS_REGEX               0x0005U
1634 #define SLAP_LIMITS_ANONYMOUS           0x0006U
1635 #define SLAP_LIMITS_USERS               0x0007U
1636 #define SLAP_LIMITS_ANY                 0x0008U
1637 #define SLAP_LIMITS_MASK                0x000FU
1638
1639 #define SLAP_LIMITS_TYPE_DN             0x0000U
1640 #define SLAP_LIMITS_TYPE_GROUP          0x0010U
1641 #define SLAP_LIMITS_TYPE_MASK           0x00F0U
1642
1643         regex_t                 lm_regex;       /* regex data for REGEX */
1644
1645         /*
1646          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1647          * pattern for REGEX; NULL for ANONYMOUS, USERS
1648          */
1649         struct berval           lm_pat;
1650
1651         /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1652          * lm_group_oc is objectClass and lm_group_at is attributeType
1653          * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1654          * can only be SLAP_LIMITS_EXACT */
1655         ObjectClass             *lm_group_oc;
1656         AttributeDescription    *lm_group_ad;
1657
1658         struct slap_limits_set  lm_limits;
1659 };
1660
1661 /* temporary aliases */
1662 typedef BackendDB Backend;
1663 #define nbackends nBackendDB
1664 #define backends backendDB
1665
1666 /*
1667  * syncinfo structure for syncrepl
1668  */
1669
1670 struct syncinfo_s;
1671
1672 #define SLAP_SYNC_RID_SIZE      3
1673 #define SLAP_SYNCUUID_SET_SIZE 256
1674
1675 #define SLAP_SYNC_UPDATE_MSGID  2
1676
1677 struct sync_cookie {
1678         struct berval ctxcsn;
1679         struct berval octet_str;
1680         long rid;
1681         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1682 };
1683
1684 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1685
1686 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1687
1688 #ifndef SLAP_MAX_CIDS
1689 #define SLAP_MAX_CIDS   32      /* Maximum number of supported controls */
1690 #endif
1691
1692 struct ConfigOCs;       /* config.h */
1693
1694 struct slap_backend_db {
1695         BackendInfo     *bd_info;       /* pointer to shared backend info */
1696
1697         /* fields in this structure (and routines acting on this structure)
1698            should be renamed from be_ to bd_ */
1699
1700         /* BackendInfo accessors */
1701 #define         be_config       bd_info->bi_db_config
1702 #define         be_type         bd_info->bi_type
1703
1704 #define         be_bind         bd_info->bi_op_bind
1705 #define         be_unbind       bd_info->bi_op_unbind
1706 #define         be_add          bd_info->bi_op_add
1707 #define         be_compare      bd_info->bi_op_compare
1708 #define         be_delete       bd_info->bi_op_delete
1709 #define         be_modify       bd_info->bi_op_modify
1710 #define         be_modrdn       bd_info->bi_op_modrdn
1711 #define         be_search       bd_info->bi_op_search
1712 #define         be_abandon      bd_info->bi_op_abandon
1713 #define         be_cancel       bd_info->bi_op_cancel
1714
1715 #define         be_extended     bd_info->bi_extended
1716
1717 #define         be_chk_referrals        bd_info->bi_chk_referrals
1718 #define         be_chk_controls         bd_info->bi_chk_controls
1719 #define         be_fetch        bd_info->bi_entry_get_rw
1720 #define         be_release      bd_info->bi_entry_release_rw
1721 #define         be_group        bd_info->bi_acl_group
1722 #define         be_attribute    bd_info->bi_acl_attribute
1723 #define         be_operational  bd_info->bi_operational
1724
1725 /*
1726  * define to honor hasSubordinates operational attribute in search filters
1727  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1728  * is fixed).
1729  */
1730 #define         be_has_subordinates bd_info->bi_has_subordinates
1731
1732 #define         be_connection_init      bd_info->bi_connection_init
1733 #define         be_connection_destroy   bd_info->bi_connection_destroy
1734
1735 #ifdef SLAPD_TOOLS
1736 #define         be_entry_open bd_info->bi_tool_entry_open
1737 #define         be_entry_close bd_info->bi_tool_entry_close
1738 #define         be_entry_first bd_info->bi_tool_entry_first
1739 #define         be_entry_next bd_info->bi_tool_entry_next
1740 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1741 #define         be_entry_get bd_info->bi_tool_entry_get
1742 #define         be_entry_put bd_info->bi_tool_entry_put
1743 #define         be_sync bd_info->bi_tool_sync
1744 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1745 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1746 #define         be_entry_modify bd_info->bi_tool_entry_modify
1747 #endif
1748
1749         /* supported controls */
1750         /* note: set to 0 if the database does not support the control;
1751          * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1752         char            be_ctrls[SLAP_MAX_CIDS + 1];
1753
1754 /* Database flags */
1755 #define SLAP_DBFLAG_NOLASTMOD           0x0001U
1756 #define SLAP_DBFLAG_NO_SCHEMA_CHECK     0x0002U
1757 #define SLAP_DBFLAG_GLUE_INSTANCE       0x0010U /* a glue backend */
1758 #define SLAP_DBFLAG_GLUE_SUBORDINATE    0x0020U /* child of a glue hierarchy */
1759 #define SLAP_DBFLAG_GLUE_LINKED         0x0040U /* child is connected to parent */
1760 #define SLAP_DBFLAG_GLUE_ADVERTISE      0x0080U /* advertise in rootDSE */
1761 #define SLAP_DBFLAG_OVERLAY             0x0100U /* this db struct is an overlay */
1762 #define SLAP_DBFLAG_GLOBAL_OVERLAY      0x0200U /* this db struct is a global overlay */
1763 #define SLAP_DBFLAG_SHADOW              0x8000U /* a shadow */
1764 #define SLAP_DBFLAG_SYNC_SHADOW         0x1000U /* a sync shadow */
1765 #define SLAP_DBFLAG_SLURP_SHADOW        0x2000U /* a slurp shadow */
1766         slap_mask_t     be_flags;
1767 #define SLAP_DBFLAGS(be)                        ((be)->be_flags)
1768 #define SLAP_NOLASTMOD(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1769 #define SLAP_LASTMOD(be)                        (!SLAP_NOLASTMOD(be))
1770 #define SLAP_ISOVERLAY(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1771 #define SLAP_NO_SCHEMA_CHECK(be)        \
1772         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1773 #define SLAP_GLUE_INSTANCE(be)          \
1774         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1775 #define SLAP_GLUE_SUBORDINATE(be)       \
1776         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1777 #define SLAP_GLUE_LINKED(be)            \
1778         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1779 #define SLAP_GLUE_ADVERTISE(be) \
1780         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1781 #define SLAP_SHADOW(be)                         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1782 #define SLAP_SYNC_SHADOW(be)                    (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1783 #define SLAP_SLURP_SHADOW(be)                   (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1784
1785         slap_mask_t     be_restrictops;         /* restriction operations */
1786 #define SLAP_RESTRICT_OP_ADD            0x0001U
1787 #define SLAP_RESTRICT_OP_BIND           0x0002U
1788 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1789 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1790 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1791 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1792 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1793 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1794 #define SLAP_RESTRICT_OP_MASK           0x00FFU
1795
1796 #define SLAP_RESTRICT_READONLY          0x80000000U
1797
1798 #define SLAP_RESTRICT_EXOP_START_TLS            0x0100U
1799 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD        0x0200U
1800 #define SLAP_RESTRICT_EXOP_WHOAMI               0x0400U
1801 #define SLAP_RESTRICT_EXOP_CANCEL               0x0800U
1802 #define SLAP_RESTRICT_EXOP_MASK                 0xFF00U
1803
1804 #define SLAP_RESTRICT_OP_READS  \
1805         ( SLAP_RESTRICT_OP_COMPARE      \
1806         | SLAP_RESTRICT_OP_SEARCH )
1807 #define SLAP_RESTRICT_OP_WRITES \
1808         ( SLAP_RESTRICT_OP_ADD    \
1809         | SLAP_RESTRICT_OP_DELETE \
1810         | SLAP_RESTRICT_OP_MODIFY \
1811         | SLAP_RESTRICT_OP_RENAME )
1812
1813 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1814 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1815 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1816
1817 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1818
1819 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1820 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1821 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1822
1823 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1824 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1825
1826 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1827
1828         slap_mask_t     be_requires;    /* pre-operation requirements */
1829 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1830 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1831 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1832 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1833 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1834
1835         /* Required Security Strength Factor */
1836         slap_ssf_set_t be_ssf_set;
1837
1838         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1839         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1840         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1841         struct berval be_schemandn;     /* normalized subschema DN */
1842         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1843         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1844         struct berval be_rootpw;        /* the magic "root" password for this db        */
1845         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1846 #define be_sizelimit    be_def_limit.lms_s_soft
1847 #define be_timelimit    be_def_limit.lms_t_soft
1848         struct slap_limits_set be_def_limit; /* default limits */
1849         struct slap_limits **be_limits; /* regex-based size and time limits */
1850         AccessControl *be_acl;  /* access control list for this backend    */
1851         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1852
1853         /* Replica Information */
1854         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1855         char    *be_replogfile; /* replication log file (in master)        */
1856         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1857         BerVarray       be_update_refs; /* where to refer modifying clients to */
1858         struct          be_pcl  *be_pending_csn_list;
1859         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1860         ldap_pvt_thread_mutex_t                                 *be_pcl_mutexp;
1861         struct syncinfo_s                                               *be_syncinfo; /* For syncrepl */
1862
1863         void    *be_pb;         /* Netscape plugin */
1864         struct ConfigOCs *be_cf_ocs;
1865
1866         void    *be_private;    /* anything the backend database needs     */
1867         LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1868 };
1869
1870 struct slap_conn;
1871 struct slap_op;
1872
1873 /* Backend function typedefs */
1874 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1875 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1876         const char *fname, int lineno,
1877         int argc, char **argv));
1878 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1879 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1880 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1881
1882 typedef int (BI_db_init) LDAP_P((Backend *bd));
1883 typedef int (BI_db_config) LDAP_P((Backend *bd,
1884         const char *fname, int lineno,
1885         int argc, char **argv));
1886 typedef int (BI_db_open) LDAP_P((Backend *bd));
1887 typedef int (BI_db_close) LDAP_P((Backend *bd));
1888 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1889
1890 typedef struct req_bind_s {
1891         int rb_method;
1892         struct berval rb_cred;
1893         struct berval rb_edn;
1894         slap_ssf_t rb_ssf;
1895         struct berval rb_tmp_mech;      /* FIXME: temporary */
1896 } req_bind_s;
1897
1898 typedef struct req_search_s {
1899         int rs_scope;
1900         int rs_deref;
1901         int rs_slimit;
1902         int rs_tlimit;
1903         /* NULL means be_isroot evaluated to TRUE */
1904         struct slap_limits_set *rs_limit;
1905         int rs_attrsonly;
1906         AttributeName *rs_attrs;
1907         Filter *rs_filter;
1908         struct berval rs_filterstr;
1909 } req_search_s;
1910
1911 typedef struct req_compare_s {
1912         AttributeAssertion *rs_ava;
1913 } req_compare_s;
1914
1915 typedef struct req_modify_s {
1916         Modifications *rs_modlist;
1917         int rs_increment;               /* FIXME: temporary */
1918 } req_modify_s;
1919
1920 typedef struct req_modrdn_s {
1921         struct berval rs_newrdn;
1922         struct berval rs_nnewrdn;
1923         struct berval *rs_newSup;
1924         struct berval *rs_nnewSup;
1925         int rs_deleteoldrdn;
1926 } req_modrdn_s;
1927
1928 typedef struct req_add_s {
1929         Entry *rs_e;
1930         Modifications *rs_modlist;      /* FIXME: temporary */
1931 } req_add_s;
1932
1933 typedef struct req_abandon_s {
1934         ber_int_t rs_msgid;
1935 } req_abandon_s;
1936
1937 #ifdef LDAP_DEVEL
1938 #define SLAP_EXOP_HIDE 0x0000
1939 #else
1940 #define SLAP_EXOP_HIDE 0x8000
1941 #endif
1942 #define SLAP_EXOP_WRITES 0x0001         /* Exop does writes */
1943
1944 typedef struct req_extended_s {
1945         struct berval rs_reqoid;
1946         int rs_flags;
1947         struct berval *rs_reqdata;
1948 } req_extended_s;
1949
1950 typedef struct req_pwdexop_s {
1951         struct berval rs_reqoid;
1952         int rs_flags;
1953         struct berval rs_old;
1954         struct berval rs_new;
1955         Modifications *rs_mods;
1956         Modifications **rs_modtail;
1957 } req_pwdexop_s;
1958
1959 typedef enum slap_reply_e {
1960         REP_RESULT,
1961         REP_SASL,
1962         REP_EXTENDED,
1963         REP_SEARCH,
1964         REP_SEARCHREF,
1965         REP_INTERMEDIATE
1966 } slap_reply_t;
1967
1968 typedef struct rep_sasl_s {
1969         struct berval *r_sasldata;
1970 } rep_sasl_s;
1971
1972 typedef struct rep_extended_s {
1973         const char *r_rspoid;
1974         struct berval *r_rspdata;
1975 } rep_extended_s;
1976
1977 typedef struct rep_search_s {
1978         Entry *r_entry;
1979         slap_mask_t r_attr_flags;
1980 #define SLAP_ATTRS_UNDEFINED    (0x00U)
1981 #define SLAP_OPATTRS_NO                 (0x01U)
1982 #define SLAP_OPATTRS_YES                (0x02U)
1983 #define SLAP_USERATTRS_NO               (0x10U)
1984 #define SLAP_USERATTRS_YES              (0x20U)
1985 #define SLAP_OPATTRS_MASK(f)    ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1986 #define SLAP_OPATTRS(f)                 (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1987 #define SLAP_USERATTRS_MASK(f)  ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1988 #define SLAP_USERATTRS(f)               \
1989         (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1990
1991         Attribute *r_operational_attrs;
1992         AttributeName *r_attrs;
1993         int r_nentries;
1994         BerVarray r_v2ref;
1995 } rep_search_s;
1996
1997 typedef struct slap_rep {
1998         slap_reply_t sr_type;
1999         ber_tag_t sr_tag;
2000         ber_int_t sr_msgid;
2001         ber_int_t sr_err;
2002         const char *sr_matched;
2003         const char *sr_text;
2004         BerVarray sr_ref;
2005         LDAPControl **sr_ctrls;
2006         union sr_u {
2007                 rep_sasl_s sru_sasl;
2008                 rep_extended_s sru_extended;
2009                 rep_search_s sru_search;
2010         } sr_un;
2011         slap_mask_t sr_flags;
2012 #define REP_ENTRY_MODIFIABLE    0x0001U
2013 #define REP_ENTRY_MUSTBEFREED   0x0002U
2014 #define REP_ENTRY_MUSTRELEASE   0x0004U
2015 #define REP_MATCHED_MUSTBEFREED 0x0010U
2016 #define REP_REF_MUSTBEFREED             0x0020U
2017 } SlapReply;
2018
2019 /* short hands for response members */
2020 #define sr_attrs sr_un.sru_search.r_attrs
2021 #define sr_entry sr_un.sru_search.r_entry
2022 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2023 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2024 #define sr_v2ref sr_un.sru_search.r_v2ref
2025 #define sr_nentries sr_un.sru_search.r_nentries
2026 #define sr_rspoid sr_un.sru_extended.r_rspoid
2027 #define sr_rspdata sr_un.sru_extended.r_rspdata
2028 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2029
2030 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2031 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2032 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2033 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2034 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2035 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2036 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2037 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2038 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2039 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2040 typedef int (BI_op_extended) LDAP_P((
2041         struct slap_op *op, struct slap_rep *rs ));
2042 typedef int (BI_chk_referrals) LDAP_P((
2043         struct slap_op *op, struct slap_rep *rs ));
2044 typedef int (BI_chk_controls) LDAP_P((
2045         struct slap_op *op, struct slap_rep *rs ));
2046 typedef int (BI_entry_release_rw)
2047         LDAP_P(( struct slap_op *op, Entry *e, int rw ));
2048 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
2049         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2050 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2051 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
2052         Entry *e, int *hasSubs ));
2053 #ifdef SLAP_OVERLAY_ACCESS
2054 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
2055         AttributeDescription *desc, struct berval *val, slap_access_t access,
2056         AccessControlState *state, slap_mask_t *maskp ));
2057 typedef int (BI_acl_group) LDAP_P(( struct slap_op *op, Entry *target,
2058         struct berval *gr_ndn, struct berval *op_ndn,
2059         ObjectClass *group_oc, AttributeDescription *group_at ));
2060 typedef int (BI_acl_attribute) LDAP_P(( struct slap_op *op, Entry *target,
2061         struct berval *entry_ndn, AttributeDescription *entry_at,
2062         BerVarray *vals, slap_access_t access ));
2063 #endif /* SLAP_OVERLAY_ACCESS */
2064
2065 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
2066         struct slap_conn *c ));
2067 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
2068         struct slap_conn *c ));
2069
2070 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2071 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2072 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2073 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2074 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2075 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2076         struct berval *text ));
2077 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
2078 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2079 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2080 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
2081 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2082         struct berval *text ));
2083
2084 struct slap_backend_info {
2085         char    *bi_type; /* type of backend */
2086
2087         /*
2088          * per backend type routines:
2089          * bi_init: called to allocate a backend_info structure,
2090          *              called once BEFORE configuration file is read.
2091          *              bi_init() initializes this structure hence is
2092          *              called directly from be_initialize()
2093          * bi_config: called per 'backend' specific option
2094          *              all such options must before any 'database' options
2095          *              bi_config() is called only from read_config()
2096          * bi_open: called to open each database, called
2097          *              once AFTER configuration file is read but
2098          *              BEFORE any bi_db_open() calls.
2099          *              bi_open() is called from backend_startup()
2100          * bi_close: called to close each database, called
2101          *              once during shutdown after all bi_db_close calls.
2102          *              bi_close() is called from backend_shutdown()
2103          * bi_destroy: called to destroy each database, called
2104          *              once during shutdown after all bi_db_destroy calls.
2105          *              bi_destory() is called from backend_destroy()
2106          */
2107         BI_init *bi_init;
2108         BI_config       *bi_config;
2109         BI_open *bi_open;
2110         BI_close        *bi_close;
2111         BI_destroy      *bi_destroy;
2112
2113         /*
2114          * per database routines:
2115          * bi_db_init: called to initialize each database,
2116          *      called upon reading 'database <type>'
2117          *      called only from backend_db_init()
2118          * bi_db_config: called to configure each database,
2119          *  called per database to handle per database options
2120          *      called only from read_config()
2121          * bi_db_open: called to open each database
2122          *      called once per database immediately AFTER bi_open()
2123          *      calls but before daemon startup.
2124          *  called only by backend_startup()
2125          * bi_db_close: called to close each database
2126          *      called once per database during shutdown but BEFORE
2127          *  any bi_close call.
2128          *  called only by backend_shutdown()
2129          * bi_db_destroy: called to destroy each database
2130          *  called once per database during shutdown AFTER all
2131          *  bi_close calls but before bi_destory calls.
2132          *  called only by backend_destory()
2133          */
2134         BI_db_init      *bi_db_init;
2135         BI_db_config    *bi_db_config;
2136         BI_db_open      *bi_db_open;
2137         BI_db_close     *bi_db_close;
2138         BI_db_destroy   *bi_db_destroy;
2139
2140         /* LDAP Operations Handling Routines */
2141         BI_op_bind      *bi_op_bind;
2142         BI_op_unbind    *bi_op_unbind;
2143         BI_op_search    *bi_op_search;
2144         BI_op_compare   *bi_op_compare;
2145         BI_op_modify    *bi_op_modify;
2146         BI_op_modrdn    *bi_op_modrdn;
2147         BI_op_add       *bi_op_add;
2148         BI_op_delete    *bi_op_delete;
2149         BI_op_abandon   *bi_op_abandon;
2150         BI_op_cancel    *bi_op_cancel;
2151
2152         /* Extended Operations Helper */
2153         BI_op_extended  *bi_extended;
2154
2155         /* Auxilary Functions */
2156         BI_operational          *bi_operational;
2157         BI_chk_referrals        *bi_chk_referrals;
2158         BI_chk_controls         *bi_chk_controls;
2159         BI_entry_get_rw         *bi_entry_get_rw;
2160         BI_entry_release_rw     *bi_entry_release_rw;
2161
2162         BI_has_subordinates     *bi_has_subordinates;
2163 #ifdef SLAP_OVERLAY_ACCESS
2164         BI_access_allowed       *bi_access_allowed;
2165         BI_acl_group            *bi_acl_group;
2166         BI_acl_attribute        *bi_acl_attribute;
2167 #endif /* SLAP_OVERLAY_ACCESS */
2168
2169         BI_connection_init      *bi_connection_init;
2170         BI_connection_destroy   *bi_connection_destroy;
2171
2172         /* hooks for slap tools */
2173         BI_tool_entry_open      *bi_tool_entry_open;
2174         BI_tool_entry_close     *bi_tool_entry_close;
2175         BI_tool_entry_first     *bi_tool_entry_first;
2176         BI_tool_entry_next      *bi_tool_entry_next;
2177         BI_tool_entry_get       *bi_tool_entry_get;
2178         BI_tool_entry_put       *bi_tool_entry_put;
2179         BI_tool_entry_reindex   *bi_tool_entry_reindex;
2180         BI_tool_sync            *bi_tool_sync;
2181         BI_tool_dn2id_get       *bi_tool_dn2id_get;
2182         BI_tool_id2entry_get    *bi_tool_id2entry_get;
2183         BI_tool_entry_modify    *bi_tool_entry_modify;
2184
2185 #define SLAP_INDEX_ADD_OP               0x0001
2186 #define SLAP_INDEX_DELETE_OP    0x0002
2187
2188         slap_mask_t     bi_flags; /* backend flags */
2189 #define SLAP_BFLAG_MONITOR                      0x0001U /* a monitor backend */
2190 #define SLAP_BFLAG_CONFIG                       0x0002U /* a config backend */
2191 #define SLAP_BFLAG_FRONTEND                     0x0004U /* the frontendDB */
2192 #define SLAP_BFLAG_NOLASTMODCMD         0x0010U
2193 #define SLAP_BFLAG_INCREMENT            0x0100U
2194 #define SLAP_BFLAG_ALIASES                      0x1000U
2195 #define SLAP_BFLAG_REFERRALS            0x2000U
2196 #define SLAP_BFLAG_SUBENTRIES           0x4000U
2197 #define SLAP_BFLAG_DYNAMIC                      0x8000U
2198
2199 #define SLAP_BFLAGS(be)         ((be)->bd_info->bi_flags)
2200 #define SLAP_MONITOR(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2201 #define SLAP_CONFIG(be)         (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2202 #define SLAP_FRONTEND(be)       (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2203 #define SLAP_INCREMENT(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2204 #define SLAP_ALIASES(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2205 #define SLAP_REFERRALS(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2206 #define SLAP_SUBENTRIES(be)     (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2207 #define SLAP_DYNAMIC(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2208 #define SLAP_NOLASTMODCMD(be)   (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2209 #define SLAP_LASTMODCMD(be)     (!SLAP_NOLASTMODCMD(be))
2210
2211         char    **bi_controls;          /* supported controls */
2212         char    bi_ctrls[SLAP_MAX_CIDS + 1];
2213
2214         unsigned int bi_nDB;    /* number of databases of this type */
2215         struct ConfigOCs *bi_cf_ocs;
2216         void    *bi_private;    /* anything the backend type needs */
2217         LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2218 };
2219
2220 #define c_authtype      c_authz.sai_method
2221 #define c_authmech      c_authz.sai_mech
2222 #define c_dn            c_authz.sai_dn
2223 #define c_ndn           c_authz.sai_ndn
2224 #define c_ssf                   c_authz.sai_ssf
2225 #define c_transport_ssf c_authz.sai_transport_ssf
2226 #define c_tls_ssf               c_authz.sai_tls_ssf
2227 #define c_sasl_ssf              c_authz.sai_sasl_ssf
2228
2229 #define o_authtype      o_authz.sai_method
2230 #define o_authmech      o_authz.sai_mech
2231 #define o_dn            o_authz.sai_dn
2232 #define o_ndn           o_authz.sai_ndn
2233 #define o_ssf                   o_authz.sai_ssf
2234 #define o_transport_ssf o_authz.sai_transport_ssf
2235 #define o_tls_ssf               o_authz.sai_tls_ssf
2236 #define o_sasl_ssf              o_authz.sai_sasl_ssf
2237
2238 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2239
2240 typedef struct slap_callback {
2241         struct slap_callback *sc_next;
2242         slap_response *sc_response;
2243         slap_response *sc_cleanup;
2244         void *sc_private;
2245 } slap_callback;
2246
2247 struct slap_overinfo;
2248
2249 typedef enum slap_operation_e {
2250         op_bind = 0,
2251         op_unbind,
2252         op_search,
2253         op_compare,
2254         op_modify,
2255         op_modrdn,
2256         op_add,
2257         op_delete,
2258         op_abandon,
2259         op_cancel,
2260         op_extended,
2261         op_aux_operational,
2262         op_aux_chk_referrals,
2263         op_aux_chk_controls,
2264         op_last
2265 } slap_operation_t;
2266
2267 typedef struct slap_overinst {
2268         BackendInfo on_bi;
2269         slap_response *on_response;
2270         struct slap_overinfo *on_info;
2271         struct slap_overinst *on_next;
2272 } slap_overinst;
2273
2274 typedef struct slap_overinfo {
2275         BackendInfo oi_bi;
2276         BackendInfo *oi_orig;
2277         struct slap_overinst *oi_list;
2278 } slap_overinfo;
2279
2280 /* Should successive callbacks in a chain be processed? */
2281 #define SLAP_CB_FREEME          0x4000
2282 #define SLAP_CB_CONTINUE        0x8000
2283
2284 /*
2285  * Paged Results state
2286  */
2287 typedef unsigned long PagedResultsCookie;
2288 typedef struct slap_paged_state {
2289         Backend *ps_be;
2290         ber_int_t ps_size;
2291         PagedResultsCookie ps_cookie;
2292         int ps_count;
2293 } PagedResultsState;
2294
2295 struct slap_csn_entry {
2296         struct berval ce_csn;
2297         unsigned long ce_opid;
2298         unsigned long ce_connid;
2299 #define SLAP_CSN_PENDING        1
2300 #define SLAP_CSN_COMMIT         2
2301         long ce_state;
2302         LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2303 };
2304
2305 /*
2306  * Caches the result of a backend_group check for ACL evaluation
2307  */
2308 typedef struct slap_gacl {
2309         struct slap_gacl *ga_next;
2310         Backend *ga_be;
2311         ObjectClass *ga_oc;
2312         AttributeDescription *ga_at;
2313         int ga_res;
2314         ber_len_t ga_len;
2315         char ga_ndn[1];
2316 } GroupAssertion;
2317
2318 struct slap_control_ids {
2319         int sc_assert;
2320         int sc_preRead;
2321         int sc_postRead;
2322         int sc_proxyAuthz;
2323         int sc_manageDIT;
2324         int sc_manageDSAit;
2325         int sc_modifyIncrement;
2326         int sc_noOp;
2327         int sc_pagedResults;
2328 #ifdef LDAP_DEVEL
2329         int sc_sortedResults;
2330 #endif
2331         int sc_valuesReturnFilter;
2332         int sc_permissiveModify;
2333         int sc_domainScope;
2334         int sc_treeDelete;
2335         int sc_searchOptions;
2336         int sc_subentries;
2337         int sc_LDAPsync;
2338 };
2339
2340 /*
2341  * represents an operation pending from an ldap client
2342  */
2343 typedef struct slap_op_header {
2344         unsigned long oh_opid;  /* id of this operation */
2345         unsigned long oh_connid; /* id of conn initiating this op */
2346         struct slap_conn *oh_conn;      /* connection spawning this op */
2347
2348         ber_int_t       oh_msgid;       /* msgid of the request */
2349         ber_int_t       oh_protocol;    /* version of the LDAP protocol used by client */
2350
2351         ldap_pvt_thread_t       oh_tid; /* thread handling this op */
2352
2353         void    *oh_threadctx;          /* thread pool thread context */
2354         void    *oh_tmpmemctx;          /* slab malloc context */
2355         BerMemoryFunctions *oh_tmpmfuncs;
2356
2357         char            oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2358
2359 #ifdef LDAP_SLAPI
2360         void    *oh_extensions;         /* NS-SLAPI plugin */
2361 #endif
2362 } Opheader;
2363
2364 typedef struct slap_op {
2365         Opheader *o_hdr;
2366
2367 #define o_opid o_hdr->oh_opid
2368 #define o_connid o_hdr->oh_connid
2369 #define o_conn o_hdr->oh_conn
2370 #define o_msgid o_hdr->oh_msgid
2371 #define o_protocol o_hdr->oh_protocol
2372 #define o_tid o_hdr->oh_tid
2373 #define o_threadctx o_hdr->oh_threadctx
2374 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2375 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2376
2377 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2378 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2379 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2380 #define o_tmpfree       o_tmpmfuncs->bmf_free
2381
2382 #define o_log_prefix o_hdr->oh_log_prefix
2383
2384         ber_tag_t       o_tag;          /* tag of the request */
2385         time_t          o_time;         /* time op was initiated */
2386         int                     o_tincr;        /* counter for multiple ops with same o_time */
2387
2388         BackendDB       *o_bd;  /* backend DB processing this op */
2389         struct berval   o_req_dn;       /* DN of target of request */
2390         struct berval   o_req_ndn;
2391
2392         union o_req_u {
2393                 req_add_s oq_add;
2394                 req_bind_s oq_bind;
2395                 req_compare_s oq_compare;
2396                 req_modify_s oq_modify;
2397                 req_modrdn_s oq_modrdn;
2398                 req_search_s oq_search;
2399                 req_abandon_s oq_abandon;
2400                 req_abandon_s oq_cancel;
2401                 req_extended_s oq_extended;
2402                 req_pwdexop_s oq_pwdexop;
2403         } o_request;
2404
2405 /* short hands for union members */
2406 #define oq_add o_request.oq_add
2407 #define oq_bind o_request.oq_bind
2408 #define oq_compare o_request.oq_compare
2409 #define oq_modify o_request.oq_modify
2410 #define oq_modrdn o_request.oq_modrdn
2411 #define oq_search o_request.oq_search
2412 #define oq_abandon o_request.oq_abandon
2413 #define oq_cancel o_request.oq_cancel
2414 #define oq_extended o_request.oq_extended
2415 #define oq_pwdexop o_request.oq_pwdexop
2416
2417 /* short hands for inner request members */
2418 #define orb_method oq_bind.rb_method
2419 #define orb_cred oq_bind.rb_cred
2420 #define orb_edn oq_bind.rb_edn
2421 #define orb_ssf oq_bind.rb_ssf
2422 #define orb_tmp_mech oq_bind.rb_tmp_mech
2423
2424 #define ors_scope oq_search.rs_scope
2425 #define ors_deref oq_search.rs_deref
2426 #define ors_slimit oq_search.rs_slimit
2427 #define ors_tlimit oq_search.rs_tlimit
2428 #define ors_limit oq_search.rs_limit
2429 #define ors_attrsonly oq_search.rs_attrsonly
2430 #define ors_attrs oq_search.rs_attrs
2431 #define ors_filter oq_search.rs_filter
2432 #define ors_filterstr oq_search.rs_filterstr
2433
2434 #define orr_newrdn oq_modrdn.rs_newrdn
2435 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2436 #define orr_newSup oq_modrdn.rs_newSup
2437 #define orr_nnewSup oq_modrdn.rs_nnewSup
2438 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2439
2440 #define orc_ava oq_compare.rs_ava
2441 #define ora_e oq_add.rs_e
2442 #define ora_modlist oq_add.rs_modlist
2443 #define orn_msgid oq_abandon.rs_msgid
2444 #define orm_modlist oq_modify.rs_modlist
2445 #define orm_increment oq_modify.rs_increment
2446
2447 #define ore_reqoid oq_extended.rs_reqoid
2448 #define ore_flags oq_extended.rs_flags
2449 #define ore_reqdata oq_extended.rs_reqdata
2450         volatile sig_atomic_t o_abandon;        /* abandon flag */
2451         volatile sig_atomic_t o_cancel;         /* cancel flag */
2452 #define SLAP_CANCEL_NONE                                0x00
2453 #define SLAP_CANCEL_REQ                                 0x01
2454 #define SLAP_CANCEL_ACK                                 0x02
2455 #define SLAP_CANCEL_DONE                                0x03
2456
2457         GroupAssertion *o_groups;
2458         char o_do_not_cache;    /* don't cache groups from this op */
2459         char o_is_auth_check;   /* authorization in progress */
2460
2461         char o_nocaching;
2462         char o_delete_glue_parent;
2463         char o_no_schema_check;
2464 #define get_no_schema_check(op)                 ((op)->o_no_schema_check)
2465
2466 #define SLAP_CONTROL_NONE       0
2467 #define SLAP_CONTROL_IGNORED    1
2468 #define SLAP_CONTROL_NONCRITICAL 2
2469 #define SLAP_CONTROL_CRITICAL   3
2470 #define SLAP_CONTROL_MASK       3
2471
2472 /* spare bits for simple flags */
2473 #define SLAP_CONTROL_SHIFT      4       /* shift to reach data bits */
2474 #define SLAP_CONTROL_DATA0      0x10
2475 #define SLAP_CONTROL_DATA1      0x20
2476 #define SLAP_CONTROL_DATA2      0x40
2477 #define SLAP_CONTROL_DATA3      0x80
2478
2479
2480 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2481
2482         char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2483         void **o_controls;              /* per-control state */
2484
2485 #define o_managedit                             o_ctrlflag[slap_cids.sc_manageDIT]
2486 #define get_manageDIT(op)               _SCM((op)->o_managedit)
2487
2488 #define o_managedsait   o_ctrlflag[slap_cids.sc_manageDSAit]
2489 #define get_manageDSAit(op)                             _SCM((op)->o_managedsait)
2490
2491 #define o_noop  o_ctrlflag[slap_cids.sc_noOp]
2492 #define o_proxy_authz   o_ctrlflag[slap_cids.sc_proxyAuthz]
2493 #define o_subentries    o_ctrlflag[slap_cids.sc_subentries]
2494
2495 #define get_subentries(op)                              _SCM((op)->o_subentries)
2496 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2497
2498 #define set_subentries_visibility(op)   ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2499 #define get_subentries_visibility(op)   (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2500
2501 #define o_assert        o_ctrlflag[slap_cids.sc_assert]
2502 #define get_assert(op)                                  ((int)(op)->o_assert)
2503 #define o_assertion     o_controls[slap_cids.sc_assert]
2504 #define get_assertion(op)                               ((op)->o_assertion)
2505
2506 #define o_valuesreturnfilter    o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2507 #define o_vrFilter      o_controls[slap_cids.sc_valuesReturnFilter]
2508
2509 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2510 #define o_permissive_modify     o_ctrlflag[slap_cids.sc_permissiveModify]
2511 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
2512 #else
2513 #define get_permissiveModify(op)                (0)
2514 #endif
2515
2516 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2517 #define o_domain_scope  o_ctrlflag[slap_cids.sc_domainScope]
2518 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
2519 #else
2520 #define get_domainScope(op)                             (0)
2521 #endif
2522
2523 #ifdef SLAP_CONTROL_X_TREE_DELETE
2524 #define o_tree_delete   o_ctrlflag[slap_cids.sc_treeDelete]
2525 #define get_treeDelete(op)                              ((int)(op)->o_tree_delete)
2526 #else
2527 #define get_treeDelete(op)                              (0)
2528 #endif
2529
2530 #define o_preread       o_ctrlflag[slap_cids.sc_preRead]
2531 #define o_postread      o_ctrlflag[slap_cids.sc_postRead]
2532
2533 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2534 #define o_postread_attrs        o_controls[slap_cids.sc_postRead]
2535
2536 #define o_pagedresults  o_ctrlflag[slap_cids.sc_pagedResults]
2537 #define o_pagedresults_state    o_controls[slap_cids.sc_pagedResults]
2538 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2539
2540 #ifdef LDAP_DEVEL
2541 #define o_sortedresults         o_ctrlflag[slap_cids.sc_sortedResults]
2542 #endif
2543
2544 #define o_sync                  o_ctrlflag[slap_cids.sc_LDAPsync]
2545
2546         AuthorizationInformation o_authz;
2547
2548         BerElement      *o_ber;         /* ber of the request */
2549         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2550         slap_callback *o_callback;      /* callback pointers */
2551         LDAPControl     **o_ctrls;       /* controls */
2552
2553         void    *o_private;     /* anything the backend needs */
2554
2555         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2556
2557 } Operation;
2558 #define OPERATION_BUFFER_SIZE   (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2559
2560 #define send_ldap_error( op, rs, err, text ) do { \
2561                 (rs)->sr_err = err; (rs)->sr_text = text; \
2562                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2563         } while (0)
2564 #define send_ldap_discon( op, rs, err, text ) do { \
2565                 (rs)->sr_err = err; (rs)->sr_text = text; \
2566                 send_ldap_disconnect( op, rs ); \
2567         } while (0)
2568
2569 typedef void (SEND_LDAP_RESULT)(
2570         struct slap_op *op, struct slap_rep *rs);
2571 typedef int (SEND_SEARCH_ENTRY)(
2572         struct slap_op *op, struct slap_rep *rs);
2573 typedef int (SEND_SEARCH_REFERENCE)(
2574         struct slap_op *op, struct slap_rep *rs);
2575 typedef void (SEND_LDAP_EXTENDED)(
2576         struct slap_op *op, struct slap_rep *rs);
2577 typedef void (SEND_LDAP_INTERMEDIATE)(
2578         struct slap_op *op, struct slap_rep *rs);
2579
2580 #define send_ldap_result( op, rs ) \
2581         ((op)->o_conn->c_send_ldap_result)( op, rs )
2582 #define send_search_entry( op, rs ) \
2583         ((op)->o_conn->c_send_search_entry)( op, rs )
2584 #define send_search_reference( op, rs ) \
2585         ((op)->o_conn->c_send_search_reference)( op, rs )
2586 #define send_ldap_extended( op, rs ) \
2587         ((op)->o_conn->c_send_ldap_extended)( op, rs )
2588 #define send_ldap_intermediate( op, rs ) \
2589         ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2590
2591 typedef struct slap_listener Listener;
2592
2593 /*
2594  * represents a connection from an ldap client
2595  */
2596 typedef struct slap_conn {
2597         int                     c_struct_state; /* structure management state */
2598         int                     c_conn_state;   /* connection state */
2599         int                     c_conn_idx;             /* slot in connections array */
2600         const char      *c_close_reason; /* why connection is closing */
2601
2602         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2603         Sockbuf         *c_sb;                  /* ber connection stuff           */
2604
2605         /* only can be changed by connect_init */
2606         time_t          c_starttime;    /* when the connection was opened */
2607         time_t          c_activitytime; /* when the connection was last used */
2608         unsigned long           c_connid;       /* id of this connection for stats*/
2609
2610         struct berval   c_peer_domain;  /* DNS name of client */
2611         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2612         Listener        *c_listener;
2613 #define c_listener_url c_listener->sl_url       /* listener URL */
2614 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2615
2616         /* only can be changed by binding thread */
2617         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2618         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2619         struct berval   c_sasl_dn;      /* temporary storage */
2620         struct berval   c_sasl_authz_dn;        /* SASL proxy authz */
2621
2622         /* authorization backend */
2623         Backend *c_authz_backend;
2624         void    *c_authz_cookie;
2625 #define SLAP_IS_AUTHZ_BACKEND( op )     \
2626         ( (op)->o_bd != NULL \
2627                 && (op)->o_bd->be_private != NULL \
2628                 && (op)->o_conn != NULL \
2629                 && (op)->o_conn->c_authz_backend != NULL \
2630                 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2631                         || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2632
2633         AuthorizationInformation c_authz;
2634
2635         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2636
2637         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2638         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2639
2640         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2641         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2642
2643         BerElement      *c_currentber;  /* ber we're attempting to read */
2644         int             c_writewaiter;  /* true if writer is waiting */
2645
2646 #define CONN_IS_TLS     1
2647 #define CONN_IS_UDP     2
2648 #define CONN_IS_CLIENT  3
2649
2650 #ifdef LDAP_CONNECTIONLESS
2651         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2652 #endif
2653 #ifdef HAVE_TLS
2654         int     c_is_tls;               /* true if this LDAP over raw TLS */
2655         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2656 #endif
2657         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2658         int     c_sasl_done;            /* SASL completed once */
2659         void    *c_sasl_authctx;        /* SASL authentication context */
2660         void    *c_sasl_sockctx;        /* SASL security layer context */
2661         void    *c_sasl_extra;          /* SASL session extra stuff */
2662         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2663
2664         PagedResultsState c_pagedresults_state; /* paged result state */
2665
2666         long    c_n_ops_received;       /* num of ops received (next op_id) */
2667         long    c_n_ops_executing;      /* num of ops currently executing */
2668         long    c_n_ops_pending;        /* num of ops pending execution */
2669         long    c_n_ops_completed;      /* num of ops completed */
2670
2671         long    c_n_get;                /* num of get calls */
2672         long    c_n_read;               /* num of read calls */
2673         long    c_n_write;              /* num of write calls */
2674
2675         void    *c_pb;                  /* Netscape plugin */
2676         void    *c_extensions;          /* Netscape plugin */
2677
2678         /*
2679          * Client connection handling
2680          */
2681         ldap_pvt_thread_start_t *c_clientfunc;
2682         void    *c_clientarg;
2683
2684         /*
2685          * These are the "callbacks" that are available for back-ends to
2686          * supply data back to connected clients that are connected
2687          * through the "front-end".
2688          */
2689         SEND_LDAP_RESULT *c_send_ldap_result;
2690         SEND_SEARCH_ENTRY *c_send_search_entry;
2691         SEND_SEARCH_REFERENCE *c_send_search_reference;
2692         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2693 #ifdef LDAP_RES_INTERMEDIATE
2694         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2695 #endif
2696
2697 } Connection;
2698
2699 #if defined(LDAP_SYSLOG) && 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                 if ( ldap_syslog & (level) ) \
2705                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2706                                 (arg2), (arg3) ); \
2707         } while (0)
2708 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2709 #elif defined(LDAP_DEBUG)
2710 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2711         do { \
2712                 if ( ldap_debug & (level) ) \
2713                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2714         } while (0)
2715 #define StatslogTest( level ) (ldap_debug & (level))
2716 #else
2717 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2718 #define StatslogTest( level ) (0)
2719 #endif
2720
2721 /*
2722  * listener; need to access it from monitor backend
2723  */
2724 struct slap_listener {
2725         struct berval sl_url;
2726         struct berval sl_name;
2727         mode_t  sl_perms;
2728 #ifdef HAVE_TLS
2729         int             sl_is_tls;
2730 #endif
2731 #ifdef LDAP_CONNECTIONLESS
2732         int     sl_is_udp;              /* UDP listener is also data port */
2733 #endif
2734         int     sl_is_mute;     /* Listening is temporarily disabled */
2735         ber_socket_t sl_sd;
2736         Sockaddr sl_sa;
2737 #define sl_addr sl_sa.sa_in_addr
2738 };
2739
2740 /*
2741  * Operation indices
2742  */
2743 enum {
2744         SLAP_OP_BIND = 0,
2745         SLAP_OP_UNBIND,
2746         SLAP_OP_ADD,
2747         SLAP_OP_DELETE,
2748         SLAP_OP_MODRDN,
2749         SLAP_OP_MODIFY,
2750         SLAP_OP_COMPARE,
2751         SLAP_OP_SEARCH,
2752         SLAP_OP_ABANDON,
2753         SLAP_OP_EXTENDED,
2754         SLAP_OP_LAST
2755 };
2756
2757 typedef struct slap_counters_t {
2758         ldap_pvt_thread_mutex_t sc_sent_mutex;
2759         ldap_pvt_mp_t           sc_bytes;
2760         ldap_pvt_mp_t           sc_pdu;
2761         ldap_pvt_mp_t           sc_entries;
2762         ldap_pvt_mp_t           sc_refs;
2763
2764         ldap_pvt_thread_mutex_t sc_ops_mutex;
2765         ldap_pvt_mp_t           sc_ops_completed;
2766         ldap_pvt_mp_t           sc_ops_initiated;
2767 #ifdef SLAPD_MONITOR
2768         ldap_pvt_mp_t           sc_ops_completed_[SLAP_OP_LAST];
2769         ldap_pvt_mp_t           sc_ops_initiated_[SLAP_OP_LAST];
2770 #endif /* SLAPD_MONITOR */
2771 } slap_counters_t;
2772
2773 /*
2774  * Better know these all around slapd
2775  */
2776 #define SLAP_LDAPDN_PRETTY 0x1
2777 #define SLAP_LDAPDN_MAXLEN 8192
2778
2779 /* number of response controls supported */
2780 #define SLAP_MAX_RESPONSE_CONTROLS   6
2781
2782 #ifdef LDAP_DEVEL
2783 #define SLAP_CTRL_HIDE                          0x00000000U
2784 #else
2785 #define SLAP_CTRL_HIDE                          0x80000000U
2786 #endif
2787
2788 #define SLAP_CTRL_REQUIRES_ROOT         0x40000000U /* for ManageDIT */
2789
2790 #define SLAP_CTRL_GLOBAL                        0x00800000U
2791 #define SLAP_CTRL_GLOBAL_SEARCH         0x00010000U     /* for NOOP */
2792
2793 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2794 #define SLAP_CTRL_ABANDON                       0x00000001U
2795 #define SLAP_CTRL_ADD                           0x00002002U
2796 #define SLAP_CTRL_BIND                          0x00000004U
2797 #define SLAP_CTRL_COMPARE                       0x00001008U
2798 #define SLAP_CTRL_DELETE                        0x00002010U
2799 #define SLAP_CTRL_MODIFY                        0x00002020U
2800 #define SLAP_CTRL_RENAME                        0x00002040U
2801 #define SLAP_CTRL_SEARCH                        0x00001080U
2802 #define SLAP_CTRL_UNBIND                        0x00000100U
2803
2804 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2805 #define SLAP_CTRL_UPDATE \
2806         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2807 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2808
2809 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2810         Operation *op,
2811         SlapReply *rs,
2812         LDAPControl *ctrl ));
2813
2814 #define SLAP_SLAB_SIZE  (1024*1024)
2815 #define SLAP_SLAB_STACK 1
2816 #define SLAP_SLAB_SOBLOCK 64
2817
2818 #define SLAP_ZONE_ALLOC 1
2819 #undef SLAP_ZONE_ALLOC
2820
2821 #ifdef LDAP_COMP_MATCH
2822 /*
2823  * Extensible Filter Definition
2824  *
2825  * MatchingRuleAssertion := SEQUENCE {
2826  *      matchingRule    [1] MatchingRuleId OPTIONAL,
2827  *      type            [2] AttributeDescription OPTIONAL,
2828  *      matchValue      [3] AssertionValue,
2829  *      dnAttributes    [4] BOOLEAN DEFAULT FALSE }
2830  *
2831  * Following ComponentFilter is contained in matchValue
2832  *
2833  * ComponentAssertion ::= SEQUENCE {
2834  *      component               ComponentReference (SIZE(1..MAX)) OPTIONAL
2835  *      useDefaultValues        BOOLEAN DEFAULT TRUE,
2836  *      rule                    MATCHING-RULE.&id,
2837  *      value                   MATCHING-RULE.&AssertionType }
2838  *
2839  * ComponentFilter ::= CHOICE {
2840  *      item    [0] ComponentAssertion,
2841  *      and     [1] SEQUENCE OF ComponentFilter,
2842  *      or      [2] SEQUENCE OF ComponentFilter,
2843  *      not     [3] ComponentFilter }
2844  */
2845
2846 #define LDAP_COMPREF_IDENTIFIER         ((ber_tag_t) 0x80U)
2847 #define LDAP_COMPREF_FROM_BEGINNING     ((ber_tag_t) 0x81U)
2848 #define LDAP_COMPREF_COUNT              ((ber_tag_t) 0x82U)
2849 #define LDAP_COMPREF_FROM_END           ((ber_tag_t) 0x83U)
2850 #define LDAP_COMPREF_CONTENT            ((ber_tag_t) 0x84U)
2851 #define LDAP_COMPREF_SELECT             ((ber_tag_t) 0x85U)
2852 #define LDAP_COMPREF_ALL                ((ber_tag_t) 0x86U)
2853 #define LDAP_COMPREF_DEFINED            ((ber_tag_t) 0x87U)
2854 #define LDAP_COMPREF_UNDEFINED          ((ber_tag_t) 0x88U)
2855
2856 #define LDAP_COMP_FILTER_AND            ((ber_tag_t) 0xa0U)
2857 #define LDAP_COMP_FILTER_OR             ((ber_tag_t) 0xa1U)
2858 #define LDAP_COMP_FILTER_NOT            ((ber_tag_t) 0xa2U)
2859 #define LDAP_COMP_FILTER_ITEM           ((ber_tag_t) 0xa3U)
2860 #define LDAP_COMP_FILTER_UNDEFINED      ((ber_tag_t) 0xa4U)
2861
2862 typedef struct slap_component_id {
2863         int     ci_type;
2864         struct slap_component_id *ci_next;
2865
2866         union comp_id_value{
2867                 BerValue        ci_identifier;
2868                 ber_int_t       ci_from_beginning;
2869                 ber_int_t       ci_count;
2870                 ber_int_t       ci_from_end;
2871                 ber_int_t       ci_content;
2872                 BerValue        ci_select_value;
2873                 char            ci_all;
2874         } ci_val;
2875 } ComponentId;
2876
2877 typedef struct slap_component_reference {
2878         ComponentId     *cr_list;
2879         ComponentId     *cr_curr;
2880         struct berval   cr_string;
2881         int cr_len;
2882         /* Component Indexing */
2883         int             cr_asn_type_id;
2884         slap_mask_t     cr_indexmask;
2885         AttributeDescription* cr_ad;
2886         BerVarray       cr_nvals;
2887         struct slap_component_reference* cr_next;
2888 } ComponentReference;
2889
2890 typedef struct slap_component_assertion {
2891         ComponentReference      *ca_comp_ref;
2892         ber_int_t               ca_use_def;
2893         MatchingRule            *ca_ma_rule;
2894         struct berval           ca_ma_value;
2895         ComponentData           ca_comp_data; /* componentized assertion */
2896         struct slap_component_filter    *ca_cf;
2897         MatchingRuleAssertion   *ca_mra;
2898 } ComponentAssertion;
2899
2900 typedef struct slap_component_filter {
2901         ber_tag_t cf_choice;
2902         union cf_un_u {
2903                 ber_int_t cf_un_result;
2904                 ComponentAssertion *cf_un_ca;
2905                 struct slap_component_filter *cf_un_complex;
2906         } cf_un;
2907
2908 #define cf_ca           cf_un.cf_un_ca
2909 #define cf_result       cf_un.cf_un_result
2910 #define cf_and          cf_un.cf_un_complex
2911 #define cf_or           cf_un.cf_un_complex
2912 #define cf_not          cf_un.cf_un_complex
2913 #define cf_any          cf_un.cf_un_complex
2914
2915         struct slap_component_filter *cf_next;
2916 } ComponentFilter;
2917
2918 typedef struct slap_component_assertion_value {
2919         char* cav_buf;
2920         char* cav_ptr;
2921         char* cav_end;
2922 } ComponentAssertionValue;
2923
2924 typedef int encoder_func LDAP_P((
2925         void* b,
2926         void* comp));
2927
2928 struct slap_component_syntax_info;
2929
2930 typedef int gser_decoder_func LDAP_P((
2931         void* mem_op,
2932         void* b,
2933         struct slap_component_syntax_info** comp_syn_info,
2934         int* len,
2935         int mode));
2936
2937 typedef int comp_free_func LDAP_P((
2938         void* b));
2939
2940 typedef int ber_decoder_func LDAP_P((
2941         void* mem_op,
2942         void* b,
2943         int tag,
2944         int elmtLen,
2945         struct slap_component_syntax_info* comp_syn_info,
2946         int* len,
2947         int mode));
2948
2949 typedef int ber_tag_decoder_func LDAP_P((
2950         void* mem_op,
2951         void* b,
2952         struct slap_component_syntax_info* comp_syn_info,
2953         int* len,
2954         int mode));
2955
2956 typedef void* extract_component_from_id_func LDAP_P((
2957         void* mem_op,
2958         ComponentReference* cr,
2959         void* comp ));
2960
2961 typedef void* convert_attr_to_comp_func LDAP_P ((
2962         Attribute* a,
2963         Syntax* syn,
2964         struct berval* bv ));
2965
2966 typedef void* alloc_nibble_func LDAP_P ((
2967         int initial_size,
2968         int increment_size ));
2969
2970 typedef void free_nibble_func LDAP_P ((
2971         void* nm ));
2972
2973 struct slap_component_syntax_info;
2974 typedef void convert_assert_to_comp_func LDAP_P ((
2975         void *mem_op,
2976         struct slap_component_syntax_info* csi_attr,
2977         struct berval* bv,
2978         struct slap_component_syntax_info** csi,
2979         int* len,
2980         int mode ));
2981
2982 typedef int convert_asn_to_ldap_func LDAP_P ((
2983         struct slap_component_syntax_info* csi,
2984         struct berval *bv ));
2985
2986 typedef void free_component_func LDAP_P ((
2987         void* mem_op));
2988
2989 typedef int test_component_func LDAP_P ((
2990         void* attr_mem_op,
2991         void* assert_mem_op,
2992         struct slap_component_syntax_info* csi,
2993         struct slap_component_assertion* ca));
2994
2995 typedef void* test_membership_func LDAP_P ((
2996         void* in ));
2997
2998 typedef void* get_component_info_func LDAP_P ((
2999         int in ));
3000
3001 struct slap_component_syntax_info;
3002
3003 typedef int component_encoder_func LDAP_P ((
3004         void* mem_op,
3005         struct slap_component_syntax_info* csi,
3006         struct berval* nvals ));
3007
3008 typedef int allcomponent_matching_func LDAP_P((
3009         char* oid,
3010         struct slap_component_syntax_info* comp1,
3011         struct slap_component_syntax_info* comp));
3012
3013 typedef struct slap_component_desc {
3014         /* Don't change the order of following four fields */
3015         int             cd_tag;
3016         AttributeType   *cd_comp_type;
3017         struct berval   cd_ad_type;/* ad_type, ad_cname */
3018         struct berval   cd_ad_cname;/* ad_type, ad_cname */
3019         unsigned        cd_flags; /*ad_flags*/
3020         int             cd_type;
3021         int             cd_type_id;
3022         encoder_func            *cd_ldap_encoder;
3023         encoder_func            *cd_gser_encoder;
3024         encoder_func            *cd_ber_encoder;
3025         gser_decoder_func       *cd_gser_decoder;
3026         ber_decoder_func        *cd_ber_decoder;
3027         comp_free_func          *cd_free;
3028         extract_component_from_id_func*  cd_extract_i;
3029         allcomponent_matching_func      *cd_all_match;
3030 } ComponentDesc;
3031
3032 typedef struct slap_component_syntax_info {
3033         Syntax* csi_syntax;
3034         ComponentDesc* csi_comp_desc;
3035 } ComponentSyntaxInfo;
3036
3037 #endif
3038
3039 /* slab heap data structures */
3040
3041 struct slab_object {
3042     void *so_ptr;
3043         int so_blockhead;
3044     LDAP_LIST_ENTRY(slab_object) so_link;
3045 };
3046
3047 struct slab_heap {
3048     void *sh_base;
3049     void *sh_last;
3050     void *sh_end;
3051         int sh_stack;
3052         int sh_maxorder;
3053     unsigned char **sh_map;
3054     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3055         LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3056 };
3057
3058 #ifdef SLAP_ZONE_ALLOC
3059 #define SLAP_ZONE_SIZE 0x80000          /* 512KB */
3060 #define SLAP_ZONE_SHIFT 19
3061 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3062 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3063 #define SLAP_ZONE_DELTA 0x800000        /* 8MB */
3064 #define SLAP_ZONE_ZOBLOCK 256
3065
3066 struct zone_object {
3067         void *zo_ptr;
3068         int zo_siz;
3069         int zo_idx;
3070         int zo_blockhead;
3071         LDAP_LIST_ENTRY(zone_object) zo_link;
3072 };
3073
3074 struct zone_latency_history {
3075         double zlh_latency;
3076         LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3077 };
3078
3079 struct zone_heap {
3080         int zh_fd;
3081         int zh_zonesize;
3082         int zh_zoneorder;
3083         int zh_numzones;
3084         int zh_maxzones;
3085         int zh_deltazones;
3086         void **zh_zones;
3087         ldap_pvt_thread_rdwr_t *zh_znlock;
3088         Avlnode *zh_zonetree;
3089         unsigned char ***zh_maps;
3090         int *zh_seqno;
3091         LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3092         LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3093         ldap_pvt_thread_mutex_t zh_mutex;
3094         ldap_pvt_thread_rdwr_t zh_lock;
3095         double zh_ema_latency;
3096         unsigned long zh_ema_samples;
3097         LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3098                                 zh_latency_history_queue;
3099         int zh_latency_history_qlen;
3100         int zh_latency_jump;
3101         int zh_swapping;
3102 };
3103 #endif
3104
3105 #define SLAP_BACKEND_INIT_MODULE(b) \
3106         static BackendInfo bi;  \
3107         int \
3108         init_module( int argc, char *argv[] ) \
3109         { \
3110                 bi.bi_type = #b ; \
3111                 bi.bi_init = b ## _back_initialize; \
3112                 backend_add( &bi ); \
3113                 return 0; \
3114         }
3115
3116 LDAP_END_DECL
3117
3118 #include "proto-slap.h"
3119
3120 #endif /* _SLAP_H_ */