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