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 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
105 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
106 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
107 (c) == '?' || (c) == ' ' )
109 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
111 /* must match in schema_init.c */
112 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
113 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
114 #define SLAPD_GROUP_ATTR "member"
115 #define SLAPD_GROUP_CLASS "groupOfNames"
116 #define SLAPD_ROLE_ATTR "roleOccupant"
117 #define SLAPD_ROLE_CLASS "organizationalRole"
119 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
120 #define SLAPD_ACI_ATTR "OpenLDAPaci"
122 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
124 /* change this to "OpenLDAPset" */
125 #define SLAPD_ACI_SET_ATTR "template"
127 #define SLAPD_TOP_OID "2.5.6.0"
129 LDAP_SLAPD_F (int) slap_debug;
131 typedef unsigned long slap_mask_t;
133 /* Security Strength Factor */
134 typedef unsigned slap_ssf_t;
136 typedef struct slap_ssf_set {
138 slap_ssf_t sss_transport;
141 slap_ssf_t sss_update_ssf;
142 slap_ssf_t sss_update_transport;
143 slap_ssf_t sss_update_tls;
144 slap_ssf_t sss_update_sasl;
150 #define SLAP_INDEX_TYPE 0x00FFUL
151 #define SLAP_INDEX_UNDEFINED 0x0001UL
152 #define SLAP_INDEX_PRESENT 0x0002UL
153 #define SLAP_INDEX_EQUALITY 0x0004UL
154 #define SLAP_INDEX_APPROX 0x0008UL
155 #define SLAP_INDEX_SUBSTR 0x0010UL
156 #define SLAP_INDEX_EXTENDED 0x0020UL
158 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
160 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
162 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
164 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
165 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
166 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
167 #define SLAP_INDEX_SUBSTR_DEFAULT \
168 ( SLAP_INDEX_SUBSTR \
169 | SLAP_INDEX_SUBSTR_INITIAL \
170 | SLAP_INDEX_SUBSTR_ANY \
171 | SLAP_INDEX_SUBSTR_FINAL )
173 #define SLAP_INDEX_SUBSTR_MINLEN 2
174 #define SLAP_INDEX_SUBSTR_MAXLEN 4
175 #define SLAP_INDEX_SUBSTR_STEP 2
177 #define SLAP_INDEX_FLAGS 0xF000UL
178 #define SLAP_INDEX_SUBTYPES 0x1000UL /* use index with subtypes */
179 #define SLAP_INDEX_AUTO_SUBTYPES 0x2000UL /* use mask with subtypes */
180 #define SLAP_INDEX_LANG 0x4000UL /* use index with lang subtypes */
181 #define SLAP_INDEX_AUTO_LANG 0x8000UL /* use mask with lang subtypes */
184 * there is a single index for each attribute. these prefixes ensure
185 * that there is no collision among keys.
187 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
188 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
189 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
190 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
191 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
192 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
193 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
195 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
196 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
197 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
200 * represents schema information for a database
202 #define SLAP_SCHERR_OUTOFMEM 1
203 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
204 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
205 #define SLAP_SCHERR_DUP_CLASS 4
206 #define SLAP_SCHERR_DUP_ATTR 5
207 #define SLAP_SCHERR_DUP_SYNTAX 6
208 #define SLAP_SCHERR_DUP_RULE 7
209 #define SLAP_SCHERR_NO_NAME 8
210 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
211 #define SLAP_SCHERR_MR_NOT_FOUND 10
212 #define SLAP_SCHERR_SYN_NOT_FOUND 11
213 #define SLAP_SCHERR_MR_INCOMPLETE 12
215 typedef struct slap_oid_macro {
216 struct berval som_oid;
218 struct slap_oid_macro *som_next;
221 /* forward declarations */
223 struct slap_matching_rule;
225 typedef int slap_syntax_validate_func LDAP_P((
226 struct slap_syntax *syntax,
227 struct berval * in));
229 typedef int slap_syntax_transform_func LDAP_P((
230 struct slap_syntax *syntax,
232 struct berval ** out));
234 typedef struct slap_syntax {
236 #define ssyn_oid ssyn_syn.syn_oid
237 #define ssyn_desc ssyn_syn.syn_desc
238 #define ssyn_extensions ssyn_syn.syn_extensions
242 #define SLAP_SYNTAX_NONE 0x00U
243 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
244 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
245 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
246 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
248 slap_syntax_validate_func *ssyn_validate;
249 slap_syntax_transform_func *ssyn_normalize;
250 slap_syntax_transform_func *ssyn_pretty;
252 #ifdef SLAPD_BINARY_CONVERSION
253 /* convert to and from binary */
254 slap_syntax_transform_func *ssyn_ber2str;
255 slap_syntax_transform_func *ssyn_str2ber;
258 struct slap_syntax *ssyn_next;
261 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
262 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
263 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
264 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
265 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
267 /* X -> Y Converter */
268 typedef int slap_mr_convert_func LDAP_P((
270 struct berval ** out ));
273 typedef int slap_mr_normalize_func LDAP_P((
275 struct slap_syntax *syntax, /* NULL if in is asserted value */
276 struct slap_matching_rule *mr,
278 struct berval ** out ));
280 /* Match (compare) function */
281 typedef int slap_mr_match_func LDAP_P((
284 struct slap_syntax *syntax, /* syntax of stored value */
285 struct slap_matching_rule *mr,
286 struct berval * value,
287 void * assertValue ));
289 /* Index generation function */
290 typedef int slap_mr_indexer_func LDAP_P((
293 struct slap_syntax *syntax, /* syntax of stored value */
294 struct slap_matching_rule *mr,
295 struct berval *prefix,
296 struct berval **values,
297 struct berval ***keys ));
299 /* Filter index function */
300 typedef int slap_mr_filter_func LDAP_P((
303 struct slap_syntax *syntax, /* syntax of stored value */
304 struct slap_matching_rule *mr,
305 struct berval *prefix,
307 struct berval ***keys ));
309 typedef struct slap_matching_rule {
310 LDAPMatchingRule smr_mrule;
311 slap_mask_t smr_usage;
313 #define SLAP_MR_TYPE_MASK 0xFF00U
314 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
315 #define SLAP_MR_USAGE 0x000FU
317 #define SLAP_MR_NONE 0x0000U
318 #define SLAP_MR_EQUALITY 0x0100U
319 #define SLAP_MR_ORDERING 0x0200U
320 #define SLAP_MR_SUBSTR 0x0400U
321 #define SLAP_MR_EXT 0x0800U
323 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
325 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
326 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
327 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
329 /* this is used to kludge objectClass testing */
330 #define SLAP_MR_MODIFY_MATCHING 0x0001U
333 slap_mr_convert_func *smr_convert;
334 slap_mr_normalize_func *smr_normalize;
335 slap_mr_match_func *smr_match;
336 slap_mr_indexer_func *smr_indexer;
337 slap_mr_filter_func *smr_filter;
339 struct slap_matching_rule *smr_associated;
340 struct slap_matching_rule *smr_next;
342 #define smr_oid smr_mrule.mr_oid
343 #define smr_names smr_mrule.mr_names
344 #define smr_desc smr_mrule.mr_desc
345 #define smr_obsolete smr_mrule.mr_obsolete
346 #define smr_syntax_oid smr_mrule.mr_syntax_oid
347 #define smr_extensions smr_mrule.mr_extensions
350 typedef struct slap_attribute_type {
352 LDAPAttributeType sat_atype;
353 struct slap_attribute_type *sat_sup;
354 struct slap_attribute_type **sat_subtypes;
355 MatchingRule *sat_equality;
356 MatchingRule *sat_approx;
357 MatchingRule *sat_ordering;
358 MatchingRule *sat_substr;
360 struct slap_attribute_type *sat_next;
361 #define sat_oid sat_atype.at_oid
362 #define sat_names sat_atype.at_names
363 #define sat_desc sat_atype.at_desc
364 #define sat_obsolete sat_atype.at_obsolete
365 #define sat_sup_oid sat_atype.at_sup_oid
366 #define sat_equality_oid sat_atype.at_equality_oid
367 #define sat_ordering_oid sat_atype.at_ordering_oid
368 #define sat_substr_oid sat_atype.at_substr_oid
369 #define sat_syntax_oid sat_atype.at_syntax_oid
370 #define sat_single_value sat_atype.at_single_value
371 #define sat_collective sat_atype.at_collective
372 #define sat_no_user_mod sat_atype.at_no_user_mod
373 #define sat_usage sat_atype.at_usage
374 #define sat_extensions sat_atype.at_extensions
377 #define is_at_operational(at) ((at)->sat_usage)
378 #define is_at_single_value(at) ((at)->sat_single_value)
379 #define is_at_collective(at) ((at)->sat_collective)
380 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
382 typedef struct slap_object_class {
383 LDAPObjectClass soc_oclass;
384 struct slap_object_class **soc_sups;
385 AttributeType **soc_required;
386 AttributeType **soc_allowed;
387 struct slap_object_class *soc_next;
388 #define soc_oid soc_oclass.oc_oid
389 #define soc_names soc_oclass.oc_names
390 #define soc_desc soc_oclass.oc_desc
391 #define soc_obsolete soc_oclass.oc_obsolete
392 #define soc_sup_oids soc_oclass.oc_sup_oids
393 #define soc_kind soc_oclass.oc_kind
394 #define soc_at_oids_must soc_oclass.oc_at_oids_must
395 #define soc_at_oids_may soc_oclass.oc_at_oids_may
396 #define soc_extensions soc_oclass.oc_extensions
401 * represents a recognized attribute description ( type + options )
403 typedef struct slap_attr_desc {
404 struct berval *ad_cname; /* canonical name, must be specified */
405 AttributeType *ad_type; /* attribute type, must be specified */
406 char *ad_lang; /* NULL if no language tags */
408 #define SLAP_DESC_NONE 0x0U
409 #define SLAP_DESC_BINARY 0x1U
410 } AttributeDescription;
412 #define slap_ad_is_lang(ad) ( (ad)->ad_lang != NULL )
413 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
416 * pointers to schema elements used internally
418 struct slap_internal_schema {
420 ObjectClass *si_oc_top;
421 ObjectClass *si_oc_extensibleObject;
422 ObjectClass *si_oc_alias;
423 ObjectClass *si_oc_referral;
424 ObjectClass *si_oc_subentry;
425 ObjectClass *si_oc_subschema;
426 ObjectClass *si_oc_rootdse;
428 /* objectClass attribute descriptions */
429 AttributeDescription *si_ad_objectClass;
431 /* operational attribute descriptions */
432 AttributeDescription *si_ad_structuralObjectClass;
433 AttributeDescription *si_ad_creatorsName;
434 AttributeDescription *si_ad_createTimestamp;
435 AttributeDescription *si_ad_modifiersName;
436 AttributeDescription *si_ad_modifyTimestamp;
437 AttributeDescription *si_ad_subschemaSubentry;
439 /* root DSE attribute descriptions */
440 AttributeDescription *si_ad_namingContexts;
441 AttributeDescription *si_ad_supportedControl;
442 AttributeDescription *si_ad_supportedExtension;
443 AttributeDescription *si_ad_supportedLDAPVersion;
444 AttributeDescription *si_ad_supportedSASLMechanisms;
446 /* subschema subentry attribute descriptions */
447 AttributeDescription *si_ad_objectClasses;
448 AttributeDescription *si_ad_attributeTypes;
449 AttributeDescription *si_ad_ldapSyntaxes;
450 AttributeDescription *si_ad_matchingRules;
451 AttributeDescription *si_ad_matchingRulesUse;
453 /* Aliases & Referrals */
454 AttributeDescription *si_ad_aliasedObjectName;
455 AttributeDescription *si_ad_ref;
457 /* Access Control Internals */
458 AttributeDescription *si_ad_entry;
459 AttributeDescription *si_ad_children;
460 #ifdef SLAPD_ACI_ENABLED
461 AttributeDescription *si_ad_aci;
464 /* Other attributes descriptions */
465 AttributeDescription *si_ad_userPassword;
466 AttributeDescription *si_ad_authPassword;
467 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
468 AttributeDescription *si_ad_krbName;
471 /* Undefined Attribute Type */
472 AttributeType *si_at_undefined;
475 typedef struct slap_attr_assertion {
476 AttributeDescription *aa_desc;
477 struct berval *aa_value;
478 } AttributeAssertion;
480 typedef struct slap_ss_assertion {
481 AttributeDescription *sa_desc;
482 struct berval *sa_initial;
483 struct berval **sa_any;
484 struct berval *sa_final;
485 } SubstringsAssertion;
487 typedef struct slap_mr_assertion {
488 MatchingRule *ma_rule; /* optional */
489 char *ma_rule_text; /* optional */
490 AttributeDescription *ma_desc; /* optional */
491 int ma_dnattrs; /* boolean */
492 struct berval *ma_value; /* required */
493 } MatchingRuleAssertion;
497 * represents a search filter
499 typedef struct slap_filter {
500 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
501 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
502 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
503 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
507 /* precomputed result */
508 ber_int_t f_un_result;
514 AttributeDescription *f_un_desc;
516 /* simple value assertion */
517 AttributeAssertion *f_un_ava;
519 /* substring assertion */
520 SubstringsAssertion *f_un_ssa;
522 /* matching rule assertion */
523 MatchingRuleAssertion *f_un_mra;
525 #define f_dn f_un.f_un_dn
526 #define f_desc f_un.f_un_desc
527 #define f_ava f_un.f_un_ava
528 #define f_av_desc f_un.f_un_ava->aa_desc
529 #define f_av_value f_un.f_un_ava->aa_value
530 #define f_sub f_un.f_un_ssa
531 #define f_sub_desc f_un.f_un_ssa->sa_desc
532 #define f_sub_initial f_un.f_un_ssa->sa_initial
533 #define f_sub_any f_un.f_un_ssa->sa_any
534 #define f_sub_final f_un.f_un_ssa->sa_final
535 #define f_mra f_un.f_un_mra
536 #define f_mr_rule f_un.f_un_mra->ma_rule
537 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
538 #define f_mr_desc f_un.f_un_mra->ma_desc
539 #define f_mr_value f_un.f_un_mra->ma_value
540 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
543 struct slap_filter *f_un_complex;
546 #define f_result f_un.f_un_result
547 #define f_and f_un.f_un_complex
548 #define f_or f_un.f_un_complex
549 #define f_not f_un.f_un_complex
550 #define f_list f_un.f_un_complex
552 struct slap_filter *f_next;
555 /* compare routines can return undefined */
556 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
559 * represents an attribute (description + values)
561 typedef struct slap_attr {
562 AttributeDescription *a_desc;
563 struct berval **a_vals;
564 struct slap_attr *a_next;
569 * the id used in the indexes to refer to an entry
571 typedef unsigned long ID;
572 #define NOID ((ID)~0)
575 * represents an entry in core
577 typedef struct slap_entry {
579 * The ID field should only be changed before entry is
580 * inserted into a cache. The ID value is backend
585 char *e_dn; /* DN of this entry */
586 char *e_ndn; /* normalized DN of this entry */
587 Attribute *e_attrs; /* list of attributes + values */
589 /* for use by the backend for any purpose */
596 typedef struct slap_mod {
598 AttributeDescription *sm_desc;
599 struct berval **sm_bvalues;
602 typedef struct slap_mod_list {
603 Modification sml_mod;
604 #define sml_op sml_mod.sm_op
605 #define sml_desc sml_mod.sm_desc
606 #define sml_bvalues sml_mod.sm_bvalues
607 struct slap_mod_list *sml_next;
610 typedef struct slap_ldap_modlist {
612 struct slap_ldap_modlist *ml_next;
613 #define ml_op ml_mod.mod_op
614 #define ml_type ml_mod.mod_type
615 #define ml_values ml_mod.mod_values
616 #define ml_bvalues ml_mod.mod_bvalues
620 * represents an access control list
622 typedef enum slap_access_e {
623 ACL_INVALID_ACCESS = -1,
632 typedef enum slap_control_e {
633 ACL_INVALID_CONTROL = 0,
639 typedef enum slap_style_e {
647 /* alternate names */
648 ACL_STYLE_EXACT = ACL_STYLE_BASE
651 typedef struct slap_authz_info {
652 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
653 char * sai_mech; /* SASL Mechanism */
654 char * sai_dn; /* DN for reporting purposes */
655 char * sai_ndn; /* Normalized DN */
657 /* Security Strength Factors */
658 slap_ssf_t sai_ssf; /* Overall SSF */
659 slap_ssf_t sai_transport_ssf; /* Transport SSF */
660 slap_ssf_t sai_tls_ssf; /* TLS SSF */
661 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
662 } AuthorizationInformation;
665 typedef struct slap_access {
666 slap_control_t a_type;
668 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
670 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
671 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
672 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
673 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
674 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
675 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
677 #define ACL_PRIV_MASK 0x00ffUL
680 #define ACL_PRIV_LEVEL 0x1000UL
681 #define ACL_PRIV_ADDITIVE 0x2000UL
682 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
685 #define ACL_PRIV_INVALID 0x0UL
687 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
688 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
689 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
690 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
692 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
693 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
695 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
697 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
699 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
700 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
701 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
703 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
704 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
705 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
706 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
707 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
708 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
710 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
711 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
712 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
713 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
714 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
715 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
716 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
718 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
719 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
720 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
721 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
722 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
723 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
725 slap_mask_t a_access_mask;
727 AuthorizationInformation a_authz;
728 #define a_dn_pat a_authz.sai_dn
730 slap_style_t a_dn_style;
731 AttributeDescription *a_dn_at;
734 slap_style_t a_peername_style;
735 char *a_peername_pat;
736 slap_style_t a_sockname_style;
737 char *a_sockname_pat;
739 slap_style_t a_domain_style;
741 slap_style_t a_sockurl_style;
743 slap_style_t a_set_style;
746 #ifdef SLAPD_ACI_ENABLED
747 AttributeDescription *a_aci_at;
751 slap_style_t a_group_style;
753 ObjectClass *a_group_oc;
754 AttributeDescription *a_group_at;
756 struct slap_access *a_next;
760 typedef struct slap_acl {
761 /* "to" part: the entries this acl applies to */
763 slap_style_t acl_dn_style;
768 /* "by" part: list of who has what access to the entries */
771 struct slap_acl *acl_next;
775 * replog moddn param structure
777 struct replog_moddn {
785 * represents a backend
788 typedef struct slap_backend_info BackendInfo; /* per backend type */
789 typedef struct slap_backend_db BackendDB; /* per backend database */
791 LDAP_SLAPD_F (int) nBackendInfo;
792 LDAP_SLAPD_F (int) nBackendDB;
793 LDAP_SLAPD_F (BackendInfo *) backendInfo;
794 LDAP_SLAPD_F (BackendDB *) backendDB;
796 LDAP_SLAPD_F (int) slapMode;
797 #define SLAP_UNDEFINED_MODE 0x0000
798 #define SLAP_SERVER_MODE 0x0001
799 #define SLAP_TOOL_MODE 0x0002
800 #define SLAP_MODE 0x0003
802 #define SLAP_TRUNCATE_MODE 0x0100
804 /* temporary aliases */
805 typedef BackendDB Backend;
806 #define nbackends nBackendDB
807 #define backends backendDB
809 struct slap_backend_db {
810 BackendInfo *bd_info; /* pointer to shared backend info */
812 /* BackendInfo accessors */
813 #define be_config bd_info->bi_db_config
814 #define be_type bd_info->bi_type
816 #define be_bind bd_info->bi_op_bind
817 #define be_unbind bd_info->bi_op_unbind
818 #define be_add bd_info->bi_op_add
819 #define be_compare bd_info->bi_op_compare
820 #define be_delete bd_info->bi_op_delete
821 #define be_modify bd_info->bi_op_modify
822 #define be_modrdn bd_info->bi_op_modrdn
823 #define be_search bd_info->bi_op_search
825 #define be_extended bd_info->bi_extended
827 #define be_release bd_info->bi_entry_release_rw
828 #define be_chk_referrals bd_info->bi_chk_referrals
829 #define be_group bd_info->bi_acl_group
830 #define be_attribute bd_info->bi_acl_attribute
832 #define be_controls bd_info->bi_controls
834 #define be_connection_init bd_info->bi_connection_init
835 #define be_connection_destroy bd_info->bi_connection_destroy
838 #define be_entry_open bd_info->bi_tool_entry_open
839 #define be_entry_close bd_info->bi_tool_entry_close
840 #define be_entry_first bd_info->bi_tool_entry_first
841 #define be_entry_next bd_info->bi_tool_entry_next
842 #define be_entry_reindex bd_info->bi_tool_entry_reindex
843 #define be_entry_get bd_info->bi_tool_entry_get
844 #define be_entry_put bd_info->bi_tool_entry_put
845 #define be_sync bd_info->bi_tool_sync
848 slap_mask_t be_restrictops; /* restriction operations */
849 #define SLAP_RESTRICT_OP_ADD 0x0001U
850 #define SLAP_RESTRICT_OP_BIND 0x0002U
851 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
852 #define SLAP_RESTRICT_OP_DELETE 0x0008U
853 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
854 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
855 #define SLAP_RESTRICT_OP_RENAME 0x0040U
856 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
858 #define SLAP_RESTRICT_OP_READS \
859 ( SLAP_RESTRICT_OP_COMPARE \
860 | SLAP_RESTRICT_OP_SEARCH )
861 #define SLAP_RESTRICT_OP_WRITES \
862 ( SLAP_RESTRICT_OP_ADD \
863 | SLAP_RESTRICT_OP_DELETE \
864 | SLAP_RESTRICT_OP_MODIFY \
865 | SLAP_RESTRICT_OP_RENAME )
867 #define SLAP_ALLOW_TLS_2_ANON 0x0001U /* StartTLS -> Anonymous */
869 #define SLAP_DISALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
870 #define SLAP_DISALLOW_BIND_ANON 0x0002U /* no anonymous */
871 #define SLAP_DISALLOW_BIND_ANON_CRED \
872 0x0004U /* cred should be empty */
873 #define SLAP_DISALLOW_BIND_ANON_DN \
874 0x0008U /* dn should be empty */
876 #define SLAP_DISALLOW_BIND_SIMPLE 0x0010U /* simple authentication */
877 #define SLAP_DISALLOW_BIND_KRBV4 0x0020U /* Kerberos V4 authentication */
879 #define SLAP_DISALLOW_TLS_AUTHC 0x0100U /* TLS while authenticated */
881 slap_mask_t be_requires; /* pre-operation requirements */
882 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
883 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
884 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
885 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
886 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
888 /* Required Security Strength Factor */
889 slap_ssf_set_t be_ssf_set;
891 /* these should be renamed from be_ to bd_ */
892 char **be_suffix; /* the DN suffixes of data in this backend */
893 char **be_nsuffix; /* the normalized DN suffixes in this backend */
894 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
895 char *be_root_dn; /* the magic "root" dn for this db */
896 char *be_root_ndn; /* the magic "root" normalized dn for this db */
897 struct berval be_root_pw; /* the magic "root" password for this db */
898 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
899 int be_sizelimit; /* size limit for this backend */
900 int be_timelimit; /* time limit for this backend */
901 AccessControl *be_acl; /* access control list for this backend */
902 slap_access_t be_dfltaccess; /* access given if no acl matches */
903 char **be_replica; /* replicas of this backend (in master) */
904 char *be_replogfile; /* replication log file (in master) */
905 char *be_update_ndn; /* allowed to make changes (in replicas) */
906 struct berval **be_update_refs; /* where to refer modifying clients to */
907 int be_lastmod; /* keep track of lastmodified{by,time} */
911 void *be_private; /* anything the backend database needs */
917 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
919 struct slap_conn *conn,
922 struct berval * reqdata,
924 struct berval ** rspdata,
925 LDAPControl *** rspctrls,
927 struct berval *** refs ));
929 struct slap_backend_info {
930 char *bi_type; /* type of backend */
933 * per backend type routines:
934 * bi_init: called to allocate a backend_info structure,
935 * called once BEFORE configuration file is read.
936 * bi_init() initializes this structure hence is
937 * called directly from be_initialize()
938 * bi_config: called per 'backend' specific option
939 * all such options must before any 'database' options
940 * bi_config() is called only from read_config()
941 * bi_open: called to open each database, called
942 * once AFTER configuration file is read but
943 * BEFORE any bi_db_open() calls.
944 * bi_open() is called from backend_startup()
945 * bi_close: called to close each database, called
946 * once during shutdown after all bi_db_close calls.
947 * bi_close() is called from backend_shutdown()
948 * bi_destroy: called to destroy each database, called
949 * once during shutdown after all bi_db_destroy calls.
950 * bi_destory() is called from backend_destroy()
952 int (*bi_init) LDAP_P((BackendInfo *bi));
953 int (*bi_config) LDAP_P((BackendInfo *bi,
954 const char *fname, int lineno, int argc, char **argv ));
955 int (*bi_open) LDAP_P((BackendInfo *bi));
956 int (*bi_close) LDAP_P((BackendInfo *bi));
957 int (*bi_destroy) LDAP_P((BackendInfo *bi));
960 * per database routines:
961 * bi_db_init: called to initialize each database,
962 * called upon reading 'database <type>'
963 * called only from backend_db_init()
964 * bi_db_config: called to configure each database,
965 * called per database to handle per database options
966 * called only from read_config()
967 * bi_db_open: called to open each database
968 * called once per database immediately AFTER bi_open()
969 * calls but before daemon startup.
970 * called only by backend_startup()
971 * bi_db_close: called to close each database
972 * called once per database during shutdown but BEFORE
974 * called only by backend_shutdown()
975 * bi_db_destroy: called to destroy each database
976 * called once per database during shutdown AFTER all
977 * bi_close calls but before bi_destory calls.
978 * called only by backend_destory()
980 int (*bi_db_init) LDAP_P((Backend *bd));
981 int (*bi_db_config) LDAP_P((Backend *bd,
982 const char *fname, int lineno, int argc, char **argv ));
983 int (*bi_db_open) LDAP_P((Backend *bd));
984 int (*bi_db_close) LDAP_P((Backend *bd));
985 int (*bi_db_destroy) LDAP_P((Backend *db));
987 /* LDAP Operations Handling Routines */
988 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
989 struct slap_conn *c, struct slap_op *o,
990 const char *dn, const char *ndn, int method,
991 struct berval *cred, char** edn ));
992 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
993 struct slap_conn *c, struct slap_op *o ));
994 int (*bi_op_search) LDAP_P((BackendDB *bd,
995 struct slap_conn *c, struct slap_op *o,
996 const char *base, const char *nbase,
997 int scope, int deref,
998 int slimit, int tlimit,
999 Filter *f, const char *filterstr,
1000 char **attrs, int attrsonly));
1001 int (*bi_op_compare)LDAP_P((BackendDB *bd,
1002 struct slap_conn *c, struct slap_op *o,
1003 const char *dn, const char *ndn,
1004 AttributeAssertion *ava));
1005 int (*bi_op_modify) LDAP_P((BackendDB *bd,
1006 struct slap_conn *c, struct slap_op *o,
1007 const char *dn, const char *ndn, Modifications *m));
1008 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
1009 struct slap_conn *c, struct slap_op *o,
1010 const char *dn, const char *ndn,
1011 const char *newrdn, int deleteoldrdn,
1012 const char *newSuperior));
1013 int (*bi_op_add) LDAP_P((BackendDB *bd,
1014 struct slap_conn *c, struct slap_op *o,
1016 int (*bi_op_delete) LDAP_P((BackendDB *bd,
1017 struct slap_conn *c, struct slap_op *o,
1018 const char *dn, const char *ndn));
1019 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
1020 struct slap_conn *c, struct slap_op *o,
1023 /* Extended Operations Helper */
1024 SLAP_EXTENDED_FN bi_extended;
1026 /* Auxilary Functions */
1027 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd,
1028 struct slap_conn *c, struct slap_op *o,
1031 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
1032 struct slap_conn *c, struct slap_op *o,
1033 const char *dn, const char *ndn,
1034 const char **text ));
1036 int (*bi_acl_group) LDAP_P((Backend *bd,
1037 struct slap_conn *c, struct slap_op *o,
1038 Entry *e, const char *bdn, const char *edn,
1039 ObjectClass *group_oc,
1040 AttributeDescription *group_at ));
1041 int (*bi_acl_attribute) LDAP_P((Backend *bd,
1042 struct slap_conn *c, struct slap_op *o,
1043 Entry *e, const char *edn,
1044 AttributeDescription *entry_at,
1045 struct berval ***vals ));
1047 int (*bi_connection_init) LDAP_P((BackendDB *bd,
1048 struct slap_conn *c));
1049 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1050 struct slap_conn *c));
1052 /* hooks for slap tools */
1053 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1054 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1055 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1056 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1057 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1058 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1059 int (*bi_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1060 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1062 #define SLAP_INDEX_ADD_OP 0x0001
1063 #define SLAP_INDEX_DELETE_OP 0x0002
1065 char **bi_controls; /* supported controls */
1067 unsigned int bi_nDB; /* number of databases of this type */
1068 void *bi_private; /* anything the backend type needs */
1071 #define c_authtype c_authz.sai_method
1072 #define c_authmech c_authz.sai_mech
1073 #define c_dn c_authz.sai_dn
1074 #define c_ssf c_authz.sai_ssf
1075 #define c_transport_ssf c_authz.sai_transport_ssf
1076 #define c_tls_ssf c_authz.sai_tls_ssf
1077 #define c_sasl_ssf c_authz.sai_sasl_ssf
1079 #define o_authtype o_authz.sai_method
1080 #define o_authmech o_authz.sai_mech
1081 #define o_dn o_authz.sai_dn
1082 #define o_ndn o_authz.sai_ndn
1083 #define o_ssf o_authz.sai_ssf
1084 #define o_transport_ssf o_authz.sai_transport_ssf
1085 #define o_tls_ssf o_authz.sai_tls_ssf
1086 #define o_sasl_ssf o_authz.sai_sasl_ssf
1089 * represents an operation pending from an ldap client
1091 typedef struct slap_op {
1092 ber_int_t o_opid; /* id of this operation */
1093 ber_int_t o_msgid; /* msgid of the request */
1095 ldap_pvt_thread_t o_tid; /* thread handling this op */
1097 BerElement *o_ber; /* ber of the request */
1099 ber_tag_t o_tag; /* tag of the request */
1100 time_t o_time; /* time op was initiated */
1102 AuthorizationInformation o_authz;
1104 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1106 LDAPControl **o_ctrls; /* controls */
1108 unsigned long o_connid; /* id of conn initiating this op */
1110 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1111 int o_abandon; /* abandon flag */
1113 struct slap_op *o_next; /* next operation in list */
1114 void *o_private; /* anything the backend needs */
1118 * represents a connection from an ldap client
1120 typedef struct slap_conn {
1121 int c_struct_state; /* structure management state */
1122 int c_conn_state; /* connection state */
1124 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1125 Sockbuf *c_sb; /* ber connection stuff */
1127 /* only can be changed by connect_init */
1128 time_t c_starttime; /* when the connection was opened */
1129 time_t c_activitytime; /* when the connection was last used */
1130 unsigned long c_connid; /* id of this connection for stats*/
1132 char *c_listener_url; /* listener URL */
1133 char *c_peer_domain; /* DNS name of client */
1134 char *c_peer_name; /* peer name (trans=addr:port) */
1135 char *c_sock_name; /* sock name (trans=addr:port) */
1137 /* only can be changed by binding thread */
1138 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1139 char *c_sasl_bind_mech; /* mech in progress */
1142 /* authentication backend */
1143 Backend *c_authc_backend;
1145 /* authorization backend - normally same as c_authc_backend */
1146 Backend *c_authz_backend;
1148 AuthorizationInformation c_authz;
1150 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1152 Operation *c_ops; /* list of operations being processed */
1153 Operation *c_pending_ops; /* list of pending operations */
1155 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1156 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1158 BerElement *c_currentber; /* ber we're attempting to read */
1159 int c_writewaiter; /* true if writer is waiting */
1162 int c_is_tls; /* true if this LDAP over raw TLS */
1163 int c_needs_tls_accept; /* true if SSL_accept should be called */
1165 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1166 void *c_sasl_context; /* SASL session context */
1167 void *c_sasl_extra; /* SASL session extra stuff */
1169 long c_n_ops_received; /* num of ops received (next op_id) */
1170 long c_n_ops_executing; /* num of ops currently executing */
1171 long c_n_ops_pending; /* num of ops pending execution */
1172 long c_n_ops_completed; /* num of ops completed */
1174 long c_n_get; /* num of get calls */
1175 long c_n_read; /* num of read calls */
1176 long c_n_write; /* num of write calls */
1179 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1180 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1182 if ( ldap_debug & (level) ) \
1183 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1184 if ( ldap_syslog & (level) ) \
1185 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1189 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1193 #define SASLREGEX_REPLACE 10
1194 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1195 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1197 typedef struct sasl_regexp {
1198 char *match; /* regexp match pattern */
1199 char *replace; /* regexp replace pattern */
1200 regex_t workspace; /* workspace for regexp engine */
1201 regmatch_t strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1202 int offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1205 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1206 #define FLAG_GETDN_FINAL 1
1207 #define FLAG_GETDN_AUTHCID 2
1208 #define FLAG_GETDN_AUTHZID 4
1213 #include "proto-slap.h"
1215 #endif /* _SLAP_H_ */