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

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