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