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