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