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

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