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-2003 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 "lber_pvt.h"
  36 #include "ldap_pvt_thread.h"
  37 #include "ldap_queue.h"
  38
  39 #define SLAP_EXTENDED_SCHEMA 1
  40 #define LDAP_CACHING 1
  41
  42 LDAP_BEGIN_DECL
  43 /*
  44  * SLAPD Memory allocation macros
  45  *
  46  * Unlike ch_*() routines, these routines do not assert() upon
  47  * allocation error.  They are intended to be used instead of
  48  * ch_*() routines where the caller has implemented proper
  49  * checking for and handling of allocation errors.
  50  *
  51  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  52  */
  53 #define SLAP_MALLOC(s)      ber_memalloc((s))
  54 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  55 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  56 #define SLAP_FREE(p)        ber_memfree((p))
  57 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  58 #define SLAP_STRDUP(s)      ber_strdup((s))
  59 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  60
  61 #ifdef f_next
  62 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  63 #endif
  64
  65 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  66 #define SLAPD_ANONYMOUS "cn=anonymous"
  67
  68 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  69  * This is a value used internally by the backends. It is needed to allow
  70  * adding values that already exist without getting an error as required by
  71  * modrdn when the new rdn was already an attribute value itself.
  72  */
  73 #define SLAP_MOD_SOFTADD        0x1000
  74
  75 #define MAXREMATCHES (100)
  76
  77 #define SLAP_MAX_WORKER_THREADS         (16)
  78
  79 #ifdef LDAP_SYNCREPL
  80 #define SLAP_MAX_SYNCREPL_THREADS       (8)
  81 #endif
  82
  83 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
  84 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
  85
  86 #define SLAP_CONN_MAX_PENDING_DEFAULT   100
  87 #define SLAP_CONN_MAX_PENDING_AUTH      1000
  88
  89 #define SLAP_TEXT_BUFLEN (256)
  90
  91 /* psuedo error code indicating abandoned operation */
  92 #define SLAPD_ABANDON (-1)
  93
  94 /* psuedo error code indicating disconnect */
  95 #define SLAPD_DISCONNECT (-2)
  96
  97
  98 /* We assume "C" locale, that is US-ASCII */
  99 #define ASCII_SPACE(c)  ( (c) == ' ' )
 100 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
 101 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
 102 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
 103 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
 104 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
 105 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
 106
 107 #define SLAP_NIBBLE(c) ((c)&0x0f)
 108 #define SLAP_ESCAPE_CHAR ('\\')
 109 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 110 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 111
 112 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 113         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 114
 115 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 116 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
 117 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 118 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 119 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 120
 121 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 122 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 123 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 124 #define OID_SEPARATOR(c)        ( (c) == '.' )
 125 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 126
 127 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 128 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
 129
 130 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
 131 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 132
 133 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 134
 135 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 136         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 137         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 138         (c) == '?' || (c) == ' ' || (c) == '=' )
 139 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 140
 141 /* must match in schema_init.c */
 142 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 143 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 144 #define SLAPD_INTEGER_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.27"
 145 #define SLAPD_GROUP_ATTR                "member"
 146 #define SLAPD_GROUP_CLASS               "groupOfNames"
 147 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 148 #define SLAPD_ROLE_CLASS                "organizationalRole"
 149
 150 #ifdef SLAPD_ACI_ENABLED
 151 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 152 #endif
 153
 154 /* change this to "OpenLDAPset" */
 155 #define SLAPD_ACI_SET_ATTR              "template"
 156
 157 #define SLAPD_TOP_OID                   "2.5.6.0"
 158
 159 LDAP_SLAPD_V (int) slap_debug;
 160
 161 typedef unsigned long slap_mask_t;
 162
 163 /* Security Strength Factor */
 164 typedef unsigned slap_ssf_t;
 165
 166 typedef struct slap_ssf_set {
 167         slap_ssf_t sss_ssf;
 168         slap_ssf_t sss_transport;
 169         slap_ssf_t sss_tls;
 170         slap_ssf_t sss_sasl;
 171         slap_ssf_t sss_update_ssf;
 172         slap_ssf_t sss_update_transport;
 173         slap_ssf_t sss_update_tls;
 174         slap_ssf_t sss_update_sasl;
 175         slap_ssf_t sss_simple_bind;
 176 } slap_ssf_set_t;
 177
 178 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
 179 #define SLAP_GETDN_AUTHCID 2
 180 #define SLAP_GETDN_AUTHZID 4
 181
 182 /*
 183  * Index types
 184  */
 185 #define SLAP_INDEX_TYPE           0x00FFUL
 186 #define SLAP_INDEX_UNDEFINED      0x0001UL
 187 #define SLAP_INDEX_PRESENT        0x0002UL
 188 #define SLAP_INDEX_EQUALITY       0x0004UL
 189 #define SLAP_INDEX_APPROX         0x0008UL
 190 #define SLAP_INDEX_SUBSTR         0x0010UL
 191 #define SLAP_INDEX_EXTENDED               0x0020UL
 192
 193 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 194
 195 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 196
 197 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 198
 199 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 200 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 201 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 202 #define SLAP_INDEX_SUBSTR_DEFAULT \
 203         ( SLAP_INDEX_SUBSTR \
 204         | SLAP_INDEX_SUBSTR_INITIAL \
 205         | SLAP_INDEX_SUBSTR_ANY \
 206         | SLAP_INDEX_SUBSTR_FINAL )
 207
 208 #define SLAP_INDEX_SUBSTR_MINLEN        2
 209 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 210 #define SLAP_INDEX_SUBSTR_STEP  2
 211
 212 #define SLAP_INDEX_FLAGS         0xF000UL
 213 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 214 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
 215
 216 /*
 217  * there is a single index for each attribute.  these prefixes ensure
 218  * that there is no collision among keys.
 219  */
 220 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 221 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 222 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 223 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 224 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 225 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 226
 227 #define SLAP_SYNTAX_MATCHINGRULES_OID    "1.3.6.1.4.1.1466.115.121.1.30"
 228 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID   "1.3.6.1.4.1.1466.115.121.1.3"
 229 #define SLAP_SYNTAX_OBJECTCLASSES_OID    "1.3.6.1.4.1.1466.115.121.1.37"
 230 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
 231 #define SLAP_SYNTAX_CONTENTRULE_OID              "1.3.6.1.4.1.1466.115.121.1.16"
 232
 233 /*
 234  * represents schema information for a database
 235  */
 236 #define SLAP_SCHERR_OUTOFMEM                    1
 237 #define SLAP_SCHERR_CLASS_NOT_FOUND             2
 238 #define SLAP_SCHERR_CLASS_BAD_USAGE             3
 239 #define SLAP_SCHERR_CLASS_BAD_SUP               4
 240 #define SLAP_SCHERR_CLASS_DUP                   5
 241 #define SLAP_SCHERR_ATTR_NOT_FOUND              6
 242 #define SLAP_SCHERR_ATTR_BAD_MR                 7
 243 #define SLAP_SCHERR_ATTR_BAD_USAGE              8
 244 #define SLAP_SCHERR_ATTR_BAD_SUP                9
 245 #define SLAP_SCHERR_ATTR_INCOMPLETE             10
 246 #define SLAP_SCHERR_ATTR_DUP                    11
 247 #define SLAP_SCHERR_MR_NOT_FOUND                12
 248 #define SLAP_SCHERR_MR_INCOMPLETE               13
 249 #define SLAP_SCHERR_MR_DUP                              14
 250 #define SLAP_SCHERR_SYN_NOT_FOUND               15
 251 #define SLAP_SCHERR_SYN_DUP                             16
 252 #define SLAP_SCHERR_NO_NAME                             17
 253 #define SLAP_SCHERR_NOT_SUPPORTED               18
 254 #define SLAP_SCHERR_BAD_DESCR                   19
 255 #define SLAP_SCHERR_OIDM                                20
 256 #define SLAP_SCHERR_CR_DUP                              21
 257 #define SLAP_SCHERR_CR_BAD_STRUCT               22
 258 #define SLAP_SCHERR_CR_BAD_AUX                  23
 259 #define SLAP_SCHERR_CR_BAD_AT                   24
 260 #define SLAP_SCHERR_LAST                                SLAP_SCHERR_CR_BAD_AT
 261
 262 typedef union slap_sockaddr {
 263         struct sockaddr sa_addr;
 264         struct sockaddr_in sa_in_addr;
 265 #ifdef LDAP_PF_INET6
 266         struct sockaddr_storage sa_storage;
 267         struct sockaddr_in6 sa_in6_addr;
 268 #endif
 269 #ifdef LDAP_PF_LOCAL
 270         struct sockaddr_un sa_un_addr;
 271 #endif
 272 } Sockaddr;
 273
 274 #ifdef LDAP_PF_INET6
 275 extern int slap_inet4or6;
 276 #endif
 277
 278 typedef struct slap_oid_macro {
 279         struct berval som_oid;
 280         char **som_names;
 281         LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
 282 } OidMacro;
 283
 284 /* forward declarations */
 285 struct slap_syntax;
 286 struct slap_matching_rule;
 287
 288 typedef int slap_syntax_validate_func LDAP_P((
 289         struct slap_syntax *syntax,
 290         struct berval * in));
 291
 292 typedef int slap_syntax_transform_func LDAP_P((
 293         struct slap_syntax *syntax,
 294         struct berval * in,
 295         struct berval * out,
 296         void *memctx));
 297
 298 typedef struct slap_syntax {
 299         LDAPSyntax                      ssyn_syn;
 300 #define ssyn_oid                ssyn_syn.syn_oid
 301 #define ssyn_desc               ssyn_syn.syn_desc
 302 #define ssyn_extensions ssyn_syn.syn_extensions
 303         /*
 304          * Note: the former
 305         ber_len_t       ssyn_oidlen;
 306          * has been replaced by a struct berval that uses the value
 307          * provided by ssyn_syn.syn_oid; a macro that expands to
 308          * the bv_len field of the berval is provided for backward
 309          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 310          */
 311         struct berval   ssyn_bvoid;
 312 #define ssyn_oidlen     ssyn_bvoid.bv_len
 313
 314         unsigned int ssyn_flags;
 315
 316 #define SLAP_SYNTAX_NONE        0x0000U
 317 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 318 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 319 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 320 #ifdef LDAP_DEVEL
 321 #define SLAP_SYNTAX_HIDE        0x0000U /* publish everything */
 322 #else
 323 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 324 #endif
 325
 326         slap_syntax_validate_func       *ssyn_validate;
 327         slap_syntax_transform_func      *ssyn_pretty;
 328
 329 #ifdef SLAPD_BINARY_CONVERSION
 330         /* convert to and from binary */
 331         slap_syntax_transform_func      *ssyn_ber2str;
 332         slap_syntax_transform_func      *ssyn_str2ber;
 333 #endif
 334
 335         LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
 336 } Syntax;
 337
 338 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 339 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 340 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 341 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 342 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 343
 344 typedef struct slap_syntax_defs_rec {
 345         char *sd_desc;
 346         int sd_flags;
 347         slap_syntax_validate_func *sd_validate;
 348         slap_syntax_transform_func *sd_pretty;
 349 #ifdef SLAPD_BINARY_CONVERSION
 350         slap_syntax_transform_func *sd_ber2str;
 351         slap_syntax_transform_func *sd_str2ber;
 352 #endif
 353 } slap_syntax_defs_rec;
 354
 355 /* X -> Y Converter */
 356 typedef int slap_mr_convert_func LDAP_P((
 357         struct berval * in,
 358         struct berval * out,
 359         void *memctx ));
 360
 361 /* Normalizer */
 362 typedef int slap_mr_normalize_func LDAP_P((
 363         slap_mask_t use,
 364         struct slap_syntax *syntax, /* NULL if in is asserted value */
 365         struct slap_matching_rule *mr,
 366         struct berval * in,
 367         struct berval * out,
 368         void *memctx ));
 369
 370 /* Match (compare) function */
 371 typedef int slap_mr_match_func LDAP_P((
 372         int *match,
 373         slap_mask_t use,
 374         struct slap_syntax *syntax,     /* syntax of stored value */
 375         struct slap_matching_rule *mr,
 376         struct berval * value,
 377         void * assertValue ));
 378
 379 /* Index generation function */
 380 typedef int slap_mr_indexer_func LDAP_P((
 381         slap_mask_t use,
 382         slap_mask_t mask,
 383         struct slap_syntax *syntax,     /* syntax of stored value */
 384         struct slap_matching_rule *mr,
 385         struct berval *prefix,
 386         BerVarray values,
 387         BerVarray *keys,
 388         void *memctx ));
 389
 390 /* Filter index function */
 391 typedef int slap_mr_filter_func LDAP_P((
 392         slap_mask_t use,
 393         slap_mask_t mask,
 394         struct slap_syntax *syntax,     /* syntax of stored value */
 395         struct slap_matching_rule *mr,
 396         struct berval *prefix,
 397         void * assertValue,
 398         BerVarray *keys,
 399         void *memctx ));
 400
 401 typedef struct slap_matching_rule_use MatchingRuleUse;
 402
 403 typedef struct slap_matching_rule {
 404         LDAPMatchingRule                smr_mrule;
 405         MatchingRuleUse                 *smr_mru;
 406         /* RFC2252 string representation */
 407         struct berval                   smr_str;
 408         /*
 409          * Note: the former
 410          *                      ber_len_t       smr_oidlen;
 411          * has been replaced by a struct berval that uses the value
 412          * provided by smr_mrule.mr_oid; a macro that expands to
 413          * the bv_len field of the berval is provided for backward
 414          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 415          */
 416         struct berval                   smr_bvoid;
 417 #define smr_oidlen                      smr_bvoid.bv_len
 418
 419         slap_mask_t                             smr_usage;
 420
 421 #ifdef LDAP_DEVEL
 422 #define SLAP_MR_HIDE                    0x0000U
 423 #else
 424 #define SLAP_MR_HIDE                    0x8000U
 425 #endif
 426
 427 #define SLAP_MR_TYPE_MASK               0x0F00U
 428 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 429 #define SLAP_MR_USAGE                   0x000FU
 430
 431 #define SLAP_MR_NONE                    0x0000U
 432 #define SLAP_MR_EQUALITY                0x0100U
 433 #define SLAP_MR_ORDERING                0x0200U
 434 #define SLAP_MR_SUBSTR                  0x0400U
 435 #define SLAP_MR_EXT                             0x0800U /* implicitly extensible */
 436
 437 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 438
 439 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 440 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 441 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 442
 443
 444 /*
 445  * The asserted value, depending on the particular usage,
 446  * is expected to conform to either the assertion syntax
 447  * or the attribute syntax.   In some cases, the syntax of
 448  * the value is known.  If so, these flags indicate which
 449  * syntax the value is expected to conform to.  If not,
 450  * neither of these flags is set (until the syntax of the
 451  * provided value is determined).  If the value is of the
 452  * attribute syntax, the flag is changed once a value of
 453  * the assertion syntax is derived from the provided value.
 454  */
 455 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX       0x0001U
 456 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX       0x0002U
 457
 458 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
 459         ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
 460 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
 461         ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
 462
 463 /* either or both the asserted value or attribute value
 464  * may be provided in normalized form
 465  */
 466 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH         0x0004U
 467 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH        0x0008U
 468
 469 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 470         (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
 471 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
 472         ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 473
 474 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
 475         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 476                 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
 477 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 478         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 479                 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 480
 481 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
 482         ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
 483 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
 484         ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
 485
 486         Syntax                                  *smr_syntax;
 487         slap_mr_convert_func    *smr_convert;
 488         slap_mr_normalize_func  *smr_normalize;
 489         slap_mr_match_func              *smr_match;
 490         slap_mr_indexer_func    *smr_indexer;
 491         slap_mr_filter_func             *smr_filter;
 492
 493         /*
 494          * null terminated array of syntaxes compatible with this syntax
 495          * note: when MS_EXT is set, this MUST NOT contain the assertion
 496          * syntax of the rule.  When MS_EXT is not set, it MAY.
 497          */
 498         Syntax                                  **smr_compat_syntaxes;
 499
 500         /*
 501          * For equality rules, refers to an associated approximate rule.
 502          * For non-equality rules, refers to an associated equality rule.
 503          */
 504         struct slap_matching_rule       *smr_associated;
 505
 506 #define SLAP_MR_ASSOCIATED(mr,amr)      (((mr) == (amr)) || \
 507         ((mr)->smr_associated == (amr)))
 508
 509         LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
 510
 511 #define smr_oid                         smr_mrule.mr_oid
 512 #define smr_names                       smr_mrule.mr_names
 513 #define smr_desc                        smr_mrule.mr_desc
 514 #define smr_obsolete            smr_mrule.mr_obsolete
 515 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 516 #define smr_extensions          smr_mrule.mr_extensions
 517 } MatchingRule;
 518
 519 struct slap_matching_rule_use {
 520         LDAPMatchingRuleUse             smru_mruleuse;
 521         MatchingRule                    *smru_mr;
 522         /* RFC2252 string representation */
 523         struct berval                   smru_str;
 524
 525         LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
 526
 527 #define smru_oid                        smru_mruleuse.mru_oid
 528 #define smru_names                      smru_mruleuse.mru_names
 529 #define smru_desc                       smru_mruleuse.mru_desc
 530 #define smru_obsolete                   smru_mruleuse.mru_obsolete
 531 #define smru_applies_oids               smru_mruleuse.mru_applies_oids
 532
 533 #define smru_usage                      smru_mr->smr_usage
 534 } /* MatchingRuleUse */ ;
 535
 536 typedef struct slap_mrule_defs_rec {
 537         char *                                          mrd_desc;
 538         slap_mask_t                                     mrd_usage;
 539         char **                                         mrd_compat_syntaxes;
 540         slap_mr_convert_func *          mrd_convert;
 541         slap_mr_normalize_func *        mrd_normalize;
 542         slap_mr_match_func *            mrd_match;
 543         slap_mr_indexer_func *          mrd_indexer;
 544         slap_mr_filter_func *           mrd_filter;
 545
 546         /* For equality rule, this may refer to an associated approximate rule */
 547         /* For non-equality rule, this may refer to an associated equality rule */
 548         char *                                          mrd_associated;
 549 } slap_mrule_defs_rec;
 550
 551 struct slap_backend_db;
 552 struct slap_entry;
 553 struct slap_attr;
 554
 555 typedef int (AttributeTypeSchemaCheckFN)(
 556         struct slap_backend_db *be,
 557         struct slap_entry *e,
 558         struct slap_attr *attr,
 559         const char** text,
 560         char *textbuf, size_t textlen );
 561
 562 typedef struct slap_attribute_type {
 563         LDAPAttributeType               sat_atype;
 564         struct berval                   sat_cname;
 565         struct slap_attribute_type      *sat_sup;
 566         struct slap_attribute_type      **sat_subtypes;
 567         MatchingRule                    *sat_equality;
 568         MatchingRule                    *sat_approx;
 569         MatchingRule                    *sat_ordering;
 570         MatchingRule                    *sat_substr;
 571         Syntax                                  *sat_syntax;
 572
 573         AttributeTypeSchemaCheckFN      *sat_check;
 574
 575 #define SLAP_AT_NONE            0x0000U
 576 #define SLAP_AT_ABSTRACT        0x0100U /* cannot be instantiated */
 577 #define SLAP_AT_FINAL           0x0200U /* cannot be subtyped */
 578 #ifdef LDAP_DEVEL
 579 #define SLAP_AT_HIDE            0x0000U /* publish everything */
 580 #else
 581 #define SLAP_AT_HIDE            0x8000U /* hide attribute */
 582 #endif
 583         slap_mask_t                                     sat_flags;
 584
 585         LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
 586
 587 #define sat_oid                         sat_atype.at_oid
 588 #define sat_names                       sat_atype.at_names
 589 #define sat_desc                        sat_atype.at_desc
 590 #define sat_obsolete            sat_atype.at_obsolete
 591 #define sat_sup_oid                     sat_atype.at_sup_oid
 592 #define sat_equality_oid        sat_atype.at_equality_oid
 593 #define sat_ordering_oid        sat_atype.at_ordering_oid
 594 #define sat_substr_oid          sat_atype.at_substr_oid
 595 #define sat_syntax_oid          sat_atype.at_syntax_oid
 596 #define sat_single_value        sat_atype.at_single_value
 597 #define sat_collective          sat_atype.at_collective
 598 #define sat_no_user_mod         sat_atype.at_no_user_mod
 599 #define sat_usage                       sat_atype.at_usage
 600 #define sat_extensions          sat_atype.at_extensions
 601
 602         struct slap_attr_desc           *sat_ad;
 603         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 604 } AttributeType;
 605
 606 #define is_at_operational(at)   ((at)->sat_usage)
 607 #define is_at_single_value(at)  ((at)->sat_single_value)
 608 #define is_at_collective(at)    ((at)->sat_collective)
 609 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 610 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 611
 612 struct slap_object_class;
 613
 614 typedef int (ObjectClassSchemaCheckFN)(
 615         struct slap_backend_db *be,
 616         struct slap_entry *e,
 617         struct slap_object_class *oc,
 618         const char** text,
 619         char *textbuf, size_t textlen );
 620
 621 typedef struct slap_object_class {
 622         LDAPObjectClass                 soc_oclass;
 623         struct berval                   soc_cname;
 624         struct slap_object_class        **soc_sups;
 625         AttributeType                           **soc_required;
 626         AttributeType                           **soc_allowed;
 627         ObjectClassSchemaCheckFN        *soc_check;
 628         slap_mask_t                                     soc_flags;
 629 #define soc_oid                         soc_oclass.oc_oid
 630 #define soc_names                       soc_oclass.oc_names
 631 #define soc_desc                        soc_oclass.oc_desc
 632 #define soc_obsolete            soc_oclass.oc_obsolete
 633 #define soc_sup_oids            soc_oclass.oc_sup_oids
 634 #define soc_kind                        soc_oclass.oc_kind
 635 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 636 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 637 #define soc_extensions          soc_oclass.oc_extensions
 638
 639         LDAP_SLIST_ENTRY(slap_object_class) soc_next;
 640 } ObjectClass;
 641
 642 #define SLAP_OC_ALIAS           0x0001
 643 #define SLAP_OC_REFERRAL        0x0002
 644 #define SLAP_OC_SUBENTRY        0x0004
 645 #define SLAP_OC_DYNAMICOBJECT   0x0008
 646 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 647 #ifdef LDAP_SYNCREPL
 648 #define SLAP_OC_GLUE            0x0020
 649 #define SLAP_OC__MASK           0x003F
 650 #define SLAP_OC__END            0x0040
 651 #else
 652 #define SLAP_OC__MASK           0x001F
 653 #define SLAP_OC__END            0x0020
 654 #endif
 655 #define SLAP_OC_OPERATIONAL     0x4000
 656 #ifdef LDAP_DEVEL
 657 #define SLAP_OC_HIDE            0x0000
 658 #else
 659 #define SLAP_OC_HIDE            0x8000
 660 #endif
 661
 662 /*
 663  * DIT content rule
 664  */
 665 typedef struct slap_content_rule {
 666         LDAPContentRule         scr_crule;
 667         ObjectClass                     *scr_sclass;
 668         ObjectClass                     **scr_auxiliaries;      /* optional */
 669         AttributeType           **scr_required;         /* optional */
 670         AttributeType           **scr_allowed;          /* optional */
 671         AttributeType           **scr_precluded;        /* optional */
 672 #define scr_oid                         scr_crule.cr_oid
 673 #define scr_names                       scr_crule.cr_names
 674 #define scr_desc                        scr_crule.cr_desc
 675 #define scr_obsolete            scr_crule.cr_obsolete
 676 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
 677 #define scr_at_oids_must        scr_crule.cr_at_oids_must
 678 #define scr_at_oids_may         scr_crule.cr_at_oids_may
 679 #define scr_at_oids_not         scr_crule.cr_at_oids_not
 680
 681         LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
 682 } ContentRule;
 683
 684 /* Represents a recognized attribute description ( type + options ). */
 685 typedef struct slap_attr_desc {
 686         struct slap_attr_desc *ad_next;
 687         AttributeType *ad_type;         /* attribute type, must be specified */
 688         struct berval ad_cname;         /* canonical name, must be specified */
 689         struct berval ad_tags;          /* empty if no tagging options */
 690         unsigned ad_flags;
 691 #define SLAP_DESC_NONE                  0x00U
 692 #define SLAP_DESC_BINARY                0x01U
 693 #define SLAP_DESC_TAG_RANGE             0x80U
 694 } AttributeDescription;
 695
 696 typedef struct slap_attr_name {
 697         struct berval an_name;
 698         AttributeDescription *an_desc;
 699         ObjectClass *an_oc;
 700 } AttributeName;
 701
 702 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
 703 #define slap_ad_is_tag_range(ad)        \
 704         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
 705 #define slap_ad_is_binary(ad)           \
 706         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 707
 708 /*
 709  * pointers to schema elements used internally
 710  */
 711 struct slap_internal_schema {
 712         /* objectClass */
 713         ObjectClass *si_oc_top;
 714         ObjectClass *si_oc_extensibleObject;
 715         ObjectClass *si_oc_alias;
 716         ObjectClass *si_oc_referral;
 717         ObjectClass *si_oc_rootdse;
 718         ObjectClass *si_oc_subentry;
 719         ObjectClass *si_oc_subschema;
 720         ObjectClass *si_oc_collectiveAttributeSubentry;
 721         ObjectClass *si_oc_dynamicObject;
 722
 723 #ifdef LDAP_SYNCREPL
 724         ObjectClass *si_oc_glue;
 725         ObjectClass *si_oc_syncConsumerSubentry;
 726         ObjectClass *si_oc_syncProviderSubentry;
 727 #endif
 728
 729         /* objectClass attribute descriptions */
 730         AttributeDescription *si_ad_objectClass;
 731
 732         /* operational attribute descriptions */
 733         AttributeDescription *si_ad_structuralObjectClass;
 734         AttributeDescription *si_ad_creatorsName;
 735         AttributeDescription *si_ad_createTimestamp;
 736         AttributeDescription *si_ad_modifiersName;
 737         AttributeDescription *si_ad_modifyTimestamp;
 738         AttributeDescription *si_ad_hasSubordinates;
 739         AttributeDescription *si_ad_subschemaSubentry;
 740         AttributeDescription *si_ad_collectiveSubentries;
 741         AttributeDescription *si_ad_collectiveExclusions;
 742         AttributeDescription *si_ad_entryUUID;
 743         AttributeDescription *si_ad_entryCSN;
 744         AttributeDescription *si_ad_namingCSN;
 745         AttributeDescription *si_ad_superiorUUID;
 746
 747 #ifdef LDAP_CACHING
 748         /* LDAP cache specific operational attribute */
 749         AttributeDescription *si_ad_queryid;
 750 #endif /* LDAP_CACHING */
 751
 752 #ifdef LDAP_SYNCREPL
 753         AttributeDescription *si_ad_dseType;
 754         AttributeDescription *si_ad_syncreplCookie;
 755         AttributeDescription *si_ad_contextCSN;
 756 #endif
 757
 758         /* root DSE attribute descriptions */
 759         AttributeDescription *si_ad_altServer;
 760         AttributeDescription *si_ad_namingContexts;
 761         AttributeDescription *si_ad_supportedControl;
 762         AttributeDescription *si_ad_supportedExtension;
 763         AttributeDescription *si_ad_supportedLDAPVersion;
 764         AttributeDescription *si_ad_supportedSASLMechanisms;
 765         AttributeDescription *si_ad_supportedFeatures;
 766         AttributeDescription *si_ad_monitorContext;
 767         AttributeDescription *si_ad_vendorName;
 768         AttributeDescription *si_ad_vendorVersion;
 769
 770         /* subentry attribute descriptions */
 771         AttributeDescription *si_ad_administrativeRole;
 772         AttributeDescription *si_ad_subtreeSpecification;
 773
 774         /* subschema subentry attribute descriptions */
 775         AttributeDescription *si_ad_ditStructureRules;
 776         AttributeDescription *si_ad_ditContentRules;
 777         AttributeDescription *si_ad_nameForms;
 778         AttributeDescription *si_ad_objectClasses;
 779         AttributeDescription *si_ad_attributeTypes;
 780         AttributeDescription *si_ad_ldapSyntaxes;
 781         AttributeDescription *si_ad_matchingRules;
 782         AttributeDescription *si_ad_matchingRuleUse;
 783
 784         /* Aliases & Referrals */
 785         AttributeDescription *si_ad_aliasedObjectName;
 786         AttributeDescription *si_ad_ref;
 787
 788         /* Access Control Internals */
 789         AttributeDescription *si_ad_entry;
 790         AttributeDescription *si_ad_children;
 791         AttributeDescription *si_ad_saslAuthzTo;
 792         AttributeDescription *si_ad_saslAuthzFrom;
 793 #ifdef SLAPD_ACI_ENABLED
 794         AttributeDescription *si_ad_aci;
 795 #endif
 796
 797         /* dynamic entries */
 798         AttributeDescription *si_ad_entryTtl;
 799         AttributeDescription *si_ad_dynamicSubtrees;
 800
 801         /* Other attributes descriptions */
 802         AttributeDescription *si_ad_distinguishedName;
 803         AttributeDescription *si_ad_name;
 804         AttributeDescription *si_ad_cn;
 805         AttributeDescription *si_ad_userPassword;
 806 #ifdef SLAPD_AUTHPASSWD
 807         AttributeDescription *si_ad_authPassword;
 808 #endif
 809 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 810         AttributeDescription *si_ad_krbName;
 811 #endif
 812
 813         /* Undefined Attribute Type */
 814         AttributeType   *si_at_undefined;
 815
 816         /* Matching Rules */
 817         MatchingRule    *si_mr_distinguishedNameMatch;
 818         MatchingRule    *si_mr_caseExactMatch;
 819         MatchingRule    *si_mr_caseExactSubstringsMatch;
 820         MatchingRule    *si_mr_caseExactIA5Match;
 821         MatchingRule    *si_mr_integerMatch;
 822         MatchingRule    *si_mr_integerFirstComponentMatch;
 823         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 824
 825         /* Syntaxes */
 826         Syntax          *si_syn_directoryString;
 827         Syntax          *si_syn_distinguishedName;
 828         Syntax          *si_syn_integer;
 829         Syntax          *si_syn_octetString;
 830 };
 831
 832 typedef struct slap_attr_assertion {
 833         AttributeDescription    *aa_desc;
 834         struct berval aa_value;
 835 } AttributeAssertion;
 836
 837 typedef struct slap_ss_assertion {
 838         AttributeDescription    *sa_desc;
 839         struct berval           sa_initial;
 840         struct berval           *sa_any;
 841         struct berval           sa_final;
 842 } SubstringsAssertion;
 843
 844 typedef struct slap_mr_assertion {
 845         MatchingRule            *ma_rule;       /* optional */
 846         struct berval           ma_rule_text;  /* optional */
 847         AttributeDescription    *ma_desc;       /* optional */
 848         int                                             ma_dnattrs; /* boolean */
 849         struct berval           ma_value;       /* required */
 850 } MatchingRuleAssertion;
 851
 852 /*
 853  * represents a search filter
 854  */
 855 typedef struct slap_filter {
 856         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 857 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 858 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 859 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 860
 861         union f_un_u {
 862                 /* precomputed result */
 863                 ber_int_t f_un_result;
 864
 865                 /* DN */
 866                 struct berval *f_un_dn;
 867
 868                 /* present */
 869                 AttributeDescription *f_un_desc;
 870
 871                 /* simple value assertion */
 872                 AttributeAssertion *f_un_ava;
 873
 874                 /* substring assertion */
 875                 SubstringsAssertion *f_un_ssa;
 876
 877                 /* matching rule assertion */
 878                 MatchingRuleAssertion *f_un_mra;
 879
 880 #define f_dn                    f_un.f_un_dn
 881 #define f_desc                  f_un.f_un_desc
 882 #define f_ava                   f_un.f_un_ava
 883 #define f_av_desc               f_un.f_un_ava->aa_desc
 884 #define f_av_value              f_un.f_un_ava->aa_value
 885 #define f_sub                   f_un.f_un_ssa
 886 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 887 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 888 #define f_sub_any               f_un.f_un_ssa->sa_any
 889 #define f_sub_final             f_un.f_un_ssa->sa_final
 890 #define f_mra                   f_un.f_un_mra
 891 #define f_mr_rule               f_un.f_un_mra->ma_rule
 892 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 893 #define f_mr_desc               f_un.f_un_mra->ma_desc
 894 #define f_mr_value              f_un.f_un_mra->ma_value
 895 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 896
 897                 /* and, or, not */
 898                 struct slap_filter *f_un_complex;
 899         } f_un;
 900
 901 #define f_result        f_un.f_un_result
 902 #define f_and           f_un.f_un_complex
 903 #define f_or            f_un.f_un_complex
 904 #define f_not           f_un.f_un_complex
 905 #define f_list          f_un.f_un_complex
 906
 907         struct slap_filter      *f_next;
 908 } Filter;
 909
 910 /* compare routines can return undefined */
 911 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 912
 913 typedef struct slap_valuesreturnfilter {
 914         ber_tag_t       vrf_choice;
 915
 916         union vrf_un_u {
 917                 /* precomputed result */
 918                 ber_int_t vrf_un_result;
 919
 920                 /* DN */
 921                 char *vrf_un_dn;
 922
 923                 /* present */
 924                 AttributeDescription *vrf_un_desc;
 925
 926                 /* simple value assertion */
 927                 AttributeAssertion *vrf_un_ava;
 928
 929                 /* substring assertion */
 930                 SubstringsAssertion *vrf_un_ssa;
 931
 932                 /* matching rule assertion */
 933                 MatchingRuleAssertion *vrf_un_mra;
 934
 935 #define vrf_result              vrf_un.vrf_un_result
 936 #define vrf_dn                  vrf_un.vrf_un_dn
 937 #define vrf_desc                vrf_un.vrf_un_desc
 938 #define vrf_ava                 vrf_un.vrf_un_ava
 939 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
 940 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
 941 #define vrf_ssa                 vrf_un.vrf_un_ssa
 942 #define vrf_sub                 vrf_un.vrf_un_ssa
 943 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
 944 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
 945 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
 946 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
 947 #define vrf_mra                 vrf_un.vrf_un_mra
 948 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
 949 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
 950 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
 951 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
 952 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
 953
 954
 955         } vrf_un;
 956
 957         struct slap_valuesreturnfilter  *vrf_next;
 958 } ValuesReturnFilter;
 959
 960 /*
 961  * represents an attribute (description + values)
 962  */
 963 typedef struct slap_attr {
 964         AttributeDescription *a_desc;
 965         BerVarray       a_vals;         /* preserved values */
 966         BerVarray       a_nvals;        /* normalized values */
 967         struct slap_attr *a_next;
 968         unsigned a_flags;
 969 #define SLAP_ATTR_IXADD         0x1U
 970 #define SLAP_ATTR_IXDEL         0x2U
 971 } Attribute;
 972
 973
 974 /*
 975  * the id used in the indexes to refer to an entry
 976  */
 977 typedef unsigned long   ID;
 978 #define NOID    ((ID)~0)
 979
 980 /*
 981  * represents an entry in core
 982  */
 983 typedef struct slap_entry {
 984         /*
 985          * The ID field should only be changed before entry is
 986          * inserted into a cache.  The ID value is backend
 987          * specific.
 988          */
 989         ID              e_id;
 990
 991         struct berval e_name;   /* name (DN) of this entry */
 992         struct berval e_nname;  /* normalized name (DN) of this entry */
 993
 994         /* for migration purposes */
 995 #define e_dn e_name.bv_val
 996 #define e_ndn e_nname.bv_val
 997
 998         Attribute       *e_attrs;       /* list of attributes + values */
 999
1000         slap_mask_t     e_ocflags;
1001
1002         struct berval   e_bv;           /* For entry_encode/entry_decode */
1003
1004         /* for use by the backend for any purpose */
1005         void*   e_private;
1006 } Entry;
1007
1008 /*
1009  * A list of LDAPMods
1010  */
1011 typedef struct slap_mod {
1012         int sm_op;
1013         AttributeDescription *sm_desc;
1014         struct berval sm_type;
1015         BerVarray sm_values;
1016 #define sm_bvalues sm_values
1017         BerVarray sm_nvalues;
1018 } Modification;
1019
1020 typedef struct slap_mod_list {
1021         Modification sml_mod;
1022 #define sml_op          sml_mod.sm_op
1023 #define sml_desc        sml_mod.sm_desc
1024 #define sml_type        sml_mod.sm_type
1025 #define sml_bvalues     sml_mod.sm_values
1026 #define sml_values      sml_mod.sm_values
1027 #define sml_nvalues     sml_mod.sm_nvalues
1028         struct slap_mod_list *sml_next;
1029 } Modifications;
1030
1031 typedef struct slap_ldap_modlist {
1032         LDAPMod ml_mod;
1033         struct slap_ldap_modlist *ml_next;
1034 #define ml_op           ml_mod.mod_op
1035 #define ml_type         ml_mod.mod_type
1036 #define ml_values       ml_mod.mod_values
1037 #define ml_bvalues      ml_mod.mod_values
1038 } LDAPModList;
1039
1040 /*
1041  * represents an access control list
1042  */
1043 typedef enum slap_access_e {
1044         ACL_INVALID_ACCESS = -1,
1045         ACL_NONE = 0,
1046         ACL_AUTH,
1047         ACL_COMPARE,
1048         ACL_SEARCH,
1049         ACL_READ,
1050         ACL_WRITE
1051 } slap_access_t;
1052
1053 typedef enum slap_control_e {
1054         ACL_INVALID_CONTROL     = 0,
1055         ACL_STOP,
1056         ACL_CONTINUE,
1057         ACL_BREAK
1058 } slap_control_t;
1059
1060 typedef enum slap_style_e {
1061         ACL_STYLE_REGEX = 0,
1062         ACL_STYLE_BASE,
1063         ACL_STYLE_ONE,
1064         ACL_STYLE_SUBTREE,
1065         ACL_STYLE_CHILDREN,
1066         ACL_STYLE_ATTROF
1067 } slap_style_t;
1068
1069 typedef struct slap_authz_info {
1070         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
1071         struct berval   sai_mech;               /* SASL Mechanism */
1072         struct berval   sai_dn;                 /* DN for reporting purposes */
1073         struct berval   sai_ndn;                /* Normalized DN */
1074
1075         /* Security Strength Factors */
1076         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1077         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1078         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1079         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1080 } AuthorizationInformation;
1081
1082 /* the "by" part */
1083 typedef struct slap_access {
1084         slap_control_t a_type;
1085
1086 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1087
1088 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1089 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1090 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1091 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1092 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1093 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
1094
1095 #define ACL_PRIV_MASK                   0x00ffUL
1096
1097 /* priv flags */
1098 #define ACL_PRIV_LEVEL                  0x1000UL
1099 #define ACL_PRIV_ADDITIVE               0x2000UL
1100 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
1101
1102 /* invalid privs */
1103 #define ACL_PRIV_INVALID                0x0UL
1104
1105 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1106 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
1107 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1108 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1109
1110 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1111 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1112
1113 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1114
1115 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1116
1117 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1118 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1119 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1120
1121 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1122 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
1123 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1124 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1125 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1126 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1127
1128 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1129 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1130 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1131 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
1132 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
1133 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1134 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1135
1136 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1137 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1138 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1139 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1140 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1141 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1142
1143         slap_mask_t     a_access_mask;
1144
1145         AuthorizationInformation        a_authz;
1146 #define a_dn_pat        a_authz.sai_dn
1147
1148         slap_style_t a_dn_style;
1149         AttributeDescription    *a_dn_at;
1150         int                     a_dn_self;
1151         int                     a_dn_expand;
1152
1153         slap_style_t a_peername_style;
1154         struct berval   a_peername_pat;
1155         slap_style_t a_sockname_style;
1156         struct berval   a_sockname_pat;
1157
1158         slap_style_t a_domain_style;
1159         struct berval   a_domain_pat;
1160         int             a_domain_expand;
1161
1162         slap_style_t a_sockurl_style;
1163         struct berval   a_sockurl_pat;
1164         slap_style_t a_set_style;
1165         struct berval   a_set_pat;
1166
1167 #ifdef SLAPD_ACI_ENABLED
1168         AttributeDescription    *a_aci_at;
1169 #endif
1170
1171         /* ACL Groups */
1172         slap_style_t a_group_style;
1173         struct berval   a_group_pat;
1174         ObjectClass                             *a_group_oc;
1175         AttributeDescription    *a_group_at;
1176
1177         struct slap_access      *a_next;
1178 } Access;
1179
1180 /* the "to" part */
1181 typedef struct slap_acl {
1182         /* "to" part: the entries this acl applies to */
1183         Filter          *acl_filter;
1184         slap_style_t acl_dn_style;
1185         regex_t         acl_dn_re;
1186         struct berval   acl_dn_pat;
1187         AttributeName   *acl_attrs;
1188
1189         /* "by" part: list of who has what access to the entries */
1190         Access  *acl_access;
1191
1192         struct slap_acl *acl_next;
1193 } AccessControl;
1194
1195 typedef struct slap_acl_state {
1196         unsigned as_recorded;
1197 #define ACL_STATE_NOT_RECORDED                  0x0
1198 #define ACL_STATE_RECORDED_VD                   0x1
1199 #define ACL_STATE_RECORDED_NV                   0x2
1200 #define ACL_STATE_RECORDED                              0x3
1201
1202         /* Access state */
1203         AccessControl *as_vd_acl;
1204         AccessControl *as_vi_acl;
1205         slap_mask_t as_vd_acl_mask;
1206         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1207         int as_vd_acl_count;
1208
1209         Access *as_vd_access;
1210         int as_vd_access_count;
1211
1212         int as_result;
1213         AttributeDescription *as_vd_ad;
1214 } AccessControlState;
1215 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1216         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1217
1218 /*
1219  * Backend-info
1220  * represents a backend
1221  */
1222
1223 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1224 typedef struct slap_backend_db BackendDB;               /* per backend database */
1225
1226 LDAP_SLAPD_V (int) nBackendInfo;
1227 LDAP_SLAPD_V (int) nBackendDB;
1228 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1229 LDAP_SLAPD_V (BackendDB *) backendDB;
1230
1231 LDAP_SLAPD_V (int) slapMode;
1232 #define SLAP_UNDEFINED_MODE     0x0000
1233 #define SLAP_SERVER_MODE        0x0001
1234 #define SLAP_TOOL_MODE          0x0002
1235 #define SLAP_MODE                       0x0003
1236
1237 #define SLAP_TRUNCATE_MODE      0x0100
1238 #define SLAP_TOOL_READMAIN      0x0200
1239 #define SLAP_TOOL_READONLY      0x0400
1240
1241 struct slap_replica_info {
1242         char *ri_host;                          /* supersedes be_replica */
1243         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1244         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1245         int ri_exclude;                 /* 1 => exclude ri_attrs */
1246 };
1247
1248 struct slap_limits_set {
1249         /* time limits */
1250         int     lms_t_soft;
1251         int     lms_t_hard;
1252
1253         /* size limits */
1254         int     lms_s_soft;
1255         int     lms_s_hard;
1256         int     lms_s_unchecked;
1257         int     lms_s_pr;
1258         int     lms_s_pr_hide;
1259 };
1260
1261 struct slap_limits {
1262         int     lm_type;        /* type of pattern */
1263 #define SLAP_LIMITS_UNDEFINED   0x0000
1264 #define SLAP_LIMITS_EXACT       0x0001
1265 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1266 #define SLAP_LIMITS_ONE         0x0002
1267 #define SLAP_LIMITS_SUBTREE     0x0003
1268 #define SLAP_LIMITS_CHILDREN    0x0004
1269 #define SLAP_LIMITS_REGEX       0x0005
1270 #define SLAP_LIMITS_ANONYMOUS   0x0006
1271 #define SLAP_LIMITS_USERS       0x0007
1272 #define SLAP_LIMITS_ANY         0x0008
1273         regex_t lm_dn_regex;            /* regex data for REGEX */
1274
1275         /*
1276          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1277          * pattern for REGEX; NULL for ANONYMOUS, USERS
1278          */
1279         struct berval lm_dn_pat;
1280
1281         struct slap_limits_set  lm_limits;
1282 };
1283
1284 /* temporary aliases */
1285 typedef BackendDB Backend;
1286 #define nbackends nBackendDB
1287 #define backends backendDB
1288
1289 #ifdef LDAP_SYNCREPL
1290 struct nonpresent_entry {
1291         struct berval *dn;
1292         struct berval *ndn;
1293         LDAP_LIST_ENTRY(nonpresent_entry) np_link;
1294 };
1295
1296  /*
1297   * syncinfo structure for syncrepl
1298   */
1299 typedef struct syncinfo_s {
1300         struct slap_conn *conn;
1301         struct slap_backend_db *be;
1302         struct slap_entry *e;
1303         void                    *ctx;
1304         int                             id;
1305         char                    *provideruri;
1306         BerVarray               provideruri_bv;
1307 #define TLS_OFF                 0
1308 #define TLS_ON                  1
1309 #define TLS_CRITICAL    2
1310         int                             tls;
1311                 struct berval   updatedn;
1312         int                             bindmethod;
1313         char                    *binddn;
1314         char                    *passwd;
1315         char                    *saslmech;
1316         char                    *secprops;
1317         char                    *realm;
1318         char                    *authcId;
1319         char                    *authzId;
1320         char                    *srvtab;
1321 #define LASTMOD_REQ             0
1322 #define LASTMOD_GEN             1
1323 #define LASTMOD_NO              2
1324         int                             lastmod;
1325         Filter                  *filter;
1326         char                    *filterstr;
1327         char                    *base;
1328         int                             scope;
1329         int                             attrsonly;
1330                 int                             attrsexclude;
1331         char                    **attrs;
1332         int                             type;
1333         time_t                  interval;
1334         struct berval   *syncCookie;
1335         int                             manageDSAit;
1336         int                             slimit;
1337                 int                             tlimit;
1338         struct berval   *syncUUID;
1339                 struct berval   *syncUUID_ndn;
1340         Avlnode                 *presentlist;
1341                 int                             sync_mode;
1342                 LDAP_LIST_HEAD(np, nonpresent_entry) nonpresentlist;
1343 } syncinfo_t;
1344
1345 #endif /* LDAP_SYNCREPL */
1346
1347 struct slap_backend_db {
1348         BackendInfo     *bd_info;       /* pointer to shared backend info */
1349
1350         /* BackendInfo accessors */
1351 #define         be_config       bd_info->bi_db_config
1352 #define         be_type         bd_info->bi_type
1353
1354 #define         be_bind         bd_info->bi_op_bind
1355 #define         be_unbind       bd_info->bi_op_unbind
1356 #define         be_add          bd_info->bi_op_add
1357 #define         be_compare      bd_info->bi_op_compare
1358 #define         be_delete       bd_info->bi_op_delete
1359 #define         be_modify       bd_info->bi_op_modify
1360 #define         be_modrdn       bd_info->bi_op_modrdn
1361 #define         be_search       bd_info->bi_op_search
1362 #define         be_abandon      bd_info->bi_op_abandon
1363 #define         be_cancel       bd_info->bi_op_cancel
1364
1365 #define         be_extended     bd_info->bi_extended
1366
1367 #define         be_fetch        bd_info->bi_entry_get_rw
1368 #define         be_release      bd_info->bi_entry_release_rw
1369 #define         be_chk_referrals        bd_info->bi_chk_referrals
1370 #define         be_group        bd_info->bi_acl_group
1371 #define         be_attribute    bd_info->bi_acl_attribute
1372 #define         be_operational  bd_info->bi_operational
1373
1374 /*
1375  * define to honor hasSubordinates operational attribute in search filters
1376  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1377  * is fixed).
1378  */
1379 #define         be_has_subordinates bd_info->bi_has_subordinates
1380
1381 #define         be_controls     bd_info->bi_controls
1382
1383 #define         be_connection_init      bd_info->bi_connection_init
1384 #define         be_connection_destroy   bd_info->bi_connection_destroy
1385
1386 #ifdef SLAPD_TOOLS
1387 #define         be_entry_open bd_info->bi_tool_entry_open
1388 #define         be_entry_close bd_info->bi_tool_entry_close
1389 #define         be_entry_first bd_info->bi_tool_entry_first
1390 #define         be_entry_next bd_info->bi_tool_entry_next
1391 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1392 #define         be_entry_get bd_info->bi_tool_entry_get
1393 #define         be_entry_put bd_info->bi_tool_entry_put
1394 #define         be_sync bd_info->bi_tool_sync
1395 #endif
1396
1397 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1398 #define SLAP_BFLAG_NO_SCHEMA_CHECK      0x0002U
1399 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1400 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1401 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1402 #define SLAP_BFLAG_MONITOR                      0x0080U /* a monitor backend */
1403 #define SLAP_BFLAG_INCREMENT            0x0100U
1404 #define SLAP_BFLAG_ALIASES                      0x1000U
1405 #define SLAP_BFLAG_REFERRALS            0x2000U
1406 #define SLAP_BFLAG_SUBENTRIES           0x4000U
1407 #define SLAP_BFLAG_DYNAMIC                      0x8000U
1408         slap_mask_t     be_flags;
1409 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1410 #define SLAP_NO_SCHEMA_CHECK    (!((be)->be_flags & SLAP_BFLAG_NO_SCHEMA_CHECK))
1411 #define SLAP_GLUE_INSTANCE(be)  ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1412 #define SLAP_GLUE_SUBORDINATE(be) \
1413         ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1414 #define SLAP_GLUE_LINKED(be)    ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1415
1416 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1417 #define SLAP_INCREMENT(be)      ((be)->be_flags & SLAP_BFLAG_INCREMENT)
1418
1419 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1420 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1421 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1422 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1423
1424
1425         slap_mask_t     be_restrictops;         /* restriction operations */
1426 #define SLAP_RESTRICT_OP_ADD            0x0001U
1427 #define SLAP_RESTRICT_OP_BIND           0x0002U
1428 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1429 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1430 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1431 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1432 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1433 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1434
1435 #define SLAP_RESTRICT_OP_READS  \
1436         ( SLAP_RESTRICT_OP_COMPARE      \
1437         | SLAP_RESTRICT_OP_SEARCH )
1438 #define SLAP_RESTRICT_OP_WRITES \
1439         ( SLAP_RESTRICT_OP_ADD    \
1440         | SLAP_RESTRICT_OP_DELETE \
1441         | SLAP_RESTRICT_OP_MODIFY \
1442         | SLAP_RESTRICT_OP_RENAME )
1443
1444 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1445 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1446 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1447
1448 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1449
1450 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1451 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1452 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1453                                                                         0x0004U /* unprotected simple auth */
1454 #define SLAP_DISALLOW_BIND_KRBV4        0x0008U /* Kerberos V4 authentication */
1455
1456 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1457 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1458
1459 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1460
1461         slap_mask_t     be_requires;    /* pre-operation requirements */
1462 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1463 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1464 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1465 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1466 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1467
1468         /* Required Security Strength Factor */
1469         slap_ssf_set_t be_ssf_set;
1470
1471         /* these should be renamed from be_ to bd_ */
1472         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1473         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1474         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1475         struct berval be_schemandn;     /* normalized subschema DN */
1476         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1477         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1478         struct berval be_rootpw;        /* the magic "root" password for this db        */
1479         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1480 #define be_sizelimit    be_def_limit.lms_s_soft
1481 #define be_timelimit    be_def_limit.lms_t_soft
1482         struct slap_limits_set be_def_limit; /* default limits */
1483         struct slap_limits **be_limits; /* regex-based size and time limits */
1484         AccessControl *be_acl;  /* access control list for this backend    */
1485         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1486         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1487         char    *be_replogfile; /* replication log file (in master)        */
1488         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1489         BerVarray       be_update_refs; /* where to refer modifying clients to */
1490         char    *be_realm;
1491         void    *be_private;    /* anything the backend database needs     */
1492
1493         void    *be_pb;         /* Netscape plugin */
1494 #ifdef LDAP_SYNC
1495         LDAP_TAILQ_HEAD( pcl, slap_csn_entry )  be_pending_csn_list;
1496         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1497         struct berval                                                   be_context_csn;
1498         ldap_pvt_thread_mutex_t                                 be_context_csn_mutex;
1499 #endif
1500 #ifdef LDAP_SYNCREPL
1501         syncinfo_t      *syncinfo;      /* For syncrepl */
1502 #endif
1503 };
1504
1505 struct slap_conn;
1506 struct slap_op;
1507
1508 /* Backend function typedefs */
1509 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1510 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1511         const char *fname, int lineno,
1512         int argc, char **argv));
1513 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1514 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1515 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1516
1517 typedef int (BI_db_init) LDAP_P((Backend *bd));
1518 typedef int (BI_db_config) LDAP_P((Backend *bd,
1519         const char *fname, int lineno,
1520         int argc, char **argv));
1521 typedef int (BI_db_open) LDAP_P((Backend *bd));
1522 typedef int (BI_db_close) LDAP_P((Backend *bd));
1523 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1524
1525 typedef struct req_bind_s {
1526         int rb_method;
1527         struct berval rb_cred;
1528         struct berval rb_edn;
1529         slap_ssf_t rb_ssf;
1530 } req_bind_s;
1531
1532 typedef struct req_search_s {
1533         int rs_scope;
1534         int rs_deref;
1535         int rs_slimit;
1536         int rs_tlimit;
1537         int rs_attrsonly;
1538         AttributeName *rs_attrs;
1539         Filter *rs_filter;
1540         struct berval rs_filterstr;
1541 } req_search_s;
1542
1543 typedef struct req_compare_s {
1544         AttributeAssertion *rs_ava;
1545 } req_compare_s;
1546
1547 typedef struct req_modify_s {
1548         Modifications *rs_modlist;
1549 } req_modify_s;
1550
1551 typedef struct req_modrdn_s {
1552         struct berval rs_newrdn;
1553         struct berval rs_nnewrdn;
1554         struct berval *rs_newSup;
1555         struct berval *rs_nnewSup;
1556         int rs_deleteoldrdn;
1557 } req_modrdn_s;
1558
1559 typedef struct req_add_s {
1560         Entry *rs_e;
1561 } req_add_s;
1562
1563 typedef struct req_abandon_s {
1564         ber_int_t rs_msgid;
1565 } req_abandon_s;
1566
1567 typedef struct req_extended_s {
1568         struct berval rs_reqoid;
1569         struct berval *rs_reqdata;
1570 } req_extended_s;
1571
1572 typedef enum slap_reply_e {
1573         REP_RESULT,
1574         REP_SASL,
1575         REP_EXTENDED,
1576         REP_SEARCH,
1577         REP_SEARCHREF,
1578         REP_INTERMEDIATE
1579 } slap_reply_t;
1580
1581 typedef struct rep_sasl_s {
1582         struct berval *r_sasldata;
1583 } rep_sasl_s;
1584
1585 typedef struct rep_extended_s {
1586         const char *r_rspoid;
1587         struct berval *r_rspdata;
1588 } rep_extended_s;
1589
1590 typedef struct rep_search_s {
1591         Entry *r_entry;
1592         AttributeName *r_attrs;
1593         int r_nentries;
1594         BerVarray r_v2ref;
1595 } rep_search_s;
1596
1597 typedef struct slap_rep {
1598         slap_reply_t sr_type;
1599         ber_tag_t sr_tag;
1600         ber_int_t sr_msgid;
1601         ber_int_t sr_err;
1602         const char *sr_matched;
1603         const char *sr_text;
1604         BerVarray sr_ref;
1605         LDAPControl **sr_ctrls;
1606         union sr_u {
1607                 rep_sasl_s sru_sasl;
1608                 rep_extended_s sru_extended;
1609                 rep_search_s sru_search;
1610         } sr_un;
1611 } SlapReply;
1612
1613 /* short hands for response members */
1614 #define sr_attrs sr_un.sru_search.r_attrs
1615 #define sr_entry sr_un.sru_search.r_entry
1616 #define sr_v2ref sr_un.sru_search.r_v2ref
1617 #define sr_nentries sr_un.sru_search.r_nentries
1618 #define sr_rspoid sr_un.sru_extended.r_rspoid
1619 #define sr_rspdata sr_un.sru_extended.r_rspdata
1620 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1621
1622 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1623 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1624 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1625 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1626 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1627 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1628 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1629 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1630 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1631 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1632 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1633 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1634 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1635         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1636 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1637 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1638 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1639
1640 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1641                 struct slap_conn *c));
1642 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1643                 struct slap_conn *c));
1644
1645 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1646 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1647 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1648 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1649 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1650 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1651                         struct berval *text ));
1652 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1653 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1654
1655 struct slap_backend_info {
1656         char    *bi_type; /* type of backend */
1657
1658         /*
1659          * per backend type routines:
1660          * bi_init: called to allocate a backend_info structure,
1661          *              called once BEFORE configuration file is read.
1662          *              bi_init() initializes this structure hence is
1663          *              called directly from be_initialize()
1664          * bi_config: called per 'backend' specific option
1665          *              all such options must before any 'database' options
1666          *              bi_config() is called only from read_config()
1667          * bi_open: called to open each database, called
1668          *              once AFTER configuration file is read but
1669          *              BEFORE any bi_db_open() calls.
1670          *              bi_open() is called from backend_startup()
1671          * bi_close: called to close each database, called
1672          *              once during shutdown after all bi_db_close calls.
1673          *              bi_close() is called from backend_shutdown()
1674          * bi_destroy: called to destroy each database, called
1675          *              once during shutdown after all bi_db_destroy calls.
1676          *              bi_destory() is called from backend_destroy()
1677          */
1678         BI_init *bi_init;
1679         BI_config       *bi_config;
1680         BI_open *bi_open;
1681         BI_close        *bi_close;
1682         BI_destroy      *bi_destroy;
1683
1684         /*
1685          * per database routines:
1686          * bi_db_init: called to initialize each database,
1687          *      called upon reading 'database <type>'
1688          *      called only from backend_db_init()
1689          * bi_db_config: called to configure each database,
1690          *  called per database to handle per database options
1691          *      called only from read_config()
1692          * bi_db_open: called to open each database
1693          *      called once per database immediately AFTER bi_open()
1694          *      calls but before daemon startup.
1695          *  called only by backend_startup()
1696          * bi_db_close: called to close each database
1697          *      called once per database during shutdown but BEFORE
1698          *  any bi_close call.
1699          *  called only by backend_shutdown()
1700          * bi_db_destroy: called to destroy each database
1701          *  called once per database during shutdown AFTER all
1702          *  bi_close calls but before bi_destory calls.
1703          *  called only by backend_destory()
1704          */
1705         BI_db_init      *bi_db_init;
1706         BI_db_config    *bi_db_config;
1707         BI_db_open      *bi_db_open;
1708         BI_db_close     *bi_db_close;
1709         BI_db_destroy   *bi_db_destroy;
1710
1711         /* LDAP Operations Handling Routines */
1712         BI_op_bind      *bi_op_bind;
1713         BI_op_unbind    *bi_op_unbind;
1714         BI_op_search    *bi_op_search;
1715         BI_op_compare   *bi_op_compare;
1716         BI_op_modify    *bi_op_modify;
1717         BI_op_modrdn    *bi_op_modrdn;
1718         BI_op_add       *bi_op_add;
1719         BI_op_delete    *bi_op_delete;
1720         BI_op_abandon   *bi_op_abandon;
1721         BI_op_cancel    *bi_op_cancel;
1722
1723         /* Extended Operations Helper */
1724         BI_op_extended  *bi_extended;
1725
1726         /* Auxilary Functions */
1727         BI_entry_get_rw         *bi_entry_get_rw;
1728         BI_entry_release_rw     *bi_entry_release_rw;
1729         BI_chk_referrals        *bi_chk_referrals;
1730
1731         BI_operational  *bi_operational;
1732         BI_has_subordinates     *bi_has_subordinates;
1733
1734         BI_connection_init      *bi_connection_init;
1735         BI_connection_destroy   *bi_connection_destroy;
1736
1737         /* hooks for slap tools */
1738         BI_tool_entry_open      *bi_tool_entry_open;
1739         BI_tool_entry_close     *bi_tool_entry_close;
1740         BI_tool_entry_first     *bi_tool_entry_first;
1741         BI_tool_entry_next      *bi_tool_entry_next;
1742         BI_tool_entry_get       *bi_tool_entry_get;
1743         BI_tool_entry_put       *bi_tool_entry_put;
1744         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1745         BI_tool_sync            *bi_tool_sync;
1746
1747 #define SLAP_INDEX_ADD_OP               0x0001
1748 #define SLAP_INDEX_DELETE_OP    0x0002
1749
1750         char **bi_controls;             /* supported controls */
1751
1752         unsigned int bi_nDB;    /* number of databases of this type */
1753         void    *bi_private;    /* anything the backend type needs */
1754 };
1755
1756 #define c_authtype      c_authz.sai_method
1757 #define c_authmech      c_authz.sai_mech
1758 #define c_dn            c_authz.sai_dn
1759 #define c_ndn           c_authz.sai_ndn
1760 #define c_ssf                   c_authz.sai_ssf
1761 #define c_transport_ssf c_authz.sai_transport_ssf
1762 #define c_tls_ssf               c_authz.sai_tls_ssf
1763 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1764
1765 #define o_authtype      o_authz.sai_method
1766 #define o_authmech      o_authz.sai_mech
1767 #define o_dn            o_authz.sai_dn
1768 #define o_ndn           o_authz.sai_ndn
1769 #define o_ssf                   o_authz.sai_ssf
1770 #define o_transport_ssf o_authz.sai_transport_ssf
1771 #define o_tls_ssf               o_authz.sai_tls_ssf
1772 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1773
1774 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1775
1776 typedef struct slap_callback {
1777         slap_response *sc_response;
1778         void *sc_private;
1779 } slap_callback;
1780
1781 struct slap_overinfo;
1782
1783 typedef struct slap_overinst {
1784         BackendInfo on_bi;
1785         slap_response *on_response;
1786         struct slap_overinfo *on_info;
1787         struct slap_overinst *on_next;
1788 } slap_overinst;
1789
1790 typedef struct slap_overinfo {
1791         BackendInfo oi_bi;
1792         BackendDB oi_bd;
1793         slap_overinst *oi_list;
1794 } slap_overinfo;
1795
1796 /* Should successive callbacks in a chain be processed? */
1797 #define SLAP_CB_CONTINUE        0x8000
1798
1799 /*
1800  * Paged Results state
1801  */
1802 typedef unsigned long PagedResultsCookie;
1803 typedef struct slap_paged_state {
1804         Backend *ps_be;
1805         PagedResultsCookie ps_cookie;
1806         ID ps_id;
1807 } PagedResultsState;
1808
1809
1810 #ifdef LDAP_SYNC
1811 #define LDAP_PSEARCH_BY_ADD                     0x01
1812 #define LDAP_PSEARCH_BY_DELETE          0x02
1813 #define LDAP_PSEARCH_BY_PREMODIFY       0x03
1814 #define LDAP_PSEARCH_BY_MODIFY          0x04
1815 #define LDAP_PSEARCH_BY_SCOPEOUT        0x05
1816
1817 struct psid_entry {
1818         struct slap_op *ps_op;
1819         LDAP_LIST_ENTRY(psid_entry) ps_link;
1820 };
1821
1822 struct slap_csn_entry {
1823         struct berval *csn;
1824         unsigned long opid;
1825         unsigned long connid;
1826 #define SLAP_CSN_PENDING        1
1827 #define SLAP_CSN_COMMIT         2
1828         long state;
1829         LDAP_TAILQ_ENTRY (slap_csn_entry) csn_link;
1830 };
1831 #endif
1832
1833
1834 /*
1835  * represents an operation pending from an ldap client
1836  */
1837 typedef struct slap_op {
1838         unsigned long o_opid;   /* id of this operation */
1839         unsigned long o_connid; /* id of conn initiating this op */
1840         struct slap_conn *o_conn;       /* connection spawning this op */
1841         BackendDB       *o_bd;  /* backend DB processing this op */
1842
1843         ber_int_t       o_msgid;        /* msgid of the request */
1844         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1845         ber_tag_t       o_tag;          /* tag of the request */
1846         time_t          o_time;         /* time op was initiated */
1847
1848         struct berval   o_req_dn;       /* DN of target of request */
1849         struct berval   o_req_ndn;
1850
1851         union o_req_u {
1852                 req_add_s oq_add;
1853                 req_bind_s oq_bind;
1854                 req_compare_s oq_compare;
1855                 req_modify_s oq_modify;
1856                 req_modrdn_s oq_modrdn;
1857                 req_search_s oq_search;
1858                 req_abandon_s oq_abandon;
1859                 req_abandon_s oq_cancel;
1860                 req_extended_s oq_extended;
1861         } o_request;
1862
1863 /* short hands for union members */
1864 #define oq_add o_request.oq_add
1865 #define oq_bind o_request.oq_bind
1866 #define oq_compare o_request.oq_compare
1867 #define oq_modify o_request.oq_modify
1868 #define oq_modrdn o_request.oq_modrdn
1869 #define oq_search o_request.oq_search
1870 #define oq_abandon o_request.oq_abandon
1871 #define oq_cancel o_request.oq_cancel
1872 #define oq_extended o_request.oq_extended
1873
1874 /* short hands for inner request members */
1875 #define orb_method oq_bind.rb_method
1876 #define orb_cred oq_bind.rb_cred
1877 #define orb_edn oq_bind.rb_edn
1878 #define orb_ssf oq_bind.rb_ssf
1879
1880 #define ors_scope oq_search.rs_scope
1881 #define ors_deref oq_search.rs_deref
1882 #define ors_slimit oq_search.rs_slimit
1883 #define ors_tlimit oq_search.rs_tlimit
1884 #define ors_attrsonly oq_search.rs_attrsonly
1885 #define ors_attrs oq_search.rs_attrs
1886 #define ors_filter oq_search.rs_filter
1887 #define ors_filterstr oq_search.rs_filterstr
1888
1889 #define orr_newrdn oq_modrdn.rs_newrdn
1890 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1891 #define orr_newSup oq_modrdn.rs_newSup
1892 #define orr_nnewSup oq_modrdn.rs_nnewSup
1893 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1894
1895 #define orc_ava oq_compare.rs_ava
1896 #define ora_e oq_add.rs_e
1897 #define orn_msgid oq_abandon.rs_msgid
1898 #define orm_modlist oq_modify.rs_modlist
1899
1900 #define ore_reqoid oq_extended.rs_reqoid
1901 #define ore_reqdata oq_extended.rs_reqdata
1902
1903         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1904
1905         volatile sig_atomic_t o_abandon;        /* abandon flag */
1906         volatile sig_atomic_t o_cancel;         /* cancel flag */
1907 #define SLAP_CANCEL_NONE                                0x00
1908 #define SLAP_CANCEL_REQ                                 0x01
1909 #define SLAP_CANCEL_ACK                                 0x02
1910 #define SLAP_CANCEL_DONE                                0x03
1911
1912         char o_do_not_cache;    /* don't cache from this op */
1913         char o_is_auth_check;   /* authorization in progress */
1914
1915 #define SLAP_NO_CONTROL 0
1916 #define SLAP_NONCRITICAL_CONTROL 1
1917 #define SLAP_CRITICAL_CONTROL 2
1918         char o_managedsait;
1919 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1920
1921         char o_noop;
1922         char o_proxy_authz;
1923
1924         char o_subentries;
1925 #define get_subentries(op)                              ((int)(op)->o_subentries)
1926         char o_subentries_visibility;
1927 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1928
1929         char o_assert;
1930 #define get_assert(op)                                  ((int)(op)->o_assert)
1931
1932         char o_valuesreturnfilter;
1933
1934 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1935         char o_permissive_modify;
1936 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
1937 #else
1938 #define get_permissiveModify(op)                (0)
1939 #endif
1940
1941 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1942         char o_domain_scope;
1943 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
1944 #else
1945 #define get_domainScope(op)                             (0)
1946 #endif
1947
1948 #ifdef LDAP_CONTROL_PAGEDRESULTS
1949         char o_pagedresults;
1950 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
1951         ber_int_t o_pagedresults_size;
1952         PagedResultsState o_pagedresults_state;
1953 #else
1954 #define get_pagedresults(op)                    (0)
1955 #endif
1956
1957 #ifdef LDAP_SYNC
1958         char o_sync;
1959         char o_sync_mode;
1960 #define SLAP_SYNC_NONE                          (0x0)
1961 #define SLAP_SYNC_REFRESH                       (0x1)
1962 #define SLAP_SYNC_PERSIST                       (0x2)
1963 #define SLAP_SYNC_REFRESH_AND_PERSIST           (0x3)
1964         struct berval o_sync_state;
1965
1966         int o_ps_protocol;
1967         int o_ps_entries;
1968         LDAP_LIST_ENTRY(slap_op) o_ps_link;
1969         LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1970 #endif
1971
1972         AuthorizationInformation o_authz;
1973
1974         BerElement      *o_ber;         /* ber of the request             */
1975 #ifdef LDAP_CONNECTIONLESS
1976         BerElement      *o_res_ber;     /* ber of the reply               */
1977 #endif
1978         slap_callback   *o_callback;    /* callback pointers */
1979         LDAPControl     **o_ctrls;       /* controls */
1980
1981         void    *o_threadctx;           /* thread pool thread context */
1982         void    *o_tmpmemctx;           /* slab malloc context */
1983         BerMemoryFunctions *o_tmpmfuncs;
1984 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
1985 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
1986 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
1987 #define o_tmpfree       o_tmpmfuncs->bmf_free
1988         void    *o_private;     /* anything the backend needs */
1989
1990         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1991
1992         Filter *o_assertion; /* Assert control filter */
1993 #define get_assertion(op)                               ((op)->o_assertion)
1994         ValuesReturnFilter *o_vrFilter; /* ValuesReturnFilter */
1995
1996 #ifdef LDAP_SYNCREPL
1997         syncinfo_t*     o_si;
1998 #endif
1999
2000 #ifdef LDAP_SLAPI
2001         void    *o_pb;                  /* NS-SLAPI plugin */
2002         void    *o_extensions;          /* NS-SLAPI plugin */
2003 #endif
2004 } Operation;
2005
2006 #define send_ldap_error( op, rs, err, text ) do { \
2007                 (rs)->sr_err = err; (rs)->sr_text = text; \
2008                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2009         } while (0)
2010 #define send_ldap_discon( op, rs, err, text ) do { \
2011                 (rs)->sr_err = err; (rs)->sr_text = text; \
2012                 send_ldap_disconnect( op, rs ); \
2013         } while (0)
2014
2015 typedef void (SEND_LDAP_RESULT)(
2016         struct slap_op *op, struct slap_rep *rs);
2017 typedef int (SEND_SEARCH_ENTRY)(
2018         struct slap_op *op, struct slap_rep *rs);
2019 typedef int (SEND_SEARCH_REFERENCE)(
2020         struct slap_op *op, struct slap_rep *rs);
2021 typedef void (SEND_LDAP_EXTENDED)(
2022         struct slap_op *op, struct slap_rep *rs);
2023 typedef void (SEND_LDAP_INTERMEDIATE)(
2024         struct slap_op *op, struct slap_rep *rs);
2025
2026 #define send_ldap_result( op, rs ) \
2027         (op->o_conn->c_send_ldap_result)( op, rs )
2028 #define send_search_entry( op, rs ) \
2029         (op->o_conn->c_send_search_entry)( op, rs )
2030 #define send_search_reference( op, rs ) \
2031         (op->o_conn->c_send_search_reference)( op, rs )
2032 #define send_ldap_extended( op, rs ) \
2033         (op->o_conn->c_send_ldap_extended)( op, rs )
2034 #define send_ldap_intermediate( op, rs ) \
2035         (op->o_conn->c_send_ldap_intermediate)( op, rs )
2036
2037 /*
2038  * Caches the result of a backend_group check for ACL evaluation
2039  */
2040 typedef struct slap_gacl {
2041         struct slap_gacl *ga_next;
2042         Backend *ga_be;
2043         ObjectClass *ga_oc;
2044         AttributeDescription *ga_at;
2045         int ga_res;
2046         ber_len_t ga_len;
2047         char ga_ndn[1];
2048 } GroupAssertion;
2049
2050 typedef struct slap_listener Listener;
2051
2052 /*
2053  * represents a connection from an ldap client
2054  */
2055 typedef struct slap_conn {
2056         int                     c_struct_state; /* structure management state */
2057         int                     c_conn_state;   /* connection state */
2058
2059         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2060         Sockbuf         *c_sb;                  /* ber connection stuff           */
2061
2062         /* only can be changed by connect_init */
2063         time_t          c_starttime;    /* when the connection was opened */
2064         time_t          c_activitytime; /* when the connection was last used */
2065         unsigned long           c_connid;       /* id of this connection for stats*/
2066
2067         struct berval   c_peer_domain;  /* DNS name of client */
2068         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2069         Listener        *c_listener;
2070 #define c_listener_url c_listener->sl_url       /* listener URL */
2071 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2072
2073         /* only can be changed by binding thread */
2074         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2075         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2076         struct berval   c_sasl_dn;      /* temporary storage */
2077
2078         /* authorization backend */
2079         Backend *c_authz_backend;
2080
2081         AuthorizationInformation c_authz;
2082         GroupAssertion *c_groups;
2083
2084         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2085
2086         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2087         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2088
2089         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2090         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2091
2092         BerElement      *c_currentber;  /* ber we're attempting to read */
2093         int             c_writewaiter;  /* true if writer is waiting */
2094
2095 #ifdef LDAP_CONNECTIONLESS
2096         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2097 #endif
2098 #ifdef HAVE_TLS
2099         int     c_is_tls;               /* true if this LDAP over raw TLS */
2100         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2101 #endif
2102         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2103         int     c_sasl_done;            /* SASL completed once */
2104         void    *c_sasl_authctx;        /* SASL authentication context */
2105         void    *c_sasl_sockctx;        /* SASL security layer context */
2106         void    *c_sasl_extra;          /* SASL session extra stuff */
2107         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2108
2109         PagedResultsState c_pagedresults_state; /* paged result state */
2110
2111         long    c_n_ops_received;       /* num of ops received (next op_id) */
2112         long    c_n_ops_executing;      /* num of ops currently executing */
2113         long    c_n_ops_pending;        /* num of ops pending execution */
2114         long    c_n_ops_completed;      /* num of ops completed */
2115
2116         long    c_n_get;                /* num of get calls */
2117         long    c_n_read;               /* num of read calls */
2118         long    c_n_write;              /* num of write calls */
2119
2120         void    *c_pb;                  /* Netscape plugin */
2121         void    *c_extensions;          /* Netscape plugin */
2122
2123         /*
2124          * These are the "callbacks" that are available for back-ends to
2125          * supply data back to connected clients that are connected
2126          * through the "front-end".
2127          */
2128         SEND_LDAP_RESULT *c_send_ldap_result;
2129         SEND_SEARCH_ENTRY *c_send_search_entry;
2130         SEND_SEARCH_REFERENCE *c_send_search_reference;
2131         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2132 #ifdef LDAP_RES_INTERMEDIATE
2133         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2134 #endif
2135
2136 } Connection;
2137
2138 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2139 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2140         do { \
2141                 if ( ldap_debug & (level) ) \
2142                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2143                 if ( ldap_syslog & (level) ) \
2144                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2145                                 (arg2), (arg3) ); \
2146         } while (0)
2147 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2148 #elif defined(LDAP_DEBUG)
2149 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2150         do { \
2151                 if ( ldap_debug & (level) ) \
2152                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2153         } while (0)
2154 #define StatslogTest( level ) (ldap_debug & (level))
2155 #else
2156 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2157 #define StatslogTest( level ) (0)
2158 #endif
2159
2160 /*
2161  * listener; need to access it from monitor backend
2162  */
2163 struct slap_listener {
2164         struct berval sl_url;
2165         struct berval sl_name;
2166         mode_t  sl_perms;
2167 #ifdef HAVE_TLS
2168         int             sl_is_tls;
2169 #endif
2170 #ifdef LDAP_CONNECTIONLESS
2171         int     sl_is_udp;              /* UDP listener is also data port */
2172 #endif
2173         int     sl_is_mute;     /* Listening is temporarily disabled */
2174         ber_socket_t sl_sd;
2175         Sockaddr sl_sa;
2176 #define sl_addr sl_sa.sa_in_addr
2177 };
2178
2179 #ifdef SLAPD_MONITOR
2180 /*
2181  * Operation indices
2182  */
2183 enum {
2184         SLAP_OP_BIND = 0,
2185         SLAP_OP_UNBIND,
2186         SLAP_OP_ADD,
2187         SLAP_OP_DELETE,
2188         SLAP_OP_MODRDN,
2189         SLAP_OP_MODIFY,
2190         SLAP_OP_COMPARE,
2191         SLAP_OP_SEARCH,
2192         SLAP_OP_ABANDON,
2193         SLAP_OP_EXTENDED,
2194         SLAP_OP_LAST
2195 };
2196 #endif /* SLAPD_MONITOR */
2197
2198 /*
2199  * Better know these all around slapd
2200  */
2201 #define SLAP_LDAPDN_PRETTY 0x1
2202 #define SLAP_LDAPDN_MAXLEN 8192
2203
2204 #ifdef LDAP_SYNC
2205 #define SLAP_SEARCH_MAX_CTRLS   10
2206 #endif
2207
2208 #ifdef LDAP_DEVEL
2209 #define SLAP_CTRL_HIDE                          0x00000000U
2210 #else
2211 #define SLAP_CTRL_HIDE                          0x80000000U
2212 #endif
2213
2214 #define SLAP_CTRL_FRONTEND                      0x00800000U
2215 #define SLAP_CTRL_FRONTEND_SEARCH       0x00010000U     /* for NOOP */
2216
2217 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2218 #define SLAP_CTRL_ABANDON                       0x00000001U
2219 #define SLAP_CTRL_ADD                           0x00002002U
2220 #define SLAP_CTRL_BIND                          0x00000004U
2221 #define SLAP_CTRL_COMPARE                       0x00001008U
2222 #define SLAP_CTRL_DELETE                        0x00002010U
2223 #define SLAP_CTRL_MODIFY                        0x00002020U
2224 #define SLAP_CTRL_RENAME                        0x00002040U
2225 #define SLAP_CTRL_SEARCH                        0x00001080U
2226 #define SLAP_CTRL_UNBIND                        0x00000100U
2227
2228 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2229 #define SLAP_CTRL_UPDATE \
2230         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2231 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2232
2233 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2234         Operation *op,
2235         SlapReply *rs,
2236         LDAPControl *ctrl ));
2237
2238 LDAP_END_DECL
2239
2240 #include "proto-slap.h"
2241
2242 #endif /* _SLAP_H_ */