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