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