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