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