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 in schema_init.c */
97 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
98 #define SLAPD_GROUP_ATTR "member"
99 #define SLAPD_GROUP_CLASS "groupOfNames"
100 #define SLAPD_ROLE_ATTR "roleOccupant"
101 #define SLAPD_ROLE_CLASS "organizationalRole"
103 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
104 #define SLAPD_ACI_ATTR "OpenLDAPaci"
106 LIBSLAPD_F (int) slap_debug;
111 #define SLAP_INDEX_PRESENCE 0x0001U
112 #define SLAP_INDEX_EQUALITY 0x0002U
113 #define SLAP_INDEX_APPROX 0x0004U
114 #define SLAP_INDEX_SUBSTR 0x0008U
115 #define SLAP_INDEX_EXTENDED 0x0010U
116 #define SLAP_INDEX_UNDEFINED 0x1000U
117 #define SLAP_INDEX_FROMINIT 0x8000U /* psuedo type */
120 * represents schema information for a database
122 #define SLAP_SCHERR_OUTOFMEM 1
123 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
124 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
125 #define SLAP_SCHERR_DUP_CLASS 4
126 #define SLAP_SCHERR_DUP_ATTR 5
127 #define SLAP_SCHERR_DUP_SYNTAX 6
128 #define SLAP_SCHERR_DUP_RULE 7
129 #define SLAP_SCHERR_NO_NAME 8
130 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
131 #define SLAP_SCHERR_MR_NOT_FOUND 10
132 #define SLAP_SCHERR_SYN_NOT_FOUND 11
133 #define SLAP_SCHERR_MR_INCOMPLETE 12
135 typedef struct slap_oid_macro {
136 struct berval som_oid;
138 struct slap_oid_macro *som_next;
141 /* forward declarations */
143 struct slap_matching_rule;
145 typedef int slap_syntax_validate_func LDAP_P((
146 struct slap_syntax *syntax,
147 struct berval * in));
149 typedef int slap_syntax_transform_func LDAP_P((
150 struct slap_syntax *syntax,
152 struct berval ** out));
154 typedef struct slap_syntax {
155 LDAP_SYNTAX ssyn_syn;
156 #define ssyn_oid ssyn_syn.syn_oid
157 #define ssyn_desc ssyn_syn.syn_desc
158 #define ssyn_extensions ssyn_syn.syn_extensions
162 #define SLAP_SYNTAX_NONE 0x00U
163 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
164 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
165 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
166 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
168 slap_syntax_validate_func *ssyn_validate;
169 slap_syntax_transform_func *ssyn_normalize;
170 slap_syntax_transform_func *ssyn_pretty;
172 #ifdef SLAPD_BINARY_CONVERSION
173 /* convert to and from binary */
174 slap_syntax_transform_func *ssyn_ber2str;
175 slap_syntax_transform_func *ssyn_str2ber;
178 struct slap_syntax *ssyn_next;
181 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
182 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
183 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
184 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
185 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
187 /* XXX -> UCS-2 Converter */
188 typedef int slap_mr_convert_func LDAP_P((
190 struct berval ** out ));
193 typedef int slap_mr_normalize_func LDAP_P((
195 struct slap_syntax *syntax, /* NULL if in is asserted value */
196 struct slap_matching_rule *mr,
198 struct berval ** out ));
200 /* Match (compare) function */
201 typedef int slap_mr_match_func LDAP_P((
204 struct slap_syntax *syntax, /* syntax of stored value */
205 struct slap_matching_rule *mr,
206 struct berval * value,
207 void * assertValue ));
209 /* Index generation function */
210 typedef int slap_mr_indexer_func LDAP_P((
212 struct slap_syntax *syntax, /* syntax of stored value */
213 struct slap_matching_rule *mr,
214 struct berval **values,
215 struct berval **keys ));
217 struct slap_filter; /* forward declaration */
219 /* Filter index function */
220 typedef int slap_mr_filter_func LDAP_P((
222 struct slap_syntax *syntax, /* syntax of stored value */
223 struct slap_matching_rule *mr,
224 struct slap_filter *filter,
225 struct berval **keys ));
227 typedef struct slap_matching_rule {
228 LDAP_MATCHING_RULE smr_mrule;
231 #define SLAP_MR_TYPE_MASK 0xFF00U
232 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
234 #define SLAP_MR_NONE 0x0000U
235 #define SLAP_MR_EQUALITY 0x0100U
236 #define SLAP_MR_ORDERING 0x0200U
237 #define SLAP_MR_SUBSTR 0x0400U
238 #define SLAP_MR_EXT 0x0800U
240 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
242 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
243 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
244 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
247 slap_mr_convert_func *smr_convert;
248 slap_mr_normalize_func *smr_normalize;
249 slap_mr_match_func *smr_match;
250 slap_mr_indexer_func *smr_indexer;
251 slap_mr_filter_func *smr_filter;
252 struct slap_matching_rule *smr_next;
253 #define smr_oid smr_mrule.mr_oid
254 #define smr_names smr_mrule.mr_names
255 #define smr_desc smr_mrule.mr_desc
256 #define smr_obsolete smr_mrule.mr_obsolete
257 #define smr_syntax_oid smr_mrule.mr_syntax_oid
258 #define smr_extensions smr_mrule.mr_extensions
261 typedef struct slap_attribute_type {
262 #ifdef SLAPD_SCHEMA_NOT_COMPAT
265 LDAP_ATTRIBUTE_TYPE sat_atype;
266 struct slap_attribute_type *sat_sup;
267 struct slap_attribute_type **sat_subtypes;
268 MatchingRule *sat_equality;
269 MatchingRule *sat_ordering;
270 MatchingRule *sat_substr;
272 #ifndef SLAPD_SCHEMA_NOT_COMPAT
273 /* The next one is created to help in the transition */
274 int sat_syntax_compat;
276 struct slap_attribute_type *sat_next;
277 #define sat_oid sat_atype.at_oid
278 #define sat_names sat_atype.at_names
279 #define sat_desc sat_atype.at_desc
280 #define sat_obsolete sat_atype.at_obsolete
281 #define sat_sup_oid sat_atype.at_sup_oid
282 #define sat_equality_oid sat_atype.at_equality_oid
283 #define sat_ordering_oid sat_atype.at_ordering_oid
284 #define sat_substr_oid sat_atype.at_substr_oid
285 #define sat_syntax_oid sat_atype.at_syntax_oid
286 #define sat_single_value sat_atype.at_single_value
287 #define sat_collective sat_atype.at_collective
288 #define sat_no_user_mod sat_atype.at_no_user_mod
289 #define sat_usage sat_atype.at_usage
290 #define sat_extensions sat_atype.at_extensions
293 #define is_at_operational(at) ((at)->sat_usage)
294 #define is_at_single_value(at) ((at)->sat_single_value)
295 #define is_at_collective(at) ((at)->sat_collective)
296 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
298 typedef struct slap_object_class {
299 LDAP_OBJECT_CLASS soc_oclass;
300 struct slap_object_class **soc_sups;
301 AttributeType **soc_required;
302 AttributeType **soc_allowed;
303 struct slap_object_class *soc_next;
304 #define soc_oid soc_oclass.oc_oid
305 #define soc_names soc_oclass.oc_names
306 #define soc_desc soc_oclass.oc_desc
307 #define soc_obsolete soc_oclass.oc_obsolete
308 #define soc_sup_oids soc_oclass.oc_sup_oids
309 #define soc_kind soc_oclass.oc_kind
310 #define soc_at_oids_must soc_oclass.oc_at_oids_must
311 #define soc_at_oids_may soc_oclass.oc_at_oids_may
312 #define soc_extensions soc_oclass.oc_extensions
316 #ifdef SLAPD_SCHEMA_NOT_COMPAT
318 * represents a recognized attribute description ( type + options )
320 typedef struct slap_attr_desc {
321 struct berval *ad_cname; /* canonical name */
322 AttributeType *ad_type; /* NULL if unknown */
323 char *ad_lang; /* NULL if no language tags */
325 #define SLAP_DESC_NONE 0x0U
326 #define SLAP_DESC_BINARY 0x1U
327 } AttributeDescription;
329 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
332 * pointers to schema elements used internally
334 struct slap_internal_schema {
336 ObjectClass *si_oc_top;
337 ObjectClass *si_oc_extensibleObject;
338 ObjectClass *si_oc_alias;
339 ObjectClass *si_oc_referral;
340 ObjectClass *si_oc_subentry;
341 ObjectClass *si_oc_subschema;
342 ObjectClass *si_oc_rootdse;
344 /* objectClass attribute */
345 AttributeDescription *si_ad_objectClass;
347 /* operational attributes */
348 AttributeDescription *si_ad_creatorsName;
349 AttributeDescription *si_ad_createTimestamp;
350 AttributeDescription *si_ad_modifiersName;
351 AttributeDescription *si_ad_modifyTimestamp;
352 AttributeDescription *si_ad_subschemaSubentry;
354 /* root DSE attributes */
355 AttributeDescription *si_ad_namingContexts;
356 AttributeDescription *si_ad_supportedControl;
357 AttributeDescription *si_ad_supportedExtension;
358 AttributeDescription *si_ad_supportedLDAPVersion;
359 AttributeDescription *si_ad_supportedSASLMechanisms;
361 /* subschema subentry attributes */
362 AttributeDescription *si_ad_objectClasses;
363 AttributeDescription *si_ad_attributeTypes;
364 AttributeDescription *si_ad_ldapSyntaxes;
365 AttributeDescription *si_ad_matchingRules;
366 AttributeDescription *si_ad_matchingRulesUse;
368 /* Aliases & Referrals */
369 AttributeDescription *si_ad_aliasedObjectName;
370 AttributeDescription *si_ad_ref;
372 /* Access Control Internals */
373 AttributeDescription *si_ad_entry;
374 AttributeDescription *si_ad_children;
375 #ifdef SLAPD_ACI_ENABLED
376 AttributeDescription *si_ad_aci;
380 AttributeDescription *si_ad_userPassword;
381 AttributeDescription *si_ad_authPassword;
382 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
383 AttributeDescription *si_ad_krbName;
387 typedef struct slap_attr_assertion {
388 AttributeDescription *aa_desc;
389 struct berval *aa_value;
390 } AttributeAssertion;
392 typedef struct slap_ss_assertion {
393 AttributeDescription *sa_desc;
394 struct berval *sa_initial;
395 struct berval **sa_any;
396 struct berval *sa_final;
397 } SubstringsAssertion;
399 typedef struct slap_mr_assertion {
400 char *ma_rule; /* optional */
401 AttributeDescription *ma_desc; /* optional */
402 int ma_dnattrs; /* boolean */
403 struct berval *ma_value; /* required */
404 } MatchingRuleAssertion;
409 * represents an attribute value assertion (i.e., attr;option=value)
411 typedef struct slap_ava {
412 char *ava_type; /* attribute description */
413 struct berval ava_value;
417 * represents an matching rule assertion
419 typedef struct slap_mra {
420 char *mra_rule; /* optional */
421 char *mra_type; /* attribute description -- optional */
423 struct berval *mra_value;
429 * represents a search filter
432 typedef struct slap_filter {
433 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
434 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
435 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
436 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
440 /* precomputed result */
441 ber_int_t f_un_result;
443 #ifdef SLAPD_SCHEMA_NOT_COMPAT
448 AttributeDescription *f_un_desc;
450 /* simple value assertion */
451 AttributeAssertion *f_un_ava;
453 /* substring assertion */
454 SubstringsAssertion *f_un_ssa;
456 /* matching rule assertion */
457 MatchingRuleAssertion *f_un_mra;
459 #define f_dn f_un.f_un_dn
460 #define f_desc f_un.f_un_desc
461 #define f_ava f_un.f_un_ava
462 #define f_av_desc f_un.f_un_ava->aa_desc
463 #define f_av_value f_un.f_un_ava->aa_value
464 #define f_sub f_un.f_un_ssa
465 #define f_sub_desc f_un.f_un_ssa->sa_desc
466 #define f_sub_initial f_un.f_un_ssa->sa_initial
467 #define f_sub_any f_un.f_un_ssa->sa_any
468 #define f_sub_final f_un.f_un_ssa->sa_final
469 #define f_mra f_un.f_un_mra
470 #define f_mr_rule f_un.f_un_mra->ma_rule
471 #define f_mr_desc f_un.f_un_mra->ma_desc
472 #define f_mr_value f_un.f_un_mra->ma_value
473 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
478 /* equality, lessorequal, greaterorequal, approx */
488 struct berval *f_un_sub_initial;
489 struct berval **f_un_sub_any;
490 struct berval *f_un_sub_final;
493 #define f_dn f_un.f_un_type /* used for DN indices */
494 #define f_type f_un.f_un_type
495 #define f_ava f_un.f_un_ava
496 #define f_avtype f_un.f_un_ava.ava_type
497 #define f_avvalue f_un.f_un_ava.ava_value
498 #define f_mra f_un.f_un_mra
499 #define f_mrtype f_un.f_un_mra.mra_type
500 #define f_mrvalue f_un.f_un_mra.mra_value
501 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
502 #define f_sub f_un.f_un_sub
503 #define f_sub_type f_un.f_un_sub.f_un_sub_type
504 #define f_sub_desc f_sub_type
505 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
506 #define f_sub_any f_un.f_un_sub.f_un_sub_any
507 #define f_sub_final f_un.f_un_sub.f_un_sub_final
511 struct slap_filter *f_un_complex;
514 #define f_result f_un.f_un_result
515 #define f_and f_un.f_un_complex
516 #define f_or f_un.f_un_complex
517 #define f_not f_un.f_un_complex
518 #define f_list f_un.f_un_complex
520 struct slap_filter *f_next;
523 /* compare routines can return undefined */
524 #define SLAPD_COMPARE_UNDEFINED ((ber_tag_t) -1)
527 * represents an attribute (description + values)
529 typedef struct slap_attr {
530 #ifdef SLAPD_SCHEMA_NOT_COMPAT
531 AttributeDescription *a_desc;
533 char *a_type; /* description */
536 struct berval **a_vals;
537 struct slap_attr *a_next;
540 #ifndef SLAPD_SCHEMA_NOT_COMPAT
542 * the attr_syntax() routine returns one of these values
543 * telling what kind of syntax an attribute supports.
545 #define SYNTAX_CIS 0x01 /* case insensitive string */
546 #define SYNTAX_CES 0x02 /* case sensitive string */
547 #define SYNTAX_BIN 0x04 /* binary data */
548 #define SYNTAX_TEL 0x08 /* telephone number string */
549 #define SYNTAX_DN 0x10 /* dn string */
553 * the id used in the indexes to refer to an entry
555 typedef unsigned long ID;
556 #define NOID ((ID)~0)
559 * represents an entry in core
561 typedef struct slap_entry {
563 * The ID field should only be changed before entry is
564 * inserted into a cache. The ID value is backend
569 char *e_dn; /* DN of this entry */
570 char *e_ndn; /* normalized DN of this entry */
571 Attribute *e_attrs; /* list of attributes + values */
573 /* for use by the backend for any purpose */
580 #ifdef SLAPD_SCHEMA_NOT_COMPAT
581 typedef struct slap_mod {
583 AttributeDescription *sm_desc;
584 struct berval **sm_bvalues;
587 #define Modification LDAPMod
589 #define sm_desc mod_type
590 #define sm_bvalues mod_bvalues
593 typedef struct slap_mod_list {
594 Modification sml_mod;
595 #define sml_op sml_mod.sm_op
596 #define sml_desc sml_mod.sm_desc
597 #define sml_bvalues sml_mod.sm_bvalues
598 #ifndef SLAPD_SCHEMA_NOT_COMPAT
599 #define sml_type sml_mod.sm_desc
601 struct slap_mod_list *sml_next;
604 #ifdef SLAPD_SCHEMA_NOT_COMPAT
605 typedef struct slap_ldap_modlist {
607 struct slap_ldap_modlist *ml_next;
608 #define ml_op ml_mod.mod_op
609 #define ml_type ml_mod.mod_type
610 #define ml_values ml_mod.mod_values
611 #define ml_bvalues ml_mod.mod_bvalues
614 #define LDAPModList Modifications
615 #define ml_mod sml_mod
616 #define ml_op sml_mod.mod_op
617 #define ml_type sml_mod.mod_type
618 #define ml_values sml_mod.mod_values
619 #define ml_bvalues sml_mod.mod_bvalues
620 #define ml_next sml_next
624 * represents an access control list
627 typedef enum slap_access_e {
628 ACL_INVALID_ACCESS = -1,
637 typedef enum slap_control_e {
638 ACL_INVALID_CONTROL = 0,
644 typedef unsigned long slap_access_mask_t;
647 typedef struct slap_access {
648 slap_control_t a_type;
650 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
652 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
653 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
654 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
655 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
656 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
657 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
659 #define ACL_PRIV_MASK 0x00ffUL
662 #define ACL_PRIV_LEVEL 0x1000UL
663 #define ACL_PRIV_ADDITIVE 0x2000UL
664 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
667 #define ACL_PRIV_INVALID 0x0UL
669 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
670 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
671 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
672 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
674 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
675 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
677 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
679 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
681 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
682 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
683 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
685 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
686 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
687 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
688 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
689 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
690 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
692 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
693 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
694 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
695 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
696 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
697 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
698 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
700 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
701 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
702 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
703 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
704 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
705 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
707 slap_access_mask_t a_mask;
710 #ifdef SLAPD_SCHEMA_NOT_COMPAT
711 AttributeDescription *a_dn_at;
717 char *a_peername_pat;
718 char *a_sockname_pat;
723 #ifdef SLAPD_ACI_ENABLED
724 #ifdef SLAPD_SCHEMA_NOT_COMPAT
725 AttributeDescription *a_aci_at;
733 #ifdef SLAPD_SCHEMA_NOT_COMPAT
734 ObjectClass *a_group_oc;
735 AttributeDescription *a_group_at;
741 struct slap_access *a_next;
745 typedef struct slap_acl {
746 /* "to" part: the entries this acl applies to */
752 /* "by" part: list of who has what access to the entries */
755 struct slap_acl *acl_next;
759 * replog moddn param structure
761 struct replog_moddn {
769 * represents a backend
772 typedef struct slap_backend_info BackendInfo; /* per backend type */
773 typedef struct slap_backend_db BackendDB; /* per backend database */
775 LIBSLAPD_F (int) nBackendInfo;
776 LIBSLAPD_F (int) nBackendDB;
777 LIBSLAPD_F (BackendInfo *) backendInfo;
778 LIBSLAPD_F (BackendDB *) backendDB;
780 LIBSLAPD_F (int) slapMode;
781 #define SLAP_UNDEFINED_MODE 0x0000
782 #define SLAP_SERVER_MODE 0x0001
783 #define SLAP_TOOL_MODE 0x0002
784 #define SLAP_MODE 0x0003
786 #define SLAP_TRUNCATE_MODE 0x0100
788 #define SLAP_TIMED_MODE 0x1000
791 /* temporary aliases */
792 typedef BackendDB Backend;
793 #define nbackends nBackendDB
794 #define backends backendDB
796 struct slap_backend_db {
797 BackendInfo *bd_info; /* pointer to shared backend info */
799 /* BackendInfo accessors */
800 #define be_config bd_info->bi_db_config
801 #define be_type bd_info->bi_type
803 #define be_bind bd_info->bi_op_bind
804 #define be_unbind bd_info->bi_op_unbind
805 #define be_add bd_info->bi_op_add
806 #define be_compare bd_info->bi_op_compare
807 #define be_delete bd_info->bi_op_delete
808 #define be_modify bd_info->bi_op_modify
809 #define be_modrdn bd_info->bi_op_modrdn
810 #define be_search bd_info->bi_op_search
812 #define be_extended bd_info->bi_extended
814 #define be_release bd_info->bi_entry_release_rw
815 #define be_group bd_info->bi_acl_group
817 #define be_controls bd_info->bi_controls
819 #define be_connection_init bd_info->bi_connection_init
820 #define be_connection_destroy bd_info->bi_connection_destroy
823 #define be_entry_open bd_info->bi_tool_entry_open
824 #define be_entry_close bd_info->bi_tool_entry_close
825 #define be_entry_first bd_info->bi_tool_entry_first
826 #define be_entry_next bd_info->bi_tool_entry_next
827 #define be_entry_get bd_info->bi_tool_entry_get
828 #define be_entry_put bd_info->bi_tool_entry_put
829 #define be_index_attr bd_info->bi_tool_index_attr
830 #define be_index_change bd_info->bi_tool_index_change
831 #define be_sync bd_info->bi_tool_sync
834 #ifdef HAVE_CYRUS_SASL
835 #define be_sasl_authorize bd_info->bi_sasl_authorize
836 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
837 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
840 /* these should be renamed from be_ to bd_ */
841 char **be_suffix; /* the DN suffixes of data in this backend */
842 char **be_nsuffix; /* the normalized DN suffixes in this backend */
843 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
844 char *be_root_dn; /* the magic "root" dn for this db */
845 char *be_root_ndn; /* the magic "root" normalized dn for this db */
846 struct berval be_root_pw; /* the magic "root" password for this db */
847 int be_readonly; /* 1 => db is in "read only" mode */
848 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
849 int be_sizelimit; /* size limit for this backend */
850 int be_timelimit; /* time limit for this backend */
851 AccessControl *be_acl; /* access control list for this backend */
852 slap_access_t be_dfltaccess; /* access given if no acl matches */
853 char **be_replica; /* replicas of this backend (in master) */
854 char *be_replogfile; /* replication log file (in master) */
855 char *be_update_ndn; /* allowed to make changes (in replicas) */
856 struct berval **be_update_refs; /* where to refer modifying clients to */
857 int be_lastmod; /* keep track of lastmodified{by,time} */
861 void *be_private; /* anything the backend database needs */
867 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
869 struct slap_conn *conn,
872 struct berval * reqdata,
874 struct berval ** rspdata,
875 LDAPControl *** rspctrls,
877 struct berval *** refs ));
879 struct slap_backend_info {
880 char *bi_type; /* type of backend */
883 * per backend type routines:
884 * bi_init: called to allocate a backend_info structure,
885 * called once BEFORE configuration file is read.
886 * bi_init() initializes this structure hence is
887 * called directly from be_initialize()
888 * bi_config: called per 'backend' specific option
889 * all such options must before any 'database' options
890 * bi_config() is called only from read_config()
891 * bi_open: called to open each database, called
892 * once AFTER configuration file is read but
893 * BEFORE any bi_db_open() calls.
894 * bi_open() is called from backend_startup()
895 * bi_close: called to close each database, called
896 * once during shutdown after all bi_db_close calls.
897 * bi_close() is called from backend_shutdown()
898 * bi_destroy: called to destroy each database, called
899 * once during shutdown after all bi_db_destroy calls.
900 * bi_destory() is called from backend_destroy()
902 int (*bi_init) LDAP_P((BackendInfo *bi));
903 int (*bi_config) LDAP_P((BackendInfo *bi,
904 const char *fname, int lineno, int argc, char **argv ));
905 int (*bi_open) LDAP_P((BackendInfo *bi));
906 int (*bi_close) LDAP_P((BackendInfo *bi));
907 int (*bi_destroy) LDAP_P((BackendInfo *bi));
910 * per database routines:
911 * bi_db_init: called to initialize each database,
912 * called upon reading 'database <type>'
913 * called only from backend_db_init()
914 * bi_db_config: called to configure each database,
915 * called per database to handle per database options
916 * called only from read_config()
917 * bi_db_open: called to open each database
918 * called once per database immediately AFTER bi_open()
919 * calls but before daemon startup.
920 * called only by backend_startup()
921 * bi_db_close: called to close each database
922 * called once per database during shutdown but BEFORE
924 * called only by backend_shutdown()
925 * bi_db_destroy: called to destroy each database
926 * called once per database during shutdown AFTER all
927 * bi_close calls but before bi_destory calls.
928 * called only by backend_destory()
930 int (*bi_db_init) LDAP_P((Backend *bd));
931 int (*bi_db_config) LDAP_P((Backend *bd,
932 const char *fname, int lineno, int argc, char **argv ));
933 int (*bi_db_open) LDAP_P((Backend *bd));
934 int (*bi_db_close) LDAP_P((Backend *bd));
935 int (*bi_db_destroy) LDAP_P((Backend *db));
937 /* LDAP Operations Handling Routines */
938 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
939 struct slap_conn *c, struct slap_op *o,
940 const char *dn, const char *ndn, int method,
941 struct berval *cred, char** edn ));
942 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
943 struct slap_conn *c, struct slap_op *o ));
944 int (*bi_op_search) LDAP_P((BackendDB *bd,
945 struct slap_conn *c, struct slap_op *o,
946 const char *base, const char *nbase,
947 int scope, int deref,
948 int slimit, int tlimit,
949 Filter *f, const char *filterstr,
950 char **attrs, int attrsonly));
951 #ifdef SLAPD_SCHEMA_NOT_COMPAT
952 int (*bi_op_compare)LDAP_P((BackendDB *bd,
953 struct slap_conn *c, struct slap_op *o,
954 const char *dn, const char *ndn,
955 AttributeAssertion *ava));
957 int (*bi_op_compare)LDAP_P((BackendDB *bd,
958 struct slap_conn *c, struct slap_op *o,
959 const char *dn, const char *ndn,
962 int (*bi_op_modify) LDAP_P((BackendDB *bd,
963 struct slap_conn *c, struct slap_op *o,
964 const char *dn, const char *ndn, Modifications *m));
965 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
966 struct slap_conn *c, struct slap_op *o,
967 const char *dn, const char *ndn,
968 const char *newrdn, int deleteoldrdn,
969 const char *newSuperior));
970 int (*bi_op_add) LDAP_P((BackendDB *bd,
971 struct slap_conn *c, struct slap_op *o,
973 int (*bi_op_delete) LDAP_P((BackendDB *bd,
974 struct slap_conn *c, struct slap_op *o,
975 const char *dn, const char *ndn));
976 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
977 struct slap_conn *c, struct slap_op *o,
980 /* Extended Operations Helper */
981 SLAP_EXTENDED_FN bi_extended;
983 /* Auxilary Functions */
984 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
986 #ifdef SLAPD_SCHEMA_NOT_COMPAT
987 int (*bi_acl_group) LDAP_P((Backend *bd,
988 Entry *e, const char *bdn, const char *edn,
989 ObjectClass *group_oc,
990 AttributeDescription *group_at ));
992 int (*bi_acl_group) LDAP_P((Backend *bd,
993 Entry *e, const char *bdn, const char *edn,
994 const char *group_oc,
995 const char *group_at ));
998 int (*bi_connection_init) LDAP_P((BackendDB *bd,
999 struct slap_conn *c));
1000 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1001 struct slap_conn *c));
1003 /* hooks for slap tools */
1004 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1005 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1006 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1007 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1008 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1009 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1010 #ifdef SLAPD_SCHEMA_NOT_COMPAT
1011 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1012 AttributeDescription *desc ));
1013 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1014 AttributeDescription *desc,
1015 struct berval **bv, ID id, int op ));
1017 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1019 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1021 struct berval **bv, ID id, int op ));
1023 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1025 #ifdef HAVE_CYRUS_SASL
1026 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
1027 const char *authnid, const char *authzid,
1028 const char **canon_authzid, const char **errstr ));
1029 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
1030 const char *mechanism, const char *authzid,
1031 const char *realm, sasl_secret_t **secret ));
1032 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
1033 const char *mechanism, const char *auth_identity,
1034 const char *realm, const sasl_secret_t *secret ));
1035 #endif /* HAVE_CYRUS_SASL */
1037 #define SLAP_INDEX_ADD_OP 0x0001
1038 #define SLAP_INDEX_DELETE_OP 0x0002
1040 char **bi_controls; /* supported controls */
1042 unsigned int bi_nDB; /* number of databases of this type */
1043 void *bi_private; /* anything the backend type needs */
1047 * represents an operation pending from an ldap client
1050 typedef struct slap_op {
1051 ber_int_t o_opid; /* id of this operation */
1052 ber_int_t o_msgid; /* msgid of the request */
1054 ldap_pvt_thread_t o_tid; /* thread handling this op */
1056 BerElement *o_ber; /* ber of the request */
1058 ber_tag_t o_tag; /* tag of the request */
1059 time_t o_time; /* time op was initiated */
1062 /* should only be used for reporting purposes */
1063 char *o_authc_dn; /* authentication DN */
1065 /* should be used as the DN of the User */
1066 char *o_authz_dn; /* authorization DN */
1067 char *o_authz_ndn; /* authorizaiton NDN */
1070 char *o_dn; /* dn bound when op was initiated */
1071 char *o_ndn; /* normalized dn bound when op was initiated */
1074 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1075 ber_tag_t o_authtype; /* auth method used to bind dn */
1076 /* values taken from ldap.h */
1078 char *o_authmech; /* SASL mechanism used to bind dn */
1080 LDAPControl **o_ctrls; /* controls */
1082 unsigned long o_connid; /* id of conn initiating this op */
1084 #ifdef LDAP_CONNECTIONLESS
1085 int o_cldap; /* != 0 if this came in via CLDAP */
1086 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1087 char o_searchbase; /* search base if via CLDAP */
1090 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1091 int o_abandon; /* abandon flag */
1093 struct slap_op *o_next; /* next operation in list */
1094 void *o_private; /* anything the backend needs */
1098 * represents a connection from an ldap client
1101 typedef struct slap_conn {
1102 int c_struct_state; /* structure management state */
1103 int c_conn_state; /* connection state */
1105 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1106 Sockbuf *c_sb; /* ber connection stuff */
1108 /* only can be changed by connect_init */
1109 time_t c_starttime; /* when the connection was opened */
1110 time_t c_activitytime; /* when the connection was last used */
1111 unsigned long c_connid; /* id of this connection for stats*/
1113 char *c_listener_url; /* listener URL */
1114 char *c_peer_domain; /* DNS name of client */
1115 char *c_peer_name; /* peer name (trans=addr:port) */
1116 char *c_sock_name; /* sock name (trans=addr:port) */
1118 /* only can be changed by binding thread */
1119 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1120 char *c_sasl_bind_mech; /* mech in progress */
1121 #ifdef HAVE_CYRUS_SASL
1122 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1125 /* authentication backend */
1126 Backend *c_authc_backend;
1128 /* authorization backend - normally same as c_authc_backend */
1129 Backend *c_authz_backend;
1132 /* authentication backend */
1133 /* should only be used for reporting purposes */
1134 char *c_authc_dn; /* authentication DN */
1136 /* should be used as the DN of the User */
1137 char *c_authz_dn; /* authorization DN */
1138 char *c_authz_ndn; /* authorization NDN */
1141 char *c_cdn; /* DN provided by the client */
1142 char *c_dn; /* DN bound to this conn */
1145 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1146 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1147 char *c_authmech; /* SASL mechanism used to bind c_dn */
1149 Operation *c_ops; /* list of operations being processed */
1150 Operation *c_pending_ops; /* list of pending operations */
1152 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1153 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1155 BerElement *c_currentber; /* ber we're attempting to read */
1156 int c_writewaiter; /* true if writer is waiting */
1159 int c_is_tls; /* true if this LDAP over raw TLS */
1160 int c_needs_tls_accept; /* true if SSL_accept should be called */
1163 long c_n_ops_received; /* num of ops received (next op_id) */
1164 long c_n_ops_executing; /* num of ops currently executing */
1165 long c_n_ops_pending; /* num of ops pending execution */
1166 long c_n_ops_completed; /* num of ops completed */
1168 long c_n_get; /* num of get calls */
1169 long c_n_read; /* num of read calls */
1170 long c_n_write; /* num of write calls */
1173 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1174 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1176 if ( ldap_debug & (level) ) \
1177 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1178 if ( ldap_syslog & (level) ) \
1179 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1183 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1188 #include "proto-slap.h"
1190 #endif /* _SLAP_H_ */