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