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/signal.h>
20 #include <ac/socket.h>
27 #define ldap_debug slap_debug
33 #include <ldap_schema.h>
35 #include "ldap_pvt_thread.h"
36 #include "ldap_queue.h"
40 * SLAPD Memory allocation macros
42 * Unlike ch_*() routines, these routines do not assert() upon
43 * allocation error. They are intended to be used instead of
44 * ch_*() routines where the caller has implemented proper
45 * checking for and handling of allocation errors.
47 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
49 #define SLAP_MALLOC(s) ber_memalloc((s))
50 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
51 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
52 #define SLAP_FREE(p) ber_memfree((p))
53 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
54 #define SLAP_STRDUP(s) ber_strdup((s))
55 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
58 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
61 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
62 #define SLAPD_ANONYMOUS "cn=anonymous"
64 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
66 * This is a value used internally by the backends. It is needed to allow
67 * adding values that already exist without getting an error as required by
68 * modrdn when the new rdn was already an attribute value itself.
69 * JCG 05/1999 (gomez@engr.sgi.com)
71 #define SLAP_MOD_SOFTADD 0x1000
73 #define MAXREMATCHES (100)
75 #define SLAP_MAX_WORKER_THREADS (32)
77 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
78 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
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 #ifdef SLAPD_ACI_ENABLED
141 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
144 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
146 /* change this to "OpenLDAPset" */
147 #define SLAPD_ACI_SET_ATTR "template"
149 #define SLAPD_TOP_OID "2.5.6.0"
151 LDAP_SLAPD_V (int) slap_debug;
153 typedef unsigned long slap_mask_t;
155 /* Security Strength Factor */
156 typedef unsigned slap_ssf_t;
158 typedef struct slap_ssf_set {
160 slap_ssf_t sss_transport;
163 slap_ssf_t sss_update_ssf;
164 slap_ssf_t sss_update_transport;
165 slap_ssf_t sss_update_tls;
166 slap_ssf_t sss_update_sasl;
172 #define SLAP_INDEX_TYPE 0x00FFUL
173 #define SLAP_INDEX_UNDEFINED 0x0001UL
174 #define SLAP_INDEX_PRESENT 0x0002UL
175 #define SLAP_INDEX_EQUALITY 0x0004UL
176 #define SLAP_INDEX_APPROX 0x0008UL
177 #define SLAP_INDEX_SUBSTR 0x0010UL
178 #define SLAP_INDEX_EXTENDED 0x0020UL
180 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
182 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
184 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
186 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
187 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
188 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
189 #define SLAP_INDEX_SUBSTR_DEFAULT \
190 ( SLAP_INDEX_SUBSTR \
191 | SLAP_INDEX_SUBSTR_INITIAL \
192 | SLAP_INDEX_SUBSTR_ANY \
193 | SLAP_INDEX_SUBSTR_FINAL )
195 #define SLAP_INDEX_SUBSTR_MINLEN 2
196 #define SLAP_INDEX_SUBSTR_MAXLEN 4
197 #define SLAP_INDEX_SUBSTR_STEP 2
199 #define SLAP_INDEX_FLAGS 0xF000UL
200 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
201 #define SLAP_INDEX_NOLANG 0x2000UL /* don't use index w/ lang */
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 */
214 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
215 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
216 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
219 * represents schema information for a database
221 #define SLAP_SCHERR_OUTOFMEM 1
222 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
223 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
224 #define SLAP_SCHERR_ATTR_NOT_FOUND 4
225 #define SLAP_SCHERR_ATTR_BAD_USAGE 5
226 #define SLAP_SCHERR_DUP_CLASS 6
227 #define SLAP_SCHERR_DUP_ATTR 7
228 #define SLAP_SCHERR_DUP_SYNTAX 8
229 #define SLAP_SCHERR_DUP_RULE 9
230 #define SLAP_SCHERR_NO_NAME 10
231 #define SLAP_SCHERR_ATTR_INCOMPLETE 11
232 #define SLAP_SCHERR_MR_NOT_FOUND 12
233 #define SLAP_SCHERR_SYN_NOT_FOUND 13
234 #define SLAP_SCHERR_MR_INCOMPLETE 14
235 #define SLAP_SCHERR_NOT_SUPPORTED 15
236 #define SLAP_SCHERR_BAD_DESCR 16
237 #define SLAP_SCHERR_OIDM 17
238 #define SLAP_SCHERR_LAST SLAP_SCHERR_OIDM
240 typedef union slap_sockaddr {
241 struct sockaddr sa_addr;
242 struct sockaddr_in sa_in_addr;
244 struct sockaddr_in6 sa_in6_addr;
247 struct sockaddr_un sa_un_addr;
251 typedef struct slap_oid_macro {
252 struct berval som_oid;
254 struct slap_oid_macro *som_next;
257 /* forward declarations */
259 struct slap_matching_rule;
261 typedef int slap_syntax_validate_func LDAP_P((
262 struct slap_syntax *syntax,
263 struct berval * in));
265 typedef int slap_syntax_transform_func LDAP_P((
266 struct slap_syntax *syntax,
268 struct berval * out));
270 typedef struct slap_syntax {
272 #define ssyn_oid ssyn_syn.syn_oid
273 #define ssyn_desc ssyn_syn.syn_desc
274 #define ssyn_extensions ssyn_syn.syn_extensions
275 ber_len_t ssyn_oidlen;
277 unsigned int ssyn_flags;
279 #define SLAP_SYNTAX_NONE 0x0000U
280 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
281 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
282 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
283 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
285 slap_syntax_validate_func *ssyn_validate;
286 slap_syntax_transform_func *ssyn_normalize;
287 slap_syntax_transform_func *ssyn_pretty;
289 #ifdef SLAPD_BINARY_CONVERSION
290 /* convert to and from binary */
291 slap_syntax_transform_func *ssyn_ber2str;
292 slap_syntax_transform_func *ssyn_str2ber;
295 struct slap_syntax *ssyn_next;
298 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
299 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
300 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
301 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
302 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
304 /* X -> Y Converter */
305 typedef int slap_mr_convert_func LDAP_P((
307 struct berval * out ));
310 typedef int slap_mr_normalize_func LDAP_P((
312 struct slap_syntax *syntax, /* NULL if in is asserted value */
313 struct slap_matching_rule *mr,
315 struct berval * out ));
317 /* Match (compare) function */
318 typedef int slap_mr_match_func LDAP_P((
321 struct slap_syntax *syntax, /* syntax of stored value */
322 struct slap_matching_rule *mr,
323 struct berval * value,
324 void * assertValue ));
326 /* Index generation function */
327 typedef int slap_mr_indexer_func LDAP_P((
330 struct slap_syntax *syntax, /* syntax of stored value */
331 struct slap_matching_rule *mr,
332 struct berval *prefix,
336 /* Filter index function */
337 typedef int slap_mr_filter_func LDAP_P((
340 struct slap_syntax *syntax, /* syntax of stored value */
341 struct slap_matching_rule *mr,
342 struct berval *prefix,
346 typedef struct slap_matching_rule {
347 LDAPMatchingRule smr_mrule;
348 ber_len_t smr_oidlen;
349 slap_mask_t smr_usage;
351 #define SLAP_MR_HIDE 0x8000U
353 #define SLAP_MR_TYPE_MASK 0x0F00U
354 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
355 #define SLAP_MR_USAGE 0x000FU
357 #define SLAP_MR_NONE 0x0000U
358 #define SLAP_MR_EQUALITY 0x0100U
359 #define SLAP_MR_ORDERING 0x0200U
360 #define SLAP_MR_SUBSTR 0x0400U
361 #define SLAP_MR_EXT 0x0800U
363 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
364 #define SLAP_MR_DN_FOLD 0x0008U
366 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
367 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
368 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
371 * normally the provided value is expected to conform to
372 * assertion syntax specified in the matching rule, however
373 * at times (such as during individual value modification),
374 * the provided value is expected to conform to the
375 * attribute's value syntax.
377 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
378 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
379 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
381 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
382 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
383 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
384 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
386 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
387 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
388 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
389 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
390 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
391 == SLAP_MR_VALUE_SYNTAX_MATCH)
394 slap_mr_convert_func *smr_convert;
395 slap_mr_normalize_func *smr_normalize;
396 slap_mr_match_func *smr_match;
397 slap_mr_indexer_func *smr_indexer;
398 slap_mr_filter_func *smr_filter;
400 struct slap_matching_rule *smr_associated;
401 struct slap_matching_rule *smr_next;
403 #define smr_oid smr_mrule.mr_oid
404 #define smr_names smr_mrule.mr_names
405 #define smr_desc smr_mrule.mr_desc
406 #define smr_obsolete smr_mrule.mr_obsolete
407 #define smr_syntax_oid smr_mrule.mr_syntax_oid
408 #define smr_extensions smr_mrule.mr_extensions
411 struct slap_backend_db;
415 typedef int (AttributeTypeSchemaCheckFN)(
416 struct slap_backend_db *be,
417 struct slap_entry *e,
418 struct slap_attr *attr,
420 char *textbuf, size_t textlen );
422 typedef struct slap_attribute_type {
423 LDAPAttributeType sat_atype;
424 struct berval sat_cname;
425 struct slap_attribute_type *sat_sup;
426 struct slap_attribute_type **sat_subtypes;
427 MatchingRule *sat_equality;
428 MatchingRule *sat_approx;
429 MatchingRule *sat_ordering;
430 MatchingRule *sat_substr;
433 AttributeTypeSchemaCheckFN *sat_check;
434 slap_mask_t sat_flags;
436 struct slap_attribute_type *sat_next;
438 #define sat_oid sat_atype.at_oid
439 #define sat_names sat_atype.at_names
440 #define sat_desc sat_atype.at_desc
441 #define sat_obsolete sat_atype.at_obsolete
442 #define sat_sup_oid sat_atype.at_sup_oid
443 #define sat_equality_oid sat_atype.at_equality_oid
444 #define sat_ordering_oid sat_atype.at_ordering_oid
445 #define sat_substr_oid sat_atype.at_substr_oid
446 #define sat_syntax_oid sat_atype.at_syntax_oid
447 #define sat_single_value sat_atype.at_single_value
448 #define sat_collective sat_atype.at_collective
449 #define sat_no_user_mod sat_atype.at_no_user_mod
450 #define sat_usage sat_atype.at_usage
451 #define sat_extensions sat_atype.at_extensions
453 struct slap_attr_desc *sat_ad;
454 ldap_pvt_thread_mutex_t sat_ad_mutex;
457 #define is_at_operational(at) ((at)->sat_usage)
458 #define is_at_single_value(at) ((at)->sat_single_value)
459 #define is_at_collective(at) ((at)->sat_collective)
460 #define is_at_obsolete(at) ((at)->sat_obsolete)
461 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
463 struct slap_object_class;
465 typedef int (ObjectClassSchemaCheckFN)(
466 struct slap_backend_db *be,
467 struct slap_entry *e,
468 struct slap_object_class *oc,
470 char *textbuf, size_t textlen );
472 typedef struct slap_object_class {
473 LDAPObjectClass soc_oclass;
474 struct slap_object_class **soc_sups;
475 AttributeType **soc_required;
476 AttributeType **soc_allowed;
477 ObjectClassSchemaCheckFN *soc_check;
478 slap_mask_t soc_flags;
479 #define soc_oid soc_oclass.oc_oid
480 #define soc_names soc_oclass.oc_names
481 #define soc_desc soc_oclass.oc_desc
482 #define soc_obsolete soc_oclass.oc_obsolete
483 #define soc_sup_oids soc_oclass.oc_sup_oids
484 #define soc_kind soc_oclass.oc_kind
485 #define soc_at_oids_must soc_oclass.oc_at_oids_must
486 #define soc_at_oids_may soc_oclass.oc_at_oids_may
487 #define soc_extensions soc_oclass.oc_extensions
489 struct slap_object_class *soc_next;
492 #define SLAP_OC_ALIAS 0x01
493 #define SLAP_OC_REFERRAL 0x02
494 #define SLAP_OC_SUBENTRY 0x04
495 #define SLAP_OC_DYNAMICOBJECT 0x08
496 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x10
497 #define SLAP_OC__MASK 0x1F
498 #define SLAP_OC__END 0x20
500 #ifdef LDAP_EXTENDED_SCHEMA
504 typedef struct slap_content_rule {
505 LDAPContentRule scr_crule;
506 ObjectClass *scr_sclass;
507 ObjectClass **scr_auxiliaries; /* optional */
508 AttributeType **scr_required; /* optional */
509 AttributeType **scr_allowed; /* optional */
510 AttributeType **scr_precluded; /* optional */
511 #define scr_oid scr_crule.cr_oid
512 #define scr_names scr_crule.cr_names
513 #define scr_desc scr_crule.cr_desc
514 #define scr_obsolete soc_oclass.cr_obsolete
515 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
516 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
517 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
518 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
523 * represents a recognized attribute description ( type + options )
525 typedef struct slap_attr_desc {
526 struct slap_attr_desc *ad_next;
527 AttributeType *ad_type; /* attribute type, must be specified */
528 struct berval ad_cname; /* canonical name, must be specified */
529 struct berval ad_lang; /* empty if no language tags */
531 #define SLAP_DESC_NONE 0x00U
532 #define SLAP_DESC_BINARY 0x01U
533 #define SLAP_DESC_LANG_RANGE 0x80U
534 } AttributeDescription;
536 typedef struct slap_attr_name {
537 struct berval an_name;
538 AttributeDescription *an_desc;
542 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
543 #define slap_ad_is_lang_range(ad) \
544 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
545 #define slap_ad_is_binary(ad) \
546 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
549 * pointers to schema elements used internally
551 struct slap_internal_schema {
553 ObjectClass *si_oc_top;
554 ObjectClass *si_oc_extensibleObject;
555 ObjectClass *si_oc_alias;
556 ObjectClass *si_oc_referral;
557 ObjectClass *si_oc_rootdse;
558 ObjectClass *si_oc_subentry;
559 ObjectClass *si_oc_subschema;
560 ObjectClass *si_oc_monitor;
562 /* objectClass attribute descriptions */
563 AttributeDescription *si_ad_objectClass;
565 /* operational attribute descriptions */
566 AttributeDescription *si_ad_structuralObjectClass;
567 AttributeDescription *si_ad_creatorsName;
568 AttributeDescription *si_ad_createTimestamp;
569 AttributeDescription *si_ad_modifiersName;
570 AttributeDescription *si_ad_modifyTimestamp;
571 AttributeDescription *si_ad_hasSubordinates;
572 AttributeDescription *si_ad_subschemaSubentry;
574 /* root DSE attribute descriptions */
575 AttributeDescription *si_ad_altServer;
576 AttributeDescription *si_ad_namingContexts;
577 AttributeDescription *si_ad_supportedControl;
578 AttributeDescription *si_ad_supportedExtension;
579 AttributeDescription *si_ad_supportedLDAPVersion;
580 AttributeDescription *si_ad_supportedSASLMechanisms;
581 AttributeDescription *si_ad_supportedFeatures;
582 AttributeDescription *si_ad_vendorName;
583 AttributeDescription *si_ad_vendorVersion;
585 /* subentry attribute descriptions */
586 AttributeDescription *si_ad_administrativeRole;
587 AttributeDescription *si_ad_subtreeSpecification;
589 /* subschema subentry attribute descriptions */
590 AttributeDescription *si_ad_ditStructureRules;
591 AttributeDescription *si_ad_ditContentRules;
592 AttributeDescription *si_ad_nameForms;
593 AttributeDescription *si_ad_objectClasses;
594 AttributeDescription *si_ad_attributeTypes;
595 AttributeDescription *si_ad_ldapSyntaxes;
596 AttributeDescription *si_ad_matchingRules;
597 AttributeDescription *si_ad_matchingRuleUse;
599 /* Aliases & Referrals */
600 AttributeDescription *si_ad_aliasedObjectName;
601 AttributeDescription *si_ad_ref;
603 /* Access Control Internals */
604 AttributeDescription *si_ad_entry;
605 AttributeDescription *si_ad_children;
606 #ifdef SLAPD_ACI_ENABLED
607 AttributeDescription *si_ad_aci;
610 /* Other attributes descriptions */
611 AttributeDescription *si_ad_distinguishedName;
612 AttributeDescription *si_ad_name;
613 AttributeDescription *si_ad_cn;
614 AttributeDescription *si_ad_userPassword;
615 #ifdef SLAPD_AUTHPASSWD
616 AttributeDescription *si_ad_authPassword;
618 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
619 AttributeDescription *si_ad_krbName;
622 /* Undefined Attribute Type */
623 AttributeType *si_at_undefined;
626 MatchingRule *si_mr_distinguishedNameMatch;
627 MatchingRule *si_mr_integerMatch;
630 Syntax *si_syn_octetString;
631 Syntax *si_syn_distinguishedName;
632 Syntax *si_syn_integer;
635 typedef struct slap_attr_assertion {
636 AttributeDescription *aa_desc;
637 struct berval aa_value;
638 } AttributeAssertion;
640 typedef struct slap_ss_assertion {
641 AttributeDescription *sa_desc;
642 struct berval sa_initial;
643 struct berval *sa_any;
644 struct berval sa_final;
645 } SubstringsAssertion;
647 typedef struct slap_mr_assertion {
648 MatchingRule *ma_rule; /* optional */
649 struct berval ma_rule_text; /* optional */
650 AttributeDescription *ma_desc; /* optional */
651 int ma_dnattrs; /* boolean */
652 struct berval ma_value; /* required */
653 } MatchingRuleAssertion;
656 * represents a search filter
658 typedef struct slap_filter {
659 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
660 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
661 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
662 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
665 /* precomputed result */
666 ber_int_t f_un_result;
669 struct berval *f_un_dn;
672 AttributeDescription *f_un_desc;
674 /* simple value assertion */
675 AttributeAssertion *f_un_ava;
677 /* substring assertion */
678 SubstringsAssertion *f_un_ssa;
680 /* matching rule assertion */
681 MatchingRuleAssertion *f_un_mra;
683 #define f_dn f_un.f_un_dn
684 #define f_desc f_un.f_un_desc
685 #define f_ava f_un.f_un_ava
686 #define f_av_desc f_un.f_un_ava->aa_desc
687 #define f_av_value f_un.f_un_ava->aa_value
688 #define f_sub f_un.f_un_ssa
689 #define f_sub_desc f_un.f_un_ssa->sa_desc
690 #define f_sub_initial f_un.f_un_ssa->sa_initial
691 #define f_sub_any f_un.f_un_ssa->sa_any
692 #define f_sub_final f_un.f_un_ssa->sa_final
693 #define f_mra f_un.f_un_mra
694 #define f_mr_rule f_un.f_un_mra->ma_rule
695 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
696 #define f_mr_desc f_un.f_un_mra->ma_desc
697 #define f_mr_value f_un.f_un_mra->ma_value
698 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
701 struct slap_filter *f_un_complex;
704 #define f_result f_un.f_un_result
705 #define f_and f_un.f_un_complex
706 #define f_or f_un.f_un_complex
707 #define f_not f_un.f_un_complex
708 #define f_list f_un.f_un_complex
710 struct slap_filter *f_next;
713 /* compare routines can return undefined */
714 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
716 typedef struct slap_valuesreturnfilter {
720 /* precomputed result */
721 ber_int_t f_un_result;
727 AttributeDescription *f_un_desc;
729 /* simple value assertion */
730 AttributeAssertion *f_un_ava;
732 /* substring assertion */
733 SubstringsAssertion *f_un_ssa;
735 /* matching rule assertion */
736 MatchingRuleAssertion *f_un_mra;
739 struct slap_valuesreturnfilter *f_next;
740 } ValuesReturnFilter;
743 * represents an attribute (description + values)
745 typedef struct slap_attr {
746 AttributeDescription *a_desc;
748 struct slap_attr *a_next;
750 #define SLAP_ATTR_IXADD 0x1U
751 #define SLAP_ATTR_IXDEL 0x2U
756 * the id used in the indexes to refer to an entry
758 typedef unsigned long ID;
759 #define NOID ((ID)~0)
762 * represents an entry in core
764 typedef struct slap_entry {
766 * The ID field should only be changed before entry is
767 * inserted into a cache. The ID value is backend
772 struct berval e_name; /* name (DN) of this entry */
773 struct berval e_nname; /* normalized name (DN) of this entry */
775 /* for migration purposes */
776 #define e_dn e_name.bv_val
777 #define e_ndn e_nname.bv_val
779 Attribute *e_attrs; /* list of attributes + values */
781 slap_mask_t e_ocflags;
783 struct berval e_bv; /* For entry_encode/entry_decode */
785 /* for use by the backend for any purpose */
792 typedef struct slap_mod {
794 AttributeDescription *sm_desc;
795 struct berval sm_type;
796 BerVarray sm_bvalues;
799 typedef struct slap_mod_list {
800 Modification sml_mod;
801 #define sml_op sml_mod.sm_op
802 #define sml_desc sml_mod.sm_desc
803 #define sml_type sml_mod.sm_type
804 #define sml_bvalues sml_mod.sm_bvalues
805 struct slap_mod_list *sml_next;
808 typedef struct slap_ldap_modlist {
810 struct slap_ldap_modlist *ml_next;
811 #define ml_op ml_mod.mod_op
812 #define ml_type ml_mod.mod_type
813 #define ml_values ml_mod.mod_values
814 #define ml_bvalues ml_mod.mod_bvalues
818 * represents an access control list
820 typedef enum slap_access_e {
821 ACL_INVALID_ACCESS = -1,
830 typedef enum slap_control_e {
831 ACL_INVALID_CONTROL = 0,
837 typedef enum slap_style_e {
845 /* alternate names */
846 ACL_STYLE_EXACT = ACL_STYLE_BASE
849 typedef struct slap_authz_info {
850 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
851 struct berval sai_mech; /* SASL Mechanism */
852 struct berval sai_dn; /* DN for reporting purposes */
853 struct berval sai_ndn; /* Normalized DN */
855 /* Security Strength Factors */
856 slap_ssf_t sai_ssf; /* Overall SSF */
857 slap_ssf_t sai_transport_ssf; /* Transport SSF */
858 slap_ssf_t sai_tls_ssf; /* TLS SSF */
859 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
860 } AuthorizationInformation;
863 typedef struct slap_access {
864 slap_control_t a_type;
866 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
868 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
869 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
870 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
871 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
872 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
873 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
875 #define ACL_PRIV_MASK 0x00ffUL
878 #define ACL_PRIV_LEVEL 0x1000UL
879 #define ACL_PRIV_ADDITIVE 0x2000UL
880 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
883 #define ACL_PRIV_INVALID 0x0UL
885 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
886 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
887 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
888 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
890 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
891 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
893 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
895 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
897 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
898 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
899 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
901 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
902 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
903 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
904 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
905 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
906 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
908 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
909 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
910 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
911 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
912 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
913 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
914 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
916 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
917 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
918 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
919 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
920 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
921 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
923 slap_mask_t a_access_mask;
925 AuthorizationInformation a_authz;
926 #define a_dn_pat a_authz.sai_dn
928 slap_style_t a_dn_style;
929 AttributeDescription *a_dn_at;
933 slap_style_t a_peername_style;
934 struct berval a_peername_pat;
935 slap_style_t a_sockname_style;
936 struct berval a_sockname_pat;
938 slap_style_t a_domain_style;
939 struct berval a_domain_pat;
942 slap_style_t a_sockurl_style;
943 struct berval a_sockurl_pat;
944 slap_style_t a_set_style;
945 struct berval a_set_pat;
947 #ifdef SLAPD_ACI_ENABLED
948 AttributeDescription *a_aci_at;
952 slap_style_t a_group_style;
953 struct berval a_group_pat;
954 ObjectClass *a_group_oc;
955 AttributeDescription *a_group_at;
957 struct slap_access *a_next;
961 typedef struct slap_acl {
962 /* "to" part: the entries this acl applies to */
964 slap_style_t acl_dn_style;
966 struct berval acl_dn_pat;
967 AttributeName *acl_attrs;
969 /* "by" part: list of who has what access to the entries */
972 struct slap_acl *acl_next;
975 typedef struct slap_acl_state {
976 unsigned as_recorded;
977 #define ACL_STATE_NOT_RECORDED 0x0
978 #define ACL_STATE_RECORDED_VD 0x1
979 #define ACL_STATE_RECORDED_NV 0x2
980 #define ACL_STATE_RECORDED 0x3
983 AccessControl *as_vd_acl;
984 slap_mask_t as_vd_acl_mask;
985 regmatch_t as_vd_acl_matches[MAXREMATCHES];
988 Access *as_vd_access;
989 int as_vd_access_count;
992 } AccessControlState;
993 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
996 * replog moddn param structure
998 struct slap_replog_moddn {
999 struct berval *newrdn;
1001 struct berval *newsup;
1006 * represents a backend
1009 typedef struct slap_backend_info BackendInfo; /* per backend type */
1010 typedef struct slap_backend_db BackendDB; /* per backend database */
1012 LDAP_SLAPD_V (int) nBackendInfo;
1013 LDAP_SLAPD_V (int) nBackendDB;
1014 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1015 LDAP_SLAPD_V (BackendDB *) backendDB;
1017 LDAP_SLAPD_V (int) slapMode;
1018 #define SLAP_UNDEFINED_MODE 0x0000
1019 #define SLAP_SERVER_MODE 0x0001
1020 #define SLAP_TOOL_MODE 0x0002
1021 #define SLAP_MODE 0x0003
1023 #define SLAP_TRUNCATE_MODE 0x0100
1025 struct slap_replica_info {
1026 char *ri_host; /* supersedes be_replica */
1027 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1028 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1029 int ri_exclude; /* 1 => exclude ri_attrs */
1032 struct slap_limits_set {
1040 int lms_s_unchecked;
1043 struct slap_limits {
1044 int lm_type; /* type of pattern */
1045 #define SLAP_LIMITS_UNDEFINED 0x0000
1046 #define SLAP_LIMITS_EXACT 0x0001
1047 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1048 #define SLAP_LIMITS_ONE 0x0002
1049 #define SLAP_LIMITS_SUBTREE 0x0003
1050 #define SLAP_LIMITS_CHILDREN 0x0004
1051 #define SLAP_LIMITS_REGEX 0x0005
1052 #define SLAP_LIMITS_ANONYMOUS 0x0006
1053 #define SLAP_LIMITS_USERS 0x0007
1054 #define SLAP_LIMITS_ANY 0x0008
1055 regex_t lm_dn_regex; /* regex data for REGEX */
1058 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1059 * pattern for REGEX; NULL for ANONYMOUS, USERS
1061 struct berval lm_dn_pat;
1063 struct slap_limits_set lm_limits;
1066 /* temporary aliases */
1067 typedef BackendDB Backend;
1068 #define nbackends nBackendDB
1069 #define backends backendDB
1071 struct slap_backend_db {
1072 BackendInfo *bd_info; /* pointer to shared backend info */
1074 /* BackendInfo accessors */
1075 #define be_config bd_info->bi_db_config
1076 #define be_type bd_info->bi_type
1078 #define be_bind bd_info->bi_op_bind
1079 #define be_unbind bd_info->bi_op_unbind
1080 #define be_add bd_info->bi_op_add
1081 #define be_compare bd_info->bi_op_compare
1082 #define be_delete bd_info->bi_op_delete
1083 #define be_modify bd_info->bi_op_modify
1084 #define be_modrdn bd_info->bi_op_modrdn
1085 #define be_search bd_info->bi_op_search
1087 #define be_extended bd_info->bi_extended
1089 #define be_release bd_info->bi_entry_release_rw
1090 #define be_chk_referrals bd_info->bi_chk_referrals
1091 #define be_group bd_info->bi_acl_group
1092 #define be_attribute bd_info->bi_acl_attribute
1093 #define be_operational bd_info->bi_operational
1095 #define be_controls bd_info->bi_controls
1097 #define be_connection_init bd_info->bi_connection_init
1098 #define be_connection_destroy bd_info->bi_connection_destroy
1101 #define be_entry_open bd_info->bi_tool_entry_open
1102 #define be_entry_close bd_info->bi_tool_entry_close
1103 #define be_entry_first bd_info->bi_tool_entry_first
1104 #define be_entry_next bd_info->bi_tool_entry_next
1105 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1106 #define be_entry_get bd_info->bi_tool_entry_get
1107 #define be_entry_put bd_info->bi_tool_entry_put
1108 #define be_sync bd_info->bi_tool_sync
1111 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1112 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1113 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1114 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1115 #define SLAP_BFLAG_ALIASES 0x0100U
1116 #define SLAP_BFLAG_REFERRALS 0x0200U
1117 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1118 #define SLAP_BFLAG_MONITOR 0x1000U
1119 #define SLAP_BFLAG_DYNAMIC 0x2000U
1120 slap_mask_t be_flags;
1121 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1122 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1123 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1124 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1125 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1126 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1128 slap_mask_t be_restrictops; /* restriction operations */
1129 #define SLAP_RESTRICT_OP_ADD 0x0001U
1130 #define SLAP_RESTRICT_OP_BIND 0x0002U
1131 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1132 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1133 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1134 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1135 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1136 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1138 #define SLAP_RESTRICT_OP_READS \
1139 ( SLAP_RESTRICT_OP_COMPARE \
1140 | SLAP_RESTRICT_OP_SEARCH )
1141 #define SLAP_RESTRICT_OP_WRITES \
1142 ( SLAP_RESTRICT_OP_ADD \
1143 | SLAP_RESTRICT_OP_DELETE \
1144 | SLAP_RESTRICT_OP_MODIFY \
1145 | SLAP_RESTRICT_OP_RENAME )
1147 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1148 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1149 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1151 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1152 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1153 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1155 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1156 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1158 slap_mask_t be_requires; /* pre-operation requirements */
1159 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1160 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1161 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1162 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1163 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1165 /* Required Security Strength Factor */
1166 slap_ssf_set_t be_ssf_set;
1168 /* these should be renamed from be_ to bd_ */
1169 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1170 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1171 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1172 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1173 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1174 struct berval be_rootpw; /* the magic "root" password for this db */
1175 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1176 #define be_sizelimit be_def_limit.lms_s_soft
1177 #define be_timelimit be_def_limit.lms_t_soft
1178 struct slap_limits_set be_def_limit; /* default limits */
1179 struct slap_limits **be_limits; /* regex-based size and time limits */
1180 AccessControl *be_acl; /* access control list for this backend */
1181 slap_access_t be_dfltaccess; /* access given if no acl matches */
1182 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1183 char *be_replogfile; /* replication log file (in master) */
1184 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1185 BerVarray be_update_refs; /* where to refer modifying clients to */
1187 void *be_private; /* anything the backend database needs */
1193 /* Backend function typedefs */
1194 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1195 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1196 const char *fname, int lineno,
1197 int argc, char **argv));
1198 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1199 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1200 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1202 typedef int (BI_db_init) LDAP_P((Backend *bd));
1203 typedef int (BI_db_config) LDAP_P((Backend *bd,
1204 const char *fname, int lineno,
1205 int argc, char **argv));
1206 typedef int (BI_db_open) LDAP_P((Backend *bd));
1207 typedef int (BI_db_close) LDAP_P((Backend *bd));
1208 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1210 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1211 struct slap_conn *c, struct slap_op *o,
1212 struct berval *dn, struct berval *ndn, int method,
1213 struct berval *cred, struct berval *edn ));
1214 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1215 struct slap_conn *c, struct slap_op *o ));
1216 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1217 struct slap_conn *c, struct slap_op *o,
1218 struct berval *base, struct berval *nbase,
1219 int scope, int deref,
1220 int slimit, int tlimit,
1221 Filter *f, struct berval *filterstr,
1222 AttributeName *attrs, int attrsonly));
1223 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1224 struct slap_conn *c, struct slap_op *o,
1225 struct berval *dn, struct berval *ndn,
1226 AttributeAssertion *ava));
1227 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1228 struct slap_conn *c, struct slap_op *o,
1229 struct berval *dn, struct berval *ndn,
1231 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1232 struct slap_conn *c, struct slap_op *o,
1233 struct berval *dn, struct berval *ndn,
1234 struct berval *newrdn, struct berval *nnewrdn,
1236 struct berval *newSup, struct berval *nnewSup ));
1237 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1238 struct slap_conn *c, struct slap_op *o,
1240 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1241 struct slap_conn *c, struct slap_op *o,
1242 struct berval *dn, struct berval *ndn));
1243 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1244 struct slap_conn *c, struct slap_op *o,
1247 typedef int (BI_op_extended) LDAP_P((
1249 struct slap_conn *conn,
1252 struct berval * reqdata,
1254 struct berval ** rspdata,
1255 LDAPControl *** rspctrls,
1259 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1260 struct slap_conn *c, struct slap_op *o,
1263 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1264 struct slap_conn *c, struct slap_op *o,
1265 struct berval *dn, struct berval *ndn,
1266 const char **text ));
1268 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1269 struct slap_conn *c, struct slap_op *o,
1273 ObjectClass *group_oc,
1274 AttributeDescription *group_at ));
1276 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1277 struct slap_conn *c, struct slap_op *o,
1278 Entry *e, struct berval *edn,
1279 AttributeDescription *entry_at,
1282 typedef int (BI_operational) LDAP_P((Backend *bd,
1283 struct slap_conn *c, struct slap_op *o,
1284 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1286 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1287 struct slap_conn *c));
1288 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1289 struct slap_conn *c));
1291 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1292 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1293 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1294 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1295 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1296 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1297 struct berval *text ));
1298 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1299 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1301 struct slap_backend_info {
1302 char *bi_type; /* type of backend */
1305 * per backend type routines:
1306 * bi_init: called to allocate a backend_info structure,
1307 * called once BEFORE configuration file is read.
1308 * bi_init() initializes this structure hence is
1309 * called directly from be_initialize()
1310 * bi_config: called per 'backend' specific option
1311 * all such options must before any 'database' options
1312 * bi_config() is called only from read_config()
1313 * bi_open: called to open each database, called
1314 * once AFTER configuration file is read but
1315 * BEFORE any bi_db_open() calls.
1316 * bi_open() is called from backend_startup()
1317 * bi_close: called to close each database, called
1318 * once during shutdown after all bi_db_close calls.
1319 * bi_close() is called from backend_shutdown()
1320 * bi_destroy: called to destroy each database, called
1321 * once during shutdown after all bi_db_destroy calls.
1322 * bi_destory() is called from backend_destroy()
1325 BI_config *bi_config;
1328 BI_destroy *bi_destroy;
1331 * per database routines:
1332 * bi_db_init: called to initialize each database,
1333 * called upon reading 'database <type>'
1334 * called only from backend_db_init()
1335 * bi_db_config: called to configure each database,
1336 * called per database to handle per database options
1337 * called only from read_config()
1338 * bi_db_open: called to open each database
1339 * called once per database immediately AFTER bi_open()
1340 * calls but before daemon startup.
1341 * called only by backend_startup()
1342 * bi_db_close: called to close each database
1343 * called once per database during shutdown but BEFORE
1344 * any bi_close call.
1345 * called only by backend_shutdown()
1346 * bi_db_destroy: called to destroy each database
1347 * called once per database during shutdown AFTER all
1348 * bi_close calls but before bi_destory calls.
1349 * called only by backend_destory()
1351 BI_db_init *bi_db_init;
1352 BI_db_config *bi_db_config;
1353 BI_db_open *bi_db_open;
1354 BI_db_close *bi_db_close;
1355 BI_db_destroy *bi_db_destroy;
1357 /* LDAP Operations Handling Routines */
1358 BI_op_bind *bi_op_bind;
1359 BI_op_unbind *bi_op_unbind;
1360 BI_op_search *bi_op_search;
1361 BI_op_compare *bi_op_compare;
1362 BI_op_modify *bi_op_modify;
1363 BI_op_modrdn *bi_op_modrdn;
1364 BI_op_add *bi_op_add;
1365 BI_op_delete *bi_op_delete;
1366 BI_op_abandon *bi_op_abandon;
1368 /* Extended Operations Helper */
1369 BI_op_extended *bi_extended;
1371 /* Auxilary Functions */
1372 BI_entry_release_rw *bi_entry_release_rw;
1373 BI_chk_referrals *bi_chk_referrals;
1375 BI_acl_group *bi_acl_group;
1376 BI_acl_attribute *bi_acl_attribute;
1378 BI_operational *bi_operational;
1380 BI_connection_init *bi_connection_init;
1381 BI_connection_destroy *bi_connection_destroy;
1383 /* hooks for slap tools */
1384 BI_tool_entry_open *bi_tool_entry_open;
1385 BI_tool_entry_close *bi_tool_entry_close;
1386 BI_tool_entry_first *bi_tool_entry_first;
1387 BI_tool_entry_next *bi_tool_entry_next;
1388 BI_tool_entry_get *bi_tool_entry_get;
1389 BI_tool_entry_put *bi_tool_entry_put;
1390 BI_tool_entry_reindex *bi_tool_entry_reindex;
1391 BI_tool_sync *bi_tool_sync;
1393 #define SLAP_INDEX_ADD_OP 0x0001
1394 #define SLAP_INDEX_DELETE_OP 0x0002
1396 char **bi_controls; /* supported controls */
1398 unsigned int bi_nDB; /* number of databases of this type */
1399 void *bi_private; /* anything the backend type needs */
1402 #define c_authtype c_authz.sai_method
1403 #define c_authmech c_authz.sai_mech
1404 #define c_dn c_authz.sai_dn
1405 #define c_ndn c_authz.sai_ndn
1406 #define c_ssf c_authz.sai_ssf
1407 #define c_transport_ssf c_authz.sai_transport_ssf
1408 #define c_tls_ssf c_authz.sai_tls_ssf
1409 #define c_sasl_ssf c_authz.sai_sasl_ssf
1411 #define o_authtype o_authz.sai_method
1412 #define o_authmech o_authz.sai_mech
1413 #define o_dn o_authz.sai_dn
1414 #define o_ndn o_authz.sai_ndn
1415 #define o_ssf o_authz.sai_ssf
1416 #define o_transport_ssf o_authz.sai_transport_ssf
1417 #define o_tls_ssf o_authz.sai_tls_ssf
1418 #define o_sasl_ssf o_authz.sai_sasl_ssf
1420 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1421 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1422 BerVarray, const char *, struct berval *,
1423 struct berval *, LDAPControl ** );
1425 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1426 ber_int_t, const char *, const char *, BerVarray,
1427 LDAPControl **, int nentries);
1429 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1430 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1432 typedef struct slap_callback {
1433 slap_response *sc_response;
1434 slap_sresult *sc_sresult;
1435 slap_sendentry *sc_sendentry;
1440 * Paged Results state
1442 typedef unsigned long PagedResultsCookie;
1443 typedef struct slap_paged_state {
1445 PagedResultsCookie ps_cookie;
1447 } PagedResultsState;
1450 * represents an operation pending from an ldap client
1452 typedef struct slap_op {
1453 unsigned long o_opid; /* id of this operation */
1454 unsigned long o_connid; /* id of conn initiating this op */
1456 ber_int_t o_msgid; /* msgid of the request */
1457 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1458 ber_tag_t o_tag; /* tag of the request */
1459 time_t o_time; /* time op was initiated */
1461 ldap_pvt_thread_t o_tid; /* thread handling this op */
1463 volatile sig_atomic_t o_abandon; /* abandon flag */
1465 #define SLAP_NO_CONTROL 0
1466 #define SLAP_NONCRITICAL_CONTROL 1
1467 #define SLAP_CRITICAL_CONTROL 2
1471 char o_subentries_visibility;
1472 char o_valuesreturnfilter;
1474 char o_pagedresults;
1475 ber_int_t o_pagedresults_size;
1476 PagedResultsState o_pagedresults_state;
1478 #ifdef LDAP_CONNECTIONLESS
1479 Sockaddr o_peeraddr; /* UDP peer address */
1481 AuthorizationInformation o_authz;
1483 BerElement *o_ber; /* ber of the request */
1484 slap_callback *o_callback; /* callback pointers */
1485 LDAPControl **o_ctrls; /* controls */
1487 void *o_private; /* anything the backend needs */
1489 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1490 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1493 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1494 #define get_subentries(op) ((int)(op)->o_subentries)
1495 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1498 * Caches the result of a backend_group check for ACL evaluation
1500 typedef struct slap_gacl {
1501 struct slap_gacl *ga_next;
1504 AttributeDescription *ga_at;
1511 * represents a connection from an ldap client
1513 typedef struct slap_conn {
1514 int c_struct_state; /* structure management state */
1515 int c_conn_state; /* connection state */
1517 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1518 Sockbuf *c_sb; /* ber connection stuff */
1520 /* only can be changed by connect_init */
1521 time_t c_starttime; /* when the connection was opened */
1522 time_t c_activitytime; /* when the connection was last used */
1523 unsigned long c_connid; /* id of this connection for stats*/
1525 struct berval c_listener_url; /* listener URL */
1526 struct berval c_peer_domain; /* DNS name of client */
1527 struct berval c_peer_name; /* peer name (trans=addr:port) */
1528 struct berval c_sock_name; /* sock name (trans=addr:port) */
1530 /* only can be changed by binding thread */
1531 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1532 struct berval c_sasl_bind_mech; /* mech in progress */
1533 struct berval c_cdn;
1535 /* authorization backend */
1536 Backend *c_authz_backend;
1538 AuthorizationInformation c_authz;
1539 GroupAssertion *c_groups;
1541 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1543 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1544 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1546 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1547 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1549 BerElement *c_currentber; /* ber we're attempting to read */
1550 int c_writewaiter; /* true if writer is waiting */
1552 #ifdef LDAP_CONNECTIONLESS
1553 int c_is_udp; /* true if this is (C)LDAP over UDP */
1556 int c_is_tls; /* true if this LDAP over raw TLS */
1557 int c_needs_tls_accept; /* true if SSL_accept should be called */
1559 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1560 void *c_sasl_context; /* SASL session context */
1561 void *c_sasl_extra; /* SASL session extra stuff */
1563 PagedResultsState c_pagedresults_state; /* paged result state */
1565 long c_n_ops_received; /* num of ops received (next op_id) */
1566 long c_n_ops_executing; /* num of ops currently executing */
1567 long c_n_ops_pending; /* num of ops pending execution */
1568 long c_n_ops_completed; /* num of ops completed */
1570 long c_n_get; /* num of get calls */
1571 long c_n_read; /* num of read calls */
1572 long c_n_write; /* num of write calls */
1575 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1576 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1578 if ( ldap_debug & (level) ) \
1579 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1580 if ( ldap_syslog & (level) ) \
1581 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1585 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1589 #define SASLREGEX_REPLACE 10
1590 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1591 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1593 typedef struct sasl_uri {
1595 struct berval filter;
1599 typedef struct sasl_regexp {
1600 char *sr_match; /* regexp match pattern */
1601 SaslUri_t sr_replace; /* regexp replace pattern */
1602 regex_t sr_workspace; /* workspace for regexp engine */
1603 regmatch_t sr_strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1604 int sr_dn_offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1605 int sr_fi_offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1609 * listener; need to access it from monitor backend
1611 typedef struct slap_listener {
1617 #ifdef LDAP_CONNECTIONLESS
1618 int sl_is_udp; /* UDP listener is also data port */
1622 #define sl_addr sl_sa.sa_in_addr
1625 #ifdef SLAPD_MONITOR
1642 #endif /* SLAPD_MONITOR */
1646 #include "proto-slap.h"
1648 #endif /* _SLAP_H_ */