git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

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