1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
13 #include <ac/stdlib.h>
15 #include <sys/types.h>
16 #include <ac/syslog.h>
18 #include <ac/socket.h>
22 #ifdef HAVE_CYRUS_SASL
29 #define ldap_debug slap_debug
36 #include <ldap_schema.h>
38 #include "ldap_pvt_thread.h"
43 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
44 #define SLAPD_ANONYMOUS "<anonymous>"
47 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
50 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
52 * This is a value used internally by the backends. It is needed to allow
53 * adding values that already exist without getting an error as required by
54 * modrdn when the new rdn was already an attribute value itself.
55 * JCG 05/1999 (gomez@engr.sgi.com)
57 #define SLAP_MOD_SOFTADD 0x1000
63 #define MAXREMATCHES 10
66 /* psuedo error code indicating abandoned operation */
67 #define SLAPD_ABANDON (-1)
69 /* psuedo error code indicating disconnect */
70 #define SLAPD_DISCONNECT (-2)
73 /* We assume "C" locale, that is US-ASCII */
74 #define ASCII_SPACE(c) ( (c) == ' ' )
75 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
76 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
77 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
78 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
79 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
81 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
82 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
83 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
85 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
86 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
87 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
88 #define OID_SEPARATOR(c) ( (c) == '.' )
89 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
91 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
92 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
94 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
95 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
97 /* must match in schema_init.c */
98 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
99 #define SLAPD_GROUP_ATTR "member"
100 #define SLAPD_GROUP_CLASS "groupOfNames"
101 #define SLAPD_ROLE_ATTR "roleOccupant"
102 #define SLAPD_ROLE_CLASS "organizationalRole"
104 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
105 #define SLAPD_ACI_ATTR "OpenLDAPaci"
107 #define SLAPD_TOP_OID "2.5.6.0"
109 LDAP_SLAPD_F (int) slap_debug;
114 #define SLAP_INDEX_TYPE 0x00FFUL
115 #define SLAP_INDEX_UNDEFINED 0x0001UL
116 #define SLAP_INDEX_PRESENT 0x0002UL
117 #define SLAP_INDEX_EQUALITY 0x0004UL
118 #define SLAP_INDEX_APPROX 0x0008UL
119 #define SLAP_INDEX_SUBSTR 0x0010UL
120 #define SLAP_INDEX_EXTENDED 0x0020UL
122 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
124 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
126 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
128 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
129 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
130 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
131 #define SLAP_INDEX_SUBSTR_DEFAULT ( SLAP_INDEX_SUBSTR \
132 | SLAP_INDEX_SUBSTR_INITIAL | SLAP_INDEX_SUBSTR_FINAL )
134 #define SLAP_INDEX_SUBSTR_INITIAL_MIN_LEN 2
135 #define SLAP_INDEX_SUBSTR_INITIAL_MAX_LEN 4
136 #define SLAP_INDEX_SUBSTR_FINAL_MIN_LEN 2
137 #define SLAP_INDEX_SUBSTR_FINAL_MAX_LEN 4
139 #define SLAP_INDEX_FLAGS 0xF000UL
140 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
141 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
142 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
143 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
145 typedef long slap_index;
148 * there is a single index for each attribute. these prefixes ensure
149 * that there is no collision among keys.
151 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
152 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
153 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
154 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
155 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
157 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
158 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
159 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
162 * represents schema information for a database
164 #define SLAP_SCHERR_OUTOFMEM 1
165 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
166 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
167 #define SLAP_SCHERR_DUP_CLASS 4
168 #define SLAP_SCHERR_DUP_ATTR 5
169 #define SLAP_SCHERR_DUP_SYNTAX 6
170 #define SLAP_SCHERR_DUP_RULE 7
171 #define SLAP_SCHERR_NO_NAME 8
172 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
173 #define SLAP_SCHERR_MR_NOT_FOUND 10
174 #define SLAP_SCHERR_SYN_NOT_FOUND 11
175 #define SLAP_SCHERR_MR_INCOMPLETE 12
177 typedef struct slap_oid_macro {
178 struct berval som_oid;
180 struct slap_oid_macro *som_next;
183 /* forward declarations */
185 struct slap_matching_rule;
187 typedef int slap_syntax_validate_func LDAP_P((
188 struct slap_syntax *syntax,
189 struct berval * in));
191 typedef int slap_syntax_transform_func LDAP_P((
192 struct slap_syntax *syntax,
194 struct berval ** out));
196 typedef struct slap_syntax {
197 LDAP_SYNTAX ssyn_syn;
198 #define ssyn_oid ssyn_syn.syn_oid
199 #define ssyn_desc ssyn_syn.syn_desc
200 #define ssyn_extensions ssyn_syn.syn_extensions
204 #define SLAP_SYNTAX_NONE 0x00U
205 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
206 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
207 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
208 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
210 slap_syntax_validate_func *ssyn_validate;
211 slap_syntax_transform_func *ssyn_normalize;
212 slap_syntax_transform_func *ssyn_pretty;
214 #ifdef SLAPD_BINARY_CONVERSION
215 /* convert to and from binary */
216 slap_syntax_transform_func *ssyn_ber2str;
217 slap_syntax_transform_func *ssyn_str2ber;
220 struct slap_syntax *ssyn_next;
223 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
224 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
225 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
226 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
227 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
229 /* XXX -> UCS-2 Converter */
230 typedef int slap_mr_convert_func LDAP_P((
232 struct berval ** out ));
235 typedef int slap_mr_normalize_func LDAP_P((
237 struct slap_syntax *syntax, /* NULL if in is asserted value */
238 struct slap_matching_rule *mr,
240 struct berval ** out ));
242 /* Match (compare) function */
243 typedef int slap_mr_match_func LDAP_P((
246 struct slap_syntax *syntax, /* syntax of stored value */
247 struct slap_matching_rule *mr,
248 struct berval * value,
249 void * assertValue ));
251 /* Index generation function */
252 typedef int slap_mr_indexer_func LDAP_P((
254 struct slap_syntax *syntax, /* syntax of stored value */
255 struct slap_matching_rule *mr,
256 struct berval *prefix,
257 struct berval **values,
258 struct berval ***keys ));
260 /* Filter index function */
261 typedef int slap_mr_filter_func LDAP_P((
263 struct slap_syntax *syntax, /* syntax of stored value */
264 struct slap_matching_rule *mr,
265 struct berval *prefix,
267 struct berval ***keys ));
269 typedef struct slap_matching_rule {
270 LDAP_MATCHING_RULE smr_mrule;
273 #define SLAP_MR_TYPE_MASK 0xFF00U
274 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
276 #define SLAP_MR_NONE 0x0000U
277 #define SLAP_MR_EQUALITY 0x0100U
278 #define SLAP_MR_ORDERING 0x0200U
279 #define SLAP_MR_SUBSTR 0x0400U
280 #define SLAP_MR_EXT 0x0800U
282 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
284 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
285 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
286 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
289 slap_mr_convert_func *smr_convert;
290 slap_mr_normalize_func *smr_normalize;
291 slap_mr_match_func *smr_match;
292 slap_mr_indexer_func *smr_indexer;
293 slap_mr_filter_func *smr_filter;
294 struct slap_matching_rule *smr_next;
295 #define smr_oid smr_mrule.mr_oid
296 #define smr_names smr_mrule.mr_names
297 #define smr_desc smr_mrule.mr_desc
298 #define smr_obsolete smr_mrule.mr_obsolete
299 #define smr_syntax_oid smr_mrule.mr_syntax_oid
300 #define smr_extensions smr_mrule.mr_extensions
303 typedef struct slap_attribute_type {
305 LDAP_ATTRIBUTE_TYPE sat_atype;
306 struct slap_attribute_type *sat_sup;
307 struct slap_attribute_type **sat_subtypes;
308 MatchingRule *sat_equality;
309 MatchingRule *sat_approx;
310 MatchingRule *sat_ordering;
311 MatchingRule *sat_substr;
313 struct slap_attribute_type *sat_next;
314 #define sat_oid sat_atype.at_oid
315 #define sat_names sat_atype.at_names
316 #define sat_desc sat_atype.at_desc
317 #define sat_obsolete sat_atype.at_obsolete
318 #define sat_sup_oid sat_atype.at_sup_oid
319 #define sat_equality_oid sat_atype.at_equality_oid
320 #define sat_ordering_oid sat_atype.at_ordering_oid
321 #define sat_substr_oid sat_atype.at_substr_oid
322 #define sat_syntax_oid sat_atype.at_syntax_oid
323 #define sat_single_value sat_atype.at_single_value
324 #define sat_collective sat_atype.at_collective
325 #define sat_no_user_mod sat_atype.at_no_user_mod
326 #define sat_usage sat_atype.at_usage
327 #define sat_extensions sat_atype.at_extensions
330 #define is_at_operational(at) ((at)->sat_usage)
331 #define is_at_single_value(at) ((at)->sat_single_value)
332 #define is_at_collective(at) ((at)->sat_collective)
333 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
335 typedef struct slap_object_class {
336 LDAP_OBJECT_CLASS soc_oclass;
337 struct slap_object_class **soc_sups;
338 AttributeType **soc_required;
339 AttributeType **soc_allowed;
340 struct slap_object_class *soc_next;
341 #define soc_oid soc_oclass.oc_oid
342 #define soc_names soc_oclass.oc_names
343 #define soc_desc soc_oclass.oc_desc
344 #define soc_obsolete soc_oclass.oc_obsolete
345 #define soc_sup_oids soc_oclass.oc_sup_oids
346 #define soc_kind soc_oclass.oc_kind
347 #define soc_at_oids_must soc_oclass.oc_at_oids_must
348 #define soc_at_oids_may soc_oclass.oc_at_oids_may
349 #define soc_extensions soc_oclass.oc_extensions
354 * represents a recognized attribute description ( type + options )
356 typedef struct slap_attr_desc {
357 struct berval *ad_cname; /* canonical name */
358 AttributeType *ad_type; /* NULL if unknown */
359 char *ad_lang; /* NULL if no language tags */
361 #define SLAP_DESC_NONE 0x0U
362 #define SLAP_DESC_BINARY 0x1U
363 } AttributeDescription;
365 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
366 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
369 * pointers to schema elements used internally
371 struct slap_internal_schema {
373 ObjectClass *si_oc_top;
374 ObjectClass *si_oc_extensibleObject;
375 ObjectClass *si_oc_alias;
376 ObjectClass *si_oc_referral;
377 ObjectClass *si_oc_subentry;
378 ObjectClass *si_oc_subschema;
379 ObjectClass *si_oc_rootdse;
381 /* objectClass attribute */
382 AttributeDescription *si_ad_objectClass;
384 /* operational attributes */
385 AttributeDescription *si_ad_creatorsName;
386 AttributeDescription *si_ad_createTimestamp;
387 AttributeDescription *si_ad_modifiersName;
388 AttributeDescription *si_ad_modifyTimestamp;
389 AttributeDescription *si_ad_subschemaSubentry;
391 /* root DSE attributes */
392 AttributeDescription *si_ad_namingContexts;
393 AttributeDescription *si_ad_supportedControl;
394 AttributeDescription *si_ad_supportedExtension;
395 AttributeDescription *si_ad_supportedLDAPVersion;
396 AttributeDescription *si_ad_supportedSASLMechanisms;
398 /* subschema subentry attributes */
399 AttributeDescription *si_ad_objectClasses;
400 AttributeDescription *si_ad_attributeTypes;
401 AttributeDescription *si_ad_ldapSyntaxes;
402 AttributeDescription *si_ad_matchingRules;
403 AttributeDescription *si_ad_matchingRulesUse;
405 /* Aliases & Referrals */
406 AttributeDescription *si_ad_aliasedObjectName;
407 AttributeDescription *si_ad_ref;
409 /* Access Control Internals */
410 AttributeDescription *si_ad_entry;
411 AttributeDescription *si_ad_children;
412 #ifdef SLAPD_ACI_ENABLED
413 AttributeDescription *si_ad_aci;
417 AttributeDescription *si_ad_userPassword;
418 AttributeDescription *si_ad_authPassword;
419 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
420 AttributeDescription *si_ad_krbName;
424 typedef struct slap_attr_assertion {
425 AttributeDescription *aa_desc;
426 struct berval *aa_value;
427 } AttributeAssertion;
429 typedef struct slap_ss_assertion {
430 AttributeDescription *sa_desc;
431 struct berval *sa_initial;
432 struct berval **sa_any;
433 struct berval *sa_final;
434 } SubstringsAssertion;
436 typedef struct slap_mr_assertion {
437 char *ma_rule; /* optional */
438 AttributeDescription *ma_desc; /* optional */
439 int ma_dnattrs; /* boolean */
440 struct berval *ma_value; /* required */
441 } MatchingRuleAssertion;
445 * represents a search filter
448 typedef struct slap_filter {
449 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
450 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
451 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
452 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
456 /* precomputed result */
457 ber_int_t f_un_result;
463 AttributeDescription *f_un_desc;
465 /* simple value assertion */
466 AttributeAssertion *f_un_ava;
468 /* substring assertion */
469 SubstringsAssertion *f_un_ssa;
471 /* matching rule assertion */
472 MatchingRuleAssertion *f_un_mra;
474 #define f_dn f_un.f_un_dn
475 #define f_desc f_un.f_un_desc
476 #define f_ava f_un.f_un_ava
477 #define f_av_desc f_un.f_un_ava->aa_desc
478 #define f_av_value f_un.f_un_ava->aa_value
479 #define f_sub f_un.f_un_ssa
480 #define f_sub_desc f_un.f_un_ssa->sa_desc
481 #define f_sub_initial f_un.f_un_ssa->sa_initial
482 #define f_sub_any f_un.f_un_ssa->sa_any
483 #define f_sub_final f_un.f_un_ssa->sa_final
484 #define f_mra f_un.f_un_mra
485 #define f_mr_rule f_un.f_un_mra->ma_rule
486 #define f_mr_desc f_un.f_un_mra->ma_desc
487 #define f_mr_value f_un.f_un_mra->ma_value
488 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
491 struct slap_filter *f_un_complex;
494 #define f_result f_un.f_un_result
495 #define f_and f_un.f_un_complex
496 #define f_or f_un.f_un_complex
497 #define f_not f_un.f_un_complex
498 #define f_list f_un.f_un_complex
500 struct slap_filter *f_next;
503 /* compare routines can return undefined */
504 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
507 * represents an attribute (description + values)
509 typedef struct slap_attr {
510 AttributeDescription *a_desc;
511 struct berval **a_vals;
512 struct slap_attr *a_next;
517 * the id used in the indexes to refer to an entry
519 typedef unsigned long ID;
520 #define NOID ((ID)~0)
523 * represents an entry in core
525 typedef struct slap_entry {
527 * The ID field should only be changed before entry is
528 * inserted into a cache. The ID value is backend
533 char *e_dn; /* DN of this entry */
534 char *e_ndn; /* normalized DN of this entry */
535 Attribute *e_attrs; /* list of attributes + values */
537 /* for use by the backend for any purpose */
544 typedef struct slap_mod {
546 AttributeDescription *sm_desc;
547 struct berval **sm_bvalues;
550 typedef struct slap_mod_list {
551 Modification sml_mod;
552 #define sml_op sml_mod.sm_op
553 #define sml_desc sml_mod.sm_desc
554 #define sml_bvalues sml_mod.sm_bvalues
555 struct slap_mod_list *sml_next;
558 typedef struct slap_ldap_modlist {
560 struct slap_ldap_modlist *ml_next;
561 #define ml_op ml_mod.mod_op
562 #define ml_type ml_mod.mod_type
563 #define ml_values ml_mod.mod_values
564 #define ml_bvalues ml_mod.mod_bvalues
568 * represents an access control list
571 typedef enum slap_access_e {
572 ACL_INVALID_ACCESS = -1,
581 typedef enum slap_control_e {
582 ACL_INVALID_CONTROL = 0,
588 typedef enum slap_style_e {
596 typedef unsigned long slap_access_mask_t;
599 typedef struct slap_access {
600 slap_control_t a_type;
602 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
604 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
605 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
606 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
607 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
608 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
609 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
611 #define ACL_PRIV_MASK 0x00ffUL
614 #define ACL_PRIV_LEVEL 0x1000UL
615 #define ACL_PRIV_ADDITIVE 0x2000UL
616 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
619 #define ACL_PRIV_INVALID 0x0UL
621 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
622 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
623 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
624 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
626 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
627 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
629 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
631 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
633 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
634 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
635 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
637 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
638 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
639 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
640 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
641 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
642 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
644 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
645 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
646 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
647 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
648 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
649 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
650 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
652 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
653 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
654 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
655 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
656 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
657 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
659 slap_access_mask_t a_mask;
661 slap_style_t a_dn_style;
663 AttributeDescription *a_dn_at;
666 slap_style_t a_peername_style;
667 char *a_peername_pat;
668 slap_style_t a_sockname_style;
669 char *a_sockname_pat;
671 slap_style_t a_domain_style;
673 slap_style_t a_sockurl_style;
676 #ifdef SLAPD_ACI_ENABLED
677 AttributeDescription *a_aci_at;
681 slap_style_t a_group_style;
683 ObjectClass *a_group_oc;
684 AttributeDescription *a_group_at;
686 struct slap_access *a_next;
690 typedef struct slap_acl {
691 /* "to" part: the entries this acl applies to */
693 slap_style_t acl_dn_style;
698 /* "by" part: list of who has what access to the entries */
701 struct slap_acl *acl_next;
705 * replog moddn param structure
707 struct replog_moddn {
715 * represents a backend
718 typedef struct slap_backend_info BackendInfo; /* per backend type */
719 typedef struct slap_backend_db BackendDB; /* per backend database */
721 LDAP_SLAPD_F (int) nBackendInfo;
722 LDAP_SLAPD_F (int) nBackendDB;
723 LDAP_SLAPD_F (BackendInfo *) backendInfo;
724 LDAP_SLAPD_F (BackendDB *) backendDB;
726 LDAP_SLAPD_F (int) slapMode;
727 #define SLAP_UNDEFINED_MODE 0x0000
728 #define SLAP_SERVER_MODE 0x0001
729 #define SLAP_TOOL_MODE 0x0002
730 #define SLAP_MODE 0x0003
732 #define SLAP_TRUNCATE_MODE 0x0100
734 /* temporary aliases */
735 typedef BackendDB Backend;
736 #define nbackends nBackendDB
737 #define backends backendDB
739 struct slap_backend_db {
740 BackendInfo *bd_info; /* pointer to shared backend info */
742 /* BackendInfo accessors */
743 #define be_config bd_info->bi_db_config
744 #define be_type bd_info->bi_type
746 #define be_bind bd_info->bi_op_bind
747 #define be_unbind bd_info->bi_op_unbind
748 #define be_add bd_info->bi_op_add
749 #define be_compare bd_info->bi_op_compare
750 #define be_delete bd_info->bi_op_delete
751 #define be_modify bd_info->bi_op_modify
752 #define be_modrdn bd_info->bi_op_modrdn
753 #define be_search bd_info->bi_op_search
755 #define be_extended bd_info->bi_extended
757 #define be_release bd_info->bi_entry_release_rw
758 #define be_chk_referrals bd_info->bi_chk_referrals
759 #define be_group bd_info->bi_acl_group
760 #define be_attribute bd_info->bi_acl_attribute
762 #define be_controls bd_info->bi_controls
764 #define be_connection_init bd_info->bi_connection_init
765 #define be_connection_destroy bd_info->bi_connection_destroy
768 #define be_entry_open bd_info->bi_tool_entry_open
769 #define be_entry_close bd_info->bi_tool_entry_close
770 #define be_entry_first bd_info->bi_tool_entry_first
771 #define be_entry_next bd_info->bi_tool_entry_next
772 #define be_entry_get bd_info->bi_tool_entry_get
773 #define be_entry_put bd_info->bi_tool_entry_put
774 #define be_index_attr bd_info->bi_tool_index_attr
775 #define be_index_change bd_info->bi_tool_index_change
776 #define be_sync bd_info->bi_tool_sync
779 #ifdef HAVE_CYRUS_SASL
780 #define be_sasl_authorize bd_info->bi_sasl_authorize
781 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
782 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
785 /* these should be renamed from be_ to bd_ */
786 char **be_suffix; /* the DN suffixes of data in this backend */
787 char **be_nsuffix; /* the normalized DN suffixes in this backend */
788 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
789 char *be_root_dn; /* the magic "root" dn for this db */
790 char *be_root_ndn; /* the magic "root" normalized dn for this db */
791 struct berval be_root_pw; /* the magic "root" password for this db */
792 int be_readonly; /* 1 => db is in "read only" mode */
793 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
794 int be_sizelimit; /* size limit for this backend */
795 int be_timelimit; /* time limit for this backend */
796 AccessControl *be_acl; /* access control list for this backend */
797 slap_access_t be_dfltaccess; /* access given if no acl matches */
798 char **be_replica; /* replicas of this backend (in master) */
799 char *be_replogfile; /* replication log file (in master) */
800 char *be_update_ndn; /* allowed to make changes (in replicas) */
801 struct berval **be_update_refs; /* where to refer modifying clients to */
802 int be_lastmod; /* keep track of lastmodified{by,time} */
806 void *be_private; /* anything the backend database needs */
812 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
814 struct slap_conn *conn,
817 struct berval * reqdata,
819 struct berval ** rspdata,
820 LDAPControl *** rspctrls,
822 struct berval *** refs ));
824 struct slap_backend_info {
825 char *bi_type; /* type of backend */
828 * per backend type routines:
829 * bi_init: called to allocate a backend_info structure,
830 * called once BEFORE configuration file is read.
831 * bi_init() initializes this structure hence is
832 * called directly from be_initialize()
833 * bi_config: called per 'backend' specific option
834 * all such options must before any 'database' options
835 * bi_config() is called only from read_config()
836 * bi_open: called to open each database, called
837 * once AFTER configuration file is read but
838 * BEFORE any bi_db_open() calls.
839 * bi_open() is called from backend_startup()
840 * bi_close: called to close each database, called
841 * once during shutdown after all bi_db_close calls.
842 * bi_close() is called from backend_shutdown()
843 * bi_destroy: called to destroy each database, called
844 * once during shutdown after all bi_db_destroy calls.
845 * bi_destory() is called from backend_destroy()
847 int (*bi_init) LDAP_P((BackendInfo *bi));
848 int (*bi_config) LDAP_P((BackendInfo *bi,
849 const char *fname, int lineno, int argc, char **argv ));
850 int (*bi_open) LDAP_P((BackendInfo *bi));
851 int (*bi_close) LDAP_P((BackendInfo *bi));
852 int (*bi_destroy) LDAP_P((BackendInfo *bi));
855 * per database routines:
856 * bi_db_init: called to initialize each database,
857 * called upon reading 'database <type>'
858 * called only from backend_db_init()
859 * bi_db_config: called to configure each database,
860 * called per database to handle per database options
861 * called only from read_config()
862 * bi_db_open: called to open each database
863 * called once per database immediately AFTER bi_open()
864 * calls but before daemon startup.
865 * called only by backend_startup()
866 * bi_db_close: called to close each database
867 * called once per database during shutdown but BEFORE
869 * called only by backend_shutdown()
870 * bi_db_destroy: called to destroy each database
871 * called once per database during shutdown AFTER all
872 * bi_close calls but before bi_destory calls.
873 * called only by backend_destory()
875 int (*bi_db_init) LDAP_P((Backend *bd));
876 int (*bi_db_config) LDAP_P((Backend *bd,
877 const char *fname, int lineno, int argc, char **argv ));
878 int (*bi_db_open) LDAP_P((Backend *bd));
879 int (*bi_db_close) LDAP_P((Backend *bd));
880 int (*bi_db_destroy) LDAP_P((Backend *db));
882 /* LDAP Operations Handling Routines */
883 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
884 struct slap_conn *c, struct slap_op *o,
885 const char *dn, const char *ndn, int method,
886 struct berval *cred, char** edn ));
887 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
888 struct slap_conn *c, struct slap_op *o ));
889 int (*bi_op_search) LDAP_P((BackendDB *bd,
890 struct slap_conn *c, struct slap_op *o,
891 const char *base, const char *nbase,
892 int scope, int deref,
893 int slimit, int tlimit,
894 Filter *f, const char *filterstr,
895 char **attrs, int attrsonly));
896 int (*bi_op_compare)LDAP_P((BackendDB *bd,
897 struct slap_conn *c, struct slap_op *o,
898 const char *dn, const char *ndn,
899 AttributeAssertion *ava));
900 int (*bi_op_modify) LDAP_P((BackendDB *bd,
901 struct slap_conn *c, struct slap_op *o,
902 const char *dn, const char *ndn, Modifications *m));
903 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
904 struct slap_conn *c, struct slap_op *o,
905 const char *dn, const char *ndn,
906 const char *newrdn, int deleteoldrdn,
907 const char *newSuperior));
908 int (*bi_op_add) LDAP_P((BackendDB *bd,
909 struct slap_conn *c, struct slap_op *o,
911 int (*bi_op_delete) LDAP_P((BackendDB *bd,
912 struct slap_conn *c, struct slap_op *o,
913 const char *dn, const char *ndn));
914 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
915 struct slap_conn *c, struct slap_op *o,
918 /* Extended Operations Helper */
919 SLAP_EXTENDED_FN bi_extended;
921 /* Auxilary Functions */
922 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
924 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
925 struct slap_conn *c, struct slap_op *o,
926 const char *dn, const char *ndn,
927 const char **text ));
929 int (*bi_acl_group) LDAP_P((Backend *bd,
930 Entry *e, const char *bdn, const char *edn,
931 ObjectClass *group_oc,
932 AttributeDescription *group_at ));
933 int (*bi_acl_attribute) LDAP_P((Backend *bd,
934 struct slap_conn *c, struct slap_op *o,
935 Entry *e, const char *edn,
936 AttributeDescription *entry_at,
937 const char ***vals ));
939 int (*bi_connection_init) LDAP_P((BackendDB *bd,
940 struct slap_conn *c));
941 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
942 struct slap_conn *c));
944 /* hooks for slap tools */
945 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
946 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
947 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
948 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
949 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
950 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
951 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
952 AttributeDescription *desc ));
953 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
954 AttributeDescription *desc,
955 struct berval **bv, ID id, int op ));
956 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
958 #ifdef HAVE_CYRUS_SASL
959 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
960 const char *authnid, const char *authzid,
961 const char **canon_authzid, const char **errstr ));
962 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
963 const char *mechanism, const char *authzid,
964 const char *realm, sasl_secret_t **secret ));
965 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
966 const char *mechanism, const char *auth_identity,
967 const char *realm, const sasl_secret_t *secret ));
968 #endif /* HAVE_CYRUS_SASL */
970 #define SLAP_INDEX_ADD_OP 0x0001
971 #define SLAP_INDEX_DELETE_OP 0x0002
973 char **bi_controls; /* supported controls */
975 unsigned int bi_nDB; /* number of databases of this type */
976 void *bi_private; /* anything the backend type needs */
980 * represents an operation pending from an ldap client
983 typedef struct slap_op {
984 ber_int_t o_opid; /* id of this operation */
985 ber_int_t o_msgid; /* msgid of the request */
987 ldap_pvt_thread_t o_tid; /* thread handling this op */
989 BerElement *o_ber; /* ber of the request */
991 ber_tag_t o_tag; /* tag of the request */
992 time_t o_time; /* time op was initiated */
995 /* should only be used for reporting purposes */
996 char *o_authc_dn; /* authentication DN */
998 /* should be used as the DN of the User */
999 char *o_authz_dn; /* authorization DN */
1000 char *o_authz_ndn; /* authorizaiton NDN */
1003 char *o_dn; /* dn bound when op was initiated */
1004 char *o_ndn; /* normalized dn bound when op was initiated */
1007 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1008 ber_tag_t o_authtype; /* auth method used to bind dn */
1009 /* values taken from ldap.h */
1011 char *o_authmech; /* SASL mechanism used to bind dn */
1013 LDAPControl **o_ctrls; /* controls */
1015 unsigned long o_connid; /* id of conn initiating this op */
1017 #ifdef LDAP_CONNECTIONLESS
1018 int o_cldap; /* != 0 if this came in via CLDAP */
1019 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1020 char o_searchbase; /* search base if via CLDAP */
1023 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1024 int o_abandon; /* abandon flag */
1026 struct slap_op *o_next; /* next operation in list */
1027 void *o_private; /* anything the backend needs */
1031 * represents a connection from an ldap client
1034 typedef struct slap_conn {
1035 int c_struct_state; /* structure management state */
1036 int c_conn_state; /* connection state */
1038 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1039 Sockbuf *c_sb; /* ber connection stuff */
1041 /* only can be changed by connect_init */
1042 time_t c_starttime; /* when the connection was opened */
1043 time_t c_activitytime; /* when the connection was last used */
1044 unsigned long c_connid; /* id of this connection for stats*/
1046 char *c_listener_url; /* listener URL */
1047 char *c_peer_domain; /* DNS name of client */
1048 char *c_peer_name; /* peer name (trans=addr:port) */
1049 char *c_sock_name; /* sock name (trans=addr:port) */
1051 /* only can be changed by binding thread */
1052 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1053 char *c_sasl_bind_mech; /* mech in progress */
1054 #ifdef HAVE_CYRUS_SASL
1055 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1058 /* authentication backend */
1059 Backend *c_authc_backend;
1061 /* authorization backend - normally same as c_authc_backend */
1062 Backend *c_authz_backend;
1065 /* authentication backend */
1066 /* should only be used for reporting purposes */
1067 char *c_authc_dn; /* authentication DN */
1069 /* should be used as the DN of the User */
1070 char *c_authz_dn; /* authorization DN */
1071 char *c_authz_ndn; /* authorization NDN */
1074 char *c_cdn; /* DN provided by the client */
1075 char *c_dn; /* DN bound to this conn */
1078 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1079 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1080 char *c_authmech; /* SASL mechanism used to bind c_dn */
1082 Operation *c_ops; /* list of operations being processed */
1083 Operation *c_pending_ops; /* list of pending operations */
1085 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1086 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1088 BerElement *c_currentber; /* ber we're attempting to read */
1089 int c_writewaiter; /* true if writer is waiting */
1092 int c_is_tls; /* true if this LDAP over raw TLS */
1093 int c_needs_tls_accept; /* true if SSL_accept should be called */
1096 long c_n_ops_received; /* num of ops received (next op_id) */
1097 long c_n_ops_executing; /* num of ops currently executing */
1098 long c_n_ops_pending; /* num of ops pending execution */
1099 long c_n_ops_completed; /* num of ops completed */
1101 long c_n_get; /* num of get calls */
1102 long c_n_read; /* num of read calls */
1103 long c_n_write; /* num of write calls */
1106 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1107 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1109 if ( ldap_debug & (level) ) \
1110 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1111 if ( ldap_syslog & (level) ) \
1112 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1116 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1121 #include "proto-slap.h"
1123 #endif /* _SLAP_H_ */