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