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