1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
14 #include <ac/stdlib.h>
16 #include <sys/types.h>
17 #include <ac/syslog.h>
19 #include <ac/signal.h>
20 #include <ac/socket.h>
27 #define ldap_debug slap_debug
33 #include <ldap_schema.h>
35 #include "ldap_pvt_thread.h"
36 #include "ldap_queue.h"
39 #define SLAP_NVALUES 1
40 #define SLAP_EXTENDED_SCHEMA 1
45 * SLAPD Memory allocation macros
47 * Unlike ch_*() routines, these routines do not assert() upon
48 * allocation error. They are intended to be used instead of
49 * ch_*() routines where the caller has implemented proper
50 * checking for and handling of allocation errors.
52 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
54 #define SLAP_MALLOC(s) ber_memalloc((s))
55 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
56 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
57 #define SLAP_FREE(p) ber_memfree((p))
58 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
59 #define SLAP_STRDUP(s) ber_strdup((s))
60 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
63 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
66 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
67 #define SLAPD_ANONYMOUS "cn=anonymous"
69 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
70 * This is a value used internally by the backends. It is needed to allow
71 * adding values that already exist without getting an error as required by
72 * modrdn when the new rdn was already an attribute value itself.
74 #define SLAP_MOD_SOFTADD 0x1000
76 #define MAXREMATCHES (100)
78 #define SLAP_MAX_WORKER_THREADS (16)
80 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
81 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
83 #define SLAP_TEXT_BUFLEN (256)
85 /* psuedo error code indicating abandoned operation */
86 #define SLAPD_ABANDON (-1)
88 /* psuedo error code indicating disconnect */
89 #define SLAPD_DISCONNECT (-2)
92 /* We assume "C" locale, that is US-ASCII */
93 #define ASCII_SPACE(c) ( (c) == ' ' )
94 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
95 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
96 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
97 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
98 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
99 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
101 #define SLAP_NIBBLE(c) ((c)&0x0f)
102 #define SLAP_ESCAPE_CHAR ('\\')
103 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
104 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
106 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
107 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
109 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
110 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
111 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
112 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
113 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
115 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
116 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
117 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
118 #define OID_SEPARATOR(c) ( (c) == '.' )
119 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
121 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
122 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
124 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
125 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
127 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
129 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
130 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
131 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
132 (c) == '?' || (c) == ' ' || (c) == '=' )
133 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
135 /* must match in schema_init.c */
136 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
137 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
138 #define SLAPD_GROUP_ATTR "member"
139 #define SLAPD_GROUP_CLASS "groupOfNames"
140 #define SLAPD_ROLE_ATTR "roleOccupant"
141 #define SLAPD_ROLE_CLASS "organizationalRole"
143 #ifdef SLAPD_ACI_ENABLED
144 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
147 /* change this to "OpenLDAPset" */
148 #define SLAPD_ACI_SET_ATTR "template"
150 #define SLAPD_TOP_OID "2.5.6.0"
152 LDAP_SLAPD_V (int) slap_debug;
154 typedef unsigned long slap_mask_t;
156 /* Security Strength Factor */
157 typedef unsigned slap_ssf_t;
159 typedef struct slap_ssf_set {
161 slap_ssf_t sss_transport;
164 slap_ssf_t sss_update_ssf;
165 slap_ssf_t sss_update_transport;
166 slap_ssf_t sss_update_tls;
167 slap_ssf_t sss_update_sasl;
168 slap_ssf_t sss_simple_bind;
171 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
172 #define SLAP_GETDN_AUTHCID 2
173 #define SLAP_GETDN_AUTHZID 4
178 #define SLAP_INDEX_TYPE 0x00FFUL
179 #define SLAP_INDEX_UNDEFINED 0x0001UL
180 #define SLAP_INDEX_PRESENT 0x0002UL
181 #define SLAP_INDEX_EQUALITY 0x0004UL
182 #define SLAP_INDEX_APPROX 0x0008UL
183 #define SLAP_INDEX_SUBSTR 0x0010UL
184 #define SLAP_INDEX_EXTENDED 0x0020UL
186 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
188 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
190 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
192 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
193 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
194 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
195 #define SLAP_INDEX_SUBSTR_DEFAULT \
196 ( SLAP_INDEX_SUBSTR \
197 | SLAP_INDEX_SUBSTR_INITIAL \
198 | SLAP_INDEX_SUBSTR_ANY \
199 | SLAP_INDEX_SUBSTR_FINAL )
201 #define SLAP_INDEX_SUBSTR_MINLEN 2
202 #define SLAP_INDEX_SUBSTR_MAXLEN 4
203 #define SLAP_INDEX_SUBSTR_STEP 2
205 #define SLAP_INDEX_FLAGS 0xF000UL
206 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
207 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
210 * there is a single index for each attribute. these prefixes ensure
211 * that there is no collision among keys.
213 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
214 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
215 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
216 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
217 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
218 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
220 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
221 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
222 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
223 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
224 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
226 #ifdef LDAP_CLIENT_UPDATE
227 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
228 #endif /* LDAP_CLIENT_UPDATE */
231 * represents schema information for a database
233 #define SLAP_SCHERR_OUTOFMEM 1
234 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
235 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
236 #define SLAP_SCHERR_CLASS_BAD_SUP 4
237 #define SLAP_SCHERR_CLASS_DUP 5
238 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
239 #define SLAP_SCHERR_ATTR_BAD_MR 7
240 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
241 #define SLAP_SCHERR_ATTR_BAD_SUP 9
242 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
243 #define SLAP_SCHERR_ATTR_DUP 11
244 #define SLAP_SCHERR_MR_NOT_FOUND 12
245 #define SLAP_SCHERR_MR_INCOMPLETE 13
246 #define SLAP_SCHERR_MR_DUP 14
247 #define SLAP_SCHERR_SYN_NOT_FOUND 15
248 #define SLAP_SCHERR_SYN_DUP 16
249 #define SLAP_SCHERR_NO_NAME 17
250 #define SLAP_SCHERR_NOT_SUPPORTED 18
251 #define SLAP_SCHERR_BAD_DESCR 19
252 #define SLAP_SCHERR_OIDM 20
253 #define SLAP_SCHERR_CR_DUP 21
254 #define SLAP_SCHERR_CR_BAD_STRUCT 22
255 #define SLAP_SCHERR_CR_BAD_AUX 23
256 #define SLAP_SCHERR_CR_BAD_AT 24
257 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
259 typedef union slap_sockaddr {
260 struct sockaddr sa_addr;
261 struct sockaddr_in sa_in_addr;
263 struct sockaddr_storage sa_storage;
264 struct sockaddr_in6 sa_in6_addr;
267 struct sockaddr_un sa_un_addr;
272 extern int slap_inet4or6;
275 typedef struct slap_oid_macro {
276 struct berval som_oid;
278 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
281 /* forward declarations */
283 struct slap_matching_rule;
285 typedef int slap_syntax_validate_func LDAP_P((
286 struct slap_syntax *syntax,
287 struct berval * in));
289 typedef int slap_syntax_transform_func LDAP_P((
290 struct slap_syntax *syntax,
292 struct berval * out));
294 typedef struct slap_syntax {
296 #define ssyn_oid ssyn_syn.syn_oid
297 #define ssyn_desc ssyn_syn.syn_desc
298 #define ssyn_extensions ssyn_syn.syn_extensions
301 ber_len_t ssyn_oidlen;
302 * has been replaced by a struct berval that uses the value
303 * provided by ssyn_syn.syn_oid; a macro that expands to
304 * the bv_len field of the berval is provided for backward
305 * compatibility. CAUTION: NEVER FREE THE BERVAL
307 struct berval ssyn_bvoid;
308 #define ssyn_oidlen ssyn_bvoid.bv_len
310 unsigned int ssyn_flags;
312 #define SLAP_SYNTAX_NONE 0x0000U
313 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
314 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
315 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
316 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
318 slap_syntax_validate_func *ssyn_validate;
320 slap_syntax_transform_func *ssyn_normalize;
322 slap_syntax_transform_func *ssyn_pretty;
324 #ifdef SLAPD_BINARY_CONVERSION
325 /* convert to and from binary */
326 slap_syntax_transform_func *ssyn_ber2str;
327 slap_syntax_transform_func *ssyn_str2ber;
330 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
333 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
334 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
335 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
336 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
337 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
339 typedef struct slap_syntax_defs_rec {
342 slap_syntax_validate_func *sd_validate;
344 slap_syntax_transform_func *sd_normalizeXXX; /* to be deleted */
346 slap_syntax_transform_func *sd_normalize;
348 slap_syntax_transform_func *sd_pretty;
349 #ifdef SLAPD_BINARY_CONVERSION
350 slap_syntax_transform_func *sd_ber2str;
351 slap_syntax_transform_func *sd_str2ber;
353 } slap_syntax_defs_rec;
355 /* X -> Y Converter */
356 typedef int slap_mr_convert_func LDAP_P((
358 struct berval * out ));
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,
366 struct berval * out ));
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,
387 /* Filter index function */
388 typedef int slap_mr_filter_func LDAP_P((
391 struct slap_syntax *syntax, /* syntax of stored value */
392 struct slap_matching_rule *mr,
393 struct berval *prefix,
397 typedef struct slap_matching_rule_use MatchingRuleUse;
399 typedef struct slap_matching_rule {
400 LDAPMatchingRule smr_mrule;
401 MatchingRuleUse *smr_mru;
402 /* RFC2252 string representation */
403 struct berval smr_str;
406 * ber_len_t smr_oidlen;
407 * has been replaced by a struct berval that uses the value
408 * provided by smr_mrule.mr_oid; a macro that expands to
409 * the bv_len field of the berval is provided for backward
410 * compatibility. CAUTION: NEVER FREE THE BERVAL
412 struct berval smr_bvoid;
413 #define smr_oidlen smr_bvoid.bv_len
415 slap_mask_t smr_usage;
417 #define SLAP_MR_HIDE 0x8000U
419 #define SLAP_MR_TYPE_MASK 0xF000U
420 #define SLAP_MR_SUBTYPE_MASK 0x0F00U
421 #define SLAP_MR_USAGE 0x00FFU
423 #define SLAP_MR_NONE 0x0000U
424 #define SLAP_MR_EQUALITY 0x1000U
425 #define SLAP_MR_ORDERING 0x2000U
426 #define SLAP_MR_SUBSTR 0x4000U
427 #define SLAP_MR_EXT 0x8000U /* implicitly extensible */
429 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0100U )
431 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0100U )
432 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0200U )
433 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0400U )
436 #define SLAP_MR_DN_FOLD 0x0080U
441 * normally the asserted value is expected to conform to
442 * assertion syntax specified in the matching rule, however
443 * at times (such as during individual value modification),
444 * the asserted value is expected to conform to the
445 * attribute's value syntax.
447 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
448 #define SLAP_MR_ATTRIBUTE_SYNTAX_MATCH 0x0001U
450 /* For SLAP_MR_ATTRIBUTE_SYNTAX_MATCHes, this flag indicates
451 * that the asserted value of the attribute syntax has been
452 * converted to the assertion syntax. (Not sure why we just
453 * don't clear the SLAP_MR_ATTRIBUTE_SYNTAX_MATCH flag instead.)
455 #define SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH 0x0002U
459 * The asserted value, depending on the particular usage,
460 * is expected to conform to either the assertion syntax
461 * or the attribute syntax. In some cases, the syntax of
462 * the value is known. If so, these flags indicate which
463 * syntax the value is expected to conform to. If not,
464 * neither of these flags is set (until the syntax of the
465 * provided value is determined). If the value is of the
466 * attribute syntax, the flag is changed once a value of
467 * the assertion syntax is derived from the provided value.
469 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
470 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
472 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
473 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
474 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
475 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
478 /* either or both the asserted value or attribute value
479 * may be provided in normalized form
481 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0010U
482 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0020U
484 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
485 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
486 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
487 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
489 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
490 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
491 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
492 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
493 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
494 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
496 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
497 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
498 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
499 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
502 slap_mr_convert_func *smr_convert;
503 slap_mr_normalize_func *smr_normalize;
504 slap_mr_match_func *smr_match;
505 slap_mr_indexer_func *smr_indexer;
506 slap_mr_filter_func *smr_filter;
509 * null terminated array of syntaxes compatible with this syntax
510 * note: when MS_EXT is set, this MUST NOT contain the assertion
511 * syntax of the rule. When MS_EXT is not set, it MAY.
513 Syntax **smr_compat_syntaxes;
515 struct slap_matching_rule *smr_associated;
516 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
518 #define smr_oid smr_mrule.mr_oid
519 #define smr_names smr_mrule.mr_names
520 #define smr_desc smr_mrule.mr_desc
521 #define smr_obsolete smr_mrule.mr_obsolete
522 #define smr_syntax_oid smr_mrule.mr_syntax_oid
523 #define smr_extensions smr_mrule.mr_extensions
526 struct slap_matching_rule_use {
527 LDAPMatchingRuleUse smru_mruleuse;
528 MatchingRule *smru_mr;
529 /* RFC2252 string representation */
530 struct berval smru_str;
532 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
534 #define smru_oid smru_mruleuse.mru_oid
535 #define smru_names smru_mruleuse.mru_names
536 #define smru_desc smru_mruleuse.mru_desc
537 #define smru_obsolete smru_mruleuse.mru_obsolete
538 #define smru_applies_oids smru_mruleuse.mru_applies_oids
540 #define smru_usage smru_mr->smr_usage
541 } /* MatchingRuleUse */ ;
543 typedef struct slap_mrule_defs_rec {
545 slap_mask_t mrd_usage;
546 char ** mrd_compat_syntaxes;
547 slap_mr_convert_func * mrd_convert;
548 slap_mr_normalize_func * mrd_normalize;
549 slap_mr_match_func * mrd_match;
550 slap_mr_indexer_func * mrd_indexer;
551 slap_mr_filter_func * mrd_filter;
553 /* For equality rule, this may refer to an appropriate approximate rule */
554 char * mrd_associated;
555 } slap_mrule_defs_rec;
557 struct slap_backend_db;
561 typedef int (AttributeTypeSchemaCheckFN)(
562 struct slap_backend_db *be,
563 struct slap_entry *e,
564 struct slap_attr *attr,
566 char *textbuf, size_t textlen );
568 typedef struct slap_attribute_type {
569 LDAPAttributeType sat_atype;
570 struct berval sat_cname;
571 struct slap_attribute_type *sat_sup;
572 struct slap_attribute_type **sat_subtypes;
573 MatchingRule *sat_equality;
574 MatchingRule *sat_approx;
575 MatchingRule *sat_ordering;
576 MatchingRule *sat_substr;
579 AttributeTypeSchemaCheckFN *sat_check;
581 #define SLAP_AT_NONE 0x0000U
582 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
583 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
584 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
585 slap_mask_t sat_flags;
587 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
589 #define sat_oid sat_atype.at_oid
590 #define sat_names sat_atype.at_names
591 #define sat_desc sat_atype.at_desc
592 #define sat_obsolete sat_atype.at_obsolete
593 #define sat_sup_oid sat_atype.at_sup_oid
594 #define sat_equality_oid sat_atype.at_equality_oid
595 #define sat_ordering_oid sat_atype.at_ordering_oid
596 #define sat_substr_oid sat_atype.at_substr_oid
597 #define sat_syntax_oid sat_atype.at_syntax_oid
598 #define sat_single_value sat_atype.at_single_value
599 #define sat_collective sat_atype.at_collective
600 #define sat_no_user_mod sat_atype.at_no_user_mod
601 #define sat_usage sat_atype.at_usage
602 #define sat_extensions sat_atype.at_extensions
604 struct slap_attr_desc *sat_ad;
605 ldap_pvt_thread_mutex_t sat_ad_mutex;
608 #define is_at_operational(at) ((at)->sat_usage)
609 #define is_at_single_value(at) ((at)->sat_single_value)
610 #define is_at_collective(at) ((at)->sat_collective)
611 #define is_at_obsolete(at) ((at)->sat_obsolete)
612 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
614 struct slap_object_class;
616 typedef int (ObjectClassSchemaCheckFN)(
617 struct slap_backend_db *be,
618 struct slap_entry *e,
619 struct slap_object_class *oc,
621 char *textbuf, size_t textlen );
623 typedef struct slap_object_class {
624 LDAPObjectClass soc_oclass;
625 struct berval soc_cname;
626 struct slap_object_class **soc_sups;
627 AttributeType **soc_required;
628 AttributeType **soc_allowed;
629 ObjectClassSchemaCheckFN *soc_check;
630 slap_mask_t soc_flags;
631 #define soc_oid soc_oclass.oc_oid
632 #define soc_names soc_oclass.oc_names
633 #define soc_desc soc_oclass.oc_desc
634 #define soc_obsolete soc_oclass.oc_obsolete
635 #define soc_sup_oids soc_oclass.oc_sup_oids
636 #define soc_kind soc_oclass.oc_kind
637 #define soc_at_oids_must soc_oclass.oc_at_oids_must
638 #define soc_at_oids_may soc_oclass.oc_at_oids_may
639 #define soc_extensions soc_oclass.oc_extensions
641 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
644 #define SLAP_OC_ALIAS 0x0001
645 #define SLAP_OC_REFERRAL 0x0002
646 #define SLAP_OC_SUBENTRY 0x0004
647 #define SLAP_OC_DYNAMICOBJECT 0x0008
648 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
649 #define SLAP_OC__MASK 0x001F
650 #define SLAP_OC__END 0x0020
651 #define SLAP_OC_OPERATIONAL 0x4000
652 #define SLAP_OC_HIDE 0x8000
657 typedef struct slap_content_rule {
658 LDAPContentRule scr_crule;
659 ObjectClass *scr_sclass;
660 ObjectClass **scr_auxiliaries; /* optional */
661 AttributeType **scr_required; /* optional */
662 AttributeType **scr_allowed; /* optional */
663 AttributeType **scr_precluded; /* optional */
664 #define scr_oid scr_crule.cr_oid
665 #define scr_names scr_crule.cr_names
666 #define scr_desc scr_crule.cr_desc
667 #define scr_obsolete scr_crule.cr_obsolete
668 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
669 #define scr_at_oids_must scr_crule.cr_at_oids_must
670 #define scr_at_oids_may scr_crule.cr_at_oids_may
671 #define scr_at_oids_not scr_crule.cr_at_oids_not
673 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
676 /* Represents a recognized attribute description ( type + options ). */
677 typedef struct slap_attr_desc {
678 struct slap_attr_desc *ad_next;
679 AttributeType *ad_type; /* attribute type, must be specified */
680 struct berval ad_cname; /* canonical name, must be specified */
681 struct berval ad_tags; /* empty if no tagging options */
683 #define SLAP_DESC_NONE 0x00U
684 #define SLAP_DESC_BINARY 0x01U
685 #define SLAP_DESC_TAG_RANGE 0x80U
686 } AttributeDescription;
688 typedef struct slap_attr_name {
689 struct berval an_name;
690 AttributeDescription *an_desc;
694 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
695 #define slap_ad_is_tag_range(ad) \
696 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
697 #define slap_ad_is_binary(ad) \
698 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
701 * pointers to schema elements used internally
703 struct slap_internal_schema {
705 ObjectClass *si_oc_top;
706 ObjectClass *si_oc_extensibleObject;
707 ObjectClass *si_oc_alias;
708 ObjectClass *si_oc_referral;
709 ObjectClass *si_oc_rootdse;
710 ObjectClass *si_oc_subentry;
711 ObjectClass *si_oc_subschema;
712 ObjectClass *si_oc_monitor;
713 ObjectClass *si_oc_collectiveAttributeSubentry;
714 ObjectClass *si_oc_dynamicObject;
716 /* objectClass attribute descriptions */
717 AttributeDescription *si_ad_objectClass;
719 /* operational attribute descriptions */
720 AttributeDescription *si_ad_structuralObjectClass;
721 AttributeDescription *si_ad_creatorsName;
722 AttributeDescription *si_ad_createTimestamp;
723 AttributeDescription *si_ad_modifiersName;
724 AttributeDescription *si_ad_modifyTimestamp;
725 AttributeDescription *si_ad_hasSubordinates;
726 AttributeDescription *si_ad_subschemaSubentry;
727 AttributeDescription *si_ad_collectiveSubentries;
728 AttributeDescription *si_ad_collectiveExclusions;
729 AttributeDescription *si_ad_entryUUID;
730 AttributeDescription *si_ad_entryCSN;
731 AttributeDescription *si_ad_namingCSN;
732 AttributeDescription *si_ad_superiorUUID;
735 /* LDAP cache specific operational attribute */
736 AttributeDescription *si_ad_queryid;
737 #endif /* LDAP_CACHING */
739 /* root DSE attribute descriptions */
740 AttributeDescription *si_ad_altServer;
741 AttributeDescription *si_ad_namingContexts;
742 AttributeDescription *si_ad_supportedControl;
743 AttributeDescription *si_ad_supportedExtension;
744 AttributeDescription *si_ad_supportedLDAPVersion;
745 AttributeDescription *si_ad_supportedSASLMechanisms;
746 AttributeDescription *si_ad_supportedFeatures;
747 AttributeDescription *si_ad_monitorContext;
748 AttributeDescription *si_ad_vendorName;
749 AttributeDescription *si_ad_vendorVersion;
751 /* subentry attribute descriptions */
752 AttributeDescription *si_ad_administrativeRole;
753 AttributeDescription *si_ad_subtreeSpecification;
755 /* subschema subentry attribute descriptions */
756 AttributeDescription *si_ad_ditStructureRules;
757 AttributeDescription *si_ad_ditContentRules;
758 AttributeDescription *si_ad_nameForms;
759 AttributeDescription *si_ad_objectClasses;
760 AttributeDescription *si_ad_attributeTypes;
761 AttributeDescription *si_ad_ldapSyntaxes;
762 AttributeDescription *si_ad_matchingRules;
763 AttributeDescription *si_ad_matchingRuleUse;
765 /* Aliases & Referrals */
766 AttributeDescription *si_ad_aliasedObjectName;
767 AttributeDescription *si_ad_ref;
769 /* Access Control Internals */
770 AttributeDescription *si_ad_entry;
771 AttributeDescription *si_ad_children;
772 AttributeDescription *si_ad_saslAuthzTo;
773 AttributeDescription *si_ad_saslAuthzFrom;
774 #ifdef SLAPD_ACI_ENABLED
775 AttributeDescription *si_ad_aci;
778 /* dynamic entries */
779 AttributeDescription *si_ad_entryTtl;
780 AttributeDescription *si_ad_dynamicSubtrees;
782 /* Other attributes descriptions */
783 AttributeDescription *si_ad_distinguishedName;
784 AttributeDescription *si_ad_name;
785 AttributeDescription *si_ad_cn;
786 AttributeDescription *si_ad_userPassword;
787 #ifdef SLAPD_AUTHPASSWD
788 AttributeDescription *si_ad_authPassword;
790 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
791 AttributeDescription *si_ad_krbName;
794 /* Undefined Attribute Type */
795 AttributeType *si_at_undefined;
798 MatchingRule *si_mr_distinguishedNameMatch;
799 MatchingRule *si_mr_caseExactMatch;
800 MatchingRule *si_mr_caseExactSubstringsMatch;
801 MatchingRule *si_mr_caseExactIA5Match;
802 MatchingRule *si_mr_integerMatch;
803 MatchingRule *si_mr_integerFirstComponentMatch;
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 */
947 BerVarray a_nvals; /* normalized values */
949 struct slap_attr *a_next;
951 #define SLAP_ATTR_IXADD 0x1U
952 #define SLAP_ATTR_IXDEL 0x2U
957 * the id used in the indexes to refer to an entry
959 typedef unsigned long ID;
960 #define NOID ((ID)~0)
963 * represents an entry in core
965 typedef struct slap_entry {
967 * The ID field should only be changed before entry is
968 * inserted into a cache. The ID value is backend
973 struct berval e_name; /* name (DN) of this entry */
974 struct berval e_nname; /* normalized name (DN) of this entry */
976 /* for migration purposes */
977 #define e_dn e_name.bv_val
978 #define e_ndn e_nname.bv_val
980 Attribute *e_attrs; /* list of attributes + values */
982 slap_mask_t e_ocflags;
984 struct berval e_bv; /* For entry_encode/entry_decode */
986 /* for use by the backend for any purpose */
993 typedef struct slap_mod {
995 AttributeDescription *sm_desc;
996 struct berval sm_type;
998 #define sm_bvalues sm_values
1000 BerVarray sm_nvalues;
1004 typedef struct slap_mod_list {
1005 Modification sml_mod;
1006 #define sml_op sml_mod.sm_op
1007 #define sml_desc sml_mod.sm_desc
1008 #define sml_type sml_mod.sm_type
1009 #define sml_bvalues sml_mod.sm_values
1010 #define sml_values sml_mod.sm_values
1011 #define sml_nvalues sml_mod.sm_nvalues
1012 struct slap_mod_list *sml_next;
1015 typedef struct slap_ldap_modlist {
1017 struct slap_ldap_modlist *ml_next;
1018 #define ml_op ml_mod.mod_op
1019 #define ml_type ml_mod.mod_type
1020 #define ml_values ml_mod.mod_values
1021 #define ml_bvalues ml_mod.mod_values
1025 * represents an access control list
1027 typedef enum slap_access_e {
1028 ACL_INVALID_ACCESS = -1,
1037 typedef enum slap_control_e {
1038 ACL_INVALID_CONTROL = 0,
1044 typedef enum slap_style_e {
1045 ACL_STYLE_REGEX = 0,
1052 /* alternate names */
1053 ACL_STYLE_EXACT = ACL_STYLE_BASE
1056 typedef struct slap_authz_info {
1057 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1058 struct berval sai_mech; /* SASL Mechanism */
1059 struct berval sai_dn; /* DN for reporting purposes */
1060 struct berval sai_ndn; /* Normalized DN */
1062 /* Security Strength Factors */
1063 slap_ssf_t sai_ssf; /* Overall SSF */
1064 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1065 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1066 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1067 } AuthorizationInformation;
1070 typedef struct slap_access {
1071 slap_control_t a_type;
1073 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1075 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1076 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1077 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1078 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1079 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1080 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1082 #define ACL_PRIV_MASK 0x00ffUL
1085 #define ACL_PRIV_LEVEL 0x1000UL
1086 #define ACL_PRIV_ADDITIVE 0x2000UL
1087 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1090 #define ACL_PRIV_INVALID 0x0UL
1092 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1093 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1094 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1095 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1097 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1098 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1100 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1102 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1104 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1105 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1106 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1108 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1109 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1110 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1111 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1112 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1113 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1115 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1116 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1117 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1118 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1119 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1120 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1121 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1123 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1124 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1125 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1126 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1127 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1128 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1130 slap_mask_t a_access_mask;
1132 AuthorizationInformation a_authz;
1133 #define a_dn_pat a_authz.sai_dn
1135 slap_style_t a_dn_style;
1136 AttributeDescription *a_dn_at;
1140 slap_style_t a_peername_style;
1141 struct berval a_peername_pat;
1142 slap_style_t a_sockname_style;
1143 struct berval a_sockname_pat;
1145 slap_style_t a_domain_style;
1146 struct berval a_domain_pat;
1147 int a_domain_expand;
1149 slap_style_t a_sockurl_style;
1150 struct berval a_sockurl_pat;
1151 slap_style_t a_set_style;
1152 struct berval a_set_pat;
1154 #ifdef SLAPD_ACI_ENABLED
1155 AttributeDescription *a_aci_at;
1159 slap_style_t a_group_style;
1160 struct berval a_group_pat;
1161 ObjectClass *a_group_oc;
1162 AttributeDescription *a_group_at;
1164 struct slap_access *a_next;
1168 typedef struct slap_acl {
1169 /* "to" part: the entries this acl applies to */
1171 slap_style_t acl_dn_style;
1173 struct berval acl_dn_pat;
1174 AttributeName *acl_attrs;
1176 /* "by" part: list of who has what access to the entries */
1179 struct slap_acl *acl_next;
1182 typedef struct slap_acl_state {
1183 unsigned as_recorded;
1184 #define ACL_STATE_NOT_RECORDED 0x0
1185 #define ACL_STATE_RECORDED_VD 0x1
1186 #define ACL_STATE_RECORDED_NV 0x2
1187 #define ACL_STATE_RECORDED 0x3
1190 AccessControl *as_vd_acl;
1191 AccessControl *as_vi_acl;
1192 slap_mask_t as_vd_acl_mask;
1193 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1194 int as_vd_acl_count;
1196 Access *as_vd_access;
1197 int as_vd_access_count;
1200 AttributeDescription *as_vd_ad;
1201 } AccessControlState;
1202 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1203 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1206 * replog moddn param structure
1208 struct slap_replog_moddn {
1209 struct berval *newrdn;
1211 struct berval *newsup;
1216 * represents a backend
1219 typedef struct slap_backend_info BackendInfo; /* per backend type */
1220 typedef struct slap_backend_db BackendDB; /* per backend database */
1222 LDAP_SLAPD_V (int) nBackendInfo;
1223 LDAP_SLAPD_V (int) nBackendDB;
1224 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1225 LDAP_SLAPD_V (BackendDB *) backendDB;
1227 LDAP_SLAPD_V (int) slapMode;
1228 #define SLAP_UNDEFINED_MODE 0x0000
1229 #define SLAP_SERVER_MODE 0x0001
1230 #define SLAP_TOOL_MODE 0x0002
1231 #define SLAP_MODE 0x0003
1233 #define SLAP_TRUNCATE_MODE 0x0100
1235 struct slap_replica_info {
1236 char *ri_host; /* supersedes be_replica */
1237 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1238 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1239 int ri_exclude; /* 1 => exclude ri_attrs */
1242 struct slap_limits_set {
1250 int lms_s_unchecked;
1255 struct slap_limits {
1256 int lm_type; /* type of pattern */
1257 #define SLAP_LIMITS_UNDEFINED 0x0000
1258 #define SLAP_LIMITS_EXACT 0x0001
1259 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1260 #define SLAP_LIMITS_ONE 0x0002
1261 #define SLAP_LIMITS_SUBTREE 0x0003
1262 #define SLAP_LIMITS_CHILDREN 0x0004
1263 #define SLAP_LIMITS_REGEX 0x0005
1264 #define SLAP_LIMITS_ANONYMOUS 0x0006
1265 #define SLAP_LIMITS_USERS 0x0007
1266 #define SLAP_LIMITS_ANY 0x0008
1267 regex_t lm_dn_regex; /* regex data for REGEX */
1270 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1271 * pattern for REGEX; NULL for ANONYMOUS, USERS
1273 struct berval lm_dn_pat;
1275 struct slap_limits_set lm_limits;
1278 /* temporary aliases */
1279 typedef BackendDB Backend;
1280 #define nbackends nBackendDB
1281 #define backends backendDB
1283 struct slap_backend_db {
1284 BackendInfo *bd_info; /* pointer to shared backend info */
1286 /* BackendInfo accessors */
1287 #define be_config bd_info->bi_db_config
1288 #define be_type bd_info->bi_type
1290 #define be_bind bd_info->bi_op_bind
1291 #define be_unbind bd_info->bi_op_unbind
1292 #define be_add bd_info->bi_op_add
1293 #define be_compare bd_info->bi_op_compare
1294 #define be_delete bd_info->bi_op_delete
1295 #define be_modify bd_info->bi_op_modify
1296 #define be_modrdn bd_info->bi_op_modrdn
1297 #define be_search bd_info->bi_op_search
1298 #define be_abandon bd_info->bi_op_abandon
1299 #define be_cancel bd_info->bi_op_cancel
1301 #define be_extended bd_info->bi_extended
1303 #define be_release bd_info->bi_entry_release_rw
1304 #define be_chk_referrals bd_info->bi_chk_referrals
1305 #define be_group bd_info->bi_acl_group
1306 #define be_attribute bd_info->bi_acl_attribute
1307 #define be_operational bd_info->bi_operational
1310 * define to honor hasSubordinates operational attribute in search filters
1311 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1314 #define be_has_subordinates bd_info->bi_has_subordinates
1316 #define be_controls bd_info->bi_controls
1318 #define be_connection_init bd_info->bi_connection_init
1319 #define be_connection_destroy bd_info->bi_connection_destroy
1322 #define be_entry_open bd_info->bi_tool_entry_open
1323 #define be_entry_close bd_info->bi_tool_entry_close
1324 #define be_entry_first bd_info->bi_tool_entry_first
1325 #define be_entry_next bd_info->bi_tool_entry_next
1326 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1327 #define be_entry_get bd_info->bi_tool_entry_get
1328 #define be_entry_put bd_info->bi_tool_entry_put
1329 #define be_sync bd_info->bi_tool_sync
1332 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1333 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1334 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1335 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1336 #define SLAP_BFLAG_ALIASES 0x0100U
1337 #define SLAP_BFLAG_REFERRALS 0x0200U
1338 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1339 #define SLAP_BFLAG_MONITOR 0x1000U
1340 #define SLAP_BFLAG_DYNAMIC 0x2000U
1341 slap_mask_t be_flags;
1342 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1343 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1344 #define SLAP_GLUE_SUBORDINATE(be) \
1345 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1346 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1347 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1348 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1349 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1350 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1351 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1353 slap_mask_t be_restrictops; /* restriction operations */
1354 #define SLAP_RESTRICT_OP_ADD 0x0001U
1355 #define SLAP_RESTRICT_OP_BIND 0x0002U
1356 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1357 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1358 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1359 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1360 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1361 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1363 #define SLAP_RESTRICT_OP_READS \
1364 ( SLAP_RESTRICT_OP_COMPARE \
1365 | SLAP_RESTRICT_OP_SEARCH )
1366 #define SLAP_RESTRICT_OP_WRITES \
1367 ( SLAP_RESTRICT_OP_ADD \
1368 | SLAP_RESTRICT_OP_DELETE \
1369 | SLAP_RESTRICT_OP_MODIFY \
1370 | SLAP_RESTRICT_OP_RENAME )
1372 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1373 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1374 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1376 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1378 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1379 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1380 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1381 0x0004U /* unprotected simple auth */
1382 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1384 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1385 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1387 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1389 slap_mask_t be_requires; /* pre-operation requirements */
1390 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1391 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1392 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1393 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1394 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1396 /* Required Security Strength Factor */
1397 slap_ssf_set_t be_ssf_set;
1399 /* these should be renamed from be_ to bd_ */
1400 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1401 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1402 struct berval be_schemadn; /* per-backend subschema subentry DN */
1403 struct berval be_schemandn; /* normalized subschema DN */
1404 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1405 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1406 struct berval be_rootpw; /* the magic "root" password for this db */
1407 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1408 #define be_sizelimit be_def_limit.lms_s_soft
1409 #define be_timelimit be_def_limit.lms_t_soft
1410 struct slap_limits_set be_def_limit; /* default limits */
1411 struct slap_limits **be_limits; /* regex-based size and time limits */
1412 AccessControl *be_acl; /* access control list for this backend */
1413 slap_access_t be_dfltaccess; /* access given if no acl matches */
1414 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1415 char *be_replogfile; /* replication log file (in master) */
1416 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1417 BerVarray be_update_refs; /* where to refer modifying clients to */
1419 void *be_private; /* anything the backend database needs */
1421 void *be_pb; /* Netscape plugin */
1427 /* Backend function typedefs */
1428 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1429 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1430 const char *fname, int lineno,
1431 int argc, char **argv));
1432 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1433 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1434 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1436 typedef int (BI_db_init) LDAP_P((Backend *bd));
1437 typedef int (BI_db_config) LDAP_P((Backend *bd,
1438 const char *fname, int lineno,
1439 int argc, char **argv));
1440 typedef int (BI_db_open) LDAP_P((Backend *bd));
1441 typedef int (BI_db_close) LDAP_P((Backend *bd));
1442 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1444 #ifdef SLAP_OP_BLOCKS
1445 typedef struct req_bind_s {
1447 struct berval rb_cred;
1448 struct berval rb_edn;
1451 typedef struct req_search_s {
1457 AttributeName *rs_attrs;
1459 struct berval rs_filterstr;
1462 typedef struct req_compare_s {
1463 AttributeAssertion *rs_ava;
1466 typedef struct req_modrdn_s {
1467 struct berval rs_newrdn;
1468 struct berval rs_nnewrdn;
1469 struct berval rs_newSup;
1470 struct berval rs_nnewSup;
1471 int rs_deleteoldrdn;
1474 typedef struct req_add_s {
1478 typedef struct req_abandon_s {
1482 typedef struct req_extended_s {
1483 struct berval rs_reqoid;
1485 struct berval *rs_rspdata;
1486 LDAPControl **rs_rspctrls;
1487 const char *rs_text;
1490 #endif /* SLAP_OP_BLOCKS */
1492 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1493 struct slap_conn *c, struct slap_op *o,
1494 struct berval *dn, struct berval *ndn, int method,
1495 struct berval *cred, struct berval *edn ));
1496 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1497 struct slap_conn *c, struct slap_op *o ));
1498 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1499 struct slap_conn *c, struct slap_op *o,
1500 struct berval *base, struct berval *nbase,
1501 int scope, int deref,
1502 int slimit, int tlimit,
1503 Filter *f, struct berval *filterstr,
1504 AttributeName *attrs, int attrsonly));
1505 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1506 struct slap_conn *c, struct slap_op *o,
1507 struct berval *dn, struct berval *ndn,
1508 AttributeAssertion *ava));
1509 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1510 struct slap_conn *c, struct slap_op *o,
1511 struct berval *dn, struct berval *ndn,
1513 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1514 struct slap_conn *c, struct slap_op *o,
1515 struct berval *dn, struct berval *ndn,
1516 struct berval *newrdn, struct berval *nnewrdn,
1518 struct berval *newSup, struct berval *nnewSup ));
1519 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1520 struct slap_conn *c, struct slap_op *o,
1522 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1523 struct slap_conn *c, struct slap_op *o,
1524 struct berval *dn, struct berval *ndn));
1525 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1526 struct slap_conn *c, struct slap_op *o,
1528 typedef int (BI_op_cancel) LDAP_P((BackendDB *bd,
1529 struct slap_conn *c, struct slap_op *o,
1532 typedef int (BI_op_extended) LDAP_P((
1534 struct slap_conn *conn,
1536 struct berval *reqoid,
1537 struct berval * reqdata,
1539 struct berval ** rspdata,
1540 LDAPControl *** rspctrls,
1544 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1545 struct slap_conn *c, struct slap_op *o,
1548 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1549 struct slap_conn *c, struct slap_op *o,
1550 struct berval *dn, struct berval *ndn,
1551 const char **text ));
1553 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1554 struct slap_conn *c, struct slap_op *o,
1558 ObjectClass *group_oc,
1559 AttributeDescription *group_at ));
1561 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1562 struct slap_conn *c, struct slap_op *o,
1563 Entry *e, struct berval *edn,
1564 AttributeDescription *entry_at,
1567 typedef int (BI_operational) LDAP_P((Backend *bd,
1568 struct slap_conn *c, struct slap_op *o,
1569 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1571 typedef int (BI_has_subordinates) LDAP_P((Backend *bd,
1572 struct slap_conn *c, struct slap_op *o,
1573 Entry *e, int *has_subordinates ));
1575 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1576 struct slap_conn *c));
1577 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1578 struct slap_conn *c));
1580 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1581 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1582 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1583 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1584 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1585 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1586 struct berval *text ));
1587 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1588 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1590 struct slap_backend_info {
1591 char *bi_type; /* type of backend */
1594 * per backend type routines:
1595 * bi_init: called to allocate a backend_info structure,
1596 * called once BEFORE configuration file is read.
1597 * bi_init() initializes this structure hence is
1598 * called directly from be_initialize()
1599 * bi_config: called per 'backend' specific option
1600 * all such options must before any 'database' options
1601 * bi_config() is called only from read_config()
1602 * bi_open: called to open each database, called
1603 * once AFTER configuration file is read but
1604 * BEFORE any bi_db_open() calls.
1605 * bi_open() is called from backend_startup()
1606 * bi_close: called to close each database, called
1607 * once during shutdown after all bi_db_close calls.
1608 * bi_close() is called from backend_shutdown()
1609 * bi_destroy: called to destroy each database, called
1610 * once during shutdown after all bi_db_destroy calls.
1611 * bi_destory() is called from backend_destroy()
1614 BI_config *bi_config;
1617 BI_destroy *bi_destroy;
1620 * per database routines:
1621 * bi_db_init: called to initialize each database,
1622 * called upon reading 'database <type>'
1623 * called only from backend_db_init()
1624 * bi_db_config: called to configure each database,
1625 * called per database to handle per database options
1626 * called only from read_config()
1627 * bi_db_open: called to open each database
1628 * called once per database immediately AFTER bi_open()
1629 * calls but before daemon startup.
1630 * called only by backend_startup()
1631 * bi_db_close: called to close each database
1632 * called once per database during shutdown but BEFORE
1633 * any bi_close call.
1634 * called only by backend_shutdown()
1635 * bi_db_destroy: called to destroy each database
1636 * called once per database during shutdown AFTER all
1637 * bi_close calls but before bi_destory calls.
1638 * called only by backend_destory()
1640 BI_db_init *bi_db_init;
1641 BI_db_config *bi_db_config;
1642 BI_db_open *bi_db_open;
1643 BI_db_close *bi_db_close;
1644 BI_db_destroy *bi_db_destroy;
1646 /* LDAP Operations Handling Routines */
1647 BI_op_bind *bi_op_bind;
1648 BI_op_unbind *bi_op_unbind;
1649 BI_op_search *bi_op_search;
1650 BI_op_compare *bi_op_compare;
1651 BI_op_modify *bi_op_modify;
1652 BI_op_modrdn *bi_op_modrdn;
1653 BI_op_add *bi_op_add;
1654 BI_op_delete *bi_op_delete;
1655 BI_op_abandon *bi_op_abandon;
1656 BI_op_cancel *bi_op_cancel;
1658 /* Extended Operations Helper */
1659 BI_op_extended *bi_extended;
1661 /* Auxilary Functions */
1662 BI_entry_release_rw *bi_entry_release_rw;
1663 BI_chk_referrals *bi_chk_referrals;
1665 BI_acl_group *bi_acl_group;
1666 BI_acl_attribute *bi_acl_attribute;
1668 BI_operational *bi_operational;
1669 BI_has_subordinates *bi_has_subordinates;
1671 BI_connection_init *bi_connection_init;
1672 BI_connection_destroy *bi_connection_destroy;
1674 /* hooks for slap tools */
1675 BI_tool_entry_open *bi_tool_entry_open;
1676 BI_tool_entry_close *bi_tool_entry_close;
1677 BI_tool_entry_first *bi_tool_entry_first;
1678 BI_tool_entry_next *bi_tool_entry_next;
1679 BI_tool_entry_get *bi_tool_entry_get;
1680 BI_tool_entry_put *bi_tool_entry_put;
1681 BI_tool_entry_reindex *bi_tool_entry_reindex;
1682 BI_tool_sync *bi_tool_sync;
1684 #define SLAP_INDEX_ADD_OP 0x0001
1685 #define SLAP_INDEX_DELETE_OP 0x0002
1687 char **bi_controls; /* supported controls */
1689 unsigned int bi_nDB; /* number of databases of this type */
1690 void *bi_private; /* anything the backend type needs */
1693 #define c_authtype c_authz.sai_method
1694 #define c_authmech c_authz.sai_mech
1695 #define c_dn c_authz.sai_dn
1696 #define c_ndn c_authz.sai_ndn
1697 #define c_ssf c_authz.sai_ssf
1698 #define c_transport_ssf c_authz.sai_transport_ssf
1699 #define c_tls_ssf c_authz.sai_tls_ssf
1700 #define c_sasl_ssf c_authz.sai_sasl_ssf
1702 #define o_authtype o_authz.sai_method
1703 #define o_authmech o_authz.sai_mech
1704 #define o_dn o_authz.sai_dn
1705 #define o_ndn o_authz.sai_ndn
1706 #define o_ssf o_authz.sai_ssf
1707 #define o_transport_ssf o_authz.sai_transport_ssf
1708 #define o_tls_ssf o_authz.sai_tls_ssf
1709 #define o_sasl_ssf o_authz.sai_sasl_ssf
1711 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1712 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1713 BerVarray, const char *, struct berval *,
1714 struct berval *, LDAPControl ** );
1716 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1717 ber_int_t, const char *, const char *, BerVarray,
1718 LDAPControl **, int nentries);
1720 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1721 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1723 typedef int (slap_sendreference)( BackendDB *, struct slap_conn *,
1724 struct slap_op *, Entry *, BerVarray, LDAPControl **, BerVarray * );
1726 typedef struct slap_callback {
1727 slap_response *sc_response;
1728 slap_sresult *sc_sresult;
1729 slap_sendentry *sc_sendentry;
1730 slap_sendreference *sc_sendreference;
1735 * Paged Results state
1737 typedef unsigned long PagedResultsCookie;
1738 typedef struct slap_paged_state {
1740 PagedResultsCookie ps_cookie;
1742 } PagedResultsState;
1745 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1746 #define LDAP_PSEARCH_BY_ADD 0x01
1747 #define LDAP_PSEARCH_BY_DELETE 0x02
1748 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1749 #define LDAP_PSEARCH_BY_MODIFY 0x04
1750 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1752 struct ldap_psearch_spec {
1754 struct berval *base;
1755 struct berval *nbase;
1761 struct berval *filterstr;
1762 AttributeName *attrs;
1766 LDAP_LIST_ENTRY(ldap_psearch_spec) link;
1770 struct ldap_psearch_spec* ps;
1771 LDAP_LIST_ENTRY(psid_entry) link;
1777 * represents an operation pending from an ldap client
1779 typedef struct slap_op {
1780 unsigned long o_opid; /* id of this operation */
1781 unsigned long o_connid; /* id of conn initiating this op */
1782 struct slap_conn *o_conn; /* connection spawning this op */
1783 #ifdef SLAP_OP_BLOCKS
1784 BackendDB *o_bd; /* backend DB processing this op */
1787 ber_int_t o_msgid; /* msgid of the request */
1788 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1789 ber_tag_t o_tag; /* tag of the request */
1790 time_t o_time; /* time op was initiated */
1792 #ifdef SLAP_OP_BLOCKS
1793 struct berval o_req_dn; /* DN of target of request */
1794 struct berval o_req_ndn;
1798 req_search_s or_search;
1799 req_compare_s or_compare;
1800 req_modrdn_s or_modrdn;
1802 req_abandon_s or_abandon;
1803 req_abandon_s or_cancel;
1804 req_extended_s or_extended;
1807 /* short hands for union members */
1808 #define o_bind o_request.or_bind
1811 /* short hands for inner request members */
1812 #define o_bind_edn o_bind.rb_edn
1816 char * o_extendedop; /* extended operation OID */
1819 ldap_pvt_thread_t o_tid; /* thread handling this op */
1821 volatile sig_atomic_t o_abandon; /* abandon flag */
1822 volatile sig_atomic_t o_cancel; /* cancel flag */
1823 #define SLAP_CANCEL_NONE 0x00
1824 #define SLAP_CANCEL_REQ 0x01
1825 #define SLAP_CANCEL_ACK 0x02
1826 #define SLAP_CANCEL_DONE 0x03
1828 char o_do_not_cache; /* don't cache from this op */
1829 char o_is_auth_check; /* authorization in progress */
1831 #define SLAP_NO_CONTROL 0
1832 #define SLAP_NONCRITICAL_CONTROL 1
1833 #define SLAP_CRITICAL_CONTROL 2
1835 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1841 #define get_subentries(op) ((int)(op)->o_subentries)
1842 char o_subentries_visibility;
1843 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1845 char o_valuesreturnfilter;
1847 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1848 char o_permissive_modify;
1849 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1851 #define get_permissiveModify(op) (0)
1854 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1855 char o_domain_scope;
1856 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1858 #define get_domainScope(op) (0)
1861 #ifdef LDAP_CONTROL_PAGEDRESULTS
1862 char o_pagedresults;
1863 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1864 ber_int_t o_pagedresults_size;
1865 PagedResultsState o_pagedresults_state;
1867 #define get_pagedresults(op) (0)
1870 #ifdef LDAP_CLIENT_UPDATE
1871 char o_clientupdate;
1872 char o_clientupdate_type;
1873 #define SLAP_LCUP_NONE (0x0)
1874 #define SLAP_LCUP_SYNC (0x1)
1875 #define SLAP_LCUP_PERSIST (0x2)
1876 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1877 ber_int_t o_clientupdate_interval;
1878 struct berval o_clientupdate_state;
1884 #define SLAP_SYNC_NONE (0x0)
1885 #define SLAP_SYNC_REFRESH (0x1)
1886 #define SLAP_SYNC_PERSIST (0x2)
1887 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1888 struct berval o_sync_state;
1891 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1892 LDAP_LIST_HEAD(lss, ldap_psearch_spec) psearch_spec;
1893 LDAP_LIST_HEAD(pe, psid_entry) premodify_list;
1894 LDAP_LIST_ENTRY(slap_op) link;
1897 AuthorizationInformation o_authz;
1899 BerElement *o_ber; /* ber of the request */
1900 #ifdef LDAP_CONNECTIONLESS
1901 BerElement *o_res_ber; /* ber of the reply */
1903 slap_callback *o_callback; /* callback pointers */
1904 LDAPControl **o_ctrls; /* controls */
1906 void *o_threadctx; /* thread pool thread context */
1907 void *o_private; /* anything the backend needs */
1909 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1910 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1914 #endif /*LDAP_CACHING */
1917 void *o_pb; /* NS-SLAPI plugin */
1921 typedef void (*SEND_LDAP_RESULT)(
1922 struct slap_conn *conn,
1925 const char *matched,
1931 #define send_ldap_result( conn, op, err, matched, text, ref, ctrls ) \
1932 (*conn->c_send_ldap_result)( conn, op, err, matched, text, ref, ctrls )
1935 typedef int (*SEND_SEARCH_ENTRY)(
1936 struct slap_backend_db *be,
1937 struct slap_conn *conn,
1939 struct slap_entry *e,
1940 AttributeName *attrs,
1945 #define send_search_entry( be, conn, op, e, attrs, attrsonly, ctrls) \
1946 (*conn->c_send_search_entry)( be, conn, op, e, attrs, attrsonly, ctrls)
1949 typedef void (*SEND_SEARCH_RESULT)(
1950 struct slap_conn *conn,
1953 const char *matched,
1956 LDAPControl **ctrls,
1960 #define send_search_result( conn, op, err, matched, text, refs, ctrls, nentries ) \
1961 (*conn->c_send_search_result)( conn, op, err, matched, text, refs, ctrls, nentries )
1964 typedef int (*SEND_SEARCH_REFERENCE)(
1965 struct slap_backend_db *be,
1966 struct slap_conn *conn,
1968 struct slap_entry *e,
1970 LDAPControl **ctrls,
1974 #define send_search_reference( be, conn, op, e, refs, ctrls, v2refs ) \
1975 (*conn->c_send_search_reference)( be, conn, op, e, refs, ctrls, v2refs )
1978 typedef void (*SEND_LDAP_EXTENDED)(
1979 struct slap_conn *conn,
1982 const char *matched,
1986 struct berval *rspdata,
1990 #define send_ldap_extended( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls) \
1991 (*conn->c_send_ldap_extended)( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls )
1993 typedef void (*SEND_LDAP_INTERMEDIATE_RESP)(
1994 struct slap_conn *conn,
1997 const char *matched,
2001 struct berval *rspdata,
2005 #define send_ldap_intermediate_resp( conn, op, err, matched, text, refs, \
2006 rspoid, rspdata, ctrls) \
2007 (*conn->c_send_ldap_intermediate_resp)( conn, op, err, matched, text, \
2008 refs, rspoid, rspdata, ctrls )
2011 * Caches the result of a backend_group check for ACL evaluation
2013 typedef struct slap_gacl {
2014 struct slap_gacl *ga_next;
2017 AttributeDescription *ga_at;
2023 typedef struct slap_listener Listener;
2026 * represents a connection from an ldap client
2028 typedef struct slap_conn {
2029 int c_struct_state; /* structure management state */
2030 int c_conn_state; /* connection state */
2032 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2033 Sockbuf *c_sb; /* ber connection stuff */
2035 /* only can be changed by connect_init */
2036 time_t c_starttime; /* when the connection was opened */
2037 time_t c_activitytime; /* when the connection was last used */
2038 unsigned long c_connid; /* id of this connection for stats*/
2040 struct berval c_peer_domain; /* DNS name of client */
2041 struct berval c_peer_name; /* peer name (trans=addr:port) */
2042 Listener *c_listener;
2043 #define c_listener_url c_listener->sl_url /* listener URL */
2044 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2046 /* only can be changed by binding thread */
2047 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2048 struct berval c_sasl_bind_mech; /* mech in progress */
2049 struct berval c_sasl_dn; /* temporary storage */
2051 /* authorization backend */
2052 Backend *c_authz_backend;
2054 AuthorizationInformation c_authz;
2055 GroupAssertion *c_groups;
2057 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2059 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2060 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2062 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2063 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2065 BerElement *c_currentber; /* ber we're attempting to read */
2066 int c_writewaiter; /* true if writer is waiting */
2068 #ifdef LDAP_CONNECTIONLESS
2069 int c_is_udp; /* true if this is (C)LDAP over UDP */
2072 int c_is_tls; /* true if this LDAP over raw TLS */
2073 int c_needs_tls_accept; /* true if SSL_accept should be called */
2075 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2076 void *c_sasl_context; /* SASL session context */
2077 void *c_sasl_extra; /* SASL session extra stuff */
2078 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2080 PagedResultsState c_pagedresults_state; /* paged result state */
2082 long c_n_ops_received; /* num of ops received (next op_id) */
2083 long c_n_ops_executing; /* num of ops currently executing */
2084 long c_n_ops_pending; /* num of ops pending execution */
2085 long c_n_ops_completed; /* num of ops completed */
2087 long c_n_get; /* num of get calls */
2088 long c_n_read; /* num of read calls */
2089 long c_n_write; /* num of write calls */
2091 void *c_pb; /* Netscape plugin */
2094 * These are the "callbacks" that are available for back-ends to
2095 * supply data back to connected clients that are connected
2096 * through the "front-end".
2098 SEND_LDAP_RESULT c_send_ldap_result;
2099 SEND_SEARCH_ENTRY c_send_search_entry;
2100 SEND_SEARCH_RESULT c_send_search_result;
2101 SEND_SEARCH_REFERENCE c_send_search_reference;
2102 SEND_LDAP_EXTENDED c_send_ldap_extended;
2103 #ifdef LDAP_RES_INTERMEDIATE_RESP
2104 SEND_LDAP_INTERMEDIATE_RESP c_send_ldap_intermediate_resp;
2109 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2110 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2112 if ( ldap_debug & (level) ) \
2113 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2114 if ( ldap_syslog & (level) ) \
2115 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2118 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2119 #elif defined(LDAP_DEBUG)
2120 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2122 if ( ldap_debug & (level) ) \
2123 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2125 #define StatslogTest( level ) (ldap_debug & (level))
2127 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2128 #define StatslogTest( level ) (0)
2132 * listener; need to access it from monitor backend
2134 struct slap_listener {
2135 struct berval sl_url;
2136 struct berval sl_name;
2141 #ifdef LDAP_CONNECTIONLESS
2142 int sl_is_udp; /* UDP listener is also data port */
2146 #define sl_addr sl_sa.sa_in_addr
2149 #ifdef SLAPD_MONITOR
2166 #endif /* SLAPD_MONITOR */
2169 * Better know these all around slapd
2171 #define SLAP_LDAPDN_PRETTY 0x1
2172 #define SLAP_LDAPDN_MAXLEN 8192
2177 #ifdef LDAP_CLIENT_UPDATE
2178 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2179 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2180 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2181 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2182 #endif /* LDAP_CLIENT_UPDATE */
2184 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2185 #define SLAP_SEARCH_MAX_CTRLS 10
2188 #define SLAP_CTRL_FRONTEND 0x80000000U
2189 #define SLAP_CTRL_FRONTEND_SEARCH 0x01000000U /* for NOOP */
2191 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2192 #define SLAP_CTRL_ABANDON 0x00000001U
2193 #define SLAP_CTRL_ADD 0x00002002U
2194 #define SLAP_CTRL_BIND 0x00000004U
2195 #define SLAP_CTRL_COMPARE 0x00001008U
2196 #define SLAP_CTRL_DELETE 0x00002010U
2197 #define SLAP_CTRL_MODIFY 0x00002020U
2198 #define SLAP_CTRL_RENAME 0x00002040U
2199 #define SLAP_CTRL_SEARCH 0x00001080U
2200 #define SLAP_CTRL_UNBIND 0x00000100U
2202 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2203 #define SLAP_CTRL_UPDATE \
2204 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2205 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2207 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2211 const char **text ));
2215 #include "proto-slap.h"
2217 #endif /* _SLAP_H_ */