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

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