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