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