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
72 #define MAXREMATCHES (100)
74 #define SLAP_MAX_WORKER_THREADS (32)
76 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
77 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
79 #define SLAP_TEXT_BUFLEN (256)
81 /* psuedo error code indicating abandoned operation */
82 #define SLAPD_ABANDON (-1)
84 /* psuedo error code indicating disconnect */
85 #define SLAPD_DISCONNECT (-2)
88 /* We assume "C" locale, that is US-ASCII */
89 #define ASCII_SPACE(c) ( (c) == ' ' )
90 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
91 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
92 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
93 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
94 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
95 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
97 #define SLAP_NIBBLE(c) ((c)&0x0f)
98 #define SLAP_ESCAPE_CHAR ('\\')
99 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
100 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
102 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
103 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
105 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
106 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
107 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
108 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
109 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
111 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
112 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
113 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
114 #define OID_SEPARATOR(c) ( (c) == '.' )
115 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
117 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
118 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
120 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
121 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
123 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
125 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
126 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
127 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
128 (c) == '?' || (c) == ' ' || (c) == '=' )
129 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
131 /* must match in schema_init.c */
132 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
133 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
134 #define SLAPD_GROUP_ATTR "member"
135 #define SLAPD_GROUP_CLASS "groupOfNames"
136 #define SLAPD_ROLE_ATTR "roleOccupant"
137 #define SLAPD_ROLE_CLASS "organizationalRole"
139 #ifdef SLAPD_ACI_ENABLED
140 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
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 */
203 * there is a single index for each attribute. these prefixes ensure
204 * that there is no collision among keys.
206 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
207 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
208 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
209 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
210 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
211 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
213 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
214 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
215 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
218 * represents schema information for a database
220 #define SLAP_SCHERR_OUTOFMEM 1
221 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
222 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
223 #define SLAP_SCHERR_ATTR_NOT_FOUND 4
224 #define SLAP_SCHERR_ATTR_BAD_USAGE 5
225 #define SLAP_SCHERR_DUP_CLASS 6
226 #define SLAP_SCHERR_DUP_ATTR 7
227 #define SLAP_SCHERR_DUP_SYNTAX 8
228 #define SLAP_SCHERR_DUP_RULE 9
229 #define SLAP_SCHERR_NO_NAME 10
230 #define SLAP_SCHERR_ATTR_INCOMPLETE 11
231 #define SLAP_SCHERR_MR_NOT_FOUND 12
232 #define SLAP_SCHERR_SYN_NOT_FOUND 13
233 #define SLAP_SCHERR_MR_INCOMPLETE 14
234 #define SLAP_SCHERR_NOT_SUPPORTED 15
235 #define SLAP_SCHERR_BAD_DESCR 16
236 #define SLAP_SCHERR_OIDM 17
237 #define SLAP_SCHERR_LAST SLAP_SCHERR_OIDM
239 typedef union slap_sockaddr {
240 struct sockaddr sa_addr;
241 struct sockaddr_in sa_in_addr;
243 struct sockaddr_in6 sa_in6_addr;
246 struct sockaddr_un sa_un_addr;
250 typedef struct slap_oid_macro {
251 struct berval som_oid;
253 struct slap_oid_macro *som_next;
256 /* forward declarations */
258 struct slap_matching_rule;
260 typedef int slap_syntax_validate_func LDAP_P((
261 struct slap_syntax *syntax,
262 struct berval * in));
264 typedef int slap_syntax_transform_func LDAP_P((
265 struct slap_syntax *syntax,
267 struct berval * out));
269 typedef struct slap_syntax {
271 #define ssyn_oid ssyn_syn.syn_oid
272 #define ssyn_desc ssyn_syn.syn_desc
273 #define ssyn_extensions ssyn_syn.syn_extensions
274 ber_len_t ssyn_oidlen;
276 unsigned int ssyn_flags;
278 #define SLAP_SYNTAX_NONE 0x0000U
279 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
280 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
281 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
282 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
284 slap_syntax_validate_func *ssyn_validate;
285 slap_syntax_transform_func *ssyn_normalize;
286 slap_syntax_transform_func *ssyn_pretty;
288 #ifdef SLAPD_BINARY_CONVERSION
289 /* convert to and from binary */
290 slap_syntax_transform_func *ssyn_ber2str;
291 slap_syntax_transform_func *ssyn_str2ber;
294 struct slap_syntax *ssyn_next;
297 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
298 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
299 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
300 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
301 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
303 /* X -> Y Converter */
304 typedef int slap_mr_convert_func LDAP_P((
306 struct berval * out ));
309 typedef int slap_mr_normalize_func LDAP_P((
311 struct slap_syntax *syntax, /* NULL if in is asserted value */
312 struct slap_matching_rule *mr,
314 struct berval * out ));
316 /* Match (compare) function */
317 typedef int slap_mr_match_func LDAP_P((
320 struct slap_syntax *syntax, /* syntax of stored value */
321 struct slap_matching_rule *mr,
322 struct berval * value,
323 void * assertValue ));
325 /* Index generation function */
326 typedef int slap_mr_indexer_func LDAP_P((
329 struct slap_syntax *syntax, /* syntax of stored value */
330 struct slap_matching_rule *mr,
331 struct berval *prefix,
335 /* Filter index function */
336 typedef int slap_mr_filter_func LDAP_P((
339 struct slap_syntax *syntax, /* syntax of stored value */
340 struct slap_matching_rule *mr,
341 struct berval *prefix,
345 typedef struct slap_matching_rule {
346 LDAPMatchingRule smr_mrule;
347 ber_len_t smr_oidlen;
348 slap_mask_t smr_usage;
350 #define SLAP_MR_HIDE 0x8000U
352 #define SLAP_MR_TYPE_MASK 0x0F00U
353 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
354 #define SLAP_MR_USAGE 0x000FU
356 #define SLAP_MR_NONE 0x0000U
357 #define SLAP_MR_EQUALITY 0x0100U
358 #define SLAP_MR_ORDERING 0x0200U
359 #define SLAP_MR_SUBSTR 0x0400U
360 #define SLAP_MR_EXT 0x0800U
362 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
363 #define SLAP_MR_DN_FOLD 0x0008U
365 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
366 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
367 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
370 * normally the provided value is expected to conform to
371 * assertion syntax specified in the matching rule, however
372 * at times (such as during individual value modification),
373 * the provided value is expected to conform to the
374 * attribute's value syntax.
376 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
377 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
378 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
380 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
381 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
382 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
383 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
385 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
386 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
387 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
388 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
389 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
390 == SLAP_MR_VALUE_SYNTAX_MATCH)
393 slap_mr_convert_func *smr_convert;
394 slap_mr_normalize_func *smr_normalize;
395 slap_mr_match_func *smr_match;
396 slap_mr_indexer_func *smr_indexer;
397 slap_mr_filter_func *smr_filter;
399 struct slap_matching_rule *smr_associated;
400 struct slap_matching_rule *smr_next;
402 #define smr_oid smr_mrule.mr_oid
403 #define smr_names smr_mrule.mr_names
404 #define smr_desc smr_mrule.mr_desc
405 #define smr_obsolete smr_mrule.mr_obsolete
406 #define smr_syntax_oid smr_mrule.mr_syntax_oid
407 #define smr_extensions smr_mrule.mr_extensions
410 struct slap_backend_db;
414 typedef int (AttributeTypeSchemaCheckFN)(
415 struct slap_backend_db *be,
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;
432 AttributeTypeSchemaCheckFN *sat_check;
433 slap_mask_t sat_flags;
435 struct slap_attribute_type *sat_next;
437 #define sat_oid sat_atype.at_oid
438 #define sat_names sat_atype.at_names
439 #define sat_desc sat_atype.at_desc
440 #define sat_obsolete sat_atype.at_obsolete
441 #define sat_sup_oid sat_atype.at_sup_oid
442 #define sat_equality_oid sat_atype.at_equality_oid
443 #define sat_ordering_oid sat_atype.at_ordering_oid
444 #define sat_substr_oid sat_atype.at_substr_oid
445 #define sat_syntax_oid sat_atype.at_syntax_oid
446 #define sat_single_value sat_atype.at_single_value
447 #define sat_collective sat_atype.at_collective
448 #define sat_no_user_mod sat_atype.at_no_user_mod
449 #define sat_usage sat_atype.at_usage
450 #define sat_extensions sat_atype.at_extensions
452 struct slap_attr_desc *sat_ad;
453 ldap_pvt_thread_mutex_t sat_ad_mutex;
456 #define is_at_operational(at) ((at)->sat_usage)
457 #define is_at_single_value(at) ((at)->sat_single_value)
458 #define is_at_collective(at) ((at)->sat_collective)
459 #define is_at_obsolete(at) ((at)->sat_obsolete)
460 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
462 struct slap_object_class;
464 typedef int (ObjectClassSchemaCheckFN)(
465 struct slap_backend_db *be,
466 struct slap_entry *e,
467 struct slap_object_class *oc,
469 char *textbuf, size_t textlen );
471 typedef struct slap_object_class {
472 LDAPObjectClass soc_oclass;
473 struct slap_object_class **soc_sups;
474 AttributeType **soc_required;
475 AttributeType **soc_allowed;
476 ObjectClassSchemaCheckFN *soc_check;
477 slap_mask_t soc_flags;
478 #define soc_oid soc_oclass.oc_oid
479 #define soc_names soc_oclass.oc_names
480 #define soc_desc soc_oclass.oc_desc
481 #define soc_obsolete soc_oclass.oc_obsolete
482 #define soc_sup_oids soc_oclass.oc_sup_oids
483 #define soc_kind soc_oclass.oc_kind
484 #define soc_at_oids_must soc_oclass.oc_at_oids_must
485 #define soc_at_oids_may soc_oclass.oc_at_oids_may
486 #define soc_extensions soc_oclass.oc_extensions
488 struct slap_object_class *soc_next;
491 #define SLAP_OC_ALIAS 0x01
492 #define SLAP_OC_REFERRAL 0x02
493 #define SLAP_OC_SUBENTRY 0x04
494 #define SLAP_OC_DYNAMICOBJECT 0x08
495 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x10
496 #define SLAP_OC__MASK 0x1F
497 #define SLAP_OC__END 0x20
499 #ifdef LDAP_EXTENDED_SCHEMA
503 typedef struct slap_content_rule {
504 LDAPContentRule scr_crule;
505 ObjectClass *scr_sclass;
506 ObjectClass **scr_auxiliaries; /* optional */
507 AttributeType **scr_required; /* optional */
508 AttributeType **scr_allowed; /* optional */
509 AttributeType **scr_precluded; /* optional */
510 #define scr_oid scr_crule.cr_oid
511 #define scr_names scr_crule.cr_names
512 #define scr_desc scr_crule.cr_desc
513 #define scr_obsolete soc_oclass.cr_obsolete
514 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
515 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
516 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
517 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
522 * represents a recognized attribute description ( type + options )
524 typedef struct slap_attr_desc {
525 struct slap_attr_desc *ad_next;
526 AttributeType *ad_type; /* attribute type, must be specified */
527 struct berval ad_cname; /* canonical name, must be specified */
528 struct berval ad_lang; /* empty if no language tags */
530 #define SLAP_DESC_NONE 0x00U
531 #define SLAP_DESC_BINARY 0x01U
532 #define SLAP_DESC_LANG_RANGE 0x80U
533 } AttributeDescription;
535 typedef struct slap_attr_name {
536 struct berval an_name;
537 AttributeDescription *an_desc;
541 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
542 #define slap_ad_is_lang_range(ad) \
543 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
544 #define slap_ad_is_binary(ad) \
545 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
548 * pointers to schema elements used internally
550 struct slap_internal_schema {
552 ObjectClass *si_oc_top;
553 ObjectClass *si_oc_extensibleObject;
554 ObjectClass *si_oc_alias;
555 ObjectClass *si_oc_referral;
556 ObjectClass *si_oc_rootdse;
557 ObjectClass *si_oc_subentry;
558 ObjectClass *si_oc_subschema;
559 ObjectClass *si_oc_monitor;
560 ObjectClass *si_oc_collectiveAttributeSubentry;
561 ObjectClass *si_oc_dynamicObject;
563 /* objectClass attribute descriptions */
564 AttributeDescription *si_ad_objectClass;
566 /* operational attribute descriptions */
567 AttributeDescription *si_ad_structuralObjectClass;
568 AttributeDescription *si_ad_creatorsName;
569 AttributeDescription *si_ad_createTimestamp;
570 AttributeDescription *si_ad_modifiersName;
571 AttributeDescription *si_ad_modifyTimestamp;
572 AttributeDescription *si_ad_hasSubordinates;
573 AttributeDescription *si_ad_subschemaSubentry;
574 AttributeDescription *si_ad_collectiveSubentries;
575 AttributeDescription *si_ad_collectiveExclusions;
576 AttributeDescription *si_ad_entryUUID;
577 AttributeDescription *si_ad_entryCSN;
579 /* root DSE attribute descriptions */
580 AttributeDescription *si_ad_altServer;
581 AttributeDescription *si_ad_namingContexts;
582 AttributeDescription *si_ad_supportedControl;
583 AttributeDescription *si_ad_supportedExtension;
584 AttributeDescription *si_ad_supportedLDAPVersion;
585 AttributeDescription *si_ad_supportedSASLMechanisms;
586 AttributeDescription *si_ad_supportedFeatures;
587 AttributeDescription *si_ad_vendorName;
588 AttributeDescription *si_ad_vendorVersion;
590 /* subentry attribute descriptions */
591 AttributeDescription *si_ad_administrativeRole;
592 AttributeDescription *si_ad_subtreeSpecification;
594 /* subschema subentry attribute descriptions */
595 AttributeDescription *si_ad_ditStructureRules;
596 AttributeDescription *si_ad_ditContentRules;
597 AttributeDescription *si_ad_nameForms;
598 AttributeDescription *si_ad_objectClasses;
599 AttributeDescription *si_ad_attributeTypes;
600 AttributeDescription *si_ad_ldapSyntaxes;
601 AttributeDescription *si_ad_matchingRules;
602 AttributeDescription *si_ad_matchingRuleUse;
604 /* Aliases & Referrals */
605 AttributeDescription *si_ad_aliasedObjectName;
606 AttributeDescription *si_ad_ref;
608 /* Access Control Internals */
609 AttributeDescription *si_ad_entry;
610 AttributeDescription *si_ad_children;
611 #ifdef SLAPD_ACI_ENABLED
612 AttributeDescription *si_ad_aci;
615 /* dynamic entries */
616 AttributeDescription *si_ad_entryTtl;
617 AttributeDescription *si_ad_dynamicSubtrees;
619 /* Other attributes descriptions */
620 AttributeDescription *si_ad_distinguishedName;
621 AttributeDescription *si_ad_name;
622 AttributeDescription *si_ad_cn;
623 AttributeDescription *si_ad_userPassword;
624 #ifdef SLAPD_AUTHPASSWD
625 AttributeDescription *si_ad_authPassword;
627 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
628 AttributeDescription *si_ad_krbName;
631 /* Undefined Attribute Type */
632 AttributeType *si_at_undefined;
635 MatchingRule *si_mr_distinguishedNameMatch;
636 MatchingRule *si_mr_integerMatch;
639 Syntax *si_syn_octetString;
640 Syntax *si_syn_distinguishedName;
641 Syntax *si_syn_integer;
644 typedef struct slap_attr_assertion {
645 AttributeDescription *aa_desc;
646 struct berval aa_value;
647 } AttributeAssertion;
649 typedef struct slap_ss_assertion {
650 AttributeDescription *sa_desc;
651 struct berval sa_initial;
652 struct berval *sa_any;
653 struct berval sa_final;
654 } SubstringsAssertion;
656 typedef struct slap_mr_assertion {
657 MatchingRule *ma_rule; /* optional */
658 struct berval ma_rule_text; /* optional */
659 AttributeDescription *ma_desc; /* optional */
660 int ma_dnattrs; /* boolean */
661 struct berval ma_value; /* required */
662 } MatchingRuleAssertion;
665 * represents a search filter
667 typedef struct slap_filter {
668 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
669 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
670 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
671 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
674 /* precomputed result */
675 ber_int_t f_un_result;
678 struct berval *f_un_dn;
681 AttributeDescription *f_un_desc;
683 /* simple value assertion */
684 AttributeAssertion *f_un_ava;
686 /* substring assertion */
687 SubstringsAssertion *f_un_ssa;
689 /* matching rule assertion */
690 MatchingRuleAssertion *f_un_mra;
692 #define f_dn f_un.f_un_dn
693 #define f_desc f_un.f_un_desc
694 #define f_ava f_un.f_un_ava
695 #define f_av_desc f_un.f_un_ava->aa_desc
696 #define f_av_value f_un.f_un_ava->aa_value
697 #define f_sub f_un.f_un_ssa
698 #define f_sub_desc f_un.f_un_ssa->sa_desc
699 #define f_sub_initial f_un.f_un_ssa->sa_initial
700 #define f_sub_any f_un.f_un_ssa->sa_any
701 #define f_sub_final f_un.f_un_ssa->sa_final
702 #define f_mra f_un.f_un_mra
703 #define f_mr_rule f_un.f_un_mra->ma_rule
704 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
705 #define f_mr_desc f_un.f_un_mra->ma_desc
706 #define f_mr_value f_un.f_un_mra->ma_value
707 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
710 struct slap_filter *f_un_complex;
713 #define f_result f_un.f_un_result
714 #define f_and f_un.f_un_complex
715 #define f_or f_un.f_un_complex
716 #define f_not f_un.f_un_complex
717 #define f_list f_un.f_un_complex
719 struct slap_filter *f_next;
722 /* compare routines can return undefined */
723 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
726 * represents an attribute (description + values)
728 typedef struct slap_attr {
729 AttributeDescription *a_desc;
731 struct slap_attr *a_next;
733 #define SLAP_ATTR_IXADD 0x1U
734 #define SLAP_ATTR_IXDEL 0x2U
739 * the id used in the indexes to refer to an entry
741 typedef unsigned long ID;
742 #define NOID ((ID)~0)
745 * represents an entry in core
747 typedef struct slap_entry {
749 * The ID field should only be changed before entry is
750 * inserted into a cache. The ID value is backend
755 struct berval e_name; /* name (DN) of this entry */
756 struct berval e_nname; /* normalized name (DN) of this entry */
758 /* for migration purposes */
759 #define e_dn e_name.bv_val
760 #define e_ndn e_nname.bv_val
762 Attribute *e_attrs; /* list of attributes + values */
764 slap_mask_t e_ocflags;
766 struct berval e_bv; /* For entry_encode/entry_decode */
768 /* for use by the backend for any purpose */
775 typedef struct slap_mod {
777 AttributeDescription *sm_desc;
778 struct berval sm_type;
779 BerVarray sm_bvalues;
782 typedef struct slap_mod_list {
783 Modification sml_mod;
784 #define sml_op sml_mod.sm_op
785 #define sml_desc sml_mod.sm_desc
786 #define sml_type sml_mod.sm_type
787 #define sml_bvalues sml_mod.sm_bvalues
788 struct slap_mod_list *sml_next;
791 typedef struct slap_ldap_modlist {
793 struct slap_ldap_modlist *ml_next;
794 #define ml_op ml_mod.mod_op
795 #define ml_type ml_mod.mod_type
796 #define ml_values ml_mod.mod_values
797 #define ml_bvalues ml_mod.mod_bvalues
801 * represents an access control list
803 typedef enum slap_access_e {
804 ACL_INVALID_ACCESS = -1,
813 typedef enum slap_control_e {
814 ACL_INVALID_CONTROL = 0,
820 typedef enum slap_style_e {
828 /* alternate names */
829 ACL_STYLE_EXACT = ACL_STYLE_BASE
832 typedef struct slap_authz_info {
833 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
834 struct berval sai_mech; /* SASL Mechanism */
835 struct berval sai_dn; /* DN for reporting purposes */
836 struct berval sai_ndn; /* Normalized DN */
838 /* Security Strength Factors */
839 slap_ssf_t sai_ssf; /* Overall SSF */
840 slap_ssf_t sai_transport_ssf; /* Transport SSF */
841 slap_ssf_t sai_tls_ssf; /* TLS SSF */
842 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
843 } AuthorizationInformation;
846 typedef struct slap_access {
847 slap_control_t a_type;
849 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
851 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
852 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
853 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
854 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
855 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
856 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
858 #define ACL_PRIV_MASK 0x00ffUL
861 #define ACL_PRIV_LEVEL 0x1000UL
862 #define ACL_PRIV_ADDITIVE 0x2000UL
863 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
866 #define ACL_PRIV_INVALID 0x0UL
868 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
869 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
870 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
871 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
873 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
874 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
876 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
878 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
880 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
881 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
882 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
884 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
885 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
886 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
887 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
888 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
889 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
891 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
892 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
893 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
894 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
895 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
896 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
897 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
899 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
900 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
901 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
902 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
903 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
904 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
906 slap_mask_t a_access_mask;
908 AuthorizationInformation a_authz;
909 #define a_dn_pat a_authz.sai_dn
911 slap_style_t a_dn_style;
912 AttributeDescription *a_dn_at;
916 slap_style_t a_peername_style;
917 struct berval a_peername_pat;
918 slap_style_t a_sockname_style;
919 struct berval a_sockname_pat;
921 slap_style_t a_domain_style;
922 struct berval a_domain_pat;
925 slap_style_t a_sockurl_style;
926 struct berval a_sockurl_pat;
927 slap_style_t a_set_style;
928 struct berval a_set_pat;
930 #ifdef SLAPD_ACI_ENABLED
931 AttributeDescription *a_aci_at;
935 slap_style_t a_group_style;
936 struct berval a_group_pat;
937 ObjectClass *a_group_oc;
938 AttributeDescription *a_group_at;
940 struct slap_access *a_next;
944 typedef struct slap_acl {
945 /* "to" part: the entries this acl applies to */
947 slap_style_t acl_dn_style;
949 struct berval acl_dn_pat;
950 AttributeName *acl_attrs;
952 /* "by" part: list of who has what access to the entries */
955 struct slap_acl *acl_next;
958 typedef struct slap_acl_state {
959 unsigned as_recorded;
960 #define ACL_STATE_NOT_RECORDED 0x0
961 #define ACL_STATE_RECORDED_VD 0x1
962 #define ACL_STATE_RECORDED_NV 0x2
963 #define ACL_STATE_RECORDED 0x3
966 AccessControl *as_vd_acl;
967 slap_mask_t as_vd_acl_mask;
968 regmatch_t as_vd_acl_matches[MAXREMATCHES];
971 Access *as_vd_access;
972 int as_vd_access_count;
975 } AccessControlState;
976 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
979 * replog moddn param structure
981 struct slap_replog_moddn {
982 struct berval *newrdn;
984 struct berval *newsup;
989 * represents a backend
992 typedef struct slap_backend_info BackendInfo; /* per backend type */
993 typedef struct slap_backend_db BackendDB; /* per backend database */
995 LDAP_SLAPD_V (int) nBackendInfo;
996 LDAP_SLAPD_V (int) nBackendDB;
997 LDAP_SLAPD_V (BackendInfo *) backendInfo;
998 LDAP_SLAPD_V (BackendDB *) backendDB;
1000 LDAP_SLAPD_V (int) slapMode;
1001 #define SLAP_UNDEFINED_MODE 0x0000
1002 #define SLAP_SERVER_MODE 0x0001
1003 #define SLAP_TOOL_MODE 0x0002
1004 #define SLAP_MODE 0x0003
1006 #define SLAP_TRUNCATE_MODE 0x0100
1008 struct slap_replica_info {
1009 char *ri_host; /* supersedes be_replica */
1010 struct berval **ri_nsuffix; /* array of suffixes this replica accepts */
1011 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1012 int ri_exclude; /* 1 => exclude ri_attrs */
1015 struct slap_limits_set {
1023 int lms_s_unchecked;
1026 struct slap_limits {
1027 int lm_type; /* type of pattern */
1028 #define SLAP_LIMITS_UNDEFINED 0x0000
1029 #define SLAP_LIMITS_EXACT 0x0001
1030 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1031 #define SLAP_LIMITS_ONE 0x0002
1032 #define SLAP_LIMITS_SUBTREE 0x0003
1033 #define SLAP_LIMITS_CHILDREN 0x0004
1034 #define SLAP_LIMITS_REGEX 0x0005
1035 #define SLAP_LIMITS_ANONYMOUS 0x0006
1036 #define SLAP_LIMITS_USERS 0x0007
1037 regex_t lm_dn_regex; /* regex data for REGEX */
1040 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1041 * pattern for REGEX; NULL for ANONYMOUS, USERS
1043 struct berval lm_dn_pat;
1045 struct slap_limits_set lm_limits;
1048 /* temporary aliases */
1049 typedef BackendDB Backend;
1050 #define nbackends nBackendDB
1051 #define backends backendDB
1053 struct slap_backend_db {
1054 BackendInfo *bd_info; /* pointer to shared backend info */
1056 /* BackendInfo accessors */
1057 #define be_config bd_info->bi_db_config
1058 #define be_type bd_info->bi_type
1060 #define be_bind bd_info->bi_op_bind
1061 #define be_unbind bd_info->bi_op_unbind
1062 #define be_add bd_info->bi_op_add
1063 #define be_compare bd_info->bi_op_compare
1064 #define be_delete bd_info->bi_op_delete
1065 #define be_modify bd_info->bi_op_modify
1066 #define be_modrdn bd_info->bi_op_modrdn
1067 #define be_search bd_info->bi_op_search
1069 #define be_extended bd_info->bi_extended
1071 #define be_release bd_info->bi_entry_release_rw
1072 #define be_chk_referrals bd_info->bi_chk_referrals
1073 #define be_group bd_info->bi_acl_group
1074 #define be_attribute bd_info->bi_acl_attribute
1075 #define be_operational bd_info->bi_operational
1077 #define be_controls bd_info->bi_controls
1079 #define be_connection_init bd_info->bi_connection_init
1080 #define be_connection_destroy bd_info->bi_connection_destroy
1083 #define be_entry_open bd_info->bi_tool_entry_open
1084 #define be_entry_close bd_info->bi_tool_entry_close
1085 #define be_entry_first bd_info->bi_tool_entry_first
1086 #define be_entry_next bd_info->bi_tool_entry_next
1087 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1088 #define be_entry_get bd_info->bi_tool_entry_get
1089 #define be_entry_put bd_info->bi_tool_entry_put
1090 #define be_sync bd_info->bi_tool_sync
1093 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1094 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1095 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1096 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1097 #define SLAP_BFLAG_ALIASES 0x0100U
1098 #define SLAP_BFLAG_REFERRALS 0x0200U
1099 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1100 #define SLAP_BFLAG_MONITOR 0x1000U
1101 #define SLAP_BFLAG_DYNAMIC 0x2000U
1102 slap_mask_t be_flags;
1103 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1104 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1105 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1106 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1107 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1108 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1110 slap_mask_t be_restrictops; /* restriction operations */
1111 #define SLAP_RESTRICT_OP_ADD 0x0001U
1112 #define SLAP_RESTRICT_OP_BIND 0x0002U
1113 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1114 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1115 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1116 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1117 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1118 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1120 #define SLAP_RESTRICT_OP_READS \
1121 ( SLAP_RESTRICT_OP_COMPARE \
1122 | SLAP_RESTRICT_OP_SEARCH )
1123 #define SLAP_RESTRICT_OP_WRITES \
1124 ( SLAP_RESTRICT_OP_ADD \
1125 | SLAP_RESTRICT_OP_DELETE \
1126 | SLAP_RESTRICT_OP_MODIFY \
1127 | SLAP_RESTRICT_OP_RENAME )
1129 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1130 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1131 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1133 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1134 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1135 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1137 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1138 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1140 slap_mask_t be_requires; /* pre-operation requirements */
1141 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1142 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1143 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1144 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1145 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1147 /* Required Security Strength Factor */
1148 slap_ssf_set_t be_ssf_set;
1150 /* these should be renamed from be_ to bd_ */
1151 struct berval **be_suffix; /* the DN suffixes of data in this backend */
1152 struct berval **be_nsuffix; /* the normalized DN suffixes in this backend */
1153 struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1154 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1155 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1156 struct berval be_rootpw; /* the magic "root" password for this db */
1157 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1158 #define be_sizelimit be_def_limit.lms_s_soft
1159 #define be_timelimit be_def_limit.lms_t_soft
1160 struct slap_limits_set be_def_limit; /* default limits */
1161 struct slap_limits **be_limits; /* regex-based size and time limits */
1162 AccessControl *be_acl; /* access control list for this backend */
1163 slap_access_t be_dfltaccess; /* access given if no acl matches */
1164 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1165 char *be_replogfile; /* replication log file (in master) */
1166 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1167 BerVarray be_update_refs; /* where to refer modifying clients to */
1169 void *be_private; /* anything the backend database needs */
1175 /* Backend function typedefs */
1176 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1177 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1178 const char *fname, int lineno,
1179 int argc, char **argv));
1180 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1181 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1182 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1184 typedef int (BI_db_init) LDAP_P((Backend *bd));
1185 typedef int (BI_db_config) LDAP_P((Backend *bd,
1186 const char *fname, int lineno,
1187 int argc, char **argv));
1188 typedef int (BI_db_open) LDAP_P((Backend *bd));
1189 typedef int (BI_db_close) LDAP_P((Backend *bd));
1190 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1192 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1193 struct slap_conn *c, struct slap_op *o,
1194 struct berval *dn, struct berval *ndn, int method,
1195 struct berval *cred, struct berval *edn ));
1196 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1197 struct slap_conn *c, struct slap_op *o ));
1198 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1199 struct slap_conn *c, struct slap_op *o,
1200 struct berval *base, struct berval *nbase,
1201 int scope, int deref,
1202 int slimit, int tlimit,
1203 Filter *f, struct berval *filterstr,
1204 AttributeName *attrs, int attrsonly));
1205 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1206 struct slap_conn *c, struct slap_op *o,
1207 struct berval *dn, struct berval *ndn,
1208 AttributeAssertion *ava));
1209 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1210 struct slap_conn *c, struct slap_op *o,
1211 struct berval *dn, struct berval *ndn,
1213 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1214 struct slap_conn *c, struct slap_op *o,
1215 struct berval *dn, struct berval *ndn,
1216 struct berval *newrdn, struct berval *nnewrdn,
1218 struct berval *newSup, struct berval *nnewSup ));
1219 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1220 struct slap_conn *c, struct slap_op *o,
1222 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1223 struct slap_conn *c, struct slap_op *o,
1224 struct berval *dn, struct berval *ndn));
1225 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1226 struct slap_conn *c, struct slap_op *o,
1229 typedef int (BI_op_extended) LDAP_P((
1231 struct slap_conn *conn,
1234 struct berval * reqdata,
1236 struct berval ** rspdata,
1237 LDAPControl *** rspctrls,
1241 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1242 struct slap_conn *c, struct slap_op *o,
1245 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1246 struct slap_conn *c, struct slap_op *o,
1247 struct berval *dn, struct berval *ndn,
1248 const char **text ));
1250 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1251 struct slap_conn *c, struct slap_op *o,
1255 ObjectClass *group_oc,
1256 AttributeDescription *group_at ));
1258 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1259 struct slap_conn *c, struct slap_op *o,
1260 Entry *e, struct berval *edn,
1261 AttributeDescription *entry_at,
1264 typedef int (BI_operational) LDAP_P((Backend *bd,
1265 struct slap_conn *c, struct slap_op *o,
1266 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1268 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1269 struct slap_conn *c));
1270 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1271 struct slap_conn *c));
1273 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1274 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1275 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1276 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1277 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1278 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1279 struct berval *text ));
1280 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1281 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1283 struct slap_backend_info {
1284 char *bi_type; /* type of backend */
1287 * per backend type routines:
1288 * bi_init: called to allocate a backend_info structure,
1289 * called once BEFORE configuration file is read.
1290 * bi_init() initializes this structure hence is
1291 * called directly from be_initialize()
1292 * bi_config: called per 'backend' specific option
1293 * all such options must before any 'database' options
1294 * bi_config() is called only from read_config()
1295 * bi_open: called to open each database, called
1296 * once AFTER configuration file is read but
1297 * BEFORE any bi_db_open() calls.
1298 * bi_open() is called from backend_startup()
1299 * bi_close: called to close each database, called
1300 * once during shutdown after all bi_db_close calls.
1301 * bi_close() is called from backend_shutdown()
1302 * bi_destroy: called to destroy each database, called
1303 * once during shutdown after all bi_db_destroy calls.
1304 * bi_destory() is called from backend_destroy()
1307 BI_config *bi_config;
1310 BI_destroy *bi_destroy;
1313 * per database routines:
1314 * bi_db_init: called to initialize each database,
1315 * called upon reading 'database <type>'
1316 * called only from backend_db_init()
1317 * bi_db_config: called to configure each database,
1318 * called per database to handle per database options
1319 * called only from read_config()
1320 * bi_db_open: called to open each database
1321 * called once per database immediately AFTER bi_open()
1322 * calls but before daemon startup.
1323 * called only by backend_startup()
1324 * bi_db_close: called to close each database
1325 * called once per database during shutdown but BEFORE
1326 * any bi_close call.
1327 * called only by backend_shutdown()
1328 * bi_db_destroy: called to destroy each database
1329 * called once per database during shutdown AFTER all
1330 * bi_close calls but before bi_destory calls.
1331 * called only by backend_destory()
1333 BI_db_init *bi_db_init;
1334 BI_db_config *bi_db_config;
1335 BI_db_open *bi_db_open;
1336 BI_db_close *bi_db_close;
1337 BI_db_destroy *bi_db_destroy;
1339 /* LDAP Operations Handling Routines */
1340 BI_op_bind *bi_op_bind;
1341 BI_op_unbind *bi_op_unbind;
1342 BI_op_search *bi_op_search;
1343 BI_op_compare *bi_op_compare;
1344 BI_op_modify *bi_op_modify;
1345 BI_op_modrdn *bi_op_modrdn;
1346 BI_op_add *bi_op_add;
1347 BI_op_delete *bi_op_delete;
1348 BI_op_abandon *bi_op_abandon;
1350 /* Extended Operations Helper */
1351 BI_op_extended *bi_extended;
1353 /* Auxilary Functions */
1354 BI_entry_release_rw *bi_entry_release_rw;
1355 BI_chk_referrals *bi_chk_referrals;
1357 BI_acl_group *bi_acl_group;
1358 BI_acl_attribute *bi_acl_attribute;
1360 BI_operational *bi_operational;
1362 BI_connection_init *bi_connection_init;
1363 BI_connection_destroy *bi_connection_destroy;
1365 /* hooks for slap tools */
1366 BI_tool_entry_open *bi_tool_entry_open;
1367 BI_tool_entry_close *bi_tool_entry_close;
1368 BI_tool_entry_first *bi_tool_entry_first;
1369 BI_tool_entry_next *bi_tool_entry_next;
1370 BI_tool_entry_get *bi_tool_entry_get;
1371 BI_tool_entry_put *bi_tool_entry_put;
1372 BI_tool_entry_reindex *bi_tool_entry_reindex;
1373 BI_tool_sync *bi_tool_sync;
1375 #define SLAP_INDEX_ADD_OP 0x0001
1376 #define SLAP_INDEX_DELETE_OP 0x0002
1378 char **bi_controls; /* supported controls */
1380 unsigned int bi_nDB; /* number of databases of this type */
1381 void *bi_private; /* anything the backend type needs */
1384 #define c_authtype c_authz.sai_method
1385 #define c_authmech c_authz.sai_mech
1386 #define c_dn c_authz.sai_dn
1387 #define c_ndn c_authz.sai_ndn
1388 #define c_ssf c_authz.sai_ssf
1389 #define c_transport_ssf c_authz.sai_transport_ssf
1390 #define c_tls_ssf c_authz.sai_tls_ssf
1391 #define c_sasl_ssf c_authz.sai_sasl_ssf
1393 #define o_authtype o_authz.sai_method
1394 #define o_authmech o_authz.sai_mech
1395 #define o_dn o_authz.sai_dn
1396 #define o_ndn o_authz.sai_ndn
1397 #define o_ssf o_authz.sai_ssf
1398 #define o_transport_ssf o_authz.sai_transport_ssf
1399 #define o_tls_ssf o_authz.sai_tls_ssf
1400 #define o_sasl_ssf o_authz.sai_sasl_ssf
1402 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1403 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1404 BerVarray, const char *, struct berval *,
1405 struct berval *, LDAPControl ** );
1407 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1408 ber_int_t, const char *, const char *, BerVarray,
1409 LDAPControl **, int nentries);
1411 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1412 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1414 typedef struct slap_callback {
1415 slap_response *sc_response;
1416 slap_sresult *sc_sresult;
1417 slap_sendentry *sc_sendentry;
1422 * Paged Results state
1424 typedef unsigned long PagedResultsCookie;
1425 typedef struct slap_paged_state {
1427 PagedResultsCookie ps_cookie;
1429 } PagedResultsState;
1432 * represents an operation pending from an ldap client
1434 typedef struct slap_op {
1435 unsigned long o_opid; /* id of this operation */
1436 unsigned long o_connid; /* id of conn initiating this op */
1438 ber_int_t o_msgid; /* msgid of the request */
1439 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1440 ber_tag_t o_tag; /* tag of the request */
1441 time_t o_time; /* time op was initiated */
1443 ldap_pvt_thread_t o_tid; /* thread handling this op */
1445 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1446 char o_abandon; /* abandon flag */
1448 #define SLAP_NO_CONTROL 0
1449 #define SLAP_NONCRITICAL_CONTROL 1
1450 #define SLAP_CRITICAL_CONTROL 2
1454 char o_subentries_visibility;
1456 char o_pagedresults;
1457 ber_int_t o_pagedresults_size;
1458 PagedResultsState o_pagedresults_state;
1460 #ifdef LDAP_CONNECTIONLESS
1461 Sockaddr o_peeraddr; /* UDP peer address */
1463 AuthorizationInformation o_authz;
1465 BerElement *o_ber; /* ber of the request */
1466 slap_callback *o_callback; /* callback pointers */
1467 LDAPControl **o_ctrls; /* controls */
1469 void *o_private; /* anything the backend needs */
1471 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1474 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1475 #define get_subentries(op) ((int)(op)->o_subentries)
1476 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1479 * Caches the result of a backend_group check for ACL evaluation
1481 typedef struct slap_gacl {
1482 struct slap_gacl *ga_next;
1485 AttributeDescription *ga_at;
1492 * represents a connection from an ldap client
1494 typedef struct slap_conn {
1495 int c_struct_state; /* structure management state */
1496 int c_conn_state; /* connection state */
1498 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1499 Sockbuf *c_sb; /* ber connection stuff */
1501 /* only can be changed by connect_init */
1502 time_t c_starttime; /* when the connection was opened */
1503 time_t c_activitytime; /* when the connection was last used */
1504 unsigned long c_connid; /* id of this connection for stats*/
1506 struct berval c_listener_url; /* listener URL */
1507 struct berval c_peer_domain; /* DNS name of client */
1508 struct berval c_peer_name; /* peer name (trans=addr:port) */
1509 struct berval c_sock_name; /* sock name (trans=addr:port) */
1511 /* only can be changed by binding thread */
1512 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1513 struct berval c_sasl_bind_mech; /* mech in progress */
1514 struct berval c_cdn;
1516 /* authorization backend */
1517 Backend *c_authz_backend;
1519 AuthorizationInformation c_authz;
1520 GroupAssertion *c_groups;
1522 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1524 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1525 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1527 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1528 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1530 BerElement *c_currentber; /* ber we're attempting to read */
1531 int c_writewaiter; /* true if writer is waiting */
1533 #ifdef LDAP_CONNECTIONLESS
1534 int c_is_udp; /* true if this is (C)LDAP over UDP */
1537 int c_is_tls; /* true if this LDAP over raw TLS */
1538 int c_needs_tls_accept; /* true if SSL_accept should be called */
1540 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1541 void *c_sasl_context; /* SASL session context */
1542 void *c_sasl_extra; /* SASL session extra stuff */
1544 PagedResultsState c_pagedresults_state; /* paged result state */
1546 long c_n_ops_received; /* num of ops received (next op_id) */
1547 long c_n_ops_executing; /* num of ops currently executing */
1548 long c_n_ops_pending; /* num of ops pending execution */
1549 long c_n_ops_completed; /* num of ops completed */
1551 long c_n_get; /* num of get calls */
1552 long c_n_read; /* num of read calls */
1553 long c_n_write; /* num of write calls */
1556 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1557 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1559 if ( ldap_debug & (level) ) \
1560 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1561 if ( ldap_syslog & (level) ) \
1562 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1566 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1570 #define SASLREGEX_REPLACE 10
1571 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1572 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1574 typedef struct sasl_regexp {
1575 char *sr_match; /* regexp match pattern */
1576 char *sr_replace; /* regexp replace pattern */
1577 regex_t sr_workspace; /* workspace for regexp engine */
1578 regmatch_t sr_strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1579 int sr_offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1583 * listener; need to access it from monitor backend
1585 typedef struct slap_listener {
1591 #ifdef LDAP_CONNECTIONLESS
1592 int sl_is_udp; /* UDP listener is also data port */
1596 #define sl_addr sl_sa.sa_in_addr
1599 #ifdef SLAPD_MONITOR
1616 #endif /* SLAPD_MONITOR */
1620 #include "proto-slap.h"
1622 #endif /* _SLAP_H_ */