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

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