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