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