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