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 #define SLAPD_TOP_OID "2.5.6.0"
108 LDAP_SLAPD_F (int) slap_debug;
113 #define SLAP_INDEX_TYPE 0x00FFUL
114 #define SLAP_INDEX_UNDEFINED 0x0001UL
115 #define SLAP_INDEX_PRESENT 0x0002UL
116 #define SLAP_INDEX_EQUALITY 0x0004UL
117 #define SLAP_INDEX_APPROX 0x0008UL
118 #define SLAP_INDEX_SUBSTR 0x0010UL
119 #define SLAP_INDEX_EXTENDED 0x0020UL
121 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
123 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
125 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
127 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
128 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
129 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
130 #define SLAP_INDEX_SUBSTR_DEFAULT ( SLAP_INDEX_SUBSTR \
131 | SLAP_INDEX_SUBSTR_INITIAL | SLAP_INDEX_SUBSTR_FINAL )
133 #define SLAP_INDEX_SUBSTR_INITIAL_MIN_LEN 2
134 #define SLAP_INDEX_SUBSTR_INITIAL_MAX_LEN 4
135 #define SLAP_INDEX_SUBSTR_FINAL_MIN_LEN 2
136 #define SLAP_INDEX_SUBSTR_FINAL_MAX_LEN 4
138 #define SLAP_INDEX_FLAGS 0xF000UL
139 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
140 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
141 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
142 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
144 typedef long slap_index;
147 * there is a single index for each attribute. these prefixes ensure
148 * that there is no collision among keys.
150 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
151 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
152 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
153 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
154 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
157 * represents schema information for a database
159 #define SLAP_SCHERR_OUTOFMEM 1
160 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
161 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
162 #define SLAP_SCHERR_DUP_CLASS 4
163 #define SLAP_SCHERR_DUP_ATTR 5
164 #define SLAP_SCHERR_DUP_SYNTAX 6
165 #define SLAP_SCHERR_DUP_RULE 7
166 #define SLAP_SCHERR_NO_NAME 8
167 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
168 #define SLAP_SCHERR_MR_NOT_FOUND 10
169 #define SLAP_SCHERR_SYN_NOT_FOUND 11
170 #define SLAP_SCHERR_MR_INCOMPLETE 12
172 typedef struct slap_oid_macro {
173 struct berval som_oid;
175 struct slap_oid_macro *som_next;
178 /* forward declarations */
180 struct slap_matching_rule;
182 typedef int slap_syntax_validate_func LDAP_P((
183 struct slap_syntax *syntax,
184 struct berval * in));
186 typedef int slap_syntax_transform_func LDAP_P((
187 struct slap_syntax *syntax,
189 struct berval ** out));
191 typedef struct slap_syntax {
192 LDAP_SYNTAX ssyn_syn;
193 #define ssyn_oid ssyn_syn.syn_oid
194 #define ssyn_desc ssyn_syn.syn_desc
195 #define ssyn_extensions ssyn_syn.syn_extensions
199 #define SLAP_SYNTAX_NONE 0x00U
200 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
201 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
202 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
203 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
205 slap_syntax_validate_func *ssyn_validate;
206 slap_syntax_transform_func *ssyn_normalize;
207 slap_syntax_transform_func *ssyn_pretty;
209 #ifdef SLAPD_BINARY_CONVERSION
210 /* convert to and from binary */
211 slap_syntax_transform_func *ssyn_ber2str;
212 slap_syntax_transform_func *ssyn_str2ber;
215 struct slap_syntax *ssyn_next;
218 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
219 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
220 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
221 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
222 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
224 /* XXX -> UCS-2 Converter */
225 typedef int slap_mr_convert_func LDAP_P((
227 struct berval ** out ));
230 typedef int slap_mr_normalize_func LDAP_P((
232 struct slap_syntax *syntax, /* NULL if in is asserted value */
233 struct slap_matching_rule *mr,
235 struct berval ** out ));
237 /* Match (compare) function */
238 typedef int slap_mr_match_func LDAP_P((
241 struct slap_syntax *syntax, /* syntax of stored value */
242 struct slap_matching_rule *mr,
243 struct berval * value,
244 void * assertValue ));
246 /* Index generation function */
247 typedef int slap_mr_indexer_func LDAP_P((
249 struct slap_syntax *syntax, /* syntax of stored value */
250 struct slap_matching_rule *mr,
251 struct berval *prefix,
252 struct berval **values,
253 struct berval ***keys ));
255 /* Filter index function */
256 typedef int slap_mr_filter_func LDAP_P((
258 struct slap_syntax *syntax, /* syntax of stored value */
259 struct slap_matching_rule *mr,
260 struct berval *prefix,
262 struct berval ***keys ));
264 typedef struct slap_matching_rule {
265 LDAP_MATCHING_RULE smr_mrule;
268 #define SLAP_MR_TYPE_MASK 0xFF00U
269 #define SLAP_MR_SUBTYPE_MASK 0x00FFU
271 #define SLAP_MR_NONE 0x0000U
272 #define SLAP_MR_EQUALITY 0x0100U
273 #define SLAP_MR_ORDERING 0x0200U
274 #define SLAP_MR_SUBSTR 0x0400U
275 #define SLAP_MR_EXT 0x0800U
277 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
279 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0001U )
280 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0002U )
281 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0004U )
284 slap_mr_convert_func *smr_convert;
285 slap_mr_normalize_func *smr_normalize;
286 slap_mr_match_func *smr_match;
287 slap_mr_indexer_func *smr_indexer;
288 slap_mr_filter_func *smr_filter;
289 struct slap_matching_rule *smr_next;
290 #define smr_oid smr_mrule.mr_oid
291 #define smr_names smr_mrule.mr_names
292 #define smr_desc smr_mrule.mr_desc
293 #define smr_obsolete smr_mrule.mr_obsolete
294 #define smr_syntax_oid smr_mrule.mr_syntax_oid
295 #define smr_extensions smr_mrule.mr_extensions
298 typedef struct slap_attribute_type {
300 LDAP_ATTRIBUTE_TYPE sat_atype;
301 struct slap_attribute_type *sat_sup;
302 struct slap_attribute_type **sat_subtypes;
303 MatchingRule *sat_equality;
304 MatchingRule *sat_approx;
305 MatchingRule *sat_ordering;
306 MatchingRule *sat_substr;
308 struct slap_attribute_type *sat_next;
309 #define sat_oid sat_atype.at_oid
310 #define sat_names sat_atype.at_names
311 #define sat_desc sat_atype.at_desc
312 #define sat_obsolete sat_atype.at_obsolete
313 #define sat_sup_oid sat_atype.at_sup_oid
314 #define sat_equality_oid sat_atype.at_equality_oid
315 #define sat_ordering_oid sat_atype.at_ordering_oid
316 #define sat_substr_oid sat_atype.at_substr_oid
317 #define sat_syntax_oid sat_atype.at_syntax_oid
318 #define sat_single_value sat_atype.at_single_value
319 #define sat_collective sat_atype.at_collective
320 #define sat_no_user_mod sat_atype.at_no_user_mod
321 #define sat_usage sat_atype.at_usage
322 #define sat_extensions sat_atype.at_extensions
325 #define is_at_operational(at) ((at)->sat_usage)
326 #define is_at_single_value(at) ((at)->sat_single_value)
327 #define is_at_collective(at) ((at)->sat_collective)
328 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
330 typedef struct slap_object_class {
331 LDAP_OBJECT_CLASS soc_oclass;
332 struct slap_object_class **soc_sups;
333 AttributeType **soc_required;
334 AttributeType **soc_allowed;
335 struct slap_object_class *soc_next;
336 #define soc_oid soc_oclass.oc_oid
337 #define soc_names soc_oclass.oc_names
338 #define soc_desc soc_oclass.oc_desc
339 #define soc_obsolete soc_oclass.oc_obsolete
340 #define soc_sup_oids soc_oclass.oc_sup_oids
341 #define soc_kind soc_oclass.oc_kind
342 #define soc_at_oids_must soc_oclass.oc_at_oids_must
343 #define soc_at_oids_may soc_oclass.oc_at_oids_may
344 #define soc_extensions soc_oclass.oc_extensions
349 * represents a recognized attribute description ( type + options )
351 typedef struct slap_attr_desc {
352 struct berval *ad_cname; /* canonical name */
353 AttributeType *ad_type; /* NULL if unknown */
354 char *ad_lang; /* NULL if no language tags */
356 #define SLAP_DESC_NONE 0x0U
357 #define SLAP_DESC_BINARY 0x1U
358 } AttributeDescription;
360 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
361 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
364 * pointers to schema elements used internally
366 struct slap_internal_schema {
368 ObjectClass *si_oc_top;
369 ObjectClass *si_oc_extensibleObject;
370 ObjectClass *si_oc_alias;
371 ObjectClass *si_oc_referral;
372 ObjectClass *si_oc_subentry;
373 ObjectClass *si_oc_subschema;
374 ObjectClass *si_oc_rootdse;
376 /* objectClass attribute */
377 AttributeDescription *si_ad_objectClass;
379 /* operational attributes */
380 AttributeDescription *si_ad_creatorsName;
381 AttributeDescription *si_ad_createTimestamp;
382 AttributeDescription *si_ad_modifiersName;
383 AttributeDescription *si_ad_modifyTimestamp;
384 AttributeDescription *si_ad_subschemaSubentry;
386 /* root DSE attributes */
387 AttributeDescription *si_ad_namingContexts;
388 AttributeDescription *si_ad_supportedControl;
389 AttributeDescription *si_ad_supportedExtension;
390 AttributeDescription *si_ad_supportedLDAPVersion;
391 AttributeDescription *si_ad_supportedSASLMechanisms;
393 /* subschema subentry attributes */
394 AttributeDescription *si_ad_objectClasses;
395 AttributeDescription *si_ad_attributeTypes;
396 AttributeDescription *si_ad_ldapSyntaxes;
397 AttributeDescription *si_ad_matchingRules;
398 AttributeDescription *si_ad_matchingRulesUse;
400 /* Aliases & Referrals */
401 AttributeDescription *si_ad_aliasedObjectName;
402 AttributeDescription *si_ad_ref;
404 /* Access Control Internals */
405 AttributeDescription *si_ad_entry;
406 AttributeDescription *si_ad_children;
407 #ifdef SLAPD_ACI_ENABLED
408 AttributeDescription *si_ad_aci;
412 AttributeDescription *si_ad_userPassword;
413 AttributeDescription *si_ad_authPassword;
414 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
415 AttributeDescription *si_ad_krbName;
419 typedef struct slap_attr_assertion {
420 AttributeDescription *aa_desc;
421 struct berval *aa_value;
422 } AttributeAssertion;
424 typedef struct slap_ss_assertion {
425 AttributeDescription *sa_desc;
426 struct berval *sa_initial;
427 struct berval **sa_any;
428 struct berval *sa_final;
429 } SubstringsAssertion;
431 typedef struct slap_mr_assertion {
432 char *ma_rule; /* optional */
433 AttributeDescription *ma_desc; /* optional */
434 int ma_dnattrs; /* boolean */
435 struct berval *ma_value; /* required */
436 } MatchingRuleAssertion;
440 * represents a search filter
443 typedef struct slap_filter {
444 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
445 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
446 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
447 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
451 /* precomputed result */
452 ber_int_t f_un_result;
458 AttributeDescription *f_un_desc;
460 /* simple value assertion */
461 AttributeAssertion *f_un_ava;
463 /* substring assertion */
464 SubstringsAssertion *f_un_ssa;
466 /* matching rule assertion */
467 MatchingRuleAssertion *f_un_mra;
469 #define f_dn f_un.f_un_dn
470 #define f_desc f_un.f_un_desc
471 #define f_ava f_un.f_un_ava
472 #define f_av_desc f_un.f_un_ava->aa_desc
473 #define f_av_value f_un.f_un_ava->aa_value
474 #define f_sub f_un.f_un_ssa
475 #define f_sub_desc f_un.f_un_ssa->sa_desc
476 #define f_sub_initial f_un.f_un_ssa->sa_initial
477 #define f_sub_any f_un.f_un_ssa->sa_any
478 #define f_sub_final f_un.f_un_ssa->sa_final
479 #define f_mra f_un.f_un_mra
480 #define f_mr_rule f_un.f_un_mra->ma_rule
481 #define f_mr_desc f_un.f_un_mra->ma_desc
482 #define f_mr_value f_un.f_un_mra->ma_value
483 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
486 struct slap_filter *f_un_complex;
489 #define f_result f_un.f_un_result
490 #define f_and f_un.f_un_complex
491 #define f_or f_un.f_un_complex
492 #define f_not f_un.f_un_complex
493 #define f_list f_un.f_un_complex
495 struct slap_filter *f_next;
498 /* compare routines can return undefined */
499 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
502 * represents an attribute (description + values)
504 typedef struct slap_attr {
505 AttributeDescription *a_desc;
506 struct berval **a_vals;
507 struct slap_attr *a_next;
512 * the id used in the indexes to refer to an entry
514 typedef unsigned long ID;
515 #define NOID ((ID)~0)
518 * represents an entry in core
520 typedef struct slap_entry {
522 * The ID field should only be changed before entry is
523 * inserted into a cache. The ID value is backend
528 char *e_dn; /* DN of this entry */
529 char *e_ndn; /* normalized DN of this entry */
530 Attribute *e_attrs; /* list of attributes + values */
532 /* for use by the backend for any purpose */
539 typedef struct slap_mod {
541 AttributeDescription *sm_desc;
542 struct berval **sm_bvalues;
545 typedef struct slap_mod_list {
546 Modification sml_mod;
547 #define sml_op sml_mod.sm_op
548 #define sml_desc sml_mod.sm_desc
549 #define sml_bvalues sml_mod.sm_bvalues
550 struct slap_mod_list *sml_next;
553 typedef struct slap_ldap_modlist {
555 struct slap_ldap_modlist *ml_next;
556 #define ml_op ml_mod.mod_op
557 #define ml_type ml_mod.mod_type
558 #define ml_values ml_mod.mod_values
559 #define ml_bvalues ml_mod.mod_bvalues
563 * represents an access control list
566 typedef enum slap_access_e {
567 ACL_INVALID_ACCESS = -1,
576 typedef enum slap_control_e {
577 ACL_INVALID_CONTROL = 0,
583 typedef enum slap_style_e {
591 typedef unsigned long slap_access_mask_t;
594 typedef struct slap_access {
595 slap_control_t a_type;
597 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
599 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
600 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
601 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
602 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
603 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
604 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
606 #define ACL_PRIV_MASK 0x00ffUL
609 #define ACL_PRIV_LEVEL 0x1000UL
610 #define ACL_PRIV_ADDITIVE 0x2000UL
611 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
614 #define ACL_PRIV_INVALID 0x0UL
616 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
617 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
618 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
619 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
621 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
622 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
624 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
626 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
628 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
629 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
630 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
632 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
633 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
634 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
635 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
636 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
637 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
639 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
640 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
641 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
642 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
643 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
644 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
645 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
647 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
648 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
649 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
650 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
651 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
652 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
654 slap_access_mask_t a_mask;
656 slap_style_t a_dn_style;
658 AttributeDescription *a_dn_at;
661 slap_style_t a_peername_style;
662 char *a_peername_pat;
663 slap_style_t a_sockname_style;
664 char *a_sockname_pat;
666 slap_style_t a_domain_style;
668 slap_style_t a_sockurl_style;
671 #ifdef SLAPD_ACI_ENABLED
672 AttributeDescription *a_aci_at;
676 slap_style_t a_group_style;
678 ObjectClass *a_group_oc;
679 AttributeDescription *a_group_at;
681 struct slap_access *a_next;
685 typedef struct slap_acl {
686 /* "to" part: the entries this acl applies to */
688 slap_style_t acl_dn_style;
693 /* "by" part: list of who has what access to the entries */
696 struct slap_acl *acl_next;
700 * replog moddn param structure
702 struct replog_moddn {
710 * represents a backend
713 typedef struct slap_backend_info BackendInfo; /* per backend type */
714 typedef struct slap_backend_db BackendDB; /* per backend database */
716 LDAP_SLAPD_F (int) nBackendInfo;
717 LDAP_SLAPD_F (int) nBackendDB;
718 LDAP_SLAPD_F (BackendInfo *) backendInfo;
719 LDAP_SLAPD_F (BackendDB *) backendDB;
721 LDAP_SLAPD_F (int) slapMode;
722 #define SLAP_UNDEFINED_MODE 0x0000
723 #define SLAP_SERVER_MODE 0x0001
724 #define SLAP_TOOL_MODE 0x0002
725 #define SLAP_MODE 0x0003
727 #define SLAP_TRUNCATE_MODE 0x0100
729 /* temporary aliases */
730 typedef BackendDB Backend;
731 #define nbackends nBackendDB
732 #define backends backendDB
734 struct slap_backend_db {
735 BackendInfo *bd_info; /* pointer to shared backend info */
737 /* BackendInfo accessors */
738 #define be_config bd_info->bi_db_config
739 #define be_type bd_info->bi_type
741 #define be_bind bd_info->bi_op_bind
742 #define be_unbind bd_info->bi_op_unbind
743 #define be_add bd_info->bi_op_add
744 #define be_compare bd_info->bi_op_compare
745 #define be_delete bd_info->bi_op_delete
746 #define be_modify bd_info->bi_op_modify
747 #define be_modrdn bd_info->bi_op_modrdn
748 #define be_search bd_info->bi_op_search
750 #define be_extended bd_info->bi_extended
752 #define be_release bd_info->bi_entry_release_rw
753 #define be_chk_referrals bd_info->bi_chk_referrals
754 #define be_group bd_info->bi_acl_group
756 #define be_controls bd_info->bi_controls
758 #define be_connection_init bd_info->bi_connection_init
759 #define be_connection_destroy bd_info->bi_connection_destroy
762 #define be_entry_open bd_info->bi_tool_entry_open
763 #define be_entry_close bd_info->bi_tool_entry_close
764 #define be_entry_first bd_info->bi_tool_entry_first
765 #define be_entry_next bd_info->bi_tool_entry_next
766 #define be_entry_get bd_info->bi_tool_entry_get
767 #define be_entry_put bd_info->bi_tool_entry_put
768 #define be_index_attr bd_info->bi_tool_index_attr
769 #define be_index_change bd_info->bi_tool_index_change
770 #define be_sync bd_info->bi_tool_sync
773 #ifdef HAVE_CYRUS_SASL
774 #define be_sasl_authorize bd_info->bi_sasl_authorize
775 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
776 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
779 /* these should be renamed from be_ to bd_ */
780 char **be_suffix; /* the DN suffixes of data in this backend */
781 char **be_nsuffix; /* the normalized DN suffixes in this backend */
782 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
783 char *be_root_dn; /* the magic "root" dn for this db */
784 char *be_root_ndn; /* the magic "root" normalized dn for this db */
785 struct berval be_root_pw; /* the magic "root" password for this db */
786 int be_readonly; /* 1 => db is in "read only" mode */
787 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
788 int be_sizelimit; /* size limit for this backend */
789 int be_timelimit; /* time limit for this backend */
790 AccessControl *be_acl; /* access control list for this backend */
791 slap_access_t be_dfltaccess; /* access given if no acl matches */
792 char **be_replica; /* replicas of this backend (in master) */
793 char *be_replogfile; /* replication log file (in master) */
794 char *be_update_ndn; /* allowed to make changes (in replicas) */
795 struct berval **be_update_refs; /* where to refer modifying clients to */
796 int be_lastmod; /* keep track of lastmodified{by,time} */
800 void *be_private; /* anything the backend database needs */
806 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
808 struct slap_conn *conn,
811 struct berval * reqdata,
813 struct berval ** rspdata,
814 LDAPControl *** rspctrls,
816 struct berval *** refs ));
818 struct slap_backend_info {
819 char *bi_type; /* type of backend */
822 * per backend type routines:
823 * bi_init: called to allocate a backend_info structure,
824 * called once BEFORE configuration file is read.
825 * bi_init() initializes this structure hence is
826 * called directly from be_initialize()
827 * bi_config: called per 'backend' specific option
828 * all such options must before any 'database' options
829 * bi_config() is called only from read_config()
830 * bi_open: called to open each database, called
831 * once AFTER configuration file is read but
832 * BEFORE any bi_db_open() calls.
833 * bi_open() is called from backend_startup()
834 * bi_close: called to close each database, called
835 * once during shutdown after all bi_db_close calls.
836 * bi_close() is called from backend_shutdown()
837 * bi_destroy: called to destroy each database, called
838 * once during shutdown after all bi_db_destroy calls.
839 * bi_destory() is called from backend_destroy()
841 int (*bi_init) LDAP_P((BackendInfo *bi));
842 int (*bi_config) LDAP_P((BackendInfo *bi,
843 const char *fname, int lineno, int argc, char **argv ));
844 int (*bi_open) LDAP_P((BackendInfo *bi));
845 int (*bi_close) LDAP_P((BackendInfo *bi));
846 int (*bi_destroy) LDAP_P((BackendInfo *bi));
849 * per database routines:
850 * bi_db_init: called to initialize each database,
851 * called upon reading 'database <type>'
852 * called only from backend_db_init()
853 * bi_db_config: called to configure each database,
854 * called per database to handle per database options
855 * called only from read_config()
856 * bi_db_open: called to open each database
857 * called once per database immediately AFTER bi_open()
858 * calls but before daemon startup.
859 * called only by backend_startup()
860 * bi_db_close: called to close each database
861 * called once per database during shutdown but BEFORE
863 * called only by backend_shutdown()
864 * bi_db_destroy: called to destroy each database
865 * called once per database during shutdown AFTER all
866 * bi_close calls but before bi_destory calls.
867 * called only by backend_destory()
869 int (*bi_db_init) LDAP_P((Backend *bd));
870 int (*bi_db_config) LDAP_P((Backend *bd,
871 const char *fname, int lineno, int argc, char **argv ));
872 int (*bi_db_open) LDAP_P((Backend *bd));
873 int (*bi_db_close) LDAP_P((Backend *bd));
874 int (*bi_db_destroy) LDAP_P((Backend *db));
876 /* LDAP Operations Handling Routines */
877 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
878 struct slap_conn *c, struct slap_op *o,
879 const char *dn, const char *ndn, int method,
880 struct berval *cred, char** edn ));
881 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
882 struct slap_conn *c, struct slap_op *o ));
883 int (*bi_op_search) LDAP_P((BackendDB *bd,
884 struct slap_conn *c, struct slap_op *o,
885 const char *base, const char *nbase,
886 int scope, int deref,
887 int slimit, int tlimit,
888 Filter *f, const char *filterstr,
889 char **attrs, int attrsonly));
890 int (*bi_op_compare)LDAP_P((BackendDB *bd,
891 struct slap_conn *c, struct slap_op *o,
892 const char *dn, const char *ndn,
893 AttributeAssertion *ava));
894 int (*bi_op_modify) LDAP_P((BackendDB *bd,
895 struct slap_conn *c, struct slap_op *o,
896 const char *dn, const char *ndn, Modifications *m));
897 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
898 struct slap_conn *c, struct slap_op *o,
899 const char *dn, const char *ndn,
900 const char *newrdn, int deleteoldrdn,
901 const char *newSuperior));
902 int (*bi_op_add) LDAP_P((BackendDB *bd,
903 struct slap_conn *c, struct slap_op *o,
905 int (*bi_op_delete) LDAP_P((BackendDB *bd,
906 struct slap_conn *c, struct slap_op *o,
907 const char *dn, const char *ndn));
908 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
909 struct slap_conn *c, struct slap_op *o,
912 /* Extended Operations Helper */
913 SLAP_EXTENDED_FN bi_extended;
915 /* Auxilary Functions */
916 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
918 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
919 struct slap_conn *c, struct slap_op *o,
920 const char *dn, const char *ndn,
921 const char **text ));
923 int (*bi_acl_group) LDAP_P((Backend *bd,
924 Entry *e, const char *bdn, const char *edn,
925 ObjectClass *group_oc,
926 AttributeDescription *group_at ));
928 int (*bi_connection_init) LDAP_P((BackendDB *bd,
929 struct slap_conn *c));
930 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
931 struct slap_conn *c));
933 /* hooks for slap tools */
934 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
935 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
936 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
937 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
938 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
939 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
940 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
941 AttributeDescription *desc ));
942 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
943 AttributeDescription *desc,
944 struct berval **bv, ID id, int op ));
945 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
947 #ifdef HAVE_CYRUS_SASL
948 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
949 const char *authnid, const char *authzid,
950 const char **canon_authzid, const char **errstr ));
951 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
952 const char *mechanism, const char *authzid,
953 const char *realm, sasl_secret_t **secret ));
954 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
955 const char *mechanism, const char *auth_identity,
956 const char *realm, const sasl_secret_t *secret ));
957 #endif /* HAVE_CYRUS_SASL */
959 #define SLAP_INDEX_ADD_OP 0x0001
960 #define SLAP_INDEX_DELETE_OP 0x0002
962 char **bi_controls; /* supported controls */
964 unsigned int bi_nDB; /* number of databases of this type */
965 void *bi_private; /* anything the backend type needs */
969 * represents an operation pending from an ldap client
972 typedef struct slap_op {
973 ber_int_t o_opid; /* id of this operation */
974 ber_int_t o_msgid; /* msgid of the request */
976 ldap_pvt_thread_t o_tid; /* thread handling this op */
978 BerElement *o_ber; /* ber of the request */
980 ber_tag_t o_tag; /* tag of the request */
981 time_t o_time; /* time op was initiated */
984 /* should only be used for reporting purposes */
985 char *o_authc_dn; /* authentication DN */
987 /* should be used as the DN of the User */
988 char *o_authz_dn; /* authorization DN */
989 char *o_authz_ndn; /* authorizaiton NDN */
992 char *o_dn; /* dn bound when op was initiated */
993 char *o_ndn; /* normalized dn bound when op was initiated */
996 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
997 ber_tag_t o_authtype; /* auth method used to bind dn */
998 /* values taken from ldap.h */
1000 char *o_authmech; /* SASL mechanism used to bind dn */
1002 LDAPControl **o_ctrls; /* controls */
1004 unsigned long o_connid; /* id of conn initiating this op */
1006 #ifdef LDAP_CONNECTIONLESS
1007 int o_cldap; /* != 0 if this came in via CLDAP */
1008 struct sockaddr o_clientaddr; /* client address if via CLDAP */
1009 char o_searchbase; /* search base if via CLDAP */
1012 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1013 int o_abandon; /* abandon flag */
1015 struct slap_op *o_next; /* next operation in list */
1016 void *o_private; /* anything the backend needs */
1020 * represents a connection from an ldap client
1023 typedef struct slap_conn {
1024 int c_struct_state; /* structure management state */
1025 int c_conn_state; /* connection state */
1027 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1028 Sockbuf *c_sb; /* ber connection stuff */
1030 /* only can be changed by connect_init */
1031 time_t c_starttime; /* when the connection was opened */
1032 time_t c_activitytime; /* when the connection was last used */
1033 unsigned long c_connid; /* id of this connection for stats*/
1035 char *c_listener_url; /* listener URL */
1036 char *c_peer_domain; /* DNS name of client */
1037 char *c_peer_name; /* peer name (trans=addr:port) */
1038 char *c_sock_name; /* sock name (trans=addr:port) */
1040 /* only can be changed by binding thread */
1041 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1042 char *c_sasl_bind_mech; /* mech in progress */
1043 #ifdef HAVE_CYRUS_SASL
1044 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1047 /* authentication backend */
1048 Backend *c_authc_backend;
1050 /* authorization backend - normally same as c_authc_backend */
1051 Backend *c_authz_backend;
1054 /* authentication backend */
1055 /* should only be used for reporting purposes */
1056 char *c_authc_dn; /* authentication DN */
1058 /* should be used as the DN of the User */
1059 char *c_authz_dn; /* authorization DN */
1060 char *c_authz_ndn; /* authorization NDN */
1063 char *c_cdn; /* DN provided by the client */
1064 char *c_dn; /* DN bound to this conn */
1067 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1068 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1069 char *c_authmech; /* SASL mechanism used to bind c_dn */
1071 Operation *c_ops; /* list of operations being processed */
1072 Operation *c_pending_ops; /* list of pending operations */
1074 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1075 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1077 BerElement *c_currentber; /* ber we're attempting to read */
1078 int c_writewaiter; /* true if writer is waiting */
1081 int c_is_tls; /* true if this LDAP over raw TLS */
1082 int c_needs_tls_accept; /* true if SSL_accept should be called */
1085 long c_n_ops_received; /* num of ops received (next op_id) */
1086 long c_n_ops_executing; /* num of ops currently executing */
1087 long c_n_ops_pending; /* num of ops pending execution */
1088 long c_n_ops_completed; /* num of ops completed */
1090 long c_n_get; /* num of get calls */
1091 long c_n_read; /* num of read calls */
1092 long c_n_write; /* num of write calls */
1095 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1096 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1098 if ( ldap_debug & (level) ) \
1099 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1100 if ( ldap_syslog & (level) ) \
1101 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1105 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1110 #include "proto-slap.h"
1112 #endif /* _SLAP_H_ */