1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
14 #include <ac/stdlib.h>
16 #include <sys/types.h>
17 #include <ac/syslog.h>
19 #include <ac/signal.h>
20 #include <ac/socket.h>
27 #define ldap_debug slap_debug
33 #include <ldap_schema.h>
36 #include "ldap_pvt_thread.h"
37 #include "ldap_queue.h"
39 #define SLAP_EXTENDED_SCHEMA 1
40 #define LDAP_CACHING 1
44 * SLAPD Memory allocation macros
46 * Unlike ch_*() routines, these routines do not assert() upon
47 * allocation error. They are intended to be used instead of
48 * ch_*() routines where the caller has implemented proper
49 * checking for and handling of allocation errors.
51 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
53 #define SLAP_MALLOC(s) ber_memalloc((s))
54 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
55 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
56 #define SLAP_FREE(p) ber_memfree((p))
57 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
58 #define SLAP_STRDUP(s) ber_strdup((s))
59 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
62 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
65 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
66 #define SLAPD_ANONYMOUS "cn=anonymous"
68 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
69 * This is a value used internally by the backends. It is needed to allow
70 * adding values that already exist without getting an error as required by
71 * modrdn when the new rdn was already an attribute value itself.
73 #define SLAP_MOD_SOFTADD 0x1000
75 #define MAXREMATCHES (100)
77 #define SLAP_MAX_WORKER_THREADS (16)
80 #define SLAP_MAX_SYNCREPL_THREADS (8)
83 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
84 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
86 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
87 #define SLAP_CONN_MAX_PENDING_AUTH 1000
89 #define SLAP_TEXT_BUFLEN (256)
91 /* psuedo error code indicating abandoned operation */
92 #define SLAPD_ABANDON (-1)
94 /* psuedo error code indicating disconnect */
95 #define SLAPD_DISCONNECT (-2)
98 /* We assume "C" locale, that is US-ASCII */
99 #define ASCII_SPACE(c) ( (c) == ' ' )
100 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
101 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
102 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
103 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
104 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
105 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
107 #define SLAP_NIBBLE(c) ((c)&0x0f)
108 #define SLAP_ESCAPE_CHAR ('\\')
109 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
110 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
112 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
113 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
115 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
116 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
117 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
118 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
119 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
121 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
122 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
123 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
124 #define OID_SEPARATOR(c) ( (c) == '.' )
125 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
127 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
128 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
130 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
131 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
133 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
135 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
136 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
137 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
138 (c) == '?' || (c) == ' ' || (c) == '=' )
139 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
141 /* must match in schema_init.c */
142 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
143 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
144 #define SLAPD_GROUP_ATTR "member"
145 #define SLAPD_GROUP_CLASS "groupOfNames"
146 #define SLAPD_ROLE_ATTR "roleOccupant"
147 #define SLAPD_ROLE_CLASS "organizationalRole"
149 #ifdef SLAPD_ACI_ENABLED
150 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
153 /* change this to "OpenLDAPset" */
154 #define SLAPD_ACI_SET_ATTR "template"
156 #define SLAPD_TOP_OID "2.5.6.0"
158 LDAP_SLAPD_V (int) slap_debug;
160 typedef unsigned long slap_mask_t;
162 /* Security Strength Factor */
163 typedef unsigned slap_ssf_t;
165 typedef struct slap_ssf_set {
167 slap_ssf_t sss_transport;
170 slap_ssf_t sss_update_ssf;
171 slap_ssf_t sss_update_transport;
172 slap_ssf_t sss_update_tls;
173 slap_ssf_t sss_update_sasl;
174 slap_ssf_t sss_simple_bind;
177 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
178 #define SLAP_GETDN_AUTHCID 2
179 #define SLAP_GETDN_AUTHZID 4
184 #define SLAP_INDEX_TYPE 0x00FFUL
185 #define SLAP_INDEX_UNDEFINED 0x0001UL
186 #define SLAP_INDEX_PRESENT 0x0002UL
187 #define SLAP_INDEX_EQUALITY 0x0004UL
188 #define SLAP_INDEX_APPROX 0x0008UL
189 #define SLAP_INDEX_SUBSTR 0x0010UL
190 #define SLAP_INDEX_EXTENDED 0x0020UL
192 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
194 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
196 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
198 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
199 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
200 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
201 #define SLAP_INDEX_SUBSTR_DEFAULT \
202 ( SLAP_INDEX_SUBSTR \
203 | SLAP_INDEX_SUBSTR_INITIAL \
204 | SLAP_INDEX_SUBSTR_ANY \
205 | SLAP_INDEX_SUBSTR_FINAL )
207 #define SLAP_INDEX_SUBSTR_MINLEN 2
208 #define SLAP_INDEX_SUBSTR_MAXLEN 4
209 #define SLAP_INDEX_SUBSTR_STEP 2
211 #define SLAP_INDEX_FLAGS 0xF000UL
212 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
213 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
216 * there is a single index for each attribute. these prefixes ensure
217 * that there is no collision among keys.
219 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
220 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
221 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
222 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
223 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
224 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
226 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
227 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
228 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
229 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
230 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
232 #ifdef LDAP_CLIENT_UPDATE
233 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
234 #endif /* LDAP_CLIENT_UPDATE */
237 * represents schema information for a database
239 #define SLAP_SCHERR_OUTOFMEM 1
240 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
241 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
242 #define SLAP_SCHERR_CLASS_BAD_SUP 4
243 #define SLAP_SCHERR_CLASS_DUP 5
244 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
245 #define SLAP_SCHERR_ATTR_BAD_MR 7
246 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
247 #define SLAP_SCHERR_ATTR_BAD_SUP 9
248 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
249 #define SLAP_SCHERR_ATTR_DUP 11
250 #define SLAP_SCHERR_MR_NOT_FOUND 12
251 #define SLAP_SCHERR_MR_INCOMPLETE 13
252 #define SLAP_SCHERR_MR_DUP 14
253 #define SLAP_SCHERR_SYN_NOT_FOUND 15
254 #define SLAP_SCHERR_SYN_DUP 16
255 #define SLAP_SCHERR_NO_NAME 17
256 #define SLAP_SCHERR_NOT_SUPPORTED 18
257 #define SLAP_SCHERR_BAD_DESCR 19
258 #define SLAP_SCHERR_OIDM 20
259 #define SLAP_SCHERR_CR_DUP 21
260 #define SLAP_SCHERR_CR_BAD_STRUCT 22
261 #define SLAP_SCHERR_CR_BAD_AUX 23
262 #define SLAP_SCHERR_CR_BAD_AT 24
263 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
265 typedef union slap_sockaddr {
266 struct sockaddr sa_addr;
267 struct sockaddr_in sa_in_addr;
269 struct sockaddr_storage sa_storage;
270 struct sockaddr_in6 sa_in6_addr;
273 struct sockaddr_un sa_un_addr;
278 extern int slap_inet4or6;
281 typedef struct slap_oid_macro {
282 struct berval som_oid;
284 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
287 /* forward declarations */
289 struct slap_matching_rule;
291 typedef int slap_syntax_validate_func LDAP_P((
292 struct slap_syntax *syntax,
293 struct berval * in));
295 typedef int slap_syntax_transform_func LDAP_P((
296 struct slap_syntax *syntax,
301 typedef struct slap_syntax {
303 #define ssyn_oid ssyn_syn.syn_oid
304 #define ssyn_desc ssyn_syn.syn_desc
305 #define ssyn_extensions ssyn_syn.syn_extensions
308 ber_len_t ssyn_oidlen;
309 * has been replaced by a struct berval that uses the value
310 * provided by ssyn_syn.syn_oid; a macro that expands to
311 * the bv_len field of the berval is provided for backward
312 * compatibility. CAUTION: NEVER FREE THE BERVAL
314 struct berval ssyn_bvoid;
315 #define ssyn_oidlen ssyn_bvoid.bv_len
317 unsigned int ssyn_flags;
319 #define SLAP_SYNTAX_NONE 0x0000U
320 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
321 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
322 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
323 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
325 slap_syntax_validate_func *ssyn_validate;
326 slap_syntax_transform_func *ssyn_pretty;
328 #ifdef SLAPD_BINARY_CONVERSION
329 /* convert to and from binary */
330 slap_syntax_transform_func *ssyn_ber2str;
331 slap_syntax_transform_func *ssyn_str2ber;
334 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
337 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
338 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
339 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
340 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
341 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
343 typedef struct slap_syntax_defs_rec {
346 slap_syntax_validate_func *sd_validate;
347 slap_syntax_transform_func *sd_pretty;
348 #ifdef SLAPD_BINARY_CONVERSION
349 slap_syntax_transform_func *sd_ber2str;
350 slap_syntax_transform_func *sd_str2ber;
352 } slap_syntax_defs_rec;
354 /* X -> Y Converter */
355 typedef int slap_mr_convert_func LDAP_P((
361 typedef int slap_mr_normalize_func LDAP_P((
363 struct slap_syntax *syntax, /* NULL if in is asserted value */
364 struct slap_matching_rule *mr,
369 /* Match (compare) function */
370 typedef int slap_mr_match_func LDAP_P((
373 struct slap_syntax *syntax, /* syntax of stored value */
374 struct slap_matching_rule *mr,
375 struct berval * value,
376 void * assertValue ));
378 /* Index generation function */
379 typedef int slap_mr_indexer_func LDAP_P((
382 struct slap_syntax *syntax, /* syntax of stored value */
383 struct slap_matching_rule *mr,
384 struct berval *prefix,
389 /* Filter index function */
390 typedef int slap_mr_filter_func LDAP_P((
393 struct slap_syntax *syntax, /* syntax of stored value */
394 struct slap_matching_rule *mr,
395 struct berval *prefix,
400 typedef struct slap_matching_rule_use MatchingRuleUse;
402 typedef struct slap_matching_rule {
403 LDAPMatchingRule smr_mrule;
404 MatchingRuleUse *smr_mru;
405 /* RFC2252 string representation */
406 struct berval smr_str;
409 * ber_len_t smr_oidlen;
410 * has been replaced by a struct berval that uses the value
411 * provided by smr_mrule.mr_oid; a macro that expands to
412 * the bv_len field of the berval is provided for backward
413 * compatibility. CAUTION: NEVER FREE THE BERVAL
415 struct berval smr_bvoid;
416 #define smr_oidlen smr_bvoid.bv_len
418 slap_mask_t smr_usage;
420 #define SLAP_MR_HIDE 0x8000U
422 #define SLAP_MR_TYPE_MASK 0x0F00U
423 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
424 #define SLAP_MR_USAGE 0x000FU
426 #define SLAP_MR_NONE 0x0000U
427 #define SLAP_MR_EQUALITY 0x0100U
428 #define SLAP_MR_ORDERING 0x0200U
429 #define SLAP_MR_SUBSTR 0x0400U
430 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
432 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
434 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
435 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
436 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
440 * The asserted value, depending on the particular usage,
441 * is expected to conform to either the assertion syntax
442 * or the attribute syntax. In some cases, the syntax of
443 * the value is known. If so, these flags indicate which
444 * syntax the value is expected to conform to. If not,
445 * neither of these flags is set (until the syntax of the
446 * provided value is determined). If the value is of the
447 * attribute syntax, the flag is changed once a value of
448 * the assertion syntax is derived from the provided value.
450 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
451 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
453 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
454 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
455 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
456 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
458 /* either or both the asserted value or attribute value
459 * may be provided in normalized form
461 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
462 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
464 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
465 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
466 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
467 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
469 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
470 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
471 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
472 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
473 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
474 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
476 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
477 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
478 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
479 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
482 slap_mr_convert_func *smr_convert;
483 slap_mr_normalize_func *smr_normalize;
484 slap_mr_match_func *smr_match;
485 slap_mr_indexer_func *smr_indexer;
486 slap_mr_filter_func *smr_filter;
489 * null terminated array of syntaxes compatible with this syntax
490 * note: when MS_EXT is set, this MUST NOT contain the assertion
491 * syntax of the rule. When MS_EXT is not set, it MAY.
493 Syntax **smr_compat_syntaxes;
496 * For equality rules, refers to an associated approximate rule.
497 * For non-equality rules, refers to an associated equality rule.
499 struct slap_matching_rule *smr_associated;
501 #define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \
502 ((mr)->smr_associated == (amr)))
504 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
506 #define smr_oid smr_mrule.mr_oid
507 #define smr_names smr_mrule.mr_names
508 #define smr_desc smr_mrule.mr_desc
509 #define smr_obsolete smr_mrule.mr_obsolete
510 #define smr_syntax_oid smr_mrule.mr_syntax_oid
511 #define smr_extensions smr_mrule.mr_extensions
514 struct slap_matching_rule_use {
515 LDAPMatchingRuleUse smru_mruleuse;
516 MatchingRule *smru_mr;
517 /* RFC2252 string representation */
518 struct berval smru_str;
520 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
522 #define smru_oid smru_mruleuse.mru_oid
523 #define smru_names smru_mruleuse.mru_names
524 #define smru_desc smru_mruleuse.mru_desc
525 #define smru_obsolete smru_mruleuse.mru_obsolete
526 #define smru_applies_oids smru_mruleuse.mru_applies_oids
528 #define smru_usage smru_mr->smr_usage
529 } /* MatchingRuleUse */ ;
531 typedef struct slap_mrule_defs_rec {
533 slap_mask_t mrd_usage;
534 char ** mrd_compat_syntaxes;
535 slap_mr_convert_func * mrd_convert;
536 slap_mr_normalize_func * mrd_normalize;
537 slap_mr_match_func * mrd_match;
538 slap_mr_indexer_func * mrd_indexer;
539 slap_mr_filter_func * mrd_filter;
541 /* For equality rule, this may refer to an associated approximate rule */
542 /* For non-equality rule, this may refer to an associated equality rule */
543 char * mrd_associated;
544 } slap_mrule_defs_rec;
546 struct slap_backend_db;
550 typedef int (AttributeTypeSchemaCheckFN)(
551 struct slap_backend_db *be,
552 struct slap_entry *e,
553 struct slap_attr *attr,
555 char *textbuf, size_t textlen );
557 typedef struct slap_attribute_type {
558 LDAPAttributeType sat_atype;
559 struct berval sat_cname;
560 struct slap_attribute_type *sat_sup;
561 struct slap_attribute_type **sat_subtypes;
562 MatchingRule *sat_equality;
563 MatchingRule *sat_approx;
564 MatchingRule *sat_ordering;
565 MatchingRule *sat_substr;
568 AttributeTypeSchemaCheckFN *sat_check;
570 #define SLAP_AT_NONE 0x0000U
571 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
572 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
573 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
574 slap_mask_t sat_flags;
576 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
578 #define sat_oid sat_atype.at_oid
579 #define sat_names sat_atype.at_names
580 #define sat_desc sat_atype.at_desc
581 #define sat_obsolete sat_atype.at_obsolete
582 #define sat_sup_oid sat_atype.at_sup_oid
583 #define sat_equality_oid sat_atype.at_equality_oid
584 #define sat_ordering_oid sat_atype.at_ordering_oid
585 #define sat_substr_oid sat_atype.at_substr_oid
586 #define sat_syntax_oid sat_atype.at_syntax_oid
587 #define sat_single_value sat_atype.at_single_value
588 #define sat_collective sat_atype.at_collective
589 #define sat_no_user_mod sat_atype.at_no_user_mod
590 #define sat_usage sat_atype.at_usage
591 #define sat_extensions sat_atype.at_extensions
593 struct slap_attr_desc *sat_ad;
594 ldap_pvt_thread_mutex_t sat_ad_mutex;
597 #define is_at_operational(at) ((at)->sat_usage)
598 #define is_at_single_value(at) ((at)->sat_single_value)
599 #define is_at_collective(at) ((at)->sat_collective)
600 #define is_at_obsolete(at) ((at)->sat_obsolete)
601 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
603 struct slap_object_class;
605 typedef int (ObjectClassSchemaCheckFN)(
606 struct slap_backend_db *be,
607 struct slap_entry *e,
608 struct slap_object_class *oc,
610 char *textbuf, size_t textlen );
612 typedef struct slap_object_class {
613 LDAPObjectClass soc_oclass;
614 struct berval soc_cname;
615 struct slap_object_class **soc_sups;
616 AttributeType **soc_required;
617 AttributeType **soc_allowed;
618 ObjectClassSchemaCheckFN *soc_check;
619 slap_mask_t soc_flags;
620 #define soc_oid soc_oclass.oc_oid
621 #define soc_names soc_oclass.oc_names
622 #define soc_desc soc_oclass.oc_desc
623 #define soc_obsolete soc_oclass.oc_obsolete
624 #define soc_sup_oids soc_oclass.oc_sup_oids
625 #define soc_kind soc_oclass.oc_kind
626 #define soc_at_oids_must soc_oclass.oc_at_oids_must
627 #define soc_at_oids_may soc_oclass.oc_at_oids_may
628 #define soc_extensions soc_oclass.oc_extensions
630 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
633 #define SLAP_OC_ALIAS 0x0001
634 #define SLAP_OC_REFERRAL 0x0002
635 #define SLAP_OC_SUBENTRY 0x0004
636 #define SLAP_OC_DYNAMICOBJECT 0x0008
637 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
638 #define SLAP_OC__MASK 0x001F
639 #define SLAP_OC__END 0x0020
640 #define SLAP_OC_OPERATIONAL 0x4000
641 #define SLAP_OC_HIDE 0x8000
646 typedef struct slap_content_rule {
647 LDAPContentRule scr_crule;
648 ObjectClass *scr_sclass;
649 ObjectClass **scr_auxiliaries; /* optional */
650 AttributeType **scr_required; /* optional */
651 AttributeType **scr_allowed; /* optional */
652 AttributeType **scr_precluded; /* optional */
653 #define scr_oid scr_crule.cr_oid
654 #define scr_names scr_crule.cr_names
655 #define scr_desc scr_crule.cr_desc
656 #define scr_obsolete scr_crule.cr_obsolete
657 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
658 #define scr_at_oids_must scr_crule.cr_at_oids_must
659 #define scr_at_oids_may scr_crule.cr_at_oids_may
660 #define scr_at_oids_not scr_crule.cr_at_oids_not
662 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
665 /* Represents a recognized attribute description ( type + options ). */
666 typedef struct slap_attr_desc {
667 struct slap_attr_desc *ad_next;
668 AttributeType *ad_type; /* attribute type, must be specified */
669 struct berval ad_cname; /* canonical name, must be specified */
670 struct berval ad_tags; /* empty if no tagging options */
672 #define SLAP_DESC_NONE 0x00U
673 #define SLAP_DESC_BINARY 0x01U
674 #define SLAP_DESC_TAG_RANGE 0x80U
675 } AttributeDescription;
677 typedef struct slap_attr_name {
678 struct berval an_name;
679 AttributeDescription *an_desc;
683 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
684 #define slap_ad_is_tag_range(ad) \
685 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
686 #define slap_ad_is_binary(ad) \
687 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
690 * pointers to schema elements used internally
692 struct slap_internal_schema {
694 ObjectClass *si_oc_top;
695 ObjectClass *si_oc_extensibleObject;
696 ObjectClass *si_oc_alias;
697 ObjectClass *si_oc_referral;
698 ObjectClass *si_oc_rootdse;
699 ObjectClass *si_oc_subentry;
700 ObjectClass *si_oc_subschema;
701 ObjectClass *si_oc_collectiveAttributeSubentry;
702 ObjectClass *si_oc_dynamicObject;
705 ObjectClass *si_oc_glue;
706 ObjectClass *si_oc_syncConsumerSubentry;
707 ObjectClass *si_oc_syncProviderSubentry;
710 /* objectClass attribute descriptions */
711 AttributeDescription *si_ad_objectClass;
713 /* operational attribute descriptions */
714 AttributeDescription *si_ad_structuralObjectClass;
715 AttributeDescription *si_ad_creatorsName;
716 AttributeDescription *si_ad_createTimestamp;
717 AttributeDescription *si_ad_modifiersName;
718 AttributeDescription *si_ad_modifyTimestamp;
719 AttributeDescription *si_ad_hasSubordinates;
720 AttributeDescription *si_ad_subschemaSubentry;
721 AttributeDescription *si_ad_collectiveSubentries;
722 AttributeDescription *si_ad_collectiveExclusions;
723 AttributeDescription *si_ad_entryUUID;
724 AttributeDescription *si_ad_entryCSN;
725 AttributeDescription *si_ad_namingCSN;
726 AttributeDescription *si_ad_superiorUUID;
729 /* LDAP cache specific operational attribute */
730 AttributeDescription *si_ad_queryid;
731 #endif /* LDAP_CACHING */
734 AttributeDescription *si_ad_dseType;
735 AttributeDescription *si_ad_syncreplCookie;
738 /* root DSE attribute descriptions */
739 AttributeDescription *si_ad_altServer;
740 AttributeDescription *si_ad_namingContexts;
741 AttributeDescription *si_ad_supportedControl;
742 AttributeDescription *si_ad_supportedExtension;
743 AttributeDescription *si_ad_supportedLDAPVersion;
744 AttributeDescription *si_ad_supportedSASLMechanisms;
745 AttributeDescription *si_ad_supportedFeatures;
746 AttributeDescription *si_ad_monitorContext;
747 AttributeDescription *si_ad_vendorName;
748 AttributeDescription *si_ad_vendorVersion;
750 /* subentry attribute descriptions */
751 AttributeDescription *si_ad_administrativeRole;
752 AttributeDescription *si_ad_subtreeSpecification;
754 /* subschema subentry attribute descriptions */
755 AttributeDescription *si_ad_ditStructureRules;
756 AttributeDescription *si_ad_ditContentRules;
757 AttributeDescription *si_ad_nameForms;
758 AttributeDescription *si_ad_objectClasses;
759 AttributeDescription *si_ad_attributeTypes;
760 AttributeDescription *si_ad_ldapSyntaxes;
761 AttributeDescription *si_ad_matchingRules;
762 AttributeDescription *si_ad_matchingRuleUse;
764 /* Aliases & Referrals */
765 AttributeDescription *si_ad_aliasedObjectName;
766 AttributeDescription *si_ad_ref;
768 /* Access Control Internals */
769 AttributeDescription *si_ad_entry;
770 AttributeDescription *si_ad_children;
771 AttributeDescription *si_ad_saslAuthzTo;
772 AttributeDescription *si_ad_saslAuthzFrom;
773 #ifdef SLAPD_ACI_ENABLED
774 AttributeDescription *si_ad_aci;
777 /* dynamic entries */
778 AttributeDescription *si_ad_entryTtl;
779 AttributeDescription *si_ad_dynamicSubtrees;
781 /* Other attributes descriptions */
782 AttributeDescription *si_ad_distinguishedName;
783 AttributeDescription *si_ad_name;
784 AttributeDescription *si_ad_cn;
785 AttributeDescription *si_ad_userPassword;
786 #ifdef SLAPD_AUTHPASSWD
787 AttributeDescription *si_ad_authPassword;
789 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
790 AttributeDescription *si_ad_krbName;
793 /* Undefined Attribute Type */
794 AttributeType *si_at_undefined;
797 MatchingRule *si_mr_distinguishedNameMatch;
798 MatchingRule *si_mr_caseExactMatch;
799 MatchingRule *si_mr_caseExactSubstringsMatch;
800 MatchingRule *si_mr_caseExactIA5Match;
801 MatchingRule *si_mr_integerMatch;
802 MatchingRule *si_mr_integerFirstComponentMatch;
803 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
806 Syntax *si_syn_directoryString;
807 Syntax *si_syn_distinguishedName;
808 Syntax *si_syn_integer;
809 Syntax *si_syn_octetString;
812 typedef struct slap_attr_assertion {
813 AttributeDescription *aa_desc;
814 struct berval aa_value;
815 } AttributeAssertion;
817 typedef struct slap_ss_assertion {
818 AttributeDescription *sa_desc;
819 struct berval sa_initial;
820 struct berval *sa_any;
821 struct berval sa_final;
822 } SubstringsAssertion;
824 typedef struct slap_mr_assertion {
825 MatchingRule *ma_rule; /* optional */
826 struct berval ma_rule_text; /* optional */
827 AttributeDescription *ma_desc; /* optional */
828 int ma_dnattrs; /* boolean */
829 struct berval ma_value; /* required */
830 } MatchingRuleAssertion;
833 * represents a search filter
835 typedef struct slap_filter {
836 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
837 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
838 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
839 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
842 /* precomputed result */
843 ber_int_t f_un_result;
846 struct berval *f_un_dn;
849 AttributeDescription *f_un_desc;
851 /* simple value assertion */
852 AttributeAssertion *f_un_ava;
854 /* substring assertion */
855 SubstringsAssertion *f_un_ssa;
857 /* matching rule assertion */
858 MatchingRuleAssertion *f_un_mra;
860 #define f_dn f_un.f_un_dn
861 #define f_desc f_un.f_un_desc
862 #define f_ava f_un.f_un_ava
863 #define f_av_desc f_un.f_un_ava->aa_desc
864 #define f_av_value f_un.f_un_ava->aa_value
865 #define f_sub f_un.f_un_ssa
866 #define f_sub_desc f_un.f_un_ssa->sa_desc
867 #define f_sub_initial f_un.f_un_ssa->sa_initial
868 #define f_sub_any f_un.f_un_ssa->sa_any
869 #define f_sub_final f_un.f_un_ssa->sa_final
870 #define f_mra f_un.f_un_mra
871 #define f_mr_rule f_un.f_un_mra->ma_rule
872 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
873 #define f_mr_desc f_un.f_un_mra->ma_desc
874 #define f_mr_value f_un.f_un_mra->ma_value
875 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
878 struct slap_filter *f_un_complex;
881 #define f_result f_un.f_un_result
882 #define f_and f_un.f_un_complex
883 #define f_or f_un.f_un_complex
884 #define f_not f_un.f_un_complex
885 #define f_list f_un.f_un_complex
887 struct slap_filter *f_next;
890 /* compare routines can return undefined */
891 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
893 typedef struct slap_valuesreturnfilter {
894 ber_tag_t vrf_choice;
897 /* precomputed result */
898 ber_int_t vrf_un_result;
904 AttributeDescription *vrf_un_desc;
906 /* simple value assertion */
907 AttributeAssertion *vrf_un_ava;
909 /* substring assertion */
910 SubstringsAssertion *vrf_un_ssa;
912 /* matching rule assertion */
913 MatchingRuleAssertion *vrf_un_mra;
915 #define vrf_result vrf_un.vrf_un_result
916 #define vrf_dn vrf_un.vrf_un_dn
917 #define vrf_desc vrf_un.vrf_un_desc
918 #define vrf_ava vrf_un.vrf_un_ava
919 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
920 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
921 #define vrf_ssa vrf_un.vrf_un_ssa
922 #define vrf_sub vrf_un.vrf_un_ssa
923 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
924 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
925 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
926 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
927 #define vrf_mra vrf_un.vrf_un_mra
928 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
929 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
930 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
931 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
932 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
937 struct slap_valuesreturnfilter *vrf_next;
938 } ValuesReturnFilter;
941 * represents an attribute (description + values)
943 typedef struct slap_attr {
944 AttributeDescription *a_desc;
945 BerVarray a_vals; /* preserved values */
946 BerVarray a_nvals; /* normalized values */
947 struct slap_attr *a_next;
949 #define SLAP_ATTR_IXADD 0x1U
950 #define SLAP_ATTR_IXDEL 0x2U
955 * the id used in the indexes to refer to an entry
957 typedef unsigned long ID;
958 #define NOID ((ID)~0)
961 * represents an entry in core
963 typedef struct slap_entry {
965 * The ID field should only be changed before entry is
966 * inserted into a cache. The ID value is backend
971 struct berval e_name; /* name (DN) of this entry */
972 struct berval e_nname; /* normalized name (DN) of this entry */
974 /* for migration purposes */
975 #define e_dn e_name.bv_val
976 #define e_ndn e_nname.bv_val
978 Attribute *e_attrs; /* list of attributes + values */
980 slap_mask_t e_ocflags;
982 struct berval e_bv; /* For entry_encode/entry_decode */
984 /* for use by the backend for any purpose */
991 typedef struct slap_mod {
993 AttributeDescription *sm_desc;
994 struct berval sm_type;
996 #define sm_bvalues sm_values
997 BerVarray sm_nvalues;
1000 typedef struct slap_mod_list {
1001 Modification sml_mod;
1002 #define sml_op sml_mod.sm_op
1003 #define sml_desc sml_mod.sm_desc
1004 #define sml_type sml_mod.sm_type
1005 #define sml_bvalues sml_mod.sm_values
1006 #define sml_values sml_mod.sm_values
1007 #define sml_nvalues sml_mod.sm_nvalues
1008 struct slap_mod_list *sml_next;
1011 typedef struct slap_ldap_modlist {
1013 struct slap_ldap_modlist *ml_next;
1014 #define ml_op ml_mod.mod_op
1015 #define ml_type ml_mod.mod_type
1016 #define ml_values ml_mod.mod_values
1017 #define ml_bvalues ml_mod.mod_values
1021 * represents an access control list
1023 typedef enum slap_access_e {
1024 ACL_INVALID_ACCESS = -1,
1033 typedef enum slap_control_e {
1034 ACL_INVALID_CONTROL = 0,
1040 typedef enum slap_style_e {
1041 ACL_STYLE_REGEX = 0,
1049 typedef struct slap_authz_info {
1050 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1051 struct berval sai_mech; /* SASL Mechanism */
1052 struct berval sai_dn; /* DN for reporting purposes */
1053 struct berval sai_ndn; /* Normalized DN */
1055 /* Security Strength Factors */
1056 slap_ssf_t sai_ssf; /* Overall SSF */
1057 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1058 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1059 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1060 } AuthorizationInformation;
1063 typedef struct slap_access {
1064 slap_control_t a_type;
1066 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1068 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1069 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1070 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1071 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1072 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1073 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1075 #define ACL_PRIV_MASK 0x00ffUL
1078 #define ACL_PRIV_LEVEL 0x1000UL
1079 #define ACL_PRIV_ADDITIVE 0x2000UL
1080 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1083 #define ACL_PRIV_INVALID 0x0UL
1085 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1086 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1087 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1088 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1090 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1091 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1093 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1095 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1097 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1098 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1099 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1101 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1102 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1103 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1104 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1105 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1106 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1108 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1109 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1110 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1111 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1112 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1113 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1114 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1116 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1117 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1118 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1119 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1120 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1121 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1123 slap_mask_t a_access_mask;
1125 AuthorizationInformation a_authz;
1126 #define a_dn_pat a_authz.sai_dn
1128 slap_style_t a_dn_style;
1129 AttributeDescription *a_dn_at;
1133 slap_style_t a_peername_style;
1134 struct berval a_peername_pat;
1135 slap_style_t a_sockname_style;
1136 struct berval a_sockname_pat;
1138 slap_style_t a_domain_style;
1139 struct berval a_domain_pat;
1140 int a_domain_expand;
1142 slap_style_t a_sockurl_style;
1143 struct berval a_sockurl_pat;
1144 slap_style_t a_set_style;
1145 struct berval a_set_pat;
1147 #ifdef SLAPD_ACI_ENABLED
1148 AttributeDescription *a_aci_at;
1152 slap_style_t a_group_style;
1153 struct berval a_group_pat;
1154 ObjectClass *a_group_oc;
1155 AttributeDescription *a_group_at;
1157 struct slap_access *a_next;
1161 typedef struct slap_acl {
1162 /* "to" part: the entries this acl applies to */
1164 slap_style_t acl_dn_style;
1166 struct berval acl_dn_pat;
1167 AttributeName *acl_attrs;
1169 /* "by" part: list of who has what access to the entries */
1172 struct slap_acl *acl_next;
1175 typedef struct slap_acl_state {
1176 unsigned as_recorded;
1177 #define ACL_STATE_NOT_RECORDED 0x0
1178 #define ACL_STATE_RECORDED_VD 0x1
1179 #define ACL_STATE_RECORDED_NV 0x2
1180 #define ACL_STATE_RECORDED 0x3
1183 AccessControl *as_vd_acl;
1184 AccessControl *as_vi_acl;
1185 slap_mask_t as_vd_acl_mask;
1186 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1187 int as_vd_acl_count;
1189 Access *as_vd_access;
1190 int as_vd_access_count;
1193 AttributeDescription *as_vd_ad;
1194 } AccessControlState;
1195 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1196 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1200 * represents a backend
1203 typedef struct slap_backend_info BackendInfo; /* per backend type */
1204 typedef struct slap_backend_db BackendDB; /* per backend database */
1206 LDAP_SLAPD_V (int) nBackendInfo;
1207 LDAP_SLAPD_V (int) nBackendDB;
1208 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1209 LDAP_SLAPD_V (BackendDB *) backendDB;
1211 LDAP_SLAPD_V (int) slapMode;
1212 #define SLAP_UNDEFINED_MODE 0x0000
1213 #define SLAP_SERVER_MODE 0x0001
1214 #define SLAP_TOOL_MODE 0x0002
1215 #define SLAP_MODE 0x0003
1217 #define SLAP_TRUNCATE_MODE 0x0100
1218 #define SLAP_TOOL_READMAIN 0x0200
1219 #define SLAP_TOOL_READONLY 0x0400
1221 struct slap_replica_info {
1222 char *ri_host; /* supersedes be_replica */
1223 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1224 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1225 int ri_exclude; /* 1 => exclude ri_attrs */
1228 struct slap_limits_set {
1236 int lms_s_unchecked;
1241 struct slap_limits {
1242 int lm_type; /* type of pattern */
1243 #define SLAP_LIMITS_UNDEFINED 0x0000
1244 #define SLAP_LIMITS_EXACT 0x0001
1245 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1246 #define SLAP_LIMITS_ONE 0x0002
1247 #define SLAP_LIMITS_SUBTREE 0x0003
1248 #define SLAP_LIMITS_CHILDREN 0x0004
1249 #define SLAP_LIMITS_REGEX 0x0005
1250 #define SLAP_LIMITS_ANONYMOUS 0x0006
1251 #define SLAP_LIMITS_USERS 0x0007
1252 #define SLAP_LIMITS_ANY 0x0008
1253 regex_t lm_dn_regex; /* regex data for REGEX */
1256 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1257 * pattern for REGEX; NULL for ANONYMOUS, USERS
1259 struct berval lm_dn_pat;
1261 struct slap_limits_set lm_limits;
1264 /* temporary aliases */
1265 typedef BackendDB Backend;
1266 #define nbackends nBackendDB
1267 #define backends backendDB
1269 #ifdef LDAP_SYNCREPL
1270 struct nonpresent_entry {
1273 LDAP_LIST_ENTRY(nonpresent_entry) np_link;
1277 * syncinfo structure for syncrepl
1279 typedef struct syncinfo_s {
1280 struct slap_conn *conn;
1281 struct slap_backend_db *be;
1282 struct slap_entry *e;
1286 struct berval *master_bv;
1290 struct berval updatedn;
1310 #define LASTMOD_REQ 0
1311 #define LASTMOD_GEN 1
1312 #define LASTMOD_NO 2
1317 #define TLS_CRITICAL 2
1320 struct berval *syncUUID;
1321 struct berval *syncUUID_ndn;
1322 struct berval *syncCookie;
1323 Avlnode *presentlist;
1324 LDAP_LIST_HEAD(np, nonpresent_entry) nonpresentlist;
1328 #define MASTERSTR "master"
1329 #define SUFFIXSTR "suffix"
1330 #define UPDATEDNSTR "updatedn"
1331 #define BINDDNSTR "binddn"
1332 #define BINDMETHSTR "bindmethod"
1333 #define SIMPLESTR "simple"
1334 #define SASLSTR "sasl"
1335 #define CREDSTR "credentials"
1336 #define OLDAUTHCSTR "bindprincipal"
1337 #define AUTHCSTR "authcID"
1338 #define AUTHZSTR "authzID"
1339 #define SRVTABSTR "srvtab"
1340 #define SASLMECHSTR "saslmech"
1341 #define REALMSTR "realm"
1342 #define SECPROPSSTR "secprops"
1343 #define TLSSTR "tls"
1344 #define TLSCRITICALSTR "critical"
1346 #define FILTERSTR "filter"
1347 #define SEARCHBASESTR "searchbase"
1348 #define SCOPESTR "scope"
1349 #define ATTRSSTR "attrs"
1350 #define ATTRSONLYSTR "attrsonly"
1351 #define TYPESTR "type"
1352 #define INTERVALSTR "interval"
1353 #define COOKIESTR "cookie"
1354 #define LASTMODSTR "lastmod"
1355 #define LMREQSTR "req"
1356 #define LMGENSTR "gen"
1357 #define LMNOSTR "no"
1359 #endif /* LDAP_SYNCREPL */
1361 struct slap_backend_db {
1362 BackendInfo *bd_info; /* pointer to shared backend info */
1364 /* BackendInfo accessors */
1365 #define be_config bd_info->bi_db_config
1366 #define be_type bd_info->bi_type
1368 #define be_bind bd_info->bi_op_bind
1369 #define be_unbind bd_info->bi_op_unbind
1370 #define be_add bd_info->bi_op_add
1371 #define be_compare bd_info->bi_op_compare
1372 #define be_delete bd_info->bi_op_delete
1373 #define be_modify bd_info->bi_op_modify
1374 #define be_modrdn bd_info->bi_op_modrdn
1375 #define be_search bd_info->bi_op_search
1376 #define be_abandon bd_info->bi_op_abandon
1377 #define be_cancel bd_info->bi_op_cancel
1379 #define be_extended bd_info->bi_extended
1381 #define be_fetch bd_info->bi_entry_get_rw
1382 #define be_release bd_info->bi_entry_release_rw
1383 #define be_chk_referrals bd_info->bi_chk_referrals
1384 #define be_group bd_info->bi_acl_group
1385 #define be_attribute bd_info->bi_acl_attribute
1386 #define be_operational bd_info->bi_operational
1389 * define to honor hasSubordinates operational attribute in search filters
1390 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1393 #define be_has_subordinates bd_info->bi_has_subordinates
1395 #define be_controls bd_info->bi_controls
1397 #define be_connection_init bd_info->bi_connection_init
1398 #define be_connection_destroy bd_info->bi_connection_destroy
1401 #define be_entry_open bd_info->bi_tool_entry_open
1402 #define be_entry_close bd_info->bi_tool_entry_close
1403 #define be_entry_first bd_info->bi_tool_entry_first
1404 #define be_entry_next bd_info->bi_tool_entry_next
1405 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1406 #define be_entry_get bd_info->bi_tool_entry_get
1407 #define be_entry_put bd_info->bi_tool_entry_put
1408 #define be_sync bd_info->bi_tool_sync
1411 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1412 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1413 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1414 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1415 #define SLAP_BFLAG_ALIASES 0x0100U
1416 #define SLAP_BFLAG_REFERRALS 0x0200U
1417 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1418 #define SLAP_BFLAG_MONITOR 0x1000U
1419 #define SLAP_BFLAG_DYNAMIC 0x2000U
1420 slap_mask_t be_flags;
1421 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1422 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1423 #define SLAP_GLUE_SUBORDINATE(be) \
1424 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1425 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1426 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1427 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1428 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1429 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1430 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1432 slap_mask_t be_restrictops; /* restriction operations */
1433 #define SLAP_RESTRICT_OP_ADD 0x0001U
1434 #define SLAP_RESTRICT_OP_BIND 0x0002U
1435 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1436 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1437 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1438 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1439 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1440 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1442 #define SLAP_RESTRICT_OP_READS \
1443 ( SLAP_RESTRICT_OP_COMPARE \
1444 | SLAP_RESTRICT_OP_SEARCH )
1445 #define SLAP_RESTRICT_OP_WRITES \
1446 ( SLAP_RESTRICT_OP_ADD \
1447 | SLAP_RESTRICT_OP_DELETE \
1448 | SLAP_RESTRICT_OP_MODIFY \
1449 | SLAP_RESTRICT_OP_RENAME )
1451 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1452 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1453 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1455 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1457 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1458 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1459 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1460 0x0004U /* unprotected simple auth */
1461 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1463 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1464 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1466 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1468 slap_mask_t be_requires; /* pre-operation requirements */
1469 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1470 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1471 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1472 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1473 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1475 /* Required Security Strength Factor */
1476 slap_ssf_set_t be_ssf_set;
1478 /* these should be renamed from be_ to bd_ */
1479 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1480 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1481 struct berval be_schemadn; /* per-backend subschema subentry DN */
1482 struct berval be_schemandn; /* normalized subschema DN */
1483 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1484 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1485 struct berval be_rootpw; /* the magic "root" password for this db */
1486 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1487 #define be_sizelimit be_def_limit.lms_s_soft
1488 #define be_timelimit be_def_limit.lms_t_soft
1489 struct slap_limits_set be_def_limit; /* default limits */
1490 struct slap_limits **be_limits; /* regex-based size and time limits */
1491 AccessControl *be_acl; /* access control list for this backend */
1492 slap_access_t be_dfltaccess; /* access given if no acl matches */
1493 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1494 char *be_replogfile; /* replication log file (in master) */
1495 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1496 BerVarray be_update_refs; /* where to refer modifying clients to */
1498 void *be_private; /* anything the backend database needs */
1500 void *be_pb; /* Netscape plugin */
1501 #ifdef LDAP_SYNCREPL
1502 syncinfo_t *syncinfo; /* For syncrepl */
1509 /* Backend function typedefs */
1510 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1511 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1512 const char *fname, int lineno,
1513 int argc, char **argv));
1514 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1515 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1516 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1518 typedef int (BI_db_init) LDAP_P((Backend *bd));
1519 typedef int (BI_db_config) LDAP_P((Backend *bd,
1520 const char *fname, int lineno,
1521 int argc, char **argv));
1522 typedef int (BI_db_open) LDAP_P((Backend *bd));
1523 typedef int (BI_db_close) LDAP_P((Backend *bd));
1524 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1526 typedef struct req_bind_s {
1528 struct berval rb_cred;
1529 struct berval rb_edn;
1533 typedef struct req_search_s {
1539 AttributeName *rs_attrs;
1541 struct berval rs_filterstr;
1544 typedef struct req_compare_s {
1545 AttributeAssertion *rs_ava;
1548 typedef struct req_modify_s {
1549 Modifications *rs_modlist;
1552 typedef struct req_modrdn_s {
1553 struct berval rs_newrdn;
1554 struct berval rs_nnewrdn;
1555 struct berval *rs_newSup;
1556 struct berval *rs_nnewSup;
1557 int rs_deleteoldrdn;
1560 typedef struct req_add_s {
1564 typedef struct req_abandon_s {
1568 typedef struct req_extended_s {
1569 struct berval rs_reqoid;
1570 struct berval *rs_reqdata;
1573 typedef enum slap_reply_e {
1582 typedef struct rep_sasl_s {
1583 struct berval *r_sasldata;
1586 typedef struct rep_extended_s {
1587 const char *r_rspoid;
1588 struct berval *r_rspdata;
1591 typedef struct rep_search_s {
1593 AttributeName *r_attrs;
1598 typedef struct slap_rep {
1599 slap_reply_t sr_type;
1603 const char *sr_matched;
1604 const char *sr_text;
1606 LDAPControl **sr_ctrls;
1608 rep_sasl_s sru_sasl;
1609 rep_extended_s sru_extended;
1610 rep_search_s sru_search;
1614 /* short hands for response members */
1615 #define sr_attrs sr_un.sru_search.r_attrs
1616 #define sr_entry sr_un.sru_search.r_entry
1617 #define sr_v2ref sr_un.sru_search.r_v2ref
1618 #define sr_nentries sr_un.sru_search.r_nentries
1619 #define sr_rspoid sr_un.sru_extended.r_rspoid
1620 #define sr_rspdata sr_un.sru_extended.r_rspdata
1621 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1623 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1624 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1625 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1626 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1627 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1628 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1629 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1630 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1631 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1632 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1633 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1634 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1635 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1636 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1637 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1638 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1639 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1641 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1642 struct slap_conn *c));
1643 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1644 struct slap_conn *c));
1646 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1647 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1648 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1649 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1650 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1651 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1652 struct berval *text ));
1653 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1654 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1656 struct slap_backend_info {
1657 char *bi_type; /* type of backend */
1660 * per backend type routines:
1661 * bi_init: called to allocate a backend_info structure,
1662 * called once BEFORE configuration file is read.
1663 * bi_init() initializes this structure hence is
1664 * called directly from be_initialize()
1665 * bi_config: called per 'backend' specific option
1666 * all such options must before any 'database' options
1667 * bi_config() is called only from read_config()
1668 * bi_open: called to open each database, called
1669 * once AFTER configuration file is read but
1670 * BEFORE any bi_db_open() calls.
1671 * bi_open() is called from backend_startup()
1672 * bi_close: called to close each database, called
1673 * once during shutdown after all bi_db_close calls.
1674 * bi_close() is called from backend_shutdown()
1675 * bi_destroy: called to destroy each database, called
1676 * once during shutdown after all bi_db_destroy calls.
1677 * bi_destory() is called from backend_destroy()
1680 BI_config *bi_config;
1683 BI_destroy *bi_destroy;
1686 * per database routines:
1687 * bi_db_init: called to initialize each database,
1688 * called upon reading 'database <type>'
1689 * called only from backend_db_init()
1690 * bi_db_config: called to configure each database,
1691 * called per database to handle per database options
1692 * called only from read_config()
1693 * bi_db_open: called to open each database
1694 * called once per database immediately AFTER bi_open()
1695 * calls but before daemon startup.
1696 * called only by backend_startup()
1697 * bi_db_close: called to close each database
1698 * called once per database during shutdown but BEFORE
1699 * any bi_close call.
1700 * called only by backend_shutdown()
1701 * bi_db_destroy: called to destroy each database
1702 * called once per database during shutdown AFTER all
1703 * bi_close calls but before bi_destory calls.
1704 * called only by backend_destory()
1706 BI_db_init *bi_db_init;
1707 BI_db_config *bi_db_config;
1708 BI_db_open *bi_db_open;
1709 BI_db_close *bi_db_close;
1710 BI_db_destroy *bi_db_destroy;
1712 /* LDAP Operations Handling Routines */
1713 BI_op_bind *bi_op_bind;
1714 BI_op_unbind *bi_op_unbind;
1715 BI_op_search *bi_op_search;
1716 BI_op_compare *bi_op_compare;
1717 BI_op_modify *bi_op_modify;
1718 BI_op_modrdn *bi_op_modrdn;
1719 BI_op_add *bi_op_add;
1720 BI_op_delete *bi_op_delete;
1721 BI_op_abandon *bi_op_abandon;
1722 BI_op_cancel *bi_op_cancel;
1724 /* Extended Operations Helper */
1725 BI_op_extended *bi_extended;
1727 /* Auxilary Functions */
1728 BI_entry_get_rw *bi_entry_get_rw;
1729 BI_entry_release_rw *bi_entry_release_rw;
1730 BI_chk_referrals *bi_chk_referrals;
1732 BI_operational *bi_operational;
1733 BI_has_subordinates *bi_has_subordinates;
1735 BI_connection_init *bi_connection_init;
1736 BI_connection_destroy *bi_connection_destroy;
1738 /* hooks for slap tools */
1739 BI_tool_entry_open *bi_tool_entry_open;
1740 BI_tool_entry_close *bi_tool_entry_close;
1741 BI_tool_entry_first *bi_tool_entry_first;
1742 BI_tool_entry_next *bi_tool_entry_next;
1743 BI_tool_entry_get *bi_tool_entry_get;
1744 BI_tool_entry_put *bi_tool_entry_put;
1745 BI_tool_entry_reindex *bi_tool_entry_reindex;
1746 BI_tool_sync *bi_tool_sync;
1748 #define SLAP_INDEX_ADD_OP 0x0001
1749 #define SLAP_INDEX_DELETE_OP 0x0002
1751 char **bi_controls; /* supported controls */
1753 unsigned int bi_nDB; /* number of databases of this type */
1754 void *bi_private; /* anything the backend type needs */
1757 #define c_authtype c_authz.sai_method
1758 #define c_authmech c_authz.sai_mech
1759 #define c_dn c_authz.sai_dn
1760 #define c_ndn c_authz.sai_ndn
1761 #define c_ssf c_authz.sai_ssf
1762 #define c_transport_ssf c_authz.sai_transport_ssf
1763 #define c_tls_ssf c_authz.sai_tls_ssf
1764 #define c_sasl_ssf c_authz.sai_sasl_ssf
1766 #define o_authtype o_authz.sai_method
1767 #define o_authmech o_authz.sai_mech
1768 #define o_dn o_authz.sai_dn
1769 #define o_ndn o_authz.sai_ndn
1770 #define o_ssf o_authz.sai_ssf
1771 #define o_transport_ssf o_authz.sai_transport_ssf
1772 #define o_tls_ssf o_authz.sai_tls_ssf
1773 #define o_sasl_ssf o_authz.sai_sasl_ssf
1775 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1777 typedef struct slap_callback {
1778 slap_response *sc_response;
1783 * Paged Results state
1785 typedef unsigned long PagedResultsCookie;
1786 typedef struct slap_paged_state {
1788 PagedResultsCookie ps_cookie;
1790 } PagedResultsState;
1793 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1794 #define LDAP_PSEARCH_BY_ADD 0x01
1795 #define LDAP_PSEARCH_BY_DELETE 0x02
1796 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1797 #define LDAP_PSEARCH_BY_MODIFY 0x04
1798 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1801 struct slap_op *ps_op;
1802 LDAP_LIST_ENTRY(psid_entry) ps_link;
1808 * represents an operation pending from an ldap client
1810 typedef struct slap_op {
1811 unsigned long o_opid; /* id of this operation */
1812 unsigned long o_connid; /* id of conn initiating this op */
1813 struct slap_conn *o_conn; /* connection spawning this op */
1814 BackendDB *o_bd; /* backend DB processing this op */
1816 ber_int_t o_msgid; /* msgid of the request */
1817 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1818 ber_tag_t o_tag; /* tag of the request */
1819 time_t o_time; /* time op was initiated */
1821 struct berval o_req_dn; /* DN of target of request */
1822 struct berval o_req_ndn;
1827 req_compare_s oq_compare;
1828 req_modify_s oq_modify;
1829 req_modrdn_s oq_modrdn;
1830 req_search_s oq_search;
1831 req_abandon_s oq_abandon;
1832 req_abandon_s oq_cancel;
1833 req_extended_s oq_extended;
1836 /* short hands for union members */
1837 #define oq_add o_request.oq_add
1838 #define oq_bind o_request.oq_bind
1839 #define oq_compare o_request.oq_compare
1840 #define oq_modify o_request.oq_modify
1841 #define oq_modrdn o_request.oq_modrdn
1842 #define oq_search o_request.oq_search
1843 #define oq_abandon o_request.oq_abandon
1844 #define oq_cancel o_request.oq_cancel
1845 #define oq_extended o_request.oq_extended
1847 /* short hands for inner request members */
1848 #define orb_method oq_bind.rb_method
1849 #define orb_cred oq_bind.rb_cred
1850 #define orb_edn oq_bind.rb_edn
1851 #define orb_ssf oq_bind.rb_ssf
1853 #define ors_scope oq_search.rs_scope
1854 #define ors_deref oq_search.rs_deref
1855 #define ors_slimit oq_search.rs_slimit
1856 #define ors_tlimit oq_search.rs_tlimit
1857 #define ors_attrsonly oq_search.rs_attrsonly
1858 #define ors_attrs oq_search.rs_attrs
1859 #define ors_filter oq_search.rs_filter
1860 #define ors_filterstr oq_search.rs_filterstr
1862 #define orr_newrdn oq_modrdn.rs_newrdn
1863 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1864 #define orr_newSup oq_modrdn.rs_newSup
1865 #define orr_nnewSup oq_modrdn.rs_nnewSup
1866 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1868 #define orc_ava oq_compare.rs_ava
1869 #define ora_e oq_add.rs_e
1870 #define orn_msgid oq_abandon.rs_msgid
1871 #define orm_modlist oq_modify.rs_modlist
1873 #define ore_reqoid oq_extended.rs_reqoid
1874 #define ore_reqdata oq_extended.rs_reqdata
1876 ldap_pvt_thread_t o_tid; /* thread handling this op */
1878 volatile sig_atomic_t o_abandon; /* abandon flag */
1879 volatile sig_atomic_t o_cancel; /* cancel flag */
1880 #define SLAP_CANCEL_NONE 0x00
1881 #define SLAP_CANCEL_REQ 0x01
1882 #define SLAP_CANCEL_ACK 0x02
1883 #define SLAP_CANCEL_DONE 0x03
1885 char o_do_not_cache; /* don't cache from this op */
1886 char o_is_auth_check; /* authorization in progress */
1888 #define SLAP_NO_CONTROL 0
1889 #define SLAP_NONCRITICAL_CONTROL 1
1890 #define SLAP_CRITICAL_CONTROL 2
1892 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1898 #define get_subentries(op) ((int)(op)->o_subentries)
1899 char o_subentries_visibility;
1900 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1902 char o_valuesreturnfilter;
1904 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1905 char o_permissive_modify;
1906 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1908 #define get_permissiveModify(op) (0)
1911 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1912 char o_domain_scope;
1913 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1915 #define get_domainScope(op) (0)
1918 #ifdef LDAP_CONTROL_PAGEDRESULTS
1919 char o_pagedresults;
1920 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1921 ber_int_t o_pagedresults_size;
1922 PagedResultsState o_pagedresults_state;
1924 #define get_pagedresults(op) (0)
1927 #ifdef LDAP_CLIENT_UPDATE
1928 char o_clientupdate;
1929 char o_clientupdate_type;
1930 #define SLAP_LCUP_NONE (0x0)
1931 #define SLAP_LCUP_SYNC (0x1)
1932 #define SLAP_LCUP_PERSIST (0x2)
1933 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1934 ber_int_t o_clientupdate_interval;
1935 struct berval o_clientupdate_state;
1941 #define SLAP_SYNC_NONE (0x0)
1942 #define SLAP_SYNC_REFRESH (0x1)
1943 #define SLAP_SYNC_PERSIST (0x2)
1944 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1945 struct berval o_sync_state;
1948 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1951 LDAP_LIST_ENTRY(slap_op) o_ps_link;
1952 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1955 AuthorizationInformation o_authz;
1957 BerElement *o_ber; /* ber of the request */
1958 #ifdef LDAP_CONNECTIONLESS
1959 BerElement *o_res_ber; /* ber of the reply */
1961 slap_callback *o_callback; /* callback pointers */
1962 LDAPControl **o_ctrls; /* controls */
1964 void *o_threadctx; /* thread pool thread context */
1965 void *o_tmpmemctx; /* slab malloc context */
1966 BerMemoryFunctions *o_tmpmfuncs;
1967 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
1968 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
1969 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
1970 #define o_tmpfree o_tmpmfuncs->bmf_free
1971 void *o_private; /* anything the backend needs */
1973 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1974 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1978 #endif /*LDAP_CACHING */
1981 void *o_pb; /* NS-SLAPI plugin */
1985 #define send_ldap_error( op, rs, err, text ) do { \
1986 (rs)->sr_err = err; (rs)->sr_text = text; \
1987 (op->o_conn->c_send_ldap_result)( op, rs ); \
1989 #define send_ldap_discon( op, rs, err, text ) do { \
1990 (rs)->sr_err = err; (rs)->sr_text = text; \
1991 send_ldap_disconnect( op, rs ); \
1994 typedef void (SEND_LDAP_RESULT)(
1995 struct slap_op *op, struct slap_rep *rs);
1996 typedef int (SEND_SEARCH_ENTRY)(
1997 struct slap_op *op, struct slap_rep *rs);
1998 typedef int (SEND_SEARCH_REFERENCE)(
1999 struct slap_op *op, struct slap_rep *rs);
2000 typedef void (SEND_LDAP_EXTENDED)(
2001 struct slap_op *op, struct slap_rep *rs);
2002 typedef void (SEND_LDAP_INTERMEDIATE)(
2003 struct slap_op *op, struct slap_rep *rs);
2005 #define send_ldap_result( op, rs ) \
2006 (op->o_conn->c_send_ldap_result)( op, rs )
2007 #define send_search_entry( op, rs ) \
2008 (op->o_conn->c_send_search_entry)( op, rs )
2009 #define send_search_reference( op, rs ) \
2010 (op->o_conn->c_send_search_reference)( op, rs )
2011 #define send_ldap_extended( op, rs ) \
2012 (op->o_conn->c_send_ldap_extended)( op, rs )
2013 #define send_ldap_intermediate( op, rs ) \
2014 (op->o_conn->c_send_ldap_intermediate)( op, rs )
2017 * Caches the result of a backend_group check for ACL evaluation
2019 typedef struct slap_gacl {
2020 struct slap_gacl *ga_next;
2023 AttributeDescription *ga_at;
2029 typedef struct slap_listener Listener;
2032 * represents a connection from an ldap client
2034 typedef struct slap_conn {
2035 int c_struct_state; /* structure management state */
2036 int c_conn_state; /* connection state */
2038 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2039 Sockbuf *c_sb; /* ber connection stuff */
2041 /* only can be changed by connect_init */
2042 time_t c_starttime; /* when the connection was opened */
2043 time_t c_activitytime; /* when the connection was last used */
2044 unsigned long c_connid; /* id of this connection for stats*/
2046 struct berval c_peer_domain; /* DNS name of client */
2047 struct berval c_peer_name; /* peer name (trans=addr:port) */
2048 Listener *c_listener;
2049 #define c_listener_url c_listener->sl_url /* listener URL */
2050 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2052 /* only can be changed by binding thread */
2053 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2054 struct berval c_sasl_bind_mech; /* mech in progress */
2055 struct berval c_sasl_dn; /* temporary storage */
2057 /* authorization backend */
2058 Backend *c_authz_backend;
2060 AuthorizationInformation c_authz;
2061 GroupAssertion *c_groups;
2063 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2065 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2066 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2068 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2069 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2071 BerElement *c_currentber; /* ber we're attempting to read */
2072 int c_writewaiter; /* true if writer is waiting */
2074 #ifdef LDAP_CONNECTIONLESS
2075 int c_is_udp; /* true if this is (C)LDAP over UDP */
2078 int c_is_tls; /* true if this LDAP over raw TLS */
2079 int c_needs_tls_accept; /* true if SSL_accept should be called */
2081 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2082 int c_sasl_done; /* SASL completed once */
2083 void *c_sasl_authctx; /* SASL authentication context */
2084 void *c_sasl_sockctx; /* SASL security layer context */
2085 void *c_sasl_extra; /* SASL session extra stuff */
2086 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2088 PagedResultsState c_pagedresults_state; /* paged result state */
2090 long c_n_ops_received; /* num of ops received (next op_id) */
2091 long c_n_ops_executing; /* num of ops currently executing */
2092 long c_n_ops_pending; /* num of ops pending execution */
2093 long c_n_ops_completed; /* num of ops completed */
2095 long c_n_get; /* num of get calls */
2096 long c_n_read; /* num of read calls */
2097 long c_n_write; /* num of write calls */
2099 void *c_pb; /* Netscape plugin */
2102 * These are the "callbacks" that are available for back-ends to
2103 * supply data back to connected clients that are connected
2104 * through the "front-end".
2106 SEND_LDAP_RESULT *c_send_ldap_result;
2107 SEND_SEARCH_ENTRY *c_send_search_entry;
2108 SEND_SEARCH_REFERENCE *c_send_search_reference;
2109 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2110 #ifdef LDAP_RES_INTERMEDIATE
2111 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2116 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2117 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2119 if ( ldap_debug & (level) ) \
2120 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2121 if ( ldap_syslog & (level) ) \
2122 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2125 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2126 #elif defined(LDAP_DEBUG)
2127 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2129 if ( ldap_debug & (level) ) \
2130 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2132 #define StatslogTest( level ) (ldap_debug & (level))
2134 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2135 #define StatslogTest( level ) (0)
2139 * listener; need to access it from monitor backend
2141 struct slap_listener {
2142 struct berval sl_url;
2143 struct berval sl_name;
2148 #ifdef LDAP_CONNECTIONLESS
2149 int sl_is_udp; /* UDP listener is also data port */
2151 int sl_is_mute; /* Listening is temporarily disabled */
2154 #define sl_addr sl_sa.sa_in_addr
2157 #ifdef SLAPD_MONITOR
2174 #endif /* SLAPD_MONITOR */
2177 * Better know these all around slapd
2179 #define SLAP_LDAPDN_PRETTY 0x1
2180 #define SLAP_LDAPDN_MAXLEN 8192
2185 #ifdef LDAP_CLIENT_UPDATE
2186 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2187 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2188 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2189 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2190 #endif /* LDAP_CLIENT_UPDATE */
2192 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2193 #define SLAP_SEARCH_MAX_CTRLS 10
2196 #define SLAP_CTRL_FRONTEND 0x80000000U
2197 #define SLAP_CTRL_FRONTEND_SEARCH 0x01000000U /* for NOOP */
2199 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2200 #define SLAP_CTRL_ABANDON 0x00000001U
2201 #define SLAP_CTRL_ADD 0x00002002U
2202 #define SLAP_CTRL_BIND 0x00000004U
2203 #define SLAP_CTRL_COMPARE 0x00001008U
2204 #define SLAP_CTRL_DELETE 0x00002010U
2205 #define SLAP_CTRL_MODIFY 0x00002020U
2206 #define SLAP_CTRL_RENAME 0x00002040U
2207 #define SLAP_CTRL_SEARCH 0x00001080U
2208 #define SLAP_CTRL_UNBIND 0x00000100U
2210 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2211 #define SLAP_CTRL_UPDATE \
2212 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2213 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2215 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2218 LDAPControl *ctrl ));
2222 #include "proto-slap.h"
2224 #endif /* _SLAP_H_ */