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 \
138 ( SLAP_INDEX_SUBSTR \
139 | SLAP_INDEX_SUBSTR_INITIAL \
140 | SLAP_INDEX_SUBSTR_ANY \
141 | SLAP_INDEX_SUBSTR_FINAL )
143 #define SLAP_INDEX_SUBSTR_MINLEN 2
144 #define SLAP_INDEX_SUBSTR_MAXLEN 4
145 #define SLAP_INDEX_SUBSTR_STEP 2
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 unsigned long slap_mask_t;
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_SUBSTR_INITIAL_PREFIX '^'
163 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
164 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
165 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
167 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
168 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
169 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
172 * represents schema information for a database
174 #define SLAP_SCHERR_OUTOFMEM 1
175 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
176 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
177 #define SLAP_SCHERR_DUP_CLASS 4
178 #define SLAP_SCHERR_DUP_ATTR 5
179 #define SLAP_SCHERR_DUP_SYNTAX 6
180 #define SLAP_SCHERR_DUP_RULE 7
181 #define SLAP_SCHERR_NO_NAME 8
182 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
183 #define SLAP_SCHERR_MR_NOT_FOUND 10
184 #define SLAP_SCHERR_SYN_NOT_FOUND 11
185 #define SLAP_SCHERR_MR_INCOMPLETE 12
187 typedef struct slap_oid_macro {
188 struct berval som_oid;
190 struct slap_oid_macro *som_next;
193 /* forward declarations */
195 struct slap_matching_rule;
197 typedef int slap_syntax_validate_func LDAP_P((
198 struct slap_syntax *syntax,
199 struct berval * in));
201 typedef int slap_syntax_transform_func LDAP_P((
202 struct slap_syntax *syntax,
204 struct berval ** out));
206 typedef struct slap_syntax {
208 #define ssyn_oid ssyn_syn.syn_oid
209 #define ssyn_desc ssyn_syn.syn_desc
210 #define ssyn_extensions ssyn_syn.syn_extensions
214 #define SLAP_SYNTAX_NONE 0x00U
215 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
216 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
217 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
218 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
220 slap_syntax_validate_func *ssyn_validate;
221 slap_syntax_transform_func *ssyn_normalize;
222 slap_syntax_transform_func *ssyn_pretty;
224 #ifdef SLAPD_BINARY_CONVERSION
225 /* convert to and from binary */
226 slap_syntax_transform_func *ssyn_ber2str;
227 slap_syntax_transform_func *ssyn_str2ber;
230 struct slap_syntax *ssyn_next;
233 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
234 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
235 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
236 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
237 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
239 /* XXX -> UCS-2 Converter */
240 typedef int slap_mr_convert_func LDAP_P((
242 struct berval ** out ));
245 typedef int slap_mr_normalize_func LDAP_P((
247 struct slap_syntax *syntax, /* NULL if in is asserted value */
248 struct slap_matching_rule *mr,
250 struct berval ** out ));
252 /* Match (compare) function */
253 typedef int slap_mr_match_func LDAP_P((
256 struct slap_syntax *syntax, /* syntax of stored value */
257 struct slap_matching_rule *mr,
258 struct berval * value,
259 void * assertValue ));
261 /* Index generation function */
262 typedef int slap_mr_indexer_func LDAP_P((
265 struct slap_syntax *syntax, /* syntax of stored value */
266 struct slap_matching_rule *mr,
267 struct berval *prefix,
268 struct berval **values,
269 struct berval ***keys ));
271 /* Filter index function */
272 typedef int slap_mr_filter_func LDAP_P((
275 struct slap_syntax *syntax, /* syntax of stored value */
276 struct slap_matching_rule *mr,
277 struct berval *prefix,
279 struct berval ***keys ));
281 typedef struct slap_matching_rule {
282 LDAPMatchingRule smr_mrule;
283 slap_mask_t smr_usage;
285 #define SLAP_MR_TYPE_MASK 0xFF00U
286 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
287 #define SLAP_MR_USAGE 0x000FU
289 #define SLAP_MR_NONE 0x0000U
290 #define SLAP_MR_EQUALITY 0x0100U
291 #define SLAP_MR_ORDERING 0x0200U
292 #define SLAP_MR_SUBSTR 0x0400U
293 #define SLAP_MR_EXT 0x0800U
295 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
297 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
298 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
299 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
301 /* this is used to kludge objectClass testing */
302 #define SLAP_MR_MODIFY_MATCHING 0x0001U
305 slap_mr_convert_func *smr_convert;
306 slap_mr_normalize_func *smr_normalize;
307 slap_mr_match_func *smr_match;
308 slap_mr_indexer_func *smr_indexer;
309 slap_mr_filter_func *smr_filter;
311 struct slap_matching_rule *smr_associated;
312 struct slap_matching_rule *smr_next;
314 #define smr_oid smr_mrule.mr_oid
315 #define smr_names smr_mrule.mr_names
316 #define smr_desc smr_mrule.mr_desc
317 #define smr_obsolete smr_mrule.mr_obsolete
318 #define smr_syntax_oid smr_mrule.mr_syntax_oid
319 #define smr_extensions smr_mrule.mr_extensions
322 typedef struct slap_attribute_type {
324 LDAPAttributeType sat_atype;
325 struct slap_attribute_type *sat_sup;
326 struct slap_attribute_type **sat_subtypes;
327 MatchingRule *sat_equality;
328 MatchingRule *sat_approx;
329 MatchingRule *sat_ordering;
330 MatchingRule *sat_substr;
332 struct slap_attribute_type *sat_next;
333 #define sat_oid sat_atype.at_oid
334 #define sat_names sat_atype.at_names
335 #define sat_desc sat_atype.at_desc
336 #define sat_obsolete sat_atype.at_obsolete
337 #define sat_sup_oid sat_atype.at_sup_oid
338 #define sat_equality_oid sat_atype.at_equality_oid
339 #define sat_ordering_oid sat_atype.at_ordering_oid
340 #define sat_substr_oid sat_atype.at_substr_oid
341 #define sat_syntax_oid sat_atype.at_syntax_oid
342 #define sat_single_value sat_atype.at_single_value
343 #define sat_collective sat_atype.at_collective
344 #define sat_no_user_mod sat_atype.at_no_user_mod
345 #define sat_usage sat_atype.at_usage
346 #define sat_extensions sat_atype.at_extensions
349 #define is_at_operational(at) ((at)->sat_usage)
350 #define is_at_single_value(at) ((at)->sat_single_value)
351 #define is_at_collective(at) ((at)->sat_collective)
352 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
354 typedef struct slap_object_class {
355 LDAPObjectClass soc_oclass;
356 struct slap_object_class **soc_sups;
357 AttributeType **soc_required;
358 AttributeType **soc_allowed;
359 struct slap_object_class *soc_next;
360 #define soc_oid soc_oclass.oc_oid
361 #define soc_names soc_oclass.oc_names
362 #define soc_desc soc_oclass.oc_desc
363 #define soc_obsolete soc_oclass.oc_obsolete
364 #define soc_sup_oids soc_oclass.oc_sup_oids
365 #define soc_kind soc_oclass.oc_kind
366 #define soc_at_oids_must soc_oclass.oc_at_oids_must
367 #define soc_at_oids_may soc_oclass.oc_at_oids_may
368 #define soc_extensions soc_oclass.oc_extensions
373 * represents a recognized attribute description ( type + options )
375 typedef struct slap_attr_desc {
376 struct berval *ad_cname; /* canonical name, must be specified */
377 AttributeType *ad_type; /* attribute type, must be specified */
378 char *ad_lang; /* NULL if no language tags */
380 #define SLAP_DESC_NONE 0x0U
381 #define SLAP_DESC_BINARY 0x1U
382 } AttributeDescription;
384 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
385 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
388 * pointers to schema elements used internally
390 struct slap_internal_schema {
392 ObjectClass *si_oc_top;
393 ObjectClass *si_oc_extensibleObject;
394 ObjectClass *si_oc_alias;
395 ObjectClass *si_oc_referral;
396 ObjectClass *si_oc_subentry;
397 ObjectClass *si_oc_subschema;
398 ObjectClass *si_oc_rootdse;
400 /* objectClass attribute descriptions */
401 AttributeDescription *si_ad_objectClass;
403 /* operational attribute descriptions */
404 AttributeDescription *si_ad_structuralObjectClass;
405 AttributeDescription *si_ad_creatorsName;
406 AttributeDescription *si_ad_createTimestamp;
407 AttributeDescription *si_ad_modifiersName;
408 AttributeDescription *si_ad_modifyTimestamp;
409 AttributeDescription *si_ad_subschemaSubentry;
411 /* root DSE attribute descriptions */
412 AttributeDescription *si_ad_namingContexts;
413 AttributeDescription *si_ad_supportedControl;
414 AttributeDescription *si_ad_supportedExtension;
415 AttributeDescription *si_ad_supportedLDAPVersion;
416 AttributeDescription *si_ad_supportedSASLMechanisms;
418 /* subschema subentry attribute descriptions */
419 AttributeDescription *si_ad_objectClasses;
420 AttributeDescription *si_ad_attributeTypes;
421 AttributeDescription *si_ad_ldapSyntaxes;
422 AttributeDescription *si_ad_matchingRules;
423 AttributeDescription *si_ad_matchingRulesUse;
425 /* Aliases & Referrals */
426 AttributeDescription *si_ad_aliasedObjectName;
427 AttributeDescription *si_ad_ref;
429 /* Access Control Internals */
430 AttributeDescription *si_ad_entry;
431 AttributeDescription *si_ad_children;
432 #ifdef SLAPD_ACI_ENABLED
433 AttributeDescription *si_ad_aci;
436 /* Other attributes descriptions */
437 AttributeDescription *si_ad_userPassword;
438 AttributeDescription *si_ad_authPassword;
439 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
440 AttributeDescription *si_ad_krbName;
443 /* Undefined Attribute Type */
444 AttributeType *si_at_undefined;
447 typedef struct slap_attr_assertion {
448 AttributeDescription *aa_desc;
449 struct berval *aa_value;
450 } AttributeAssertion;
452 typedef struct slap_ss_assertion {
453 AttributeDescription *sa_desc;
454 struct berval *sa_initial;
455 struct berval **sa_any;
456 struct berval *sa_final;
457 } SubstringsAssertion;
459 typedef struct slap_mr_assertion {
460 char *ma_rule; /* optional */
461 AttributeDescription *ma_desc; /* optional */
462 int ma_dnattrs; /* boolean */
463 struct berval *ma_value; /* required */
464 } MatchingRuleAssertion;
468 * represents a search filter
470 typedef struct slap_filter {
471 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
472 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
473 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
474 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
478 /* precomputed result */
479 ber_int_t f_un_result;
485 AttributeDescription *f_un_desc;
487 /* simple value assertion */
488 AttributeAssertion *f_un_ava;
490 /* substring assertion */
491 SubstringsAssertion *f_un_ssa;
493 /* matching rule assertion */
494 MatchingRuleAssertion *f_un_mra;
496 #define f_dn f_un.f_un_dn
497 #define f_desc f_un.f_un_desc
498 #define f_ava f_un.f_un_ava
499 #define f_av_desc f_un.f_un_ava->aa_desc
500 #define f_av_value f_un.f_un_ava->aa_value
501 #define f_sub f_un.f_un_ssa
502 #define f_sub_desc f_un.f_un_ssa->sa_desc
503 #define f_sub_initial f_un.f_un_ssa->sa_initial
504 #define f_sub_any f_un.f_un_ssa->sa_any
505 #define f_sub_final f_un.f_un_ssa->sa_final
506 #define f_mra f_un.f_un_mra
507 #define f_mr_rule f_un.f_un_mra->ma_rule
508 #define f_mr_desc f_un.f_un_mra->ma_desc
509 #define f_mr_value f_un.f_un_mra->ma_value
510 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
513 struct slap_filter *f_un_complex;
516 #define f_result f_un.f_un_result
517 #define f_and f_un.f_un_complex
518 #define f_or f_un.f_un_complex
519 #define f_not f_un.f_un_complex
520 #define f_list f_un.f_un_complex
522 struct slap_filter *f_next;
525 /* compare routines can return undefined */
526 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
529 * represents an attribute (description + values)
531 typedef struct slap_attr {
532 AttributeDescription *a_desc;
533 struct berval **a_vals;
534 struct slap_attr *a_next;
539 * the id used in the indexes to refer to an entry
541 typedef unsigned long ID;
542 #define NOID ((ID)~0)
545 * represents an entry in core
547 typedef struct slap_entry {
549 * The ID field should only be changed before entry is
550 * inserted into a cache. The ID value is backend
555 char *e_dn; /* DN of this entry */
556 char *e_ndn; /* normalized DN of this entry */
557 Attribute *e_attrs; /* list of attributes + values */
559 /* for use by the backend for any purpose */
566 typedef struct slap_mod {
568 AttributeDescription *sm_desc;
569 struct berval **sm_bvalues;
572 typedef struct slap_mod_list {
573 Modification sml_mod;
574 #define sml_op sml_mod.sm_op
575 #define sml_desc sml_mod.sm_desc
576 #define sml_bvalues sml_mod.sm_bvalues
577 struct slap_mod_list *sml_next;
580 typedef struct slap_ldap_modlist {
582 struct slap_ldap_modlist *ml_next;
583 #define ml_op ml_mod.mod_op
584 #define ml_type ml_mod.mod_type
585 #define ml_values ml_mod.mod_values
586 #define ml_bvalues ml_mod.mod_bvalues
590 * represents an access control list
592 typedef enum slap_access_e {
593 ACL_INVALID_ACCESS = -1,
602 typedef enum slap_control_e {
603 ACL_INVALID_CONTROL = 0,
609 typedef enum slap_style_e {
617 /* alternate names */
618 ACL_STYLE_EXACT = ACL_STYLE_BASE
621 typedef unsigned long slap_access_mask_t;
624 typedef struct slap_access {
625 slap_control_t a_type;
627 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
629 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
630 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
631 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
632 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
633 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
634 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
636 #define ACL_PRIV_MASK 0x00ffUL
639 #define ACL_PRIV_LEVEL 0x1000UL
640 #define ACL_PRIV_ADDITIVE 0x2000UL
641 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
644 #define ACL_PRIV_INVALID 0x0UL
646 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
647 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
648 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
649 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
651 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
652 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
654 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
656 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
658 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
659 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
660 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
662 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
663 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
664 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
665 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
666 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
667 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
669 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
670 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
671 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
672 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
673 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
674 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
675 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
677 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
678 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
679 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
680 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
681 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
682 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
684 slap_access_mask_t a_mask;
686 slap_style_t a_dn_style;
688 AttributeDescription *a_dn_at;
691 slap_style_t a_peername_style;
692 char *a_peername_pat;
693 slap_style_t a_sockname_style;
694 char *a_sockname_pat;
696 slap_style_t a_domain_style;
698 slap_style_t a_sockurl_style;
700 slap_style_t a_set_style;
703 #ifdef SLAPD_ACI_ENABLED
704 AttributeDescription *a_aci_at;
708 slap_style_t a_group_style;
710 ObjectClass *a_group_oc;
711 AttributeDescription *a_group_at;
713 struct slap_access *a_next;
717 typedef struct slap_acl {
718 /* "to" part: the entries this acl applies to */
720 slap_style_t acl_dn_style;
725 /* "by" part: list of who has what access to the entries */
728 struct slap_acl *acl_next;
732 * replog moddn param structure
734 struct replog_moddn {
742 * represents a backend
745 typedef struct slap_backend_info BackendInfo; /* per backend type */
746 typedef struct slap_backend_db BackendDB; /* per backend database */
748 LDAP_SLAPD_F (int) nBackendInfo;
749 LDAP_SLAPD_F (int) nBackendDB;
750 LDAP_SLAPD_F (BackendInfo *) backendInfo;
751 LDAP_SLAPD_F (BackendDB *) backendDB;
753 LDAP_SLAPD_F (int) slapMode;
754 #define SLAP_UNDEFINED_MODE 0x0000
755 #define SLAP_SERVER_MODE 0x0001
756 #define SLAP_TOOL_MODE 0x0002
757 #define SLAP_MODE 0x0003
759 #define SLAP_TRUNCATE_MODE 0x0100
761 /* temporary aliases */
762 typedef BackendDB Backend;
763 #define nbackends nBackendDB
764 #define backends backendDB
766 struct slap_backend_db {
767 BackendInfo *bd_info; /* pointer to shared backend info */
769 /* BackendInfo accessors */
770 #define be_config bd_info->bi_db_config
771 #define be_type bd_info->bi_type
773 #define be_bind bd_info->bi_op_bind
774 #define be_unbind bd_info->bi_op_unbind
775 #define be_add bd_info->bi_op_add
776 #define be_compare bd_info->bi_op_compare
777 #define be_delete bd_info->bi_op_delete
778 #define be_modify bd_info->bi_op_modify
779 #define be_modrdn bd_info->bi_op_modrdn
780 #define be_search bd_info->bi_op_search
782 #define be_extended bd_info->bi_extended
784 #define be_release bd_info->bi_entry_release_rw
785 #define be_chk_referrals bd_info->bi_chk_referrals
786 #define be_group bd_info->bi_acl_group
787 #define be_attribute bd_info->bi_acl_attribute
789 #define be_controls bd_info->bi_controls
791 #define be_connection_init bd_info->bi_connection_init
792 #define be_connection_destroy bd_info->bi_connection_destroy
795 #define be_entry_open bd_info->bi_tool_entry_open
796 #define be_entry_close bd_info->bi_tool_entry_close
797 #define be_entry_first bd_info->bi_tool_entry_first
798 #define be_entry_next bd_info->bi_tool_entry_next
799 #define be_entry_reindex bd_info->bi_tool_entry_reindex
800 #define be_entry_get bd_info->bi_tool_entry_get
801 #define be_entry_put bd_info->bi_tool_entry_put
802 #define be_sync bd_info->bi_tool_sync
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_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
972 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
974 #define SLAP_INDEX_ADD_OP 0x0001
975 #define SLAP_INDEX_DELETE_OP 0x0002
977 char **bi_controls; /* supported controls */
979 unsigned int bi_nDB; /* number of databases of this type */
980 void *bi_private; /* anything the backend type needs */
983 typedef struct slap_authz_info {
984 unsigned sai_ssf; /* Security Strength Factor */
985 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
986 char * sai_mech; /* SASL Mechanism */
987 char * sai_dn; /* DN for reporting purposes */
988 char * sai_ndn; /* Normalized DN */
989 } AuthorizationInformation;
991 #define c_authtype c_authz.sai_method
992 #define c_authmech c_authz.sai_mech
993 #define c_dn c_authz.sai_dn
995 #define o_authtype o_authz.sai_method
996 #define o_authmech o_authz.sai_mech
997 #define o_dn o_authz.sai_dn
998 #define o_ndn o_authz.sai_ndn
1001 * represents an operation pending from an ldap client
1003 typedef struct slap_op {
1004 ber_int_t o_opid; /* id of this operation */
1005 ber_int_t o_msgid; /* msgid of the request */
1007 ldap_pvt_thread_t o_tid; /* thread handling this op */
1009 BerElement *o_ber; /* ber of the request */
1011 ber_tag_t o_tag; /* tag of the request */
1012 time_t o_time; /* time op was initiated */
1014 AuthorizationInformation o_authz;
1016 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1018 LDAPControl **o_ctrls; /* controls */
1020 unsigned long o_connid; /* id of conn initiating this op */
1022 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1023 int o_abandon; /* abandon flag */
1025 struct slap_op *o_next; /* next operation in list */
1026 void *o_private; /* anything the backend needs */
1030 * represents a connection from an ldap client
1032 typedef struct slap_conn {
1033 int c_struct_state; /* structure management state */
1034 int c_conn_state; /* connection state */
1036 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1037 Sockbuf *c_sb; /* ber connection stuff */
1039 /* only can be changed by connect_init */
1040 time_t c_starttime; /* when the connection was opened */
1041 time_t c_activitytime; /* when the connection was last used */
1042 unsigned long c_connid; /* id of this connection for stats*/
1044 char *c_listener_url; /* listener URL */
1045 char *c_peer_domain; /* DNS name of client */
1046 char *c_peer_name; /* peer name (trans=addr:port) */
1047 char *c_sock_name; /* sock name (trans=addr:port) */
1049 /* only can be changed by binding thread */
1050 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1051 char *c_sasl_bind_mech; /* mech in progress */
1054 /* authentication backend */
1055 Backend *c_authc_backend;
1057 /* authorization backend - normally same as c_authc_backend */
1058 Backend *c_authz_backend;
1060 AuthorizationInformation c_authz;
1062 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1064 Operation *c_ops; /* list of operations being processed */
1065 Operation *c_pending_ops; /* list of pending operations */
1067 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1068 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1070 BerElement *c_currentber; /* ber we're attempting to read */
1071 int c_writewaiter; /* true if writer is waiting */
1074 int c_is_tls; /* true if this LDAP over raw TLS */
1075 int c_needs_tls_accept; /* true if SSL_accept should be called */
1077 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1078 void *c_sasl_context; /* SASL session context */
1079 void *c_sasl_extra; /* SASL session extra stuff */
1081 long c_n_ops_received; /* num of ops received (next op_id) */
1082 long c_n_ops_executing; /* num of ops currently executing */
1083 long c_n_ops_pending; /* num of ops pending execution */
1084 long c_n_ops_completed; /* num of ops completed */
1086 long c_n_get; /* num of get calls */
1087 long c_n_read; /* num of read calls */
1088 long c_n_write; /* num of write calls */
1091 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1092 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1094 if ( ldap_debug & (level) ) \
1095 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1096 if ( ldap_syslog & (level) ) \
1097 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1101 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1106 #include "proto-slap.h"
1108 #endif /* _SLAP_H_ */