1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
13 #include <ac/stdlib.h>
15 #include <sys/types.h>
16 #include <ac/syslog.h>
18 #include <ac/socket.h>
22 #ifdef HAVE_CYRUS_SASL
29 #define ldap_debug slap_debug
36 #include <ldap_schema.h>
38 #include "ldap_pvt_thread.h"
43 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
44 #define SLAPD_ANONYMOUS "<anonymous>"
47 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
50 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
52 * This is a value used internally by the backends. It is needed to allow
53 * adding values that already exist without getting an error as required by
54 * modrdn when the new rdn was already an attribute value itself.
55 * JCG 05/1999 (gomez@engr.sgi.com)
57 #define SLAP_MOD_SOFTADD 0x1000
63 #define MAXREMATCHES 10
66 /* psuedo error code indicating abandoned operation */
67 #define SLAPD_ABANDON (-1)
69 /* psuedo error code indicating disconnect */
70 #define SLAPD_DISCONNECT (-2)
73 /* We assume "C" locale, that is US-ASCII */
74 #define ASCII_SPACE(c) ( (c) == ' ' )
75 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
76 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
77 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
78 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
79 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
81 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
82 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
83 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
85 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
86 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
87 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
88 #define OID_CHAR(c) ( ASCII_DIGIT(c) || (c) == '.' )
90 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
91 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
93 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
94 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
96 /* must match syntaxes in schema_init.c */
97 #define SLAPD_OID_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
98 #define SLAPD_OID_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
99 #define SLAPD_ACI_DEFAULT_ATTR "aci"
101 LIBSLAPD_F (int) slap_debug;
106 #define SLAP_INDEX_PRESENCE 0x0001U
107 #define SLAP_INDEX_EQUALITY 0x0002U
108 #define SLAP_INDEX_APPROX 0x0004U
109 #define SLAP_INDEX_SUBSTR 0x0008U
110 #define SLAP_INDEX_EXTENDED 0x0010U
111 #define SLAP_INDEX_UNDEFINED 0x1000U
112 #define SLAP_INDEX_FROMINIT 0x8000U /* psuedo type */
115 * represents schema information for a database
117 #define SLAP_SCHERR_OUTOFMEM 1
118 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
119 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
120 #define SLAP_SCHERR_DUP_CLASS 4
121 #define SLAP_SCHERR_DUP_ATTR 5
122 #define SLAP_SCHERR_DUP_SYNTAX 6
123 #define SLAP_SCHERR_DUP_RULE 7
124 #define SLAP_SCHERR_NO_NAME 8
125 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
126 #define SLAP_SCHERR_MR_NOT_FOUND 10
127 #define SLAP_SCHERR_SYN_NOT_FOUND 11
128 #define SLAP_SCHERR_MR_INCOMPLETE 12
130 typedef struct slap_oid_macro {
131 struct berval som_oid;
133 struct slap_oid_macro *som_next;
136 /* forward declarations */
138 struct slap_matching_rule;
140 typedef int slap_syntax_validate_func LDAP_P((
141 struct slap_syntax *syntax,
142 struct berval * in));
144 typedef int slap_syntax_transform_func LDAP_P((
145 struct slap_syntax *syntax,
147 struct berval ** out));
149 typedef struct slap_syntax {
150 LDAP_SYNTAX ssyn_syn;
151 #define ssyn_oid ssyn_syn.syn_oid
152 #define ssyn_desc ssyn_syn.syn_desc
153 #define ssyn_extensions ssyn_syn.syn_extensions
157 #define SLAP_SYNTAX_NONE 0x00U
158 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
159 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
160 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
161 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
163 slap_syntax_validate_func *ssyn_validate;
164 slap_syntax_transform_func *ssyn_normalize;
165 slap_syntax_transform_func *ssyn_pretty;
167 #ifdef SLAPD_BINARY_CONVERSION
168 /* convert to and from binary */
169 slap_syntax_transform_func *ssyn_ber2str;
170 slap_syntax_transform_func *ssyn_str2ber;
173 struct slap_syntax *ssyn_next;
176 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
177 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
178 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
179 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
180 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
182 /* XXX -> UCS-2 Converter */
183 typedef int slap_mr_convert_func LDAP_P((
185 struct berval ** out ));
188 typedef int slap_mr_normalize_func LDAP_P((
190 struct slap_syntax *syntax, /* NULL if in is asserted value */
191 struct slap_matching_rule *mr,
193 struct berval ** out ));
195 /* Match (compare) function */
196 typedef int slap_mr_match_func LDAP_P((
199 struct slap_syntax *syntax, /* syntax of stored value */
200 struct slap_matching_rule *mr,
201 struct berval * value,
202 void * assertValue ));
204 /* Index generation function */
205 typedef int slap_mr_indexer_func LDAP_P((
207 struct slap_syntax *syntax, /* syntax of stored value */
208 struct slap_matching_rule *mr,
209 struct berval **values,
210 struct berval **keys ));
212 struct slap_filter; /* forward declaration */
214 /* Filter index function */
215 typedef int slap_mr_filter_func LDAP_P((
217 struct slap_syntax *syntax, /* syntax of stored value */
218 struct slap_matching_rule *mr,
219 struct slap_filter *filter,
220 struct berval **keys ));
222 typedef struct slap_matching_rule {
223 LDAP_MATCHING_RULE smr_mrule;
226 #define SLAP_MR_TYPE_MASK 0xFF00U
227 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
229 #define SLAP_MR_NONE 0x0000U
230 #define SLAP_MR_EQUALITY 0x0100U
231 #define SLAP_MR_ORDERING 0x0200U
232 #define SLAP_MR_SUBSTR 0x0400U
233 #define SLAP_MR_EXT 0x0800U
235 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
237 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
238 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
239 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
242 slap_mr_convert_func *smr_convert;
243 slap_mr_normalize_func *smr_normalize;
244 slap_mr_match_func *smr_match;
245 slap_mr_indexer_func *smr_indexer;
246 slap_mr_filter_func *smr_filter;
247 struct slap_matching_rule *smr_next;
248 #define smr_oid smr_mrule.mr_oid
249 #define smr_names smr_mrule.mr_names
250 #define smr_desc smr_mrule.mr_desc
251 #define smr_obsolete smr_mrule.mr_obsolete
252 #define smr_syntax_oid smr_mrule.mr_syntax_oid
253 #define smr_extensions smr_mrule.mr_extensions
256 typedef struct slap_attribute_type {
257 #ifdef SLAPD_SCHEMA_NOT_COMPAT
260 LDAP_ATTRIBUTE_TYPE sat_atype;
261 struct slap_attribute_type *sat_sup;
262 struct slap_attribute_type **sat_subtypes;
263 MatchingRule *sat_equality;
264 MatchingRule *sat_ordering;
265 MatchingRule *sat_substr;
267 #ifndef SLAPD_SCHEMA_NOT_COMPAT
268 /* The next one is created to help in the transition */
269 int sat_syntax_compat;
271 struct slap_attribute_type *sat_next;
272 #define sat_oid sat_atype.at_oid
273 #define sat_names sat_atype.at_names
274 #define sat_desc sat_atype.at_desc
275 #define sat_obsolete sat_atype.at_obsolete
276 #define sat_sup_oid sat_atype.at_sup_oid
277 #define sat_equality_oid sat_atype.at_equality_oid
278 #define sat_ordering_oid sat_atype.at_ordering_oid
279 #define sat_substr_oid sat_atype.at_substr_oid
280 #define sat_syntax_oid sat_atype.at_syntax_oid
281 #define sat_single_value sat_atype.at_single_value
282 #define sat_collective sat_atype.at_collective
283 #define sat_no_user_mod sat_atype.at_no_user_mod
284 #define sat_usage sat_atype.at_usage
285 #define sat_extensions sat_atype.at_extensions
288 #define is_at_operational(at) ((at)->sat_usage)
289 #define is_at_single_value(at) ((at)->sat_single_value)
290 #define is_at_collective(at) ((at)->sat_collective)
291 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
293 typedef struct slap_object_class {
294 LDAP_OBJECT_CLASS soc_oclass;
295 struct slap_object_class **soc_sups;
296 AttributeType **soc_required;
297 AttributeType **soc_allowed;
298 struct slap_object_class *soc_next;
299 #define soc_oid soc_oclass.oc_oid
300 #define soc_names soc_oclass.oc_names
301 #define soc_desc soc_oclass.oc_desc
302 #define soc_obsolete soc_oclass.oc_obsolete
303 #define soc_sup_oids soc_oclass.oc_sup_oids
304 #define soc_kind soc_oclass.oc_kind
305 #define soc_at_oids_must soc_oclass.oc_at_oids_must
306 #define soc_at_oids_may soc_oclass.oc_at_oids_may
307 #define soc_extensions soc_oclass.oc_extensions
311 #ifdef SLAPD_SCHEMA_NOT_COMPAT
313 * represents a recognized attribute description ( type + options )
315 typedef struct slap_attr_desc {
316 struct berval *ad_cname; /* canonical name */
317 AttributeType *ad_type; /* NULL if unknown */
318 char *ad_lang; /* NULL if no language tags */
320 #define SLAP_DESC_NONE 0x0U
321 #define SLAP_DESC_BINARY 0x1U
322 } AttributeDescription;
324 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
327 * pointers to schema elements used internally
329 struct slap_internal_schema {
331 ObjectClass *si_oc_top;
332 ObjectClass *si_oc_alias;
333 ObjectClass *si_oc_referral;
334 ObjectClass *si_oc_subentry;
335 ObjectClass *si_oc_subschema;
336 ObjectClass *si_oc_rootdse;
338 /* objectClass attribute */
339 AttributeDescription *si_ad_objectClass;
341 /* operational attributes */
342 AttributeDescription *si_ad_creatorsName;
343 AttributeDescription *si_ad_createTimestamp;
344 AttributeDescription *si_ad_modifiersName;
345 AttributeDescription *si_ad_modifyTimestamp;
346 AttributeDescription *si_ad_subschemaSubentry;
348 /* root DSE attributes */
349 AttributeDescription *si_ad_namingContexts;
350 AttributeDescription *si_ad_supportedControl;
351 AttributeDescription *si_ad_supportedExtension;
352 AttributeDescription *si_ad_supportedLDAPVersion;
353 #ifdef SLAPD_ACI_ENABLED
354 AttributeDescription *si_ad_supportedACIMechanisms;
356 AttributeDescription *si_ad_supportedSASLMechanisms;
358 /* subschema subentry attributes */
359 AttributeDescription *si_ad_objectClasses;
360 AttributeDescription *si_ad_attributeTypes;
361 AttributeDescription *si_ad_ldapSyntaxes;
362 AttributeDescription *si_ad_matchingRules;
363 AttributeDescription *si_ad_matchingRulesUse;
365 /* Aliases & Referrals */
366 AttributeDescription *si_ad_aliasedObjectName;
367 AttributeDescription *si_ad_ref;
369 /* Access Control Internals */
370 AttributeDescription *si_ad_entry;
371 AttributeDescription *si_ad_children;
374 AttributeDescription *si_ad_userPassword;
375 AttributeDescription *si_ad_authPassword;
376 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
377 AttributeDescription *si_ad_krbName;
381 typedef struct slap_attr_assertion {
382 AttributeDescription *aa_desc;
383 struct berval *aa_value;
384 } AttributeAssertion;
386 typedef struct slap_ss_assertion {
387 AttributeDescription *sa_desc;
388 struct berval *sa_initial;
389 struct berval **sa_any;
390 struct berval *sa_final;
391 } SubstringsAssertion;
393 typedef struct slap_mr_assertion {
394 char *ma_rule; /* optional */
395 AttributeDescription *ma_desc; /* optional */
396 int ma_dnattrs; /* boolean */
397 struct berval *ma_value; /* required */
398 } MatchingRuleAssertion;
403 * represents an attribute value assertion (i.e., attr;option=value)
405 typedef struct slap_ava {
406 char *ava_type; /* attribute description */
407 struct berval ava_value;
411 * represents an matching rule assertion
413 typedef struct slap_mra {
414 char *mra_rule; /* optional */
415 char *mra_type; /* attribute description -- optional */
417 struct berval *mra_value;
423 * represents a search filter
426 typedef struct slap_filter {
427 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
428 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
429 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
430 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
434 /* precomputed result */
435 ber_int_t f_un_result;
437 #ifdef SLAPD_SCHEMA_NOT_COMPAT
442 AttributeDescription *f_un_desc;
444 /* simple value assertion */
445 AttributeAssertion *f_un_ava;
447 /* substring assertion */
448 SubstringsAssertion *f_un_ssa;
450 /* matching rule assertion */
451 MatchingRuleAssertion *f_un_mra;
453 #define f_dn f_un.f_un_dn
454 #define f_desc f_un.f_un_desc
455 #define f_ava f_un.f_un_ava
456 #define f_av_desc f_un.f_un_ava->aa_desc
457 #define f_av_value f_un.f_un_ava->aa_value
458 #define f_sub f_un.f_un_ssa
459 #define f_sub_desc f_un.f_un_ssa->sa_desc
460 #define f_sub_initial f_un.f_un_ssa->sa_initial
461 #define f_sub_any f_un.f_un_ssa->sa_any
462 #define f_sub_final f_un.f_un_ssa->sa_final
463 #define f_mra f_un.f_un_mra
464 #define f_mr_rule f_un.f_un_mra->ma_rule
465 #define f_mr_desc f_un.f_un_mra->ma_desc
466 #define f_mr_value f_un.f_un_mra->ma_value
467 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
472 /* equality, lessorequal, greaterorequal, approx */
482 struct berval *f_un_sub_initial;
483 struct berval **f_un_sub_any;
484 struct berval *f_un_sub_final;
487 #define f_dn f_un.f_un_type /* used for DN indices */
488 #define f_type f_un.f_un_type
489 #define f_ava f_un.f_un_ava
490 #define f_avtype f_un.f_un_ava.ava_type
491 #define f_avvalue f_un.f_un_ava.ava_value
492 #define f_mra f_un.f_un_mra
493 #define f_mrtype f_un.f_un_mra.mra_type
494 #define f_mrvalue f_un.f_un_mra.mra_value
495 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
496 #define f_sub f_un.f_un_sub
497 #define f_sub_type f_un.f_un_sub.f_un_sub_type
498 #define f_sub_desc f_sub_type
499 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
500 #define f_sub_any f_un.f_un_sub.f_un_sub_any
501 #define f_sub_final f_un.f_un_sub.f_un_sub_final
505 struct slap_filter *f_un_complex;
508 #define f_result f_un.f_un_result
509 #define f_and f_un.f_un_complex
510 #define f_or f_un.f_un_complex
511 #define f_not f_un.f_un_complex
512 #define f_list f_un.f_un_complex
514 struct slap_filter *f_next;
517 /* compare routines can return undefined */
518 #define SLAPD_COMPARE_UNDEFINED ((ber_tag_t) -1)
521 * represents an attribute (description + values)
523 typedef struct slap_attr {
524 #ifdef SLAPD_SCHEMA_NOT_COMPAT
525 AttributeDescription *a_desc;
527 char *a_type; /* description */
530 struct berval **a_vals;
531 struct slap_attr *a_next;
534 #ifndef SLAPD_SCHEMA_NOT_COMPAT
536 * the attr_syntax() routine returns one of these values
537 * telling what kind of syntax an attribute supports.
539 #define SYNTAX_CIS 0x01 /* case insensitive string */
540 #define SYNTAX_CES 0x02 /* case sensitive string */
541 #define SYNTAX_BIN 0x04 /* binary data */
542 #define SYNTAX_TEL 0x08 /* telephone number string */
543 #define SYNTAX_DN 0x10 /* dn string */
547 * the id used in the indexes to refer to an entry
549 typedef unsigned long ID;
550 #define NOID ((ID)~0)
553 * represents an entry in core
555 typedef struct slap_entry {
557 * The ID field should only be changed before entry is
558 * inserted into a cache. The ID value is backend
563 char *e_dn; /* DN of this entry */
564 char *e_ndn; /* normalized DN of this entry */
565 Attribute *e_attrs; /* list of attributes + values */
567 /* for use by the backend for any purpose */
574 #ifdef SLAPD_SCHEMA_NOT_COMPAT
575 typedef struct slap_mod {
577 AttributeDescription *sm_desc;
578 struct berval **sm_bvalues;
581 #define Modification LDAPMod
583 #define sm_desc mod_type
584 #define sm_bvalues mod_bvalues
587 typedef struct slap_mod_list {
588 Modification sml_mod;
589 #define sml_op sml_mod.sm_op
590 #define sml_desc sml_mod.sm_desc
591 #define sml_bvalues sml_mod.sm_bvalues
592 #ifndef SLAPD_SCHEMA_NOT_COMPAT
593 #define sml_type sml_mod.sm_desc
595 struct slap_mod_list *sml_next;
598 #ifdef SLAPD_SCHEMA_NOT_COMPAT
599 typedef struct slap_ldap_modlist {
601 struct slap_ldap_modlist *ml_next;
602 #define ml_op ml_mod.mod_op
603 #define ml_type ml_mod.mod_type
604 #define ml_values ml_mod.mod_values
605 #define ml_bvalues ml_mod.mod_bvalues
608 #define LDAPModList Modifications
609 #define ml_mod sml_mod
610 #define ml_op sml_mod.mod_op
611 #define ml_type sml_mod.mod_type
612 #define ml_values sml_mod.mod_values
613 #define ml_bvalues sml_mod.mod_bvalues
614 #define ml_next sml_next
618 * represents an access control list
621 typedef enum slap_access_e {
622 ACL_INVALID_ACCESS = -1,
631 typedef enum slap_control_e {
632 ACL_INVALID_CONTROL = 0,
638 typedef unsigned long slap_access_mask_t;
641 typedef struct slap_access {
642 slap_control_t a_type;
644 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
646 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
647 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
648 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
649 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
650 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
651 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
653 #define ACL_PRIV_MASK 0x00ffUL
656 #define ACL_PRIV_LEVEL 0x1000UL
657 #define ACL_PRIV_ADDITIVE 0x2000UL
658 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
661 #define ACL_PRIV_INVALID 0x0UL
663 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
664 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
665 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
666 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
668 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
669 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
671 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
673 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
675 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
676 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
677 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
679 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
680 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
681 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
682 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
683 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
684 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
686 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
687 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
688 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
689 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
690 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
691 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
692 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
694 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
695 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
696 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
697 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
698 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
699 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
701 slap_access_mask_t a_mask;
704 #ifdef SLAPD_SCHEMA_NOT_COMPAT
705 AttributeDescription *a_dn_at;
711 char *a_peername_pat;
712 char *a_sockname_pat;
717 #ifdef SLAPD_ACI_ENABLED
718 #ifdef SLAPD_SCHEMA_NOT_COMPAT
719 AttributeDescription *a_aci_at;
727 #ifdef SLAPD_SCHEMA_NOT_COMPAT
728 ObjectClass *a_group_oc;
729 AttributeDescription *a_group_at;
735 struct slap_access *a_next;
739 typedef struct slap_acl {
740 /* "to" part: the entries this acl applies to */
746 /* "by" part: list of who has what access to the entries */
749 struct slap_acl *acl_next;
753 * replog moddn param structure
755 struct replog_moddn {
763 * represents a backend
766 typedef struct slap_backend_info BackendInfo; /* per backend type */
767 typedef struct slap_backend_db BackendDB; /* per backend database */
769 LIBSLAPD_F (int) nBackendInfo;
770 LIBSLAPD_F (int) nBackendDB;
771 LIBSLAPD_F (BackendInfo *) backendInfo;
772 LIBSLAPD_F (BackendDB *) backendDB;
774 LIBSLAPD_F (int) slapMode;
775 #define SLAP_UNDEFINED_MODE 0x0000
776 #define SLAP_SERVER_MODE 0x0001
777 #define SLAP_TOOL_MODE 0x0002
778 #define SLAP_MODE 0x0003
780 #define SLAP_TRUNCATE_MODE 0x0100
782 #define SLAP_TIMED_MODE 0x1000
785 /* temporary aliases */
786 typedef BackendDB Backend;
787 #define nbackends nBackendDB
788 #define backends backendDB
790 struct slap_backend_db {
791 BackendInfo *bd_info; /* pointer to shared backend info */
793 /* BackendInfo accessors */
794 #define be_config bd_info->bi_db_config
795 #define be_type bd_info->bi_type
797 #define be_bind bd_info->bi_op_bind
798 #define be_unbind bd_info->bi_op_unbind
799 #define be_add bd_info->bi_op_add
800 #define be_compare bd_info->bi_op_compare
801 #define be_delete bd_info->bi_op_delete
802 #define be_modify bd_info->bi_op_modify
803 #define be_modrdn bd_info->bi_op_modrdn
804 #define be_search bd_info->bi_op_search
806 #define be_extended bd_info->bi_extended
808 #define be_release bd_info->bi_entry_release_rw
809 #define be_group bd_info->bi_acl_group
811 #define be_controls bd_info->bi_controls
813 #define be_connection_init bd_info->bi_connection_init
814 #define be_connection_destroy bd_info->bi_connection_destroy
817 #define be_entry_open bd_info->bi_tool_entry_open
818 #define be_entry_close bd_info->bi_tool_entry_close
819 #define be_entry_first bd_info->bi_tool_entry_first
820 #define be_entry_next bd_info->bi_tool_entry_next
821 #define be_entry_get bd_info->bi_tool_entry_get
822 #define be_entry_put bd_info->bi_tool_entry_put
823 #define be_index_attr bd_info->bi_tool_index_attr
824 #define be_index_change bd_info->bi_tool_index_change
825 #define be_sync bd_info->bi_tool_sync
828 #ifdef HAVE_CYRUS_SASL
829 #define be_sasl_authorize bd_info->bi_sasl_authorize
830 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
831 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
834 /* these should be renamed from be_ to bd_ */
835 char **be_suffix; /* the DN suffixes of data in this backend */
836 char **be_nsuffix; /* the normalized DN suffixes in this backend */
837 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
838 char *be_root_dn; /* the magic "root" dn for this db */
839 char *be_root_ndn; /* the magic "root" normalized dn for this db */
840 struct berval be_root_pw; /* the magic "root" password for this db */
841 int be_readonly; /* 1 => db is in "read only" mode */
842 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
843 int be_sizelimit; /* size limit for this backend */
844 int be_timelimit; /* time limit for this backend */
845 AccessControl *be_acl; /* access control list for this backend */
846 slap_access_t be_dfltaccess; /* access given if no acl matches */
847 char **be_replica; /* replicas of this backend (in master) */
848 char *be_replogfile; /* replication log file (in master) */
849 char *be_update_ndn; /* allowed to make changes (in replicas) */
850 struct berval **be_update_refs; /* where to refer modifying clients to */
851 int be_lastmod; /* keep track of lastmodified{by,time} */
855 void *be_private; /* anything the backend database needs */
861 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
863 struct slap_conn *conn,
866 struct berval * reqdata,
868 struct berval ** rspdata,
869 LDAPControl *** rspctrls,
871 struct berval *** refs ));
873 struct slap_backend_info {
874 char *bi_type; /* type of backend */
877 * per backend type routines:
878 * bi_init: called to allocate a backend_info structure,
879 * called once BEFORE configuration file is read.
880 * bi_init() initializes this structure hence is
881 * called directly from be_initialize()
882 * bi_config: called per 'backend' specific option
883 * all such options must before any 'database' options
884 * bi_config() is called only from read_config()
885 * bi_open: called to open each database, called
886 * once AFTER configuration file is read but
887 * BEFORE any bi_db_open() calls.
888 * bi_open() is called from backend_startup()
889 * bi_close: called to close each database, called
890 * once during shutdown after all bi_db_close calls.
891 * bi_close() is called from backend_shutdown()
892 * bi_destroy: called to destroy each database, called
893 * once during shutdown after all bi_db_destroy calls.
894 * bi_destory() is called from backend_destroy()
896 int (*bi_init) LDAP_P((BackendInfo *bi));
897 int (*bi_config) LDAP_P((BackendInfo *bi,
898 const char *fname, int lineno, int argc, char **argv ));
899 int (*bi_open) LDAP_P((BackendInfo *bi));
900 int (*bi_close) LDAP_P((BackendInfo *bi));
901 int (*bi_destroy) LDAP_P((BackendInfo *bi));
904 * per database routines:
905 * bi_db_init: called to initialize each database,
906 * called upon reading 'database <type>'
907 * called only from backend_db_init()
908 * bi_db_config: called to configure each database,
909 * called per database to handle per database options
910 * called only from read_config()
911 * bi_db_open: called to open each database
912 * called once per database immediately AFTER bi_open()
913 * calls but before daemon startup.
914 * called only by backend_startup()
915 * bi_db_close: called to close each database
916 * called once per database during shutdown but BEFORE
918 * called only by backend_shutdown()
919 * bi_db_destroy: called to destroy each database
920 * called once per database during shutdown AFTER all
921 * bi_close calls but before bi_destory calls.
922 * called only by backend_destory()
924 int (*bi_db_init) LDAP_P((Backend *bd));
925 int (*bi_db_config) LDAP_P((Backend *bd,
926 const char *fname, int lineno, int argc, char **argv ));
927 int (*bi_db_open) LDAP_P((Backend *bd));
928 int (*bi_db_close) LDAP_P((Backend *bd));
929 int (*bi_db_destroy) LDAP_P((Backend *db));
931 /* LDAP Operations Handling Routines */
932 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
933 struct slap_conn *c, struct slap_op *o,
934 const char *dn, const char *ndn, int method,
935 struct berval *cred, char** edn ));
936 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
937 struct slap_conn *c, struct slap_op *o ));
938 int (*bi_op_search) LDAP_P((BackendDB *bd,
939 struct slap_conn *c, struct slap_op *o,
940 const char *base, const char *nbase,
941 int scope, int deref,
942 int slimit, int tlimit,
943 Filter *f, const char *filterstr,
944 char **attrs, int attrsonly));
945 #ifdef SLAPD_SCHEMA_NOT_COMPAT
946 int (*bi_op_compare)LDAP_P((BackendDB *bd,
947 struct slap_conn *c, struct slap_op *o,
948 const char *dn, const char *ndn,
949 AttributeAssertion *ava));
951 int (*bi_op_compare)LDAP_P((BackendDB *bd,
952 struct slap_conn *c, struct slap_op *o,
953 const char *dn, const char *ndn,
956 int (*bi_op_modify) LDAP_P((BackendDB *bd,
957 struct slap_conn *c, struct slap_op *o,
958 const char *dn, const char *ndn, Modifications *m));
959 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
960 struct slap_conn *c, struct slap_op *o,
961 const char *dn, const char *ndn,
962 const char *newrdn, int deleteoldrdn,
963 const char *newSuperior));
964 int (*bi_op_add) LDAP_P((BackendDB *bd,
965 struct slap_conn *c, struct slap_op *o,
967 int (*bi_op_delete) LDAP_P((BackendDB *bd,
968 struct slap_conn *c, struct slap_op *o,
969 const char *dn, const char *ndn));
970 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
971 struct slap_conn *c, struct slap_op *o,
974 /* Extended Operations Helper */
975 SLAP_EXTENDED_FN bi_extended;
977 /* Auxilary Functions */
978 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
980 #ifdef SLAPD_SCHEMA_NOT_COMPAT
981 int (*bi_acl_group) LDAP_P((Backend *bd,
982 Entry *e, const char *bdn, const char *edn,
983 ObjectClass *group_oc,
984 AttributeDescription *group_at ));
986 int (*bi_acl_group) LDAP_P((Backend *bd,
987 Entry *e, const char *bdn, const char *edn,
988 const char *group_oc,
989 const char *group_at ));
992 int (*bi_connection_init) LDAP_P((BackendDB *bd,
993 struct slap_conn *c));
994 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
995 struct slap_conn *c));
997 /* hooks for slap tools */
998 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
999 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1000 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1001 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1002 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1003 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1004 #ifdef SLAPD_SCHEMA_NOT_COMPAT
1005 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1006 AttributeDescription *desc ));
1007 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1008 AttributeDescription *desc,
1009 struct berval **bv, ID id, int op ));
1011 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1013 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1015 struct berval **bv, ID id, int op ));
1017 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1019 #ifdef HAVE_CYRUS_SASL
1020 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
1021 const char *authnid, const char *authzid,
1022 const char **canon_authzid, const char **errstr ));
1023 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
1024 const char *mechanism, const char *authzid,
1025 const char *realm, sasl_secret_t **secret ));
1026 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
1027 const char *mechanism, const char *auth_identity,
1028 const char *realm, const sasl_secret_t *secret ));
1029 #endif /* HAVE_CYRUS_SASL */
1031 #define SLAP_INDEX_ADD_OP 0x0001
1032 #define SLAP_INDEX_DELETE_OP 0x0002
1034 char **bi_controls; /* supported controls */
1036 unsigned int bi_nDB; /* number of databases of this type */
1037 void *bi_private; /* anything the backend type needs */
1041 * represents an operation pending from an ldap client
1044 typedef struct slap_op {
1045 ber_int_t o_opid; /* id of this operation */
1046 ber_int_t o_msgid; /* msgid of the request */
1048 ldap_pvt_thread_t o_tid; /* thread handling this op */
1050 BerElement *o_ber; /* ber of the request */
1052 ber_tag_t o_tag; /* tag of the request */
1053 time_t o_time; /* time op was initiated */
1056 /* should only be used for reporting purposes */
1057 char *o_authc_dn; /* authentication DN */
1059 /* should be used as the DN of the User */
1060 char *o_authz_dn; /* authorization DN */
1061 char *o_authz_ndn; /* authorizaiton NDN */
1064 char *o_dn; /* dn bound when op was initiated */
1065 char *o_ndn; /* normalized dn bound when op was initiated */
1068 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1069 ber_tag_t o_authtype; /* auth method used to bind dn */
1070 /* values taken from ldap.h */
1072 char *o_authmech; /* SASL mechanism used to bind dn */
1074 LDAPControl **o_ctrls; /* controls */
1076 unsigned long o_connid; /* id of conn initiating this op */
1078 #ifdef LDAP_CONNECTIONLESS
1079 int o_cldap; /* != 0 if this came in via CLDAP */
1080 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1081 char o_searchbase; /* search base if via CLDAP */
1084 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1085 int o_abandon; /* abandon flag */
1087 struct slap_op *o_next; /* next operation in list */
1088 void *o_private; /* anything the backend needs */
1092 * represents a connection from an ldap client
1095 typedef struct slap_conn {
1096 int c_struct_state; /* structure management state */
1097 int c_conn_state; /* connection state */
1099 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1100 Sockbuf *c_sb; /* ber connection stuff */
1102 /* only can be changed by connect_init */
1103 time_t c_starttime; /* when the connection was opened */
1104 time_t c_activitytime; /* when the connection was last used */
1105 unsigned long c_connid; /* id of this connection for stats*/
1107 char *c_listener_url; /* listener URL */
1108 char *c_peer_domain; /* DNS name of client */
1109 char *c_peer_name; /* peer name (trans=addr:port) */
1110 char *c_sock_name; /* sock name (trans=addr:port) */
1112 /* only can be changed by binding thread */
1113 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1114 char *c_sasl_bind_mech; /* mech in progress */
1115 #ifdef HAVE_CYRUS_SASL
1116 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1119 /* authentication backend */
1120 Backend *c_authc_backend;
1122 /* authorization backend - normally same as c_authc_backend */
1123 Backend *c_authz_backend;
1126 /* authentication backend */
1127 /* should only be used for reporting purposes */
1128 char *c_authc_dn; /* authentication DN */
1130 /* should be used as the DN of the User */
1131 char *c_authz_dn; /* authorization DN */
1132 char *c_authz_ndn; /* authorization NDN */
1135 char *c_cdn; /* DN provided by the client */
1136 char *c_dn; /* DN bound to this conn */
1139 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1140 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1141 char *c_authmech; /* SASL mechanism used to bind c_dn */
1143 Operation *c_ops; /* list of operations being processed */
1144 Operation *c_pending_ops; /* list of pending operations */
1146 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1147 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1149 BerElement *c_currentber; /* ber we're attempting to read */
1150 int c_writewaiter; /* true if writer is waiting */
1153 int c_is_tls; /* true if this LDAP over raw TLS */
1154 int c_needs_tls_accept; /* true if SSL_accept should be called */
1157 long c_n_ops_received; /* num of ops received (next op_id) */
1158 long c_n_ops_executing; /* num of ops currently executing */
1159 long c_n_ops_pending; /* num of ops pending execution */
1160 long c_n_ops_completed; /* num of ops completed */
1162 long c_n_get; /* num of get calls */
1163 long c_n_read; /* num of read calls */
1164 long c_n_write; /* num of write calls */
1167 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1168 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1170 if ( ldap_debug & (level) ) \
1171 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1172 if ( ldap_syslog & (level) ) \
1173 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1177 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1182 #include "proto-slap.h"
1184 #endif /* _SLAP_H_ */