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