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