git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

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