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