1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
14 #include <ac/stdlib.h>
16 #include <sys/types.h>
17 #include <ac/syslog.h>
19 #include <ac/signal.h>
20 #include <ac/socket.h>
27 #define ldap_debug slap_debug
33 #include <ldap_schema.h>
35 #include "ldap_pvt_thread.h"
36 #include "ldap_queue.h"
39 #define SLAP_NVALUES 1
40 /* #define SLAP_NVALUES_ON_DISK 1 */
41 #define SLAP_EXTENDED_SCHEMA 1
46 * SLAPD Memory allocation macros
48 * Unlike ch_*() routines, these routines do not assert() upon
49 * allocation error. They are intended to be used instead of
50 * ch_*() routines where the caller has implemented proper
51 * checking for and handling of allocation errors.
53 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
55 #define SLAP_MALLOC(s) ber_memalloc((s))
56 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
57 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
58 #define SLAP_FREE(p) ber_memfree((p))
59 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
60 #define SLAP_STRDUP(s) ber_strdup((s))
61 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
64 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
67 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
68 #define SLAPD_ANONYMOUS "cn=anonymous"
70 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
71 * This is a value used internally by the backends. It is needed to allow
72 * adding values that already exist without getting an error as required by
73 * modrdn when the new rdn was already an attribute value itself.
75 #define SLAP_MOD_SOFTADD 0x1000
77 #define MAXREMATCHES (100)
79 #define SLAP_MAX_WORKER_THREADS (16)
81 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
82 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
84 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
85 #define SLAP_CONN_MAX_PENDING_AUTH 1000
87 #define SLAP_TEXT_BUFLEN (256)
89 /* psuedo error code indicating abandoned operation */
90 #define SLAPD_ABANDON (-1)
92 /* psuedo error code indicating disconnect */
93 #define SLAPD_DISCONNECT (-2)
96 /* We assume "C" locale, that is US-ASCII */
97 #define ASCII_SPACE(c) ( (c) == ' ' )
98 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
99 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
100 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
101 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
102 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
103 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
105 #define SLAP_NIBBLE(c) ((c)&0x0f)
106 #define SLAP_ESCAPE_CHAR ('\\')
107 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
108 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
110 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
111 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
113 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
114 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
115 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
116 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
117 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
119 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
120 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
121 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
122 #define OID_SEPARATOR(c) ( (c) == '.' )
123 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
125 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
126 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
128 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
129 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
131 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
133 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
134 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
135 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
136 (c) == '?' || (c) == ' ' || (c) == '=' )
137 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
139 /* must match in schema_init.c */
140 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
141 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
142 #define SLAPD_GROUP_ATTR "member"
143 #define SLAPD_GROUP_CLASS "groupOfNames"
144 #define SLAPD_ROLE_ATTR "roleOccupant"
145 #define SLAPD_ROLE_CLASS "organizationalRole"
147 #ifdef SLAPD_ACI_ENABLED
148 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
151 /* change this to "OpenLDAPset" */
152 #define SLAPD_ACI_SET_ATTR "template"
154 #define SLAPD_TOP_OID "2.5.6.0"
156 LDAP_SLAPD_V (int) slap_debug;
158 typedef unsigned long slap_mask_t;
160 /* Security Strength Factor */
161 typedef unsigned slap_ssf_t;
163 typedef struct slap_ssf_set {
165 slap_ssf_t sss_transport;
168 slap_ssf_t sss_update_ssf;
169 slap_ssf_t sss_update_transport;
170 slap_ssf_t sss_update_tls;
171 slap_ssf_t sss_update_sasl;
172 slap_ssf_t sss_simple_bind;
175 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
176 #define SLAP_GETDN_AUTHCID 2
177 #define SLAP_GETDN_AUTHZID 4
182 #define SLAP_INDEX_TYPE 0x00FFUL
183 #define SLAP_INDEX_UNDEFINED 0x0001UL
184 #define SLAP_INDEX_PRESENT 0x0002UL
185 #define SLAP_INDEX_EQUALITY 0x0004UL
186 #define SLAP_INDEX_APPROX 0x0008UL
187 #define SLAP_INDEX_SUBSTR 0x0010UL
188 #define SLAP_INDEX_EXTENDED 0x0020UL
190 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
192 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
194 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
196 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
197 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
198 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
199 #define SLAP_INDEX_SUBSTR_DEFAULT \
200 ( SLAP_INDEX_SUBSTR \
201 | SLAP_INDEX_SUBSTR_INITIAL \
202 | SLAP_INDEX_SUBSTR_ANY \
203 | SLAP_INDEX_SUBSTR_FINAL )
205 #define SLAP_INDEX_SUBSTR_MINLEN 2
206 #define SLAP_INDEX_SUBSTR_MAXLEN 4
207 #define SLAP_INDEX_SUBSTR_STEP 2
209 #define SLAP_INDEX_FLAGS 0xF000UL
210 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
211 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
214 * there is a single index for each attribute. these prefixes ensure
215 * that there is no collision among keys.
217 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
218 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
219 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
220 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
221 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
222 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
224 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
225 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
226 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
227 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
228 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
230 #ifdef LDAP_CLIENT_UPDATE
231 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
232 #endif /* LDAP_CLIENT_UPDATE */
235 * represents schema information for a database
237 #define SLAP_SCHERR_OUTOFMEM 1
238 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
239 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
240 #define SLAP_SCHERR_CLASS_BAD_SUP 4
241 #define SLAP_SCHERR_CLASS_DUP 5
242 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
243 #define SLAP_SCHERR_ATTR_BAD_MR 7
244 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
245 #define SLAP_SCHERR_ATTR_BAD_SUP 9
246 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
247 #define SLAP_SCHERR_ATTR_DUP 11
248 #define SLAP_SCHERR_MR_NOT_FOUND 12
249 #define SLAP_SCHERR_MR_INCOMPLETE 13
250 #define SLAP_SCHERR_MR_DUP 14
251 #define SLAP_SCHERR_SYN_NOT_FOUND 15
252 #define SLAP_SCHERR_SYN_DUP 16
253 #define SLAP_SCHERR_NO_NAME 17
254 #define SLAP_SCHERR_NOT_SUPPORTED 18
255 #define SLAP_SCHERR_BAD_DESCR 19
256 #define SLAP_SCHERR_OIDM 20
257 #define SLAP_SCHERR_CR_DUP 21
258 #define SLAP_SCHERR_CR_BAD_STRUCT 22
259 #define SLAP_SCHERR_CR_BAD_AUX 23
260 #define SLAP_SCHERR_CR_BAD_AT 24
261 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
263 typedef union slap_sockaddr {
264 struct sockaddr sa_addr;
265 struct sockaddr_in sa_in_addr;
267 struct sockaddr_storage sa_storage;
268 struct sockaddr_in6 sa_in6_addr;
271 struct sockaddr_un sa_un_addr;
276 extern int slap_inet4or6;
279 typedef struct slap_oid_macro {
280 struct berval som_oid;
282 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
285 /* forward declarations */
287 struct slap_matching_rule;
289 typedef int slap_syntax_validate_func LDAP_P((
290 struct slap_syntax *syntax,
291 struct berval * in));
293 typedef int slap_syntax_transform_func LDAP_P((
294 struct slap_syntax *syntax,
296 struct berval * out));
298 typedef struct slap_syntax {
300 #define ssyn_oid ssyn_syn.syn_oid
301 #define ssyn_desc ssyn_syn.syn_desc
302 #define ssyn_extensions ssyn_syn.syn_extensions
305 ber_len_t ssyn_oidlen;
306 * has been replaced by a struct berval that uses the value
307 * provided by ssyn_syn.syn_oid; a macro that expands to
308 * the bv_len field of the berval is provided for backward
309 * compatibility. CAUTION: NEVER FREE THE BERVAL
311 struct berval ssyn_bvoid;
312 #define ssyn_oidlen ssyn_bvoid.bv_len
314 unsigned int ssyn_flags;
316 #define SLAP_SYNTAX_NONE 0x0000U
317 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
318 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
319 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
320 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
322 slap_syntax_validate_func *ssyn_validate;
324 slap_syntax_transform_func *ssyn_normalize;
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;
348 slap_syntax_transform_func *sd_normalizeXXX; /* to be deleted */
350 slap_syntax_transform_func *sd_normalize;
352 slap_syntax_transform_func *sd_pretty;
353 #ifdef SLAPD_BINARY_CONVERSION
354 slap_syntax_transform_func *sd_ber2str;
355 slap_syntax_transform_func *sd_str2ber;
357 } slap_syntax_defs_rec;
359 /* X -> Y Converter */
360 typedef int slap_mr_convert_func LDAP_P((
362 struct berval * out ));
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,
370 struct berval * out ));
372 /* Match (compare) function */
373 typedef int slap_mr_match_func LDAP_P((
376 struct slap_syntax *syntax, /* syntax of stored value */
377 struct slap_matching_rule *mr,
378 struct berval * value,
379 void * assertValue ));
381 /* Index generation function */
382 typedef int slap_mr_indexer_func LDAP_P((
385 struct slap_syntax *syntax, /* syntax of stored value */
386 struct slap_matching_rule *mr,
387 struct berval *prefix,
391 /* Filter index function */
392 typedef int slap_mr_filter_func LDAP_P((
395 struct slap_syntax *syntax, /* syntax of stored value */
396 struct slap_matching_rule *mr,
397 struct berval *prefix,
401 typedef struct slap_matching_rule_use MatchingRuleUse;
403 typedef struct slap_matching_rule {
404 LDAPMatchingRule smr_mrule;
405 MatchingRuleUse *smr_mru;
406 /* RFC2252 string representation */
407 struct berval smr_str;
410 * ber_len_t smr_oidlen;
411 * has been replaced by a struct berval that uses the value
412 * provided by smr_mrule.mr_oid; a macro that expands to
413 * the bv_len field of the berval is provided for backward
414 * compatibility. CAUTION: NEVER FREE THE BERVAL
416 struct berval smr_bvoid;
417 #define smr_oidlen smr_bvoid.bv_len
419 slap_mask_t smr_usage;
421 #define SLAP_MR_HIDE 0x8000U
423 #define SLAP_MR_TYPE_MASK 0xF000U
424 #define SLAP_MR_SUBTYPE_MASK 0x0F00U
425 #define SLAP_MR_USAGE 0x00FFU
427 #define SLAP_MR_NONE 0x0000U
428 #define SLAP_MR_EQUALITY 0x1000U
429 #define SLAP_MR_ORDERING 0x2000U
430 #define SLAP_MR_SUBSTR 0x4000U
431 #define SLAP_MR_EXT 0x8000U /* implicitly extensible */
433 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0100U )
435 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0100U )
436 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0200U )
437 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0400U )
440 #define SLAP_MR_DN_FOLD 0x0080U
445 * normally the asserted value is expected to conform to
446 * assertion syntax specified in the matching rule, however
447 * at times (such as during individual value modification),
448 * the asserted value is expected to conform to the
449 * attribute's value syntax.
451 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
452 #define SLAP_MR_ATTRIBUTE_SYNTAX_MATCH 0x0001U
454 /* For SLAP_MR_ATTRIBUTE_SYNTAX_MATCHes, this flag indicates
455 * that the asserted value of the attribute syntax has been
456 * converted to the assertion syntax. (Not sure why we just
457 * don't clear the SLAP_MR_ATTRIBUTE_SYNTAX_MATCH flag instead.)
459 #define SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH 0x0002U
463 * The asserted value, depending on the particular usage,
464 * is expected to conform to either the assertion syntax
465 * or the attribute syntax. In some cases, the syntax of
466 * the value is known. If so, these flags indicate which
467 * syntax the value is expected to conform to. If not,
468 * neither of these flags is set (until the syntax of the
469 * provided value is determined). If the value is of the
470 * attribute syntax, the flag is changed once a value of
471 * the assertion syntax is derived from the provided value.
473 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
474 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
476 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
477 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
478 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
479 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
482 /* either or both the asserted value or attribute value
483 * may be provided in normalized form
485 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0010U
486 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0020U
488 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
489 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
490 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
491 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
493 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
494 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
495 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
496 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
497 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
498 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
500 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
501 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
502 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
503 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
506 slap_mr_convert_func *smr_convert;
507 slap_mr_normalize_func *smr_normalize;
508 slap_mr_match_func *smr_match;
509 slap_mr_indexer_func *smr_indexer;
510 slap_mr_filter_func *smr_filter;
513 * null terminated array of syntaxes compatible with this syntax
514 * note: when MS_EXT is set, this MUST NOT contain the assertion
515 * syntax of the rule. When MS_EXT is not set, it MAY.
517 Syntax **smr_compat_syntaxes;
519 struct slap_matching_rule *smr_associated;
520 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
522 #define smr_oid smr_mrule.mr_oid
523 #define smr_names smr_mrule.mr_names
524 #define smr_desc smr_mrule.mr_desc
525 #define smr_obsolete smr_mrule.mr_obsolete
526 #define smr_syntax_oid smr_mrule.mr_syntax_oid
527 #define smr_extensions smr_mrule.mr_extensions
530 struct slap_matching_rule_use {
531 LDAPMatchingRuleUse smru_mruleuse;
532 MatchingRule *smru_mr;
533 /* RFC2252 string representation */
534 struct berval smru_str;
536 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
538 #define smru_oid smru_mruleuse.mru_oid
539 #define smru_names smru_mruleuse.mru_names
540 #define smru_desc smru_mruleuse.mru_desc
541 #define smru_obsolete smru_mruleuse.mru_obsolete
542 #define smru_applies_oids smru_mruleuse.mru_applies_oids
544 #define smru_usage smru_mr->smr_usage
545 } /* MatchingRuleUse */ ;
547 typedef struct slap_mrule_defs_rec {
549 slap_mask_t mrd_usage;
550 char ** mrd_compat_syntaxes;
551 slap_mr_convert_func * mrd_convert;
552 slap_mr_normalize_func * mrd_normalize;
553 slap_mr_match_func * mrd_match;
554 slap_mr_indexer_func * mrd_indexer;
555 slap_mr_filter_func * mrd_filter;
557 /* For equality rule, this may refer to an appropriate approximate rule */
558 char * mrd_associated;
559 } slap_mrule_defs_rec;
561 struct slap_backend_db;
565 typedef int (AttributeTypeSchemaCheckFN)(
566 struct slap_backend_db *be,
567 struct slap_entry *e,
568 struct slap_attr *attr,
570 char *textbuf, size_t textlen );
572 typedef struct slap_attribute_type {
573 LDAPAttributeType sat_atype;
574 struct berval sat_cname;
575 struct slap_attribute_type *sat_sup;
576 struct slap_attribute_type **sat_subtypes;
577 MatchingRule *sat_equality;
578 MatchingRule *sat_approx;
579 MatchingRule *sat_ordering;
580 MatchingRule *sat_substr;
583 AttributeTypeSchemaCheckFN *sat_check;
585 #define SLAP_AT_NONE 0x0000U
586 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
587 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
588 #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__MASK 0x001F
654 #define SLAP_OC__END 0x0020
655 #define SLAP_OC_OPERATIONAL 0x4000
656 #define SLAP_OC_HIDE 0x8000
661 typedef struct slap_content_rule {
662 LDAPContentRule scr_crule;
663 ObjectClass *scr_sclass;
664 ObjectClass **scr_auxiliaries; /* optional */
665 AttributeType **scr_required; /* optional */
666 AttributeType **scr_allowed; /* optional */
667 AttributeType **scr_precluded; /* optional */
668 #define scr_oid scr_crule.cr_oid
669 #define scr_names scr_crule.cr_names
670 #define scr_desc scr_crule.cr_desc
671 #define scr_obsolete scr_crule.cr_obsolete
672 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
673 #define scr_at_oids_must scr_crule.cr_at_oids_must
674 #define scr_at_oids_may scr_crule.cr_at_oids_may
675 #define scr_at_oids_not scr_crule.cr_at_oids_not
677 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
680 /* Represents a recognized attribute description ( type + options ). */
681 typedef struct slap_attr_desc {
682 struct slap_attr_desc *ad_next;
683 AttributeType *ad_type; /* attribute type, must be specified */
684 struct berval ad_cname; /* canonical name, must be specified */
685 struct berval ad_tags; /* empty if no tagging options */
687 #define SLAP_DESC_NONE 0x00U
688 #define SLAP_DESC_BINARY 0x01U
689 #define SLAP_DESC_TAG_RANGE 0x80U
690 } AttributeDescription;
692 typedef struct slap_attr_name {
693 struct berval an_name;
694 AttributeDescription *an_desc;
698 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
699 #define slap_ad_is_tag_range(ad) \
700 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
701 #define slap_ad_is_binary(ad) \
702 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
705 * pointers to schema elements used internally
707 struct slap_internal_schema {
709 ObjectClass *si_oc_top;
710 ObjectClass *si_oc_extensibleObject;
711 ObjectClass *si_oc_alias;
712 ObjectClass *si_oc_referral;
713 ObjectClass *si_oc_rootdse;
714 ObjectClass *si_oc_subentry;
715 ObjectClass *si_oc_subschema;
716 ObjectClass *si_oc_monitor;
717 ObjectClass *si_oc_collectiveAttributeSubentry;
718 ObjectClass *si_oc_dynamicObject;
720 /* objectClass attribute descriptions */
721 AttributeDescription *si_ad_objectClass;
723 /* operational attribute descriptions */
724 AttributeDescription *si_ad_structuralObjectClass;
725 AttributeDescription *si_ad_creatorsName;
726 AttributeDescription *si_ad_createTimestamp;
727 AttributeDescription *si_ad_modifiersName;
728 AttributeDescription *si_ad_modifyTimestamp;
729 AttributeDescription *si_ad_hasSubordinates;
730 AttributeDescription *si_ad_subschemaSubentry;
731 AttributeDescription *si_ad_collectiveSubentries;
732 AttributeDescription *si_ad_collectiveExclusions;
733 AttributeDescription *si_ad_entryUUID;
734 AttributeDescription *si_ad_entryCSN;
735 AttributeDescription *si_ad_namingCSN;
736 AttributeDescription *si_ad_superiorUUID;
739 /* LDAP cache specific operational attribute */
740 AttributeDescription *si_ad_queryid;
741 #endif /* LDAP_CACHING */
743 /* root DSE attribute descriptions */
744 AttributeDescription *si_ad_altServer;
745 AttributeDescription *si_ad_namingContexts;
746 AttributeDescription *si_ad_supportedControl;
747 AttributeDescription *si_ad_supportedExtension;
748 AttributeDescription *si_ad_supportedLDAPVersion;
749 AttributeDescription *si_ad_supportedSASLMechanisms;
750 AttributeDescription *si_ad_supportedFeatures;
751 AttributeDescription *si_ad_monitorContext;
752 AttributeDescription *si_ad_vendorName;
753 AttributeDescription *si_ad_vendorVersion;
755 /* subentry attribute descriptions */
756 AttributeDescription *si_ad_administrativeRole;
757 AttributeDescription *si_ad_subtreeSpecification;
759 /* subschema subentry attribute descriptions */
760 AttributeDescription *si_ad_ditStructureRules;
761 AttributeDescription *si_ad_ditContentRules;
762 AttributeDescription *si_ad_nameForms;
763 AttributeDescription *si_ad_objectClasses;
764 AttributeDescription *si_ad_attributeTypes;
765 AttributeDescription *si_ad_ldapSyntaxes;
766 AttributeDescription *si_ad_matchingRules;
767 AttributeDescription *si_ad_matchingRuleUse;
769 /* Aliases & Referrals */
770 AttributeDescription *si_ad_aliasedObjectName;
771 AttributeDescription *si_ad_ref;
773 /* Access Control Internals */
774 AttributeDescription *si_ad_entry;
775 AttributeDescription *si_ad_children;
776 AttributeDescription *si_ad_saslAuthzTo;
777 AttributeDescription *si_ad_saslAuthzFrom;
778 #ifdef SLAPD_ACI_ENABLED
779 AttributeDescription *si_ad_aci;
782 /* dynamic entries */
783 AttributeDescription *si_ad_entryTtl;
784 AttributeDescription *si_ad_dynamicSubtrees;
786 /* Other attributes descriptions */
787 AttributeDescription *si_ad_distinguishedName;
788 AttributeDescription *si_ad_name;
789 AttributeDescription *si_ad_cn;
790 AttributeDescription *si_ad_userPassword;
791 #ifdef SLAPD_AUTHPASSWD
792 AttributeDescription *si_ad_authPassword;
794 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
795 AttributeDescription *si_ad_krbName;
798 /* Undefined Attribute Type */
799 AttributeType *si_at_undefined;
802 MatchingRule *si_mr_distinguishedNameMatch;
803 MatchingRule *si_mr_caseExactMatch;
804 MatchingRule *si_mr_caseExactSubstringsMatch;
805 MatchingRule *si_mr_caseExactIA5Match;
806 MatchingRule *si_mr_integerMatch;
807 MatchingRule *si_mr_integerFirstComponentMatch;
810 Syntax *si_syn_directoryString;
811 Syntax *si_syn_distinguishedName;
812 Syntax *si_syn_integer;
813 Syntax *si_syn_octetString;
816 typedef struct slap_attr_assertion {
817 AttributeDescription *aa_desc;
818 struct berval aa_value;
819 } AttributeAssertion;
821 typedef struct slap_ss_assertion {
822 AttributeDescription *sa_desc;
823 struct berval sa_initial;
824 struct berval *sa_any;
825 struct berval sa_final;
826 } SubstringsAssertion;
828 typedef struct slap_mr_assertion {
829 MatchingRule *ma_rule; /* optional */
830 struct berval ma_rule_text; /* optional */
831 AttributeDescription *ma_desc; /* optional */
832 int ma_dnattrs; /* boolean */
833 struct berval ma_value; /* required */
834 } MatchingRuleAssertion;
837 * represents a search filter
839 typedef struct slap_filter {
840 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
841 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
842 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
843 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
846 /* precomputed result */
847 ber_int_t f_un_result;
850 struct berval *f_un_dn;
853 AttributeDescription *f_un_desc;
855 /* simple value assertion */
856 AttributeAssertion *f_un_ava;
858 /* substring assertion */
859 SubstringsAssertion *f_un_ssa;
861 /* matching rule assertion */
862 MatchingRuleAssertion *f_un_mra;
864 #define f_dn f_un.f_un_dn
865 #define f_desc f_un.f_un_desc
866 #define f_ava f_un.f_un_ava
867 #define f_av_desc f_un.f_un_ava->aa_desc
868 #define f_av_value f_un.f_un_ava->aa_value
869 #define f_sub f_un.f_un_ssa
870 #define f_sub_desc f_un.f_un_ssa->sa_desc
871 #define f_sub_initial f_un.f_un_ssa->sa_initial
872 #define f_sub_any f_un.f_un_ssa->sa_any
873 #define f_sub_final f_un.f_un_ssa->sa_final
874 #define f_mra f_un.f_un_mra
875 #define f_mr_rule f_un.f_un_mra->ma_rule
876 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
877 #define f_mr_desc f_un.f_un_mra->ma_desc
878 #define f_mr_value f_un.f_un_mra->ma_value
879 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
882 struct slap_filter *f_un_complex;
885 #define f_result f_un.f_un_result
886 #define f_and f_un.f_un_complex
887 #define f_or f_un.f_un_complex
888 #define f_not f_un.f_un_complex
889 #define f_list f_un.f_un_complex
891 struct slap_filter *f_next;
894 /* compare routines can return undefined */
895 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
897 typedef struct slap_valuesreturnfilter {
898 ber_tag_t vrf_choice;
901 /* precomputed result */
902 ber_int_t vrf_un_result;
908 AttributeDescription *vrf_un_desc;
910 /* simple value assertion */
911 AttributeAssertion *vrf_un_ava;
913 /* substring assertion */
914 SubstringsAssertion *vrf_un_ssa;
916 /* matching rule assertion */
917 MatchingRuleAssertion *vrf_un_mra;
919 #define vrf_result vrf_un.vrf_un_result
920 #define vrf_dn vrf_un.vrf_un_dn
921 #define vrf_desc vrf_un.vrf_un_desc
922 #define vrf_ava vrf_un.vrf_un_ava
923 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
924 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
925 #define vrf_ssa vrf_un.vrf_un_ssa
926 #define vrf_sub vrf_un.vrf_un_ssa
927 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
928 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
929 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
930 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
931 #define vrf_mra vrf_un.vrf_un_mra
932 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
933 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
934 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
935 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
936 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
941 struct slap_valuesreturnfilter *vrf_next;
942 } ValuesReturnFilter;
945 * represents an attribute (description + values)
947 typedef struct slap_attr {
948 AttributeDescription *a_desc;
949 BerVarray a_vals; /* preserved values */
951 BerVarray a_nvals; /* normalized values */
953 struct slap_attr *a_next;
955 #define SLAP_ATTR_IXADD 0x1U
956 #define SLAP_ATTR_IXDEL 0x2U
961 * the id used in the indexes to refer to an entry
963 typedef unsigned long ID;
964 #define NOID ((ID)~0)
967 * represents an entry in core
969 typedef struct slap_entry {
971 * The ID field should only be changed before entry is
972 * inserted into a cache. The ID value is backend
977 struct berval e_name; /* name (DN) of this entry */
978 struct berval e_nname; /* normalized name (DN) of this entry */
980 /* for migration purposes */
981 #define e_dn e_name.bv_val
982 #define e_ndn e_nname.bv_val
984 Attribute *e_attrs; /* list of attributes + values */
986 slap_mask_t e_ocflags;
988 struct berval e_bv; /* For entry_encode/entry_decode */
990 /* for use by the backend for any purpose */
997 typedef struct slap_mod {
999 AttributeDescription *sm_desc;
1000 struct berval sm_type;
1001 BerVarray sm_values;
1002 #define sm_bvalues sm_values
1004 BerVarray sm_nvalues;
1008 typedef struct slap_mod_list {
1009 Modification sml_mod;
1010 #define sml_op sml_mod.sm_op
1011 #define sml_desc sml_mod.sm_desc
1012 #define sml_type sml_mod.sm_type
1013 #define sml_bvalues sml_mod.sm_values
1014 #define sml_values sml_mod.sm_values
1015 #define sml_nvalues sml_mod.sm_nvalues
1016 struct slap_mod_list *sml_next;
1019 typedef struct slap_ldap_modlist {
1021 struct slap_ldap_modlist *ml_next;
1022 #define ml_op ml_mod.mod_op
1023 #define ml_type ml_mod.mod_type
1024 #define ml_values ml_mod.mod_values
1025 #define ml_bvalues ml_mod.mod_values
1029 * represents an access control list
1031 typedef enum slap_access_e {
1032 ACL_INVALID_ACCESS = -1,
1041 typedef enum slap_control_e {
1042 ACL_INVALID_CONTROL = 0,
1048 typedef enum slap_style_e {
1049 ACL_STYLE_REGEX = 0,
1056 /* alternate names */
1057 ACL_STYLE_EXACT = ACL_STYLE_BASE
1060 typedef struct slap_authz_info {
1061 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1062 struct berval sai_mech; /* SASL Mechanism */
1063 struct berval sai_dn; /* DN for reporting purposes */
1064 struct berval sai_ndn; /* Normalized DN */
1066 /* Security Strength Factors */
1067 slap_ssf_t sai_ssf; /* Overall SSF */
1068 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1069 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1070 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1071 } AuthorizationInformation;
1074 typedef struct slap_access {
1075 slap_control_t a_type;
1077 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1079 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1080 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1081 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1082 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1083 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1084 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1086 #define ACL_PRIV_MASK 0x00ffUL
1089 #define ACL_PRIV_LEVEL 0x1000UL
1090 #define ACL_PRIV_ADDITIVE 0x2000UL
1091 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1094 #define ACL_PRIV_INVALID 0x0UL
1096 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1097 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1098 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1099 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1101 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1102 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1104 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1106 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1108 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1109 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1110 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1112 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1113 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1114 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1115 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1116 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1117 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1119 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1120 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1121 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1122 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1123 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1124 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1125 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1127 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1128 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1129 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1130 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1131 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1132 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1134 slap_mask_t a_access_mask;
1136 AuthorizationInformation a_authz;
1137 #define a_dn_pat a_authz.sai_dn
1139 slap_style_t a_dn_style;
1140 AttributeDescription *a_dn_at;
1144 slap_style_t a_peername_style;
1145 struct berval a_peername_pat;
1146 slap_style_t a_sockname_style;
1147 struct berval a_sockname_pat;
1149 slap_style_t a_domain_style;
1150 struct berval a_domain_pat;
1151 int a_domain_expand;
1153 slap_style_t a_sockurl_style;
1154 struct berval a_sockurl_pat;
1155 slap_style_t a_set_style;
1156 struct berval a_set_pat;
1158 #ifdef SLAPD_ACI_ENABLED
1159 AttributeDescription *a_aci_at;
1163 slap_style_t a_group_style;
1164 struct berval a_group_pat;
1165 ObjectClass *a_group_oc;
1166 AttributeDescription *a_group_at;
1168 struct slap_access *a_next;
1172 typedef struct slap_acl {
1173 /* "to" part: the entries this acl applies to */
1175 slap_style_t acl_dn_style;
1177 struct berval acl_dn_pat;
1178 AttributeName *acl_attrs;
1180 /* "by" part: list of who has what access to the entries */
1183 struct slap_acl *acl_next;
1186 typedef struct slap_acl_state {
1187 unsigned as_recorded;
1188 #define ACL_STATE_NOT_RECORDED 0x0
1189 #define ACL_STATE_RECORDED_VD 0x1
1190 #define ACL_STATE_RECORDED_NV 0x2
1191 #define ACL_STATE_RECORDED 0x3
1194 AccessControl *as_vd_acl;
1195 AccessControl *as_vi_acl;
1196 slap_mask_t as_vd_acl_mask;
1197 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1198 int as_vd_acl_count;
1200 Access *as_vd_access;
1201 int as_vd_access_count;
1204 AttributeDescription *as_vd_ad;
1205 } AccessControlState;
1206 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1207 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1211 * represents a backend
1214 typedef struct slap_backend_info BackendInfo; /* per backend type */
1215 typedef struct slap_backend_db BackendDB; /* per backend database */
1217 LDAP_SLAPD_V (int) nBackendInfo;
1218 LDAP_SLAPD_V (int) nBackendDB;
1219 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1220 LDAP_SLAPD_V (BackendDB *) backendDB;
1222 LDAP_SLAPD_V (int) slapMode;
1223 #define SLAP_UNDEFINED_MODE 0x0000
1224 #define SLAP_SERVER_MODE 0x0001
1225 #define SLAP_TOOL_MODE 0x0002
1226 #define SLAP_MODE 0x0003
1228 #define SLAP_TRUNCATE_MODE 0x0100
1230 struct slap_replica_info {
1231 char *ri_host; /* supersedes be_replica */
1232 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1233 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1234 int ri_exclude; /* 1 => exclude ri_attrs */
1237 struct slap_limits_set {
1245 int lms_s_unchecked;
1250 struct slap_limits {
1251 int lm_type; /* type of pattern */
1252 #define SLAP_LIMITS_UNDEFINED 0x0000
1253 #define SLAP_LIMITS_EXACT 0x0001
1254 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1255 #define SLAP_LIMITS_ONE 0x0002
1256 #define SLAP_LIMITS_SUBTREE 0x0003
1257 #define SLAP_LIMITS_CHILDREN 0x0004
1258 #define SLAP_LIMITS_REGEX 0x0005
1259 #define SLAP_LIMITS_ANONYMOUS 0x0006
1260 #define SLAP_LIMITS_USERS 0x0007
1261 #define SLAP_LIMITS_ANY 0x0008
1262 regex_t lm_dn_regex; /* regex data for REGEX */
1265 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1266 * pattern for REGEX; NULL for ANONYMOUS, USERS
1268 struct berval lm_dn_pat;
1270 struct slap_limits_set lm_limits;
1273 /* temporary aliases */
1274 typedef BackendDB Backend;
1275 #define nbackends nBackendDB
1276 #define backends backendDB
1278 struct slap_backend_db {
1279 BackendInfo *bd_info; /* pointer to shared backend info */
1281 /* BackendInfo accessors */
1282 #define be_config bd_info->bi_db_config
1283 #define be_type bd_info->bi_type
1285 #define be_bind bd_info->bi_op_bind
1286 #define be_unbind bd_info->bi_op_unbind
1287 #define be_add bd_info->bi_op_add
1288 #define be_compare bd_info->bi_op_compare
1289 #define be_delete bd_info->bi_op_delete
1290 #define be_modify bd_info->bi_op_modify
1291 #define be_modrdn bd_info->bi_op_modrdn
1292 #define be_search bd_info->bi_op_search
1293 #define be_abandon bd_info->bi_op_abandon
1294 #define be_cancel bd_info->bi_op_cancel
1296 #define be_extended bd_info->bi_extended
1298 #define be_fetch bd_info->bi_entry_get_rw
1299 #define be_release bd_info->bi_entry_release_rw
1300 #define be_chk_referrals bd_info->bi_chk_referrals
1301 #define be_group bd_info->bi_acl_group
1302 #define be_attribute bd_info->bi_acl_attribute
1303 #define be_operational bd_info->bi_operational
1306 * define to honor hasSubordinates operational attribute in search filters
1307 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1310 #define be_has_subordinates bd_info->bi_has_subordinates
1312 #define be_controls bd_info->bi_controls
1314 #define be_connection_init bd_info->bi_connection_init
1315 #define be_connection_destroy bd_info->bi_connection_destroy
1318 #define be_entry_open bd_info->bi_tool_entry_open
1319 #define be_entry_close bd_info->bi_tool_entry_close
1320 #define be_entry_first bd_info->bi_tool_entry_first
1321 #define be_entry_next bd_info->bi_tool_entry_next
1322 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1323 #define be_entry_get bd_info->bi_tool_entry_get
1324 #define be_entry_put bd_info->bi_tool_entry_put
1325 #define be_sync bd_info->bi_tool_sync
1328 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1329 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1330 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1331 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1332 #define SLAP_BFLAG_ALIASES 0x0100U
1333 #define SLAP_BFLAG_REFERRALS 0x0200U
1334 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1335 #define SLAP_BFLAG_MONITOR 0x1000U
1336 #define SLAP_BFLAG_DYNAMIC 0x2000U
1337 slap_mask_t be_flags;
1338 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1339 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1340 #define SLAP_GLUE_SUBORDINATE(be) \
1341 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1342 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1343 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1344 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1345 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1346 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1347 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1349 slap_mask_t be_restrictops; /* restriction operations */
1350 #define SLAP_RESTRICT_OP_ADD 0x0001U
1351 #define SLAP_RESTRICT_OP_BIND 0x0002U
1352 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1353 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1354 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1355 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1356 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1357 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1359 #define SLAP_RESTRICT_OP_READS \
1360 ( SLAP_RESTRICT_OP_COMPARE \
1361 | SLAP_RESTRICT_OP_SEARCH )
1362 #define SLAP_RESTRICT_OP_WRITES \
1363 ( SLAP_RESTRICT_OP_ADD \
1364 | SLAP_RESTRICT_OP_DELETE \
1365 | SLAP_RESTRICT_OP_MODIFY \
1366 | SLAP_RESTRICT_OP_RENAME )
1368 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1369 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1370 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1372 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1374 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1375 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1376 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1377 0x0004U /* unprotected simple auth */
1378 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1380 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1381 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1383 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1385 slap_mask_t be_requires; /* pre-operation requirements */
1386 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1387 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1388 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1389 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1390 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1392 /* Required Security Strength Factor */
1393 slap_ssf_set_t be_ssf_set;
1395 /* these should be renamed from be_ to bd_ */
1396 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1397 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1398 struct berval be_schemadn; /* per-backend subschema subentry DN */
1399 struct berval be_schemandn; /* normalized subschema DN */
1400 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1401 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1402 struct berval be_rootpw; /* the magic "root" password for this db */
1403 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1404 #define be_sizelimit be_def_limit.lms_s_soft
1405 #define be_timelimit be_def_limit.lms_t_soft
1406 struct slap_limits_set be_def_limit; /* default limits */
1407 struct slap_limits **be_limits; /* regex-based size and time limits */
1408 AccessControl *be_acl; /* access control list for this backend */
1409 slap_access_t be_dfltaccess; /* access given if no acl matches */
1410 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1411 char *be_replogfile; /* replication log file (in master) */
1412 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1413 BerVarray be_update_refs; /* where to refer modifying clients to */
1415 void *be_private; /* anything the backend database needs */
1417 void *be_pb; /* Netscape plugin */
1423 /* Backend function typedefs */
1424 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1425 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1426 const char *fname, int lineno,
1427 int argc, char **argv));
1428 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1429 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1430 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1432 typedef int (BI_db_init) LDAP_P((Backend *bd));
1433 typedef int (BI_db_config) LDAP_P((Backend *bd,
1434 const char *fname, int lineno,
1435 int argc, char **argv));
1436 typedef int (BI_db_open) LDAP_P((Backend *bd));
1437 typedef int (BI_db_close) LDAP_P((Backend *bd));
1438 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1440 typedef struct req_bind_s {
1442 struct berval rb_cred;
1443 struct berval rb_edn;
1447 typedef struct req_search_s {
1453 AttributeName *rs_attrs;
1455 struct berval rs_filterstr;
1458 typedef struct req_compare_s {
1459 AttributeAssertion *rs_ava;
1462 typedef struct req_modify_s {
1463 Modifications *rs_modlist;
1466 typedef struct req_modrdn_s {
1467 struct berval rs_newrdn;
1468 struct berval rs_nnewrdn;
1469 struct berval *rs_newSup;
1470 struct berval *rs_nnewSup;
1471 int rs_deleteoldrdn;
1474 typedef struct req_add_s {
1478 typedef struct req_abandon_s {
1482 typedef struct req_extended_s {
1483 struct berval rs_reqoid;
1484 struct berval *rs_reqdata;
1487 typedef enum slap_reply_e {
1496 typedef struct rep_sasl_s {
1497 struct berval *r_sasldata;
1500 typedef struct rep_sresult_s {
1504 typedef struct rep_extended_s {
1505 const char *r_rspoid;
1506 struct berval *r_rspdata;
1509 typedef struct rep_search_s {
1510 AttributeName *r_attrs;
1515 typedef struct slap_rep {
1516 slap_reply_t sr_type;
1520 const char *sr_matched;
1521 const char *sr_text;
1523 LDAPControl **sr_ctrls;
1525 rep_sasl_s sru_sasl;
1526 rep_sresult_s sru_sresult;
1527 rep_extended_s sru_extended;
1528 rep_search_s sru_search;
1532 /* short hands for response members */
1533 #define sr_attrs sr_un.sru_search.r_attrs
1534 #define sr_entry sr_un.sru_search.r_entry
1535 #define sr_v2ref sr_un.sru_search.r_v2ref
1536 #define sr_rspoid sr_un.sru_extended.r_rspoid
1537 #define sr_rspdata sr_un.sru_extended.r_rspdata
1538 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1539 #define sr_nentries sr_un.sru_sresult.r_nentries
1541 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1542 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1543 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1544 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1545 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1546 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1547 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1548 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1549 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1550 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1551 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1552 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1553 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1554 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1555 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1556 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1557 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1559 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1560 struct slap_conn *c));
1561 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1562 struct slap_conn *c));
1564 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1565 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1566 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1567 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1568 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1569 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1570 struct berval *text ));
1571 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1572 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1574 struct slap_backend_info {
1575 char *bi_type; /* type of backend */
1578 * per backend type routines:
1579 * bi_init: called to allocate a backend_info structure,
1580 * called once BEFORE configuration file is read.
1581 * bi_init() initializes this structure hence is
1582 * called directly from be_initialize()
1583 * bi_config: called per 'backend' specific option
1584 * all such options must before any 'database' options
1585 * bi_config() is called only from read_config()
1586 * bi_open: called to open each database, called
1587 * once AFTER configuration file is read but
1588 * BEFORE any bi_db_open() calls.
1589 * bi_open() is called from backend_startup()
1590 * bi_close: called to close each database, called
1591 * once during shutdown after all bi_db_close calls.
1592 * bi_close() is called from backend_shutdown()
1593 * bi_destroy: called to destroy each database, called
1594 * once during shutdown after all bi_db_destroy calls.
1595 * bi_destory() is called from backend_destroy()
1598 BI_config *bi_config;
1601 BI_destroy *bi_destroy;
1604 * per database routines:
1605 * bi_db_init: called to initialize each database,
1606 * called upon reading 'database <type>'
1607 * called only from backend_db_init()
1608 * bi_db_config: called to configure each database,
1609 * called per database to handle per database options
1610 * called only from read_config()
1611 * bi_db_open: called to open each database
1612 * called once per database immediately AFTER bi_open()
1613 * calls but before daemon startup.
1614 * called only by backend_startup()
1615 * bi_db_close: called to close each database
1616 * called once per database during shutdown but BEFORE
1617 * any bi_close call.
1618 * called only by backend_shutdown()
1619 * bi_db_destroy: called to destroy each database
1620 * called once per database during shutdown AFTER all
1621 * bi_close calls but before bi_destory calls.
1622 * called only by backend_destory()
1624 BI_db_init *bi_db_init;
1625 BI_db_config *bi_db_config;
1626 BI_db_open *bi_db_open;
1627 BI_db_close *bi_db_close;
1628 BI_db_destroy *bi_db_destroy;
1630 /* LDAP Operations Handling Routines */
1631 BI_op_bind *bi_op_bind;
1632 BI_op_unbind *bi_op_unbind;
1633 BI_op_search *bi_op_search;
1634 BI_op_compare *bi_op_compare;
1635 BI_op_modify *bi_op_modify;
1636 BI_op_modrdn *bi_op_modrdn;
1637 BI_op_add *bi_op_add;
1638 BI_op_delete *bi_op_delete;
1639 BI_op_abandon *bi_op_abandon;
1640 BI_op_cancel *bi_op_cancel;
1642 /* Extended Operations Helper */
1643 BI_op_extended *bi_extended;
1645 /* Auxilary Functions */
1646 BI_entry_get_rw *bi_entry_get_rw;
1647 BI_entry_release_rw *bi_entry_release_rw;
1648 BI_chk_referrals *bi_chk_referrals;
1650 BI_operational *bi_operational;
1651 BI_has_subordinates *bi_has_subordinates;
1653 BI_connection_init *bi_connection_init;
1654 BI_connection_destroy *bi_connection_destroy;
1656 /* hooks for slap tools */
1657 BI_tool_entry_open *bi_tool_entry_open;
1658 BI_tool_entry_close *bi_tool_entry_close;
1659 BI_tool_entry_first *bi_tool_entry_first;
1660 BI_tool_entry_next *bi_tool_entry_next;
1661 BI_tool_entry_get *bi_tool_entry_get;
1662 BI_tool_entry_put *bi_tool_entry_put;
1663 BI_tool_entry_reindex *bi_tool_entry_reindex;
1664 BI_tool_sync *bi_tool_sync;
1666 #define SLAP_INDEX_ADD_OP 0x0001
1667 #define SLAP_INDEX_DELETE_OP 0x0002
1669 char **bi_controls; /* supported controls */
1671 unsigned int bi_nDB; /* number of databases of this type */
1672 void *bi_private; /* anything the backend type needs */
1675 #define c_authtype c_authz.sai_method
1676 #define c_authmech c_authz.sai_mech
1677 #define c_dn c_authz.sai_dn
1678 #define c_ndn c_authz.sai_ndn
1679 #define c_ssf c_authz.sai_ssf
1680 #define c_transport_ssf c_authz.sai_transport_ssf
1681 #define c_tls_ssf c_authz.sai_tls_ssf
1682 #define c_sasl_ssf c_authz.sai_sasl_ssf
1684 #define o_authtype o_authz.sai_method
1685 #define o_authmech o_authz.sai_mech
1686 #define o_dn o_authz.sai_dn
1687 #define o_ndn o_authz.sai_ndn
1688 #define o_ssf o_authz.sai_ssf
1689 #define o_transport_ssf o_authz.sai_transport_ssf
1690 #define o_tls_ssf o_authz.sai_tls_ssf
1691 #define o_sasl_ssf o_authz.sai_sasl_ssf
1693 typedef void (slap_response)( struct slap_op *, struct slap_rep * );
1694 typedef void (slap_sresult)( struct slap_op *, struct slap_rep * );
1695 typedef int (slap_sendentry)( struct slap_op *, struct slap_rep * );
1696 typedef int (slap_sendreference)( struct slap_op *, struct slap_rep * );
1698 typedef struct slap_callback {
1699 slap_response *sc_response;
1700 slap_sresult *sc_sresult;
1701 slap_sendentry *sc_sendentry;
1702 slap_sendreference *sc_sendreference;
1707 * Paged Results state
1709 typedef unsigned long PagedResultsCookie;
1710 typedef struct slap_paged_state {
1712 PagedResultsCookie ps_cookie;
1714 } PagedResultsState;
1717 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1718 #define LDAP_PSEARCH_BY_ADD 0x01
1719 #define LDAP_PSEARCH_BY_DELETE 0x02
1720 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1721 #define LDAP_PSEARCH_BY_MODIFY 0x04
1722 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1725 struct slap_op *ps_op;
1726 LDAP_LIST_ENTRY(psid_entry) ps_link;
1732 * represents an operation pending from an ldap client
1734 typedef struct slap_op {
1735 unsigned long o_opid; /* id of this operation */
1736 unsigned long o_connid; /* id of conn initiating this op */
1737 struct slap_conn *o_conn; /* connection spawning this op */
1738 BackendDB *o_bd; /* backend DB processing this op */
1740 ber_int_t o_msgid; /* msgid of the request */
1741 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1742 ber_tag_t o_tag; /* tag of the request */
1743 time_t o_time; /* time op was initiated */
1745 struct berval o_req_dn; /* DN of target of request */
1746 struct berval o_req_ndn;
1751 req_compare_s oq_compare;
1752 req_modify_s oq_modify;
1753 req_modrdn_s oq_modrdn;
1754 req_search_s oq_search;
1755 req_abandon_s oq_abandon;
1756 req_abandon_s oq_cancel;
1757 req_extended_s oq_extended;
1760 /* short hands for union members */
1761 #define oq_add o_request.oq_add
1762 #define oq_bind o_request.oq_bind
1763 #define oq_compare o_request.oq_compare
1764 #define oq_modify o_request.oq_modify
1765 #define oq_modrdn o_request.oq_modrdn
1766 #define oq_search o_request.oq_search
1767 #define oq_abandon o_request.oq_abandon
1768 #define oq_cancel o_request.oq_cancel
1769 #define oq_extended o_request.oq_extended
1771 /* short hands for inner request members */
1772 #define orb_method oq_bind.rb_method
1773 #define orb_cred oq_bind.rb_cred
1774 #define orb_edn oq_bind.rb_edn
1775 #define orb_ssf oq_bind.rb_ssf
1777 #define ors_scope oq_search.rs_scope
1778 #define ors_deref oq_search.rs_deref
1779 #define ors_slimit oq_search.rs_slimit
1780 #define ors_tlimit oq_search.rs_tlimit
1781 #define ors_attrsonly oq_search.rs_attrsonly
1782 #define ors_attrs oq_search.rs_attrs
1783 #define ors_filter oq_search.rs_filter
1784 #define ors_filterstr oq_search.rs_filterstr
1786 #define orr_newrdn oq_modrdn.rs_newrdn
1787 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1788 #define orr_newSup oq_modrdn.rs_newSup
1789 #define orr_nnewSup oq_modrdn.rs_nnewSup
1790 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1792 #define orc_ava oq_compare.rs_ava
1793 #define ora_e oq_add.rs_e
1794 #define orn_msgid oq_abandon.rs_msgid
1795 #define orm_modlist oq_modify.rs_modlist
1797 #define ore_reqoid oq_extended.rs_reqoid
1798 #define ore_reqdata oq_extended.rs_reqdata
1800 ldap_pvt_thread_t o_tid; /* thread handling this op */
1802 volatile sig_atomic_t o_abandon; /* abandon flag */
1803 volatile sig_atomic_t o_cancel; /* cancel flag */
1804 #define SLAP_CANCEL_NONE 0x00
1805 #define SLAP_CANCEL_REQ 0x01
1806 #define SLAP_CANCEL_ACK 0x02
1807 #define SLAP_CANCEL_DONE 0x03
1809 char o_do_not_cache; /* don't cache from this op */
1810 char o_is_auth_check; /* authorization in progress */
1812 #define SLAP_NO_CONTROL 0
1813 #define SLAP_NONCRITICAL_CONTROL 1
1814 #define SLAP_CRITICAL_CONTROL 2
1816 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1822 #define get_subentries(op) ((int)(op)->o_subentries)
1823 char o_subentries_visibility;
1824 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1826 char o_valuesreturnfilter;
1828 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1829 char o_permissive_modify;
1830 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1832 #define get_permissiveModify(op) (0)
1835 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1836 char o_domain_scope;
1837 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1839 #define get_domainScope(op) (0)
1842 #ifdef LDAP_CONTROL_PAGEDRESULTS
1843 char o_pagedresults;
1844 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1845 ber_int_t o_pagedresults_size;
1846 PagedResultsState o_pagedresults_state;
1848 #define get_pagedresults(op) (0)
1851 #ifdef LDAP_CLIENT_UPDATE
1852 char o_clientupdate;
1853 char o_clientupdate_type;
1854 #define SLAP_LCUP_NONE (0x0)
1855 #define SLAP_LCUP_SYNC (0x1)
1856 #define SLAP_LCUP_PERSIST (0x2)
1857 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1858 ber_int_t o_clientupdate_interval;
1859 struct berval o_clientupdate_state;
1865 #define SLAP_SYNC_NONE (0x0)
1866 #define SLAP_SYNC_REFRESH (0x1)
1867 #define SLAP_SYNC_PERSIST (0x2)
1868 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1869 struct berval o_sync_state;
1872 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1875 LDAP_LIST_ENTRY(slap_op) o_ps_link;
1876 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1879 AuthorizationInformation o_authz;
1881 BerElement *o_ber; /* ber of the request */
1882 #ifdef LDAP_CONNECTIONLESS
1883 BerElement *o_res_ber; /* ber of the reply */
1885 slap_callback *o_callback; /* callback pointers */
1886 LDAPControl **o_ctrls; /* controls */
1888 void *o_threadctx; /* thread pool thread context */
1889 void *o_private; /* anything the backend needs */
1891 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1892 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1896 #endif /*LDAP_CACHING */
1899 void *o_pb; /* NS-SLAPI plugin */
1903 #define send_ldap_error( op, rs, err, text ) \
1904 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1905 (op->o_conn->c_send_ldap_result)( op, rs ); } while (0)
1906 #define send_ldap_discon( op, rs, err, text ) \
1907 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1908 send_ldap_disconnect( op, rs ); } while (0)
1909 typedef void (SEND_LDAP_RESULT)(struct slap_op *op, struct slap_rep *rs);
1910 typedef int (SEND_SEARCH_ENTRY)(struct slap_op *op, struct slap_rep *rs);
1911 typedef void (SEND_SEARCH_RESULT)(struct slap_op *op, struct slap_rep *rs);
1912 typedef int (SEND_SEARCH_REFERENCE)(struct slap_op *op, struct slap_rep *rs);
1913 typedef void (SEND_LDAP_EXTENDED)(struct slap_op *op, struct slap_rep *rs);
1914 typedef void (SEND_LDAP_INTERMEDIATE_RESP)(struct slap_op *op, struct slap_rep *rs);
1915 #define send_ldap_result( op, rs ) \
1916 (op->o_conn->c_send_ldap_result)( op, rs )
1917 #define send_search_entry( op, rs ) \
1918 (op->o_conn->c_send_search_entry)( op, rs )
1919 #define send_search_result( op, rs ) \
1920 (op->o_conn->c_send_search_result)( op, rs )
1921 #define send_search_reference( op, rs ) \
1922 (op->o_conn->c_send_search_reference)( op, rs )
1923 #define send_ldap_extended( op, rs ) \
1924 (op->o_conn->c_send_ldap_extended)( op, rs )
1925 #define send_ldap_intermediate_resp( op, rs ) \
1926 (op->o_conn->c_send_ldap_intermediate_resp)( op, rs )
1929 * Caches the result of a backend_group check for ACL evaluation
1931 typedef struct slap_gacl {
1932 struct slap_gacl *ga_next;
1935 AttributeDescription *ga_at;
1941 typedef struct slap_listener Listener;
1944 * represents a connection from an ldap client
1946 typedef struct slap_conn {
1947 int c_struct_state; /* structure management state */
1948 int c_conn_state; /* connection state */
1950 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1951 Sockbuf *c_sb; /* ber connection stuff */
1953 /* only can be changed by connect_init */
1954 time_t c_starttime; /* when the connection was opened */
1955 time_t c_activitytime; /* when the connection was last used */
1956 unsigned long c_connid; /* id of this connection for stats*/
1958 struct berval c_peer_domain; /* DNS name of client */
1959 struct berval c_peer_name; /* peer name (trans=addr:port) */
1960 Listener *c_listener;
1961 #define c_listener_url c_listener->sl_url /* listener URL */
1962 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
1964 /* only can be changed by binding thread */
1965 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1966 struct berval c_sasl_bind_mech; /* mech in progress */
1967 struct berval c_sasl_dn; /* temporary storage */
1969 /* authorization backend */
1970 Backend *c_authz_backend;
1972 AuthorizationInformation c_authz;
1973 GroupAssertion *c_groups;
1975 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1977 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1978 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1980 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1981 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1983 BerElement *c_currentber; /* ber we're attempting to read */
1984 int c_writewaiter; /* true if writer is waiting */
1986 #ifdef LDAP_CONNECTIONLESS
1987 int c_is_udp; /* true if this is (C)LDAP over UDP */
1990 int c_is_tls; /* true if this LDAP over raw TLS */
1991 int c_needs_tls_accept; /* true if SSL_accept should be called */
1993 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1994 void *c_sasl_context; /* SASL session context */
1995 void *c_sasl_extra; /* SASL session extra stuff */
1996 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1998 PagedResultsState c_pagedresults_state; /* paged result state */
2000 long c_n_ops_received; /* num of ops received (next op_id) */
2001 long c_n_ops_executing; /* num of ops currently executing */
2002 long c_n_ops_pending; /* num of ops pending execution */
2003 long c_n_ops_completed; /* num of ops completed */
2005 long c_n_get; /* num of get calls */
2006 long c_n_read; /* num of read calls */
2007 long c_n_write; /* num of write calls */
2009 void *c_pb; /* Netscape plugin */
2012 * These are the "callbacks" that are available for back-ends to
2013 * supply data back to connected clients that are connected
2014 * through the "front-end".
2016 SEND_LDAP_RESULT *c_send_ldap_result;
2017 SEND_SEARCH_ENTRY *c_send_search_entry;
2018 SEND_SEARCH_RESULT *c_send_search_result;
2019 SEND_SEARCH_REFERENCE *c_send_search_reference;
2020 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2021 #ifdef LDAP_RES_INTERMEDIATE_RESP
2022 SEND_LDAP_INTERMEDIATE_RESP *c_send_ldap_intermediate_resp;
2027 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2028 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2030 if ( ldap_debug & (level) ) \
2031 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2032 if ( ldap_syslog & (level) ) \
2033 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2036 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2037 #elif defined(LDAP_DEBUG)
2038 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2040 if ( ldap_debug & (level) ) \
2041 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2043 #define StatslogTest( level ) (ldap_debug & (level))
2045 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2046 #define StatslogTest( level ) (0)
2050 * listener; need to access it from monitor backend
2052 struct slap_listener {
2053 struct berval sl_url;
2054 struct berval sl_name;
2059 #ifdef LDAP_CONNECTIONLESS
2060 int sl_is_udp; /* UDP listener is also data port */
2064 #define sl_addr sl_sa.sa_in_addr
2067 #ifdef SLAPD_MONITOR
2084 #endif /* SLAPD_MONITOR */
2087 * Better know these all around slapd
2089 #define SLAP_LDAPDN_PRETTY 0x1
2090 #define SLAP_LDAPDN_MAXLEN 8192
2095 #ifdef LDAP_CLIENT_UPDATE
2096 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2097 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2098 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2099 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2100 #endif /* LDAP_CLIENT_UPDATE */
2102 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2103 #define SLAP_SEARCH_MAX_CTRLS 10
2106 #define SLAP_CTRL_FRONTEND 0x80000000U
2107 #define SLAP_CTRL_FRONTEND_SEARCH 0x01000000U /* for NOOP */
2109 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2110 #define SLAP_CTRL_ABANDON 0x00000001U
2111 #define SLAP_CTRL_ADD 0x00002002U
2112 #define SLAP_CTRL_BIND 0x00000004U
2113 #define SLAP_CTRL_COMPARE 0x00001008U
2114 #define SLAP_CTRL_DELETE 0x00002010U
2115 #define SLAP_CTRL_MODIFY 0x00002020U
2116 #define SLAP_CTRL_RENAME 0x00002040U
2117 #define SLAP_CTRL_SEARCH 0x00001080U
2118 #define SLAP_CTRL_UNBIND 0x00000100U
2120 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2121 #define SLAP_CTRL_UPDATE \
2122 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2123 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2125 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2128 LDAPControl *ctrl ));
2132 #include "proto-slap.h"
2134 #endif /* _SLAP_H_ */