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