1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
14 #include <ac/stdlib.h>
16 #include <sys/types.h>
17 #include <ac/syslog.h>
19 #include <ac/signal.h>
20 #include <ac/socket.h>
27 #define ldap_debug slap_debug
33 #include <ldap_schema.h>
35 #include "ldap_pvt_thread.h"
36 #include "ldap_queue.h"
38 #define SLAP_EXTENDED_SCHEMA 1
39 #define LDAP_CACHING 1
43 * SLAPD Memory allocation macros
45 * Unlike ch_*() routines, these routines do not assert() upon
46 * allocation error. They are intended to be used instead of
47 * ch_*() routines where the caller has implemented proper
48 * checking for and handling of allocation errors.
50 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
52 #define SLAP_MALLOC(s) ber_memalloc((s))
53 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
54 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
55 #define SLAP_FREE(p) ber_memfree((p))
56 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
57 #define SLAP_STRDUP(s) ber_strdup((s))
58 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
61 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
64 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
65 #define SLAPD_ANONYMOUS "cn=anonymous"
67 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
68 * This is a value used internally by the backends. It is needed to allow
69 * adding values that already exist without getting an error as required by
70 * modrdn when the new rdn was already an attribute value itself.
72 #define SLAP_MOD_SOFTADD 0x1000
74 #define MAXREMATCHES (100)
76 #define SLAP_MAX_WORKER_THREADS (16)
79 #define SLAP_MAX_SYNCREPL_THREADS (8)
82 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
83 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
85 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
86 #define SLAP_CONN_MAX_PENDING_AUTH 1000
88 #define SLAP_TEXT_BUFLEN (256)
90 /* psuedo error code indicating abandoned operation */
91 #define SLAPD_ABANDON (-1)
93 /* psuedo error code indicating disconnect */
94 #define SLAPD_DISCONNECT (-2)
97 /* We assume "C" locale, that is US-ASCII */
98 #define ASCII_SPACE(c) ( (c) == ' ' )
99 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
100 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
101 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
102 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
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_GROUP_ATTR "member"
144 #define SLAPD_GROUP_CLASS "groupOfNames"
145 #define SLAPD_ROLE_ATTR "roleOccupant"
146 #define SLAPD_ROLE_CLASS "organizationalRole"
148 #ifdef SLAPD_ACI_ENABLED
149 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
152 /* change this to "OpenLDAPset" */
153 #define SLAPD_ACI_SET_ATTR "template"
155 #define SLAPD_TOP_OID "2.5.6.0"
157 LDAP_SLAPD_V (int) slap_debug;
159 typedef unsigned long slap_mask_t;
161 /* Security Strength Factor */
162 typedef unsigned slap_ssf_t;
164 typedef struct slap_ssf_set {
166 slap_ssf_t sss_transport;
169 slap_ssf_t sss_update_ssf;
170 slap_ssf_t sss_update_transport;
171 slap_ssf_t sss_update_tls;
172 slap_ssf_t sss_update_sasl;
173 slap_ssf_t sss_simple_bind;
176 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
177 #define SLAP_GETDN_AUTHCID 2
178 #define SLAP_GETDN_AUTHZID 4
183 #define SLAP_INDEX_TYPE 0x00FFUL
184 #define SLAP_INDEX_UNDEFINED 0x0001UL
185 #define SLAP_INDEX_PRESENT 0x0002UL
186 #define SLAP_INDEX_EQUALITY 0x0004UL
187 #define SLAP_INDEX_APPROX 0x0008UL
188 #define SLAP_INDEX_SUBSTR 0x0010UL
189 #define SLAP_INDEX_EXTENDED 0x0020UL
191 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
193 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
195 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
197 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
198 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
199 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
200 #define SLAP_INDEX_SUBSTR_DEFAULT \
201 ( SLAP_INDEX_SUBSTR \
202 | SLAP_INDEX_SUBSTR_INITIAL \
203 | SLAP_INDEX_SUBSTR_ANY \
204 | SLAP_INDEX_SUBSTR_FINAL )
206 #define SLAP_INDEX_SUBSTR_MINLEN 2
207 #define SLAP_INDEX_SUBSTR_MAXLEN 4
208 #define SLAP_INDEX_SUBSTR_STEP 2
210 #define SLAP_INDEX_FLAGS 0xF000UL
211 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
212 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
215 * there is a single index for each attribute. these prefixes ensure
216 * that there is no collision among keys.
218 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
219 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
220 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
221 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
222 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
223 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
225 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
226 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
227 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
228 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
229 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
231 #ifdef LDAP_CLIENT_UPDATE
232 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
233 #endif /* LDAP_CLIENT_UPDATE */
236 * represents schema information for a database
238 #define SLAP_SCHERR_OUTOFMEM 1
239 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
240 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
241 #define SLAP_SCHERR_CLASS_BAD_SUP 4
242 #define SLAP_SCHERR_CLASS_DUP 5
243 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
244 #define SLAP_SCHERR_ATTR_BAD_MR 7
245 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
246 #define SLAP_SCHERR_ATTR_BAD_SUP 9
247 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
248 #define SLAP_SCHERR_ATTR_DUP 11
249 #define SLAP_SCHERR_MR_NOT_FOUND 12
250 #define SLAP_SCHERR_MR_INCOMPLETE 13
251 #define SLAP_SCHERR_MR_DUP 14
252 #define SLAP_SCHERR_SYN_NOT_FOUND 15
253 #define SLAP_SCHERR_SYN_DUP 16
254 #define SLAP_SCHERR_NO_NAME 17
255 #define SLAP_SCHERR_NOT_SUPPORTED 18
256 #define SLAP_SCHERR_BAD_DESCR 19
257 #define SLAP_SCHERR_OIDM 20
258 #define SLAP_SCHERR_CR_DUP 21
259 #define SLAP_SCHERR_CR_BAD_STRUCT 22
260 #define SLAP_SCHERR_CR_BAD_AUX 23
261 #define SLAP_SCHERR_CR_BAD_AT 24
262 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
264 typedef union slap_sockaddr {
265 struct sockaddr sa_addr;
266 struct sockaddr_in sa_in_addr;
268 struct sockaddr_storage sa_storage;
269 struct sockaddr_in6 sa_in6_addr;
272 struct sockaddr_un sa_un_addr;
277 extern int slap_inet4or6;
280 typedef struct slap_oid_macro {
281 struct berval som_oid;
283 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
286 /* forward declarations */
288 struct slap_matching_rule;
290 typedef int slap_syntax_validate_func LDAP_P((
291 struct slap_syntax *syntax,
292 struct berval * in));
294 typedef int slap_syntax_transform_func LDAP_P((
295 struct slap_syntax *syntax,
300 typedef struct slap_syntax {
302 #define ssyn_oid ssyn_syn.syn_oid
303 #define ssyn_desc ssyn_syn.syn_desc
304 #define ssyn_extensions ssyn_syn.syn_extensions
307 ber_len_t ssyn_oidlen;
308 * has been replaced by a struct berval that uses the value
309 * provided by ssyn_syn.syn_oid; a macro that expands to
310 * the bv_len field of the berval is provided for backward
311 * compatibility. CAUTION: NEVER FREE THE BERVAL
313 struct berval ssyn_bvoid;
314 #define ssyn_oidlen ssyn_bvoid.bv_len
316 unsigned int ssyn_flags;
318 #define SLAP_SYNTAX_NONE 0x0000U
319 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
320 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
321 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
322 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
324 slap_syntax_validate_func *ssyn_validate;
325 slap_syntax_transform_func *ssyn_pretty;
327 #ifdef SLAPD_BINARY_CONVERSION
328 /* convert to and from binary */
329 slap_syntax_transform_func *ssyn_ber2str;
330 slap_syntax_transform_func *ssyn_str2ber;
333 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
336 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
337 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
338 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
339 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
340 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
342 typedef struct slap_syntax_defs_rec {
345 slap_syntax_validate_func *sd_validate;
346 slap_syntax_transform_func *sd_pretty;
347 #ifdef SLAPD_BINARY_CONVERSION
348 slap_syntax_transform_func *sd_ber2str;
349 slap_syntax_transform_func *sd_str2ber;
351 } slap_syntax_defs_rec;
353 /* X -> Y Converter */
354 typedef int slap_mr_convert_func LDAP_P((
360 typedef int slap_mr_normalize_func LDAP_P((
362 struct slap_syntax *syntax, /* NULL if in is asserted value */
363 struct slap_matching_rule *mr,
368 /* Match (compare) function */
369 typedef int slap_mr_match_func LDAP_P((
372 struct slap_syntax *syntax, /* syntax of stored value */
373 struct slap_matching_rule *mr,
374 struct berval * value,
375 void * assertValue ));
377 /* Index generation function */
378 typedef int slap_mr_indexer_func LDAP_P((
381 struct slap_syntax *syntax, /* syntax of stored value */
382 struct slap_matching_rule *mr,
383 struct berval *prefix,
388 /* Filter index function */
389 typedef int slap_mr_filter_func LDAP_P((
392 struct slap_syntax *syntax, /* syntax of stored value */
393 struct slap_matching_rule *mr,
394 struct berval *prefix,
399 typedef struct slap_matching_rule_use MatchingRuleUse;
401 typedef struct slap_matching_rule {
402 LDAPMatchingRule smr_mrule;
403 MatchingRuleUse *smr_mru;
404 /* RFC2252 string representation */
405 struct berval smr_str;
408 * ber_len_t smr_oidlen;
409 * has been replaced by a struct berval that uses the value
410 * provided by smr_mrule.mr_oid; a macro that expands to
411 * the bv_len field of the berval is provided for backward
412 * compatibility. CAUTION: NEVER FREE THE BERVAL
414 struct berval smr_bvoid;
415 #define smr_oidlen smr_bvoid.bv_len
417 slap_mask_t smr_usage;
419 #define SLAP_MR_HIDE 0x8000U
421 #define SLAP_MR_TYPE_MASK 0x0F00U
422 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
423 #define SLAP_MR_USAGE 0x000FU
425 #define SLAP_MR_NONE 0x0000U
426 #define SLAP_MR_EQUALITY 0x0100U
427 #define SLAP_MR_ORDERING 0x0200U
428 #define SLAP_MR_SUBSTR 0x0400U
429 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
431 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
433 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
434 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
435 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
439 * The asserted value, depending on the particular usage,
440 * is expected to conform to either the assertion syntax
441 * or the attribute syntax. In some cases, the syntax of
442 * the value is known. If so, these flags indicate which
443 * syntax the value is expected to conform to. If not,
444 * neither of these flags is set (until the syntax of the
445 * provided value is determined). If the value is of the
446 * attribute syntax, the flag is changed once a value of
447 * the assertion syntax is derived from the provided value.
449 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
450 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
452 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
453 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
454 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
455 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
457 /* either or both the asserted value or attribute value
458 * may be provided in normalized form
460 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
461 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
463 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
464 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
465 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
466 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
468 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
469 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
470 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
471 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
472 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
473 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
475 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
476 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
477 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
478 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
481 slap_mr_convert_func *smr_convert;
482 slap_mr_normalize_func *smr_normalize;
483 slap_mr_match_func *smr_match;
484 slap_mr_indexer_func *smr_indexer;
485 slap_mr_filter_func *smr_filter;
488 * null terminated array of syntaxes compatible with this syntax
489 * note: when MS_EXT is set, this MUST NOT contain the assertion
490 * syntax of the rule. When MS_EXT is not set, it MAY.
492 Syntax **smr_compat_syntaxes;
495 * For equality rules, refers to an associated approximate rule.
496 * For non-equality rules, refers to an associated equality rule.
498 struct slap_matching_rule *smr_associated;
500 #define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \
501 ((mr)->smr_associated == (amr)))
503 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
505 #define smr_oid smr_mrule.mr_oid
506 #define smr_names smr_mrule.mr_names
507 #define smr_desc smr_mrule.mr_desc
508 #define smr_obsolete smr_mrule.mr_obsolete
509 #define smr_syntax_oid smr_mrule.mr_syntax_oid
510 #define smr_extensions smr_mrule.mr_extensions
513 struct slap_matching_rule_use {
514 LDAPMatchingRuleUse smru_mruleuse;
515 MatchingRule *smru_mr;
516 /* RFC2252 string representation */
517 struct berval smru_str;
519 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
521 #define smru_oid smru_mruleuse.mru_oid
522 #define smru_names smru_mruleuse.mru_names
523 #define smru_desc smru_mruleuse.mru_desc
524 #define smru_obsolete smru_mruleuse.mru_obsolete
525 #define smru_applies_oids smru_mruleuse.mru_applies_oids
527 #define smru_usage smru_mr->smr_usage
528 } /* MatchingRuleUse */ ;
530 typedef struct slap_mrule_defs_rec {
532 slap_mask_t mrd_usage;
533 char ** mrd_compat_syntaxes;
534 slap_mr_convert_func * mrd_convert;
535 slap_mr_normalize_func * mrd_normalize;
536 slap_mr_match_func * mrd_match;
537 slap_mr_indexer_func * mrd_indexer;
538 slap_mr_filter_func * mrd_filter;
540 /* For equality rule, this may refer to an associated approximate rule */
541 /* For non-equality rule, this may refer to an associated equality rule */
542 char * mrd_associated;
543 } slap_mrule_defs_rec;
545 struct slap_backend_db;
549 typedef int (AttributeTypeSchemaCheckFN)(
550 struct slap_backend_db *be,
551 struct slap_entry *e,
552 struct slap_attr *attr,
554 char *textbuf, size_t textlen );
556 typedef struct slap_attribute_type {
557 LDAPAttributeType sat_atype;
558 struct berval sat_cname;
559 struct slap_attribute_type *sat_sup;
560 struct slap_attribute_type **sat_subtypes;
561 MatchingRule *sat_equality;
562 MatchingRule *sat_approx;
563 MatchingRule *sat_ordering;
564 MatchingRule *sat_substr;
567 AttributeTypeSchemaCheckFN *sat_check;
569 #define SLAP_AT_NONE 0x0000U
570 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
571 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
572 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
573 slap_mask_t sat_flags;
575 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
577 #define sat_oid sat_atype.at_oid
578 #define sat_names sat_atype.at_names
579 #define sat_desc sat_atype.at_desc
580 #define sat_obsolete sat_atype.at_obsolete
581 #define sat_sup_oid sat_atype.at_sup_oid
582 #define sat_equality_oid sat_atype.at_equality_oid
583 #define sat_ordering_oid sat_atype.at_ordering_oid
584 #define sat_substr_oid sat_atype.at_substr_oid
585 #define sat_syntax_oid sat_atype.at_syntax_oid
586 #define sat_single_value sat_atype.at_single_value
587 #define sat_collective sat_atype.at_collective
588 #define sat_no_user_mod sat_atype.at_no_user_mod
589 #define sat_usage sat_atype.at_usage
590 #define sat_extensions sat_atype.at_extensions
592 struct slap_attr_desc *sat_ad;
593 ldap_pvt_thread_mutex_t sat_ad_mutex;
596 #define is_at_operational(at) ((at)->sat_usage)
597 #define is_at_single_value(at) ((at)->sat_single_value)
598 #define is_at_collective(at) ((at)->sat_collective)
599 #define is_at_obsolete(at) ((at)->sat_obsolete)
600 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
602 struct slap_object_class;
604 typedef int (ObjectClassSchemaCheckFN)(
605 struct slap_backend_db *be,
606 struct slap_entry *e,
607 struct slap_object_class *oc,
609 char *textbuf, size_t textlen );
611 typedef struct slap_object_class {
612 LDAPObjectClass soc_oclass;
613 struct berval soc_cname;
614 struct slap_object_class **soc_sups;
615 AttributeType **soc_required;
616 AttributeType **soc_allowed;
617 ObjectClassSchemaCheckFN *soc_check;
618 slap_mask_t soc_flags;
619 #define soc_oid soc_oclass.oc_oid
620 #define soc_names soc_oclass.oc_names
621 #define soc_desc soc_oclass.oc_desc
622 #define soc_obsolete soc_oclass.oc_obsolete
623 #define soc_sup_oids soc_oclass.oc_sup_oids
624 #define soc_kind soc_oclass.oc_kind
625 #define soc_at_oids_must soc_oclass.oc_at_oids_must
626 #define soc_at_oids_may soc_oclass.oc_at_oids_may
627 #define soc_extensions soc_oclass.oc_extensions
629 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
632 #define SLAP_OC_ALIAS 0x0001
633 #define SLAP_OC_REFERRAL 0x0002
634 #define SLAP_OC_SUBENTRY 0x0004
635 #define SLAP_OC_DYNAMICOBJECT 0x0008
636 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
637 #define SLAP_OC__MASK 0x001F
638 #define SLAP_OC__END 0x0020
639 #define SLAP_OC_OPERATIONAL 0x4000
640 #define SLAP_OC_HIDE 0x8000
645 typedef struct slap_content_rule {
646 LDAPContentRule scr_crule;
647 ObjectClass *scr_sclass;
648 ObjectClass **scr_auxiliaries; /* optional */
649 AttributeType **scr_required; /* optional */
650 AttributeType **scr_allowed; /* optional */
651 AttributeType **scr_precluded; /* optional */
652 #define scr_oid scr_crule.cr_oid
653 #define scr_names scr_crule.cr_names
654 #define scr_desc scr_crule.cr_desc
655 #define scr_obsolete scr_crule.cr_obsolete
656 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
657 #define scr_at_oids_must scr_crule.cr_at_oids_must
658 #define scr_at_oids_may scr_crule.cr_at_oids_may
659 #define scr_at_oids_not scr_crule.cr_at_oids_not
661 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
664 /* Represents a recognized attribute description ( type + options ). */
665 typedef struct slap_attr_desc {
666 struct slap_attr_desc *ad_next;
667 AttributeType *ad_type; /* attribute type, must be specified */
668 struct berval ad_cname; /* canonical name, must be specified */
669 struct berval ad_tags; /* empty if no tagging options */
671 #define SLAP_DESC_NONE 0x00U
672 #define SLAP_DESC_BINARY 0x01U
673 #define SLAP_DESC_TAG_RANGE 0x80U
674 } AttributeDescription;
676 typedef struct slap_attr_name {
677 struct berval an_name;
678 AttributeDescription *an_desc;
682 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
683 #define slap_ad_is_tag_range(ad) \
684 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
685 #define slap_ad_is_binary(ad) \
686 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
689 * pointers to schema elements used internally
691 struct slap_internal_schema {
693 ObjectClass *si_oc_top;
694 ObjectClass *si_oc_extensibleObject;
695 ObjectClass *si_oc_alias;
696 ObjectClass *si_oc_referral;
697 ObjectClass *si_oc_rootdse;
698 ObjectClass *si_oc_subentry;
699 ObjectClass *si_oc_subschema;
700 ObjectClass *si_oc_collectiveAttributeSubentry;
701 ObjectClass *si_oc_dynamicObject;
704 ObjectClass *si_oc_glue;
705 ObjectClass *si_oc_syncConsumerSubentry;
706 ObjectClass *si_oc_syncProviderSubentry;
709 /* objectClass attribute descriptions */
710 AttributeDescription *si_ad_objectClass;
712 /* operational attribute descriptions */
713 AttributeDescription *si_ad_structuralObjectClass;
714 AttributeDescription *si_ad_creatorsName;
715 AttributeDescription *si_ad_createTimestamp;
716 AttributeDescription *si_ad_modifiersName;
717 AttributeDescription *si_ad_modifyTimestamp;
718 AttributeDescription *si_ad_hasSubordinates;
719 AttributeDescription *si_ad_subschemaSubentry;
720 AttributeDescription *si_ad_collectiveSubentries;
721 AttributeDescription *si_ad_collectiveExclusions;
722 AttributeDescription *si_ad_entryUUID;
723 AttributeDescription *si_ad_entryCSN;
724 AttributeDescription *si_ad_namingCSN;
725 AttributeDescription *si_ad_superiorUUID;
728 /* LDAP cache specific operational attribute */
729 AttributeDescription *si_ad_queryid;
730 #endif /* LDAP_CACHING */
733 AttributeDescription *si_ad_dseType;
734 AttributeDescription *si_ad_syncreplCookie;
737 /* root DSE attribute descriptions */
738 AttributeDescription *si_ad_altServer;
739 AttributeDescription *si_ad_namingContexts;
740 AttributeDescription *si_ad_supportedControl;
741 AttributeDescription *si_ad_supportedExtension;
742 AttributeDescription *si_ad_supportedLDAPVersion;
743 AttributeDescription *si_ad_supportedSASLMechanisms;
744 AttributeDescription *si_ad_supportedFeatures;
745 AttributeDescription *si_ad_monitorContext;
746 AttributeDescription *si_ad_vendorName;
747 AttributeDescription *si_ad_vendorVersion;
749 /* subentry attribute descriptions */
750 AttributeDescription *si_ad_administrativeRole;
751 AttributeDescription *si_ad_subtreeSpecification;
753 /* subschema subentry attribute descriptions */
754 AttributeDescription *si_ad_ditStructureRules;
755 AttributeDescription *si_ad_ditContentRules;
756 AttributeDescription *si_ad_nameForms;
757 AttributeDescription *si_ad_objectClasses;
758 AttributeDescription *si_ad_attributeTypes;
759 AttributeDescription *si_ad_ldapSyntaxes;
760 AttributeDescription *si_ad_matchingRules;
761 AttributeDescription *si_ad_matchingRuleUse;
763 /* Aliases & Referrals */
764 AttributeDescription *si_ad_aliasedObjectName;
765 AttributeDescription *si_ad_ref;
767 /* Access Control Internals */
768 AttributeDescription *si_ad_entry;
769 AttributeDescription *si_ad_children;
770 AttributeDescription *si_ad_saslAuthzTo;
771 AttributeDescription *si_ad_saslAuthzFrom;
772 #ifdef SLAPD_ACI_ENABLED
773 AttributeDescription *si_ad_aci;
776 /* dynamic entries */
777 AttributeDescription *si_ad_entryTtl;
778 AttributeDescription *si_ad_dynamicSubtrees;
780 /* Other attributes descriptions */
781 AttributeDescription *si_ad_distinguishedName;
782 AttributeDescription *si_ad_name;
783 AttributeDescription *si_ad_cn;
784 AttributeDescription *si_ad_userPassword;
785 #ifdef SLAPD_AUTHPASSWD
786 AttributeDescription *si_ad_authPassword;
788 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
789 AttributeDescription *si_ad_krbName;
792 /* Undefined Attribute Type */
793 AttributeType *si_at_undefined;
796 MatchingRule *si_mr_distinguishedNameMatch;
797 MatchingRule *si_mr_caseExactMatch;
798 MatchingRule *si_mr_caseExactSubstringsMatch;
799 MatchingRule *si_mr_caseExactIA5Match;
800 MatchingRule *si_mr_integerMatch;
801 MatchingRule *si_mr_integerFirstComponentMatch;
802 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
805 Syntax *si_syn_directoryString;
806 Syntax *si_syn_distinguishedName;
807 Syntax *si_syn_integer;
808 Syntax *si_syn_octetString;
811 typedef struct slap_attr_assertion {
812 AttributeDescription *aa_desc;
813 struct berval aa_value;
814 } AttributeAssertion;
816 typedef struct slap_ss_assertion {
817 AttributeDescription *sa_desc;
818 struct berval sa_initial;
819 struct berval *sa_any;
820 struct berval sa_final;
821 } SubstringsAssertion;
823 typedef struct slap_mr_assertion {
824 MatchingRule *ma_rule; /* optional */
825 struct berval ma_rule_text; /* optional */
826 AttributeDescription *ma_desc; /* optional */
827 int ma_dnattrs; /* boolean */
828 struct berval ma_value; /* required */
829 } MatchingRuleAssertion;
832 * represents a search filter
834 typedef struct slap_filter {
835 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
836 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
837 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
838 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
841 /* precomputed result */
842 ber_int_t f_un_result;
845 struct berval *f_un_dn;
848 AttributeDescription *f_un_desc;
850 /* simple value assertion */
851 AttributeAssertion *f_un_ava;
853 /* substring assertion */
854 SubstringsAssertion *f_un_ssa;
856 /* matching rule assertion */
857 MatchingRuleAssertion *f_un_mra;
859 #define f_dn f_un.f_un_dn
860 #define f_desc f_un.f_un_desc
861 #define f_ava f_un.f_un_ava
862 #define f_av_desc f_un.f_un_ava->aa_desc
863 #define f_av_value f_un.f_un_ava->aa_value
864 #define f_sub f_un.f_un_ssa
865 #define f_sub_desc f_un.f_un_ssa->sa_desc
866 #define f_sub_initial f_un.f_un_ssa->sa_initial
867 #define f_sub_any f_un.f_un_ssa->sa_any
868 #define f_sub_final f_un.f_un_ssa->sa_final
869 #define f_mra f_un.f_un_mra
870 #define f_mr_rule f_un.f_un_mra->ma_rule
871 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
872 #define f_mr_desc f_un.f_un_mra->ma_desc
873 #define f_mr_value f_un.f_un_mra->ma_value
874 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
877 struct slap_filter *f_un_complex;
880 #define f_result f_un.f_un_result
881 #define f_and f_un.f_un_complex
882 #define f_or f_un.f_un_complex
883 #define f_not f_un.f_un_complex
884 #define f_list f_un.f_un_complex
886 struct slap_filter *f_next;
889 /* compare routines can return undefined */
890 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
892 typedef struct slap_valuesreturnfilter {
893 ber_tag_t vrf_choice;
896 /* precomputed result */
897 ber_int_t vrf_un_result;
903 AttributeDescription *vrf_un_desc;
905 /* simple value assertion */
906 AttributeAssertion *vrf_un_ava;
908 /* substring assertion */
909 SubstringsAssertion *vrf_un_ssa;
911 /* matching rule assertion */
912 MatchingRuleAssertion *vrf_un_mra;
914 #define vrf_result vrf_un.vrf_un_result
915 #define vrf_dn vrf_un.vrf_un_dn
916 #define vrf_desc vrf_un.vrf_un_desc
917 #define vrf_ava vrf_un.vrf_un_ava
918 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
919 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
920 #define vrf_ssa vrf_un.vrf_un_ssa
921 #define vrf_sub vrf_un.vrf_un_ssa
922 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
923 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
924 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
925 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
926 #define vrf_mra vrf_un.vrf_un_mra
927 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
928 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
929 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
930 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
931 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
936 struct slap_valuesreturnfilter *vrf_next;
937 } ValuesReturnFilter;
940 * represents an attribute (description + values)
942 typedef struct slap_attr {
943 AttributeDescription *a_desc;
944 BerVarray a_vals; /* preserved values */
945 BerVarray a_nvals; /* normalized values */
946 struct slap_attr *a_next;
948 #define SLAP_ATTR_IXADD 0x1U
949 #define SLAP_ATTR_IXDEL 0x2U
954 * the id used in the indexes to refer to an entry
956 typedef unsigned long ID;
957 #define NOID ((ID)~0)
960 * represents an entry in core
962 typedef struct slap_entry {
964 * The ID field should only be changed before entry is
965 * inserted into a cache. The ID value is backend
970 struct berval e_name; /* name (DN) of this entry */
971 struct berval e_nname; /* normalized name (DN) of this entry */
973 /* for migration purposes */
974 #define e_dn e_name.bv_val
975 #define e_ndn e_nname.bv_val
977 Attribute *e_attrs; /* list of attributes + values */
979 slap_mask_t e_ocflags;
981 struct berval e_bv; /* For entry_encode/entry_decode */
983 /* for use by the backend for any purpose */
990 typedef struct slap_mod {
992 AttributeDescription *sm_desc;
993 struct berval sm_type;
995 #define sm_bvalues sm_values
996 BerVarray sm_nvalues;
999 typedef struct slap_mod_list {
1000 Modification sml_mod;
1001 #define sml_op sml_mod.sm_op
1002 #define sml_desc sml_mod.sm_desc
1003 #define sml_type sml_mod.sm_type
1004 #define sml_bvalues sml_mod.sm_values
1005 #define sml_values sml_mod.sm_values
1006 #define sml_nvalues sml_mod.sm_nvalues
1007 struct slap_mod_list *sml_next;
1010 typedef struct slap_ldap_modlist {
1012 struct slap_ldap_modlist *ml_next;
1013 #define ml_op ml_mod.mod_op
1014 #define ml_type ml_mod.mod_type
1015 #define ml_values ml_mod.mod_values
1016 #define ml_bvalues ml_mod.mod_values
1020 * represents an access control list
1022 typedef enum slap_access_e {
1023 ACL_INVALID_ACCESS = -1,
1032 typedef enum slap_control_e {
1033 ACL_INVALID_CONTROL = 0,
1039 typedef enum slap_style_e {
1040 ACL_STYLE_REGEX = 0,
1048 typedef struct slap_authz_info {
1049 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1050 struct berval sai_mech; /* SASL Mechanism */
1051 struct berval sai_dn; /* DN for reporting purposes */
1052 struct berval sai_ndn; /* Normalized DN */
1054 /* Security Strength Factors */
1055 slap_ssf_t sai_ssf; /* Overall SSF */
1056 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1057 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1058 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1059 } AuthorizationInformation;
1062 typedef struct slap_access {
1063 slap_control_t a_type;
1065 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1067 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1068 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1069 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1070 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1071 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1072 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1074 #define ACL_PRIV_MASK 0x00ffUL
1077 #define ACL_PRIV_LEVEL 0x1000UL
1078 #define ACL_PRIV_ADDITIVE 0x2000UL
1079 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1082 #define ACL_PRIV_INVALID 0x0UL
1084 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1085 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1086 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1087 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1089 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1090 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1092 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1094 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1096 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1097 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1098 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1100 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1101 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1102 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1103 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1104 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1105 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1107 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1108 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1109 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1110 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1111 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1112 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1113 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1115 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1116 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1117 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1118 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1119 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1120 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1122 slap_mask_t a_access_mask;
1124 AuthorizationInformation a_authz;
1125 #define a_dn_pat a_authz.sai_dn
1127 slap_style_t a_dn_style;
1128 AttributeDescription *a_dn_at;
1132 slap_style_t a_peername_style;
1133 struct berval a_peername_pat;
1134 slap_style_t a_sockname_style;
1135 struct berval a_sockname_pat;
1137 slap_style_t a_domain_style;
1138 struct berval a_domain_pat;
1139 int a_domain_expand;
1141 slap_style_t a_sockurl_style;
1142 struct berval a_sockurl_pat;
1143 slap_style_t a_set_style;
1144 struct berval a_set_pat;
1146 #ifdef SLAPD_ACI_ENABLED
1147 AttributeDescription *a_aci_at;
1151 slap_style_t a_group_style;
1152 struct berval a_group_pat;
1153 ObjectClass *a_group_oc;
1154 AttributeDescription *a_group_at;
1156 struct slap_access *a_next;
1160 typedef struct slap_acl {
1161 /* "to" part: the entries this acl applies to */
1163 slap_style_t acl_dn_style;
1165 struct berval acl_dn_pat;
1166 AttributeName *acl_attrs;
1168 /* "by" part: list of who has what access to the entries */
1171 struct slap_acl *acl_next;
1174 typedef struct slap_acl_state {
1175 unsigned as_recorded;
1176 #define ACL_STATE_NOT_RECORDED 0x0
1177 #define ACL_STATE_RECORDED_VD 0x1
1178 #define ACL_STATE_RECORDED_NV 0x2
1179 #define ACL_STATE_RECORDED 0x3
1182 AccessControl *as_vd_acl;
1183 AccessControl *as_vi_acl;
1184 slap_mask_t as_vd_acl_mask;
1185 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1186 int as_vd_acl_count;
1188 Access *as_vd_access;
1189 int as_vd_access_count;
1192 AttributeDescription *as_vd_ad;
1193 } AccessControlState;
1194 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1195 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1199 * represents a backend
1202 typedef struct slap_backend_info BackendInfo; /* per backend type */
1203 typedef struct slap_backend_db BackendDB; /* per backend database */
1205 LDAP_SLAPD_V (int) nBackendInfo;
1206 LDAP_SLAPD_V (int) nBackendDB;
1207 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1208 LDAP_SLAPD_V (BackendDB *) backendDB;
1210 LDAP_SLAPD_V (int) slapMode;
1211 #define SLAP_UNDEFINED_MODE 0x0000
1212 #define SLAP_SERVER_MODE 0x0001
1213 #define SLAP_TOOL_MODE 0x0002
1214 #define SLAP_MODE 0x0003
1216 #define SLAP_TRUNCATE_MODE 0x0100
1217 #define SLAP_TOOL_READMAIN 0x0200
1218 #define SLAP_TOOL_READONLY 0x0400
1220 struct slap_replica_info {
1221 char *ri_host; /* supersedes be_replica */
1222 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1223 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1224 int ri_exclude; /* 1 => exclude ri_attrs */
1227 struct slap_limits_set {
1235 int lms_s_unchecked;
1240 struct slap_limits {
1241 int lm_type; /* type of pattern */
1242 #define SLAP_LIMITS_UNDEFINED 0x0000
1243 #define SLAP_LIMITS_EXACT 0x0001
1244 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1245 #define SLAP_LIMITS_ONE 0x0002
1246 #define SLAP_LIMITS_SUBTREE 0x0003
1247 #define SLAP_LIMITS_CHILDREN 0x0004
1248 #define SLAP_LIMITS_REGEX 0x0005
1249 #define SLAP_LIMITS_ANONYMOUS 0x0006
1250 #define SLAP_LIMITS_USERS 0x0007
1251 #define SLAP_LIMITS_ANY 0x0008
1252 regex_t lm_dn_regex; /* regex data for REGEX */
1255 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1256 * pattern for REGEX; NULL for ANONYMOUS, USERS
1258 struct berval lm_dn_pat;
1260 struct slap_limits_set lm_limits;
1263 /* temporary aliases */
1264 typedef BackendDB Backend;
1265 #define nbackends nBackendDB
1266 #define backends backendDB
1268 #ifdef LDAP_SYNCREPL
1269 struct nonpresent_entry {
1272 LDAP_LIST_ENTRY(nonpresent_entry) np_link;
1276 * syncinfo structure for syncrepl
1278 typedef struct syncinfo_s {
1279 struct slap_conn *conn;
1280 struct slap_backend_db *be;
1281 struct slap_entry *e;
1285 struct berval *master_bv;
1289 struct berval updatedn;
1309 #define LASTMOD_REQ 0
1310 #define LASTMOD_GEN 1
1311 #define LASTMOD_NO 2
1316 #define TLS_CRITICAL 2
1319 struct berval *syncUUID;
1320 struct berval *syncUUID_ndn;
1321 struct berval *syncCookie;
1322 Avlnode *presentlist;
1323 LDAP_LIST_HEAD(np, nonpresent_entry) nonpresentlist;
1327 #define MASTERSTR "master"
1328 #define SUFFIXSTR "suffix"
1329 #define UPDATEDNSTR "updatedn"
1330 #define BINDDNSTR "binddn"
1331 #define BINDMETHSTR "bindmethod"
1332 #define SIMPLESTR "simple"
1333 #define SASLSTR "sasl"
1334 #define CREDSTR "credentials"
1335 #define OLDAUTHCSTR "bindprincipal"
1336 #define AUTHCSTR "authcID"
1337 #define AUTHZSTR "authzID"
1338 #define SRVTABSTR "srvtab"
1339 #define SASLMECHSTR "saslmech"
1340 #define REALMSTR "realm"
1341 #define SECPROPSSTR "secprops"
1342 #define TLSSTR "tls"
1343 #define TLSCRITICALSTR "critical"
1345 #define FILTERSTR "filter"
1346 #define SEARCHBASESTR "searchbase"
1347 #define SCOPESTR "scope"
1348 #define ATTRSSTR "attrs"
1349 #define ATTRSONLYSTR "attrsonly"
1350 #define TYPESTR "type"
1351 #define INTERVALSTR "interval"
1352 #define COOKIESTR "cookie"
1353 #define LASTMODSTR "lastmod"
1354 #define LMREQSTR "req"
1355 #define LMGENSTR "gen"
1356 #define LMNOSTR "no"
1358 #endif /* LDAP_SYNCREPL */
1360 struct slap_backend_db {
1361 BackendInfo *bd_info; /* pointer to shared backend info */
1363 /* BackendInfo accessors */
1364 #define be_config bd_info->bi_db_config
1365 #define be_type bd_info->bi_type
1367 #define be_bind bd_info->bi_op_bind
1368 #define be_unbind bd_info->bi_op_unbind
1369 #define be_add bd_info->bi_op_add
1370 #define be_compare bd_info->bi_op_compare
1371 #define be_delete bd_info->bi_op_delete
1372 #define be_modify bd_info->bi_op_modify
1373 #define be_modrdn bd_info->bi_op_modrdn
1374 #define be_search bd_info->bi_op_search
1375 #define be_abandon bd_info->bi_op_abandon
1376 #define be_cancel bd_info->bi_op_cancel
1378 #define be_extended bd_info->bi_extended
1380 #define be_fetch bd_info->bi_entry_get_rw
1381 #define be_release bd_info->bi_entry_release_rw
1382 #define be_chk_referrals bd_info->bi_chk_referrals
1383 #define be_group bd_info->bi_acl_group
1384 #define be_attribute bd_info->bi_acl_attribute
1385 #define be_operational bd_info->bi_operational
1388 * define to honor hasSubordinates operational attribute in search filters
1389 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1392 #define be_has_subordinates bd_info->bi_has_subordinates
1394 #define be_controls bd_info->bi_controls
1396 #define be_connection_init bd_info->bi_connection_init
1397 #define be_connection_destroy bd_info->bi_connection_destroy
1400 #define be_entry_open bd_info->bi_tool_entry_open
1401 #define be_entry_close bd_info->bi_tool_entry_close
1402 #define be_entry_first bd_info->bi_tool_entry_first
1403 #define be_entry_next bd_info->bi_tool_entry_next
1404 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1405 #define be_entry_get bd_info->bi_tool_entry_get
1406 #define be_entry_put bd_info->bi_tool_entry_put
1407 #define be_sync bd_info->bi_tool_sync
1410 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1411 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1412 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1413 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1414 #define SLAP_BFLAG_ALIASES 0x0100U
1415 #define SLAP_BFLAG_REFERRALS 0x0200U
1416 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1417 #define SLAP_BFLAG_MONITOR 0x1000U
1418 #define SLAP_BFLAG_DYNAMIC 0x2000U
1419 slap_mask_t be_flags;
1420 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1421 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1422 #define SLAP_GLUE_SUBORDINATE(be) \
1423 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1424 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1425 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1426 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1427 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1428 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1429 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1431 slap_mask_t be_restrictops; /* restriction operations */
1432 #define SLAP_RESTRICT_OP_ADD 0x0001U
1433 #define SLAP_RESTRICT_OP_BIND 0x0002U
1434 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1435 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1436 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1437 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1438 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1439 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1441 #define SLAP_RESTRICT_OP_READS \
1442 ( SLAP_RESTRICT_OP_COMPARE \
1443 | SLAP_RESTRICT_OP_SEARCH )
1444 #define SLAP_RESTRICT_OP_WRITES \
1445 ( SLAP_RESTRICT_OP_ADD \
1446 | SLAP_RESTRICT_OP_DELETE \
1447 | SLAP_RESTRICT_OP_MODIFY \
1448 | SLAP_RESTRICT_OP_RENAME )
1450 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1451 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1452 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1454 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1456 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1457 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1458 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1459 0x0004U /* unprotected simple auth */
1460 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1462 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1463 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1465 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1467 slap_mask_t be_requires; /* pre-operation requirements */
1468 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1469 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1470 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1471 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1472 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1474 /* Required Security Strength Factor */
1475 slap_ssf_set_t be_ssf_set;
1477 /* these should be renamed from be_ to bd_ */
1478 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1479 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1480 struct berval be_schemadn; /* per-backend subschema subentry DN */
1481 struct berval be_schemandn; /* normalized subschema DN */
1482 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1483 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1484 struct berval be_rootpw; /* the magic "root" password for this db */
1485 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1486 #define be_sizelimit be_def_limit.lms_s_soft
1487 #define be_timelimit be_def_limit.lms_t_soft
1488 struct slap_limits_set be_def_limit; /* default limits */
1489 struct slap_limits **be_limits; /* regex-based size and time limits */
1490 AccessControl *be_acl; /* access control list for this backend */
1491 slap_access_t be_dfltaccess; /* access given if no acl matches */
1492 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1493 char *be_replogfile; /* replication log file (in master) */
1494 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1495 BerVarray be_update_refs; /* where to refer modifying clients to */
1497 void *be_private; /* anything the backend database needs */
1499 void *be_pb; /* Netscape plugin */
1500 #ifdef LDAP_SYNCREPL
1501 syncinfo_t *syncinfo; /* For syncrepl */
1508 /* Backend function typedefs */
1509 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1510 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1511 const char *fname, int lineno,
1512 int argc, char **argv));
1513 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1514 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1515 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1517 typedef int (BI_db_init) LDAP_P((Backend *bd));
1518 typedef int (BI_db_config) LDAP_P((Backend *bd,
1519 const char *fname, int lineno,
1520 int argc, char **argv));
1521 typedef int (BI_db_open) LDAP_P((Backend *bd));
1522 typedef int (BI_db_close) LDAP_P((Backend *bd));
1523 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1525 typedef struct req_bind_s {
1527 struct berval rb_cred;
1528 struct berval rb_edn;
1532 typedef struct req_search_s {
1538 AttributeName *rs_attrs;
1540 struct berval rs_filterstr;
1543 typedef struct req_compare_s {
1544 AttributeAssertion *rs_ava;
1547 typedef struct req_modify_s {
1548 Modifications *rs_modlist;
1551 typedef struct req_modrdn_s {
1552 struct berval rs_newrdn;
1553 struct berval rs_nnewrdn;
1554 struct berval *rs_newSup;
1555 struct berval *rs_nnewSup;
1556 int rs_deleteoldrdn;
1559 typedef struct req_add_s {
1563 typedef struct req_abandon_s {
1567 typedef struct req_extended_s {
1568 struct berval rs_reqoid;
1569 struct berval *rs_reqdata;
1572 typedef enum slap_reply_e {
1580 typedef struct rep_sasl_s {
1581 struct berval *r_sasldata;
1584 typedef struct rep_extended_s {
1585 const char *r_rspoid;
1586 struct berval *r_rspdata;
1589 typedef struct rep_search_s {
1591 AttributeName *r_attrs;
1596 typedef struct slap_rep {
1597 slap_reply_t sr_type;
1601 const char *sr_matched;
1602 const char *sr_text;
1604 LDAPControl **sr_ctrls;
1606 rep_sasl_s sru_sasl;
1607 rep_extended_s sru_extended;
1608 rep_search_s sru_search;
1612 /* short hands for response members */
1613 #define sr_attrs sr_un.sru_search.r_attrs
1614 #define sr_entry sr_un.sru_search.r_entry
1615 #define sr_v2ref sr_un.sru_search.r_v2ref
1616 #define sr_nentries sr_un.sru_search.r_nentries
1617 #define sr_rspoid sr_un.sru_extended.r_rspoid
1618 #define sr_rspdata sr_un.sru_extended.r_rspdata
1619 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1621 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1622 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1623 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1624 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1625 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1626 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1627 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1628 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1629 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1630 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1631 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1632 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1633 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1634 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1635 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1636 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1637 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1639 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1640 struct slap_conn *c));
1641 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1642 struct slap_conn *c));
1644 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1645 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1646 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1647 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1648 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1649 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1650 struct berval *text ));
1651 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1652 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1654 struct slap_backend_info {
1655 char *bi_type; /* type of backend */
1658 * per backend type routines:
1659 * bi_init: called to allocate a backend_info structure,
1660 * called once BEFORE configuration file is read.
1661 * bi_init() initializes this structure hence is
1662 * called directly from be_initialize()
1663 * bi_config: called per 'backend' specific option
1664 * all such options must before any 'database' options
1665 * bi_config() is called only from read_config()
1666 * bi_open: called to open each database, called
1667 * once AFTER configuration file is read but
1668 * BEFORE any bi_db_open() calls.
1669 * bi_open() is called from backend_startup()
1670 * bi_close: called to close each database, called
1671 * once during shutdown after all bi_db_close calls.
1672 * bi_close() is called from backend_shutdown()
1673 * bi_destroy: called to destroy each database, called
1674 * once during shutdown after all bi_db_destroy calls.
1675 * bi_destory() is called from backend_destroy()
1678 BI_config *bi_config;
1681 BI_destroy *bi_destroy;
1684 * per database routines:
1685 * bi_db_init: called to initialize each database,
1686 * called upon reading 'database <type>'
1687 * called only from backend_db_init()
1688 * bi_db_config: called to configure each database,
1689 * called per database to handle per database options
1690 * called only from read_config()
1691 * bi_db_open: called to open each database
1692 * called once per database immediately AFTER bi_open()
1693 * calls but before daemon startup.
1694 * called only by backend_startup()
1695 * bi_db_close: called to close each database
1696 * called once per database during shutdown but BEFORE
1697 * any bi_close call.
1698 * called only by backend_shutdown()
1699 * bi_db_destroy: called to destroy each database
1700 * called once per database during shutdown AFTER all
1701 * bi_close calls but before bi_destory calls.
1702 * called only by backend_destory()
1704 BI_db_init *bi_db_init;
1705 BI_db_config *bi_db_config;
1706 BI_db_open *bi_db_open;
1707 BI_db_close *bi_db_close;
1708 BI_db_destroy *bi_db_destroy;
1710 /* LDAP Operations Handling Routines */
1711 BI_op_bind *bi_op_bind;
1712 BI_op_unbind *bi_op_unbind;
1713 BI_op_search *bi_op_search;
1714 BI_op_compare *bi_op_compare;
1715 BI_op_modify *bi_op_modify;
1716 BI_op_modrdn *bi_op_modrdn;
1717 BI_op_add *bi_op_add;
1718 BI_op_delete *bi_op_delete;
1719 BI_op_abandon *bi_op_abandon;
1720 BI_op_cancel *bi_op_cancel;
1722 /* Extended Operations Helper */
1723 BI_op_extended *bi_extended;
1725 /* Auxilary Functions */
1726 BI_entry_get_rw *bi_entry_get_rw;
1727 BI_entry_release_rw *bi_entry_release_rw;
1728 BI_chk_referrals *bi_chk_referrals;
1730 BI_operational *bi_operational;
1731 BI_has_subordinates *bi_has_subordinates;
1733 BI_connection_init *bi_connection_init;
1734 BI_connection_destroy *bi_connection_destroy;
1736 /* hooks for slap tools */
1737 BI_tool_entry_open *bi_tool_entry_open;
1738 BI_tool_entry_close *bi_tool_entry_close;
1739 BI_tool_entry_first *bi_tool_entry_first;
1740 BI_tool_entry_next *bi_tool_entry_next;
1741 BI_tool_entry_get *bi_tool_entry_get;
1742 BI_tool_entry_put *bi_tool_entry_put;
1743 BI_tool_entry_reindex *bi_tool_entry_reindex;
1744 BI_tool_sync *bi_tool_sync;
1746 #define SLAP_INDEX_ADD_OP 0x0001
1747 #define SLAP_INDEX_DELETE_OP 0x0002
1749 char **bi_controls; /* supported controls */
1751 unsigned int bi_nDB; /* number of databases of this type */
1752 void *bi_private; /* anything the backend type needs */
1755 #define c_authtype c_authz.sai_method
1756 #define c_authmech c_authz.sai_mech
1757 #define c_dn c_authz.sai_dn
1758 #define c_ndn c_authz.sai_ndn
1759 #define c_ssf c_authz.sai_ssf
1760 #define c_transport_ssf c_authz.sai_transport_ssf
1761 #define c_tls_ssf c_authz.sai_tls_ssf
1762 #define c_sasl_ssf c_authz.sai_sasl_ssf
1764 #define o_authtype o_authz.sai_method
1765 #define o_authmech o_authz.sai_mech
1766 #define o_dn o_authz.sai_dn
1767 #define o_ndn o_authz.sai_ndn
1768 #define o_ssf o_authz.sai_ssf
1769 #define o_transport_ssf o_authz.sai_transport_ssf
1770 #define o_tls_ssf o_authz.sai_tls_ssf
1771 #define o_sasl_ssf o_authz.sai_sasl_ssf
1773 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1775 typedef struct slap_callback {
1776 slap_response *sc_response;
1781 * Paged Results state
1783 typedef unsigned long PagedResultsCookie;
1784 typedef struct slap_paged_state {
1786 PagedResultsCookie ps_cookie;
1788 } PagedResultsState;
1791 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1792 #define LDAP_PSEARCH_BY_ADD 0x01
1793 #define LDAP_PSEARCH_BY_DELETE 0x02
1794 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1795 #define LDAP_PSEARCH_BY_MODIFY 0x04
1796 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1799 struct slap_op *ps_op;
1800 LDAP_LIST_ENTRY(psid_entry) ps_link;
1806 * represents an operation pending from an ldap client
1808 typedef struct slap_op {
1809 unsigned long o_opid; /* id of this operation */
1810 unsigned long o_connid; /* id of conn initiating this op */
1811 struct slap_conn *o_conn; /* connection spawning this op */
1812 BackendDB *o_bd; /* backend DB processing this op */
1814 ber_int_t o_msgid; /* msgid of the request */
1815 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1816 ber_tag_t o_tag; /* tag of the request */
1817 time_t o_time; /* time op was initiated */
1819 struct berval o_req_dn; /* DN of target of request */
1820 struct berval o_req_ndn;
1825 req_compare_s oq_compare;
1826 req_modify_s oq_modify;
1827 req_modrdn_s oq_modrdn;
1828 req_search_s oq_search;
1829 req_abandon_s oq_abandon;
1830 req_abandon_s oq_cancel;
1831 req_extended_s oq_extended;
1834 /* short hands for union members */
1835 #define oq_add o_request.oq_add
1836 #define oq_bind o_request.oq_bind
1837 #define oq_compare o_request.oq_compare
1838 #define oq_modify o_request.oq_modify
1839 #define oq_modrdn o_request.oq_modrdn
1840 #define oq_search o_request.oq_search
1841 #define oq_abandon o_request.oq_abandon
1842 #define oq_cancel o_request.oq_cancel
1843 #define oq_extended o_request.oq_extended
1845 /* short hands for inner request members */
1846 #define orb_method oq_bind.rb_method
1847 #define orb_cred oq_bind.rb_cred
1848 #define orb_edn oq_bind.rb_edn
1849 #define orb_ssf oq_bind.rb_ssf
1851 #define ors_scope oq_search.rs_scope
1852 #define ors_deref oq_search.rs_deref
1853 #define ors_slimit oq_search.rs_slimit
1854 #define ors_tlimit oq_search.rs_tlimit
1855 #define ors_attrsonly oq_search.rs_attrsonly
1856 #define ors_attrs oq_search.rs_attrs
1857 #define ors_filter oq_search.rs_filter
1858 #define ors_filterstr oq_search.rs_filterstr
1860 #define orr_newrdn oq_modrdn.rs_newrdn
1861 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1862 #define orr_newSup oq_modrdn.rs_newSup
1863 #define orr_nnewSup oq_modrdn.rs_nnewSup
1864 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1866 #define orc_ava oq_compare.rs_ava
1867 #define ora_e oq_add.rs_e
1868 #define orn_msgid oq_abandon.rs_msgid
1869 #define orm_modlist oq_modify.rs_modlist
1871 #define ore_reqoid oq_extended.rs_reqoid
1872 #define ore_reqdata oq_extended.rs_reqdata
1874 ldap_pvt_thread_t o_tid; /* thread handling this op */
1876 volatile sig_atomic_t o_abandon; /* abandon flag */
1877 volatile sig_atomic_t o_cancel; /* cancel flag */
1878 #define SLAP_CANCEL_NONE 0x00
1879 #define SLAP_CANCEL_REQ 0x01
1880 #define SLAP_CANCEL_ACK 0x02
1881 #define SLAP_CANCEL_DONE 0x03
1883 char o_do_not_cache; /* don't cache from this op */
1884 char o_is_auth_check; /* authorization in progress */
1886 #define SLAP_NO_CONTROL 0
1887 #define SLAP_NONCRITICAL_CONTROL 1
1888 #define SLAP_CRITICAL_CONTROL 2
1890 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1896 #define get_subentries(op) ((int)(op)->o_subentries)
1897 char o_subentries_visibility;
1898 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1900 char o_valuesreturnfilter;
1902 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1903 char o_permissive_modify;
1904 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1906 #define get_permissiveModify(op) (0)
1909 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1910 char o_domain_scope;
1911 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1913 #define get_domainScope(op) (0)
1916 #ifdef LDAP_CONTROL_PAGEDRESULTS
1917 char o_pagedresults;
1918 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1919 ber_int_t o_pagedresults_size;
1920 PagedResultsState o_pagedresults_state;
1922 #define get_pagedresults(op) (0)
1925 #ifdef LDAP_CLIENT_UPDATE
1926 char o_clientupdate;
1927 char o_clientupdate_type;
1928 #define SLAP_LCUP_NONE (0x0)
1929 #define SLAP_LCUP_SYNC (0x1)
1930 #define SLAP_LCUP_PERSIST (0x2)
1931 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1932 ber_int_t o_clientupdate_interval;
1933 struct berval o_clientupdate_state;
1939 #define SLAP_SYNC_NONE (0x0)
1940 #define SLAP_SYNC_REFRESH (0x1)
1941 #define SLAP_SYNC_PERSIST (0x2)
1942 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1943 struct berval o_sync_state;
1946 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1949 LDAP_LIST_ENTRY(slap_op) o_ps_link;
1950 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1953 AuthorizationInformation o_authz;
1955 BerElement *o_ber; /* ber of the request */
1956 #ifdef LDAP_CONNECTIONLESS
1957 BerElement *o_res_ber; /* ber of the reply */
1959 slap_callback *o_callback; /* callback pointers */
1960 LDAPControl **o_ctrls; /* controls */
1962 void *o_threadctx; /* thread pool thread context */
1963 void *o_tmpmemctx; /* slab malloc context */
1964 BerMemoryFunctions *o_tmpmfuncs;
1965 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
1966 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
1967 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
1968 #define o_tmpfree o_tmpmfuncs->bmf_free
1969 void *o_private; /* anything the backend needs */
1971 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1972 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1976 #endif /*LDAP_CACHING */
1979 void *o_pb; /* NS-SLAPI plugin */
1983 #define send_ldap_error( op, rs, err, text ) do { \
1984 (rs)->sr_err = err; (rs)->sr_text = text; \
1985 (op->o_conn->c_send_ldap_result)( op, rs ); \
1987 #define send_ldap_discon( op, rs, err, text ) do { \
1988 (rs)->sr_err = err; (rs)->sr_text = text; \
1989 send_ldap_disconnect( op, rs ); \
1992 typedef void (SEND_LDAP_RESULT)(
1993 struct slap_op *op, struct slap_rep *rs);
1994 typedef int (SEND_SEARCH_ENTRY)(
1995 struct slap_op *op, struct slap_rep *rs);
1996 typedef int (SEND_SEARCH_REFERENCE)(
1997 struct slap_op *op, struct slap_rep *rs);
1998 typedef void (SEND_LDAP_EXTENDED)(
1999 struct slap_op *op, struct slap_rep *rs);
2000 typedef void (SEND_LDAP_INTERMEDIATE_RESP)(
2001 struct slap_op *op, struct slap_rep *rs);
2003 #define send_ldap_result( op, rs ) \
2004 (op->o_conn->c_send_ldap_result)( op, rs )
2005 #define send_search_entry( op, rs ) \
2006 (op->o_conn->c_send_search_entry)( op, rs )
2007 #define send_search_reference( op, rs ) \
2008 (op->o_conn->c_send_search_reference)( op, rs )
2009 #define send_ldap_extended( op, rs ) \
2010 (op->o_conn->c_send_ldap_extended)( op, rs )
2011 #define send_ldap_intermediate_resp( op, rs ) \
2012 (op->o_conn->c_send_ldap_intermediate_resp)( op, rs )
2015 * Caches the result of a backend_group check for ACL evaluation
2017 typedef struct slap_gacl {
2018 struct slap_gacl *ga_next;
2021 AttributeDescription *ga_at;
2027 typedef struct slap_listener Listener;
2030 * represents a connection from an ldap client
2032 typedef struct slap_conn {
2033 int c_struct_state; /* structure management state */
2034 int c_conn_state; /* connection state */
2036 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2037 Sockbuf *c_sb; /* ber connection stuff */
2039 /* only can be changed by connect_init */
2040 time_t c_starttime; /* when the connection was opened */
2041 time_t c_activitytime; /* when the connection was last used */
2042 unsigned long c_connid; /* id of this connection for stats*/
2044 struct berval c_peer_domain; /* DNS name of client */
2045 struct berval c_peer_name; /* peer name (trans=addr:port) */
2046 Listener *c_listener;
2047 #define c_listener_url c_listener->sl_url /* listener URL */
2048 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2050 /* only can be changed by binding thread */
2051 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2052 struct berval c_sasl_bind_mech; /* mech in progress */
2053 struct berval c_sasl_dn; /* temporary storage */
2055 /* authorization backend */
2056 Backend *c_authz_backend;
2058 AuthorizationInformation c_authz;
2059 GroupAssertion *c_groups;
2061 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2063 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2064 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2066 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2067 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2069 BerElement *c_currentber; /* ber we're attempting to read */
2070 int c_writewaiter; /* true if writer is waiting */
2072 #ifdef LDAP_CONNECTIONLESS
2073 int c_is_udp; /* true if this is (C)LDAP over UDP */
2076 int c_is_tls; /* true if this LDAP over raw TLS */
2077 int c_needs_tls_accept; /* true if SSL_accept should be called */
2079 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2080 int c_sasl_done; /* SASL completed once */
2081 void *c_sasl_authctx; /* SASL authentication context */
2082 void *c_sasl_sockctx; /* SASL security layer context */
2083 void *c_sasl_extra; /* SASL session extra stuff */
2084 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2086 PagedResultsState c_pagedresults_state; /* paged result state */
2088 long c_n_ops_received; /* num of ops received (next op_id) */
2089 long c_n_ops_executing; /* num of ops currently executing */
2090 long c_n_ops_pending; /* num of ops pending execution */
2091 long c_n_ops_completed; /* num of ops completed */
2093 long c_n_get; /* num of get calls */
2094 long c_n_read; /* num of read calls */
2095 long c_n_write; /* num of write calls */
2097 void *c_pb; /* Netscape plugin */
2100 * These are the "callbacks" that are available for back-ends to
2101 * supply data back to connected clients that are connected
2102 * through the "front-end".
2104 SEND_LDAP_RESULT *c_send_ldap_result;
2105 SEND_SEARCH_ENTRY *c_send_search_entry;
2106 SEND_SEARCH_REFERENCE *c_send_search_reference;
2107 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2108 #ifdef LDAP_RES_INTERMEDIATE_RESP
2109 SEND_LDAP_INTERMEDIATE_RESP *c_send_ldap_intermediate_resp;
2114 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2115 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2117 if ( ldap_debug & (level) ) \
2118 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2119 if ( ldap_syslog & (level) ) \
2120 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2123 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2124 #elif defined(LDAP_DEBUG)
2125 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2127 if ( ldap_debug & (level) ) \
2128 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2130 #define StatslogTest( level ) (ldap_debug & (level))
2132 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2133 #define StatslogTest( level ) (0)
2137 * listener; need to access it from monitor backend
2139 struct slap_listener {
2140 struct berval sl_url;
2141 struct berval sl_name;
2146 #ifdef LDAP_CONNECTIONLESS
2147 int sl_is_udp; /* UDP listener is also data port */
2149 int sl_is_mute; /* Listening is temporarily disabled */
2152 #define sl_addr sl_sa.sa_in_addr
2155 #ifdef SLAPD_MONITOR
2172 #endif /* SLAPD_MONITOR */
2175 * Better know these all around slapd
2177 #define SLAP_LDAPDN_PRETTY 0x1
2178 #define SLAP_LDAPDN_MAXLEN 8192
2183 #ifdef LDAP_CLIENT_UPDATE
2184 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2185 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2186 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2187 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2188 #endif /* LDAP_CLIENT_UPDATE */
2190 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2191 #define SLAP_SEARCH_MAX_CTRLS 10
2194 #define SLAP_CTRL_FRONTEND 0x80000000U
2195 #define SLAP_CTRL_FRONTEND_SEARCH 0x01000000U /* for NOOP */
2197 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2198 #define SLAP_CTRL_ABANDON 0x00000001U
2199 #define SLAP_CTRL_ADD 0x00002002U
2200 #define SLAP_CTRL_BIND 0x00000004U
2201 #define SLAP_CTRL_COMPARE 0x00001008U
2202 #define SLAP_CTRL_DELETE 0x00002010U
2203 #define SLAP_CTRL_MODIFY 0x00002020U
2204 #define SLAP_CTRL_RENAME 0x00002040U
2205 #define SLAP_CTRL_SEARCH 0x00001080U
2206 #define SLAP_CTRL_UNBIND 0x00000100U
2208 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2209 #define SLAP_CTRL_UPDATE \
2210 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2211 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2213 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2216 LDAPControl *ctrl ));
2220 #include "proto-slap.h"
2222 #endif /* _SLAP_H_ */