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