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

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