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