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

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