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