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