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