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/socket.h>
  20 #include <ac/time.h>
  21 #include <ac/param.h>
  22
  23 #include "avl.h"
  24
  25 #ifndef ldap_debug
  26 #define ldap_debug slap_debug
  27 #endif
  28
  29 #include "ldap_log.h"
  30
  31 #include <ldap.h>
  32 #include <ldap_schema.h>
  33
  34 #include "ldap_pvt_thread.h"
  35 #include "ldap_queue.h"
  36
  37 LDAP_BEGIN_DECL
  38 /*
  39  * SLAPD Memory allocation macros
  40  *
  41  * Unlike ch_*() routines, these routines do not assert() upon
  42  * allocation error.  They are intended to be used instead of
  43  * ch_*() routines where the caller has implemented proper
  44  * checking for and handling of allocation errors.
  45  *
  46  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  47  */
  48 #define SLAP_MALLOC(s)      ber_memalloc((s))
  49 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  50 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  51 #define SLAP_FREE(p)        ber_memfree((p))
  52 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  53 #define SLAP_STRDUP(s)      ber_strdup((s))
  54 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  55
  56 #ifdef f_next
  57 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  58 #endif
  59
  60 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  61 #define SLAPD_ANONYMOUS "cn=anonymous"
  62
  63 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  64  *
  65  * This is a value used internally by the backends. It is needed to allow
  66  * adding values that already exist without getting an error as required by
  67  * modrdn when the new rdn was already an attribute value itself.
  68  * JCG 05/1999 (gomez@engr.sgi.com)
  69  */
  70 #define SLAP_MOD_SOFTADD        0x1000
  71
  72 #define ON      (1)
  73 #define OFF     (-1)
  74 #define UNDEFINED (0)
  75
  76 #define MAXREMATCHES (10)
  77
  78 #define SLAP_MAX_WORKER_THREADS         (32)
  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 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 141 #define SLAPD_ACI_ATTR                  "OpenLDAPaci"
 142
 143 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
 144
 145 /* change this to "OpenLDAPset" */
 146 #define SLAPD_ACI_SET_ATTR              "template"
 147
 148 #define SLAPD_TOP_OID                   "2.5.6.0"
 149
 150 LDAP_SLAPD_V (int) slap_debug;
 151
 152 typedef unsigned long slap_mask_t;
 153
 154 /* Security Strength Factor */
 155 typedef unsigned slap_ssf_t;
 156
 157 typedef struct slap_ssf_set {
 158         slap_ssf_t sss_ssf;
 159         slap_ssf_t sss_transport;
 160         slap_ssf_t sss_tls;
 161         slap_ssf_t sss_sasl;
 162         slap_ssf_t sss_update_ssf;
 163         slap_ssf_t sss_update_transport;
 164         slap_ssf_t sss_update_tls;
 165         slap_ssf_t sss_update_sasl;
 166 } slap_ssf_set_t;
 167
 168 /*
 169  * Index types
 170  */
 171 #define SLAP_INDEX_TYPE           0x00FFUL
 172 #define SLAP_INDEX_UNDEFINED      0x0001UL
 173 #define SLAP_INDEX_PRESENT        0x0002UL
 174 #define SLAP_INDEX_EQUALITY       0x0004UL
 175 #define SLAP_INDEX_APPROX         0x0008UL
 176 #define SLAP_INDEX_SUBSTR         0x0010UL
 177 #define SLAP_INDEX_EXTENDED               0x0020UL
 178
 179 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 180
 181 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type) )
 182
 183 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 184
 185 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 186 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 187 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 188 #define SLAP_INDEX_SUBSTR_DEFAULT \
 189         ( SLAP_INDEX_SUBSTR \
 190         | SLAP_INDEX_SUBSTR_INITIAL \
 191         | SLAP_INDEX_SUBSTR_ANY \
 192         | SLAP_INDEX_SUBSTR_FINAL )
 193
 194 #define SLAP_INDEX_SUBSTR_MINLEN        2
 195 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 196 #define SLAP_INDEX_SUBSTR_STEP  2
 197
 198 #define SLAP_INDEX_FLAGS         0xF000UL
 199 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 200 #define SLAP_INDEX_NOLANG        0x2000UL /* don't use index w/ lang */
 201 #define SLAP_INDEX_AUTO_SUBTYPES 0x4000UL /* use mask with lang subtypes */
 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 #define SLAP_INDEX_UNKNOWN_PREFIX       '?'             /* prefix for unknown keys */
 214
 215 #define SLAP_SYNTAX_MATCHINGRULES_OID   "1.3.6.1.4.1.1466.115.121.1.30"
 216 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID  "1.3.6.1.4.1.1466.115.121.1.3"
 217 #define SLAP_SYNTAX_OBJECTCLASSES_OID   "1.3.6.1.4.1.1466.115.121.1.37"
 218
 219 /*
 220  * represents schema information for a database
 221  */
 222 #define SLAP_SCHERR_OUTOFMEM            1
 223 #define SLAP_SCHERR_CLASS_NOT_FOUND     2
 224 #define SLAP_SCHERR_CLASS_BAD_USAGE     3
 225 #define SLAP_SCHERR_ATTR_NOT_FOUND      4
 226 #define SLAP_SCHERR_ATTR_BAD_USAGE      5
 227 #define SLAP_SCHERR_DUP_CLASS           6
 228 #define SLAP_SCHERR_DUP_ATTR            7
 229 #define SLAP_SCHERR_DUP_SYNTAX          8
 230 #define SLAP_SCHERR_DUP_RULE            9
 231 #define SLAP_SCHERR_NO_NAME             10
 232 #define SLAP_SCHERR_ATTR_INCOMPLETE     11
 233 #define SLAP_SCHERR_MR_NOT_FOUND        12
 234 #define SLAP_SCHERR_SYN_NOT_FOUND       13
 235 #define SLAP_SCHERR_MR_INCOMPLETE       14
 236 #define SLAP_SCHERR_NOT_SUPPORTED       15
 237 #define SLAP_SCHERR_BAD_DESCR   16
 238
 239 typedef union slap_sockaddr {
 240         struct sockaddr sa_addr;
 241         struct sockaddr_in sa_in_addr;
 242 #ifdef LDAP_PF_INET6
 243         struct sockaddr_in6 sa_in6_addr;
 244 #endif
 245 #ifdef LDAP_PF_LOCAL
 246         struct sockaddr_un sa_un_addr;
 247 #endif
 248 } Sockaddr;
 249
 250 typedef struct slap_oid_macro {
 251         struct berval som_oid;
 252         char **som_names;
 253         struct slap_oid_macro *som_next;
 254 } OidMacro;
 255
 256 /* forward declarations */
 257 struct slap_syntax;
 258 struct slap_matching_rule;
 259
 260 typedef int slap_syntax_validate_func LDAP_P((
 261         struct slap_syntax *syntax,
 262         struct berval * in));
 263
 264 typedef int slap_syntax_transform_func LDAP_P((
 265         struct slap_syntax *syntax,
 266         struct berval * in,
 267         struct berval * out));
 268
 269 typedef struct slap_syntax {
 270         LDAPSyntax                      ssyn_syn;
 271 #define ssyn_oid                ssyn_syn.syn_oid
 272 #define ssyn_desc               ssyn_syn.syn_desc
 273 #define ssyn_extensions         ssyn_syn.syn_extensions
 274         ber_len_t       ssyn_oidlen;
 275
 276         unsigned        ssyn_flags;
 277
 278 #define SLAP_SYNTAX_NONE        0x00U
 279 #define SLAP_SYNTAX_BLOB        0x01U /* syntax treated as blob (audio) */
 280 #define SLAP_SYNTAX_BINARY      0x02U /* binary transfer required (certificate) */
 281 #define SLAP_SYNTAX_BER         0x04U /* stored using BER encoding (binary,certificate) */
 282 #define SLAP_SYNTAX_HIDE        0x80U /* hide (do not publish) */
 283
 284         slap_syntax_validate_func       *ssyn_validate;
 285         slap_syntax_transform_func      *ssyn_normalize;
 286         slap_syntax_transform_func      *ssyn_pretty;
 287
 288 #ifdef SLAPD_BINARY_CONVERSION
 289         /* convert to and from binary */
 290         slap_syntax_transform_func      *ssyn_ber2str;
 291         slap_syntax_transform_func      *ssyn_str2ber;
 292 #endif
 293
 294         struct slap_syntax              *ssyn_next;
 295 } Syntax;
 296
 297 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 298 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 299 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 300 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 301 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 302
 303 /* X -> Y Converter */
 304 typedef int slap_mr_convert_func LDAP_P((
 305         struct berval * in,
 306         struct berval * out ));
 307
 308 /* Normalizer */
 309 typedef int slap_mr_normalize_func LDAP_P((
 310         slap_mask_t use,
 311         struct slap_syntax *syntax, /* NULL if in is asserted value */
 312         struct slap_matching_rule *mr,
 313         struct berval * in,
 314         struct berval * out ));
 315
 316 /* Match (compare) function */
 317 typedef int slap_mr_match_func LDAP_P((
 318         int *match,
 319         slap_mask_t use,
 320         struct slap_syntax *syntax,     /* syntax of stored value */
 321         struct slap_matching_rule *mr,
 322         struct berval * value,
 323         void * assertValue ));
 324
 325 /* Index generation function */
 326 typedef int slap_mr_indexer_func LDAP_P((
 327         slap_mask_t use,
 328         slap_mask_t mask,
 329         struct slap_syntax *syntax,     /* syntax of stored value */
 330         struct slap_matching_rule *mr,
 331         struct berval *prefix,
 332         BVarray values,
 333         BVarray *keys ));
 334
 335 /* Filter index function */
 336 typedef int slap_mr_filter_func LDAP_P((
 337         slap_mask_t use,
 338         slap_mask_t mask,
 339         struct slap_syntax *syntax,     /* syntax of stored value */
 340         struct slap_matching_rule *mr,
 341         struct berval *prefix,
 342         void * assertValue,
 343         BVarray *keys ));
 344
 345 typedef struct slap_matching_rule {
 346         LDAPMatchingRule                smr_mrule;
 347         ber_len_t                       smr_oidlen;
 348         slap_mask_t                             smr_usage;
 349
 350 #define SLAP_MR_TYPE_MASK               0xFF00U
 351 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 352 #define SLAP_MR_USAGE                   0x000FU
 353
 354 #define SLAP_MR_NONE                    0x0000U
 355 #define SLAP_MR_EQUALITY                0x0100U
 356 #define SLAP_MR_ORDERING                0x0200U
 357 #define SLAP_MR_SUBSTR                  0x0400U
 358 #define SLAP_MR_EXT                             0x0800U
 359
 360 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 361 #define SLAP_MR_DN_FOLD                 0x0008U
 362
 363 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 364 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 365 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 366
 367 /*
 368  * normally the provided value is expected to conform to
 369  * assertion syntax specified in the matching rule, however
 370  * at times (such as during individual value modification),
 371  * the provided value is expected to conform to the
 372  * attribute's value syntax.
 373  */
 374 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
 375 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
 376 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
 377
 378 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 379         (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
 380 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
 381         ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
 382
 383 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
 384         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 385                 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
 386 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 387         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 388                 == SLAP_MR_VALUE_SYNTAX_MATCH)
 389
 390         Syntax                                  *smr_syntax;
 391         slap_mr_convert_func    *smr_convert;
 392         slap_mr_normalize_func  *smr_normalize;
 393         slap_mr_match_func              *smr_match;
 394         slap_mr_indexer_func    *smr_indexer;
 395         slap_mr_filter_func             *smr_filter;
 396
 397         struct slap_matching_rule       *smr_associated;
 398         struct slap_matching_rule       *smr_next;
 399
 400 #define smr_oid                         smr_mrule.mr_oid
 401 #define smr_names                       smr_mrule.mr_names
 402 #define smr_desc                        smr_mrule.mr_desc
 403 #define smr_obsolete            smr_mrule.mr_obsolete
 404 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 405 #define smr_extensions          smr_mrule.mr_extensions
 406 } MatchingRule;
 407
 408 struct slap_attr_desc;
 409
 410 typedef struct slap_attribute_type {
 411         LDAPAttributeType               sat_atype;
 412         struct berval                   sat_cname;
 413         struct slap_attribute_type      *sat_sup;
 414         struct slap_attribute_type      **sat_subtypes;
 415         MatchingRule                    *sat_equality;
 416         MatchingRule                    *sat_approx;
 417         MatchingRule                    *sat_ordering;
 418         MatchingRule                    *sat_substr;
 419         Syntax                          *sat_syntax;
 420         struct slap_attr_desc           *sat_ad;
 421         struct slap_attribute_type      *sat_next;
 422         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 423 #define sat_oid                 sat_atype.at_oid
 424 #define sat_names               sat_atype.at_names
 425 #define sat_desc                sat_atype.at_desc
 426 #define sat_obsolete            sat_atype.at_obsolete
 427 #define sat_sup_oid             sat_atype.at_sup_oid
 428 #define sat_equality_oid        sat_atype.at_equality_oid
 429 #define sat_ordering_oid        sat_atype.at_ordering_oid
 430 #define sat_substr_oid          sat_atype.at_substr_oid
 431 #define sat_syntax_oid          sat_atype.at_syntax_oid
 432 #define sat_single_value        sat_atype.at_single_value
 433 #define sat_collective          sat_atype.at_collective
 434 #define sat_no_user_mod         sat_atype.at_no_user_mod
 435 #define sat_usage               sat_atype.at_usage
 436 #define sat_extensions          sat_atype.at_extensions
 437 } AttributeType;
 438
 439 #define is_at_operational(at)   ((at)->sat_usage)
 440 #define is_at_single_value(at)  ((at)->sat_single_value)
 441 #define is_at_collective(at)    ((at)->sat_collective)
 442 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 443 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 444
 445 typedef struct slap_object_class {
 446         LDAPObjectClass         soc_oclass;
 447         struct slap_object_class        **soc_sups;
 448         AttributeType                   **soc_required;
 449         AttributeType                   **soc_allowed;
 450         struct slap_object_class        *soc_next;
 451 #define soc_oid                 soc_oclass.oc_oid
 452 #define soc_names               soc_oclass.oc_names
 453 #define soc_desc                soc_oclass.oc_desc
 454 #define soc_obsolete            soc_oclass.oc_obsolete
 455 #define soc_sup_oids            soc_oclass.oc_sup_oids
 456 #define soc_kind                soc_oclass.oc_kind
 457 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 458 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 459 #define soc_extensions          soc_oclass.oc_extensions
 460 } ObjectClass;
 461
 462
 463 /*
 464  * represents a recognized attribute description ( type + options )
 465  */
 466 typedef struct slap_attr_desc {
 467         struct slap_attr_desc *ad_next;
 468         AttributeType *ad_type;         /* attribute type, must be specified */
 469         struct berval ad_cname;         /* canonical name, must be specified */
 470         struct berval ad_lang;          /* empty if no language tags */
 471         unsigned ad_flags;
 472 #define SLAP_DESC_NONE          0x0U
 473 #define SLAP_DESC_BINARY        0x1U
 474 } AttributeDescription;
 475
 476 typedef struct slap_attr_name {
 477         struct berval an_name;
 478         AttributeDescription *an_desc;
 479 } AttributeName;
 480
 481 #define slap_ad_is_lang(ad)             ( (ad)->ad_lang.bv_len != 0 )
 482 #define slap_ad_is_binary(ad)   ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 483
 484 /*
 485  * pointers to schema elements used internally
 486  */
 487 struct slap_internal_schema {
 488         /* objectClass */
 489         ObjectClass *si_oc_top;
 490         ObjectClass *si_oc_extensibleObject;
 491         ObjectClass *si_oc_alias;
 492         ObjectClass *si_oc_referral;
 493         ObjectClass *si_oc_subentry;
 494         ObjectClass *si_oc_subschema;
 495         ObjectClass *si_oc_rootdse;
 496
 497         /* objectClass attribute descriptions */
 498         AttributeDescription *si_ad_objectClass;
 499
 500         /* operational attribute descriptions */
 501         AttributeDescription *si_ad_structuralObjectClass;
 502         AttributeDescription *si_ad_entryUUID;
 503         AttributeDescription *si_ad_entryCSN;
 504         AttributeDescription *si_ad_creatorsName;
 505         AttributeDescription *si_ad_createTimestamp;
 506         AttributeDescription *si_ad_modifiersName;
 507         AttributeDescription *si_ad_modifyTimestamp;
 508         AttributeDescription *si_ad_hasSubordinates;
 509         AttributeDescription *si_ad_subschemaSubentry;
 510
 511         /* root DSE attribute descriptions */
 512         AttributeDescription *si_ad_namingContexts;
 513         AttributeDescription *si_ad_supportedControl;
 514         AttributeDescription *si_ad_supportedExtension;
 515         AttributeDescription *si_ad_supportedLDAPVersion;
 516         AttributeDescription *si_ad_supportedSASLMechanisms;
 517         AttributeDescription *si_ad_supportedFeatures;
 518
 519         /* subschema subentry attribute descriptions */
 520         AttributeDescription *si_ad_objectClasses;
 521         AttributeDescription *si_ad_attributeTypes;
 522         AttributeDescription *si_ad_ldapSyntaxes;
 523         AttributeDescription *si_ad_matchingRules;
 524         AttributeDescription *si_ad_matchingRulesUse;
 525
 526         /* Aliases & Referrals */
 527         AttributeDescription *si_ad_aliasedObjectName;
 528         AttributeDescription *si_ad_ref;
 529
 530         /* Access Control Internals */
 531         AttributeDescription *si_ad_entry;
 532         AttributeDescription *si_ad_children;
 533 #ifdef SLAPD_ACI_ENABLED
 534         AttributeDescription *si_ad_aci;
 535 #endif
 536
 537         /* Other attributes descriptions */
 538         AttributeDescription *si_ad_userPassword;
 539         AttributeDescription *si_ad_authPassword;
 540 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 541         AttributeDescription *si_ad_krbName;
 542 #endif
 543
 544         /* Undefined Attribute Type */
 545         AttributeType   *si_at_undefined;
 546
 547         /* Matching Rules */
 548         MatchingRule    *si_mr_distinguishedNameMatch;
 549         MatchingRule    *si_mr_integerMatch;
 550
 551         /* Syntaxes */
 552         Syntax          *si_syn_distinguishedName;
 553         Syntax          *si_syn_integer;
 554 };
 555
 556 typedef struct slap_attr_assertion {
 557         AttributeDescription    *aa_desc;
 558         struct berval aa_value;
 559 } AttributeAssertion;
 560
 561 typedef struct slap_ss_assertion {
 562         AttributeDescription    *sa_desc;
 563         struct berval           sa_initial;
 564         struct berval           *sa_any;
 565         struct berval           sa_final;
 566 } SubstringsAssertion;
 567
 568 typedef struct slap_mr_assertion {
 569         MatchingRule            *ma_rule;       /* optional */
 570         struct berval           ma_rule_text;  /* optional */
 571         AttributeDescription    *ma_desc;       /* optional */
 572         int                                             ma_dnattrs; /* boolean */
 573         struct berval           ma_value;       /* required */
 574 } MatchingRuleAssertion;
 575
 576 /*
 577  * represents a search filter
 578  */
 579 typedef struct slap_filter {
 580         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 581 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 582 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 583 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 584
 585         union f_un_u {
 586                 /* precomputed result */
 587                 ber_int_t f_un_result;
 588
 589                 /* DN */
 590                 struct berval *f_un_dn;
 591
 592                 /* present */
 593                 AttributeDescription *f_un_desc;
 594
 595                 /* simple value assertion */
 596                 AttributeAssertion *f_un_ava;
 597
 598                 /* substring assertion */
 599                 SubstringsAssertion *f_un_ssa;
 600
 601                 /* matching rule assertion */
 602                 MatchingRuleAssertion *f_un_mra;
 603
 604 #define f_dn                    f_un.f_un_dn
 605 #define f_desc                  f_un.f_un_desc
 606 #define f_ava                   f_un.f_un_ava
 607 #define f_av_desc               f_un.f_un_ava->aa_desc
 608 #define f_av_value              f_un.f_un_ava->aa_value
 609 #define f_sub                   f_un.f_un_ssa
 610 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 611 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 612 #define f_sub_any               f_un.f_un_ssa->sa_any
 613 #define f_sub_final             f_un.f_un_ssa->sa_final
 614 #define f_mra                   f_un.f_un_mra
 615 #define f_mr_rule               f_un.f_un_mra->ma_rule
 616 #define f_mr_rule_text          f_un.f_un_mra->ma_rule_text
 617 #define f_mr_desc               f_un.f_un_mra->ma_desc
 618 #define f_mr_value              f_un.f_un_mra->ma_value
 619 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 620
 621                 /* and, or, not */
 622                 struct slap_filter *f_un_complex;
 623         } f_un;
 624
 625 #define f_result        f_un.f_un_result
 626 #define f_and           f_un.f_un_complex
 627 #define f_or            f_un.f_un_complex
 628 #define f_not           f_un.f_un_complex
 629 #define f_list          f_un.f_un_complex
 630
 631         struct slap_filter      *f_next;
 632 } Filter;
 633
 634 /* compare routines can return undefined */
 635 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 636
 637 /*
 638  * represents an attribute (description + values)
 639  */
 640 typedef struct slap_attr {
 641         AttributeDescription *a_desc;
 642         BVarray a_vals;
 643         struct slap_attr        *a_next;
 644 } Attribute;
 645
 646
 647 /*
 648  * the id used in the indexes to refer to an entry
 649  */
 650 typedef unsigned long   ID;
 651 #define NOID    ((ID)~0)
 652
 653 /*
 654  * represents an entry in core
 655  */
 656 typedef struct slap_entry {
 657         /*
 658          * The ID field should only be changed before entry is
 659          * inserted into a cache.  The ID value is backend
 660          * specific.
 661          */
 662         ID              e_id;
 663
 664         struct berval e_name;   /* name (DN) of this entry */
 665         struct berval e_nname;  /* normalized name (DN) of this entry */
 666
 667         /* for migration purposes */
 668 #define e_dn e_name.bv_val
 669 #define e_ndn e_nname.bv_val
 670
 671         Attribute       *e_attrs;       /* list of attributes + values */
 672
 673         /* for use by the backend for any purpose */
 674         void*   e_private;
 675 } Entry;
 676
 677 /*
 678  * A list of LDAPMods
 679  */
 680 typedef struct slap_mod {
 681         int sm_op;
 682         AttributeDescription *sm_desc;
 683         struct berval sm_type;
 684         BVarray sm_bvalues;
 685 } Modification;
 686
 687 typedef struct slap_mod_list {
 688         Modification sml_mod;
 689 #define sml_op          sml_mod.sm_op
 690 #define sml_desc        sml_mod.sm_desc
 691 #define sml_type        sml_mod.sm_type
 692 #define sml_bvalues     sml_mod.sm_bvalues
 693         struct slap_mod_list *sml_next;
 694 } Modifications;
 695
 696 typedef struct slap_ldap_modlist {
 697         LDAPMod ml_mod;
 698         struct slap_ldap_modlist *ml_next;
 699 #define ml_op           ml_mod.mod_op
 700 #define ml_type         ml_mod.mod_type
 701 #define ml_values       ml_mod.mod_values
 702 #define ml_bvalues      ml_mod.mod_bvalues
 703 } LDAPModList;
 704
 705 /*
 706  * represents an access control list
 707  */
 708 typedef enum slap_access_e {
 709         ACL_INVALID_ACCESS = -1,
 710         ACL_NONE = 0,
 711         ACL_AUTH,
 712         ACL_COMPARE,
 713         ACL_SEARCH,
 714         ACL_READ,
 715         ACL_WRITE
 716 } slap_access_t;
 717
 718 typedef enum slap_control_e {
 719         ACL_INVALID_CONTROL     = 0,
 720         ACL_STOP,
 721         ACL_CONTINUE,
 722         ACL_BREAK
 723 } slap_control_t;
 724
 725 typedef enum slap_style_e {
 726         ACL_STYLE_REGEX = 0,
 727         ACL_STYLE_BASE,
 728         ACL_STYLE_ONE,
 729         ACL_STYLE_SUBTREE,
 730         ACL_STYLE_CHILDREN,
 731         ACL_STYLE_ATTROF,
 732
 733         /* alternate names */
 734         ACL_STYLE_EXACT = ACL_STYLE_BASE
 735 } slap_style_t;
 736
 737 typedef struct slap_authz_info {
 738         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
 739         char *          sai_mech;               /* SASL Mechanism */
 740         struct berval   sai_dn;                 /* DN for reporting purposes */
 741         struct berval   sai_ndn;                /* Normalized DN */
 742
 743         /* Security Strength Factors */
 744         slap_ssf_t      sai_ssf;                        /* Overall SSF */
 745         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
 746         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
 747         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
 748 } AuthorizationInformation;
 749
 750 /* the "by" part */
 751 typedef struct slap_access {
 752         slap_control_t a_type;
 753
 754 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
 755
 756 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
 757 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
 758 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
 759 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
 760 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
 761 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
 762
 763 #define ACL_PRIV_MASK                   0x00ffUL
 764
 765 /* priv flags */
 766 #define ACL_PRIV_LEVEL                  0x1000UL
 767 #define ACL_PRIV_ADDITIVE               0x2000UL
 768 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
 769
 770 /* invalid privs */
 771 #define ACL_PRIV_INVALID                0x0UL
 772
 773 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
 774 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
 775 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
 776 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
 777
 778 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
 779 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
 780
 781 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
 782
 783 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
 784
 785 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
 786 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
 787 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
 788
 789 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
 790 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
 791 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
 792 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
 793 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
 794 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
 795
 796 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
 797 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
 798 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
 799 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
 800 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
 801 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
 802 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
 803
 804 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
 805 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
 806 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
 807 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
 808 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
 809 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
 810
 811         slap_mask_t     a_access_mask;
 812
 813         AuthorizationInformation        a_authz;
 814 #define a_dn_pat        a_authz.sai_dn
 815
 816         slap_style_t a_dn_style;
 817         AttributeDescription    *a_dn_at;
 818         int                     a_dn_self;
 819
 820         slap_style_t a_peername_style;
 821         char            *a_peername_pat;
 822         slap_style_t a_sockname_style;
 823         char            *a_sockname_pat;
 824
 825         slap_style_t a_domain_style;
 826         char            *a_domain_pat;
 827         slap_style_t a_sockurl_style;
 828         char            *a_sockurl_pat;
 829         slap_style_t a_set_style;
 830         struct berval   a_set_pat;
 831
 832 #ifdef SLAPD_ACI_ENABLED
 833         AttributeDescription    *a_aci_at;
 834 #endif
 835
 836         /* ACL Groups */
 837         slap_style_t a_group_style;
 838         struct berval   a_group_pat;
 839         ObjectClass                             *a_group_oc;
 840         AttributeDescription    *a_group_at;
 841
 842         struct slap_access      *a_next;
 843 } Access;
 844
 845 /* the "to" part */
 846 typedef struct slap_acl {
 847         /* "to" part: the entries this acl applies to */
 848         Filter          *acl_filter;
 849         slap_style_t acl_dn_style;
 850         regex_t         acl_dn_re;
 851         struct berval   acl_dn_pat;
 852         AttributeName   *acl_attrs;
 853
 854         /* "by" part: list of who has what access to the entries */
 855         Access  *acl_access;
 856
 857         struct slap_acl *acl_next;
 858 } AccessControl;
 859
 860 /*
 861  * replog moddn param structure
 862  */
 863 struct slap_replog_moddn {
 864         struct berval *newrdn;
 865         int     deloldrdn;
 866         struct berval *newsup;
 867 };
 868
 869 /*
 870  * Backend-info
 871  * represents a backend
 872  */
 873
 874 typedef struct slap_backend_info BackendInfo;   /* per backend type */
 875 typedef struct slap_backend_db BackendDB;               /* per backend database */
 876
 877 LDAP_SLAPD_V (int) nBackendInfo;
 878 LDAP_SLAPD_V (int) nBackendDB;
 879 LDAP_SLAPD_V (BackendInfo *) backendInfo;
 880 LDAP_SLAPD_V (BackendDB *) backendDB;
 881
 882 LDAP_SLAPD_V (int) slapMode;
 883 #define SLAP_UNDEFINED_MODE     0x0000
 884 #define SLAP_SERVER_MODE        0x0001
 885 #define SLAP_TOOL_MODE          0x0002
 886 #define SLAP_MODE                       0x0003
 887
 888 #define SLAP_TRUNCATE_MODE      0x0100
 889
 890 struct slap_replica_info {
 891         char *ri_host;                          /* supersedes be_replica */
 892         struct berval **ri_nsuffix;     /* array of suffixes this replica accepts */
 893 };
 894
 895 struct slap_limits_set {
 896         /* time limits */
 897         int     lms_t_soft;
 898         int     lms_t_hard;
 899
 900         /* size limits */
 901         int     lms_s_soft;
 902         int     lms_s_hard;
 903         int     lms_s_unchecked;
 904 };
 905
 906 struct slap_limits {
 907         int     lm_type;        /* type of pattern */
 908 #define SLAP_LIMITS_UNDEFINED   0x0000
 909 #define SLAP_LIMITS_EXACT       0x0001
 910 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
 911 #define SLAP_LIMITS_ONE         0x0002
 912 #define SLAP_LIMITS_SUBTREE     0x0003
 913 #define SLAP_LIMITS_CHILDREN    0x0004
 914 #define SLAP_LIMITS_REGEX       0x0005
 915 #define SLAP_LIMITS_ANONYMOUS   0x0006
 916 #define SLAP_LIMITS_USERS       0x0007
 917         regex_t lm_dn_regex;            /* regex data for REGEX */
 918
 919         /*
 920          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
 921          * pattern for REGEX; NULL for ANONYMOUS, USERS
 922          */
 923         struct berval lm_dn_pat;
 924
 925         struct slap_limits_set  lm_limits;
 926 };
 927
 928 /* temporary aliases */
 929 typedef BackendDB Backend;
 930 #define nbackends nBackendDB
 931 #define backends backendDB
 932
 933 struct slap_backend_db {
 934         BackendInfo     *bd_info;       /* pointer to shared backend info */
 935
 936         /* BackendInfo accessors */
 937 #define         be_config       bd_info->bi_db_config
 938 #define         be_type         bd_info->bi_type
 939
 940 #define         be_bind         bd_info->bi_op_bind
 941 #define         be_unbind       bd_info->bi_op_unbind
 942 #define         be_add          bd_info->bi_op_add
 943 #define         be_compare      bd_info->bi_op_compare
 944 #define         be_delete       bd_info->bi_op_delete
 945 #define         be_modify       bd_info->bi_op_modify
 946 #define         be_modrdn       bd_info->bi_op_modrdn
 947 #define         be_search       bd_info->bi_op_search
 948
 949 #define         be_extended     bd_info->bi_extended
 950
 951 #define         be_release      bd_info->bi_entry_release_rw
 952 #define         be_chk_referrals        bd_info->bi_chk_referrals
 953 #define         be_group        bd_info->bi_acl_group
 954 #define         be_attribute    bd_info->bi_acl_attribute
 955 #define         be_operational  bd_info->bi_operational
 956
 957 #define         be_controls     bd_info->bi_controls
 958
 959 #define         be_connection_init      bd_info->bi_connection_init
 960 #define         be_connection_destroy   bd_info->bi_connection_destroy
 961
 962 #ifdef SLAPD_TOOLS
 963 #define         be_entry_open bd_info->bi_tool_entry_open
 964 #define         be_entry_close bd_info->bi_tool_entry_close
 965 #define         be_entry_first bd_info->bi_tool_entry_first
 966 #define         be_entry_next bd_info->bi_tool_entry_next
 967 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
 968 #define         be_entry_get bd_info->bi_tool_entry_get
 969 #define         be_entry_put bd_info->bi_tool_entry_put
 970 #define         be_sync bd_info->bi_tool_sync
 971 #endif
 972
 973         slap_mask_t     be_restrictops;         /* restriction operations */
 974 #define SLAP_RESTRICT_OP_ADD            0x0001U
 975 #define SLAP_RESTRICT_OP_BIND           0x0002U
 976 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
 977 #define SLAP_RESTRICT_OP_DELETE         0x0008U
 978 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
 979 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
 980 #define SLAP_RESTRICT_OP_RENAME         0x0040U
 981 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
 982
 983 #define SLAP_RESTRICT_OP_READS  \
 984         ( SLAP_RESTRICT_OP_COMPARE    \
 985         | SLAP_RESTRICT_OP_SEARCH )
 986 #define SLAP_RESTRICT_OP_WRITES \
 987         ( SLAP_RESTRICT_OP_ADD    \
 988         | SLAP_RESTRICT_OP_DELETE \
 989         | SLAP_RESTRICT_OP_MODIFY \
 990         | SLAP_RESTRICT_OP_RENAME )
 991
 992 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
 993 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
 994 #define SLAP_ALLOW_BIND_ANON_DN         0x0003U /* dn should be empty */
 995
 996 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
 997 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
 998 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
 999
1000 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1001 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1002
1003         slap_mask_t     be_requires;    /* pre-operation requirements */
1004 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1005 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1006 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1007 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1008 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1009
1010         /* Required Security Strength Factor */
1011         slap_ssf_set_t be_ssf_set;
1012
1013         /* these should be renamed from be_ to bd_ */
1014         struct berval **be_suffix;      /* the DN suffixes of data in this backend */
1015         struct berval **be_nsuffix;     /* the normalized DN suffixes in this backend */
1016         struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1017         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1018         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1019         struct berval be_rootpw;        /* the magic "root" password for this db        */
1020         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
1021 #define be_sizelimit    be_def_limit.lms_s_soft
1022 #define be_timelimit    be_def_limit.lms_t_soft
1023         struct slap_limits_set be_def_limit; /* default limits */
1024         struct slap_limits **be_limits; /* regex-based size and time limits */
1025         AccessControl *be_acl;  /* access control list for this backend    */
1026         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1027         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1028         char    *be_replogfile; /* replication log file (in master)        */
1029         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1030         BVarray be_update_refs; /* where to refer modifying clients to */
1031         char    *be_realm;
1032         int     be_lastmod;     /* keep track of lastmodified{by,time}     */
1033
1034 #define SLAP_GLUE_INSTANCE      0x01    /* a glue backend */
1035 #define SLAP_GLUE_SUBORDINATE   0x02    /* child of a glue hierarchy */
1036 #define SLAP_GLUE_LINKED        0x04    /* child is connected to parent */
1037
1038         int     be_glueflags;   /* */
1039         void    *be_private;    /* anything the backend database needs     */
1040 };
1041
1042 struct slap_conn;
1043 struct slap_op;
1044
1045 /* Backend function typedefs */
1046 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1047 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1048         const char *fname, int lineno,
1049         int argc, char **argv));
1050 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1051 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1052 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1053
1054 typedef int (BI_db_init) LDAP_P((Backend *bd));
1055 typedef int (BI_db_config) LDAP_P((Backend *bd,
1056         const char *fname, int lineno,
1057         int argc, char **argv));
1058 typedef int (BI_db_open) LDAP_P((Backend *bd));
1059 typedef int (BI_db_close) LDAP_P((Backend *bd));
1060 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1061
1062 typedef int (BI_op_bind)  LDAP_P(( BackendDB *bd,
1063                 struct slap_conn *c, struct slap_op *o,
1064                 struct berval *dn, struct berval *ndn, int method,
1065                 struct berval *cred, struct berval *edn ));
1066 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1067                 struct slap_conn *c, struct slap_op *o ));
1068 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1069                 struct slap_conn *c, struct slap_op *o,
1070                 struct berval *base, struct berval *nbase,
1071                 int scope, int deref,
1072                 int slimit, int tlimit,
1073                 Filter *f, struct berval *filterstr,
1074                 AttributeName *attrs, int attrsonly));
1075 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1076                 struct slap_conn *c, struct slap_op *o,
1077                 struct berval *dn, struct berval *ndn,
1078                 AttributeAssertion *ava));
1079 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1080                 struct slap_conn *c, struct slap_op *o,
1081                 struct berval *dn, struct berval *ndn,
1082                 Modifications *m));
1083 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1084                 struct slap_conn *c, struct slap_op *o,
1085                 struct berval *dn, struct berval *ndn,
1086                 struct berval *newrdn, struct berval *nnewrdn,
1087                 int deleteoldrdn,
1088                 struct berval *newSup, struct berval *nnewSup ));
1089 typedef int (BI_op_add)    LDAP_P((BackendDB *bd,
1090                 struct slap_conn *c, struct slap_op *o,
1091                 Entry *e));
1092 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1093                 struct slap_conn *c, struct slap_op *o,
1094                 struct berval *dn, struct berval *ndn));
1095 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1096                 struct slap_conn *c, struct slap_op *o,
1097                 ber_int_t msgid));
1098
1099 typedef int (BI_op_extended) LDAP_P((
1100     BackendDB           *be,
1101     struct slap_conn    *conn,
1102     struct slap_op              *op,
1103         const char              *reqoid,
1104     struct berval * reqdata,
1105         char            **rspoid,
1106     struct berval ** rspdata,
1107         LDAPControl *** rspctrls,
1108         const char **   text,
1109         BVarray *refs ));
1110
1111 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1112                 struct slap_conn *c, struct slap_op *o,
1113                 Entry *e, int rw));
1114
1115 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1116                 struct slap_conn *c, struct slap_op *o,
1117                 struct berval *dn, struct berval *ndn,
1118                 const char **text ));
1119
1120 typedef int (BI_acl_group)  LDAP_P((Backend *bd,
1121                 struct slap_conn *c, struct slap_op *o,
1122                 Entry *e,
1123                 struct berval *bdn,
1124                 struct berval *edn,
1125                 ObjectClass *group_oc,
1126                 AttributeDescription *group_at ));
1127
1128 typedef int (BI_acl_attribute)  LDAP_P((Backend *bd,
1129                 struct slap_conn *c, struct slap_op *o,
1130                 Entry *e, struct berval *edn,
1131                 AttributeDescription *entry_at,
1132                 BVarray *vals ));
1133
1134 typedef int (BI_operational)  LDAP_P((Backend *bd,
1135                 struct slap_conn *c, struct slap_op *o,
1136                 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1137
1138 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1139                 struct slap_conn *c));
1140 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1141                 struct slap_conn *c));
1142
1143 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1144 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1145 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1146 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1147 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1148 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1149 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1150 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1151
1152 struct slap_backend_info {
1153         char    *bi_type;       /* type of backend */
1154
1155         /*
1156          * per backend type routines:
1157          * bi_init: called to allocate a backend_info structure,
1158          *              called once BEFORE configuration file is read.
1159          *              bi_init() initializes this structure hence is
1160          *              called directly from be_initialize()
1161          * bi_config: called per 'backend' specific option
1162          *              all such options must before any 'database' options
1163          *              bi_config() is called only from read_config()
1164          * bi_open: called to open each database, called
1165          *              once AFTER configuration file is read but
1166          *              BEFORE any bi_db_open() calls.
1167          *              bi_open() is called from backend_startup()
1168          * bi_close: called to close each database, called
1169          *              once during shutdown after all bi_db_close calls.
1170          *              bi_close() is called from backend_shutdown()
1171          * bi_destroy: called to destroy each database, called
1172          *              once during shutdown after all bi_db_destroy calls.
1173          *              bi_destory() is called from backend_destroy()
1174          */
1175         BI_init *bi_init;
1176         BI_config       *bi_config;
1177         BI_open *bi_open;
1178         BI_close        *bi_close;
1179         BI_destroy      *bi_destroy;
1180
1181         /*
1182          * per database routines:
1183          * bi_db_init: called to initialize each database,
1184          *      called upon reading 'database <type>'
1185          *      called only from backend_db_init()
1186          * bi_db_config: called to configure each database,
1187          *  called per database to handle per database options
1188          *      called only from read_config()
1189          * bi_db_open: called to open each database
1190          *      called once per database immediately AFTER bi_open()
1191          *      calls but before daemon startup.
1192          *  called only by backend_startup()
1193          * bi_db_close: called to close each database
1194          *      called once per database during shutdown but BEFORE
1195          *  any bi_close call.
1196          *  called only by backend_shutdown()
1197          * bi_db_destroy: called to destroy each database
1198          *  called once per database during shutdown AFTER all
1199          *  bi_close calls but before bi_destory calls.
1200          *  called only by backend_destory()
1201          */
1202         BI_db_init      *bi_db_init;
1203         BI_db_config    *bi_db_config;
1204         BI_db_open      *bi_db_open;
1205         BI_db_close     *bi_db_close;
1206         BI_db_destroy   *bi_db_destroy;
1207
1208         /* LDAP Operations Handling Routines */
1209         BI_op_bind      *bi_op_bind;
1210         BI_op_unbind    *bi_op_unbind;
1211         BI_op_search    *bi_op_search;
1212         BI_op_compare   *bi_op_compare;
1213         BI_op_modify    *bi_op_modify;
1214         BI_op_modrdn    *bi_op_modrdn;
1215         BI_op_add       *bi_op_add;
1216         BI_op_delete    *bi_op_delete;
1217         BI_op_abandon   *bi_op_abandon;
1218
1219         /* Extended Operations Helper */
1220         BI_op_extended  *bi_extended;
1221
1222         /* Auxilary Functions */
1223         BI_entry_release_rw     *bi_entry_release_rw;
1224         BI_chk_referrals        *bi_chk_referrals;
1225
1226         BI_acl_group    *bi_acl_group;
1227         BI_acl_attribute        *bi_acl_attribute;
1228
1229         BI_operational  *bi_operational;
1230
1231         BI_connection_init      *bi_connection_init;
1232         BI_connection_destroy   *bi_connection_destroy;
1233
1234         /* hooks for slap tools */
1235         BI_tool_entry_open      *bi_tool_entry_open;
1236         BI_tool_entry_close     *bi_tool_entry_close;
1237         BI_tool_entry_first     *bi_tool_entry_first;
1238         BI_tool_entry_next      *bi_tool_entry_next;
1239         BI_tool_entry_get       *bi_tool_entry_get;
1240         BI_tool_entry_put       *bi_tool_entry_put;
1241         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1242         BI_tool_sync            *bi_tool_sync;
1243
1244 #define SLAP_INDEX_ADD_OP               0x0001
1245 #define SLAP_INDEX_DELETE_OP    0x0002
1246
1247         char **bi_controls;             /* supported controls */
1248
1249         unsigned int bi_nDB;    /* number of databases of this type */
1250         void    *bi_private;    /* anything the backend type needs */
1251 };
1252
1253 #define c_authtype      c_authz.sai_method
1254 #define c_authmech      c_authz.sai_mech
1255 #define c_dn            c_authz.sai_dn
1256 #define c_ndn           c_authz.sai_ndn
1257 #define c_ssf                   c_authz.sai_ssf
1258 #define c_transport_ssf c_authz.sai_transport_ssf
1259 #define c_tls_ssf               c_authz.sai_tls_ssf
1260 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1261
1262 #define o_authtype      o_authz.sai_method
1263 #define o_authmech      o_authz.sai_mech
1264 #define o_dn            o_authz.sai_dn
1265 #define o_ndn           o_authz.sai_ndn
1266 #define o_ssf                   o_authz.sai_ssf
1267 #define o_transport_ssf o_authz.sai_transport_ssf
1268 #define o_tls_ssf               o_authz.sai_tls_ssf
1269 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1270
1271 struct slap_op;
1272 struct slap_conn;
1273
1274 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1275         ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1276         BVarray, const char *, struct berval *,
1277         struct berval *, LDAPControl ** );
1278
1279 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1280         ber_int_t, const char *, const char *, BVarray,
1281         LDAPControl **, int nentries);
1282
1283 /*
1284  * represents an operation pending from an ldap client
1285  */
1286 typedef struct slap_op {
1287         ber_int_t       o_opid;         /* id of this operation           */
1288         ber_int_t       o_msgid;        /* msgid of the request           */
1289 #ifdef LDAP_CONNECTIONLESS
1290         Sockaddr        o_peeraddr;     /* UDP peer address               */
1291 #endif
1292
1293         ldap_pvt_thread_t       o_tid;  /* thread handling this op        */
1294
1295         BerElement      *o_ber;         /* ber of the request             */
1296
1297         ber_tag_t       o_tag;          /* tag of the request             */
1298         time_t          o_time;         /* time op was initiated          */
1299
1300         AuthorizationInformation o_authz;
1301
1302         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1303
1304         LDAPControl     **o_ctrls;       /* controls */
1305
1306         unsigned long   o_connid; /* id of conn initiating this op  */
1307
1308         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
1309         int             o_abandon;      /* abandon flag */
1310         slap_response   *o_response;    /* callback function */
1311         slap_sresult    *o_sresult;     /* search result callback */
1312
1313         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1314         void    *o_private;     /* anything the backend needs     */
1315         void    *o_glue;        /* for the glue backend */
1316 } Operation;
1317
1318 /*
1319  * Caches the result of a backend_group check for ACL evaluation
1320  */
1321 typedef struct slap_gacl {
1322         struct slap_gacl *next;
1323         Backend *be;
1324         ObjectClass *oc;
1325         AttributeDescription *at;
1326         int res;
1327         ber_len_t len;
1328         char ndn[1];
1329 } GroupAssertion;
1330
1331 /*
1332  * represents a connection from an ldap client
1333  */
1334 typedef struct slap_conn {
1335         int                     c_struct_state; /* structure management state */
1336         int                     c_conn_state;   /* connection state */
1337
1338         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1339         Sockbuf         *c_sb;                  /* ber connection stuff           */
1340
1341         /* only can be changed by connect_init */
1342         time_t          c_starttime;    /* when the connection was opened */
1343         time_t          c_activitytime; /* when the connection was last used */
1344         unsigned long           c_connid;       /* id of this connection for stats*/
1345
1346         char            *c_listener_url;        /* listener URL */
1347         char            *c_peer_domain; /* DNS name of client */
1348         char            *c_peer_name;   /* peer name (trans=addr:port) */
1349         char            *c_sock_name;   /* sock name (trans=addr:port) */
1350
1351         /* only can be changed by binding thread */
1352         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1353         char    *c_sasl_bind_mech;                      /* mech in progress */
1354         struct berval   c_cdn;
1355
1356         /* authentication backend */
1357         Backend *c_authc_backend;
1358
1359         /* authorization backend - normally same as c_authc_backend */
1360         Backend *c_authz_backend;
1361
1362         AuthorizationInformation c_authz;
1363         GroupAssertion *c_groups;
1364
1365         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1366
1367         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
1368         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
1369
1370         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1371         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1372
1373         BerElement      *c_currentber;  /* ber we're attempting to read */
1374         int             c_writewaiter;  /* true if writer is waiting */
1375
1376 #ifdef LDAP_CONNECTIONLESS
1377         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
1378 #endif
1379 #ifdef HAVE_TLS
1380         int     c_is_tls;               /* true if this LDAP over raw TLS */
1381         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1382 #endif
1383         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1384         void    *c_sasl_context;        /* SASL session context */
1385         void    *c_sasl_extra;          /* SASL session extra stuff */
1386
1387         long    c_n_ops_received;               /* num of ops received (next op_id) */
1388         long    c_n_ops_executing;      /* num of ops currently executing */
1389         long    c_n_ops_pending;                /* num of ops pending execution */
1390         long    c_n_ops_completed;      /* num of ops completed */
1391
1392         long    c_n_get;                /* num of get calls */
1393         long    c_n_read;               /* num of read calls */
1394         long    c_n_write;              /* num of write calls */
1395 } Connection;
1396
1397 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1398 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1399         do { \
1400                 if ( ldap_debug & (level) ) \
1401                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1402                 if ( ldap_syslog & (level) ) \
1403                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1404                                 (arg2), (arg3) ); \
1405         } while (0)
1406 #else
1407 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1408 #endif
1409
1410
1411 #define SASLREGEX_REPLACE 10
1412 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1413 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1414
1415 typedef struct sasl_regexp {
1416   char *match;                            /* regexp match pattern */
1417   char *replace;                          /* regexp replace pattern */
1418   regex_t workspace;                      /* workspace for regexp engine */
1419   regmatch_t strings[SASLREGEX_REPLACE];  /* strings matching $1,$2 ... */
1420   int offset[SASLREGEX_REPLACE+2];        /* offsets of $1,$2... in *replace */
1421 } SaslRegexp_t;
1422
1423 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1424 #define FLAG_GETDN_FINAL   1
1425 #define FLAG_GETDN_AUTHCID 2
1426 #define FLAG_GETDN_AUTHZID 4
1427
1428 LDAP_END_DECL
1429
1430 #include "proto-slap.h"
1431
1432 #endif /* _SLAP_H_ */