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>
25 #define ldap_debug slap_debug
32 #include <ldap_schema.h>
34 #include "ldap_pvt_thread.h"
39 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
40 #define SLAPD_ANONYMOUS "<anonymous>"
43 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
46 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
48 * This is a value used internally by the backends. It is needed to allow
49 * adding values that already exist without getting an error as required by
50 * modrdn when the new rdn was already an attribute value itself.
51 * JCG 05/1999 (gomez@engr.sgi.com)
53 #define SLAP_MOD_SOFTADD 0x1000
59 #define MAXREMATCHES 10
61 #define SLAP_MAX_WORKER_THREADS 32
64 /* psuedo error code indicating abandoned operation */
65 #define SLAPD_ABANDON (-1)
67 /* psuedo error code indicating disconnect */
68 #define SLAPD_DISCONNECT (-2)
71 /* We assume "C" locale, that is US-ASCII */
72 #define ASCII_SPACE(c) ( (c) == ' ' )
73 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
74 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
75 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
76 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
77 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
79 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
80 #define FILTER_ESCAPE(c) ( (c) == '\\' || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
82 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
83 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
84 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
86 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
87 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
88 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
89 #define OID_SEPARATOR(c) ( (c) == '.' )
90 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
92 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
93 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
95 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
96 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
98 /* must match in schema_init.c */
99 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
100 #define SLAPD_GROUP_ATTR "member"
101 #define SLAPD_GROUP_CLASS "groupOfNames"
102 #define SLAPD_ROLE_ATTR "roleOccupant"
103 #define SLAPD_ROLE_CLASS "organizationalRole"
105 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
106 #define SLAPD_ACI_ATTR "OpenLDAPaci"
108 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
110 /* change this to "OpenLDAPset" */
111 #define SLAPD_ACI_SET_ATTR "template"
113 #define SLAPD_TOP_OID "2.5.6.0"
115 LDAP_SLAPD_F (int) slap_debug;
120 #define SLAP_INDEX_TYPE 0x00FFUL
121 #define SLAP_INDEX_UNDEFINED 0x0001UL
122 #define SLAP_INDEX_PRESENT 0x0002UL
123 #define SLAP_INDEX_EQUALITY 0x0004UL
124 #define SLAP_INDEX_APPROX 0x0008UL
125 #define SLAP_INDEX_SUBSTR 0x0010UL
126 #define SLAP_INDEX_EXTENDED 0x0020UL
128 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
130 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
132 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
134 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
135 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
136 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
137 #define SLAP_INDEX_SUBSTR_DEFAULT ( SLAP_INDEX_SUBSTR \
138 | SLAP_INDEX_SUBSTR_INITIAL | SLAP_INDEX_SUBSTR_FINAL )
140 #define SLAP_INDEX_SUBSTR_MINLEN 2
141 #define SLAP_INDEX_SUBSTR_MAXLEN 4
143 #define SLAP_INDEX_FLAGS 0xF000UL
144 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
145 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
146 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
147 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
149 typedef long slap_index;
152 * there is a single index for each attribute. these prefixes ensure
153 * that there is no collision among keys.
155 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
156 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
157 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
158 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
159 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
160 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
161 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
163 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
164 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
165 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
168 * represents schema information for a database
170 #define SLAP_SCHERR_OUTOFMEM 1
171 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
172 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
173 #define SLAP_SCHERR_DUP_CLASS 4
174 #define SLAP_SCHERR_DUP_ATTR 5
175 #define SLAP_SCHERR_DUP_SYNTAX 6
176 #define SLAP_SCHERR_DUP_RULE 7
177 #define SLAP_SCHERR_NO_NAME 8
178 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
179 #define SLAP_SCHERR_MR_NOT_FOUND 10
180 #define SLAP_SCHERR_SYN_NOT_FOUND 11
181 #define SLAP_SCHERR_MR_INCOMPLETE 12
183 typedef struct slap_oid_macro {
184 struct berval som_oid;
186 struct slap_oid_macro *som_next;
189 /* forward declarations */
191 struct slap_matching_rule;
193 typedef int slap_syntax_validate_func LDAP_P((
194 struct slap_syntax *syntax,
195 struct berval * in));
197 typedef int slap_syntax_transform_func LDAP_P((
198 struct slap_syntax *syntax,
200 struct berval ** out));
202 typedef struct slap_syntax {
203 LDAP_SYNTAX ssyn_syn;
204 #define ssyn_oid ssyn_syn.syn_oid
205 #define ssyn_desc ssyn_syn.syn_desc
206 #define ssyn_extensions ssyn_syn.syn_extensions
210 #define SLAP_SYNTAX_NONE 0x00U
211 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
212 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
213 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
214 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
216 slap_syntax_validate_func *ssyn_validate;
217 slap_syntax_transform_func *ssyn_normalize;
218 slap_syntax_transform_func *ssyn_pretty;
220 #ifdef SLAPD_BINARY_CONVERSION
221 /* convert to and from binary */
222 slap_syntax_transform_func *ssyn_ber2str;
223 slap_syntax_transform_func *ssyn_str2ber;
226 struct slap_syntax *ssyn_next;
229 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
230 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
231 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
232 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
233 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
235 /* XXX -> UCS-2 Converter */
236 typedef int slap_mr_convert_func LDAP_P((
238 struct berval ** out ));
241 typedef int slap_mr_normalize_func LDAP_P((
243 struct slap_syntax *syntax, /* NULL if in is asserted value */
244 struct slap_matching_rule *mr,
246 struct berval ** out ));
248 /* Match (compare) function */
249 typedef int slap_mr_match_func LDAP_P((
252 struct slap_syntax *syntax, /* syntax of stored value */
253 struct slap_matching_rule *mr,
254 struct berval * value,
255 void * assertValue ));
257 /* Index generation function */
258 typedef int slap_mr_indexer_func LDAP_P((
260 struct slap_syntax *syntax, /* syntax of stored value */
261 struct slap_matching_rule *mr,
262 struct berval *prefix,
263 struct berval **values,
264 struct berval ***keys ));
266 /* Filter index function */
267 typedef int slap_mr_filter_func LDAP_P((
269 struct slap_syntax *syntax, /* syntax of stored value */
270 struct slap_matching_rule *mr,
271 struct berval *prefix,
273 struct berval ***keys ));
275 typedef struct slap_matching_rule {
276 LDAP_MATCHING_RULE smr_mrule;
279 #define SLAP_MR_TYPE_MASK 0xFF00U
280 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
281 #define SLAP_MR_USAGE 0x000FU
283 #define SLAP_MR_NONE 0x0000U
284 #define SLAP_MR_EQUALITY 0x0100U
285 #define SLAP_MR_ORDERING 0x0200U
286 #define SLAP_MR_SUBSTR 0x0400U
287 #define SLAP_MR_EXT 0x0800U
289 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
291 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
292 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
293 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
295 /* this is used to kludge objectClass testing */
296 #define SLAP_MR_MODIFY_MATCHING 0x0001U
299 slap_mr_convert_func *smr_convert;
300 slap_mr_normalize_func *smr_normalize;
301 slap_mr_match_func *smr_match;
302 slap_mr_indexer_func *smr_indexer;
303 slap_mr_filter_func *smr_filter;
304 struct slap_matching_rule *smr_next;
305 #define smr_oid smr_mrule.mr_oid
306 #define smr_names smr_mrule.mr_names
307 #define smr_desc smr_mrule.mr_desc
308 #define smr_obsolete smr_mrule.mr_obsolete
309 #define smr_syntax_oid smr_mrule.mr_syntax_oid
310 #define smr_extensions smr_mrule.mr_extensions
313 typedef struct slap_attribute_type {
315 LDAP_ATTRIBUTE_TYPE sat_atype;
316 struct slap_attribute_type *sat_sup;
317 struct slap_attribute_type **sat_subtypes;
318 MatchingRule *sat_equality;
319 MatchingRule *sat_approx;
320 MatchingRule *sat_ordering;
321 MatchingRule *sat_substr;
323 struct slap_attribute_type *sat_next;
324 #define sat_oid sat_atype.at_oid
325 #define sat_names sat_atype.at_names
326 #define sat_desc sat_atype.at_desc
327 #define sat_obsolete sat_atype.at_obsolete
328 #define sat_sup_oid sat_atype.at_sup_oid
329 #define sat_equality_oid sat_atype.at_equality_oid
330 #define sat_ordering_oid sat_atype.at_ordering_oid
331 #define sat_substr_oid sat_atype.at_substr_oid
332 #define sat_syntax_oid sat_atype.at_syntax_oid
333 #define sat_single_value sat_atype.at_single_value
334 #define sat_collective sat_atype.at_collective
335 #define sat_no_user_mod sat_atype.at_no_user_mod
336 #define sat_usage sat_atype.at_usage
337 #define sat_extensions sat_atype.at_extensions
340 #define is_at_operational(at) ((at)->sat_usage)
341 #define is_at_single_value(at) ((at)->sat_single_value)
342 #define is_at_collective(at) ((at)->sat_collective)
343 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
345 typedef struct slap_object_class {
346 LDAP_OBJECT_CLASS soc_oclass;
347 struct slap_object_class **soc_sups;
348 AttributeType **soc_required;
349 AttributeType **soc_allowed;
350 struct slap_object_class *soc_next;
351 #define soc_oid soc_oclass.oc_oid
352 #define soc_names soc_oclass.oc_names
353 #define soc_desc soc_oclass.oc_desc
354 #define soc_obsolete soc_oclass.oc_obsolete
355 #define soc_sup_oids soc_oclass.oc_sup_oids
356 #define soc_kind soc_oclass.oc_kind
357 #define soc_at_oids_must soc_oclass.oc_at_oids_must
358 #define soc_at_oids_may soc_oclass.oc_at_oids_may
359 #define soc_extensions soc_oclass.oc_extensions
364 * represents a recognized attribute description ( type + options )
366 typedef struct slap_attr_desc {
367 struct berval *ad_cname; /* canonical name, must be specified */
368 AttributeType *ad_type; /* attribute type, must be specified */
369 char *ad_lang; /* NULL if no language tags */
371 #define SLAP_DESC_NONE 0x0U
372 #define SLAP_DESC_BINARY 0x1U
373 } AttributeDescription;
375 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
376 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
379 * pointers to schema elements used internally
381 struct slap_internal_schema {
383 ObjectClass *si_oc_top;
384 ObjectClass *si_oc_extensibleObject;
385 ObjectClass *si_oc_alias;
386 ObjectClass *si_oc_referral;
387 ObjectClass *si_oc_subentry;
388 ObjectClass *si_oc_subschema;
389 ObjectClass *si_oc_rootdse;
391 /* objectClass attribute descriptions */
392 AttributeDescription *si_ad_objectClass;
394 /* operational attribute descriptions */
395 AttributeDescription *si_ad_structuralObjectClass;
396 AttributeDescription *si_ad_creatorsName;
397 AttributeDescription *si_ad_createTimestamp;
398 AttributeDescription *si_ad_modifiersName;
399 AttributeDescription *si_ad_modifyTimestamp;
400 AttributeDescription *si_ad_subschemaSubentry;
402 /* root DSE attribute descriptions */
403 AttributeDescription *si_ad_namingContexts;
404 AttributeDescription *si_ad_supportedControl;
405 AttributeDescription *si_ad_supportedExtension;
406 AttributeDescription *si_ad_supportedLDAPVersion;
407 AttributeDescription *si_ad_supportedSASLMechanisms;
409 /* subschema subentry attribute descriptions */
410 AttributeDescription *si_ad_objectClasses;
411 AttributeDescription *si_ad_attributeTypes;
412 AttributeDescription *si_ad_ldapSyntaxes;
413 AttributeDescription *si_ad_matchingRules;
414 AttributeDescription *si_ad_matchingRulesUse;
416 /* Aliases & Referrals */
417 AttributeDescription *si_ad_aliasedObjectName;
418 AttributeDescription *si_ad_ref;
420 /* Access Control Internals */
421 AttributeDescription *si_ad_entry;
422 AttributeDescription *si_ad_children;
423 #ifdef SLAPD_ACI_ENABLED
424 AttributeDescription *si_ad_aci;
427 /* Other attributes descriptions */
428 AttributeDescription *si_ad_userPassword;
429 AttributeDescription *si_ad_authPassword;
430 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
431 AttributeDescription *si_ad_krbName;
434 /* Undefined Attribute Type */
435 AttributeType *si_at_undefined;
438 typedef struct slap_attr_assertion {
439 AttributeDescription *aa_desc;
440 struct berval *aa_value;
441 } AttributeAssertion;
443 typedef struct slap_ss_assertion {
444 AttributeDescription *sa_desc;
445 struct berval *sa_initial;
446 struct berval **sa_any;
447 struct berval *sa_final;
448 } SubstringsAssertion;
450 typedef struct slap_mr_assertion {
451 char *ma_rule; /* optional */
452 AttributeDescription *ma_desc; /* optional */
453 int ma_dnattrs; /* boolean */
454 struct berval *ma_value; /* required */
455 } MatchingRuleAssertion;
459 * represents a search filter
461 typedef struct slap_filter {
462 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
463 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
464 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
465 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
469 /* precomputed result */
470 ber_int_t f_un_result;
476 AttributeDescription *f_un_desc;
478 /* simple value assertion */
479 AttributeAssertion *f_un_ava;
481 /* substring assertion */
482 SubstringsAssertion *f_un_ssa;
484 /* matching rule assertion */
485 MatchingRuleAssertion *f_un_mra;
487 #define f_dn f_un.f_un_dn
488 #define f_desc f_un.f_un_desc
489 #define f_ava f_un.f_un_ava
490 #define f_av_desc f_un.f_un_ava->aa_desc
491 #define f_av_value f_un.f_un_ava->aa_value
492 #define f_sub f_un.f_un_ssa
493 #define f_sub_desc f_un.f_un_ssa->sa_desc
494 #define f_sub_initial f_un.f_un_ssa->sa_initial
495 #define f_sub_any f_un.f_un_ssa->sa_any
496 #define f_sub_final f_un.f_un_ssa->sa_final
497 #define f_mra f_un.f_un_mra
498 #define f_mr_rule f_un.f_un_mra->ma_rule
499 #define f_mr_desc f_un.f_un_mra->ma_desc
500 #define f_mr_value f_un.f_un_mra->ma_value
501 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
504 struct slap_filter *f_un_complex;
507 #define f_result f_un.f_un_result
508 #define f_and f_un.f_un_complex
509 #define f_or f_un.f_un_complex
510 #define f_not f_un.f_un_complex
511 #define f_list f_un.f_un_complex
513 struct slap_filter *f_next;
516 /* compare routines can return undefined */
517 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
520 * represents an attribute (description + values)
522 typedef struct slap_attr {
523 AttributeDescription *a_desc;
524 struct berval **a_vals;
525 struct slap_attr *a_next;
530 * the id used in the indexes to refer to an entry
532 typedef unsigned long ID;
533 #define NOID ((ID)~0)
536 * represents an entry in core
538 typedef struct slap_entry {
540 * The ID field should only be changed before entry is
541 * inserted into a cache. The ID value is backend
546 char *e_dn; /* DN of this entry */
547 char *e_ndn; /* normalized DN of this entry */
548 Attribute *e_attrs; /* list of attributes + values */
550 /* for use by the backend for any purpose */
557 typedef struct slap_mod {
559 AttributeDescription *sm_desc;
560 struct berval **sm_bvalues;
563 typedef struct slap_mod_list {
564 Modification sml_mod;
565 #define sml_op sml_mod.sm_op
566 #define sml_desc sml_mod.sm_desc
567 #define sml_bvalues sml_mod.sm_bvalues
568 struct slap_mod_list *sml_next;
571 typedef struct slap_ldap_modlist {
573 struct slap_ldap_modlist *ml_next;
574 #define ml_op ml_mod.mod_op
575 #define ml_type ml_mod.mod_type
576 #define ml_values ml_mod.mod_values
577 #define ml_bvalues ml_mod.mod_bvalues
581 * represents an access control list
583 typedef enum slap_access_e {
584 ACL_INVALID_ACCESS = -1,
593 typedef enum slap_control_e {
594 ACL_INVALID_CONTROL = 0,
600 typedef enum slap_style_e {
608 /* alternate names */
609 ACL_STYLE_EXACT = ACL_STYLE_BASE
612 typedef unsigned long slap_access_mask_t;
615 typedef struct slap_access {
616 slap_control_t a_type;
618 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
620 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
621 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
622 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
623 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
624 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
625 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
627 #define ACL_PRIV_MASK 0x00ffUL
630 #define ACL_PRIV_LEVEL 0x1000UL
631 #define ACL_PRIV_ADDITIVE 0x2000UL
632 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
635 #define ACL_PRIV_INVALID 0x0UL
637 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
638 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
639 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
640 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
642 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
643 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
645 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
647 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
649 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
650 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
651 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
653 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
654 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
655 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
656 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
657 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
658 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
660 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
661 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
662 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
663 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
664 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
665 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
666 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
668 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
669 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
670 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
671 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
672 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
673 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
675 slap_access_mask_t a_mask;
677 slap_style_t a_dn_style;
679 AttributeDescription *a_dn_at;
682 slap_style_t a_peername_style;
683 char *a_peername_pat;
684 slap_style_t a_sockname_style;
685 char *a_sockname_pat;
687 slap_style_t a_domain_style;
689 slap_style_t a_sockurl_style;
691 slap_style_t a_set_style;
694 #ifdef SLAPD_ACI_ENABLED
695 AttributeDescription *a_aci_at;
699 slap_style_t a_group_style;
701 ObjectClass *a_group_oc;
702 AttributeDescription *a_group_at;
704 struct slap_access *a_next;
708 typedef struct slap_acl {
709 /* "to" part: the entries this acl applies to */
711 slap_style_t acl_dn_style;
716 /* "by" part: list of who has what access to the entries */
719 struct slap_acl *acl_next;
723 * replog moddn param structure
725 struct replog_moddn {
733 * represents a backend
736 typedef struct slap_backend_info BackendInfo; /* per backend type */
737 typedef struct slap_backend_db BackendDB; /* per backend database */
739 LDAP_SLAPD_F (int) nBackendInfo;
740 LDAP_SLAPD_F (int) nBackendDB;
741 LDAP_SLAPD_F (BackendInfo *) backendInfo;
742 LDAP_SLAPD_F (BackendDB *) backendDB;
744 LDAP_SLAPD_F (int) slapMode;
745 #define SLAP_UNDEFINED_MODE 0x0000
746 #define SLAP_SERVER_MODE 0x0001
747 #define SLAP_TOOL_MODE 0x0002
748 #define SLAP_MODE 0x0003
750 #define SLAP_TRUNCATE_MODE 0x0100
752 /* temporary aliases */
753 typedef BackendDB Backend;
754 #define nbackends nBackendDB
755 #define backends backendDB
757 struct slap_backend_db {
758 BackendInfo *bd_info; /* pointer to shared backend info */
760 /* BackendInfo accessors */
761 #define be_config bd_info->bi_db_config
762 #define be_type bd_info->bi_type
764 #define be_bind bd_info->bi_op_bind
765 #define be_unbind bd_info->bi_op_unbind
766 #define be_add bd_info->bi_op_add
767 #define be_compare bd_info->bi_op_compare
768 #define be_delete bd_info->bi_op_delete
769 #define be_modify bd_info->bi_op_modify
770 #define be_modrdn bd_info->bi_op_modrdn
771 #define be_search bd_info->bi_op_search
773 #define be_extended bd_info->bi_extended
775 #define be_release bd_info->bi_entry_release_rw
776 #define be_chk_referrals bd_info->bi_chk_referrals
777 #define be_group bd_info->bi_acl_group
778 #define be_attribute bd_info->bi_acl_attribute
780 #define be_controls bd_info->bi_controls
782 #define be_connection_init bd_info->bi_connection_init
783 #define be_connection_destroy bd_info->bi_connection_destroy
786 #define be_entry_open bd_info->bi_tool_entry_open
787 #define be_entry_close bd_info->bi_tool_entry_close
788 #define be_entry_first bd_info->bi_tool_entry_first
789 #define be_entry_next bd_info->bi_tool_entry_next
790 #define be_entry_reindex bd_info->bi_tool_entry_reindex
791 #define be_entry_get bd_info->bi_tool_entry_get
792 #define be_entry_put bd_info->bi_tool_entry_put
793 #define be_sync bd_info->bi_tool_sync
796 /* these should be renamed from be_ to bd_ */
797 char **be_suffix; /* the DN suffixes of data in this backend */
798 char **be_nsuffix; /* the normalized DN suffixes in this backend */
799 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
800 char *be_root_dn; /* the magic "root" dn for this db */
801 char *be_root_ndn; /* the magic "root" normalized dn for this db */
802 struct berval be_root_pw; /* the magic "root" password for this db */
803 int be_readonly; /* 1 => db is in "read only" mode */
804 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
805 int be_sizelimit; /* size limit for this backend */
806 int be_timelimit; /* time limit for this backend */
807 AccessControl *be_acl; /* access control list for this backend */
808 slap_access_t be_dfltaccess; /* access given if no acl matches */
809 char **be_replica; /* replicas of this backend (in master) */
810 char *be_replogfile; /* replication log file (in master) */
811 char *be_update_ndn; /* allowed to make changes (in replicas) */
812 struct berval **be_update_refs; /* where to refer modifying clients to */
813 int be_lastmod; /* keep track of lastmodified{by,time} */
817 void *be_private; /* anything the backend database needs */
823 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
825 struct slap_conn *conn,
828 struct berval * reqdata,
830 struct berval ** rspdata,
831 LDAPControl *** rspctrls,
833 struct berval *** refs ));
835 struct slap_backend_info {
836 char *bi_type; /* type of backend */
839 * per backend type routines:
840 * bi_init: called to allocate a backend_info structure,
841 * called once BEFORE configuration file is read.
842 * bi_init() initializes this structure hence is
843 * called directly from be_initialize()
844 * bi_config: called per 'backend' specific option
845 * all such options must before any 'database' options
846 * bi_config() is called only from read_config()
847 * bi_open: called to open each database, called
848 * once AFTER configuration file is read but
849 * BEFORE any bi_db_open() calls.
850 * bi_open() is called from backend_startup()
851 * bi_close: called to close each database, called
852 * once during shutdown after all bi_db_close calls.
853 * bi_close() is called from backend_shutdown()
854 * bi_destroy: called to destroy each database, called
855 * once during shutdown after all bi_db_destroy calls.
856 * bi_destory() is called from backend_destroy()
858 int (*bi_init) LDAP_P((BackendInfo *bi));
859 int (*bi_config) LDAP_P((BackendInfo *bi,
860 const char *fname, int lineno, int argc, char **argv ));
861 int (*bi_open) LDAP_P((BackendInfo *bi));
862 int (*bi_close) LDAP_P((BackendInfo *bi));
863 int (*bi_destroy) LDAP_P((BackendInfo *bi));
866 * per database routines:
867 * bi_db_init: called to initialize each database,
868 * called upon reading 'database <type>'
869 * called only from backend_db_init()
870 * bi_db_config: called to configure each database,
871 * called per database to handle per database options
872 * called only from read_config()
873 * bi_db_open: called to open each database
874 * called once per database immediately AFTER bi_open()
875 * calls but before daemon startup.
876 * called only by backend_startup()
877 * bi_db_close: called to close each database
878 * called once per database during shutdown but BEFORE
880 * called only by backend_shutdown()
881 * bi_db_destroy: called to destroy each database
882 * called once per database during shutdown AFTER all
883 * bi_close calls but before bi_destory calls.
884 * called only by backend_destory()
886 int (*bi_db_init) LDAP_P((Backend *bd));
887 int (*bi_db_config) LDAP_P((Backend *bd,
888 const char *fname, int lineno, int argc, char **argv ));
889 int (*bi_db_open) LDAP_P((Backend *bd));
890 int (*bi_db_close) LDAP_P((Backend *bd));
891 int (*bi_db_destroy) LDAP_P((Backend *db));
893 /* LDAP Operations Handling Routines */
894 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
895 struct slap_conn *c, struct slap_op *o,
896 const char *dn, const char *ndn, int method,
897 struct berval *cred, char** edn ));
898 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
899 struct slap_conn *c, struct slap_op *o ));
900 int (*bi_op_search) LDAP_P((BackendDB *bd,
901 struct slap_conn *c, struct slap_op *o,
902 const char *base, const char *nbase,
903 int scope, int deref,
904 int slimit, int tlimit,
905 Filter *f, const char *filterstr,
906 char **attrs, int attrsonly));
907 int (*bi_op_compare)LDAP_P((BackendDB *bd,
908 struct slap_conn *c, struct slap_op *o,
909 const char *dn, const char *ndn,
910 AttributeAssertion *ava));
911 int (*bi_op_modify) LDAP_P((BackendDB *bd,
912 struct slap_conn *c, struct slap_op *o,
913 const char *dn, const char *ndn, Modifications *m));
914 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
915 struct slap_conn *c, struct slap_op *o,
916 const char *dn, const char *ndn,
917 const char *newrdn, int deleteoldrdn,
918 const char *newSuperior));
919 int (*bi_op_add) LDAP_P((BackendDB *bd,
920 struct slap_conn *c, struct slap_op *o,
922 int (*bi_op_delete) LDAP_P((BackendDB *bd,
923 struct slap_conn *c, struct slap_op *o,
924 const char *dn, const char *ndn));
925 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
926 struct slap_conn *c, struct slap_op *o,
929 /* Extended Operations Helper */
930 SLAP_EXTENDED_FN bi_extended;
932 /* Auxilary Functions */
933 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
935 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
936 struct slap_conn *c, struct slap_op *o,
937 const char *dn, const char *ndn,
938 const char **text ));
940 int (*bi_acl_group) LDAP_P((Backend *bd,
941 Entry *e, const char *bdn, const char *edn,
942 ObjectClass *group_oc,
943 AttributeDescription *group_at ));
944 int (*bi_acl_attribute) LDAP_P((Backend *bd,
945 struct slap_conn *c, struct slap_op *o,
946 Entry *e, const char *edn,
947 AttributeDescription *entry_at,
948 struct berval ***vals ));
950 int (*bi_connection_init) LDAP_P((BackendDB *bd,
951 struct slap_conn *c));
952 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
953 struct slap_conn *c));
955 /* hooks for slap tools */
956 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
957 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
958 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
959 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
960 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
961 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
962 int (*bi_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
963 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
965 #define SLAP_INDEX_ADD_OP 0x0001
966 #define SLAP_INDEX_DELETE_OP 0x0002
968 char **bi_controls; /* supported controls */
970 unsigned int bi_nDB; /* number of databases of this type */
971 void *bi_private; /* anything the backend type needs */
974 typedef struct slap_authz_info {
975 unsigned sai_ssf; /* Security Strength Factor */
976 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
977 char * sai_mech; /* SASL Mechanism */
978 char * sai_dn; /* DN for reporting purposes */
979 char * sai_ndn; /* Normalized DN */
980 } AuthorizationInformation;
982 #define c_authtype c_authz.sai_method
983 #define c_authmech c_authz.sai_mech
984 #define c_dn c_authz.sai_dn
986 #define o_authtype o_authz.sai_method
987 #define o_authmech o_authz.sai_mech
988 #define o_dn o_authz.sai_dn
989 #define o_ndn o_authz.sai_ndn
992 * represents an operation pending from an ldap client
994 typedef struct slap_op {
995 ber_int_t o_opid; /* id of this operation */
996 ber_int_t o_msgid; /* msgid of the request */
998 ldap_pvt_thread_t o_tid; /* thread handling this op */
1000 BerElement *o_ber; /* ber of the request */
1002 ber_tag_t o_tag; /* tag of the request */
1003 time_t o_time; /* time op was initiated */
1005 AuthorizationInformation o_authz;
1007 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1009 LDAPControl **o_ctrls; /* controls */
1011 unsigned long o_connid; /* id of conn initiating this op */
1013 #ifdef LDAP_CONNECTIONLESS
1014 int o_cldap; /* != 0 if this came in via CLDAP */
1015 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1016 char o_searchbase; /* search base if via CLDAP */
1019 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1020 int o_abandon; /* abandon flag */
1022 struct slap_op *o_next; /* next operation in list */
1023 void *o_private; /* anything the backend needs */
1027 * represents a connection from an ldap client
1029 typedef struct slap_conn {
1030 int c_struct_state; /* structure management state */
1031 int c_conn_state; /* connection state */
1033 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1034 Sockbuf *c_sb; /* ber connection stuff */
1036 /* only can be changed by connect_init */
1037 time_t c_starttime; /* when the connection was opened */
1038 time_t c_activitytime; /* when the connection was last used */
1039 unsigned long c_connid; /* id of this connection for stats*/
1041 char *c_listener_url; /* listener URL */
1042 char *c_peer_domain; /* DNS name of client */
1043 char *c_peer_name; /* peer name (trans=addr:port) */
1044 char *c_sock_name; /* sock name (trans=addr:port) */
1046 /* only can be changed by binding thread */
1047 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1048 char *c_sasl_bind_mech; /* mech in progress */
1051 /* authentication backend */
1052 Backend *c_authc_backend;
1054 /* authorization backend - normally same as c_authc_backend */
1055 Backend *c_authz_backend;
1057 AuthorizationInformation c_authz;
1059 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1061 Operation *c_ops; /* list of operations being processed */
1062 Operation *c_pending_ops; /* list of pending operations */
1064 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1065 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1067 BerElement *c_currentber; /* ber we're attempting to read */
1068 int c_writewaiter; /* true if writer is waiting */
1071 int c_is_tls; /* true if this LDAP over raw TLS */
1072 int c_needs_tls_accept; /* true if SSL_accept should be called */
1074 void *c_sasl_context; /* SASL session context */
1075 void *c_sasl_extra; /* SASL session extra stuff */
1077 long c_n_ops_received; /* num of ops received (next op_id) */
1078 long c_n_ops_executing; /* num of ops currently executing */
1079 long c_n_ops_pending; /* num of ops pending execution */
1080 long c_n_ops_completed; /* num of ops completed */
1082 long c_n_get; /* num of get calls */
1083 long c_n_read; /* num of read calls */
1084 long c_n_write; /* num of write calls */
1087 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1088 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1090 if ( ldap_debug & (level) ) \
1091 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1092 if ( ldap_syslog & (level) ) \
1093 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1097 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1102 #include "proto-slap.h"
1104 #endif /* _SLAP_H_ */