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_WORKER_THREADS         (32)
  62
  63 #define SLAP_TEXT_BUFLEN (256)
  64
  65 /* psuedo error code indicating abandoned operation */
  66 #define SLAPD_ABANDON (-1)
  67
  68 /* psuedo error code indicating disconnect */
  69 #define SLAPD_DISCONNECT (-2)
  70
  71
  72 /* We assume "C" locale, that is US-ASCII */
  73 #define ASCII_SPACE(c)  ( (c) == ' ' )
  74 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
  75 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
  76 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
  77 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
  78 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
  79 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
  80
  81 #define SLAP_NIBBLE(c) ((c)&0x0f)
  82 #define SLAP_ESCAPE_CHAR ('\\')
  83 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
  84 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
  85
  86 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
  87         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
  88
  89 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
  90 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
  91 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(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         AttributeDescription *si_ad_supportedFeatures;
 454
 455         /* subschema subentry attribute descriptions */
 456         AttributeDescription *si_ad_objectClasses;
 457         AttributeDescription *si_ad_attributeTypes;
 458         AttributeDescription *si_ad_ldapSyntaxes;
 459         AttributeDescription *si_ad_matchingRules;
 460         AttributeDescription *si_ad_matchingRulesUse;
 461
 462         /* Aliases & Referrals */
 463         AttributeDescription *si_ad_aliasedObjectName;
 464         AttributeDescription *si_ad_ref;
 465
 466         /* Access Control Internals */
 467         AttributeDescription *si_ad_entry;
 468         AttributeDescription *si_ad_children;
 469 #ifdef SLAPD_ACI_ENABLED
 470         AttributeDescription *si_ad_aci;
 471 #endif
 472
 473         /* Other attributes descriptions */
 474         AttributeDescription *si_ad_userPassword;
 475         AttributeDescription *si_ad_authPassword;
 476 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 477         AttributeDescription *si_ad_krbName;
 478 #endif
 479
 480         /* Undefined Attribute Type */
 481         AttributeType   *si_at_undefined;
 482 };
 483
 484 typedef struct slap_attr_assertion {
 485         AttributeDescription    *aa_desc;
 486         struct berval *aa_value;
 487 } AttributeAssertion;
 488
 489 typedef struct slap_ss_assertion {
 490         AttributeDescription    *sa_desc;
 491         struct berval                   *sa_initial;
 492         struct berval                   **sa_any;
 493         struct berval                   *sa_final;
 494 } SubstringsAssertion;
 495
 496 typedef struct slap_mr_assertion {
 497         MatchingRule                            *ma_rule;       /* optional */
 498         char                                    *ma_rule_text;  /* optional */
 499         AttributeDescription    *ma_desc;       /* optional */
 500         int                                             ma_dnattrs; /* boolean */
 501         struct berval                   *ma_value;      /* required */
 502 } MatchingRuleAssertion;
 503
 504
 505 /*
 506  * represents a search filter
 507  */
 508 typedef struct slap_filter {
 509         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 510 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 511 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 512 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 513
 514
 515         union f_un_u {
 516                 /* precomputed result */
 517                 ber_int_t f_un_result;
 518
 519                 /* DN */
 520                 char *f_un_dn;
 521
 522                 /* present */
 523                 AttributeDescription *f_un_desc;
 524
 525                 /* simple value assertion */
 526                 AttributeAssertion *f_un_ava;
 527
 528                 /* substring assertion */
 529                 SubstringsAssertion *f_un_ssa;
 530
 531                 /* matching rule assertion */
 532                 MatchingRuleAssertion *f_un_mra;
 533
 534 #define f_dn                    f_un.f_un_dn
 535 #define f_desc                  f_un.f_un_desc
 536 #define f_ava                   f_un.f_un_ava
 537 #define f_av_desc               f_un.f_un_ava->aa_desc
 538 #define f_av_value              f_un.f_un_ava->aa_value
 539 #define f_sub                   f_un.f_un_ssa
 540 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 541 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 542 #define f_sub_any               f_un.f_un_ssa->sa_any
 543 #define f_sub_final             f_un.f_un_ssa->sa_final
 544 #define f_mra                   f_un.f_un_mra
 545 #define f_mr_rule               f_un.f_un_mra->ma_rule
 546 #define f_mr_rule_text          f_un.f_un_mra->ma_rule_text
 547 #define f_mr_desc               f_un.f_un_mra->ma_desc
 548 #define f_mr_value              f_un.f_un_mra->ma_value
 549 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 550
 551                 /* and, or, not */
 552                 struct slap_filter *f_un_complex;
 553         } f_un;
 554
 555 #define f_result        f_un.f_un_result
 556 #define f_and           f_un.f_un_complex
 557 #define f_or            f_un.f_un_complex
 558 #define f_not           f_un.f_un_complex
 559 #define f_list          f_un.f_un_complex
 560
 561         struct slap_filter      *f_next;
 562 } Filter;
 563
 564 /* compare routines can return undefined */
 565 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 566
 567 /*
 568  * represents an attribute (description + values)
 569  */
 570 typedef struct slap_attr {
 571         AttributeDescription *a_desc;
 572         struct berval   **a_vals;
 573         struct slap_attr        *a_next;
 574 } Attribute;
 575
 576
 577 /*
 578  * the id used in the indexes to refer to an entry
 579  */
 580 typedef unsigned long   ID;
 581 #define NOID    ((ID)~0)
 582
 583 /*
 584  * represents an entry in core
 585  */
 586 typedef struct slap_entry {
 587         /*
 588          * The ID field should only be changed before entry is
 589          * inserted into a cache.  The ID value is backend
 590          * specific.
 591          */
 592         ID              e_id;
 593
 594         char            *e_dn;          /* DN of this entry */
 595         char            *e_ndn;         /* normalized DN of this entry */
 596         Attribute       *e_attrs;       /* list of attributes + values */
 597
 598         /* for use by the backend for any purpose */
 599         void*   e_private;
 600 } Entry;
 601
 602 /*
 603  * A list of LDAPMods
 604  */
 605 typedef struct slap_mod {
 606         int sm_op;
 607         AttributeDescription *sm_desc;
 608         struct berval **sm_bvalues;
 609 } Modification;
 610
 611 typedef struct slap_mod_list {
 612         Modification sml_mod;
 613 #define sml_op          sml_mod.sm_op
 614 #define sml_desc        sml_mod.sm_desc
 615 #define sml_bvalues     sml_mod.sm_bvalues
 616         struct slap_mod_list *sml_next;
 617 } Modifications;
 618
 619 typedef struct slap_ldap_modlist {
 620         LDAPMod ml_mod;
 621         struct slap_ldap_modlist *ml_next;
 622 #define ml_op           ml_mod.mod_op
 623 #define ml_type         ml_mod.mod_type
 624 #define ml_values       ml_mod.mod_values
 625 #define ml_bvalues      ml_mod.mod_bvalues
 626 } LDAPModList;
 627
 628 /*
 629  * represents an access control list
 630  */
 631 typedef enum slap_access_e {
 632         ACL_INVALID_ACCESS = -1,
 633         ACL_NONE = 0,
 634         ACL_AUTH,
 635         ACL_COMPARE,
 636         ACL_SEARCH,
 637         ACL_READ,
 638         ACL_WRITE
 639 } slap_access_t;
 640
 641 typedef enum slap_control_e {
 642         ACL_INVALID_CONTROL     = 0,
 643         ACL_STOP,
 644         ACL_CONTINUE,
 645         ACL_BREAK
 646 } slap_control_t;
 647
 648 typedef enum slap_style_e {
 649         ACL_STYLE_REGEX = 0,
 650         ACL_STYLE_BASE,
 651         ACL_STYLE_ONE,
 652         ACL_STYLE_SUBTREE,
 653         ACL_STYLE_CHILDREN,
 654         ACL_STYLE_ATTROF,
 655
 656         /* alternate names */
 657         ACL_STYLE_EXACT = ACL_STYLE_BASE
 658 } slap_style_t;
 659
 660 typedef struct slap_authz_info {
 661         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
 662         char *          sai_mech;               /* SASL Mechanism */
 663         char *          sai_dn;                 /* DN for reporting purposes */
 664         char *          sai_ndn;                /* Normalized DN */
 665
 666         /* Security Strength Factors */
 667         slap_ssf_t      sai_ssf;                        /* Overall SSF */
 668         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
 669         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
 670         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
 671 } AuthorizationInformation;
 672
 673 /* the "by" part */
 674 typedef struct slap_access {
 675         slap_control_t a_type;
 676
 677 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
 678
 679 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
 680 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
 681 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
 682 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
 683 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
 684 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
 685
 686 #define ACL_PRIV_MASK                   0x00ffUL
 687
 688 /* priv flags */
 689 #define ACL_PRIV_LEVEL                  0x1000UL
 690 #define ACL_PRIV_ADDITIVE               0x2000UL
 691 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
 692
 693 /* invalid privs */
 694 #define ACL_PRIV_INVALID                0x0UL
 695
 696 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
 697 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
 698 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
 699 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
 700
 701 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
 702 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
 703
 704 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
 705
 706 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
 707
 708 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
 709 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
 710 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
 711
 712 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
 713 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
 714 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
 715 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
 716 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
 717 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
 718
 719 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
 720 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
 721 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
 722 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
 723 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
 724 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
 725 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
 726
 727 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
 728 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
 729 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
 730 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
 731 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
 732 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
 733
 734         slap_mask_t     a_access_mask;
 735
 736         AuthorizationInformation        a_authz;
 737 #define a_dn_pat        a_authz.sai_dn
 738
 739         slap_style_t a_dn_style;
 740         AttributeDescription    *a_dn_at;
 741         int                     a_dn_self;
 742
 743         slap_style_t a_peername_style;
 744         char            *a_peername_pat;
 745         slap_style_t a_sockname_style;
 746         char            *a_sockname_pat;
 747
 748         slap_style_t a_domain_style;
 749         char            *a_domain_pat;
 750         slap_style_t a_sockurl_style;
 751         char            *a_sockurl_pat;
 752         slap_style_t a_set_style;
 753         char            *a_set_pat;
 754
 755 #ifdef SLAPD_ACI_ENABLED
 756         AttributeDescription    *a_aci_at;
 757 #endif
 758
 759         /* ACL Groups */
 760         slap_style_t a_group_style;
 761         char            *a_group_pat;
 762         ObjectClass                             *a_group_oc;
 763         AttributeDescription    *a_group_at;
 764
 765         struct slap_access      *a_next;
 766 } Access;
 767
 768 /* the "to" part */
 769 typedef struct slap_acl {
 770         /* "to" part: the entries this acl applies to */
 771         Filter          *acl_filter;
 772         slap_style_t acl_dn_style;
 773         regex_t         acl_dn_re;
 774         char            *acl_dn_pat;
 775         char            **acl_attrs;
 776
 777         /* "by" part: list of who has what access to the entries */
 778         Access  *acl_access;
 779
 780         struct slap_acl *acl_next;
 781 } AccessControl;
 782
 783 /*
 784  * replog moddn param structure
 785  */
 786 struct replog_moddn {
 787         char *newrdn;
 788         int     deloldrdn;
 789         char *newsup;
 790 };
 791
 792 /*
 793  * Backend-info
 794  * represents a backend
 795  */
 796
 797 typedef struct slap_backend_info BackendInfo;   /* per backend type */
 798 typedef struct slap_backend_db BackendDB;               /* per backend database */
 799
 800 LDAP_SLAPD_F (int) nBackendInfo;
 801 LDAP_SLAPD_F (int) nBackendDB;
 802 LDAP_SLAPD_F (BackendInfo       *) backendInfo;
 803 LDAP_SLAPD_F (BackendDB *) backendDB;
 804
 805 LDAP_SLAPD_F (int) slapMode;
 806 #define SLAP_UNDEFINED_MODE     0x0000
 807 #define SLAP_SERVER_MODE        0x0001
 808 #define SLAP_TOOL_MODE          0x0002
 809 #define SLAP_MODE                       0x0003
 810
 811 #define SLAP_TRUNCATE_MODE      0x0100
 812
 813 struct slap_replica_info {
 814         char   *ri_host;        /* supersedes be_replica */
 815         char  **ri_nsuffix;     /* array of suffixes this replica accepts */
 816 };
 817
 818 struct slap_limits_set {
 819         /* time limits */
 820         int     lms_t_soft;
 821         int     lms_t_hard;
 822
 823         /* size limits */
 824         int     lms_s_soft;
 825         int     lms_s_hard;
 826         int     lms_s_unchecked;
 827 };
 828
 829 struct slap_limits {
 830         int     lm_type;        /* type of pattern */
 831 #define SLAP_LIMITS_UNDEFINED   0x0000
 832 #define SLAP_LIMITS_EXACT       0x0001
 833 #define SLAP_LIMITS_REGEX       0x0002
 834         regex_t lm_dn_regex;    /* regex-based size and time limits */
 835         char   *lm_dn_pat;      /* ndn for EXACT; pattern for REGEX */
 836         struct slap_limits_set  lm_limits;
 837 };
 838
 839 /* temporary aliases */
 840 typedef BackendDB Backend;
 841 #define nbackends nBackendDB
 842 #define backends backendDB
 843
 844 struct slap_backend_db {
 845         BackendInfo     *bd_info;       /* pointer to shared backend info */
 846
 847         /* BackendInfo accessors */
 848 #define         be_config       bd_info->bi_db_config
 849 #define         be_type         bd_info->bi_type
 850
 851 #define         be_bind         bd_info->bi_op_bind
 852 #define         be_unbind       bd_info->bi_op_unbind
 853 #define         be_add          bd_info->bi_op_add
 854 #define         be_compare      bd_info->bi_op_compare
 855 #define         be_delete       bd_info->bi_op_delete
 856 #define         be_modify       bd_info->bi_op_modify
 857 #define         be_modrdn       bd_info->bi_op_modrdn
 858 #define         be_search       bd_info->bi_op_search
 859
 860 #define         be_extended     bd_info->bi_extended
 861
 862 #define         be_release      bd_info->bi_entry_release_rw
 863 #define         be_chk_referrals        bd_info->bi_chk_referrals
 864 #define         be_group        bd_info->bi_acl_group
 865 #define         be_attribute    bd_info->bi_acl_attribute
 866
 867 #define         be_controls     bd_info->bi_controls
 868
 869 #define         be_connection_init      bd_info->bi_connection_init
 870 #define         be_connection_destroy   bd_info->bi_connection_destroy
 871
 872 #ifdef SLAPD_TOOLS
 873 #define         be_entry_open bd_info->bi_tool_entry_open
 874 #define         be_entry_close bd_info->bi_tool_entry_close
 875 #define         be_entry_first bd_info->bi_tool_entry_first
 876 #define         be_entry_next bd_info->bi_tool_entry_next
 877 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
 878 #define         be_entry_get bd_info->bi_tool_entry_get
 879 #define         be_entry_put bd_info->bi_tool_entry_put
 880 #define         be_sync bd_info->bi_tool_sync
 881 #endif
 882
 883         slap_mask_t     be_restrictops;         /* restriction operations */
 884 #define SLAP_RESTRICT_OP_ADD            0x0001U
 885 #define SLAP_RESTRICT_OP_BIND           0x0002U
 886 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
 887 #define SLAP_RESTRICT_OP_DELETE         0x0008U
 888 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
 889 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
 890 #define SLAP_RESTRICT_OP_RENAME         0x0040U
 891 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
 892
 893 #define SLAP_RESTRICT_OP_READS  \
 894         ( SLAP_RESTRICT_OP_COMPARE    \
 895         | SLAP_RESTRICT_OP_SEARCH )
 896 #define SLAP_RESTRICT_OP_WRITES \
 897         ( SLAP_RESTRICT_OP_ADD    \
 898         | SLAP_RESTRICT_OP_DELETE \
 899         | SLAP_RESTRICT_OP_MODIFY \
 900         | SLAP_RESTRICT_OP_RENAME )
 901
 902 #define SLAP_ALLOW_TLS_2_ANON   0x0001U /* StartTLS -> Anonymous */
 903
 904 #define SLAP_DISALLOW_BIND_V2   0x0001U /* LDAPv2 bind */
 905 #define SLAP_DISALLOW_BIND_ANON 0x0002U /* no anonymous */
 906 #define SLAP_DISALLOW_BIND_ANON_CRED \
 907                                                                 0x0004U /* cred should be empty */
 908 #define SLAP_DISALLOW_BIND_ANON_DN \
 909                                                                 0x0008U /* dn should be empty */
 910
 911 #define SLAP_DISALLOW_BIND_SIMPLE       0x0010U /* simple authentication */
 912 #define SLAP_DISALLOW_BIND_KRBV4        0x0020U /* Kerberos V4 authentication */
 913
 914 #define SLAP_DISALLOW_TLS_AUTHC 0x0100U /* TLS while authenticated */
 915
 916         slap_mask_t     be_requires;    /* pre-operation requirements */
 917 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
 918 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
 919 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
 920 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
 921 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
 922
 923         /* Required Security Strength Factor */
 924         slap_ssf_set_t be_ssf_set;
 925
 926         /* these should be renamed from be_ to bd_ */
 927         char    **be_suffix;    /* the DN suffixes of data in this backend */
 928         char    **be_nsuffix;   /* the normalized DN suffixes in this backend */
 929         char    **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
 930         char    *be_root_dn;    /* the magic "root" dn for this db      */
 931         char    *be_root_ndn;   /* the magic "root" normalized dn for this db   */
 932         struct berval be_root_pw;       /* the magic "root" password for this db        */
 933         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
 934 #define be_sizelimit    be_def_limit.lms_s_soft
 935 #define be_timelimit    be_def_limit.lms_t_soft
 936         struct slap_limits_set be_def_limit; /* default limits */
 937         struct slap_limits **be_limits; /* regex-based size and time limits */
 938         AccessControl *be_acl;  /* access control list for this backend    */
 939         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
 940         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
 941         char    *be_replogfile; /* replication log file (in master)        */
 942         char    *be_update_ndn; /* allowed to make changes (in replicas) */
 943         struct berval **be_update_refs; /* where to refer modifying clients to */
 944         int     be_lastmod;     /* keep track of lastmodified{by,time}     */
 945
 946         char    *be_realm;
 947
 948         void    *be_private;    /* anything the backend database needs     */
 949 };
 950
 951 struct slap_conn;
 952 struct slap_op;
 953
 954 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
 955     BackendDB           *be,
 956     struct slap_conn    *conn,
 957     struct slap_op              *op,
 958         const char              *reqoid,
 959     struct berval * reqdata,
 960         char            **rspoid,
 961     struct berval ** rspdata,
 962         LDAPControl *** rspctrls,
 963         const char **   text,
 964         struct berval *** refs ));
 965
 966 struct slap_backend_info {
 967         char    *bi_type;       /* type of backend */
 968
 969         /*
 970          * per backend type routines:
 971          * bi_init: called to allocate a backend_info structure,
 972          *              called once BEFORE configuration file is read.
 973          *              bi_init() initializes this structure hence is
 974          *              called directly from be_initialize()
 975          * bi_config: called per 'backend' specific option
 976          *              all such options must before any 'database' options
 977          *              bi_config() is called only from read_config()
 978          * bi_open: called to open each database, called
 979          *              once AFTER configuration file is read but
 980          *              BEFORE any bi_db_open() calls.
 981          *              bi_open() is called from backend_startup()
 982          * bi_close: called to close each database, called
 983          *              once during shutdown after all bi_db_close calls.
 984          *              bi_close() is called from backend_shutdown()
 985          * bi_destroy: called to destroy each database, called
 986          *              once during shutdown after all bi_db_destroy calls.
 987          *              bi_destory() is called from backend_destroy()
 988          */
 989         int (*bi_init)  LDAP_P((BackendInfo *bi));
 990         int     (*bi_config) LDAP_P((BackendInfo *bi,
 991                 const char *fname, int lineno, int argc, char **argv ));
 992         int (*bi_open) LDAP_P((BackendInfo *bi));
 993         int (*bi_close) LDAP_P((BackendInfo *bi));
 994         int (*bi_destroy) LDAP_P((BackendInfo *bi));
 995
 996         /*
 997          * per database routines:
 998          * bi_db_init: called to initialize each database,
 999          *      called upon reading 'database <type>'
1000          *      called only from backend_db_init()
1001          * bi_db_config: called to configure each database,
1002          *  called per database to handle per database options
1003          *      called only from read_config()
1004          * bi_db_open: called to open each database
1005          *      called once per database immediately AFTER bi_open()
1006          *      calls but before daemon startup.
1007          *  called only by backend_startup()
1008          * bi_db_close: called to close each database
1009          *      called once per database during shutdown but BEFORE
1010          *  any bi_close call.
1011          *  called only by backend_shutdown()
1012          * bi_db_destroy: called to destroy each database
1013          *  called once per database during shutdown AFTER all
1014          *  bi_close calls but before bi_destory calls.
1015          *  called only by backend_destory()
1016          */
1017         int (*bi_db_init) LDAP_P((Backend *bd));
1018         int     (*bi_db_config) LDAP_P((Backend *bd,
1019                 const char *fname, int lineno, int argc, char **argv ));
1020         int (*bi_db_open) LDAP_P((Backend *bd));
1021         int (*bi_db_close) LDAP_P((Backend *bd));
1022         int (*bi_db_destroy) LDAP_P((Backend *db));
1023
1024         /* LDAP Operations Handling Routines */
1025         int     (*bi_op_bind)  LDAP_P(( BackendDB *bd,
1026                 struct slap_conn *c, struct slap_op *o,
1027                 const char *dn, const char *ndn, int method,
1028                 struct berval *cred, char** edn ));
1029         int (*bi_op_unbind) LDAP_P((BackendDB *bd,
1030                 struct slap_conn *c, struct slap_op *o ));
1031         int     (*bi_op_search) LDAP_P((BackendDB *bd,
1032                 struct slap_conn *c, struct slap_op *o,
1033                 const char *base, const char *nbase,
1034                 int scope, int deref,
1035                 int slimit, int tlimit,
1036                 Filter *f, const char *filterstr,
1037                 char **attrs, int attrsonly));
1038         int     (*bi_op_compare)LDAP_P((BackendDB *bd,
1039                 struct slap_conn *c, struct slap_op *o,
1040                 const char *dn, const char *ndn,
1041                 AttributeAssertion *ava));
1042         int     (*bi_op_modify) LDAP_P((BackendDB *bd,
1043                 struct slap_conn *c, struct slap_op *o,
1044                 const char *dn, const char *ndn, Modifications *m));
1045         int     (*bi_op_modrdn) LDAP_P((BackendDB *bd,
1046                 struct slap_conn *c, struct slap_op *o,
1047                 const char *dn, const char *ndn,
1048                 const char *newrdn, int deleteoldrdn,
1049                 const char *newSuperior));
1050         int     (*bi_op_add)    LDAP_P((BackendDB *bd,
1051                 struct slap_conn *c, struct slap_op *o,
1052                 Entry *e));
1053         int     (*bi_op_delete) LDAP_P((BackendDB *bd,
1054                 struct slap_conn *c, struct slap_op *o,
1055                 const char *dn, const char *ndn));
1056         int     (*bi_op_abandon) LDAP_P((BackendDB *bd,
1057                 struct slap_conn *c, struct slap_op *o,
1058                 ber_int_t msgid));
1059
1060         /* Extended Operations Helper */
1061         SLAP_EXTENDED_FN bi_extended;
1062
1063         /* Auxilary Functions */
1064         int     (*bi_entry_release_rw) LDAP_P((BackendDB *bd,
1065                 struct slap_conn *c, struct slap_op *o,
1066                 Entry *e, int rw));
1067
1068         int     (*bi_chk_referrals) LDAP_P((BackendDB *bd,
1069                 struct slap_conn *c, struct slap_op *o,
1070                 const char *dn, const char *ndn,
1071                 const char **text ));
1072
1073         int     (*bi_acl_group)  LDAP_P((Backend *bd,
1074                 struct slap_conn *c, struct slap_op *o,
1075                 Entry *e, const char *bdn, const char *edn,
1076                 ObjectClass *group_oc,
1077                 AttributeDescription *group_at ));
1078         int     (*bi_acl_attribute)  LDAP_P((Backend *bd,
1079                 struct slap_conn *c, struct slap_op *o,
1080                 Entry *e, const char *edn,
1081                 AttributeDescription *entry_at,
1082                 struct berval ***vals ));
1083
1084         int     (*bi_connection_init) LDAP_P((BackendDB *bd,
1085                 struct slap_conn *c));
1086         int     (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1087                 struct slap_conn *c));
1088
1089         /* hooks for slap tools */
1090         int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1091         int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1092         ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1093         ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1094         Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1095         ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1096         int (*bi_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1097         int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1098
1099 #define SLAP_INDEX_ADD_OP               0x0001
1100 #define SLAP_INDEX_DELETE_OP    0x0002
1101
1102         char **bi_controls;             /* supported controls */
1103
1104         unsigned int bi_nDB;    /* number of databases of this type */
1105         void    *bi_private;    /* anything the backend type needs */
1106 };
1107
1108 #define c_authtype      c_authz.sai_method
1109 #define c_authmech      c_authz.sai_mech
1110 #define c_dn            c_authz.sai_dn
1111 #define c_ssf                   c_authz.sai_ssf
1112 #define c_transport_ssf c_authz.sai_transport_ssf
1113 #define c_tls_ssf               c_authz.sai_tls_ssf
1114 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1115
1116 #define o_authtype      o_authz.sai_method
1117 #define o_authmech      o_authz.sai_mech
1118 #define o_dn            o_authz.sai_dn
1119 #define o_ndn           o_authz.sai_ndn
1120 #define o_ssf                   o_authz.sai_ssf
1121 #define o_transport_ssf o_authz.sai_transport_ssf
1122 #define o_tls_ssf               o_authz.sai_tls_ssf
1123 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1124
1125 /*
1126  * represents an operation pending from an ldap client
1127  */
1128 typedef struct slap_op {
1129         ber_int_t       o_opid;         /* id of this operation           */
1130         ber_int_t       o_msgid;        /* msgid of the request           */
1131
1132         ldap_pvt_thread_t       o_tid;  /* thread handling this op        */
1133
1134         BerElement      *o_ber;         /* ber of the request             */
1135
1136         ber_tag_t       o_tag;          /* tag of the request             */
1137         time_t          o_time;         /* time op was initiated          */
1138
1139         AuthorizationInformation o_authz;
1140
1141         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1142
1143         LDAPControl     **o_ctrls;       /* controls */
1144
1145         unsigned long   o_connid; /* id of conn initiating this op  */
1146
1147         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
1148         int             o_abandon;      /* abandon flag */
1149
1150         struct slap_op  *o_next;        /* next operation in list         */
1151         void    *o_private;     /* anything the backend needs     */
1152 } Operation;
1153
1154 /*
1155  * represents a connection from an ldap client
1156  */
1157 typedef struct slap_conn {
1158         int                     c_struct_state; /* structure management state */
1159         int                     c_conn_state;   /* connection state */
1160
1161         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1162         Sockbuf         *c_sb;                  /* ber connection stuff           */
1163
1164         /* only can be changed by connect_init */
1165         time_t          c_starttime;    /* when the connection was opened */
1166         time_t          c_activitytime; /* when the connection was last used */
1167         unsigned long           c_connid;       /* id of this connection for stats*/
1168
1169         char            *c_listener_url;        /* listener URL */
1170         char            *c_peer_domain; /* DNS name of client */
1171         char            *c_peer_name;   /* peer name (trans=addr:port) */
1172         char            *c_sock_name;   /* sock name (trans=addr:port) */
1173
1174         /* only can be changed by binding thread */
1175         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1176         char    *c_sasl_bind_mech;                      /* mech in progress */
1177         char    *c_cdn;
1178
1179         /* authentication backend */
1180         Backend *c_authc_backend;
1181
1182         /* authorization backend - normally same as c_authc_backend */
1183         Backend *c_authz_backend;
1184
1185         AuthorizationInformation c_authz;
1186
1187         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1188
1189         Operation       *c_ops;                 /* list of operations being processed */
1190         Operation       *c_pending_ops; /* list of pending operations */
1191
1192         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1193         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1194
1195         BerElement      *c_currentber;  /* ber we're attempting to read */
1196         int             c_writewaiter;  /* true if writer is waiting */
1197
1198 #ifdef HAVE_TLS
1199         int     c_is_tls;               /* true if this LDAP over raw TLS */
1200         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1201 #endif
1202         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1203         void    *c_sasl_context;        /* SASL session context */
1204         void    *c_sasl_extra;          /* SASL session extra stuff */
1205
1206         long    c_n_ops_received;               /* num of ops received (next op_id) */
1207         long    c_n_ops_executing;      /* num of ops currently executing */
1208         long    c_n_ops_pending;                /* num of ops pending execution */
1209         long    c_n_ops_completed;      /* num of ops completed */
1210
1211         long    c_n_get;                /* num of get calls */
1212         long    c_n_read;               /* num of read calls */
1213         long    c_n_write;              /* num of write calls */
1214 } Connection;
1215
1216 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1217 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1218         do { \
1219                 if ( ldap_debug & (level) ) \
1220                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1221                 if ( ldap_syslog & (level) ) \
1222                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1223                                 (arg2), (arg3) ); \
1224         } while (0)
1225 #else
1226 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1227 #endif
1228
1229
1230 #define SASLREGEX_REPLACE 10
1231 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1232 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1233
1234 typedef struct sasl_regexp {
1235   char *match;                            /* regexp match pattern */
1236   char *replace;                          /* regexp replace pattern */
1237   regex_t workspace;                      /* workspace for regexp engine */
1238   regmatch_t strings[SASLREGEX_REPLACE];  /* strings matching $1,$2 ... */
1239   int offset[SASLREGEX_REPLACE+2];        /* offsets of $1,$2... in *replace */
1240 } SaslRegexp_t;
1241
1242 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1243 #define FLAG_GETDN_FINAL   1
1244 #define FLAG_GETDN_AUTHCID 2
1245 #define FLAG_GETDN_AUTHZID 4
1246
1247
1248 LDAP_END_DECL
1249
1250 #include "proto-slap.h"
1251
1252 #endif /* _SLAP_H_ */