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