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