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

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