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 provided 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 provided value is expected to conform to the
435 * attribute's value syntax.
437 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
438 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
439 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
440 #define SLAP_MR_VALUE_NORMALIZED_MATCH 0x0004U
442 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
443 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
444 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
445 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
447 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
448 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
449 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
450 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
451 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
452 == SLAP_MR_VALUE_SYNTAX_MATCH)
455 slap_mr_convert_func *smr_convert;
456 slap_mr_normalize_func *smr_normalize;
457 slap_mr_match_func *smr_match;
458 slap_mr_indexer_func *smr_indexer;
459 slap_mr_filter_func *smr_filter;
462 * null terminated array of syntaxes compatible with this syntax
463 * note: when MS_EXT is set, this MUST NOT contain the assertion
464 * syntax of the rule. When MS_EXT is not set, it MAY.
466 Syntax **smr_compat_syntaxes;
468 struct slap_matching_rule *smr_associated;
469 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
471 #define smr_oid smr_mrule.mr_oid
472 #define smr_names smr_mrule.mr_names
473 #define smr_desc smr_mrule.mr_desc
474 #define smr_obsolete smr_mrule.mr_obsolete
475 #define smr_syntax_oid smr_mrule.mr_syntax_oid
476 #define smr_extensions smr_mrule.mr_extensions
479 struct slap_matching_rule_use {
480 LDAPMatchingRuleUse smru_mruleuse;
481 MatchingRule *smru_mr;
482 /* RFC2252 string representation */
483 struct berval smru_str;
485 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
487 #define smru_oid smru_mruleuse.mru_oid
488 #define smru_names smru_mruleuse.mru_names
489 #define smru_desc smru_mruleuse.mru_desc
490 #define smru_obsolete smru_mruleuse.mru_obsolete
491 #define smru_applies_oids smru_mruleuse.mru_applies_oids
493 #define smru_usage smru_mr->smr_usage
494 } /* MatchingRuleUse */ ;
496 typedef struct slap_mrule_defs_rec {
498 slap_mask_t mrd_usage;
499 char ** mrd_compat_syntaxes;
500 slap_mr_convert_func * mrd_convert;
501 slap_mr_normalize_func * mrd_normalize;
502 slap_mr_match_func * mrd_match;
503 slap_mr_indexer_func * mrd_indexer;
504 slap_mr_filter_func * mrd_filter;
506 char * mrd_associated;
507 } slap_mrule_defs_rec;
509 struct slap_backend_db;
513 typedef int (AttributeTypeSchemaCheckFN)(
514 struct slap_backend_db *be,
515 struct slap_entry *e,
516 struct slap_attr *attr,
518 char *textbuf, size_t textlen );
520 typedef struct slap_attribute_type {
521 LDAPAttributeType sat_atype;
522 struct berval sat_cname;
523 struct slap_attribute_type *sat_sup;
524 struct slap_attribute_type **sat_subtypes;
525 MatchingRule *sat_equality;
526 MatchingRule *sat_approx;
527 MatchingRule *sat_ordering;
528 MatchingRule *sat_substr;
531 AttributeTypeSchemaCheckFN *sat_check;
533 #define SLAP_AT_NONE 0x0000U
534 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
535 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
536 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
537 slap_mask_t sat_flags;
539 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
541 #define sat_oid sat_atype.at_oid
542 #define sat_names sat_atype.at_names
543 #define sat_desc sat_atype.at_desc
544 #define sat_obsolete sat_atype.at_obsolete
545 #define sat_sup_oid sat_atype.at_sup_oid
546 #define sat_equality_oid sat_atype.at_equality_oid
547 #define sat_ordering_oid sat_atype.at_ordering_oid
548 #define sat_substr_oid sat_atype.at_substr_oid
549 #define sat_syntax_oid sat_atype.at_syntax_oid
550 #define sat_single_value sat_atype.at_single_value
551 #define sat_collective sat_atype.at_collective
552 #define sat_no_user_mod sat_atype.at_no_user_mod
553 #define sat_usage sat_atype.at_usage
554 #define sat_extensions sat_atype.at_extensions
556 struct slap_attr_desc *sat_ad;
557 ldap_pvt_thread_mutex_t sat_ad_mutex;
560 #define is_at_operational(at) ((at)->sat_usage)
561 #define is_at_single_value(at) ((at)->sat_single_value)
562 #define is_at_collective(at) ((at)->sat_collective)
563 #define is_at_obsolete(at) ((at)->sat_obsolete)
564 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
566 struct slap_object_class;
568 typedef int (ObjectClassSchemaCheckFN)(
569 struct slap_backend_db *be,
570 struct slap_entry *e,
571 struct slap_object_class *oc,
573 char *textbuf, size_t textlen );
575 typedef struct slap_object_class {
576 LDAPObjectClass soc_oclass;
577 struct berval soc_cname;
578 struct slap_object_class **soc_sups;
579 AttributeType **soc_required;
580 AttributeType **soc_allowed;
581 ObjectClassSchemaCheckFN *soc_check;
582 slap_mask_t soc_flags;
583 #define soc_oid soc_oclass.oc_oid
584 #define soc_names soc_oclass.oc_names
585 #define soc_desc soc_oclass.oc_desc
586 #define soc_obsolete soc_oclass.oc_obsolete
587 #define soc_sup_oids soc_oclass.oc_sup_oids
588 #define soc_kind soc_oclass.oc_kind
589 #define soc_at_oids_must soc_oclass.oc_at_oids_must
590 #define soc_at_oids_may soc_oclass.oc_at_oids_may
591 #define soc_extensions soc_oclass.oc_extensions
593 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
596 #define SLAP_OC_ALIAS 0x0001
597 #define SLAP_OC_REFERRAL 0x0002
598 #define SLAP_OC_SUBENTRY 0x0004
599 #define SLAP_OC_DYNAMICOBJECT 0x0008
600 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
601 #define SLAP_OC__MASK 0x001F
602 #define SLAP_OC__END 0x0020
603 #define SLAP_OC_OPERATIONAL 0x4000
604 #define SLAP_OC_HIDE 0x8000
609 typedef struct slap_content_rule {
610 LDAPContentRule scr_crule;
611 ObjectClass *scr_sclass;
612 ObjectClass **scr_auxiliaries; /* optional */
613 AttributeType **scr_required; /* optional */
614 AttributeType **scr_allowed; /* optional */
615 AttributeType **scr_precluded; /* optional */
616 #define scr_oid scr_crule.cr_oid
617 #define scr_names scr_crule.cr_names
618 #define scr_desc scr_crule.cr_desc
619 #define scr_obsolete scr_crule.cr_obsolete
620 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
621 #define scr_at_oids_must scr_crule.cr_at_oids_must
622 #define scr_at_oids_may scr_crule.cr_at_oids_may
623 #define scr_at_oids_not scr_crule.cr_at_oids_not
625 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
628 /* Represents a recognized attribute description ( type + options ). */
629 typedef struct slap_attr_desc {
630 struct slap_attr_desc *ad_next;
631 AttributeType *ad_type; /* attribute type, must be specified */
632 struct berval ad_cname; /* canonical name, must be specified */
633 struct berval ad_tags; /* empty if no tagging options */
635 #define SLAP_DESC_NONE 0x00U
636 #define SLAP_DESC_BINARY 0x01U
637 #define SLAP_DESC_TAG_RANGE 0x80U
638 } AttributeDescription;
640 typedef struct slap_attr_name {
641 struct berval an_name;
642 AttributeDescription *an_desc;
646 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
647 #define slap_ad_is_tag_range(ad) \
648 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
649 #define slap_ad_is_binary(ad) \
650 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
653 * pointers to schema elements used internally
655 struct slap_internal_schema {
657 ObjectClass *si_oc_top;
658 ObjectClass *si_oc_extensibleObject;
659 ObjectClass *si_oc_alias;
660 ObjectClass *si_oc_referral;
661 ObjectClass *si_oc_rootdse;
662 ObjectClass *si_oc_subentry;
663 ObjectClass *si_oc_subschema;
664 ObjectClass *si_oc_monitor;
665 ObjectClass *si_oc_collectiveAttributeSubentry;
666 ObjectClass *si_oc_dynamicObject;
668 /* objectClass attribute descriptions */
669 AttributeDescription *si_ad_objectClass;
671 /* operational attribute descriptions */
672 AttributeDescription *si_ad_structuralObjectClass;
673 AttributeDescription *si_ad_creatorsName;
674 AttributeDescription *si_ad_createTimestamp;
675 AttributeDescription *si_ad_modifiersName;
676 AttributeDescription *si_ad_modifyTimestamp;
677 AttributeDescription *si_ad_hasSubordinates;
678 AttributeDescription *si_ad_subschemaSubentry;
679 AttributeDescription *si_ad_collectiveSubentries;
680 AttributeDescription *si_ad_collectiveExclusions;
681 AttributeDescription *si_ad_entryUUID;
682 AttributeDescription *si_ad_entryCSN;
683 AttributeDescription *si_ad_superiorUUID;
685 /* root DSE attribute descriptions */
686 AttributeDescription *si_ad_altServer;
687 AttributeDescription *si_ad_namingContexts;
688 AttributeDescription *si_ad_supportedControl;
689 AttributeDescription *si_ad_supportedExtension;
690 AttributeDescription *si_ad_supportedLDAPVersion;
691 AttributeDescription *si_ad_supportedSASLMechanisms;
692 AttributeDescription *si_ad_supportedFeatures;
693 AttributeDescription *si_ad_monitorContext;
694 AttributeDescription *si_ad_vendorName;
695 AttributeDescription *si_ad_vendorVersion;
697 /* subentry attribute descriptions */
698 AttributeDescription *si_ad_administrativeRole;
699 AttributeDescription *si_ad_subtreeSpecification;
701 /* subschema subentry attribute descriptions */
702 AttributeDescription *si_ad_ditStructureRules;
703 AttributeDescription *si_ad_ditContentRules;
704 AttributeDescription *si_ad_nameForms;
705 AttributeDescription *si_ad_objectClasses;
706 AttributeDescription *si_ad_attributeTypes;
707 AttributeDescription *si_ad_ldapSyntaxes;
708 AttributeDescription *si_ad_matchingRules;
709 AttributeDescription *si_ad_matchingRuleUse;
711 /* Aliases & Referrals */
712 AttributeDescription *si_ad_aliasedObjectName;
713 AttributeDescription *si_ad_ref;
715 /* Access Control Internals */
716 AttributeDescription *si_ad_entry;
717 AttributeDescription *si_ad_children;
718 AttributeDescription *si_ad_saslAuthzTo;
719 AttributeDescription *si_ad_saslAuthzFrom;
720 #ifdef SLAPD_ACI_ENABLED
721 AttributeDescription *si_ad_aci;
724 /* dynamic entries */
725 AttributeDescription *si_ad_entryTtl;
726 AttributeDescription *si_ad_dynamicSubtrees;
728 /* Other attributes descriptions */
729 AttributeDescription *si_ad_distinguishedName;
730 AttributeDescription *si_ad_name;
731 AttributeDescription *si_ad_cn;
732 AttributeDescription *si_ad_userPassword;
733 #ifdef SLAPD_AUTHPASSWD
734 AttributeDescription *si_ad_authPassword;
736 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
737 AttributeDescription *si_ad_krbName;
740 /* Undefined Attribute Type */
741 AttributeType *si_at_undefined;
744 MatchingRule *si_mr_distinguishedNameMatch;
745 MatchingRule *si_mr_integerMatch;
748 Syntax *si_syn_octetString;
749 Syntax *si_syn_distinguishedName;
750 Syntax *si_syn_integer;
753 typedef struct slap_attr_assertion {
754 AttributeDescription *aa_desc;
755 struct berval aa_value;
756 } AttributeAssertion;
758 typedef struct slap_ss_assertion {
759 AttributeDescription *sa_desc;
760 struct berval sa_initial;
761 struct berval *sa_any;
762 struct berval sa_final;
763 } SubstringsAssertion;
765 typedef struct slap_mr_assertion {
766 MatchingRule *ma_rule; /* optional */
767 struct berval ma_rule_text; /* optional */
768 AttributeDescription *ma_desc; /* optional */
769 int ma_dnattrs; /* boolean */
770 struct berval ma_value; /* required */
771 } MatchingRuleAssertion;
774 * represents a search filter
776 typedef struct slap_filter {
777 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
778 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
779 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
780 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
783 /* precomputed result */
784 ber_int_t f_un_result;
787 struct berval *f_un_dn;
790 AttributeDescription *f_un_desc;
792 /* simple value assertion */
793 AttributeAssertion *f_un_ava;
795 /* substring assertion */
796 SubstringsAssertion *f_un_ssa;
798 /* matching rule assertion */
799 MatchingRuleAssertion *f_un_mra;
801 #define f_dn f_un.f_un_dn
802 #define f_desc f_un.f_un_desc
803 #define f_ava f_un.f_un_ava
804 #define f_av_desc f_un.f_un_ava->aa_desc
805 #define f_av_value f_un.f_un_ava->aa_value
806 #define f_sub f_un.f_un_ssa
807 #define f_sub_desc f_un.f_un_ssa->sa_desc
808 #define f_sub_initial f_un.f_un_ssa->sa_initial
809 #define f_sub_any f_un.f_un_ssa->sa_any
810 #define f_sub_final f_un.f_un_ssa->sa_final
811 #define f_mra f_un.f_un_mra
812 #define f_mr_rule f_un.f_un_mra->ma_rule
813 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
814 #define f_mr_desc f_un.f_un_mra->ma_desc
815 #define f_mr_value f_un.f_un_mra->ma_value
816 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
819 struct slap_filter *f_un_complex;
822 #define f_result f_un.f_un_result
823 #define f_and f_un.f_un_complex
824 #define f_or f_un.f_un_complex
825 #define f_not f_un.f_un_complex
826 #define f_list f_un.f_un_complex
828 struct slap_filter *f_next;
831 /* compare routines can return undefined */
832 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
834 typedef struct slap_valuesreturnfilter {
835 ber_tag_t vrf_choice;
838 /* precomputed result */
839 ber_int_t vrf_un_result;
845 AttributeDescription *vrf_un_desc;
847 /* simple value assertion */
848 AttributeAssertion *vrf_un_ava;
850 /* substring assertion */
851 SubstringsAssertion *vrf_un_ssa;
853 /* matching rule assertion */
854 MatchingRuleAssertion *vrf_un_mra;
856 #define vrf_result vrf_un.vrf_un_result
857 #define vrf_dn vrf_un.vrf_un_dn
858 #define vrf_desc vrf_un.vrf_un_desc
859 #define vrf_ava vrf_un.vrf_un_ava
860 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
861 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
862 #define vrf_ssa vrf_un.vrf_un_ssa
863 #define vrf_sub vrf_un.vrf_un_ssa
864 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
865 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
866 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
867 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
868 #define vrf_mra vrf_un.vrf_un_mra
869 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
870 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
871 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
872 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
873 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
878 struct slap_valuesreturnfilter *vrf_next;
879 } ValuesReturnFilter;
882 * represents an attribute (description + values)
884 typedef struct slap_attr {
885 AttributeDescription *a_desc;
886 BerVarray a_vals; /* preserved values */
888 BerVarray a_nvals; /* normalized values */
890 struct slap_attr *a_next;
892 #define SLAP_ATTR_IXADD 0x1U
893 #define SLAP_ATTR_IXDEL 0x2U
898 * the id used in the indexes to refer to an entry
900 typedef unsigned long ID;
901 #define NOID ((ID)~0)
904 * represents an entry in core
906 typedef struct slap_entry {
908 * The ID field should only be changed before entry is
909 * inserted into a cache. The ID value is backend
914 struct berval e_name; /* name (DN) of this entry */
915 struct berval e_nname; /* normalized name (DN) of this entry */
917 /* for migration purposes */
918 #define e_dn e_name.bv_val
919 #define e_ndn e_nname.bv_val
921 Attribute *e_attrs; /* list of attributes + values */
923 slap_mask_t e_ocflags;
925 struct berval e_bv; /* For entry_encode/entry_decode */
927 /* for use by the backend for any purpose */
934 typedef struct slap_mod {
936 AttributeDescription *sm_desc;
937 struct berval sm_type;
938 #define sm_bvalues sm_values
941 BerVarray sm_nvalues;
945 typedef struct slap_mod_list {
946 Modification sml_mod;
947 #define sml_op sml_mod.sm_op
948 #define sml_desc sml_mod.sm_desc
949 #define sml_type sml_mod.sm_type
950 #define sml_bvalues sml_mod.sm_bvalues
951 struct slap_mod_list *sml_next;
954 typedef struct slap_ldap_modlist {
956 struct slap_ldap_modlist *ml_next;
957 #define ml_op ml_mod.mod_op
958 #define ml_type ml_mod.mod_type
959 #define ml_values ml_mod.mod_values
960 #define ml_bvalues ml_mod.mod_bvalues
964 * represents an access control list
966 typedef enum slap_access_e {
967 ACL_INVALID_ACCESS = -1,
976 typedef enum slap_control_e {
977 ACL_INVALID_CONTROL = 0,
983 typedef enum slap_style_e {
991 /* alternate names */
992 ACL_STYLE_EXACT = ACL_STYLE_BASE
995 typedef struct slap_authz_info {
996 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
997 struct berval sai_mech; /* SASL Mechanism */
998 struct berval sai_dn; /* DN for reporting purposes */
999 struct berval sai_ndn; /* Normalized DN */
1001 /* Security Strength Factors */
1002 slap_ssf_t sai_ssf; /* Overall SSF */
1003 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1004 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1005 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1006 } AuthorizationInformation;
1009 typedef struct slap_access {
1010 slap_control_t a_type;
1012 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1014 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1015 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1016 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1017 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1018 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1019 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1021 #define ACL_PRIV_MASK 0x00ffUL
1024 #define ACL_PRIV_LEVEL 0x1000UL
1025 #define ACL_PRIV_ADDITIVE 0x2000UL
1026 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1029 #define ACL_PRIV_INVALID 0x0UL
1031 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1032 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1033 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1034 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1036 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1037 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1039 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1041 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1043 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1044 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1045 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1047 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1048 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1049 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1050 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1051 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1052 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1054 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1055 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1056 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1057 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1058 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1059 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1060 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1062 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1063 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1064 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1065 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1066 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1067 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1069 slap_mask_t a_access_mask;
1071 AuthorizationInformation a_authz;
1072 #define a_dn_pat a_authz.sai_dn
1074 slap_style_t a_dn_style;
1075 AttributeDescription *a_dn_at;
1079 slap_style_t a_peername_style;
1080 struct berval a_peername_pat;
1081 slap_style_t a_sockname_style;
1082 struct berval a_sockname_pat;
1084 slap_style_t a_domain_style;
1085 struct berval a_domain_pat;
1086 int a_domain_expand;
1088 slap_style_t a_sockurl_style;
1089 struct berval a_sockurl_pat;
1090 slap_style_t a_set_style;
1091 struct berval a_set_pat;
1093 #ifdef SLAPD_ACI_ENABLED
1094 AttributeDescription *a_aci_at;
1098 slap_style_t a_group_style;
1099 struct berval a_group_pat;
1100 ObjectClass *a_group_oc;
1101 AttributeDescription *a_group_at;
1103 struct slap_access *a_next;
1107 typedef struct slap_acl {
1108 /* "to" part: the entries this acl applies to */
1110 slap_style_t acl_dn_style;
1112 struct berval acl_dn_pat;
1113 AttributeName *acl_attrs;
1115 /* "by" part: list of who has what access to the entries */
1118 struct slap_acl *acl_next;
1121 typedef struct slap_acl_state {
1122 unsigned as_recorded;
1123 #define ACL_STATE_NOT_RECORDED 0x0
1124 #define ACL_STATE_RECORDED_VD 0x1
1125 #define ACL_STATE_RECORDED_NV 0x2
1126 #define ACL_STATE_RECORDED 0x3
1129 AccessControl *as_vd_acl;
1130 AccessControl *as_vi_acl;
1131 slap_mask_t as_vd_acl_mask;
1132 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1133 int as_vd_acl_count;
1135 Access *as_vd_access;
1136 int as_vd_access_count;
1139 AttributeDescription *as_vd_ad;
1140 } AccessControlState;
1141 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1142 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1145 * replog moddn param structure
1147 struct slap_replog_moddn {
1148 struct berval *newrdn;
1150 struct berval *newsup;
1155 * represents a backend
1158 typedef struct slap_backend_info BackendInfo; /* per backend type */
1159 typedef struct slap_backend_db BackendDB; /* per backend database */
1161 LDAP_SLAPD_V (int) nBackendInfo;
1162 LDAP_SLAPD_V (int) nBackendDB;
1163 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1164 LDAP_SLAPD_V (BackendDB *) backendDB;
1166 LDAP_SLAPD_V (int) slapMode;
1167 #define SLAP_UNDEFINED_MODE 0x0000
1168 #define SLAP_SERVER_MODE 0x0001
1169 #define SLAP_TOOL_MODE 0x0002
1170 #define SLAP_MODE 0x0003
1172 #define SLAP_TRUNCATE_MODE 0x0100
1174 struct slap_replica_info {
1175 char *ri_host; /* supersedes be_replica */
1176 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1177 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1178 int ri_exclude; /* 1 => exclude ri_attrs */
1181 struct slap_limits_set {
1189 int lms_s_unchecked;
1194 struct slap_limits {
1195 int lm_type; /* type of pattern */
1196 #define SLAP_LIMITS_UNDEFINED 0x0000
1197 #define SLAP_LIMITS_EXACT 0x0001
1198 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1199 #define SLAP_LIMITS_ONE 0x0002
1200 #define SLAP_LIMITS_SUBTREE 0x0003
1201 #define SLAP_LIMITS_CHILDREN 0x0004
1202 #define SLAP_LIMITS_REGEX 0x0005
1203 #define SLAP_LIMITS_ANONYMOUS 0x0006
1204 #define SLAP_LIMITS_USERS 0x0007
1205 #define SLAP_LIMITS_ANY 0x0008
1206 regex_t lm_dn_regex; /* regex data for REGEX */
1209 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1210 * pattern for REGEX; NULL for ANONYMOUS, USERS
1212 struct berval lm_dn_pat;
1214 struct slap_limits_set lm_limits;
1217 /* temporary aliases */
1218 typedef BackendDB Backend;
1219 #define nbackends nBackendDB
1220 #define backends backendDB
1222 struct slap_backend_db {
1223 BackendInfo *bd_info; /* pointer to shared backend info */
1225 /* BackendInfo accessors */
1226 #define be_config bd_info->bi_db_config
1227 #define be_type bd_info->bi_type
1229 #define be_bind bd_info->bi_op_bind
1230 #define be_unbind bd_info->bi_op_unbind
1231 #define be_add bd_info->bi_op_add
1232 #define be_compare bd_info->bi_op_compare
1233 #define be_delete bd_info->bi_op_delete
1234 #define be_modify bd_info->bi_op_modify
1235 #define be_modrdn bd_info->bi_op_modrdn
1236 #define be_search bd_info->bi_op_search
1237 #define be_abandon bd_info->bi_op_abandon
1238 #define be_cancel bd_info->bi_op_cancel
1240 #define be_extended bd_info->bi_extended
1242 #define be_release bd_info->bi_entry_release_rw
1243 #define be_chk_referrals bd_info->bi_chk_referrals
1244 #define be_group bd_info->bi_acl_group
1245 #define be_attribute bd_info->bi_acl_attribute
1246 #define be_operational bd_info->bi_operational
1249 * define to honor hasSubordinates operational attribute in search filters
1250 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1253 #define be_has_subordinates bd_info->bi_has_subordinates
1255 #define be_controls bd_info->bi_controls
1257 #define be_connection_init bd_info->bi_connection_init
1258 #define be_connection_destroy bd_info->bi_connection_destroy
1261 #define be_entry_open bd_info->bi_tool_entry_open
1262 #define be_entry_close bd_info->bi_tool_entry_close
1263 #define be_entry_first bd_info->bi_tool_entry_first
1264 #define be_entry_next bd_info->bi_tool_entry_next
1265 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1266 #define be_entry_get bd_info->bi_tool_entry_get
1267 #define be_entry_put bd_info->bi_tool_entry_put
1268 #define be_sync bd_info->bi_tool_sync
1271 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1272 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1273 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1274 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1275 #define SLAP_BFLAG_ALIASES 0x0100U
1276 #define SLAP_BFLAG_REFERRALS 0x0200U
1277 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1278 #define SLAP_BFLAG_MONITOR 0x1000U
1279 #define SLAP_BFLAG_DYNAMIC 0x2000U
1280 slap_mask_t be_flags;
1281 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1282 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1283 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1284 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1285 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1286 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1288 slap_mask_t be_restrictops; /* restriction operations */
1289 #define SLAP_RESTRICT_OP_ADD 0x0001U
1290 #define SLAP_RESTRICT_OP_BIND 0x0002U
1291 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1292 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1293 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1294 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1295 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1296 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1298 #define SLAP_RESTRICT_OP_READS \
1299 ( SLAP_RESTRICT_OP_COMPARE \
1300 | SLAP_RESTRICT_OP_SEARCH )
1301 #define SLAP_RESTRICT_OP_WRITES \
1302 ( SLAP_RESTRICT_OP_ADD \
1303 | SLAP_RESTRICT_OP_DELETE \
1304 | SLAP_RESTRICT_OP_MODIFY \
1305 | SLAP_RESTRICT_OP_RENAME )
1307 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1308 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1309 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1311 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1313 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1314 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1315 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1316 0x0004U /* unprotected simple auth */
1317 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1319 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1320 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1322 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1324 slap_mask_t be_requires; /* pre-operation requirements */
1325 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1326 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1327 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1328 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1329 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1331 /* Required Security Strength Factor */
1332 slap_ssf_set_t be_ssf_set;
1334 /* these should be renamed from be_ to bd_ */
1335 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1336 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1337 struct berval be_schemadn; /* per-backend subschema subentry DN */
1338 struct berval be_schemandn; /* normalized subschema DN */
1339 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1340 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1341 struct berval be_rootpw; /* the magic "root" password for this db */
1342 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1343 #define be_sizelimit be_def_limit.lms_s_soft
1344 #define be_timelimit be_def_limit.lms_t_soft
1345 struct slap_limits_set be_def_limit; /* default limits */
1346 struct slap_limits **be_limits; /* regex-based size and time limits */
1347 AccessControl *be_acl; /* access control list for this backend */
1348 slap_access_t be_dfltaccess; /* access given if no acl matches */
1349 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1350 char *be_replogfile; /* replication log file (in master) */
1351 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1352 BerVarray be_update_refs; /* where to refer modifying clients to */
1354 void *be_private; /* anything the backend database needs */
1356 void *be_pb; /* Netscape plugin */
1362 /* Backend function typedefs */
1363 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1364 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1365 const char *fname, int lineno,
1366 int argc, char **argv));
1367 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1368 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1369 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1371 typedef int (BI_db_init) LDAP_P((Backend *bd));
1372 typedef int (BI_db_config) LDAP_P((Backend *bd,
1373 const char *fname, int lineno,
1374 int argc, char **argv));
1375 typedef int (BI_db_open) LDAP_P((Backend *bd));
1376 typedef int (BI_db_close) LDAP_P((Backend *bd));
1377 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1379 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1380 struct slap_conn *c, struct slap_op *o,
1381 struct berval *dn, struct berval *ndn, int method,
1382 struct berval *cred, struct berval *edn ));
1383 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1384 struct slap_conn *c, struct slap_op *o ));
1385 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1386 struct slap_conn *c, struct slap_op *o,
1387 struct berval *base, struct berval *nbase,
1388 int scope, int deref,
1389 int slimit, int tlimit,
1390 Filter *f, struct berval *filterstr,
1391 AttributeName *attrs, int attrsonly));
1392 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1393 struct slap_conn *c, struct slap_op *o,
1394 struct berval *dn, struct berval *ndn,
1395 AttributeAssertion *ava));
1396 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1397 struct slap_conn *c, struct slap_op *o,
1398 struct berval *dn, struct berval *ndn,
1400 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1401 struct slap_conn *c, struct slap_op *o,
1402 struct berval *dn, struct berval *ndn,
1403 struct berval *newrdn, struct berval *nnewrdn,
1405 struct berval *newSup, struct berval *nnewSup ));
1406 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1407 struct slap_conn *c, struct slap_op *o,
1409 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1410 struct slap_conn *c, struct slap_op *o,
1411 struct berval *dn, struct berval *ndn));
1412 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1413 struct slap_conn *c, struct slap_op *o,
1415 typedef int (BI_op_cancel) LDAP_P((BackendDB *bd,
1416 struct slap_conn *c, struct slap_op *o,
1419 typedef int (BI_op_extended) LDAP_P((
1421 struct slap_conn *conn,
1423 struct berval *reqoid,
1424 struct berval * reqdata,
1426 struct berval ** rspdata,
1427 LDAPControl *** rspctrls,
1431 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1432 struct slap_conn *c, struct slap_op *o,
1435 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1436 struct slap_conn *c, struct slap_op *o,
1437 struct berval *dn, struct berval *ndn,
1438 const char **text ));
1440 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1441 struct slap_conn *c, struct slap_op *o,
1445 ObjectClass *group_oc,
1446 AttributeDescription *group_at ));
1448 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1449 struct slap_conn *c, struct slap_op *o,
1450 Entry *e, struct berval *edn,
1451 AttributeDescription *entry_at,
1454 typedef int (BI_operational) LDAP_P((Backend *bd,
1455 struct slap_conn *c, struct slap_op *o,
1456 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1458 typedef int (BI_has_subordinates) LDAP_P((Backend *bd,
1459 struct slap_conn *c, struct slap_op *o,
1460 Entry *e, int *has_subordinates ));
1462 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1463 struct slap_conn *c));
1464 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1465 struct slap_conn *c));
1467 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1468 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1469 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1470 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1471 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1472 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1473 struct berval *text ));
1474 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1475 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1477 struct slap_backend_info {
1478 char *bi_type; /* type of backend */
1481 * per backend type routines:
1482 * bi_init: called to allocate a backend_info structure,
1483 * called once BEFORE configuration file is read.
1484 * bi_init() initializes this structure hence is
1485 * called directly from be_initialize()
1486 * bi_config: called per 'backend' specific option
1487 * all such options must before any 'database' options
1488 * bi_config() is called only from read_config()
1489 * bi_open: called to open each database, called
1490 * once AFTER configuration file is read but
1491 * BEFORE any bi_db_open() calls.
1492 * bi_open() is called from backend_startup()
1493 * bi_close: called to close each database, called
1494 * once during shutdown after all bi_db_close calls.
1495 * bi_close() is called from backend_shutdown()
1496 * bi_destroy: called to destroy each database, called
1497 * once during shutdown after all bi_db_destroy calls.
1498 * bi_destory() is called from backend_destroy()
1501 BI_config *bi_config;
1504 BI_destroy *bi_destroy;
1507 * per database routines:
1508 * bi_db_init: called to initialize each database,
1509 * called upon reading 'database <type>'
1510 * called only from backend_db_init()
1511 * bi_db_config: called to configure each database,
1512 * called per database to handle per database options
1513 * called only from read_config()
1514 * bi_db_open: called to open each database
1515 * called once per database immediately AFTER bi_open()
1516 * calls but before daemon startup.
1517 * called only by backend_startup()
1518 * bi_db_close: called to close each database
1519 * called once per database during shutdown but BEFORE
1520 * any bi_close call.
1521 * called only by backend_shutdown()
1522 * bi_db_destroy: called to destroy each database
1523 * called once per database during shutdown AFTER all
1524 * bi_close calls but before bi_destory calls.
1525 * called only by backend_destory()
1527 BI_db_init *bi_db_init;
1528 BI_db_config *bi_db_config;
1529 BI_db_open *bi_db_open;
1530 BI_db_close *bi_db_close;
1531 BI_db_destroy *bi_db_destroy;
1533 /* LDAP Operations Handling Routines */
1534 BI_op_bind *bi_op_bind;
1535 BI_op_unbind *bi_op_unbind;
1536 BI_op_search *bi_op_search;
1537 BI_op_compare *bi_op_compare;
1538 BI_op_modify *bi_op_modify;
1539 BI_op_modrdn *bi_op_modrdn;
1540 BI_op_add *bi_op_add;
1541 BI_op_delete *bi_op_delete;
1542 BI_op_abandon *bi_op_abandon;
1543 BI_op_cancel *bi_op_cancel;
1545 /* Extended Operations Helper */
1546 BI_op_extended *bi_extended;
1548 /* Auxilary Functions */
1549 BI_entry_release_rw *bi_entry_release_rw;
1550 BI_chk_referrals *bi_chk_referrals;
1552 BI_acl_group *bi_acl_group;
1553 BI_acl_attribute *bi_acl_attribute;
1555 BI_operational *bi_operational;
1556 BI_has_subordinates *bi_has_subordinates;
1558 BI_connection_init *bi_connection_init;
1559 BI_connection_destroy *bi_connection_destroy;
1561 /* hooks for slap tools */
1562 BI_tool_entry_open *bi_tool_entry_open;
1563 BI_tool_entry_close *bi_tool_entry_close;
1564 BI_tool_entry_first *bi_tool_entry_first;
1565 BI_tool_entry_next *bi_tool_entry_next;
1566 BI_tool_entry_get *bi_tool_entry_get;
1567 BI_tool_entry_put *bi_tool_entry_put;
1568 BI_tool_entry_reindex *bi_tool_entry_reindex;
1569 BI_tool_sync *bi_tool_sync;
1571 #define SLAP_INDEX_ADD_OP 0x0001
1572 #define SLAP_INDEX_DELETE_OP 0x0002
1574 char **bi_controls; /* supported controls */
1576 unsigned int bi_nDB; /* number of databases of this type */
1577 void *bi_private; /* anything the backend type needs */
1580 #define c_authtype c_authz.sai_method
1581 #define c_authmech c_authz.sai_mech
1582 #define c_dn c_authz.sai_dn
1583 #define c_ndn c_authz.sai_ndn
1584 #define c_ssf c_authz.sai_ssf
1585 #define c_transport_ssf c_authz.sai_transport_ssf
1586 #define c_tls_ssf c_authz.sai_tls_ssf
1587 #define c_sasl_ssf c_authz.sai_sasl_ssf
1589 #define o_authtype o_authz.sai_method
1590 #define o_authmech o_authz.sai_mech
1591 #define o_dn o_authz.sai_dn
1592 #define o_ndn o_authz.sai_ndn
1593 #define o_ssf o_authz.sai_ssf
1594 #define o_transport_ssf o_authz.sai_transport_ssf
1595 #define o_tls_ssf o_authz.sai_tls_ssf
1596 #define o_sasl_ssf o_authz.sai_sasl_ssf
1598 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1599 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1600 BerVarray, const char *, struct berval *,
1601 struct berval *, LDAPControl ** );
1603 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1604 ber_int_t, const char *, const char *, BerVarray,
1605 LDAPControl **, int nentries);
1607 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1608 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1610 typedef int (slap_sendreference)( BackendDB *, struct slap_conn *,
1611 struct slap_op *, Entry *, BerVarray, LDAPControl **, BerVarray * );
1613 typedef struct slap_callback {
1614 slap_response *sc_response;
1615 slap_sresult *sc_sresult;
1616 slap_sendentry *sc_sendentry;
1617 slap_sendreference *sc_sendreference;
1622 * Paged Results state
1624 typedef unsigned long PagedResultsCookie;
1625 typedef struct slap_paged_state {
1627 PagedResultsCookie ps_cookie;
1629 } PagedResultsState;
1632 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1633 #define LDAP_PSEARCH_BY_ADD 0x01
1634 #define LDAP_PSEARCH_BY_DELETE 0x02
1635 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1636 #define LDAP_PSEARCH_BY_MODIFY 0x04
1637 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1639 struct ldap_psearch_spec {
1641 struct berval *base;
1642 struct berval *nbase;
1648 struct berval *filterstr;
1649 AttributeName *attrs;
1653 LDAP_LIST_ENTRY(ldap_psearch_spec) link;
1657 struct ldap_psearch_spec* ps;
1658 LDAP_LIST_ENTRY(psid_entry) link;
1664 * represents an operation pending from an ldap client
1666 typedef struct slap_op {
1667 unsigned long o_opid; /* id of this operation */
1668 unsigned long o_connid; /* id of conn initiating this op */
1669 struct slap_conn *o_conn; /* connection spawning this op */
1671 ber_int_t o_msgid; /* msgid of the request */
1672 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1673 ber_tag_t o_tag; /* tag of the request */
1674 time_t o_time; /* time op was initiated */
1676 char * o_extendedop; /* extended operation OID */
1678 ldap_pvt_thread_t o_tid; /* thread handling this op */
1680 volatile sig_atomic_t o_abandon; /* abandon flag */
1681 volatile sig_atomic_t o_cancel; /* cancel flag */
1682 #define SLAP_CANCEL_NONE 0x00
1683 #define SLAP_CANCEL_REQ 0x01
1684 #define SLAP_CANCEL_ACK 0x02
1685 #define SLAP_CANCEL_DONE 0x03
1687 char o_do_not_cache; /* don't cache from this op */
1689 #define SLAP_NO_CONTROL 0
1690 #define SLAP_NONCRITICAL_CONTROL 1
1691 #define SLAP_CRITICAL_CONTROL 2
1693 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1699 #define get_subentries(op) ((int)(op)->o_subentries)
1700 char o_subentries_visibility;
1701 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1703 char o_valuesreturnfilter;
1705 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1706 char o_permissive_modify;
1707 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
1709 #define get_permissiveModify(op) (0)
1712 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1713 char o_domain_scope;
1714 #define get_domainScope(op) ((int)(op)->o_domain_scope)
1716 #define get_domainScope(op) (0)
1719 #ifdef LDAP_CONTROL_PAGEDRESULTS
1720 char o_pagedresults;
1721 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1722 ber_int_t o_pagedresults_size;
1723 PagedResultsState o_pagedresults_state;
1725 #define get_pagedresults(op) (0)
1728 #ifdef LDAP_CLIENT_UPDATE
1729 char o_clientupdate;
1730 char o_clientupdate_type;
1731 #define SLAP_LCUP_NONE (0x0)
1732 #define SLAP_LCUP_SYNC (0x1)
1733 #define SLAP_LCUP_PERSIST (0x2)
1734 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1735 ber_int_t o_clientupdate_interval;
1736 struct berval o_clientupdate_state;
1742 #define SLAP_SYNC_NONE (0x0)
1743 #define SLAP_SYNC_REFRESH (0x1)
1744 #define SLAP_SYNC_PERSIST (0x2)
1745 #define SLAP_SYNC_REFRESH_AND_PERSIST (0x3)
1746 struct berval o_sync_state;
1749 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
1750 LDAP_LIST_HEAD(lss, ldap_psearch_spec) psearch_spec;
1751 LDAP_LIST_HEAD(pe, psid_entry) premodify_list;
1752 LDAP_LIST_ENTRY(slap_op) link;
1755 #ifdef LDAP_CONNECTIONLESS
1756 Sockaddr o_peeraddr; /* UDP peer address */
1758 AuthorizationInformation o_authz;
1760 BerElement *o_ber; /* ber of the request */
1761 #ifdef LDAP_CONNECTIONLESS
1762 BerElement *o_res_ber; /* ber of the reply */
1764 slap_callback *o_callback; /* callback pointers */
1765 LDAPControl **o_ctrls; /* controls */
1767 void *o_threadctx; /* thread pool thread context */
1768 void *o_private; /* anything the backend needs */
1770 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1771 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1774 void *o_pb; /* NS-SLAPI plugin */
1778 typedef void (*SEND_LDAP_RESULT)(
1779 struct slap_conn *conn,
1782 const char *matched,
1788 #define send_ldap_result( conn, op, err, matched, text, ref, ctrls ) \
1789 (*conn->c_send_ldap_result)( conn, op, err, matched, text, ref, ctrls )
1792 typedef int (*SEND_SEARCH_ENTRY)(
1793 struct slap_backend_db *be,
1794 struct slap_conn *conn,
1796 struct slap_entry *e,
1797 AttributeName *attrs,
1802 #define send_search_entry( be, conn, op, e, attrs, attrsonly, ctrls) \
1803 (*conn->c_send_search_entry)( be, conn, op, e, attrs, attrsonly, ctrls)
1806 typedef void (*SEND_SEARCH_RESULT)(
1807 struct slap_conn *conn,
1810 const char *matched,
1813 LDAPControl **ctrls,
1817 #define send_search_result( conn, op, err, matched, text, refs, ctrls, nentries ) \
1818 (*conn->c_send_search_result)( conn, op, err, matched, text, refs, ctrls, nentries )
1821 typedef int (*SEND_SEARCH_REFERENCE)(
1822 struct slap_backend_db *be,
1823 struct slap_conn *conn,
1825 struct slap_entry *e,
1827 LDAPControl **ctrls,
1831 #define send_search_reference( be, conn, op, e, refs, ctrls, v2refs ) \
1832 (*conn->c_send_search_reference)( be, conn, op, e, refs, ctrls, v2refs )
1835 typedef void (*SEND_LDAP_EXTENDED)(
1836 struct slap_conn *conn,
1839 const char *matched,
1843 struct berval *rspdata,
1847 #define send_ldap_extended( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls) \
1848 (*conn->c_send_ldap_extended)( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls )
1850 typedef void (*SEND_LDAP_INTERMEDIATE_RESP)(
1851 struct slap_conn *conn,
1854 const char *matched,
1858 struct berval *rspdata,
1862 #define send_ldap_intermediate_resp( conn, op, err, matched, text, refs, \
1863 rspoid, rspdata, ctrls) \
1864 (*conn->c_send_ldap_intermediate_resp)( conn, op, err, matched, text, \
1865 refs, rspoid, rspdata, ctrls )
1868 * Caches the result of a backend_group check for ACL evaluation
1870 typedef struct slap_gacl {
1871 struct slap_gacl *ga_next;
1874 AttributeDescription *ga_at;
1880 typedef struct slap_listener Listener;
1883 * represents a connection from an ldap client
1885 typedef struct slap_conn {
1886 int c_struct_state; /* structure management state */
1887 int c_conn_state; /* connection state */
1889 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1890 Sockbuf *c_sb; /* ber connection stuff */
1892 /* only can be changed by connect_init */
1893 time_t c_starttime; /* when the connection was opened */
1894 time_t c_activitytime; /* when the connection was last used */
1895 unsigned long c_connid; /* id of this connection for stats*/
1897 struct berval c_peer_domain; /* DNS name of client */
1898 struct berval c_peer_name; /* peer name (trans=addr:port) */
1899 Listener *c_listener;
1900 #define c_listener_url c_listener->sl_url /* listener URL */
1901 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
1903 /* only can be changed by binding thread */
1904 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1905 struct berval c_sasl_bind_mech; /* mech in progress */
1906 struct berval c_sasl_dn; /* temporary storage */
1908 /* authorization backend */
1909 Backend *c_authz_backend;
1911 AuthorizationInformation c_authz;
1912 GroupAssertion *c_groups;
1914 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1916 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1917 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1919 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1920 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1922 BerElement *c_currentber; /* ber we're attempting to read */
1923 int c_writewaiter; /* true if writer is waiting */
1925 #ifdef LDAP_CONNECTIONLESS
1926 int c_is_udp; /* true if this is (C)LDAP over UDP */
1929 int c_is_tls; /* true if this LDAP over raw TLS */
1930 int c_needs_tls_accept; /* true if SSL_accept should be called */
1932 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1933 void *c_sasl_context; /* SASL session context */
1934 void *c_sasl_extra; /* SASL session extra stuff */
1935 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1937 PagedResultsState c_pagedresults_state; /* paged result state */
1939 long c_n_ops_received; /* num of ops received (next op_id) */
1940 long c_n_ops_executing; /* num of ops currently executing */
1941 long c_n_ops_pending; /* num of ops pending execution */
1942 long c_n_ops_completed; /* num of ops completed */
1944 long c_n_get; /* num of get calls */
1945 long c_n_read; /* num of read calls */
1946 long c_n_write; /* num of write calls */
1948 void *c_pb; /* Netscape plugin */
1951 * These are the "callbacks" that are available for back-ends to
1952 * supply data back to connected clients that are connected
1953 * through the "front-end".
1955 SEND_LDAP_RESULT c_send_ldap_result;
1956 SEND_SEARCH_ENTRY c_send_search_entry;
1957 SEND_SEARCH_RESULT c_send_search_result;
1958 SEND_SEARCH_REFERENCE c_send_search_reference;
1959 SEND_LDAP_EXTENDED c_send_ldap_extended;
1960 #ifdef LDAP_RES_INTERMEDIATE_RESP
1961 SEND_LDAP_INTERMEDIATE_RESP c_send_ldap_intermediate_resp;
1966 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1967 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1969 if ( ldap_debug & (level) ) \
1970 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1971 if ( ldap_syslog & (level) ) \
1972 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1975 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
1976 #elif defined(LDAP_DEBUG)
1977 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1979 if ( ldap_debug & (level) ) \
1980 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1982 #define StatslogTest( level ) (ldap_debug & (level))
1983 #elif defined(LDAP_SYSLOG)
1984 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1986 if ( ldap_syslog & (level) ) \
1987 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1990 #define StatslogTest( level ) (ldap_syslog & (level))
1992 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1993 #define StatslogTest( level ) (0)
1997 * listener; need to access it from monitor backend
1999 struct slap_listener {
2000 struct berval sl_url;
2001 struct berval sl_name;
2006 #ifdef LDAP_CONNECTIONLESS
2007 int sl_is_udp; /* UDP listener is also data port */
2011 #define sl_addr sl_sa.sa_in_addr
2014 #ifdef SLAPD_MONITOR
2031 #endif /* SLAPD_MONITOR */
2034 * Better know these all around slapd
2036 #define SLAP_LDAPDN_PRETTY 0x1
2037 #define SLAP_LDAPDN_MAXLEN 8192
2042 #ifdef LDAP_CLIENT_UPDATE
2043 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
2044 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
2045 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
2046 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
2047 #endif /* LDAP_CLIENT_UPDATE */
2049 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
2050 #define SLAP_SEARCH_MAX_CTRLS 10
2055 #include "proto-slap.h"
2057 #endif /* _SLAP_H_ */