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 #define SLAPD_ACI_DEFAULT_ATTR "aci"
98 /* schema needed by slapd */
99 #define SLAPD_OID_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
100 #define SLAPD_OID_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1" /* experimental */
102 LIBSLAPD_F (int) slap_debug;
107 #define SLAP_INDEX_PRESENCE 0x0001U
108 #define SLAP_INDEX_EQUALITY 0x0002U
109 #define SLAP_INDEX_APPROX 0x0004U
110 #define SLAP_INDEX_SUBSTR 0x0008U
111 #define SLAP_INDEX_EXTENDED 0x0010U
112 #define SLAP_INDEX_UNDEFINED 0x1000U
113 #define SLAP_INDEX_FROMINIT 0x8000U /* psuedo type */
116 * represents schema information for a database
118 #define SLAP_SCHERR_OUTOFMEM 1
119 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
120 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
121 #define SLAP_SCHERR_DUP_CLASS 4
122 #define SLAP_SCHERR_DUP_ATTR 5
123 #define SLAP_SCHERR_DUP_SYNTAX 6
124 #define SLAP_SCHERR_DUP_RULE 7
125 #define SLAP_SCHERR_NO_NAME 8
126 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
127 #define SLAP_SCHERR_MR_NOT_FOUND 10
128 #define SLAP_SCHERR_SYN_NOT_FOUND 11
129 #define SLAP_SCHERR_MR_INCOMPLETE 12
131 typedef struct slap_oid_macro {
132 struct berval som_oid;
134 struct slap_oid_macro *som_next;
137 /* forward declarations */
139 struct slap_matching_rule;
141 typedef int slap_syntax_validate_func LDAP_P((
142 struct slap_syntax *syntax,
143 struct berval * in));
145 typedef int slap_syntax_transform_func LDAP_P((
146 struct slap_syntax *syntax,
148 struct berval ** out));
150 typedef struct slap_syntax {
151 LDAP_SYNTAX ssyn_syn;
152 #define ssyn_oid ssyn_syn.syn_oid
153 #define ssyn_desc ssyn_syn.syn_desc
154 #define ssyn_extensions ssyn_syn.syn_extensions
158 #define SLAP_SYNTAX_NONE 0x0U
159 #define SLAP_SYNTAX_BLOB 0x1U /* syntax treated as blob (audio) */
160 #define SLAP_SYNTAX_BINARY 0x2U /* binary transfer required (certificate) */
161 #define SLAP_SYNTAX_BER 0x4U /* stored using BER encoding (binary,certificate) */
163 slap_syntax_validate_func *ssyn_validate;
165 #ifdef SLAPD_BINARY_CONVERSION
166 /* convert to and from binary */
167 slap_syntax_transform_func *ssyn_ber2str;
168 slap_syntax_transform_func *ssyn_str2ber;
171 struct slap_syntax *ssyn_next;
174 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
175 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
176 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
177 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
179 /* XXX -> UCS-2 Converter */
180 typedef int slap_mr_convert_func LDAP_P((
182 struct berval ** out ));
185 typedef int slap_mr_normalize_func LDAP_P((
187 struct slap_syntax *syntax, /* NULL if in is asserted value */
188 struct slap_matching_rule *mr,
190 struct berval ** out ));
192 /* Match (compare) function */
193 typedef int slap_mr_match_func LDAP_P((
195 struct slap_syntax *syntax, /* syntax of stored value */
196 struct slap_matching_rule *mr,
197 struct berval * value,
198 void * assertValue ));
200 /* Index generation function */
201 typedef int slap_mr_indexer_func LDAP_P((
203 struct slap_syntax *syntax, /* syntax of stored value */
204 struct slap_matching_rule *mr,
205 struct berval **values,
206 struct berval **keys ));
208 struct slap_filter; /* forward declaration */
210 /* Filter index function */
211 typedef int slap_mr_filter_func LDAP_P((
213 struct slap_syntax *syntax, /* syntax of stored value */
214 struct slap_matching_rule *mr,
215 struct slap_filter *filter,
216 struct berval **keys ));
218 typedef struct slap_matching_rule {
219 LDAP_MATCHING_RULE smr_mrule;
222 #define SLAP_MR_TYPE_MASK 0xFF00U
223 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
225 #define SLAP_MR_NONE 0x0000U
226 #define SLAP_MR_EQUALITY 0x0100U
227 #define SLAP_MR_ORDERING 0x0200U
228 #define SLAP_MR_SUBSTR 0x0400U
229 #define SLAP_MR_EXT 0x0800U
231 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
233 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
234 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
235 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
238 slap_mr_convert_func *smr_convert;
239 slap_mr_normalize_func *smr_normalize;
240 slap_mr_match_func *smr_match;
241 slap_mr_indexer_func *smr_indexer;
242 slap_mr_filter_func *smr_filter;
243 struct slap_matching_rule *smr_next;
244 #define smr_oid smr_mrule.mr_oid
245 #define smr_names smr_mrule.mr_names
246 #define smr_desc smr_mrule.mr_desc
247 #define smr_obsolete smr_mrule.mr_obsolete
248 #define smr_syntax_oid smr_mrule.mr_syntax_oid
249 #define smr_extensions smr_mrule.mr_extensions
252 typedef struct slap_attribute_type {
253 #ifdef SLAPD_SCHEMA_NOT_COMPAT
256 LDAP_ATTRIBUTE_TYPE sat_atype;
257 struct slap_attribute_type *sat_sup;
258 struct slap_attribute_type **sat_subtypes;
259 MatchingRule *sat_equality;
260 MatchingRule *sat_ordering;
261 MatchingRule *sat_substr;
263 #ifndef SLAPD_SCHEMA_NOT_COMPAT
264 /* The next one is created to help in the transition */
265 int sat_syntax_compat;
267 struct slap_attribute_type *sat_next;
268 #define sat_oid sat_atype.at_oid
269 #define sat_names sat_atype.at_names
270 #define sat_desc sat_atype.at_desc
271 #define sat_obsolete sat_atype.at_obsolete
272 #define sat_sup_oid sat_atype.at_sup_oid
273 #define sat_equality_oid sat_atype.at_equality_oid
274 #define sat_ordering_oid sat_atype.at_ordering_oid
275 #define sat_substr_oid sat_atype.at_substr_oid
276 #define sat_syntax_oid sat_atype.at_syntax_oid
277 #define sat_single_value sat_atype.at_single_value
278 #define sat_collective sat_atype.at_collective
279 #define sat_no_user_mod sat_atype.at_no_user_mod
280 #define sat_usage sat_atype.at_usage
281 #define sat_extensions sat_atype.at_extensions
284 #define is_at_operational(at) ((at)->sat_usage)
285 #define is_at_single_value(at) ((at)->sat_single_value)
286 #define is_at_collective(at) ((at)->sat_collective)
287 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
289 typedef struct slap_object_class {
290 LDAP_OBJECT_CLASS soc_oclass;
291 struct slap_object_class **soc_sups;
292 AttributeType **soc_required;
293 AttributeType **soc_allowed;
294 struct slap_object_class *soc_next;
295 #define soc_oid soc_oclass.oc_oid
296 #define soc_names soc_oclass.oc_names
297 #define soc_desc soc_oclass.oc_desc
298 #define soc_obsolete soc_oclass.oc_obsolete
299 #define soc_sup_oids soc_oclass.oc_sup_oids
300 #define soc_kind soc_oclass.oc_kind
301 #define soc_at_oids_must soc_oclass.oc_at_oids_must
302 #define soc_at_oids_may soc_oclass.oc_at_oids_may
303 #define soc_extensions soc_oclass.oc_extensions
307 #ifdef SLAPD_SCHEMA_NOT_COMPAT
309 * represents a recognized attribute description ( type + options )
311 typedef struct slap_attr_desc {
312 struct berval *ad_cname; /* canonical name */
313 AttributeType *ad_type; /* NULL if unknown */
314 char *ad_lang; /* NULL if no language tags */
316 #define SLAP_DESC_NONE 0x0U
317 #define SLAP_DESC_BINARY 0x1U
318 } AttributeDescription;
320 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
323 * pointers to schema elements used internally
325 struct slap_internal_schema {
327 ObjectClass *si_oc_alias;
328 ObjectClass *si_oc_referral;
330 /* objectClass attribute */
331 AttributeDescription *si_ad_objectClass;
333 /* operational attributes */
334 AttributeDescription *si_ad_creatorsName;
335 AttributeDescription *si_ad_createTimestamp;
336 AttributeDescription *si_ad_modifiersName;
337 AttributeDescription *si_ad_modifyTimestamp;
338 AttributeDescription *si_ad_subschemaSubentry;
340 /* root DSE attributes */
341 AttributeDescription *si_ad_namingContexts;
342 AttributeDescription *si_ad_supportedControl;
343 AttributeDescription *si_ad_supportedExtension;
344 AttributeDescription *si_ad_supportedLDAPVersion;
345 #ifdef SLAPD_ACI_ENABLED
346 AttributeDescription *si_ad_supportedACIMechanisms;
348 AttributeDescription *si_ad_supportedSASLMechanisms;
350 /* subschema subentry attributes */
351 AttributeDescription *si_ad_objectClasses;
352 AttributeDescription *si_ad_attributeTypes;
353 AttributeDescription *si_ad_ldapSyntaxes;
354 AttributeDescription *si_ad_matchingRules;
355 AttributeDescription *si_ad_matchingRulesUse;
357 /* Aliases & Referrals */
358 AttributeDescription *si_ad_aliasedObjectName;
359 AttributeDescription *si_ad_ref;
362 AttributeDescription *si_ad_entry;
363 AttributeDescription *si_ad_children;
366 AttributeDescription *si_ad_userPassword;
367 AttributeDescription *si_ad_authPassword;
368 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
369 AttributeDescription *si_ad_krbName;
373 typedef struct slap_attr_assertion {
374 AttributeDescription *aa_desc;
375 struct berval *aa_value;
376 } AttributeAssertion;
378 typedef struct slap_ss_assertion {
379 AttributeDescription *sa_desc;
380 struct berval *sa_initial;
381 struct berval **sa_any;
382 struct berval *sa_final;
383 } SubstringAssertion;
385 typedef struct slap_mr_assertion {
386 char *ma_rule; /* optional */
387 AttributeDescription *ma_desc; /* optional */
388 int ma_dnattrs; /* boolean */
389 struct berval *ma_value; /* required */
390 } MatchingRuleAssertion;
395 * represents an attribute value assertion (i.e., attr;option=value)
397 typedef struct slap_ava {
398 char *ava_type; /* attribute description */
399 struct berval ava_value;
403 * represents an matching rule assertion
405 typedef struct slap_mra {
406 char *mra_rule; /* optional */
407 char *mra_type; /* attribute description -- optional */
409 struct berval *mra_value;
415 * represents a search filter
418 typedef struct slap_filter {
419 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
420 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
421 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
422 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
426 /* precomputed result */
427 ber_int_t f_un_result;
429 #ifdef SLAPD_SCHEMA_NOT_COMPAT
434 AttributeDescription *f_un_desc;
436 /* simple value assertion */
437 AttributeAssertion *f_un_ava;
439 /* substring assertion */
440 SubstringAssertion *f_un_ssa;
442 /* matching rule assertion */
443 MatchingRuleAssertion *f_un_mra;
445 #define f_dn f_un.f_un_dn
446 #define f_desc f_un.f_un_desc
447 #define f_ava f_un.f_un_ava
448 #define f_av_desc f_un.f_un_ava->aa_desc
449 #define f_av_value f_un.f_un_ava->aa_value
450 #define f_sub f_un.f_un_ssa
451 #define f_sub_desc f_un.f_un_ssa->sa_desc
452 #define f_sub_initial f_un.f_un_ssa->sa_initial
453 #define f_sub_any f_un.f_un_ssa->sa_any
454 #define f_sub_final f_un.f_un_ssa->sa_final
455 #define f_mra f_un.f_un_mra
456 #define f_mr_rule f_un.f_un_mra->ma_rule
457 #define f_mr_desc f_un.f_un_mra->ma_desc
458 #define f_mr_value f_un.f_un_mra->ma_value
459 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
464 /* equality, lessorequal, greaterorequal, approx */
474 struct berval *f_un_sub_initial;
475 struct berval **f_un_sub_any;
476 struct berval *f_un_sub_final;
479 #define f_dn f_un.f_un_type /* used for DN indices */
480 #define f_type f_un.f_un_type
481 #define f_ava f_un.f_un_ava
482 #define f_avtype f_un.f_un_ava.ava_type
483 #define f_avvalue f_un.f_un_ava.ava_value
484 #define f_mra f_un.f_un_mra
485 #define f_mrtype f_un.f_un_mra.mra_type
486 #define f_mrvalue f_un.f_un_mra.mra_value
487 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
488 #define f_sub f_un.f_un_sub
489 #define f_sub_type f_un.f_un_sub.f_un_sub_type
490 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
491 #define f_sub_any f_un.f_un_sub.f_un_sub_any
492 #define f_sub_final f_un.f_un_sub.f_un_sub_final
496 struct slap_filter *f_un_complex;
499 #define f_result f_un.f_un_result
500 #define f_and f_un.f_un_complex
501 #define f_or f_un.f_un_complex
502 #define f_not f_un.f_un_complex
503 #define f_list f_un.f_un_complex
505 struct slap_filter *f_next;
508 /* compare routines can return undefined */
509 #define SLAPD_COMPARE_UNDEFINED ((ber_tag_t) -1)
512 * represents an attribute (description + values)
514 typedef struct slap_attr {
515 #ifdef SLAPD_SCHEMA_NOT_COMPAT
516 AttributeDescription *a_desc;
518 char *a_type; /* description */
521 struct berval **a_vals;
522 struct slap_attr *a_next;
525 #ifndef SLAPD_SCHEMA_NOT_COMPAT
527 * the attr_syntax() routine returns one of these values
528 * telling what kind of syntax an attribute supports.
530 #define SYNTAX_CIS 0x01 /* case insensitive string */
531 #define SYNTAX_CES 0x02 /* case sensitive string */
532 #define SYNTAX_BIN 0x04 /* binary data */
533 #define SYNTAX_TEL 0x08 /* telephone number string */
534 #define SYNTAX_DN 0x10 /* dn string */
538 * the id used in the indexes to refer to an entry
540 typedef unsigned long ID;
541 #define NOID ((ID)~0)
544 * represents an entry in core
546 typedef struct slap_entry {
548 * The ID field should only be changed before entry is
549 * inserted into a cache. The ID value is backend
554 char *e_dn; /* DN of this entry */
555 char *e_ndn; /* normalized DN of this entry */
556 Attribute *e_attrs; /* list of attributes + values */
558 /* for use by the backend for any purpose */
565 #ifdef SLAPD_SCHEMA_NOT_COMPAT
566 typedef struct slap_mod {
568 AttributeDescription *sm_desc;
569 struct berval **sm_bvalues;
572 #define Modification LDAPMod
574 #define sm_desc mod_type
575 #define sm_bvalues mod_bvalues
578 typedef struct slap_mod_list {
579 Modification sml_mod;
580 #define sml_op sml_mod.sm_op
581 #define sml_desc sml_mod.sm_desc
582 #define sml_bvalues sml_mod.sm_bvalues
583 #ifndef SLAPD_SCHEMA_NOT_COMPAT
584 #define sml_type sml_mod.sm_desc
586 struct slap_mod_list *sml_next;
589 #ifdef SLAPD_SCHEMA_NOT_COMPAT
590 typedef struct slap_ldap_modlist {
592 struct slap_ldap_modlist *ml_next;
593 #define ml_op ml_mod.mod_op
594 #define ml_type ml_mod.mod_type
595 #define ml_values ml_mod.mod_values
596 #define ml_bvalues ml_mod.mod_bvalues
599 #define LDAPModList Modifications
600 #define ml_mod sml_mod
601 #define ml_op sml_mod.mod_op
602 #define ml_type sml_mod.mod_type
603 #define ml_values sml_mod.mod_values
604 #define ml_bvalues sml_mod.mod_bvalues
605 #define ml_next sml_next
609 * represents an access control list
612 typedef enum slap_access_e {
613 ACL_INVALID_ACCESS = -1,
622 typedef enum slap_control_e {
623 ACL_INVALID_CONTROL = 0,
629 typedef unsigned long slap_access_mask_t;
632 typedef struct slap_access {
633 slap_control_t a_type;
635 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
637 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
638 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
639 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
640 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
641 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
642 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
644 #define ACL_PRIV_MASK 0x00ffUL
647 #define ACL_PRIV_LEVEL 0x1000UL
648 #define ACL_PRIV_ADDITIVE 0x2000UL
649 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
652 #define ACL_PRIV_INVALID 0x0UL
654 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
655 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
656 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
657 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
659 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
660 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
662 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
664 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
666 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
667 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
668 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
670 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
671 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
672 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
673 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
674 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
675 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
677 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
678 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
679 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
680 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
681 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
682 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
683 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
685 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
686 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
687 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
688 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
689 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
690 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
692 slap_access_mask_t a_mask;
695 #ifdef SLAPD_SCHEMA_NOT_COMPAT
696 AttributeDescription *a_dn_at;
702 char *a_peername_pat;
703 char *a_sockname_pat;
708 #ifdef SLAPD_ACI_ENABLED
709 #ifdef SLAPD_SCHEMA_NOT_COMPAT
710 AttributeDescription *a_aci_at;
719 #ifdef SLAPD_SCHEMA_NOT_COMPAT
720 AttributeDescription *a_group_at;
725 struct slap_access *a_next;
729 typedef struct slap_acl {
730 /* "to" part: the entries this acl applies to */
736 /* "by" part: list of who has what access to the entries */
739 struct slap_acl *acl_next;
743 * replog moddn param structure
745 struct replog_moddn {
753 * represents a backend
756 typedef struct slap_backend_info BackendInfo; /* per backend type */
757 typedef struct slap_backend_db BackendDB; /* per backend database */
759 LIBSLAPD_F (int) nBackendInfo;
760 LIBSLAPD_F (int) nBackendDB;
761 LIBSLAPD_F (BackendInfo *) backendInfo;
762 LIBSLAPD_F (BackendDB *) backendDB;
764 LIBSLAPD_F (int) slapMode;
765 #define SLAP_UNDEFINED_MODE 0x0000
766 #define SLAP_SERVER_MODE 0x0001
767 #define SLAP_TOOL_MODE 0x0002
768 #define SLAP_MODE 0x0003
770 #define SLAP_TRUNCATE_MODE 0x0100
772 #define SLAP_TIMED_MODE 0x1000
775 /* temporary aliases */
776 typedef BackendDB Backend;
777 #define nbackends nBackendDB
778 #define backends backendDB
780 struct slap_backend_db {
781 BackendInfo *bd_info; /* pointer to shared backend info */
783 /* BackendInfo accessors */
784 #define be_config bd_info->bi_db_config
785 #define be_type bd_info->bi_type
787 #define be_bind bd_info->bi_op_bind
788 #define be_unbind bd_info->bi_op_unbind
789 #define be_add bd_info->bi_op_add
790 #define be_compare bd_info->bi_op_compare
791 #define be_delete bd_info->bi_op_delete
792 #define be_modify bd_info->bi_op_modify
793 #define be_modrdn bd_info->bi_op_modrdn
794 #define be_search bd_info->bi_op_search
796 #define be_extended bd_info->bi_extended
798 #define be_release bd_info->bi_entry_release_rw
799 #define be_group bd_info->bi_acl_group
801 #define be_controls bd_info->bi_controls
803 #define be_connection_init bd_info->bi_connection_init
804 #define be_connection_destroy bd_info->bi_connection_destroy
807 #define be_entry_open bd_info->bi_tool_entry_open
808 #define be_entry_close bd_info->bi_tool_entry_close
809 #define be_entry_first bd_info->bi_tool_entry_first
810 #define be_entry_next bd_info->bi_tool_entry_next
811 #define be_entry_get bd_info->bi_tool_entry_get
812 #define be_entry_put bd_info->bi_tool_entry_put
813 #define be_index_attr bd_info->bi_tool_index_attr
814 #define be_index_change bd_info->bi_tool_index_change
815 #define be_sync bd_info->bi_tool_sync
818 #ifdef HAVE_CYRUS_SASL
819 #define be_sasl_authorize bd_info->bi_sasl_authorize
820 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
821 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
824 /* these should be renamed from be_ to bd_ */
825 char **be_suffix; /* the DN suffixes of data in this backend */
826 char **be_nsuffix; /* the normalized DN suffixes in this backend */
827 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
828 char *be_root_dn; /* the magic "root" dn for this db */
829 char *be_root_ndn; /* the magic "root" normalized dn for this db */
830 struct berval be_root_pw; /* the magic "root" password for this db */
831 int be_readonly; /* 1 => db is in "read only" mode */
832 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
833 int be_sizelimit; /* size limit for this backend */
834 int be_timelimit; /* time limit for this backend */
835 AccessControl *be_acl; /* access control list for this backend */
836 slap_access_t be_dfltaccess; /* access given if no acl matches */
837 char **be_replica; /* replicas of this backend (in master) */
838 char *be_replogfile; /* replication log file (in master) */
839 char *be_update_ndn; /* allowed to make changes (in replicas) */
840 struct berval **be_update_refs; /* where to refer modifying clients to */
841 int be_lastmod; /* keep track of lastmodified{by,time} */
845 void *be_private; /* anything the backend database needs */
851 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
853 struct slap_conn *conn,
856 struct berval * reqdata,
858 struct berval ** rspdata,
859 LDAPControl *** rspctrls,
861 struct berval *** refs ));
863 struct slap_backend_info {
864 char *bi_type; /* type of backend */
867 * per backend type routines:
868 * bi_init: called to allocate a backend_info structure,
869 * called once BEFORE configuration file is read.
870 * bi_init() initializes this structure hence is
871 * called directly from be_initialize()
872 * bi_config: called per 'backend' specific option
873 * all such options must before any 'database' options
874 * bi_config() is called only from read_config()
875 * bi_open: called to open each database, called
876 * once AFTER configuration file is read but
877 * BEFORE any bi_db_open() calls.
878 * bi_open() is called from backend_startup()
879 * bi_close: called to close each database, called
880 * once during shutdown after all bi_db_close calls.
881 * bi_close() is called from backend_shutdown()
882 * bi_destroy: called to destroy each database, called
883 * once during shutdown after all bi_db_destroy calls.
884 * bi_destory() is called from backend_destroy()
886 int (*bi_init) LDAP_P((BackendInfo *bi));
887 int (*bi_config) LDAP_P((BackendInfo *bi,
888 const char *fname, int lineno, int argc, char **argv ));
889 int (*bi_open) LDAP_P((BackendInfo *bi));
890 int (*bi_close) LDAP_P((BackendInfo *bi));
891 int (*bi_destroy) LDAP_P((BackendInfo *bi));
894 * per database routines:
895 * bi_db_init: called to initialize each database,
896 * called upon reading 'database <type>'
897 * called only from backend_db_init()
898 * bi_db_config: called to configure each database,
899 * called per database to handle per database options
900 * called only from read_config()
901 * bi_db_open: called to open each database
902 * called once per database immediately AFTER bi_open()
903 * calls but before daemon startup.
904 * called only by backend_startup()
905 * bi_db_close: called to close each database
906 * called once per database during shutdown but BEFORE
908 * called only by backend_shutdown()
909 * bi_db_destroy: called to destroy each database
910 * called once per database during shutdown AFTER all
911 * bi_close calls but before bi_destory calls.
912 * called only by backend_destory()
914 int (*bi_db_init) LDAP_P((Backend *bd));
915 int (*bi_db_config) LDAP_P((Backend *bd,
916 const char *fname, int lineno, int argc, char **argv ));
917 int (*bi_db_open) LDAP_P((Backend *bd));
918 int (*bi_db_close) LDAP_P((Backend *bd));
919 int (*bi_db_destroy) LDAP_P((Backend *db));
921 /* LDAP Operations Handling Routines */
922 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
923 struct slap_conn *c, struct slap_op *o,
924 const char *dn, const char *ndn, int method,
925 struct berval *cred, char** edn ));
926 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
927 struct slap_conn *c, struct slap_op *o ));
928 int (*bi_op_search) LDAP_P((BackendDB *bd,
929 struct slap_conn *c, struct slap_op *o,
930 const char *base, const char *nbase,
931 int scope, int deref,
932 int slimit, int tlimit,
933 Filter *f, const char *filterstr,
934 char **attrs, int attrsonly));
935 #ifdef SLAPD_SCHEMA_NOT_COMPAT
936 int (*bi_op_compare)LDAP_P((BackendDB *bd,
937 struct slap_conn *c, struct slap_op *o,
938 const char *dn, const char *ndn,
939 AttributeAssertion *ava));
941 int (*bi_op_compare)LDAP_P((BackendDB *bd,
942 struct slap_conn *c, struct slap_op *o,
943 const char *dn, const char *ndn,
946 int (*bi_op_modify) LDAP_P((BackendDB *bd,
947 struct slap_conn *c, struct slap_op *o,
948 const char *dn, const char *ndn, Modifications *m));
949 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
950 struct slap_conn *c, struct slap_op *o,
951 const char *dn, const char *ndn,
952 const char *newrdn, int deleteoldrdn,
953 const char *newSuperior));
954 int (*bi_op_add) LDAP_P((BackendDB *bd,
955 struct slap_conn *c, struct slap_op *o,
957 int (*bi_op_delete) LDAP_P((BackendDB *bd,
958 struct slap_conn *c, struct slap_op *o,
959 const char *dn, const char *ndn));
960 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
961 struct slap_conn *c, struct slap_op *o,
964 /* Extended Operations Helper */
965 SLAP_EXTENDED_FN bi_extended;
967 /* Auxilary Functions */
968 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
970 #ifdef SLAPD_SCHEMA_NOT_COMPAT
971 int (*bi_acl_group) LDAP_P((Backend *bd,
972 Entry *e, const char *bdn, const char *edn,
973 const char *objectclassValue,
974 AttributeDescription *group_at ));
976 int (*bi_acl_group) LDAP_P((Backend *bd,
977 Entry *e, const char *bdn, const char *edn,
978 const char *objectclassValue,
979 const char *group_at ));
982 int (*bi_connection_init) LDAP_P((BackendDB *bd,
983 struct slap_conn *c));
984 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
985 struct slap_conn *c));
987 /* hooks for slap tools */
988 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
989 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
990 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
991 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
992 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
993 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
994 #ifdef SLAPD_SCHEMA_NOT_COMPAT
995 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
996 AttributeDescription *desc ));
997 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
998 AttributeDescription *desc,
999 struct berval **bv, ID id, int op ));
1001 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
1003 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
1005 struct berval **bv, ID id, int op ));
1007 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1009 #ifdef HAVE_CYRUS_SASL
1010 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
1011 const char *authnid, const char *authzid,
1012 const char **canon_authzid, const char **errstr ));
1013 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
1014 const char *mechanism, const char *authzid,
1015 const char *realm, sasl_secret_t **secret ));
1016 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
1017 const char *mechanism, const char *auth_identity,
1018 const char *realm, const sasl_secret_t *secret ));
1019 #endif /* HAVE_CYRUS_SASL */
1021 #define SLAP_INDEX_ADD_OP 0x0001
1022 #define SLAP_INDEX_DELETE_OP 0x0002
1024 char **bi_controls; /* supported controls */
1026 unsigned int bi_nDB; /* number of databases of this type */
1027 void *bi_private; /* anything the backend type needs */
1031 * represents an operation pending from an ldap client
1034 typedef struct slap_op {
1035 ber_int_t o_opid; /* id of this operation */
1036 ber_int_t o_msgid; /* msgid of the request */
1038 ldap_pvt_thread_t o_tid; /* thread handling this op */
1040 BerElement *o_ber; /* ber of the request */
1042 ber_tag_t o_tag; /* tag of the request */
1043 time_t o_time; /* time op was initiated */
1046 /* should only be used for reporting purposes */
1047 char *o_authc_dn; /* authentication DN */
1049 /* should be used as the DN of the User */
1050 char *o_authz_dn; /* authorization DN */
1051 char *o_authz_ndn; /* authorizaiton NDN */
1054 char *o_dn; /* dn bound when op was initiated */
1055 char *o_ndn; /* normalized dn bound when op was initiated */
1058 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1059 ber_tag_t o_authtype; /* auth method used to bind dn */
1060 /* values taken from ldap.h */
1062 char *o_authmech; /* SASL mechanism used to bind dn */
1064 LDAPControl **o_ctrls; /* controls */
1066 unsigned long o_connid; /* id of conn initiating this op */
1068 #ifdef LDAP_CONNECTIONLESS
1069 int o_cldap; /* != 0 if this came in via CLDAP */
1070 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1071 char o_searchbase; /* search base if via CLDAP */
1074 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1075 int o_abandon; /* abandon flag */
1077 struct slap_op *o_next; /* next operation in list */
1078 void *o_private; /* anything the backend needs */
1082 * represents a connection from an ldap client
1085 typedef struct slap_conn {
1086 int c_struct_state; /* structure management state */
1087 int c_conn_state; /* connection state */
1089 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1090 Sockbuf *c_sb; /* ber connection stuff */
1092 /* only can be changed by connect_init */
1093 time_t c_starttime; /* when the connection was opened */
1094 time_t c_activitytime; /* when the connection was last used */
1095 unsigned long c_connid; /* id of this connection for stats*/
1097 char *c_listener_url; /* listener URL */
1098 char *c_peer_domain; /* DNS name of client */
1099 char *c_peer_name; /* peer name (trans=addr:port) */
1100 char *c_sock_name; /* sock name (trans=addr:port) */
1102 /* only can be changed by binding thread */
1103 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1104 char *c_sasl_bind_mech; /* mech in progress */
1105 #ifdef HAVE_CYRUS_SASL
1106 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1109 /* authentication backend */
1110 Backend *c_authc_backend;
1112 /* authorization backend - normally same as c_authc_backend */
1113 Backend *c_authz_backend;
1116 /* authentication backend */
1117 /* should only be used for reporting purposes */
1118 char *c_authc_dn; /* authentication DN */
1120 /* should be used as the DN of the User */
1121 char *c_authz_dn; /* authorization DN */
1122 char *c_authz_ndn; /* authorization NDN */
1125 char *c_cdn; /* DN provided by the client */
1126 char *c_dn; /* DN bound to this conn */
1129 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1130 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1131 char *c_authmech; /* SASL mechanism used to bind c_dn */
1133 Operation *c_ops; /* list of operations being processed */
1134 Operation *c_pending_ops; /* list of pending operations */
1136 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1137 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1139 BerElement *c_currentber; /* ber we're attempting to read */
1140 int c_writewaiter; /* true if writer is waiting */
1143 int c_is_tls; /* true if this LDAP over raw TLS */
1144 int c_needs_tls_accept; /* true if SSL_accept should be called */
1147 long c_n_ops_received; /* num of ops received (next op_id) */
1148 long c_n_ops_executing; /* num of ops currently executing */
1149 long c_n_ops_pending; /* num of ops pending execution */
1150 long c_n_ops_completed; /* num of ops completed */
1152 long c_n_get; /* num of get calls */
1153 long c_n_read; /* num of read calls */
1154 long c_n_write; /* num of write calls */
1157 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1158 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1160 if ( ldap_debug & (level) ) \
1161 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1162 if ( ldap_syslog & (level) ) \
1163 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1167 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1172 #include "proto-slap.h"
1174 #endif /* _SLAP_H_ */