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