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