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