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