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