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