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