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"
41 * SLAPD Memory allocation macros
43 * Unlike ch_*() routines, these routines do not assert() upon
44 * allocation error. They are intended to be used instead of
45 * ch_*() routines where the caller has implemented proper
46 * checking for and handling of allocation errors.
48 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
50 #define SLAP_MALLOC(s) ber_memalloc((s))
51 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
52 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
53 #define SLAP_FREE(p) ber_memfree((p))
54 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
55 #define SLAP_STRDUP(s) ber_strdup((s))
56 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
59 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
62 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
63 #define SLAPD_ANONYMOUS "cn=anonymous"
65 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
66 * This is a value used internally by the backends. It is needed to allow
67 * adding values that already exist without getting an error as required by
68 * modrdn when the new rdn was already an attribute value itself.
70 #define SLAP_MOD_SOFTADD 0x1000
72 #define MAXREMATCHES (100)
74 #define SLAP_MAX_WORKER_THREADS (16)
76 #define SLAP_MAX_SYNCREPL_THREADS (8)
78 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
79 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
81 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
82 #define SLAP_CONN_MAX_PENDING_AUTH 1000
84 #define SLAP_TEXT_BUFLEN (256)
86 /* psuedo error code indicating abandoned operation */
87 #define SLAPD_ABANDON (-1)
89 /* psuedo error code indicating disconnect */
90 #define SLAPD_DISCONNECT (-2)
93 /* We assume "C" locale, that is US-ASCII */
94 #define ASCII_SPACE(c) ( (c) == ' ' )
95 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
96 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
97 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
98 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
99 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'h' )
100 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'H' )
101 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
102 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
103 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
104 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
106 #define SLAP_NIBBLE(c) ((c)&0x0f)
107 #define SLAP_ESCAPE_CHAR ('\\')
108 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
109 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
111 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
112 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
114 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
115 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
116 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
117 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
118 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
120 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
121 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
122 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
123 #define OID_SEPARATOR(c) ( (c) == '.' )
124 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
126 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
127 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
129 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
130 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
132 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
134 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
135 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
136 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
137 (c) == '?' || (c) == ' ' || (c) == '=' )
138 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
140 /* must match in schema_init.c */
141 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
142 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
143 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
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"
233 * represents schema information for a database
235 #define SLAP_SCHERR_OUTOFMEM 1
236 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
237 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
238 #define SLAP_SCHERR_CLASS_BAD_SUP 4
239 #define SLAP_SCHERR_CLASS_DUP 5
240 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
241 #define SLAP_SCHERR_ATTR_BAD_MR 7
242 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
243 #define SLAP_SCHERR_ATTR_BAD_SUP 9
244 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
245 #define SLAP_SCHERR_ATTR_DUP 11
246 #define SLAP_SCHERR_MR_NOT_FOUND 12
247 #define SLAP_SCHERR_MR_INCOMPLETE 13
248 #define SLAP_SCHERR_MR_DUP 14
249 #define SLAP_SCHERR_SYN_NOT_FOUND 15
250 #define SLAP_SCHERR_SYN_DUP 16
251 #define SLAP_SCHERR_NO_NAME 17
252 #define SLAP_SCHERR_NOT_SUPPORTED 18
253 #define SLAP_SCHERR_BAD_DESCR 19
254 #define SLAP_SCHERR_OIDM 20
255 #define SLAP_SCHERR_CR_DUP 21
256 #define SLAP_SCHERR_CR_BAD_STRUCT 22
257 #define SLAP_SCHERR_CR_BAD_AUX 23
258 #define SLAP_SCHERR_CR_BAD_AT 24
259 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
261 typedef union slap_sockaddr {
262 struct sockaddr sa_addr;
263 struct sockaddr_in sa_in_addr;
265 struct sockaddr_storage sa_storage;
266 struct sockaddr_in6 sa_in6_addr;
269 struct sockaddr_un sa_un_addr;
274 extern int slap_inet4or6;
277 typedef struct slap_oid_macro {
278 struct berval som_oid;
280 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
283 /* forward declarations */
285 struct slap_matching_rule;
287 typedef int slap_syntax_validate_func LDAP_P((
288 struct slap_syntax *syntax,
289 struct berval * in));
291 typedef int slap_syntax_transform_func LDAP_P((
292 struct slap_syntax *syntax,
297 typedef struct slap_syntax {
299 #define ssyn_oid ssyn_syn.syn_oid
300 #define ssyn_desc ssyn_syn.syn_desc
301 #define ssyn_extensions ssyn_syn.syn_extensions
304 ber_len_t ssyn_oidlen;
305 * has been replaced by a struct berval that uses the value
306 * provided by ssyn_syn.syn_oid; a macro that expands to
307 * the bv_len field of the berval is provided for backward
308 * compatibility. CAUTION: NEVER FREE THE BERVAL
310 struct berval ssyn_bvoid;
311 #define ssyn_oidlen ssyn_bvoid.bv_len
313 unsigned int ssyn_flags;
315 #define SLAP_SYNTAX_NONE 0x0000U
316 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
317 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
318 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
320 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
322 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
325 slap_syntax_validate_func *ssyn_validate;
326 slap_syntax_transform_func *ssyn_pretty;
328 #ifdef SLAPD_BINARY_CONVERSION
329 /* convert to and from binary */
330 slap_syntax_transform_func *ssyn_ber2str;
331 slap_syntax_transform_func *ssyn_str2ber;
334 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
337 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
338 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
339 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
340 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
341 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
343 typedef struct slap_syntax_defs_rec {
346 slap_syntax_validate_func *sd_validate;
347 slap_syntax_transform_func *sd_pretty;
348 #ifdef SLAPD_BINARY_CONVERSION
349 slap_syntax_transform_func *sd_ber2str;
350 slap_syntax_transform_func *sd_str2ber;
352 } slap_syntax_defs_rec;
354 /* X -> Y Converter */
355 typedef int slap_mr_convert_func LDAP_P((
361 typedef int slap_mr_normalize_func LDAP_P((
363 struct slap_syntax *syntax, /* NULL if in is asserted value */
364 struct slap_matching_rule *mr,
369 /* Match (compare) function */
370 typedef int slap_mr_match_func LDAP_P((
373 struct slap_syntax *syntax, /* syntax of stored value */
374 struct slap_matching_rule *mr,
375 struct berval * value,
376 void * assertValue ));
378 /* Index generation function */
379 typedef int slap_mr_indexer_func LDAP_P((
382 struct slap_syntax *syntax, /* syntax of stored value */
383 struct slap_matching_rule *mr,
384 struct berval *prefix,
389 /* Filter index function */
390 typedef int slap_mr_filter_func LDAP_P((
393 struct slap_syntax *syntax, /* syntax of stored value */
394 struct slap_matching_rule *mr,
395 struct berval *prefix,
400 typedef struct slap_matching_rule_use MatchingRuleUse;
402 typedef struct slap_matching_rule {
403 LDAPMatchingRule smr_mrule;
404 MatchingRuleUse *smr_mru;
405 /* RFC2252 string representation */
406 struct berval smr_str;
409 * ber_len_t smr_oidlen;
410 * has been replaced by a struct berval that uses the value
411 * provided by smr_mrule.mr_oid; a macro that expands to
412 * the bv_len field of the berval is provided for backward
413 * compatibility. CAUTION: NEVER FREE THE BERVAL
415 struct berval smr_bvoid;
416 #define smr_oidlen smr_bvoid.bv_len
418 slap_mask_t smr_usage;
421 #define SLAP_MR_HIDE 0x0000U
423 #define SLAP_MR_HIDE 0x8000U
426 #define SLAP_MR_TYPE_MASK 0x0F00U
427 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
428 #define SLAP_MR_USAGE 0x000FU
430 #define SLAP_MR_NONE 0x0000U
431 #define SLAP_MR_EQUALITY 0x0100U
432 #define SLAP_MR_ORDERING 0x0200U
433 #define SLAP_MR_SUBSTR 0x0400U
434 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
436 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
438 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
439 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
440 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
444 * The asserted value, depending on the particular usage,
445 * is expected to conform to either the assertion syntax
446 * or the attribute syntax. In some cases, the syntax of
447 * the value is known. If so, these flags indicate which
448 * syntax the value is expected to conform to. If not,
449 * neither of these flags is set (until the syntax of the
450 * provided value is determined). If the value is of the
451 * attribute syntax, the flag is changed once a value of
452 * the assertion syntax is derived from the provided value.
454 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
455 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
456 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
458 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
459 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
460 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
461 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
463 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
464 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
466 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
469 /* either or both the asserted value or attribute value
470 * may be provided in normalized form
472 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
473 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
475 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
476 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
477 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
478 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
480 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
481 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
482 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
483 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
484 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
485 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
487 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
488 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
489 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
490 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
493 slap_mr_convert_func *smr_convert;
494 slap_mr_normalize_func *smr_normalize;
495 slap_mr_match_func *smr_match;
496 slap_mr_indexer_func *smr_indexer;
497 slap_mr_filter_func *smr_filter;
500 * null terminated array of syntaxes compatible with this syntax
501 * note: when MS_EXT is set, this MUST NOT contain the assertion
502 * syntax of the rule. When MS_EXT is not set, it MAY.
504 Syntax **smr_compat_syntaxes;
507 * For equality rules, refers to an associated approximate rule.
508 * For non-equality rules, refers to an associated equality rule.
510 struct slap_matching_rule *smr_associated;
512 #define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \
513 ((mr)->smr_associated == (amr)))
515 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
517 #define smr_oid smr_mrule.mr_oid
518 #define smr_names smr_mrule.mr_names
519 #define smr_desc smr_mrule.mr_desc
520 #define smr_obsolete smr_mrule.mr_obsolete
521 #define smr_syntax_oid smr_mrule.mr_syntax_oid
522 #define smr_extensions smr_mrule.mr_extensions
525 struct slap_matching_rule_use {
526 LDAPMatchingRuleUse smru_mruleuse;
527 MatchingRule *smru_mr;
528 /* RFC2252 string representation */
529 struct berval smru_str;
531 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
533 #define smru_oid smru_mruleuse.mru_oid
534 #define smru_names smru_mruleuse.mru_names
535 #define smru_desc smru_mruleuse.mru_desc
536 #define smru_obsolete smru_mruleuse.mru_obsolete
537 #define smru_applies_oids smru_mruleuse.mru_applies_oids
539 #define smru_usage smru_mr->smr_usage
540 } /* MatchingRuleUse */ ;
542 typedef struct slap_mrule_defs_rec {
544 slap_mask_t mrd_usage;
545 char ** mrd_compat_syntaxes;
546 slap_mr_convert_func * mrd_convert;
547 slap_mr_normalize_func * mrd_normalize;
548 slap_mr_match_func * mrd_match;
549 slap_mr_indexer_func * mrd_indexer;
550 slap_mr_filter_func * mrd_filter;
552 /* For equality rule, this may refer to an associated approximate rule */
553 /* For non-equality rule, this may refer to an associated equality rule */
554 char * mrd_associated;
555 } slap_mrule_defs_rec;
557 struct slap_backend_db;
561 typedef int (AttributeTypeSchemaCheckFN)(
562 struct slap_backend_db *be,
563 struct slap_entry *e,
564 struct slap_attr *attr,
566 char *textbuf, size_t textlen );
568 typedef struct slap_attribute_type {
569 LDAPAttributeType sat_atype;
570 struct berval sat_cname;
571 struct slap_attribute_type *sat_sup;
572 struct slap_attribute_type **sat_subtypes;
573 MatchingRule *sat_equality;
574 MatchingRule *sat_approx;
575 MatchingRule *sat_ordering;
576 MatchingRule *sat_substr;
579 AttributeTypeSchemaCheckFN *sat_check;
581 #define SLAP_AT_NONE 0x0000U
582 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
583 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
585 #define SLAP_AT_HIDE 0x0000U /* publish everything */
587 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
589 slap_mask_t sat_flags;
591 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
593 #define sat_oid sat_atype.at_oid
594 #define sat_names sat_atype.at_names
595 #define sat_desc sat_atype.at_desc
596 #define sat_obsolete sat_atype.at_obsolete
597 #define sat_sup_oid sat_atype.at_sup_oid
598 #define sat_equality_oid sat_atype.at_equality_oid
599 #define sat_ordering_oid sat_atype.at_ordering_oid
600 #define sat_substr_oid sat_atype.at_substr_oid
601 #define sat_syntax_oid sat_atype.at_syntax_oid
602 #define sat_single_value sat_atype.at_single_value
603 #define sat_collective sat_atype.at_collective
604 #define sat_no_user_mod sat_atype.at_no_user_mod
605 #define sat_usage sat_atype.at_usage
606 #define sat_extensions sat_atype.at_extensions
608 struct slap_attr_desc *sat_ad;
609 ldap_pvt_thread_mutex_t sat_ad_mutex;
612 #define is_at_operational(at) ((at)->sat_usage)
613 #define is_at_single_value(at) ((at)->sat_single_value)
614 #define is_at_collective(at) ((at)->sat_collective)
615 #define is_at_obsolete(at) ((at)->sat_obsolete)
616 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
618 struct slap_object_class;
620 typedef int (ObjectClassSchemaCheckFN)(
621 struct slap_backend_db *be,
622 struct slap_entry *e,
623 struct slap_object_class *oc,
625 char *textbuf, size_t textlen );
627 typedef struct slap_object_class {
628 LDAPObjectClass soc_oclass;
629 struct berval soc_cname;
630 struct slap_object_class **soc_sups;
631 AttributeType **soc_required;
632 AttributeType **soc_allowed;
633 ObjectClassSchemaCheckFN *soc_check;
634 slap_mask_t soc_flags;
635 #define soc_oid soc_oclass.oc_oid
636 #define soc_names soc_oclass.oc_names
637 #define soc_desc soc_oclass.oc_desc
638 #define soc_obsolete soc_oclass.oc_obsolete
639 #define soc_sup_oids soc_oclass.oc_sup_oids
640 #define soc_kind soc_oclass.oc_kind
641 #define soc_at_oids_must soc_oclass.oc_at_oids_must
642 #define soc_at_oids_may soc_oclass.oc_at_oids_may
643 #define soc_extensions soc_oclass.oc_extensions
645 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
648 #define SLAP_OC_ALIAS 0x0001
649 #define SLAP_OC_REFERRAL 0x0002
650 #define SLAP_OC_SUBENTRY 0x0004
651 #define SLAP_OC_DYNAMICOBJECT 0x0008
652 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
653 #define SLAP_OC_GLUE 0x0020
654 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
655 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
656 #define SLAP_OC__MASK 0x00FF
657 #define SLAP_OC__END 0x0100
658 #define SLAP_OC_OPERATIONAL 0x4000
660 #define SLAP_OC_HIDE 0x0000
662 #define SLAP_OC_HIDE 0x8000
668 typedef struct slap_content_rule {
669 LDAPContentRule scr_crule;
670 ObjectClass *scr_sclass;
671 ObjectClass **scr_auxiliaries; /* optional */
672 AttributeType **scr_required; /* optional */
673 AttributeType **scr_allowed; /* optional */
674 AttributeType **scr_precluded; /* optional */
675 #define scr_oid scr_crule.cr_oid
676 #define scr_names scr_crule.cr_names
677 #define scr_desc scr_crule.cr_desc
678 #define scr_obsolete scr_crule.cr_obsolete
679 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
680 #define scr_at_oids_must scr_crule.cr_at_oids_must
681 #define scr_at_oids_may scr_crule.cr_at_oids_may
682 #define scr_at_oids_not scr_crule.cr_at_oids_not
684 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
687 /* Represents a recognized attribute description ( type + options ). */
688 typedef struct slap_attr_desc {
689 struct slap_attr_desc *ad_next;
690 AttributeType *ad_type; /* attribute type, must be specified */
691 struct berval ad_cname; /* canonical name, must be specified */
692 struct berval ad_tags; /* empty if no tagging options */
694 #define SLAP_DESC_NONE 0x00U
695 #define SLAP_DESC_BINARY 0x01U
696 #define SLAP_DESC_TAG_RANGE 0x80U
697 } AttributeDescription;
699 typedef struct slap_attr_name {
700 struct berval an_name;
701 AttributeDescription *an_desc;
705 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
706 #define slap_ad_is_tag_range(ad) \
707 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
708 #define slap_ad_is_binary(ad) \
709 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
712 * pointers to schema elements used internally
714 struct slap_internal_schema {
716 ObjectClass *si_oc_top;
717 ObjectClass *si_oc_extensibleObject;
718 ObjectClass *si_oc_alias;
719 ObjectClass *si_oc_referral;
720 ObjectClass *si_oc_rootdse;
721 ObjectClass *si_oc_subentry;
722 ObjectClass *si_oc_subschema;
723 ObjectClass *si_oc_collectiveAttributeSubentry;
724 ObjectClass *si_oc_dynamicObject;
726 ObjectClass *si_oc_glue;
727 ObjectClass *si_oc_syncConsumerSubentry;
728 ObjectClass *si_oc_syncProviderSubentry;
730 /* objectClass attribute descriptions */
731 AttributeDescription *si_ad_objectClass;
733 /* operational attribute descriptions */
734 AttributeDescription *si_ad_structuralObjectClass;
735 AttributeDescription *si_ad_creatorsName;
736 AttributeDescription *si_ad_createTimestamp;
737 AttributeDescription *si_ad_modifiersName;
738 AttributeDescription *si_ad_modifyTimestamp;
739 AttributeDescription *si_ad_hasSubordinates;
740 AttributeDescription *si_ad_subschemaSubentry;
741 AttributeDescription *si_ad_collectiveSubentries;
742 AttributeDescription *si_ad_collectiveExclusions;
743 AttributeDescription *si_ad_entryUUID;
744 AttributeDescription *si_ad_entryCSN;
745 AttributeDescription *si_ad_namingCSN;
746 AttributeDescription *si_ad_superiorUUID;
748 /* LDAP cache specific operational attribute */
749 AttributeDescription *si_ad_queryid;
751 AttributeDescription *si_ad_dseType;
752 AttributeDescription *si_ad_syncreplCookie;
753 AttributeDescription *si_ad_contextCSN;
755 /* root DSE attribute descriptions */
756 AttributeDescription *si_ad_altServer;
757 AttributeDescription *si_ad_namingContexts;
758 AttributeDescription *si_ad_supportedControl;
759 AttributeDescription *si_ad_supportedExtension;
760 AttributeDescription *si_ad_supportedLDAPVersion;
761 AttributeDescription *si_ad_supportedSASLMechanisms;
762 AttributeDescription *si_ad_supportedFeatures;
763 AttributeDescription *si_ad_monitorContext;
764 AttributeDescription *si_ad_vendorName;
765 AttributeDescription *si_ad_vendorVersion;
767 /* subentry attribute descriptions */
768 AttributeDescription *si_ad_administrativeRole;
769 AttributeDescription *si_ad_subtreeSpecification;
771 /* subschema subentry attribute descriptions */
772 AttributeDescription *si_ad_ditStructureRules;
773 AttributeDescription *si_ad_ditContentRules;
774 AttributeDescription *si_ad_nameForms;
775 AttributeDescription *si_ad_objectClasses;
776 AttributeDescription *si_ad_attributeTypes;
777 AttributeDescription *si_ad_ldapSyntaxes;
778 AttributeDescription *si_ad_matchingRules;
779 AttributeDescription *si_ad_matchingRuleUse;
781 /* Aliases & Referrals */
782 AttributeDescription *si_ad_aliasedObjectName;
783 AttributeDescription *si_ad_ref;
785 /* Access Control Internals */
786 AttributeDescription *si_ad_entry;
787 AttributeDescription *si_ad_children;
788 AttributeDescription *si_ad_saslAuthzTo;
789 AttributeDescription *si_ad_saslAuthzFrom;
790 #ifdef SLAPD_ACI_ENABLED
791 AttributeDescription *si_ad_aci;
794 /* dynamic entries */
795 AttributeDescription *si_ad_entryTtl;
796 AttributeDescription *si_ad_dynamicSubtrees;
798 /* Other attributes descriptions */
799 AttributeDescription *si_ad_distinguishedName;
800 AttributeDescription *si_ad_name;
801 AttributeDescription *si_ad_cn;
802 AttributeDescription *si_ad_userPassword;
803 AttributeDescription *si_ad_labeledURI;
804 #ifdef SLAPD_AUTHPASSWD
805 AttributeDescription *si_ad_authPassword;
807 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
808 AttributeDescription *si_ad_krbName;
811 /* Undefined Attribute Type */
812 AttributeType *si_at_undefined;
815 MatchingRule *si_mr_distinguishedNameMatch;
816 MatchingRule *si_mr_caseExactMatch;
817 MatchingRule *si_mr_caseExactSubstringsMatch;
818 MatchingRule *si_mr_caseExactIA5Match;
819 MatchingRule *si_mr_integerMatch;
820 MatchingRule *si_mr_integerFirstComponentMatch;
821 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
824 Syntax *si_syn_directoryString;
825 Syntax *si_syn_distinguishedName;
826 Syntax *si_syn_integer;
827 Syntax *si_syn_octetString;
830 typedef struct slap_attr_assertion {
831 AttributeDescription *aa_desc;
832 struct berval aa_value;
833 } AttributeAssertion;
835 typedef struct slap_ss_assertion {
836 AttributeDescription *sa_desc;
837 struct berval sa_initial;
838 struct berval *sa_any;
839 struct berval sa_final;
840 } SubstringsAssertion;
842 typedef struct slap_mr_assertion {
843 MatchingRule *ma_rule; /* optional */
844 struct berval ma_rule_text; /* optional */
845 AttributeDescription *ma_desc; /* optional */
846 int ma_dnattrs; /* boolean */
847 struct berval ma_value; /* required */
848 } MatchingRuleAssertion;
851 * represents a search filter
853 typedef struct slap_filter {
854 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
855 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
856 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
857 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
860 /* precomputed result */
861 ber_int_t f_un_result;
864 struct berval *f_un_dn;
867 AttributeDescription *f_un_desc;
869 /* simple value assertion */
870 AttributeAssertion *f_un_ava;
872 /* substring assertion */
873 SubstringsAssertion *f_un_ssa;
875 /* matching rule assertion */
876 MatchingRuleAssertion *f_un_mra;
878 #define f_dn f_un.f_un_dn
879 #define f_desc f_un.f_un_desc
880 #define f_ava f_un.f_un_ava
881 #define f_av_desc f_un.f_un_ava->aa_desc
882 #define f_av_value f_un.f_un_ava->aa_value
883 #define f_sub f_un.f_un_ssa
884 #define f_sub_desc f_un.f_un_ssa->sa_desc
885 #define f_sub_initial f_un.f_un_ssa->sa_initial
886 #define f_sub_any f_un.f_un_ssa->sa_any
887 #define f_sub_final f_un.f_un_ssa->sa_final
888 #define f_mra f_un.f_un_mra
889 #define f_mr_rule f_un.f_un_mra->ma_rule
890 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
891 #define f_mr_desc f_un.f_un_mra->ma_desc
892 #define f_mr_value f_un.f_un_mra->ma_value
893 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
896 struct slap_filter *f_un_complex;
899 #define f_result f_un.f_un_result
900 #define f_and f_un.f_un_complex
901 #define f_or f_un.f_un_complex
902 #define f_not f_un.f_un_complex
903 #define f_list f_un.f_un_complex
905 struct slap_filter *f_next;
908 /* compare routines can return undefined */
909 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
911 typedef struct slap_valuesreturnfilter {
912 ber_tag_t vrf_choice;
915 /* precomputed result */
916 ber_int_t vrf_un_result;
922 AttributeDescription *vrf_un_desc;
924 /* simple value assertion */
925 AttributeAssertion *vrf_un_ava;
927 /* substring assertion */
928 SubstringsAssertion *vrf_un_ssa;
930 /* matching rule assertion */
931 MatchingRuleAssertion *vrf_un_mra;
933 #define vrf_result vrf_un.vrf_un_result
934 #define vrf_dn vrf_un.vrf_un_dn
935 #define vrf_desc vrf_un.vrf_un_desc
936 #define vrf_ava vrf_un.vrf_un_ava
937 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
938 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
939 #define vrf_ssa vrf_un.vrf_un_ssa
940 #define vrf_sub vrf_un.vrf_un_ssa
941 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
942 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
943 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
944 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
945 #define vrf_mra vrf_un.vrf_un_mra
946 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
947 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
948 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
949 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
950 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
955 struct slap_valuesreturnfilter *vrf_next;
956 } ValuesReturnFilter;
959 * represents an attribute (description + values)
961 typedef struct slap_attr {
962 AttributeDescription *a_desc;
963 BerVarray a_vals; /* preserved values */
964 BerVarray a_nvals; /* normalized values */
965 struct slap_attr *a_next;
967 #define SLAP_ATTR_IXADD 0x1U
968 #define SLAP_ATTR_IXDEL 0x2U
973 * the id used in the indexes to refer to an entry
975 typedef unsigned long ID;
976 #define NOID ((ID)~0)
979 * represents an entry in core
981 typedef struct slap_entry {
983 * The ID field should only be changed before entry is
984 * inserted into a cache. The ID value is backend
989 struct berval e_name; /* name (DN) of this entry */
990 struct berval e_nname; /* normalized name (DN) of this entry */
992 /* for migration purposes */
993 #define e_dn e_name.bv_val
994 #define e_ndn e_nname.bv_val
996 Attribute *e_attrs; /* list of attributes + values */
998 slap_mask_t e_ocflags;
1000 struct berval e_bv; /* For entry_encode/entry_decode */
1002 /* for use by the backend for any purpose */
1007 * A list of LDAPMods
1009 typedef struct slap_mod {
1011 AttributeDescription *sm_desc;
1012 struct berval sm_type;
1013 BerVarray sm_values;
1014 #define sm_bvalues sm_values
1015 BerVarray sm_nvalues;
1018 typedef struct slap_mod_list {
1019 Modification sml_mod;
1020 #define sml_op sml_mod.sm_op
1021 #define sml_desc sml_mod.sm_desc
1022 #define sml_type sml_mod.sm_type
1023 #define sml_bvalues sml_mod.sm_values
1024 #define sml_values sml_mod.sm_values
1025 #define sml_nvalues sml_mod.sm_nvalues
1026 struct slap_mod_list *sml_next;
1029 typedef struct slap_ldap_modlist {
1031 struct slap_ldap_modlist *ml_next;
1032 #define ml_op ml_mod.mod_op
1033 #define ml_type ml_mod.mod_type
1034 #define ml_values ml_mod.mod_values
1035 #define ml_bvalues ml_mod.mod_values
1039 * represents an access control list
1041 typedef enum slap_access_e {
1042 ACL_INVALID_ACCESS = -1,
1051 typedef enum slap_control_e {
1052 ACL_INVALID_CONTROL = 0,
1058 typedef enum slap_style_e {
1059 ACL_STYLE_REGEX = 0,
1067 typedef struct slap_authz_info {
1068 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1069 struct berval sai_mech; /* SASL Mechanism */
1070 struct berval sai_dn; /* DN for reporting purposes */
1071 struct berval sai_ndn; /* Normalized DN */
1073 /* Security Strength Factors */
1074 slap_ssf_t sai_ssf; /* Overall SSF */
1075 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1076 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1077 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1078 } AuthorizationInformation;
1081 typedef struct slap_access {
1082 slap_control_t a_type;
1084 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1086 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1087 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1088 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1089 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1090 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1091 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1093 #define ACL_PRIV_MASK 0x00ffUL
1096 #define ACL_PRIV_LEVEL 0x1000UL
1097 #define ACL_PRIV_ADDITIVE 0x2000UL
1098 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1101 #define ACL_PRIV_INVALID 0x0UL
1103 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1104 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1105 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1106 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1108 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1109 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1111 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1113 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1115 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1116 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1117 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1119 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1120 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1121 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1122 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1123 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1124 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1126 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1127 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1128 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1129 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1130 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1131 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1132 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1134 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1135 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1136 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1137 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1138 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1139 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1141 slap_mask_t a_access_mask;
1143 AuthorizationInformation a_authz;
1144 #define a_dn_pat a_authz.sai_dn
1146 slap_style_t a_dn_style;
1147 AttributeDescription *a_dn_at;
1151 slap_style_t a_peername_style;
1152 struct berval a_peername_pat;
1153 slap_style_t a_sockname_style;
1154 struct berval a_sockname_pat;
1156 slap_style_t a_domain_style;
1157 struct berval a_domain_pat;
1158 int a_domain_expand;
1160 slap_style_t a_sockurl_style;
1161 struct berval a_sockurl_pat;
1162 slap_style_t a_set_style;
1163 struct berval a_set_pat;
1165 #ifdef SLAPD_ACI_ENABLED
1166 AttributeDescription *a_aci_at;
1170 slap_style_t a_group_style;
1171 struct berval a_group_pat;
1172 ObjectClass *a_group_oc;
1173 AttributeDescription *a_group_at;
1175 struct slap_access *a_next;
1179 typedef struct slap_acl {
1180 /* "to" part: the entries this acl applies to */
1182 slap_style_t acl_dn_style;
1184 struct berval acl_dn_pat;
1185 AttributeName *acl_attrs;
1186 slap_style_t acl_attrval_style;
1187 regex_t acl_attrval_re;
1188 struct berval acl_attrval;
1190 /* "by" part: list of who has what access to the entries */
1193 struct slap_acl *acl_next;
1196 typedef struct slap_acl_state {
1197 unsigned as_recorded;
1198 #define ACL_STATE_NOT_RECORDED 0x0
1199 #define ACL_STATE_RECORDED_VD 0x1
1200 #define ACL_STATE_RECORDED_NV 0x2
1201 #define ACL_STATE_RECORDED 0x3
1204 AccessControl *as_vd_acl;
1205 AccessControl *as_vi_acl;
1206 slap_mask_t as_vd_acl_mask;
1207 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1208 int as_vd_acl_count;
1210 Access *as_vd_access;
1211 int as_vd_access_count;
1214 AttributeDescription *as_vd_ad;
1215 } AccessControlState;
1216 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1217 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1221 * represents a backend
1224 typedef struct slap_backend_info BackendInfo; /* per backend type */
1225 typedef struct slap_backend_db BackendDB; /* per backend database */
1227 LDAP_SLAPD_V (int) nBackendInfo;
1228 LDAP_SLAPD_V (int) nBackendDB;
1229 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1230 LDAP_SLAPD_V (BackendDB *) backendDB;
1232 LDAP_SLAPD_V (int) slapMode;
1233 #define SLAP_UNDEFINED_MODE 0x0000
1234 #define SLAP_SERVER_MODE 0x0001
1235 #define SLAP_TOOL_MODE 0x0002
1236 #define SLAP_MODE 0x0003
1238 #define SLAP_TRUNCATE_MODE 0x0100
1239 #define SLAP_TOOL_READMAIN 0x0200
1240 #define SLAP_TOOL_READONLY 0x0400
1242 struct slap_replica_info {
1243 char *ri_host; /* supersedes be_replica */
1244 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1245 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1246 int ri_exclude; /* 1 => exclude ri_attrs */
1249 struct slap_limits_set {
1257 int lms_s_unchecked;
1262 struct slap_limits {
1263 int lm_type; /* type of pattern */
1264 #define SLAP_LIMITS_UNDEFINED 0x0000
1265 #define SLAP_LIMITS_EXACT 0x0001
1266 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1267 #define SLAP_LIMITS_ONE 0x0002
1268 #define SLAP_LIMITS_SUBTREE 0x0003
1269 #define SLAP_LIMITS_CHILDREN 0x0004
1270 #define SLAP_LIMITS_REGEX 0x0005
1271 #define SLAP_LIMITS_ANONYMOUS 0x0006
1272 #define SLAP_LIMITS_USERS 0x0007
1273 #define SLAP_LIMITS_ANY 0x0008
1274 regex_t lm_dn_regex; /* regex data for REGEX */
1277 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1278 * pattern for REGEX; NULL for ANONYMOUS, USERS
1280 struct berval lm_dn_pat;
1282 struct slap_limits_set lm_limits;
1285 /* temporary aliases */
1286 typedef BackendDB Backend;
1287 #define nbackends nBackendDB
1288 #define backends backendDB
1290 struct nonpresent_entry {
1291 struct berval *npe_name;
1292 struct berval *npe_nname;
1293 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1297 * syncinfo structure for syncrepl
1299 typedef struct syncinfo_s {
1300 struct slap_backend_db *si_be;
1302 char *si_provideruri;
1303 BerVarray si_provideruri_bv;
1304 #define SYNCINFO_TLS_OFF 0
1305 #define SYNCINFO_TLS_ON 1
1306 #define SYNCINFO_TLS_CRITICAL 2
1308 struct berval si_updatedn;
1317 int si_schemachecking;
1319 struct berval si_filterstr;
1320 struct berval si_base;
1326 struct berval si_syncCookie;
1330 struct berval si_syncUUID_ndn;
1331 Avlnode *si_presentlist;
1334 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1337 struct slap_backend_db {
1338 BackendInfo *bd_info; /* pointer to shared backend info */
1340 /* BackendInfo accessors */
1341 #define be_config bd_info->bi_db_config
1342 #define be_type bd_info->bi_type
1344 #define be_bind bd_info->bi_op_bind
1345 #define be_unbind bd_info->bi_op_unbind
1346 #define be_add bd_info->bi_op_add
1347 #define be_compare bd_info->bi_op_compare
1348 #define be_delete bd_info->bi_op_delete
1349 #define be_modify bd_info->bi_op_modify
1350 #define be_modrdn bd_info->bi_op_modrdn
1351 #define be_search bd_info->bi_op_search
1352 #define be_abandon bd_info->bi_op_abandon
1353 #define be_cancel bd_info->bi_op_cancel
1355 #define be_extended bd_info->bi_extended
1357 #define be_fetch bd_info->bi_entry_get_rw
1358 #define be_release bd_info->bi_entry_release_rw
1359 #define be_chk_referrals bd_info->bi_chk_referrals
1360 #define be_group bd_info->bi_acl_group
1361 #define be_attribute bd_info->bi_acl_attribute
1362 #define be_operational bd_info->bi_operational
1365 * define to honor hasSubordinates operational attribute in search filters
1366 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1369 #define be_has_subordinates bd_info->bi_has_subordinates
1371 #define be_controls bd_info->bi_controls
1373 #define be_connection_init bd_info->bi_connection_init
1374 #define be_connection_destroy bd_info->bi_connection_destroy
1377 #define be_entry_open bd_info->bi_tool_entry_open
1378 #define be_entry_close bd_info->bi_tool_entry_close
1379 #define be_entry_first bd_info->bi_tool_entry_first
1380 #define be_entry_next bd_info->bi_tool_entry_next
1381 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1382 #define be_entry_get bd_info->bi_tool_entry_get
1383 #define be_entry_put bd_info->bi_tool_entry_put
1384 #define be_sync bd_info->bi_tool_sync
1385 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1386 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1387 #define be_entry_modify bd_info->bi_tool_entry_modify
1390 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1391 #define SLAP_BFLAG_NO_SCHEMA_CHECK 0x0002U
1392 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1393 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1394 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1395 #define SLAP_BFLAG_MONITOR 0x0080U /* a monitor backend */
1396 #define SLAP_BFLAG_INCREMENT 0x0100U
1397 #define SLAP_BFLAG_ALIASES 0x1000U
1398 #define SLAP_BFLAG_REFERRALS 0x2000U
1399 #define SLAP_BFLAG_SUBENTRIES 0x4000U
1400 #define SLAP_BFLAG_DYNAMIC 0x8000U
1401 slap_mask_t be_flags;
1402 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1403 #define SLAP_NO_SCHEMA_CHECK(be) (((be)->be_flags & SLAP_BFLAG_NO_SCHEMA_CHECK))
1404 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1405 #define SLAP_GLUE_SUBORDINATE(be) \
1406 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1407 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1409 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1410 #define SLAP_INCREMENT(be) ((be)->be_flags & SLAP_BFLAG_INCREMENT)
1412 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1413 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1414 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1415 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1418 slap_mask_t be_restrictops; /* restriction operations */
1419 #define SLAP_RESTRICT_OP_ADD 0x0001U
1420 #define SLAP_RESTRICT_OP_BIND 0x0002U
1421 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1422 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1423 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1424 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1425 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1426 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1428 #define SLAP_RESTRICT_OP_READS \
1429 ( SLAP_RESTRICT_OP_COMPARE \
1430 | SLAP_RESTRICT_OP_SEARCH )
1431 #define SLAP_RESTRICT_OP_WRITES \
1432 ( SLAP_RESTRICT_OP_ADD \
1433 | SLAP_RESTRICT_OP_DELETE \
1434 | SLAP_RESTRICT_OP_MODIFY \
1435 | SLAP_RESTRICT_OP_RENAME )
1437 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1438 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1439 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1441 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1443 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1444 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1445 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* 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 LDAP_TAILQ_HEAD( pcl, slap_csn_entry ) be_pending_csn_list;
1486 ldap_pvt_thread_mutex_t be_pcl_mutex;
1487 struct berval be_context_csn;
1488 ldap_pvt_thread_mutex_t be_context_csn_mutex;
1489 syncinfo_t *be_syncinfo; /* For syncrepl */
1495 /* Backend function typedefs */
1496 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1497 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1498 const char *fname, int lineno,
1499 int argc, char **argv));
1500 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1501 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1502 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1504 typedef int (BI_db_init) LDAP_P((Backend *bd));
1505 typedef int (BI_db_config) LDAP_P((Backend *bd,
1506 const char *fname, int lineno,
1507 int argc, char **argv));
1508 typedef int (BI_db_open) LDAP_P((Backend *bd));
1509 typedef int (BI_db_close) LDAP_P((Backend *bd));
1510 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1512 typedef struct req_bind_s {
1514 struct berval rb_cred;
1515 struct berval rb_edn;
1519 typedef struct req_search_s {
1525 AttributeName *rs_attrs;
1527 struct berval rs_filterstr;
1530 typedef struct req_compare_s {
1531 AttributeAssertion *rs_ava;
1534 typedef struct req_modify_s {
1535 Modifications *rs_modlist;
1538 typedef struct req_modrdn_s {
1539 struct berval rs_newrdn;
1540 struct berval rs_nnewrdn;
1541 struct berval *rs_newSup;
1542 struct berval *rs_nnewSup;
1543 int rs_deleteoldrdn;
1546 typedef struct req_add_s {
1550 typedef struct req_abandon_s {
1554 typedef struct req_extended_s {
1555 struct berval rs_reqoid;
1556 struct berval *rs_reqdata;
1559 typedef enum slap_reply_e {
1568 typedef struct rep_sasl_s {
1569 struct berval *r_sasldata;
1572 typedef struct rep_extended_s {
1573 const char *r_rspoid;
1574 struct berval *r_rspdata;
1577 typedef struct rep_search_s {
1579 AttributeName *r_attrs;
1584 typedef struct slap_rep {
1585 slap_reply_t sr_type;
1589 const char *sr_matched;
1590 const char *sr_text;
1592 LDAPControl **sr_ctrls;
1594 rep_sasl_s sru_sasl;
1595 rep_extended_s sru_extended;
1596 rep_search_s sru_search;
1600 /* short hands for response members */
1601 #define sr_attrs sr_un.sru_search.r_attrs
1602 #define sr_entry sr_un.sru_search.r_entry
1603 #define sr_v2ref sr_un.sru_search.r_v2ref
1604 #define sr_nentries sr_un.sru_search.r_nentries
1605 #define sr_rspoid sr_un.sru_extended.r_rspoid
1606 #define sr_rspdata sr_un.sru_extended.r_rspdata
1607 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1609 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1610 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1611 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1612 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1613 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1614 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1615 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1616 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1617 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1618 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1619 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1620 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1621 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1622 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1623 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1624 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1625 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1627 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1628 struct slap_conn *c));
1629 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1630 struct slap_conn *c));
1632 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1633 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1634 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1635 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1636 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1637 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1638 struct berval *text ));
1639 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1640 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1641 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1642 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1643 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1644 struct berval *text ));
1646 struct slap_backend_info {
1647 char *bi_type; /* type of backend */
1650 * per backend type routines:
1651 * bi_init: called to allocate a backend_info structure,
1652 * called once BEFORE configuration file is read.
1653 * bi_init() initializes this structure hence is
1654 * called directly from be_initialize()
1655 * bi_config: called per 'backend' specific option
1656 * all such options must before any 'database' options
1657 * bi_config() is called only from read_config()
1658 * bi_open: called to open each database, called
1659 * once AFTER configuration file is read but
1660 * BEFORE any bi_db_open() calls.
1661 * bi_open() is called from backend_startup()
1662 * bi_close: called to close each database, called
1663 * once during shutdown after all bi_db_close calls.
1664 * bi_close() is called from backend_shutdown()
1665 * bi_destroy: called to destroy each database, called
1666 * once during shutdown after all bi_db_destroy calls.
1667 * bi_destory() is called from backend_destroy()
1670 BI_config *bi_config;
1673 BI_destroy *bi_destroy;
1676 * per database routines:
1677 * bi_db_init: called to initialize each database,
1678 * called upon reading 'database <type>'
1679 * called only from backend_db_init()
1680 * bi_db_config: called to configure each database,
1681 * called per database to handle per database options
1682 * called only from read_config()
1683 * bi_db_open: called to open each database
1684 * called once per database immediately AFTER bi_open()
1685 * calls but before daemon startup.
1686 * called only by backend_startup()
1687 * bi_db_close: called to close each database
1688 * called once per database during shutdown but BEFORE
1689 * any bi_close call.
1690 * called only by backend_shutdown()
1691 * bi_db_destroy: called to destroy each database
1692 * called once per database during shutdown AFTER all
1693 * bi_close calls but before bi_destory calls.
1694 * called only by backend_destory()
1696 BI_db_init *bi_db_init;
1697 BI_db_config *bi_db_config;
1698 BI_db_open *bi_db_open;
1699 BI_db_close *bi_db_close;
1700 BI_db_destroy *bi_db_destroy;
1702 /* LDAP Operations Handling Routines */
1703 BI_op_bind *bi_op_bind;
1704 BI_op_unbind *bi_op_unbind;
1705 BI_op_search *bi_op_search;
1706 BI_op_compare *bi_op_compare;
1707 BI_op_modify *bi_op_modify;
1708 BI_op_modrdn *bi_op_modrdn;
1709 BI_op_add *bi_op_add;
1710 BI_op_delete *bi_op_delete;
1711 BI_op_abandon *bi_op_abandon;
1712 BI_op_cancel *bi_op_cancel;
1714 /* Extended Operations Helper */
1715 BI_op_extended *bi_extended;
1717 /* Auxilary Functions */
1718 BI_entry_get_rw *bi_entry_get_rw;
1719 BI_entry_release_rw *bi_entry_release_rw;
1720 BI_chk_referrals *bi_chk_referrals;
1722 BI_operational *bi_operational;
1723 BI_has_subordinates *bi_has_subordinates;
1725 BI_connection_init *bi_connection_init;
1726 BI_connection_destroy *bi_connection_destroy;
1728 /* hooks for slap tools */
1729 BI_tool_entry_open *bi_tool_entry_open;
1730 BI_tool_entry_close *bi_tool_entry_close;
1731 BI_tool_entry_first *bi_tool_entry_first;
1732 BI_tool_entry_next *bi_tool_entry_next;
1733 BI_tool_entry_get *bi_tool_entry_get;
1734 BI_tool_entry_put *bi_tool_entry_put;
1735 BI_tool_entry_reindex *bi_tool_entry_reindex;
1736 BI_tool_sync *bi_tool_sync;
1737 BI_tool_dn2id_get *bi_tool_dn2id_get;
1738 BI_tool_id2entry_get *bi_tool_id2entry_get;
1739 BI_tool_entry_modify *bi_tool_entry_modify;
1741 #define SLAP_INDEX_ADD_OP 0x0001
1742 #define SLAP_INDEX_DELETE_OP 0x0002
1744 char **bi_controls; /* supported controls */
1746 unsigned int bi_nDB; /* number of databases of this type */
1747 void *bi_private; /* anything the backend type needs */
1750 #define c_authtype c_authz.sai_method
1751 #define c_authmech c_authz.sai_mech
1752 #define c_dn c_authz.sai_dn
1753 #define c_ndn c_authz.sai_ndn
1754 #define c_ssf c_authz.sai_ssf
1755 #define c_transport_ssf c_authz.sai_transport_ssf
1756 #define c_tls_ssf c_authz.sai_tls_ssf
1757 #define c_sasl_ssf c_authz.sai_sasl_ssf
1759 #define o_authtype o_authz.sai_method
1760 #define o_authmech o_authz.sai_mech
1761 #define o_dn o_authz.sai_dn
1762 #define o_ndn o_authz.sai_ndn
1763 #define o_ssf o_authz.sai_ssf
1764 #define o_transport_ssf o_authz.sai_transport_ssf
1765 #define o_tls_ssf o_authz.sai_tls_ssf
1766 #define o_sasl_ssf o_authz.sai_sasl_ssf
1768 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1770 typedef struct slap_callback {
1771 slap_response *sc_response;
1775 struct slap_overinfo;
1777 typedef struct slap_overinst {
1779 slap_response *on_response;
1780 struct slap_overinfo *on_info;
1781 struct slap_overinst *on_next;
1784 typedef struct slap_overinfo {
1787 slap_overinst *oi_list;
1790 /* Should successive callbacks in a chain be processed? */
1791 #define SLAP_CB_CONTINUE 0x8000
1794 * Paged Results state
1796 typedef unsigned long PagedResultsCookie;
1797 typedef struct slap_paged_state {
1799 PagedResultsCookie ps_cookie;
1801 } PagedResultsState;
1804 #define LDAP_PSEARCH_BY_ADD 0x01
1805 #define LDAP_PSEARCH_BY_DELETE 0x02
1806 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1807 #define LDAP_PSEARCH_BY_MODIFY 0x04
1808 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1811 struct slap_op *ps_op;
1812 LDAP_LIST_ENTRY(psid_entry) ps_link;
1815 struct slap_csn_entry {
1818 unsigned long connid;
1819 #define SLAP_CSN_PENDING 1
1820 #define SLAP_CSN_COMMIT 2
1822 LDAP_TAILQ_ENTRY (slap_csn_entry) csn_link;
1826 * Caches the result of a backend_group check for ACL evaluation
1828 typedef struct slap_gacl {
1829 struct slap_gacl *ga_next;
1832 AttributeDescription *ga_at;
1839 * represents an operation pending from an ldap client
1841 typedef struct slap_op {
1842 unsigned long o_opid; /* id of this operation */
1843 unsigned long o_connid; /* id of conn initiating this op */
1844 struct slap_conn *o_conn; /* connection spawning this op */
1845 BackendDB *o_bd; /* backend DB processing this op */
1847 ber_int_t o_msgid; /* msgid of the request */
1848 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1849 ber_tag_t o_tag; /* tag of the request */
1850 time_t o_time; /* time op was initiated */
1852 struct berval o_req_dn; /* DN of target of request */
1853 struct berval o_req_ndn;
1858 req_compare_s oq_compare;
1859 req_modify_s oq_modify;
1860 req_modrdn_s oq_modrdn;
1861 req_search_s oq_search;
1862 req_abandon_s oq_abandon;
1863 req_abandon_s oq_cancel;
1864 req_extended_s oq_extended;
1867 /* short hands for union members */
1868 #define oq_add o_request.oq_add
1869 #define oq_bind o_request.oq_bind
1870 #define oq_compare o_request.oq_compare
1871 #define oq_modify o_request.oq_modify
1872 #define oq_modrdn o_request.oq_modrdn
1873 #define oq_search o_request.oq_search
1874 #define oq_abandon o_request.oq_abandon
1875 #define oq_cancel o_request.oq_cancel
1876 #define oq_extended o_request.oq_extended
1878 /* short hands for inner request members */
1879 #define orb_method oq_bind.rb_method
1880 #define orb_cred oq_bind.rb_cred
1881 #define orb_edn oq_bind.rb_edn
1882 #define orb_ssf oq_bind.rb_ssf
1884 #define ors_scope oq_search.rs_scope
1885 #define ors_deref oq_search.rs_deref
1886 #define ors_slimit oq_search.rs_slimit
1887 #define ors_tlimit oq_search.rs_tlimit
1888 #define ors_attrsonly oq_search.rs_attrsonly
1889 #define ors_attrs oq_search.rs_attrs
1890 #define ors_filter oq_search.rs_filter
1891 #define ors_filterstr oq_search.rs_filterstr
1893 #define orr_newrdn oq_modrdn.rs_newrdn
1894 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1895 #define orr_newSup oq_modrdn.rs_newSup
1896 #define orr_nnewSup oq_modrdn.rs_nnewSup
1897 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1899 #define orc_ava oq_compare.rs_ava
1900 #define ora_e oq_add.rs_e
1901 #define orn_msgid oq_abandon.rs_msgid
1902 #define orm_modlist oq_modify.rs_modlist
1904 #define ore_reqoid oq_extended.rs_reqoid
1905 #define ore_reqdata oq_extended.rs_reqdata
1907 ldap_pvt_thread_t o_tid; /* thread handling this op */
1909 volatile sig_atomic_t o_abandon; /* abandon flag */
1910 volatile sig_atomic_t o_cancel; /* cancel flag */
1911 #define SLAP_CANCEL_NONE 0x00
1912 #define SLAP_CANCEL_REQ 0x01
1913 #define SLAP_CANCEL_ACK 0x02
1914 #define SLAP_CANCEL_DONE 0x03
1916 GroupAssertion *o_groups;
1917 char o_do_not_cache; /* don't cache groups from this op */
1918 char o_is_auth_check; /* authorization in progress */
1920 #define SLAP_NO_CONTROL 0
1921 #define SLAP_NONCRITICAL_CONTROL 1
1922 #define SLAP_CRITICAL_CONTROL 2
1924 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1930 #define get_subentries(op) ((int)(op)->o_subentries)
1931 char o_subentries_visibility;
1932 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1935 #define get_assert(op) ((int)(op)->o_assert)
1937 char o_valuesreturnfilter;
1939 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1940 char o_permissive_modify;
1941 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1943 #define get_permissiveModify(op) (0)
1946 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1947 char o_domain_scope;
1948 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1950 #define get_domainScope(op) (0)
1955 AttributeName *o_preread_attrs;
1956 AttributeName *o_postread_attrs;
1958 #ifdef LDAP_CONTROL_PAGEDRESULTS
1959 char o_pagedresults;
1960 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1961 ber_int_t o_pagedresults_size;
1962 PagedResultsState o_pagedresults_state;
1964 #define get_pagedresults(op) (0)
1969 #define SLAP_SYNC_NONE (0x0)
1970 #define SLAP_SYNC_REFRESH (0x1)
1971 #define SLAP_SYNC_PERSIST (0x2)
1972 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1973 struct berval o_sync_state;
1976 LDAP_LIST_ENTRY(slap_op) o_ps_link;
1977 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1979 AuthorizationInformation o_authz;
1981 BerElement *o_ber; /* ber of the request */
1982 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
1983 slap_callback *o_callback; /* callback pointers */
1984 LDAPControl **o_ctrls; /* controls */
1986 void *o_threadctx; /* thread pool thread context */
1987 void *o_tmpmemctx; /* slab malloc context */
1988 BerMemoryFunctions *o_tmpmfuncs;
1989 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
1990 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
1991 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
1992 #define o_tmpfree o_tmpmfuncs->bmf_free
1993 void *o_private; /* anything the backend needs */
1995 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1997 Filter *o_assertion; /* Assert control filter */
1998 #define get_assertion(op) ((op)->o_assertion)
2000 ValuesReturnFilter *o_vrFilter; /* ValuesReturnFilter */
2005 void *o_pb; /* NS-SLAPI plugin */
2006 void *o_extensions; /* NS-SLAPI plugin */
2010 #define send_ldap_error( op, rs, err, text ) do { \
2011 (rs)->sr_err = err; (rs)->sr_text = text; \
2012 (op->o_conn->c_send_ldap_result)( op, rs ); \
2014 #define send_ldap_discon( op, rs, err, text ) do { \
2015 (rs)->sr_err = err; (rs)->sr_text = text; \
2016 send_ldap_disconnect( op, rs ); \
2019 typedef void (SEND_LDAP_RESULT)(
2020 struct slap_op *op, struct slap_rep *rs);
2021 typedef int (SEND_SEARCH_ENTRY)(
2022 struct slap_op *op, struct slap_rep *rs);
2023 typedef int (SEND_SEARCH_REFERENCE)(
2024 struct slap_op *op, struct slap_rep *rs);
2025 typedef void (SEND_LDAP_EXTENDED)(
2026 struct slap_op *op, struct slap_rep *rs);
2027 typedef void (SEND_LDAP_INTERMEDIATE)(
2028 struct slap_op *op, struct slap_rep *rs);
2030 #define send_ldap_result( op, rs ) \
2031 (op->o_conn->c_send_ldap_result)( op, rs )
2032 #define send_search_entry( op, rs ) \
2033 (op->o_conn->c_send_search_entry)( op, rs )
2034 #define send_search_reference( op, rs ) \
2035 (op->o_conn->c_send_search_reference)( op, rs )
2036 #define send_ldap_extended( op, rs ) \
2037 (op->o_conn->c_send_ldap_extended)( op, rs )
2038 #define send_ldap_intermediate( op, rs ) \
2039 (op->o_conn->c_send_ldap_intermediate)( op, rs )
2041 typedef struct slap_listener Listener;
2044 * represents a connection from an ldap client
2046 typedef struct slap_conn {
2047 int c_struct_state; /* structure management state */
2048 int c_conn_state; /* connection state */
2050 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2051 Sockbuf *c_sb; /* ber connection stuff */
2053 /* only can be changed by connect_init */
2054 time_t c_starttime; /* when the connection was opened */
2055 time_t c_activitytime; /* when the connection was last used */
2056 unsigned long c_connid; /* id of this connection for stats*/
2058 struct berval c_peer_domain; /* DNS name of client */
2059 struct berval c_peer_name; /* peer name (trans=addr:port) */
2060 Listener *c_listener;
2061 #define c_listener_url c_listener->sl_url /* listener URL */
2062 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2064 /* only can be changed by binding thread */
2065 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2066 struct berval c_sasl_bind_mech; /* mech in progress */
2067 struct berval c_sasl_dn; /* temporary storage */
2069 /* authorization backend */
2070 Backend *c_authz_backend;
2072 AuthorizationInformation c_authz;
2074 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2076 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2077 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2079 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2080 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2082 BerElement *c_currentber; /* ber we're attempting to read */
2083 int c_writewaiter; /* true if writer is waiting */
2085 #define CONN_IS_TLS 1
2086 #define CONN_IS_UDP 2
2087 #define CONN_IS_CLIENT 3
2089 #ifdef LDAP_CONNECTIONLESS
2090 int c_is_udp; /* true if this is (C)LDAP over UDP */
2093 int c_is_tls; /* true if this LDAP over raw TLS */
2094 int c_needs_tls_accept; /* true if SSL_accept should be called */
2096 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2097 int c_sasl_done; /* SASL completed once */
2098 void *c_sasl_authctx; /* SASL authentication context */
2099 void *c_sasl_sockctx; /* SASL security layer context */
2100 void *c_sasl_extra; /* SASL session extra stuff */
2101 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2103 PagedResultsState c_pagedresults_state; /* paged result state */
2105 long c_n_ops_received; /* num of ops received (next op_id) */
2106 long c_n_ops_executing; /* num of ops currently executing */
2107 long c_n_ops_pending; /* num of ops pending execution */
2108 long c_n_ops_completed; /* num of ops completed */
2110 long c_n_get; /* num of get calls */
2111 long c_n_read; /* num of read calls */
2112 long c_n_write; /* num of write calls */
2114 void *c_pb; /* Netscape plugin */
2115 void *c_extensions; /* Netscape plugin */
2118 * Client connection handling
2120 ldap_pvt_thread_start_t *c_clientfunc;
2124 * These are the "callbacks" that are available for back-ends to
2125 * supply data back to connected clients that are connected
2126 * through the "front-end".
2128 SEND_LDAP_RESULT *c_send_ldap_result;
2129 SEND_SEARCH_ENTRY *c_send_search_entry;
2130 SEND_SEARCH_REFERENCE *c_send_search_reference;
2131 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2132 #ifdef LDAP_RES_INTERMEDIATE
2133 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2138 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2139 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2141 if ( ldap_debug & (level) ) \
2142 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2143 if ( ldap_syslog & (level) ) \
2144 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2147 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2148 #elif defined(LDAP_DEBUG)
2149 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2151 if ( ldap_debug & (level) ) \
2152 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2154 #define StatslogTest( level ) (ldap_debug & (level))
2156 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2157 #define StatslogTest( level ) (0)
2161 * listener; need to access it from monitor backend
2163 struct slap_listener {
2164 struct berval sl_url;
2165 struct berval sl_name;
2170 #ifdef LDAP_CONNECTIONLESS
2171 int sl_is_udp; /* UDP listener is also data port */
2173 int sl_is_mute; /* Listening is temporarily disabled */
2176 #define sl_addr sl_sa.sa_in_addr
2179 #ifdef SLAPD_MONITOR
2196 #endif /* SLAPD_MONITOR */
2199 * Better know these all around slapd
2201 #define SLAP_LDAPDN_PRETTY 0x1
2202 #define SLAP_LDAPDN_MAXLEN 8192
2204 /* number of response controls supported */
2205 #define SLAP_MAX_RESPONSE_CONTROLS 6
2208 #define SLAP_CTRL_HIDE 0x00000000U
2210 #define SLAP_CTRL_HIDE 0x80000000U
2213 #define SLAP_CTRL_FRONTEND 0x00800000U
2214 #define SLAP_CTRL_FRONTEND_SEARCH 0x00010000U /* for NOOP */
2216 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2217 #define SLAP_CTRL_ABANDON 0x00000001U
2218 #define SLAP_CTRL_ADD 0x00002002U
2219 #define SLAP_CTRL_BIND 0x00000004U
2220 #define SLAP_CTRL_COMPARE 0x00001008U
2221 #define SLAP_CTRL_DELETE 0x00002010U
2222 #define SLAP_CTRL_MODIFY 0x00002020U
2223 #define SLAP_CTRL_RENAME 0x00002040U
2224 #define SLAP_CTRL_SEARCH 0x00001080U
2225 #define SLAP_CTRL_UNBIND 0x00000100U
2227 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2228 #define SLAP_CTRL_UPDATE \
2229 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2230 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2232 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2235 LDAPControl *ctrl ));
2239 #include "proto-slap.h"
2241 #endif /* _SLAP_H_ */