git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

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