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