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