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 ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
82 #define FILTER_ESCAPE(c) ( (c) == '\\' || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
84 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
85 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
86 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
88 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
89 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
90 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
91 #define OID_SEPARATOR(c) ( (c) == '.' )
92 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
94 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
95 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
97 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
98 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
100 /* must match in schema_init.c */
101 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
102 #define SLAPD_GROUP_ATTR "member"
103 #define SLAPD_GROUP_CLASS "groupOfNames"
104 #define SLAPD_ROLE_ATTR "roleOccupant"
105 #define SLAPD_ROLE_CLASS "organizationalRole"
107 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
108 #define SLAPD_ACI_ATTR "OpenLDAPaci"
110 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
112 /* change this to "OpenLDAPset" */
113 #define SLAPD_ACI_SET_ATTR "template"
115 #define SLAPD_TOP_OID "2.5.6.0"
117 LDAP_SLAPD_F (int) slap_debug;
122 #define SLAP_INDEX_TYPE 0x00FFUL
123 #define SLAP_INDEX_UNDEFINED 0x0001UL
124 #define SLAP_INDEX_PRESENT 0x0002UL
125 #define SLAP_INDEX_EQUALITY 0x0004UL
126 #define SLAP_INDEX_APPROX 0x0008UL
127 #define SLAP_INDEX_SUBSTR 0x0010UL
128 #define SLAP_INDEX_EXTENDED 0x0020UL
130 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
132 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
134 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
136 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
137 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
138 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
139 #define SLAP_INDEX_SUBSTR_DEFAULT ( SLAP_INDEX_SUBSTR \
140 | SLAP_INDEX_SUBSTR_INITIAL | SLAP_INDEX_SUBSTR_FINAL )
142 #define SLAP_INDEX_SUBSTR_INITIAL_MIN_LEN 2
143 #define SLAP_INDEX_SUBSTR_INITIAL_MAX_LEN 4
144 #define SLAP_INDEX_SUBSTR_FINAL_MIN_LEN 2
145 #define SLAP_INDEX_SUBSTR_FINAL_MAX_LEN 4
147 #define SLAP_INDEX_FLAGS 0xF000UL
148 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
149 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
150 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
151 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
153 typedef long slap_index;
156 * there is a single index for each attribute. these prefixes ensure
157 * that there is no collision among keys.
159 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
160 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
161 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
162 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
163 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
165 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
166 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
167 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
170 * represents schema information for a database
172 #define SLAP_SCHERR_OUTOFMEM 1
173 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
174 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
175 #define SLAP_SCHERR_DUP_CLASS 4
176 #define SLAP_SCHERR_DUP_ATTR 5
177 #define SLAP_SCHERR_DUP_SYNTAX 6
178 #define SLAP_SCHERR_DUP_RULE 7
179 #define SLAP_SCHERR_NO_NAME 8
180 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
181 #define SLAP_SCHERR_MR_NOT_FOUND 10
182 #define SLAP_SCHERR_SYN_NOT_FOUND 11
183 #define SLAP_SCHERR_MR_INCOMPLETE 12
185 typedef struct slap_oid_macro {
186 struct berval som_oid;
188 struct slap_oid_macro *som_next;
191 /* forward declarations */
193 struct slap_matching_rule;
195 typedef int slap_syntax_validate_func LDAP_P((
196 struct slap_syntax *syntax,
197 struct berval * in));
199 typedef int slap_syntax_transform_func LDAP_P((
200 struct slap_syntax *syntax,
202 struct berval ** out));
204 typedef struct slap_syntax {
205 LDAP_SYNTAX ssyn_syn;
206 #define ssyn_oid ssyn_syn.syn_oid
207 #define ssyn_desc ssyn_syn.syn_desc
208 #define ssyn_extensions ssyn_syn.syn_extensions
212 #define SLAP_SYNTAX_NONE 0x00U
213 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
214 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
215 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
216 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
218 slap_syntax_validate_func *ssyn_validate;
219 slap_syntax_transform_func *ssyn_normalize;
220 slap_syntax_transform_func *ssyn_pretty;
222 #ifdef SLAPD_BINARY_CONVERSION
223 /* convert to and from binary */
224 slap_syntax_transform_func *ssyn_ber2str;
225 slap_syntax_transform_func *ssyn_str2ber;
228 struct slap_syntax *ssyn_next;
231 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
232 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
233 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
234 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
235 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
237 /* XXX -> UCS-2 Converter */
238 typedef int slap_mr_convert_func LDAP_P((
240 struct berval ** out ));
243 typedef int slap_mr_normalize_func LDAP_P((
245 struct slap_syntax *syntax, /* NULL if in is asserted value */
246 struct slap_matching_rule *mr,
248 struct berval ** out ));
250 /* Match (compare) function */
251 typedef int slap_mr_match_func LDAP_P((
254 struct slap_syntax *syntax, /* syntax of stored value */
255 struct slap_matching_rule *mr,
256 struct berval * value,
257 void * assertValue ));
259 /* Index generation function */
260 typedef int slap_mr_indexer_func LDAP_P((
262 struct slap_syntax *syntax, /* syntax of stored value */
263 struct slap_matching_rule *mr,
264 struct berval *prefix,
265 struct berval **values,
266 struct berval ***keys ));
268 /* Filter index function */
269 typedef int slap_mr_filter_func LDAP_P((
271 struct slap_syntax *syntax, /* syntax of stored value */
272 struct slap_matching_rule *mr,
273 struct berval *prefix,
275 struct berval ***keys ));
277 typedef struct slap_matching_rule {
278 LDAP_MATCHING_RULE smr_mrule;
281 #define SLAP_MR_TYPE_MASK 0xFF00U
282 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
283 #define SLAP_MR_USAGE 0x000FU
285 #define SLAP_MR_NONE 0x0000U
286 #define SLAP_MR_EQUALITY 0x0100U
287 #define SLAP_MR_ORDERING 0x0200U
288 #define SLAP_MR_SUBSTR 0x0400U
289 #define SLAP_MR_EXT 0x0800U
291 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
293 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
294 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
295 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
297 /* this is used to kludge objectClass testing */
298 #define SLAP_MR_MODIFY_MATCHING 0x0001U
301 slap_mr_convert_func *smr_convert;
302 slap_mr_normalize_func *smr_normalize;
303 slap_mr_match_func *smr_match;
304 slap_mr_indexer_func *smr_indexer;
305 slap_mr_filter_func *smr_filter;
306 struct slap_matching_rule *smr_next;
307 #define smr_oid smr_mrule.mr_oid
308 #define smr_names smr_mrule.mr_names
309 #define smr_desc smr_mrule.mr_desc
310 #define smr_obsolete smr_mrule.mr_obsolete
311 #define smr_syntax_oid smr_mrule.mr_syntax_oid
312 #define smr_extensions smr_mrule.mr_extensions
315 typedef struct slap_attribute_type {
317 LDAP_ATTRIBUTE_TYPE sat_atype;
318 struct slap_attribute_type *sat_sup;
319 struct slap_attribute_type **sat_subtypes;
320 MatchingRule *sat_equality;
321 MatchingRule *sat_approx;
322 MatchingRule *sat_ordering;
323 MatchingRule *sat_substr;
325 struct slap_attribute_type *sat_next;
326 #define sat_oid sat_atype.at_oid
327 #define sat_names sat_atype.at_names
328 #define sat_desc sat_atype.at_desc
329 #define sat_obsolete sat_atype.at_obsolete
330 #define sat_sup_oid sat_atype.at_sup_oid
331 #define sat_equality_oid sat_atype.at_equality_oid
332 #define sat_ordering_oid sat_atype.at_ordering_oid
333 #define sat_substr_oid sat_atype.at_substr_oid
334 #define sat_syntax_oid sat_atype.at_syntax_oid
335 #define sat_single_value sat_atype.at_single_value
336 #define sat_collective sat_atype.at_collective
337 #define sat_no_user_mod sat_atype.at_no_user_mod
338 #define sat_usage sat_atype.at_usage
339 #define sat_extensions sat_atype.at_extensions
342 #define is_at_operational(at) ((at)->sat_usage)
343 #define is_at_single_value(at) ((at)->sat_single_value)
344 #define is_at_collective(at) ((at)->sat_collective)
345 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
347 typedef struct slap_object_class {
348 LDAP_OBJECT_CLASS soc_oclass;
349 struct slap_object_class **soc_sups;
350 AttributeType **soc_required;
351 AttributeType **soc_allowed;
352 struct slap_object_class *soc_next;
353 #define soc_oid soc_oclass.oc_oid
354 #define soc_names soc_oclass.oc_names
355 #define soc_desc soc_oclass.oc_desc
356 #define soc_obsolete soc_oclass.oc_obsolete
357 #define soc_sup_oids soc_oclass.oc_sup_oids
358 #define soc_kind soc_oclass.oc_kind
359 #define soc_at_oids_must soc_oclass.oc_at_oids_must
360 #define soc_at_oids_may soc_oclass.oc_at_oids_may
361 #define soc_extensions soc_oclass.oc_extensions
366 * represents a recognized attribute description ( type + options )
368 typedef struct slap_attr_desc {
369 struct berval *ad_cname; /* canonical name, must be specified */
370 AttributeType *ad_type; /* attribute type, must be specified */
371 char *ad_lang; /* NULL if no language tags */
373 #define SLAP_DESC_NONE 0x0U
374 #define SLAP_DESC_BINARY 0x1U
375 } AttributeDescription;
377 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
378 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
381 * pointers to schema elements used internally
383 struct slap_internal_schema {
385 ObjectClass *si_oc_top;
386 ObjectClass *si_oc_extensibleObject;
387 ObjectClass *si_oc_alias;
388 ObjectClass *si_oc_referral;
389 ObjectClass *si_oc_subentry;
390 ObjectClass *si_oc_subschema;
391 ObjectClass *si_oc_rootdse;
393 /* objectClass attribute descriptions */
394 AttributeDescription *si_ad_objectClass;
396 /* operational attribute descriptions */
397 AttributeDescription *si_ad_structuralObjectClass;
398 AttributeDescription *si_ad_creatorsName;
399 AttributeDescription *si_ad_createTimestamp;
400 AttributeDescription *si_ad_modifiersName;
401 AttributeDescription *si_ad_modifyTimestamp;
402 AttributeDescription *si_ad_subschemaSubentry;
404 /* root DSE attribute descriptions */
405 AttributeDescription *si_ad_namingContexts;
406 AttributeDescription *si_ad_supportedControl;
407 AttributeDescription *si_ad_supportedExtension;
408 AttributeDescription *si_ad_supportedLDAPVersion;
409 AttributeDescription *si_ad_supportedSASLMechanisms;
411 /* subschema subentry attribute descriptions */
412 AttributeDescription *si_ad_objectClasses;
413 AttributeDescription *si_ad_attributeTypes;
414 AttributeDescription *si_ad_ldapSyntaxes;
415 AttributeDescription *si_ad_matchingRules;
416 AttributeDescription *si_ad_matchingRulesUse;
418 /* Aliases & Referrals */
419 AttributeDescription *si_ad_aliasedObjectName;
420 AttributeDescription *si_ad_ref;
422 /* Access Control Internals */
423 AttributeDescription *si_ad_entry;
424 AttributeDescription *si_ad_children;
425 #ifdef SLAPD_ACI_ENABLED
426 AttributeDescription *si_ad_aci;
429 /* Other attributes descriptions */
430 AttributeDescription *si_ad_userPassword;
431 AttributeDescription *si_ad_authPassword;
432 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
433 AttributeDescription *si_ad_krbName;
436 /* Undefined Attribute Type */
437 AttributeType *si_at_undefined;
440 typedef struct slap_attr_assertion {
441 AttributeDescription *aa_desc;
442 struct berval *aa_value;
443 } AttributeAssertion;
445 typedef struct slap_ss_assertion {
446 AttributeDescription *sa_desc;
447 struct berval *sa_initial;
448 struct berval **sa_any;
449 struct berval *sa_final;
450 } SubstringsAssertion;
452 typedef struct slap_mr_assertion {
453 char *ma_rule; /* optional */
454 AttributeDescription *ma_desc; /* optional */
455 int ma_dnattrs; /* boolean */
456 struct berval *ma_value; /* required */
457 } MatchingRuleAssertion;
461 * represents a search filter
463 typedef struct slap_filter {
464 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
465 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
466 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
467 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
471 /* precomputed result */
472 ber_int_t f_un_result;
478 AttributeDescription *f_un_desc;
480 /* simple value assertion */
481 AttributeAssertion *f_un_ava;
483 /* substring assertion */
484 SubstringsAssertion *f_un_ssa;
486 /* matching rule assertion */
487 MatchingRuleAssertion *f_un_mra;
489 #define f_dn f_un.f_un_dn
490 #define f_desc f_un.f_un_desc
491 #define f_ava f_un.f_un_ava
492 #define f_av_desc f_un.f_un_ava->aa_desc
493 #define f_av_value f_un.f_un_ava->aa_value
494 #define f_sub f_un.f_un_ssa
495 #define f_sub_desc f_un.f_un_ssa->sa_desc
496 #define f_sub_initial f_un.f_un_ssa->sa_initial
497 #define f_sub_any f_un.f_un_ssa->sa_any
498 #define f_sub_final f_un.f_un_ssa->sa_final
499 #define f_mra f_un.f_un_mra
500 #define f_mr_rule f_un.f_un_mra->ma_rule
501 #define f_mr_desc f_un.f_un_mra->ma_desc
502 #define f_mr_value f_un.f_un_mra->ma_value
503 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
506 struct slap_filter *f_un_complex;
509 #define f_result f_un.f_un_result
510 #define f_and f_un.f_un_complex
511 #define f_or f_un.f_un_complex
512 #define f_not f_un.f_un_complex
513 #define f_list f_un.f_un_complex
515 struct slap_filter *f_next;
518 /* compare routines can return undefined */
519 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
522 * represents an attribute (description + values)
524 typedef struct slap_attr {
525 AttributeDescription *a_desc;
526 struct berval **a_vals;
527 struct slap_attr *a_next;
532 * the id used in the indexes to refer to an entry
534 typedef unsigned long ID;
535 #define NOID ((ID)~0)
538 * represents an entry in core
540 typedef struct slap_entry {
542 * The ID field should only be changed before entry is
543 * inserted into a cache. The ID value is backend
548 char *e_dn; /* DN of this entry */
549 char *e_ndn; /* normalized DN of this entry */
550 Attribute *e_attrs; /* list of attributes + values */
552 /* for use by the backend for any purpose */
559 typedef struct slap_mod {
561 AttributeDescription *sm_desc;
562 struct berval **sm_bvalues;
565 typedef struct slap_mod_list {
566 Modification sml_mod;
567 #define sml_op sml_mod.sm_op
568 #define sml_desc sml_mod.sm_desc
569 #define sml_bvalues sml_mod.sm_bvalues
570 struct slap_mod_list *sml_next;
573 typedef struct slap_ldap_modlist {
575 struct slap_ldap_modlist *ml_next;
576 #define ml_op ml_mod.mod_op
577 #define ml_type ml_mod.mod_type
578 #define ml_values ml_mod.mod_values
579 #define ml_bvalues ml_mod.mod_bvalues
583 * represents an access control list
585 typedef enum slap_access_e {
586 ACL_INVALID_ACCESS = -1,
595 typedef enum slap_control_e {
596 ACL_INVALID_CONTROL = 0,
602 typedef enum slap_style_e {
610 /* alternate names */
611 ACL_STYLE_EXACT = ACL_STYLE_BASE
614 typedef unsigned long slap_access_mask_t;
617 typedef struct slap_access {
618 slap_control_t a_type;
620 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
622 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
623 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
624 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
625 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
626 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
627 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
629 #define ACL_PRIV_MASK 0x00ffUL
632 #define ACL_PRIV_LEVEL 0x1000UL
633 #define ACL_PRIV_ADDITIVE 0x2000UL
634 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
637 #define ACL_PRIV_INVALID 0x0UL
639 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
640 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
641 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
642 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
644 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
645 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
647 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
649 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
651 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
652 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
653 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
655 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
656 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
657 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
658 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
659 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
660 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
662 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
663 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
664 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
665 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
666 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
667 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
668 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
670 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
671 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
672 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
673 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
674 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
675 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
677 slap_access_mask_t a_mask;
679 slap_style_t a_dn_style;
681 AttributeDescription *a_dn_at;
684 slap_style_t a_peername_style;
685 char *a_peername_pat;
686 slap_style_t a_sockname_style;
687 char *a_sockname_pat;
689 slap_style_t a_domain_style;
691 slap_style_t a_sockurl_style;
693 slap_style_t a_set_style;
696 #ifdef SLAPD_ACI_ENABLED
697 AttributeDescription *a_aci_at;
701 slap_style_t a_group_style;
703 ObjectClass *a_group_oc;
704 AttributeDescription *a_group_at;
706 struct slap_access *a_next;
710 typedef struct slap_acl {
711 /* "to" part: the entries this acl applies to */
713 slap_style_t acl_dn_style;
718 /* "by" part: list of who has what access to the entries */
721 struct slap_acl *acl_next;
725 * replog moddn param structure
727 struct replog_moddn {
735 * represents a backend
738 typedef struct slap_backend_info BackendInfo; /* per backend type */
739 typedef struct slap_backend_db BackendDB; /* per backend database */
741 LDAP_SLAPD_F (int) nBackendInfo;
742 LDAP_SLAPD_F (int) nBackendDB;
743 LDAP_SLAPD_F (BackendInfo *) backendInfo;
744 LDAP_SLAPD_F (BackendDB *) backendDB;
746 LDAP_SLAPD_F (int) slapMode;
747 #define SLAP_UNDEFINED_MODE 0x0000
748 #define SLAP_SERVER_MODE 0x0001
749 #define SLAP_TOOL_MODE 0x0002
750 #define SLAP_MODE 0x0003
752 #define SLAP_TRUNCATE_MODE 0x0100
754 /* temporary aliases */
755 typedef BackendDB Backend;
756 #define nbackends nBackendDB
757 #define backends backendDB
759 struct slap_backend_db {
760 BackendInfo *bd_info; /* pointer to shared backend info */
762 /* BackendInfo accessors */
763 #define be_config bd_info->bi_db_config
764 #define be_type bd_info->bi_type
766 #define be_bind bd_info->bi_op_bind
767 #define be_unbind bd_info->bi_op_unbind
768 #define be_add bd_info->bi_op_add
769 #define be_compare bd_info->bi_op_compare
770 #define be_delete bd_info->bi_op_delete
771 #define be_modify bd_info->bi_op_modify
772 #define be_modrdn bd_info->bi_op_modrdn
773 #define be_search bd_info->bi_op_search
775 #define be_extended bd_info->bi_extended
777 #define be_release bd_info->bi_entry_release_rw
778 #define be_chk_referrals bd_info->bi_chk_referrals
779 #define be_group bd_info->bi_acl_group
780 #define be_attribute bd_info->bi_acl_attribute
782 #define be_controls bd_info->bi_controls
784 #define be_connection_init bd_info->bi_connection_init
785 #define be_connection_destroy bd_info->bi_connection_destroy
788 #define be_entry_open bd_info->bi_tool_entry_open
789 #define be_entry_close bd_info->bi_tool_entry_close
790 #define be_entry_first bd_info->bi_tool_entry_first
791 #define be_entry_next bd_info->bi_tool_entry_next
792 #define be_entry_get bd_info->bi_tool_entry_get
793 #define be_entry_put bd_info->bi_tool_entry_put
794 #define be_index_attr bd_info->bi_tool_index_attr
795 #define be_index_change bd_info->bi_tool_index_change
796 #define be_sync bd_info->bi_tool_sync
799 #ifdef HAVE_CYRUS_SASL
800 #define be_sasl_authorize bd_info->bi_sasl_authorize
801 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
802 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
805 /* these should be renamed from be_ to bd_ */
806 char **be_suffix; /* the DN suffixes of data in this backend */
807 char **be_nsuffix; /* the normalized DN suffixes in this backend */
808 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
809 char *be_root_dn; /* the magic "root" dn for this db */
810 char *be_root_ndn; /* the magic "root" normalized dn for this db */
811 struct berval be_root_pw; /* the magic "root" password for this db */
812 int be_readonly; /* 1 => db is in "read only" mode */
813 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
814 int be_sizelimit; /* size limit for this backend */
815 int be_timelimit; /* time limit for this backend */
816 AccessControl *be_acl; /* access control list for this backend */
817 slap_access_t be_dfltaccess; /* access given if no acl matches */
818 char **be_replica; /* replicas of this backend (in master) */
819 char *be_replogfile; /* replication log file (in master) */
820 char *be_update_ndn; /* allowed to make changes (in replicas) */
821 struct berval **be_update_refs; /* where to refer modifying clients to */
822 int be_lastmod; /* keep track of lastmodified{by,time} */
826 void *be_private; /* anything the backend database needs */
832 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
834 struct slap_conn *conn,
837 struct berval * reqdata,
839 struct berval ** rspdata,
840 LDAPControl *** rspctrls,
842 struct berval *** refs ));
844 struct slap_backend_info {
845 char *bi_type; /* type of backend */
848 * per backend type routines:
849 * bi_init: called to allocate a backend_info structure,
850 * called once BEFORE configuration file is read.
851 * bi_init() initializes this structure hence is
852 * called directly from be_initialize()
853 * bi_config: called per 'backend' specific option
854 * all such options must before any 'database' options
855 * bi_config() is called only from read_config()
856 * bi_open: called to open each database, called
857 * once AFTER configuration file is read but
858 * BEFORE any bi_db_open() calls.
859 * bi_open() is called from backend_startup()
860 * bi_close: called to close each database, called
861 * once during shutdown after all bi_db_close calls.
862 * bi_close() is called from backend_shutdown()
863 * bi_destroy: called to destroy each database, called
864 * once during shutdown after all bi_db_destroy calls.
865 * bi_destory() is called from backend_destroy()
867 int (*bi_init) LDAP_P((BackendInfo *bi));
868 int (*bi_config) LDAP_P((BackendInfo *bi,
869 const char *fname, int lineno, int argc, char **argv ));
870 int (*bi_open) LDAP_P((BackendInfo *bi));
871 int (*bi_close) LDAP_P((BackendInfo *bi));
872 int (*bi_destroy) LDAP_P((BackendInfo *bi));
875 * per database routines:
876 * bi_db_init: called to initialize each database,
877 * called upon reading 'database <type>'
878 * called only from backend_db_init()
879 * bi_db_config: called to configure each database,
880 * called per database to handle per database options
881 * called only from read_config()
882 * bi_db_open: called to open each database
883 * called once per database immediately AFTER bi_open()
884 * calls but before daemon startup.
885 * called only by backend_startup()
886 * bi_db_close: called to close each database
887 * called once per database during shutdown but BEFORE
889 * called only by backend_shutdown()
890 * bi_db_destroy: called to destroy each database
891 * called once per database during shutdown AFTER all
892 * bi_close calls but before bi_destory calls.
893 * called only by backend_destory()
895 int (*bi_db_init) LDAP_P((Backend *bd));
896 int (*bi_db_config) LDAP_P((Backend *bd,
897 const char *fname, int lineno, int argc, char **argv ));
898 int (*bi_db_open) LDAP_P((Backend *bd));
899 int (*bi_db_close) LDAP_P((Backend *bd));
900 int (*bi_db_destroy) LDAP_P((Backend *db));
902 /* LDAP Operations Handling Routines */
903 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
904 struct slap_conn *c, struct slap_op *o,
905 const char *dn, const char *ndn, int method,
906 struct berval *cred, char** edn ));
907 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
908 struct slap_conn *c, struct slap_op *o ));
909 int (*bi_op_search) LDAP_P((BackendDB *bd,
910 struct slap_conn *c, struct slap_op *o,
911 const char *base, const char *nbase,
912 int scope, int deref,
913 int slimit, int tlimit,
914 Filter *f, const char *filterstr,
915 char **attrs, int attrsonly));
916 int (*bi_op_compare)LDAP_P((BackendDB *bd,
917 struct slap_conn *c, struct slap_op *o,
918 const char *dn, const char *ndn,
919 AttributeAssertion *ava));
920 int (*bi_op_modify) LDAP_P((BackendDB *bd,
921 struct slap_conn *c, struct slap_op *o,
922 const char *dn, const char *ndn, Modifications *m));
923 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
924 struct slap_conn *c, struct slap_op *o,
925 const char *dn, const char *ndn,
926 const char *newrdn, int deleteoldrdn,
927 const char *newSuperior));
928 int (*bi_op_add) LDAP_P((BackendDB *bd,
929 struct slap_conn *c, struct slap_op *o,
931 int (*bi_op_delete) LDAP_P((BackendDB *bd,
932 struct slap_conn *c, struct slap_op *o,
933 const char *dn, const char *ndn));
934 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
935 struct slap_conn *c, struct slap_op *o,
938 /* Extended Operations Helper */
939 SLAP_EXTENDED_FN bi_extended;
941 /* Auxilary Functions */
942 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
944 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
945 struct slap_conn *c, struct slap_op *o,
946 const char *dn, const char *ndn,
947 const char **text ));
949 int (*bi_acl_group) LDAP_P((Backend *bd,
950 Entry *e, const char *bdn, const char *edn,
951 ObjectClass *group_oc,
952 AttributeDescription *group_at ));
953 int (*bi_acl_attribute) LDAP_P((Backend *bd,
954 struct slap_conn *c, struct slap_op *o,
955 Entry *e, const char *edn,
956 AttributeDescription *entry_at,
957 struct berval ***vals ));
959 int (*bi_connection_init) LDAP_P((BackendDB *bd,
960 struct slap_conn *c));
961 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
962 struct slap_conn *c));
964 /* hooks for slap tools */
965 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
966 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
967 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
968 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
969 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
970 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
971 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
972 AttributeDescription *desc ));
973 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
974 AttributeDescription *desc,
975 struct berval **bv, ID id, int op ));
976 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
978 #ifdef HAVE_CYRUS_SASL
979 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
980 const char *authnid, const char *authzid,
981 const char **canon_authzid, const char **errstr ));
982 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
983 const char *mechanism, const char *authzid,
984 const char *realm, sasl_secret_t **secret ));
985 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
986 const char *mechanism, const char *auth_identity,
987 const char *realm, const sasl_secret_t *secret ));
988 #endif /* HAVE_CYRUS_SASL */
990 #define SLAP_INDEX_ADD_OP 0x0001
991 #define SLAP_INDEX_DELETE_OP 0x0002
993 char **bi_controls; /* supported controls */
995 unsigned int bi_nDB; /* number of databases of this type */
996 void *bi_private; /* anything the backend type needs */
1000 * represents an operation pending from an ldap client
1002 typedef struct slap_op {
1003 ber_int_t o_opid; /* id of this operation */
1004 ber_int_t o_msgid; /* msgid of the request */
1006 ldap_pvt_thread_t o_tid; /* thread handling this op */
1008 BerElement *o_ber; /* ber of the request */
1010 ber_tag_t o_tag; /* tag of the request */
1011 time_t o_time; /* time op was initiated */
1014 /* should only be used for reporting purposes */
1015 char *o_authc_dn; /* authentication DN */
1017 /* should be used as the DN of the User */
1018 char *o_authz_dn; /* authorization DN */
1019 char *o_authz_ndn; /* authorizaiton NDN */
1022 char *o_dn; /* dn bound when op was initiated */
1023 char *o_ndn; /* normalized dn bound when op was initiated */
1026 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1027 ber_tag_t o_authtype; /* auth method used to bind dn */
1028 /* values taken from ldap.h */
1030 char *o_authmech; /* SASL mechanism used to bind dn */
1032 LDAPControl **o_ctrls; /* controls */
1034 unsigned long o_connid; /* id of conn initiating this op */
1036 #ifdef LDAP_CONNECTIONLESS
1037 int o_cldap; /* != 0 if this came in via CLDAP */
1038 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1039 char o_searchbase; /* search base if via CLDAP */
1042 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1043 int o_abandon; /* abandon flag */
1045 struct slap_op *o_next; /* next operation in list */
1046 void *o_private; /* anything the backend needs */
1050 * represents a connection from an ldap client
1052 typedef struct slap_conn {
1053 int c_struct_state; /* structure management state */
1054 int c_conn_state; /* connection state */
1056 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1057 Sockbuf *c_sb; /* ber connection stuff */
1059 /* only can be changed by connect_init */
1060 time_t c_starttime; /* when the connection was opened */
1061 time_t c_activitytime; /* when the connection was last used */
1062 unsigned long c_connid; /* id of this connection for stats*/
1064 char *c_listener_url; /* listener URL */
1065 char *c_peer_domain; /* DNS name of client */
1066 char *c_peer_name; /* peer name (trans=addr:port) */
1067 char *c_sock_name; /* sock name (trans=addr:port) */
1069 /* only can be changed by binding thread */
1070 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1071 char *c_sasl_bind_mech; /* mech in progress */
1072 #ifdef HAVE_CYRUS_SASL
1073 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1076 /* authentication backend */
1077 Backend *c_authc_backend;
1079 /* authorization backend - normally same as c_authc_backend */
1080 Backend *c_authz_backend;
1083 /* authentication backend */
1084 /* should only be used for reporting purposes */
1085 char *c_authc_dn; /* authentication DN */
1087 /* should be used as the DN of the User */
1088 char *c_authz_dn; /* authorization DN */
1089 char *c_authz_ndn; /* authorization NDN */
1092 char *c_cdn; /* DN provided by the client */
1093 char *c_dn; /* DN bound to this conn */
1096 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1097 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1098 char *c_authmech; /* SASL mechanism used to bind c_dn */
1100 Operation *c_ops; /* list of operations being processed */
1101 Operation *c_pending_ops; /* list of pending operations */
1103 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1104 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1106 BerElement *c_currentber; /* ber we're attempting to read */
1107 int c_writewaiter; /* true if writer is waiting */
1110 int c_is_tls; /* true if this LDAP over raw TLS */
1111 int c_needs_tls_accept; /* true if SSL_accept should be called */
1114 long c_n_ops_received; /* num of ops received (next op_id) */
1115 long c_n_ops_executing; /* num of ops currently executing */
1116 long c_n_ops_pending; /* num of ops pending execution */
1117 long c_n_ops_completed; /* num of ops completed */
1119 long c_n_get; /* num of get calls */
1120 long c_n_read; /* num of read calls */
1121 long c_n_write; /* num of write calls */
1124 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1125 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1127 if ( ldap_debug & (level) ) \
1128 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1129 if ( ldap_syslog & (level) ) \
1130 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1134 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1139 #include "proto-slap.h"
1141 #endif /* _SLAP_H_ */