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