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