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