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