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 "cn=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_INCOMING (1<<18 - 1)
62 #define SLAP_MAX_WORKER_THREADS 32
65 /* psuedo error code indicating abandoned operation */
66 #define SLAPD_ABANDON (-1)
68 /* psuedo error code indicating disconnect */
69 #define SLAPD_DISCONNECT (-2)
72 /* We assume "C" locale, that is US-ASCII */
73 #define ASCII_SPACE(c) ( (c) == ' ' )
74 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
75 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
76 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
77 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
78 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
79 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
81 #define SLAP_NIBBLE(c) ((c)&0x0f)
82 #define SLAP_ESCAPE_CHAR ('\\')
83 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
84 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
86 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
87 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
89 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
90 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
91 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
93 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
94 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
95 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
96 #define OID_SEPARATOR(c) ( (c) == '.' )
97 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
99 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
100 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
102 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
103 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
105 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
107 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
108 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
109 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
110 (c) == '?' || (c) == ' ' )
111 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
113 /* must match in schema_init.c */
114 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
115 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
116 #define SLAPD_GROUP_ATTR "member"
117 #define SLAPD_GROUP_CLASS "groupOfNames"
118 #define SLAPD_ROLE_ATTR "roleOccupant"
119 #define SLAPD_ROLE_CLASS "organizationalRole"
121 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
122 #define SLAPD_ACI_ATTR "OpenLDAPaci"
124 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
126 /* change this to "OpenLDAPset" */
127 #define SLAPD_ACI_SET_ATTR "template"
129 #define SLAPD_TOP_OID "2.5.6.0"
131 LDAP_SLAPD_F (int) slap_debug;
133 typedef unsigned long slap_mask_t;
135 /* Security Strength Factor */
136 typedef unsigned slap_ssf_t;
138 typedef struct slap_ssf_set {
140 slap_ssf_t sss_transport;
143 slap_ssf_t sss_update_ssf;
144 slap_ssf_t sss_update_transport;
145 slap_ssf_t sss_update_tls;
146 slap_ssf_t sss_update_sasl;
152 #define SLAP_INDEX_TYPE 0x00FFUL
153 #define SLAP_INDEX_UNDEFINED 0x0001UL
154 #define SLAP_INDEX_PRESENT 0x0002UL
155 #define SLAP_INDEX_EQUALITY 0x0004UL
156 #define SLAP_INDEX_APPROX 0x0008UL
157 #define SLAP_INDEX_SUBSTR 0x0010UL
158 #define SLAP_INDEX_EXTENDED 0x0020UL
160 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
162 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
164 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
166 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
167 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
168 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
169 #define SLAP_INDEX_SUBSTR_DEFAULT \
170 ( SLAP_INDEX_SUBSTR \
171 | SLAP_INDEX_SUBSTR_INITIAL \
172 | SLAP_INDEX_SUBSTR_ANY \
173 | SLAP_INDEX_SUBSTR_FINAL )
175 #define SLAP_INDEX_SUBSTR_MINLEN 2
176 #define SLAP_INDEX_SUBSTR_MAXLEN 4
177 #define SLAP_INDEX_SUBSTR_STEP 2
179 #define SLAP_INDEX_FLAGS 0xF000UL
180 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
181 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
182 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
183 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
186 * there is a single index for each attribute. these prefixes ensure
187 * that there is no collision among keys.
189 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
190 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
191 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
192 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
193 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
194 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
195 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
197 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
198 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
199 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
202 * represents schema information for a database
204 #define SLAP_SCHERR_OUTOFMEM 1
205 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
206 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
207 #define SLAP_SCHERR_ATTR_NOT_FOUND 4
208 #define SLAP_SCHERR_ATTR_BAD_USAGE 5
209 #define SLAP_SCHERR_DUP_CLASS 6
210 #define SLAP_SCHERR_DUP_ATTR 7
211 #define SLAP_SCHERR_DUP_SYNTAX 8
212 #define SLAP_SCHERR_DUP_RULE 9
213 #define SLAP_SCHERR_NO_NAME 10
214 #define SLAP_SCHERR_ATTR_INCOMPLETE 11
215 #define SLAP_SCHERR_MR_NOT_FOUND 12
216 #define SLAP_SCHERR_SYN_NOT_FOUND 13
217 #define SLAP_SCHERR_MR_INCOMPLETE 14
219 typedef struct slap_oid_macro {
220 struct berval som_oid;
222 struct slap_oid_macro *som_next;
225 /* forward declarations */
227 struct slap_matching_rule;
229 typedef int slap_syntax_validate_func LDAP_P((
230 struct slap_syntax *syntax,
231 struct berval * in));
233 typedef int slap_syntax_transform_func LDAP_P((
234 struct slap_syntax *syntax,
236 struct berval ** out));
238 typedef struct slap_syntax {
240 #define ssyn_oid ssyn_syn.syn_oid
241 #define ssyn_desc ssyn_syn.syn_desc
242 #define ssyn_extensions ssyn_syn.syn_extensions
246 #define SLAP_SYNTAX_NONE 0x00U
247 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
248 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
249 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
250 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
252 slap_syntax_validate_func *ssyn_validate;
253 slap_syntax_transform_func *ssyn_normalize;
254 slap_syntax_transform_func *ssyn_pretty;
256 #ifdef SLAPD_BINARY_CONVERSION
257 /* convert to and from binary */
258 slap_syntax_transform_func *ssyn_ber2str;
259 slap_syntax_transform_func *ssyn_str2ber;
262 struct slap_syntax *ssyn_next;
265 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
266 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
267 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
268 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
269 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
271 /* X -> Y Converter */
272 typedef int slap_mr_convert_func LDAP_P((
274 struct berval ** out ));
277 typedef int slap_mr_normalize_func LDAP_P((
279 struct slap_syntax *syntax, /* NULL if in is asserted value */
280 struct slap_matching_rule *mr,
282 struct berval ** out ));
284 /* Match (compare) function */
285 typedef int slap_mr_match_func LDAP_P((
288 struct slap_syntax *syntax, /* syntax of stored value */
289 struct slap_matching_rule *mr,
290 struct berval * value,
291 void * assertValue ));
293 /* Index generation function */
294 typedef int slap_mr_indexer_func LDAP_P((
297 struct slap_syntax *syntax, /* syntax of stored value */
298 struct slap_matching_rule *mr,
299 struct berval *prefix,
300 struct berval **values,
301 struct berval ***keys ));
303 /* Filter index function */
304 typedef int slap_mr_filter_func LDAP_P((
307 struct slap_syntax *syntax, /* syntax of stored value */
308 struct slap_matching_rule *mr,
309 struct berval *prefix,
311 struct berval ***keys ));
313 typedef struct slap_matching_rule {
314 LDAPMatchingRule smr_mrule;
315 slap_mask_t smr_usage;
317 #define SLAP_MR_TYPE_MASK 0xFF00U
318 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
319 #define SLAP_MR_USAGE 0x000FU
321 #define SLAP_MR_NONE 0x0000U
322 #define SLAP_MR_EQUALITY 0x0100U
323 #define SLAP_MR_ORDERING 0x0200U
324 #define SLAP_MR_SUBSTR 0x0400U
325 #define SLAP_MR_EXT 0x0800U
327 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
329 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
330 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
331 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
333 /* this is used to kludge objectClass testing */
334 #define SLAP_MR_MODIFY_MATCHING 0x0001U
337 slap_mr_convert_func *smr_convert;
338 slap_mr_normalize_func *smr_normalize;
339 slap_mr_match_func *smr_match;
340 slap_mr_indexer_func *smr_indexer;
341 slap_mr_filter_func *smr_filter;
343 struct slap_matching_rule *smr_associated;
344 struct slap_matching_rule *smr_next;
346 #define smr_oid smr_mrule.mr_oid
347 #define smr_names smr_mrule.mr_names
348 #define smr_desc smr_mrule.mr_desc
349 #define smr_obsolete smr_mrule.mr_obsolete
350 #define smr_syntax_oid smr_mrule.mr_syntax_oid
351 #define smr_extensions smr_mrule.mr_extensions
354 typedef struct slap_attribute_type {
356 LDAPAttributeType sat_atype;
357 struct slap_attribute_type *sat_sup;
358 struct slap_attribute_type **sat_subtypes;
359 MatchingRule *sat_equality;
360 MatchingRule *sat_approx;
361 MatchingRule *sat_ordering;
362 MatchingRule *sat_substr;
364 struct slap_attribute_type *sat_next;
365 #define sat_oid sat_atype.at_oid
366 #define sat_names sat_atype.at_names
367 #define sat_desc sat_atype.at_desc
368 #define sat_obsolete sat_atype.at_obsolete
369 #define sat_sup_oid sat_atype.at_sup_oid
370 #define sat_equality_oid sat_atype.at_equality_oid
371 #define sat_ordering_oid sat_atype.at_ordering_oid
372 #define sat_substr_oid sat_atype.at_substr_oid
373 #define sat_syntax_oid sat_atype.at_syntax_oid
374 #define sat_single_value sat_atype.at_single_value
375 #define sat_collective sat_atype.at_collective
376 #define sat_no_user_mod sat_atype.at_no_user_mod
377 #define sat_usage sat_atype.at_usage
378 #define sat_extensions sat_atype.at_extensions
381 #define is_at_operational(at) ((at)->sat_usage)
382 #define is_at_single_value(at) ((at)->sat_single_value)
383 #define is_at_collective(at) ((at)->sat_collective)
384 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
386 typedef struct slap_object_class {
387 LDAPObjectClass soc_oclass;
388 struct slap_object_class **soc_sups;
389 AttributeType **soc_required;
390 AttributeType **soc_allowed;
391 struct slap_object_class *soc_next;
392 #define soc_oid soc_oclass.oc_oid
393 #define soc_names soc_oclass.oc_names
394 #define soc_desc soc_oclass.oc_desc
395 #define soc_obsolete soc_oclass.oc_obsolete
396 #define soc_sup_oids soc_oclass.oc_sup_oids
397 #define soc_kind soc_oclass.oc_kind
398 #define soc_at_oids_must soc_oclass.oc_at_oids_must
399 #define soc_at_oids_may soc_oclass.oc_at_oids_may
400 #define soc_extensions soc_oclass.oc_extensions
405 * represents a recognized attribute description ( type + options )
407 typedef struct slap_attr_desc {
408 struct berval *ad_cname; /* canonical name, must be specified */
409 AttributeType *ad_type; /* attribute type, must be specified */
410 char *ad_lang; /* NULL if no language tags */
412 #define SLAP_DESC_NONE 0x0U
413 #define SLAP_DESC_BINARY 0x1U
414 } AttributeDescription;
416 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
417 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
420 * pointers to schema elements used internally
422 struct slap_internal_schema {
424 ObjectClass *si_oc_top;
425 ObjectClass *si_oc_extensibleObject;
426 ObjectClass *si_oc_alias;
427 ObjectClass *si_oc_referral;
428 ObjectClass *si_oc_subentry;
429 ObjectClass *si_oc_subschema;
430 ObjectClass *si_oc_rootdse;
432 /* objectClass attribute descriptions */
433 AttributeDescription *si_ad_objectClass;
435 /* operational attribute descriptions */
436 AttributeDescription *si_ad_structuralObjectClass;
437 AttributeDescription *si_ad_creatorsName;
438 AttributeDescription *si_ad_createTimestamp;
439 AttributeDescription *si_ad_modifiersName;
440 AttributeDescription *si_ad_modifyTimestamp;
441 AttributeDescription *si_ad_subschemaSubentry;
443 /* root DSE attribute descriptions */
444 AttributeDescription *si_ad_namingContexts;
445 AttributeDescription *si_ad_supportedControl;
446 AttributeDescription *si_ad_supportedExtension;
447 AttributeDescription *si_ad_supportedLDAPVersion;
448 AttributeDescription *si_ad_supportedSASLMechanisms;
450 /* subschema subentry attribute descriptions */
451 AttributeDescription *si_ad_objectClasses;
452 AttributeDescription *si_ad_attributeTypes;
453 AttributeDescription *si_ad_ldapSyntaxes;
454 AttributeDescription *si_ad_matchingRules;
455 AttributeDescription *si_ad_matchingRulesUse;
457 /* Aliases & Referrals */
458 AttributeDescription *si_ad_aliasedObjectName;
459 AttributeDescription *si_ad_ref;
461 /* Access Control Internals */
462 AttributeDescription *si_ad_entry;
463 AttributeDescription *si_ad_children;
464 #ifdef SLAPD_ACI_ENABLED
465 AttributeDescription *si_ad_aci;
468 /* Other attributes descriptions */
469 AttributeDescription *si_ad_userPassword;
470 AttributeDescription *si_ad_authPassword;
471 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
472 AttributeDescription *si_ad_krbName;
475 /* Undefined Attribute Type */
476 AttributeType *si_at_undefined;
479 typedef struct slap_attr_assertion {
480 AttributeDescription *aa_desc;
481 struct berval *aa_value;
482 } AttributeAssertion;
484 typedef struct slap_ss_assertion {
485 AttributeDescription *sa_desc;
486 struct berval *sa_initial;
487 struct berval **sa_any;
488 struct berval *sa_final;
489 } SubstringsAssertion;
491 typedef struct slap_mr_assertion {
492 MatchingRule *ma_rule; /* optional */
493 char *ma_rule_text; /* optional */
494 AttributeDescription *ma_desc; /* optional */
495 int ma_dnattrs; /* boolean */
496 struct berval *ma_value; /* required */
497 } MatchingRuleAssertion;
501 * represents a search filter
503 typedef struct slap_filter {
504 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
505 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
506 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
507 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
511 /* precomputed result */
512 ber_int_t f_un_result;
518 AttributeDescription *f_un_desc;
520 /* simple value assertion */
521 AttributeAssertion *f_un_ava;
523 /* substring assertion */
524 SubstringsAssertion *f_un_ssa;
526 /* matching rule assertion */
527 MatchingRuleAssertion *f_un_mra;
529 #define f_dn f_un.f_un_dn
530 #define f_desc f_un.f_un_desc
531 #define f_ava f_un.f_un_ava
532 #define f_av_desc f_un.f_un_ava->aa_desc
533 #define f_av_value f_un.f_un_ava->aa_value
534 #define f_sub f_un.f_un_ssa
535 #define f_sub_desc f_un.f_un_ssa->sa_desc
536 #define f_sub_initial f_un.f_un_ssa->sa_initial
537 #define f_sub_any f_un.f_un_ssa->sa_any
538 #define f_sub_final f_un.f_un_ssa->sa_final
539 #define f_mra f_un.f_un_mra
540 #define f_mr_rule f_un.f_un_mra->ma_rule
541 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
542 #define f_mr_desc f_un.f_un_mra->ma_desc
543 #define f_mr_value f_un.f_un_mra->ma_value
544 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
547 struct slap_filter *f_un_complex;
550 #define f_result f_un.f_un_result
551 #define f_and f_un.f_un_complex
552 #define f_or f_un.f_un_complex
553 #define f_not f_un.f_un_complex
554 #define f_list f_un.f_un_complex
556 struct slap_filter *f_next;
559 /* compare routines can return undefined */
560 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
563 * represents an attribute (description + values)
565 typedef struct slap_attr {
566 AttributeDescription *a_desc;
567 struct berval **a_vals;
568 struct slap_attr *a_next;
573 * the id used in the indexes to refer to an entry
575 typedef unsigned long ID;
576 #define NOID ((ID)~0)
579 * represents an entry in core
581 typedef struct slap_entry {
583 * The ID field should only be changed before entry is
584 * inserted into a cache. The ID value is backend
589 char *e_dn; /* DN of this entry */
590 char *e_ndn; /* normalized DN of this entry */
591 Attribute *e_attrs; /* list of attributes + values */
593 /* for use by the backend for any purpose */
600 typedef struct slap_mod {
602 AttributeDescription *sm_desc;
603 struct berval **sm_bvalues;
606 typedef struct slap_mod_list {
607 Modification sml_mod;
608 #define sml_op sml_mod.sm_op
609 #define sml_desc sml_mod.sm_desc
610 #define sml_bvalues sml_mod.sm_bvalues
611 struct slap_mod_list *sml_next;
614 typedef struct slap_ldap_modlist {
616 struct slap_ldap_modlist *ml_next;
617 #define ml_op ml_mod.mod_op
618 #define ml_type ml_mod.mod_type
619 #define ml_values ml_mod.mod_values
620 #define ml_bvalues ml_mod.mod_bvalues
624 * represents an access control list
626 typedef enum slap_access_e {
627 ACL_INVALID_ACCESS = -1,
636 typedef enum slap_control_e {
637 ACL_INVALID_CONTROL = 0,
643 typedef enum slap_style_e {
651 /* alternate names */
652 ACL_STYLE_EXACT = ACL_STYLE_BASE
655 typedef struct slap_authz_info {
656 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
657 char * sai_mech; /* SASL Mechanism */
658 char * sai_dn; /* DN for reporting purposes */
659 char * sai_ndn; /* Normalized DN */
661 /* Security Strength Factors */
662 slap_ssf_t sai_ssf; /* Overall SSF */
663 slap_ssf_t sai_transport_ssf; /* Transport SSF */
664 slap_ssf_t sai_tls_ssf; /* TLS SSF */
665 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
666 } AuthorizationInformation;
669 typedef struct slap_access {
670 slap_control_t a_type;
672 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
674 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
675 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
676 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
677 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
678 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
679 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
681 #define ACL_PRIV_MASK 0x00ffUL
684 #define ACL_PRIV_LEVEL 0x1000UL
685 #define ACL_PRIV_ADDITIVE 0x2000UL
686 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
689 #define ACL_PRIV_INVALID 0x0UL
691 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
692 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
693 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
694 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
696 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
697 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
699 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
701 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
703 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
704 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
705 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
707 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
708 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
709 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
710 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
711 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
712 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
714 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
715 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
716 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
717 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
718 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
719 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
720 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
722 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
723 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
724 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
725 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
726 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
727 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
729 slap_mask_t a_access_mask;
731 AuthorizationInformation a_authz;
732 #define a_dn_pat a_authz.sai_dn
734 slap_style_t a_dn_style;
735 AttributeDescription *a_dn_at;
738 slap_style_t a_peername_style;
739 char *a_peername_pat;
740 slap_style_t a_sockname_style;
741 char *a_sockname_pat;
743 slap_style_t a_domain_style;
745 slap_style_t a_sockurl_style;
747 slap_style_t a_set_style;
750 #ifdef SLAPD_ACI_ENABLED
751 AttributeDescription *a_aci_at;
755 slap_style_t a_group_style;
757 ObjectClass *a_group_oc;
758 AttributeDescription *a_group_at;
760 struct slap_access *a_next;
764 typedef struct slap_acl {
765 /* "to" part: the entries this acl applies to */
767 slap_style_t acl_dn_style;
772 /* "by" part: list of who has what access to the entries */
775 struct slap_acl *acl_next;
779 * replog moddn param structure
781 struct replog_moddn {
789 * represents a backend
792 typedef struct slap_backend_info BackendInfo; /* per backend type */
793 typedef struct slap_backend_db BackendDB; /* per backend database */
795 LDAP_SLAPD_F (int) nBackendInfo;
796 LDAP_SLAPD_F (int) nBackendDB;
797 LDAP_SLAPD_F (BackendInfo *) backendInfo;
798 LDAP_SLAPD_F (BackendDB *) backendDB;
800 LDAP_SLAPD_F (int) slapMode;
801 #define SLAP_UNDEFINED_MODE 0x0000
802 #define SLAP_SERVER_MODE 0x0001
803 #define SLAP_TOOL_MODE 0x0002
804 #define SLAP_MODE 0x0003
806 #define SLAP_TRUNCATE_MODE 0x0100
808 /* temporary aliases */
809 typedef BackendDB Backend;
810 #define nbackends nBackendDB
811 #define backends backendDB
813 struct slap_backend_db {
814 BackendInfo *bd_info; /* pointer to shared backend info */
816 /* BackendInfo accessors */
817 #define be_config bd_info->bi_db_config
818 #define be_type bd_info->bi_type
820 #define be_bind bd_info->bi_op_bind
821 #define be_unbind bd_info->bi_op_unbind
822 #define be_add bd_info->bi_op_add
823 #define be_compare bd_info->bi_op_compare
824 #define be_delete bd_info->bi_op_delete
825 #define be_modify bd_info->bi_op_modify
826 #define be_modrdn bd_info->bi_op_modrdn
827 #define be_search bd_info->bi_op_search
829 #define be_extended bd_info->bi_extended
831 #define be_release bd_info->bi_entry_release_rw
832 #define be_chk_referrals bd_info->bi_chk_referrals
833 #define be_group bd_info->bi_acl_group
834 #define be_attribute bd_info->bi_acl_attribute
836 #define be_controls bd_info->bi_controls
838 #define be_connection_init bd_info->bi_connection_init
839 #define be_connection_destroy bd_info->bi_connection_destroy
842 #define be_entry_open bd_info->bi_tool_entry_open
843 #define be_entry_close bd_info->bi_tool_entry_close
844 #define be_entry_first bd_info->bi_tool_entry_first
845 #define be_entry_next bd_info->bi_tool_entry_next
846 #define be_entry_reindex bd_info->bi_tool_entry_reindex
847 #define be_entry_get bd_info->bi_tool_entry_get
848 #define be_entry_put bd_info->bi_tool_entry_put
849 #define be_sync bd_info->bi_tool_sync
852 slap_mask_t be_restrictops; /* restriction operations */
853 #define SLAP_RESTRICT_OP_ADD 0x0001U
854 #define SLAP_RESTRICT_OP_BIND 0x0002U
855 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
856 #define SLAP_RESTRICT_OP_DELETE 0x0008U
857 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
858 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
859 #define SLAP_RESTRICT_OP_RENAME 0x0040U
860 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
862 #define SLAP_RESTRICT_OP_READS \
863 ( SLAP_RESTRICT_OP_COMPARE \
864 | SLAP_RESTRICT_OP_SEARCH )
865 #define SLAP_RESTRICT_OP_WRITES \
866 ( SLAP_RESTRICT_OP_ADD \
867 | SLAP_RESTRICT_OP_DELETE \
868 | SLAP_RESTRICT_OP_MODIFY \
869 | SLAP_RESTRICT_OP_RENAME )
871 #define SLAP_ALLOW_TLS_2_ANON 0x0001U /* StartTLS -> Anonymous */
873 #define SLAP_DISALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
874 #define SLAP_DISALLOW_BIND_ANON 0x0002U /* no anonymous */
875 #define SLAP_DISALLOW_BIND_ANON_CRED \
876 0x0004U /* cred should be empty */
877 #define SLAP_DISALLOW_BIND_ANON_DN \
878 0x0008U /* dn should be empty */
880 #define SLAP_DISALLOW_BIND_SIMPLE 0x0010U /* simple authentication */
881 #define SLAP_DISALLOW_BIND_KRBV4 0x0020U /* Kerberos V4 authentication */
883 #define SLAP_DISALLOW_TLS_AUTHC 0x0100U /* TLS while authenticated */
885 slap_mask_t be_requires; /* pre-operation requirements */
886 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
887 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
888 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
889 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
890 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
892 /* Required Security Strength Factor */
893 slap_ssf_set_t be_ssf_set;
895 /* these should be renamed from be_ to bd_ */
896 char **be_suffix; /* the DN suffixes of data in this backend */
897 char **be_nsuffix; /* the normalized DN suffixes in this backend */
898 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
899 char *be_root_dn; /* the magic "root" dn for this db */
900 char *be_root_ndn; /* the magic "root" normalized dn for this db */
901 struct berval be_root_pw; /* the magic "root" password for this db */
902 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
903 int be_sizelimit; /* size limit for this backend */
904 int be_timelimit; /* time limit for this backend */
905 AccessControl *be_acl; /* access control list for this backend */
906 slap_access_t be_dfltaccess; /* access given if no acl matches */
907 char **be_replica; /* replicas of this backend (in master) */
908 char *be_replogfile; /* replication log file (in master) */
909 char *be_update_ndn; /* allowed to make changes (in replicas) */
910 struct berval **be_update_refs; /* where to refer modifying clients to */
911 int be_lastmod; /* keep track of lastmodified{by,time} */
915 void *be_private; /* anything the backend database needs */
921 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
923 struct slap_conn *conn,
926 struct berval * reqdata,
928 struct berval ** rspdata,
929 LDAPControl *** rspctrls,
931 struct berval *** refs ));
933 struct slap_backend_info {
934 char *bi_type; /* type of backend */
937 * per backend type routines:
938 * bi_init: called to allocate a backend_info structure,
939 * called once BEFORE configuration file is read.
940 * bi_init() initializes this structure hence is
941 * called directly from be_initialize()
942 * bi_config: called per 'backend' specific option
943 * all such options must before any 'database' options
944 * bi_config() is called only from read_config()
945 * bi_open: called to open each database, called
946 * once AFTER configuration file is read but
947 * BEFORE any bi_db_open() calls.
948 * bi_open() is called from backend_startup()
949 * bi_close: called to close each database, called
950 * once during shutdown after all bi_db_close calls.
951 * bi_close() is called from backend_shutdown()
952 * bi_destroy: called to destroy each database, called
953 * once during shutdown after all bi_db_destroy calls.
954 * bi_destory() is called from backend_destroy()
956 int (*bi_init) LDAP_P((BackendInfo *bi));
957 int (*bi_config) LDAP_P((BackendInfo *bi,
958 const char *fname, int lineno, int argc, char **argv ));
959 int (*bi_open) LDAP_P((BackendInfo *bi));
960 int (*bi_close) LDAP_P((BackendInfo *bi));
961 int (*bi_destroy) LDAP_P((BackendInfo *bi));
964 * per database routines:
965 * bi_db_init: called to initialize each database,
966 * called upon reading 'database <type>'
967 * called only from backend_db_init()
968 * bi_db_config: called to configure each database,
969 * called per database to handle per database options
970 * called only from read_config()
971 * bi_db_open: called to open each database
972 * called once per database immediately AFTER bi_open()
973 * calls but before daemon startup.
974 * called only by backend_startup()
975 * bi_db_close: called to close each database
976 * called once per database during shutdown but BEFORE
978 * called only by backend_shutdown()
979 * bi_db_destroy: called to destroy each database
980 * called once per database during shutdown AFTER all
981 * bi_close calls but before bi_destory calls.
982 * called only by backend_destory()
984 int (*bi_db_init) LDAP_P((Backend *bd));
985 int (*bi_db_config) LDAP_P((Backend *bd,
986 const char *fname, int lineno, int argc, char **argv ));
987 int (*bi_db_open) LDAP_P((Backend *bd));
988 int (*bi_db_close) LDAP_P((Backend *bd));
989 int (*bi_db_destroy) LDAP_P((Backend *db));
991 /* LDAP Operations Handling Routines */
992 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
993 struct slap_conn *c, struct slap_op *o,
994 const char *dn, const char *ndn, int method,
995 struct berval *cred, char** edn ));
996 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
997 struct slap_conn *c, struct slap_op *o ));
998 int (*bi_op_search) LDAP_P((BackendDB *bd,
999 struct slap_conn *c, struct slap_op *o,
1000 const char *base, const char *nbase,
1001 int scope, int deref,
1002 int slimit, int tlimit,
1003 Filter *f, const char *filterstr,
1004 char **attrs, int attrsonly));
1005 int (*bi_op_compare)LDAP_P((BackendDB *bd,
1006 struct slap_conn *c, struct slap_op *o,
1007 const char *dn, const char *ndn,
1008 AttributeAssertion *ava));
1009 int (*bi_op_modify) LDAP_P((BackendDB *bd,
1010 struct slap_conn *c, struct slap_op *o,
1011 const char *dn, const char *ndn, Modifications *m));
1012 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
1013 struct slap_conn *c, struct slap_op *o,
1014 const char *dn, const char *ndn,
1015 const char *newrdn, int deleteoldrdn,
1016 const char *newSuperior));
1017 int (*bi_op_add) LDAP_P((BackendDB *bd,
1018 struct slap_conn *c, struct slap_op *o,
1020 int (*bi_op_delete) LDAP_P((BackendDB *bd,
1021 struct slap_conn *c, struct slap_op *o,
1022 const char *dn, const char *ndn));
1023 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
1024 struct slap_conn *c, struct slap_op *o,
1027 /* Extended Operations Helper */
1028 SLAP_EXTENDED_FN bi_extended;
1030 /* Auxilary Functions */
1031 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd,
1032 struct slap_conn *c, struct slap_op *o,
1035 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
1036 struct slap_conn *c, struct slap_op *o,
1037 const char *dn, const char *ndn,
1038 const char **text ));
1040 int (*bi_acl_group) LDAP_P((Backend *bd,
1041 struct slap_conn *c, struct slap_op *o,
1042 Entry *e, const char *bdn, const char *edn,
1043 ObjectClass *group_oc,
1044 AttributeDescription *group_at ));
1045 int (*bi_acl_attribute) LDAP_P((Backend *bd,
1046 struct slap_conn *c, struct slap_op *o,
1047 Entry *e, const char *edn,
1048 AttributeDescription *entry_at,
1049 struct berval ***vals ));
1051 int (*bi_connection_init) LDAP_P((BackendDB *bd,
1052 struct slap_conn *c));
1053 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1054 struct slap_conn *c));
1056 /* hooks for slap tools */
1057 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1058 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1059 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1060 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1061 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1062 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1063 int (*bi_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1064 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1066 #define SLAP_INDEX_ADD_OP 0x0001
1067 #define SLAP_INDEX_DELETE_OP 0x0002
1069 char **bi_controls; /* supported controls */
1071 unsigned int bi_nDB; /* number of databases of this type */
1072 void *bi_private; /* anything the backend type needs */
1075 #define c_authtype c_authz.sai_method
1076 #define c_authmech c_authz.sai_mech
1077 #define c_dn c_authz.sai_dn
1078 #define c_ssf c_authz.sai_ssf
1079 #define c_transport_ssf c_authz.sai_transport_ssf
1080 #define c_tls_ssf c_authz.sai_tls_ssf
1081 #define c_sasl_ssf c_authz.sai_sasl_ssf
1083 #define o_authtype o_authz.sai_method
1084 #define o_authmech o_authz.sai_mech
1085 #define o_dn o_authz.sai_dn
1086 #define o_ndn o_authz.sai_ndn
1087 #define o_ssf o_authz.sai_ssf
1088 #define o_transport_ssf o_authz.sai_transport_ssf
1089 #define o_tls_ssf o_authz.sai_tls_ssf
1090 #define o_sasl_ssf o_authz.sai_sasl_ssf
1093 * represents an operation pending from an ldap client
1095 typedef struct slap_op {
1096 ber_int_t o_opid; /* id of this operation */
1097 ber_int_t o_msgid; /* msgid of the request */
1099 ldap_pvt_thread_t o_tid; /* thread handling this op */
1101 BerElement *o_ber; /* ber of the request */
1103 ber_tag_t o_tag; /* tag of the request */
1104 time_t o_time; /* time op was initiated */
1106 AuthorizationInformation o_authz;
1108 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1110 LDAPControl **o_ctrls; /* controls */
1112 unsigned long o_connid; /* id of conn initiating this op */
1114 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1115 int o_abandon; /* abandon flag */
1117 struct slap_op *o_next; /* next operation in list */
1118 void *o_private; /* anything the backend needs */
1122 * represents a connection from an ldap client
1124 typedef struct slap_conn {
1125 int c_struct_state; /* structure management state */
1126 int c_conn_state; /* connection state */
1128 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1129 Sockbuf *c_sb; /* ber connection stuff */
1131 /* only can be changed by connect_init */
1132 time_t c_starttime; /* when the connection was opened */
1133 time_t c_activitytime; /* when the connection was last used */
1134 unsigned long c_connid; /* id of this connection for stats*/
1136 char *c_listener_url; /* listener URL */
1137 char *c_peer_domain; /* DNS name of client */
1138 char *c_peer_name; /* peer name (trans=addr:port) */
1139 char *c_sock_name; /* sock name (trans=addr:port) */
1141 /* only can be changed by binding thread */
1142 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1143 char *c_sasl_bind_mech; /* mech in progress */
1146 /* authentication backend */
1147 Backend *c_authc_backend;
1149 /* authorization backend - normally same as c_authc_backend */
1150 Backend *c_authz_backend;
1152 AuthorizationInformation c_authz;
1154 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1156 Operation *c_ops; /* list of operations being processed */
1157 Operation *c_pending_ops; /* list of pending operations */
1159 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1160 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1162 BerElement *c_currentber; /* ber we're attempting to read */
1163 int c_writewaiter; /* true if writer is waiting */
1166 int c_is_tls; /* true if this LDAP over raw TLS */
1167 int c_needs_tls_accept; /* true if SSL_accept should be called */
1169 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1170 void *c_sasl_context; /* SASL session context */
1171 void *c_sasl_extra; /* SASL session extra stuff */
1173 long c_n_ops_received; /* num of ops received (next op_id) */
1174 long c_n_ops_executing; /* num of ops currently executing */
1175 long c_n_ops_pending; /* num of ops pending execution */
1176 long c_n_ops_completed; /* num of ops completed */
1178 long c_n_get; /* num of get calls */
1179 long c_n_read; /* num of read calls */
1180 long c_n_write; /* num of write calls */
1183 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1184 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1186 if ( ldap_debug & (level) ) \
1187 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1188 if ( ldap_syslog & (level) ) \
1189 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1193 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1197 #define SASLREGEX_REPLACE 10
1198 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1199 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1201 typedef struct sasl_regexp {
1202 char *match; /* regexp match pattern */
1203 char *replace; /* regexp replace pattern */
1204 regex_t workspace; /* workspace for regexp engine */
1205 regmatch_t strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1206 int offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1209 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1210 #define FLAG_GETDN_FINAL 1
1211 #define FLAG_GETDN_AUTHCID 2
1212 #define FLAG_GETDN_AUTHZID 4
1217 #include "proto-slap.h"
1219 #endif /* _SLAP_H_ */