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>
36 #include "ldap_pvt_thread.h"
37 #include "ldap_queue.h"
39 #define SLAP_EXTENDED_SCHEMA 1
40 #define LDAP_CACHING 1
44 * SLAPD Memory allocation macros
46 * Unlike ch_*() routines, these routines do not assert() upon
47 * allocation error. They are intended to be used instead of
48 * ch_*() routines where the caller has implemented proper
49 * checking for and handling of allocation errors.
51 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
53 #define SLAP_MALLOC(s) ber_memalloc((s))
54 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
55 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
56 #define SLAP_FREE(p) ber_memfree((p))
57 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
58 #define SLAP_STRDUP(s) ber_strdup((s))
59 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
62 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
65 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
66 #define SLAPD_ANONYMOUS "cn=anonymous"
68 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
69 * This is a value used internally by the backends. It is needed to allow
70 * adding values that already exist without getting an error as required by
71 * modrdn when the new rdn was already an attribute value itself.
73 #define SLAP_MOD_SOFTADD 0x1000
75 #define MAXREMATCHES (100)
77 #define SLAP_MAX_WORKER_THREADS (16)
80 #define SLAP_MAX_SYNCREPL_THREADS (8)
83 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
84 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
86 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
87 #define SLAP_CONN_MAX_PENDING_AUTH 1000
89 #define SLAP_TEXT_BUFLEN (256)
91 /* psuedo error code indicating abandoned operation */
92 #define SLAPD_ABANDON (-1)
94 /* psuedo error code indicating disconnect */
95 #define SLAPD_DISCONNECT (-2)
98 /* We assume "C" locale, that is US-ASCII */
99 #define ASCII_SPACE(c) ( (c) == ' ' )
100 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
101 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
102 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
103 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
104 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
105 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
107 #define SLAP_NIBBLE(c) ((c)&0x0f)
108 #define SLAP_ESCAPE_CHAR ('\\')
109 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
110 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
112 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
113 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
115 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
116 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
117 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
118 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
119 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
121 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
122 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
123 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
124 #define OID_SEPARATOR(c) ( (c) == '.' )
125 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
127 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
128 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
130 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
131 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
133 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
135 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
136 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
137 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
138 (c) == '?' || (c) == ' ' || (c) == '=' )
139 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
141 /* must match in schema_init.c */
142 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
143 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
144 #define SLAPD_GROUP_ATTR "member"
145 #define SLAPD_GROUP_CLASS "groupOfNames"
146 #define SLAPD_ROLE_ATTR "roleOccupant"
147 #define SLAPD_ROLE_CLASS "organizationalRole"
149 #ifdef SLAPD_ACI_ENABLED
150 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
153 /* change this to "OpenLDAPset" */
154 #define SLAPD_ACI_SET_ATTR "template"
156 #define SLAPD_TOP_OID "2.5.6.0"
158 LDAP_SLAPD_V (int) slap_debug;
160 typedef unsigned long slap_mask_t;
162 /* Security Strength Factor */
163 typedef unsigned slap_ssf_t;
165 typedef struct slap_ssf_set {
167 slap_ssf_t sss_transport;
170 slap_ssf_t sss_update_ssf;
171 slap_ssf_t sss_update_transport;
172 slap_ssf_t sss_update_tls;
173 slap_ssf_t sss_update_sasl;
174 slap_ssf_t sss_simple_bind;
177 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
178 #define SLAP_GETDN_AUTHCID 2
179 #define SLAP_GETDN_AUTHZID 4
184 #define SLAP_INDEX_TYPE 0x00FFUL
185 #define SLAP_INDEX_UNDEFINED 0x0001UL
186 #define SLAP_INDEX_PRESENT 0x0002UL
187 #define SLAP_INDEX_EQUALITY 0x0004UL
188 #define SLAP_INDEX_APPROX 0x0008UL
189 #define SLAP_INDEX_SUBSTR 0x0010UL
190 #define SLAP_INDEX_EXTENDED 0x0020UL
192 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
194 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
196 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
198 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
199 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
200 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
201 #define SLAP_INDEX_SUBSTR_DEFAULT \
202 ( SLAP_INDEX_SUBSTR \
203 | SLAP_INDEX_SUBSTR_INITIAL \
204 | SLAP_INDEX_SUBSTR_ANY \
205 | SLAP_INDEX_SUBSTR_FINAL )
207 #define SLAP_INDEX_SUBSTR_MINLEN 2
208 #define SLAP_INDEX_SUBSTR_MAXLEN 4
209 #define SLAP_INDEX_SUBSTR_STEP 2
211 #define SLAP_INDEX_FLAGS 0xF000UL
212 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
213 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
216 * there is a single index for each attribute. these prefixes ensure
217 * that there is no collision among keys.
219 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
220 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
221 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
222 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
223 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
224 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
226 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
227 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
228 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
229 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
230 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
232 #ifdef LDAP_CLIENT_UPDATE
233 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
234 #endif /* LDAP_CLIENT_UPDATE */
237 * represents schema information for a database
239 #define SLAP_SCHERR_OUTOFMEM 1
240 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
241 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
242 #define SLAP_SCHERR_CLASS_BAD_SUP 4
243 #define SLAP_SCHERR_CLASS_DUP 5
244 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
245 #define SLAP_SCHERR_ATTR_BAD_MR 7
246 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
247 #define SLAP_SCHERR_ATTR_BAD_SUP 9
248 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
249 #define SLAP_SCHERR_ATTR_DUP 11
250 #define SLAP_SCHERR_MR_NOT_FOUND 12
251 #define SLAP_SCHERR_MR_INCOMPLETE 13
252 #define SLAP_SCHERR_MR_DUP 14
253 #define SLAP_SCHERR_SYN_NOT_FOUND 15
254 #define SLAP_SCHERR_SYN_DUP 16
255 #define SLAP_SCHERR_NO_NAME 17
256 #define SLAP_SCHERR_NOT_SUPPORTED 18
257 #define SLAP_SCHERR_BAD_DESCR 19
258 #define SLAP_SCHERR_OIDM 20
259 #define SLAP_SCHERR_CR_DUP 21
260 #define SLAP_SCHERR_CR_BAD_STRUCT 22
261 #define SLAP_SCHERR_CR_BAD_AUX 23
262 #define SLAP_SCHERR_CR_BAD_AT 24
263 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
265 typedef union slap_sockaddr {
266 struct sockaddr sa_addr;
267 struct sockaddr_in sa_in_addr;
269 struct sockaddr_storage sa_storage;
270 struct sockaddr_in6 sa_in6_addr;
273 struct sockaddr_un sa_un_addr;
278 extern int slap_inet4or6;
281 typedef struct slap_oid_macro {
282 struct berval som_oid;
284 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
287 /* forward declarations */
289 struct slap_matching_rule;
291 typedef int slap_syntax_validate_func LDAP_P((
292 struct slap_syntax *syntax,
293 struct berval * in));
295 typedef int slap_syntax_transform_func LDAP_P((
296 struct slap_syntax *syntax,
301 typedef struct slap_syntax {
303 #define ssyn_oid ssyn_syn.syn_oid
304 #define ssyn_desc ssyn_syn.syn_desc
305 #define ssyn_extensions ssyn_syn.syn_extensions
308 ber_len_t ssyn_oidlen;
309 * has been replaced by a struct berval that uses the value
310 * provided by ssyn_syn.syn_oid; a macro that expands to
311 * the bv_len field of the berval is provided for backward
312 * compatibility. CAUTION: NEVER FREE THE BERVAL
314 struct berval ssyn_bvoid;
315 #define ssyn_oidlen ssyn_bvoid.bv_len
317 unsigned int ssyn_flags;
319 #define SLAP_SYNTAX_NONE 0x0000U
320 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
321 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
322 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
324 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
326 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
329 slap_syntax_validate_func *ssyn_validate;
330 slap_syntax_transform_func *ssyn_pretty;
332 #ifdef SLAPD_BINARY_CONVERSION
333 /* convert to and from binary */
334 slap_syntax_transform_func *ssyn_ber2str;
335 slap_syntax_transform_func *ssyn_str2ber;
338 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
341 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
342 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
343 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
344 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
345 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
347 typedef struct slap_syntax_defs_rec {
350 slap_syntax_validate_func *sd_validate;
351 slap_syntax_transform_func *sd_pretty;
352 #ifdef SLAPD_BINARY_CONVERSION
353 slap_syntax_transform_func *sd_ber2str;
354 slap_syntax_transform_func *sd_str2ber;
356 } slap_syntax_defs_rec;
358 /* X -> Y Converter */
359 typedef int slap_mr_convert_func LDAP_P((
365 typedef int slap_mr_normalize_func LDAP_P((
367 struct slap_syntax *syntax, /* NULL if in is asserted value */
368 struct slap_matching_rule *mr,
373 /* Match (compare) function */
374 typedef int slap_mr_match_func LDAP_P((
377 struct slap_syntax *syntax, /* syntax of stored value */
378 struct slap_matching_rule *mr,
379 struct berval * value,
380 void * assertValue ));
382 /* Index generation function */
383 typedef int slap_mr_indexer_func LDAP_P((
386 struct slap_syntax *syntax, /* syntax of stored value */
387 struct slap_matching_rule *mr,
388 struct berval *prefix,
393 /* Filter index function */
394 typedef int slap_mr_filter_func LDAP_P((
397 struct slap_syntax *syntax, /* syntax of stored value */
398 struct slap_matching_rule *mr,
399 struct berval *prefix,
404 typedef struct slap_matching_rule_use MatchingRuleUse;
406 typedef struct slap_matching_rule {
407 LDAPMatchingRule smr_mrule;
408 MatchingRuleUse *smr_mru;
409 /* RFC2252 string representation */
410 struct berval smr_str;
413 * ber_len_t smr_oidlen;
414 * has been replaced by a struct berval that uses the value
415 * provided by smr_mrule.mr_oid; a macro that expands to
416 * the bv_len field of the berval is provided for backward
417 * compatibility. CAUTION: NEVER FREE THE BERVAL
419 struct berval smr_bvoid;
420 #define smr_oidlen smr_bvoid.bv_len
422 slap_mask_t smr_usage;
425 #define SLAP_MR_HIDE 0x0000U
427 #define SLAP_MR_HIDE 0x8000U
430 #define SLAP_MR_TYPE_MASK 0x0F00U
431 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
432 #define SLAP_MR_USAGE 0x000FU
434 #define SLAP_MR_NONE 0x0000U
435 #define SLAP_MR_EQUALITY 0x0100U
436 #define SLAP_MR_ORDERING 0x0200U
437 #define SLAP_MR_SUBSTR 0x0400U
438 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
440 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
442 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
443 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
444 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
448 * The asserted value, depending on the particular usage,
449 * is expected to conform to either the assertion syntax
450 * or the attribute syntax. In some cases, the syntax of
451 * the value is known. If so, these flags indicate which
452 * syntax the value is expected to conform to. If not,
453 * neither of these flags is set (until the syntax of the
454 * provided value is determined). If the value is of the
455 * attribute syntax, the flag is changed once a value of
456 * the assertion syntax is derived from the provided value.
458 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
459 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
461 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
462 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
463 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
464 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
466 /* either or both the asserted value or attribute value
467 * may be provided in normalized form
469 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
470 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
472 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
473 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
474 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
475 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
477 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
478 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
479 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
480 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
481 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
482 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
484 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
485 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
486 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
487 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
490 slap_mr_convert_func *smr_convert;
491 slap_mr_normalize_func *smr_normalize;
492 slap_mr_match_func *smr_match;
493 slap_mr_indexer_func *smr_indexer;
494 slap_mr_filter_func *smr_filter;
497 * null terminated array of syntaxes compatible with this syntax
498 * note: when MS_EXT is set, this MUST NOT contain the assertion
499 * syntax of the rule. When MS_EXT is not set, it MAY.
501 Syntax **smr_compat_syntaxes;
504 * For equality rules, refers to an associated approximate rule.
505 * For non-equality rules, refers to an associated equality rule.
507 struct slap_matching_rule *smr_associated;
509 #define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \
510 ((mr)->smr_associated == (amr)))
512 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
514 #define smr_oid smr_mrule.mr_oid
515 #define smr_names smr_mrule.mr_names
516 #define smr_desc smr_mrule.mr_desc
517 #define smr_obsolete smr_mrule.mr_obsolete
518 #define smr_syntax_oid smr_mrule.mr_syntax_oid
519 #define smr_extensions smr_mrule.mr_extensions
522 struct slap_matching_rule_use {
523 LDAPMatchingRuleUse smru_mruleuse;
524 MatchingRule *smru_mr;
525 /* RFC2252 string representation */
526 struct berval smru_str;
528 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
530 #define smru_oid smru_mruleuse.mru_oid
531 #define smru_names smru_mruleuse.mru_names
532 #define smru_desc smru_mruleuse.mru_desc
533 #define smru_obsolete smru_mruleuse.mru_obsolete
534 #define smru_applies_oids smru_mruleuse.mru_applies_oids
536 #define smru_usage smru_mr->smr_usage
537 } /* MatchingRuleUse */ ;
539 typedef struct slap_mrule_defs_rec {
541 slap_mask_t mrd_usage;
542 char ** mrd_compat_syntaxes;
543 slap_mr_convert_func * mrd_convert;
544 slap_mr_normalize_func * mrd_normalize;
545 slap_mr_match_func * mrd_match;
546 slap_mr_indexer_func * mrd_indexer;
547 slap_mr_filter_func * mrd_filter;
549 /* For equality rule, this may refer to an associated approximate rule */
550 /* For non-equality rule, this may refer to an associated equality rule */
551 char * mrd_associated;
552 } slap_mrule_defs_rec;
554 struct slap_backend_db;
558 typedef int (AttributeTypeSchemaCheckFN)(
559 struct slap_backend_db *be,
560 struct slap_entry *e,
561 struct slap_attr *attr,
563 char *textbuf, size_t textlen );
565 typedef struct slap_attribute_type {
566 LDAPAttributeType sat_atype;
567 struct berval sat_cname;
568 struct slap_attribute_type *sat_sup;
569 struct slap_attribute_type **sat_subtypes;
570 MatchingRule *sat_equality;
571 MatchingRule *sat_approx;
572 MatchingRule *sat_ordering;
573 MatchingRule *sat_substr;
576 AttributeTypeSchemaCheckFN *sat_check;
578 #define SLAP_AT_NONE 0x0000U
579 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
580 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
582 #define SLAP_AT_HIDE 0x0000U /* publish everything */
584 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
586 slap_mask_t sat_flags;
588 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
590 #define sat_oid sat_atype.at_oid
591 #define sat_names sat_atype.at_names
592 #define sat_desc sat_atype.at_desc
593 #define sat_obsolete sat_atype.at_obsolete
594 #define sat_sup_oid sat_atype.at_sup_oid
595 #define sat_equality_oid sat_atype.at_equality_oid
596 #define sat_ordering_oid sat_atype.at_ordering_oid
597 #define sat_substr_oid sat_atype.at_substr_oid
598 #define sat_syntax_oid sat_atype.at_syntax_oid
599 #define sat_single_value sat_atype.at_single_value
600 #define sat_collective sat_atype.at_collective
601 #define sat_no_user_mod sat_atype.at_no_user_mod
602 #define sat_usage sat_atype.at_usage
603 #define sat_extensions sat_atype.at_extensions
605 struct slap_attr_desc *sat_ad;
606 ldap_pvt_thread_mutex_t sat_ad_mutex;
609 #define is_at_operational(at) ((at)->sat_usage)
610 #define is_at_single_value(at) ((at)->sat_single_value)
611 #define is_at_collective(at) ((at)->sat_collective)
612 #define is_at_obsolete(at) ((at)->sat_obsolete)
613 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
615 struct slap_object_class;
617 typedef int (ObjectClassSchemaCheckFN)(
618 struct slap_backend_db *be,
619 struct slap_entry *e,
620 struct slap_object_class *oc,
622 char *textbuf, size_t textlen );
624 typedef struct slap_object_class {
625 LDAPObjectClass soc_oclass;
626 struct berval soc_cname;
627 struct slap_object_class **soc_sups;
628 AttributeType **soc_required;
629 AttributeType **soc_allowed;
630 ObjectClassSchemaCheckFN *soc_check;
631 slap_mask_t soc_flags;
632 #define soc_oid soc_oclass.oc_oid
633 #define soc_names soc_oclass.oc_names
634 #define soc_desc soc_oclass.oc_desc
635 #define soc_obsolete soc_oclass.oc_obsolete
636 #define soc_sup_oids soc_oclass.oc_sup_oids
637 #define soc_kind soc_oclass.oc_kind
638 #define soc_at_oids_must soc_oclass.oc_at_oids_must
639 #define soc_at_oids_may soc_oclass.oc_at_oids_may
640 #define soc_extensions soc_oclass.oc_extensions
642 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
645 #define SLAP_OC_ALIAS 0x0001
646 #define SLAP_OC_REFERRAL 0x0002
647 #define SLAP_OC_SUBENTRY 0x0004
648 #define SLAP_OC_DYNAMICOBJECT 0x0008
649 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
650 #define SLAP_OC__MASK 0x001F
651 #define SLAP_OC__END 0x0020
652 #define SLAP_OC_OPERATIONAL 0x4000
654 #define SLAP_OC_HIDE 0x0000
656 #define SLAP_OC_HIDE 0x8000
662 typedef struct slap_content_rule {
663 LDAPContentRule scr_crule;
664 ObjectClass *scr_sclass;
665 ObjectClass **scr_auxiliaries; /* optional */
666 AttributeType **scr_required; /* optional */
667 AttributeType **scr_allowed; /* optional */
668 AttributeType **scr_precluded; /* optional */
669 #define scr_oid scr_crule.cr_oid
670 #define scr_names scr_crule.cr_names
671 #define scr_desc scr_crule.cr_desc
672 #define scr_obsolete scr_crule.cr_obsolete
673 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
674 #define scr_at_oids_must scr_crule.cr_at_oids_must
675 #define scr_at_oids_may scr_crule.cr_at_oids_may
676 #define scr_at_oids_not scr_crule.cr_at_oids_not
678 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
681 /* Represents a recognized attribute description ( type + options ). */
682 typedef struct slap_attr_desc {
683 struct slap_attr_desc *ad_next;
684 AttributeType *ad_type; /* attribute type, must be specified */
685 struct berval ad_cname; /* canonical name, must be specified */
686 struct berval ad_tags; /* empty if no tagging options */
688 #define SLAP_DESC_NONE 0x00U
689 #define SLAP_DESC_BINARY 0x01U
690 #define SLAP_DESC_TAG_RANGE 0x80U
691 } AttributeDescription;
693 typedef struct slap_attr_name {
694 struct berval an_name;
695 AttributeDescription *an_desc;
699 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
700 #define slap_ad_is_tag_range(ad) \
701 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
702 #define slap_ad_is_binary(ad) \
703 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
706 * pointers to schema elements used internally
708 struct slap_internal_schema {
710 ObjectClass *si_oc_top;
711 ObjectClass *si_oc_extensibleObject;
712 ObjectClass *si_oc_alias;
713 ObjectClass *si_oc_referral;
714 ObjectClass *si_oc_rootdse;
715 ObjectClass *si_oc_subentry;
716 ObjectClass *si_oc_subschema;
717 ObjectClass *si_oc_collectiveAttributeSubentry;
718 ObjectClass *si_oc_dynamicObject;
721 ObjectClass *si_oc_glue;
722 ObjectClass *si_oc_syncConsumerSubentry;
723 ObjectClass *si_oc_syncProviderSubentry;
726 /* objectClass attribute descriptions */
727 AttributeDescription *si_ad_objectClass;
729 /* operational attribute descriptions */
730 AttributeDescription *si_ad_structuralObjectClass;
731 AttributeDescription *si_ad_creatorsName;
732 AttributeDescription *si_ad_createTimestamp;
733 AttributeDescription *si_ad_modifiersName;
734 AttributeDescription *si_ad_modifyTimestamp;
735 AttributeDescription *si_ad_hasSubordinates;
736 AttributeDescription *si_ad_subschemaSubentry;
737 AttributeDescription *si_ad_collectiveSubentries;
738 AttributeDescription *si_ad_collectiveExclusions;
739 AttributeDescription *si_ad_entryUUID;
740 AttributeDescription *si_ad_entryCSN;
741 AttributeDescription *si_ad_namingCSN;
742 AttributeDescription *si_ad_superiorUUID;
745 /* LDAP cache specific operational attribute */
746 AttributeDescription *si_ad_queryid;
747 #endif /* LDAP_CACHING */
750 AttributeDescription *si_ad_dseType;
751 AttributeDescription *si_ad_syncreplCookie;
754 /* root DSE attribute descriptions */
755 AttributeDescription *si_ad_altServer;
756 AttributeDescription *si_ad_namingContexts;
757 AttributeDescription *si_ad_supportedControl;
758 AttributeDescription *si_ad_supportedExtension;
759 AttributeDescription *si_ad_supportedLDAPVersion;
760 AttributeDescription *si_ad_supportedSASLMechanisms;
761 AttributeDescription *si_ad_supportedFeatures;
762 AttributeDescription *si_ad_monitorContext;
763 AttributeDescription *si_ad_vendorName;
764 AttributeDescription *si_ad_vendorVersion;
766 /* subentry attribute descriptions */
767 AttributeDescription *si_ad_administrativeRole;
768 AttributeDescription *si_ad_subtreeSpecification;
770 /* subschema subentry attribute descriptions */
771 AttributeDescription *si_ad_ditStructureRules;
772 AttributeDescription *si_ad_ditContentRules;
773 AttributeDescription *si_ad_nameForms;
774 AttributeDescription *si_ad_objectClasses;
775 AttributeDescription *si_ad_attributeTypes;
776 AttributeDescription *si_ad_ldapSyntaxes;
777 AttributeDescription *si_ad_matchingRules;
778 AttributeDescription *si_ad_matchingRuleUse;
780 /* Aliases & Referrals */
781 AttributeDescription *si_ad_aliasedObjectName;
782 AttributeDescription *si_ad_ref;
784 /* Access Control Internals */
785 AttributeDescription *si_ad_entry;
786 AttributeDescription *si_ad_children;
787 AttributeDescription *si_ad_saslAuthzTo;
788 AttributeDescription *si_ad_saslAuthzFrom;
789 #ifdef SLAPD_ACI_ENABLED
790 AttributeDescription *si_ad_aci;
793 /* dynamic entries */
794 AttributeDescription *si_ad_entryTtl;
795 AttributeDescription *si_ad_dynamicSubtrees;
797 /* Other attributes descriptions */
798 AttributeDescription *si_ad_distinguishedName;
799 AttributeDescription *si_ad_name;
800 AttributeDescription *si_ad_cn;
801 AttributeDescription *si_ad_userPassword;
802 #ifdef SLAPD_AUTHPASSWD
803 AttributeDescription *si_ad_authPassword;
805 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
806 AttributeDescription *si_ad_krbName;
809 /* Undefined Attribute Type */
810 AttributeType *si_at_undefined;
813 MatchingRule *si_mr_distinguishedNameMatch;
814 MatchingRule *si_mr_caseExactMatch;
815 MatchingRule *si_mr_caseExactSubstringsMatch;
816 MatchingRule *si_mr_caseExactIA5Match;
817 MatchingRule *si_mr_integerMatch;
818 MatchingRule *si_mr_integerFirstComponentMatch;
819 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
822 Syntax *si_syn_directoryString;
823 Syntax *si_syn_distinguishedName;
824 Syntax *si_syn_integer;
825 Syntax *si_syn_octetString;
828 typedef struct slap_attr_assertion {
829 AttributeDescription *aa_desc;
830 struct berval aa_value;
831 } AttributeAssertion;
833 typedef struct slap_ss_assertion {
834 AttributeDescription *sa_desc;
835 struct berval sa_initial;
836 struct berval *sa_any;
837 struct berval sa_final;
838 } SubstringsAssertion;
840 typedef struct slap_mr_assertion {
841 MatchingRule *ma_rule; /* optional */
842 struct berval ma_rule_text; /* optional */
843 AttributeDescription *ma_desc; /* optional */
844 int ma_dnattrs; /* boolean */
845 struct berval ma_value; /* required */
846 } MatchingRuleAssertion;
849 * represents a search filter
851 typedef struct slap_filter {
852 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
853 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
854 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
855 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
858 /* precomputed result */
859 ber_int_t f_un_result;
862 struct berval *f_un_dn;
865 AttributeDescription *f_un_desc;
867 /* simple value assertion */
868 AttributeAssertion *f_un_ava;
870 /* substring assertion */
871 SubstringsAssertion *f_un_ssa;
873 /* matching rule assertion */
874 MatchingRuleAssertion *f_un_mra;
876 #define f_dn f_un.f_un_dn
877 #define f_desc f_un.f_un_desc
878 #define f_ava f_un.f_un_ava
879 #define f_av_desc f_un.f_un_ava->aa_desc
880 #define f_av_value f_un.f_un_ava->aa_value
881 #define f_sub f_un.f_un_ssa
882 #define f_sub_desc f_un.f_un_ssa->sa_desc
883 #define f_sub_initial f_un.f_un_ssa->sa_initial
884 #define f_sub_any f_un.f_un_ssa->sa_any
885 #define f_sub_final f_un.f_un_ssa->sa_final
886 #define f_mra f_un.f_un_mra
887 #define f_mr_rule f_un.f_un_mra->ma_rule
888 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
889 #define f_mr_desc f_un.f_un_mra->ma_desc
890 #define f_mr_value f_un.f_un_mra->ma_value
891 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
894 struct slap_filter *f_un_complex;
897 #define f_result f_un.f_un_result
898 #define f_and f_un.f_un_complex
899 #define f_or f_un.f_un_complex
900 #define f_not f_un.f_un_complex
901 #define f_list f_un.f_un_complex
903 struct slap_filter *f_next;
906 /* compare routines can return undefined */
907 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
909 typedef struct slap_valuesreturnfilter {
910 ber_tag_t vrf_choice;
913 /* precomputed result */
914 ber_int_t vrf_un_result;
920 AttributeDescription *vrf_un_desc;
922 /* simple value assertion */
923 AttributeAssertion *vrf_un_ava;
925 /* substring assertion */
926 SubstringsAssertion *vrf_un_ssa;
928 /* matching rule assertion */
929 MatchingRuleAssertion *vrf_un_mra;
931 #define vrf_result vrf_un.vrf_un_result
932 #define vrf_dn vrf_un.vrf_un_dn
933 #define vrf_desc vrf_un.vrf_un_desc
934 #define vrf_ava vrf_un.vrf_un_ava
935 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
936 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
937 #define vrf_ssa vrf_un.vrf_un_ssa
938 #define vrf_sub vrf_un.vrf_un_ssa
939 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
940 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
941 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
942 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
943 #define vrf_mra vrf_un.vrf_un_mra
944 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
945 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
946 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
947 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
948 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
953 struct slap_valuesreturnfilter *vrf_next;
954 } ValuesReturnFilter;
957 * represents an attribute (description + values)
959 typedef struct slap_attr {
960 AttributeDescription *a_desc;
961 BerVarray a_vals; /* preserved values */
962 BerVarray a_nvals; /* normalized values */
963 struct slap_attr *a_next;
965 #define SLAP_ATTR_IXADD 0x1U
966 #define SLAP_ATTR_IXDEL 0x2U
971 * the id used in the indexes to refer to an entry
973 typedef unsigned long ID;
974 #define NOID ((ID)~0)
977 * represents an entry in core
979 typedef struct slap_entry {
981 * The ID field should only be changed before entry is
982 * inserted into a cache. The ID value is backend
987 struct berval e_name; /* name (DN) of this entry */
988 struct berval e_nname; /* normalized name (DN) of this entry */
990 /* for migration purposes */
991 #define e_dn e_name.bv_val
992 #define e_ndn e_nname.bv_val
994 Attribute *e_attrs; /* list of attributes + values */
996 slap_mask_t e_ocflags;
998 struct berval e_bv; /* For entry_encode/entry_decode */
1000 /* for use by the backend for any purpose */
1005 * A list of LDAPMods
1007 typedef struct slap_mod {
1009 AttributeDescription *sm_desc;
1010 struct berval sm_type;
1011 BerVarray sm_values;
1012 #define sm_bvalues sm_values
1013 BerVarray sm_nvalues;
1016 typedef struct slap_mod_list {
1017 Modification sml_mod;
1018 #define sml_op sml_mod.sm_op
1019 #define sml_desc sml_mod.sm_desc
1020 #define sml_type sml_mod.sm_type
1021 #define sml_bvalues sml_mod.sm_values
1022 #define sml_values sml_mod.sm_values
1023 #define sml_nvalues sml_mod.sm_nvalues
1024 struct slap_mod_list *sml_next;
1027 typedef struct slap_ldap_modlist {
1029 struct slap_ldap_modlist *ml_next;
1030 #define ml_op ml_mod.mod_op
1031 #define ml_type ml_mod.mod_type
1032 #define ml_values ml_mod.mod_values
1033 #define ml_bvalues ml_mod.mod_values
1037 * represents an access control list
1039 typedef enum slap_access_e {
1040 ACL_INVALID_ACCESS = -1,
1049 typedef enum slap_control_e {
1050 ACL_INVALID_CONTROL = 0,
1056 typedef enum slap_style_e {
1057 ACL_STYLE_REGEX = 0,
1065 typedef struct slap_authz_info {
1066 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1067 struct berval sai_mech; /* SASL Mechanism */
1068 struct berval sai_dn; /* DN for reporting purposes */
1069 struct berval sai_ndn; /* Normalized DN */
1071 /* Security Strength Factors */
1072 slap_ssf_t sai_ssf; /* Overall SSF */
1073 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1074 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1075 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1076 } AuthorizationInformation;
1079 typedef struct slap_access {
1080 slap_control_t a_type;
1082 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1084 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1085 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1086 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1087 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1088 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1089 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1091 #define ACL_PRIV_MASK 0x00ffUL
1094 #define ACL_PRIV_LEVEL 0x1000UL
1095 #define ACL_PRIV_ADDITIVE 0x2000UL
1096 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1099 #define ACL_PRIV_INVALID 0x0UL
1101 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1102 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1103 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1104 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1106 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1107 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1109 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1111 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1113 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1114 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1115 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1117 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1118 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1119 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1120 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1121 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1122 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1124 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1125 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1126 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1127 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1128 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1129 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1130 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1132 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1133 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1134 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1135 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1136 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1137 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1139 slap_mask_t a_access_mask;
1141 AuthorizationInformation a_authz;
1142 #define a_dn_pat a_authz.sai_dn
1144 slap_style_t a_dn_style;
1145 AttributeDescription *a_dn_at;
1149 slap_style_t a_peername_style;
1150 struct berval a_peername_pat;
1151 slap_style_t a_sockname_style;
1152 struct berval a_sockname_pat;
1154 slap_style_t a_domain_style;
1155 struct berval a_domain_pat;
1156 int a_domain_expand;
1158 slap_style_t a_sockurl_style;
1159 struct berval a_sockurl_pat;
1160 slap_style_t a_set_style;
1161 struct berval a_set_pat;
1163 #ifdef SLAPD_ACI_ENABLED
1164 AttributeDescription *a_aci_at;
1168 slap_style_t a_group_style;
1169 struct berval a_group_pat;
1170 ObjectClass *a_group_oc;
1171 AttributeDescription *a_group_at;
1173 struct slap_access *a_next;
1177 typedef struct slap_acl {
1178 /* "to" part: the entries this acl applies to */
1180 slap_style_t acl_dn_style;
1182 struct berval acl_dn_pat;
1183 AttributeName *acl_attrs;
1185 /* "by" part: list of who has what access to the entries */
1188 struct slap_acl *acl_next;
1191 typedef struct slap_acl_state {
1192 unsigned as_recorded;
1193 #define ACL_STATE_NOT_RECORDED 0x0
1194 #define ACL_STATE_RECORDED_VD 0x1
1195 #define ACL_STATE_RECORDED_NV 0x2
1196 #define ACL_STATE_RECORDED 0x3
1199 AccessControl *as_vd_acl;
1200 AccessControl *as_vi_acl;
1201 slap_mask_t as_vd_acl_mask;
1202 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1203 int as_vd_acl_count;
1205 Access *as_vd_access;
1206 int as_vd_access_count;
1209 AttributeDescription *as_vd_ad;
1210 } AccessControlState;
1211 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1212 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1216 * represents a backend
1219 typedef struct slap_backend_info BackendInfo; /* per backend type */
1220 typedef struct slap_backend_db BackendDB; /* per backend database */
1222 LDAP_SLAPD_V (int) nBackendInfo;
1223 LDAP_SLAPD_V (int) nBackendDB;
1224 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1225 LDAP_SLAPD_V (BackendDB *) backendDB;
1227 LDAP_SLAPD_V (int) slapMode;
1228 #define SLAP_UNDEFINED_MODE 0x0000
1229 #define SLAP_SERVER_MODE 0x0001
1230 #define SLAP_TOOL_MODE 0x0002
1231 #define SLAP_MODE 0x0003
1233 #define SLAP_TRUNCATE_MODE 0x0100
1234 #define SLAP_TOOL_READMAIN 0x0200
1235 #define SLAP_TOOL_READONLY 0x0400
1237 struct slap_replica_info {
1238 char *ri_host; /* supersedes be_replica */
1239 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1240 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1241 int ri_exclude; /* 1 => exclude ri_attrs */
1244 struct slap_limits_set {
1252 int lms_s_unchecked;
1257 struct slap_limits {
1258 int lm_type; /* type of pattern */
1259 #define SLAP_LIMITS_UNDEFINED 0x0000
1260 #define SLAP_LIMITS_EXACT 0x0001
1261 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1262 #define SLAP_LIMITS_ONE 0x0002
1263 #define SLAP_LIMITS_SUBTREE 0x0003
1264 #define SLAP_LIMITS_CHILDREN 0x0004
1265 #define SLAP_LIMITS_REGEX 0x0005
1266 #define SLAP_LIMITS_ANONYMOUS 0x0006
1267 #define SLAP_LIMITS_USERS 0x0007
1268 #define SLAP_LIMITS_ANY 0x0008
1269 regex_t lm_dn_regex; /* regex data for REGEX */
1272 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1273 * pattern for REGEX; NULL for ANONYMOUS, USERS
1275 struct berval lm_dn_pat;
1277 struct slap_limits_set lm_limits;
1280 /* temporary aliases */
1281 typedef BackendDB Backend;
1282 #define nbackends nBackendDB
1283 #define backends backendDB
1285 #ifdef LDAP_SYNCREPL
1286 struct nonpresent_entry {
1289 LDAP_LIST_ENTRY(nonpresent_entry) np_link;
1293 * syncinfo structure for syncrepl
1295 typedef struct syncinfo_s {
1296 struct slap_conn *conn;
1297 struct slap_backend_db *be;
1298 struct slap_entry *e;
1302 struct berval *master_bv;
1306 struct berval updatedn;
1326 #define LASTMOD_REQ 0
1327 #define LASTMOD_GEN 1
1328 #define LASTMOD_NO 2
1333 #define TLS_CRITICAL 2
1336 struct berval *syncUUID;
1337 struct berval *syncUUID_ndn;
1338 struct berval *syncCookie;
1339 Avlnode *presentlist;
1340 LDAP_LIST_HEAD(np, nonpresent_entry) nonpresentlist;
1343 #endif /* LDAP_SYNCREPL */
1345 struct slap_backend_db {
1346 BackendInfo *bd_info; /* pointer to shared backend info */
1348 /* BackendInfo accessors */
1349 #define be_config bd_info->bi_db_config
1350 #define be_type bd_info->bi_type
1352 #define be_bind bd_info->bi_op_bind
1353 #define be_unbind bd_info->bi_op_unbind
1354 #define be_add bd_info->bi_op_add
1355 #define be_compare bd_info->bi_op_compare
1356 #define be_delete bd_info->bi_op_delete
1357 #define be_modify bd_info->bi_op_modify
1358 #define be_modrdn bd_info->bi_op_modrdn
1359 #define be_search bd_info->bi_op_search
1360 #define be_abandon bd_info->bi_op_abandon
1361 #define be_cancel bd_info->bi_op_cancel
1363 #define be_extended bd_info->bi_extended
1365 #define be_fetch bd_info->bi_entry_get_rw
1366 #define be_release bd_info->bi_entry_release_rw
1367 #define be_chk_referrals bd_info->bi_chk_referrals
1368 #define be_group bd_info->bi_acl_group
1369 #define be_attribute bd_info->bi_acl_attribute
1370 #define be_operational bd_info->bi_operational
1373 * define to honor hasSubordinates operational attribute in search filters
1374 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1377 #define be_has_subordinates bd_info->bi_has_subordinates
1379 #define be_controls bd_info->bi_controls
1381 #define be_connection_init bd_info->bi_connection_init
1382 #define be_connection_destroy bd_info->bi_connection_destroy
1385 #define be_entry_open bd_info->bi_tool_entry_open
1386 #define be_entry_close bd_info->bi_tool_entry_close
1387 #define be_entry_first bd_info->bi_tool_entry_first
1388 #define be_entry_next bd_info->bi_tool_entry_next
1389 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1390 #define be_entry_get bd_info->bi_tool_entry_get
1391 #define be_entry_put bd_info->bi_tool_entry_put
1392 #define be_sync bd_info->bi_tool_sync
1395 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1396 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1397 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1398 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1399 #define SLAP_BFLAG_ALIASES 0x0100U
1400 #define SLAP_BFLAG_REFERRALS 0x0200U
1401 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1402 #define SLAP_BFLAG_MONITOR 0x1000U
1403 #define SLAP_BFLAG_DYNAMIC 0x2000U
1404 slap_mask_t be_flags;
1405 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1406 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1407 #define SLAP_GLUE_SUBORDINATE(be) \
1408 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1409 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1410 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1411 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1412 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1413 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1414 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1416 slap_mask_t be_restrictops; /* restriction operations */
1417 #define SLAP_RESTRICT_OP_ADD 0x0001U
1418 #define SLAP_RESTRICT_OP_BIND 0x0002U
1419 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1420 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1421 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1422 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1423 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1424 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1426 #define SLAP_RESTRICT_OP_READS \
1427 ( SLAP_RESTRICT_OP_COMPARE \
1428 | SLAP_RESTRICT_OP_SEARCH )
1429 #define SLAP_RESTRICT_OP_WRITES \
1430 ( SLAP_RESTRICT_OP_ADD \
1431 | SLAP_RESTRICT_OP_DELETE \
1432 | SLAP_RESTRICT_OP_MODIFY \
1433 | SLAP_RESTRICT_OP_RENAME )
1435 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1436 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1437 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1439 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1441 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1442 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1443 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1444 0x0004U /* unprotected simple auth */
1445 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1447 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1448 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1450 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1452 slap_mask_t be_requires; /* pre-operation requirements */
1453 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1454 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1455 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1456 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1457 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1459 /* Required Security Strength Factor */
1460 slap_ssf_set_t be_ssf_set;
1462 /* these should be renamed from be_ to bd_ */
1463 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1464 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1465 struct berval be_schemadn; /* per-backend subschema subentry DN */
1466 struct berval be_schemandn; /* normalized subschema DN */
1467 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1468 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1469 struct berval be_rootpw; /* the magic "root" password for this db */
1470 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1471 #define be_sizelimit be_def_limit.lms_s_soft
1472 #define be_timelimit be_def_limit.lms_t_soft
1473 struct slap_limits_set be_def_limit; /* default limits */
1474 struct slap_limits **be_limits; /* regex-based size and time limits */
1475 AccessControl *be_acl; /* access control list for this backend */
1476 slap_access_t be_dfltaccess; /* access given if no acl matches */
1477 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1478 char *be_replogfile; /* replication log file (in master) */
1479 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1480 BerVarray be_update_refs; /* where to refer modifying clients to */
1482 void *be_private; /* anything the backend database needs */
1484 void *be_pb; /* Netscape plugin */
1485 #ifdef LDAP_SYNCREPL
1486 syncinfo_t *syncinfo; /* For syncrepl */
1493 /* Backend function typedefs */
1494 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1495 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1496 const char *fname, int lineno,
1497 int argc, char **argv));
1498 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1499 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1500 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1502 typedef int (BI_db_init) LDAP_P((Backend *bd));
1503 typedef int (BI_db_config) LDAP_P((Backend *bd,
1504 const char *fname, int lineno,
1505 int argc, char **argv));
1506 typedef int (BI_db_open) LDAP_P((Backend *bd));
1507 typedef int (BI_db_close) LDAP_P((Backend *bd));
1508 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1510 typedef struct req_bind_s {
1512 struct berval rb_cred;
1513 struct berval rb_edn;
1517 typedef struct req_search_s {
1523 AttributeName *rs_attrs;
1525 struct berval rs_filterstr;
1528 typedef struct req_compare_s {
1529 AttributeAssertion *rs_ava;
1532 typedef struct req_modify_s {
1533 Modifications *rs_modlist;
1536 typedef struct req_modrdn_s {
1537 struct berval rs_newrdn;
1538 struct berval rs_nnewrdn;
1539 struct berval *rs_newSup;
1540 struct berval *rs_nnewSup;
1541 int rs_deleteoldrdn;
1544 typedef struct req_add_s {
1548 typedef struct req_abandon_s {
1552 typedef struct req_extended_s {
1553 struct berval rs_reqoid;
1554 struct berval *rs_reqdata;
1557 typedef enum slap_reply_e {
1566 typedef struct rep_sasl_s {
1567 struct berval *r_sasldata;
1570 typedef struct rep_extended_s {
1571 const char *r_rspoid;
1572 struct berval *r_rspdata;
1575 typedef struct rep_search_s {
1577 AttributeName *r_attrs;
1582 typedef struct slap_rep {
1583 slap_reply_t sr_type;
1587 const char *sr_matched;
1588 const char *sr_text;
1590 LDAPControl **sr_ctrls;
1592 rep_sasl_s sru_sasl;
1593 rep_extended_s sru_extended;
1594 rep_search_s sru_search;
1598 /* short hands for response members */
1599 #define sr_attrs sr_un.sru_search.r_attrs
1600 #define sr_entry sr_un.sru_search.r_entry
1601 #define sr_v2ref sr_un.sru_search.r_v2ref
1602 #define sr_nentries sr_un.sru_search.r_nentries
1603 #define sr_rspoid sr_un.sru_extended.r_rspoid
1604 #define sr_rspdata sr_un.sru_extended.r_rspdata
1605 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1607 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1608 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1609 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1610 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1611 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1612 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1613 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1614 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1615 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1616 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1617 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1618 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1619 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1620 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1621 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1622 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1623 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1625 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1626 struct slap_conn *c));
1627 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1628 struct slap_conn *c));
1630 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1631 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1632 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1633 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1634 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1635 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1636 struct berval *text ));
1637 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1638 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1640 struct slap_backend_info {
1641 char *bi_type; /* type of backend */
1644 * per backend type routines:
1645 * bi_init: called to allocate a backend_info structure,
1646 * called once BEFORE configuration file is read.
1647 * bi_init() initializes this structure hence is
1648 * called directly from be_initialize()
1649 * bi_config: called per 'backend' specific option
1650 * all such options must before any 'database' options
1651 * bi_config() is called only from read_config()
1652 * bi_open: called to open each database, called
1653 * once AFTER configuration file is read but
1654 * BEFORE any bi_db_open() calls.
1655 * bi_open() is called from backend_startup()
1656 * bi_close: called to close each database, called
1657 * once during shutdown after all bi_db_close calls.
1658 * bi_close() is called from backend_shutdown()
1659 * bi_destroy: called to destroy each database, called
1660 * once during shutdown after all bi_db_destroy calls.
1661 * bi_destory() is called from backend_destroy()
1664 BI_config *bi_config;
1667 BI_destroy *bi_destroy;
1670 * per database routines:
1671 * bi_db_init: called to initialize each database,
1672 * called upon reading 'database <type>'
1673 * called only from backend_db_init()
1674 * bi_db_config: called to configure each database,
1675 * called per database to handle per database options
1676 * called only from read_config()
1677 * bi_db_open: called to open each database
1678 * called once per database immediately AFTER bi_open()
1679 * calls but before daemon startup.
1680 * called only by backend_startup()
1681 * bi_db_close: called to close each database
1682 * called once per database during shutdown but BEFORE
1683 * any bi_close call.
1684 * called only by backend_shutdown()
1685 * bi_db_destroy: called to destroy each database
1686 * called once per database during shutdown AFTER all
1687 * bi_close calls but before bi_destory calls.
1688 * called only by backend_destory()
1690 BI_db_init *bi_db_init;
1691 BI_db_config *bi_db_config;
1692 BI_db_open *bi_db_open;
1693 BI_db_close *bi_db_close;
1694 BI_db_destroy *bi_db_destroy;
1696 /* LDAP Operations Handling Routines */
1697 BI_op_bind *bi_op_bind;
1698 BI_op_unbind *bi_op_unbind;
1699 BI_op_search *bi_op_search;
1700 BI_op_compare *bi_op_compare;
1701 BI_op_modify *bi_op_modify;
1702 BI_op_modrdn *bi_op_modrdn;
1703 BI_op_add *bi_op_add;
1704 BI_op_delete *bi_op_delete;
1705 BI_op_abandon *bi_op_abandon;
1706 BI_op_cancel *bi_op_cancel;
1708 /* Extended Operations Helper */
1709 BI_op_extended *bi_extended;
1711 /* Auxilary Functions */
1712 BI_entry_get_rw *bi_entry_get_rw;
1713 BI_entry_release_rw *bi_entry_release_rw;
1714 BI_chk_referrals *bi_chk_referrals;
1716 BI_operational *bi_operational;
1717 BI_has_subordinates *bi_has_subordinates;
1719 BI_connection_init *bi_connection_init;
1720 BI_connection_destroy *bi_connection_destroy;
1722 /* hooks for slap tools */
1723 BI_tool_entry_open *bi_tool_entry_open;
1724 BI_tool_entry_close *bi_tool_entry_close;
1725 BI_tool_entry_first *bi_tool_entry_first;
1726 BI_tool_entry_next *bi_tool_entry_next;
1727 BI_tool_entry_get *bi_tool_entry_get;
1728 BI_tool_entry_put *bi_tool_entry_put;
1729 BI_tool_entry_reindex *bi_tool_entry_reindex;
1730 BI_tool_sync *bi_tool_sync;
1732 #define SLAP_INDEX_ADD_OP 0x0001
1733 #define SLAP_INDEX_DELETE_OP 0x0002
1735 char **bi_controls; /* supported controls */
1737 unsigned int bi_nDB; /* number of databases of this type */
1738 void *bi_private; /* anything the backend type needs */
1741 #define c_authtype c_authz.sai_method
1742 #define c_authmech c_authz.sai_mech
1743 #define c_dn c_authz.sai_dn
1744 #define c_ndn c_authz.sai_ndn
1745 #define c_ssf c_authz.sai_ssf
1746 #define c_transport_ssf c_authz.sai_transport_ssf
1747 #define c_tls_ssf c_authz.sai_tls_ssf
1748 #define c_sasl_ssf c_authz.sai_sasl_ssf
1750 #define o_authtype o_authz.sai_method
1751 #define o_authmech o_authz.sai_mech
1752 #define o_dn o_authz.sai_dn
1753 #define o_ndn o_authz.sai_ndn
1754 #define o_ssf o_authz.sai_ssf
1755 #define o_transport_ssf o_authz.sai_transport_ssf
1756 #define o_tls_ssf o_authz.sai_tls_ssf
1757 #define o_sasl_ssf o_authz.sai_sasl_ssf
1759 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1761 typedef struct slap_callback {
1762 slap_response *sc_response;
1766 struct slap_overinfo;
1768 typedef struct slap_overinst {
1770 slap_response *on_response;
1772 struct slap_overinfo *on_info;
1773 struct slap_overinst *on_next;
1776 typedef struct slap_overinfo {
1779 slap_overinst *oi_list;
1783 * Paged Results state
1785 typedef unsigned long PagedResultsCookie;
1786 typedef struct slap_paged_state {
1788 PagedResultsCookie ps_cookie;
1790 } PagedResultsState;
1793 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1794 #define LDAP_PSEARCH_BY_ADD 0x01
1795 #define LDAP_PSEARCH_BY_DELETE 0x02
1796 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1797 #define LDAP_PSEARCH_BY_MODIFY 0x04
1798 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1801 struct slap_op *ps_op;
1802 LDAP_LIST_ENTRY(psid_entry) ps_link;
1808 * represents an operation pending from an ldap client
1810 typedef struct slap_op {
1811 unsigned long o_opid; /* id of this operation */
1812 unsigned long o_connid; /* id of conn initiating this op */
1813 struct slap_conn *o_conn; /* connection spawning this op */
1814 BackendDB *o_bd; /* backend DB processing this op */
1816 ber_int_t o_msgid; /* msgid of the request */
1817 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1818 ber_tag_t o_tag; /* tag of the request */
1819 time_t o_time; /* time op was initiated */
1821 struct berval o_req_dn; /* DN of target of request */
1822 struct berval o_req_ndn;
1827 req_compare_s oq_compare;
1828 req_modify_s oq_modify;
1829 req_modrdn_s oq_modrdn;
1830 req_search_s oq_search;
1831 req_abandon_s oq_abandon;
1832 req_abandon_s oq_cancel;
1833 req_extended_s oq_extended;
1836 /* short hands for union members */
1837 #define oq_add o_request.oq_add
1838 #define oq_bind o_request.oq_bind
1839 #define oq_compare o_request.oq_compare
1840 #define oq_modify o_request.oq_modify
1841 #define oq_modrdn o_request.oq_modrdn
1842 #define oq_search o_request.oq_search
1843 #define oq_abandon o_request.oq_abandon
1844 #define oq_cancel o_request.oq_cancel
1845 #define oq_extended o_request.oq_extended
1847 /* short hands for inner request members */
1848 #define orb_method oq_bind.rb_method
1849 #define orb_cred oq_bind.rb_cred
1850 #define orb_edn oq_bind.rb_edn
1851 #define orb_ssf oq_bind.rb_ssf
1853 #define ors_scope oq_search.rs_scope
1854 #define ors_deref oq_search.rs_deref
1855 #define ors_slimit oq_search.rs_slimit
1856 #define ors_tlimit oq_search.rs_tlimit
1857 #define ors_attrsonly oq_search.rs_attrsonly
1858 #define ors_attrs oq_search.rs_attrs
1859 #define ors_filter oq_search.rs_filter
1860 #define ors_filterstr oq_search.rs_filterstr
1862 #define orr_newrdn oq_modrdn.rs_newrdn
1863 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1864 #define orr_newSup oq_modrdn.rs_newSup
1865 #define orr_nnewSup oq_modrdn.rs_nnewSup
1866 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1868 #define orc_ava oq_compare.rs_ava
1869 #define ora_e oq_add.rs_e
1870 #define orn_msgid oq_abandon.rs_msgid
1871 #define orm_modlist oq_modify.rs_modlist
1873 #define ore_reqoid oq_extended.rs_reqoid
1874 #define ore_reqdata oq_extended.rs_reqdata
1876 ldap_pvt_thread_t o_tid; /* thread handling this op */
1878 volatile sig_atomic_t o_abandon; /* abandon flag */
1879 volatile sig_atomic_t o_cancel; /* cancel flag */
1880 #define SLAP_CANCEL_NONE 0x00
1881 #define SLAP_CANCEL_REQ 0x01
1882 #define SLAP_CANCEL_ACK 0x02
1883 #define SLAP_CANCEL_DONE 0x03
1885 char o_do_not_cache; /* don't cache from this op */
1886 char o_is_auth_check; /* authorization in progress */
1888 #define SLAP_NO_CONTROL 0
1889 #define SLAP_NONCRITICAL_CONTROL 1
1890 #define SLAP_CRITICAL_CONTROL 2
1892 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1898 #define get_subentries(op) ((int)(op)->o_subentries)
1899 char o_subentries_visibility;
1900 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1903 #define get_assert(op) ((int)(op)->o_assert)
1905 char o_valuesreturnfilter;
1907 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1908 char o_permissive_modify;
1909 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1911 #define get_permissiveModify(op) (0)
1914 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1915 char o_domain_scope;
1916 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1918 #define get_domainScope(op) (0)
1921 #ifdef LDAP_CONTROL_PAGEDRESULTS
1922 char o_pagedresults;
1923 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1924 ber_int_t o_pagedresults_size;
1925 PagedResultsState o_pagedresults_state;
1927 #define get_pagedresults(op) (0)
1930 #ifdef LDAP_CLIENT_UPDATE
1931 char o_clientupdate;
1932 char o_clientupdate_type;
1933 #define SLAP_LCUP_NONE (0x0)
1934 #define SLAP_LCUP_SYNC (0x1)
1935 #define SLAP_LCUP_PERSIST (0x2)
1936 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1937 ber_int_t o_clientupdate_interval;
1938 struct berval o_clientupdate_state;
1944 #define SLAP_SYNC_NONE (0x0)
1945 #define SLAP_SYNC_REFRESH (0x1)
1946 #define SLAP_SYNC_PERSIST (0x2)
1947 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1948 struct berval o_sync_state;
1951 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1954 LDAP_LIST_ENTRY(slap_op) o_ps_link;
1955 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1958 AuthorizationInformation o_authz;
1960 BerElement *o_ber; /* ber of the request */
1961 #ifdef LDAP_CONNECTIONLESS
1962 BerElement *o_res_ber; /* ber of the reply */
1964 slap_callback *o_callback; /* callback pointers */
1965 LDAPControl **o_ctrls; /* controls */
1967 void *o_threadctx; /* thread pool thread context */
1968 void *o_tmpmemctx; /* slab malloc context */
1969 BerMemoryFunctions *o_tmpmfuncs;
1970 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
1971 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
1972 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
1973 #define o_tmpfree o_tmpmfuncs->bmf_free
1974 void *o_private; /* anything the backend needs */
1976 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1978 Filter *o_assertion; /* Assert control filter */
1979 #define get_assertion(op) ((op)->o_assertion)
1980 ValuesReturnFilter *o_vrFilter; /* ValuesReturnFilter */
1984 #endif /*LDAP_CACHING */
1987 void *o_pb; /* NS-SLAPI plugin */
1991 #define send_ldap_error( op, rs, err, text ) do { \
1992 (rs)->sr_err = err; (rs)->sr_text = text; \
1993 (op->o_conn->c_send_ldap_result)( op, rs ); \
1995 #define send_ldap_discon( op, rs, err, text ) do { \
1996 (rs)->sr_err = err; (rs)->sr_text = text; \
1997 send_ldap_disconnect( op, rs ); \
2000 typedef void (SEND_LDAP_RESULT)(
2001 struct slap_op *op, struct slap_rep *rs);
2002 typedef int (SEND_SEARCH_ENTRY)(
2003 struct slap_op *op, struct slap_rep *rs);
2004 typedef int (SEND_SEARCH_REFERENCE)(
2005 struct slap_op *op, struct slap_rep *rs);
2006 typedef void (SEND_LDAP_EXTENDED)(
2007 struct slap_op *op, struct slap_rep *rs);
2008 typedef void (SEND_LDAP_INTERMEDIATE)(
2009 struct slap_op *op, struct slap_rep *rs);
2011 #define send_ldap_result( op, rs ) \
2012 (op->o_conn->c_send_ldap_result)( op, rs )
2013 #define send_search_entry( op, rs ) \
2014 (op->o_conn->c_send_search_entry)( op, rs )
2015 #define send_search_reference( op, rs ) \
2016 (op->o_conn->c_send_search_reference)( op, rs )
2017 #define send_ldap_extended( op, rs ) \
2018 (op->o_conn->c_send_ldap_extended)( op, rs )
2019 #define send_ldap_intermediate( op, rs ) \
2020 (op->o_conn->c_send_ldap_intermediate)( op, rs )
2023 * Caches the result of a backend_group check for ACL evaluation
2025 typedef struct slap_gacl {
2026 struct slap_gacl *ga_next;
2029 AttributeDescription *ga_at;
2035 typedef struct slap_listener Listener;
2038 * represents a connection from an ldap client
2040 typedef struct slap_conn {
2041 int c_struct_state; /* structure management state */
2042 int c_conn_state; /* connection state */
2044 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2045 Sockbuf *c_sb; /* ber connection stuff */
2047 /* only can be changed by connect_init */
2048 time_t c_starttime; /* when the connection was opened */
2049 time_t c_activitytime; /* when the connection was last used */
2050 unsigned long c_connid; /* id of this connection for stats*/
2052 struct berval c_peer_domain; /* DNS name of client */
2053 struct berval c_peer_name; /* peer name (trans=addr:port) */
2054 Listener *c_listener;
2055 #define c_listener_url c_listener->sl_url /* listener URL */
2056 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2058 /* only can be changed by binding thread */
2059 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2060 struct berval c_sasl_bind_mech; /* mech in progress */
2061 struct berval c_sasl_dn; /* temporary storage */
2063 /* authorization backend */
2064 Backend *c_authz_backend;
2066 AuthorizationInformation c_authz;
2067 GroupAssertion *c_groups;
2069 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2071 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2072 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2074 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2075 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2077 BerElement *c_currentber; /* ber we're attempting to read */
2078 int c_writewaiter; /* true if writer is waiting */
2080 #ifdef LDAP_CONNECTIONLESS
2081 int c_is_udp; /* true if this is (C)LDAP over UDP */
2084 int c_is_tls; /* true if this LDAP over raw TLS */
2085 int c_needs_tls_accept; /* true if SSL_accept should be called */
2087 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2088 int c_sasl_done; /* SASL completed once */
2089 void *c_sasl_authctx; /* SASL authentication context */
2090 void *c_sasl_sockctx; /* SASL security layer context */
2091 void *c_sasl_extra; /* SASL session extra stuff */
2092 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2094 PagedResultsState c_pagedresults_state; /* paged result state */
2096 long c_n_ops_received; /* num of ops received (next op_id) */
2097 long c_n_ops_executing; /* num of ops currently executing */
2098 long c_n_ops_pending; /* num of ops pending execution */
2099 long c_n_ops_completed; /* num of ops completed */
2101 long c_n_get; /* num of get calls */
2102 long c_n_read; /* num of read calls */
2103 long c_n_write; /* num of write calls */
2105 void *c_pb; /* Netscape plugin */
2108 * These are the "callbacks" that are available for back-ends to
2109 * supply data back to connected clients that are connected
2110 * through the "front-end".
2112 SEND_LDAP_RESULT *c_send_ldap_result;
2113 SEND_SEARCH_ENTRY *c_send_search_entry;
2114 SEND_SEARCH_REFERENCE *c_send_search_reference;
2115 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2116 #ifdef LDAP_RES_INTERMEDIATE
2117 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2122 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2123 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2125 if ( ldap_debug & (level) ) \
2126 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2127 if ( ldap_syslog & (level) ) \
2128 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2131 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2132 #elif defined(LDAP_DEBUG)
2133 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2135 if ( ldap_debug & (level) ) \
2136 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2138 #define StatslogTest( level ) (ldap_debug & (level))
2140 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2141 #define StatslogTest( level ) (0)
2145 * listener; need to access it from monitor backend
2147 struct slap_listener {
2148 struct berval sl_url;
2149 struct berval sl_name;
2154 #ifdef LDAP_CONNECTIONLESS
2155 int sl_is_udp; /* UDP listener is also data port */
2157 int sl_is_mute; /* Listening is temporarily disabled */
2160 #define sl_addr sl_sa.sa_in_addr
2163 #ifdef SLAPD_MONITOR
2180 #endif /* SLAPD_MONITOR */
2183 * Better know these all around slapd
2185 #define SLAP_LDAPDN_PRETTY 0x1
2186 #define SLAP_LDAPDN_MAXLEN 8192
2191 #ifdef LDAP_CLIENT_UPDATE
2192 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2193 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2194 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2195 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2196 #endif /* LDAP_CLIENT_UPDATE */
2198 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2199 #define SLAP_SEARCH_MAX_CTRLS 10
2203 #define SLAP_CTRL_HIDE 0x00000000U
2205 #define SLAP_CTRL_HIDE 0x80000000U
2208 #define SLAP_CTRL_FRONTEND 0x00800000U
2209 #define SLAP_CTRL_FRONTEND_SEARCH 0x00010000U /* for NOOP */
2211 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2212 #define SLAP_CTRL_ABANDON 0x00000001U
2213 #define SLAP_CTRL_ADD 0x00002002U
2214 #define SLAP_CTRL_BIND 0x00000004U
2215 #define SLAP_CTRL_COMPARE 0x00001008U
2216 #define SLAP_CTRL_DELETE 0x00002010U
2217 #define SLAP_CTRL_MODIFY 0x00002020U
2218 #define SLAP_CTRL_RENAME 0x00002040U
2219 #define SLAP_CTRL_SEARCH 0x00001080U
2220 #define SLAP_CTRL_UNBIND 0x00000100U
2222 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2223 #define SLAP_CTRL_UPDATE \
2224 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2225 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2227 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2230 LDAPControl *ctrl ));
2234 #include "proto-slap.h"
2236 #endif /* _SLAP_H_ */