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