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