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