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