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

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