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