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