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

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