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