1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2003 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"
38 #define SLAP_EXTENDED_SCHEMA 1
42 * SLAPD Memory allocation macros
44 * Unlike ch_*() routines, these routines do not assert() upon
45 * allocation error. They are intended to be used instead of
46 * ch_*() routines where the caller has implemented proper
47 * checking for and handling of allocation errors.
49 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
51 #define SLAP_MALLOC(s) ber_memalloc((s))
52 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
53 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
54 #define SLAP_FREE(p) ber_memfree((p))
55 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
56 #define SLAP_STRDUP(s) ber_strdup((s))
57 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
60 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
63 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
64 #define SLAPD_ANONYMOUS "cn=anonymous"
66 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
67 * This is a value used internally by the backends. It is needed to allow
68 * adding values that already exist without getting an error as required by
69 * modrdn when the new rdn was already an attribute value itself.
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 /* change this to "OpenLDAPset" */
145 #define SLAPD_ACI_SET_ATTR "template"
147 #define SLAPD_TOP_OID "2.5.6.0"
149 LDAP_SLAPD_V (int) slap_debug;
151 typedef unsigned long slap_mask_t;
153 /* Security Strength Factor */
154 typedef unsigned slap_ssf_t;
156 typedef struct slap_ssf_set {
158 slap_ssf_t sss_transport;
161 slap_ssf_t sss_update_ssf;
162 slap_ssf_t sss_update_transport;
163 slap_ssf_t sss_update_tls;
164 slap_ssf_t sss_update_sasl;
165 slap_ssf_t sss_simple_bind;
168 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
169 #define SLAP_GETDN_AUTHCID 2
170 #define SLAP_GETDN_AUTHZID 4
175 #define SLAP_INDEX_TYPE 0x00FFUL
176 #define SLAP_INDEX_UNDEFINED 0x0001UL
177 #define SLAP_INDEX_PRESENT 0x0002UL
178 #define SLAP_INDEX_EQUALITY 0x0004UL
179 #define SLAP_INDEX_APPROX 0x0008UL
180 #define SLAP_INDEX_SUBSTR 0x0010UL
181 #define SLAP_INDEX_EXTENDED 0x0020UL
183 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
185 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
187 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
189 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
190 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
191 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
192 #define SLAP_INDEX_SUBSTR_DEFAULT \
193 ( SLAP_INDEX_SUBSTR \
194 | SLAP_INDEX_SUBSTR_INITIAL \
195 | SLAP_INDEX_SUBSTR_ANY \
196 | SLAP_INDEX_SUBSTR_FINAL )
198 #define SLAP_INDEX_SUBSTR_MINLEN 2
199 #define SLAP_INDEX_SUBSTR_MAXLEN 4
200 #define SLAP_INDEX_SUBSTR_STEP 2
202 #define SLAP_INDEX_FLAGS 0xF000UL
203 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
204 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
207 * there is a single index for each attribute. these prefixes ensure
208 * that there is no collision among keys.
210 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
211 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
212 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
213 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
214 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
215 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
217 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
218 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
219 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
220 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
221 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
223 #ifdef LDAP_CLIENT_UPDATE
224 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
225 #endif /* LDAP_CLIENT_UPDATE */
228 * represents schema information for a database
230 #define SLAP_SCHERR_OUTOFMEM 1
231 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
232 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
233 #define SLAP_SCHERR_CLASS_BAD_SUP 4
234 #define SLAP_SCHERR_CLASS_DUP 5
235 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
236 #define SLAP_SCHERR_ATTR_BAD_MR 7
237 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
238 #define SLAP_SCHERR_ATTR_BAD_SUP 9
239 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
240 #define SLAP_SCHERR_ATTR_DUP 11
241 #define SLAP_SCHERR_MR_NOT_FOUND 12
242 #define SLAP_SCHERR_MR_INCOMPLETE 13
243 #define SLAP_SCHERR_MR_DUP 14
244 #define SLAP_SCHERR_SYN_NOT_FOUND 15
245 #define SLAP_SCHERR_SYN_DUP 16
246 #define SLAP_SCHERR_NO_NAME 17
247 #define SLAP_SCHERR_NOT_SUPPORTED 18
248 #define SLAP_SCHERR_BAD_DESCR 19
249 #define SLAP_SCHERR_OIDM 20
250 #define SLAP_SCHERR_CR_DUP 21
251 #define SLAP_SCHERR_CR_BAD_STRUCT 22
252 #define SLAP_SCHERR_CR_BAD_AUX 23
253 #define SLAP_SCHERR_CR_BAD_AT 24
254 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
256 typedef union slap_sockaddr {
257 struct sockaddr sa_addr;
258 struct sockaddr_in sa_in_addr;
260 struct sockaddr_storage sa_storage;
261 struct sockaddr_in6 sa_in6_addr;
264 struct sockaddr_un sa_un_addr;
269 extern int slap_inet4or6;
272 typedef struct slap_oid_macro {
273 struct berval som_oid;
275 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
278 /* forward declarations */
280 struct slap_matching_rule;
282 typedef int slap_syntax_validate_func LDAP_P((
283 struct slap_syntax *syntax,
284 struct berval * in));
286 typedef int slap_syntax_transform_func LDAP_P((
287 struct slap_syntax *syntax,
289 struct berval * out));
291 typedef struct slap_syntax {
293 #define ssyn_oid ssyn_syn.syn_oid
294 #define ssyn_desc ssyn_syn.syn_desc
295 #define ssyn_extensions ssyn_syn.syn_extensions
298 ber_len_t ssyn_oidlen;
299 * has been replaced by a struct berval that uses the value
300 * provided by ssyn_syn.syn_oid; a macro that expands to
301 * the bv_len field of the berval is provided for backward
302 * compatibility. CAUTION: NEVER FREE THE BERVAL
304 struct berval ssyn_bvoid;
305 #define ssyn_oidlen ssyn_bvoid.bv_len
307 unsigned int ssyn_flags;
309 #define SLAP_SYNTAX_NONE 0x0000U
310 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
311 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
312 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
313 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
315 slap_syntax_validate_func *ssyn_validate;
316 slap_syntax_transform_func *ssyn_normalize;
317 slap_syntax_transform_func *ssyn_pretty;
319 #ifdef SLAPD_BINARY_CONVERSION
320 /* convert to and from binary */
321 slap_syntax_transform_func *ssyn_ber2str;
322 slap_syntax_transform_func *ssyn_str2ber;
325 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
328 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
329 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
330 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
331 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
332 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
334 typedef struct slap_syntax_defs_rec {
337 slap_syntax_validate_func *sd_validate;
338 slap_syntax_transform_func *sd_normalize;
339 slap_syntax_transform_func *sd_pretty;
340 #ifdef SLAPD_BINARY_CONVERSION
341 slap_syntax_transform_func *sd_ber2str;
342 slap_syntax_transform_func *sd_str2ber;
344 } slap_syntax_defs_rec;
346 /* X -> Y Converter */
347 typedef int slap_mr_convert_func LDAP_P((
349 struct berval * out ));
352 typedef int slap_mr_normalize_func LDAP_P((
354 struct slap_syntax *syntax, /* NULL if in is asserted value */
355 struct slap_matching_rule *mr,
357 struct berval * out ));
359 /* Match (compare) function */
360 typedef int slap_mr_match_func LDAP_P((
363 struct slap_syntax *syntax, /* syntax of stored value */
364 struct slap_matching_rule *mr,
365 struct berval * value,
366 void * assertValue ));
368 /* Index generation function */
369 typedef int slap_mr_indexer_func LDAP_P((
372 struct slap_syntax *syntax, /* syntax of stored value */
373 struct slap_matching_rule *mr,
374 struct berval *prefix,
378 /* Filter index function */
379 typedef int slap_mr_filter_func LDAP_P((
382 struct slap_syntax *syntax, /* syntax of stored value */
383 struct slap_matching_rule *mr,
384 struct berval *prefix,
388 typedef struct slap_matching_rule_use MatchingRuleUse;
390 typedef struct slap_matching_rule {
391 LDAPMatchingRule smr_mrule;
392 MatchingRuleUse *smr_mru;
393 /* RFC2252 string representation */
394 struct berval smr_str;
397 * ber_len_t smr_oidlen;
398 * has been replaced by a struct berval that uses the value
399 * provided by smr_mrule.mr_oid; a macro that expands to
400 * the bv_len field of the berval is provided for backward
401 * compatibility. CAUTION: NEVER FREE THE BERVAL
403 struct berval smr_bvoid;
404 #define smr_oidlen smr_bvoid.bv_len
406 slap_mask_t smr_usage;
408 #define SLAP_MR_HIDE 0x8000U
410 #define SLAP_MR_TYPE_MASK 0x0F00U
411 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
412 #define SLAP_MR_USAGE 0x000FU
414 #define SLAP_MR_NONE 0x0000U
415 #define SLAP_MR_EQUALITY 0x0100U
416 #define SLAP_MR_ORDERING 0x0200U
417 #define SLAP_MR_SUBSTR 0x0400U
418 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
420 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
421 #define SLAP_MR_DN_FOLD 0x0008U
423 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
424 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
425 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
428 * normally the provided value is expected to conform to
429 * assertion syntax specified in the matching rule, however
430 * at times (such as during individual value modification),
431 * the provided value is expected to conform to the
432 * attribute's value syntax.
434 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
435 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
436 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
437 #define SLAP_MR_VALUE_NORMALIZED_MATCH 0x0004U
439 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
440 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
441 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
442 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
444 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
445 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
446 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
447 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
448 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
449 == SLAP_MR_VALUE_SYNTAX_MATCH)
452 slap_mr_convert_func *smr_convert;
453 slap_mr_normalize_func *smr_normalize;
454 slap_mr_match_func *smr_match;
455 slap_mr_indexer_func *smr_indexer;
456 slap_mr_filter_func *smr_filter;
459 * null terminated array of syntaxes compatible with this syntax
460 * note: when MS_EXT is set, this MUST NOT contain the assertion
461 * syntax of the rule. When MS_EXT is not set, it MAY.
463 Syntax **smr_compat_syntaxes;
465 struct slap_matching_rule *smr_associated;
466 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
468 #define smr_oid smr_mrule.mr_oid
469 #define smr_names smr_mrule.mr_names
470 #define smr_desc smr_mrule.mr_desc
471 #define smr_obsolete smr_mrule.mr_obsolete
472 #define smr_syntax_oid smr_mrule.mr_syntax_oid
473 #define smr_extensions smr_mrule.mr_extensions
476 struct slap_matching_rule_use {
477 LDAPMatchingRuleUse smru_mruleuse;
478 MatchingRule *smru_mr;
479 /* RFC2252 string representation */
480 struct berval smru_str;
482 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
484 #define smru_oid smru_mruleuse.mru_oid
485 #define smru_names smru_mruleuse.mru_names
486 #define smru_desc smru_mruleuse.mru_desc
487 #define smru_obsolete smru_mruleuse.mru_obsolete
488 #define smru_applies_oids smru_mruleuse.mru_applies_oids
490 #define smru_usage smru_mr->smr_usage
491 } /* MatchingRuleUse */ ;
493 typedef struct slap_mrule_defs_rec {
495 slap_mask_t mrd_usage;
496 char ** mrd_compat_syntaxes;
497 slap_mr_convert_func * mrd_convert;
498 slap_mr_normalize_func * mrd_normalize;
499 slap_mr_match_func * mrd_match;
500 slap_mr_indexer_func * mrd_indexer;
501 slap_mr_filter_func * mrd_filter;
503 char * mrd_associated;
504 } slap_mrule_defs_rec;
506 struct slap_backend_db;
510 typedef int (AttributeTypeSchemaCheckFN)(
511 struct slap_backend_db *be,
512 struct slap_entry *e,
513 struct slap_attr *attr,
515 char *textbuf, size_t textlen );
517 typedef struct slap_attribute_type {
518 LDAPAttributeType sat_atype;
519 struct berval sat_cname;
520 struct slap_attribute_type *sat_sup;
521 struct slap_attribute_type **sat_subtypes;
522 MatchingRule *sat_equality;
523 MatchingRule *sat_approx;
524 MatchingRule *sat_ordering;
525 MatchingRule *sat_substr;
528 AttributeTypeSchemaCheckFN *sat_check;
530 #define SLAP_AT_NONE 0x0000U
531 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
532 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
533 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
534 slap_mask_t sat_flags;
536 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
538 #define sat_oid sat_atype.at_oid
539 #define sat_names sat_atype.at_names
540 #define sat_desc sat_atype.at_desc
541 #define sat_obsolete sat_atype.at_obsolete
542 #define sat_sup_oid sat_atype.at_sup_oid
543 #define sat_equality_oid sat_atype.at_equality_oid
544 #define sat_ordering_oid sat_atype.at_ordering_oid
545 #define sat_substr_oid sat_atype.at_substr_oid
546 #define sat_syntax_oid sat_atype.at_syntax_oid
547 #define sat_single_value sat_atype.at_single_value
548 #define sat_collective sat_atype.at_collective
549 #define sat_no_user_mod sat_atype.at_no_user_mod
550 #define sat_usage sat_atype.at_usage
551 #define sat_extensions sat_atype.at_extensions
553 struct slap_attr_desc *sat_ad;
554 ldap_pvt_thread_mutex_t sat_ad_mutex;
557 #define is_at_operational(at) ((at)->sat_usage)
558 #define is_at_single_value(at) ((at)->sat_single_value)
559 #define is_at_collective(at) ((at)->sat_collective)
560 #define is_at_obsolete(at) ((at)->sat_obsolete)
561 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
563 struct slap_object_class;
565 typedef int (ObjectClassSchemaCheckFN)(
566 struct slap_backend_db *be,
567 struct slap_entry *e,
568 struct slap_object_class *oc,
570 char *textbuf, size_t textlen );
572 typedef struct slap_object_class {
573 LDAPObjectClass soc_oclass;
574 struct berval soc_cname;
575 struct slap_object_class **soc_sups;
576 AttributeType **soc_required;
577 AttributeType **soc_allowed;
578 ObjectClassSchemaCheckFN *soc_check;
579 slap_mask_t soc_flags;
580 #define soc_oid soc_oclass.oc_oid
581 #define soc_names soc_oclass.oc_names
582 #define soc_desc soc_oclass.oc_desc
583 #define soc_obsolete soc_oclass.oc_obsolete
584 #define soc_sup_oids soc_oclass.oc_sup_oids
585 #define soc_kind soc_oclass.oc_kind
586 #define soc_at_oids_must soc_oclass.oc_at_oids_must
587 #define soc_at_oids_may soc_oclass.oc_at_oids_may
588 #define soc_extensions soc_oclass.oc_extensions
590 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
593 #define SLAP_OC_ALIAS 0x0001
594 #define SLAP_OC_REFERRAL 0x0002
595 #define SLAP_OC_SUBENTRY 0x0004
596 #define SLAP_OC_DYNAMICOBJECT 0x0008
597 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
598 #define SLAP_OC__MASK 0x001F
599 #define SLAP_OC__END 0x0020
600 #define SLAP_OC_OPERATIONAL 0x4000
601 #define SLAP_OC_HIDE 0x8000
606 typedef struct slap_content_rule {
607 LDAPContentRule scr_crule;
608 ObjectClass *scr_sclass;
609 ObjectClass **scr_auxiliaries; /* optional */
610 AttributeType **scr_required; /* optional */
611 AttributeType **scr_allowed; /* optional */
612 AttributeType **scr_precluded; /* optional */
613 #define scr_oid scr_crule.cr_oid
614 #define scr_names scr_crule.cr_names
615 #define scr_desc scr_crule.cr_desc
616 #define scr_obsolete scr_crule.cr_obsolete
617 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
618 #define scr_at_oids_must scr_crule.cr_at_oids_must
619 #define scr_at_oids_may scr_crule.cr_at_oids_may
620 #define scr_at_oids_not scr_crule.cr_at_oids_not
622 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
625 /* Represents a recognized attribute description ( type + options ). */
626 typedef struct slap_attr_desc {
627 struct slap_attr_desc *ad_next;
628 AttributeType *ad_type; /* attribute type, must be specified */
629 struct berval ad_cname; /* canonical name, must be specified */
630 struct berval ad_tags; /* empty if no tagging options */
632 #define SLAP_DESC_NONE 0x00U
633 #define SLAP_DESC_BINARY 0x01U
634 #define SLAP_DESC_TAG_RANGE 0x80U
635 } AttributeDescription;
637 typedef struct slap_attr_name {
638 struct berval an_name;
639 AttributeDescription *an_desc;
643 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
644 #define slap_ad_is_tag_range(ad) \
645 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
646 #define slap_ad_is_binary(ad) \
647 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
650 * pointers to schema elements used internally
652 struct slap_internal_schema {
654 ObjectClass *si_oc_top;
655 ObjectClass *si_oc_extensibleObject;
656 ObjectClass *si_oc_alias;
657 ObjectClass *si_oc_referral;
658 ObjectClass *si_oc_rootdse;
659 ObjectClass *si_oc_subentry;
660 ObjectClass *si_oc_subschema;
661 ObjectClass *si_oc_monitor;
662 ObjectClass *si_oc_collectiveAttributeSubentry;
663 ObjectClass *si_oc_dynamicObject;
665 /* objectClass attribute descriptions */
666 AttributeDescription *si_ad_objectClass;
668 /* operational attribute descriptions */
669 AttributeDescription *si_ad_structuralObjectClass;
670 AttributeDescription *si_ad_creatorsName;
671 AttributeDescription *si_ad_createTimestamp;
672 AttributeDescription *si_ad_modifiersName;
673 AttributeDescription *si_ad_modifyTimestamp;
674 AttributeDescription *si_ad_hasSubordinates;
675 AttributeDescription *si_ad_subschemaSubentry;
676 AttributeDescription *si_ad_collectiveSubentries;
677 AttributeDescription *si_ad_collectiveExclusions;
678 AttributeDescription *si_ad_entryUUID;
679 AttributeDescription *si_ad_entryCSN;
680 AttributeDescription *si_ad_superiorUUID;
682 /* root DSE attribute descriptions */
683 AttributeDescription *si_ad_altServer;
684 AttributeDescription *si_ad_namingContexts;
685 AttributeDescription *si_ad_supportedControl;
686 AttributeDescription *si_ad_supportedExtension;
687 AttributeDescription *si_ad_supportedLDAPVersion;
688 AttributeDescription *si_ad_supportedSASLMechanisms;
689 AttributeDescription *si_ad_supportedFeatures;
690 AttributeDescription *si_ad_monitorContext;
691 AttributeDescription *si_ad_vendorName;
692 AttributeDescription *si_ad_vendorVersion;
694 /* subentry attribute descriptions */
695 AttributeDescription *si_ad_administrativeRole;
696 AttributeDescription *si_ad_subtreeSpecification;
698 /* subschema subentry attribute descriptions */
699 AttributeDescription *si_ad_ditStructureRules;
700 AttributeDescription *si_ad_ditContentRules;
701 AttributeDescription *si_ad_nameForms;
702 AttributeDescription *si_ad_objectClasses;
703 AttributeDescription *si_ad_attributeTypes;
704 AttributeDescription *si_ad_ldapSyntaxes;
705 AttributeDescription *si_ad_matchingRules;
706 AttributeDescription *si_ad_matchingRuleUse;
708 /* Aliases & Referrals */
709 AttributeDescription *si_ad_aliasedObjectName;
710 AttributeDescription *si_ad_ref;
712 /* Access Control Internals */
713 AttributeDescription *si_ad_entry;
714 AttributeDescription *si_ad_children;
715 AttributeDescription *si_ad_saslAuthzTo;
716 AttributeDescription *si_ad_saslAuthzFrom;
717 #ifdef SLAPD_ACI_ENABLED
718 AttributeDescription *si_ad_aci;
721 /* dynamic entries */
722 AttributeDescription *si_ad_entryTtl;
723 AttributeDescription *si_ad_dynamicSubtrees;
725 /* Other attributes descriptions */
726 AttributeDescription *si_ad_distinguishedName;
727 AttributeDescription *si_ad_name;
728 AttributeDescription *si_ad_cn;
729 AttributeDescription *si_ad_userPassword;
730 #ifdef SLAPD_AUTHPASSWD
731 AttributeDescription *si_ad_authPassword;
733 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
734 AttributeDescription *si_ad_krbName;
737 /* Undefined Attribute Type */
738 AttributeType *si_at_undefined;
741 MatchingRule *si_mr_distinguishedNameMatch;
742 MatchingRule *si_mr_integerMatch;
745 Syntax *si_syn_octetString;
746 Syntax *si_syn_distinguishedName;
747 Syntax *si_syn_integer;
750 typedef struct slap_attr_assertion {
751 AttributeDescription *aa_desc;
752 struct berval aa_value;
753 } AttributeAssertion;
755 typedef struct slap_ss_assertion {
756 AttributeDescription *sa_desc;
757 struct berval sa_initial;
758 struct berval *sa_any;
759 struct berval sa_final;
760 } SubstringsAssertion;
762 typedef struct slap_mr_assertion {
763 MatchingRule *ma_rule; /* optional */
764 struct berval ma_rule_text; /* optional */
765 AttributeDescription *ma_desc; /* optional */
766 int ma_dnattrs; /* boolean */
767 struct berval ma_value; /* required */
768 } MatchingRuleAssertion;
771 * represents a search filter
773 typedef struct slap_filter {
774 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
775 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
776 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
777 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
780 /* precomputed result */
781 ber_int_t f_un_result;
784 struct berval *f_un_dn;
787 AttributeDescription *f_un_desc;
789 /* simple value assertion */
790 AttributeAssertion *f_un_ava;
792 /* substring assertion */
793 SubstringsAssertion *f_un_ssa;
795 /* matching rule assertion */
796 MatchingRuleAssertion *f_un_mra;
798 #define f_dn f_un.f_un_dn
799 #define f_desc f_un.f_un_desc
800 #define f_ava f_un.f_un_ava
801 #define f_av_desc f_un.f_un_ava->aa_desc
802 #define f_av_value f_un.f_un_ava->aa_value
803 #define f_sub f_un.f_un_ssa
804 #define f_sub_desc f_un.f_un_ssa->sa_desc
805 #define f_sub_initial f_un.f_un_ssa->sa_initial
806 #define f_sub_any f_un.f_un_ssa->sa_any
807 #define f_sub_final f_un.f_un_ssa->sa_final
808 #define f_mra f_un.f_un_mra
809 #define f_mr_rule f_un.f_un_mra->ma_rule
810 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
811 #define f_mr_desc f_un.f_un_mra->ma_desc
812 #define f_mr_value f_un.f_un_mra->ma_value
813 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
816 struct slap_filter *f_un_complex;
819 #define f_result f_un.f_un_result
820 #define f_and f_un.f_un_complex
821 #define f_or f_un.f_un_complex
822 #define f_not f_un.f_un_complex
823 #define f_list f_un.f_un_complex
825 struct slap_filter *f_next;
828 /* compare routines can return undefined */
829 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
831 typedef struct slap_valuesreturnfilter {
832 ber_tag_t vrf_choice;
835 /* precomputed result */
836 ber_int_t vrf_un_result;
842 AttributeDescription *vrf_un_desc;
844 /* simple value assertion */
845 AttributeAssertion *vrf_un_ava;
847 /* substring assertion */
848 SubstringsAssertion *vrf_un_ssa;
850 /* matching rule assertion */
851 MatchingRuleAssertion *vrf_un_mra;
853 #define vrf_result vrf_un.vrf_un_result
854 #define vrf_dn vrf_un.vrf_un_dn
855 #define vrf_desc vrf_un.vrf_un_desc
856 #define vrf_ava vrf_un.vrf_un_ava
857 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
858 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
859 #define vrf_ssa vrf_un.vrf_un_ssa
860 #define vrf_sub vrf_un.vrf_un_ssa
861 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
862 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
863 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
864 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
865 #define vrf_mra vrf_un.vrf_un_mra
866 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
867 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
868 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
869 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
870 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
875 struct slap_valuesreturnfilter *vrf_next;
876 } ValuesReturnFilter;
879 * represents an attribute (description + values)
881 typedef struct slap_attr {
882 AttributeDescription *a_desc;
884 struct slap_attr *a_next;
886 #define SLAP_ATTR_IXADD 0x1U
887 #define SLAP_ATTR_IXDEL 0x2U
892 * the id used in the indexes to refer to an entry
894 typedef unsigned long ID;
895 #define NOID ((ID)~0)
898 * represents an entry in core
900 typedef struct slap_entry {
902 * The ID field should only be changed before entry is
903 * inserted into a cache. The ID value is backend
908 struct berval e_name; /* name (DN) of this entry */
909 struct berval e_nname; /* normalized name (DN) of this entry */
911 /* for migration purposes */
912 #define e_dn e_name.bv_val
913 #define e_ndn e_nname.bv_val
915 Attribute *e_attrs; /* list of attributes + values */
917 slap_mask_t e_ocflags;
919 struct berval e_bv; /* For entry_encode/entry_decode */
921 /* for use by the backend for any purpose */
928 typedef struct slap_mod {
930 AttributeDescription *sm_desc;
931 struct berval sm_type;
932 BerVarray sm_bvalues;
935 typedef struct slap_mod_list {
936 Modification sml_mod;
937 #define sml_op sml_mod.sm_op
938 #define sml_desc sml_mod.sm_desc
939 #define sml_type sml_mod.sm_type
940 #define sml_bvalues sml_mod.sm_bvalues
941 struct slap_mod_list *sml_next;
944 typedef struct slap_ldap_modlist {
946 struct slap_ldap_modlist *ml_next;
947 #define ml_op ml_mod.mod_op
948 #define ml_type ml_mod.mod_type
949 #define ml_values ml_mod.mod_values
950 #define ml_bvalues ml_mod.mod_bvalues
954 * represents an access control list
956 typedef enum slap_access_e {
957 ACL_INVALID_ACCESS = -1,
966 typedef enum slap_control_e {
967 ACL_INVALID_CONTROL = 0,
973 typedef enum slap_style_e {
981 /* alternate names */
982 ACL_STYLE_EXACT = ACL_STYLE_BASE
985 typedef struct slap_authz_info {
986 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
987 struct berval sai_mech; /* SASL Mechanism */
988 struct berval sai_dn; /* DN for reporting purposes */
989 struct berval sai_ndn; /* Normalized DN */
991 /* Security Strength Factors */
992 slap_ssf_t sai_ssf; /* Overall SSF */
993 slap_ssf_t sai_transport_ssf; /* Transport SSF */
994 slap_ssf_t sai_tls_ssf; /* TLS SSF */
995 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
996 } AuthorizationInformation;
999 typedef struct slap_access {
1000 slap_control_t a_type;
1002 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1004 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1005 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1006 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1007 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1008 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1009 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1011 #define ACL_PRIV_MASK 0x00ffUL
1014 #define ACL_PRIV_LEVEL 0x1000UL
1015 #define ACL_PRIV_ADDITIVE 0x2000UL
1016 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1019 #define ACL_PRIV_INVALID 0x0UL
1021 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1022 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1023 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1024 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1026 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1027 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1029 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1031 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1033 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1034 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1035 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1037 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1038 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1039 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1040 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1041 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1042 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1044 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1045 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1046 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1047 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1048 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1049 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1050 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1052 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1053 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1054 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1055 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1056 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1057 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1059 slap_mask_t a_access_mask;
1061 AuthorizationInformation a_authz;
1062 #define a_dn_pat a_authz.sai_dn
1064 slap_style_t a_dn_style;
1065 AttributeDescription *a_dn_at;
1069 slap_style_t a_peername_style;
1070 struct berval a_peername_pat;
1071 slap_style_t a_sockname_style;
1072 struct berval a_sockname_pat;
1074 slap_style_t a_domain_style;
1075 struct berval a_domain_pat;
1076 int a_domain_expand;
1078 slap_style_t a_sockurl_style;
1079 struct berval a_sockurl_pat;
1080 slap_style_t a_set_style;
1081 struct berval a_set_pat;
1083 #ifdef SLAPD_ACI_ENABLED
1084 AttributeDescription *a_aci_at;
1088 slap_style_t a_group_style;
1089 struct berval a_group_pat;
1090 ObjectClass *a_group_oc;
1091 AttributeDescription *a_group_at;
1093 struct slap_access *a_next;
1097 typedef struct slap_acl {
1098 /* "to" part: the entries this acl applies to */
1100 slap_style_t acl_dn_style;
1102 struct berval acl_dn_pat;
1103 AttributeName *acl_attrs;
1105 /* "by" part: list of who has what access to the entries */
1108 struct slap_acl *acl_next;
1111 typedef struct slap_acl_state {
1112 unsigned as_recorded;
1113 #define ACL_STATE_NOT_RECORDED 0x0
1114 #define ACL_STATE_RECORDED_VD 0x1
1115 #define ACL_STATE_RECORDED_NV 0x2
1116 #define ACL_STATE_RECORDED 0x3
1119 AccessControl *as_vd_acl;
1120 AccessControl *as_vi_acl;
1121 slap_mask_t as_vd_acl_mask;
1122 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1123 int as_vd_acl_count;
1125 Access *as_vd_access;
1126 int as_vd_access_count;
1129 AttributeDescription *as_vd_ad;
1130 } AccessControlState;
1131 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1132 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1135 * replog moddn param structure
1137 struct slap_replog_moddn {
1138 struct berval *newrdn;
1140 struct berval *newsup;
1145 * represents a backend
1148 typedef struct slap_backend_info BackendInfo; /* per backend type */
1149 typedef struct slap_backend_db BackendDB; /* per backend database */
1151 LDAP_SLAPD_V (int) nBackendInfo;
1152 LDAP_SLAPD_V (int) nBackendDB;
1153 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1154 LDAP_SLAPD_V (BackendDB *) backendDB;
1156 LDAP_SLAPD_V (int) slapMode;
1157 #define SLAP_UNDEFINED_MODE 0x0000
1158 #define SLAP_SERVER_MODE 0x0001
1159 #define SLAP_TOOL_MODE 0x0002
1160 #define SLAP_MODE 0x0003
1162 #define SLAP_TRUNCATE_MODE 0x0100
1164 struct slap_replica_info {
1165 char *ri_host; /* supersedes be_replica */
1166 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1167 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1168 int ri_exclude; /* 1 => exclude ri_attrs */
1171 struct slap_limits_set {
1179 int lms_s_unchecked;
1184 struct slap_limits {
1185 int lm_type; /* type of pattern */
1186 #define SLAP_LIMITS_UNDEFINED 0x0000
1187 #define SLAP_LIMITS_EXACT 0x0001
1188 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1189 #define SLAP_LIMITS_ONE 0x0002
1190 #define SLAP_LIMITS_SUBTREE 0x0003
1191 #define SLAP_LIMITS_CHILDREN 0x0004
1192 #define SLAP_LIMITS_REGEX 0x0005
1193 #define SLAP_LIMITS_ANONYMOUS 0x0006
1194 #define SLAP_LIMITS_USERS 0x0007
1195 #define SLAP_LIMITS_ANY 0x0008
1196 regex_t lm_dn_regex; /* regex data for REGEX */
1199 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1200 * pattern for REGEX; NULL for ANONYMOUS, USERS
1202 struct berval lm_dn_pat;
1204 struct slap_limits_set lm_limits;
1207 /* temporary aliases */
1208 typedef BackendDB Backend;
1209 #define nbackends nBackendDB
1210 #define backends backendDB
1212 struct slap_backend_db {
1213 BackendInfo *bd_info; /* pointer to shared backend info */
1215 /* BackendInfo accessors */
1216 #define be_config bd_info->bi_db_config
1217 #define be_type bd_info->bi_type
1219 #define be_bind bd_info->bi_op_bind
1220 #define be_unbind bd_info->bi_op_unbind
1221 #define be_add bd_info->bi_op_add
1222 #define be_compare bd_info->bi_op_compare
1223 #define be_delete bd_info->bi_op_delete
1224 #define be_modify bd_info->bi_op_modify
1225 #define be_modrdn bd_info->bi_op_modrdn
1226 #define be_search bd_info->bi_op_search
1228 #define be_extended bd_info->bi_extended
1230 #define be_release bd_info->bi_entry_release_rw
1231 #define be_chk_referrals bd_info->bi_chk_referrals
1232 #define be_group bd_info->bi_acl_group
1233 #define be_attribute bd_info->bi_acl_attribute
1234 #define be_operational bd_info->bi_operational
1237 * define to honor hasSubordinates operational attribute in search filters
1238 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1241 #define be_has_subordinates bd_info->bi_has_subordinates
1243 #define be_controls bd_info->bi_controls
1245 #define be_connection_init bd_info->bi_connection_init
1246 #define be_connection_destroy bd_info->bi_connection_destroy
1249 #define be_entry_open bd_info->bi_tool_entry_open
1250 #define be_entry_close bd_info->bi_tool_entry_close
1251 #define be_entry_first bd_info->bi_tool_entry_first
1252 #define be_entry_next bd_info->bi_tool_entry_next
1253 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1254 #define be_entry_get bd_info->bi_tool_entry_get
1255 #define be_entry_put bd_info->bi_tool_entry_put
1256 #define be_sync bd_info->bi_tool_sync
1259 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1260 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1261 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1262 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1263 #define SLAP_BFLAG_ALIASES 0x0100U
1264 #define SLAP_BFLAG_REFERRALS 0x0200U
1265 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1266 #define SLAP_BFLAG_MONITOR 0x1000U
1267 #define SLAP_BFLAG_DYNAMIC 0x2000U
1268 slap_mask_t be_flags;
1269 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1270 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1271 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1272 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1273 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1274 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1276 slap_mask_t be_restrictops; /* restriction operations */
1277 #define SLAP_RESTRICT_OP_ADD 0x0001U
1278 #define SLAP_RESTRICT_OP_BIND 0x0002U
1279 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1280 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1281 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1282 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1283 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1284 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1286 #define SLAP_RESTRICT_OP_READS \
1287 ( SLAP_RESTRICT_OP_COMPARE \
1288 | SLAP_RESTRICT_OP_SEARCH )
1289 #define SLAP_RESTRICT_OP_WRITES \
1290 ( SLAP_RESTRICT_OP_ADD \
1291 | SLAP_RESTRICT_OP_DELETE \
1292 | SLAP_RESTRICT_OP_MODIFY \
1293 | SLAP_RESTRICT_OP_RENAME )
1295 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1296 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1297 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1299 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1301 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1302 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1303 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1304 0x0004U /* unprotected simple auth */
1305 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1307 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1308 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1310 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1312 slap_mask_t be_requires; /* pre-operation requirements */
1313 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1314 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1315 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1316 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1317 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1319 /* Required Security Strength Factor */
1320 slap_ssf_set_t be_ssf_set;
1322 /* these should be renamed from be_ to bd_ */
1323 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1324 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1325 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1326 struct berval be_schemadn; /* per-backend subschema subentry DN */
1327 struct berval be_schemandn; /* normalized subschema DN */
1328 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1329 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1330 struct berval be_rootpw; /* the magic "root" password for this db */
1331 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1332 #define be_sizelimit be_def_limit.lms_s_soft
1333 #define be_timelimit be_def_limit.lms_t_soft
1334 struct slap_limits_set be_def_limit; /* default limits */
1335 struct slap_limits **be_limits; /* regex-based size and time limits */
1336 AccessControl *be_acl; /* access control list for this backend */
1337 slap_access_t be_dfltaccess; /* access given if no acl matches */
1338 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1339 char *be_replogfile; /* replication log file (in master) */
1340 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1341 BerVarray be_update_refs; /* where to refer modifying clients to */
1343 void *be_private; /* anything the backend database needs */
1345 void *be_pb; /* Netscape plugin */
1351 /* Backend function typedefs */
1352 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1353 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1354 const char *fname, int lineno,
1355 int argc, char **argv));
1356 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1357 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1358 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1360 typedef int (BI_db_init) LDAP_P((Backend *bd));
1361 typedef int (BI_db_config) LDAP_P((Backend *bd,
1362 const char *fname, int lineno,
1363 int argc, char **argv));
1364 typedef int (BI_db_open) LDAP_P((Backend *bd));
1365 typedef int (BI_db_close) LDAP_P((Backend *bd));
1366 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1368 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1369 struct slap_conn *c, struct slap_op *o,
1370 struct berval *dn, struct berval *ndn, int method,
1371 struct berval *cred, struct berval *edn ));
1372 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1373 struct slap_conn *c, struct slap_op *o ));
1374 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1375 struct slap_conn *c, struct slap_op *o,
1376 struct berval *base, struct berval *nbase,
1377 int scope, int deref,
1378 int slimit, int tlimit,
1379 Filter *f, struct berval *filterstr,
1380 AttributeName *attrs, int attrsonly));
1381 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1382 struct slap_conn *c, struct slap_op *o,
1383 struct berval *dn, struct berval *ndn,
1384 AttributeAssertion *ava));
1385 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1386 struct slap_conn *c, struct slap_op *o,
1387 struct berval *dn, struct berval *ndn,
1389 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1390 struct slap_conn *c, struct slap_op *o,
1391 struct berval *dn, struct berval *ndn,
1392 struct berval *newrdn, struct berval *nnewrdn,
1394 struct berval *newSup, struct berval *nnewSup ));
1395 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1396 struct slap_conn *c, struct slap_op *o,
1398 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1399 struct slap_conn *c, struct slap_op *o,
1400 struct berval *dn, struct berval *ndn));
1401 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1402 struct slap_conn *c, struct slap_op *o,
1405 typedef int (BI_op_extended) LDAP_P((
1407 struct slap_conn *conn,
1410 struct berval * reqdata,
1412 struct berval ** rspdata,
1413 LDAPControl *** rspctrls,
1417 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1418 struct slap_conn *c, struct slap_op *o,
1421 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1422 struct slap_conn *c, struct slap_op *o,
1423 struct berval *dn, struct berval *ndn,
1424 const char **text ));
1426 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1427 struct slap_conn *c, struct slap_op *o,
1431 ObjectClass *group_oc,
1432 AttributeDescription *group_at ));
1434 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1435 struct slap_conn *c, struct slap_op *o,
1436 Entry *e, struct berval *edn,
1437 AttributeDescription *entry_at,
1440 typedef int (BI_operational) LDAP_P((Backend *bd,
1441 struct slap_conn *c, struct slap_op *o,
1442 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1444 typedef int (BI_has_subordinates) LDAP_P((Backend *bd,
1445 struct slap_conn *c, struct slap_op *o,
1446 Entry *e, int *has_subordinates ));
1448 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1449 struct slap_conn *c));
1450 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1451 struct slap_conn *c));
1453 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1454 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1455 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1456 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1457 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1458 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1459 struct berval *text ));
1460 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1461 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1463 struct slap_backend_info {
1464 char *bi_type; /* type of backend */
1467 * per backend type routines:
1468 * bi_init: called to allocate a backend_info structure,
1469 * called once BEFORE configuration file is read.
1470 * bi_init() initializes this structure hence is
1471 * called directly from be_initialize()
1472 * bi_config: called per 'backend' specific option
1473 * all such options must before any 'database' options
1474 * bi_config() is called only from read_config()
1475 * bi_open: called to open each database, called
1476 * once AFTER configuration file is read but
1477 * BEFORE any bi_db_open() calls.
1478 * bi_open() is called from backend_startup()
1479 * bi_close: called to close each database, called
1480 * once during shutdown after all bi_db_close calls.
1481 * bi_close() is called from backend_shutdown()
1482 * bi_destroy: called to destroy each database, called
1483 * once during shutdown after all bi_db_destroy calls.
1484 * bi_destory() is called from backend_destroy()
1487 BI_config *bi_config;
1490 BI_destroy *bi_destroy;
1493 * per database routines:
1494 * bi_db_init: called to initialize each database,
1495 * called upon reading 'database <type>'
1496 * called only from backend_db_init()
1497 * bi_db_config: called to configure each database,
1498 * called per database to handle per database options
1499 * called only from read_config()
1500 * bi_db_open: called to open each database
1501 * called once per database immediately AFTER bi_open()
1502 * calls but before daemon startup.
1503 * called only by backend_startup()
1504 * bi_db_close: called to close each database
1505 * called once per database during shutdown but BEFORE
1506 * any bi_close call.
1507 * called only by backend_shutdown()
1508 * bi_db_destroy: called to destroy each database
1509 * called once per database during shutdown AFTER all
1510 * bi_close calls but before bi_destory calls.
1511 * called only by backend_destory()
1513 BI_db_init *bi_db_init;
1514 BI_db_config *bi_db_config;
1515 BI_db_open *bi_db_open;
1516 BI_db_close *bi_db_close;
1517 BI_db_destroy *bi_db_destroy;
1519 /* LDAP Operations Handling Routines */
1520 BI_op_bind *bi_op_bind;
1521 BI_op_unbind *bi_op_unbind;
1522 BI_op_search *bi_op_search;
1523 BI_op_compare *bi_op_compare;
1524 BI_op_modify *bi_op_modify;
1525 BI_op_modrdn *bi_op_modrdn;
1526 BI_op_add *bi_op_add;
1527 BI_op_delete *bi_op_delete;
1528 BI_op_abandon *bi_op_abandon;
1530 /* Extended Operations Helper */
1531 BI_op_extended *bi_extended;
1533 /* Auxilary Functions */
1534 BI_entry_release_rw *bi_entry_release_rw;
1535 BI_chk_referrals *bi_chk_referrals;
1537 BI_acl_group *bi_acl_group;
1538 BI_acl_attribute *bi_acl_attribute;
1540 BI_operational *bi_operational;
1541 BI_has_subordinates *bi_has_subordinates;
1543 BI_connection_init *bi_connection_init;
1544 BI_connection_destroy *bi_connection_destroy;
1546 /* hooks for slap tools */
1547 BI_tool_entry_open *bi_tool_entry_open;
1548 BI_tool_entry_close *bi_tool_entry_close;
1549 BI_tool_entry_first *bi_tool_entry_first;
1550 BI_tool_entry_next *bi_tool_entry_next;
1551 BI_tool_entry_get *bi_tool_entry_get;
1552 BI_tool_entry_put *bi_tool_entry_put;
1553 BI_tool_entry_reindex *bi_tool_entry_reindex;
1554 BI_tool_sync *bi_tool_sync;
1556 #define SLAP_INDEX_ADD_OP 0x0001
1557 #define SLAP_INDEX_DELETE_OP 0x0002
1559 char **bi_controls; /* supported controls */
1561 unsigned int bi_nDB; /* number of databases of this type */
1562 void *bi_private; /* anything the backend type needs */
1565 #define c_authtype c_authz.sai_method
1566 #define c_authmech c_authz.sai_mech
1567 #define c_dn c_authz.sai_dn
1568 #define c_ndn c_authz.sai_ndn
1569 #define c_ssf c_authz.sai_ssf
1570 #define c_transport_ssf c_authz.sai_transport_ssf
1571 #define c_tls_ssf c_authz.sai_tls_ssf
1572 #define c_sasl_ssf c_authz.sai_sasl_ssf
1574 #define o_authtype o_authz.sai_method
1575 #define o_authmech o_authz.sai_mech
1576 #define o_dn o_authz.sai_dn
1577 #define o_ndn o_authz.sai_ndn
1578 #define o_ssf o_authz.sai_ssf
1579 #define o_transport_ssf o_authz.sai_transport_ssf
1580 #define o_tls_ssf o_authz.sai_tls_ssf
1581 #define o_sasl_ssf o_authz.sai_sasl_ssf
1583 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1584 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1585 BerVarray, const char *, struct berval *,
1586 struct berval *, LDAPControl ** );
1588 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1589 ber_int_t, const char *, const char *, BerVarray,
1590 LDAPControl **, int nentries);
1592 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1593 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1595 typedef int (slap_sendreference)( BackendDB *, struct slap_conn *,
1596 struct slap_op *, Entry *, BerVarray, LDAPControl **, BerVarray * );
1598 typedef struct slap_callback {
1599 slap_response *sc_response;
1600 slap_sresult *sc_sresult;
1601 slap_sendentry *sc_sendentry;
1602 slap_sendreference *sc_sendreference;
1607 * Paged Results state
1609 typedef unsigned long PagedResultsCookie;
1610 typedef struct slap_paged_state {
1612 PagedResultsCookie ps_cookie;
1614 } PagedResultsState;
1617 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1618 #define LDAP_PSEARCH_BY_ADD 0x01
1619 #define LDAP_PSEARCH_BY_DELETE 0x02
1620 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1621 #define LDAP_PSEARCH_BY_MODIFY 0x04
1622 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1624 struct ldap_psearch_spec {
1626 struct berval *base;
1627 struct berval *nbase;
1633 struct berval *filterstr;
1634 AttributeName *attrs;
1638 LDAP_LIST_ENTRY(ldap_psearch_spec) link;
1642 struct ldap_psearch_spec* ps;
1643 LDAP_LIST_ENTRY(psid_entry) link;
1649 * represents an operation pending from an ldap client
1651 typedef struct slap_op {
1652 unsigned long o_opid; /* id of this operation */
1653 unsigned long o_connid; /* id of conn initiating this op */
1654 struct slap_conn *o_conn; /* connection spawning this op */
1656 ber_int_t o_msgid; /* msgid of the request */
1657 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1658 ber_tag_t o_tag; /* tag of the request */
1659 time_t o_time; /* time op was initiated */
1661 char * o_extendedop; /* extended operation OID */
1663 ldap_pvt_thread_t o_tid; /* thread handling this op */
1665 volatile sig_atomic_t o_abandon; /* abandon flag */
1666 volatile sig_atomic_t o_cancel; /* cancel flag */
1668 char o_do_not_cache; /* don't cache from this op */
1670 #define SLAP_NO_CONTROL 0
1671 #define SLAP_NONCRITICAL_CONTROL 1
1672 #define SLAP_CRITICAL_CONTROL 2
1674 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1680 #define get_subentries(op) ((int)(op)->o_subentries)
1681 char o_subentries_visibility;
1682 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1684 char o_valuesreturnfilter;
1686 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1687 char o_permissive_modify;
1688 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1690 #define get_permissiveModify(op) (0)
1693 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1694 char o_domain_scope;
1695 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1697 #define get_domainScope(op) (0)
1700 #ifdef LDAP_CONTROL_PAGEDRESULTS
1701 char o_pagedresults;
1702 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1703 ber_int_t o_pagedresults_size;
1704 PagedResultsState o_pagedresults_state;
1706 #define get_pagedresults(op) (0)
1709 #ifdef LDAP_CLIENT_UPDATE
1710 char o_clientupdate;
1711 char o_clientupdate_type;
1712 #define SLAP_LCUP_NONE (0x0)
1713 #define SLAP_LCUP_SYNC (0x1)
1714 #define SLAP_LCUP_PERSIST (0x2)
1715 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1716 ber_int_t o_clientupdate_interval;
1717 struct berval o_clientupdate_state;
1723 #define SLAP_SYNC_NONE (0x0)
1724 #define SLAP_SYNC_REFRESH (0x1)
1725 #define SLAP_SYNC_PERSIST (0x2)
1726 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1727 struct berval o_sync_state;
1730 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1731 LDAP_LIST_HEAD(lss, ldap_psearch_spec) psearch_spec;
1732 LDAP_LIST_HEAD(pe, psid_entry) premodify_list;
1733 LDAP_LIST_ENTRY(slap_op) link;
1736 #ifdef LDAP_CONNECTIONLESS
1737 Sockaddr o_peeraddr; /* UDP peer address */
1739 AuthorizationInformation o_authz;
1741 BerElement *o_ber; /* ber of the request */
1742 #ifdef LDAP_CONNECTIONLESS
1743 BerElement *o_res_ber; /* ber of the reply */
1745 slap_callback *o_callback; /* callback pointers */
1746 LDAPControl **o_ctrls; /* controls */
1748 void *o_threadctx; /* thread pool thread context */
1749 void *o_private; /* anything the backend needs */
1751 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1752 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1755 void *o_pb; /* NS-SLAPI plugin */
1759 typedef void (*SEND_LDAP_RESULT)(
1760 struct slap_conn *conn,
1763 const char *matched,
1769 #define send_ldap_result( conn, op, err, matched, text, ref, ctrls ) \
1770 (*conn->c_send_ldap_result)( conn, op, err, matched, text, ref, ctrls )
1773 typedef int (*SEND_SEARCH_ENTRY)(
1774 struct slap_backend_db *be,
1775 struct slap_conn *conn,
1777 struct slap_entry *e,
1778 AttributeName *attrs,
1783 #define send_search_entry( be, conn, op, e, attrs, attrsonly, ctrls) \
1784 (*conn->c_send_search_entry)( be, conn, op, e, attrs, attrsonly, ctrls)
1787 typedef void (*SEND_SEARCH_RESULT)(
1788 struct slap_conn *conn,
1791 const char *matched,
1794 LDAPControl **ctrls,
1798 #define send_search_result( conn, op, err, matched, text, refs, ctrls, nentries ) \
1799 (*conn->c_send_search_result)( conn, op, err, matched, text, refs, ctrls, nentries )
1802 typedef int (*SEND_SEARCH_REFERENCE)(
1803 struct slap_backend_db *be,
1804 struct slap_conn *conn,
1806 struct slap_entry *e,
1808 LDAPControl **ctrls,
1812 #define send_search_reference( be, conn, op, e, refs, ctrls, v2refs ) \
1813 (*conn->c_send_search_reference)( be, conn, op, e, refs, ctrls, v2refs )
1816 typedef void (*SEND_LDAP_EXTENDED)(
1817 struct slap_conn *conn,
1820 const char *matched,
1824 struct berval *rspdata,
1828 #define send_ldap_extended( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls) \
1829 (*conn->c_send_ldap_extended)( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls )
1831 typedef void (*SEND_LDAP_INTERMEDIATE_RESP)(
1832 struct slap_conn *conn,
1835 const char *matched,
1839 struct berval *rspdata,
1843 #define send_ldap_intermediate_resp( conn, op, err, matched, text, refs, \
1844 rspoid, rspdata, ctrls) \
1845 (*conn->c_send_ldap_intermediate_resp)( conn, op, err, matched, text, \
1846 refs, rspoid, rspdata, ctrls )
1849 * Caches the result of a backend_group check for ACL evaluation
1851 typedef struct slap_gacl {
1852 struct slap_gacl *ga_next;
1855 AttributeDescription *ga_at;
1861 typedef struct slap_listener Listener;
1864 * represents a connection from an ldap client
1866 typedef struct slap_conn {
1867 int c_struct_state; /* structure management state */
1868 int c_conn_state; /* connection state */
1870 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1871 Sockbuf *c_sb; /* ber connection stuff */
1873 /* only can be changed by connect_init */
1874 time_t c_starttime; /* when the connection was opened */
1875 time_t c_activitytime; /* when the connection was last used */
1876 unsigned long c_connid; /* id of this connection for stats*/
1878 struct berval c_peer_domain; /* DNS name of client */
1879 struct berval c_peer_name; /* peer name (trans=addr:port) */
1880 Listener *c_listener;
1881 #define c_listener_url c_listener->sl_url /* listener URL */
1882 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
1884 /* only can be changed by binding thread */
1885 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1886 struct berval c_sasl_bind_mech; /* mech in progress */
1887 struct berval c_sasl_dn; /* temporary storage */
1889 /* authorization backend */
1890 Backend *c_authz_backend;
1892 AuthorizationInformation c_authz;
1893 GroupAssertion *c_groups;
1895 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1897 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1898 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1900 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1901 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1903 BerElement *c_currentber; /* ber we're attempting to read */
1904 int c_writewaiter; /* true if writer is waiting */
1906 #ifdef LDAP_CONNECTIONLESS
1907 int c_is_udp; /* true if this is (C)LDAP over UDP */
1910 int c_is_tls; /* true if this LDAP over raw TLS */
1911 int c_needs_tls_accept; /* true if SSL_accept should be called */
1913 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1914 void *c_sasl_context; /* SASL session context */
1915 void *c_sasl_extra; /* SASL session extra stuff */
1916 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1918 PagedResultsState c_pagedresults_state; /* paged result state */
1920 long c_n_ops_received; /* num of ops received (next op_id) */
1921 long c_n_ops_executing; /* num of ops currently executing */
1922 long c_n_ops_pending; /* num of ops pending execution */
1923 long c_n_ops_completed; /* num of ops completed */
1925 long c_n_get; /* num of get calls */
1926 long c_n_read; /* num of read calls */
1927 long c_n_write; /* num of write calls */
1929 void *c_pb; /* Netscape plugin */
1932 * These are the "callbacks" that are available for back-ends to
1933 * supply data back to connected clients that are connected
1934 * through the "front-end".
1936 SEND_LDAP_RESULT c_send_ldap_result;
1937 SEND_SEARCH_ENTRY c_send_search_entry;
1938 SEND_SEARCH_RESULT c_send_search_result;
1939 SEND_SEARCH_REFERENCE c_send_search_reference;
1940 SEND_LDAP_EXTENDED c_send_ldap_extended;
1941 #ifdef LDAP_RES_INTERMEDIATE_RESP
1942 SEND_LDAP_INTERMEDIATE_RESP c_send_ldap_intermediate_resp;
1947 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1948 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1950 if ( ldap_debug & (level) ) \
1951 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1952 if ( ldap_syslog & (level) ) \
1953 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1956 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
1957 #elif defined(LDAP_DEBUG)
1958 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1960 if ( ldap_debug & (level) ) \
1961 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1963 #define StatslogTest( level ) (ldap_debug & (level))
1964 #elif defined(LDAP_SYSLOG)
1965 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1967 if ( ldap_syslog & (level) ) \
1968 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1971 #define StatslogTest( level ) (ldap_syslog & (level))
1973 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1974 #define StatslogTest( level ) (0)
1978 * listener; need to access it from monitor backend
1980 struct slap_listener {
1981 struct berval sl_url;
1982 struct berval sl_name;
1987 #ifdef LDAP_CONNECTIONLESS
1988 int sl_is_udp; /* UDP listener is also data port */
1992 #define sl_addr sl_sa.sa_in_addr
1995 #ifdef SLAPD_MONITOR
2012 #endif /* SLAPD_MONITOR */
2015 * Better know these all around slapd
2017 #define SLAP_LDAPDN_PRETTY 0x1
2018 #define SLAP_LDAPDN_MAXLEN 8192
2023 #ifdef LDAP_CLIENT_UPDATE
2024 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2025 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2026 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2027 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2028 #endif /* LDAP_CLIENT_UPDATE */
2030 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2031 #define SLAP_SEARCH_MAX_CTRLS 10
2036 #include "proto-slap.h"
2038 #endif /* _SLAP_H_ */