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

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