1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2002 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 "ldap_queue.h"
39 * SLAPD Memory allocation macros
41 * Unlike ch_*() routines, these routines do not assert() upon
42 * allocation error. They are intended to be used instead of
43 * ch_*() routines where the caller has implemented proper
44 * checking for and handling of allocation errors.
46 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
48 #define SLAP_MALLOC(s) ber_memalloc((s))
49 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
50 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
51 #define SLAP_FREE(p) ber_memfree((p))
52 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
53 #define SLAP_STRDUP(s) ber_strdup((s))
54 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
57 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
60 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
61 #define SLAPD_ANONYMOUS "cn=anonymous"
63 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
65 * This is a value used internally by the backends. It is needed to allow
66 * adding values that already exist without getting an error as required by
67 * modrdn when the new rdn was already an attribute value itself.
68 * JCG 05/1999 (gomez@engr.sgi.com)
70 #define SLAP_MOD_SOFTADD 0x1000
76 #define MAXREMATCHES (10)
78 #define SLAP_MAX_WORKER_THREADS (32)
80 #define SLAP_TEXT_BUFLEN (256)
82 /* psuedo error code indicating abandoned operation */
83 #define SLAPD_ABANDON (-1)
85 /* psuedo error code indicating disconnect */
86 #define SLAPD_DISCONNECT (-2)
89 /* We assume "C" locale, that is US-ASCII */
90 #define ASCII_SPACE(c) ( (c) == ' ' )
91 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
92 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
93 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
94 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
95 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
96 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
98 #define SLAP_NIBBLE(c) ((c)&0x0f)
99 #define SLAP_ESCAPE_CHAR ('\\')
100 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
101 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
103 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
104 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
106 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
107 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
108 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
109 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
110 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
112 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
113 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
114 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
115 #define OID_SEPARATOR(c) ( (c) == '.' )
116 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
118 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
119 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
121 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
122 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
124 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
126 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
127 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
128 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
129 (c) == '?' || (c) == ' ' || (c) == '=' )
130 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
132 /* must match in schema_init.c */
133 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
134 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
135 #define SLAPD_GROUP_ATTR "member"
136 #define SLAPD_GROUP_CLASS "groupOfNames"
137 #define SLAPD_ROLE_ATTR "roleOccupant"
138 #define SLAPD_ROLE_CLASS "organizationalRole"
140 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
141 #define SLAPD_ACI_ATTR "OpenLDAPaci"
143 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
145 /* change this to "OpenLDAPset" */
146 #define SLAPD_ACI_SET_ATTR "template"
148 #define SLAPD_TOP_OID "2.5.6.0"
150 LDAP_SLAPD_V (int) slap_debug;
152 typedef unsigned long slap_mask_t;
154 /* Security Strength Factor */
155 typedef unsigned slap_ssf_t;
157 typedef struct slap_ssf_set {
159 slap_ssf_t sss_transport;
162 slap_ssf_t sss_update_ssf;
163 slap_ssf_t sss_update_transport;
164 slap_ssf_t sss_update_tls;
165 slap_ssf_t sss_update_sasl;
171 #define SLAP_INDEX_TYPE 0x00FFUL
172 #define SLAP_INDEX_UNDEFINED 0x0001UL
173 #define SLAP_INDEX_PRESENT 0x0002UL
174 #define SLAP_INDEX_EQUALITY 0x0004UL
175 #define SLAP_INDEX_APPROX 0x0008UL
176 #define SLAP_INDEX_SUBSTR 0x0010UL
177 #define SLAP_INDEX_EXTENDED 0x0020UL
179 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
181 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
183 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
185 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
186 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
187 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
188 #define SLAP_INDEX_SUBSTR_DEFAULT \
189 ( SLAP_INDEX_SUBSTR \
190 | SLAP_INDEX_SUBSTR_INITIAL \
191 | SLAP_INDEX_SUBSTR_ANY \
192 | SLAP_INDEX_SUBSTR_FINAL )
194 #define SLAP_INDEX_SUBSTR_MINLEN 2
195 #define SLAP_INDEX_SUBSTR_MAXLEN 4
196 #define SLAP_INDEX_SUBSTR_STEP 2
198 #define SLAP_INDEX_FLAGS 0xF000UL
199 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
200 #define SLAP_INDEX_NOLANG 0x2000UL /* don't use index w/ lang */
201 #define SLAP_INDEX_AUTO_SUBTYPES 0x4000UL /* use mask with lang subtypes */
204 * there is a single index for each attribute. these prefixes ensure
205 * that there is no collision among keys.
207 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
208 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
209 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
210 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
211 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
212 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
213 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
215 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
216 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
217 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
220 * represents schema information for a database
222 #define SLAP_SCHERR_OUTOFMEM 1
223 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
224 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
225 #define SLAP_SCHERR_ATTR_NOT_FOUND 4
226 #define SLAP_SCHERR_ATTR_BAD_USAGE 5
227 #define SLAP_SCHERR_DUP_CLASS 6
228 #define SLAP_SCHERR_DUP_ATTR 7
229 #define SLAP_SCHERR_DUP_SYNTAX 8
230 #define SLAP_SCHERR_DUP_RULE 9
231 #define SLAP_SCHERR_NO_NAME 10
232 #define SLAP_SCHERR_ATTR_INCOMPLETE 11
233 #define SLAP_SCHERR_MR_NOT_FOUND 12
234 #define SLAP_SCHERR_SYN_NOT_FOUND 13
235 #define SLAP_SCHERR_MR_INCOMPLETE 14
236 #define SLAP_SCHERR_NOT_SUPPORTED 15
237 #define SLAP_SCHERR_BAD_DESCR 16
238 #define SLAP_SCHERR_OIDM 17
239 #define SLAP_SCHERR_LAST SLAP_SCHERR_OIDM
241 typedef union slap_sockaddr {
242 struct sockaddr sa_addr;
243 struct sockaddr_in sa_in_addr;
245 struct sockaddr_in6 sa_in6_addr;
248 struct sockaddr_un sa_un_addr;
252 typedef struct slap_oid_macro {
253 struct berval som_oid;
255 struct slap_oid_macro *som_next;
258 /* forward declarations */
260 struct slap_matching_rule;
262 typedef int slap_syntax_validate_func LDAP_P((
263 struct slap_syntax *syntax,
264 struct berval * in));
266 typedef int slap_syntax_transform_func LDAP_P((
267 struct slap_syntax *syntax,
269 struct berval * out));
271 typedef struct slap_syntax {
273 #define ssyn_oid ssyn_syn.syn_oid
274 #define ssyn_desc ssyn_syn.syn_desc
275 #define ssyn_extensions ssyn_syn.syn_extensions
276 ber_len_t ssyn_oidlen;
278 unsigned int ssyn_flags;
280 #define SLAP_SYNTAX_NONE 0x0000U
281 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
282 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
283 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
284 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
286 slap_syntax_validate_func *ssyn_validate;
287 slap_syntax_transform_func *ssyn_normalize;
288 slap_syntax_transform_func *ssyn_pretty;
290 #ifdef SLAPD_BINARY_CONVERSION
291 /* convert to and from binary */
292 slap_syntax_transform_func *ssyn_ber2str;
293 slap_syntax_transform_func *ssyn_str2ber;
296 struct slap_syntax *ssyn_next;
299 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
300 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
301 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
302 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
303 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
305 /* X -> Y Converter */
306 typedef int slap_mr_convert_func LDAP_P((
308 struct berval * out ));
311 typedef int slap_mr_normalize_func LDAP_P((
313 struct slap_syntax *syntax, /* NULL if in is asserted value */
314 struct slap_matching_rule *mr,
316 struct berval * out ));
318 /* Match (compare) function */
319 typedef int slap_mr_match_func LDAP_P((
322 struct slap_syntax *syntax, /* syntax of stored value */
323 struct slap_matching_rule *mr,
324 struct berval * value,
325 void * assertValue ));
327 /* Index generation function */
328 typedef int slap_mr_indexer_func LDAP_P((
331 struct slap_syntax *syntax, /* syntax of stored value */
332 struct slap_matching_rule *mr,
333 struct berval *prefix,
337 /* Filter index function */
338 typedef int slap_mr_filter_func LDAP_P((
341 struct slap_syntax *syntax, /* syntax of stored value */
342 struct slap_matching_rule *mr,
343 struct berval *prefix,
347 typedef struct slap_matching_rule {
348 LDAPMatchingRule smr_mrule;
349 ber_len_t smr_oidlen;
350 slap_mask_t smr_usage;
352 #define SLAP_MR_HIDE 0x8000U
354 #define SLAP_MR_TYPE_MASK 0x0F00U
355 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
356 #define SLAP_MR_USAGE 0x000FU
358 #define SLAP_MR_NONE 0x0000U
359 #define SLAP_MR_EQUALITY 0x0100U
360 #define SLAP_MR_ORDERING 0x0200U
361 #define SLAP_MR_SUBSTR 0x0400U
362 #define SLAP_MR_EXT 0x0800U
364 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
365 #define SLAP_MR_DN_FOLD 0x0008U
367 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
368 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
369 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
372 * normally the provided value is expected to conform to
373 * assertion syntax specified in the matching rule, however
374 * at times (such as during individual value modification),
375 * the provided value is expected to conform to the
376 * attribute's value syntax.
378 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
379 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
380 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
382 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
383 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
384 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
385 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
387 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
388 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
389 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
390 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
391 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
392 == SLAP_MR_VALUE_SYNTAX_MATCH)
395 slap_mr_convert_func *smr_convert;
396 slap_mr_normalize_func *smr_normalize;
397 slap_mr_match_func *smr_match;
398 slap_mr_indexer_func *smr_indexer;
399 slap_mr_filter_func *smr_filter;
401 struct slap_matching_rule *smr_associated;
402 struct slap_matching_rule *smr_next;
404 #define smr_oid smr_mrule.mr_oid
405 #define smr_names smr_mrule.mr_names
406 #define smr_desc smr_mrule.mr_desc
407 #define smr_obsolete smr_mrule.mr_obsolete
408 #define smr_syntax_oid smr_mrule.mr_syntax_oid
409 #define smr_extensions smr_mrule.mr_extensions
415 typedef int (AttributeTypeSchemaCheckFN)(
416 struct slap_entry *e,
417 struct slap_attr *attr,
419 char *textbuf, size_t textlen );
421 typedef struct slap_attribute_type {
422 LDAPAttributeType sat_atype;
423 struct berval sat_cname;
424 struct slap_attribute_type *sat_sup;
425 struct slap_attribute_type **sat_subtypes;
426 MatchingRule *sat_equality;
427 MatchingRule *sat_approx;
428 MatchingRule *sat_ordering;
429 MatchingRule *sat_substr;
431 AttributeTypeSchemaCheckFN *sat_check;
432 struct slap_attr_desc *sat_ad;
433 struct slap_attribute_type *sat_next;
434 ldap_pvt_thread_mutex_t sat_ad_mutex;
435 #define sat_oid sat_atype.at_oid
436 #define sat_names sat_atype.at_names
437 #define sat_desc sat_atype.at_desc
438 #define sat_obsolete sat_atype.at_obsolete
439 #define sat_sup_oid sat_atype.at_sup_oid
440 #define sat_equality_oid sat_atype.at_equality_oid
441 #define sat_ordering_oid sat_atype.at_ordering_oid
442 #define sat_substr_oid sat_atype.at_substr_oid
443 #define sat_syntax_oid sat_atype.at_syntax_oid
444 #define sat_single_value sat_atype.at_single_value
445 #define sat_collective sat_atype.at_collective
446 #define sat_no_user_mod sat_atype.at_no_user_mod
447 #define sat_usage sat_atype.at_usage
448 #define sat_extensions sat_atype.at_extensions
451 #define is_at_operational(at) ((at)->sat_usage)
452 #define is_at_single_value(at) ((at)->sat_single_value)
453 #define is_at_collective(at) ((at)->sat_collective)
454 #define is_at_obsolete(at) ((at)->sat_obsolete)
455 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
457 struct slap_object_class;
459 typedef int (ObjectClassSchemaCheckFN)(
460 struct slap_entry *e,
461 struct slap_object_class *oc,
463 char *textbuf, size_t textlen );
465 typedef struct slap_object_class {
466 LDAPObjectClass soc_oclass;
467 struct slap_object_class **soc_sups;
468 AttributeType **soc_required;
469 AttributeType **soc_allowed;
470 ObjectClassSchemaCheckFN *sco_check;
471 struct slap_object_class *soc_next;
472 #define soc_oid soc_oclass.oc_oid
473 #define soc_names soc_oclass.oc_names
474 #define soc_desc soc_oclass.oc_desc
475 #define soc_obsolete soc_oclass.oc_obsolete
476 #define soc_sup_oids soc_oclass.oc_sup_oids
477 #define soc_kind soc_oclass.oc_kind
478 #define soc_at_oids_must soc_oclass.oc_at_oids_must
479 #define soc_at_oids_may soc_oclass.oc_at_oids_may
480 #define soc_extensions soc_oclass.oc_extensions
485 * represents a recognized attribute description ( type + options )
487 typedef struct slap_attr_desc {
488 struct slap_attr_desc *ad_next;
489 AttributeType *ad_type; /* attribute type, must be specified */
490 struct berval ad_cname; /* canonical name, must be specified */
491 struct berval ad_lang; /* empty if no language tags */
493 #define SLAP_DESC_NONE 0x0U
494 #define SLAP_DESC_BINARY 0x1U
495 } AttributeDescription;
497 typedef struct slap_attr_name {
498 struct berval an_name;
499 AttributeDescription *an_desc;
502 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
503 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
506 * pointers to schema elements used internally
508 struct slap_internal_schema {
510 ObjectClass *si_oc_top;
511 ObjectClass *si_oc_extensibleObject;
512 ObjectClass *si_oc_alias;
513 ObjectClass *si_oc_referral;
514 ObjectClass *si_oc_subentry;
515 ObjectClass *si_oc_subschema;
516 ObjectClass *si_oc_rootdse;
518 /* objectClass attribute descriptions */
519 AttributeDescription *si_ad_objectClass;
521 /* operational attribute descriptions */
522 AttributeDescription *si_ad_structuralObjectClass;
523 AttributeDescription *si_ad_entryUUID;
524 AttributeDescription *si_ad_entryCSN;
525 AttributeDescription *si_ad_creatorsName;
526 AttributeDescription *si_ad_createTimestamp;
527 AttributeDescription *si_ad_modifiersName;
528 AttributeDescription *si_ad_modifyTimestamp;
529 AttributeDescription *si_ad_hasSubordinates;
530 AttributeDescription *si_ad_subschemaSubentry;
532 /* root DSE attribute descriptions */
533 AttributeDescription *si_ad_namingContexts;
534 AttributeDescription *si_ad_supportedControl;
535 AttributeDescription *si_ad_supportedExtension;
536 AttributeDescription *si_ad_supportedLDAPVersion;
537 AttributeDescription *si_ad_supportedSASLMechanisms;
538 AttributeDescription *si_ad_supportedFeatures;
540 /* subschema subentry attribute descriptions */
541 AttributeDescription *si_ad_objectClasses;
542 AttributeDescription *si_ad_attributeTypes;
543 AttributeDescription *si_ad_ldapSyntaxes;
544 AttributeDescription *si_ad_matchingRules;
545 AttributeDescription *si_ad_matchingRulesUse;
547 /* Aliases & Referrals */
548 AttributeDescription *si_ad_aliasedObjectName;
549 AttributeDescription *si_ad_ref;
551 /* Access Control Internals */
552 AttributeDescription *si_ad_entry;
553 AttributeDescription *si_ad_children;
554 #ifdef SLAPD_ACI_ENABLED
555 AttributeDescription *si_ad_aci;
558 /* Other attributes descriptions */
559 AttributeDescription *si_ad_name;
560 AttributeDescription *si_ad_cn;
561 AttributeDescription *si_ad_userPassword;
562 #ifdef SLAPD_AUTHPASSWD
563 AttributeDescription *si_ad_authPassword;
565 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
566 AttributeDescription *si_ad_krbName;
569 /* Undefined Attribute Type */
570 AttributeType *si_at_undefined;
573 MatchingRule *si_mr_distinguishedNameMatch;
574 MatchingRule *si_mr_integerMatch;
577 Syntax *si_syn_distinguishedName;
578 Syntax *si_syn_integer;
581 typedef struct slap_attr_assertion {
582 AttributeDescription *aa_desc;
583 struct berval aa_value;
584 } AttributeAssertion;
586 typedef struct slap_ss_assertion {
587 AttributeDescription *sa_desc;
588 struct berval sa_initial;
589 struct berval *sa_any;
590 struct berval sa_final;
591 } SubstringsAssertion;
593 typedef struct slap_mr_assertion {
594 MatchingRule *ma_rule; /* optional */
595 struct berval ma_rule_text; /* optional */
596 AttributeDescription *ma_desc; /* optional */
597 int ma_dnattrs; /* boolean */
598 struct berval ma_value; /* required */
599 } MatchingRuleAssertion;
602 * represents a search filter
604 typedef struct slap_filter {
605 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
606 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
607 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
608 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
611 /* precomputed result */
612 ber_int_t f_un_result;
615 struct berval *f_un_dn;
618 AttributeDescription *f_un_desc;
620 /* simple value assertion */
621 AttributeAssertion *f_un_ava;
623 /* substring assertion */
624 SubstringsAssertion *f_un_ssa;
626 /* matching rule assertion */
627 MatchingRuleAssertion *f_un_mra;
629 #define f_dn f_un.f_un_dn
630 #define f_desc f_un.f_un_desc
631 #define f_ava f_un.f_un_ava
632 #define f_av_desc f_un.f_un_ava->aa_desc
633 #define f_av_value f_un.f_un_ava->aa_value
634 #define f_sub f_un.f_un_ssa
635 #define f_sub_desc f_un.f_un_ssa->sa_desc
636 #define f_sub_initial f_un.f_un_ssa->sa_initial
637 #define f_sub_any f_un.f_un_ssa->sa_any
638 #define f_sub_final f_un.f_un_ssa->sa_final
639 #define f_mra f_un.f_un_mra
640 #define f_mr_rule f_un.f_un_mra->ma_rule
641 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
642 #define f_mr_desc f_un.f_un_mra->ma_desc
643 #define f_mr_value f_un.f_un_mra->ma_value
644 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
647 struct slap_filter *f_un_complex;
650 #define f_result f_un.f_un_result
651 #define f_and f_un.f_un_complex
652 #define f_or f_un.f_un_complex
653 #define f_not f_un.f_un_complex
654 #define f_list f_un.f_un_complex
656 struct slap_filter *f_next;
659 /* compare routines can return undefined */
660 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
663 * represents an attribute (description + values)
665 typedef struct slap_attr {
666 AttributeDescription *a_desc;
668 struct slap_attr *a_next;
673 * the id used in the indexes to refer to an entry
675 typedef unsigned long ID;
676 #define NOID ((ID)~0)
679 * represents an entry in core
681 typedef struct slap_entry {
683 * The ID field should only be changed before entry is
684 * inserted into a cache. The ID value is backend
689 struct berval e_name; /* name (DN) of this entry */
690 struct berval e_nname; /* normalized name (DN) of this entry */
692 /* for migration purposes */
693 #define e_dn e_name.bv_val
694 #define e_ndn e_nname.bv_val
696 Attribute *e_attrs; /* list of attributes + values */
698 /* for use by the backend for any purpose */
705 typedef struct slap_mod {
707 AttributeDescription *sm_desc;
708 struct berval sm_type;
712 typedef struct slap_mod_list {
713 Modification sml_mod;
714 #define sml_op sml_mod.sm_op
715 #define sml_desc sml_mod.sm_desc
716 #define sml_type sml_mod.sm_type
717 #define sml_bvalues sml_mod.sm_bvalues
718 struct slap_mod_list *sml_next;
721 typedef struct slap_ldap_modlist {
723 struct slap_ldap_modlist *ml_next;
724 #define ml_op ml_mod.mod_op
725 #define ml_type ml_mod.mod_type
726 #define ml_values ml_mod.mod_values
727 #define ml_bvalues ml_mod.mod_bvalues
731 * represents an access control list
733 typedef enum slap_access_e {
734 ACL_INVALID_ACCESS = -1,
743 typedef enum slap_control_e {
744 ACL_INVALID_CONTROL = 0,
750 typedef enum slap_style_e {
758 /* alternate names */
759 ACL_STYLE_EXACT = ACL_STYLE_BASE
762 typedef struct slap_authz_info {
763 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
764 char * sai_mech; /* SASL Mechanism */
765 struct berval sai_dn; /* DN for reporting purposes */
766 struct berval sai_ndn; /* Normalized DN */
768 /* Security Strength Factors */
769 slap_ssf_t sai_ssf; /* Overall SSF */
770 slap_ssf_t sai_transport_ssf; /* Transport SSF */
771 slap_ssf_t sai_tls_ssf; /* TLS SSF */
772 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
773 } AuthorizationInformation;
776 typedef struct slap_access {
777 slap_control_t a_type;
779 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
781 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
782 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
783 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
784 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
785 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
786 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
788 #define ACL_PRIV_MASK 0x00ffUL
791 #define ACL_PRIV_LEVEL 0x1000UL
792 #define ACL_PRIV_ADDITIVE 0x2000UL
793 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
796 #define ACL_PRIV_INVALID 0x0UL
798 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
799 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
800 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
801 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
803 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
804 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
806 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
808 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
810 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
811 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
812 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
814 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
815 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
816 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
817 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
818 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
819 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
821 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
822 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
823 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
824 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
825 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
826 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
827 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
829 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
830 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
831 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
832 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
833 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
834 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
836 slap_mask_t a_access_mask;
838 AuthorizationInformation a_authz;
839 #define a_dn_pat a_authz.sai_dn
841 slap_style_t a_dn_style;
842 AttributeDescription *a_dn_at;
845 slap_style_t a_peername_style;
846 char *a_peername_pat;
847 slap_style_t a_sockname_style;
848 char *a_sockname_pat;
850 slap_style_t a_domain_style;
852 slap_style_t a_sockurl_style;
854 slap_style_t a_set_style;
855 struct berval a_set_pat;
857 #ifdef SLAPD_ACI_ENABLED
858 AttributeDescription *a_aci_at;
862 slap_style_t a_group_style;
863 struct berval a_group_pat;
864 ObjectClass *a_group_oc;
865 AttributeDescription *a_group_at;
867 struct slap_access *a_next;
871 typedef struct slap_acl {
872 /* "to" part: the entries this acl applies to */
874 slap_style_t acl_dn_style;
876 struct berval acl_dn_pat;
877 AttributeName *acl_attrs;
879 /* "by" part: list of who has what access to the entries */
882 struct slap_acl *acl_next;
886 * replog moddn param structure
888 struct slap_replog_moddn {
889 struct berval *newrdn;
891 struct berval *newsup;
896 * represents a backend
899 typedef struct slap_backend_info BackendInfo; /* per backend type */
900 typedef struct slap_backend_db BackendDB; /* per backend database */
902 LDAP_SLAPD_V (int) nBackendInfo;
903 LDAP_SLAPD_V (int) nBackendDB;
904 LDAP_SLAPD_V (BackendInfo *) backendInfo;
905 LDAP_SLAPD_V (BackendDB *) backendDB;
907 LDAP_SLAPD_V (int) slapMode;
908 #define SLAP_UNDEFINED_MODE 0x0000
909 #define SLAP_SERVER_MODE 0x0001
910 #define SLAP_TOOL_MODE 0x0002
911 #define SLAP_MODE 0x0003
913 #define SLAP_TRUNCATE_MODE 0x0100
915 struct slap_replica_info {
916 char *ri_host; /* supersedes be_replica */
917 struct berval **ri_nsuffix; /* array of suffixes this replica accepts */
920 struct slap_limits_set {
932 int lm_type; /* type of pattern */
933 #define SLAP_LIMITS_UNDEFINED 0x0000
934 #define SLAP_LIMITS_EXACT 0x0001
935 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
936 #define SLAP_LIMITS_ONE 0x0002
937 #define SLAP_LIMITS_SUBTREE 0x0003
938 #define SLAP_LIMITS_CHILDREN 0x0004
939 #define SLAP_LIMITS_REGEX 0x0005
940 #define SLAP_LIMITS_ANONYMOUS 0x0006
941 #define SLAP_LIMITS_USERS 0x0007
942 regex_t lm_dn_regex; /* regex data for REGEX */
945 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
946 * pattern for REGEX; NULL for ANONYMOUS, USERS
948 struct berval lm_dn_pat;
950 struct slap_limits_set lm_limits;
953 /* temporary aliases */
954 typedef BackendDB Backend;
955 #define nbackends nBackendDB
956 #define backends backendDB
958 struct slap_backend_db {
959 BackendInfo *bd_info; /* pointer to shared backend info */
961 /* BackendInfo accessors */
962 #define be_config bd_info->bi_db_config
963 #define be_type bd_info->bi_type
965 #define be_bind bd_info->bi_op_bind
966 #define be_unbind bd_info->bi_op_unbind
967 #define be_add bd_info->bi_op_add
968 #define be_compare bd_info->bi_op_compare
969 #define be_delete bd_info->bi_op_delete
970 #define be_modify bd_info->bi_op_modify
971 #define be_modrdn bd_info->bi_op_modrdn
972 #define be_search bd_info->bi_op_search
974 #define be_extended bd_info->bi_extended
976 #define be_release bd_info->bi_entry_release_rw
977 #define be_chk_referrals bd_info->bi_chk_referrals
978 #define be_group bd_info->bi_acl_group
979 #define be_attribute bd_info->bi_acl_attribute
980 #define be_operational bd_info->bi_operational
982 #define be_controls bd_info->bi_controls
984 #define be_connection_init bd_info->bi_connection_init
985 #define be_connection_destroy bd_info->bi_connection_destroy
988 #define be_entry_open bd_info->bi_tool_entry_open
989 #define be_entry_close bd_info->bi_tool_entry_close
990 #define be_entry_first bd_info->bi_tool_entry_first
991 #define be_entry_next bd_info->bi_tool_entry_next
992 #define be_entry_reindex bd_info->bi_tool_entry_reindex
993 #define be_entry_get bd_info->bi_tool_entry_get
994 #define be_entry_put bd_info->bi_tool_entry_put
995 #define be_sync bd_info->bi_tool_sync
998 slap_mask_t be_restrictops; /* restriction operations */
999 #define SLAP_RESTRICT_OP_ADD 0x0001U
1000 #define SLAP_RESTRICT_OP_BIND 0x0002U
1001 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1002 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1003 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1004 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1005 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1006 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1008 #define SLAP_RESTRICT_OP_READS \
1009 ( SLAP_RESTRICT_OP_COMPARE \
1010 | SLAP_RESTRICT_OP_SEARCH )
1011 #define SLAP_RESTRICT_OP_WRITES \
1012 ( SLAP_RESTRICT_OP_ADD \
1013 | SLAP_RESTRICT_OP_DELETE \
1014 | SLAP_RESTRICT_OP_MODIFY \
1015 | SLAP_RESTRICT_OP_RENAME )
1017 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1018 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1019 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1021 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1022 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1023 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1025 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1026 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1028 slap_mask_t be_requires; /* pre-operation requirements */
1029 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1030 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1031 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1032 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1033 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1035 /* Required Security Strength Factor */
1036 slap_ssf_set_t be_ssf_set;
1038 /* these should be renamed from be_ to bd_ */
1039 struct berval **be_suffix; /* the DN suffixes of data in this backend */
1040 struct berval **be_nsuffix; /* the normalized DN suffixes in this backend */
1041 struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1042 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1043 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1044 struct berval be_rootpw; /* the magic "root" password for this db */
1045 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1046 #define be_sizelimit be_def_limit.lms_s_soft
1047 #define be_timelimit be_def_limit.lms_t_soft
1048 struct slap_limits_set be_def_limit; /* default limits */
1049 struct slap_limits **be_limits; /* regex-based size and time limits */
1050 AccessControl *be_acl; /* access control list for this backend */
1051 slap_access_t be_dfltaccess; /* access given if no acl matches */
1052 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1053 char *be_replogfile; /* replication log file (in master) */
1054 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1055 BVarray be_update_refs; /* where to refer modifying clients to */
1057 int be_lastmod; /* keep track of lastmodified{by,time} */
1059 #define SLAP_GLUE_INSTANCE 0x01 /* a glue backend */
1060 #define SLAP_GLUE_SUBORDINATE 0x02 /* child of a glue hierarchy */
1061 #define SLAP_GLUE_LINKED 0x04 /* child is connected to parent */
1063 int be_glueflags; /* */
1064 void *be_private; /* anything the backend database needs */
1070 /* Backend function typedefs */
1071 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1072 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1073 const char *fname, int lineno,
1074 int argc, char **argv));
1075 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1076 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1077 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1079 typedef int (BI_db_init) LDAP_P((Backend *bd));
1080 typedef int (BI_db_config) LDAP_P((Backend *bd,
1081 const char *fname, int lineno,
1082 int argc, char **argv));
1083 typedef int (BI_db_open) LDAP_P((Backend *bd));
1084 typedef int (BI_db_close) LDAP_P((Backend *bd));
1085 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1087 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1088 struct slap_conn *c, struct slap_op *o,
1089 struct berval *dn, struct berval *ndn, int method,
1090 struct berval *cred, struct berval *edn ));
1091 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1092 struct slap_conn *c, struct slap_op *o ));
1093 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1094 struct slap_conn *c, struct slap_op *o,
1095 struct berval *base, struct berval *nbase,
1096 int scope, int deref,
1097 int slimit, int tlimit,
1098 Filter *f, struct berval *filterstr,
1099 AttributeName *attrs, int attrsonly));
1100 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1101 struct slap_conn *c, struct slap_op *o,
1102 struct berval *dn, struct berval *ndn,
1103 AttributeAssertion *ava));
1104 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1105 struct slap_conn *c, struct slap_op *o,
1106 struct berval *dn, struct berval *ndn,
1108 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1109 struct slap_conn *c, struct slap_op *o,
1110 struct berval *dn, struct berval *ndn,
1111 struct berval *newrdn, struct berval *nnewrdn,
1113 struct berval *newSup, struct berval *nnewSup ));
1114 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1115 struct slap_conn *c, struct slap_op *o,
1117 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1118 struct slap_conn *c, struct slap_op *o,
1119 struct berval *dn, struct berval *ndn));
1120 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1121 struct slap_conn *c, struct slap_op *o,
1124 typedef int (BI_op_extended) LDAP_P((
1126 struct slap_conn *conn,
1129 struct berval * reqdata,
1131 struct berval ** rspdata,
1132 LDAPControl *** rspctrls,
1136 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1137 struct slap_conn *c, struct slap_op *o,
1140 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1141 struct slap_conn *c, struct slap_op *o,
1142 struct berval *dn, struct berval *ndn,
1143 const char **text ));
1145 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1146 struct slap_conn *c, struct slap_op *o,
1150 ObjectClass *group_oc,
1151 AttributeDescription *group_at ));
1153 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1154 struct slap_conn *c, struct slap_op *o,
1155 Entry *e, struct berval *edn,
1156 AttributeDescription *entry_at,
1159 typedef int (BI_operational) LDAP_P((Backend *bd,
1160 struct slap_conn *c, struct slap_op *o,
1161 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1163 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1164 struct slap_conn *c));
1165 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1166 struct slap_conn *c));
1168 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1169 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1170 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1171 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1172 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1173 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1174 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1175 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1177 struct slap_backend_info {
1178 char *bi_type; /* type of backend */
1181 * per backend type routines:
1182 * bi_init: called to allocate a backend_info structure,
1183 * called once BEFORE configuration file is read.
1184 * bi_init() initializes this structure hence is
1185 * called directly from be_initialize()
1186 * bi_config: called per 'backend' specific option
1187 * all such options must before any 'database' options
1188 * bi_config() is called only from read_config()
1189 * bi_open: called to open each database, called
1190 * once AFTER configuration file is read but
1191 * BEFORE any bi_db_open() calls.
1192 * bi_open() is called from backend_startup()
1193 * bi_close: called to close each database, called
1194 * once during shutdown after all bi_db_close calls.
1195 * bi_close() is called from backend_shutdown()
1196 * bi_destroy: called to destroy each database, called
1197 * once during shutdown after all bi_db_destroy calls.
1198 * bi_destory() is called from backend_destroy()
1201 BI_config *bi_config;
1204 BI_destroy *bi_destroy;
1207 * per database routines:
1208 * bi_db_init: called to initialize each database,
1209 * called upon reading 'database <type>'
1210 * called only from backend_db_init()
1211 * bi_db_config: called to configure each database,
1212 * called per database to handle per database options
1213 * called only from read_config()
1214 * bi_db_open: called to open each database
1215 * called once per database immediately AFTER bi_open()
1216 * calls but before daemon startup.
1217 * called only by backend_startup()
1218 * bi_db_close: called to close each database
1219 * called once per database during shutdown but BEFORE
1220 * any bi_close call.
1221 * called only by backend_shutdown()
1222 * bi_db_destroy: called to destroy each database
1223 * called once per database during shutdown AFTER all
1224 * bi_close calls but before bi_destory calls.
1225 * called only by backend_destory()
1227 BI_db_init *bi_db_init;
1228 BI_db_config *bi_db_config;
1229 BI_db_open *bi_db_open;
1230 BI_db_close *bi_db_close;
1231 BI_db_destroy *bi_db_destroy;
1233 /* LDAP Operations Handling Routines */
1234 BI_op_bind *bi_op_bind;
1235 BI_op_unbind *bi_op_unbind;
1236 BI_op_search *bi_op_search;
1237 BI_op_compare *bi_op_compare;
1238 BI_op_modify *bi_op_modify;
1239 BI_op_modrdn *bi_op_modrdn;
1240 BI_op_add *bi_op_add;
1241 BI_op_delete *bi_op_delete;
1242 BI_op_abandon *bi_op_abandon;
1244 /* Extended Operations Helper */
1245 BI_op_extended *bi_extended;
1247 /* Auxilary Functions */
1248 BI_entry_release_rw *bi_entry_release_rw;
1249 BI_chk_referrals *bi_chk_referrals;
1251 BI_acl_group *bi_acl_group;
1252 BI_acl_attribute *bi_acl_attribute;
1254 BI_operational *bi_operational;
1256 BI_connection_init *bi_connection_init;
1257 BI_connection_destroy *bi_connection_destroy;
1259 /* hooks for slap tools */
1260 BI_tool_entry_open *bi_tool_entry_open;
1261 BI_tool_entry_close *bi_tool_entry_close;
1262 BI_tool_entry_first *bi_tool_entry_first;
1263 BI_tool_entry_next *bi_tool_entry_next;
1264 BI_tool_entry_get *bi_tool_entry_get;
1265 BI_tool_entry_put *bi_tool_entry_put;
1266 BI_tool_entry_reindex *bi_tool_entry_reindex;
1267 BI_tool_sync *bi_tool_sync;
1269 #define SLAP_INDEX_ADD_OP 0x0001
1270 #define SLAP_INDEX_DELETE_OP 0x0002
1272 char **bi_controls; /* supported controls */
1274 unsigned int bi_nDB; /* number of databases of this type */
1275 void *bi_private; /* anything the backend type needs */
1278 #define c_authtype c_authz.sai_method
1279 #define c_authmech c_authz.sai_mech
1280 #define c_dn c_authz.sai_dn
1281 #define c_ndn c_authz.sai_ndn
1282 #define c_ssf c_authz.sai_ssf
1283 #define c_transport_ssf c_authz.sai_transport_ssf
1284 #define c_tls_ssf c_authz.sai_tls_ssf
1285 #define c_sasl_ssf c_authz.sai_sasl_ssf
1287 #define o_authtype o_authz.sai_method
1288 #define o_authmech o_authz.sai_mech
1289 #define o_dn o_authz.sai_dn
1290 #define o_ndn o_authz.sai_ndn
1291 #define o_ssf o_authz.sai_ssf
1292 #define o_transport_ssf o_authz.sai_transport_ssf
1293 #define o_tls_ssf o_authz.sai_tls_ssf
1294 #define o_sasl_ssf o_authz.sai_sasl_ssf
1299 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1300 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1301 BVarray, const char *, struct berval *,
1302 struct berval *, LDAPControl ** );
1304 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1305 ber_int_t, const char *, const char *, BVarray,
1306 LDAPControl **, int nentries);
1309 * represents an operation pending from an ldap client
1311 typedef struct slap_op {
1312 ber_int_t o_opid; /* id of this operation */
1313 ber_int_t o_msgid; /* msgid of the request */
1314 #ifdef LDAP_CONNECTIONLESS
1315 Sockaddr o_peeraddr; /* UDP peer address */
1318 ldap_pvt_thread_t o_tid; /* thread handling this op */
1320 BerElement *o_ber; /* ber of the request */
1322 ber_tag_t o_tag; /* tag of the request */
1323 time_t o_time; /* time op was initiated */
1325 AuthorizationInformation o_authz;
1327 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1329 LDAPControl **o_ctrls; /* controls */
1331 unsigned long o_connid; /* id of conn initiating this op */
1333 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1334 int o_abandon; /* abandon flag */
1335 slap_response *o_response; /* callback function */
1336 slap_sresult *o_sresult; /* search result callback */
1338 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1339 void *o_private; /* anything the backend needs */
1340 void *o_glue; /* for the glue backend */
1342 #define SLAP_NO_CONTROL 0
1343 #define SLAP_NONCRITICAL_CONTROL 1
1344 #define SLAP_CRITICAL_CONTROL 2
1348 char o_subentries_visibility;
1351 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1352 #define get_subentries(op) ((int)(op)->o_subentries)
1353 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1356 * Caches the result of a backend_group check for ACL evaluation
1358 typedef struct slap_gacl {
1359 struct slap_gacl *next;
1362 AttributeDescription *at;
1369 * represents a connection from an ldap client
1371 typedef struct slap_conn {
1372 int c_struct_state; /* structure management state */
1373 int c_conn_state; /* connection state */
1375 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1376 Sockbuf *c_sb; /* ber connection stuff */
1378 /* only can be changed by connect_init */
1379 time_t c_starttime; /* when the connection was opened */
1380 time_t c_activitytime; /* when the connection was last used */
1381 unsigned long c_connid; /* id of this connection for stats*/
1383 char *c_listener_url; /* listener URL */
1384 char *c_peer_domain; /* DNS name of client */
1385 char *c_peer_name; /* peer name (trans=addr:port) */
1386 char *c_sock_name; /* sock name (trans=addr:port) */
1388 /* only can be changed by binding thread */
1389 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1390 char *c_sasl_bind_mech; /* mech in progress */
1391 struct berval c_cdn;
1393 /* authentication backend */
1394 Backend *c_authc_backend;
1396 /* authorization backend - normally same as c_authc_backend */
1397 Backend *c_authz_backend;
1399 AuthorizationInformation c_authz;
1400 GroupAssertion *c_groups;
1402 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1404 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1405 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1407 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1408 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1410 BerElement *c_currentber; /* ber we're attempting to read */
1411 int c_writewaiter; /* true if writer is waiting */
1413 #ifdef LDAP_CONNECTIONLESS
1414 int c_is_udp; /* true if this is (C)LDAP over UDP */
1417 int c_is_tls; /* true if this LDAP over raw TLS */
1418 int c_needs_tls_accept; /* true if SSL_accept should be called */
1420 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1421 void *c_sasl_context; /* SASL session context */
1422 void *c_sasl_extra; /* SASL session extra stuff */
1424 long c_n_ops_received; /* num of ops received (next op_id) */
1425 long c_n_ops_executing; /* num of ops currently executing */
1426 long c_n_ops_pending; /* num of ops pending execution */
1427 long c_n_ops_completed; /* num of ops completed */
1429 long c_n_get; /* num of get calls */
1430 long c_n_read; /* num of read calls */
1431 long c_n_write; /* num of write calls */
1434 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1435 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1437 if ( ldap_debug & (level) ) \
1438 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1439 if ( ldap_syslog & (level) ) \
1440 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1444 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1448 #define SASLREGEX_REPLACE 10
1449 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1450 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1452 typedef struct sasl_regexp {
1453 char *match; /* regexp match pattern */
1454 char *replace; /* regexp replace pattern */
1455 regex_t workspace; /* workspace for regexp engine */
1456 regmatch_t strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1457 int offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1460 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1461 #define FLAG_GETDN_FINAL 1
1462 #define FLAG_GETDN_AUTHCID 2
1463 #define FLAG_GETDN_AUTHZID 4
1467 #include "proto-slap.h"
1469 #endif /* _SLAP_H_ */