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