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>
25 #define ldap_debug slap_debug
32 #include <ldap_schema.h>
34 #include "ldap_pvt_thread.h"
39 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
40 #define SLAPD_ANONYMOUS "<anonymous>"
43 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
46 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
48 * This is a value used internally by the backends. It is needed to allow
49 * adding values that already exist without getting an error as required by
50 * modrdn when the new rdn was already an attribute value itself.
51 * JCG 05/1999 (gomez@engr.sgi.com)
53 #define SLAP_MOD_SOFTADD 0x1000
59 #define MAXREMATCHES 10
61 #define SLAP_MAX_WORKER_THREADS 32
64 /* psuedo error code indicating abandoned operation */
65 #define SLAPD_ABANDON (-1)
67 /* psuedo error code indicating disconnect */
68 #define SLAPD_DISCONNECT (-2)
71 /* We assume "C" locale, that is US-ASCII */
72 #define ASCII_SPACE(c) ( (c) == ' ' )
73 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
74 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
75 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
76 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
77 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
78 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
80 #define SLAP_NIBBLE(c) ((c)&0x0f)
81 #define SLAP_ESCAPE_CHAR ('\\')
82 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
83 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
85 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
86 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
88 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
89 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
90 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
92 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
93 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
94 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
95 #define OID_SEPARATOR(c) ( (c) == '.' )
96 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
98 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
99 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
101 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
102 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
104 /* must match in schema_init.c */
105 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
106 #define SLAPD_GROUP_ATTR "member"
107 #define SLAPD_GROUP_CLASS "groupOfNames"
108 #define SLAPD_ROLE_ATTR "roleOccupant"
109 #define SLAPD_ROLE_CLASS "organizationalRole"
111 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
112 #define SLAPD_ACI_ATTR "OpenLDAPaci"
114 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
116 /* change this to "OpenLDAPset" */
117 #define SLAPD_ACI_SET_ATTR "template"
119 #define SLAPD_TOP_OID "2.5.6.0"
121 LDAP_SLAPD_F (int) slap_debug;
123 typedef unsigned long slap_mask_t;
125 /* Security Strength Factor */
126 typedef unsigned slap_ssf_t;
128 typedef struct slap_ssf_set {
130 slap_ssf_t sss_transport;
133 slap_ssf_t sss_update_ssf;
134 slap_ssf_t sss_update_transport;
135 slap_ssf_t sss_update_tls;
136 slap_ssf_t sss_update_sasl;
142 #define SLAP_INDEX_TYPE 0x00FFUL
143 #define SLAP_INDEX_UNDEFINED 0x0001UL
144 #define SLAP_INDEX_PRESENT 0x0002UL
145 #define SLAP_INDEX_EQUALITY 0x0004UL
146 #define SLAP_INDEX_APPROX 0x0008UL
147 #define SLAP_INDEX_SUBSTR 0x0010UL
148 #define SLAP_INDEX_EXTENDED 0x0020UL
150 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
152 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
154 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
156 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
157 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
158 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
159 #define SLAP_INDEX_SUBSTR_DEFAULT \
160 ( SLAP_INDEX_SUBSTR \
161 | SLAP_INDEX_SUBSTR_INITIAL \
162 | SLAP_INDEX_SUBSTR_ANY \
163 | SLAP_INDEX_SUBSTR_FINAL )
165 #define SLAP_INDEX_SUBSTR_MINLEN 2
166 #define SLAP_INDEX_SUBSTR_MAXLEN 4
167 #define SLAP_INDEX_SUBSTR_STEP 2
169 #define SLAP_INDEX_FLAGS 0xF000UL
170 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
171 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
172 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
173 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
176 * there is a single index for each attribute. these prefixes ensure
177 * that there is no collision among keys.
179 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
180 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
181 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
182 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
183 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
184 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
185 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
187 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
188 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
189 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
192 * represents schema information for a database
194 #define SLAP_SCHERR_OUTOFMEM 1
195 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
196 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
197 #define SLAP_SCHERR_DUP_CLASS 4
198 #define SLAP_SCHERR_DUP_ATTR 5
199 #define SLAP_SCHERR_DUP_SYNTAX 6
200 #define SLAP_SCHERR_DUP_RULE 7
201 #define SLAP_SCHERR_NO_NAME 8
202 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
203 #define SLAP_SCHERR_MR_NOT_FOUND 10
204 #define SLAP_SCHERR_SYN_NOT_FOUND 11
205 #define SLAP_SCHERR_MR_INCOMPLETE 12
207 typedef struct slap_oid_macro {
208 struct berval som_oid;
210 struct slap_oid_macro *som_next;
213 /* forward declarations */
215 struct slap_matching_rule;
217 typedef int slap_syntax_validate_func LDAP_P((
218 struct slap_syntax *syntax,
219 struct berval * in));
221 typedef int slap_syntax_transform_func LDAP_P((
222 struct slap_syntax *syntax,
224 struct berval ** out));
226 typedef struct slap_syntax {
228 #define ssyn_oid ssyn_syn.syn_oid
229 #define ssyn_desc ssyn_syn.syn_desc
230 #define ssyn_extensions ssyn_syn.syn_extensions
234 #define SLAP_SYNTAX_NONE 0x00U
235 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
236 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
237 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
238 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
240 slap_syntax_validate_func *ssyn_validate;
241 slap_syntax_transform_func *ssyn_normalize;
242 slap_syntax_transform_func *ssyn_pretty;
244 #ifdef SLAPD_BINARY_CONVERSION
245 /* convert to and from binary */
246 slap_syntax_transform_func *ssyn_ber2str;
247 slap_syntax_transform_func *ssyn_str2ber;
250 struct slap_syntax *ssyn_next;
253 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
254 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
255 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
256 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
257 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
259 /* XXX -> UCS-2 Converter */
260 typedef int slap_mr_convert_func LDAP_P((
262 struct berval ** out ));
265 typedef int slap_mr_normalize_func LDAP_P((
267 struct slap_syntax *syntax, /* NULL if in is asserted value */
268 struct slap_matching_rule *mr,
270 struct berval ** out ));
272 /* Match (compare) function */
273 typedef int slap_mr_match_func LDAP_P((
276 struct slap_syntax *syntax, /* syntax of stored value */
277 struct slap_matching_rule *mr,
278 struct berval * value,
279 void * assertValue ));
281 /* Index generation function */
282 typedef int slap_mr_indexer_func LDAP_P((
285 struct slap_syntax *syntax, /* syntax of stored value */
286 struct slap_matching_rule *mr,
287 struct berval *prefix,
288 struct berval **values,
289 struct berval ***keys ));
291 /* Filter index function */
292 typedef int slap_mr_filter_func LDAP_P((
295 struct slap_syntax *syntax, /* syntax of stored value */
296 struct slap_matching_rule *mr,
297 struct berval *prefix,
299 struct berval ***keys ));
301 typedef struct slap_matching_rule {
302 LDAPMatchingRule smr_mrule;
303 slap_mask_t smr_usage;
305 #define SLAP_MR_TYPE_MASK 0xFF00U
306 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
307 #define SLAP_MR_USAGE 0x000FU
309 #define SLAP_MR_NONE 0x0000U
310 #define SLAP_MR_EQUALITY 0x0100U
311 #define SLAP_MR_ORDERING 0x0200U
312 #define SLAP_MR_SUBSTR 0x0400U
313 #define SLAP_MR_EXT 0x0800U
315 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
317 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
318 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
319 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
321 /* this is used to kludge objectClass testing */
322 #define SLAP_MR_MODIFY_MATCHING 0x0001U
325 slap_mr_convert_func *smr_convert;
326 slap_mr_normalize_func *smr_normalize;
327 slap_mr_match_func *smr_match;
328 slap_mr_indexer_func *smr_indexer;
329 slap_mr_filter_func *smr_filter;
331 struct slap_matching_rule *smr_associated;
332 struct slap_matching_rule *smr_next;
334 #define smr_oid smr_mrule.mr_oid
335 #define smr_names smr_mrule.mr_names
336 #define smr_desc smr_mrule.mr_desc
337 #define smr_obsolete smr_mrule.mr_obsolete
338 #define smr_syntax_oid smr_mrule.mr_syntax_oid
339 #define smr_extensions smr_mrule.mr_extensions
342 typedef struct slap_attribute_type {
344 LDAPAttributeType sat_atype;
345 struct slap_attribute_type *sat_sup;
346 struct slap_attribute_type **sat_subtypes;
347 MatchingRule *sat_equality;
348 MatchingRule *sat_approx;
349 MatchingRule *sat_ordering;
350 MatchingRule *sat_substr;
352 struct slap_attribute_type *sat_next;
353 #define sat_oid sat_atype.at_oid
354 #define sat_names sat_atype.at_names
355 #define sat_desc sat_atype.at_desc
356 #define sat_obsolete sat_atype.at_obsolete
357 #define sat_sup_oid sat_atype.at_sup_oid
358 #define sat_equality_oid sat_atype.at_equality_oid
359 #define sat_ordering_oid sat_atype.at_ordering_oid
360 #define sat_substr_oid sat_atype.at_substr_oid
361 #define sat_syntax_oid sat_atype.at_syntax_oid
362 #define sat_single_value sat_atype.at_single_value
363 #define sat_collective sat_atype.at_collective
364 #define sat_no_user_mod sat_atype.at_no_user_mod
365 #define sat_usage sat_atype.at_usage
366 #define sat_extensions sat_atype.at_extensions
369 #define is_at_operational(at) ((at)->sat_usage)
370 #define is_at_single_value(at) ((at)->sat_single_value)
371 #define is_at_collective(at) ((at)->sat_collective)
372 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
374 typedef struct slap_object_class {
375 LDAPObjectClass soc_oclass;
376 struct slap_object_class **soc_sups;
377 AttributeType **soc_required;
378 AttributeType **soc_allowed;
379 struct slap_object_class *soc_next;
380 #define soc_oid soc_oclass.oc_oid
381 #define soc_names soc_oclass.oc_names
382 #define soc_desc soc_oclass.oc_desc
383 #define soc_obsolete soc_oclass.oc_obsolete
384 #define soc_sup_oids soc_oclass.oc_sup_oids
385 #define soc_kind soc_oclass.oc_kind
386 #define soc_at_oids_must soc_oclass.oc_at_oids_must
387 #define soc_at_oids_may soc_oclass.oc_at_oids_may
388 #define soc_extensions soc_oclass.oc_extensions
393 * represents a recognized attribute description ( type + options )
395 typedef struct slap_attr_desc {
396 struct berval *ad_cname; /* canonical name, must be specified */
397 AttributeType *ad_type; /* attribute type, must be specified */
398 char *ad_lang; /* NULL if no language tags */
400 #define SLAP_DESC_NONE 0x0U
401 #define SLAP_DESC_BINARY 0x1U
402 } AttributeDescription;
404 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
405 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
408 * pointers to schema elements used internally
410 struct slap_internal_schema {
412 ObjectClass *si_oc_top;
413 ObjectClass *si_oc_extensibleObject;
414 ObjectClass *si_oc_alias;
415 ObjectClass *si_oc_referral;
416 ObjectClass *si_oc_subentry;
417 ObjectClass *si_oc_subschema;
418 ObjectClass *si_oc_rootdse;
420 /* objectClass attribute descriptions */
421 AttributeDescription *si_ad_objectClass;
423 /* operational attribute descriptions */
424 AttributeDescription *si_ad_structuralObjectClass;
425 AttributeDescription *si_ad_creatorsName;
426 AttributeDescription *si_ad_createTimestamp;
427 AttributeDescription *si_ad_modifiersName;
428 AttributeDescription *si_ad_modifyTimestamp;
429 AttributeDescription *si_ad_subschemaSubentry;
431 /* root DSE attribute descriptions */
432 AttributeDescription *si_ad_namingContexts;
433 AttributeDescription *si_ad_supportedControl;
434 AttributeDescription *si_ad_supportedExtension;
435 AttributeDescription *si_ad_supportedLDAPVersion;
436 AttributeDescription *si_ad_supportedSASLMechanisms;
438 /* subschema subentry attribute descriptions */
439 AttributeDescription *si_ad_objectClasses;
440 AttributeDescription *si_ad_attributeTypes;
441 AttributeDescription *si_ad_ldapSyntaxes;
442 AttributeDescription *si_ad_matchingRules;
443 AttributeDescription *si_ad_matchingRulesUse;
445 /* Aliases & Referrals */
446 AttributeDescription *si_ad_aliasedObjectName;
447 AttributeDescription *si_ad_ref;
449 /* Access Control Internals */
450 AttributeDescription *si_ad_entry;
451 AttributeDescription *si_ad_children;
452 #ifdef SLAPD_ACI_ENABLED
453 AttributeDescription *si_ad_aci;
456 /* Other attributes descriptions */
457 AttributeDescription *si_ad_userPassword;
458 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
459 AttributeDescription *si_ad_krbName;
462 /* Undefined Attribute Type */
463 AttributeType *si_at_undefined;
466 typedef struct slap_attr_assertion {
467 AttributeDescription *aa_desc;
468 struct berval *aa_value;
469 } AttributeAssertion;
471 typedef struct slap_ss_assertion {
472 AttributeDescription *sa_desc;
473 struct berval *sa_initial;
474 struct berval **sa_any;
475 struct berval *sa_final;
476 } SubstringsAssertion;
478 typedef struct slap_mr_assertion {
479 char *ma_rule; /* optional */
480 AttributeDescription *ma_desc; /* optional */
481 int ma_dnattrs; /* boolean */
482 struct berval *ma_value; /* required */
483 } MatchingRuleAssertion;
487 * represents a search filter
489 typedef struct slap_filter {
490 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
491 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
492 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
493 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
497 /* precomputed result */
498 ber_int_t f_un_result;
504 AttributeDescription *f_un_desc;
506 /* simple value assertion */
507 AttributeAssertion *f_un_ava;
509 /* substring assertion */
510 SubstringsAssertion *f_un_ssa;
512 /* matching rule assertion */
513 MatchingRuleAssertion *f_un_mra;
515 #define f_dn f_un.f_un_dn
516 #define f_desc f_un.f_un_desc
517 #define f_ava f_un.f_un_ava
518 #define f_av_desc f_un.f_un_ava->aa_desc
519 #define f_av_value f_un.f_un_ava->aa_value
520 #define f_sub f_un.f_un_ssa
521 #define f_sub_desc f_un.f_un_ssa->sa_desc
522 #define f_sub_initial f_un.f_un_ssa->sa_initial
523 #define f_sub_any f_un.f_un_ssa->sa_any
524 #define f_sub_final f_un.f_un_ssa->sa_final
525 #define f_mra f_un.f_un_mra
526 #define f_mr_rule f_un.f_un_mra->ma_rule
527 #define f_mr_desc f_un.f_un_mra->ma_desc
528 #define f_mr_value f_un.f_un_mra->ma_value
529 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
532 struct slap_filter *f_un_complex;
535 #define f_result f_un.f_un_result
536 #define f_and f_un.f_un_complex
537 #define f_or f_un.f_un_complex
538 #define f_not f_un.f_un_complex
539 #define f_list f_un.f_un_complex
541 struct slap_filter *f_next;
544 /* compare routines can return undefined */
545 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
548 * represents an attribute (description + values)
550 typedef struct slap_attr {
551 AttributeDescription *a_desc;
552 struct berval **a_vals;
553 struct slap_attr *a_next;
558 * the id used in the indexes to refer to an entry
560 typedef unsigned long ID;
561 #define NOID ((ID)~0)
564 * represents an entry in core
566 typedef struct slap_entry {
568 * The ID field should only be changed before entry is
569 * inserted into a cache. The ID value is backend
574 char *e_dn; /* DN of this entry */
575 char *e_ndn; /* normalized DN of this entry */
576 Attribute *e_attrs; /* list of attributes + values */
578 /* for use by the backend for any purpose */
585 typedef struct slap_mod {
587 AttributeDescription *sm_desc;
588 struct berval **sm_bvalues;
591 typedef struct slap_mod_list {
592 Modification sml_mod;
593 #define sml_op sml_mod.sm_op
594 #define sml_desc sml_mod.sm_desc
595 #define sml_bvalues sml_mod.sm_bvalues
596 struct slap_mod_list *sml_next;
599 typedef struct slap_ldap_modlist {
601 struct slap_ldap_modlist *ml_next;
602 #define ml_op ml_mod.mod_op
603 #define ml_type ml_mod.mod_type
604 #define ml_values ml_mod.mod_values
605 #define ml_bvalues ml_mod.mod_bvalues
609 * represents an access control list
611 typedef enum slap_access_e {
612 ACL_INVALID_ACCESS = -1,
621 typedef enum slap_control_e {
622 ACL_INVALID_CONTROL = 0,
628 typedef enum slap_style_e {
636 /* alternate names */
637 ACL_STYLE_EXACT = ACL_STYLE_BASE
640 typedef struct slap_authz_info {
641 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
642 char * sai_mech; /* SASL Mechanism */
643 char * sai_dn; /* DN for reporting purposes */
644 char * sai_ndn; /* Normalized DN */
646 /* Security Strength Factors */
647 slap_ssf_t sai_ssf; /* Overall SSF */
648 slap_ssf_t sai_transport_ssf; /* Transport SSF */
649 slap_ssf_t sai_tls_ssf; /* TLS SSF */
650 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
651 } AuthorizationInformation;
654 typedef struct slap_access {
655 slap_control_t a_type;
657 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
659 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
660 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
661 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
662 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
663 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
664 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
666 #define ACL_PRIV_MASK 0x00ffUL
669 #define ACL_PRIV_LEVEL 0x1000UL
670 #define ACL_PRIV_ADDITIVE 0x2000UL
671 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
674 #define ACL_PRIV_INVALID 0x0UL
676 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
677 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
678 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
679 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
681 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
682 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
684 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
686 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
688 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
689 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
690 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
692 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
693 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
694 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
695 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
696 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
697 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
699 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
700 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
701 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
702 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
703 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
704 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
705 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
707 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
708 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
709 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
710 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
711 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
712 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
714 slap_mask_t a_access_mask;
716 AuthorizationInformation a_authz;
717 #define a_dn_pat a_authz.sai_dn
719 slap_style_t a_dn_style;
720 AttributeDescription *a_dn_at;
723 slap_style_t a_peername_style;
724 char *a_peername_pat;
725 slap_style_t a_sockname_style;
726 char *a_sockname_pat;
728 slap_style_t a_domain_style;
730 slap_style_t a_sockurl_style;
732 slap_style_t a_set_style;
735 #ifdef SLAPD_ACI_ENABLED
736 AttributeDescription *a_aci_at;
740 slap_style_t a_group_style;
742 ObjectClass *a_group_oc;
743 AttributeDescription *a_group_at;
745 struct slap_access *a_next;
749 typedef struct slap_acl {
750 /* "to" part: the entries this acl applies to */
752 slap_style_t acl_dn_style;
757 /* "by" part: list of who has what access to the entries */
760 struct slap_acl *acl_next;
764 * replog moddn param structure
766 struct replog_moddn {
774 * represents a backend
777 typedef struct slap_backend_info BackendInfo; /* per backend type */
778 typedef struct slap_backend_db BackendDB; /* per backend database */
780 LDAP_SLAPD_F (int) nBackendInfo;
781 LDAP_SLAPD_F (int) nBackendDB;
782 LDAP_SLAPD_F (BackendInfo *) backendInfo;
783 LDAP_SLAPD_F (BackendDB *) backendDB;
785 LDAP_SLAPD_F (int) slapMode;
786 #define SLAP_UNDEFINED_MODE 0x0000
787 #define SLAP_SERVER_MODE 0x0001
788 #define SLAP_TOOL_MODE 0x0002
789 #define SLAP_MODE 0x0003
791 #define SLAP_TRUNCATE_MODE 0x0100
793 /* temporary aliases */
794 typedef BackendDB Backend;
795 #define nbackends nBackendDB
796 #define backends backendDB
798 struct slap_backend_db {
799 BackendInfo *bd_info; /* pointer to shared backend info */
801 /* BackendInfo accessors */
802 #define be_config bd_info->bi_db_config
803 #define be_type bd_info->bi_type
805 #define be_bind bd_info->bi_op_bind
806 #define be_unbind bd_info->bi_op_unbind
807 #define be_add bd_info->bi_op_add
808 #define be_compare bd_info->bi_op_compare
809 #define be_delete bd_info->bi_op_delete
810 #define be_modify bd_info->bi_op_modify
811 #define be_modrdn bd_info->bi_op_modrdn
812 #define be_search bd_info->bi_op_search
814 #define be_extended bd_info->bi_extended
816 #define be_release bd_info->bi_entry_release_rw
817 #define be_chk_referrals bd_info->bi_chk_referrals
818 #define be_group bd_info->bi_acl_group
819 #define be_attribute bd_info->bi_acl_attribute
821 #define be_controls bd_info->bi_controls
823 #define be_connection_init bd_info->bi_connection_init
824 #define be_connection_destroy bd_info->bi_connection_destroy
827 #define be_entry_open bd_info->bi_tool_entry_open
828 #define be_entry_close bd_info->bi_tool_entry_close
829 #define be_entry_first bd_info->bi_tool_entry_first
830 #define be_entry_next bd_info->bi_tool_entry_next
831 #define be_entry_reindex bd_info->bi_tool_entry_reindex
832 #define be_entry_get bd_info->bi_tool_entry_get
833 #define be_entry_put bd_info->bi_tool_entry_put
834 #define be_sync bd_info->bi_tool_sync
837 slap_mask_t be_restrictops; /* restriction operations */
838 #define SLAP_RESTRICT_OP_ADD 0x0001U
839 #define SLAP_RESTRICT_OP_BIND 0x0002U
840 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
841 #define SLAP_RESTRICT_OP_DELETE 0x0008U
842 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
843 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
844 #define SLAP_RESTRICT_OP_RENAME 0x0040U
845 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
847 #define SLAP_RESTRICT_OP_READS \
848 ( SLAP_RESTRICT_OP_COMPARE \
849 | SLAP_RESTRICT_OP_SEARCH )
850 #define SLAP_RESTRICT_OP_WRITES \
851 ( SLAP_RESTRICT_OP_ADD \
852 | SLAP_RESTRICT_OP_DELETE \
853 | SLAP_RESTRICT_OP_MODIFY \
854 | SLAP_RESTRICT_OP_RENAME )
856 #define SLAP_DISALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
857 #define SLAP_DISALLOW_BIND_ANON 0x0002U /* no anonymous */
858 #define SLAP_DISALLOW_BIND_ANON_CRED \
859 0x0004U /* cred should be empty */
860 #define SLAP_DISALLOW_BIND_ANON_DN \
861 0x0008U /* dn should be empty */
863 slap_mask_t be_requires; /* pre-operation requirements */
864 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
865 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
866 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
867 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
868 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
871 /* Required Security Strength Factor */
872 slap_ssf_set_t be_ssf_set;
874 /* these should be renamed from be_ to bd_ */
875 char **be_suffix; /* the DN suffixes of data in this backend */
876 char **be_nsuffix; /* the normalized DN suffixes in this backend */
877 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
878 char *be_root_dn; /* the magic "root" dn for this db */
879 char *be_root_ndn; /* the magic "root" normalized dn for this db */
880 struct berval be_root_pw; /* the magic "root" password for this db */
881 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
882 int be_sizelimit; /* size limit for this backend */
883 int be_timelimit; /* time limit for this backend */
884 AccessControl *be_acl; /* access control list for this backend */
885 slap_access_t be_dfltaccess; /* access given if no acl matches */
886 char **be_replica; /* replicas of this backend (in master) */
887 char *be_replogfile; /* replication log file (in master) */
888 char *be_update_ndn; /* allowed to make changes (in replicas) */
889 struct berval **be_update_refs; /* where to refer modifying clients to */
890 int be_lastmod; /* keep track of lastmodified{by,time} */
894 void *be_private; /* anything the backend database needs */
900 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
902 struct slap_conn *conn,
905 struct berval * reqdata,
907 struct berval ** rspdata,
908 LDAPControl *** rspctrls,
910 struct berval *** refs ));
912 struct slap_backend_info {
913 char *bi_type; /* type of backend */
916 * per backend type routines:
917 * bi_init: called to allocate a backend_info structure,
918 * called once BEFORE configuration file is read.
919 * bi_init() initializes this structure hence is
920 * called directly from be_initialize()
921 * bi_config: called per 'backend' specific option
922 * all such options must before any 'database' options
923 * bi_config() is called only from read_config()
924 * bi_open: called to open each database, called
925 * once AFTER configuration file is read but
926 * BEFORE any bi_db_open() calls.
927 * bi_open() is called from backend_startup()
928 * bi_close: called to close each database, called
929 * once during shutdown after all bi_db_close calls.
930 * bi_close() is called from backend_shutdown()
931 * bi_destroy: called to destroy each database, called
932 * once during shutdown after all bi_db_destroy calls.
933 * bi_destory() is called from backend_destroy()
935 int (*bi_init) LDAP_P((BackendInfo *bi));
936 int (*bi_config) LDAP_P((BackendInfo *bi,
937 const char *fname, int lineno, int argc, char **argv ));
938 int (*bi_open) LDAP_P((BackendInfo *bi));
939 int (*bi_close) LDAP_P((BackendInfo *bi));
940 int (*bi_destroy) LDAP_P((BackendInfo *bi));
943 * per database routines:
944 * bi_db_init: called to initialize each database,
945 * called upon reading 'database <type>'
946 * called only from backend_db_init()
947 * bi_db_config: called to configure each database,
948 * called per database to handle per database options
949 * called only from read_config()
950 * bi_db_open: called to open each database
951 * called once per database immediately AFTER bi_open()
952 * calls but before daemon startup.
953 * called only by backend_startup()
954 * bi_db_close: called to close each database
955 * called once per database during shutdown but BEFORE
957 * called only by backend_shutdown()
958 * bi_db_destroy: called to destroy each database
959 * called once per database during shutdown AFTER all
960 * bi_close calls but before bi_destory calls.
961 * called only by backend_destory()
963 int (*bi_db_init) LDAP_P((Backend *bd));
964 int (*bi_db_config) LDAP_P((Backend *bd,
965 const char *fname, int lineno, int argc, char **argv ));
966 int (*bi_db_open) LDAP_P((Backend *bd));
967 int (*bi_db_close) LDAP_P((Backend *bd));
968 int (*bi_db_destroy) LDAP_P((Backend *db));
970 /* LDAP Operations Handling Routines */
971 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
972 struct slap_conn *c, struct slap_op *o,
973 const char *dn, const char *ndn, int method,
974 struct berval *cred, char** edn ));
975 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
976 struct slap_conn *c, struct slap_op *o ));
977 int (*bi_op_search) LDAP_P((BackendDB *bd,
978 struct slap_conn *c, struct slap_op *o,
979 const char *base, const char *nbase,
980 int scope, int deref,
981 int slimit, int tlimit,
982 Filter *f, const char *filterstr,
983 char **attrs, int attrsonly));
984 int (*bi_op_compare)LDAP_P((BackendDB *bd,
985 struct slap_conn *c, struct slap_op *o,
986 const char *dn, const char *ndn,
987 AttributeAssertion *ava));
988 int (*bi_op_modify) LDAP_P((BackendDB *bd,
989 struct slap_conn *c, struct slap_op *o,
990 const char *dn, const char *ndn, Modifications *m));
991 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
992 struct slap_conn *c, struct slap_op *o,
993 const char *dn, const char *ndn,
994 const char *newrdn, int deleteoldrdn,
995 const char *newSuperior));
996 int (*bi_op_add) LDAP_P((BackendDB *bd,
997 struct slap_conn *c, struct slap_op *o,
999 int (*bi_op_delete) LDAP_P((BackendDB *bd,
1000 struct slap_conn *c, struct slap_op *o,
1001 const char *dn, const char *ndn));
1002 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
1003 struct slap_conn *c, struct slap_op *o,
1006 /* Extended Operations Helper */
1007 SLAP_EXTENDED_FN bi_extended;
1009 /* Auxilary Functions */
1010 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
1012 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
1013 struct slap_conn *c, struct slap_op *o,
1014 const char *dn, const char *ndn,
1015 const char **text ));
1017 int (*bi_acl_group) LDAP_P((Backend *bd,
1018 Entry *e, const char *bdn, const char *edn,
1019 ObjectClass *group_oc,
1020 AttributeDescription *group_at ));
1021 int (*bi_acl_attribute) LDAP_P((Backend *bd,
1022 struct slap_conn *c, struct slap_op *o,
1023 Entry *e, const char *edn,
1024 AttributeDescription *entry_at,
1025 struct berval ***vals ));
1027 int (*bi_connection_init) LDAP_P((BackendDB *bd,
1028 struct slap_conn *c));
1029 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1030 struct slap_conn *c));
1032 /* hooks for slap tools */
1033 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1034 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1035 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1036 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1037 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1038 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1039 int (*bi_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1040 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1042 #define SLAP_INDEX_ADD_OP 0x0001
1043 #define SLAP_INDEX_DELETE_OP 0x0002
1045 char **bi_controls; /* supported controls */
1047 unsigned int bi_nDB; /* number of databases of this type */
1048 void *bi_private; /* anything the backend type needs */
1051 #define c_authtype c_authz.sai_method
1052 #define c_authmech c_authz.sai_mech
1053 #define c_dn c_authz.sai_dn
1054 #define c_ssf c_authz.sai_ssf
1055 #define c_transport_ssf c_authz.sai_transport_ssf
1056 #define c_tls_ssf c_authz.sai_tls_ssf
1057 #define c_sasl_ssf c_authz.sai_sasl_ssf
1059 #define o_authtype o_authz.sai_method
1060 #define o_authmech o_authz.sai_mech
1061 #define o_dn o_authz.sai_dn
1062 #define o_ndn o_authz.sai_ndn
1063 #define o_ssf o_authz.sai_ssf
1064 #define o_transport_ssf o_authz.sai_transport_ssf
1065 #define o_tls_ssf o_authz.sai_tls_ssf
1066 #define o_sasl_ssf o_authz.sai_sasl_ssf
1069 * represents an operation pending from an ldap client
1071 typedef struct slap_op {
1072 ber_int_t o_opid; /* id of this operation */
1073 ber_int_t o_msgid; /* msgid of the request */
1075 ldap_pvt_thread_t o_tid; /* thread handling this op */
1077 BerElement *o_ber; /* ber of the request */
1079 ber_tag_t o_tag; /* tag of the request */
1080 time_t o_time; /* time op was initiated */
1082 AuthorizationInformation o_authz;
1084 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1086 LDAPControl **o_ctrls; /* controls */
1088 unsigned long o_connid; /* id of conn initiating this op */
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
1100 typedef struct slap_conn {
1101 int c_struct_state; /* structure management state */
1102 int c_conn_state; /* connection state */
1104 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1105 Sockbuf *c_sb; /* ber connection stuff */
1107 /* only can be changed by connect_init */
1108 time_t c_starttime; /* when the connection was opened */
1109 time_t c_activitytime; /* when the connection was last used */
1110 unsigned long c_connid; /* id of this connection for stats*/
1112 char *c_listener_url; /* listener URL */
1113 char *c_peer_domain; /* DNS name of client */
1114 char *c_peer_name; /* peer name (trans=addr:port) */
1115 char *c_sock_name; /* sock name (trans=addr:port) */
1117 /* only can be changed by binding thread */
1118 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1119 char *c_sasl_bind_mech; /* mech in progress */
1122 /* authentication backend */
1123 Backend *c_authc_backend;
1125 /* authorization backend - normally same as c_authc_backend */
1126 Backend *c_authz_backend;
1128 AuthorizationInformation c_authz;
1130 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1132 Operation *c_ops; /* list of operations being processed */
1133 Operation *c_pending_ops; /* list of pending operations */
1135 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1136 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1138 BerElement *c_currentber; /* ber we're attempting to read */
1139 int c_writewaiter; /* true if writer is waiting */
1142 int c_is_tls; /* true if this LDAP over raw TLS */
1143 int c_needs_tls_accept; /* true if SSL_accept should be called */
1145 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1146 void *c_sasl_context; /* SASL session context */
1147 void *c_sasl_extra; /* SASL session extra stuff */
1149 long c_n_ops_received; /* num of ops received (next op_id) */
1150 long c_n_ops_executing; /* num of ops currently executing */
1151 long c_n_ops_pending; /* num of ops pending execution */
1152 long c_n_ops_completed; /* num of ops completed */
1154 long c_n_get; /* num of get calls */
1155 long c_n_read; /* num of read calls */
1156 long c_n_write; /* num of write calls */
1159 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1160 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1162 if ( ldap_debug & (level) ) \
1163 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1164 if ( ldap_syslog & (level) ) \
1165 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1169 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1174 #include "proto-slap.h"
1176 #endif /* _SLAP_H_ */