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

   1 /* slap.h - stand alone ldap server include file */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #ifndef _SLAP_H_
   9 #define _SLAP_H_
  10
  11 #include "ldap_defaults.h"
  12
  13 #include <stdio.h>
  14 #include <ac/stdlib.h>
  15
  16 #include <sys/types.h>
  17 #include <ac/syslog.h>
  18 #include <ac/regex.h>
  19 #include <ac/signal.h>
  20 #include <ac/socket.h>
  21 #include <ac/time.h>
  22 #include <ac/param.h>
  23
  24 #include "avl.h"
  25
  26 #ifndef ldap_debug
  27 #define ldap_debug slap_debug
  28 #endif
  29
  30 #include "ldap_log.h"
  31
  32 #include <ldap.h>
  33 #include <ldap_schema.h>
  34
  35 #include "ldap_pvt_thread.h"
  36 #include "ldap_queue.h"
  37
  38 LDAP_BEGIN_DECL
  39 /*
  40  * SLAPD Memory allocation macros
  41  *
  42  * Unlike ch_*() routines, these routines do not assert() upon
  43  * allocation error.  They are intended to be used instead of
  44  * ch_*() routines where the caller has implemented proper
  45  * checking for and handling of allocation errors.
  46  *
  47  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  48  */
  49 #define SLAP_MALLOC(s)      ber_memalloc((s))
  50 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  51 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  52 #define SLAP_FREE(p)        ber_memfree((p))
  53 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  54 #define SLAP_STRDUP(s)      ber_strdup((s))
  55 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  56
  57 #ifdef f_next
  58 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  59 #endif
  60
  61 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  62 #define SLAPD_ANONYMOUS "cn=anonymous"
  63
  64 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  65  *
  66  * This is a value used internally by the backends. It is needed to allow
  67  * adding values that already exist without getting an error as required by
  68  * modrdn when the new rdn was already an attribute value itself.
  69  * JCG 05/1999 (gomez@engr.sgi.com)
  70  */
  71 #define SLAP_MOD_SOFTADD        0x1000
  72
  73 #define MAXREMATCHES (100)
  74
  75 #define SLAP_MAX_WORKER_THREADS         (32)
  76
  77 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
  78 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
  79
  80 #define SLAP_TEXT_BUFLEN (256)
  81
  82 /* psuedo error code indicating abandoned operation */
  83 #define SLAPD_ABANDON (-1)
  84
  85 /* psuedo error code indicating disconnect */
  86 #define SLAPD_DISCONNECT (-2)
  87
  88
  89 /* We assume "C" locale, that is US-ASCII */
  90 #define ASCII_SPACE(c)  ( (c) == ' ' )
  91 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
  92 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
  93 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
  94 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
  95 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
  96 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
  97
  98 #define SLAP_NIBBLE(c) ((c)&0x0f)
  99 #define SLAP_ESCAPE_CHAR ('\\')
 100 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 101 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 102
 103 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 104         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 105
 106 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 107 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
 108 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 109 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 110 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 111
 112 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 113 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 114 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 115 #define OID_SEPARATOR(c)        ( (c) == '.' )
 116 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 117
 118 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 119 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
 120
 121 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
 122 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 123
 124 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 125
 126 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 127         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 128         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 129         (c) == '?' || (c) == ' ' || (c) == '=' )
 130 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 131
 132 /* must match in schema_init.c */
 133 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 134 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 135 #define SLAPD_GROUP_ATTR                "member"
 136 #define SLAPD_GROUP_CLASS               "groupOfNames"
 137 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 138 #define SLAPD_ROLE_CLASS                "organizationalRole"
 139
 140 #ifdef SLAPD_ACI_ENABLED
 141 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 142 #endif
 143
 144 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
 145
 146 /* change this to "OpenLDAPset" */
 147 #define SLAPD_ACI_SET_ATTR              "template"
 148
 149 #define SLAPD_TOP_OID                   "2.5.6.0"
 150
 151 LDAP_SLAPD_V (int) slap_debug;
 152
 153 typedef unsigned long slap_mask_t;
 154
 155 /* Security Strength Factor */
 156 typedef unsigned slap_ssf_t;
 157
 158 typedef struct slap_ssf_set {
 159         slap_ssf_t sss_ssf;
 160         slap_ssf_t sss_transport;
 161         slap_ssf_t sss_tls;
 162         slap_ssf_t sss_sasl;
 163         slap_ssf_t sss_update_ssf;
 164         slap_ssf_t sss_update_transport;
 165         slap_ssf_t sss_update_tls;
 166         slap_ssf_t sss_update_sasl;
 167 } slap_ssf_set_t;
 168
 169 /*
 170  * Index types
 171  */
 172 #define SLAP_INDEX_TYPE           0x00FFUL
 173 #define SLAP_INDEX_UNDEFINED      0x0001UL
 174 #define SLAP_INDEX_PRESENT        0x0002UL
 175 #define SLAP_INDEX_EQUALITY       0x0004UL
 176 #define SLAP_INDEX_APPROX         0x0008UL
 177 #define SLAP_INDEX_SUBSTR         0x0010UL
 178 #define SLAP_INDEX_EXTENDED               0x0020UL
 179
 180 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 181
 182 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 183
 184 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 185
 186 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 187 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 188 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 189 #define SLAP_INDEX_SUBSTR_DEFAULT \
 190         ( SLAP_INDEX_SUBSTR \
 191         | SLAP_INDEX_SUBSTR_INITIAL \
 192         | SLAP_INDEX_SUBSTR_ANY \
 193         | SLAP_INDEX_SUBSTR_FINAL )
 194
 195 #define SLAP_INDEX_SUBSTR_MINLEN        2
 196 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 197 #define SLAP_INDEX_SUBSTR_STEP  2
 198
 199 #define SLAP_INDEX_FLAGS         0xF000UL
 200 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 201 #define SLAP_INDEX_NOLANG        0x2000UL /* don't use index w/ lang */
 202
 203 /*
 204  * there is a single index for each attribute.  these prefixes ensure
 205  * that there is no collision among keys.
 206  */
 207 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 208 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 209 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 210 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 211 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 212 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 213
 214 #define SLAP_SYNTAX_MATCHINGRULES_OID   "1.3.6.1.4.1.1466.115.121.1.30"
 215 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID  "1.3.6.1.4.1.1466.115.121.1.3"
 216 #define SLAP_SYNTAX_OBJECTCLASSES_OID   "1.3.6.1.4.1.1466.115.121.1.37"
 217
 218 /*
 219  * represents schema information for a database
 220  */
 221 #define SLAP_SCHERR_OUTOFMEM                    1
 222 #define SLAP_SCHERR_CLASS_NOT_FOUND             2
 223 #define SLAP_SCHERR_CLASS_BAD_USAGE             3
 224 #define SLAP_SCHERR_CLASS_BAD_SUP               4
 225 #define SLAP_SCHERR_CLASS_DUP                   5
 226 #define SLAP_SCHERR_ATTR_NOT_FOUND              6
 227 #define SLAP_SCHERR_ATTR_BAD_USAGE              7
 228 #define SLAP_SCHERR_ATTR_BAD_SUP                8
 229 #define SLAP_SCHERR_ATTR_INCOMPLETE             9
 230 #define SLAP_SCHERR_ATTR_DUP                    10
 231 #define SLAP_SCHERR_MR_NOT_FOUND                11
 232 #define SLAP_SCHERR_MR_INCOMPLETE               12
 233 #define SLAP_SCHERR_MR_DUP                              13
 234 #define SLAP_SCHERR_SYN_NOT_FOUND               14
 235 #define SLAP_SCHERR_SYN_DUP                             15
 236 #define SLAP_SCHERR_NO_NAME                             16
 237 #define SLAP_SCHERR_NOT_SUPPORTED               17
 238 #define SLAP_SCHERR_BAD_DESCR                   18
 239 #define SLAP_SCHERR_OIDM                                19
 240 #define SLAP_SCHERR_LAST                                SLAP_SCHERR_OIDM
 241
 242 typedef union slap_sockaddr {
 243         struct sockaddr sa_addr;
 244         struct sockaddr_in sa_in_addr;
 245 #ifdef LDAP_PF_INET6
 246         struct sockaddr_in6 sa_in6_addr;
 247 #endif
 248 #ifdef LDAP_PF_LOCAL
 249         struct sockaddr_un sa_un_addr;
 250 #endif
 251 } Sockaddr;
 252
 253 #ifdef LDAP_PF_INET6
 254 extern int slap_inet4or6;
 255 #endif
 256
 257 typedef struct slap_oid_macro {
 258         struct berval som_oid;
 259         char **som_names;
 260         struct slap_oid_macro *som_next;
 261 } OidMacro;
 262
 263 /* forward declarations */
 264 struct slap_syntax;
 265 struct slap_matching_rule;
 266
 267 typedef int slap_syntax_validate_func LDAP_P((
 268         struct slap_syntax *syntax,
 269         struct berval * in));
 270
 271 typedef int slap_syntax_transform_func LDAP_P((
 272         struct slap_syntax *syntax,
 273         struct berval * in,
 274         struct berval * out));
 275
 276 typedef struct slap_syntax {
 277         LDAPSyntax                      ssyn_syn;
 278 #define ssyn_oid                ssyn_syn.syn_oid
 279 #define ssyn_desc               ssyn_syn.syn_desc
 280 #define ssyn_extensions         ssyn_syn.syn_extensions
 281         /*
 282          * Note: the former
 283         ber_len_t       ssyn_oidlen;
 284          * has been replaced by a struct berval that uses the value
 285          * provided by ssyn_syn.syn_oid; a macro that expands to
 286          * the bv_len field of the berval is provided for backward
 287          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 288          */
 289         struct berval   ssyn_bvoid;
 290 #define ssyn_oidlen     ssyn_bvoid.bv_len
 291
 292         unsigned int ssyn_flags;
 293
 294 #define SLAP_SYNTAX_NONE        0x0000U
 295 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 296 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 297 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 298 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 299
 300         slap_syntax_validate_func       *ssyn_validate;
 301         slap_syntax_transform_func      *ssyn_normalize;
 302         slap_syntax_transform_func      *ssyn_pretty;
 303
 304 #ifdef SLAPD_BINARY_CONVERSION
 305         /* convert to and from binary */
 306         slap_syntax_transform_func      *ssyn_ber2str;
 307         slap_syntax_transform_func      *ssyn_str2ber;
 308 #endif
 309
 310         struct slap_syntax              *ssyn_next;
 311 } Syntax;
 312
 313 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 314 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 315 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 316 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 317 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 318
 319 typedef struct slap_syntax_defs_rec {
 320         char *sd_desc;
 321         int sd_flags;
 322         slap_syntax_validate_func *sd_validate;
 323         slap_syntax_transform_func *sd_normalize;
 324         slap_syntax_transform_func *sd_pretty;
 325 #ifdef SLAPD_BINARY_CONVERSION
 326         slap_syntax_transform_func *sd_ber2str;
 327         slap_syntax_transform_func *sd_str2ber;
 328 #endif
 329 } slap_syntax_defs_rec;
 330
 331 /* X -> Y Converter */
 332 typedef int slap_mr_convert_func LDAP_P((
 333         struct berval * in,
 334         struct berval * out ));
 335
 336 /* Normalizer */
 337 typedef int slap_mr_normalize_func LDAP_P((
 338         slap_mask_t use,
 339         struct slap_syntax *syntax, /* NULL if in is asserted value */
 340         struct slap_matching_rule *mr,
 341         struct berval * in,
 342         struct berval * out ));
 343
 344 /* Match (compare) function */
 345 typedef int slap_mr_match_func LDAP_P((
 346         int *match,
 347         slap_mask_t use,
 348         struct slap_syntax *syntax,     /* syntax of stored value */
 349         struct slap_matching_rule *mr,
 350         struct berval * value,
 351         void * assertValue ));
 352
 353 /* Index generation function */
 354 typedef int slap_mr_indexer_func LDAP_P((
 355         slap_mask_t use,
 356         slap_mask_t mask,
 357         struct slap_syntax *syntax,     /* syntax of stored value */
 358         struct slap_matching_rule *mr,
 359         struct berval *prefix,
 360         BerVarray values,
 361         BerVarray *keys ));
 362
 363 /* Filter index function */
 364 typedef int slap_mr_filter_func LDAP_P((
 365         slap_mask_t use,
 366         slap_mask_t mask,
 367         struct slap_syntax *syntax,     /* syntax of stored value */
 368         struct slap_matching_rule *mr,
 369         struct berval *prefix,
 370         void * assertValue,
 371         BerVarray *keys ));
 372
 373 typedef struct slap_matching_rule_use MatchingRuleUse;
 374
 375 typedef struct slap_matching_rule {
 376         LDAPMatchingRule                smr_mrule;
 377         MatchingRuleUse                 *smr_mru;
 378         /* RFC2252 string representation */
 379         struct berval                   smr_str;
 380         /*
 381          * Note: the former
 382         ber_len_t       smr_oidlen;
 383          * has been replaced by a struct berval that uses the value
 384          * provided by smr_mrule.mr_oid; a macro that expands to
 385          * the bv_len field of the berval is provided for backward
 386          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 387          */
 388         struct berval                   smr_bvoid;
 389 #define smr_oidlen                      smr_bvoid.bv_len
 390
 391         slap_mask_t                             smr_usage;
 392
 393 #define SLAP_MR_HIDE                    0x8000U
 394
 395 #define SLAP_MR_TYPE_MASK               0x0F00U
 396 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 397 #define SLAP_MR_USAGE                   0x000FU
 398
 399 #define SLAP_MR_NONE                    0x0000U
 400 #define SLAP_MR_EQUALITY                0x0100U
 401 #define SLAP_MR_ORDERING                0x0200U
 402 #define SLAP_MR_SUBSTR                  0x0400U
 403 #define SLAP_MR_EXT                             0x0800U
 404
 405 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 406 #define SLAP_MR_DN_FOLD                 0x0008U
 407
 408 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 409 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 410 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 411
 412 /*
 413  * normally the provided value is expected to conform to
 414  * assertion syntax specified in the matching rule, however
 415  * at times (such as during individual value modification),
 416  * the provided value is expected to conform to the
 417  * attribute's value syntax.
 418  */
 419 #define SLAP_MR_ASSERTION_SYNTAX_MATCH                  0x0000U
 420 #define SLAP_MR_VALUE_SYNTAX_MATCH                              0x0001U
 421 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH    0x0003U
 422
 423 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 424         (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
 425 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
 426         ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
 427
 428 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
 429         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 430                 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
 431 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 432         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 433                 == SLAP_MR_VALUE_SYNTAX_MATCH)
 434
 435         Syntax                                  *smr_syntax;
 436         slap_mr_convert_func    *smr_convert;
 437         slap_mr_normalize_func  *smr_normalize;
 438         slap_mr_match_func              *smr_match;
 439         slap_mr_indexer_func    *smr_indexer;
 440         slap_mr_filter_func             *smr_filter;
 441
 442         struct slap_matching_rule       *smr_associated;
 443         struct slap_matching_rule       *smr_next;
 444
 445 #define smr_oid                         smr_mrule.mr_oid
 446 #define smr_names                       smr_mrule.mr_names
 447 #define smr_desc                        smr_mrule.mr_desc
 448 #define smr_obsolete            smr_mrule.mr_obsolete
 449 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 450 #define smr_extensions          smr_mrule.mr_extensions
 451 } MatchingRule;
 452
 453 struct slap_matching_rule_use {
 454         LDAPMatchingRuleUse             smru_mruleuse;
 455         MatchingRule                    *smru_mr;
 456         /* RFC2252 string representation */
 457         struct berval                   smru_str;
 458
 459         struct slap_matching_rule_use   *smru_next;
 460
 461 #define smru_oid                        smru_mruleuse.mru_oid
 462 #define smru_names                      smru_mruleuse.mru_names
 463 #define smru_desc                       smru_mruleuse.mru_desc
 464 #define smru_obsolete                   smru_mruleuse.mru_obsolete
 465 #define smru_applies_oids               smru_mruleuse.mru_applies_oids
 466
 467 #define smru_usage                      smru_mr->smr_usage
 468 } /* MatchingRuleUse */ ;
 469
 470 typedef struct slap_mrule_defs_rec {
 471         char *                                          mrd_desc;
 472         slap_mask_t                                     mrd_usage;
 473         slap_mr_convert_func *          mrd_convert;
 474         slap_mr_normalize_func *        mrd_normalize;
 475         slap_mr_match_func *            mrd_match;
 476         slap_mr_indexer_func *          mrd_indexer;
 477         slap_mr_filter_func *           mrd_filter;
 478
 479         char *                                          mrd_associated;
 480 } slap_mrule_defs_rec;
 481
 482 struct slap_backend_db;
 483 struct slap_entry;
 484 struct slap_attr;
 485
 486 typedef int (AttributeTypeSchemaCheckFN)(
 487         struct slap_backend_db *be,
 488         struct slap_entry *e,
 489         struct slap_attr *attr,
 490         const char** text,
 491         char *textbuf, size_t textlen );
 492
 493 typedef struct slap_attribute_type {
 494         LDAPAttributeType               sat_atype;
 495         struct berval                   sat_cname;
 496         struct slap_attribute_type      *sat_sup;
 497         struct slap_attribute_type      **sat_subtypes;
 498         MatchingRule                    *sat_equality;
 499         MatchingRule                    *sat_approx;
 500         MatchingRule                    *sat_ordering;
 501         MatchingRule                    *sat_substr;
 502         Syntax                                  *sat_syntax;
 503
 504         AttributeTypeSchemaCheckFN      *sat_check;
 505
 506 #define SLAP_AT_NONE            0x0000U
 507 #define SLAP_AT_ABSTRACT        0x0100U /* cannot be instantiated */
 508 #define SLAP_AT_FINAL           0x0200U /* cannot be subtyped */
 509 #define SLAP_AT_HIDE            0x8000U /* hide attribute */
 510         slap_mask_t                                     sat_flags;
 511
 512         struct slap_attribute_type      *sat_next;
 513
 514 #define sat_oid                         sat_atype.at_oid
 515 #define sat_names                       sat_atype.at_names
 516 #define sat_desc                        sat_atype.at_desc
 517 #define sat_obsolete            sat_atype.at_obsolete
 518 #define sat_sup_oid                     sat_atype.at_sup_oid
 519 #define sat_equality_oid        sat_atype.at_equality_oid
 520 #define sat_ordering_oid        sat_atype.at_ordering_oid
 521 #define sat_substr_oid          sat_atype.at_substr_oid
 522 #define sat_syntax_oid          sat_atype.at_syntax_oid
 523 #define sat_single_value        sat_atype.at_single_value
 524 #define sat_collective          sat_atype.at_collective
 525 #define sat_no_user_mod         sat_atype.at_no_user_mod
 526 #define sat_usage                       sat_atype.at_usage
 527 #define sat_extensions          sat_atype.at_extensions
 528
 529         struct slap_attr_desc           *sat_ad;
 530         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 531 } AttributeType;
 532
 533 #define is_at_operational(at)   ((at)->sat_usage)
 534 #define is_at_single_value(at)  ((at)->sat_single_value)
 535 #define is_at_collective(at)    ((at)->sat_collective)
 536 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 537 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 538
 539 struct slap_object_class;
 540
 541 typedef int (ObjectClassSchemaCheckFN)(
 542         struct slap_backend_db *be,
 543         struct slap_entry *e,
 544         struct slap_object_class *oc,
 545         const char** text,
 546         char *textbuf, size_t textlen );
 547
 548 typedef struct slap_object_class {
 549         LDAPObjectClass                 soc_oclass;
 550         struct berval                   soc_cname;
 551         struct slap_object_class        **soc_sups;
 552         AttributeType                           **soc_required;
 553         AttributeType                           **soc_allowed;
 554         ObjectClassSchemaCheckFN        *soc_check;
 555         slap_mask_t                                     soc_flags;
 556 #define soc_oid                         soc_oclass.oc_oid
 557 #define soc_names                       soc_oclass.oc_names
 558 #define soc_desc                        soc_oclass.oc_desc
 559 #define soc_obsolete            soc_oclass.oc_obsolete
 560 #define soc_sup_oids            soc_oclass.oc_sup_oids
 561 #define soc_kind                        soc_oclass.oc_kind
 562 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 563 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 564 #define soc_extensions          soc_oclass.oc_extensions
 565
 566         struct slap_object_class        *soc_next;
 567 } ObjectClass;
 568
 569 #define SLAP_OC_ALIAS           0x0001
 570 #define SLAP_OC_REFERRAL        0x0002
 571 #define SLAP_OC_SUBENTRY        0x0004
 572 #define SLAP_OC_DYNAMICOBJECT   0x0008
 573 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 574 #define SLAP_OC__MASK           0x001F
 575 #define SLAP_OC__END            0x0020
 576 #define SLAP_OC_OPERATIONAL     0x4000
 577 #define SLAP_OC_HIDE            0x8000
 578
 579 #ifdef LDAP_EXTENDED_SCHEMA
 580 /*
 581  * DIT content rule
 582  */
 583 typedef struct slap_content_rule {
 584         LDAPContentRule         scr_crule;
 585         ObjectClass                     *scr_sclass;
 586         ObjectClass                     **scr_auxiliaries;      /* optional */
 587         AttributeType           **scr_required;         /* optional */
 588         AttributeType           **scr_allowed;          /* optional */
 589         AttributeType           **scr_precluded;        /* optional */
 590 #define scr_oid                 scr_crule.cr_oid
 591 #define scr_names               scr_crule.cr_names
 592 #define scr_desc                scr_crule.cr_desc
 593 #define scr_obsolete            soc_oclass.cr_obsolete
 594 #define scr_cr_oids_aux         soc_oclass.cr_oc_oids_aux
 595 #define scr_cr_oids_must        soc_oclass.cr_at_oids_must
 596 #define scr_cr_oids_may         soc_oclass.cr_at_oids_may
 597 #define scr_cr_oids_not         soc_oclass.cr_at_oids_not
 598 } ContentRule;
 599 #endif
 600
 601 /*
 602  * represents a recognized attribute description ( type + options )
 603  */
 604 typedef struct slap_attr_desc {
 605         struct slap_attr_desc *ad_next;
 606         AttributeType *ad_type;         /* attribute type, must be specified */
 607         struct berval ad_cname;         /* canonical name, must be specified */
 608         struct berval ad_lang;          /* empty if no language tags */
 609         unsigned ad_flags;
 610 #define SLAP_DESC_NONE                  0x00U
 611 #define SLAP_DESC_BINARY                0x01U
 612 #define SLAP_DESC_LANG_RANGE    0x80U
 613 } AttributeDescription;
 614
 615 typedef struct slap_attr_name {
 616         struct berval an_name;
 617         AttributeDescription *an_desc;
 618         ObjectClass *an_oc;
 619 } AttributeName;
 620
 621 #define slap_ad_is_lang(ad)                     ( (ad)->ad_lang.bv_len != 0 )
 622 #define slap_ad_is_lang_range(ad)       \
 623         ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
 624 #define slap_ad_is_binary(ad)           \
 625         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 626
 627 /*
 628  * pointers to schema elements used internally
 629  */
 630 struct slap_internal_schema {
 631         /* objectClass */
 632         ObjectClass *si_oc_top;
 633         ObjectClass *si_oc_extensibleObject;
 634         ObjectClass *si_oc_alias;
 635         ObjectClass *si_oc_referral;
 636         ObjectClass *si_oc_rootdse;
 637         ObjectClass *si_oc_subentry;
 638         ObjectClass *si_oc_subschema;
 639         ObjectClass *si_oc_monitor;
 640         ObjectClass *si_oc_collectiveAttributeSubentry;
 641         ObjectClass *si_oc_dynamicObject;
 642
 643         /* objectClass attribute descriptions */
 644         AttributeDescription *si_ad_objectClass;
 645
 646         /* operational attribute descriptions */
 647         AttributeDescription *si_ad_structuralObjectClass;
 648         AttributeDescription *si_ad_creatorsName;
 649         AttributeDescription *si_ad_createTimestamp;
 650         AttributeDescription *si_ad_modifiersName;
 651         AttributeDescription *si_ad_modifyTimestamp;
 652         AttributeDescription *si_ad_hasSubordinates;
 653         AttributeDescription *si_ad_subschemaSubentry;
 654         AttributeDescription *si_ad_collectiveSubentries;
 655         AttributeDescription *si_ad_collectiveExclusions;
 656         AttributeDescription *si_ad_entryUUID;
 657         AttributeDescription *si_ad_entryCSN;
 658
 659         /* root DSE attribute descriptions */
 660         AttributeDescription *si_ad_altServer;
 661         AttributeDescription *si_ad_namingContexts;
 662         AttributeDescription *si_ad_supportedControl;
 663         AttributeDescription *si_ad_supportedExtension;
 664         AttributeDescription *si_ad_supportedLDAPVersion;
 665         AttributeDescription *si_ad_supportedSASLMechanisms;
 666         AttributeDescription *si_ad_supportedFeatures;
 667         AttributeDescription *si_ad_monitorContext;
 668         AttributeDescription *si_ad_vendorName;
 669         AttributeDescription *si_ad_vendorVersion;
 670
 671         /* subentry attribute descriptions */
 672         AttributeDescription *si_ad_administrativeRole;
 673         AttributeDescription *si_ad_subtreeSpecification;
 674
 675         /* subschema subentry attribute descriptions */
 676         AttributeDescription *si_ad_ditStructureRules;
 677         AttributeDescription *si_ad_ditContentRules;
 678         AttributeDescription *si_ad_nameForms;
 679         AttributeDescription *si_ad_objectClasses;
 680         AttributeDescription *si_ad_attributeTypes;
 681         AttributeDescription *si_ad_ldapSyntaxes;
 682         AttributeDescription *si_ad_matchingRules;
 683         AttributeDescription *si_ad_matchingRuleUse;
 684
 685         /* Aliases & Referrals */
 686         AttributeDescription *si_ad_aliasedObjectName;
 687         AttributeDescription *si_ad_ref;
 688
 689         /* Access Control Internals */
 690         AttributeDescription *si_ad_entry;
 691         AttributeDescription *si_ad_children;
 692         AttributeDescription *si_ad_saslAuthzTo;
 693         AttributeDescription *si_ad_saslAuthzFrom;
 694 #ifdef SLAPD_ACI_ENABLED
 695         AttributeDescription *si_ad_aci;
 696 #endif
 697
 698         /* dynamic entries */
 699         AttributeDescription *si_ad_entryTtl;
 700         AttributeDescription *si_ad_dynamicSubtrees;
 701
 702         /* Other attributes descriptions */
 703         AttributeDescription *si_ad_distinguishedName;
 704         AttributeDescription *si_ad_name;
 705         AttributeDescription *si_ad_cn;
 706         AttributeDescription *si_ad_userPassword;
 707 #ifdef SLAPD_AUTHPASSWD
 708         AttributeDescription *si_ad_authPassword;
 709 #endif
 710 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 711         AttributeDescription *si_ad_krbName;
 712 #endif
 713
 714         /* Undefined Attribute Type */
 715         AttributeType   *si_at_undefined;
 716
 717         /* Matching Rules */
 718         MatchingRule    *si_mr_distinguishedNameMatch;
 719         MatchingRule    *si_mr_integerMatch;
 720
 721         /* Syntaxes */
 722         Syntax          *si_syn_octetString;
 723         Syntax          *si_syn_distinguishedName;
 724         Syntax          *si_syn_integer;
 725 };
 726
 727 typedef struct slap_attr_assertion {
 728         AttributeDescription    *aa_desc;
 729         struct berval aa_value;
 730 } AttributeAssertion;
 731
 732 typedef struct slap_ss_assertion {
 733         AttributeDescription    *sa_desc;
 734         struct berval           sa_initial;
 735         struct berval           *sa_any;
 736         struct berval           sa_final;
 737 } SubstringsAssertion;
 738
 739 typedef struct slap_mr_assertion {
 740         MatchingRule            *ma_rule;       /* optional */
 741         struct berval           ma_rule_text;  /* optional */
 742         AttributeDescription    *ma_desc;       /* optional */
 743         int                                             ma_dnattrs; /* boolean */
 744         struct berval           ma_value;       /* required */
 745 } MatchingRuleAssertion;
 746
 747 /*
 748  * represents a search filter
 749  */
 750 typedef struct slap_filter {
 751         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 752 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 753 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 754 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 755
 756         union f_un_u {
 757                 /* precomputed result */
 758                 ber_int_t f_un_result;
 759
 760                 /* DN */
 761                 struct berval *f_un_dn;
 762
 763                 /* present */
 764                 AttributeDescription *f_un_desc;
 765
 766                 /* simple value assertion */
 767                 AttributeAssertion *f_un_ava;
 768
 769                 /* substring assertion */
 770                 SubstringsAssertion *f_un_ssa;
 771
 772                 /* matching rule assertion */
 773                 MatchingRuleAssertion *f_un_mra;
 774
 775 #define f_dn                    f_un.f_un_dn
 776 #define f_desc                  f_un.f_un_desc
 777 #define f_ava                   f_un.f_un_ava
 778 #define f_av_desc               f_un.f_un_ava->aa_desc
 779 #define f_av_value              f_un.f_un_ava->aa_value
 780 #define f_sub                   f_un.f_un_ssa
 781 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 782 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 783 #define f_sub_any               f_un.f_un_ssa->sa_any
 784 #define f_sub_final             f_un.f_un_ssa->sa_final
 785 #define f_mra                   f_un.f_un_mra
 786 #define f_mr_rule               f_un.f_un_mra->ma_rule
 787 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 788 #define f_mr_desc               f_un.f_un_mra->ma_desc
 789 #define f_mr_value              f_un.f_un_mra->ma_value
 790 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 791
 792                 /* and, or, not */
 793                 struct slap_filter *f_un_complex;
 794         } f_un;
 795
 796 #define f_result        f_un.f_un_result
 797 #define f_and           f_un.f_un_complex
 798 #define f_or            f_un.f_un_complex
 799 #define f_not           f_un.f_un_complex
 800 #define f_list          f_un.f_un_complex
 801
 802         struct slap_filter      *f_next;
 803 } Filter;
 804
 805 /* compare routines can return undefined */
 806 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 807
 808 typedef struct slap_valuesreturnfilter {
 809         ber_tag_t       f_choice;
 810
 811         union vrf_un_u {
 812                 /* precomputed result */
 813                 ber_int_t f_un_result;
 814
 815                 /* DN */
 816                 char *f_un_dn;
 817
 818                 /* present */
 819                 AttributeDescription *f_un_desc;
 820
 821                 /* simple value assertion */
 822                 AttributeAssertion *f_un_ava;
 823
 824                 /* substring assertion */
 825                 SubstringsAssertion *f_un_ssa;
 826
 827                 /* matching rule assertion */
 828                 MatchingRuleAssertion *f_un_mra;
 829         } f_un;
 830
 831         struct slap_valuesreturnfilter  *f_next;
 832 } ValuesReturnFilter;
 833
 834 /*
 835  * represents an attribute (description + values)
 836  */
 837 typedef struct slap_attr {
 838         AttributeDescription *a_desc;
 839         BerVarray       a_vals;
 840         struct slap_attr        *a_next;
 841         unsigned a_flags;
 842 #define SLAP_ATTR_IXADD         0x1U
 843 #define SLAP_ATTR_IXDEL         0x2U
 844 } Attribute;
 845
 846
 847 /*
 848  * the id used in the indexes to refer to an entry
 849  */
 850 typedef unsigned long   ID;
 851 #define NOID    ((ID)~0)
 852
 853 /*
 854  * represents an entry in core
 855  */
 856 typedef struct slap_entry {
 857         /*
 858          * The ID field should only be changed before entry is
 859          * inserted into a cache.  The ID value is backend
 860          * specific.
 861          */
 862         ID              e_id;
 863
 864         struct berval e_name;   /* name (DN) of this entry */
 865         struct berval e_nname;  /* normalized name (DN) of this entry */
 866
 867         /* for migration purposes */
 868 #define e_dn e_name.bv_val
 869 #define e_ndn e_nname.bv_val
 870
 871         Attribute       *e_attrs;       /* list of attributes + values */
 872
 873         slap_mask_t     e_ocflags;
 874
 875         struct berval   e_bv;           /* For entry_encode/entry_decode */
 876
 877         /* for use by the backend for any purpose */
 878         void*   e_private;
 879 } Entry;
 880
 881 /*
 882  * A list of LDAPMods
 883  */
 884 typedef struct slap_mod {
 885         int sm_op;
 886         AttributeDescription *sm_desc;
 887         struct berval sm_type;
 888         BerVarray sm_bvalues;
 889 } Modification;
 890
 891 typedef struct slap_mod_list {
 892         Modification sml_mod;
 893 #define sml_op          sml_mod.sm_op
 894 #define sml_desc        sml_mod.sm_desc
 895 #define sml_type        sml_mod.sm_type
 896 #define sml_bvalues     sml_mod.sm_bvalues
 897         struct slap_mod_list *sml_next;
 898 } Modifications;
 899
 900 typedef struct slap_ldap_modlist {
 901         LDAPMod ml_mod;
 902         struct slap_ldap_modlist *ml_next;
 903 #define ml_op           ml_mod.mod_op
 904 #define ml_type         ml_mod.mod_type
 905 #define ml_values       ml_mod.mod_values
 906 #define ml_bvalues      ml_mod.mod_bvalues
 907 } LDAPModList;
 908
 909 /*
 910  * represents an access control list
 911  */
 912 typedef enum slap_access_e {
 913         ACL_INVALID_ACCESS = -1,
 914         ACL_NONE = 0,
 915         ACL_AUTH,
 916         ACL_COMPARE,
 917         ACL_SEARCH,
 918         ACL_READ,
 919         ACL_WRITE
 920 } slap_access_t;
 921
 922 typedef enum slap_control_e {
 923         ACL_INVALID_CONTROL     = 0,
 924         ACL_STOP,
 925         ACL_CONTINUE,
 926         ACL_BREAK
 927 } slap_control_t;
 928
 929 typedef enum slap_style_e {
 930         ACL_STYLE_REGEX = 0,
 931         ACL_STYLE_BASE,
 932         ACL_STYLE_ONE,
 933         ACL_STYLE_SUBTREE,
 934         ACL_STYLE_CHILDREN,
 935         ACL_STYLE_ATTROF,
 936
 937         /* alternate names */
 938         ACL_STYLE_EXACT = ACL_STYLE_BASE
 939 } slap_style_t;
 940
 941 typedef struct slap_authz_info {
 942         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
 943         struct berval   sai_mech;               /* SASL Mechanism */
 944         struct berval   sai_dn;                 /* DN for reporting purposes */
 945         struct berval   sai_ndn;                /* Normalized DN */
 946
 947         /* Security Strength Factors */
 948         slap_ssf_t      sai_ssf;                        /* Overall SSF */
 949         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
 950         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
 951         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
 952 } AuthorizationInformation;
 953
 954 /* the "by" part */
 955 typedef struct slap_access {
 956         slap_control_t a_type;
 957
 958 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
 959
 960 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
 961 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
 962 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
 963 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
 964 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
 965 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
 966
 967 #define ACL_PRIV_MASK                   0x00ffUL
 968
 969 /* priv flags */
 970 #define ACL_PRIV_LEVEL                  0x1000UL
 971 #define ACL_PRIV_ADDITIVE               0x2000UL
 972 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
 973
 974 /* invalid privs */
 975 #define ACL_PRIV_INVALID                0x0UL
 976
 977 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
 978 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
 979 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
 980 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
 981
 982 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
 983 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
 984
 985 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
 986
 987 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
 988
 989 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
 990 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
 991 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
 992
 993 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
 994 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
 995 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
 996 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
 997 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
 998 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
 999
1000 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1001 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1002 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1003 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
1004 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
1005 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1006 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1007
1008 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1009 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1010 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1011 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1012 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1013 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1014
1015         slap_mask_t     a_access_mask;
1016
1017         AuthorizationInformation        a_authz;
1018 #define a_dn_pat        a_authz.sai_dn
1019
1020         slap_style_t a_dn_style;
1021         AttributeDescription    *a_dn_at;
1022         int                     a_dn_self;
1023         int                     a_dn_expand;
1024
1025         slap_style_t a_peername_style;
1026         struct berval   a_peername_pat;
1027         slap_style_t a_sockname_style;
1028         struct berval   a_sockname_pat;
1029
1030         slap_style_t a_domain_style;
1031         struct berval   a_domain_pat;
1032         int             a_domain_expand;
1033
1034         slap_style_t a_sockurl_style;
1035         struct berval   a_sockurl_pat;
1036         slap_style_t a_set_style;
1037         struct berval   a_set_pat;
1038
1039 #ifdef SLAPD_ACI_ENABLED
1040         AttributeDescription    *a_aci_at;
1041 #endif
1042
1043         /* ACL Groups */
1044         slap_style_t a_group_style;
1045         struct berval   a_group_pat;
1046         ObjectClass                             *a_group_oc;
1047         AttributeDescription    *a_group_at;
1048
1049         struct slap_access      *a_next;
1050 } Access;
1051
1052 /* the "to" part */
1053 typedef struct slap_acl {
1054         /* "to" part: the entries this acl applies to */
1055         Filter          *acl_filter;
1056         slap_style_t acl_dn_style;
1057         regex_t         acl_dn_re;
1058         struct berval   acl_dn_pat;
1059         AttributeName   *acl_attrs;
1060
1061         /* "by" part: list of who has what access to the entries */
1062         Access  *acl_access;
1063
1064         struct slap_acl *acl_next;
1065 } AccessControl;
1066
1067 typedef struct slap_acl_state {
1068         unsigned as_recorded;
1069 #define ACL_STATE_NOT_RECORDED                  0x0
1070 #define ACL_STATE_RECORDED_VD                   0x1
1071 #define ACL_STATE_RECORDED_NV                   0x2
1072 #define ACL_STATE_RECORDED                              0x3
1073
1074         /* Access state */
1075         AccessControl *as_vd_acl;
1076         slap_mask_t as_vd_acl_mask;
1077         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1078         int as_vd_acl_count;
1079
1080         Access *as_vd_access;
1081         int as_vd_access_count;
1082
1083         int as_result;
1084 } AccessControlState;
1085 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1086
1087 /*
1088  * replog moddn param structure
1089  */
1090 struct slap_replog_moddn {
1091         struct berval *newrdn;
1092         int     deloldrdn;
1093         struct berval *newsup;
1094 };
1095
1096 /*
1097  * Backend-info
1098  * represents a backend
1099  */
1100
1101 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1102 typedef struct slap_backend_db BackendDB;               /* per backend database */
1103
1104 LDAP_SLAPD_V (int) nBackendInfo;
1105 LDAP_SLAPD_V (int) nBackendDB;
1106 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1107 LDAP_SLAPD_V (BackendDB *) backendDB;
1108
1109 LDAP_SLAPD_V (int) slapMode;
1110 #define SLAP_UNDEFINED_MODE     0x0000
1111 #define SLAP_SERVER_MODE        0x0001
1112 #define SLAP_TOOL_MODE          0x0002
1113 #define SLAP_MODE                       0x0003
1114
1115 #define SLAP_TRUNCATE_MODE      0x0100
1116
1117 struct slap_replica_info {
1118         char *ri_host;                          /* supersedes be_replica */
1119         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1120         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1121         int ri_exclude;                 /* 1 => exclude ri_attrs */
1122 };
1123
1124 struct slap_limits_set {
1125         /* time limits */
1126         int     lms_t_soft;
1127         int     lms_t_hard;
1128
1129         /* size limits */
1130         int     lms_s_soft;
1131         int     lms_s_hard;
1132         int     lms_s_unchecked;
1133 };
1134
1135 struct slap_limits {
1136         int     lm_type;        /* type of pattern */
1137 #define SLAP_LIMITS_UNDEFINED   0x0000
1138 #define SLAP_LIMITS_EXACT       0x0001
1139 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1140 #define SLAP_LIMITS_ONE         0x0002
1141 #define SLAP_LIMITS_SUBTREE     0x0003
1142 #define SLAP_LIMITS_CHILDREN    0x0004
1143 #define SLAP_LIMITS_REGEX       0x0005
1144 #define SLAP_LIMITS_ANONYMOUS   0x0006
1145 #define SLAP_LIMITS_USERS       0x0007
1146 #define SLAP_LIMITS_ANY         0x0008
1147         regex_t lm_dn_regex;            /* regex data for REGEX */
1148
1149         /*
1150          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1151          * pattern for REGEX; NULL for ANONYMOUS, USERS
1152          */
1153         struct berval lm_dn_pat;
1154
1155         struct slap_limits_set  lm_limits;
1156 };
1157
1158 /* temporary aliases */
1159 typedef BackendDB Backend;
1160 #define nbackends nBackendDB
1161 #define backends backendDB
1162
1163 struct slap_backend_db {
1164         BackendInfo     *bd_info;       /* pointer to shared backend info */
1165
1166         /* BackendInfo accessors */
1167 #define         be_config       bd_info->bi_db_config
1168 #define         be_type         bd_info->bi_type
1169
1170 #define         be_bind         bd_info->bi_op_bind
1171 #define         be_unbind       bd_info->bi_op_unbind
1172 #define         be_add          bd_info->bi_op_add
1173 #define         be_compare      bd_info->bi_op_compare
1174 #define         be_delete       bd_info->bi_op_delete
1175 #define         be_modify       bd_info->bi_op_modify
1176 #define         be_modrdn       bd_info->bi_op_modrdn
1177 #define         be_search       bd_info->bi_op_search
1178
1179 #define         be_extended     bd_info->bi_extended
1180
1181 #define         be_release      bd_info->bi_entry_release_rw
1182 #define         be_chk_referrals        bd_info->bi_chk_referrals
1183 #define         be_group        bd_info->bi_acl_group
1184 #define         be_attribute    bd_info->bi_acl_attribute
1185 #define         be_operational  bd_info->bi_operational
1186
1187 #define         be_controls     bd_info->bi_controls
1188
1189 #define         be_connection_init      bd_info->bi_connection_init
1190 #define         be_connection_destroy   bd_info->bi_connection_destroy
1191
1192 #ifdef SLAPD_TOOLS
1193 #define         be_entry_open bd_info->bi_tool_entry_open
1194 #define         be_entry_close bd_info->bi_tool_entry_close
1195 #define         be_entry_first bd_info->bi_tool_entry_first
1196 #define         be_entry_next bd_info->bi_tool_entry_next
1197 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1198 #define         be_entry_get bd_info->bi_tool_entry_get
1199 #define         be_entry_put bd_info->bi_tool_entry_put
1200 #define         be_sync bd_info->bi_tool_sync
1201 #endif
1202
1203 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1204 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1205 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1206 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1207 #define SLAP_BFLAG_ALIASES              0x0100U
1208 #define SLAP_BFLAG_REFERRALS    0x0200U
1209 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1210 #define SLAP_BFLAG_MONITOR              0x1000U
1211 #define SLAP_BFLAG_DYNAMIC              0x2000U
1212         slap_mask_t     be_flags;
1213 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1214 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1215 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1216 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1217 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1218 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1219
1220         slap_mask_t     be_restrictops;         /* restriction operations */
1221 #define SLAP_RESTRICT_OP_ADD            0x0001U
1222 #define SLAP_RESTRICT_OP_BIND           0x0002U
1223 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1224 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1225 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1226 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1227 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1228 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1229
1230 #define SLAP_RESTRICT_OP_READS  \
1231         ( SLAP_RESTRICT_OP_COMPARE    \
1232         | SLAP_RESTRICT_OP_SEARCH )
1233 #define SLAP_RESTRICT_OP_WRITES \
1234         ( SLAP_RESTRICT_OP_ADD    \
1235         | SLAP_RESTRICT_OP_DELETE \
1236         | SLAP_RESTRICT_OP_MODIFY \
1237         | SLAP_RESTRICT_OP_RENAME )
1238
1239 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1240 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1241 #define SLAP_ALLOW_BIND_ANON_DN         0x0003U /* dn should be empty */
1242
1243 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1244 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1245 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1246                                                                         0x0004U /* unprotected simple auth */
1247 #define SLAP_DISALLOW_BIND_KRBV4        0x0008U /* Kerberos V4 authentication */
1248
1249 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1250 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1251
1252         slap_mask_t     be_requires;    /* pre-operation requirements */
1253 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1254 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1255 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1256 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1257 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1258
1259         /* Required Security Strength Factor */
1260         slap_ssf_set_t be_ssf_set;
1261
1262         /* these should be renamed from be_ to bd_ */
1263         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1264         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1265         BerVarray       be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1266 #ifdef SLAPD_SCHEMA_DN
1267         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1268         struct berval be_schemandn;     /* normalized subschema DN */
1269 #endif
1270         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1271         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1272         struct berval be_rootpw;        /* the magic "root" password for this db        */
1273         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
1274 #define be_sizelimit    be_def_limit.lms_s_soft
1275 #define be_timelimit    be_def_limit.lms_t_soft
1276         struct slap_limits_set be_def_limit; /* default limits */
1277         struct slap_limits **be_limits; /* regex-based size and time limits */
1278         AccessControl *be_acl;  /* access control list for this backend    */
1279         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1280         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1281         char    *be_replogfile; /* replication log file (in master)        */
1282         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1283         BerVarray       be_update_refs; /* where to refer modifying clients to */
1284         char    *be_realm;
1285         void    *be_private;    /* anything the backend database needs     */
1286 };
1287
1288 struct slap_conn;
1289 struct slap_op;
1290
1291 /* Backend function typedefs */
1292 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1293 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1294         const char *fname, int lineno,
1295         int argc, char **argv));
1296 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1297 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1298 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1299
1300 typedef int (BI_db_init) LDAP_P((Backend *bd));
1301 typedef int (BI_db_config) LDAP_P((Backend *bd,
1302         const char *fname, int lineno,
1303         int argc, char **argv));
1304 typedef int (BI_db_open) LDAP_P((Backend *bd));
1305 typedef int (BI_db_close) LDAP_P((Backend *bd));
1306 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1307
1308 typedef int (BI_op_bind)  LDAP_P(( BackendDB *bd,
1309                 struct slap_conn *c, struct slap_op *o,
1310                 struct berval *dn, struct berval *ndn, int method,
1311                 struct berval *cred, struct berval *edn ));
1312 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1313                 struct slap_conn *c, struct slap_op *o ));
1314 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1315                 struct slap_conn *c, struct slap_op *o,
1316                 struct berval *base, struct berval *nbase,
1317                 int scope, int deref,
1318                 int slimit, int tlimit,
1319                 Filter *f, struct berval *filterstr,
1320                 AttributeName *attrs, int attrsonly));
1321 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1322                 struct slap_conn *c, struct slap_op *o,
1323                 struct berval *dn, struct berval *ndn,
1324                 AttributeAssertion *ava));
1325 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1326                 struct slap_conn *c, struct slap_op *o,
1327                 struct berval *dn, struct berval *ndn,
1328                 Modifications *m));
1329 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1330                 struct slap_conn *c, struct slap_op *o,
1331                 struct berval *dn, struct berval *ndn,
1332                 struct berval *newrdn, struct berval *nnewrdn,
1333                 int deleteoldrdn,
1334                 struct berval *newSup, struct berval *nnewSup ));
1335 typedef int (BI_op_add)    LDAP_P((BackendDB *bd,
1336                 struct slap_conn *c, struct slap_op *o,
1337                 Entry *e));
1338 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1339                 struct slap_conn *c, struct slap_op *o,
1340                 struct berval *dn, struct berval *ndn));
1341 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1342                 struct slap_conn *c, struct slap_op *o,
1343                 ber_int_t msgid));
1344
1345 typedef int (BI_op_extended) LDAP_P((
1346     BackendDB           *be,
1347     struct slap_conn    *conn,
1348     struct slap_op              *op,
1349         const char              *reqoid,
1350     struct berval * reqdata,
1351         char            **rspoid,
1352     struct berval ** rspdata,
1353         LDAPControl *** rspctrls,
1354         const char **   text,
1355         BerVarray *refs ));
1356
1357 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1358                 struct slap_conn *c, struct slap_op *o,
1359                 Entry *e, int rw));
1360
1361 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1362                 struct slap_conn *c, struct slap_op *o,
1363                 struct berval *dn, struct berval *ndn,
1364                 const char **text ));
1365
1366 typedef int (BI_acl_group)  LDAP_P((Backend *bd,
1367                 struct slap_conn *c, struct slap_op *o,
1368                 Entry *e,
1369                 struct berval *bdn,
1370                 struct berval *edn,
1371                 ObjectClass *group_oc,
1372                 AttributeDescription *group_at ));
1373
1374 typedef int (BI_acl_attribute)  LDAP_P((Backend *bd,
1375                 struct slap_conn *c, struct slap_op *o,
1376                 Entry *e, struct berval *edn,
1377                 AttributeDescription *entry_at,
1378                 BerVarray *vals ));
1379
1380 typedef int (BI_operational)  LDAP_P((Backend *bd,
1381                 struct slap_conn *c, struct slap_op *o,
1382                 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1383
1384 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1385                 struct slap_conn *c));
1386 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1387                 struct slap_conn *c));
1388
1389 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1390 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1391 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1392 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1393 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1394 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1395                         struct berval *text ));
1396 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1397 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1398
1399 struct slap_backend_info {
1400         char    *bi_type; /* type of backend */
1401
1402         /*
1403          * per backend type routines:
1404          * bi_init: called to allocate a backend_info structure,
1405          *              called once BEFORE configuration file is read.
1406          *              bi_init() initializes this structure hence is
1407          *              called directly from be_initialize()
1408          * bi_config: called per 'backend' specific option
1409          *              all such options must before any 'database' options
1410          *              bi_config() is called only from read_config()
1411          * bi_open: called to open each database, called
1412          *              once AFTER configuration file is read but
1413          *              BEFORE any bi_db_open() calls.
1414          *              bi_open() is called from backend_startup()
1415          * bi_close: called to close each database, called
1416          *              once during shutdown after all bi_db_close calls.
1417          *              bi_close() is called from backend_shutdown()
1418          * bi_destroy: called to destroy each database, called
1419          *              once during shutdown after all bi_db_destroy calls.
1420          *              bi_destory() is called from backend_destroy()
1421          */
1422         BI_init *bi_init;
1423         BI_config       *bi_config;
1424         BI_open *bi_open;
1425         BI_close        *bi_close;
1426         BI_destroy      *bi_destroy;
1427
1428         /*
1429          * per database routines:
1430          * bi_db_init: called to initialize each database,
1431          *      called upon reading 'database <type>'
1432          *      called only from backend_db_init()
1433          * bi_db_config: called to configure each database,
1434          *  called per database to handle per database options
1435          *      called only from read_config()
1436          * bi_db_open: called to open each database
1437          *      called once per database immediately AFTER bi_open()
1438          *      calls but before daemon startup.
1439          *  called only by backend_startup()
1440          * bi_db_close: called to close each database
1441          *      called once per database during shutdown but BEFORE
1442          *  any bi_close call.
1443          *  called only by backend_shutdown()
1444          * bi_db_destroy: called to destroy each database
1445          *  called once per database during shutdown AFTER all
1446          *  bi_close calls but before bi_destory calls.
1447          *  called only by backend_destory()
1448          */
1449         BI_db_init      *bi_db_init;
1450         BI_db_config    *bi_db_config;
1451         BI_db_open      *bi_db_open;
1452         BI_db_close     *bi_db_close;
1453         BI_db_destroy   *bi_db_destroy;
1454
1455         /* LDAP Operations Handling Routines */
1456         BI_op_bind      *bi_op_bind;
1457         BI_op_unbind    *bi_op_unbind;
1458         BI_op_search    *bi_op_search;
1459         BI_op_compare   *bi_op_compare;
1460         BI_op_modify    *bi_op_modify;
1461         BI_op_modrdn    *bi_op_modrdn;
1462         BI_op_add       *bi_op_add;
1463         BI_op_delete    *bi_op_delete;
1464         BI_op_abandon   *bi_op_abandon;
1465
1466         /* Extended Operations Helper */
1467         BI_op_extended  *bi_extended;
1468
1469         /* Auxilary Functions */
1470         BI_entry_release_rw     *bi_entry_release_rw;
1471         BI_chk_referrals        *bi_chk_referrals;
1472
1473         BI_acl_group    *bi_acl_group;
1474         BI_acl_attribute        *bi_acl_attribute;
1475
1476         BI_operational  *bi_operational;
1477
1478         BI_connection_init      *bi_connection_init;
1479         BI_connection_destroy   *bi_connection_destroy;
1480
1481         /* hooks for slap tools */
1482         BI_tool_entry_open      *bi_tool_entry_open;
1483         BI_tool_entry_close     *bi_tool_entry_close;
1484         BI_tool_entry_first     *bi_tool_entry_first;
1485         BI_tool_entry_next      *bi_tool_entry_next;
1486         BI_tool_entry_get       *bi_tool_entry_get;
1487         BI_tool_entry_put       *bi_tool_entry_put;
1488         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1489         BI_tool_sync            *bi_tool_sync;
1490
1491 #define SLAP_INDEX_ADD_OP               0x0001
1492 #define SLAP_INDEX_DELETE_OP    0x0002
1493
1494         char **bi_controls;             /* supported controls */
1495
1496         unsigned int bi_nDB;    /* number of databases of this type */
1497         void    *bi_private;    /* anything the backend type needs */
1498 };
1499
1500 #define c_authtype      c_authz.sai_method
1501 #define c_authmech      c_authz.sai_mech
1502 #define c_dn            c_authz.sai_dn
1503 #define c_ndn           c_authz.sai_ndn
1504 #define c_ssf                   c_authz.sai_ssf
1505 #define c_transport_ssf c_authz.sai_transport_ssf
1506 #define c_tls_ssf               c_authz.sai_tls_ssf
1507 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1508
1509 #define o_authtype      o_authz.sai_method
1510 #define o_authmech      o_authz.sai_mech
1511 #define o_dn            o_authz.sai_dn
1512 #define o_ndn           o_authz.sai_ndn
1513 #define o_ssf                   o_authz.sai_ssf
1514 #define o_transport_ssf o_authz.sai_transport_ssf
1515 #define o_tls_ssf               o_authz.sai_tls_ssf
1516 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1517
1518 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1519         ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1520         BerVarray, const char *, struct berval *,
1521         struct berval *, LDAPControl ** );
1522
1523 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1524         ber_int_t, const char *, const char *, BerVarray,
1525         LDAPControl **, int nentries);
1526
1527 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1528         struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1529
1530 typedef struct slap_callback {
1531         slap_response *sc_response;
1532         slap_sresult *sc_sresult;
1533         slap_sendentry *sc_sendentry;
1534         void *sc_private;
1535 } slap_callback;
1536
1537 /*
1538  * Paged Results state
1539  */
1540 typedef unsigned long PagedResultsCookie;
1541 typedef struct slap_paged_state {
1542         Backend *ps_be;
1543         PagedResultsCookie ps_cookie;
1544         ID ps_id;
1545 } PagedResultsState;
1546
1547 /*
1548  * represents an operation pending from an ldap client
1549  */
1550 typedef struct slap_op {
1551         unsigned long o_opid;   /* id of this operation */
1552         unsigned long o_connid; /* id of conn initiating this op */
1553         struct slap_conn *o_conn;       /* connection spawning this op */
1554
1555         ber_int_t       o_msgid;        /* msgid of the request */
1556         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1557         ber_tag_t       o_tag;          /* tag of the request */
1558         time_t          o_time;         /* time op was initiated */
1559
1560         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1561
1562         volatile sig_atomic_t o_abandon;        /* abandon flag */
1563
1564         char o_do_not_cache;    /* don't cache from this op */
1565
1566 #define SLAP_NO_CONTROL 0
1567 #define SLAP_NONCRITICAL_CONTROL 1
1568 #define SLAP_CRITICAL_CONTROL 2
1569         char o_managedsait;
1570         char o_noop;
1571         char o_subentries;
1572         char o_subentries_visibility;
1573         char o_valuesreturnfilter;
1574
1575         char o_pagedresults;
1576         ber_int_t o_pagedresults_size;
1577         PagedResultsState o_pagedresults_state;
1578
1579 #ifdef LDAP_CONNECTIONLESS
1580         Sockaddr        o_peeraddr;     /* UDP peer address               */
1581 #endif
1582         AuthorizationInformation o_authz;
1583
1584         BerElement      *o_ber;         /* ber of the request             */
1585         slap_callback   *o_callback;    /* callback pointers */
1586         LDAPControl     **o_ctrls;       /* controls */
1587
1588         void    *o_threadctx;           /* thread pool thread context */
1589         void    *o_private;     /* anything the backend needs */
1590
1591         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1592         ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1593 } Operation;
1594
1595 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1596 #define get_subentries(op)                              ((int)(op)->o_subentries)
1597 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1598
1599 /*
1600  * Caches the result of a backend_group check for ACL evaluation
1601  */
1602 typedef struct slap_gacl {
1603         struct slap_gacl *ga_next;
1604         Backend *ga_be;
1605         ObjectClass *ga_oc;
1606         AttributeDescription *ga_at;
1607         int ga_res;
1608         ber_len_t ga_len;
1609         char ga_ndn[1];
1610 } GroupAssertion;
1611
1612 /*
1613  * represents a connection from an ldap client
1614  */
1615 typedef struct slap_conn {
1616         int                     c_struct_state; /* structure management state */
1617         int                     c_conn_state;   /* connection state */
1618
1619         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1620         Sockbuf         *c_sb;                  /* ber connection stuff           */
1621
1622         /* only can be changed by connect_init */
1623         time_t          c_starttime;    /* when the connection was opened */
1624         time_t          c_activitytime; /* when the connection was last used */
1625         unsigned long           c_connid;       /* id of this connection for stats*/
1626
1627         struct berval   c_listener_url; /* listener URL */
1628         struct berval   c_peer_domain;  /* DNS name of client */
1629         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
1630         struct berval   c_sock_name;    /* sock name (trans=addr:port) */
1631
1632         /* only can be changed by binding thread */
1633         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1634         struct berval   c_sasl_bind_mech;                       /* mech in progress */
1635         struct berval   c_sasl_dn;      /* temporary storage */
1636
1637         /* authorization backend */
1638         Backend *c_authz_backend;
1639
1640         AuthorizationInformation c_authz;
1641         GroupAssertion *c_groups;
1642
1643         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1644
1645         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
1646         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
1647
1648         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1649         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1650
1651         BerElement      *c_currentber;  /* ber we're attempting to read */
1652         int             c_writewaiter;  /* true if writer is waiting */
1653
1654 #ifdef LDAP_CONNECTIONLESS
1655         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
1656 #endif
1657 #ifdef HAVE_TLS
1658         int     c_is_tls;               /* true if this LDAP over raw TLS */
1659         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1660 #endif
1661         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1662         void    *c_sasl_context;        /* SASL session context */
1663         void    *c_sasl_extra;          /* SASL session extra stuff */
1664         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
1665
1666         PagedResultsState c_pagedresults_state; /* paged result state */
1667
1668         long    c_n_ops_received;       /* num of ops received (next op_id) */
1669         long    c_n_ops_executing;      /* num of ops currently executing */
1670         long    c_n_ops_pending;        /* num of ops pending execution */
1671         long    c_n_ops_completed;      /* num of ops completed */
1672
1673         long    c_n_get;                /* num of get calls */
1674         long    c_n_read;               /* num of read calls */
1675         long    c_n_write;              /* num of write calls */
1676 } Connection;
1677
1678 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1679 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1680         do { \
1681                 if ( ldap_debug & (level) ) \
1682                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1683                 if ( ldap_syslog & (level) ) \
1684                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1685                                 (arg2), (arg3) ); \
1686         } while (0)
1687 #else
1688 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1689 #endif
1690
1691 /*
1692  * listener; need to access it from monitor backend
1693  */
1694 typedef struct slap_listener {
1695         char* sl_url;
1696         char* sl_name;
1697 #ifdef HAVE_TLS
1698         int             sl_is_tls;
1699 #endif
1700 #ifdef LDAP_CONNECTIONLESS
1701         int     sl_is_udp;              /* UDP listener is also data port */
1702 #endif
1703         ber_socket_t sl_sd;
1704         Sockaddr sl_sa;
1705 #define sl_addr sl_sa.sa_in_addr
1706 } Listener;
1707
1708 #ifdef SLAPD_MONITOR
1709 /*
1710  * Operation indices
1711  */
1712 enum {
1713         SLAP_OP_BIND = 0,
1714         SLAP_OP_UNBIND,
1715         SLAP_OP_ADD,
1716         SLAP_OP_DELETE,
1717         SLAP_OP_MODRDN,
1718         SLAP_OP_MODIFY,
1719         SLAP_OP_COMPARE,
1720         SLAP_OP_SEARCH,
1721         SLAP_OP_ABANDON,
1722         SLAP_OP_EXTENDED,
1723         SLAP_OP_LAST
1724 };
1725 #endif /* SLAPD_MONITOR */
1726
1727 /*
1728  * Better know these all around slapd
1729  */
1730 #define SLAP_LDAPDN_PRETTY 0x1
1731 #define SLAP_LDAPDN_MAXLEN 8192
1732
1733 LDAP_END_DECL
1734
1735 #include "proto-slap.h"
1736
1737 #endif /* _SLAP_H_ */