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_ORDERED_VAL             0x0001U /* values are ordered */
 672 #define SLAP_AT_ORDERED_SIB             0x0002U /* siblings are ordered */
 673 #define SLAP_AT_ORDERED         0x0003U /* value has order index */
 674 #define SLAP_AT_HARDCODE        0x10000U        /* This is hardcoded schema */
 675
 676         slap_mask_t                                     sat_flags;
 677
 678         LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
 679
 680 #define sat_oid                         sat_atype.at_oid
 681 #define sat_names                       sat_atype.at_names
 682 #define sat_desc                        sat_atype.at_desc
 683 #define sat_obsolete            sat_atype.at_obsolete
 684 #define sat_sup_oid                     sat_atype.at_sup_oid
 685 #define sat_equality_oid        sat_atype.at_equality_oid
 686 #define sat_ordering_oid        sat_atype.at_ordering_oid
 687 #define sat_substr_oid          sat_atype.at_substr_oid
 688 #define sat_syntax_oid          sat_atype.at_syntax_oid
 689 #define sat_single_value        sat_atype.at_single_value
 690 #define sat_collective          sat_atype.at_collective
 691 #define sat_no_user_mod         sat_atype.at_no_user_mod
 692 #define sat_usage                       sat_atype.at_usage
 693 #define sat_extensions          sat_atype.at_extensions
 694
 695         struct slap_attr_desc           *sat_ad;
 696         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 697 } AttributeType;
 698
 699 #define is_at_operational(at)   ((at)->sat_usage)
 700 #define is_at_single_value(at)  ((at)->sat_single_value)
 701 #define is_at_collective(at)    ((at)->sat_collective)
 702 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 703 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 704
 705 struct slap_object_class;
 706
 707 typedef int (ObjectClassSchemaCheckFN)(
 708         struct slap_backend_db *be,
 709         struct slap_entry *e,
 710         struct slap_object_class *oc,
 711         const char** text,
 712         char *textbuf, size_t textlen );
 713
 714 typedef struct slap_object_class {
 715         LDAPObjectClass                 soc_oclass;
 716         struct berval                   soc_cname;
 717         struct slap_object_class        **soc_sups;
 718         AttributeType                           **soc_required;
 719         AttributeType                           **soc_allowed;
 720         ObjectClassSchemaCheckFN        *soc_check;
 721         char                                    *soc_oidmacro;
 722         slap_mask_t                                     soc_flags;
 723 #define soc_oid                         soc_oclass.oc_oid
 724 #define soc_names                       soc_oclass.oc_names
 725 #define soc_desc                        soc_oclass.oc_desc
 726 #define soc_obsolete            soc_oclass.oc_obsolete
 727 #define soc_sup_oids            soc_oclass.oc_sup_oids
 728 #define soc_kind                        soc_oclass.oc_kind
 729 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 730 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 731 #define soc_extensions          soc_oclass.oc_extensions
 732
 733         LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
 734 } ObjectClass;
 735
 736 #define SLAP_OC_ALIAS           0x0001
 737 #define SLAP_OC_REFERRAL        0x0002
 738 #define SLAP_OC_SUBENTRY        0x0004
 739 #define SLAP_OC_DYNAMICOBJECT   0x0008
 740 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 741 #define SLAP_OC_GLUE            0x0020
 742 #define SLAP_OC_SYNCPROVIDERSUBENTRY            0x0040
 743 #define SLAP_OC_SYNCCONSUMERSUBENTRY            0x0080
 744 #define SLAP_OC__MASK           0x00FF
 745 #define SLAP_OC__END            0x0100
 746 #define SLAP_OC_OPERATIONAL     0x4000
 747 #ifdef LDAP_DEVEL
 748 #define SLAP_OC_HIDE            0x0000
 749 #else
 750 #define SLAP_OC_HIDE            0x8000
 751 #endif
 752 #define SLAP_OC_HARDCODE        0x10000U        /* This is hardcoded schema */
 753
 754 /*
 755  * DIT content rule
 756  */
 757 typedef struct slap_content_rule {
 758         LDAPContentRule         scr_crule;
 759         ObjectClass                     *scr_sclass;
 760         ObjectClass                     **scr_auxiliaries;      /* optional */
 761         AttributeType           **scr_required;         /* optional */
 762         AttributeType           **scr_allowed;          /* optional */
 763         AttributeType           **scr_precluded;        /* optional */
 764 #define scr_oid                         scr_crule.cr_oid
 765 #define scr_names                       scr_crule.cr_names
 766 #define scr_desc                        scr_crule.cr_desc
 767 #define scr_obsolete            scr_crule.cr_obsolete
 768 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
 769 #define scr_at_oids_must        scr_crule.cr_at_oids_must
 770 #define scr_at_oids_may         scr_crule.cr_at_oids_may
 771 #define scr_at_oids_not         scr_crule.cr_at_oids_not
 772
 773         char                            *scr_oidmacro;
 774 #define         SLAP_CR_HARDCODE        0x10000U
 775         int     scr_flags;
 776
 777         LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
 778 } ContentRule;
 779
 780 /* Represents a recognized attribute description ( type + options ). */
 781 typedef struct slap_attr_desc {
 782         struct slap_attr_desc *ad_next;
 783         AttributeType *ad_type;         /* attribute type, must be specified */
 784         struct berval ad_cname;         /* canonical name, must be specified */
 785         struct berval ad_tags;          /* empty if no tagging options */
 786         unsigned ad_flags;
 787 #define SLAP_DESC_NONE                  0x00U
 788 #define SLAP_DESC_BINARY                0x01U
 789 #define SLAP_DESC_TAG_RANGE             0x80U
 790 } AttributeDescription;
 791
 792 typedef struct slap_attr_name {
 793         struct berval an_name;
 794         AttributeDescription *an_desc;
 795         int an_oc_exclude;
 796         ObjectClass *an_oc;
 797 } AttributeName;
 798
 799 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
 800 #define slap_ad_is_tag_range(ad)        \
 801         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
 802 #define slap_ad_is_binary(ad)           \
 803         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 804
 805 /*
 806  * pointers to schema elements used internally
 807  */
 808 struct slap_internal_schema {
 809         /* objectClass */
 810         ObjectClass *si_oc_top;
 811         ObjectClass *si_oc_extensibleObject;
 812         ObjectClass *si_oc_alias;
 813         ObjectClass *si_oc_referral;
 814         ObjectClass *si_oc_rootdse;
 815         ObjectClass *si_oc_subentry;
 816         ObjectClass *si_oc_subschema;
 817         ObjectClass *si_oc_collectiveAttributeSubentry;
 818         ObjectClass *si_oc_dynamicObject;
 819
 820         ObjectClass *si_oc_glue;
 821         ObjectClass *si_oc_syncConsumerSubentry;
 822         ObjectClass *si_oc_syncProviderSubentry;
 823
 824         /* objectClass attribute descriptions */
 825         AttributeDescription *si_ad_objectClass;
 826
 827         /* operational attribute descriptions */
 828         AttributeDescription *si_ad_structuralObjectClass;
 829         AttributeDescription *si_ad_creatorsName;
 830         AttributeDescription *si_ad_createTimestamp;
 831         AttributeDescription *si_ad_modifiersName;
 832         AttributeDescription *si_ad_modifyTimestamp;
 833         AttributeDescription *si_ad_hasSubordinates;
 834         AttributeDescription *si_ad_subschemaSubentry;
 835         AttributeDescription *si_ad_collectiveSubentries;
 836         AttributeDescription *si_ad_collectiveExclusions;
 837         AttributeDescription *si_ad_entryDN;
 838         AttributeDescription *si_ad_entryUUID;
 839         AttributeDescription *si_ad_entryCSN;
 840         AttributeDescription *si_ad_namingCSN;
 841
 842         AttributeDescription *si_ad_dseType;
 843         AttributeDescription *si_ad_syncreplCookie;
 844         AttributeDescription *si_ad_syncTimestamp;
 845         AttributeDescription *si_ad_contextCSN;
 846
 847         /* root DSE attribute descriptions */
 848         AttributeDescription *si_ad_altServer;
 849         AttributeDescription *si_ad_namingContexts;
 850         AttributeDescription *si_ad_supportedControl;
 851         AttributeDescription *si_ad_supportedExtension;
 852         AttributeDescription *si_ad_supportedLDAPVersion;
 853         AttributeDescription *si_ad_supportedSASLMechanisms;
 854         AttributeDescription *si_ad_supportedFeatures;
 855         AttributeDescription *si_ad_monitorContext;
 856         AttributeDescription *si_ad_vendorName;
 857         AttributeDescription *si_ad_vendorVersion;
 858         AttributeDescription *si_ad_configContext;
 859
 860         /* subentry attribute descriptions */
 861         AttributeDescription *si_ad_administrativeRole;
 862         AttributeDescription *si_ad_subtreeSpecification;
 863
 864         /* subschema subentry attribute descriptions */
 865         AttributeDescription *si_ad_attributeTypes;
 866         AttributeDescription *si_ad_ditContentRules;
 867         AttributeDescription *si_ad_ditStructureRules;
 868         AttributeDescription *si_ad_ldapSyntaxes;
 869         AttributeDescription *si_ad_matchingRules;
 870         AttributeDescription *si_ad_matchingRuleUse;
 871         AttributeDescription *si_ad_nameForms;
 872         AttributeDescription *si_ad_objectClasses;
 873
 874         /* Aliases & Referrals */
 875         AttributeDescription *si_ad_aliasedObjectName;
 876         AttributeDescription *si_ad_ref;
 877
 878         /* Access Control Internals */
 879         AttributeDescription *si_ad_entry;
 880         AttributeDescription *si_ad_children;
 881         AttributeDescription *si_ad_saslAuthzTo;
 882         AttributeDescription *si_ad_saslAuthzFrom;
 883 #ifdef SLAPD_ACI_ENABLED
 884         AttributeDescription *si_ad_aci;
 885 #endif /* SLAPD_ACI_ENABLED */
 886
 887         /* dynamic entries */
 888         AttributeDescription *si_ad_entryTtl;
 889         AttributeDescription *si_ad_dynamicSubtrees;
 890
 891         /* Other attributes descriptions */
 892         AttributeDescription *si_ad_distinguishedName;
 893         AttributeDescription *si_ad_name;
 894         AttributeDescription *si_ad_cn;
 895         AttributeDescription *si_ad_uid;
 896         AttributeDescription *si_ad_userPassword;
 897         AttributeDescription *si_ad_labeledURI;
 898 #ifdef SLAPD_AUTHPASSWD
 899         AttributeDescription *si_ad_authPassword;
 900         AttributeDescription *si_ad_authPasswordSchemes;
 901 #endif
 902 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 903         AttributeDescription *si_ad_krbName;
 904 #endif
 905         AttributeDescription *si_ad_description;
 906         AttributeDescription *si_ad_seeAlso;
 907
 908         /* Undefined Attribute Type */
 909         AttributeType   *si_at_undefined;
 910
 911         /* Matching Rules */
 912         MatchingRule    *si_mr_distinguishedNameMatch;
 913         MatchingRule    *si_mr_dnSubtreeMatch;
 914         MatchingRule    *si_mr_dnOneLevelMatch;
 915         MatchingRule    *si_mr_dnSubordinateMatch;
 916         MatchingRule    *si_mr_dnSuperiorMatch;
 917         MatchingRule    *si_mr_caseExactMatch;
 918         MatchingRule    *si_mr_caseExactSubstringsMatch;
 919         MatchingRule    *si_mr_caseExactIA5Match;
 920         MatchingRule    *si_mr_integerMatch;
 921         MatchingRule    *si_mr_integerFirstComponentMatch;
 922         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 923
 924         /* Syntaxes */
 925         Syntax          *si_syn_directoryString;
 926         Syntax          *si_syn_distinguishedName;
 927         Syntax          *si_syn_integer;
 928         Syntax          *si_syn_octetString;
 929
 930         /* Schema Syntaxes */
 931         Syntax          *si_syn_attributeTypeDesc;
 932         Syntax          *si_syn_ditContentRuleDesc;
 933         Syntax          *si_syn_ditStructureRuleDesc;
 934         Syntax          *si_syn_ldapSyntaxDesc;
 935         Syntax          *si_syn_matchingRuleDesc;
 936         Syntax          *si_syn_matchingRuleUseDesc;
 937         Syntax          *si_syn_nameFormDesc;
 938         Syntax          *si_syn_objectClassDesc;
 939 };
 940
 941 typedef struct slap_attr_assertion {
 942         AttributeDescription    *aa_desc;
 943         struct berval aa_value;
 944 #ifdef LDAP_COMP_MATCH
 945         struct slap_component_filter *aa_cf;/* for attribute aliasing */
 946 #endif
 947 } AttributeAssertion;
 948
 949 typedef struct slap_ss_assertion {
 950         AttributeDescription    *sa_desc;
 951         struct berval           sa_initial;
 952         struct berval           *sa_any;
 953         struct berval           sa_final;
 954 } SubstringsAssertion;
 955
 956 #ifdef LDAP_COMP_MATCH
 957 struct slap_component_filter;
 958 #endif
 959
 960 typedef struct slap_mr_assertion {
 961         MatchingRule            *ma_rule;       /* optional */
 962         struct berval           ma_rule_text;  /* optional */
 963         AttributeDescription    *ma_desc;       /* optional */
 964         int                                             ma_dnattrs; /* boolean */
 965         struct berval           ma_value;       /* required */
 966 #ifdef LDAP_COMP_MATCH
 967         struct slap_component_filter* ma_cf; /* component filter */
 968 #endif
 969 } MatchingRuleAssertion;
 970
 971 /*
 972  * represents a search filter
 973  */
 974 typedef struct slap_filter {
 975         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 976 #define SLAPD_FILTER_COMPUTED           ((ber_tag_t) -1)
 977 #define SLAPD_FILTER_DN_ONE                     ((ber_tag_t) -2)
 978 #define SLAPD_FILTER_DN_SUBTREE         ((ber_tag_t) -3)
 979 #ifdef LDAP_SCOPE_SUBORDINATE
 980 #define SLAPD_FILTER_DN_CHILDREN        ((ber_tag_t) -4)
 981 #endif
 982
 983         union f_un_u {
 984                 /* precomputed result */
 985                 ber_int_t f_un_result;
 986
 987                 /* DN */
 988                 struct berval *f_un_dn;
 989
 990                 /* present */
 991                 AttributeDescription *f_un_desc;
 992
 993                 /* simple value assertion */
 994                 AttributeAssertion *f_un_ava;
 995
 996                 /* substring assertion */
 997                 SubstringsAssertion *f_un_ssa;
 998
 999                 /* matching rule assertion */
1000                 MatchingRuleAssertion *f_un_mra;
1001
1002 #define f_dn                    f_un.f_un_dn
1003 #define f_desc                  f_un.f_un_desc
1004 #define f_ava                   f_un.f_un_ava
1005 #define f_av_desc               f_un.f_un_ava->aa_desc
1006 #define f_av_value              f_un.f_un_ava->aa_value
1007 #define f_sub                   f_un.f_un_ssa
1008 #define f_sub_desc              f_un.f_un_ssa->sa_desc
1009 #define f_sub_initial   f_un.f_un_ssa->sa_initial
1010 #define f_sub_any               f_un.f_un_ssa->sa_any
1011 #define f_sub_final             f_un.f_un_ssa->sa_final
1012 #define f_mra                   f_un.f_un_mra
1013 #define f_mr_rule               f_un.f_un_mra->ma_rule
1014 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
1015 #define f_mr_desc               f_un.f_un_mra->ma_desc
1016 #define f_mr_value              f_un.f_un_mra->ma_value
1017 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
1018
1019                 /* and, or, not */
1020                 struct slap_filter *f_un_complex;
1021         } f_un;
1022
1023 #define f_result        f_un.f_un_result
1024 #define f_and           f_un.f_un_complex
1025 #define f_or            f_un.f_un_complex
1026 #define f_not           f_un.f_un_complex
1027 #define f_list          f_un.f_un_complex
1028
1029         struct slap_filter      *f_next;
1030 } Filter;
1031
1032 /* compare routines can return undefined */
1033 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1034
1035 typedef struct slap_valuesreturnfilter {
1036         ber_tag_t       vrf_choice;
1037
1038         union vrf_un_u {
1039                 /* precomputed result */
1040                 ber_int_t vrf_un_result;
1041
1042                 /* DN */
1043                 char *vrf_un_dn;
1044
1045                 /* present */
1046                 AttributeDescription *vrf_un_desc;
1047
1048                 /* simple value assertion */
1049                 AttributeAssertion *vrf_un_ava;
1050
1051                 /* substring assertion */
1052                 SubstringsAssertion *vrf_un_ssa;
1053
1054                 /* matching rule assertion */
1055                 MatchingRuleAssertion *vrf_un_mra;
1056
1057 #define vrf_result              vrf_un.vrf_un_result
1058 #define vrf_dn                  vrf_un.vrf_un_dn
1059 #define vrf_desc                vrf_un.vrf_un_desc
1060 #define vrf_ava                 vrf_un.vrf_un_ava
1061 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
1062 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
1063 #define vrf_ssa                 vrf_un.vrf_un_ssa
1064 #define vrf_sub                 vrf_un.vrf_un_ssa
1065 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
1066 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1067 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
1068 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
1069 #define vrf_mra                 vrf_un.vrf_un_mra
1070 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
1071 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
1072 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
1073 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
1074 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
1075
1076
1077         } vrf_un;
1078
1079         struct slap_valuesreturnfilter  *vrf_next;
1080 } ValuesReturnFilter;
1081
1082 #ifdef LDAP_COMP_MATCH
1083 struct slap_component_syntax_info;
1084 typedef struct  slap_component_data {
1085         void* cd_mem_op;/* nibble memory handler */
1086         struct slap_component_syntax_info** cd_tree;/* component tree */
1087 } ComponentData;
1088 #endif
1089
1090 /*
1091  * represents an attribute (description + values)
1092  */
1093 typedef struct slap_attr {
1094         AttributeDescription *a_desc;
1095         BerVarray       a_vals;         /* preserved values */
1096         BerVarray       a_nvals;        /* normalized values */
1097 #ifdef LDAP_COMP_MATCH
1098         ComponentData   *a_comp_data; /* component values */
1099 #endif
1100         struct slap_attr *a_next;
1101         unsigned a_flags;
1102 #define SLAP_ATTR_IXADD         0x1U
1103 #define SLAP_ATTR_IXDEL         0x2U
1104 } Attribute;
1105
1106
1107 /*
1108  * the id used in the indexes to refer to an entry
1109  */
1110 typedef unsigned long   ID;
1111 #define NOID    ((ID)~0)
1112
1113 /*
1114  * represents an entry in core
1115  */
1116 typedef struct slap_entry {
1117         /*
1118          * The ID field should only be changed before entry is
1119          * inserted into a cache.  The ID value is backend
1120          * specific.
1121          */
1122         ID              e_id;
1123
1124         struct berval e_name;   /* name (DN) of this entry */
1125         struct berval e_nname;  /* normalized name (DN) of this entry */
1126
1127         /* for migration purposes */
1128 #define e_dn e_name.bv_val
1129 #define e_ndn e_nname.bv_val
1130
1131         Attribute       *e_attrs;       /* list of attributes + values */
1132
1133         slap_mask_t     e_ocflags;
1134
1135         struct berval   e_bv;           /* For entry_encode/entry_decode */
1136
1137         /* for use by the backend for any purpose */
1138         void*   e_private;
1139 } Entry;
1140
1141 /*
1142  * A list of LDAPMods
1143  */
1144 typedef struct slap_mod {
1145         int sm_op;
1146         AttributeDescription *sm_desc;
1147         struct berval sm_type;
1148         BerVarray sm_values;
1149         BerVarray sm_nvalues;
1150 } Modification;
1151
1152 typedef struct slap_mod_list {
1153         Modification sml_mod;
1154 #define sml_op          sml_mod.sm_op
1155 #define sml_desc        sml_mod.sm_desc
1156 #define sml_type        sml_mod.sm_type
1157 #define sml_values      sml_mod.sm_values
1158 #define sml_nvalues     sml_mod.sm_nvalues
1159         struct slap_mod_list *sml_next;
1160 } Modifications;
1161
1162 typedef struct slap_ldap_modlist {
1163         LDAPMod ml_mod;
1164         struct slap_ldap_modlist *ml_next;
1165 #define ml_op           ml_mod.mod_op
1166 #define ml_type         ml_mod.mod_type
1167 #define ml_values       ml_mod.mod_values
1168 } LDAPModList;
1169
1170 /*
1171  * represents an access control list
1172  */
1173 typedef enum slap_access_e {
1174         ACL_INVALID_ACCESS = -1,
1175         ACL_NONE = 0,
1176         ACL_DISCLOSE,
1177         ACL_AUTH,
1178         ACL_COMPARE,
1179         ACL_SEARCH,
1180         ACL_READ,
1181         ACL_WRITE,
1182         ACL_MANAGE,
1183
1184         /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1185         ACL_LAST,
1186
1187         /* ACL level mask and modifiers */
1188         ACL_LEVEL_MASK = 0x000f,
1189         ACL_QUALIFIER1 = 0x0100,
1190         ACL_QUALIFIER2 = 0x0200,
1191         ACL_QUALIFIER3 = 0x0400,
1192         ACL_QUALIFIER4 = 0x0800,
1193         ACL_QUALIFIER_MASK = 0x0f00,
1194
1195         /* write granularity */
1196         ACL_WADD = ACL_WRITE|ACL_QUALIFIER1,
1197         ACL_WDEL = ACL_WRITE|ACL_QUALIFIER2
1198 } slap_access_t;
1199
1200 typedef enum slap_control_e {
1201         ACL_INVALID_CONTROL     = 0,
1202         ACL_STOP,
1203         ACL_CONTINUE,
1204         ACL_BREAK
1205 } slap_control_t;
1206
1207 typedef enum slap_style_e {
1208         ACL_STYLE_REGEX = 0,
1209         ACL_STYLE_EXPAND,
1210         ACL_STYLE_BASE,
1211         ACL_STYLE_ONE,
1212         ACL_STYLE_SUBTREE,
1213         ACL_STYLE_CHILDREN,
1214         ACL_STYLE_LEVEL,
1215         ACL_STYLE_ATTROF,
1216         ACL_STYLE_ANONYMOUS,
1217         ACL_STYLE_USERS,
1218         ACL_STYLE_SELF,
1219         ACL_STYLE_IP,
1220         ACL_STYLE_PATH
1221 } slap_style_t;
1222
1223 typedef struct slap_authz_info {
1224         ber_tag_t       sai_method;                     /* LDAP_AUTH_* from <ldap.h> */
1225         struct berval   sai_mech;               /* SASL Mechanism */
1226         struct berval   sai_dn;                 /* DN for reporting purposes */
1227         struct berval   sai_ndn;                /* Normalized DN */
1228
1229         /* Security Strength Factors */
1230         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1231         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1232         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1233         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1234 } AuthorizationInformation;
1235
1236
1237 #ifdef SLAP_DYNACL
1238 struct slap_op;
1239
1240 /*
1241  * "dynamic" ACL infrastructure (for ACIs and more)
1242  */
1243 typedef int (slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1244 typedef int (slap_dynacl_unparse)( void *priv, struct berval *bv );
1245 typedef int (slap_dynacl_mask)(
1246                 void                    *priv,
1247                 struct slap_op          *op,
1248                 Entry                   *e,
1249                 AttributeDescription    *desc,
1250                 struct berval           *val,
1251                 int                     nmatch,
1252                 regmatch_t              *matches,
1253                 slap_access_t           *grant,
1254                 slap_access_t           *deny );
1255 typedef int (slap_dynacl_destroy)( void *priv );
1256
1257 typedef struct slap_dynacl_t {
1258         char                    *da_name;
1259         slap_dynacl_parse       *da_parse;
1260         slap_dynacl_unparse     *da_unparse;
1261         slap_dynacl_mask        *da_mask;
1262         slap_dynacl_destroy     *da_destroy;
1263
1264         void                    *da_private;
1265         struct slap_dynacl_t    *da_next;
1266 } slap_dynacl_t;
1267 #endif /* SLAP_DYNACL */
1268
1269 /* the DN portion of the "by" part */
1270 typedef struct slap_dn_access {
1271         /* DN pattern */
1272         AuthorizationInformation        a_dnauthz;
1273 #define a_pat                   a_dnauthz.sai_dn
1274
1275         slap_style_t            a_style;
1276         int                     a_level;
1277         int                     a_self_level;
1278         AttributeDescription    *a_at;
1279         int                     a_self;
1280         int                     a_expand;
1281 } slap_dn_access;
1282
1283 /* the "by" part */
1284 typedef struct slap_access {
1285         slap_control_t a_type;
1286
1287 /* strip qualifiers */
1288 #define ACL_LEVEL(p)                    ((p) & ACL_LEVEL_MASK)
1289 #define ACL_QUALIFIERS(p)               ((p) & ~ACL_LEVEL_MASK)
1290
1291 #define ACL_ACCESS2PRIV(access)         ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1292
1293 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1294 #define ACL_PRIV_DISCLOSE               ACL_ACCESS2PRIV( ACL_DISCLOSE )
1295 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1296 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1297 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1298 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1299 #define ACL_PRIV_WADD                   ACL_ACCESS2PRIV( ACL_WADD )
1300 #define ACL_PRIV_WDEL                   ACL_ACCESS2PRIV( ACL_WDEL )
1301 #define ACL_PRIV_WRITE                  ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1302 #define ACL_PRIV_MANAGE                 ACL_ACCESS2PRIV( ACL_MANAGE )
1303
1304 /* NOTE: always use the highest level; current: 0x00ffUL */
1305 #define ACL_PRIV_MASK                   ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1306
1307 /* priv flags */
1308 #define ACL_PRIV_LEVEL                  0x1000UL
1309 #define ACL_PRIV_ADDITIVE               0x2000UL
1310 #define ACL_PRIV_SUBSTRACTIVE           0x4000UL
1311
1312 /* invalid privs */
1313 #define ACL_PRIV_INVALID                0x0UL
1314
1315 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1316 #define ACL_PRIV_ASSIGN(m,p)            do { (m)  =  (p); } while(0)
1317 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1318 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1319
1320 #define ACL_INIT(m)                     ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1321 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1322
1323 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1324
1325 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1326
1327 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1328 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1329 #define ACL_IS_SUBTRACTIVE(m)           ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1330
1331 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1332 #define ACL_LVL_DISCLOSE                (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1333 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1334 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1335 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1336 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1337 #define ACL_LVL_WADD                    (ACL_PRIV_WADD|ACL_LVL_READ)
1338 #define ACL_LVL_WDEL                    (ACL_PRIV_WDEL|ACL_LVL_READ)
1339 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1340 #define ACL_LVL_MANAGE                  (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1341
1342 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1343 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1344 #define ACL_LVL_IS_DISCLOSE(m)          ACL_LVL((m),ACL_LVL_DISCLOSE)
1345 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1346 #define ACL_LVL_IS_COMPARE(m)           ACL_LVL((m),ACL_LVL_COMPARE)
1347 #define ACL_LVL_IS_SEARCH(m)            ACL_LVL((m),ACL_LVL_SEARCH)
1348 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1349 #define ACL_LVL_IS_WADD(m)              ACL_LVL((m),ACL_LVL_WADD)
1350 #define ACL_LVL_IS_WDEL(m)              ACL_LVL((m),ACL_LVL_WDEL)
1351 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1352 #define ACL_LVL_IS_MANAGE(m)            ACL_LVL((m),ACL_LVL_MANAGE)
1353
1354 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1355 #define ACL_LVL_ASSIGN_DISCLOSE(m)      ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1356 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1357 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1358 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1359 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1360 #define ACL_LVL_ASSIGN_WADD(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1361 #define ACL_LVL_ASSIGN_WDEL(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1362 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1363 #define ACL_LVL_ASSIGN_MANAGE(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1364
1365         slap_mask_t     a_access_mask;
1366
1367         /* DN pattern */
1368         slap_dn_access          a_dn;
1369 #define a_dn_pat                a_dn.a_dnauthz.sai_dn
1370 #define a_dn_at                 a_dn.a_at
1371 #define a_dn_self               a_dn.a_self
1372
1373         /* real DN pattern */
1374         slap_dn_access          a_realdn;
1375 #define a_realdn_pat            a_realdn.a_dnauthz.sai_dn
1376 #define a_realdn_at             a_realdn.a_at
1377 #define a_realdn_self           a_realdn.a_self
1378
1379         /* used for ssf stuff
1380          * NOTE: the ssf stuff in a_realdn is ignored */
1381 #define a_authz                 a_dn.a_dnauthz
1382
1383         /* connection related stuff */
1384         slap_style_t a_peername_style;
1385         struct berval   a_peername_pat;
1386         unsigned long   a_peername_addr,
1387                         a_peername_mask;
1388         int             a_peername_port;
1389
1390         slap_style_t a_sockname_style;
1391         struct berval   a_sockname_pat;
1392
1393         slap_style_t a_domain_style;
1394         struct berval   a_domain_pat;
1395         int             a_domain_expand;
1396
1397         slap_style_t a_sockurl_style;
1398         struct berval   a_sockurl_pat;
1399         slap_style_t a_set_style;
1400         struct berval   a_set_pat;
1401
1402 #ifdef SLAP_DYNACL
1403         slap_dynacl_t           *a_dynacl;
1404 #else /* ! SLAP_DYNACL */
1405 #ifdef SLAPD_ACI_ENABLED
1406         /* NOTE: ACIs have been moved under the "dynacl" interface,
1407          * which is currently built only when LDAP_DEVEL is defined.
1408          *
1409          * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1410          * is required to enable ACI support.
1411          */
1412         AttributeDescription    *a_aci_at;
1413 #endif /* SLAPD_ACI_ENABLED */
1414 #endif /* SLAP_DYNACL */
1415
1416         /* ACL Groups */
1417         slap_style_t a_group_style;
1418         struct berval   a_group_pat;
1419         ObjectClass                             *a_group_oc;
1420         AttributeDescription    *a_group_at;
1421
1422         struct slap_access      *a_next;
1423 } Access;
1424
1425 /* the "to" part */
1426 typedef struct slap_acl {
1427         /* "to" part: the entries this acl applies to */
1428         Filter          *acl_filter;
1429         slap_style_t acl_dn_style;
1430         regex_t         acl_dn_re;
1431         struct berval   acl_dn_pat;
1432         AttributeName   *acl_attrs;
1433         slap_style_t    acl_attrval_style;
1434         regex_t         acl_attrval_re;
1435         struct berval   acl_attrval;
1436
1437         /* "by" part: list of who has what access to the entries */
1438         Access  *acl_access;
1439
1440         struct slap_acl *acl_next;
1441 } AccessControl;
1442
1443 typedef struct slap_acl_state {
1444         unsigned as_recorded;
1445 #define ACL_STATE_NOT_RECORDED                  0x0
1446 #define ACL_STATE_RECORDED_VD                   0x1
1447 #define ACL_STATE_RECORDED_NV                   0x2
1448 #define ACL_STATE_RECORDED                              0x3
1449
1450         /* Access state */
1451         AccessControl *as_vd_acl;
1452         AccessControl *as_vi_acl;
1453         slap_mask_t as_vd_acl_mask;
1454         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1455         int as_vd_acl_count;
1456
1457         Access *as_vd_access;
1458         int as_vd_access_count;
1459
1460         int as_result;
1461         AttributeDescription *as_vd_ad;
1462 } AccessControlState;
1463 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1464         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1465
1466 /*
1467  * Backend-info
1468  * represents a backend
1469  */
1470
1471 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1472 typedef struct slap_backend_db BackendDB;               /* per backend database */
1473 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1474 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1475
1476 LDAP_SLAPD_V (int) nBackendInfo;
1477 LDAP_SLAPD_V (int) nBackendDB;
1478 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1479 LDAP_SLAPD_V (slap_be_head) backendDB;
1480 LDAP_SLAPD_V (BackendDB *) frontendDB;
1481
1482 LDAP_SLAPD_V (int) slapMode;
1483 #define SLAP_UNDEFINED_MODE     0x0000
1484 #define SLAP_SERVER_MODE        0x0001
1485 #define SLAP_TOOL_MODE          0x0002
1486 #define SLAP_MODE                       0x0003
1487
1488 #define SLAP_TRUNCATE_MODE      0x0100
1489 #define SLAP_TOOL_READMAIN      0x0200
1490 #define SLAP_TOOL_READONLY      0x0400
1491 #define SLAP_TOOL_QUICK         0x0800
1492
1493 #define SB_TLS_OFF              0
1494 #define SB_TLS_ON               1
1495 #define SB_TLS_CRITICAL 2
1496
1497 typedef struct slap_bindconf {
1498         int sb_tls;
1499         int sb_method;
1500         struct berval sb_binddn;
1501         struct berval sb_cred;
1502         struct berval sb_saslmech;
1503         char *sb_secprops;
1504         struct berval sb_realm;
1505         struct berval sb_authcId;
1506         struct berval sb_authzId;
1507 } slap_bindconf;
1508
1509 struct slap_replica_info {
1510         const char *ri_uri;                     /* supersedes be_replica */
1511         const char *ri_host;            /* points to host part of uri */
1512         BerVarray ri_nsuffix;           /* array of suffixes this replica accepts */
1513         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1514         int ri_exclude;                         /* 1 => exclude ri_attrs */
1515         slap_bindconf ri_bindconf;      /* for back-config */
1516 };
1517
1518 typedef struct slap_verbmasks {
1519         struct berval word;
1520         const int mask;
1521 } slap_verbmasks;
1522
1523 #define SLAP_LIMIT_TIME 1
1524 #define SLAP_LIMIT_SIZE 2
1525
1526 struct slap_limits_set {
1527         /* time limits */
1528         int     lms_t_soft;
1529         int     lms_t_hard;
1530
1531         /* size limits */
1532         int     lms_s_soft;
1533         int     lms_s_hard;
1534         int     lms_s_unchecked;
1535         int     lms_s_pr;
1536         int     lms_s_pr_hide;
1537         int     lms_s_pr_total;
1538 };
1539
1540 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1541 #define SLAP_NO_LIMIT                   -1
1542 #define SLAP_MAX_LIMIT                  2147483647
1543
1544 struct slap_limits {
1545         unsigned                lm_flags;       /* type of pattern */
1546 #define SLAP_LIMITS_UNDEFINED           0x0000U
1547 #define SLAP_LIMITS_EXACT               0x0001U
1548 #define SLAP_LIMITS_BASE                SLAP_LIMITS_EXACT
1549 #define SLAP_LIMITS_ONE                 0x0002U
1550 #define SLAP_LIMITS_SUBTREE             0x0003U
1551 #define SLAP_LIMITS_CHILDREN            0x0004U
1552 #define SLAP_LIMITS_REGEX               0x0005U
1553 #define SLAP_LIMITS_ANONYMOUS           0x0006U
1554 #define SLAP_LIMITS_USERS               0x0007U
1555 #define SLAP_LIMITS_ANY                 0x0008U
1556 #define SLAP_LIMITS_MASK                0x000FU
1557
1558 #define SLAP_LIMITS_TYPE_DN             0x0000U
1559 #define SLAP_LIMITS_TYPE_GROUP          0x0010U
1560 #define SLAP_LIMITS_TYPE_MASK           0x00F0U
1561
1562         regex_t                 lm_regex;       /* regex data for REGEX */
1563
1564         /*
1565          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1566          * pattern for REGEX; NULL for ANONYMOUS, USERS
1567          */
1568         struct berval           lm_pat;
1569
1570         /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1571          * lm_group_oc is objectClass and lm_group_at is attributeType
1572          * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1573          * can only be SLAP_LIMITS_EXACT */
1574         ObjectClass             *lm_group_oc;
1575         AttributeDescription    *lm_group_ad;
1576
1577         struct slap_limits_set  lm_limits;
1578 };
1579
1580 /* temporary aliases */
1581 typedef BackendDB Backend;
1582 #define nbackends nBackendDB
1583 #define backends backendDB
1584
1585 /*
1586  * syncinfo structure for syncrepl
1587  */
1588
1589 struct syncinfo_s;
1590
1591 #define SLAP_SYNC_RID_SIZE      3
1592 #define SLAP_SYNCUUID_SET_SIZE 256
1593
1594 #define SLAP_SYNC_UPDATE_MSGID  2
1595
1596 struct sync_cookie {
1597         struct berval ctxcsn;
1598         struct berval octet_str;
1599         long rid;
1600         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1601 };
1602
1603 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1604
1605 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1606
1607 #ifndef SLAP_MAX_CIDS
1608 #define SLAP_MAX_CIDS   32      /* Maximum number of supported controls */
1609 #endif
1610
1611 struct ConfigOCs;       /* config.h */
1612
1613 struct slap_backend_db {
1614         BackendInfo     *bd_info;       /* pointer to shared backend info */
1615
1616         /* fields in this structure (and routines acting on this structure)
1617            should be renamed from be_ to bd_ */
1618
1619         /* BackendInfo accessors */
1620 #define         be_config       bd_info->bi_db_config
1621 #define         be_type         bd_info->bi_type
1622
1623 #define         be_bind         bd_info->bi_op_bind
1624 #define         be_unbind       bd_info->bi_op_unbind
1625 #define         be_add          bd_info->bi_op_add
1626 #define         be_compare      bd_info->bi_op_compare
1627 #define         be_delete       bd_info->bi_op_delete
1628 #define         be_modify       bd_info->bi_op_modify
1629 #define         be_modrdn       bd_info->bi_op_modrdn
1630 #define         be_search       bd_info->bi_op_search
1631 #define         be_abandon      bd_info->bi_op_abandon
1632 #define         be_cancel       bd_info->bi_op_cancel
1633
1634 #define         be_extended     bd_info->bi_extended
1635
1636 #define         be_chk_referrals        bd_info->bi_chk_referrals
1637 #define         be_chk_controls         bd_info->bi_chk_controls
1638 #define         be_fetch        bd_info->bi_entry_get_rw
1639 #define         be_release      bd_info->bi_entry_release_rw
1640 #define         be_group        bd_info->bi_acl_group
1641 #define         be_attribute    bd_info->bi_acl_attribute
1642 #define         be_operational  bd_info->bi_operational
1643
1644 /*
1645  * define to honor hasSubordinates operational attribute in search filters
1646  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1647  * is fixed).
1648  */
1649 #define         be_has_subordinates bd_info->bi_has_subordinates
1650
1651 #define         be_connection_init      bd_info->bi_connection_init
1652 #define         be_connection_destroy   bd_info->bi_connection_destroy
1653
1654 #ifdef SLAPD_TOOLS
1655 #define         be_entry_open bd_info->bi_tool_entry_open
1656 #define         be_entry_close bd_info->bi_tool_entry_close
1657 #define         be_entry_first bd_info->bi_tool_entry_first
1658 #define         be_entry_next bd_info->bi_tool_entry_next
1659 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1660 #define         be_entry_get bd_info->bi_tool_entry_get
1661 #define         be_entry_put bd_info->bi_tool_entry_put
1662 #define         be_sync bd_info->bi_tool_sync
1663 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1664 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1665 #define         be_entry_modify bd_info->bi_tool_entry_modify
1666 #endif
1667
1668         /* supported controls */
1669         /* note: set to 0 if the database does not support the control;
1670          * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1671         char            be_ctrls[SLAP_MAX_CIDS + 1];
1672
1673 /* Database flags */
1674 #define SLAP_DBFLAG_NOLASTMOD           0x0001U
1675 #define SLAP_DBFLAG_NO_SCHEMA_CHECK     0x0002U
1676 #define SLAP_DBFLAG_GLUE_INSTANCE       0x0010U /* a glue backend */
1677 #define SLAP_DBFLAG_GLUE_SUBORDINATE    0x0020U /* child of a glue hierarchy */
1678 #define SLAP_DBFLAG_GLUE_LINKED         0x0040U /* child is connected to parent */
1679 #define SLAP_DBFLAG_GLUE_ADVERTISE      0x0080U /* advertise in rootDSE */
1680 #define SLAP_DBFLAG_OVERLAY             0x0100U /* this db struct is an overlay */
1681 #define SLAP_DBFLAG_GLOBAL_OVERLAY      0x0200U /* this db struct is a global overlay */
1682 #define SLAP_DBFLAG_SHADOW              0x8000U /* a shadow */
1683 #define SLAP_DBFLAG_SYNC_SHADOW         0x1000U /* a sync shadow */
1684 #define SLAP_DBFLAG_SLURP_SHADOW        0x2000U /* a slurp shadow */
1685         slap_mask_t     be_flags;
1686 #define SLAP_DBFLAGS(be)                        ((be)->be_flags)
1687 #define SLAP_NOLASTMOD(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1688 #define SLAP_LASTMOD(be)                        (!SLAP_NOLASTMOD(be))
1689 #define SLAP_ISOVERLAY(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1690 #define SLAP_NO_SCHEMA_CHECK(be)        \
1691         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1692 #define SLAP_GLUE_INSTANCE(be)          \
1693         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1694 #define SLAP_GLUE_SUBORDINATE(be)       \
1695         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1696 #define SLAP_GLUE_LINKED(be)            \
1697         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1698 #define SLAP_GLUE_ADVERTISE(be) \
1699         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1700 #define SLAP_SHADOW(be)                         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1701 #define SLAP_SYNC_SHADOW(be)                    (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1702 #define SLAP_SLURP_SHADOW(be)                   (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1703
1704         slap_mask_t     be_restrictops;         /* restriction operations */
1705 #define SLAP_RESTRICT_OP_ADD            0x0001U
1706 #define SLAP_RESTRICT_OP_BIND           0x0002U
1707 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1708 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1709 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1710 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1711 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1712 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1713 #define SLAP_RESTRICT_OP_MASK           0x00FFU
1714
1715 #define SLAP_RESTRICT_READONLY          0x80000000U
1716
1717 #define SLAP_RESTRICT_EXOP_START_TLS            0x0100U
1718 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD        0x0200U
1719 #define SLAP_RESTRICT_EXOP_WHOAMI               0x0400U
1720 #define SLAP_RESTRICT_EXOP_CANCEL               0x0800U
1721 #define SLAP_RESTRICT_EXOP_MASK                 0xFF00U
1722
1723 #define SLAP_RESTRICT_OP_READS  \
1724         ( SLAP_RESTRICT_OP_COMPARE      \
1725         | SLAP_RESTRICT_OP_SEARCH )
1726 #define SLAP_RESTRICT_OP_WRITES \
1727         ( SLAP_RESTRICT_OP_ADD    \
1728         | SLAP_RESTRICT_OP_DELETE \
1729         | SLAP_RESTRICT_OP_MODIFY \
1730         | SLAP_RESTRICT_OP_RENAME )
1731
1732 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1733 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1734 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1735
1736 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1737
1738 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1739 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1740 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1741
1742 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1743 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1744
1745 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1746
1747         slap_mask_t     be_requires;    /* pre-operation requirements */
1748 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1749 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1750 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1751 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1752 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1753
1754         /* Required Security Strength Factor */
1755         slap_ssf_set_t be_ssf_set;
1756
1757         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1758         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1759         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1760         struct berval be_schemandn;     /* normalized subschema DN */
1761         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1762         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1763         struct berval be_rootpw;        /* the magic "root" password for this db        */
1764         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1765 #define be_sizelimit    be_def_limit.lms_s_soft
1766 #define be_timelimit    be_def_limit.lms_t_soft
1767         struct slap_limits_set be_def_limit; /* default limits */
1768         struct slap_limits **be_limits; /* regex-based size and time limits */
1769         AccessControl *be_acl;  /* access control list for this backend    */
1770         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1771
1772         /* Replica Information */
1773         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1774         char    *be_replogfile; /* replication log file (in master)        */
1775         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1776         BerVarray       be_update_refs; /* where to refer modifying clients to */
1777         struct          be_pcl  *be_pending_csn_list;
1778         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1779         ldap_pvt_thread_mutex_t                                 *be_pcl_mutexp;
1780         struct syncinfo_s                                               *be_syncinfo; /* For syncrepl */
1781
1782         void    *be_pb;         /* Netscape plugin */
1783         struct ConfigOCs *be_cf_ocs;
1784
1785         void    *be_private;    /* anything the backend database needs     */
1786         LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1787 };
1788
1789 struct slap_conn;
1790 struct slap_op;
1791
1792 /* Backend function typedefs */
1793 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1794 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1795         const char *fname, int lineno,
1796         int argc, char **argv));
1797 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1798 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1799 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1800
1801 typedef int (BI_db_init) LDAP_P((Backend *bd));
1802 typedef int (BI_db_config) LDAP_P((Backend *bd,
1803         const char *fname, int lineno,
1804         int argc, char **argv));
1805 typedef int (BI_db_open) LDAP_P((Backend *bd));
1806 typedef int (BI_db_close) LDAP_P((Backend *bd));
1807 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1808
1809 typedef struct req_bind_s {
1810         int rb_method;
1811         struct berval rb_cred;
1812         struct berval rb_edn;
1813         slap_ssf_t rb_ssf;
1814         struct berval rb_tmp_mech;      /* FIXME: temporary */
1815 } req_bind_s;
1816
1817 typedef struct req_search_s {
1818         int rs_scope;
1819         int rs_deref;
1820         int rs_slimit;
1821         int rs_tlimit;
1822         /* NULL means be_isroot evaluated to TRUE */
1823         struct slap_limits_set *rs_limit;
1824         int rs_attrsonly;
1825         AttributeName *rs_attrs;
1826         Filter *rs_filter;
1827         struct berval rs_filterstr;
1828 } req_search_s;
1829
1830 typedef struct req_compare_s {
1831         AttributeAssertion *rs_ava;
1832 } req_compare_s;
1833
1834 typedef struct req_modify_s {
1835         Modifications *rs_modlist;
1836         int rs_increment;               /* FIXME: temporary */
1837 } req_modify_s;
1838
1839 typedef struct req_modrdn_s {
1840         struct berval rs_newrdn;
1841         struct berval rs_nnewrdn;
1842         struct berval *rs_newSup;
1843         struct berval *rs_nnewSup;
1844         int rs_deleteoldrdn;
1845 } req_modrdn_s;
1846
1847 typedef struct req_add_s {
1848         Entry *rs_e;
1849         Modifications *rs_modlist;      /* FIXME: temporary */
1850 } req_add_s;
1851
1852 typedef struct req_abandon_s {
1853         ber_int_t rs_msgid;
1854 } req_abandon_s;
1855
1856 #ifdef LDAP_DEVEL
1857 #define SLAP_EXOP_HIDE 0x0000
1858 #else
1859 #define SLAP_EXOP_HIDE 0x8000
1860 #endif
1861 #define SLAP_EXOP_WRITES 0x0001         /* Exop does writes */
1862
1863 typedef struct req_extended_s {
1864         struct berval rs_reqoid;
1865         int rs_flags;
1866         struct berval *rs_reqdata;
1867 } req_extended_s;
1868
1869 typedef struct req_pwdexop_s {
1870         struct berval rs_reqoid;
1871         int rs_flags;
1872         struct berval rs_old;
1873         struct berval rs_new;
1874         Modifications *rs_mods;
1875         Modifications **rs_modtail;
1876 } req_pwdexop_s;
1877
1878 typedef enum slap_reply_e {
1879         REP_RESULT,
1880         REP_SASL,
1881         REP_EXTENDED,
1882         REP_SEARCH,
1883         REP_SEARCHREF,
1884         REP_INTERMEDIATE
1885 } slap_reply_t;
1886
1887 typedef struct rep_sasl_s {
1888         struct berval *r_sasldata;
1889 } rep_sasl_s;
1890
1891 typedef struct rep_extended_s {
1892         const char *r_rspoid;
1893         struct berval *r_rspdata;
1894 } rep_extended_s;
1895
1896 typedef struct rep_search_s {
1897         Entry *r_entry;
1898         slap_mask_t r_attr_flags;
1899 #define SLAP_ATTRS_UNDEFINED    (0x00U)
1900 #define SLAP_OPATTRS_NO                 (0x01U)
1901 #define SLAP_OPATTRS_YES                (0x02U)
1902 #define SLAP_USERATTRS_NO               (0x10U)
1903 #define SLAP_USERATTRS_YES              (0x20U)
1904 #define SLAP_OPATTRS_MASK(f)    ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1905 #define SLAP_OPATTRS(f)                 (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1906 #define SLAP_USERATTRS_MASK(f)  ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1907 #define SLAP_USERATTRS(f)               \
1908         (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1909
1910         Attribute *r_operational_attrs;
1911         AttributeName *r_attrs;
1912         int r_nentries;
1913         BerVarray r_v2ref;
1914 } rep_search_s;
1915
1916 typedef struct slap_rep {
1917         slap_reply_t sr_type;
1918         ber_tag_t sr_tag;
1919         ber_int_t sr_msgid;
1920         ber_int_t sr_err;
1921         const char *sr_matched;
1922         const char *sr_text;
1923         BerVarray sr_ref;
1924         LDAPControl **sr_ctrls;
1925         union sr_u {
1926                 rep_sasl_s sru_sasl;
1927                 rep_extended_s sru_extended;
1928                 rep_search_s sru_search;
1929         } sr_un;
1930         slap_mask_t sr_flags;
1931 #define REP_ENTRY_MODIFIABLE    0x0001U
1932 #define REP_ENTRY_MUSTBEFREED   0x0002U
1933 #define REP_ENTRY_MUSTRELEASE   0x0004U
1934 #define REP_MATCHED_MUSTBEFREED 0x0010U
1935 #define REP_REF_MUSTBEFREED             0x0020U
1936 } SlapReply;
1937
1938 /* short hands for response members */
1939 #define sr_attrs sr_un.sru_search.r_attrs
1940 #define sr_entry sr_un.sru_search.r_entry
1941 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1942 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1943 #define sr_v2ref sr_un.sru_search.r_v2ref
1944 #define sr_nentries sr_un.sru_search.r_nentries
1945 #define sr_rspoid sr_un.sru_extended.r_rspoid
1946 #define sr_rspdata sr_un.sru_extended.r_rspdata
1947 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1948
1949 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1950 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1951 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1952 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1953 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1954 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1955 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1956 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1957 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1958 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1959 typedef int (BI_op_extended) LDAP_P((
1960         struct slap_op *op, struct slap_rep *rs ));
1961 typedef int (BI_chk_referrals) LDAP_P((
1962         struct slap_op *op, struct slap_rep *rs ));
1963 typedef int (BI_chk_controls) LDAP_P((
1964         struct slap_op *op, struct slap_rep *rs ));
1965 typedef int (BI_entry_release_rw)
1966         LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1967 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1968         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1969 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1970 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1971         Entry *e, int *hasSubs ));
1972 #ifdef SLAP_OVERLAY_ACCESS
1973 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
1974         AttributeDescription *desc, struct berval *val, slap_access_t access,
1975         AccessControlState *state, slap_mask_t *maskp ));
1976 #endif /* SLAP_OVERLAY_ACCESS */
1977
1978 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1979         struct slap_conn *c ));
1980 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1981         struct slap_conn *c ));
1982
1983 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1984 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1985 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1986 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1987 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1988 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1989         struct berval *text ));
1990 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1991 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1992 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1993 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1994 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1995         struct berval *text ));
1996
1997 struct slap_backend_info {
1998         char    *bi_type; /* type of backend */
1999
2000         /*
2001          * per backend type routines:
2002          * bi_init: called to allocate a backend_info structure,
2003          *              called once BEFORE configuration file is read.
2004          *              bi_init() initializes this structure hence is
2005          *              called directly from be_initialize()
2006          * bi_config: called per 'backend' specific option
2007          *              all such options must before any 'database' options
2008          *              bi_config() is called only from read_config()
2009          * bi_open: called to open each database, called
2010          *              once AFTER configuration file is read but
2011          *              BEFORE any bi_db_open() calls.
2012          *              bi_open() is called from backend_startup()
2013          * bi_close: called to close each database, called
2014          *              once during shutdown after all bi_db_close calls.
2015          *              bi_close() is called from backend_shutdown()
2016          * bi_destroy: called to destroy each database, called
2017          *              once during shutdown after all bi_db_destroy calls.
2018          *              bi_destory() is called from backend_destroy()
2019          */
2020         BI_init *bi_init;
2021         BI_config       *bi_config;
2022         BI_open *bi_open;
2023         BI_close        *bi_close;
2024         BI_destroy      *bi_destroy;
2025
2026         /*
2027          * per database routines:
2028          * bi_db_init: called to initialize each database,
2029          *      called upon reading 'database <type>'
2030          *      called only from backend_db_init()
2031          * bi_db_config: called to configure each database,
2032          *  called per database to handle per database options
2033          *      called only from read_config()
2034          * bi_db_open: called to open each database
2035          *      called once per database immediately AFTER bi_open()
2036          *      calls but before daemon startup.
2037          *  called only by backend_startup()
2038          * bi_db_close: called to close each database
2039          *      called once per database during shutdown but BEFORE
2040          *  any bi_close call.
2041          *  called only by backend_shutdown()
2042          * bi_db_destroy: called to destroy each database
2043          *  called once per database during shutdown AFTER all
2044          *  bi_close calls but before bi_destory calls.
2045          *  called only by backend_destory()
2046          */
2047         BI_db_init      *bi_db_init;
2048         BI_db_config    *bi_db_config;
2049         BI_db_open      *bi_db_open;
2050         BI_db_close     *bi_db_close;
2051         BI_db_destroy   *bi_db_destroy;
2052
2053         /* LDAP Operations Handling Routines */
2054         BI_op_bind      *bi_op_bind;
2055         BI_op_unbind    *bi_op_unbind;
2056         BI_op_search    *bi_op_search;
2057         BI_op_compare   *bi_op_compare;
2058         BI_op_modify    *bi_op_modify;
2059         BI_op_modrdn    *bi_op_modrdn;
2060         BI_op_add       *bi_op_add;
2061         BI_op_delete    *bi_op_delete;
2062         BI_op_abandon   *bi_op_abandon;
2063         BI_op_cancel    *bi_op_cancel;
2064
2065         /* Extended Operations Helper */
2066         BI_op_extended  *bi_extended;
2067
2068         /* Auxilary Functions */
2069         BI_operational          *bi_operational;
2070         BI_chk_referrals        *bi_chk_referrals;
2071         BI_chk_controls         *bi_chk_controls;
2072         BI_entry_get_rw         *bi_entry_get_rw;
2073         BI_entry_release_rw     *bi_entry_release_rw;
2074
2075         BI_has_subordinates     *bi_has_subordinates;
2076 #ifdef SLAP_OVERLAY_ACCESS
2077         BI_access_allowed       *bi_access_allowed;
2078 #endif /* SLAP_OVERLAY_ACCESS */
2079
2080         BI_connection_init      *bi_connection_init;
2081         BI_connection_destroy   *bi_connection_destroy;
2082
2083         /* hooks for slap tools */
2084         BI_tool_entry_open      *bi_tool_entry_open;
2085         BI_tool_entry_close     *bi_tool_entry_close;
2086         BI_tool_entry_first     *bi_tool_entry_first;
2087         BI_tool_entry_next      *bi_tool_entry_next;
2088         BI_tool_entry_get       *bi_tool_entry_get;
2089         BI_tool_entry_put       *bi_tool_entry_put;
2090         BI_tool_entry_reindex   *bi_tool_entry_reindex;
2091         BI_tool_sync            *bi_tool_sync;
2092         BI_tool_dn2id_get       *bi_tool_dn2id_get;
2093         BI_tool_id2entry_get    *bi_tool_id2entry_get;
2094         BI_tool_entry_modify    *bi_tool_entry_modify;
2095
2096 #define SLAP_INDEX_ADD_OP               0x0001
2097 #define SLAP_INDEX_DELETE_OP    0x0002
2098
2099         slap_mask_t     bi_flags; /* backend flags */
2100 #define SLAP_BFLAG_MONITOR                      0x0001U /* a monitor backend */
2101 #define SLAP_BFLAG_CONFIG                       0x0002U /* a config backend */
2102 #define SLAP_BFLAG_NOLASTMODCMD         0x0010U
2103 #define SLAP_BFLAG_INCREMENT            0x0100U
2104 #define SLAP_BFLAG_ALIASES                      0x1000U
2105 #define SLAP_BFLAG_REFERRALS            0x2000U
2106 #define SLAP_BFLAG_SUBENTRIES           0x4000U
2107 #define SLAP_BFLAG_DYNAMIC                      0x8000U
2108
2109 #define SLAP_BFLAGS(be)         ((be)->bd_info->bi_flags)
2110 #define SLAP_MONITOR(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2111 #define SLAP_CONFIG(be)         (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2112 #define SLAP_INCREMENT(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2113 #define SLAP_ALIASES(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2114 #define SLAP_REFERRALS(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2115 #define SLAP_SUBENTRIES(be)     (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2116 #define SLAP_DYNAMIC(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2117 #define SLAP_NOLASTMODCMD(be)   (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2118 #define SLAP_LASTMODCMD(be)     (!SLAP_NOLASTMODCMD(be))
2119
2120         char    **bi_controls;          /* supported controls */
2121         char    bi_ctrls[SLAP_MAX_CIDS + 1];
2122
2123         unsigned int bi_nDB;    /* number of databases of this type */
2124         struct ConfigOCs *bi_cf_ocs;
2125         void    *bi_private;    /* anything the backend type needs */
2126         LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2127 };
2128
2129 #define c_authtype      c_authz.sai_method
2130 #define c_authmech      c_authz.sai_mech
2131 #define c_dn            c_authz.sai_dn
2132 #define c_ndn           c_authz.sai_ndn
2133 #define c_ssf                   c_authz.sai_ssf
2134 #define c_transport_ssf c_authz.sai_transport_ssf
2135 #define c_tls_ssf               c_authz.sai_tls_ssf
2136 #define c_sasl_ssf              c_authz.sai_sasl_ssf
2137
2138 #define o_authtype      o_authz.sai_method
2139 #define o_authmech      o_authz.sai_mech
2140 #define o_dn            o_authz.sai_dn
2141 #define o_ndn           o_authz.sai_ndn
2142 #define o_ssf                   o_authz.sai_ssf
2143 #define o_transport_ssf o_authz.sai_transport_ssf
2144 #define o_tls_ssf               o_authz.sai_tls_ssf
2145 #define o_sasl_ssf              o_authz.sai_sasl_ssf
2146
2147 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2148
2149 typedef struct slap_callback {
2150         struct slap_callback *sc_next;
2151         slap_response *sc_response;
2152         slap_response *sc_cleanup;
2153         void *sc_private;
2154 } slap_callback;
2155
2156 struct slap_overinfo;
2157
2158 typedef struct slap_overinst {
2159         BackendInfo on_bi;
2160         slap_response *on_response;
2161         struct slap_overinfo *on_info;
2162         struct slap_overinst *on_next;
2163 } slap_overinst;
2164
2165 typedef struct slap_overinfo {
2166         BackendInfo oi_bi;
2167         BackendInfo *oi_orig;
2168         struct slap_overinst *oi_list;
2169 } slap_overinfo;
2170
2171 /* Should successive callbacks in a chain be processed? */
2172 #define SLAP_CB_FREEME          0x4000
2173 #define SLAP_CB_CONTINUE        0x8000
2174
2175 /*
2176  * Paged Results state
2177  */
2178 typedef unsigned long PagedResultsCookie;
2179 typedef struct slap_paged_state {
2180         Backend *ps_be;
2181         ber_int_t ps_size;
2182         PagedResultsCookie ps_cookie;
2183         int ps_count;
2184 } PagedResultsState;
2185
2186 struct slap_csn_entry {
2187         struct berval ce_csn;
2188         unsigned long ce_opid;
2189         unsigned long ce_connid;
2190 #define SLAP_CSN_PENDING        1
2191 #define SLAP_CSN_COMMIT         2
2192         long ce_state;
2193         LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2194 };
2195
2196 /*
2197  * Caches the result of a backend_group check for ACL evaluation
2198  */
2199 typedef struct slap_gacl {
2200         struct slap_gacl *ga_next;
2201         Backend *ga_be;
2202         ObjectClass *ga_oc;
2203         AttributeDescription *ga_at;
2204         int ga_res;
2205         ber_len_t ga_len;
2206         char ga_ndn[1];
2207 } GroupAssertion;
2208
2209 struct slap_control_ids {
2210         int sc_assert;
2211         int sc_preRead;
2212         int sc_postRead;
2213         int sc_proxyAuthz;
2214         int sc_manageDIT;
2215         int sc_manageDSAit;
2216         int sc_modifyIncrement;
2217         int sc_noOp;
2218         int sc_pagedResults;
2219 #ifdef LDAP_DEVEL
2220         int sc_sortedResults;
2221 #endif
2222         int sc_valuesReturnFilter;
2223         int sc_permissiveModify;
2224         int sc_domainScope;
2225         int sc_treeDelete;
2226         int sc_searchOptions;
2227         int sc_subentries;
2228         int sc_LDAPsync;
2229 };
2230
2231 /*
2232  * represents an operation pending from an ldap client
2233  */
2234 typedef struct slap_op_header {
2235         unsigned long oh_opid;  /* id of this operation */
2236         unsigned long oh_connid; /* id of conn initiating this op */
2237         struct slap_conn *oh_conn;      /* connection spawning this op */
2238
2239         ber_int_t       oh_msgid;       /* msgid of the request */
2240         ber_int_t       oh_protocol;    /* version of the LDAP protocol used by client */
2241
2242         ldap_pvt_thread_t       oh_tid; /* thread handling this op */
2243
2244         void    *oh_threadctx;          /* thread pool thread context */
2245         void    *oh_tmpmemctx;          /* slab malloc context */
2246         BerMemoryFunctions *oh_tmpmfuncs;
2247
2248         char            oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2249
2250 #ifdef LDAP_SLAPI
2251         void    *oh_pb;                  /* NS-SLAPI plugin */
2252         void    *oh_extensions;         /* NS-SLAPI plugin */
2253 #endif
2254 } Opheader;
2255
2256 typedef struct slap_op {
2257         Opheader *o_hdr;
2258
2259 #define o_opid o_hdr->oh_opid
2260 #define o_connid o_hdr->oh_connid
2261 #define o_conn o_hdr->oh_conn
2262 #define o_msgid o_hdr->oh_msgid
2263 #define o_protocol o_hdr->oh_protocol
2264 #define o_tid o_hdr->oh_tid
2265 #define o_threadctx o_hdr->oh_threadctx
2266 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2267 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2268
2269 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2270 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2271 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2272 #define o_tmpfree       o_tmpmfuncs->bmf_free
2273
2274 #define o_log_prefix o_hdr->oh_log_prefix
2275
2276 #ifdef LDAP_SLAPI
2277 #define o_pb o_hdr->oh_pb
2278 #define o_extensions o_hdr->oh_extensions
2279 #endif
2280
2281         ber_tag_t       o_tag;          /* tag of the request */
2282         time_t          o_time;         /* time op was initiated */
2283
2284         BackendDB       *o_bd;  /* backend DB processing this op */
2285         struct berval   o_req_dn;       /* DN of target of request */
2286         struct berval   o_req_ndn;
2287
2288         union o_req_u {
2289                 req_add_s oq_add;
2290                 req_bind_s oq_bind;
2291                 req_compare_s oq_compare;
2292                 req_modify_s oq_modify;
2293                 req_modrdn_s oq_modrdn;
2294                 req_search_s oq_search;
2295                 req_abandon_s oq_abandon;
2296                 req_abandon_s oq_cancel;
2297                 req_extended_s oq_extended;
2298                 req_pwdexop_s oq_pwdexop;
2299         } o_request;
2300
2301 /* short hands for union members */
2302 #define oq_add o_request.oq_add
2303 #define oq_bind o_request.oq_bind
2304 #define oq_compare o_request.oq_compare
2305 #define oq_modify o_request.oq_modify
2306 #define oq_modrdn o_request.oq_modrdn
2307 #define oq_search o_request.oq_search
2308 #define oq_abandon o_request.oq_abandon
2309 #define oq_cancel o_request.oq_cancel
2310 #define oq_extended o_request.oq_extended
2311 #define oq_pwdexop o_request.oq_pwdexop
2312
2313 /* short hands for inner request members */
2314 #define orb_method oq_bind.rb_method
2315 #define orb_cred oq_bind.rb_cred
2316 #define orb_edn oq_bind.rb_edn
2317 #define orb_ssf oq_bind.rb_ssf
2318 #define orb_tmp_mech oq_bind.rb_tmp_mech
2319
2320 #define ors_scope oq_search.rs_scope
2321 #define ors_deref oq_search.rs_deref
2322 #define ors_slimit oq_search.rs_slimit
2323 #define ors_tlimit oq_search.rs_tlimit
2324 #define ors_limit oq_search.rs_limit
2325 #define ors_attrsonly oq_search.rs_attrsonly
2326 #define ors_attrs oq_search.rs_attrs
2327 #define ors_filter oq_search.rs_filter
2328 #define ors_filterstr oq_search.rs_filterstr
2329
2330 #define orr_newrdn oq_modrdn.rs_newrdn
2331 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2332 #define orr_newSup oq_modrdn.rs_newSup
2333 #define orr_nnewSup oq_modrdn.rs_nnewSup
2334 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2335
2336 #define orc_ava oq_compare.rs_ava
2337 #define ora_e oq_add.rs_e
2338 #define ora_modlist oq_add.rs_modlist
2339 #define orn_msgid oq_abandon.rs_msgid
2340 #define orm_modlist oq_modify.rs_modlist
2341 #define orm_increment oq_modify.rs_increment
2342
2343 #define ore_reqoid oq_extended.rs_reqoid
2344 #define ore_flags oq_extended.rs_flags
2345 #define ore_reqdata oq_extended.rs_reqdata
2346         volatile sig_atomic_t o_abandon;        /* abandon flag */
2347         volatile sig_atomic_t o_cancel;         /* cancel flag */
2348 #define SLAP_CANCEL_NONE                                0x00
2349 #define SLAP_CANCEL_REQ                                 0x01
2350 #define SLAP_CANCEL_ACK                                 0x02
2351 #define SLAP_CANCEL_DONE                                0x03
2352
2353         GroupAssertion *o_groups;
2354         char o_do_not_cache;    /* don't cache groups from this op */
2355         char o_is_auth_check;   /* authorization in progress */
2356
2357 #define SLAP_CONTROL_NONE       0
2358 #define SLAP_CONTROL_IGNORED    1
2359 #define SLAP_CONTROL_NONCRITICAL 2
2360 #define SLAP_CONTROL_CRITICAL   3
2361 #define SLAP_CONTROL_MASK       3
2362
2363 /* spare bits for simple flags */
2364 #define SLAP_CONTROL_SHIFT      4       /* shift to reach data bits */
2365 #define SLAP_CONTROL_DATA0      0x10
2366 #define SLAP_CONTROL_DATA1      0x20
2367 #define SLAP_CONTROL_DATA2      0x40
2368 #define SLAP_CONTROL_DATA3      0x80
2369
2370
2371 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2372
2373         char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2374         void **o_controls;              /* per-control state */
2375
2376 #define o_managedit                             o_ctrlflag[slap_cids.sc_manageDIT]
2377 #define get_manageDIT(op)               _SCM((op)->o_managedit)
2378
2379 #define o_managedsait   o_ctrlflag[slap_cids.sc_manageDSAit]
2380 #define get_manageDSAit(op)                             _SCM((op)->o_managedsait)
2381
2382 #define o_noop  o_ctrlflag[slap_cids.sc_noOp]
2383 #define o_proxy_authz   o_ctrlflag[slap_cids.sc_proxyAuthz]
2384 #define o_subentries    o_ctrlflag[slap_cids.sc_subentries]
2385
2386 #define get_subentries(op)                              _SCM((op)->o_subentries)
2387 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2388
2389 #define set_subentries_visibility(op)   ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2390 #define get_subentries_visibility(op)   (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2391
2392 #define o_assert        o_ctrlflag[slap_cids.sc_assert]
2393 #define get_assert(op)                                  ((int)(op)->o_assert)
2394 #define o_assertion     o_controls[slap_cids.sc_assert]
2395 #define get_assertion(op)                               ((op)->o_assertion)
2396
2397 #define o_valuesreturnfilter    o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2398 #define o_vrFilter      o_controls[slap_cids.sc_valuesReturnFilter]
2399
2400 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2401 #define o_permissive_modify     o_ctrlflag[slap_cids.sc_permissiveModify]
2402 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
2403 #else
2404 #define get_permissiveModify(op)                (0)
2405 #endif
2406
2407 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2408 #define o_domain_scope  o_ctrlflag[slap_cids.sc_domainScope]
2409 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
2410 #else
2411 #define get_domainScope(op)                             (0)
2412 #endif
2413
2414 #ifdef LDAP_CONTROL_X_TREE_DELETE
2415 #define o_tree_delete   o_ctrlflag[slap_cids.sc_treeDelete]
2416 #define get_treeDelete(op)                              ((int)(op)->o_tree_delete)
2417 #else
2418 #define get_treeDelete(op)                              (0)
2419 #endif
2420
2421 #define o_preread       o_ctrlflag[slap_cids.sc_preRead]
2422 #define o_postread      o_ctrlflag[slap_cids.sc_postRead]
2423
2424 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2425 #define o_postread_attrs        o_controls[slap_cids.sc_postRead]
2426
2427 #define o_pagedresults  o_ctrlflag[slap_cids.sc_pagedResults]
2428 #define o_pagedresults_state    o_controls[slap_cids.sc_pagedResults]
2429 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2430
2431 #ifdef LDAP_DEVEL
2432 #define o_sortedresults         o_ctrlflag[slap_cids.sc_sortedResults]
2433 #endif
2434
2435 #define o_sync                  o_ctrlflag[slap_cids.sc_LDAPsync]
2436
2437         AuthorizationInformation o_authz;
2438
2439         BerElement      *o_ber;         /* ber of the request */
2440         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2441         slap_callback *o_callback;      /* callback pointers */
2442         LDAPControl     **o_ctrls;       /* controls */
2443
2444         void    *o_private;     /* anything the backend needs */
2445
2446         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2447
2448         int o_nocaching;
2449         int     o_delete_glue_parent;
2450
2451 } Operation;
2452 #define OPERATION_BUFFER_SIZE   (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2453
2454 #define send_ldap_error( op, rs, err, text ) do { \
2455                 (rs)->sr_err = err; (rs)->sr_text = text; \
2456                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2457         } while (0)
2458 #define send_ldap_discon( op, rs, err, text ) do { \
2459                 (rs)->sr_err = err; (rs)->sr_text = text; \
2460                 send_ldap_disconnect( op, rs ); \
2461         } while (0)
2462
2463 typedef void (SEND_LDAP_RESULT)(
2464         struct slap_op *op, struct slap_rep *rs);
2465 typedef int (SEND_SEARCH_ENTRY)(
2466         struct slap_op *op, struct slap_rep *rs);
2467 typedef int (SEND_SEARCH_REFERENCE)(
2468         struct slap_op *op, struct slap_rep *rs);
2469 typedef void (SEND_LDAP_EXTENDED)(
2470         struct slap_op *op, struct slap_rep *rs);
2471 typedef void (SEND_LDAP_INTERMEDIATE)(
2472         struct slap_op *op, struct slap_rep *rs);
2473
2474 #define send_ldap_result( op, rs ) \
2475         ((op)->o_conn->c_send_ldap_result)( op, rs )
2476 #define send_search_entry( op, rs ) \
2477         ((op)->o_conn->c_send_search_entry)( op, rs )
2478 #define send_search_reference( op, rs ) \
2479         ((op)->o_conn->c_send_search_reference)( op, rs )
2480 #define send_ldap_extended( op, rs ) \
2481         ((op)->o_conn->c_send_ldap_extended)( op, rs )
2482 #define send_ldap_intermediate( op, rs ) \
2483         ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2484
2485 typedef struct slap_listener Listener;
2486
2487 /*
2488  * represents a connection from an ldap client
2489  */
2490 typedef struct slap_conn {
2491         int                     c_struct_state; /* structure management state */
2492         int                     c_conn_state;   /* connection state */
2493         int                     c_conn_idx;             /* slot in connections array */
2494
2495         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2496         Sockbuf         *c_sb;                  /* ber connection stuff           */
2497
2498         /* only can be changed by connect_init */
2499         time_t          c_starttime;    /* when the connection was opened */
2500         time_t          c_activitytime; /* when the connection was last used */
2501         unsigned long           c_connid;       /* id of this connection for stats*/
2502
2503         struct berval   c_peer_domain;  /* DNS name of client */
2504         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2505         Listener        *c_listener;
2506 #define c_listener_url c_listener->sl_url       /* listener URL */
2507 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2508
2509         /* only can be changed by binding thread */
2510         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2511         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2512         struct berval   c_sasl_dn;      /* temporary storage */
2513         struct berval   c_sasl_authz_dn;        /* SASL proxy authz */
2514
2515         /* authorization backend */
2516         Backend *c_authz_backend;
2517
2518         AuthorizationInformation c_authz;
2519
2520         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2521
2522         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2523         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2524
2525         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2526         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2527
2528         BerElement      *c_currentber;  /* ber we're attempting to read */
2529         int             c_writewaiter;  /* true if writer is waiting */
2530
2531 #define CONN_IS_TLS     1
2532 #define CONN_IS_UDP     2
2533 #define CONN_IS_CLIENT  3
2534
2535 #ifdef LDAP_CONNECTIONLESS
2536         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2537 #endif
2538 #ifdef HAVE_TLS
2539         int     c_is_tls;               /* true if this LDAP over raw TLS */
2540         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2541 #endif
2542         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2543         int     c_sasl_done;            /* SASL completed once */
2544         void    *c_sasl_authctx;        /* SASL authentication context */
2545         void    *c_sasl_sockctx;        /* SASL security layer context */
2546         void    *c_sasl_extra;          /* SASL session extra stuff */
2547         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2548
2549         PagedResultsState c_pagedresults_state; /* paged result state */
2550
2551         long    c_n_ops_received;       /* num of ops received (next op_id) */
2552         long    c_n_ops_executing;      /* num of ops currently executing */
2553         long    c_n_ops_pending;        /* num of ops pending execution */
2554         long    c_n_ops_completed;      /* num of ops completed */
2555
2556         long    c_n_get;                /* num of get calls */
2557         long    c_n_read;               /* num of read calls */
2558         long    c_n_write;              /* num of write calls */
2559
2560         void    *c_pb;                  /* Netscape plugin */
2561         void    *c_extensions;          /* Netscape plugin */
2562
2563         /*
2564          * Client connection handling
2565          */
2566         ldap_pvt_thread_start_t *c_clientfunc;
2567         void    *c_clientarg;
2568
2569         /*
2570          * These are the "callbacks" that are available for back-ends to
2571          * supply data back to connected clients that are connected
2572          * through the "front-end".
2573          */
2574         SEND_LDAP_RESULT *c_send_ldap_result;
2575         SEND_SEARCH_ENTRY *c_send_search_entry;
2576         SEND_SEARCH_REFERENCE *c_send_search_reference;
2577         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2578 #ifdef LDAP_RES_INTERMEDIATE
2579         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2580 #endif
2581
2582 } Connection;
2583
2584 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2585 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2586         do { \
2587                 if ( ldap_debug & (level) ) \
2588                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2589                 if ( ldap_syslog & (level) ) \
2590                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2591                                 (arg2), (arg3) ); \
2592         } while (0)
2593 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2594 #elif defined(LDAP_DEBUG)
2595 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2596         do { \
2597                 if ( ldap_debug & (level) ) \
2598                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2599         } while (0)
2600 #define StatslogTest( level ) (ldap_debug & (level))
2601 #else
2602 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2603 #define StatslogTest( level ) (0)
2604 #endif
2605
2606 /*
2607  * listener; need to access it from monitor backend
2608  */
2609 struct slap_listener {
2610         struct berval sl_url;
2611         struct berval sl_name;
2612         mode_t  sl_perms;
2613 #ifdef HAVE_TLS
2614         int             sl_is_tls;
2615 #endif
2616 #ifdef LDAP_CONNECTIONLESS
2617         int     sl_is_udp;              /* UDP listener is also data port */
2618 #endif
2619         int     sl_is_mute;     /* Listening is temporarily disabled */
2620         ber_socket_t sl_sd;
2621         Sockaddr sl_sa;
2622 #define sl_addr sl_sa.sa_in_addr
2623 };
2624
2625 #ifdef SLAPD_MONITOR
2626 /*
2627  * Operation indices
2628  */
2629 enum {
2630         SLAP_OP_BIND = 0,
2631         SLAP_OP_UNBIND,
2632         SLAP_OP_ADD,
2633         SLAP_OP_DELETE,
2634         SLAP_OP_MODRDN,
2635         SLAP_OP_MODIFY,
2636         SLAP_OP_COMPARE,
2637         SLAP_OP_SEARCH,
2638         SLAP_OP_ABANDON,
2639         SLAP_OP_EXTENDED,
2640         SLAP_OP_LAST
2641 };
2642 #endif /* SLAPD_MONITOR */
2643
2644 typedef struct slap_counters_t {
2645         ldap_pvt_thread_mutex_t sc_sent_mutex;
2646         ldap_pvt_mp_t           sc_bytes;
2647         ldap_pvt_mp_t           sc_pdu;
2648         ldap_pvt_mp_t           sc_entries;
2649         ldap_pvt_mp_t           sc_refs;
2650
2651         ldap_pvt_thread_mutex_t sc_ops_mutex;
2652         ldap_pvt_mp_t           sc_ops_completed;
2653         ldap_pvt_mp_t           sc_ops_initiated;
2654 #ifdef SLAPD_MONITOR
2655         ldap_pvt_mp_t           sc_ops_completed_[SLAP_OP_LAST];
2656         ldap_pvt_mp_t           sc_ops_initiated_[SLAP_OP_LAST];
2657 #endif /* SLAPD_MONITOR */
2658 } slap_counters_t;
2659
2660 /*
2661  * Better know these all around slapd
2662  */
2663 #define SLAP_LDAPDN_PRETTY 0x1
2664 #define SLAP_LDAPDN_MAXLEN 8192
2665
2666 /* number of response controls supported */
2667 #define SLAP_MAX_RESPONSE_CONTROLS   6
2668
2669 #ifdef LDAP_DEVEL
2670 #define SLAP_CTRL_HIDE                          0x00000000U
2671 #else
2672 #define SLAP_CTRL_HIDE                          0x80000000U
2673 #endif
2674
2675 #define SLAP_CTRL_GLOBAL                        0x00800000U
2676 #define SLAP_CTRL_GLOBAL_SEARCH         0x00010000U     /* for NOOP */
2677
2678 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2679 #define SLAP_CTRL_ABANDON                       0x00000001U
2680 #define SLAP_CTRL_ADD                           0x00002002U
2681 #define SLAP_CTRL_BIND                          0x00000004U
2682 #define SLAP_CTRL_COMPARE                       0x00001008U
2683 #define SLAP_CTRL_DELETE                        0x00002010U
2684 #define SLAP_CTRL_MODIFY                        0x00002020U
2685 #define SLAP_CTRL_RENAME                        0x00002040U
2686 #define SLAP_CTRL_SEARCH                        0x00001080U
2687 #define SLAP_CTRL_UNBIND                        0x00000100U
2688
2689 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2690 #define SLAP_CTRL_UPDATE \
2691         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2692 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2693
2694 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2695         Operation *op,
2696         SlapReply *rs,
2697         LDAPControl *ctrl ));
2698
2699 #define SLAP_SLAB_SIZE  (1024*1024)
2700 #define SLAP_SLAB_STACK 1
2701 #define SLAP_SLAB_SOBLOCK 64
2702
2703 #define SLAP_ZONE_ALLOC 1
2704 #undef SLAP_ZONE_ALLOC
2705
2706 #ifdef LDAP_COMP_MATCH
2707 /*
2708  * Extensible Filter Definition
2709  *
2710  * MatchingRuleAssertion := SEQUENCE {
2711  *      matchingRule    [1] MatchingRuleId OPTIONAL,
2712  *      type            [2] AttributeDescription OPTIONAL,
2713  *      matchValue      [3] AssertionValue,
2714  *      dnAttributes    [4] BOOLEAN DEFAULT FALSE }
2715  *
2716  * Following ComponentFilter is contained in matchValue
2717  *
2718  * ComponentAssertion ::= SEQUENCE {
2719  *      component               ComponentReference (SIZE(1..MAX)) OPTIONAL
2720  *      useDefaultValues        BOOLEAN DEFAULT TRUE,
2721  *      rule                    MATCHING-RULE.&id,
2722  *      value                   MATCHING-RULE.&AssertionType }
2723  *
2724  * ComponentFilter ::= CHOICE {
2725  *      item    [0] ComponentAssertion,
2726  *      and     [1] SEQUENCE OF ComponentFilter,
2727  *      or      [2] SEQUENCE OF ComponentFilter,
2728  *      not     [3] ComponentFilter }
2729  */
2730
2731 #define LDAP_COMPREF_IDENTIFIER         ((ber_tag_t) 0x80U)
2732 #define LDAP_COMPREF_FROM_BEGINNING     ((ber_tag_t) 0x81U)
2733 #define LDAP_COMPREF_COUNT              ((ber_tag_t) 0x82U)
2734 #define LDAP_COMPREF_FROM_END           ((ber_tag_t) 0x83U)
2735 #define LDAP_COMPREF_CONTENT            ((ber_tag_t) 0x84U)
2736 #define LDAP_COMPREF_SELECT             ((ber_tag_t) 0x85U)
2737 #define LDAP_COMPREF_ALL                ((ber_tag_t) 0x86U)
2738 #define LDAP_COMPREF_DEFINED            ((ber_tag_t) 0x87U)
2739 #define LDAP_COMPREF_UNDEFINED          ((ber_tag_t) 0x88U)
2740
2741 #define LDAP_COMP_FILTER_AND            ((ber_tag_t) 0xa0U)
2742 #define LDAP_COMP_FILTER_OR             ((ber_tag_t) 0xa1U)
2743 #define LDAP_COMP_FILTER_NOT            ((ber_tag_t) 0xa2U)
2744 #define LDAP_COMP_FILTER_ITEM           ((ber_tag_t) 0xa3U)
2745 #define LDAP_COMP_FILTER_UNDEFINED      ((ber_tag_t) 0xa4U)
2746
2747 typedef struct slap_component_id {
2748         int     ci_type;
2749         struct slap_component_id *ci_next;
2750
2751         union comp_id_value{
2752                 BerValue        ci_identifier;
2753                 ber_int_t       ci_from_beginning;
2754                 ber_int_t       ci_count;
2755                 ber_int_t       ci_from_end;
2756                 ber_int_t       ci_content;
2757                 BerValue        ci_select_value;
2758                 char            ci_all;
2759         } ci_val;
2760 } ComponentId;
2761
2762 typedef struct slap_component_reference {
2763         ComponentId     *cr_list;
2764         ComponentId     *cr_curr;
2765         struct berval   cr_string;
2766         int cr_len;
2767         /* Component Indexing */
2768         int             cr_asn_type_id;
2769         slap_mask_t     cr_indexmask;
2770         AttributeDescription* cr_ad;
2771         BerVarray       cr_nvals;
2772         struct slap_component_reference* cr_next;
2773 } ComponentReference;
2774
2775 typedef struct slap_component_assertion {
2776         ComponentReference      *ca_comp_ref;
2777         ber_int_t               ca_use_def;
2778         MatchingRule            *ca_ma_rule;
2779         struct berval           ca_ma_value;
2780         ComponentData           ca_comp_data; /* componentized assertion */
2781         struct slap_component_filter    *ca_cf;
2782         MatchingRuleAssertion   *ca_mra;
2783 } ComponentAssertion;
2784
2785 typedef struct slap_component_filter {
2786         ber_tag_t cf_choice;
2787         union cf_un_u {
2788                 ber_int_t cf_un_result;
2789                 ComponentAssertion *cf_un_ca;
2790                 struct slap_component_filter *cf_un_complex;
2791         } cf_un;
2792
2793 #define cf_ca           cf_un.cf_un_ca
2794 #define cf_result       cf_un.cf_un_result
2795 #define cf_and          cf_un.cf_un_complex
2796 #define cf_or           cf_un.cf_un_complex
2797 #define cf_not          cf_un.cf_un_complex
2798 #define cf_any          cf_un.cf_un_complex
2799
2800         struct slap_component_filter *cf_next;
2801 } ComponentFilter;
2802
2803 typedef struct slap_component_assertion_value {
2804         char* cav_buf;
2805         char* cav_ptr;
2806         char* cav_end;
2807 } ComponentAssertionValue;
2808
2809 typedef int encoder_func LDAP_P((
2810         void* b,
2811         void* comp));
2812
2813 struct slap_component_syntax_info;
2814
2815 typedef int gser_decoder_func LDAP_P((
2816         void* mem_op,
2817         void* b,
2818         struct slap_component_syntax_info** comp_syn_info,
2819         int* len,
2820         int mode));
2821
2822 typedef int comp_free_func LDAP_P((
2823         void* b));
2824
2825 typedef int ber_decoder_func LDAP_P((
2826         void* mem_op,
2827         void* b,
2828         int tag,
2829         int elmtLen,
2830         struct slap_component_syntax_info* comp_syn_info,
2831         int* len,
2832         int mode));
2833
2834 typedef int ber_tag_decoder_func LDAP_P((
2835         void* mem_op,
2836         void* b,
2837         struct slap_component_syntax_info* comp_syn_info,
2838         int* len,
2839         int mode));
2840
2841 typedef void* extract_component_from_id_func LDAP_P((
2842         void* mem_op,
2843         ComponentReference* cr,
2844         void* comp ));
2845
2846 typedef void* convert_attr_to_comp_func LDAP_P ((
2847         Attribute* a,
2848         Syntax* syn,
2849         struct berval* bv ));
2850
2851 typedef void* alloc_nibble_func LDAP_P ((
2852         int initial_size,
2853         int increment_size ));
2854
2855 typedef void free_nibble_func LDAP_P ((
2856         void* nm ));
2857
2858 struct slap_component_syntax_info;
2859 typedef void convert_assert_to_comp_func LDAP_P ((
2860         void *mem_op,
2861         struct slap_component_syntax_info* csi_attr,
2862         struct berval* bv,
2863         struct slap_component_syntax_info** csi,
2864         int* len,
2865         int mode ));
2866
2867 typedef int convert_asn_to_ldap_func LDAP_P ((
2868         struct slap_component_syntax_info* csi,
2869         struct berval *bv ));
2870
2871 typedef void free_component_func LDAP_P ((
2872         void* mem_op));
2873
2874 typedef int test_component_func LDAP_P ((
2875         void* attr_mem_op,
2876         void* assert_mem_op,
2877         struct slap_component_syntax_info* csi,
2878         struct slap_component_assertion* ca));
2879
2880 typedef void* test_membership_func LDAP_P ((
2881         void* in ));
2882
2883 typedef void* get_component_info_func LDAP_P ((
2884         int in ));
2885
2886 struct slap_component_syntax_info;
2887
2888 typedef int component_encoder_func LDAP_P ((
2889         void* mem_op,
2890         struct slap_component_syntax_info* csi,
2891         struct berval* nvals ));
2892
2893 typedef int allcomponent_matching_func LDAP_P((
2894         char* oid,
2895         struct slap_component_syntax_info* comp1,
2896         struct slap_component_syntax_info* comp));
2897
2898 typedef struct slap_component_desc {
2899         /* Don't change the order of following four fields */
2900         int             cd_tag;
2901         AttributeType   *cd_comp_type;
2902         struct berval   cd_ad_type;/* ad_type, ad_cname */
2903         struct berval   cd_ad_cname;/* ad_type, ad_cname */
2904         unsigned        cd_flags; /*ad_flags*/
2905         int             cd_type;
2906         int             cd_type_id;
2907         encoder_func            *cd_ldap_encoder;
2908         encoder_func            *cd_gser_encoder;
2909         encoder_func            *cd_ber_encoder;
2910         gser_decoder_func       *cd_gser_decoder;
2911         ber_decoder_func        *cd_ber_decoder;
2912         comp_free_func          *cd_free;
2913         extract_component_from_id_func*  cd_extract_i;
2914         allcomponent_matching_func      *cd_all_match;
2915 } ComponentDesc;
2916
2917 typedef struct slap_component_syntax_info {
2918         Syntax* csi_syntax;
2919         ComponentDesc* csi_comp_desc;
2920 } ComponentSyntaxInfo;
2921
2922 #endif
2923
2924 /* slab heap data structures */
2925
2926 struct slab_object {
2927     void *so_ptr;
2928         int so_blockhead;
2929     LDAP_LIST_ENTRY(slab_object) so_link;
2930 };
2931
2932 struct slab_heap {
2933     void *sh_base;
2934     void *sh_last;
2935     void *sh_end;
2936         int sh_stack;
2937         int sh_maxorder;
2938     unsigned char **sh_map;
2939     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2940         LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2941 };
2942
2943 #ifdef SLAP_ZONE_ALLOC
2944 #define SLAP_ZONE_SIZE 0x80000          /* 512KB */
2945 #define SLAP_ZONE_SHIFT 19
2946 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2947 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2948 #define SLAP_ZONE_DELTA 0x800000        /* 8MB */
2949 #define SLAP_ZONE_ZOBLOCK 256
2950
2951 struct zone_object {
2952         void *zo_ptr;
2953         int zo_siz;
2954         int zo_idx;
2955         int zo_blockhead;
2956         LDAP_LIST_ENTRY(zone_object) zo_link;
2957 };
2958
2959 struct zone_latency_history {
2960         double zlh_latency;
2961         LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2962 };
2963
2964 struct zone_heap {
2965         int zh_fd;
2966         int zh_zonesize;
2967         int zh_zoneorder;
2968         int zh_numzones;
2969         int zh_maxzones;
2970         int zh_deltazones;
2971         void **zh_zones;
2972         ldap_pvt_thread_rdwr_t *zh_znlock;
2973         Avlnode *zh_zonetree;
2974         unsigned char ***zh_maps;
2975         int *zh_seqno;
2976         LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2977         LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2978         ldap_pvt_thread_mutex_t zh_mutex;
2979         ldap_pvt_thread_rdwr_t zh_lock;
2980         double zh_ema_latency;
2981         unsigned long zh_ema_samples;
2982         LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2983                                 zh_latency_history_queue;
2984         int zh_latency_history_qlen;
2985         int zh_latency_jump;
2986         int zh_swapping;
2987 };
2988 #endif
2989
2990 #define SLAP_BACKEND_INIT_MODULE(b) \
2991         static BackendInfo bi;  \
2992         int \
2993         init_module( int argc, char *argv[] ) \
2994         { \
2995                 bi.bi_type = #b ; \
2996                 bi.bi_init = b ## _back_initialize; \
2997                 backend_add( &bi ); \
2998                 return 0; \
2999         }
3000
3001 LDAP_END_DECL
3002
3003 #include "proto-slap.h"
3004
3005 #endif /* _SLAP_H_ */