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_CHAR(c) ( ASCII_DIGIT(c) || (c) == '.' )
90 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
91 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
93 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
94 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
96 /* must match in schema_init.c */
97 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
98 #define SLAPD_GROUP_ATTR "member"
99 #define SLAPD_GROUP_CLASS "groupOfNames"
100 #define SLAPD_ROLE_ATTR "roleOccupant"
101 #define SLAPD_ROLE_CLASS "organizationalRole"
103 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
104 #define SLAPD_ACI_ATTR "OpenLDAPaci"
106 #define SLAPD_TOP_OID "2.5.6.0"
108 LDAP_SLAPD_F (int) slap_debug;
113 #define SLAP_INDEX_TYPE 0x00FFUL
114 #define SLAP_INDEX_UNDEFINED 0x0001UL
115 #define SLAP_INDEX_PRESENT 0x0002UL
116 #define SLAP_INDEX_EQUALITY 0x0004UL
117 #define SLAP_INDEX_APPROX 0x0008UL
118 #define SLAP_INDEX_SUBSTR 0x0010UL
119 #define SLAP_INDEX_EXTENDED 0x0020UL
121 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
123 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
125 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
127 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
128 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
129 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
130 #define SLAP_INDEX_SUBSTR_DEFAULT ( SLAP_INDEX_SUBSTR \
131 | SLAP_INDEX_SUBSTR_INITIAL | SLAP_INDEX_SUBSTR_FINAL )
133 #define SLAP_INDEX_FLAGS 0xF000UL
134 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
135 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
136 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
137 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
139 typedef long slap_index;
142 * there is a single index for each attribute. these prefixes ensure
143 * that there is no collision among keys.
145 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
146 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
147 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
148 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
149 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
152 * represents schema information for a database
154 #define SLAP_SCHERR_OUTOFMEM 1
155 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
156 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
157 #define SLAP_SCHERR_DUP_CLASS 4
158 #define SLAP_SCHERR_DUP_ATTR 5
159 #define SLAP_SCHERR_DUP_SYNTAX 6
160 #define SLAP_SCHERR_DUP_RULE 7
161 #define SLAP_SCHERR_NO_NAME 8
162 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
163 #define SLAP_SCHERR_MR_NOT_FOUND 10
164 #define SLAP_SCHERR_SYN_NOT_FOUND 11
165 #define SLAP_SCHERR_MR_INCOMPLETE 12
167 typedef struct slap_oid_macro {
168 struct berval som_oid;
170 struct slap_oid_macro *som_next;
173 /* forward declarations */
175 struct slap_matching_rule;
177 typedef int slap_syntax_validate_func LDAP_P((
178 struct slap_syntax *syntax,
179 struct berval * in));
181 typedef int slap_syntax_transform_func LDAP_P((
182 struct slap_syntax *syntax,
184 struct berval ** out));
186 typedef struct slap_syntax {
187 LDAP_SYNTAX ssyn_syn;
188 #define ssyn_oid ssyn_syn.syn_oid
189 #define ssyn_desc ssyn_syn.syn_desc
190 #define ssyn_extensions ssyn_syn.syn_extensions
194 #define SLAP_SYNTAX_NONE 0x00U
195 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
196 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
197 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
198 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
200 slap_syntax_validate_func *ssyn_validate;
201 slap_syntax_transform_func *ssyn_normalize;
202 slap_syntax_transform_func *ssyn_pretty;
204 #ifdef SLAPD_BINARY_CONVERSION
205 /* convert to and from binary */
206 slap_syntax_transform_func *ssyn_ber2str;
207 slap_syntax_transform_func *ssyn_str2ber;
210 struct slap_syntax *ssyn_next;
213 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
214 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
215 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
216 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
217 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
219 /* XXX -> UCS-2 Converter */
220 typedef int slap_mr_convert_func LDAP_P((
222 struct berval ** out ));
225 typedef int slap_mr_normalize_func LDAP_P((
227 struct slap_syntax *syntax, /* NULL if in is asserted value */
228 struct slap_matching_rule *mr,
230 struct berval ** out ));
232 /* Match (compare) function */
233 typedef int slap_mr_match_func LDAP_P((
236 struct slap_syntax *syntax, /* syntax of stored value */
237 struct slap_matching_rule *mr,
238 struct berval * value,
239 void * assertValue ));
241 /* Index generation function */
242 typedef int slap_mr_indexer_func LDAP_P((
244 struct slap_syntax *syntax, /* syntax of stored value */
245 struct slap_matching_rule *mr,
246 struct berval *prefix,
247 struct berval **values,
248 struct berval ***keys ));
250 /* Filter index function */
251 typedef int slap_mr_filter_func LDAP_P((
253 struct slap_syntax *syntax, /* syntax of stored value */
254 struct slap_matching_rule *mr,
255 struct berval *prefix,
257 struct berval ***keys ));
259 typedef struct slap_matching_rule {
260 LDAP_MATCHING_RULE smr_mrule;
263 #define SLAP_MR_TYPE_MASK 0xFF00U
264 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
266 #define SLAP_MR_NONE 0x0000U
267 #define SLAP_MR_EQUALITY 0x0100U
268 #define SLAP_MR_ORDERING 0x0200U
269 #define SLAP_MR_SUBSTR 0x0400U
270 #define SLAP_MR_EXT 0x0800U
272 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
274 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
275 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
276 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
279 slap_mr_convert_func *smr_convert;
280 slap_mr_normalize_func *smr_normalize;
281 slap_mr_match_func *smr_match;
282 slap_mr_indexer_func *smr_indexer;
283 slap_mr_filter_func *smr_filter;
284 struct slap_matching_rule *smr_next;
285 #define smr_oid smr_mrule.mr_oid
286 #define smr_names smr_mrule.mr_names
287 #define smr_desc smr_mrule.mr_desc
288 #define smr_obsolete smr_mrule.mr_obsolete
289 #define smr_syntax_oid smr_mrule.mr_syntax_oid
290 #define smr_extensions smr_mrule.mr_extensions
293 typedef struct slap_attribute_type {
295 LDAP_ATTRIBUTE_TYPE sat_atype;
296 struct slap_attribute_type *sat_sup;
297 struct slap_attribute_type **sat_subtypes;
298 MatchingRule *sat_equality;
299 MatchingRule *sat_approx;
300 MatchingRule *sat_ordering;
301 MatchingRule *sat_substr;
303 struct slap_attribute_type *sat_next;
304 #define sat_oid sat_atype.at_oid
305 #define sat_names sat_atype.at_names
306 #define sat_desc sat_atype.at_desc
307 #define sat_obsolete sat_atype.at_obsolete
308 #define sat_sup_oid sat_atype.at_sup_oid
309 #define sat_equality_oid sat_atype.at_equality_oid
310 #define sat_ordering_oid sat_atype.at_ordering_oid
311 #define sat_substr_oid sat_atype.at_substr_oid
312 #define sat_syntax_oid sat_atype.at_syntax_oid
313 #define sat_single_value sat_atype.at_single_value
314 #define sat_collective sat_atype.at_collective
315 #define sat_no_user_mod sat_atype.at_no_user_mod
316 #define sat_usage sat_atype.at_usage
317 #define sat_extensions sat_atype.at_extensions
320 #define is_at_operational(at) ((at)->sat_usage)
321 #define is_at_single_value(at) ((at)->sat_single_value)
322 #define is_at_collective(at) ((at)->sat_collective)
323 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
325 typedef struct slap_object_class {
326 LDAP_OBJECT_CLASS soc_oclass;
327 struct slap_object_class **soc_sups;
328 AttributeType **soc_required;
329 AttributeType **soc_allowed;
330 struct slap_object_class *soc_next;
331 #define soc_oid soc_oclass.oc_oid
332 #define soc_names soc_oclass.oc_names
333 #define soc_desc soc_oclass.oc_desc
334 #define soc_obsolete soc_oclass.oc_obsolete
335 #define soc_sup_oids soc_oclass.oc_sup_oids
336 #define soc_kind soc_oclass.oc_kind
337 #define soc_at_oids_must soc_oclass.oc_at_oids_must
338 #define soc_at_oids_may soc_oclass.oc_at_oids_may
339 #define soc_extensions soc_oclass.oc_extensions
344 * represents a recognized attribute description ( type + options )
346 typedef struct slap_attr_desc {
347 struct berval *ad_cname; /* canonical name */
348 AttributeType *ad_type; /* NULL if unknown */
349 char *ad_lang; /* NULL if no language tags */
351 #define SLAP_DESC_NONE 0x0U
352 #define SLAP_DESC_BINARY 0x1U
353 } AttributeDescription;
355 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
356 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
359 * pointers to schema elements used internally
361 struct slap_internal_schema {
363 ObjectClass *si_oc_top;
364 ObjectClass *si_oc_extensibleObject;
365 ObjectClass *si_oc_alias;
366 ObjectClass *si_oc_referral;
367 ObjectClass *si_oc_subentry;
368 ObjectClass *si_oc_subschema;
369 ObjectClass *si_oc_rootdse;
371 /* objectClass attribute */
372 AttributeDescription *si_ad_objectClass;
374 /* operational attributes */
375 AttributeDescription *si_ad_creatorsName;
376 AttributeDescription *si_ad_createTimestamp;
377 AttributeDescription *si_ad_modifiersName;
378 AttributeDescription *si_ad_modifyTimestamp;
379 AttributeDescription *si_ad_subschemaSubentry;
381 /* root DSE attributes */
382 AttributeDescription *si_ad_namingContexts;
383 AttributeDescription *si_ad_supportedControl;
384 AttributeDescription *si_ad_supportedExtension;
385 AttributeDescription *si_ad_supportedLDAPVersion;
386 AttributeDescription *si_ad_supportedSASLMechanisms;
388 /* subschema subentry attributes */
389 AttributeDescription *si_ad_objectClasses;
390 AttributeDescription *si_ad_attributeTypes;
391 AttributeDescription *si_ad_ldapSyntaxes;
392 AttributeDescription *si_ad_matchingRules;
393 AttributeDescription *si_ad_matchingRulesUse;
395 /* Aliases & Referrals */
396 AttributeDescription *si_ad_aliasedObjectName;
397 AttributeDescription *si_ad_ref;
399 /* Access Control Internals */
400 AttributeDescription *si_ad_entry;
401 AttributeDescription *si_ad_children;
402 #ifdef SLAPD_ACI_ENABLED
403 AttributeDescription *si_ad_aci;
407 AttributeDescription *si_ad_userPassword;
408 AttributeDescription *si_ad_authPassword;
409 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
410 AttributeDescription *si_ad_krbName;
414 typedef struct slap_attr_assertion {
415 AttributeDescription *aa_desc;
416 struct berval *aa_value;
417 } AttributeAssertion;
419 typedef struct slap_ss_assertion {
420 AttributeDescription *sa_desc;
421 struct berval *sa_initial;
422 struct berval **sa_any;
423 struct berval *sa_final;
424 } SubstringsAssertion;
426 typedef struct slap_mr_assertion {
427 char *ma_rule; /* optional */
428 AttributeDescription *ma_desc; /* optional */
429 int ma_dnattrs; /* boolean */
430 struct berval *ma_value; /* required */
431 } MatchingRuleAssertion;
435 * represents a search filter
438 typedef struct slap_filter {
439 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
440 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
441 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
442 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
446 /* precomputed result */
447 ber_int_t f_un_result;
453 AttributeDescription *f_un_desc;
455 /* simple value assertion */
456 AttributeAssertion *f_un_ava;
458 /* substring assertion */
459 SubstringsAssertion *f_un_ssa;
461 /* matching rule assertion */
462 MatchingRuleAssertion *f_un_mra;
464 #define f_dn f_un.f_un_dn
465 #define f_desc f_un.f_un_desc
466 #define f_ava f_un.f_un_ava
467 #define f_av_desc f_un.f_un_ava->aa_desc
468 #define f_av_value f_un.f_un_ava->aa_value
469 #define f_sub f_un.f_un_ssa
470 #define f_sub_desc f_un.f_un_ssa->sa_desc
471 #define f_sub_initial f_un.f_un_ssa->sa_initial
472 #define f_sub_any f_un.f_un_ssa->sa_any
473 #define f_sub_final f_un.f_un_ssa->sa_final
474 #define f_mra f_un.f_un_mra
475 #define f_mr_rule f_un.f_un_mra->ma_rule
476 #define f_mr_desc f_un.f_un_mra->ma_desc
477 #define f_mr_value f_un.f_un_mra->ma_value
478 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
481 struct slap_filter *f_un_complex;
484 #define f_result f_un.f_un_result
485 #define f_and f_un.f_un_complex
486 #define f_or f_un.f_un_complex
487 #define f_not f_un.f_un_complex
488 #define f_list f_un.f_un_complex
490 struct slap_filter *f_next;
493 /* compare routines can return undefined */
494 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
497 * represents an attribute (description + values)
499 typedef struct slap_attr {
500 AttributeDescription *a_desc;
501 struct berval **a_vals;
502 struct slap_attr *a_next;
507 * the id used in the indexes to refer to an entry
509 typedef unsigned long ID;
510 #define NOID ((ID)~0)
513 * represents an entry in core
515 typedef struct slap_entry {
517 * The ID field should only be changed before entry is
518 * inserted into a cache. The ID value is backend
523 char *e_dn; /* DN of this entry */
524 char *e_ndn; /* normalized DN of this entry */
525 Attribute *e_attrs; /* list of attributes + values */
527 /* for use by the backend for any purpose */
534 typedef struct slap_mod {
536 AttributeDescription *sm_desc;
537 struct berval **sm_bvalues;
540 typedef struct slap_mod_list {
541 Modification sml_mod;
542 #define sml_op sml_mod.sm_op
543 #define sml_desc sml_mod.sm_desc
544 #define sml_bvalues sml_mod.sm_bvalues
545 struct slap_mod_list *sml_next;
548 typedef struct slap_ldap_modlist {
550 struct slap_ldap_modlist *ml_next;
551 #define ml_op ml_mod.mod_op
552 #define ml_type ml_mod.mod_type
553 #define ml_values ml_mod.mod_values
554 #define ml_bvalues ml_mod.mod_bvalues
558 * represents an access control list
561 typedef enum slap_access_e {
562 ACL_INVALID_ACCESS = -1,
571 typedef enum slap_control_e {
572 ACL_INVALID_CONTROL = 0,
578 typedef enum slap_style_e {
586 typedef unsigned long slap_access_mask_t;
589 typedef struct slap_access {
590 slap_control_t a_type;
592 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
594 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
595 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
596 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
597 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
598 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
599 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
601 #define ACL_PRIV_MASK 0x00ffUL
604 #define ACL_PRIV_LEVEL 0x1000UL
605 #define ACL_PRIV_ADDITIVE 0x2000UL
606 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
609 #define ACL_PRIV_INVALID 0x0UL
611 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
612 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
613 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
614 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
616 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
617 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
619 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
621 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
623 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
624 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
625 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
627 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
628 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
629 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
630 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
631 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
632 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
634 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
635 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
636 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
637 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
638 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
639 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
640 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
642 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
643 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
644 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
645 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
646 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
647 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
649 slap_access_mask_t a_mask;
651 slap_style_t a_dn_style;
653 AttributeDescription *a_dn_at;
656 slap_style_t a_peername_style;
657 char *a_peername_pat;
658 slap_style_t a_sockname_style;
659 char *a_sockname_pat;
661 slap_style_t a_domain_style;
663 slap_style_t a_sockurl_style;
666 #ifdef SLAPD_ACI_ENABLED
667 AttributeDescription *a_aci_at;
671 slap_style_t a_group_style;
673 ObjectClass *a_group_oc;
674 AttributeDescription *a_group_at;
676 struct slap_access *a_next;
680 typedef struct slap_acl {
681 /* "to" part: the entries this acl applies to */
683 slap_style_t acl_dn_style;
688 /* "by" part: list of who has what access to the entries */
691 struct slap_acl *acl_next;
695 * replog moddn param structure
697 struct replog_moddn {
705 * represents a backend
708 typedef struct slap_backend_info BackendInfo; /* per backend type */
709 typedef struct slap_backend_db BackendDB; /* per backend database */
711 LDAP_SLAPD_F (int) nBackendInfo;
712 LDAP_SLAPD_F (int) nBackendDB;
713 LDAP_SLAPD_F (BackendInfo *) backendInfo;
714 LDAP_SLAPD_F (BackendDB *) backendDB;
716 LDAP_SLAPD_F (int) slapMode;
717 #define SLAP_UNDEFINED_MODE 0x0000
718 #define SLAP_SERVER_MODE 0x0001
719 #define SLAP_TOOL_MODE 0x0002
720 #define SLAP_MODE 0x0003
722 #define SLAP_TRUNCATE_MODE 0x0100
724 /* temporary aliases */
725 typedef BackendDB Backend;
726 #define nbackends nBackendDB
727 #define backends backendDB
729 struct slap_backend_db {
730 BackendInfo *bd_info; /* pointer to shared backend info */
732 /* BackendInfo accessors */
733 #define be_config bd_info->bi_db_config
734 #define be_type bd_info->bi_type
736 #define be_bind bd_info->bi_op_bind
737 #define be_unbind bd_info->bi_op_unbind
738 #define be_add bd_info->bi_op_add
739 #define be_compare bd_info->bi_op_compare
740 #define be_delete bd_info->bi_op_delete
741 #define be_modify bd_info->bi_op_modify
742 #define be_modrdn bd_info->bi_op_modrdn
743 #define be_search bd_info->bi_op_search
745 #define be_extended bd_info->bi_extended
747 #define be_release bd_info->bi_entry_release_rw
748 #define be_chk_referrals bd_info->bi_chk_referrals
749 #define be_group bd_info->bi_acl_group
751 #define be_controls bd_info->bi_controls
753 #define be_connection_init bd_info->bi_connection_init
754 #define be_connection_destroy bd_info->bi_connection_destroy
757 #define be_entry_open bd_info->bi_tool_entry_open
758 #define be_entry_close bd_info->bi_tool_entry_close
759 #define be_entry_first bd_info->bi_tool_entry_first
760 #define be_entry_next bd_info->bi_tool_entry_next
761 #define be_entry_get bd_info->bi_tool_entry_get
762 #define be_entry_put bd_info->bi_tool_entry_put
763 #define be_index_attr bd_info->bi_tool_index_attr
764 #define be_index_change bd_info->bi_tool_index_change
765 #define be_sync bd_info->bi_tool_sync
768 #ifdef HAVE_CYRUS_SASL
769 #define be_sasl_authorize bd_info->bi_sasl_authorize
770 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
771 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
774 /* these should be renamed from be_ to bd_ */
775 char **be_suffix; /* the DN suffixes of data in this backend */
776 char **be_nsuffix; /* the normalized DN suffixes in this backend */
777 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
778 char *be_root_dn; /* the magic "root" dn for this db */
779 char *be_root_ndn; /* the magic "root" normalized dn for this db */
780 struct berval be_root_pw; /* the magic "root" password for this db */
781 int be_readonly; /* 1 => db is in "read only" mode */
782 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
783 int be_sizelimit; /* size limit for this backend */
784 int be_timelimit; /* time limit for this backend */
785 AccessControl *be_acl; /* access control list for this backend */
786 slap_access_t be_dfltaccess; /* access given if no acl matches */
787 char **be_replica; /* replicas of this backend (in master) */
788 char *be_replogfile; /* replication log file (in master) */
789 char *be_update_ndn; /* allowed to make changes (in replicas) */
790 struct berval **be_update_refs; /* where to refer modifying clients to */
791 int be_lastmod; /* keep track of lastmodified{by,time} */
795 void *be_private; /* anything the backend database needs */
801 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
803 struct slap_conn *conn,
806 struct berval * reqdata,
808 struct berval ** rspdata,
809 LDAPControl *** rspctrls,
811 struct berval *** refs ));
813 struct slap_backend_info {
814 char *bi_type; /* type of backend */
817 * per backend type routines:
818 * bi_init: called to allocate a backend_info structure,
819 * called once BEFORE configuration file is read.
820 * bi_init() initializes this structure hence is
821 * called directly from be_initialize()
822 * bi_config: called per 'backend' specific option
823 * all such options must before any 'database' options
824 * bi_config() is called only from read_config()
825 * bi_open: called to open each database, called
826 * once AFTER configuration file is read but
827 * BEFORE any bi_db_open() calls.
828 * bi_open() is called from backend_startup()
829 * bi_close: called to close each database, called
830 * once during shutdown after all bi_db_close calls.
831 * bi_close() is called from backend_shutdown()
832 * bi_destroy: called to destroy each database, called
833 * once during shutdown after all bi_db_destroy calls.
834 * bi_destory() is called from backend_destroy()
836 int (*bi_init) LDAP_P((BackendInfo *bi));
837 int (*bi_config) LDAP_P((BackendInfo *bi,
838 const char *fname, int lineno, int argc, char **argv ));
839 int (*bi_open) LDAP_P((BackendInfo *bi));
840 int (*bi_close) LDAP_P((BackendInfo *bi));
841 int (*bi_destroy) LDAP_P((BackendInfo *bi));
844 * per database routines:
845 * bi_db_init: called to initialize each database,
846 * called upon reading 'database <type>'
847 * called only from backend_db_init()
848 * bi_db_config: called to configure each database,
849 * called per database to handle per database options
850 * called only from read_config()
851 * bi_db_open: called to open each database
852 * called once per database immediately AFTER bi_open()
853 * calls but before daemon startup.
854 * called only by backend_startup()
855 * bi_db_close: called to close each database
856 * called once per database during shutdown but BEFORE
858 * called only by backend_shutdown()
859 * bi_db_destroy: called to destroy each database
860 * called once per database during shutdown AFTER all
861 * bi_close calls but before bi_destory calls.
862 * called only by backend_destory()
864 int (*bi_db_init) LDAP_P((Backend *bd));
865 int (*bi_db_config) LDAP_P((Backend *bd,
866 const char *fname, int lineno, int argc, char **argv ));
867 int (*bi_db_open) LDAP_P((Backend *bd));
868 int (*bi_db_close) LDAP_P((Backend *bd));
869 int (*bi_db_destroy) LDAP_P((Backend *db));
871 /* LDAP Operations Handling Routines */
872 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
873 struct slap_conn *c, struct slap_op *o,
874 const char *dn, const char *ndn, int method,
875 struct berval *cred, char** edn ));
876 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
877 struct slap_conn *c, struct slap_op *o ));
878 int (*bi_op_search) LDAP_P((BackendDB *bd,
879 struct slap_conn *c, struct slap_op *o,
880 const char *base, const char *nbase,
881 int scope, int deref,
882 int slimit, int tlimit,
883 Filter *f, const char *filterstr,
884 char **attrs, int attrsonly));
885 int (*bi_op_compare)LDAP_P((BackendDB *bd,
886 struct slap_conn *c, struct slap_op *o,
887 const char *dn, const char *ndn,
888 AttributeAssertion *ava));
889 int (*bi_op_modify) LDAP_P((BackendDB *bd,
890 struct slap_conn *c, struct slap_op *o,
891 const char *dn, const char *ndn, Modifications *m));
892 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
893 struct slap_conn *c, struct slap_op *o,
894 const char *dn, const char *ndn,
895 const char *newrdn, int deleteoldrdn,
896 const char *newSuperior));
897 int (*bi_op_add) LDAP_P((BackendDB *bd,
898 struct slap_conn *c, struct slap_op *o,
900 int (*bi_op_delete) LDAP_P((BackendDB *bd,
901 struct slap_conn *c, struct slap_op *o,
902 const char *dn, const char *ndn));
903 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
904 struct slap_conn *c, struct slap_op *o,
907 /* Extended Operations Helper */
908 SLAP_EXTENDED_FN bi_extended;
910 /* Auxilary Functions */
911 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
913 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
914 struct slap_conn *c, struct slap_op *o,
915 const char *dn, const char *ndn,
916 const char **text ));
918 int (*bi_acl_group) LDAP_P((Backend *bd,
919 Entry *e, const char *bdn, const char *edn,
920 ObjectClass *group_oc,
921 AttributeDescription *group_at ));
923 int (*bi_connection_init) LDAP_P((BackendDB *bd,
924 struct slap_conn *c));
925 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
926 struct slap_conn *c));
928 /* hooks for slap tools */
929 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
930 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
931 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
932 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
933 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
934 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
935 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
936 AttributeDescription *desc ));
937 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
938 AttributeDescription *desc,
939 struct berval **bv, ID id, int op ));
940 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
942 #ifdef HAVE_CYRUS_SASL
943 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
944 const char *authnid, const char *authzid,
945 const char **canon_authzid, const char **errstr ));
946 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
947 const char *mechanism, const char *authzid,
948 const char *realm, sasl_secret_t **secret ));
949 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
950 const char *mechanism, const char *auth_identity,
951 const char *realm, const sasl_secret_t *secret ));
952 #endif /* HAVE_CYRUS_SASL */
954 #define SLAP_INDEX_ADD_OP 0x0001
955 #define SLAP_INDEX_DELETE_OP 0x0002
957 char **bi_controls; /* supported controls */
959 unsigned int bi_nDB; /* number of databases of this type */
960 void *bi_private; /* anything the backend type needs */
964 * represents an operation pending from an ldap client
967 typedef struct slap_op {
968 ber_int_t o_opid; /* id of this operation */
969 ber_int_t o_msgid; /* msgid of the request */
971 ldap_pvt_thread_t o_tid; /* thread handling this op */
973 BerElement *o_ber; /* ber of the request */
975 ber_tag_t o_tag; /* tag of the request */
976 time_t o_time; /* time op was initiated */
979 /* should only be used for reporting purposes */
980 char *o_authc_dn; /* authentication DN */
982 /* should be used as the DN of the User */
983 char *o_authz_dn; /* authorization DN */
984 char *o_authz_ndn; /* authorizaiton NDN */
987 char *o_dn; /* dn bound when op was initiated */
988 char *o_ndn; /* normalized dn bound when op was initiated */
991 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
992 ber_tag_t o_authtype; /* auth method used to bind dn */
993 /* values taken from ldap.h */
995 char *o_authmech; /* SASL mechanism used to bind dn */
997 LDAPControl **o_ctrls; /* controls */
999 unsigned long o_connid; /* id of conn initiating this op */
1001 #ifdef LDAP_CONNECTIONLESS
1002 int o_cldap; /* != 0 if this came in via CLDAP */
1003 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1004 char o_searchbase; /* search base if via CLDAP */
1007 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1008 int o_abandon; /* abandon flag */
1010 struct slap_op *o_next; /* next operation in list */
1011 void *o_private; /* anything the backend needs */
1015 * represents a connection from an ldap client
1018 typedef struct slap_conn {
1019 int c_struct_state; /* structure management state */
1020 int c_conn_state; /* connection state */
1022 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1023 Sockbuf *c_sb; /* ber connection stuff */
1025 /* only can be changed by connect_init */
1026 time_t c_starttime; /* when the connection was opened */
1027 time_t c_activitytime; /* when the connection was last used */
1028 unsigned long c_connid; /* id of this connection for stats*/
1030 char *c_listener_url; /* listener URL */
1031 char *c_peer_domain; /* DNS name of client */
1032 char *c_peer_name; /* peer name (trans=addr:port) */
1033 char *c_sock_name; /* sock name (trans=addr:port) */
1035 /* only can be changed by binding thread */
1036 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1037 char *c_sasl_bind_mech; /* mech in progress */
1038 #ifdef HAVE_CYRUS_SASL
1039 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1042 /* authentication backend */
1043 Backend *c_authc_backend;
1045 /* authorization backend - normally same as c_authc_backend */
1046 Backend *c_authz_backend;
1049 /* authentication backend */
1050 /* should only be used for reporting purposes */
1051 char *c_authc_dn; /* authentication DN */
1053 /* should be used as the DN of the User */
1054 char *c_authz_dn; /* authorization DN */
1055 char *c_authz_ndn; /* authorization NDN */
1058 char *c_cdn; /* DN provided by the client */
1059 char *c_dn; /* DN bound to this conn */
1062 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1063 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1064 char *c_authmech; /* SASL mechanism used to bind c_dn */
1066 Operation *c_ops; /* list of operations being processed */
1067 Operation *c_pending_ops; /* list of pending operations */
1069 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1070 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1072 BerElement *c_currentber; /* ber we're attempting to read */
1073 int c_writewaiter; /* true if writer is waiting */
1076 int c_is_tls; /* true if this LDAP over raw TLS */
1077 int c_needs_tls_accept; /* true if SSL_accept should be called */
1080 long c_n_ops_received; /* num of ops received (next op_id) */
1081 long c_n_ops_executing; /* num of ops currently executing */
1082 long c_n_ops_pending; /* num of ops pending execution */
1083 long c_n_ops_completed; /* num of ops completed */
1085 long c_n_get; /* num of get calls */
1086 long c_n_read; /* num of read calls */
1087 long c_n_write; /* num of write calls */
1090 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1091 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1093 if ( ldap_debug & (level) ) \
1094 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1095 if ( ldap_syslog & (level) ) \
1096 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1100 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1105 #include "proto-slap.h"
1107 #endif /* _SLAP_H_ */