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;
319 slap_syntax_transform_func *ssyn_normalize;
320 slap_syntax_transform_func *ssyn_pretty;
322 #ifdef SLAPD_BINARY_CONVERSION
323 /* convert to and from binary */
324 slap_syntax_transform_func *ssyn_ber2str;
325 slap_syntax_transform_func *ssyn_str2ber;
328 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
331 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
332 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
333 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
334 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
335 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
337 typedef struct slap_syntax_defs_rec {
340 slap_syntax_validate_func *sd_validate;
341 slap_syntax_transform_func *sd_normalize;
342 slap_syntax_transform_func *sd_pretty;
343 #ifdef SLAPD_BINARY_CONVERSION
344 slap_syntax_transform_func *sd_ber2str;
345 slap_syntax_transform_func *sd_str2ber;
347 } slap_syntax_defs_rec;
349 /* X -> Y Converter */
350 typedef int slap_mr_convert_func LDAP_P((
352 struct berval * out ));
355 typedef int slap_mr_normalize_func LDAP_P((
357 struct slap_syntax *syntax, /* NULL if in is asserted value */
358 struct slap_matching_rule *mr,
360 struct berval * out ));
362 /* Match (compare) function */
363 typedef int slap_mr_match_func LDAP_P((
366 struct slap_syntax *syntax, /* syntax of stored value */
367 struct slap_matching_rule *mr,
368 struct berval * value,
369 void * assertValue ));
371 /* Index generation function */
372 typedef int slap_mr_indexer_func LDAP_P((
375 struct slap_syntax *syntax, /* syntax of stored value */
376 struct slap_matching_rule *mr,
377 struct berval *prefix,
381 /* Filter index function */
382 typedef int slap_mr_filter_func LDAP_P((
385 struct slap_syntax *syntax, /* syntax of stored value */
386 struct slap_matching_rule *mr,
387 struct berval *prefix,
391 typedef struct slap_matching_rule_use MatchingRuleUse;
393 typedef struct slap_matching_rule {
394 LDAPMatchingRule smr_mrule;
395 MatchingRuleUse *smr_mru;
396 /* RFC2252 string representation */
397 struct berval smr_str;
400 * ber_len_t smr_oidlen;
401 * has been replaced by a struct berval that uses the value
402 * provided by smr_mrule.mr_oid; a macro that expands to
403 * the bv_len field of the berval is provided for backward
404 * compatibility. CAUTION: NEVER FREE THE BERVAL
406 struct berval smr_bvoid;
407 #define smr_oidlen smr_bvoid.bv_len
409 slap_mask_t smr_usage;
411 #define SLAP_MR_HIDE 0x8000U
413 #define SLAP_MR_TYPE_MASK 0x0F00U
414 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
415 #define SLAP_MR_USAGE 0x000FU
417 #define SLAP_MR_NONE 0x0000U
418 #define SLAP_MR_EQUALITY 0x0100U
419 #define SLAP_MR_ORDERING 0x0200U
420 #define SLAP_MR_SUBSTR 0x0400U
421 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
423 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
424 #define SLAP_MR_DN_FOLD 0x0008U
426 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
427 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
428 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
431 * normally the asserted value is expected to conform to
432 * assertion syntax specified in the matching rule, however
433 * at times (such as during individual value modification),
434 * the asserted value is expected to conform to the
435 * attribute's value syntax.
437 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
438 #define SLAP_MR_ATTRIBUTE_SYNTAX_MATCH 0x0001U
440 /* For SLAP_MR_ATTRIBUTE_SYNTAX_MATCHes, this flag indicates
441 * that the asserted value of the attribute syntax has been
442 * converted to the assertion syntax. (Not sure why we just
443 * don't clear the SLAP_MR_ATTRIBUTE_SYNTAX_MATCH flag instead.)
445 #define SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH 0x0002U
447 /* either or both the asserted value or attribute value
448 * may be provided in normalized form
450 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
451 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
453 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
454 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
455 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
456 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
458 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
459 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
460 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
461 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
462 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
463 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
465 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
466 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
467 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
468 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
471 slap_mr_convert_func *smr_convert;
472 slap_mr_normalize_func *smr_normalize;
473 slap_mr_match_func *smr_match;
474 slap_mr_indexer_func *smr_indexer;
475 slap_mr_filter_func *smr_filter;
478 * null terminated array of syntaxes compatible with this syntax
479 * note: when MS_EXT is set, this MUST NOT contain the assertion
480 * syntax of the rule. When MS_EXT is not set, it MAY.
482 Syntax **smr_compat_syntaxes;
484 struct slap_matching_rule *smr_associated;
485 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
487 #define smr_oid smr_mrule.mr_oid
488 #define smr_names smr_mrule.mr_names
489 #define smr_desc smr_mrule.mr_desc
490 #define smr_obsolete smr_mrule.mr_obsolete
491 #define smr_syntax_oid smr_mrule.mr_syntax_oid
492 #define smr_extensions smr_mrule.mr_extensions
495 struct slap_matching_rule_use {
496 LDAPMatchingRuleUse smru_mruleuse;
497 MatchingRule *smru_mr;
498 /* RFC2252 string representation */
499 struct berval smru_str;
501 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
503 #define smru_oid smru_mruleuse.mru_oid
504 #define smru_names smru_mruleuse.mru_names
505 #define smru_desc smru_mruleuse.mru_desc
506 #define smru_obsolete smru_mruleuse.mru_obsolete
507 #define smru_applies_oids smru_mruleuse.mru_applies_oids
509 #define smru_usage smru_mr->smr_usage
510 } /* MatchingRuleUse */ ;
512 typedef struct slap_mrule_defs_rec {
514 slap_mask_t mrd_usage;
515 char ** mrd_compat_syntaxes;
516 slap_mr_convert_func * mrd_convert;
517 slap_mr_normalize_func * mrd_normalize;
518 slap_mr_match_func * mrd_match;
519 slap_mr_indexer_func * mrd_indexer;
520 slap_mr_filter_func * mrd_filter;
522 char * mrd_associated;
523 } slap_mrule_defs_rec;
525 struct slap_backend_db;
529 typedef int (AttributeTypeSchemaCheckFN)(
530 struct slap_backend_db *be,
531 struct slap_entry *e,
532 struct slap_attr *attr,
534 char *textbuf, size_t textlen );
536 typedef struct slap_attribute_type {
537 LDAPAttributeType sat_atype;
538 struct berval sat_cname;
539 struct slap_attribute_type *sat_sup;
540 struct slap_attribute_type **sat_subtypes;
541 MatchingRule *sat_equality;
542 MatchingRule *sat_approx;
543 MatchingRule *sat_ordering;
544 MatchingRule *sat_substr;
547 AttributeTypeSchemaCheckFN *sat_check;
549 #define SLAP_AT_NONE 0x0000U
550 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
551 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
552 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
553 slap_mask_t sat_flags;
555 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
557 #define sat_oid sat_atype.at_oid
558 #define sat_names sat_atype.at_names
559 #define sat_desc sat_atype.at_desc
560 #define sat_obsolete sat_atype.at_obsolete
561 #define sat_sup_oid sat_atype.at_sup_oid
562 #define sat_equality_oid sat_atype.at_equality_oid
563 #define sat_ordering_oid sat_atype.at_ordering_oid
564 #define sat_substr_oid sat_atype.at_substr_oid
565 #define sat_syntax_oid sat_atype.at_syntax_oid
566 #define sat_single_value sat_atype.at_single_value
567 #define sat_collective sat_atype.at_collective
568 #define sat_no_user_mod sat_atype.at_no_user_mod
569 #define sat_usage sat_atype.at_usage
570 #define sat_extensions sat_atype.at_extensions
572 struct slap_attr_desc *sat_ad;
573 ldap_pvt_thread_mutex_t sat_ad_mutex;
576 #define is_at_operational(at) ((at)->sat_usage)
577 #define is_at_single_value(at) ((at)->sat_single_value)
578 #define is_at_collective(at) ((at)->sat_collective)
579 #define is_at_obsolete(at) ((at)->sat_obsolete)
580 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
582 struct slap_object_class;
584 typedef int (ObjectClassSchemaCheckFN)(
585 struct slap_backend_db *be,
586 struct slap_entry *e,
587 struct slap_object_class *oc,
589 char *textbuf, size_t textlen );
591 typedef struct slap_object_class {
592 LDAPObjectClass soc_oclass;
593 struct berval soc_cname;
594 struct slap_object_class **soc_sups;
595 AttributeType **soc_required;
596 AttributeType **soc_allowed;
597 ObjectClassSchemaCheckFN *soc_check;
598 slap_mask_t soc_flags;
599 #define soc_oid soc_oclass.oc_oid
600 #define soc_names soc_oclass.oc_names
601 #define soc_desc soc_oclass.oc_desc
602 #define soc_obsolete soc_oclass.oc_obsolete
603 #define soc_sup_oids soc_oclass.oc_sup_oids
604 #define soc_kind soc_oclass.oc_kind
605 #define soc_at_oids_must soc_oclass.oc_at_oids_must
606 #define soc_at_oids_may soc_oclass.oc_at_oids_may
607 #define soc_extensions soc_oclass.oc_extensions
609 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
612 #define SLAP_OC_ALIAS 0x0001
613 #define SLAP_OC_REFERRAL 0x0002
614 #define SLAP_OC_SUBENTRY 0x0004
615 #define SLAP_OC_DYNAMICOBJECT 0x0008
616 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
617 #define SLAP_OC__MASK 0x001F
618 #define SLAP_OC__END 0x0020
619 #define SLAP_OC_OPERATIONAL 0x4000
620 #define SLAP_OC_HIDE 0x8000
625 typedef struct slap_content_rule {
626 LDAPContentRule scr_crule;
627 ObjectClass *scr_sclass;
628 ObjectClass **scr_auxiliaries; /* optional */
629 AttributeType **scr_required; /* optional */
630 AttributeType **scr_allowed; /* optional */
631 AttributeType **scr_precluded; /* optional */
632 #define scr_oid scr_crule.cr_oid
633 #define scr_names scr_crule.cr_names
634 #define scr_desc scr_crule.cr_desc
635 #define scr_obsolete scr_crule.cr_obsolete
636 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
637 #define scr_at_oids_must scr_crule.cr_at_oids_must
638 #define scr_at_oids_may scr_crule.cr_at_oids_may
639 #define scr_at_oids_not scr_crule.cr_at_oids_not
641 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
644 /* Represents a recognized attribute description ( type + options ). */
645 typedef struct slap_attr_desc {
646 struct slap_attr_desc *ad_next;
647 AttributeType *ad_type; /* attribute type, must be specified */
648 struct berval ad_cname; /* canonical name, must be specified */
649 struct berval ad_tags; /* empty if no tagging options */
651 #define SLAP_DESC_NONE 0x00U
652 #define SLAP_DESC_BINARY 0x01U
653 #define SLAP_DESC_TAG_RANGE 0x80U
654 } AttributeDescription;
656 typedef struct slap_attr_name {
657 struct berval an_name;
658 AttributeDescription *an_desc;
662 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
663 #define slap_ad_is_tag_range(ad) \
664 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
665 #define slap_ad_is_binary(ad) \
666 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
669 * pointers to schema elements used internally
671 struct slap_internal_schema {
673 ObjectClass *si_oc_top;
674 ObjectClass *si_oc_extensibleObject;
675 ObjectClass *si_oc_alias;
676 ObjectClass *si_oc_referral;
677 ObjectClass *si_oc_rootdse;
678 ObjectClass *si_oc_subentry;
679 ObjectClass *si_oc_subschema;
680 ObjectClass *si_oc_monitor;
681 ObjectClass *si_oc_collectiveAttributeSubentry;
682 ObjectClass *si_oc_dynamicObject;
684 /* objectClass attribute descriptions */
685 AttributeDescription *si_ad_objectClass;
687 /* operational attribute descriptions */
688 AttributeDescription *si_ad_structuralObjectClass;
689 AttributeDescription *si_ad_creatorsName;
690 AttributeDescription *si_ad_createTimestamp;
691 AttributeDescription *si_ad_modifiersName;
692 AttributeDescription *si_ad_modifyTimestamp;
693 AttributeDescription *si_ad_hasSubordinates;
694 AttributeDescription *si_ad_subschemaSubentry;
695 AttributeDescription *si_ad_collectiveSubentries;
696 AttributeDescription *si_ad_collectiveExclusions;
697 AttributeDescription *si_ad_entryUUID;
698 AttributeDescription *si_ad_entryCSN;
699 AttributeDescription *si_ad_superiorUUID;
701 /* root DSE attribute descriptions */
702 AttributeDescription *si_ad_altServer;
703 AttributeDescription *si_ad_namingContexts;
704 AttributeDescription *si_ad_supportedControl;
705 AttributeDescription *si_ad_supportedExtension;
706 AttributeDescription *si_ad_supportedLDAPVersion;
707 AttributeDescription *si_ad_supportedSASLMechanisms;
708 AttributeDescription *si_ad_supportedFeatures;
709 AttributeDescription *si_ad_monitorContext;
710 AttributeDescription *si_ad_vendorName;
711 AttributeDescription *si_ad_vendorVersion;
713 /* subentry attribute descriptions */
714 AttributeDescription *si_ad_administrativeRole;
715 AttributeDescription *si_ad_subtreeSpecification;
717 /* subschema subentry attribute descriptions */
718 AttributeDescription *si_ad_ditStructureRules;
719 AttributeDescription *si_ad_ditContentRules;
720 AttributeDescription *si_ad_nameForms;
721 AttributeDescription *si_ad_objectClasses;
722 AttributeDescription *si_ad_attributeTypes;
723 AttributeDescription *si_ad_ldapSyntaxes;
724 AttributeDescription *si_ad_matchingRules;
725 AttributeDescription *si_ad_matchingRuleUse;
727 /* Aliases & Referrals */
728 AttributeDescription *si_ad_aliasedObjectName;
729 AttributeDescription *si_ad_ref;
731 /* Access Control Internals */
732 AttributeDescription *si_ad_entry;
733 AttributeDescription *si_ad_children;
734 AttributeDescription *si_ad_saslAuthzTo;
735 AttributeDescription *si_ad_saslAuthzFrom;
736 #ifdef SLAPD_ACI_ENABLED
737 AttributeDescription *si_ad_aci;
740 /* dynamic entries */
741 AttributeDescription *si_ad_entryTtl;
742 AttributeDescription *si_ad_dynamicSubtrees;
744 /* Other attributes descriptions */
745 AttributeDescription *si_ad_distinguishedName;
746 AttributeDescription *si_ad_name;
747 AttributeDescription *si_ad_cn;
748 AttributeDescription *si_ad_userPassword;
749 #ifdef SLAPD_AUTHPASSWD
750 AttributeDescription *si_ad_authPassword;
752 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
753 AttributeDescription *si_ad_krbName;
756 /* Undefined Attribute Type */
757 AttributeType *si_at_undefined;
760 MatchingRule *si_mr_distinguishedNameMatch;
761 MatchingRule *si_mr_integerMatch;
764 Syntax *si_syn_octetString;
765 Syntax *si_syn_distinguishedName;
766 Syntax *si_syn_integer;
769 typedef struct slap_attr_assertion {
770 AttributeDescription *aa_desc;
771 struct berval aa_value;
772 } AttributeAssertion;
774 typedef struct slap_ss_assertion {
775 AttributeDescription *sa_desc;
776 struct berval sa_initial;
777 struct berval *sa_any;
778 struct berval sa_final;
779 } SubstringsAssertion;
781 typedef struct slap_mr_assertion {
782 MatchingRule *ma_rule; /* optional */
783 struct berval ma_rule_text; /* optional */
784 AttributeDescription *ma_desc; /* optional */
785 int ma_dnattrs; /* boolean */
786 struct berval ma_value; /* required */
787 } MatchingRuleAssertion;
790 * represents a search filter
792 typedef struct slap_filter {
793 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
794 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
795 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
796 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
799 /* precomputed result */
800 ber_int_t f_un_result;
803 struct berval *f_un_dn;
806 AttributeDescription *f_un_desc;
808 /* simple value assertion */
809 AttributeAssertion *f_un_ava;
811 /* substring assertion */
812 SubstringsAssertion *f_un_ssa;
814 /* matching rule assertion */
815 MatchingRuleAssertion *f_un_mra;
817 #define f_dn f_un.f_un_dn
818 #define f_desc f_un.f_un_desc
819 #define f_ava f_un.f_un_ava
820 #define f_av_desc f_un.f_un_ava->aa_desc
821 #define f_av_value f_un.f_un_ava->aa_value
822 #define f_sub f_un.f_un_ssa
823 #define f_sub_desc f_un.f_un_ssa->sa_desc
824 #define f_sub_initial f_un.f_un_ssa->sa_initial
825 #define f_sub_any f_un.f_un_ssa->sa_any
826 #define f_sub_final f_un.f_un_ssa->sa_final
827 #define f_mra f_un.f_un_mra
828 #define f_mr_rule f_un.f_un_mra->ma_rule
829 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
830 #define f_mr_desc f_un.f_un_mra->ma_desc
831 #define f_mr_value f_un.f_un_mra->ma_value
832 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
835 struct slap_filter *f_un_complex;
838 #define f_result f_un.f_un_result
839 #define f_and f_un.f_un_complex
840 #define f_or f_un.f_un_complex
841 #define f_not f_un.f_un_complex
842 #define f_list f_un.f_un_complex
844 struct slap_filter *f_next;
847 /* compare routines can return undefined */
848 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
850 typedef struct slap_valuesreturnfilter {
851 ber_tag_t vrf_choice;
854 /* precomputed result */
855 ber_int_t vrf_un_result;
861 AttributeDescription *vrf_un_desc;
863 /* simple value assertion */
864 AttributeAssertion *vrf_un_ava;
866 /* substring assertion */
867 SubstringsAssertion *vrf_un_ssa;
869 /* matching rule assertion */
870 MatchingRuleAssertion *vrf_un_mra;
872 #define vrf_result vrf_un.vrf_un_result
873 #define vrf_dn vrf_un.vrf_un_dn
874 #define vrf_desc vrf_un.vrf_un_desc
875 #define vrf_ava vrf_un.vrf_un_ava
876 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
877 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
878 #define vrf_ssa vrf_un.vrf_un_ssa
879 #define vrf_sub vrf_un.vrf_un_ssa
880 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
881 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
882 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
883 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
884 #define vrf_mra vrf_un.vrf_un_mra
885 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
886 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
887 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
888 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
889 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
894 struct slap_valuesreturnfilter *vrf_next;
895 } ValuesReturnFilter;
898 * represents an attribute (description + values)
900 typedef struct slap_attr {
901 AttributeDescription *a_desc;
902 BerVarray a_vals; /* preserved values */
904 BerVarray a_nvals; /* normalized values */
906 struct slap_attr *a_next;
908 #define SLAP_ATTR_IXADD 0x1U
909 #define SLAP_ATTR_IXDEL 0x2U
914 * the id used in the indexes to refer to an entry
916 typedef unsigned long ID;
917 #define NOID ((ID)~0)
920 * represents an entry in core
922 typedef struct slap_entry {
924 * The ID field should only be changed before entry is
925 * inserted into a cache. The ID value is backend
930 struct berval e_name; /* name (DN) of this entry */
931 struct berval e_nname; /* normalized name (DN) of this entry */
933 /* for migration purposes */
934 #define e_dn e_name.bv_val
935 #define e_ndn e_nname.bv_val
937 Attribute *e_attrs; /* list of attributes + values */
939 slap_mask_t e_ocflags;
941 struct berval e_bv; /* For entry_encode/entry_decode */
943 /* for use by the backend for any purpose */
950 typedef struct slap_mod {
952 AttributeDescription *sm_desc;
953 struct berval sm_type;
955 #define sm_bvalues sm_values
957 BerVarray sm_nvalues;
961 typedef struct slap_mod_list {
962 Modification sml_mod;
963 #define sml_op sml_mod.sm_op
964 #define sml_desc sml_mod.sm_desc
965 #define sml_type sml_mod.sm_type
966 #define sml_bvalues sml_mod.sm_values
967 #define sml_values sml_mod.sm_values
968 #define sml_nvalues sml_mod.sm_nvalues
969 struct slap_mod_list *sml_next;
972 typedef struct slap_ldap_modlist {
974 struct slap_ldap_modlist *ml_next;
975 #define ml_op ml_mod.mod_op
976 #define ml_type ml_mod.mod_type
977 #define ml_values ml_mod.mod_values
978 #define ml_bvalues ml_mod.mod_values
982 * represents an access control list
984 typedef enum slap_access_e {
985 ACL_INVALID_ACCESS = -1,
994 typedef enum slap_control_e {
995 ACL_INVALID_CONTROL = 0,
1001 typedef enum slap_style_e {
1002 ACL_STYLE_REGEX = 0,
1009 /* alternate names */
1010 ACL_STYLE_EXACT = ACL_STYLE_BASE
1013 typedef struct slap_authz_info {
1014 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1015 struct berval sai_mech; /* SASL Mechanism */
1016 struct berval sai_dn; /* DN for reporting purposes */
1017 struct berval sai_ndn; /* Normalized DN */
1019 /* Security Strength Factors */
1020 slap_ssf_t sai_ssf; /* Overall SSF */
1021 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1022 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1023 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1024 } AuthorizationInformation;
1027 typedef struct slap_access {
1028 slap_control_t a_type;
1030 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1032 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1033 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1034 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1035 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1036 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1037 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1039 #define ACL_PRIV_MASK 0x00ffUL
1042 #define ACL_PRIV_LEVEL 0x1000UL
1043 #define ACL_PRIV_ADDITIVE 0x2000UL
1044 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1047 #define ACL_PRIV_INVALID 0x0UL
1049 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1050 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1051 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1052 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1054 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1055 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1057 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1059 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1061 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1062 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1063 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1065 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1066 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1067 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1068 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1069 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1070 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1072 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1073 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1074 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1075 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1076 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1077 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1078 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1080 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1081 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1082 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1083 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1084 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1085 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1087 slap_mask_t a_access_mask;
1089 AuthorizationInformation a_authz;
1090 #define a_dn_pat a_authz.sai_dn
1092 slap_style_t a_dn_style;
1093 AttributeDescription *a_dn_at;
1097 slap_style_t a_peername_style;
1098 struct berval a_peername_pat;
1099 slap_style_t a_sockname_style;
1100 struct berval a_sockname_pat;
1102 slap_style_t a_domain_style;
1103 struct berval a_domain_pat;
1104 int a_domain_expand;
1106 slap_style_t a_sockurl_style;
1107 struct berval a_sockurl_pat;
1108 slap_style_t a_set_style;
1109 struct berval a_set_pat;
1111 #ifdef SLAPD_ACI_ENABLED
1112 AttributeDescription *a_aci_at;
1116 slap_style_t a_group_style;
1117 struct berval a_group_pat;
1118 ObjectClass *a_group_oc;
1119 AttributeDescription *a_group_at;
1121 struct slap_access *a_next;
1125 typedef struct slap_acl {
1126 /* "to" part: the entries this acl applies to */
1128 slap_style_t acl_dn_style;
1130 struct berval acl_dn_pat;
1131 AttributeName *acl_attrs;
1133 /* "by" part: list of who has what access to the entries */
1136 struct slap_acl *acl_next;
1139 typedef struct slap_acl_state {
1140 unsigned as_recorded;
1141 #define ACL_STATE_NOT_RECORDED 0x0
1142 #define ACL_STATE_RECORDED_VD 0x1
1143 #define ACL_STATE_RECORDED_NV 0x2
1144 #define ACL_STATE_RECORDED 0x3
1147 AccessControl *as_vd_acl;
1148 AccessControl *as_vi_acl;
1149 slap_mask_t as_vd_acl_mask;
1150 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1151 int as_vd_acl_count;
1153 Access *as_vd_access;
1154 int as_vd_access_count;
1157 AttributeDescription *as_vd_ad;
1158 } AccessControlState;
1159 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1160 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1163 * replog moddn param structure
1165 struct slap_replog_moddn {
1166 struct berval *newrdn;
1168 struct berval *newsup;
1173 * represents a backend
1176 typedef struct slap_backend_info BackendInfo; /* per backend type */
1177 typedef struct slap_backend_db BackendDB; /* per backend database */
1179 LDAP_SLAPD_V (int) nBackendInfo;
1180 LDAP_SLAPD_V (int) nBackendDB;
1181 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1182 LDAP_SLAPD_V (BackendDB *) backendDB;
1184 LDAP_SLAPD_V (int) slapMode;
1185 #define SLAP_UNDEFINED_MODE 0x0000
1186 #define SLAP_SERVER_MODE 0x0001
1187 #define SLAP_TOOL_MODE 0x0002
1188 #define SLAP_MODE 0x0003
1190 #define SLAP_TRUNCATE_MODE 0x0100
1192 struct slap_replica_info {
1193 char *ri_host; /* supersedes be_replica */
1194 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1195 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1196 int ri_exclude; /* 1 => exclude ri_attrs */
1199 struct slap_limits_set {
1207 int lms_s_unchecked;
1212 struct slap_limits {
1213 int lm_type; /* type of pattern */
1214 #define SLAP_LIMITS_UNDEFINED 0x0000
1215 #define SLAP_LIMITS_EXACT 0x0001
1216 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1217 #define SLAP_LIMITS_ONE 0x0002
1218 #define SLAP_LIMITS_SUBTREE 0x0003
1219 #define SLAP_LIMITS_CHILDREN 0x0004
1220 #define SLAP_LIMITS_REGEX 0x0005
1221 #define SLAP_LIMITS_ANONYMOUS 0x0006
1222 #define SLAP_LIMITS_USERS 0x0007
1223 #define SLAP_LIMITS_ANY 0x0008
1224 regex_t lm_dn_regex; /* regex data for REGEX */
1227 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1228 * pattern for REGEX; NULL for ANONYMOUS, USERS
1230 struct berval lm_dn_pat;
1232 struct slap_limits_set lm_limits;
1235 /* temporary aliases */
1236 typedef BackendDB Backend;
1237 #define nbackends nBackendDB
1238 #define backends backendDB
1240 struct slap_backend_db {
1241 BackendInfo *bd_info; /* pointer to shared backend info */
1243 /* BackendInfo accessors */
1244 #define be_config bd_info->bi_db_config
1245 #define be_type bd_info->bi_type
1247 #define be_bind bd_info->bi_op_bind
1248 #define be_unbind bd_info->bi_op_unbind
1249 #define be_add bd_info->bi_op_add
1250 #define be_compare bd_info->bi_op_compare
1251 #define be_delete bd_info->bi_op_delete
1252 #define be_modify bd_info->bi_op_modify
1253 #define be_modrdn bd_info->bi_op_modrdn
1254 #define be_search bd_info->bi_op_search
1255 #define be_abandon bd_info->bi_op_abandon
1256 #define be_cancel bd_info->bi_op_cancel
1258 #define be_extended bd_info->bi_extended
1260 #define be_release bd_info->bi_entry_release_rw
1261 #define be_chk_referrals bd_info->bi_chk_referrals
1262 #define be_group bd_info->bi_acl_group
1263 #define be_attribute bd_info->bi_acl_attribute
1264 #define be_operational bd_info->bi_operational
1267 * define to honor hasSubordinates operational attribute in search filters
1268 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1271 #define be_has_subordinates bd_info->bi_has_subordinates
1273 #define be_controls bd_info->bi_controls
1275 #define be_connection_init bd_info->bi_connection_init
1276 #define be_connection_destroy bd_info->bi_connection_destroy
1279 #define be_entry_open bd_info->bi_tool_entry_open
1280 #define be_entry_close bd_info->bi_tool_entry_close
1281 #define be_entry_first bd_info->bi_tool_entry_first
1282 #define be_entry_next bd_info->bi_tool_entry_next
1283 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1284 #define be_entry_get bd_info->bi_tool_entry_get
1285 #define be_entry_put bd_info->bi_tool_entry_put
1286 #define be_sync bd_info->bi_tool_sync
1289 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1290 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1291 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1292 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1293 #define SLAP_BFLAG_ALIASES 0x0100U
1294 #define SLAP_BFLAG_REFERRALS 0x0200U
1295 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1296 #define SLAP_BFLAG_MONITOR 0x1000U
1297 #define SLAP_BFLAG_DYNAMIC 0x2000U
1298 slap_mask_t be_flags;
1299 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1300 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1301 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1302 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1303 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1304 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1306 slap_mask_t be_restrictops; /* restriction operations */
1307 #define SLAP_RESTRICT_OP_ADD 0x0001U
1308 #define SLAP_RESTRICT_OP_BIND 0x0002U
1309 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1310 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1311 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1312 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1313 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1314 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1316 #define SLAP_RESTRICT_OP_READS \
1317 ( SLAP_RESTRICT_OP_COMPARE \
1318 | SLAP_RESTRICT_OP_SEARCH )
1319 #define SLAP_RESTRICT_OP_WRITES \
1320 ( SLAP_RESTRICT_OP_ADD \
1321 | SLAP_RESTRICT_OP_DELETE \
1322 | SLAP_RESTRICT_OP_MODIFY \
1323 | SLAP_RESTRICT_OP_RENAME )
1325 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1326 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1327 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1329 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1331 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1332 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1333 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1334 0x0004U /* unprotected simple auth */
1335 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1337 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1338 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1340 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1342 slap_mask_t be_requires; /* pre-operation requirements */
1343 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1344 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1345 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1346 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1347 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1349 /* Required Security Strength Factor */
1350 slap_ssf_set_t be_ssf_set;
1352 /* these should be renamed from be_ to bd_ */
1353 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1354 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1355 struct berval be_schemadn; /* per-backend subschema subentry DN */
1356 struct berval be_schemandn; /* normalized subschema DN */
1357 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1358 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1359 struct berval be_rootpw; /* the magic "root" password for this db */
1360 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1361 #define be_sizelimit be_def_limit.lms_s_soft
1362 #define be_timelimit be_def_limit.lms_t_soft
1363 struct slap_limits_set be_def_limit; /* default limits */
1364 struct slap_limits **be_limits; /* regex-based size and time limits */
1365 AccessControl *be_acl; /* access control list for this backend */
1366 slap_access_t be_dfltaccess; /* access given if no acl matches */
1367 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1368 char *be_replogfile; /* replication log file (in master) */
1369 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1370 BerVarray be_update_refs; /* where to refer modifying clients to */
1372 void *be_private; /* anything the backend database needs */
1374 void *be_pb; /* Netscape plugin */
1380 /* Backend function typedefs */
1381 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1382 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1383 const char *fname, int lineno,
1384 int argc, char **argv));
1385 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1386 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1387 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1389 typedef int (BI_db_init) LDAP_P((Backend *bd));
1390 typedef int (BI_db_config) LDAP_P((Backend *bd,
1391 const char *fname, int lineno,
1392 int argc, char **argv));
1393 typedef int (BI_db_open) LDAP_P((Backend *bd));
1394 typedef int (BI_db_close) LDAP_P((Backend *bd));
1395 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1397 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1398 struct slap_conn *c, struct slap_op *o,
1399 struct berval *dn, struct berval *ndn, int method,
1400 struct berval *cred, struct berval *edn ));
1401 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1402 struct slap_conn *c, struct slap_op *o ));
1403 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1404 struct slap_conn *c, struct slap_op *o,
1405 struct berval *base, struct berval *nbase,
1406 int scope, int deref,
1407 int slimit, int tlimit,
1408 Filter *f, struct berval *filterstr,
1409 AttributeName *attrs, int attrsonly));
1410 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1411 struct slap_conn *c, struct slap_op *o,
1412 struct berval *dn, struct berval *ndn,
1413 AttributeAssertion *ava));
1414 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1415 struct slap_conn *c, struct slap_op *o,
1416 struct berval *dn, struct berval *ndn,
1418 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1419 struct slap_conn *c, struct slap_op *o,
1420 struct berval *dn, struct berval *ndn,
1421 struct berval *newrdn, struct berval *nnewrdn,
1423 struct berval *newSup, struct berval *nnewSup ));
1424 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1425 struct slap_conn *c, struct slap_op *o,
1427 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1428 struct slap_conn *c, struct slap_op *o,
1429 struct berval *dn, struct berval *ndn));
1430 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1431 struct slap_conn *c, struct slap_op *o,
1433 typedef int (BI_op_cancel) LDAP_P((BackendDB *bd,
1434 struct slap_conn *c, struct slap_op *o,
1437 typedef int (BI_op_extended) LDAP_P((
1439 struct slap_conn *conn,
1441 struct berval *reqoid,
1442 struct berval * reqdata,
1444 struct berval ** rspdata,
1445 LDAPControl *** rspctrls,
1449 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1450 struct slap_conn *c, struct slap_op *o,
1453 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1454 struct slap_conn *c, struct slap_op *o,
1455 struct berval *dn, struct berval *ndn,
1456 const char **text ));
1458 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1459 struct slap_conn *c, struct slap_op *o,
1463 ObjectClass *group_oc,
1464 AttributeDescription *group_at ));
1466 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1467 struct slap_conn *c, struct slap_op *o,
1468 Entry *e, struct berval *edn,
1469 AttributeDescription *entry_at,
1472 typedef int (BI_operational) LDAP_P((Backend *bd,
1473 struct slap_conn *c, struct slap_op *o,
1474 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1476 typedef int (BI_has_subordinates) LDAP_P((Backend *bd,
1477 struct slap_conn *c, struct slap_op *o,
1478 Entry *e, int *has_subordinates ));
1480 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1481 struct slap_conn *c));
1482 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1483 struct slap_conn *c));
1485 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1486 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1487 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1488 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1489 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1490 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1491 struct berval *text ));
1492 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1493 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1495 struct slap_backend_info {
1496 char *bi_type; /* type of backend */
1499 * per backend type routines:
1500 * bi_init: called to allocate a backend_info structure,
1501 * called once BEFORE configuration file is read.
1502 * bi_init() initializes this structure hence is
1503 * called directly from be_initialize()
1504 * bi_config: called per 'backend' specific option
1505 * all such options must before any 'database' options
1506 * bi_config() is called only from read_config()
1507 * bi_open: called to open each database, called
1508 * once AFTER configuration file is read but
1509 * BEFORE any bi_db_open() calls.
1510 * bi_open() is called from backend_startup()
1511 * bi_close: called to close each database, called
1512 * once during shutdown after all bi_db_close calls.
1513 * bi_close() is called from backend_shutdown()
1514 * bi_destroy: called to destroy each database, called
1515 * once during shutdown after all bi_db_destroy calls.
1516 * bi_destory() is called from backend_destroy()
1519 BI_config *bi_config;
1522 BI_destroy *bi_destroy;
1525 * per database routines:
1526 * bi_db_init: called to initialize each database,
1527 * called upon reading 'database <type>'
1528 * called only from backend_db_init()
1529 * bi_db_config: called to configure each database,
1530 * called per database to handle per database options
1531 * called only from read_config()
1532 * bi_db_open: called to open each database
1533 * called once per database immediately AFTER bi_open()
1534 * calls but before daemon startup.
1535 * called only by backend_startup()
1536 * bi_db_close: called to close each database
1537 * called once per database during shutdown but BEFORE
1538 * any bi_close call.
1539 * called only by backend_shutdown()
1540 * bi_db_destroy: called to destroy each database
1541 * called once per database during shutdown AFTER all
1542 * bi_close calls but before bi_destory calls.
1543 * called only by backend_destory()
1545 BI_db_init *bi_db_init;
1546 BI_db_config *bi_db_config;
1547 BI_db_open *bi_db_open;
1548 BI_db_close *bi_db_close;
1549 BI_db_destroy *bi_db_destroy;
1551 /* LDAP Operations Handling Routines */
1552 BI_op_bind *bi_op_bind;
1553 BI_op_unbind *bi_op_unbind;
1554 BI_op_search *bi_op_search;
1555 BI_op_compare *bi_op_compare;
1556 BI_op_modify *bi_op_modify;
1557 BI_op_modrdn *bi_op_modrdn;
1558 BI_op_add *bi_op_add;
1559 BI_op_delete *bi_op_delete;
1560 BI_op_abandon *bi_op_abandon;
1561 BI_op_cancel *bi_op_cancel;
1563 /* Extended Operations Helper */
1564 BI_op_extended *bi_extended;
1566 /* Auxilary Functions */
1567 BI_entry_release_rw *bi_entry_release_rw;
1568 BI_chk_referrals *bi_chk_referrals;
1570 BI_acl_group *bi_acl_group;
1571 BI_acl_attribute *bi_acl_attribute;
1573 BI_operational *bi_operational;
1574 BI_has_subordinates *bi_has_subordinates;
1576 BI_connection_init *bi_connection_init;
1577 BI_connection_destroy *bi_connection_destroy;
1579 /* hooks for slap tools */
1580 BI_tool_entry_open *bi_tool_entry_open;
1581 BI_tool_entry_close *bi_tool_entry_close;
1582 BI_tool_entry_first *bi_tool_entry_first;
1583 BI_tool_entry_next *bi_tool_entry_next;
1584 BI_tool_entry_get *bi_tool_entry_get;
1585 BI_tool_entry_put *bi_tool_entry_put;
1586 BI_tool_entry_reindex *bi_tool_entry_reindex;
1587 BI_tool_sync *bi_tool_sync;
1589 #define SLAP_INDEX_ADD_OP 0x0001
1590 #define SLAP_INDEX_DELETE_OP 0x0002
1592 char **bi_controls; /* supported controls */
1594 unsigned int bi_nDB; /* number of databases of this type */
1595 void *bi_private; /* anything the backend type needs */
1598 #define c_authtype c_authz.sai_method
1599 #define c_authmech c_authz.sai_mech
1600 #define c_dn c_authz.sai_dn
1601 #define c_ndn c_authz.sai_ndn
1602 #define c_ssf c_authz.sai_ssf
1603 #define c_transport_ssf c_authz.sai_transport_ssf
1604 #define c_tls_ssf c_authz.sai_tls_ssf
1605 #define c_sasl_ssf c_authz.sai_sasl_ssf
1607 #define o_authtype o_authz.sai_method
1608 #define o_authmech o_authz.sai_mech
1609 #define o_dn o_authz.sai_dn
1610 #define o_ndn o_authz.sai_ndn
1611 #define o_ssf o_authz.sai_ssf
1612 #define o_transport_ssf o_authz.sai_transport_ssf
1613 #define o_tls_ssf o_authz.sai_tls_ssf
1614 #define o_sasl_ssf o_authz.sai_sasl_ssf
1616 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1617 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1618 BerVarray, const char *, struct berval *,
1619 struct berval *, LDAPControl ** );
1621 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1622 ber_int_t, const char *, const char *, BerVarray,
1623 LDAPControl **, int nentries);
1625 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1626 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1628 typedef int (slap_sendreference)( BackendDB *, struct slap_conn *,
1629 struct slap_op *, Entry *, BerVarray, LDAPControl **, BerVarray * );
1631 typedef struct slap_callback {
1632 slap_response *sc_response;
1633 slap_sresult *sc_sresult;
1634 slap_sendentry *sc_sendentry;
1635 slap_sendreference *sc_sendreference;
1640 * Paged Results state
1642 typedef unsigned long PagedResultsCookie;
1643 typedef struct slap_paged_state {
1645 PagedResultsCookie ps_cookie;
1647 } PagedResultsState;
1650 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1651 #define LDAP_PSEARCH_BY_ADD 0x01
1652 #define LDAP_PSEARCH_BY_DELETE 0x02
1653 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1654 #define LDAP_PSEARCH_BY_MODIFY 0x04
1655 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1657 struct ldap_psearch_spec {
1659 struct berval *base;
1660 struct berval *nbase;
1666 struct berval *filterstr;
1667 AttributeName *attrs;
1671 LDAP_LIST_ENTRY(ldap_psearch_spec) link;
1675 struct ldap_psearch_spec* ps;
1676 LDAP_LIST_ENTRY(psid_entry) link;
1682 * represents an operation pending from an ldap client
1684 typedef struct slap_op {
1685 unsigned long o_opid; /* id of this operation */
1686 unsigned long o_connid; /* id of conn initiating this op */
1687 struct slap_conn *o_conn; /* connection spawning this op */
1689 ber_int_t o_msgid; /* msgid of the request */
1690 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1691 ber_tag_t o_tag; /* tag of the request */
1692 time_t o_time; /* time op was initiated */
1694 char * o_extendedop; /* extended operation OID */
1696 ldap_pvt_thread_t o_tid; /* thread handling this op */
1698 volatile sig_atomic_t o_abandon; /* abandon flag */
1699 volatile sig_atomic_t o_cancel; /* cancel flag */
1700 #define SLAP_CANCEL_NONE 0x00
1701 #define SLAP_CANCEL_REQ 0x01
1702 #define SLAP_CANCEL_ACK 0x02
1703 #define SLAP_CANCEL_DONE 0x03
1705 char o_do_not_cache; /* don't cache from this op */
1707 #define SLAP_NO_CONTROL 0
1708 #define SLAP_NONCRITICAL_CONTROL 1
1709 #define SLAP_CRITICAL_CONTROL 2
1711 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1717 #define get_subentries(op) ((int)(op)->o_subentries)
1718 char o_subentries_visibility;
1719 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1721 char o_valuesreturnfilter;
1723 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1724 char o_permissive_modify;
1725 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1727 #define get_permissiveModify(op) (0)
1730 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1731 char o_domain_scope;
1732 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1734 #define get_domainScope(op) (0)
1737 #ifdef LDAP_CONTROL_PAGEDRESULTS
1738 char o_pagedresults;
1739 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1740 ber_int_t o_pagedresults_size;
1741 PagedResultsState o_pagedresults_state;
1743 #define get_pagedresults(op) (0)
1746 #ifdef LDAP_CLIENT_UPDATE
1747 char o_clientupdate;
1748 char o_clientupdate_type;
1749 #define SLAP_LCUP_NONE (0x0)
1750 #define SLAP_LCUP_SYNC (0x1)
1751 #define SLAP_LCUP_PERSIST (0x2)
1752 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1753 ber_int_t o_clientupdate_interval;
1754 struct berval o_clientupdate_state;
1760 #define SLAP_SYNC_NONE (0x0)
1761 #define SLAP_SYNC_REFRESH (0x1)
1762 #define SLAP_SYNC_PERSIST (0x2)
1763 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1764 struct berval o_sync_state;
1767 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1768 LDAP_LIST_HEAD(lss, ldap_psearch_spec) psearch_spec;
1769 LDAP_LIST_HEAD(pe, psid_entry) premodify_list;
1770 LDAP_LIST_ENTRY(slap_op) link;
1773 #ifdef LDAP_CONNECTIONLESS
1774 Sockaddr o_peeraddr; /* UDP peer address */
1776 AuthorizationInformation o_authz;
1778 BerElement *o_ber; /* ber of the request */
1779 #ifdef LDAP_CONNECTIONLESS
1780 BerElement *o_res_ber; /* ber of the reply */
1782 slap_callback *o_callback; /* callback pointers */
1783 LDAPControl **o_ctrls; /* controls */
1785 void *o_threadctx; /* thread pool thread context */
1786 void *o_private; /* anything the backend needs */
1788 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1789 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1792 void *o_pb; /* NS-SLAPI plugin */
1796 typedef void (*SEND_LDAP_RESULT)(
1797 struct slap_conn *conn,
1800 const char *matched,
1806 #define send_ldap_result( conn, op, err, matched, text, ref, ctrls ) \
1807 (*conn->c_send_ldap_result)( conn, op, err, matched, text, ref, ctrls )
1810 typedef int (*SEND_SEARCH_ENTRY)(
1811 struct slap_backend_db *be,
1812 struct slap_conn *conn,
1814 struct slap_entry *e,
1815 AttributeName *attrs,
1820 #define send_search_entry( be, conn, op, e, attrs, attrsonly, ctrls) \
1821 (*conn->c_send_search_entry)( be, conn, op, e, attrs, attrsonly, ctrls)
1824 typedef void (*SEND_SEARCH_RESULT)(
1825 struct slap_conn *conn,
1828 const char *matched,
1831 LDAPControl **ctrls,
1835 #define send_search_result( conn, op, err, matched, text, refs, ctrls, nentries ) \
1836 (*conn->c_send_search_result)( conn, op, err, matched, text, refs, ctrls, nentries )
1839 typedef int (*SEND_SEARCH_REFERENCE)(
1840 struct slap_backend_db *be,
1841 struct slap_conn *conn,
1843 struct slap_entry *e,
1845 LDAPControl **ctrls,
1849 #define send_search_reference( be, conn, op, e, refs, ctrls, v2refs ) \
1850 (*conn->c_send_search_reference)( be, conn, op, e, refs, ctrls, v2refs )
1853 typedef void (*SEND_LDAP_EXTENDED)(
1854 struct slap_conn *conn,
1857 const char *matched,
1861 struct berval *rspdata,
1865 #define send_ldap_extended( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls) \
1866 (*conn->c_send_ldap_extended)( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls )
1868 typedef void (*SEND_LDAP_INTERMEDIATE_RESP)(
1869 struct slap_conn *conn,
1872 const char *matched,
1876 struct berval *rspdata,
1880 #define send_ldap_intermediate_resp( conn, op, err, matched, text, refs, \
1881 rspoid, rspdata, ctrls) \
1882 (*conn->c_send_ldap_intermediate_resp)( conn, op, err, matched, text, \
1883 refs, rspoid, rspdata, ctrls )
1886 * Caches the result of a backend_group check for ACL evaluation
1888 typedef struct slap_gacl {
1889 struct slap_gacl *ga_next;
1892 AttributeDescription *ga_at;
1898 typedef struct slap_listener Listener;
1901 * represents a connection from an ldap client
1903 typedef struct slap_conn {
1904 int c_struct_state; /* structure management state */
1905 int c_conn_state; /* connection state */
1907 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1908 Sockbuf *c_sb; /* ber connection stuff */
1910 /* only can be changed by connect_init */
1911 time_t c_starttime; /* when the connection was opened */
1912 time_t c_activitytime; /* when the connection was last used */
1913 unsigned long c_connid; /* id of this connection for stats*/
1915 struct berval c_peer_domain; /* DNS name of client */
1916 struct berval c_peer_name; /* peer name (trans=addr:port) */
1917 Listener *c_listener;
1918 #define c_listener_url c_listener->sl_url /* listener URL */
1919 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
1921 /* only can be changed by binding thread */
1922 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1923 struct berval c_sasl_bind_mech; /* mech in progress */
1924 struct berval c_sasl_dn; /* temporary storage */
1926 /* authorization backend */
1927 Backend *c_authz_backend;
1929 AuthorizationInformation c_authz;
1930 GroupAssertion *c_groups;
1932 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1934 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1935 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1937 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1938 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1940 BerElement *c_currentber; /* ber we're attempting to read */
1941 int c_writewaiter; /* true if writer is waiting */
1943 #ifdef LDAP_CONNECTIONLESS
1944 int c_is_udp; /* true if this is (C)LDAP over UDP */
1947 int c_is_tls; /* true if this LDAP over raw TLS */
1948 int c_needs_tls_accept; /* true if SSL_accept should be called */
1950 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1951 void *c_sasl_context; /* SASL session context */
1952 void *c_sasl_extra; /* SASL session extra stuff */
1953 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1955 PagedResultsState c_pagedresults_state; /* paged result state */
1957 long c_n_ops_received; /* num of ops received (next op_id) */
1958 long c_n_ops_executing; /* num of ops currently executing */
1959 long c_n_ops_pending; /* num of ops pending execution */
1960 long c_n_ops_completed; /* num of ops completed */
1962 long c_n_get; /* num of get calls */
1963 long c_n_read; /* num of read calls */
1964 long c_n_write; /* num of write calls */
1966 void *c_pb; /* Netscape plugin */
1969 * These are the "callbacks" that are available for back-ends to
1970 * supply data back to connected clients that are connected
1971 * through the "front-end".
1973 SEND_LDAP_RESULT c_send_ldap_result;
1974 SEND_SEARCH_ENTRY c_send_search_entry;
1975 SEND_SEARCH_RESULT c_send_search_result;
1976 SEND_SEARCH_REFERENCE c_send_search_reference;
1977 SEND_LDAP_EXTENDED c_send_ldap_extended;
1978 #ifdef LDAP_RES_INTERMEDIATE_RESP
1979 SEND_LDAP_INTERMEDIATE_RESP c_send_ldap_intermediate_resp;
1984 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1985 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1987 if ( ldap_debug & (level) ) \
1988 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1989 if ( ldap_syslog & (level) ) \
1990 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1993 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
1994 #elif defined(LDAP_DEBUG)
1995 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1997 if ( ldap_debug & (level) ) \
1998 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2000 #define StatslogTest( level ) (ldap_debug & (level))
2001 #elif defined(LDAP_SYSLOG)
2002 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2004 if ( ldap_syslog & (level) ) \
2005 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2008 #define StatslogTest( level ) (ldap_syslog & (level))
2010 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2011 #define StatslogTest( level ) (0)
2015 * listener; need to access it from monitor backend
2017 struct slap_listener {
2018 struct berval sl_url;
2019 struct berval sl_name;
2024 #ifdef LDAP_CONNECTIONLESS
2025 int sl_is_udp; /* UDP listener is also data port */
2029 #define sl_addr sl_sa.sa_in_addr
2032 #ifdef SLAPD_MONITOR
2049 #endif /* SLAPD_MONITOR */
2052 * Better know these all around slapd
2054 #define SLAP_LDAPDN_PRETTY 0x1
2055 #define SLAP_LDAPDN_MAXLEN 8192
2060 #ifdef LDAP_CLIENT_UPDATE
2061 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2062 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2063 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2064 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2065 #endif /* LDAP_CLIENT_UPDATE */
2067 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2068 #define SLAP_SEARCH_MAX_CTRLS 10
2073 #include "proto-slap.h"
2075 #endif /* _SLAP_H_ */