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