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