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 /* not yet implemented */
  68 #endif
  69
  70 #if defined(LDAP_DEVEL) && defined(ENABLE_REWRITE)
  71 /* use librewrite for sasl-regexp */
  72 #define SLAP_AUTH_REWRITE       1
  73 #endif /* LDAP_DEVEL && ENABLE_REWRITE */
  74
  75 /*
  76  * SLAPD Memory allocation macros
  77  *
  78  * Unlike ch_*() routines, these routines do not assert() upon
  79  * allocation error.  They are intended to be used instead of
  80  * ch_*() routines where the caller has implemented proper
  81  * checking for and handling of allocation errors.
  82  *
  83  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  84  */
  85 #define SLAP_MALLOC(s)      ber_memalloc((s))
  86 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  87 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  88 #define SLAP_FREE(p)        ber_memfree((p))
  89 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  90 #define SLAP_STRDUP(s)      ber_strdup((s))
  91 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  92
  93 #ifdef f_next
  94 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  95 #endif
  96
  97 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  98 #define SLAPD_ANONYMOUS "cn=anonymous"
  99
 100 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
 101  * This is a value used internally by the backends. It is needed to allow
 102  * adding values that already exist without getting an error as required by
 103  * modrdn when the new rdn was already an attribute value itself.
 104  */
 105 #define SLAP_MOD_SOFTADD        0x1000
 106
 107 #define MAXREMATCHES (100)
 108
 109 #define SLAP_MAX_WORKER_THREADS         (16)
 110
 111 #define SLAP_MAX_SYNCREPL_THREADS       (8)
 112
 113 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
 114 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
 115
 116 #define SLAP_CONN_MAX_PENDING_DEFAULT   100
 117 #define SLAP_CONN_MAX_PENDING_AUTH      1000
 118
 119 #define SLAP_TEXT_BUFLEN (256)
 120
 121 /* psuedo error code indicating abandoned operation */
 122 #define SLAPD_ABANDON (-1024)
 123
 124 /* psuedo error code indicating disconnect */
 125 #define SLAPD_DISCONNECT (-1025)
 126
 127 /* unknown config file directive */
 128 #define SLAP_CONF_UNKNOWN (-1026)
 129
 130 /* We assume "C" locale, that is US-ASCII */
 131 #define ASCII_SPACE(c)  ( (c) == ' ' )
 132 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
 133 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
 134 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
 135 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
 136 #define ASCII_HEXLOWER(c)       ( (c) >= 'a' && (c) <= 'f' )
 137 #define ASCII_HEXUPPER(c)       ( (c) >= 'A' && (c) <= 'F' )
 138 #define ASCII_HEX(c)    ( ASCII_DIGIT(c) || \
 139         ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
 140 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
 141 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
 142
 143 #define SLAP_NIBBLE(c) ((c)&0x0f)
 144 #define SLAP_ESCAPE_CHAR ('\\')
 145 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 146 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 147
 148 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 149         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 150
 151 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 152 /* NOTE: for consistency, this macro must only operate
 153  * on normalized/pretty DN, such that ';' is never used
 154  * as RDN separator, and all occurrences of ';' must be escaped */
 155 #define DN_SEPARATOR(c) ((c) == ',')
 156 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 157 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 158 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 159
 160 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 161 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 162 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 163 #define OID_SEPARATOR(c)        ( (c) == '.' )
 164 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 165
 166 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 167 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
 168
 169 #define AD_LEADCHAR(c)  ( ATTR_LEADCHAR(c) )
 170 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 171
 172 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 173
 174 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 175         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 176         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 177         (c) == '?' || (c) == ' ' || (c) == '=' )
 178 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 179
 180 /* must match in schema_init.c */
 181 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 182 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 183 #define SLAPD_INTEGER_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.27"
 184 #define SLAPD_GROUP_ATTR                "member"
 185 #define SLAPD_GROUP_CLASS               "groupOfNames"
 186 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 187 #define SLAPD_ROLE_CLASS                "organizationalRole"
 188
 189 #ifdef SLAPD_ACI_ENABLED
 190 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 191 #endif
 192
 193 /* change this to "OpenLDAPset" */
 194 #define SLAPD_ACI_SET_ATTR              "template"
 195
 196 #define SLAPD_TOP_OID                   "2.5.6.0"
 197
 198 LDAP_SLAPD_V (int) slap_debug;
 199
 200 typedef unsigned long slap_mask_t;
 201
 202 /* Security Strength Factor */
 203 typedef unsigned slap_ssf_t;
 204
 205 typedef struct slap_ssf_set {
 206         slap_ssf_t sss_ssf;
 207         slap_ssf_t sss_transport;
 208         slap_ssf_t sss_tls;
 209         slap_ssf_t sss_sasl;
 210         slap_ssf_t sss_update_ssf;
 211         slap_ssf_t sss_update_transport;
 212         slap_ssf_t sss_update_tls;
 213         slap_ssf_t sss_update_sasl;
 214         slap_ssf_t sss_simple_bind;
 215 } slap_ssf_set_t;
 216
 217 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
 218 #define SLAP_GETDN_AUTHCID 2
 219 #define SLAP_GETDN_AUTHZID 4
 220
 221 /*
 222  * Index types
 223  */
 224 #define SLAP_INDEX_TYPE           0x00FFUL
 225 #define SLAP_INDEX_UNDEFINED      0x0001UL
 226 #define SLAP_INDEX_PRESENT        0x0002UL
 227 #define SLAP_INDEX_EQUALITY       0x0004UL
 228 #define SLAP_INDEX_APPROX         0x0008UL
 229 #define SLAP_INDEX_SUBSTR         0x0010UL
 230 #define SLAP_INDEX_EXTENDED               0x0020UL
 231
 232 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 233
 234 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 235
 236 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 237
 238 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 239 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 240 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 241 #define SLAP_INDEX_SUBSTR_DEFAULT \
 242         ( SLAP_INDEX_SUBSTR \
 243         | SLAP_INDEX_SUBSTR_INITIAL \
 244         | SLAP_INDEX_SUBSTR_ANY \
 245         | SLAP_INDEX_SUBSTR_FINAL )
 246
 247 /* defaults for initial/final substring indices */
 248 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT     2
 249 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT     4
 250
 251 /* defaults for any substring indices */
 252 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT               4
 253 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT              2
 254
 255 #define SLAP_INDEX_FLAGS         0xF000UL
 256 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 257 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
 258
 259 /*
 260  * there is a single index for each attribute.  these prefixes ensure
 261  * that there is no collision among keys.
 262  */
 263 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 264 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 265 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 266 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 267 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 268 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 269
 270 #define SLAP_SYNTAX_MATCHINGRULES_OID    "1.3.6.1.4.1.1466.115.121.1.30"
 271 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID   "1.3.6.1.4.1.1466.115.121.1.3"
 272 #define SLAP_SYNTAX_OBJECTCLASSES_OID    "1.3.6.1.4.1.1466.115.121.1.37"
 273 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
 274 #define SLAP_SYNTAX_CONTENTRULE_OID              "1.3.6.1.4.1.1466.115.121.1.16"
 275
 276 /*
 277  * represents schema information for a database
 278  */
 279 #define SLAP_SCHERR_OUTOFMEM                    1
 280 #define SLAP_SCHERR_CLASS_NOT_FOUND             2
 281 #define SLAP_SCHERR_CLASS_BAD_USAGE             3
 282 #define SLAP_SCHERR_CLASS_BAD_SUP               4
 283 #define SLAP_SCHERR_CLASS_DUP                   5
 284 #define SLAP_SCHERR_ATTR_NOT_FOUND              6
 285 #define SLAP_SCHERR_ATTR_BAD_MR                 7
 286 #define SLAP_SCHERR_ATTR_BAD_USAGE              8
 287 #define SLAP_SCHERR_ATTR_BAD_SUP                9
 288 #define SLAP_SCHERR_ATTR_INCOMPLETE             10
 289 #define SLAP_SCHERR_ATTR_DUP                    11
 290 #define SLAP_SCHERR_MR_NOT_FOUND                12
 291 #define SLAP_SCHERR_MR_INCOMPLETE               13
 292 #define SLAP_SCHERR_MR_DUP                              14
 293 #define SLAP_SCHERR_SYN_NOT_FOUND               15
 294 #define SLAP_SCHERR_SYN_DUP                             16
 295 #define SLAP_SCHERR_NO_NAME                             17
 296 #define SLAP_SCHERR_NOT_SUPPORTED               18
 297 #define SLAP_SCHERR_BAD_DESCR                   19
 298 #define SLAP_SCHERR_OIDM                                20
 299 #define SLAP_SCHERR_CR_DUP                              21
 300 #define SLAP_SCHERR_CR_BAD_STRUCT               22
 301 #define SLAP_SCHERR_CR_BAD_AUX                  23
 302 #define SLAP_SCHERR_CR_BAD_AT                   24
 303 #define SLAP_SCHERR_LAST                                SLAP_SCHERR_CR_BAD_AT
 304
 305 typedef union slap_sockaddr {
 306         struct sockaddr sa_addr;
 307         struct sockaddr_in sa_in_addr;
 308 #ifdef LDAP_PF_INET6
 309         struct sockaddr_storage sa_storage;
 310         struct sockaddr_in6 sa_in6_addr;
 311 #endif
 312 #ifdef LDAP_PF_LOCAL
 313         struct sockaddr_un sa_un_addr;
 314 #endif
 315 } Sockaddr;
 316
 317 #ifdef LDAP_PF_INET6
 318 extern int slap_inet4or6;
 319 #endif
 320
 321 typedef struct slap_oid_macro {
 322         struct berval som_oid;
 323         char **som_names;
 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 } AttributeAssertion;
 908
 909 typedef struct slap_ss_assertion {
 910         AttributeDescription    *sa_desc;
 911         struct berval           sa_initial;
 912         struct berval           *sa_any;
 913         struct berval           sa_final;
 914 } SubstringsAssertion;
 915
 916 #ifdef LDAP_COMP_MATCH
 917 struct slap_component_filter;
 918 #endif
 919
 920 typedef struct slap_mr_assertion {
 921         MatchingRule            *ma_rule;       /* optional */
 922         struct berval           ma_rule_text;  /* optional */
 923         AttributeDescription    *ma_desc;       /* optional */
 924         int                                             ma_dnattrs; /* boolean */
 925         struct berval           ma_value;       /* required */
 926 #ifdef LDAP_COMP_MATCH
 927         struct slap_component_filter* ma_cf; /* component filter */
 928 #endif
 929 } MatchingRuleAssertion;
 930
 931 /*
 932  * represents a search filter
 933  */
 934 typedef struct slap_filter {
 935         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 936 #define SLAPD_FILTER_COMPUTED           ((ber_tag_t) -1)
 937 #define SLAPD_FILTER_DN_ONE                     ((ber_tag_t) -2)
 938 #define SLAPD_FILTER_DN_SUBTREE         ((ber_tag_t) -3)
 939 #ifdef LDAP_SCOPE_SUBORDINATE
 940 #define SLAPD_FILTER_DN_CHILDREN        ((ber_tag_t) -4)
 941 #endif
 942
 943         union f_un_u {
 944                 /* precomputed result */
 945                 ber_int_t f_un_result;
 946
 947                 /* DN */
 948                 struct berval *f_un_dn;
 949
 950                 /* present */
 951                 AttributeDescription *f_un_desc;
 952
 953                 /* simple value assertion */
 954                 AttributeAssertion *f_un_ava;
 955
 956                 /* substring assertion */
 957                 SubstringsAssertion *f_un_ssa;
 958
 959                 /* matching rule assertion */
 960                 MatchingRuleAssertion *f_un_mra;
 961
 962 #define f_dn                    f_un.f_un_dn
 963 #define f_desc                  f_un.f_un_desc
 964 #define f_ava                   f_un.f_un_ava
 965 #define f_av_desc               f_un.f_un_ava->aa_desc
 966 #define f_av_value              f_un.f_un_ava->aa_value
 967 #define f_sub                   f_un.f_un_ssa
 968 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 969 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 970 #define f_sub_any               f_un.f_un_ssa->sa_any
 971 #define f_sub_final             f_un.f_un_ssa->sa_final
 972 #define f_mra                   f_un.f_un_mra
 973 #define f_mr_rule               f_un.f_un_mra->ma_rule
 974 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 975 #define f_mr_desc               f_un.f_un_mra->ma_desc
 976 #define f_mr_value              f_un.f_un_mra->ma_value
 977 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 978
 979                 /* and, or, not */
 980                 struct slap_filter *f_un_complex;
 981         } f_un;
 982
 983 #define f_result        f_un.f_un_result
 984 #define f_and           f_un.f_un_complex
 985 #define f_or            f_un.f_un_complex
 986 #define f_not           f_un.f_un_complex
 987 #define f_list          f_un.f_un_complex
 988
 989         struct slap_filter      *f_next;
 990 } Filter;
 991
 992 /* compare routines can return undefined */
 993 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 994
 995 typedef struct slap_valuesreturnfilter {
 996         ber_tag_t       vrf_choice;
 997
 998         union vrf_un_u {
 999                 /* precomputed result */
1000                 ber_int_t vrf_un_result;
1001
1002                 /* DN */
1003                 char *vrf_un_dn;
1004
1005                 /* present */
1006                 AttributeDescription *vrf_un_desc;
1007
1008                 /* simple value assertion */
1009                 AttributeAssertion *vrf_un_ava;
1010
1011                 /* substring assertion */
1012                 SubstringsAssertion *vrf_un_ssa;
1013
1014                 /* matching rule assertion */
1015                 MatchingRuleAssertion *vrf_un_mra;
1016
1017 #define vrf_result              vrf_un.vrf_un_result
1018 #define vrf_dn                  vrf_un.vrf_un_dn
1019 #define vrf_desc                vrf_un.vrf_un_desc
1020 #define vrf_ava                 vrf_un.vrf_un_ava
1021 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
1022 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
1023 #define vrf_ssa                 vrf_un.vrf_un_ssa
1024 #define vrf_sub                 vrf_un.vrf_un_ssa
1025 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
1026 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1027 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
1028 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
1029 #define vrf_mra                 vrf_un.vrf_un_mra
1030 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
1031 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
1032 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
1033 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
1034 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
1035
1036
1037         } vrf_un;
1038
1039         struct slap_valuesreturnfilter  *vrf_next;
1040 } ValuesReturnFilter;
1041
1042 #ifdef LDAP_COMP_MATCH
1043 struct slap_component_syntax_info;
1044 typedef struct  slap_component_data {
1045         void* cd_mem_op;/* nibble memory handler */
1046         struct slap_component_syntax_info** cd_tree;/* component tree */
1047 } ComponentData;
1048 #endif
1049
1050 /*
1051  * represents an attribute (description + values)
1052  */
1053 typedef struct slap_attr {
1054         AttributeDescription *a_desc;
1055         BerVarray       a_vals;         /* preserved values */
1056         BerVarray       a_nvals;        /* normalized values */
1057 #ifdef LDAP_COMP_MATCH
1058         ComponentData   *a_comp_data; /* component values */
1059 #endif
1060         struct slap_attr *a_next;
1061         unsigned a_flags;
1062 #define SLAP_ATTR_IXADD         0x1U
1063 #define SLAP_ATTR_IXDEL         0x2U
1064 } Attribute;
1065
1066
1067 /*
1068  * the id used in the indexes to refer to an entry
1069  */
1070 typedef unsigned long   ID;
1071 #define NOID    ((ID)~0)
1072
1073 /*
1074  * represents an entry in core
1075  */
1076 typedef struct slap_entry {
1077         /*
1078          * The ID field should only be changed before entry is
1079          * inserted into a cache.  The ID value is backend
1080          * specific.
1081          */
1082         ID              e_id;
1083
1084         struct berval e_name;   /* name (DN) of this entry */
1085         struct berval e_nname;  /* normalized name (DN) of this entry */
1086
1087         /* for migration purposes */
1088 #define e_dn e_name.bv_val
1089 #define e_ndn e_nname.bv_val
1090
1091         Attribute       *e_attrs;       /* list of attributes + values */
1092
1093         slap_mask_t     e_ocflags;
1094
1095         struct berval   e_bv;           /* For entry_encode/entry_decode */
1096
1097         /* for use by the backend for any purpose */
1098         void*   e_private;
1099 } Entry;
1100
1101 /*
1102  * A list of LDAPMods
1103  */
1104 typedef struct slap_mod {
1105         int sm_op;
1106         AttributeDescription *sm_desc;
1107         struct berval sm_type;
1108         BerVarray sm_values;
1109         BerVarray sm_nvalues;
1110 } Modification;
1111
1112 typedef struct slap_mod_list {
1113         Modification sml_mod;
1114 #define sml_op          sml_mod.sm_op
1115 #define sml_desc        sml_mod.sm_desc
1116 #define sml_type        sml_mod.sm_type
1117 #define sml_values      sml_mod.sm_values
1118 #define sml_nvalues     sml_mod.sm_nvalues
1119         struct slap_mod_list *sml_next;
1120 } Modifications;
1121
1122 typedef struct slap_ldap_modlist {
1123         LDAPMod ml_mod;
1124         struct slap_ldap_modlist *ml_next;
1125 #define ml_op           ml_mod.mod_op
1126 #define ml_type         ml_mod.mod_type
1127 #define ml_values       ml_mod.mod_values
1128 } LDAPModList;
1129
1130 /*
1131  * represents an access control list
1132  */
1133 typedef enum slap_access_e {
1134         ACL_INVALID_ACCESS = -1,
1135         ACL_NONE = 0,
1136         ACL_DISCLOSE,
1137         ACL_AUTH,
1138         ACL_COMPARE,
1139         ACL_SEARCH,
1140         ACL_READ,
1141         ACL_WRITE,
1142         ACL_MANAGE
1143 } slap_access_t;
1144
1145 typedef enum slap_control_e {
1146         ACL_INVALID_CONTROL     = 0,
1147         ACL_STOP,
1148         ACL_CONTINUE,
1149         ACL_BREAK
1150 } slap_control_t;
1151
1152 typedef enum slap_style_e {
1153         ACL_STYLE_REGEX = 0,
1154         ACL_STYLE_EXPAND,
1155         ACL_STYLE_BASE,
1156         ACL_STYLE_ONE,
1157         ACL_STYLE_SUBTREE,
1158         ACL_STYLE_CHILDREN,
1159         ACL_STYLE_ATTROF,
1160         ACL_STYLE_ANONYMOUS,
1161         ACL_STYLE_USERS,
1162         ACL_STYLE_SELF,
1163         ACL_STYLE_IP,
1164         ACL_STYLE_PATH
1165 } slap_style_t;
1166
1167 typedef struct slap_authz_info {
1168         ber_tag_t       sai_method;                     /* LDAP_AUTH_* from <ldap.h> */
1169         struct berval   sai_mech;               /* SASL Mechanism */
1170         struct berval   sai_dn;                 /* DN for reporting purposes */
1171         struct berval   sai_ndn;                /* Normalized DN */
1172
1173         /* Security Strength Factors */
1174         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1175         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1176         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1177         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1178 } AuthorizationInformation;
1179
1180
1181 #ifdef SLAP_DYNACL
1182 struct slap_op;
1183
1184 /*
1185  * "dynamic" ACL infrastructure (for ACIs and more)
1186  */
1187 typedef int (*slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1188 typedef int (*slap_dynacl_print)( void *priv );
1189 typedef int (*slap_dynacl_mask)(
1190                 void                    *priv,
1191                 struct slap_op          *op,
1192                 Entry                   *e,
1193                 AttributeDescription    *desc,
1194                 struct berval           *val,
1195                 int                     nmatch,
1196                 regmatch_t              *matches,
1197                 slap_access_t           *grant,
1198                 slap_access_t           *deny );
1199 typedef int (*slap_dynacl_destroy)( void *priv );
1200
1201 typedef struct slap_dynacl_t {
1202         char                    *da_name;
1203         slap_dynacl_parse       da_parse;
1204         slap_dynacl_print       da_print;
1205         slap_dynacl_mask        da_mask;
1206         slap_dynacl_destroy     da_destroy;
1207
1208         void                    *da_private;
1209         struct slap_dynacl_t    *da_next;
1210 } slap_dynacl_t;
1211 #endif /* SLAP_DYNACL */
1212
1213 /* the "by" part */
1214 typedef struct slap_access {
1215         slap_control_t a_type;
1216
1217 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1218
1219 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1220 #define ACL_PRIV_DISCLOSE               ACL_ACCESS2PRIV( ACL_DISCLOSE )
1221 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1222 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1223 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1224 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1225 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
1226 #define ACL_PRIV_MANAGE                 ACL_ACCESS2PRIV( ACL_MANAGE )
1227
1228 #define ACL_PRIV_MASK                   0x00ffUL
1229
1230 /* priv flags */
1231 #define ACL_PRIV_LEVEL                  0x1000UL
1232 #define ACL_PRIV_ADDITIVE               0x2000UL
1233 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
1234
1235 /* invalid privs */
1236 #define ACL_PRIV_INVALID                0x0UL
1237
1238 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1239 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
1240 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1241 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1242
1243 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1244 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1245
1246 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1247
1248 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1249
1250 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1251 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1252 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1253
1254 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1255 #define ACL_LVL_DISCLOSE                (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1256 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1257 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1258 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1259 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1260 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1261 #define ACL_LVL_MANAGE                  (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1262
1263 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1264 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1265 #define ACL_LVL_IS_DISCLOSE(m)  ACL_LVL((m),ACL_LVL_DISCLOSE)
1266 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1267 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
1268 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
1269 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1270 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1271 #define ACL_LVL_IS_MANAGE(m)    ACL_LVL((m),ACL_LVL_MANAGE)
1272
1273 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1274 #define ACL_LVL_ASSIGN_DISCLOSE(m)      ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1275 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1276 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1277 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1278 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1279 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1280 #define ACL_LVL_ASSIGN_MANAGE(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1281
1282         slap_mask_t     a_access_mask;
1283
1284         AuthorizationInformation        a_authz;
1285 #define a_dn_pat        a_authz.sai_dn
1286
1287         slap_style_t a_dn_style;
1288         AttributeDescription    *a_dn_at;
1289         int                     a_dn_self;
1290         int                     a_dn_expand;
1291
1292         slap_style_t a_peername_style;
1293         struct berval   a_peername_pat;
1294         unsigned long   a_peername_addr,
1295                         a_peername_mask;
1296         int             a_peername_port;
1297
1298         slap_style_t a_sockname_style;
1299         struct berval   a_sockname_pat;
1300
1301         slap_style_t a_domain_style;
1302         struct berval   a_domain_pat;
1303         int             a_domain_expand;
1304
1305         slap_style_t a_sockurl_style;
1306         struct berval   a_sockurl_pat;
1307         slap_style_t a_set_style;
1308         struct berval   a_set_pat;
1309
1310 #ifdef SLAP_DYNACL
1311         slap_dynacl_t           *a_dynacl;
1312 #else /* ! SLAP_DYNACL */
1313 #ifdef SLAPD_ACI_ENABLED
1314         AttributeDescription    *a_aci_at;
1315 #endif
1316 #endif /* SLAP_DYNACL */
1317
1318         /* ACL Groups */
1319         slap_style_t a_group_style;
1320         struct berval   a_group_pat;
1321         ObjectClass                             *a_group_oc;
1322         AttributeDescription    *a_group_at;
1323
1324         struct slap_access      *a_next;
1325 } Access;
1326
1327 /* the "to" part */
1328 typedef struct slap_acl {
1329         /* "to" part: the entries this acl applies to */
1330         Filter          *acl_filter;
1331         slap_style_t acl_dn_style;
1332         regex_t         acl_dn_re;
1333         struct berval   acl_dn_pat;
1334         AttributeName   *acl_attrs;
1335         slap_style_t    acl_attrval_style;
1336         regex_t         acl_attrval_re;
1337         struct berval   acl_attrval;
1338
1339         /* "by" part: list of who has what access to the entries */
1340         Access  *acl_access;
1341
1342         struct slap_acl *acl_next;
1343 } AccessControl;
1344
1345 typedef struct slap_acl_state {
1346         unsigned as_recorded;
1347 #define ACL_STATE_NOT_RECORDED                  0x0
1348 #define ACL_STATE_RECORDED_VD                   0x1
1349 #define ACL_STATE_RECORDED_NV                   0x2
1350 #define ACL_STATE_RECORDED                              0x3
1351
1352         /* Access state */
1353         AccessControl *as_vd_acl;
1354         AccessControl *as_vi_acl;
1355         slap_mask_t as_vd_acl_mask;
1356         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1357         int as_vd_acl_count;
1358
1359         Access *as_vd_access;
1360         int as_vd_access_count;
1361
1362         int as_result;
1363         AttributeDescription *as_vd_ad;
1364 } AccessControlState;
1365 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1366         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1367
1368 /*
1369  * Backend-info
1370  * represents a backend
1371  */
1372
1373 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1374 typedef struct slap_backend_db BackendDB;               /* per backend database */
1375
1376 LDAP_SLAPD_V (int) nBackendInfo;
1377 LDAP_SLAPD_V (int) nBackendDB;
1378 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1379 LDAP_SLAPD_V (BackendDB *) backendDB;
1380 LDAP_SLAPD_V (BackendDB *) frontendDB;
1381
1382 LDAP_SLAPD_V (int) slapMode;
1383 #define SLAP_UNDEFINED_MODE     0x0000
1384 #define SLAP_SERVER_MODE        0x0001
1385 #define SLAP_TOOL_MODE          0x0002
1386 #define SLAP_MODE                       0x0003
1387
1388 #define SLAP_TRUNCATE_MODE      0x0100
1389 #define SLAP_TOOL_READMAIN      0x0200
1390 #define SLAP_TOOL_READONLY      0x0400
1391
1392 struct slap_replica_info {
1393         char *ri_host;                          /* supersedes be_replica */
1394         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1395         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1396         int ri_exclude;                 /* 1 => exclude ri_attrs */
1397 };
1398
1399 struct slap_limits_set {
1400         /* time limits */
1401         int     lms_t_soft;
1402         int     lms_t_hard;
1403
1404         /* size limits */
1405         int     lms_s_soft;
1406         int     lms_s_hard;
1407         int     lms_s_unchecked;
1408         int     lms_s_pr;
1409         int     lms_s_pr_hide;
1410         int     lms_s_pr_total;
1411 };
1412
1413 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1414 #define SLAP_NO_LIMIT                   -1
1415 #define SLAP_MAX_LIMIT                  2147483647
1416
1417 struct slap_limits {
1418         unsigned                lm_flags;       /* type of pattern */
1419 #define SLAP_LIMITS_UNDEFINED           0x0000U
1420 #define SLAP_LIMITS_EXACT               0x0001U
1421 #define SLAP_LIMITS_BASE                SLAP_LIMITS_EXACT
1422 #define SLAP_LIMITS_ONE                 0x0002U
1423 #define SLAP_LIMITS_SUBTREE             0x0003U
1424 #define SLAP_LIMITS_CHILDREN            0x0004U
1425 #define SLAP_LIMITS_REGEX               0x0005U
1426 #define SLAP_LIMITS_ANONYMOUS           0x0006U
1427 #define SLAP_LIMITS_USERS               0x0007U
1428 #define SLAP_LIMITS_ANY                 0x0008U
1429 #define SLAP_LIMITS_MASK                0x000FU
1430
1431 #define SLAP_LIMITS_TYPE_DN             0x0000U
1432 #define SLAP_LIMITS_TYPE_GROUP          0x0010U
1433 #define SLAP_LIMITS_TYPE_MASK           0x00F0U
1434
1435         regex_t                 lm_regex;       /* regex data for REGEX */
1436
1437         /*
1438          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1439          * pattern for REGEX; NULL for ANONYMOUS, USERS
1440          */
1441         struct berval           lm_pat;
1442
1443         /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1444          * lm_group_oc is objectClass and lm_group_at is attributeType
1445          * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1446          * can only be SLAP_LIMITS_EXACT */
1447         ObjectClass             *lm_group_oc;
1448         AttributeDescription    *lm_group_ad;
1449
1450         struct slap_limits_set  lm_limits;
1451 };
1452
1453 /* temporary aliases */
1454 typedef BackendDB Backend;
1455 #define nbackends nBackendDB
1456 #define backends backendDB
1457
1458 /*
1459  * syncinfo structure for syncrepl
1460  */
1461
1462 #define SLAP_SYNC_SID_SIZE      3
1463 #define SLAP_SYNC_RID_SIZE      3
1464 #define SLAP_SYNCUUID_SET_SIZE 256
1465
1466 #define SLAP_SYNC_UPDATE_MSGID  2
1467
1468 struct nonpresent_entry {
1469         struct berval *npe_name;
1470         struct berval *npe_nname;
1471         LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1472 };
1473
1474 struct sync_cookie {
1475         struct berval ctxcsn;
1476         struct berval octet_str;
1477         long rid;
1478         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1479 };
1480
1481 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1482
1483 typedef struct syncinfo_s {
1484         struct slap_backend_db *si_be;
1485         long                            si_rid;
1486         struct berval                   si_provideruri;
1487 #define SYNCINFO_TLS_OFF                0
1488 #define SYNCINFO_TLS_ON                 1
1489 #define SYNCINFO_TLS_CRITICAL   2
1490         int                                     si_tls;
1491         int                                     si_bindmethod;
1492         char                            *si_binddn;
1493         char                            *si_passwd;
1494         char                            *si_saslmech;
1495         char                            *si_secprops;
1496         char                            *si_realm;
1497         char                            *si_authcId;
1498         char                            *si_authzId;
1499                 int                                     si_schemachecking;
1500         struct berval           si_filterstr;
1501         struct berval           si_base;
1502         int                                     si_scope;
1503         int                                     si_attrsonly;
1504                 AttributeName           *si_anlist;
1505                 AttributeName           *si_exanlist;
1506                 char                            **si_attrs;
1507                 int                                     si_allattrs;
1508                 int                                     si_allopattrs;
1509                 char                            **si_exattrs;
1510         int                                     si_type;
1511         time_t                          si_interval;
1512                 time_t                          *si_retryinterval;
1513                 int                                     *si_retrynum_init;
1514                 int                                     *si_retrynum;
1515                 struct sync_cookie      si_syncCookie;
1516         int                                     si_manageDSAit;
1517         int                                     si_slimit;
1518                 int                                     si_tlimit;
1519                 int                                     si_refreshDelete;
1520                 int                                     si_refreshPresent;
1521         Avlnode                         *si_presentlist;
1522                 LDAP                            *si_ld;
1523                 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1524 } syncinfo_t;
1525
1526 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1527
1528 struct slap_backend_db {
1529         BackendInfo     *bd_info;       /* pointer to shared backend info */
1530
1531         /* fields in this structure (and routines acting on this structure)
1532            should be renamed from be_ to bd_ */
1533
1534         /* BackendInfo accessors */
1535 #define         be_config       bd_info->bi_db_config
1536 #define         be_type         bd_info->bi_type
1537
1538 #define         be_bind         bd_info->bi_op_bind
1539 #define         be_unbind       bd_info->bi_op_unbind
1540 #define         be_add          bd_info->bi_op_add
1541 #define         be_compare      bd_info->bi_op_compare
1542 #define         be_delete       bd_info->bi_op_delete
1543 #define         be_modify       bd_info->bi_op_modify
1544 #define         be_modrdn       bd_info->bi_op_modrdn
1545 #define         be_search       bd_info->bi_op_search
1546 #define         be_abandon      bd_info->bi_op_abandon
1547 #define         be_cancel       bd_info->bi_op_cancel
1548
1549 #define         be_extended     bd_info->bi_extended
1550
1551 #define         be_chk_referrals        bd_info->bi_chk_referrals
1552 #define         be_fetch        bd_info->bi_entry_get_rw
1553 #define         be_release      bd_info->bi_entry_release_rw
1554 #define         be_group        bd_info->bi_acl_group
1555 #define         be_attribute    bd_info->bi_acl_attribute
1556 #define         be_operational  bd_info->bi_operational
1557
1558 /*
1559  * define to honor hasSubordinates operational attribute in search filters
1560  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1561  * is fixed).
1562  */
1563 #define         be_has_subordinates bd_info->bi_has_subordinates
1564
1565 #define         be_controls     bd_info->bi_controls
1566
1567 #define         be_connection_init      bd_info->bi_connection_init
1568 #define         be_connection_destroy   bd_info->bi_connection_destroy
1569
1570 #ifdef SLAPD_TOOLS
1571 #define         be_entry_open bd_info->bi_tool_entry_open
1572 #define         be_entry_close bd_info->bi_tool_entry_close
1573 #define         be_entry_first bd_info->bi_tool_entry_first
1574 #define         be_entry_next bd_info->bi_tool_entry_next
1575 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1576 #define         be_entry_get bd_info->bi_tool_entry_get
1577 #define         be_entry_put bd_info->bi_tool_entry_put
1578 #define         be_sync bd_info->bi_tool_sync
1579 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1580 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1581 #define         be_entry_modify bd_info->bi_tool_entry_modify
1582 #endif
1583
1584 /* Database flags */
1585 #define SLAP_DBFLAG_NOLASTMOD           0x0001U
1586 #define SLAP_DBFLAG_NO_SCHEMA_CHECK     0x0002U
1587 #define SLAP_DBFLAG_GLUE_INSTANCE       0x0010U /* a glue backend */
1588 #define SLAP_DBFLAG_GLUE_SUBORDINATE    0x0020U /* child of a glue hierarchy */
1589 #define SLAP_DBFLAG_GLUE_LINKED         0x0040U /* child is connected to parent */
1590 #define SLAP_DBFLAG_OVERLAY                     0x0080U /* this db struct is an overlay */
1591 #define SLAP_DBFLAG_SHADOW              0x8000U /* a shadow */
1592 #define SLAP_DBFLAG_SYNC_SHADOW         0x1000U /* a sync shadow */
1593 #define SLAP_DBFLAG_SLURP_SHADOW        0x2000U /* a slurp shadow */
1594         slap_mask_t     be_flags;
1595 #define SLAP_DBFLAGS(be)                        ((be)->be_flags)
1596 #define SLAP_NOLASTMOD(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1597 #define SLAP_LASTMOD(be)                        (!SLAP_NOLASTMOD(be))
1598 #define SLAP_ISOVERLAY(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1599 #define SLAP_NO_SCHEMA_CHECK(be)        \
1600         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1601 #define SLAP_GLUE_INSTANCE(be)          \
1602         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1603 #define SLAP_GLUE_SUBORDINATE(be)       \
1604         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1605 #define SLAP_GLUE_LINKED(be)            \
1606         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1607 #define SLAP_SHADOW(be)                         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1608 #define SLAP_SYNC_SHADOW(be)                    (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1609 #define SLAP_SLURP_SHADOW(be)                   (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1610
1611         slap_mask_t     be_restrictops;         /* restriction operations */
1612 #define SLAP_RESTRICT_OP_ADD            0x0001U
1613 #define SLAP_RESTRICT_OP_BIND           0x0002U
1614 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1615 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1616 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1617 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1618 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1619 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1620 #define SLAP_RESTRICT_OP_MASK           0x00FFU
1621
1622 #define SLAP_RESTRICT_READONLY          0x80000000U
1623
1624 #define SLAP_RESTRICT_EXOP_START_TLS            0x0100U
1625 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD        0x0200U
1626 #define SLAP_RESTRICT_EXOP_WHOAMI               0x0400U
1627 #define SLAP_RESTRICT_EXOP_CANCEL               0x0800U
1628 #define SLAP_RESTRICT_EXOP_MASK                 0xFF00U
1629
1630 #define SLAP_RESTRICT_OP_READS  \
1631         ( SLAP_RESTRICT_OP_COMPARE      \
1632         | SLAP_RESTRICT_OP_SEARCH )
1633 #define SLAP_RESTRICT_OP_WRITES \
1634         ( SLAP_RESTRICT_OP_ADD    \
1635         | SLAP_RESTRICT_OP_DELETE \
1636         | SLAP_RESTRICT_OP_MODIFY \
1637         | SLAP_RESTRICT_OP_RENAME )
1638
1639 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1640 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1641 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1642
1643 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1644
1645 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1646 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1647 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1648
1649 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1650 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1651
1652 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1653
1654         slap_mask_t     be_requires;    /* pre-operation requirements */
1655 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1656 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1657 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1658 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1659 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1660
1661         /* Required Security Strength Factor */
1662         slap_ssf_set_t be_ssf_set;
1663
1664         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1665         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1666         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1667         struct berval be_schemandn;     /* normalized subschema DN */
1668         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1669         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1670         struct berval be_rootpw;        /* the magic "root" password for this db        */
1671         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1672 #define be_sizelimit    be_def_limit.lms_s_soft
1673 #define be_timelimit    be_def_limit.lms_t_soft
1674         struct slap_limits_set be_def_limit; /* default limits */
1675         struct slap_limits **be_limits; /* regex-based size and time limits */
1676         AccessControl *be_acl;  /* access control list for this backend    */
1677         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1678
1679         /* Replica Information */
1680         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1681         char    *be_replogfile; /* replication log file (in master)        */
1682         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1683         BerVarray       be_update_refs; /* where to refer modifying clients to */
1684         struct          be_pcl  *be_pending_csn_list;
1685         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1686         ldap_pvt_thread_mutex_t                                 *be_pcl_mutexp;
1687         syncinfo_t                                                              *be_syncinfo; /* For syncrepl */
1688
1689         char    *be_realm;
1690         void    *be_pb;         /* Netscape plugin */
1691
1692         void    *be_private;    /* anything the backend database needs     */
1693 };
1694
1695 struct slap_conn;
1696 struct slap_op;
1697
1698 /* Backend function typedefs */
1699 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1700 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1701         const char *fname, int lineno,
1702         int argc, char **argv));
1703 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1704 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1705 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1706
1707 typedef int (BI_db_init) LDAP_P((Backend *bd));
1708 typedef int (BI_db_config) LDAP_P((Backend *bd,
1709         const char *fname, int lineno,
1710         int argc, char **argv));
1711 typedef int (BI_db_open) LDAP_P((Backend *bd));
1712 typedef int (BI_db_close) LDAP_P((Backend *bd));
1713 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1714
1715 typedef struct req_bind_s {
1716         int rb_method;
1717         struct berval rb_cred;
1718         struct berval rb_edn;
1719         slap_ssf_t rb_ssf;
1720         struct berval rb_tmp_mech;      /* FIXME: temporary */
1721 } req_bind_s;
1722
1723 typedef struct req_search_s {
1724         int rs_scope;
1725         int rs_deref;
1726         int rs_slimit;
1727         int rs_tlimit;
1728         /* NULL means be_isroot evaluated to TRUE */
1729         struct slap_limits_set *rs_limit;
1730         int rs_attrsonly;
1731         AttributeName *rs_attrs;
1732         Filter *rs_filter;
1733         struct berval rs_filterstr;
1734         int rs_post_search_id;
1735 } req_search_s;
1736
1737 typedef struct req_compare_s {
1738         AttributeAssertion *rs_ava;
1739 } req_compare_s;
1740
1741 typedef struct req_modify_s {
1742         Modifications *rs_modlist;
1743         int rs_increment;               /* FIXME: temporary */
1744 } req_modify_s;
1745
1746 typedef struct req_modrdn_s {
1747         struct berval rs_newrdn;
1748         struct berval rs_nnewrdn;
1749         struct berval *rs_newSup;
1750         struct berval *rs_nnewSup;
1751         int rs_deleteoldrdn;
1752 } req_modrdn_s;
1753
1754 typedef struct req_add_s {
1755         Entry *rs_e;
1756         Modifications *rs_modlist;      /* FIXME: temporary */
1757 } req_add_s;
1758
1759 typedef struct req_abandon_s {
1760         ber_int_t rs_msgid;
1761 } req_abandon_s;
1762
1763 #ifdef LDAP_DEVEL
1764 #define SLAP_EXOP_HIDE 0x0000
1765 #else
1766 #define SLAP_EXOP_HIDE 0x8000
1767 #endif
1768 #define SLAP_EXOP_WRITES 0x0001         /* Exop does writes */
1769
1770 typedef struct req_extended_s {
1771         struct berval rs_reqoid;
1772         int rs_flags;
1773         struct berval *rs_reqdata;
1774 } req_extended_s;
1775
1776 typedef struct req_pwdexop_s {
1777         struct berval rs_reqoid;
1778         int rs_flags;
1779         struct berval rs_old;
1780         struct berval rs_new;
1781         Modifications *rs_mods;
1782         Modifications **rs_modtail;
1783 } req_pwdexop_s;
1784
1785 typedef enum slap_reply_e {
1786         REP_RESULT,
1787         REP_SASL,
1788         REP_EXTENDED,
1789         REP_SEARCH,
1790         REP_SEARCHREF,
1791         REP_INTERMEDIATE
1792 } slap_reply_t;
1793
1794 typedef struct rep_sasl_s {
1795         struct berval *r_sasldata;
1796 } rep_sasl_s;
1797
1798 typedef struct rep_extended_s {
1799         const char *r_rspoid;
1800         struct berval *r_rspdata;
1801 } rep_extended_s;
1802
1803 typedef struct rep_search_s {
1804         Entry *r_entry;
1805         slap_mask_t r_attr_flags;
1806 #define SLAP_ATTRS_UNDEFINED    (0x00U)
1807 #define SLAP_OPATTRS_NO                 (0x01U)
1808 #define SLAP_OPATTRS_YES                (0x02U)
1809 #define SLAP_USERATTRS_NO               (0x10U)
1810 #define SLAP_USERATTRS_YES              (0x20U)
1811 #define SLAP_OPATTRS_MASK(f)    ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1812 #define SLAP_OPATTRS(f)                 (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1813 #define SLAP_USERATTRS_MASK(f)  ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1814 #define SLAP_USERATTRS(f)               \
1815         (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1816
1817         Attribute *r_operational_attrs;
1818         AttributeName *r_attrs;
1819         int r_nentries;
1820         BerVarray r_v2ref;
1821 } rep_search_s;
1822
1823 typedef struct slap_rep {
1824         slap_reply_t sr_type;
1825         ber_tag_t sr_tag;
1826         ber_int_t sr_msgid;
1827         ber_int_t sr_err;
1828         const char *sr_matched;
1829         const char *sr_text;
1830         BerVarray sr_ref;
1831         LDAPControl **sr_ctrls;
1832         union sr_u {
1833                 rep_sasl_s sru_sasl;
1834                 rep_extended_s sru_extended;
1835                 rep_search_s sru_search;
1836         } sr_un;
1837         slap_mask_t sr_flags;
1838 #define REP_ENTRY_MODIFIABLE    0x0001U
1839 #define REP_ENTRY_MUSTBEFREED   0x0002U
1840 #define REP_MATCHED_MUSTBEFREED 0x0010U
1841 #define REP_REF_MUSTBEFREED             0x0020U
1842 } SlapReply;
1843
1844 /* short hands for response members */
1845 #define sr_attrs sr_un.sru_search.r_attrs
1846 #define sr_entry sr_un.sru_search.r_entry
1847 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1848 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1849 #define sr_v2ref sr_un.sru_search.r_v2ref
1850 #define sr_nentries sr_un.sru_search.r_nentries
1851 #define sr_rspoid sr_un.sru_extended.r_rspoid
1852 #define sr_rspdata sr_un.sru_extended.r_rspdata
1853 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1854
1855 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1856 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1857 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1858 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1859 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1860 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1861 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1862 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1863 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1864 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1865 typedef int (BI_op_extended) LDAP_P((
1866         struct slap_op *op, struct slap_rep *rs ));
1867 typedef int (BI_chk_referrals) LDAP_P((
1868         struct slap_op *op, struct slap_rep *rs ));
1869 typedef int (BI_entry_release_rw)
1870         LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1871 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1872         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1873 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1874 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1875         Entry *e, int *hasSubs ));
1876
1877 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1878         struct slap_conn *c ));
1879 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1880         struct slap_conn *c ));
1881
1882 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1883 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1884 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1885 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1886 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1887 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1888         struct berval *text ));
1889 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1890 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1891 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1892 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1893 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1894         struct berval *text ));
1895
1896 struct slap_backend_info {
1897         char    *bi_type; /* type of backend */
1898
1899         /*
1900          * per backend type routines:
1901          * bi_init: called to allocate a backend_info structure,
1902          *              called once BEFORE configuration file is read.
1903          *              bi_init() initializes this structure hence is
1904          *              called directly from be_initialize()
1905          * bi_config: called per 'backend' specific option
1906          *              all such options must before any 'database' options
1907          *              bi_config() is called only from read_config()
1908          * bi_open: called to open each database, called
1909          *              once AFTER configuration file is read but
1910          *              BEFORE any bi_db_open() calls.
1911          *              bi_open() is called from backend_startup()
1912          * bi_close: called to close each database, called
1913          *              once during shutdown after all bi_db_close calls.
1914          *              bi_close() is called from backend_shutdown()
1915          * bi_destroy: called to destroy each database, called
1916          *              once during shutdown after all bi_db_destroy calls.
1917          *              bi_destory() is called from backend_destroy()
1918          */
1919         BI_init *bi_init;
1920         BI_config       *bi_config;
1921         BI_open *bi_open;
1922         BI_close        *bi_close;
1923         BI_destroy      *bi_destroy;
1924
1925         /*
1926          * per database routines:
1927          * bi_db_init: called to initialize each database,
1928          *      called upon reading 'database <type>'
1929          *      called only from backend_db_init()
1930          * bi_db_config: called to configure each database,
1931          *  called per database to handle per database options
1932          *      called only from read_config()
1933          * bi_db_open: called to open each database
1934          *      called once per database immediately AFTER bi_open()
1935          *      calls but before daemon startup.
1936          *  called only by backend_startup()
1937          * bi_db_close: called to close each database
1938          *      called once per database during shutdown but BEFORE
1939          *  any bi_close call.
1940          *  called only by backend_shutdown()
1941          * bi_db_destroy: called to destroy each database
1942          *  called once per database during shutdown AFTER all
1943          *  bi_close calls but before bi_destory calls.
1944          *  called only by backend_destory()
1945          */
1946         BI_db_init      *bi_db_init;
1947         BI_db_config    *bi_db_config;
1948         BI_db_open      *bi_db_open;
1949         BI_db_close     *bi_db_close;
1950         BI_db_destroy   *bi_db_destroy;
1951
1952         /* LDAP Operations Handling Routines */
1953         BI_op_bind      *bi_op_bind;
1954         BI_op_unbind    *bi_op_unbind;
1955         BI_op_search    *bi_op_search;
1956         BI_op_compare   *bi_op_compare;
1957         BI_op_modify    *bi_op_modify;
1958         BI_op_modrdn    *bi_op_modrdn;
1959         BI_op_add       *bi_op_add;
1960         BI_op_delete    *bi_op_delete;
1961         BI_op_abandon   *bi_op_abandon;
1962         BI_op_cancel    *bi_op_cancel;
1963
1964         /* Extended Operations Helper */
1965         BI_op_extended  *bi_extended;
1966
1967         /* Auxilary Functions */
1968         BI_operational          *bi_operational;
1969         BI_chk_referrals        *bi_chk_referrals;
1970         BI_entry_get_rw         *bi_entry_get_rw;
1971         BI_entry_release_rw     *bi_entry_release_rw;
1972
1973         BI_has_subordinates     *bi_has_subordinates;
1974
1975         BI_connection_init      *bi_connection_init;
1976         BI_connection_destroy   *bi_connection_destroy;
1977
1978         /* hooks for slap tools */
1979         BI_tool_entry_open      *bi_tool_entry_open;
1980         BI_tool_entry_close     *bi_tool_entry_close;
1981         BI_tool_entry_first     *bi_tool_entry_first;
1982         BI_tool_entry_next      *bi_tool_entry_next;
1983         BI_tool_entry_get       *bi_tool_entry_get;
1984         BI_tool_entry_put       *bi_tool_entry_put;
1985         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1986         BI_tool_sync            *bi_tool_sync;
1987         BI_tool_dn2id_get       *bi_tool_dn2id_get;
1988         BI_tool_id2entry_get    *bi_tool_id2entry_get;
1989         BI_tool_entry_modify    *bi_tool_entry_modify;
1990
1991 #define SLAP_INDEX_ADD_OP               0x0001
1992 #define SLAP_INDEX_DELETE_OP    0x0002
1993
1994         slap_mask_t     bi_flags; /* backend flags */
1995 #define SLAP_BFLAG_MONITOR                      0x0001U /* a monitor backend */
1996 #define SLAP_BFLAG_NOLASTMODCMD         0x0010U
1997 #define SLAP_BFLAG_INCREMENT            0x0100U
1998 #define SLAP_BFLAG_ALIASES                      0x1000U
1999 #define SLAP_BFLAG_REFERRALS            0x2000U
2000 #define SLAP_BFLAG_SUBENTRIES           0x4000U
2001 #define SLAP_BFLAG_DYNAMIC                      0x8000U
2002
2003 #define SLAP_BFLAGS(be)         ((be)->bd_info->bi_flags)
2004 #define SLAP_MONITOR(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2005 #define SLAP_INCREMENT(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2006 #define SLAP_ALIASES(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2007 #define SLAP_REFERRALS(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2008 #define SLAP_SUBENTRIES(be)     (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2009 #define SLAP_DYNAMIC(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2010 #define SLAP_NOLASTMODCMD(be)   (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2011 #define SLAP_LASTMODCMD(be)     (!SLAP_NOLASTMODCMD(be))
2012
2013         char **bi_controls;             /* supported controls */
2014
2015         unsigned int bi_nDB;    /* number of databases of this type */
2016         void    *bi_private;    /* anything the backend type needs */
2017 };
2018
2019 #define c_authtype      c_authz.sai_method
2020 #define c_authmech      c_authz.sai_mech
2021 #define c_dn            c_authz.sai_dn
2022 #define c_ndn           c_authz.sai_ndn
2023 #define c_ssf                   c_authz.sai_ssf
2024 #define c_transport_ssf c_authz.sai_transport_ssf
2025 #define c_tls_ssf               c_authz.sai_tls_ssf
2026 #define c_sasl_ssf              c_authz.sai_sasl_ssf
2027
2028 #define o_authtype      o_authz.sai_method
2029 #define o_authmech      o_authz.sai_mech
2030 #define o_dn            o_authz.sai_dn
2031 #define o_ndn           o_authz.sai_ndn
2032 #define o_ssf                   o_authz.sai_ssf
2033 #define o_transport_ssf o_authz.sai_transport_ssf
2034 #define o_tls_ssf               o_authz.sai_tls_ssf
2035 #define o_sasl_ssf              o_authz.sai_sasl_ssf
2036
2037 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2038
2039 typedef struct slap_callback {
2040         struct slap_callback *sc_next;
2041         slap_response *sc_response;
2042         slap_response *sc_cleanup;
2043         void *sc_private;
2044 } slap_callback;
2045
2046 struct slap_overinfo;
2047
2048 typedef struct slap_overinst {
2049         BackendInfo on_bi;
2050         slap_response *on_response;
2051         struct slap_overinfo *on_info;
2052         struct slap_overinst *on_next;
2053 } slap_overinst;
2054
2055 typedef struct slap_overinfo {
2056         BackendInfo oi_bi;
2057         BackendInfo *oi_orig;
2058         struct slap_overinst *oi_list;
2059 } slap_overinfo;
2060
2061 /* Should successive callbacks in a chain be processed? */
2062 #define SLAP_CB_FREEME          0x4000
2063 #define SLAP_CB_CONTINUE        0x8000
2064
2065 /*
2066  * Paged Results state
2067  */
2068 typedef unsigned long PagedResultsCookie;
2069 typedef struct slap_paged_state {
2070         Backend *ps_be;
2071         ber_int_t ps_size;
2072         PagedResultsCookie ps_cookie;
2073         int ps_count;
2074 } PagedResultsState;
2075
2076 struct slap_csn_entry {
2077         struct berval ce_csn;
2078         unsigned long ce_opid;
2079         unsigned long ce_connid;
2080 #define SLAP_CSN_PENDING        1
2081 #define SLAP_CSN_COMMIT         2
2082         long ce_state;
2083         LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2084 };
2085
2086 /*
2087  * Caches the result of a backend_group check for ACL evaluation
2088  */
2089 typedef struct slap_gacl {
2090         struct slap_gacl *ga_next;
2091         Backend *ga_be;
2092         ObjectClass *ga_oc;
2093         AttributeDescription *ga_at;
2094         int ga_res;
2095         ber_len_t ga_len;
2096         char ga_ndn[1];
2097 } GroupAssertion;
2098
2099 #ifndef SLAP_MAX_CIDS
2100 #define SLAP_MAX_CIDS   32      /* Maximum number of supported controls */
2101 #endif
2102
2103 struct slap_control_ids {
2104         int sc_assert;
2105         int sc_preRead;
2106         int sc_postRead;
2107         int sc_proxyAuthz;
2108         int sc_manageDSAit;
2109         int sc_modifyIncrement;
2110         int sc_noOp;
2111         int sc_pagedResults;
2112         int sc_valuesReturnFilter;
2113         int sc_permissiveModify;
2114         int sc_domainScope;
2115         int sc_treeDelete;
2116         int sc_searchOptions;
2117         int sc_subentries;
2118         int sc_LDAPsync;
2119 };
2120
2121 /*
2122  * represents an operation pending from an ldap client
2123  */
2124 typedef struct slap_op_header {
2125         unsigned long oh_opid;  /* id of this operation */
2126         unsigned long oh_connid; /* id of conn initiating this op */
2127         struct slap_conn *oh_conn;      /* connection spawning this op */
2128
2129         ber_int_t       oh_msgid;       /* msgid of the request */
2130         ber_int_t       oh_protocol;    /* version of the LDAP protocol used by client */
2131
2132         ldap_pvt_thread_t       oh_tid; /* thread handling this op */
2133
2134         void    *oh_threadctx;          /* thread pool thread context */
2135         void    *oh_tmpmemctx;          /* slab malloc context */
2136         BerMemoryFunctions *oh_tmpmfuncs;
2137
2138         char            oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2139
2140 #ifdef LDAP_SLAPI
2141         void    *oh_pb;                  /* NS-SLAPI plugin */
2142         void    *oh_extensions;         /* NS-SLAPI plugin */
2143 #endif
2144 } Opheader;
2145
2146 typedef struct slap_op {
2147         Opheader *o_hdr;
2148
2149 #define o_opid o_hdr->oh_opid
2150 #define o_connid o_hdr->oh_connid
2151 #define o_conn o_hdr->oh_conn
2152 #define o_msgid o_hdr->oh_msgid
2153 #define o_protocol o_hdr->oh_protocol
2154 #define o_tid o_hdr->oh_tid
2155 #define o_threadctx o_hdr->oh_threadctx
2156 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2157 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2158
2159 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2160 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2161 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2162 #define o_tmpfree       o_tmpmfuncs->bmf_free
2163
2164 #define o_log_prefix o_hdr->oh_log_prefix
2165
2166 #ifdef LDAP_SLAPI
2167 #define o_pb o_hdr->oh_pb
2168 #define o_extensions o_hdr->oh_extensions
2169 #endif
2170
2171         ber_tag_t       o_tag;          /* tag of the request */
2172         time_t          o_time;         /* time op was initiated */
2173
2174         BackendDB       *o_bd;  /* backend DB processing this op */
2175         struct berval   o_req_dn;       /* DN of target of request */
2176         struct berval   o_req_ndn;
2177
2178         union o_req_u {
2179                 req_add_s oq_add;
2180                 req_bind_s oq_bind;
2181                 req_compare_s oq_compare;
2182                 req_modify_s oq_modify;
2183                 req_modrdn_s oq_modrdn;
2184                 req_search_s oq_search;
2185                 req_abandon_s oq_abandon;
2186                 req_abandon_s oq_cancel;
2187                 req_extended_s oq_extended;
2188                 req_pwdexop_s oq_pwdexop;
2189         } o_request;
2190
2191 /* short hands for union members */
2192 #define oq_add o_request.oq_add
2193 #define oq_bind o_request.oq_bind
2194 #define oq_compare o_request.oq_compare
2195 #define oq_modify o_request.oq_modify
2196 #define oq_modrdn o_request.oq_modrdn
2197 #define oq_search o_request.oq_search
2198 #define oq_abandon o_request.oq_abandon
2199 #define oq_cancel o_request.oq_cancel
2200 #define oq_extended o_request.oq_extended
2201 #define oq_pwdexop o_request.oq_pwdexop
2202
2203 /* short hands for inner request members */
2204 #define orb_method oq_bind.rb_method
2205 #define orb_cred oq_bind.rb_cred
2206 #define orb_edn oq_bind.rb_edn
2207 #define orb_ssf oq_bind.rb_ssf
2208 #define orb_tmp_mech oq_bind.rb_tmp_mech
2209
2210 #define ors_scope oq_search.rs_scope
2211 #define ors_deref oq_search.rs_deref
2212 #define ors_slimit oq_search.rs_slimit
2213 #define ors_tlimit oq_search.rs_tlimit
2214 #define ors_limit oq_search.rs_limit
2215 #define ors_attrsonly oq_search.rs_attrsonly
2216 #define ors_attrs oq_search.rs_attrs
2217 #define ors_filter oq_search.rs_filter
2218 #define ors_filterstr oq_search.rs_filterstr
2219 #define ors_post_search_id oq_search.rs_post_search_id
2220
2221 #define orr_newrdn oq_modrdn.rs_newrdn
2222 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2223 #define orr_newSup oq_modrdn.rs_newSup
2224 #define orr_nnewSup oq_modrdn.rs_nnewSup
2225 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2226
2227 #define orc_ava oq_compare.rs_ava
2228 #define ora_e oq_add.rs_e
2229 #define ora_modlist oq_add.rs_modlist
2230 #define orn_msgid oq_abandon.rs_msgid
2231 #define orm_modlist oq_modify.rs_modlist
2232 #define orm_increment oq_modify.rs_increment
2233
2234 #define ore_reqoid oq_extended.rs_reqoid
2235 #define ore_flags oq_extended.rs_flags
2236 #define ore_reqdata oq_extended.rs_reqdata
2237         volatile sig_atomic_t o_abandon;        /* abandon flag */
2238         volatile sig_atomic_t o_cancel;         /* cancel flag */
2239 #define SLAP_CANCEL_NONE                                0x00
2240 #define SLAP_CANCEL_REQ                                 0x01
2241 #define SLAP_CANCEL_ACK                                 0x02
2242 #define SLAP_CANCEL_DONE                                0x03
2243
2244         GroupAssertion *o_groups;
2245         char o_do_not_cache;    /* don't cache groups from this op */
2246         char o_is_auth_check;   /* authorization in progress */
2247
2248 #define SLAP_CONTROL_NONE       0
2249 #define SLAP_CONTROL_IGNORED    1
2250 #define SLAP_CONTROL_NONCRITICAL 2
2251 #define SLAP_CONTROL_CRITICAL   3
2252 #define SLAP_CONTROL_MASK       3
2253
2254 /* spare bits for simple flags */
2255 #define SLAP_CONTROL_SHIFT      4       /* shift to reach data bits */
2256 #define SLAP_CONTROL_DATA0      0x10
2257 #define SLAP_CONTROL_DATA1      0x20
2258 #define SLAP_CONTROL_DATA2      0x40
2259 #define SLAP_CONTROL_DATA3      0x80
2260
2261
2262 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2263
2264         char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2265         void **o_controls;              /* per-control state */
2266
2267 #define o_managedsait   o_ctrlflag[slap_cids.sc_manageDSAit]
2268 #define get_manageDSAit(op)                             _SCM((op)->o_managedsait)
2269
2270 #define o_noop  o_ctrlflag[slap_cids.sc_noOp]
2271 #define o_proxy_authz   o_ctrlflag[slap_cids.sc_proxyAuthz]
2272 #define o_subentries    o_ctrlflag[slap_cids.sc_subentries]
2273
2274 #define get_subentries(op)                              _SCM((op)->o_subentries)
2275 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2276
2277 #define set_subentries_visibility(op)   ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2278 #define get_subentries_visibility(op)   (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2279
2280 #define o_assert        o_ctrlflag[slap_cids.sc_assert]
2281 #define get_assert(op)                                  ((int)(op)->o_assert)
2282 #define o_assertion     o_controls[slap_cids.sc_assert]
2283 #define get_assertion(op)                               ((op)->o_assertion)
2284
2285 #define o_valuesreturnfilter    o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2286 #define o_vrFilter      o_controls[slap_cids.sc_valuesReturnFilter]
2287
2288 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2289 #define o_permissive_modify     o_ctrlflag[slap_cids.sc_permissiveModify]
2290 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
2291 #else
2292 #define get_permissiveModify(op)                (0)
2293 #endif
2294
2295 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2296 #define o_domain_scope  o_ctrlflag[slap_cids.sc_domainScope]
2297 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
2298 #else
2299 #define get_domainScope(op)                             (0)
2300 #endif
2301
2302 #ifdef LDAP_CONTROL_X_TREE_DELETE
2303 #define o_tree_delete   o_ctrlflag[slap_cids.sc_treeDelete]
2304 #define get_treeDelete(op)                              ((int)(op)->o_tree_delete)
2305 #else
2306 #define get_treeDelete(op)                              (0)
2307 #endif
2308
2309 #define o_preread       o_ctrlflag[slap_cids.sc_preRead]
2310 #define o_postread      o_ctrlflag[slap_cids.sc_postRead]
2311
2312 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2313 #define o_postread_attrs        o_controls[slap_cids.sc_postRead]
2314
2315 #define o_pagedresults  o_ctrlflag[slap_cids.sc_pagedResults]
2316 #define o_pagedresults_state    o_controls[slap_cids.sc_pagedResults]
2317
2318 #define o_sync                  o_ctrlflag[slap_cids.sc_LDAPsync]
2319
2320 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2321
2322         AuthorizationInformation o_authz;
2323
2324         BerElement      *o_ber;         /* ber of the request */
2325         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2326         slap_callback *o_callback;      /* callback pointers */
2327         LDAPControl     **o_ctrls;       /* controls */
2328
2329         void    *o_private;     /* anything the backend needs */
2330
2331         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2332
2333         int o_nocaching;
2334         int     o_delete_glue_parent;
2335
2336 } Operation;
2337 #define OPERATION_BUFFER_SIZE   (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2338
2339 #define send_ldap_error( op, rs, err, text ) do { \
2340                 (rs)->sr_err = err; (rs)->sr_text = text; \
2341                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2342         } while (0)
2343 #define send_ldap_discon( op, rs, err, text ) do { \
2344                 (rs)->sr_err = err; (rs)->sr_text = text; \
2345                 send_ldap_disconnect( op, rs ); \
2346         } while (0)
2347
2348 typedef void (SEND_LDAP_RESULT)(
2349         struct slap_op *op, struct slap_rep *rs);
2350 typedef int (SEND_SEARCH_ENTRY)(
2351         struct slap_op *op, struct slap_rep *rs);
2352 typedef int (SEND_SEARCH_REFERENCE)(
2353         struct slap_op *op, struct slap_rep *rs);
2354 typedef void (SEND_LDAP_EXTENDED)(
2355         struct slap_op *op, struct slap_rep *rs);
2356 typedef void (SEND_LDAP_INTERMEDIATE)(
2357         struct slap_op *op, struct slap_rep *rs);
2358
2359 #define send_ldap_result( op, rs ) \
2360         ((op)->o_conn->c_send_ldap_result)( op, rs )
2361 #define send_search_entry( op, rs ) \
2362         ((op)->o_conn->c_send_search_entry)( op, rs )
2363 #define send_search_reference( op, rs ) \
2364         ((op)->o_conn->c_send_search_reference)( op, rs )
2365 #define send_ldap_extended( op, rs ) \
2366         ((op)->o_conn->c_send_ldap_extended)( op, rs )
2367 #define send_ldap_intermediate( op, rs ) \
2368         ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2369
2370 typedef struct slap_listener Listener;
2371
2372 /*
2373  * represents a connection from an ldap client
2374  */
2375 typedef struct slap_conn {
2376         int                     c_struct_state; /* structure management state */
2377         int                     c_conn_state;   /* connection state */
2378         int                     c_conn_idx;             /* slot in connections array */
2379
2380         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2381         Sockbuf         *c_sb;                  /* ber connection stuff           */
2382
2383         /* only can be changed by connect_init */
2384         time_t          c_starttime;    /* when the connection was opened */
2385         time_t          c_activitytime; /* when the connection was last used */
2386         unsigned long           c_connid;       /* id of this connection for stats*/
2387
2388         struct berval   c_peer_domain;  /* DNS name of client */
2389         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2390         Listener        *c_listener;
2391 #define c_listener_url c_listener->sl_url       /* listener URL */
2392 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2393
2394         /* only can be changed by binding thread */
2395         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2396         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2397         struct berval   c_sasl_dn;      /* temporary storage */
2398
2399         /* authorization backend */
2400         Backend *c_authz_backend;
2401
2402         AuthorizationInformation c_authz;
2403
2404         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2405
2406         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2407         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2408
2409         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2410         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2411
2412         BerElement      *c_currentber;  /* ber we're attempting to read */
2413         int             c_writewaiter;  /* true if writer is waiting */
2414
2415 #define CONN_IS_TLS     1
2416 #define CONN_IS_UDP     2
2417 #define CONN_IS_CLIENT  3
2418
2419 #ifdef LDAP_CONNECTIONLESS
2420         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2421 #endif
2422 #ifdef HAVE_TLS
2423         int     c_is_tls;               /* true if this LDAP over raw TLS */
2424         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2425 #endif
2426         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2427         int     c_sasl_done;            /* SASL completed once */
2428         void    *c_sasl_authctx;        /* SASL authentication context */
2429         void    *c_sasl_sockctx;        /* SASL security layer context */
2430         void    *c_sasl_extra;          /* SASL session extra stuff */
2431         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2432
2433         PagedResultsState c_pagedresults_state; /* paged result state */
2434
2435         long    c_n_ops_received;       /* num of ops received (next op_id) */
2436         long    c_n_ops_executing;      /* num of ops currently executing */
2437         long    c_n_ops_pending;        /* num of ops pending execution */
2438         long    c_n_ops_completed;      /* num of ops completed */
2439
2440         long    c_n_get;                /* num of get calls */
2441         long    c_n_read;               /* num of read calls */
2442         long    c_n_write;              /* num of write calls */
2443
2444         void    *c_pb;                  /* Netscape plugin */
2445         void    *c_extensions;          /* Netscape plugin */
2446
2447         /*
2448          * Client connection handling
2449          */
2450         ldap_pvt_thread_start_t *c_clientfunc;
2451         void    *c_clientarg;
2452
2453         /*
2454          * These are the "callbacks" that are available for back-ends to
2455          * supply data back to connected clients that are connected
2456          * through the "front-end".
2457          */
2458         SEND_LDAP_RESULT *c_send_ldap_result;
2459         SEND_SEARCH_ENTRY *c_send_search_entry;
2460         SEND_SEARCH_REFERENCE *c_send_search_reference;
2461         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2462 #ifdef LDAP_RES_INTERMEDIATE
2463         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2464 #endif
2465
2466 } Connection;
2467
2468 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2469 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2470         do { \
2471                 if ( ldap_debug & (level) ) \
2472                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2473                 if ( ldap_syslog & (level) ) \
2474                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2475                                 (arg2), (arg3) ); \
2476         } while (0)
2477 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2478 #elif defined(LDAP_DEBUG)
2479 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2480         do { \
2481                 if ( ldap_debug & (level) ) \
2482                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2483         } while (0)
2484 #define StatslogTest( level ) (ldap_debug & (level))
2485 #else
2486 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2487 #define StatslogTest( level ) (0)
2488 #endif
2489
2490 /*
2491  * listener; need to access it from monitor backend
2492  */
2493 struct slap_listener {
2494         struct berval sl_url;
2495         struct berval sl_name;
2496         mode_t  sl_perms;
2497 #ifdef HAVE_TLS
2498         int             sl_is_tls;
2499 #endif
2500 #ifdef LDAP_CONNECTIONLESS
2501         int     sl_is_udp;              /* UDP listener is also data port */
2502 #endif
2503         int     sl_is_mute;     /* Listening is temporarily disabled */
2504         ber_socket_t sl_sd;
2505         Sockaddr sl_sa;
2506 #define sl_addr sl_sa.sa_in_addr
2507 };
2508
2509 #ifdef SLAPD_MONITOR
2510 /*
2511  * Operation indices
2512  */
2513 enum {
2514         SLAP_OP_BIND = 0,
2515         SLAP_OP_UNBIND,
2516         SLAP_OP_ADD,
2517         SLAP_OP_DELETE,
2518         SLAP_OP_MODRDN,
2519         SLAP_OP_MODIFY,
2520         SLAP_OP_COMPARE,
2521         SLAP_OP_SEARCH,
2522         SLAP_OP_ABANDON,
2523         SLAP_OP_EXTENDED,
2524         SLAP_OP_LAST
2525 };
2526 #endif /* SLAPD_MONITOR */
2527
2528 typedef struct slap_counters_t {
2529         ldap_pvt_thread_mutex_t sc_sent_mutex;
2530         ldap_pvt_mp_t           sc_bytes;
2531         ldap_pvt_mp_t           sc_pdu;
2532         ldap_pvt_mp_t           sc_entries;
2533         ldap_pvt_mp_t           sc_refs;
2534
2535         ldap_pvt_thread_mutex_t sc_ops_mutex;
2536         ldap_pvt_mp_t           sc_ops_completed;
2537         ldap_pvt_mp_t           sc_ops_initiated;
2538 #ifdef SLAPD_MONITOR
2539         ldap_pvt_mp_t           sc_ops_completed_[SLAP_OP_LAST];
2540         ldap_pvt_mp_t           sc_ops_initiated_[SLAP_OP_LAST];
2541 #endif /* SLAPD_MONITOR */
2542 } slap_counters_t;
2543
2544 /*
2545  * Better know these all around slapd
2546  */
2547 #define SLAP_LDAPDN_PRETTY 0x1
2548 #define SLAP_LDAPDN_MAXLEN 8192
2549
2550 /* number of response controls supported */
2551 #define SLAP_MAX_RESPONSE_CONTROLS   6
2552
2553 #ifdef LDAP_DEVEL
2554 #define SLAP_CTRL_HIDE                          0x00000000U
2555 #else
2556 #define SLAP_CTRL_HIDE                          0x80000000U
2557 #endif
2558
2559 #define SLAP_CTRL_FRONTEND                      0x00800000U
2560 #define SLAP_CTRL_FRONTEND_SEARCH       0x00010000U     /* for NOOP */
2561
2562 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2563 #define SLAP_CTRL_ABANDON                       0x00000001U
2564 #define SLAP_CTRL_ADD                           0x00002002U
2565 #define SLAP_CTRL_BIND                          0x00000004U
2566 #define SLAP_CTRL_COMPARE                       0x00001008U
2567 #define SLAP_CTRL_DELETE                        0x00002010U
2568 #define SLAP_CTRL_MODIFY                        0x00002020U
2569 #define SLAP_CTRL_RENAME                        0x00002040U
2570 #define SLAP_CTRL_SEARCH                        0x00001080U
2571 #define SLAP_CTRL_UNBIND                        0x00000100U
2572
2573 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2574 #define SLAP_CTRL_UPDATE \
2575         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2576 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2577
2578 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2579         Operation *op,
2580         SlapReply *rs,
2581         LDAPControl *ctrl ));
2582
2583 #define SLAP_SLAB_SIZE  (1024*1024)
2584 #define SLAP_SLAB_STACK 1
2585 #define SLAP_SLAB_SOBLOCK 64
2586
2587 #define SLAP_ZONE_ALLOC 1
2588 #undef SLAP_ZONE_ALLOC
2589
2590 #ifdef LDAP_COMP_MATCH
2591 /*
2592  * Extensible Filter Definition
2593  *
2594  * MatchingRuleAssertion := SEQUENCE {
2595  *      matchingRule    [1] MatchingRuleId OPTIONAL,
2596  *      type            [2] AttributeDescription OPTIONAL,
2597  *      matchValue      [3] AssertionValue,
2598  *      dnAttributes    [4] BOOLEAN DEFAULT FALSE }
2599  *
2600  * Following ComponentFilter is contained in matchValue
2601  *
2602  * ComponentAssertion ::= SEQUENCE {
2603  *      component               ComponentReference (SIZE(1..MAX)) OPTIONAL
2604  *      useDefaultValues        BOOLEAN DEFAULT TRUE,
2605  *      rule                    MATCHING-RULE.&id,
2606  *      value                   MATCHING-RULE.&AssertionType }
2607  *
2608  * ComponentFilter ::= CHOICE {
2609  *      item    [0] ComponentAssertion,
2610  *      and     [1] SEQUENCE OF ComponentFilter,
2611  *      or      [2] SEQUENCE OF ComponentFilter,
2612  *      not     [3] ComponentFilter }
2613  */
2614
2615 #define LDAP_COMPREF_IDENTIFIER         ((ber_tag_t) 0x80U)
2616 #define LDAP_COMPREF_FROM_BEGINNING     ((ber_tag_t) 0x81U)
2617 #define LDAP_COMPREF_COUNT              ((ber_tag_t) 0x82U)
2618 #define LDAP_COMPREF_FROM_END           ((ber_tag_t) 0x83U)
2619 #define LDAP_COMPREF_CONTENT            ((ber_tag_t) 0x84U)
2620 #define LDAP_COMPREF_SELECT             ((ber_tag_t) 0x85U)
2621 #define LDAP_COMPREF_ALL                ((ber_tag_t) 0x86U)
2622 #define LDAP_COMPREF_DEFINED            ((ber_tag_t) 0x87U)
2623 #define LDAP_COMPREF_UNDEFINED          ((ber_tag_t) 0x88U)
2624
2625 #define LDAP_COMP_FILTER_AND            ((ber_tag_t) 0xa0U)
2626 #define LDAP_COMP_FILTER_OR             ((ber_tag_t) 0xa1U)
2627 #define LDAP_COMP_FILTER_NOT            ((ber_tag_t) 0xa2U)
2628 #define LDAP_COMP_FILTER_ITEM           ((ber_tag_t) 0xa3U)
2629 #define LDAP_COMP_FILTER_UNDEFINED      ((ber_tag_t) 0xa4U)
2630
2631 typedef struct slap_component_id {
2632         int     ci_type;
2633         struct slap_component_id *ci_next;
2634
2635         union comp_id_value{
2636                 BerValue        ci_identifier;
2637                 ber_int_t       ci_from_beginning;
2638                 ber_int_t       ci_count;
2639                 ber_int_t       ci_from_end;
2640                 ber_int_t       ci_content;
2641                 BerValue        ci_select_value;
2642                 char            ci_all;
2643         } ci_val;
2644 } ComponentId;
2645
2646 typedef struct slap_component_reference {
2647         ComponentId     *cr_list;
2648         ComponentId     *cr_curr;
2649         struct berval   cr_string;
2650         int cr_len;
2651         /* Component Indexing */
2652         int             cr_asn_type_id;
2653         slap_mask_t     cr_indexmask;
2654         AttributeDescription* cr_ad;
2655         BerVarray       cr_nvals;
2656         struct slap_component_reference* cr_next;
2657 } ComponentReference;
2658
2659 typedef struct slap_component_assertion {
2660         ComponentReference      *ca_comp_ref;
2661         ber_int_t               ca_use_def;
2662         MatchingRule            *ca_ma_rule;
2663         struct berval           ca_ma_value;
2664         ComponentData           ca_comp_data; /* componentized assertion */
2665         struct slap_component_filter    *ca_cf;
2666         MatchingRuleAssertion   *ca_mra;
2667 } ComponentAssertion;
2668
2669 typedef struct slap_component_filter {
2670         ber_tag_t cf_choice;
2671         union cf_un_u {
2672                 ber_int_t cf_un_result;
2673                 ComponentAssertion *cf_un_ca;
2674                 struct slap_component_filter *cf_un_complex;
2675         } cf_un;
2676
2677 #define cf_ca           cf_un.cf_un_ca
2678 #define cf_result       cf_un.cf_un_result
2679 #define cf_and          cf_un.cf_un_complex
2680 #define cf_or           cf_un.cf_un_complex
2681 #define cf_not          cf_un.cf_un_complex
2682 #define cf_any          cf_un.cf_un_complex
2683
2684         struct slap_component_filter *cf_next;
2685 } ComponentFilter;
2686
2687 typedef struct slap_component_assertion_value {
2688         char* cav_buf;
2689         char* cav_ptr;
2690         char* cav_end;
2691 } ComponentAssertionValue;
2692
2693 typedef int encoder_func LDAP_P((
2694         void* b,
2695         void* comp));
2696
2697 struct slap_component_syntax_info;
2698
2699 typedef int gser_decoder_func LDAP_P((
2700         void* mem_op,
2701         void* b,
2702         struct slap_component_syntax_info** comp_syn_info,
2703         int* len,
2704         int mode));
2705
2706 typedef int comp_free_func LDAP_P((
2707         void* b));
2708
2709 typedef int ber_decoder_func LDAP_P((
2710         void* mem_op,
2711         void* b,
2712         int tag,
2713         int elmtLen,
2714         struct slap_component_syntax_info* comp_syn_info,
2715         int* len,
2716         int mode));
2717
2718 typedef int ber_tag_decoder_func LDAP_P((
2719         void* mem_op,
2720         void* b,
2721         struct slap_component_syntax_info* comp_syn_info,
2722         int* len,
2723         int mode));
2724
2725 typedef void* extract_component_from_id_func LDAP_P((
2726         void* mem_op,
2727         ComponentReference* cr,
2728         void* comp ));
2729
2730 typedef void* convert_attr_to_comp_func LDAP_P ((
2731         Attribute* a,
2732         Syntax* syn,
2733         struct berval* bv ));
2734
2735 typedef void* alloc_nibble_func LDAP_P ((
2736         int initial_size,
2737         int increment_size ));
2738
2739 typedef void free_nibble_func LDAP_P ((
2740         void* nm ));
2741
2742 struct slap_component_syntax_info;
2743 typedef void convert_assert_to_comp_func LDAP_P ((
2744         void *mem_op,
2745         struct slap_component_syntax_info* csi_attr,
2746         struct berval* bv,
2747         struct slap_component_syntax_info** csi,
2748         int* len,
2749         int mode ));
2750
2751 typedef int convert_asn_to_ldap_func LDAP_P ((
2752         struct slap_component_syntax_info* csi,
2753         struct berval *bv ));
2754
2755 typedef void free_component_func LDAP_P ((
2756         void* mem_op));
2757
2758 typedef int test_component_func LDAP_P ((
2759         void* attr_mem_op,
2760         void* assert_mem_op,
2761         struct slap_component_syntax_info* csi,
2762         struct slap_component_assertion* ca));
2763
2764 typedef void* test_membership_func LDAP_P ((
2765         void* in ));
2766
2767 typedef void* get_component_info_func LDAP_P ((
2768         int in ));
2769
2770 struct slap_component_syntax_info;
2771
2772 typedef int component_encoder_func LDAP_P ((
2773         void* mem_op,
2774         struct slap_component_syntax_info* csi,
2775         struct berval* nvals ));
2776
2777 typedef int allcomponent_matching_func LDAP_P((
2778         char* oid,
2779         struct slap_component_syntax_info* comp1,
2780         struct slap_component_syntax_info* comp));
2781
2782 typedef struct slap_component_desc {
2783         /* Don't change the order of following four fields */
2784         int             cd_tag;
2785         AttributeType   *cd_comp_type;
2786         struct berval   cd_ad_type;/* ad_type, ad_cname */
2787         struct berval   cd_ad_cname;/* ad_type, ad_cname */
2788         unsigned        cd_flags; /*ad_flags*/
2789         int             cd_type;
2790         int             cd_type_id;
2791         encoder_func            *cd_ldap_encoder;
2792         encoder_func            *cd_gser_encoder;
2793         encoder_func            *cd_ber_encoder;
2794         gser_decoder_func       *cd_gser_decoder;
2795         ber_decoder_func        *cd_ber_decoder;
2796         comp_free_func          *cd_free;
2797         extract_component_from_id_func*  cd_extract_i;
2798         allcomponent_matching_func      *cd_all_match;
2799 } ComponentDesc;
2800
2801 typedef struct slap_component_syntax_info {
2802         Syntax* csi_syntax;
2803         ComponentDesc* csi_comp_desc;
2804 } ComponentSyntaxInfo;
2805
2806 #endif
2807
2808 /* slab heap data structures */
2809
2810 struct slab_object {
2811     void *so_ptr;
2812         int so_blockhead;
2813     LDAP_LIST_ENTRY(slab_object) so_link;
2814 };
2815
2816 struct slab_heap {
2817     void *sh_base;
2818     void *sh_last;
2819     void *sh_end;
2820         int sh_stack;
2821         int sh_maxorder;
2822     unsigned char **sh_map;
2823     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2824         LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2825 };
2826
2827 #ifdef SLAP_ZONE_ALLOC
2828 #define SLAP_ZONE_SIZE 0x80000          /* 512KB */
2829 #define SLAP_ZONE_SHIFT 19
2830 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2831 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2832 #define SLAP_ZONE_DELTA 0x800000        /* 8MB */
2833 #define SLAP_ZONE_ZOBLOCK 256
2834
2835 struct zone_object {
2836         void *zo_ptr;
2837         int zo_siz;
2838         int zo_idx;
2839         int zo_blockhead;
2840         LDAP_LIST_ENTRY(zone_object) zo_link;
2841 };
2842
2843 struct zone_latency_history {
2844         double zlh_latency;
2845         LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2846 };
2847
2848 struct zone_heap {
2849         int zh_fd;
2850         int zh_zonesize;
2851         int zh_zoneorder;
2852         int zh_numzones;
2853         int zh_maxzones;
2854         int zh_deltazones;
2855         void **zh_zones;
2856         ldap_pvt_thread_rdwr_t *zh_znlock;
2857         Avlnode *zh_zonetree;
2858         unsigned char ***zh_maps;
2859         int *zh_seqno;
2860         LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2861         LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2862         ldap_pvt_thread_mutex_t zh_mutex;
2863         ldap_pvt_thread_rdwr_t zh_lock;
2864         double zh_ema_latency;
2865         unsigned long zh_ema_samples;
2866         LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2867                                 zh_latency_history_queue;
2868         int zh_latency_history_qlen;
2869         int zh_latency_jump;
2870         int zh_swapping;
2871 };
2872 #endif
2873
2874 #define SLAP_BACKEND_INIT_MODULE(b) \
2875         int \
2876         init_module( int argc, char *argv[] ) \
2877         { \
2878                 BackendInfo bi; \
2879                 memset( &bi, '\0', sizeof( bi ) ); \
2880                 bi.bi_type = #b ; \
2881                 bi.bi_init = b ## _back_initialize; \
2882                 backend_add( &bi ); \
2883                 return 0; \
2884         }
2885
2886 LDAP_END_DECL
2887
2888 #include "proto-slap.h"
2889
2890 #endif /* _SLAP_H_ */