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