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