1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
13 #include <ac/stdlib.h>
15 #include <sys/types.h>
16 #include <ac/syslog.h>
18 #include <ac/socket.h>
22 #ifdef HAVE_CYRUS_SASL
29 #define ldap_debug slap_debug
36 #include <ldap_schema.h>
38 #include "ldap_pvt_thread.h"
43 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
44 #define SLAPD_ANONYMOUS "<anonymous>"
47 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
50 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
52 * This is a value used internally by the backends. It is needed to allow
53 * adding values that already exist without getting an error as required by
54 * modrdn when the new rdn was already an attribute value itself.
55 * JCG 05/1999 (gomez@engr.sgi.com)
57 #define SLAP_MOD_SOFTADD 0x1000
63 #define MAXREMATCHES 10
66 /* psuedo error code indicating abandoned operation */
67 #define SLAPD_ABANDON (-1)
69 /* psuedo error code indicating disconnect */
70 #define SLAPD_DISCONNECT (-2)
73 /* We assume "C" locale, that is US-ASCII */
74 #define ASCII_SPACE(c) ( (c) == ' ' )
75 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
76 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
77 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
78 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
79 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
81 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
82 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
83 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
85 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
86 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
87 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
88 #define OID_CHAR(c) ( ASCII_DIGIT(c) || (c) == '.' )
90 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
91 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
93 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
94 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
96 #ifndef SLAPD_SCHEMA_NOT_COMPAT
97 /* schema needed by slapd */
98 #define SLAPD_OID_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1" /* experimental */
99 #define SLAPD_ACI_DEFAULT_ATTR "aci"
103 LIBSLAPD_F (int) slap_debug;
108 #define SLAP_INDEX_PRESENCE 0x0001U
109 #define SLAP_INDEX_EQUALITY 0x0002U
110 #define SLAP_INDEX_APPROX 0x0004U
111 #define SLAP_INDEX_SUBSTR 0x0008U
112 #define SLAP_INDEX_EXTENDED 0x0010U
113 #define SLAP_INDEX_UNDEFINED 0x1000U
114 #define SLAP_INDEX_FROMINIT 0x8000U /* psuedo type */
117 * represents schema information for a database
119 #define SLAP_SCHERR_OUTOFMEM 1
120 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
121 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
122 #define SLAP_SCHERR_DUP_CLASS 4
123 #define SLAP_SCHERR_DUP_ATTR 5
124 #define SLAP_SCHERR_DUP_SYNTAX 6
125 #define SLAP_SCHERR_DUP_RULE 7
126 #define SLAP_SCHERR_NO_NAME 8
127 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
128 #define SLAP_SCHERR_MR_NOT_FOUND 10
129 #define SLAP_SCHERR_SYN_NOT_FOUND 11
130 #define SLAP_SCHERR_MR_INCOMPLETE 12
132 typedef struct slap_oid_macro {
133 struct berval som_oid;
135 struct slap_oid_macro *som_next;
138 /* forward declarations */
140 struct slap_matching_rule;
142 typedef int slap_syntax_validate_func LDAP_P((
143 struct slap_syntax *syntax,
144 struct berval * in));
146 typedef int slap_syntax_transform_func LDAP_P((
147 struct slap_syntax *syntax,
149 struct berval ** out));
151 typedef struct slap_syntax {
152 LDAP_SYNTAX ssyn_syn;
153 #define ssyn_oid ssyn_syn.syn_oid
154 #define ssyn_desc ssyn_syn.syn_desc
155 #define ssyn_extensions ssyn_syn.syn_extensions
159 #define SLAP_SYNTAX_NONE 0x00U
160 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
161 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
162 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
163 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
165 slap_syntax_validate_func *ssyn_validate;
166 slap_syntax_transform_func *ssyn_normalize;
167 slap_syntax_transform_func *ssyn_pretty;
169 #ifdef SLAPD_BINARY_CONVERSION
170 /* convert to and from binary */
171 slap_syntax_transform_func *ssyn_ber2str;
172 slap_syntax_transform_func *ssyn_str2ber;
175 struct slap_syntax *ssyn_next;
178 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
179 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
180 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
181 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
182 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
184 /* XXX -> UCS-2 Converter */
185 typedef int slap_mr_convert_func LDAP_P((
187 struct berval ** out ));
190 typedef int slap_mr_normalize_func LDAP_P((
192 struct slap_syntax *syntax, /* NULL if in is asserted value */
193 struct slap_matching_rule *mr,
195 struct berval ** out ));
197 /* Match (compare) function */
198 typedef int slap_mr_match_func LDAP_P((
201 struct slap_syntax *syntax, /* syntax of stored value */
202 struct slap_matching_rule *mr,
203 struct berval * value,
204 void * assertValue ));
206 /* Index generation function */
207 typedef int slap_mr_indexer_func LDAP_P((
209 struct slap_syntax *syntax, /* syntax of stored value */
210 struct slap_matching_rule *mr,
211 struct berval **values,
212 struct berval **keys ));
214 struct slap_filter; /* forward declaration */
216 /* Filter index function */
217 typedef int slap_mr_filter_func LDAP_P((
219 struct slap_syntax *syntax, /* syntax of stored value */
220 struct slap_matching_rule *mr,
221 struct slap_filter *filter,
222 struct berval **keys ));
224 typedef struct slap_matching_rule {
225 LDAP_MATCHING_RULE smr_mrule;
228 #define SLAP_MR_TYPE_MASK 0xFF00U
229 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
231 #define SLAP_MR_NONE 0x0000U
232 #define SLAP_MR_EQUALITY 0x0100U
233 #define SLAP_MR_ORDERING 0x0200U
234 #define SLAP_MR_SUBSTR 0x0400U
235 #define SLAP_MR_EXT 0x0800U
237 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
239 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
240 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
241 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
244 slap_mr_convert_func *smr_convert;
245 slap_mr_normalize_func *smr_normalize;
246 slap_mr_match_func *smr_match;
247 slap_mr_indexer_func *smr_indexer;
248 slap_mr_filter_func *smr_filter;
249 struct slap_matching_rule *smr_next;
250 #define smr_oid smr_mrule.mr_oid
251 #define smr_names smr_mrule.mr_names
252 #define smr_desc smr_mrule.mr_desc
253 #define smr_obsolete smr_mrule.mr_obsolete
254 #define smr_syntax_oid smr_mrule.mr_syntax_oid
255 #define smr_extensions smr_mrule.mr_extensions
258 typedef struct slap_attribute_type {
259 #ifdef SLAPD_SCHEMA_NOT_COMPAT
262 LDAP_ATTRIBUTE_TYPE sat_atype;
263 struct slap_attribute_type *sat_sup;
264 struct slap_attribute_type **sat_subtypes;
265 MatchingRule *sat_equality;
266 MatchingRule *sat_ordering;
267 MatchingRule *sat_substr;
269 #ifndef SLAPD_SCHEMA_NOT_COMPAT
270 /* The next one is created to help in the transition */
271 int sat_syntax_compat;
273 struct slap_attribute_type *sat_next;
274 #define sat_oid sat_atype.at_oid
275 #define sat_names sat_atype.at_names
276 #define sat_desc sat_atype.at_desc
277 #define sat_obsolete sat_atype.at_obsolete
278 #define sat_sup_oid sat_atype.at_sup_oid
279 #define sat_equality_oid sat_atype.at_equality_oid
280 #define sat_ordering_oid sat_atype.at_ordering_oid
281 #define sat_substr_oid sat_atype.at_substr_oid
282 #define sat_syntax_oid sat_atype.at_syntax_oid
283 #define sat_single_value sat_atype.at_single_value
284 #define sat_collective sat_atype.at_collective
285 #define sat_no_user_mod sat_atype.at_no_user_mod
286 #define sat_usage sat_atype.at_usage
287 #define sat_extensions sat_atype.at_extensions
290 #define is_at_operational(at) ((at)->sat_usage)
291 #define is_at_single_value(at) ((at)->sat_single_value)
292 #define is_at_collective(at) ((at)->sat_collective)
293 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
295 typedef struct slap_object_class {
296 LDAP_OBJECT_CLASS soc_oclass;
297 struct slap_object_class **soc_sups;
298 AttributeType **soc_required;
299 AttributeType **soc_allowed;
300 struct slap_object_class *soc_next;
301 #define soc_oid soc_oclass.oc_oid
302 #define soc_names soc_oclass.oc_names
303 #define soc_desc soc_oclass.oc_desc
304 #define soc_obsolete soc_oclass.oc_obsolete
305 #define soc_sup_oids soc_oclass.oc_sup_oids
306 #define soc_kind soc_oclass.oc_kind
307 #define soc_at_oids_must soc_oclass.oc_at_oids_must
308 #define soc_at_oids_may soc_oclass.oc_at_oids_may
309 #define soc_extensions soc_oclass.oc_extensions
313 #ifdef SLAPD_SCHEMA_NOT_COMPAT
315 * represents a recognized attribute description ( type + options )
317 typedef struct slap_attr_desc {
318 struct berval *ad_cname; /* canonical name */
319 AttributeType *ad_type; /* NULL if unknown */
320 char *ad_lang; /* NULL if no language tags */
322 #define SLAP_DESC_NONE 0x0U
323 #define SLAP_DESC_BINARY 0x1U
324 } AttributeDescription;
326 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
329 * pointers to schema elements used internally
331 struct slap_internal_schema {
333 ObjectClass *si_oc_top;
334 ObjectClass *si_oc_alias;
335 ObjectClass *si_oc_referral;
336 ObjectClass *si_oc_subentry;
337 ObjectClass *si_oc_subschema;
338 ObjectClass *si_oc_rootdse;
339 #ifdef SLAPD_ACI_ENABLED
340 ObjectClass *si_oc_groupOfNames;
343 /* objectClass attribute */
344 AttributeDescription *si_ad_objectClass;
346 /* operational attributes */
347 AttributeDescription *si_ad_creatorsName;
348 AttributeDescription *si_ad_createTimestamp;
349 AttributeDescription *si_ad_modifiersName;
350 AttributeDescription *si_ad_modifyTimestamp;
351 AttributeDescription *si_ad_subschemaSubentry;
353 /* root DSE attributes */
354 AttributeDescription *si_ad_namingContexts;
355 AttributeDescription *si_ad_supportedControl;
356 AttributeDescription *si_ad_supportedExtension;
357 AttributeDescription *si_ad_supportedLDAPVersion;
358 #ifdef SLAPD_ACI_ENABLED
359 AttributeDescription *si_ad_supportedACIMechanisms;
361 AttributeDescription *si_ad_supportedSASLMechanisms;
363 /* subschema subentry attributes */
364 AttributeDescription *si_ad_objectClasses;
365 AttributeDescription *si_ad_attributeTypes;
366 AttributeDescription *si_ad_ldapSyntaxes;
367 AttributeDescription *si_ad_matchingRules;
368 AttributeDescription *si_ad_matchingRulesUse;
370 /* Aliases & Referrals */
371 AttributeDescription *si_ad_aliasedObjectName;
372 AttributeDescription *si_ad_ref;
374 /* Access Control Internals */
375 AttributeDescription *si_ad_entry;
376 AttributeDescription *si_ad_children;
377 AttributeDescription *si_ad_member;
378 AttributeDescription *si_ad_distinguishedName;
379 #ifdef SLAPD_ACI_ENABLED
380 AttributeDescription *si_ad_aci;
384 AttributeDescription *si_ad_userPassword;
385 AttributeDescription *si_ad_authPassword;
386 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
387 AttributeDescription *si_ad_krbName;
391 typedef struct slap_attr_assertion {
392 AttributeDescription *aa_desc;
393 struct berval *aa_value;
394 } AttributeAssertion;
396 typedef struct slap_ss_assertion {
397 AttributeDescription *sa_desc;
398 struct berval *sa_initial;
399 struct berval **sa_any;
400 struct berval *sa_final;
401 } SubstringsAssertion;
403 typedef struct slap_mr_assertion {
404 char *ma_rule; /* optional */
405 AttributeDescription *ma_desc; /* optional */
406 int ma_dnattrs; /* boolean */
407 struct berval *ma_value; /* required */
408 } MatchingRuleAssertion;
413 * represents an attribute value assertion (i.e., attr;option=value)
415 typedef struct slap_ava {
416 char *ava_type; /* attribute description */
417 struct berval ava_value;
421 * represents an matching rule assertion
423 typedef struct slap_mra {
424 char *mra_rule; /* optional */
425 char *mra_type; /* attribute description -- optional */
427 struct berval *mra_value;
433 * represents a search filter
436 typedef struct slap_filter {
437 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
438 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
439 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
440 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
444 /* precomputed result */
445 ber_int_t f_un_result;
447 #ifdef SLAPD_SCHEMA_NOT_COMPAT
452 AttributeDescription *f_un_desc;
454 /* simple value assertion */
455 AttributeAssertion *f_un_ava;
457 /* substring assertion */
458 SubstringsAssertion *f_un_ssa;
460 /* matching rule assertion */
461 MatchingRuleAssertion *f_un_mra;
463 #define f_dn f_un.f_un_dn
464 #define f_desc f_un.f_un_desc
465 #define f_ava f_un.f_un_ava
466 #define f_av_desc f_un.f_un_ava->aa_desc
467 #define f_av_value f_un.f_un_ava->aa_value
468 #define f_sub f_un.f_un_ssa
469 #define f_sub_desc f_un.f_un_ssa->sa_desc
470 #define f_sub_initial f_un.f_un_ssa->sa_initial
471 #define f_sub_any f_un.f_un_ssa->sa_any
472 #define f_sub_final f_un.f_un_ssa->sa_final
473 #define f_mra f_un.f_un_mra
474 #define f_mr_rule f_un.f_un_mra->ma_rule
475 #define f_mr_desc f_un.f_un_mra->ma_desc
476 #define f_mr_value f_un.f_un_mra->ma_value
477 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
482 /* equality, lessorequal, greaterorequal, approx */
492 struct berval *f_un_sub_initial;
493 struct berval **f_un_sub_any;
494 struct berval *f_un_sub_final;
497 #define f_dn f_un.f_un_type /* used for DN indices */
498 #define f_type f_un.f_un_type
499 #define f_ava f_un.f_un_ava
500 #define f_avtype f_un.f_un_ava.ava_type
501 #define f_avvalue f_un.f_un_ava.ava_value
502 #define f_mra f_un.f_un_mra
503 #define f_mrtype f_un.f_un_mra.mra_type
504 #define f_mrvalue f_un.f_un_mra.mra_value
505 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
506 #define f_sub f_un.f_un_sub
507 #define f_sub_type f_un.f_un_sub.f_un_sub_type
508 #define f_sub_desc f_sub_type
509 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
510 #define f_sub_any f_un.f_un_sub.f_un_sub_any
511 #define f_sub_final f_un.f_un_sub.f_un_sub_final
515 struct slap_filter *f_un_complex;
518 #define f_result f_un.f_un_result
519 #define f_and f_un.f_un_complex
520 #define f_or f_un.f_un_complex
521 #define f_not f_un.f_un_complex
522 #define f_list f_un.f_un_complex
524 struct slap_filter *f_next;
527 /* compare routines can return undefined */
528 #define SLAPD_COMPARE_UNDEFINED ((ber_tag_t) -1)
531 * represents an attribute (description + values)
533 typedef struct slap_attr {
534 #ifdef SLAPD_SCHEMA_NOT_COMPAT
535 AttributeDescription *a_desc;
537 char *a_type; /* description */
540 struct berval **a_vals;
541 struct slap_attr *a_next;
544 #ifndef SLAPD_SCHEMA_NOT_COMPAT
546 * the attr_syntax() routine returns one of these values
547 * telling what kind of syntax an attribute supports.
549 #define SYNTAX_CIS 0x01 /* case insensitive string */
550 #define SYNTAX_CES 0x02 /* case sensitive string */
551 #define SYNTAX_BIN 0x04 /* binary data */
552 #define SYNTAX_TEL 0x08 /* telephone number string */
553 #define SYNTAX_DN 0x10 /* dn string */
557 * the id used in the indexes to refer to an entry
559 typedef unsigned long ID;
560 #define NOID ((ID)~0)
563 * represents an entry in core
565 typedef struct slap_entry {
567 * The ID field should only be changed before entry is
568 * inserted into a cache. The ID value is backend
573 char *e_dn; /* DN of this entry */
574 char *e_ndn; /* normalized DN of this entry */
575 Attribute *e_attrs; /* list of attributes + values */
577 /* for use by the backend for any purpose */
584 #ifdef SLAPD_SCHEMA_NOT_COMPAT
585 typedef struct slap_mod {
587 AttributeDescription *sm_desc;
588 struct berval **sm_bvalues;
591 #define Modification LDAPMod
593 #define sm_desc mod_type
594 #define sm_bvalues mod_bvalues
597 typedef struct slap_mod_list {
598 Modification sml_mod;
599 #define sml_op sml_mod.sm_op
600 #define sml_desc sml_mod.sm_desc
601 #define sml_bvalues sml_mod.sm_bvalues
602 #ifndef SLAPD_SCHEMA_NOT_COMPAT
603 #define sml_type sml_mod.sm_desc
605 struct slap_mod_list *sml_next;
608 #ifdef SLAPD_SCHEMA_NOT_COMPAT
609 typedef struct slap_ldap_modlist {
611 struct slap_ldap_modlist *ml_next;
612 #define ml_op ml_mod.mod_op
613 #define ml_type ml_mod.mod_type
614 #define ml_values ml_mod.mod_values
615 #define ml_bvalues ml_mod.mod_bvalues
618 #define LDAPModList Modifications
619 #define ml_mod sml_mod
620 #define ml_op sml_mod.mod_op
621 #define ml_type sml_mod.mod_type
622 #define ml_values sml_mod.mod_values
623 #define ml_bvalues sml_mod.mod_bvalues
624 #define ml_next sml_next
628 * represents an access control list
631 typedef enum slap_access_e {
632 ACL_INVALID_ACCESS = -1,
641 typedef enum slap_control_e {
642 ACL_INVALID_CONTROL = 0,
648 typedef unsigned long slap_access_mask_t;
651 typedef struct slap_access {
652 slap_control_t a_type;
654 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
656 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
657 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
658 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
659 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
660 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
661 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
663 #define ACL_PRIV_MASK 0x00ffUL
666 #define ACL_PRIV_LEVEL 0x1000UL
667 #define ACL_PRIV_ADDITIVE 0x2000UL
668 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
671 #define ACL_PRIV_INVALID 0x0UL
673 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
674 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
675 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
676 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
678 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
679 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
681 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
683 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
685 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
686 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
687 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
689 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
690 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
691 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
692 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
693 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
694 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
696 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
697 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
698 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
699 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
700 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
701 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
702 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
704 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
705 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
706 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
707 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
708 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
709 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
711 slap_access_mask_t a_mask;
714 #ifdef SLAPD_SCHEMA_NOT_COMPAT
715 AttributeDescription *a_dn_at;
721 char *a_peername_pat;
722 char *a_sockname_pat;
727 #ifdef SLAPD_ACI_ENABLED
728 #ifdef SLAPD_SCHEMA_NOT_COMPAT
729 AttributeDescription *a_aci_at;
738 #ifdef SLAPD_SCHEMA_NOT_COMPAT
739 AttributeDescription *a_group_at;
744 struct slap_access *a_next;
748 typedef struct slap_acl {
749 /* "to" part: the entries this acl applies to */
755 /* "by" part: list of who has what access to the entries */
758 struct slap_acl *acl_next;
762 * replog moddn param structure
764 struct replog_moddn {
772 * represents a backend
775 typedef struct slap_backend_info BackendInfo; /* per backend type */
776 typedef struct slap_backend_db BackendDB; /* per backend database */
778 LIBSLAPD_F (int) nBackendInfo;
779 LIBSLAPD_F (int) nBackendDB;
780 LIBSLAPD_F (BackendInfo *) backendInfo;
781 LIBSLAPD_F (BackendDB *) backendDB;
783 LIBSLAPD_F (int) slapMode;
784 #define SLAP_UNDEFINED_MODE 0x0000
785 #define SLAP_SERVER_MODE 0x0001
786 #define SLAP_TOOL_MODE 0x0002
787 #define SLAP_MODE 0x0003
789 #define SLAP_TRUNCATE_MODE 0x0100
791 #define SLAP_TIMED_MODE 0x1000
794 /* temporary aliases */
795 typedef BackendDB Backend;
796 #define nbackends nBackendDB
797 #define backends backendDB
799 struct slap_backend_db {
800 BackendInfo *bd_info; /* pointer to shared backend info */
802 /* BackendInfo accessors */
803 #define be_config bd_info->bi_db_config
804 #define be_type bd_info->bi_type
806 #define be_bind bd_info->bi_op_bind
807 #define be_unbind bd_info->bi_op_unbind
808 #define be_add bd_info->bi_op_add
809 #define be_compare bd_info->bi_op_compare
810 #define be_delete bd_info->bi_op_delete
811 #define be_modify bd_info->bi_op_modify
812 #define be_modrdn bd_info->bi_op_modrdn
813 #define be_search bd_info->bi_op_search
815 #define be_extended bd_info->bi_extended
817 #define be_release bd_info->bi_entry_release_rw
818 #define be_group bd_info->bi_acl_group
820 #define be_controls bd_info->bi_controls
822 #define be_connection_init bd_info->bi_connection_init
823 #define be_connection_destroy bd_info->bi_connection_destroy
826 #define be_entry_open bd_info->bi_tool_entry_open
827 #define be_entry_close bd_info->bi_tool_entry_close
828 #define be_entry_first bd_info->bi_tool_entry_first
829 #define be_entry_next bd_info->bi_tool_entry_next
830 #define be_entry_get bd_info->bi_tool_entry_get
831 #define be_entry_put bd_info->bi_tool_entry_put
832 #define be_index_attr bd_info->bi_tool_index_attr
833 #define be_index_change bd_info->bi_tool_index_change
834 #define be_sync bd_info->bi_tool_sync
837 #ifdef HAVE_CYRUS_SASL
838 #define be_sasl_authorize bd_info->bi_sasl_authorize
839 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
840 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
843 /* these should be renamed from be_ to bd_ */
844 char **be_suffix; /* the DN suffixes of data in this backend */
845 char **be_nsuffix; /* the normalized DN suffixes in this backend */
846 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
847 char *be_root_dn; /* the magic "root" dn for this db */
848 char *be_root_ndn; /* the magic "root" normalized dn for this db */
849 struct berval be_root_pw; /* the magic "root" password for this db */
850 int be_readonly; /* 1 => db is in "read only" mode */
851 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
852 int be_sizelimit; /* size limit for this backend */
853 int be_timelimit; /* time limit for this backend */
854 AccessControl *be_acl; /* access control list for this backend */
855 slap_access_t be_dfltaccess; /* access given if no acl matches */
856 char **be_replica; /* replicas of this backend (in master) */
857 char *be_replogfile; /* replication log file (in master) */
858 char *be_update_ndn; /* allowed to make changes (in replicas) */
859 struct berval **be_update_refs; /* where to refer modifying clients to */
860 int be_lastmod; /* keep track of lastmodified{by,time} */
864 void *be_private; /* anything the backend database needs */
870 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
872 struct slap_conn *conn,
875 struct berval * reqdata,
877 struct berval ** rspdata,
878 LDAPControl *** rspctrls,
880 struct berval *** refs ));
882 struct slap_backend_info {
883 char *bi_type; /* type of backend */
886 * per backend type routines:
887 * bi_init: called to allocate a backend_info structure,
888 * called once BEFORE configuration file is read.
889 * bi_init() initializes this structure hence is
890 * called directly from be_initialize()
891 * bi_config: called per 'backend' specific option
892 * all such options must before any 'database' options
893 * bi_config() is called only from read_config()
894 * bi_open: called to open each database, called
895 * once AFTER configuration file is read but
896 * BEFORE any bi_db_open() calls.
897 * bi_open() is called from backend_startup()
898 * bi_close: called to close each database, called
899 * once during shutdown after all bi_db_close calls.
900 * bi_close() is called from backend_shutdown()
901 * bi_destroy: called to destroy each database, called
902 * once during shutdown after all bi_db_destroy calls.
903 * bi_destory() is called from backend_destroy()
905 int (*bi_init) LDAP_P((BackendInfo *bi));
906 int (*bi_config) LDAP_P((BackendInfo *bi,
907 const char *fname, int lineno, int argc, char **argv ));
908 int (*bi_open) LDAP_P((BackendInfo *bi));
909 int (*bi_close) LDAP_P((BackendInfo *bi));
910 int (*bi_destroy) LDAP_P((BackendInfo *bi));
913 * per database routines:
914 * bi_db_init: called to initialize each database,
915 * called upon reading 'database <type>'
916 * called only from backend_db_init()
917 * bi_db_config: called to configure each database,
918 * called per database to handle per database options
919 * called only from read_config()
920 * bi_db_open: called to open each database
921 * called once per database immediately AFTER bi_open()
922 * calls but before daemon startup.
923 * called only by backend_startup()
924 * bi_db_close: called to close each database
925 * called once per database during shutdown but BEFORE
927 * called only by backend_shutdown()
928 * bi_db_destroy: called to destroy each database
929 * called once per database during shutdown AFTER all
930 * bi_close calls but before bi_destory calls.
931 * called only by backend_destory()
933 int (*bi_db_init) LDAP_P((Backend *bd));
934 int (*bi_db_config) LDAP_P((Backend *bd,
935 const char *fname, int lineno, int argc, char **argv ));
936 int (*bi_db_open) LDAP_P((Backend *bd));
937 int (*bi_db_close) LDAP_P((Backend *bd));
938 int (*bi_db_destroy) LDAP_P((Backend *db));
940 /* LDAP Operations Handling Routines */
941 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
942 struct slap_conn *c, struct slap_op *o,
943 const char *dn, const char *ndn, int method,
944 struct berval *cred, char** edn ));
945 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
946 struct slap_conn *c, struct slap_op *o ));
947 int (*bi_op_search) LDAP_P((BackendDB *bd,
948 struct slap_conn *c, struct slap_op *o,
949 const char *base, const char *nbase,
950 int scope, int deref,
951 int slimit, int tlimit,
952 Filter *f, const char *filterstr,
953 char **attrs, int attrsonly));
954 #ifdef SLAPD_SCHEMA_NOT_COMPAT
955 int (*bi_op_compare)LDAP_P((BackendDB *bd,
956 struct slap_conn *c, struct slap_op *o,
957 const char *dn, const char *ndn,
958 AttributeAssertion *ava));
960 int (*bi_op_compare)LDAP_P((BackendDB *bd,
961 struct slap_conn *c, struct slap_op *o,
962 const char *dn, const char *ndn,
965 int (*bi_op_modify) LDAP_P((BackendDB *bd,
966 struct slap_conn *c, struct slap_op *o,
967 const char *dn, const char *ndn, Modifications *m));
968 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
969 struct slap_conn *c, struct slap_op *o,
970 const char *dn, const char *ndn,
971 const char *newrdn, int deleteoldrdn,
972 const char *newSuperior));
973 int (*bi_op_add) LDAP_P((BackendDB *bd,
974 struct slap_conn *c, struct slap_op *o,
976 int (*bi_op_delete) LDAP_P((BackendDB *bd,
977 struct slap_conn *c, struct slap_op *o,
978 const char *dn, const char *ndn));
979 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
980 struct slap_conn *c, struct slap_op *o,
983 /* Extended Operations Helper */
984 SLAP_EXTENDED_FN bi_extended;
986 /* Auxilary Functions */
987 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
989 #ifdef SLAPD_SCHEMA_NOT_COMPAT
990 int (*bi_acl_group) LDAP_P((Backend *bd,
991 Entry *e, const char *bdn, const char *edn,
992 const char *objectclassValue,
993 AttributeDescription *group_at ));
995 int (*bi_acl_group) LDAP_P((Backend *bd,
996 Entry *e, const char *bdn, const char *edn,
997 const char *objectclassValue,
998 const char *group_at ));
1001 int (*bi_connection_init) LDAP_P((BackendDB *bd,
1002 struct slap_conn *c));
1003 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1004 struct slap_conn *c));
1006 /* hooks for slap tools */
1007 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1008 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1009 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1010 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1011 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1012 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1013 #ifdef SLAPD_SCHEMA_NOT_COMPAT
1014 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1015 AttributeDescription *desc ));
1016 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1017 AttributeDescription *desc,
1018 struct berval **bv, ID id, int op ));
1020 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1022 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1024 struct berval **bv, ID id, int op ));
1026 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1028 #ifdef HAVE_CYRUS_SASL
1029 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
1030 const char *authnid, const char *authzid,
1031 const char **canon_authzid, const char **errstr ));
1032 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
1033 const char *mechanism, const char *authzid,
1034 const char *realm, sasl_secret_t **secret ));
1035 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
1036 const char *mechanism, const char *auth_identity,
1037 const char *realm, const sasl_secret_t *secret ));
1038 #endif /* HAVE_CYRUS_SASL */
1040 #define SLAP_INDEX_ADD_OP 0x0001
1041 #define SLAP_INDEX_DELETE_OP 0x0002
1043 char **bi_controls; /* supported controls */
1045 unsigned int bi_nDB; /* number of databases of this type */
1046 void *bi_private; /* anything the backend type needs */
1050 * represents an operation pending from an ldap client
1053 typedef struct slap_op {
1054 ber_int_t o_opid; /* id of this operation */
1055 ber_int_t o_msgid; /* msgid of the request */
1057 ldap_pvt_thread_t o_tid; /* thread handling this op */
1059 BerElement *o_ber; /* ber of the request */
1061 ber_tag_t o_tag; /* tag of the request */
1062 time_t o_time; /* time op was initiated */
1065 /* should only be used for reporting purposes */
1066 char *o_authc_dn; /* authentication DN */
1068 /* should be used as the DN of the User */
1069 char *o_authz_dn; /* authorization DN */
1070 char *o_authz_ndn; /* authorizaiton NDN */
1073 char *o_dn; /* dn bound when op was initiated */
1074 char *o_ndn; /* normalized dn bound when op was initiated */
1077 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1078 ber_tag_t o_authtype; /* auth method used to bind dn */
1079 /* values taken from ldap.h */
1081 char *o_authmech; /* SASL mechanism used to bind dn */
1083 LDAPControl **o_ctrls; /* controls */
1085 unsigned long o_connid; /* id of conn initiating this op */
1087 #ifdef LDAP_CONNECTIONLESS
1088 int o_cldap; /* != 0 if this came in via CLDAP */
1089 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1090 char o_searchbase; /* search base if via CLDAP */
1093 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1094 int o_abandon; /* abandon flag */
1096 struct slap_op *o_next; /* next operation in list */
1097 void *o_private; /* anything the backend needs */
1101 * represents a connection from an ldap client
1104 typedef struct slap_conn {
1105 int c_struct_state; /* structure management state */
1106 int c_conn_state; /* connection state */
1108 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1109 Sockbuf *c_sb; /* ber connection stuff */
1111 /* only can be changed by connect_init */
1112 time_t c_starttime; /* when the connection was opened */
1113 time_t c_activitytime; /* when the connection was last used */
1114 unsigned long c_connid; /* id of this connection for stats*/
1116 char *c_listener_url; /* listener URL */
1117 char *c_peer_domain; /* DNS name of client */
1118 char *c_peer_name; /* peer name (trans=addr:port) */
1119 char *c_sock_name; /* sock name (trans=addr:port) */
1121 /* only can be changed by binding thread */
1122 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1123 char *c_sasl_bind_mech; /* mech in progress */
1124 #ifdef HAVE_CYRUS_SASL
1125 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1128 /* authentication backend */
1129 Backend *c_authc_backend;
1131 /* authorization backend - normally same as c_authc_backend */
1132 Backend *c_authz_backend;
1135 /* authentication backend */
1136 /* should only be used for reporting purposes */
1137 char *c_authc_dn; /* authentication DN */
1139 /* should be used as the DN of the User */
1140 char *c_authz_dn; /* authorization DN */
1141 char *c_authz_ndn; /* authorization NDN */
1144 char *c_cdn; /* DN provided by the client */
1145 char *c_dn; /* DN bound to this conn */
1148 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1149 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1150 char *c_authmech; /* SASL mechanism used to bind c_dn */
1152 Operation *c_ops; /* list of operations being processed */
1153 Operation *c_pending_ops; /* list of pending operations */
1155 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1156 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1158 BerElement *c_currentber; /* ber we're attempting to read */
1159 int c_writewaiter; /* true if writer is waiting */
1162 int c_is_tls; /* true if this LDAP over raw TLS */
1163 int c_needs_tls_accept; /* true if SSL_accept should be called */
1166 long c_n_ops_received; /* num of ops received (next op_id) */
1167 long c_n_ops_executing; /* num of ops currently executing */
1168 long c_n_ops_pending; /* num of ops pending execution */
1169 long c_n_ops_completed; /* num of ops completed */
1171 long c_n_get; /* num of get calls */
1172 long c_n_read; /* num of read calls */
1173 long c_n_write; /* num of write calls */
1176 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1177 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1179 if ( ldap_debug & (level) ) \
1180 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1181 if ( ldap_syslog & (level) ) \
1182 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1186 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1191 #include "proto-slap.h"
1193 #endif /* _SLAP_H_ */