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"
14 #include <ac/stdlib.h>
16 #include <sys/types.h>
17 #include <ac/syslog.h>
19 #include <ac/socket.h>
26 #define ldap_debug slap_debug
32 #include <ldap_schema.h>
34 #include "ldap_pvt_thread.h"
35 #include "queue-compat.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_WORKER_THREADS (32)
63 #define SLAP_TEXT_BUFLEN (256)
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_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
90 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
91 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
92 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
93 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
95 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
96 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
97 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
98 #define OID_SEPARATOR(c) ( (c) == '.' )
99 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
101 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
102 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
104 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
105 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
107 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
109 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
110 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
111 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
112 (c) == '?' || (c) == ' ' || (c) == '=' )
113 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
115 /* must match in schema_init.c */
116 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
117 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
118 #define SLAPD_GROUP_ATTR "member"
119 #define SLAPD_GROUP_CLASS "groupOfNames"
120 #define SLAPD_ROLE_ATTR "roleOccupant"
121 #define SLAPD_ROLE_CLASS "organizationalRole"
123 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
124 #define SLAPD_ACI_ATTR "OpenLDAPaci"
126 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
128 /* change this to "OpenLDAPset" */
129 #define SLAPD_ACI_SET_ATTR "template"
131 #define SLAPD_TOP_OID "2.5.6.0"
133 LDAP_SLAPD_V (int) slap_debug;
135 typedef unsigned long slap_mask_t;
137 /* Security Strength Factor */
138 typedef unsigned slap_ssf_t;
140 typedef struct slap_ssf_set {
142 slap_ssf_t sss_transport;
145 slap_ssf_t sss_update_ssf;
146 slap_ssf_t sss_update_transport;
147 slap_ssf_t sss_update_tls;
148 slap_ssf_t sss_update_sasl;
154 #define SLAP_INDEX_TYPE 0x00FFUL
155 #define SLAP_INDEX_UNDEFINED 0x0001UL
156 #define SLAP_INDEX_PRESENT 0x0002UL
157 #define SLAP_INDEX_EQUALITY 0x0004UL
158 #define SLAP_INDEX_APPROX 0x0008UL
159 #define SLAP_INDEX_SUBSTR 0x0010UL
160 #define SLAP_INDEX_EXTENDED 0x0020UL
162 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
164 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
166 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
168 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
169 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
170 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
171 #define SLAP_INDEX_SUBSTR_DEFAULT \
172 ( SLAP_INDEX_SUBSTR \
173 | SLAP_INDEX_SUBSTR_INITIAL \
174 | SLAP_INDEX_SUBSTR_ANY \
175 | SLAP_INDEX_SUBSTR_FINAL )
177 #define SLAP_INDEX_SUBSTR_MINLEN 2
178 #define SLAP_INDEX_SUBSTR_MAXLEN 4
179 #define SLAP_INDEX_SUBSTR_STEP 2
181 #define SLAP_INDEX_FLAGS 0xF000UL
182 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
183 #define SLAP_INDEX_NOLANG 0x2000UL /* don't use index w/ lang */
184 #define SLAP_INDEX_AUTO_SUBTYPES 0x4000UL /* use mask with lang subtypes */
187 * there is a single index for each attribute. these prefixes ensure
188 * that there is no collision among keys.
190 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
191 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
192 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
193 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
194 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
195 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
196 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
198 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
199 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
200 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
203 * represents schema information for a database
205 #define SLAP_SCHERR_OUTOFMEM 1
206 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
207 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
208 #define SLAP_SCHERR_ATTR_NOT_FOUND 4
209 #define SLAP_SCHERR_ATTR_BAD_USAGE 5
210 #define SLAP_SCHERR_DUP_CLASS 6
211 #define SLAP_SCHERR_DUP_ATTR 7
212 #define SLAP_SCHERR_DUP_SYNTAX 8
213 #define SLAP_SCHERR_DUP_RULE 9
214 #define SLAP_SCHERR_NO_NAME 10
215 #define SLAP_SCHERR_ATTR_INCOMPLETE 11
216 #define SLAP_SCHERR_MR_NOT_FOUND 12
217 #define SLAP_SCHERR_SYN_NOT_FOUND 13
218 #define SLAP_SCHERR_MR_INCOMPLETE 14
219 #define SLAP_SCHERR_NOT_SUPPORTED 15
220 #define SLAP_SCHERR_BAD_DESCR 16
222 typedef union slap_sockaddr {
223 struct sockaddr sa_addr;
224 struct sockaddr_in sa_in_addr;
226 struct sockaddr_in6 sa_in6_addr;
229 struct sockaddr_un sa_un_addr;
233 typedef struct slap_oid_macro {
234 struct berval som_oid;
236 struct slap_oid_macro *som_next;
239 /* forward declarations */
241 struct slap_matching_rule;
243 typedef int slap_syntax_validate_func LDAP_P((
244 struct slap_syntax *syntax,
245 struct berval * in));
247 typedef int slap_syntax_transform_func LDAP_P((
248 struct slap_syntax *syntax,
250 struct berval * out));
252 typedef struct slap_syntax {
254 #define ssyn_oid ssyn_syn.syn_oid
255 #define ssyn_desc ssyn_syn.syn_desc
256 #define ssyn_extensions ssyn_syn.syn_extensions
257 ber_len_t ssyn_oidlen;
261 #define SLAP_SYNTAX_NONE 0x00U
262 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
263 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
264 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
265 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
267 slap_syntax_validate_func *ssyn_validate;
268 slap_syntax_transform_func *ssyn_normalize;
269 slap_syntax_transform_func *ssyn_pretty;
271 #ifdef SLAPD_BINARY_CONVERSION
272 /* convert to and from binary */
273 slap_syntax_transform_func *ssyn_ber2str;
274 slap_syntax_transform_func *ssyn_str2ber;
277 struct slap_syntax *ssyn_next;
280 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
281 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
282 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
283 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
284 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
286 /* X -> Y Converter */
287 typedef int slap_mr_convert_func LDAP_P((
289 struct berval * out ));
292 typedef int slap_mr_normalize_func LDAP_P((
294 struct slap_syntax *syntax, /* NULL if in is asserted value */
295 struct slap_matching_rule *mr,
297 struct berval * out ));
299 /* Match (compare) function */
300 typedef int slap_mr_match_func LDAP_P((
303 struct slap_syntax *syntax, /* syntax of stored value */
304 struct slap_matching_rule *mr,
305 struct berval * value,
306 void * assertValue ));
308 /* Index generation function */
309 typedef int slap_mr_indexer_func LDAP_P((
312 struct slap_syntax *syntax, /* syntax of stored value */
313 struct slap_matching_rule *mr,
314 struct berval *prefix,
318 /* Filter index function */
319 typedef int slap_mr_filter_func LDAP_P((
322 struct slap_syntax *syntax, /* syntax of stored value */
323 struct slap_matching_rule *mr,
324 struct berval *prefix,
328 typedef struct slap_matching_rule {
329 LDAPMatchingRule smr_mrule;
330 ber_len_t smr_oidlen;
331 slap_mask_t smr_usage;
333 #define SLAP_MR_TYPE_MASK 0xFF00U
334 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
335 #define SLAP_MR_USAGE 0x000FU
337 #define SLAP_MR_NONE 0x0000U
338 #define SLAP_MR_EQUALITY 0x0100U
339 #define SLAP_MR_ORDERING 0x0200U
340 #define SLAP_MR_SUBSTR 0x0400U
341 #define SLAP_MR_EXT 0x0800U
343 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
344 #define SLAP_MR_DN_FOLD 0x0008U
346 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
347 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
348 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
351 * normally the provided value is expected to conform to
352 * assertion syntax specified in the matching rule, however
353 * at times (such as during individual value modification),
354 * the provided value is expected to conform to the
355 * attribute's value syntax.
357 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
358 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
359 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
361 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
362 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
363 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
364 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
366 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
367 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
368 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
369 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
370 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
371 == SLAP_MR_VALUE_SYNTAX_MATCH)
374 slap_mr_convert_func *smr_convert;
375 slap_mr_normalize_func *smr_normalize;
376 slap_mr_match_func *smr_match;
377 slap_mr_indexer_func *smr_indexer;
378 slap_mr_filter_func *smr_filter;
380 struct slap_matching_rule *smr_associated;
381 struct slap_matching_rule *smr_next;
383 #define smr_oid smr_mrule.mr_oid
384 #define smr_names smr_mrule.mr_names
385 #define smr_desc smr_mrule.mr_desc
386 #define smr_obsolete smr_mrule.mr_obsolete
387 #define smr_syntax_oid smr_mrule.mr_syntax_oid
388 #define smr_extensions smr_mrule.mr_extensions
391 struct slap_attr_desc;
393 typedef struct slap_attribute_type {
394 LDAPAttributeType sat_atype;
395 struct berval sat_cname;
396 struct slap_attribute_type *sat_sup;
397 struct slap_attribute_type **sat_subtypes;
398 MatchingRule *sat_equality;
399 MatchingRule *sat_approx;
400 MatchingRule *sat_ordering;
401 MatchingRule *sat_substr;
403 struct slap_attr_desc *sat_ad;
404 struct slap_attribute_type *sat_next;
405 ldap_pvt_thread_mutex_t sat_ad_mutex;
406 #define sat_oid sat_atype.at_oid
407 #define sat_names sat_atype.at_names
408 #define sat_desc sat_atype.at_desc
409 #define sat_obsolete sat_atype.at_obsolete
410 #define sat_sup_oid sat_atype.at_sup_oid
411 #define sat_equality_oid sat_atype.at_equality_oid
412 #define sat_ordering_oid sat_atype.at_ordering_oid
413 #define sat_substr_oid sat_atype.at_substr_oid
414 #define sat_syntax_oid sat_atype.at_syntax_oid
415 #define sat_single_value sat_atype.at_single_value
416 #define sat_collective sat_atype.at_collective
417 #define sat_no_user_mod sat_atype.at_no_user_mod
418 #define sat_usage sat_atype.at_usage
419 #define sat_extensions sat_atype.at_extensions
422 #define is_at_operational(at) ((at)->sat_usage)
423 #define is_at_single_value(at) ((at)->sat_single_value)
424 #define is_at_collective(at) ((at)->sat_collective)
425 #define is_at_obsolete(at) ((at)->sat_obsolete)
426 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
428 typedef struct slap_object_class {
429 LDAPObjectClass soc_oclass;
430 struct slap_object_class **soc_sups;
431 AttributeType **soc_required;
432 AttributeType **soc_allowed;
433 struct slap_object_class *soc_next;
434 #define soc_oid soc_oclass.oc_oid
435 #define soc_names soc_oclass.oc_names
436 #define soc_desc soc_oclass.oc_desc
437 #define soc_obsolete soc_oclass.oc_obsolete
438 #define soc_sup_oids soc_oclass.oc_sup_oids
439 #define soc_kind soc_oclass.oc_kind
440 #define soc_at_oids_must soc_oclass.oc_at_oids_must
441 #define soc_at_oids_may soc_oclass.oc_at_oids_may
442 #define soc_extensions soc_oclass.oc_extensions
447 * represents a recognized attribute description ( type + options )
449 typedef struct slap_attr_desc {
450 struct slap_attr_desc *ad_next;
451 AttributeType *ad_type; /* attribute type, must be specified */
452 struct berval ad_cname; /* canonical name, must be specified */
453 struct berval ad_lang; /* empty if no language tags */
455 #define SLAP_DESC_NONE 0x0U
456 #define SLAP_DESC_BINARY 0x1U
457 } AttributeDescription;
459 typedef struct slap_attr_name {
460 struct slap_attr_name *an_next;
461 struct berval an_name;
462 AttributeDescription *an_desc;
465 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
466 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
469 * pointers to schema elements used internally
471 struct slap_internal_schema {
473 ObjectClass *si_oc_top;
474 ObjectClass *si_oc_extensibleObject;
475 ObjectClass *si_oc_alias;
476 ObjectClass *si_oc_referral;
477 ObjectClass *si_oc_subentry;
478 ObjectClass *si_oc_subschema;
479 ObjectClass *si_oc_rootdse;
481 /* objectClass attribute descriptions */
482 AttributeDescription *si_ad_objectClass;
484 /* operational attribute descriptions */
485 AttributeDescription *si_ad_structuralObjectClass;
486 AttributeDescription *si_ad_entryUUID;
487 AttributeDescription *si_ad_entryCSN;
488 AttributeDescription *si_ad_creatorsName;
489 AttributeDescription *si_ad_createTimestamp;
490 AttributeDescription *si_ad_modifiersName;
491 AttributeDescription *si_ad_modifyTimestamp;
492 AttributeDescription *si_ad_hasSubordinates;
493 AttributeDescription *si_ad_subschemaSubentry;
495 /* root DSE attribute descriptions */
496 AttributeDescription *si_ad_namingContexts;
497 AttributeDescription *si_ad_supportedControl;
498 AttributeDescription *si_ad_supportedExtension;
499 AttributeDescription *si_ad_supportedLDAPVersion;
500 AttributeDescription *si_ad_supportedSASLMechanisms;
501 AttributeDescription *si_ad_supportedFeatures;
503 /* subschema subentry attribute descriptions */
504 AttributeDescription *si_ad_objectClasses;
505 AttributeDescription *si_ad_attributeTypes;
506 AttributeDescription *si_ad_ldapSyntaxes;
507 AttributeDescription *si_ad_matchingRules;
508 AttributeDescription *si_ad_matchingRulesUse;
510 /* Aliases & Referrals */
511 AttributeDescription *si_ad_aliasedObjectName;
512 AttributeDescription *si_ad_ref;
514 /* Access Control Internals */
515 AttributeDescription *si_ad_entry;
516 AttributeDescription *si_ad_children;
517 #ifdef SLAPD_ACI_ENABLED
518 AttributeDescription *si_ad_aci;
521 /* Other attributes descriptions */
522 AttributeDescription *si_ad_userPassword;
523 AttributeDescription *si_ad_authPassword;
524 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
525 AttributeDescription *si_ad_krbName;
528 /* Undefined Attribute Type */
529 AttributeType *si_at_undefined;
532 MatchingRule *si_mr_distinguishedNameMatch;
533 MatchingRule *si_mr_integerMatch;
536 Syntax *si_syn_distinguishedName;
537 Syntax *si_syn_integer;
540 typedef struct slap_attr_assertion {
541 AttributeDescription *aa_desc;
542 struct berval aa_value;
543 } AttributeAssertion;
545 typedef struct slap_ss_assertion {
546 AttributeDescription *sa_desc;
547 struct berval sa_initial;
548 struct berval *sa_any;
549 struct berval sa_final;
550 } SubstringsAssertion;
552 typedef struct slap_mr_assertion {
553 MatchingRule *ma_rule; /* optional */
554 struct berval ma_rule_text; /* optional */
555 AttributeDescription *ma_desc; /* optional */
556 int ma_dnattrs; /* boolean */
557 struct berval ma_value; /* required */
558 } MatchingRuleAssertion;
561 * represents a search filter
563 typedef struct slap_filter {
564 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
565 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
566 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
567 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
570 /* precomputed result */
571 ber_int_t f_un_result;
574 struct berval *f_un_dn;
577 AttributeDescription *f_un_desc;
579 /* simple value assertion */
580 AttributeAssertion *f_un_ava;
582 /* substring assertion */
583 SubstringsAssertion *f_un_ssa;
585 /* matching rule assertion */
586 MatchingRuleAssertion *f_un_mra;
588 #define f_dn f_un.f_un_dn
589 #define f_desc f_un.f_un_desc
590 #define f_ava f_un.f_un_ava
591 #define f_av_desc f_un.f_un_ava->aa_desc
592 #define f_av_value f_un.f_un_ava->aa_value
593 #define f_sub f_un.f_un_ssa
594 #define f_sub_desc f_un.f_un_ssa->sa_desc
595 #define f_sub_initial f_un.f_un_ssa->sa_initial
596 #define f_sub_any f_un.f_un_ssa->sa_any
597 #define f_sub_final f_un.f_un_ssa->sa_final
598 #define f_mra f_un.f_un_mra
599 #define f_mr_rule f_un.f_un_mra->ma_rule
600 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
601 #define f_mr_desc f_un.f_un_mra->ma_desc
602 #define f_mr_value f_un.f_un_mra->ma_value
603 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
606 struct slap_filter *f_un_complex;
609 #define f_result f_un.f_un_result
610 #define f_and f_un.f_un_complex
611 #define f_or f_un.f_un_complex
612 #define f_not f_un.f_un_complex
613 #define f_list f_un.f_un_complex
615 struct slap_filter *f_next;
618 /* compare routines can return undefined */
619 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
622 * represents an attribute (description + values)
624 typedef struct slap_attr {
625 AttributeDescription *a_desc;
627 struct slap_attr *a_next;
632 * the id used in the indexes to refer to an entry
634 typedef unsigned long ID;
635 #define NOID ((ID)~0)
638 * represents an entry in core
640 typedef struct slap_entry {
642 * The ID field should only be changed before entry is
643 * inserted into a cache. The ID value is backend
648 struct berval e_name; /* name (DN) of this entry */
649 struct berval e_nname; /* normalized name (DN) of this entry */
651 /* for migration purposes */
652 #define e_dn e_name.bv_val
653 #define e_ndn e_nname.bv_val
655 Attribute *e_attrs; /* list of attributes + values */
657 /* for use by the backend for any purpose */
664 typedef struct slap_mod {
666 AttributeDescription *sm_desc;
667 struct berval sm_type;
671 typedef struct slap_mod_list {
672 Modification sml_mod;
673 #define sml_op sml_mod.sm_op
674 #define sml_desc sml_mod.sm_desc
675 #define sml_type sml_mod.sm_type
676 #define sml_bvalues sml_mod.sm_bvalues
677 struct slap_mod_list *sml_next;
680 typedef struct slap_ldap_modlist {
682 struct slap_ldap_modlist *ml_next;
683 #define ml_op ml_mod.mod_op
684 #define ml_type ml_mod.mod_type
685 #define ml_values ml_mod.mod_values
686 #define ml_bvalues ml_mod.mod_bvalues
690 * represents an access control list
692 typedef enum slap_access_e {
693 ACL_INVALID_ACCESS = -1,
702 typedef enum slap_control_e {
703 ACL_INVALID_CONTROL = 0,
709 typedef enum slap_style_e {
717 /* alternate names */
718 ACL_STYLE_EXACT = ACL_STYLE_BASE
721 typedef struct slap_authz_info {
722 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
723 char * sai_mech; /* SASL Mechanism */
724 struct berval sai_dn; /* DN for reporting purposes */
725 struct berval sai_ndn; /* Normalized DN */
727 /* Security Strength Factors */
728 slap_ssf_t sai_ssf; /* Overall SSF */
729 slap_ssf_t sai_transport_ssf; /* Transport SSF */
730 slap_ssf_t sai_tls_ssf; /* TLS SSF */
731 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
732 } AuthorizationInformation;
735 typedef struct slap_access {
736 slap_control_t a_type;
738 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
740 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
741 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
742 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
743 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
744 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
745 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
747 #define ACL_PRIV_MASK 0x00ffUL
750 #define ACL_PRIV_LEVEL 0x1000UL
751 #define ACL_PRIV_ADDITIVE 0x2000UL
752 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
755 #define ACL_PRIV_INVALID 0x0UL
757 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
758 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
759 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
760 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
762 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
763 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
765 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
767 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
769 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
770 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
771 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
773 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
774 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
775 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
776 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
777 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
778 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
780 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
781 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
782 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
783 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
784 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
785 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
786 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
788 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
789 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
790 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
791 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
792 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
793 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
795 slap_mask_t a_access_mask;
797 AuthorizationInformation a_authz;
798 #define a_dn_pat a_authz.sai_dn
800 slap_style_t a_dn_style;
801 AttributeDescription *a_dn_at;
804 slap_style_t a_peername_style;
805 char *a_peername_pat;
806 slap_style_t a_sockname_style;
807 char *a_sockname_pat;
809 slap_style_t a_domain_style;
811 slap_style_t a_sockurl_style;
813 slap_style_t a_set_style;
814 struct berval a_set_pat;
816 #ifdef SLAPD_ACI_ENABLED
817 AttributeDescription *a_aci_at;
821 slap_style_t a_group_style;
822 struct berval a_group_pat;
823 ObjectClass *a_group_oc;
824 AttributeDescription *a_group_at;
826 struct slap_access *a_next;
830 typedef struct slap_acl {
831 /* "to" part: the entries this acl applies to */
833 slap_style_t acl_dn_style;
835 struct berval acl_dn_pat;
836 AttributeName *acl_attrs;
838 /* "by" part: list of who has what access to the entries */
841 struct slap_acl *acl_next;
845 * replog moddn param structure
847 struct slap_replog_moddn {
848 struct berval *newrdn;
850 struct berval *newsup;
855 * represents a backend
858 typedef struct slap_backend_info BackendInfo; /* per backend type */
859 typedef struct slap_backend_db BackendDB; /* per backend database */
861 LDAP_SLAPD_V (int) nBackendInfo;
862 LDAP_SLAPD_V (int) nBackendDB;
863 LDAP_SLAPD_V (BackendInfo *) backendInfo;
864 LDAP_SLAPD_V (BackendDB *) backendDB;
866 LDAP_SLAPD_V (int) slapMode;
867 #define SLAP_UNDEFINED_MODE 0x0000
868 #define SLAP_SERVER_MODE 0x0001
869 #define SLAP_TOOL_MODE 0x0002
870 #define SLAP_MODE 0x0003
872 #define SLAP_TRUNCATE_MODE 0x0100
874 struct slap_replica_info {
875 char *ri_host; /* supersedes be_replica */
876 struct berval **ri_nsuffix; /* array of suffixes this replica accepts */
879 struct slap_limits_set {
891 int lm_type; /* type of pattern */
892 #define SLAP_LIMITS_UNDEFINED 0x0000
893 #define SLAP_LIMITS_EXACT 0x0001
894 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
895 #define SLAP_LIMITS_ONE 0x0002
896 #define SLAP_LIMITS_SUBTREE 0x0003
897 #define SLAP_LIMITS_CHILDREN 0x0004
898 #define SLAP_LIMITS_REGEX 0x0005
899 #define SLAP_LIMITS_ANONYMOUS 0x0006
900 #define SLAP_LIMITS_USERS 0x0007
901 regex_t lm_dn_regex; /* regex data for REGEX */
904 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
905 * pattern for REGEX; NULL for ANONYMOUS, USERS
907 struct berval lm_dn_pat;
909 struct slap_limits_set lm_limits;
912 /* temporary aliases */
913 typedef BackendDB Backend;
914 #define nbackends nBackendDB
915 #define backends backendDB
917 struct slap_backend_db {
918 BackendInfo *bd_info; /* pointer to shared backend info */
920 /* BackendInfo accessors */
921 #define be_config bd_info->bi_db_config
922 #define be_type bd_info->bi_type
924 #define be_bind bd_info->bi_op_bind
925 #define be_unbind bd_info->bi_op_unbind
926 #define be_add bd_info->bi_op_add
927 #define be_compare bd_info->bi_op_compare
928 #define be_delete bd_info->bi_op_delete
929 #define be_modify bd_info->bi_op_modify
930 #define be_modrdn bd_info->bi_op_modrdn
931 #define be_search bd_info->bi_op_search
933 #define be_extended bd_info->bi_extended
935 #define be_release bd_info->bi_entry_release_rw
936 #define be_chk_referrals bd_info->bi_chk_referrals
937 #define be_group bd_info->bi_acl_group
938 #define be_attribute bd_info->bi_acl_attribute
939 #define be_operational bd_info->bi_operational
941 #define be_controls bd_info->bi_controls
943 #define be_connection_init bd_info->bi_connection_init
944 #define be_connection_destroy bd_info->bi_connection_destroy
947 #define be_entry_open bd_info->bi_tool_entry_open
948 #define be_entry_close bd_info->bi_tool_entry_close
949 #define be_entry_first bd_info->bi_tool_entry_first
950 #define be_entry_next bd_info->bi_tool_entry_next
951 #define be_entry_reindex bd_info->bi_tool_entry_reindex
952 #define be_entry_get bd_info->bi_tool_entry_get
953 #define be_entry_put bd_info->bi_tool_entry_put
954 #define be_sync bd_info->bi_tool_sync
957 slap_mask_t be_restrictops; /* restriction operations */
958 #define SLAP_RESTRICT_OP_ADD 0x0001U
959 #define SLAP_RESTRICT_OP_BIND 0x0002U
960 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
961 #define SLAP_RESTRICT_OP_DELETE 0x0008U
962 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
963 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
964 #define SLAP_RESTRICT_OP_RENAME 0x0040U
965 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
967 #define SLAP_RESTRICT_OP_READS \
968 ( SLAP_RESTRICT_OP_COMPARE \
969 | SLAP_RESTRICT_OP_SEARCH )
970 #define SLAP_RESTRICT_OP_WRITES \
971 ( SLAP_RESTRICT_OP_ADD \
972 | SLAP_RESTRICT_OP_DELETE \
973 | SLAP_RESTRICT_OP_MODIFY \
974 | SLAP_RESTRICT_OP_RENAME )
976 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
977 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
978 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
980 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
981 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
982 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
984 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
985 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
987 slap_mask_t be_requires; /* pre-operation requirements */
988 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
989 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
990 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
991 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
992 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
994 /* Required Security Strength Factor */
995 slap_ssf_set_t be_ssf_set;
997 /* these should be renamed from be_ to bd_ */
998 struct berval **be_suffix; /* the DN suffixes of data in this backend */
999 struct berval **be_nsuffix; /* the normalized DN suffixes in this backend */
1000 struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1001 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1002 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1003 struct berval be_rootpw; /* the magic "root" password for this db */
1004 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1005 #define be_sizelimit be_def_limit.lms_s_soft
1006 #define be_timelimit be_def_limit.lms_t_soft
1007 struct slap_limits_set be_def_limit; /* default limits */
1008 struct slap_limits **be_limits; /* regex-based size and time limits */
1009 AccessControl *be_acl; /* access control list for this backend */
1010 slap_access_t be_dfltaccess; /* access given if no acl matches */
1011 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1012 char *be_replogfile; /* replication log file (in master) */
1013 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1014 BVarray be_update_refs; /* where to refer modifying clients to */
1016 int be_lastmod; /* keep track of lastmodified{by,time} */
1018 #define SLAP_GLUE_INSTANCE 0x01 /* a glue backend */
1019 #define SLAP_GLUE_SUBORDINATE 0x02 /* child of a glue hierarchy */
1020 #define SLAP_GLUE_LINKED 0x04 /* child is connected to parent */
1022 int be_glueflags; /* */
1023 void *be_private; /* anything the backend database needs */
1029 /* Backend function typedefs */
1030 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1031 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1032 const char *fname, int lineno,
1033 int argc, char **argv));
1034 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1035 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1036 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1038 typedef int (BI_db_init) LDAP_P((Backend *bd));
1039 typedef int (BI_db_config) LDAP_P((Backend *bd,
1040 const char *fname, int lineno,
1041 int argc, char **argv));
1042 typedef int (BI_db_open) LDAP_P((Backend *bd));
1043 typedef int (BI_db_close) LDAP_P((Backend *bd));
1044 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1046 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1047 struct slap_conn *c, struct slap_op *o,
1048 struct berval *dn, struct berval *ndn, int method,
1049 struct berval *cred, struct berval *edn ));
1050 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1051 struct slap_conn *c, struct slap_op *o ));
1052 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1053 struct slap_conn *c, struct slap_op *o,
1054 struct berval *base, struct berval *nbase,
1055 int scope, int deref,
1056 int slimit, int tlimit,
1057 Filter *f, struct berval *filterstr,
1058 AttributeName *attrs, int attrsonly));
1059 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1060 struct slap_conn *c, struct slap_op *o,
1061 struct berval *dn, struct berval *ndn,
1062 AttributeAssertion *ava));
1063 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1064 struct slap_conn *c, struct slap_op *o,
1065 struct berval *dn, struct berval *ndn,
1067 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1068 struct slap_conn *c, struct slap_op *o,
1069 struct berval *dn, struct berval *ndn,
1070 struct berval *newrdn, struct berval *nnewrdn,
1072 struct berval *newSup, struct berval *nnewSup ));
1073 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1074 struct slap_conn *c, struct slap_op *o,
1076 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1077 struct slap_conn *c, struct slap_op *o,
1078 struct berval *dn, struct berval *ndn));
1079 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1080 struct slap_conn *c, struct slap_op *o,
1083 typedef int (BI_op_extended) LDAP_P((
1085 struct slap_conn *conn,
1088 struct berval * reqdata,
1090 struct berval ** rspdata,
1091 LDAPControl *** rspctrls,
1095 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1096 struct slap_conn *c, struct slap_op *o,
1099 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1100 struct slap_conn *c, struct slap_op *o,
1101 struct berval *dn, struct berval *ndn,
1102 const char **text ));
1104 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1105 struct slap_conn *c, struct slap_op *o,
1109 ObjectClass *group_oc,
1110 AttributeDescription *group_at ));
1112 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1113 struct slap_conn *c, struct slap_op *o,
1114 Entry *e, struct berval *edn,
1115 AttributeDescription *entry_at,
1118 typedef int (BI_operational) LDAP_P((Backend *bd,
1119 struct slap_conn *c, struct slap_op *o,
1120 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1122 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1123 struct slap_conn *c));
1124 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1125 struct slap_conn *c));
1127 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1128 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1129 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1130 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1131 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1132 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1133 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1134 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1136 struct slap_backend_info {
1137 char *bi_type; /* type of backend */
1140 * per backend type routines:
1141 * bi_init: called to allocate a backend_info structure,
1142 * called once BEFORE configuration file is read.
1143 * bi_init() initializes this structure hence is
1144 * called directly from be_initialize()
1145 * bi_config: called per 'backend' specific option
1146 * all such options must before any 'database' options
1147 * bi_config() is called only from read_config()
1148 * bi_open: called to open each database, called
1149 * once AFTER configuration file is read but
1150 * BEFORE any bi_db_open() calls.
1151 * bi_open() is called from backend_startup()
1152 * bi_close: called to close each database, called
1153 * once during shutdown after all bi_db_close calls.
1154 * bi_close() is called from backend_shutdown()
1155 * bi_destroy: called to destroy each database, called
1156 * once during shutdown after all bi_db_destroy calls.
1157 * bi_destory() is called from backend_destroy()
1160 BI_config *bi_config;
1163 BI_destroy *bi_destroy;
1166 * per database routines:
1167 * bi_db_init: called to initialize each database,
1168 * called upon reading 'database <type>'
1169 * called only from backend_db_init()
1170 * bi_db_config: called to configure each database,
1171 * called per database to handle per database options
1172 * called only from read_config()
1173 * bi_db_open: called to open each database
1174 * called once per database immediately AFTER bi_open()
1175 * calls but before daemon startup.
1176 * called only by backend_startup()
1177 * bi_db_close: called to close each database
1178 * called once per database during shutdown but BEFORE
1179 * any bi_close call.
1180 * called only by backend_shutdown()
1181 * bi_db_destroy: called to destroy each database
1182 * called once per database during shutdown AFTER all
1183 * bi_close calls but before bi_destory calls.
1184 * called only by backend_destory()
1186 BI_db_init *bi_db_init;
1187 BI_db_config *bi_db_config;
1188 BI_db_open *bi_db_open;
1189 BI_db_close *bi_db_close;
1190 BI_db_destroy *bi_db_destroy;
1192 /* LDAP Operations Handling Routines */
1193 BI_op_bind *bi_op_bind;
1194 BI_op_unbind *bi_op_unbind;
1195 BI_op_search *bi_op_search;
1196 BI_op_compare *bi_op_compare;
1197 BI_op_modify *bi_op_modify;
1198 BI_op_modrdn *bi_op_modrdn;
1199 BI_op_add *bi_op_add;
1200 BI_op_delete *bi_op_delete;
1201 BI_op_abandon *bi_op_abandon;
1203 /* Extended Operations Helper */
1204 BI_op_extended *bi_extended;
1206 /* Auxilary Functions */
1207 BI_entry_release_rw *bi_entry_release_rw;
1208 BI_chk_referrals *bi_chk_referrals;
1210 BI_acl_group *bi_acl_group;
1211 BI_acl_attribute *bi_acl_attribute;
1213 BI_operational *bi_operational;
1215 BI_connection_init *bi_connection_init;
1216 BI_connection_destroy *bi_connection_destroy;
1218 /* hooks for slap tools */
1219 BI_tool_entry_open *bi_tool_entry_open;
1220 BI_tool_entry_close *bi_tool_entry_close;
1221 BI_tool_entry_first *bi_tool_entry_first;
1222 BI_tool_entry_next *bi_tool_entry_next;
1223 BI_tool_entry_get *bi_tool_entry_get;
1224 BI_tool_entry_put *bi_tool_entry_put;
1225 BI_tool_entry_reindex *bi_tool_entry_reindex;
1226 BI_tool_sync *bi_tool_sync;
1228 #define SLAP_INDEX_ADD_OP 0x0001
1229 #define SLAP_INDEX_DELETE_OP 0x0002
1231 char **bi_controls; /* supported controls */
1233 unsigned int bi_nDB; /* number of databases of this type */
1234 void *bi_private; /* anything the backend type needs */
1237 #define c_authtype c_authz.sai_method
1238 #define c_authmech c_authz.sai_mech
1239 #define c_dn c_authz.sai_dn
1240 #define c_ndn c_authz.sai_ndn
1241 #define c_ssf c_authz.sai_ssf
1242 #define c_transport_ssf c_authz.sai_transport_ssf
1243 #define c_tls_ssf c_authz.sai_tls_ssf
1244 #define c_sasl_ssf c_authz.sai_sasl_ssf
1246 #define o_authtype o_authz.sai_method
1247 #define o_authmech o_authz.sai_mech
1248 #define o_dn o_authz.sai_dn
1249 #define o_ndn o_authz.sai_ndn
1250 #define o_ssf o_authz.sai_ssf
1251 #define o_transport_ssf o_authz.sai_transport_ssf
1252 #define o_tls_ssf o_authz.sai_tls_ssf
1253 #define o_sasl_ssf o_authz.sai_sasl_ssf
1258 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1259 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1260 BVarray, const char *, struct berval *,
1261 struct berval *, LDAPControl ** );
1263 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1264 ber_int_t, const char *, const char *, BVarray,
1265 LDAPControl **, int nentries);
1268 * represents an operation pending from an ldap client
1270 typedef struct slap_op {
1271 ber_int_t o_opid; /* id of this operation */
1272 ber_int_t o_msgid; /* msgid of the request */
1273 #ifdef LDAP_CONNECTIONLESS
1274 Sockaddr o_peeraddr; /* UDP peer address */
1277 ldap_pvt_thread_t o_tid; /* thread handling this op */
1279 BerElement *o_ber; /* ber of the request */
1281 ber_tag_t o_tag; /* tag of the request */
1282 time_t o_time; /* time op was initiated */
1284 AuthorizationInformation o_authz;
1286 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1288 LDAPControl **o_ctrls; /* controls */
1290 unsigned long o_connid; /* id of conn initiating this op */
1292 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1293 int o_abandon; /* abandon flag */
1294 slap_response *o_response; /* callback function */
1295 slap_sresult *o_sresult; /* search result callback */
1297 STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1298 void *o_private; /* anything the backend needs */
1299 void *o_glue; /* for the glue backend */
1303 * Caches the result of a backend_group check for ACL evaluation
1305 typedef struct slap_gacl {
1306 struct slap_gacl *next;
1309 AttributeDescription *at;
1316 * represents a connection from an ldap client
1318 typedef struct slap_conn {
1319 int c_struct_state; /* structure management state */
1320 int c_conn_state; /* connection state */
1322 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1323 Sockbuf *c_sb; /* ber connection stuff */
1325 /* only can be changed by connect_init */
1326 time_t c_starttime; /* when the connection was opened */
1327 time_t c_activitytime; /* when the connection was last used */
1328 unsigned long c_connid; /* id of this connection for stats*/
1330 char *c_listener_url; /* listener URL */
1331 char *c_peer_domain; /* DNS name of client */
1332 char *c_peer_name; /* peer name (trans=addr:port) */
1333 char *c_sock_name; /* sock name (trans=addr:port) */
1335 /* only can be changed by binding thread */
1336 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1337 char *c_sasl_bind_mech; /* mech in progress */
1340 /* authentication backend */
1341 Backend *c_authc_backend;
1343 /* authorization backend - normally same as c_authc_backend */
1344 Backend *c_authz_backend;
1346 AuthorizationInformation c_authz;
1347 GroupAssertion *c_groups;
1349 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1351 STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1352 STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1354 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1355 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1357 BerElement *c_currentber; /* ber we're attempting to read */
1358 int c_writewaiter; /* true if writer is waiting */
1360 #ifdef LDAP_CONNECTIONLESS
1361 int c_is_udp; /* true if this is (C)LDAP over UDP */
1364 int c_is_tls; /* true if this LDAP over raw TLS */
1365 int c_needs_tls_accept; /* true if SSL_accept should be called */
1367 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1368 void *c_sasl_context; /* SASL session context */
1369 void *c_sasl_extra; /* SASL session extra stuff */
1371 long c_n_ops_received; /* num of ops received (next op_id) */
1372 long c_n_ops_executing; /* num of ops currently executing */
1373 long c_n_ops_pending; /* num of ops pending execution */
1374 long c_n_ops_completed; /* num of ops completed */
1376 long c_n_get; /* num of get calls */
1377 long c_n_read; /* num of read calls */
1378 long c_n_write; /* num of write calls */
1381 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1382 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1384 if ( ldap_debug & (level) ) \
1385 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1386 if ( ldap_syslog & (level) ) \
1387 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1391 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1395 #define SASLREGEX_REPLACE 10
1396 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1397 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1399 typedef struct sasl_regexp {
1400 char *match; /* regexp match pattern */
1401 char *replace; /* regexp replace pattern */
1402 regex_t workspace; /* workspace for regexp engine */
1403 regmatch_t strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1404 int offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1407 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1408 #define FLAG_GETDN_FINAL 1
1409 #define FLAG_GETDN_AUTHCID 2
1410 #define FLAG_GETDN_AUTHZID 4
1415 #include "proto-slap.h"
1417 #endif /* _SLAP_H_ */