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