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