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