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_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_CONN_MAX_PENDING_DEFAULT 100
84 #define SLAP_CONN_MAX_PENDING_AUTH 1000
86 #define SLAP_TEXT_BUFLEN (256)
88 /* psuedo error code indicating abandoned operation */
89 #define SLAPD_ABANDON (-1)
91 /* psuedo error code indicating disconnect */
92 #define SLAPD_DISCONNECT (-2)
95 /* We assume "C" locale, that is US-ASCII */
96 #define ASCII_SPACE(c) ( (c) == ' ' )
97 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
98 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
99 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
100 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
101 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
102 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
104 #define SLAP_NIBBLE(c) ((c)&0x0f)
105 #define SLAP_ESCAPE_CHAR ('\\')
106 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
107 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
109 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
110 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
112 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
113 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
114 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
115 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
116 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
118 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
119 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
120 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
121 #define OID_SEPARATOR(c) ( (c) == '.' )
122 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
124 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
125 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
127 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
128 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
130 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
132 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
133 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
134 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
135 (c) == '?' || (c) == ' ' || (c) == '=' )
136 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
138 /* must match in schema_init.c */
139 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
140 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
141 #define SLAPD_GROUP_ATTR "member"
142 #define SLAPD_GROUP_CLASS "groupOfNames"
143 #define SLAPD_ROLE_ATTR "roleOccupant"
144 #define SLAPD_ROLE_CLASS "organizationalRole"
146 #ifdef SLAPD_ACI_ENABLED
147 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
150 /* change this to "OpenLDAPset" */
151 #define SLAPD_ACI_SET_ATTR "template"
153 #define SLAPD_TOP_OID "2.5.6.0"
155 LDAP_SLAPD_V (int) slap_debug;
157 typedef unsigned long slap_mask_t;
159 /* Security Strength Factor */
160 typedef unsigned slap_ssf_t;
162 typedef struct slap_ssf_set {
164 slap_ssf_t sss_transport;
167 slap_ssf_t sss_update_ssf;
168 slap_ssf_t sss_update_transport;
169 slap_ssf_t sss_update_tls;
170 slap_ssf_t sss_update_sasl;
171 slap_ssf_t sss_simple_bind;
174 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
175 #define SLAP_GETDN_AUTHCID 2
176 #define SLAP_GETDN_AUTHZID 4
181 #define SLAP_INDEX_TYPE 0x00FFUL
182 #define SLAP_INDEX_UNDEFINED 0x0001UL
183 #define SLAP_INDEX_PRESENT 0x0002UL
184 #define SLAP_INDEX_EQUALITY 0x0004UL
185 #define SLAP_INDEX_APPROX 0x0008UL
186 #define SLAP_INDEX_SUBSTR 0x0010UL
187 #define SLAP_INDEX_EXTENDED 0x0020UL
189 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
191 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
193 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
195 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
196 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
197 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
198 #define SLAP_INDEX_SUBSTR_DEFAULT \
199 ( SLAP_INDEX_SUBSTR \
200 | SLAP_INDEX_SUBSTR_INITIAL \
201 | SLAP_INDEX_SUBSTR_ANY \
202 | SLAP_INDEX_SUBSTR_FINAL )
204 #define SLAP_INDEX_SUBSTR_MINLEN 2
205 #define SLAP_INDEX_SUBSTR_MAXLEN 4
206 #define SLAP_INDEX_SUBSTR_STEP 2
208 #define SLAP_INDEX_FLAGS 0xF000UL
209 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
210 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
213 * there is a single index for each attribute. these prefixes ensure
214 * that there is no collision among keys.
216 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
217 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
218 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
219 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
220 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
221 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
223 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
224 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
225 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
226 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
227 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
229 #ifdef LDAP_CLIENT_UPDATE
230 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
231 #endif /* LDAP_CLIENT_UPDATE */
234 * represents schema information for a database
236 #define SLAP_SCHERR_OUTOFMEM 1
237 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
238 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
239 #define SLAP_SCHERR_CLASS_BAD_SUP 4
240 #define SLAP_SCHERR_CLASS_DUP 5
241 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
242 #define SLAP_SCHERR_ATTR_BAD_MR 7
243 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
244 #define SLAP_SCHERR_ATTR_BAD_SUP 9
245 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
246 #define SLAP_SCHERR_ATTR_DUP 11
247 #define SLAP_SCHERR_MR_NOT_FOUND 12
248 #define SLAP_SCHERR_MR_INCOMPLETE 13
249 #define SLAP_SCHERR_MR_DUP 14
250 #define SLAP_SCHERR_SYN_NOT_FOUND 15
251 #define SLAP_SCHERR_SYN_DUP 16
252 #define SLAP_SCHERR_NO_NAME 17
253 #define SLAP_SCHERR_NOT_SUPPORTED 18
254 #define SLAP_SCHERR_BAD_DESCR 19
255 #define SLAP_SCHERR_OIDM 20
256 #define SLAP_SCHERR_CR_DUP 21
257 #define SLAP_SCHERR_CR_BAD_STRUCT 22
258 #define SLAP_SCHERR_CR_BAD_AUX 23
259 #define SLAP_SCHERR_CR_BAD_AT 24
260 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
262 typedef union slap_sockaddr {
263 struct sockaddr sa_addr;
264 struct sockaddr_in sa_in_addr;
266 struct sockaddr_storage sa_storage;
267 struct sockaddr_in6 sa_in6_addr;
270 struct sockaddr_un sa_un_addr;
275 extern int slap_inet4or6;
278 typedef struct slap_oid_macro {
279 struct berval som_oid;
281 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
284 /* forward declarations */
286 struct slap_matching_rule;
288 typedef int slap_syntax_validate_func LDAP_P((
289 struct slap_syntax *syntax,
290 struct berval * in));
292 typedef int slap_syntax_transform_func LDAP_P((
293 struct slap_syntax *syntax,
298 typedef struct slap_syntax {
300 #define ssyn_oid ssyn_syn.syn_oid
301 #define ssyn_desc ssyn_syn.syn_desc
302 #define ssyn_extensions ssyn_syn.syn_extensions
305 ber_len_t ssyn_oidlen;
306 * has been replaced by a struct berval that uses the value
307 * provided by ssyn_syn.syn_oid; a macro that expands to
308 * the bv_len field of the berval is provided for backward
309 * compatibility. CAUTION: NEVER FREE THE BERVAL
311 struct berval ssyn_bvoid;
312 #define ssyn_oidlen ssyn_bvoid.bv_len
314 unsigned int ssyn_flags;
316 #define SLAP_SYNTAX_NONE 0x0000U
317 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
318 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
319 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
320 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
322 slap_syntax_validate_func *ssyn_validate;
323 slap_syntax_transform_func *ssyn_pretty;
325 #ifdef SLAPD_BINARY_CONVERSION
326 /* convert to and from binary */
327 slap_syntax_transform_func *ssyn_ber2str;
328 slap_syntax_transform_func *ssyn_str2ber;
331 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
334 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
335 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
336 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
337 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
338 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
340 typedef struct slap_syntax_defs_rec {
343 slap_syntax_validate_func *sd_validate;
344 slap_syntax_transform_func *sd_pretty;
345 #ifdef SLAPD_BINARY_CONVERSION
346 slap_syntax_transform_func *sd_ber2str;
347 slap_syntax_transform_func *sd_str2ber;
349 } slap_syntax_defs_rec;
351 /* X -> Y Converter */
352 typedef int slap_mr_convert_func LDAP_P((
358 typedef int slap_mr_normalize_func LDAP_P((
360 struct slap_syntax *syntax, /* NULL if in is asserted value */
361 struct slap_matching_rule *mr,
366 /* Match (compare) function */
367 typedef int slap_mr_match_func LDAP_P((
370 struct slap_syntax *syntax, /* syntax of stored value */
371 struct slap_matching_rule *mr,
372 struct berval * value,
373 void * assertValue ));
375 /* Index generation function */
376 typedef int slap_mr_indexer_func LDAP_P((
379 struct slap_syntax *syntax, /* syntax of stored value */
380 struct slap_matching_rule *mr,
381 struct berval *prefix,
386 /* Filter index function */
387 typedef int slap_mr_filter_func LDAP_P((
390 struct slap_syntax *syntax, /* syntax of stored value */
391 struct slap_matching_rule *mr,
392 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 )
437 * The asserted value, depending on the particular usage,
438 * is expected to conform to either the assertion syntax
439 * or the attribute syntax. In some cases, the syntax of
440 * the value is known. If so, these flags indicate which
441 * syntax the value is expected to conform to. If not,
442 * neither of these flags is set (until the syntax of the
443 * provided value is determined). If the value is of the
444 * attribute syntax, the flag is changed once a value of
445 * the assertion syntax is derived from the provided value.
447 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
448 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
450 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
451 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
452 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
453 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
455 /* either or both the asserted value or attribute value
456 * may be provided in normalized form
458 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0010U
459 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0020U
461 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
462 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
463 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
464 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
466 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
467 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
468 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
469 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
470 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
471 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
473 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
474 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
475 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
476 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
479 slap_mr_convert_func *smr_convert;
480 slap_mr_normalize_func *smr_normalize;
481 slap_mr_match_func *smr_match;
482 slap_mr_indexer_func *smr_indexer;
483 slap_mr_filter_func *smr_filter;
486 * null terminated array of syntaxes compatible with this syntax
487 * note: when MS_EXT is set, this MUST NOT contain the assertion
488 * syntax of the rule. When MS_EXT is not set, it MAY.
490 Syntax **smr_compat_syntaxes;
493 * For equality rules, refers to an associated approximate rule.
494 * For non-equality rules, refers to an associated equality rule.
496 struct slap_matching_rule *smr_associated;
498 #define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \
499 ((mr)->smr_associated == (amr)))
501 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
503 #define smr_oid smr_mrule.mr_oid
504 #define smr_names smr_mrule.mr_names
505 #define smr_desc smr_mrule.mr_desc
506 #define smr_obsolete smr_mrule.mr_obsolete
507 #define smr_syntax_oid smr_mrule.mr_syntax_oid
508 #define smr_extensions smr_mrule.mr_extensions
511 struct slap_matching_rule_use {
512 LDAPMatchingRuleUse smru_mruleuse;
513 MatchingRule *smru_mr;
514 /* RFC2252 string representation */
515 struct berval smru_str;
517 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
519 #define smru_oid smru_mruleuse.mru_oid
520 #define smru_names smru_mruleuse.mru_names
521 #define smru_desc smru_mruleuse.mru_desc
522 #define smru_obsolete smru_mruleuse.mru_obsolete
523 #define smru_applies_oids smru_mruleuse.mru_applies_oids
525 #define smru_usage smru_mr->smr_usage
526 } /* MatchingRuleUse */ ;
528 typedef struct slap_mrule_defs_rec {
530 slap_mask_t mrd_usage;
531 char ** mrd_compat_syntaxes;
532 slap_mr_convert_func * mrd_convert;
533 slap_mr_normalize_func * mrd_normalize;
534 slap_mr_match_func * mrd_match;
535 slap_mr_indexer_func * mrd_indexer;
536 slap_mr_filter_func * mrd_filter;
538 /* For equality rule, this may refer to an associated approximate rule */
539 /* For non-equality rule, this may refer to an associated equality rule */
540 char * mrd_associated;
541 } slap_mrule_defs_rec;
543 struct slap_backend_db;
547 typedef int (AttributeTypeSchemaCheckFN)(
548 struct slap_backend_db *be,
549 struct slap_entry *e,
550 struct slap_attr *attr,
552 char *textbuf, size_t textlen );
554 typedef struct slap_attribute_type {
555 LDAPAttributeType sat_atype;
556 struct berval sat_cname;
557 struct slap_attribute_type *sat_sup;
558 struct slap_attribute_type **sat_subtypes;
559 MatchingRule *sat_equality;
560 MatchingRule *sat_approx;
561 MatchingRule *sat_ordering;
562 MatchingRule *sat_substr;
565 AttributeTypeSchemaCheckFN *sat_check;
567 #define SLAP_AT_NONE 0x0000U
568 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
569 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
570 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
571 slap_mask_t sat_flags;
573 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
575 #define sat_oid sat_atype.at_oid
576 #define sat_names sat_atype.at_names
577 #define sat_desc sat_atype.at_desc
578 #define sat_obsolete sat_atype.at_obsolete
579 #define sat_sup_oid sat_atype.at_sup_oid
580 #define sat_equality_oid sat_atype.at_equality_oid
581 #define sat_ordering_oid sat_atype.at_ordering_oid
582 #define sat_substr_oid sat_atype.at_substr_oid
583 #define sat_syntax_oid sat_atype.at_syntax_oid
584 #define sat_single_value sat_atype.at_single_value
585 #define sat_collective sat_atype.at_collective
586 #define sat_no_user_mod sat_atype.at_no_user_mod
587 #define sat_usage sat_atype.at_usage
588 #define sat_extensions sat_atype.at_extensions
590 struct slap_attr_desc *sat_ad;
591 ldap_pvt_thread_mutex_t sat_ad_mutex;
594 #define is_at_operational(at) ((at)->sat_usage)
595 #define is_at_single_value(at) ((at)->sat_single_value)
596 #define is_at_collective(at) ((at)->sat_collective)
597 #define is_at_obsolete(at) ((at)->sat_obsolete)
598 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
600 struct slap_object_class;
602 typedef int (ObjectClassSchemaCheckFN)(
603 struct slap_backend_db *be,
604 struct slap_entry *e,
605 struct slap_object_class *oc,
607 char *textbuf, size_t textlen );
609 typedef struct slap_object_class {
610 LDAPObjectClass soc_oclass;
611 struct berval soc_cname;
612 struct slap_object_class **soc_sups;
613 AttributeType **soc_required;
614 AttributeType **soc_allowed;
615 ObjectClassSchemaCheckFN *soc_check;
616 slap_mask_t soc_flags;
617 #define soc_oid soc_oclass.oc_oid
618 #define soc_names soc_oclass.oc_names
619 #define soc_desc soc_oclass.oc_desc
620 #define soc_obsolete soc_oclass.oc_obsolete
621 #define soc_sup_oids soc_oclass.oc_sup_oids
622 #define soc_kind soc_oclass.oc_kind
623 #define soc_at_oids_must soc_oclass.oc_at_oids_must
624 #define soc_at_oids_may soc_oclass.oc_at_oids_may
625 #define soc_extensions soc_oclass.oc_extensions
627 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
630 #define SLAP_OC_ALIAS 0x0001
631 #define SLAP_OC_REFERRAL 0x0002
632 #define SLAP_OC_SUBENTRY 0x0004
633 #define SLAP_OC_DYNAMICOBJECT 0x0008
634 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
635 #define SLAP_OC__MASK 0x001F
636 #define SLAP_OC__END 0x0020
637 #define SLAP_OC_OPERATIONAL 0x4000
638 #define SLAP_OC_HIDE 0x8000
643 typedef struct slap_content_rule {
644 LDAPContentRule scr_crule;
645 ObjectClass *scr_sclass;
646 ObjectClass **scr_auxiliaries; /* optional */
647 AttributeType **scr_required; /* optional */
648 AttributeType **scr_allowed; /* optional */
649 AttributeType **scr_precluded; /* optional */
650 #define scr_oid scr_crule.cr_oid
651 #define scr_names scr_crule.cr_names
652 #define scr_desc scr_crule.cr_desc
653 #define scr_obsolete scr_crule.cr_obsolete
654 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
655 #define scr_at_oids_must scr_crule.cr_at_oids_must
656 #define scr_at_oids_may scr_crule.cr_at_oids_may
657 #define scr_at_oids_not scr_crule.cr_at_oids_not
659 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
662 /* Represents a recognized attribute description ( type + options ). */
663 typedef struct slap_attr_desc {
664 struct slap_attr_desc *ad_next;
665 AttributeType *ad_type; /* attribute type, must be specified */
666 struct berval ad_cname; /* canonical name, must be specified */
667 struct berval ad_tags; /* empty if no tagging options */
669 #define SLAP_DESC_NONE 0x00U
670 #define SLAP_DESC_BINARY 0x01U
671 #define SLAP_DESC_TAG_RANGE 0x80U
672 } AttributeDescription;
674 typedef struct slap_attr_name {
675 struct berval an_name;
676 AttributeDescription *an_desc;
680 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
681 #define slap_ad_is_tag_range(ad) \
682 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
683 #define slap_ad_is_binary(ad) \
684 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
687 * pointers to schema elements used internally
689 struct slap_internal_schema {
691 ObjectClass *si_oc_top;
692 ObjectClass *si_oc_extensibleObject;
693 ObjectClass *si_oc_alias;
694 ObjectClass *si_oc_referral;
695 ObjectClass *si_oc_rootdse;
696 ObjectClass *si_oc_subentry;
697 ObjectClass *si_oc_subschema;
698 ObjectClass *si_oc_collectiveAttributeSubentry;
699 ObjectClass *si_oc_dynamicObject;
701 /* objectClass attribute descriptions */
702 AttributeDescription *si_ad_objectClass;
704 /* operational attribute descriptions */
705 AttributeDescription *si_ad_structuralObjectClass;
706 AttributeDescription *si_ad_creatorsName;
707 AttributeDescription *si_ad_createTimestamp;
708 AttributeDescription *si_ad_modifiersName;
709 AttributeDescription *si_ad_modifyTimestamp;
710 AttributeDescription *si_ad_hasSubordinates;
711 AttributeDescription *si_ad_subschemaSubentry;
712 AttributeDescription *si_ad_collectiveSubentries;
713 AttributeDescription *si_ad_collectiveExclusions;
714 AttributeDescription *si_ad_entryUUID;
715 AttributeDescription *si_ad_entryCSN;
716 AttributeDescription *si_ad_namingCSN;
717 AttributeDescription *si_ad_superiorUUID;
720 /* LDAP cache specific operational attribute */
721 AttributeDescription *si_ad_queryid;
722 #endif /* LDAP_CACHING */
724 /* root DSE attribute descriptions */
725 AttributeDescription *si_ad_altServer;
726 AttributeDescription *si_ad_namingContexts;
727 AttributeDescription *si_ad_supportedControl;
728 AttributeDescription *si_ad_supportedExtension;
729 AttributeDescription *si_ad_supportedLDAPVersion;
730 AttributeDescription *si_ad_supportedSASLMechanisms;
731 AttributeDescription *si_ad_supportedFeatures;
732 AttributeDescription *si_ad_monitorContext;
733 AttributeDescription *si_ad_vendorName;
734 AttributeDescription *si_ad_vendorVersion;
736 /* subentry attribute descriptions */
737 AttributeDescription *si_ad_administrativeRole;
738 AttributeDescription *si_ad_subtreeSpecification;
740 /* subschema subentry attribute descriptions */
741 AttributeDescription *si_ad_ditStructureRules;
742 AttributeDescription *si_ad_ditContentRules;
743 AttributeDescription *si_ad_nameForms;
744 AttributeDescription *si_ad_objectClasses;
745 AttributeDescription *si_ad_attributeTypes;
746 AttributeDescription *si_ad_ldapSyntaxes;
747 AttributeDescription *si_ad_matchingRules;
748 AttributeDescription *si_ad_matchingRuleUse;
750 /* Aliases & Referrals */
751 AttributeDescription *si_ad_aliasedObjectName;
752 AttributeDescription *si_ad_ref;
754 /* Access Control Internals */
755 AttributeDescription *si_ad_entry;
756 AttributeDescription *si_ad_children;
757 AttributeDescription *si_ad_saslAuthzTo;
758 AttributeDescription *si_ad_saslAuthzFrom;
759 #ifdef SLAPD_ACI_ENABLED
760 AttributeDescription *si_ad_aci;
763 /* dynamic entries */
764 AttributeDescription *si_ad_entryTtl;
765 AttributeDescription *si_ad_dynamicSubtrees;
767 /* Other attributes descriptions */
768 AttributeDescription *si_ad_distinguishedName;
769 AttributeDescription *si_ad_name;
770 AttributeDescription *si_ad_cn;
771 AttributeDescription *si_ad_userPassword;
772 #ifdef SLAPD_AUTHPASSWD
773 AttributeDescription *si_ad_authPassword;
775 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
776 AttributeDescription *si_ad_krbName;
779 /* Undefined Attribute Type */
780 AttributeType *si_at_undefined;
783 MatchingRule *si_mr_distinguishedNameMatch;
784 MatchingRule *si_mr_caseExactMatch;
785 MatchingRule *si_mr_caseExactSubstringsMatch;
786 MatchingRule *si_mr_caseExactIA5Match;
787 MatchingRule *si_mr_integerMatch;
788 MatchingRule *si_mr_integerFirstComponentMatch;
791 Syntax *si_syn_directoryString;
792 Syntax *si_syn_distinguishedName;
793 Syntax *si_syn_integer;
794 Syntax *si_syn_octetString;
797 typedef struct slap_attr_assertion {
798 AttributeDescription *aa_desc;
799 struct berval aa_value;
800 } AttributeAssertion;
802 typedef struct slap_ss_assertion {
803 AttributeDescription *sa_desc;
804 struct berval sa_initial;
805 struct berval *sa_any;
806 struct berval sa_final;
807 } SubstringsAssertion;
809 typedef struct slap_mr_assertion {
810 MatchingRule *ma_rule; /* optional */
811 struct berval ma_rule_text; /* optional */
812 AttributeDescription *ma_desc; /* optional */
813 int ma_dnattrs; /* boolean */
814 struct berval ma_value; /* required */
815 } MatchingRuleAssertion;
818 * represents a search filter
820 typedef struct slap_filter {
821 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
822 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
823 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
824 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
827 /* precomputed result */
828 ber_int_t f_un_result;
831 struct berval *f_un_dn;
834 AttributeDescription *f_un_desc;
836 /* simple value assertion */
837 AttributeAssertion *f_un_ava;
839 /* substring assertion */
840 SubstringsAssertion *f_un_ssa;
842 /* matching rule assertion */
843 MatchingRuleAssertion *f_un_mra;
845 #define f_dn f_un.f_un_dn
846 #define f_desc f_un.f_un_desc
847 #define f_ava f_un.f_un_ava
848 #define f_av_desc f_un.f_un_ava->aa_desc
849 #define f_av_value f_un.f_un_ava->aa_value
850 #define f_sub f_un.f_un_ssa
851 #define f_sub_desc f_un.f_un_ssa->sa_desc
852 #define f_sub_initial f_un.f_un_ssa->sa_initial
853 #define f_sub_any f_un.f_un_ssa->sa_any
854 #define f_sub_final f_un.f_un_ssa->sa_final
855 #define f_mra f_un.f_un_mra
856 #define f_mr_rule f_un.f_un_mra->ma_rule
857 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
858 #define f_mr_desc f_un.f_un_mra->ma_desc
859 #define f_mr_value f_un.f_un_mra->ma_value
860 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
863 struct slap_filter *f_un_complex;
866 #define f_result f_un.f_un_result
867 #define f_and f_un.f_un_complex
868 #define f_or f_un.f_un_complex
869 #define f_not f_un.f_un_complex
870 #define f_list f_un.f_un_complex
872 struct slap_filter *f_next;
875 /* compare routines can return undefined */
876 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
878 typedef struct slap_valuesreturnfilter {
879 ber_tag_t vrf_choice;
882 /* precomputed result */
883 ber_int_t vrf_un_result;
889 AttributeDescription *vrf_un_desc;
891 /* simple value assertion */
892 AttributeAssertion *vrf_un_ava;
894 /* substring assertion */
895 SubstringsAssertion *vrf_un_ssa;
897 /* matching rule assertion */
898 MatchingRuleAssertion *vrf_un_mra;
900 #define vrf_result vrf_un.vrf_un_result
901 #define vrf_dn vrf_un.vrf_un_dn
902 #define vrf_desc vrf_un.vrf_un_desc
903 #define vrf_ava vrf_un.vrf_un_ava
904 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
905 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
906 #define vrf_ssa vrf_un.vrf_un_ssa
907 #define vrf_sub vrf_un.vrf_un_ssa
908 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
909 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
910 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
911 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
912 #define vrf_mra vrf_un.vrf_un_mra
913 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
914 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
915 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
916 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
917 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
922 struct slap_valuesreturnfilter *vrf_next;
923 } ValuesReturnFilter;
926 * represents an attribute (description + values)
928 typedef struct slap_attr {
929 AttributeDescription *a_desc;
930 BerVarray a_vals; /* preserved values */
931 BerVarray a_nvals; /* normalized values */
932 struct slap_attr *a_next;
934 #define SLAP_ATTR_IXADD 0x1U
935 #define SLAP_ATTR_IXDEL 0x2U
940 * the id used in the indexes to refer to an entry
942 typedef unsigned long ID;
943 #define NOID ((ID)~0)
946 * represents an entry in core
948 typedef struct slap_entry {
950 * The ID field should only be changed before entry is
951 * inserted into a cache. The ID value is backend
956 struct berval e_name; /* name (DN) of this entry */
957 struct berval e_nname; /* normalized name (DN) of this entry */
959 /* for migration purposes */
960 #define e_dn e_name.bv_val
961 #define e_ndn e_nname.bv_val
963 Attribute *e_attrs; /* list of attributes + values */
965 slap_mask_t e_ocflags;
967 struct berval e_bv; /* For entry_encode/entry_decode */
969 /* for use by the backend for any purpose */
976 typedef struct slap_mod {
978 AttributeDescription *sm_desc;
979 struct berval sm_type;
981 #define sm_bvalues sm_values
982 BerVarray sm_nvalues;
985 typedef struct slap_mod_list {
986 Modification sml_mod;
987 #define sml_op sml_mod.sm_op
988 #define sml_desc sml_mod.sm_desc
989 #define sml_type sml_mod.sm_type
990 #define sml_bvalues sml_mod.sm_values
991 #define sml_values sml_mod.sm_values
992 #define sml_nvalues sml_mod.sm_nvalues
993 struct slap_mod_list *sml_next;
996 typedef struct slap_ldap_modlist {
998 struct slap_ldap_modlist *ml_next;
999 #define ml_op ml_mod.mod_op
1000 #define ml_type ml_mod.mod_type
1001 #define ml_values ml_mod.mod_values
1002 #define ml_bvalues ml_mod.mod_values
1006 * represents an access control list
1008 typedef enum slap_access_e {
1009 ACL_INVALID_ACCESS = -1,
1018 typedef enum slap_control_e {
1019 ACL_INVALID_CONTROL = 0,
1025 typedef enum slap_style_e {
1026 ACL_STYLE_REGEX = 0,
1033 /* alternate names */
1034 ACL_STYLE_EXACT = ACL_STYLE_BASE
1037 typedef struct slap_authz_info {
1038 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1039 struct berval sai_mech; /* SASL Mechanism */
1040 struct berval sai_dn; /* DN for reporting purposes */
1041 struct berval sai_ndn; /* Normalized DN */
1043 /* Security Strength Factors */
1044 slap_ssf_t sai_ssf; /* Overall SSF */
1045 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1046 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1047 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1048 } AuthorizationInformation;
1051 typedef struct slap_access {
1052 slap_control_t a_type;
1054 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1056 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1057 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1058 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1059 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1060 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1061 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1063 #define ACL_PRIV_MASK 0x00ffUL
1066 #define ACL_PRIV_LEVEL 0x1000UL
1067 #define ACL_PRIV_ADDITIVE 0x2000UL
1068 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1071 #define ACL_PRIV_INVALID 0x0UL
1073 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1074 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1075 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1076 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1078 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1079 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1081 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1083 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1085 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1086 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1087 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1089 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1090 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1091 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1092 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1093 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1094 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1096 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1097 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1098 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1099 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1100 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1101 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1102 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1104 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1105 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1106 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1107 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1108 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1109 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1111 slap_mask_t a_access_mask;
1113 AuthorizationInformation a_authz;
1114 #define a_dn_pat a_authz.sai_dn
1116 slap_style_t a_dn_style;
1117 AttributeDescription *a_dn_at;
1121 slap_style_t a_peername_style;
1122 struct berval a_peername_pat;
1123 slap_style_t a_sockname_style;
1124 struct berval a_sockname_pat;
1126 slap_style_t a_domain_style;
1127 struct berval a_domain_pat;
1128 int a_domain_expand;
1130 slap_style_t a_sockurl_style;
1131 struct berval a_sockurl_pat;
1132 slap_style_t a_set_style;
1133 struct berval a_set_pat;
1135 #ifdef SLAPD_ACI_ENABLED
1136 AttributeDescription *a_aci_at;
1140 slap_style_t a_group_style;
1141 struct berval a_group_pat;
1142 ObjectClass *a_group_oc;
1143 AttributeDescription *a_group_at;
1145 struct slap_access *a_next;
1149 typedef struct slap_acl {
1150 /* "to" part: the entries this acl applies to */
1152 slap_style_t acl_dn_style;
1154 struct berval acl_dn_pat;
1155 AttributeName *acl_attrs;
1157 /* "by" part: list of who has what access to the entries */
1160 struct slap_acl *acl_next;
1163 typedef struct slap_acl_state {
1164 unsigned as_recorded;
1165 #define ACL_STATE_NOT_RECORDED 0x0
1166 #define ACL_STATE_RECORDED_VD 0x1
1167 #define ACL_STATE_RECORDED_NV 0x2
1168 #define ACL_STATE_RECORDED 0x3
1171 AccessControl *as_vd_acl;
1172 AccessControl *as_vi_acl;
1173 slap_mask_t as_vd_acl_mask;
1174 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1175 int as_vd_acl_count;
1177 Access *as_vd_access;
1178 int as_vd_access_count;
1181 AttributeDescription *as_vd_ad;
1182 } AccessControlState;
1183 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1184 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1188 * represents a backend
1191 typedef struct slap_backend_info BackendInfo; /* per backend type */
1192 typedef struct slap_backend_db BackendDB; /* per backend database */
1194 LDAP_SLAPD_V (int) nBackendInfo;
1195 LDAP_SLAPD_V (int) nBackendDB;
1196 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1197 LDAP_SLAPD_V (BackendDB *) backendDB;
1199 LDAP_SLAPD_V (int) slapMode;
1200 #define SLAP_UNDEFINED_MODE 0x0000
1201 #define SLAP_SERVER_MODE 0x0001
1202 #define SLAP_TOOL_MODE 0x0002
1203 #define SLAP_MODE 0x0003
1205 #define SLAP_TRUNCATE_MODE 0x0100
1207 struct slap_replica_info {
1208 char *ri_host; /* supersedes be_replica */
1209 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1210 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1211 int ri_exclude; /* 1 => exclude ri_attrs */
1214 struct slap_limits_set {
1222 int lms_s_unchecked;
1227 struct slap_limits {
1228 int lm_type; /* type of pattern */
1229 #define SLAP_LIMITS_UNDEFINED 0x0000
1230 #define SLAP_LIMITS_EXACT 0x0001
1231 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1232 #define SLAP_LIMITS_ONE 0x0002
1233 #define SLAP_LIMITS_SUBTREE 0x0003
1234 #define SLAP_LIMITS_CHILDREN 0x0004
1235 #define SLAP_LIMITS_REGEX 0x0005
1236 #define SLAP_LIMITS_ANONYMOUS 0x0006
1237 #define SLAP_LIMITS_USERS 0x0007
1238 #define SLAP_LIMITS_ANY 0x0008
1239 regex_t lm_dn_regex; /* regex data for REGEX */
1242 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1243 * pattern for REGEX; NULL for ANONYMOUS, USERS
1245 struct berval lm_dn_pat;
1247 struct slap_limits_set lm_limits;
1250 /* temporary aliases */
1251 typedef BackendDB Backend;
1252 #define nbackends nBackendDB
1253 #define backends backendDB
1255 struct slap_backend_db {
1256 BackendInfo *bd_info; /* pointer to shared backend info */
1258 /* BackendInfo accessors */
1259 #define be_config bd_info->bi_db_config
1260 #define be_type bd_info->bi_type
1262 #define be_bind bd_info->bi_op_bind
1263 #define be_unbind bd_info->bi_op_unbind
1264 #define be_add bd_info->bi_op_add
1265 #define be_compare bd_info->bi_op_compare
1266 #define be_delete bd_info->bi_op_delete
1267 #define be_modify bd_info->bi_op_modify
1268 #define be_modrdn bd_info->bi_op_modrdn
1269 #define be_search bd_info->bi_op_search
1270 #define be_abandon bd_info->bi_op_abandon
1271 #define be_cancel bd_info->bi_op_cancel
1273 #define be_extended bd_info->bi_extended
1275 #define be_fetch bd_info->bi_entry_get_rw
1276 #define be_release bd_info->bi_entry_release_rw
1277 #define be_chk_referrals bd_info->bi_chk_referrals
1278 #define be_group bd_info->bi_acl_group
1279 #define be_attribute bd_info->bi_acl_attribute
1280 #define be_operational bd_info->bi_operational
1283 * define to honor hasSubordinates operational attribute in search filters
1284 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1287 #define be_has_subordinates bd_info->bi_has_subordinates
1289 #define be_controls bd_info->bi_controls
1291 #define be_connection_init bd_info->bi_connection_init
1292 #define be_connection_destroy bd_info->bi_connection_destroy
1295 #define be_entry_open bd_info->bi_tool_entry_open
1296 #define be_entry_close bd_info->bi_tool_entry_close
1297 #define be_entry_first bd_info->bi_tool_entry_first
1298 #define be_entry_next bd_info->bi_tool_entry_next
1299 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1300 #define be_entry_get bd_info->bi_tool_entry_get
1301 #define be_entry_put bd_info->bi_tool_entry_put
1302 #define be_sync bd_info->bi_tool_sync
1305 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1306 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1307 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1308 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1309 #define SLAP_BFLAG_ALIASES 0x0100U
1310 #define SLAP_BFLAG_REFERRALS 0x0200U
1311 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1312 #define SLAP_BFLAG_MONITOR 0x1000U
1313 #define SLAP_BFLAG_DYNAMIC 0x2000U
1314 slap_mask_t be_flags;
1315 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1316 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1317 #define SLAP_GLUE_SUBORDINATE(be) \
1318 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1319 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1320 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1321 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1322 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1323 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1324 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1326 slap_mask_t be_restrictops; /* restriction operations */
1327 #define SLAP_RESTRICT_OP_ADD 0x0001U
1328 #define SLAP_RESTRICT_OP_BIND 0x0002U
1329 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1330 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1331 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1332 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1333 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1334 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1336 #define SLAP_RESTRICT_OP_READS \
1337 ( SLAP_RESTRICT_OP_COMPARE \
1338 | SLAP_RESTRICT_OP_SEARCH )
1339 #define SLAP_RESTRICT_OP_WRITES \
1340 ( SLAP_RESTRICT_OP_ADD \
1341 | SLAP_RESTRICT_OP_DELETE \
1342 | SLAP_RESTRICT_OP_MODIFY \
1343 | SLAP_RESTRICT_OP_RENAME )
1345 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1346 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1347 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1349 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1351 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1352 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1353 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1354 0x0004U /* unprotected simple auth */
1355 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1357 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1358 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1360 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1362 slap_mask_t be_requires; /* pre-operation requirements */
1363 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1364 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1365 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1366 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1367 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1369 /* Required Security Strength Factor */
1370 slap_ssf_set_t be_ssf_set;
1372 /* these should be renamed from be_ to bd_ */
1373 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1374 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1375 struct berval be_schemadn; /* per-backend subschema subentry DN */
1376 struct berval be_schemandn; /* normalized subschema DN */
1377 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1378 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1379 struct berval be_rootpw; /* the magic "root" password for this db */
1380 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1381 #define be_sizelimit be_def_limit.lms_s_soft
1382 #define be_timelimit be_def_limit.lms_t_soft
1383 struct slap_limits_set be_def_limit; /* default limits */
1384 struct slap_limits **be_limits; /* regex-based size and time limits */
1385 AccessControl *be_acl; /* access control list for this backend */
1386 slap_access_t be_dfltaccess; /* access given if no acl matches */
1387 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1388 char *be_replogfile; /* replication log file (in master) */
1389 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1390 BerVarray be_update_refs; /* where to refer modifying clients to */
1392 void *be_private; /* anything the backend database needs */
1394 void *be_pb; /* Netscape plugin */
1400 /* Backend function typedefs */
1401 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1402 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1403 const char *fname, int lineno,
1404 int argc, char **argv));
1405 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1406 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1407 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1409 typedef int (BI_db_init) LDAP_P((Backend *bd));
1410 typedef int (BI_db_config) LDAP_P((Backend *bd,
1411 const char *fname, int lineno,
1412 int argc, char **argv));
1413 typedef int (BI_db_open) LDAP_P((Backend *bd));
1414 typedef int (BI_db_close) LDAP_P((Backend *bd));
1415 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1417 typedef struct req_bind_s {
1419 struct berval rb_cred;
1420 struct berval rb_edn;
1424 typedef struct req_search_s {
1430 AttributeName *rs_attrs;
1432 struct berval rs_filterstr;
1435 typedef struct req_compare_s {
1436 AttributeAssertion *rs_ava;
1439 typedef struct req_modify_s {
1440 Modifications *rs_modlist;
1443 typedef struct req_modrdn_s {
1444 struct berval rs_newrdn;
1445 struct berval rs_nnewrdn;
1446 struct berval *rs_newSup;
1447 struct berval *rs_nnewSup;
1448 int rs_deleteoldrdn;
1451 typedef struct req_add_s {
1455 typedef struct req_abandon_s {
1459 typedef struct req_extended_s {
1460 struct berval rs_reqoid;
1461 struct berval *rs_reqdata;
1464 typedef enum slap_reply_e {
1472 typedef struct rep_sasl_s {
1473 struct berval *r_sasldata;
1476 typedef struct rep_extended_s {
1477 const char *r_rspoid;
1478 struct berval *r_rspdata;
1481 typedef struct rep_search_s {
1483 AttributeName *r_attrs;
1488 typedef struct slap_rep {
1489 slap_reply_t sr_type;
1493 const char *sr_matched;
1494 const char *sr_text;
1496 LDAPControl **sr_ctrls;
1498 rep_sasl_s sru_sasl;
1499 rep_extended_s sru_extended;
1500 rep_search_s sru_search;
1504 /* short hands for response members */
1505 #define sr_attrs sr_un.sru_search.r_attrs
1506 #define sr_entry sr_un.sru_search.r_entry
1507 #define sr_v2ref sr_un.sru_search.r_v2ref
1508 #define sr_nentries sr_un.sru_search.r_nentries
1509 #define sr_rspoid sr_un.sru_extended.r_rspoid
1510 #define sr_rspdata sr_un.sru_extended.r_rspdata
1511 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1513 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1514 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1515 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1516 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1517 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1518 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1519 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1520 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1521 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1522 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1523 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1524 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1525 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1526 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1527 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1528 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1529 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1531 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1532 struct slap_conn *c));
1533 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1534 struct slap_conn *c));
1536 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1537 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1538 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1539 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1540 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1541 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1542 struct berval *text ));
1543 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1544 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1546 struct slap_backend_info {
1547 char *bi_type; /* type of backend */
1550 * per backend type routines:
1551 * bi_init: called to allocate a backend_info structure,
1552 * called once BEFORE configuration file is read.
1553 * bi_init() initializes this structure hence is
1554 * called directly from be_initialize()
1555 * bi_config: called per 'backend' specific option
1556 * all such options must before any 'database' options
1557 * bi_config() is called only from read_config()
1558 * bi_open: called to open each database, called
1559 * once AFTER configuration file is read but
1560 * BEFORE any bi_db_open() calls.
1561 * bi_open() is called from backend_startup()
1562 * bi_close: called to close each database, called
1563 * once during shutdown after all bi_db_close calls.
1564 * bi_close() is called from backend_shutdown()
1565 * bi_destroy: called to destroy each database, called
1566 * once during shutdown after all bi_db_destroy calls.
1567 * bi_destory() is called from backend_destroy()
1570 BI_config *bi_config;
1573 BI_destroy *bi_destroy;
1576 * per database routines:
1577 * bi_db_init: called to initialize each database,
1578 * called upon reading 'database <type>'
1579 * called only from backend_db_init()
1580 * bi_db_config: called to configure each database,
1581 * called per database to handle per database options
1582 * called only from read_config()
1583 * bi_db_open: called to open each database
1584 * called once per database immediately AFTER bi_open()
1585 * calls but before daemon startup.
1586 * called only by backend_startup()
1587 * bi_db_close: called to close each database
1588 * called once per database during shutdown but BEFORE
1589 * any bi_close call.
1590 * called only by backend_shutdown()
1591 * bi_db_destroy: called to destroy each database
1592 * called once per database during shutdown AFTER all
1593 * bi_close calls but before bi_destory calls.
1594 * called only by backend_destory()
1596 BI_db_init *bi_db_init;
1597 BI_db_config *bi_db_config;
1598 BI_db_open *bi_db_open;
1599 BI_db_close *bi_db_close;
1600 BI_db_destroy *bi_db_destroy;
1602 /* LDAP Operations Handling Routines */
1603 BI_op_bind *bi_op_bind;
1604 BI_op_unbind *bi_op_unbind;
1605 BI_op_search *bi_op_search;
1606 BI_op_compare *bi_op_compare;
1607 BI_op_modify *bi_op_modify;
1608 BI_op_modrdn *bi_op_modrdn;
1609 BI_op_add *bi_op_add;
1610 BI_op_delete *bi_op_delete;
1611 BI_op_abandon *bi_op_abandon;
1612 BI_op_cancel *bi_op_cancel;
1614 /* Extended Operations Helper */
1615 BI_op_extended *bi_extended;
1617 /* Auxilary Functions */
1618 BI_entry_get_rw *bi_entry_get_rw;
1619 BI_entry_release_rw *bi_entry_release_rw;
1620 BI_chk_referrals *bi_chk_referrals;
1622 BI_operational *bi_operational;
1623 BI_has_subordinates *bi_has_subordinates;
1625 BI_connection_init *bi_connection_init;
1626 BI_connection_destroy *bi_connection_destroy;
1628 /* hooks for slap tools */
1629 BI_tool_entry_open *bi_tool_entry_open;
1630 BI_tool_entry_close *bi_tool_entry_close;
1631 BI_tool_entry_first *bi_tool_entry_first;
1632 BI_tool_entry_next *bi_tool_entry_next;
1633 BI_tool_entry_get *bi_tool_entry_get;
1634 BI_tool_entry_put *bi_tool_entry_put;
1635 BI_tool_entry_reindex *bi_tool_entry_reindex;
1636 BI_tool_sync *bi_tool_sync;
1638 #define SLAP_INDEX_ADD_OP 0x0001
1639 #define SLAP_INDEX_DELETE_OP 0x0002
1641 char **bi_controls; /* supported controls */
1643 unsigned int bi_nDB; /* number of databases of this type */
1644 void *bi_private; /* anything the backend type needs */
1647 #define c_authtype c_authz.sai_method
1648 #define c_authmech c_authz.sai_mech
1649 #define c_dn c_authz.sai_dn
1650 #define c_ndn c_authz.sai_ndn
1651 #define c_ssf c_authz.sai_ssf
1652 #define c_transport_ssf c_authz.sai_transport_ssf
1653 #define c_tls_ssf c_authz.sai_tls_ssf
1654 #define c_sasl_ssf c_authz.sai_sasl_ssf
1656 #define o_authtype o_authz.sai_method
1657 #define o_authmech o_authz.sai_mech
1658 #define o_dn o_authz.sai_dn
1659 #define o_ndn o_authz.sai_ndn
1660 #define o_ssf o_authz.sai_ssf
1661 #define o_transport_ssf o_authz.sai_transport_ssf
1662 #define o_tls_ssf o_authz.sai_tls_ssf
1663 #define o_sasl_ssf o_authz.sai_sasl_ssf
1665 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1667 typedef struct slap_callback {
1668 slap_response *sc_response;
1673 * Paged Results state
1675 typedef unsigned long PagedResultsCookie;
1676 typedef struct slap_paged_state {
1678 PagedResultsCookie ps_cookie;
1680 } PagedResultsState;
1683 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1684 #define LDAP_PSEARCH_BY_ADD 0x01
1685 #define LDAP_PSEARCH_BY_DELETE 0x02
1686 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1687 #define LDAP_PSEARCH_BY_MODIFY 0x04
1688 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1691 struct slap_op *ps_op;
1692 LDAP_LIST_ENTRY(psid_entry) ps_link;
1698 * represents an operation pending from an ldap client
1700 typedef struct slap_op {
1701 unsigned long o_opid; /* id of this operation */
1702 unsigned long o_connid; /* id of conn initiating this op */
1703 struct slap_conn *o_conn; /* connection spawning this op */
1704 BackendDB *o_bd; /* backend DB processing this op */
1706 ber_int_t o_msgid; /* msgid of the request */
1707 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1708 ber_tag_t o_tag; /* tag of the request */
1709 time_t o_time; /* time op was initiated */
1711 struct berval o_req_dn; /* DN of target of request */
1712 struct berval o_req_ndn;
1717 req_compare_s oq_compare;
1718 req_modify_s oq_modify;
1719 req_modrdn_s oq_modrdn;
1720 req_search_s oq_search;
1721 req_abandon_s oq_abandon;
1722 req_abandon_s oq_cancel;
1723 req_extended_s oq_extended;
1726 /* short hands for union members */
1727 #define oq_add o_request.oq_add
1728 #define oq_bind o_request.oq_bind
1729 #define oq_compare o_request.oq_compare
1730 #define oq_modify o_request.oq_modify
1731 #define oq_modrdn o_request.oq_modrdn
1732 #define oq_search o_request.oq_search
1733 #define oq_abandon o_request.oq_abandon
1734 #define oq_cancel o_request.oq_cancel
1735 #define oq_extended o_request.oq_extended
1737 /* short hands for inner request members */
1738 #define orb_method oq_bind.rb_method
1739 #define orb_cred oq_bind.rb_cred
1740 #define orb_edn oq_bind.rb_edn
1741 #define orb_ssf oq_bind.rb_ssf
1743 #define ors_scope oq_search.rs_scope
1744 #define ors_deref oq_search.rs_deref
1745 #define ors_slimit oq_search.rs_slimit
1746 #define ors_tlimit oq_search.rs_tlimit
1747 #define ors_attrsonly oq_search.rs_attrsonly
1748 #define ors_attrs oq_search.rs_attrs
1749 #define ors_filter oq_search.rs_filter
1750 #define ors_filterstr oq_search.rs_filterstr
1752 #define orr_newrdn oq_modrdn.rs_newrdn
1753 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1754 #define orr_newSup oq_modrdn.rs_newSup
1755 #define orr_nnewSup oq_modrdn.rs_nnewSup
1756 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1758 #define orc_ava oq_compare.rs_ava
1759 #define ora_e oq_add.rs_e
1760 #define orn_msgid oq_abandon.rs_msgid
1761 #define orm_modlist oq_modify.rs_modlist
1763 #define ore_reqoid oq_extended.rs_reqoid
1764 #define ore_reqdata oq_extended.rs_reqdata
1766 ldap_pvt_thread_t o_tid; /* thread handling this op */
1768 volatile sig_atomic_t o_abandon; /* abandon flag */
1769 volatile sig_atomic_t o_cancel; /* cancel flag */
1770 #define SLAP_CANCEL_NONE 0x00
1771 #define SLAP_CANCEL_REQ 0x01
1772 #define SLAP_CANCEL_ACK 0x02
1773 #define SLAP_CANCEL_DONE 0x03
1775 char o_do_not_cache; /* don't cache from this op */
1776 char o_is_auth_check; /* authorization in progress */
1778 #define SLAP_NO_CONTROL 0
1779 #define SLAP_NONCRITICAL_CONTROL 1
1780 #define SLAP_CRITICAL_CONTROL 2
1782 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1788 #define get_subentries(op) ((int)(op)->o_subentries)
1789 char o_subentries_visibility;
1790 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1792 char o_valuesreturnfilter;
1794 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1795 char o_permissive_modify;
1796 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1798 #define get_permissiveModify(op) (0)
1801 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1802 char o_domain_scope;
1803 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1805 #define get_domainScope(op) (0)
1808 #ifdef LDAP_CONTROL_PAGEDRESULTS
1809 char o_pagedresults;
1810 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1811 ber_int_t o_pagedresults_size;
1812 PagedResultsState o_pagedresults_state;
1814 #define get_pagedresults(op) (0)
1817 #ifdef LDAP_CLIENT_UPDATE
1818 char o_clientupdate;
1819 char o_clientupdate_type;
1820 #define SLAP_LCUP_NONE (0x0)
1821 #define SLAP_LCUP_SYNC (0x1)
1822 #define SLAP_LCUP_PERSIST (0x2)
1823 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1824 ber_int_t o_clientupdate_interval;
1825 struct berval o_clientupdate_state;
1831 #define SLAP_SYNC_NONE (0x0)
1832 #define SLAP_SYNC_REFRESH (0x1)
1833 #define SLAP_SYNC_PERSIST (0x2)
1834 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1835 struct berval o_sync_state;
1838 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1841 LDAP_LIST_ENTRY(slap_op) o_ps_link;
1842 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
1845 AuthorizationInformation o_authz;
1847 BerElement *o_ber; /* ber of the request */
1848 #ifdef LDAP_CONNECTIONLESS
1849 BerElement *o_res_ber; /* ber of the reply */
1851 slap_callback *o_callback; /* callback pointers */
1852 LDAPControl **o_ctrls; /* controls */
1854 void *o_threadctx; /* thread pool thread context */
1855 void *o_tmpmemctx; /* slab malloc context */
1856 BerMemoryFunctions *o_tmpmfuncs;
1857 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
1858 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
1859 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
1860 #define o_tmpfree o_tmpmfuncs->bmf_free
1861 void *o_private; /* anything the backend needs */
1863 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1864 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1868 #endif /*LDAP_CACHING */
1871 void *o_pb; /* NS-SLAPI plugin */
1875 #define send_ldap_error( op, rs, err, text ) \
1876 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1877 (op->o_conn->c_send_ldap_result)( op, rs ); } while (0)
1878 #define send_ldap_discon( op, rs, err, text ) \
1879 do { (rs)->sr_err = err; (rs)->sr_text = text; \
1880 send_ldap_disconnect( op, rs ); } while (0)
1881 typedef void (SEND_LDAP_RESULT)(struct slap_op *op, struct slap_rep *rs);
1882 typedef int (SEND_SEARCH_ENTRY)(struct slap_op *op, struct slap_rep *rs);
1883 typedef int (SEND_SEARCH_REFERENCE)(struct slap_op *op, struct slap_rep *rs);
1884 typedef void (SEND_LDAP_EXTENDED)(struct slap_op *op, struct slap_rep *rs);
1885 typedef void (SEND_LDAP_INTERMEDIATE_RESP)(struct slap_op *op, struct slap_rep *rs);
1886 #define send_ldap_result( op, rs ) \
1887 (op->o_conn->c_send_ldap_result)( op, rs )
1888 #define send_search_entry( op, rs ) \
1889 (op->o_conn->c_send_search_entry)( op, rs )
1890 #define send_search_reference( op, rs ) \
1891 (op->o_conn->c_send_search_reference)( op, rs )
1892 #define send_ldap_extended( op, rs ) \
1893 (op->o_conn->c_send_ldap_extended)( op, rs )
1894 #define send_ldap_intermediate_resp( op, rs ) \
1895 (op->o_conn->c_send_ldap_intermediate_resp)( op, rs )
1898 * Caches the result of a backend_group check for ACL evaluation
1900 typedef struct slap_gacl {
1901 struct slap_gacl *ga_next;
1904 AttributeDescription *ga_at;
1910 typedef struct slap_listener Listener;
1913 * represents a connection from an ldap client
1915 typedef struct slap_conn {
1916 int c_struct_state; /* structure management state */
1917 int c_conn_state; /* connection state */
1919 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1920 Sockbuf *c_sb; /* ber connection stuff */
1922 /* only can be changed by connect_init */
1923 time_t c_starttime; /* when the connection was opened */
1924 time_t c_activitytime; /* when the connection was last used */
1925 unsigned long c_connid; /* id of this connection for stats*/
1927 struct berval c_peer_domain; /* DNS name of client */
1928 struct berval c_peer_name; /* peer name (trans=addr:port) */
1929 Listener *c_listener;
1930 #define c_listener_url c_listener->sl_url /* listener URL */
1931 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
1933 /* only can be changed by binding thread */
1934 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1935 struct berval c_sasl_bind_mech; /* mech in progress */
1936 struct berval c_sasl_dn; /* temporary storage */
1938 /* authorization backend */
1939 Backend *c_authz_backend;
1941 AuthorizationInformation c_authz;
1942 GroupAssertion *c_groups;
1944 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1946 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1947 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1949 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1950 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1952 BerElement *c_currentber; /* ber we're attempting to read */
1953 int c_writewaiter; /* true if writer is waiting */
1955 #ifdef LDAP_CONNECTIONLESS
1956 int c_is_udp; /* true if this is (C)LDAP over UDP */
1959 int c_is_tls; /* true if this LDAP over raw TLS */
1960 int c_needs_tls_accept; /* true if SSL_accept should be called */
1962 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1963 void *c_sasl_context; /* SASL session context */
1964 void *c_sasl_extra; /* SASL session extra stuff */
1965 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1967 PagedResultsState c_pagedresults_state; /* paged result state */
1969 long c_n_ops_received; /* num of ops received (next op_id) */
1970 long c_n_ops_executing; /* num of ops currently executing */
1971 long c_n_ops_pending; /* num of ops pending execution */
1972 long c_n_ops_completed; /* num of ops completed */
1974 long c_n_get; /* num of get calls */
1975 long c_n_read; /* num of read calls */
1976 long c_n_write; /* num of write calls */
1978 void *c_pb; /* Netscape plugin */
1981 * These are the "callbacks" that are available for back-ends to
1982 * supply data back to connected clients that are connected
1983 * through the "front-end".
1985 SEND_LDAP_RESULT *c_send_ldap_result;
1986 SEND_SEARCH_ENTRY *c_send_search_entry;
1987 SEND_SEARCH_REFERENCE *c_send_search_reference;
1988 SEND_LDAP_EXTENDED *c_send_ldap_extended;
1989 #ifdef LDAP_RES_INTERMEDIATE_RESP
1990 SEND_LDAP_INTERMEDIATE_RESP *c_send_ldap_intermediate_resp;
1995 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1996 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1998 if ( ldap_debug & (level) ) \
1999 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2000 if ( ldap_syslog & (level) ) \
2001 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2004 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2005 #elif defined(LDAP_DEBUG)
2006 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2008 if ( ldap_debug & (level) ) \
2009 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2011 #define StatslogTest( level ) (ldap_debug & (level))
2013 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2014 #define StatslogTest( level ) (0)
2018 * listener; need to access it from monitor backend
2020 struct slap_listener {
2021 struct berval sl_url;
2022 struct berval sl_name;
2027 #ifdef LDAP_CONNECTIONLESS
2028 int sl_is_udp; /* UDP listener is also data port */
2032 #define sl_addr sl_sa.sa_in_addr
2035 #ifdef SLAPD_MONITOR
2052 #endif /* SLAPD_MONITOR */
2055 * Better know these all around slapd
2057 #define SLAP_LDAPDN_PRETTY 0x1
2058 #define SLAP_LDAPDN_MAXLEN 8192
2063 #ifdef LDAP_CLIENT_UPDATE
2064 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2065 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2066 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2067 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2068 #endif /* LDAP_CLIENT_UPDATE */
2070 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2071 #define SLAP_SEARCH_MAX_CTRLS 10
2074 #define SLAP_CTRL_FRONTEND 0x80000000U
2075 #define SLAP_CTRL_FRONTEND_SEARCH 0x01000000U /* for NOOP */
2077 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2078 #define SLAP_CTRL_ABANDON 0x00000001U
2079 #define SLAP_CTRL_ADD 0x00002002U
2080 #define SLAP_CTRL_BIND 0x00000004U
2081 #define SLAP_CTRL_COMPARE 0x00001008U
2082 #define SLAP_CTRL_DELETE 0x00002010U
2083 #define SLAP_CTRL_MODIFY 0x00002020U
2084 #define SLAP_CTRL_RENAME 0x00002040U
2085 #define SLAP_CTRL_SEARCH 0x00001080U
2086 #define SLAP_CTRL_UNBIND 0x00000100U
2088 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2089 #define SLAP_CTRL_UPDATE \
2090 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2091 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2093 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2096 LDAPControl *ctrl ));
2100 #include "proto-slap.h"
2102 #endif /* _SLAP_H_ */