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