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

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