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