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