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"
38 #define SLAP_EXTENDED_SCHEMA 1
42 * SLAPD Memory allocation macros
44 * Unlike ch_*() routines, these routines do not assert() upon
45 * allocation error. They are intended to be used instead of
46 * ch_*() routines where the caller has implemented proper
47 * checking for and handling of allocation errors.
49 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
51 #define SLAP_MALLOC(s) ber_memalloc((s))
52 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
53 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
54 #define SLAP_FREE(p) ber_memfree((p))
55 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
56 #define SLAP_STRDUP(s) ber_strdup((s))
57 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
60 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
63 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
64 #define SLAPD_ANONYMOUS "cn=anonymous"
66 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
67 * This is a value used internally by the backends. It is needed to allow
68 * adding values that already exist without getting an error as required by
69 * modrdn when the new rdn was already an attribute value itself.
71 #define SLAP_MOD_SOFTADD 0x1000
73 #define MAXREMATCHES (100)
75 #define SLAP_MAX_WORKER_THREADS (32)
77 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
78 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
80 #define SLAP_TEXT_BUFLEN (256)
82 /* psuedo error code indicating abandoned operation */
83 #define SLAPD_ABANDON (-1)
85 /* psuedo error code indicating disconnect */
86 #define SLAPD_DISCONNECT (-2)
89 /* We assume "C" locale, that is US-ASCII */
90 #define ASCII_SPACE(c) ( (c) == ' ' )
91 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
92 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
93 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
94 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
95 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
96 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
98 #define SLAP_NIBBLE(c) ((c)&0x0f)
99 #define SLAP_ESCAPE_CHAR ('\\')
100 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
101 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
103 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
104 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
106 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
107 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
108 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
109 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
110 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
112 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
113 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
114 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
115 #define OID_SEPARATOR(c) ( (c) == '.' )
116 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
118 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
119 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
121 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
122 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
124 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
126 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
127 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
128 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
129 (c) == '?' || (c) == ' ' || (c) == '=' )
130 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
132 /* must match in schema_init.c */
133 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
134 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
135 #define SLAPD_GROUP_ATTR "member"
136 #define SLAPD_GROUP_CLASS "groupOfNames"
137 #define SLAPD_ROLE_ATTR "roleOccupant"
138 #define SLAPD_ROLE_CLASS "organizationalRole"
140 #ifdef SLAPD_ACI_ENABLED
141 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
144 /* change this to "OpenLDAPset" */
145 #define SLAPD_ACI_SET_ATTR "template"
147 #define SLAPD_TOP_OID "2.5.6.0"
149 LDAP_SLAPD_V (int) slap_debug;
151 typedef unsigned long slap_mask_t;
153 /* Security Strength Factor */
154 typedef unsigned slap_ssf_t;
156 typedef struct slap_ssf_set {
158 slap_ssf_t sss_transport;
161 slap_ssf_t sss_update_ssf;
162 slap_ssf_t sss_update_transport;
163 slap_ssf_t sss_update_tls;
164 slap_ssf_t sss_update_sasl;
165 slap_ssf_t sss_simple_bind;
169 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
170 #define SLAP_GETDN_AUTHCID 2
171 #define SLAP_GETDN_AUTHZID 4
176 #define SLAP_INDEX_TYPE 0x00FFUL
177 #define SLAP_INDEX_UNDEFINED 0x0001UL
178 #define SLAP_INDEX_PRESENT 0x0002UL
179 #define SLAP_INDEX_EQUALITY 0x0004UL
180 #define SLAP_INDEX_APPROX 0x0008UL
181 #define SLAP_INDEX_SUBSTR 0x0010UL
182 #define SLAP_INDEX_EXTENDED 0x0020UL
184 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
186 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
188 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
190 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
191 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
192 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
193 #define SLAP_INDEX_SUBSTR_DEFAULT \
194 ( SLAP_INDEX_SUBSTR \
195 | SLAP_INDEX_SUBSTR_INITIAL \
196 | SLAP_INDEX_SUBSTR_ANY \
197 | SLAP_INDEX_SUBSTR_FINAL )
199 #define SLAP_INDEX_SUBSTR_MINLEN 2
200 #define SLAP_INDEX_SUBSTR_MAXLEN 4
201 #define SLAP_INDEX_SUBSTR_STEP 2
203 #define SLAP_INDEX_FLAGS 0xF000UL
204 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
205 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
208 * there is a single index for each attribute. these prefixes ensure
209 * that there is no collision among keys.
211 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
212 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
213 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
214 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
215 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
216 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
218 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
219 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
220 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
221 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
222 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
224 #ifdef LDAP_CLIENT_UPDATE
225 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
226 #endif /* LDAP_CLIENT_UPDATE */
229 * represents schema information for a database
231 #define SLAP_SCHERR_OUTOFMEM 1
232 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
233 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
234 #define SLAP_SCHERR_CLASS_BAD_SUP 4
235 #define SLAP_SCHERR_CLASS_DUP 5
236 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
237 #define SLAP_SCHERR_ATTR_BAD_MR 7
238 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
239 #define SLAP_SCHERR_ATTR_BAD_SUP 9
240 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
241 #define SLAP_SCHERR_ATTR_DUP 11
242 #define SLAP_SCHERR_MR_NOT_FOUND 12
243 #define SLAP_SCHERR_MR_INCOMPLETE 13
244 #define SLAP_SCHERR_MR_DUP 14
245 #define SLAP_SCHERR_SYN_NOT_FOUND 15
246 #define SLAP_SCHERR_SYN_DUP 16
247 #define SLAP_SCHERR_NO_NAME 17
248 #define SLAP_SCHERR_NOT_SUPPORTED 18
249 #define SLAP_SCHERR_BAD_DESCR 19
250 #define SLAP_SCHERR_OIDM 20
251 #define SLAP_SCHERR_CR_DUP 21
252 #define SLAP_SCHERR_CR_BAD_STRUCT 22
253 #define SLAP_SCHERR_CR_BAD_AUX 23
254 #define SLAP_SCHERR_CR_BAD_AT 24
255 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
257 typedef union slap_sockaddr {
258 struct sockaddr sa_addr;
259 struct sockaddr_in sa_in_addr;
261 struct sockaddr_storage sa_storage;
262 struct sockaddr_in6 sa_in6_addr;
265 struct sockaddr_un sa_un_addr;
270 extern int slap_inet4or6;
273 typedef struct slap_oid_macro {
274 struct berval som_oid;
276 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
279 /* forward declarations */
281 struct slap_matching_rule;
283 typedef int slap_syntax_validate_func LDAP_P((
284 struct slap_syntax *syntax,
285 struct berval * in));
287 typedef int slap_syntax_transform_func LDAP_P((
288 struct slap_syntax *syntax,
290 struct berval * out));
292 typedef struct slap_syntax {
294 #define ssyn_oid ssyn_syn.syn_oid
295 #define ssyn_desc ssyn_syn.syn_desc
296 #define ssyn_extensions ssyn_syn.syn_extensions
299 ber_len_t ssyn_oidlen;
300 * has been replaced by a struct berval that uses the value
301 * provided by ssyn_syn.syn_oid; a macro that expands to
302 * the bv_len field of the berval is provided for backward
303 * compatibility. CAUTION: NEVER FREE THE BERVAL
305 struct berval ssyn_bvoid;
306 #define ssyn_oidlen ssyn_bvoid.bv_len
308 unsigned int ssyn_flags;
310 #define SLAP_SYNTAX_NONE 0x0000U
311 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
312 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
313 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
314 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
316 slap_syntax_validate_func *ssyn_validate;
317 slap_syntax_transform_func *ssyn_normalize;
318 slap_syntax_transform_func *ssyn_pretty;
320 #ifdef SLAPD_BINARY_CONVERSION
321 /* convert to and from binary */
322 slap_syntax_transform_func *ssyn_ber2str;
323 slap_syntax_transform_func *ssyn_str2ber;
326 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
329 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
330 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
331 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
332 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
333 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
335 typedef struct slap_syntax_defs_rec {
338 slap_syntax_validate_func *sd_validate;
339 slap_syntax_transform_func *sd_normalize;
340 slap_syntax_transform_func *sd_pretty;
341 #ifdef SLAPD_BINARY_CONVERSION
342 slap_syntax_transform_func *sd_ber2str;
343 slap_syntax_transform_func *sd_str2ber;
345 } slap_syntax_defs_rec;
347 /* X -> Y Converter */
348 typedef int slap_mr_convert_func LDAP_P((
350 struct berval * out ));
353 typedef int slap_mr_normalize_func LDAP_P((
355 struct slap_syntax *syntax, /* NULL if in is asserted value */
356 struct slap_matching_rule *mr,
358 struct berval * out ));
360 /* Match (compare) function */
361 typedef int slap_mr_match_func LDAP_P((
364 struct slap_syntax *syntax, /* syntax of stored value */
365 struct slap_matching_rule *mr,
366 struct berval * value,
367 void * assertValue ));
369 /* Index generation function */
370 typedef int slap_mr_indexer_func LDAP_P((
373 struct slap_syntax *syntax, /* syntax of stored value */
374 struct slap_matching_rule *mr,
375 struct berval *prefix,
379 /* Filter index function */
380 typedef int slap_mr_filter_func LDAP_P((
383 struct slap_syntax *syntax, /* syntax of stored value */
384 struct slap_matching_rule *mr,
385 struct berval *prefix,
389 typedef struct slap_matching_rule_use MatchingRuleUse;
391 typedef struct slap_matching_rule {
392 LDAPMatchingRule smr_mrule;
393 MatchingRuleUse *smr_mru;
394 /* RFC2252 string representation */
395 struct berval smr_str;
398 * ber_len_t smr_oidlen;
399 * has been replaced by a struct berval that uses the value
400 * provided by smr_mrule.mr_oid; a macro that expands to
401 * the bv_len field of the berval is provided for backward
402 * compatibility. CAUTION: NEVER FREE THE BERVAL
404 struct berval smr_bvoid;
405 #define smr_oidlen smr_bvoid.bv_len
407 slap_mask_t smr_usage;
409 #define SLAP_MR_HIDE 0x8000U
411 #define SLAP_MR_TYPE_MASK 0x0F00U
412 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
413 #define SLAP_MR_USAGE 0x000FU
415 #define SLAP_MR_NONE 0x0000U
416 #define SLAP_MR_EQUALITY 0x0100U
417 #define SLAP_MR_ORDERING 0x0200U
418 #define SLAP_MR_SUBSTR 0x0400U
419 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
421 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
422 #define SLAP_MR_DN_FOLD 0x0008U
424 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
425 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
426 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
429 * normally the provided value is expected to conform to
430 * assertion syntax specified in the matching rule, however
431 * at times (such as during individual value modification),
432 * the provided value is expected to conform to the
433 * attribute's value syntax.
435 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
436 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
437 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
438 #define SLAP_MR_VALUE_NORMALIZED_MATCH 0x0004U
440 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
441 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
442 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
443 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
445 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
446 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
447 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
448 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
449 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
450 == SLAP_MR_VALUE_SYNTAX_MATCH)
453 slap_mr_convert_func *smr_convert;
454 slap_mr_normalize_func *smr_normalize;
455 slap_mr_match_func *smr_match;
456 slap_mr_indexer_func *smr_indexer;
457 slap_mr_filter_func *smr_filter;
460 * null terminated array of syntaxes compatible with this syntax
461 * note: when MS_EXT is set, this MUST NOT contain the assertion
462 * syntax of the rule. When MS_EXT is not set, it MAY.
464 Syntax **smr_compat_syntaxes;
466 struct slap_matching_rule *smr_associated;
467 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
469 #define smr_oid smr_mrule.mr_oid
470 #define smr_names smr_mrule.mr_names
471 #define smr_desc smr_mrule.mr_desc
472 #define smr_obsolete smr_mrule.mr_obsolete
473 #define smr_syntax_oid smr_mrule.mr_syntax_oid
474 #define smr_extensions smr_mrule.mr_extensions
477 struct slap_matching_rule_use {
478 LDAPMatchingRuleUse smru_mruleuse;
479 MatchingRule *smru_mr;
480 /* RFC2252 string representation */
481 struct berval smru_str;
483 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
485 #define smru_oid smru_mruleuse.mru_oid
486 #define smru_names smru_mruleuse.mru_names
487 #define smru_desc smru_mruleuse.mru_desc
488 #define smru_obsolete smru_mruleuse.mru_obsolete
489 #define smru_applies_oids smru_mruleuse.mru_applies_oids
491 #define smru_usage smru_mr->smr_usage
492 } /* MatchingRuleUse */ ;
494 typedef struct slap_mrule_defs_rec {
496 slap_mask_t mrd_usage;
497 char ** mrd_compat_syntaxes;
498 slap_mr_convert_func * mrd_convert;
499 slap_mr_normalize_func * mrd_normalize;
500 slap_mr_match_func * mrd_match;
501 slap_mr_indexer_func * mrd_indexer;
502 slap_mr_filter_func * mrd_filter;
504 char * mrd_associated;
505 } slap_mrule_defs_rec;
507 struct slap_backend_db;
511 typedef int (AttributeTypeSchemaCheckFN)(
512 struct slap_backend_db *be,
513 struct slap_entry *e,
514 struct slap_attr *attr,
516 char *textbuf, size_t textlen );
518 typedef struct slap_attribute_type {
519 LDAPAttributeType sat_atype;
520 struct berval sat_cname;
521 struct slap_attribute_type *sat_sup;
522 struct slap_attribute_type **sat_subtypes;
523 MatchingRule *sat_equality;
524 MatchingRule *sat_approx;
525 MatchingRule *sat_ordering;
526 MatchingRule *sat_substr;
529 AttributeTypeSchemaCheckFN *sat_check;
531 #define SLAP_AT_NONE 0x0000U
532 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
533 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
534 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
535 slap_mask_t sat_flags;
537 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
539 #define sat_oid sat_atype.at_oid
540 #define sat_names sat_atype.at_names
541 #define sat_desc sat_atype.at_desc
542 #define sat_obsolete sat_atype.at_obsolete
543 #define sat_sup_oid sat_atype.at_sup_oid
544 #define sat_equality_oid sat_atype.at_equality_oid
545 #define sat_ordering_oid sat_atype.at_ordering_oid
546 #define sat_substr_oid sat_atype.at_substr_oid
547 #define sat_syntax_oid sat_atype.at_syntax_oid
548 #define sat_single_value sat_atype.at_single_value
549 #define sat_collective sat_atype.at_collective
550 #define sat_no_user_mod sat_atype.at_no_user_mod
551 #define sat_usage sat_atype.at_usage
552 #define sat_extensions sat_atype.at_extensions
554 struct slap_attr_desc *sat_ad;
555 ldap_pvt_thread_mutex_t sat_ad_mutex;
558 #define is_at_operational(at) ((at)->sat_usage)
559 #define is_at_single_value(at) ((at)->sat_single_value)
560 #define is_at_collective(at) ((at)->sat_collective)
561 #define is_at_obsolete(at) ((at)->sat_obsolete)
562 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
564 struct slap_object_class;
566 typedef int (ObjectClassSchemaCheckFN)(
567 struct slap_backend_db *be,
568 struct slap_entry *e,
569 struct slap_object_class *oc,
571 char *textbuf, size_t textlen );
573 typedef struct slap_object_class {
574 LDAPObjectClass soc_oclass;
575 struct berval soc_cname;
576 struct slap_object_class **soc_sups;
577 AttributeType **soc_required;
578 AttributeType **soc_allowed;
579 ObjectClassSchemaCheckFN *soc_check;
580 slap_mask_t soc_flags;
581 #define soc_oid soc_oclass.oc_oid
582 #define soc_names soc_oclass.oc_names
583 #define soc_desc soc_oclass.oc_desc
584 #define soc_obsolete soc_oclass.oc_obsolete
585 #define soc_sup_oids soc_oclass.oc_sup_oids
586 #define soc_kind soc_oclass.oc_kind
587 #define soc_at_oids_must soc_oclass.oc_at_oids_must
588 #define soc_at_oids_may soc_oclass.oc_at_oids_may
589 #define soc_extensions soc_oclass.oc_extensions
591 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
594 #define SLAP_OC_ALIAS 0x0001
595 #define SLAP_OC_REFERRAL 0x0002
596 #define SLAP_OC_SUBENTRY 0x0004
597 #define SLAP_OC_DYNAMICOBJECT 0x0008
598 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
599 #define SLAP_OC__MASK 0x001F
600 #define SLAP_OC__END 0x0020
601 #define SLAP_OC_OPERATIONAL 0x4000
602 #define SLAP_OC_HIDE 0x8000
607 typedef struct slap_content_rule {
608 LDAPContentRule scr_crule;
609 ObjectClass *scr_sclass;
610 ObjectClass **scr_auxiliaries; /* optional */
611 AttributeType **scr_required; /* optional */
612 AttributeType **scr_allowed; /* optional */
613 AttributeType **scr_precluded; /* optional */
614 #define scr_oid scr_crule.cr_oid
615 #define scr_names scr_crule.cr_names
616 #define scr_desc scr_crule.cr_desc
617 #define scr_obsolete scr_crule.cr_obsolete
618 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
619 #define scr_at_oids_must scr_crule.cr_at_oids_must
620 #define scr_at_oids_may scr_crule.cr_at_oids_may
621 #define scr_at_oids_not scr_crule.cr_at_oids_not
623 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
626 /* Represents a recognized attribute description ( type + options ). */
627 typedef struct slap_attr_desc {
628 struct slap_attr_desc *ad_next;
629 AttributeType *ad_type; /* attribute type, must be specified */
630 struct berval ad_cname; /* canonical name, must be specified */
631 struct berval ad_tags; /* empty if no tagging options */
633 #define SLAP_DESC_NONE 0x00U
634 #define SLAP_DESC_BINARY 0x01U
635 #define SLAP_DESC_TAG_RANGE 0x80U
636 } AttributeDescription;
638 typedef struct slap_attr_name {
639 struct berval an_name;
640 AttributeDescription *an_desc;
644 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
645 #define slap_ad_is_tag_range(ad) \
646 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
647 #define slap_ad_is_binary(ad) \
648 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
651 * pointers to schema elements used internally
653 struct slap_internal_schema {
655 ObjectClass *si_oc_top;
656 ObjectClass *si_oc_extensibleObject;
657 ObjectClass *si_oc_alias;
658 ObjectClass *si_oc_referral;
659 ObjectClass *si_oc_rootdse;
660 ObjectClass *si_oc_subentry;
661 ObjectClass *si_oc_subschema;
662 ObjectClass *si_oc_monitor;
663 ObjectClass *si_oc_collectiveAttributeSubentry;
664 ObjectClass *si_oc_dynamicObject;
666 /* objectClass attribute descriptions */
667 AttributeDescription *si_ad_objectClass;
669 /* operational attribute descriptions */
670 AttributeDescription *si_ad_structuralObjectClass;
671 AttributeDescription *si_ad_creatorsName;
672 AttributeDescription *si_ad_createTimestamp;
673 AttributeDescription *si_ad_modifiersName;
674 AttributeDescription *si_ad_modifyTimestamp;
675 AttributeDescription *si_ad_hasSubordinates;
676 AttributeDescription *si_ad_subschemaSubentry;
677 AttributeDescription *si_ad_collectiveSubentries;
678 AttributeDescription *si_ad_collectiveExclusions;
679 AttributeDescription *si_ad_entryUUID;
680 AttributeDescription *si_ad_entryCSN;
681 AttributeDescription *si_ad_superiorUUID;
683 /* root DSE attribute descriptions */
684 AttributeDescription *si_ad_altServer;
685 AttributeDescription *si_ad_namingContexts;
686 AttributeDescription *si_ad_supportedControl;
687 AttributeDescription *si_ad_supportedExtension;
688 AttributeDescription *si_ad_supportedLDAPVersion;
689 AttributeDescription *si_ad_supportedSASLMechanisms;
690 AttributeDescription *si_ad_supportedFeatures;
691 AttributeDescription *si_ad_monitorContext;
692 AttributeDescription *si_ad_vendorName;
693 AttributeDescription *si_ad_vendorVersion;
695 /* subentry attribute descriptions */
696 AttributeDescription *si_ad_administrativeRole;
697 AttributeDescription *si_ad_subtreeSpecification;
699 /* subschema subentry attribute descriptions */
700 AttributeDescription *si_ad_ditStructureRules;
701 AttributeDescription *si_ad_ditContentRules;
702 AttributeDescription *si_ad_nameForms;
703 AttributeDescription *si_ad_objectClasses;
704 AttributeDescription *si_ad_attributeTypes;
705 AttributeDescription *si_ad_ldapSyntaxes;
706 AttributeDescription *si_ad_matchingRules;
707 AttributeDescription *si_ad_matchingRuleUse;
709 /* Aliases & Referrals */
710 AttributeDescription *si_ad_aliasedObjectName;
711 AttributeDescription *si_ad_ref;
713 /* Access Control Internals */
714 AttributeDescription *si_ad_entry;
715 AttributeDescription *si_ad_children;
716 AttributeDescription *si_ad_saslAuthzTo;
717 AttributeDescription *si_ad_saslAuthzFrom;
718 #ifdef SLAPD_ACI_ENABLED
719 AttributeDescription *si_ad_aci;
722 /* dynamic entries */
723 AttributeDescription *si_ad_entryTtl;
724 AttributeDescription *si_ad_dynamicSubtrees;
726 /* Other attributes descriptions */
727 AttributeDescription *si_ad_distinguishedName;
728 AttributeDescription *si_ad_name;
729 AttributeDescription *si_ad_cn;
730 AttributeDescription *si_ad_userPassword;
731 #ifdef SLAPD_AUTHPASSWD
732 AttributeDescription *si_ad_authPassword;
734 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
735 AttributeDescription *si_ad_krbName;
738 /* Undefined Attribute Type */
739 AttributeType *si_at_undefined;
742 MatchingRule *si_mr_distinguishedNameMatch;
743 MatchingRule *si_mr_integerMatch;
746 Syntax *si_syn_octetString;
747 Syntax *si_syn_distinguishedName;
748 Syntax *si_syn_integer;
751 typedef struct slap_attr_assertion {
752 AttributeDescription *aa_desc;
753 struct berval aa_value;
754 } AttributeAssertion;
756 typedef struct slap_ss_assertion {
757 AttributeDescription *sa_desc;
758 struct berval sa_initial;
759 struct berval *sa_any;
760 struct berval sa_final;
761 } SubstringsAssertion;
763 typedef struct slap_mr_assertion {
764 MatchingRule *ma_rule; /* optional */
765 struct berval ma_rule_text; /* optional */
766 AttributeDescription *ma_desc; /* optional */
767 int ma_dnattrs; /* boolean */
768 struct berval ma_value; /* required */
769 } MatchingRuleAssertion;
772 * represents a search filter
774 typedef struct slap_filter {
775 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
776 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
777 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
778 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
781 /* precomputed result */
782 ber_int_t f_un_result;
785 struct berval *f_un_dn;
788 AttributeDescription *f_un_desc;
790 /* simple value assertion */
791 AttributeAssertion *f_un_ava;
793 /* substring assertion */
794 SubstringsAssertion *f_un_ssa;
796 /* matching rule assertion */
797 MatchingRuleAssertion *f_un_mra;
799 #define f_dn f_un.f_un_dn
800 #define f_desc f_un.f_un_desc
801 #define f_ava f_un.f_un_ava
802 #define f_av_desc f_un.f_un_ava->aa_desc
803 #define f_av_value f_un.f_un_ava->aa_value
804 #define f_sub f_un.f_un_ssa
805 #define f_sub_desc f_un.f_un_ssa->sa_desc
806 #define f_sub_initial f_un.f_un_ssa->sa_initial
807 #define f_sub_any f_un.f_un_ssa->sa_any
808 #define f_sub_final f_un.f_un_ssa->sa_final
809 #define f_mra f_un.f_un_mra
810 #define f_mr_rule f_un.f_un_mra->ma_rule
811 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
812 #define f_mr_desc f_un.f_un_mra->ma_desc
813 #define f_mr_value f_un.f_un_mra->ma_value
814 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
817 struct slap_filter *f_un_complex;
820 #define f_result f_un.f_un_result
821 #define f_and f_un.f_un_complex
822 #define f_or f_un.f_un_complex
823 #define f_not f_un.f_un_complex
824 #define f_list f_un.f_un_complex
826 struct slap_filter *f_next;
829 /* compare routines can return undefined */
830 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
832 typedef struct slap_valuesreturnfilter {
833 ber_tag_t vrf_choice;
836 /* precomputed result */
837 ber_int_t vrf_un_result;
843 AttributeDescription *vrf_un_desc;
845 /* simple value assertion */
846 AttributeAssertion *vrf_un_ava;
848 /* substring assertion */
849 SubstringsAssertion *vrf_un_ssa;
851 /* matching rule assertion */
852 MatchingRuleAssertion *vrf_un_mra;
854 #define vrf_result vrf_un.vrf_un_result
855 #define vrf_dn vrf_un.vrf_un_dn
856 #define vrf_desc vrf_un.vrf_un_desc
857 #define vrf_ava vrf_un.vrf_un_ava
858 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
859 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
860 #define vrf_ssa vrf_un.vrf_un_ssa
861 #define vrf_sub vrf_un.vrf_un_ssa
862 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
863 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
864 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
865 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
866 #define vrf_mra vrf_un.vrf_un_mra
867 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
868 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
869 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
870 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
871 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
876 struct slap_valuesreturnfilter *vrf_next;
877 } ValuesReturnFilter;
880 * represents an attribute (description + values)
882 typedef struct slap_attr {
883 AttributeDescription *a_desc;
885 struct slap_attr *a_next;
887 #define SLAP_ATTR_IXADD 0x1U
888 #define SLAP_ATTR_IXDEL 0x2U
893 * the id used in the indexes to refer to an entry
895 typedef unsigned long ID;
896 #define NOID ((ID)~0)
899 * represents an entry in core
901 typedef struct slap_entry {
903 * The ID field should only be changed before entry is
904 * inserted into a cache. The ID value is backend
909 struct berval e_name; /* name (DN) of this entry */
910 struct berval e_nname; /* normalized name (DN) of this entry */
912 /* for migration purposes */
913 #define e_dn e_name.bv_val
914 #define e_ndn e_nname.bv_val
916 Attribute *e_attrs; /* list of attributes + values */
918 slap_mask_t e_ocflags;
920 struct berval e_bv; /* For entry_encode/entry_decode */
922 /* for use by the backend for any purpose */
929 typedef struct slap_mod {
931 AttributeDescription *sm_desc;
932 struct berval sm_type;
933 BerVarray sm_bvalues;
936 typedef struct slap_mod_list {
937 Modification sml_mod;
938 #define sml_op sml_mod.sm_op
939 #define sml_desc sml_mod.sm_desc
940 #define sml_type sml_mod.sm_type
941 #define sml_bvalues sml_mod.sm_bvalues
942 struct slap_mod_list *sml_next;
945 typedef struct slap_ldap_modlist {
947 struct slap_ldap_modlist *ml_next;
948 #define ml_op ml_mod.mod_op
949 #define ml_type ml_mod.mod_type
950 #define ml_values ml_mod.mod_values
951 #define ml_bvalues ml_mod.mod_bvalues
955 * represents an access control list
957 typedef enum slap_access_e {
958 ACL_INVALID_ACCESS = -1,
967 typedef enum slap_control_e {
968 ACL_INVALID_CONTROL = 0,
974 typedef enum slap_style_e {
982 /* alternate names */
983 ACL_STYLE_EXACT = ACL_STYLE_BASE
986 typedef struct slap_authz_info {
987 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
988 struct berval sai_mech; /* SASL Mechanism */
989 struct berval sai_dn; /* DN for reporting purposes */
990 struct berval sai_ndn; /* Normalized DN */
992 /* Security Strength Factors */
993 slap_ssf_t sai_ssf; /* Overall SSF */
994 slap_ssf_t sai_transport_ssf; /* Transport SSF */
995 slap_ssf_t sai_tls_ssf; /* TLS SSF */
996 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
997 } AuthorizationInformation;
1000 typedef struct slap_access {
1001 slap_control_t a_type;
1003 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1005 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1006 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1007 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1008 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1009 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1010 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1012 #define ACL_PRIV_MASK 0x00ffUL
1015 #define ACL_PRIV_LEVEL 0x1000UL
1016 #define ACL_PRIV_ADDITIVE 0x2000UL
1017 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1020 #define ACL_PRIV_INVALID 0x0UL
1022 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1023 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1024 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1025 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1027 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1028 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1030 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1032 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1034 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1035 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1036 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1038 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1039 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1040 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1041 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1042 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1043 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1045 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1046 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1047 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1048 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1049 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1050 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1051 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1053 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1054 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1055 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1056 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1057 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1058 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1060 slap_mask_t a_access_mask;
1062 AuthorizationInformation a_authz;
1063 #define a_dn_pat a_authz.sai_dn
1065 slap_style_t a_dn_style;
1066 AttributeDescription *a_dn_at;
1070 slap_style_t a_peername_style;
1071 struct berval a_peername_pat;
1072 slap_style_t a_sockname_style;
1073 struct berval a_sockname_pat;
1075 slap_style_t a_domain_style;
1076 struct berval a_domain_pat;
1077 int a_domain_expand;
1079 slap_style_t a_sockurl_style;
1080 struct berval a_sockurl_pat;
1081 slap_style_t a_set_style;
1082 struct berval a_set_pat;
1084 #ifdef SLAPD_ACI_ENABLED
1085 AttributeDescription *a_aci_at;
1089 slap_style_t a_group_style;
1090 struct berval a_group_pat;
1091 ObjectClass *a_group_oc;
1092 AttributeDescription *a_group_at;
1094 struct slap_access *a_next;
1098 typedef struct slap_acl {
1099 /* "to" part: the entries this acl applies to */
1101 slap_style_t acl_dn_style;
1103 struct berval acl_dn_pat;
1104 AttributeName *acl_attrs;
1106 /* "by" part: list of who has what access to the entries */
1109 struct slap_acl *acl_next;
1112 typedef struct slap_acl_state {
1113 unsigned as_recorded;
1114 #define ACL_STATE_NOT_RECORDED 0x0
1115 #define ACL_STATE_RECORDED_VD 0x1
1116 #define ACL_STATE_RECORDED_NV 0x2
1117 #define ACL_STATE_RECORDED 0x3
1120 AccessControl *as_vd_acl;
1121 AccessControl *as_vi_acl;
1122 slap_mask_t as_vd_acl_mask;
1123 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1124 int as_vd_acl_count;
1126 Access *as_vd_access;
1127 int as_vd_access_count;
1130 AttributeDescription *as_vd_ad;
1131 } AccessControlState;
1132 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1133 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1136 * replog moddn param structure
1138 struct slap_replog_moddn {
1139 struct berval *newrdn;
1141 struct berval *newsup;
1146 * represents a backend
1149 typedef struct slap_backend_info BackendInfo; /* per backend type */
1150 typedef struct slap_backend_db BackendDB; /* per backend database */
1152 LDAP_SLAPD_V (int) nBackendInfo;
1153 LDAP_SLAPD_V (int) nBackendDB;
1154 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1155 LDAP_SLAPD_V (BackendDB *) backendDB;
1157 LDAP_SLAPD_V (int) slapMode;
1158 #define SLAP_UNDEFINED_MODE 0x0000
1159 #define SLAP_SERVER_MODE 0x0001
1160 #define SLAP_TOOL_MODE 0x0002
1161 #define SLAP_MODE 0x0003
1163 #define SLAP_TRUNCATE_MODE 0x0100
1165 struct slap_replica_info {
1166 char *ri_host; /* supersedes be_replica */
1167 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1168 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1169 int ri_exclude; /* 1 => exclude ri_attrs */
1172 struct slap_limits_set {
1180 int lms_s_unchecked;
1185 struct slap_limits {
1186 int lm_type; /* type of pattern */
1187 #define SLAP_LIMITS_UNDEFINED 0x0000
1188 #define SLAP_LIMITS_EXACT 0x0001
1189 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1190 #define SLAP_LIMITS_ONE 0x0002
1191 #define SLAP_LIMITS_SUBTREE 0x0003
1192 #define SLAP_LIMITS_CHILDREN 0x0004
1193 #define SLAP_LIMITS_REGEX 0x0005
1194 #define SLAP_LIMITS_ANONYMOUS 0x0006
1195 #define SLAP_LIMITS_USERS 0x0007
1196 #define SLAP_LIMITS_ANY 0x0008
1197 regex_t lm_dn_regex; /* regex data for REGEX */
1200 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1201 * pattern for REGEX; NULL for ANONYMOUS, USERS
1203 struct berval lm_dn_pat;
1205 struct slap_limits_set lm_limits;
1208 /* temporary aliases */
1209 typedef BackendDB Backend;
1210 #define nbackends nBackendDB
1211 #define backends backendDB
1213 struct slap_backend_db {
1214 BackendInfo *bd_info; /* pointer to shared backend info */
1216 /* BackendInfo accessors */
1217 #define be_config bd_info->bi_db_config
1218 #define be_type bd_info->bi_type
1220 #define be_bind bd_info->bi_op_bind
1221 #define be_unbind bd_info->bi_op_unbind
1222 #define be_add bd_info->bi_op_add
1223 #define be_compare bd_info->bi_op_compare
1224 #define be_delete bd_info->bi_op_delete
1225 #define be_modify bd_info->bi_op_modify
1226 #define be_modrdn bd_info->bi_op_modrdn
1227 #define be_search bd_info->bi_op_search
1229 #define be_extended bd_info->bi_extended
1231 #define be_release bd_info->bi_entry_release_rw
1232 #define be_chk_referrals bd_info->bi_chk_referrals
1233 #define be_group bd_info->bi_acl_group
1234 #define be_attribute bd_info->bi_acl_attribute
1235 #define be_operational bd_info->bi_operational
1238 * define to honor hasSubordinates operational attribute in search filters
1239 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1242 #define be_has_subordinates bd_info->bi_has_subordinates
1244 #define be_controls bd_info->bi_controls
1246 #define be_connection_init bd_info->bi_connection_init
1247 #define be_connection_destroy bd_info->bi_connection_destroy
1250 #define be_entry_open bd_info->bi_tool_entry_open
1251 #define be_entry_close bd_info->bi_tool_entry_close
1252 #define be_entry_first bd_info->bi_tool_entry_first
1253 #define be_entry_next bd_info->bi_tool_entry_next
1254 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1255 #define be_entry_get bd_info->bi_tool_entry_get
1256 #define be_entry_put bd_info->bi_tool_entry_put
1257 #define be_sync bd_info->bi_tool_sync
1260 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1261 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1262 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1263 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1264 #define SLAP_BFLAG_ALIASES 0x0100U
1265 #define SLAP_BFLAG_REFERRALS 0x0200U
1266 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1267 #define SLAP_BFLAG_MONITOR 0x1000U
1268 #define SLAP_BFLAG_DYNAMIC 0x2000U
1269 slap_mask_t be_flags;
1270 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1271 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1272 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1273 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1274 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1275 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1277 slap_mask_t be_restrictops; /* restriction operations */
1278 #define SLAP_RESTRICT_OP_ADD 0x0001U
1279 #define SLAP_RESTRICT_OP_BIND 0x0002U
1280 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1281 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1282 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1283 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1284 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1285 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1287 #define SLAP_RESTRICT_OP_READS \
1288 ( SLAP_RESTRICT_OP_COMPARE \
1289 | SLAP_RESTRICT_OP_SEARCH )
1290 #define SLAP_RESTRICT_OP_WRITES \
1291 ( SLAP_RESTRICT_OP_ADD \
1292 | SLAP_RESTRICT_OP_DELETE \
1293 | SLAP_RESTRICT_OP_MODIFY \
1294 | SLAP_RESTRICT_OP_RENAME )
1296 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1297 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1298 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1300 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1302 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1303 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1304 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1305 0x0004U /* unprotected simple auth */
1306 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1308 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1309 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1311 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1313 slap_mask_t be_requires; /* pre-operation requirements */
1314 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1315 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1316 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1317 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1318 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1320 /* Required Security Strength Factor */
1321 slap_ssf_set_t be_ssf_set;
1323 /* these should be renamed from be_ to bd_ */
1324 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1325 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1326 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1327 struct berval be_schemadn; /* per-backend subschema subentry DN */
1328 struct berval be_schemandn; /* normalized subschema DN */
1329 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1330 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1331 struct berval be_rootpw; /* the magic "root" password for this db */
1332 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1333 #define be_sizelimit be_def_limit.lms_s_soft
1334 #define be_timelimit be_def_limit.lms_t_soft
1335 struct slap_limits_set be_def_limit; /* default limits */
1336 struct slap_limits **be_limits; /* regex-based size and time limits */
1337 AccessControl *be_acl; /* access control list for this backend */
1338 slap_access_t be_dfltaccess; /* access given if no acl matches */
1339 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1340 char *be_replogfile; /* replication log file (in master) */
1341 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1342 BerVarray be_update_refs; /* where to refer modifying clients to */
1344 void *be_private; /* anything the backend database needs */
1346 void *be_pb; /* Netscape plugin */
1352 /* Backend function typedefs */
1353 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1354 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1355 const char *fname, int lineno,
1356 int argc, char **argv));
1357 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1358 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1359 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1361 typedef int (BI_db_init) LDAP_P((Backend *bd));
1362 typedef int (BI_db_config) LDAP_P((Backend *bd,
1363 const char *fname, int lineno,
1364 int argc, char **argv));
1365 typedef int (BI_db_open) LDAP_P((Backend *bd));
1366 typedef int (BI_db_close) LDAP_P((Backend *bd));
1367 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1369 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1370 struct slap_conn *c, struct slap_op *o,
1371 struct berval *dn, struct berval *ndn, int method,
1372 struct berval *cred, struct berval *edn ));
1373 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1374 struct slap_conn *c, struct slap_op *o ));
1375 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1376 struct slap_conn *c, struct slap_op *o,
1377 struct berval *base, struct berval *nbase,
1378 int scope, int deref,
1379 int slimit, int tlimit,
1380 Filter *f, struct berval *filterstr,
1381 AttributeName *attrs, int attrsonly));
1382 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1383 struct slap_conn *c, struct slap_op *o,
1384 struct berval *dn, struct berval *ndn,
1385 AttributeAssertion *ava));
1386 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1387 struct slap_conn *c, struct slap_op *o,
1388 struct berval *dn, struct berval *ndn,
1390 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1391 struct slap_conn *c, struct slap_op *o,
1392 struct berval *dn, struct berval *ndn,
1393 struct berval *newrdn, struct berval *nnewrdn,
1395 struct berval *newSup, struct berval *nnewSup ));
1396 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1397 struct slap_conn *c, struct slap_op *o,
1399 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1400 struct slap_conn *c, struct slap_op *o,
1401 struct berval *dn, struct berval *ndn));
1402 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1403 struct slap_conn *c, struct slap_op *o,
1406 typedef int (BI_op_extended) LDAP_P((
1408 struct slap_conn *conn,
1411 struct berval * reqdata,
1413 struct berval ** rspdata,
1414 LDAPControl *** rspctrls,
1418 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1419 struct slap_conn *c, struct slap_op *o,
1422 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1423 struct slap_conn *c, struct slap_op *o,
1424 struct berval *dn, struct berval *ndn,
1425 const char **text ));
1427 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1428 struct slap_conn *c, struct slap_op *o,
1432 ObjectClass *group_oc,
1433 AttributeDescription *group_at ));
1435 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1436 struct slap_conn *c, struct slap_op *o,
1437 Entry *e, struct berval *edn,
1438 AttributeDescription *entry_at,
1441 typedef int (BI_operational) LDAP_P((Backend *bd,
1442 struct slap_conn *c, struct slap_op *o,
1443 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1445 typedef int (BI_has_subordinates) LDAP_P((Backend *bd,
1446 struct slap_conn *c, struct slap_op *o,
1447 Entry *e, int *has_subordinates ));
1449 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1450 struct slap_conn *c));
1451 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1452 struct slap_conn *c));
1454 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1455 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1456 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1457 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1458 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1459 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1460 struct berval *text ));
1461 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1462 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1464 struct slap_backend_info {
1465 char *bi_type; /* type of backend */
1468 * per backend type routines:
1469 * bi_init: called to allocate a backend_info structure,
1470 * called once BEFORE configuration file is read.
1471 * bi_init() initializes this structure hence is
1472 * called directly from be_initialize()
1473 * bi_config: called per 'backend' specific option
1474 * all such options must before any 'database' options
1475 * bi_config() is called only from read_config()
1476 * bi_open: called to open each database, called
1477 * once AFTER configuration file is read but
1478 * BEFORE any bi_db_open() calls.
1479 * bi_open() is called from backend_startup()
1480 * bi_close: called to close each database, called
1481 * once during shutdown after all bi_db_close calls.
1482 * bi_close() is called from backend_shutdown()
1483 * bi_destroy: called to destroy each database, called
1484 * once during shutdown after all bi_db_destroy calls.
1485 * bi_destory() is called from backend_destroy()
1488 BI_config *bi_config;
1491 BI_destroy *bi_destroy;
1494 * per database routines:
1495 * bi_db_init: called to initialize each database,
1496 * called upon reading 'database <type>'
1497 * called only from backend_db_init()
1498 * bi_db_config: called to configure each database,
1499 * called per database to handle per database options
1500 * called only from read_config()
1501 * bi_db_open: called to open each database
1502 * called once per database immediately AFTER bi_open()
1503 * calls but before daemon startup.
1504 * called only by backend_startup()
1505 * bi_db_close: called to close each database
1506 * called once per database during shutdown but BEFORE
1507 * any bi_close call.
1508 * called only by backend_shutdown()
1509 * bi_db_destroy: called to destroy each database
1510 * called once per database during shutdown AFTER all
1511 * bi_close calls but before bi_destory calls.
1512 * called only by backend_destory()
1514 BI_db_init *bi_db_init;
1515 BI_db_config *bi_db_config;
1516 BI_db_open *bi_db_open;
1517 BI_db_close *bi_db_close;
1518 BI_db_destroy *bi_db_destroy;
1520 /* LDAP Operations Handling Routines */
1521 BI_op_bind *bi_op_bind;
1522 BI_op_unbind *bi_op_unbind;
1523 BI_op_search *bi_op_search;
1524 BI_op_compare *bi_op_compare;
1525 BI_op_modify *bi_op_modify;
1526 BI_op_modrdn *bi_op_modrdn;
1527 BI_op_add *bi_op_add;
1528 BI_op_delete *bi_op_delete;
1529 BI_op_abandon *bi_op_abandon;
1531 /* Extended Operations Helper */
1532 BI_op_extended *bi_extended;
1534 /* Auxilary Functions */
1535 BI_entry_release_rw *bi_entry_release_rw;
1536 BI_chk_referrals *bi_chk_referrals;
1538 BI_acl_group *bi_acl_group;
1539 BI_acl_attribute *bi_acl_attribute;
1541 BI_operational *bi_operational;
1542 BI_has_subordinates *bi_has_subordinates;
1544 BI_connection_init *bi_connection_init;
1545 BI_connection_destroy *bi_connection_destroy;
1547 /* hooks for slap tools */
1548 BI_tool_entry_open *bi_tool_entry_open;
1549 BI_tool_entry_close *bi_tool_entry_close;
1550 BI_tool_entry_first *bi_tool_entry_first;
1551 BI_tool_entry_next *bi_tool_entry_next;
1552 BI_tool_entry_get *bi_tool_entry_get;
1553 BI_tool_entry_put *bi_tool_entry_put;
1554 BI_tool_entry_reindex *bi_tool_entry_reindex;
1555 BI_tool_sync *bi_tool_sync;
1557 #define SLAP_INDEX_ADD_OP 0x0001
1558 #define SLAP_INDEX_DELETE_OP 0x0002
1560 char **bi_controls; /* supported controls */
1562 unsigned int bi_nDB; /* number of databases of this type */
1563 void *bi_private; /* anything the backend type needs */
1566 #define c_authtype c_authz.sai_method
1567 #define c_authmech c_authz.sai_mech
1568 #define c_dn c_authz.sai_dn
1569 #define c_ndn c_authz.sai_ndn
1570 #define c_ssf c_authz.sai_ssf
1571 #define c_transport_ssf c_authz.sai_transport_ssf
1572 #define c_tls_ssf c_authz.sai_tls_ssf
1573 #define c_sasl_ssf c_authz.sai_sasl_ssf
1575 #define o_authtype o_authz.sai_method
1576 #define o_authmech o_authz.sai_mech
1577 #define o_dn o_authz.sai_dn
1578 #define o_ndn o_authz.sai_ndn
1579 #define o_ssf o_authz.sai_ssf
1580 #define o_transport_ssf o_authz.sai_transport_ssf
1581 #define o_tls_ssf o_authz.sai_tls_ssf
1582 #define o_sasl_ssf o_authz.sai_sasl_ssf
1584 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1585 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1586 BerVarray, const char *, struct berval *,
1587 struct berval *, LDAPControl ** );
1589 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1590 ber_int_t, const char *, const char *, BerVarray,
1591 LDAPControl **, int nentries);
1593 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1594 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1596 typedef int (slap_sendreference)( BackendDB *, struct slap_conn *,
1597 struct slap_op *, Entry *, BerVarray, LDAPControl **, BerVarray * );
1599 typedef struct slap_callback {
1600 slap_response *sc_response;
1601 slap_sresult *sc_sresult;
1602 slap_sendentry *sc_sendentry;
1603 slap_sendreference *sc_sendreference;
1608 * Paged Results state
1610 typedef unsigned long PagedResultsCookie;
1611 typedef struct slap_paged_state {
1613 PagedResultsCookie ps_cookie;
1615 } PagedResultsState;
1618 #ifdef LDAP_CLIENT_UPDATE
1619 #define LCUP_PSEARCH_BY_ADD 0x01
1620 #define LCUP_PSEARCH_BY_DELETE 0x02
1621 #define LCUP_PSEARCH_BY_PREMODIFY 0x03
1622 #define LCUP_PSEARCH_BY_MODIFY 0x04
1623 #define LCUP_PSEARCH_BY_SCOPEOUT 0x05
1625 struct lcup_search_spec {
1627 struct berval *base;
1628 struct berval *nbase;
1634 struct berval *filterstr;
1635 AttributeName *attrs;
1637 struct lcup_entry *elist;
1638 ldap_pvt_thread_mutex_t elist_mutex;
1640 LDAP_LIST_ENTRY(lcup_search_spec) link;
1644 struct lcup_search_spec* ps;
1645 LDAP_LIST_ENTRY(psid_entry) link;
1647 #endif /* LDAP_CLIENT_UPDATE */
1651 * represents an operation pending from an ldap client
1653 typedef struct slap_op {
1654 unsigned long o_opid; /* id of this operation */
1655 unsigned long o_connid; /* id of conn initiating this op */
1656 struct slap_conn *o_conn; /* connection spawning this op */
1658 ber_int_t o_msgid; /* msgid of the request */
1659 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1660 ber_tag_t o_tag; /* tag of the request */
1661 time_t o_time; /* time op was initiated */
1663 char * o_extendedop; /* extended operation OID */
1665 ldap_pvt_thread_t o_tid; /* thread handling this op */
1667 volatile sig_atomic_t o_abandon; /* abandon flag */
1668 volatile sig_atomic_t o_cancel; /* cancel flag */
1670 char o_do_not_cache; /* don't cache from this op */
1672 #define SLAP_NO_CONTROL 0
1673 #define SLAP_NONCRITICAL_CONTROL 1
1674 #define SLAP_CRITICAL_CONTROL 2
1679 char o_subentries_visibility;
1680 char o_valuesreturnfilter;
1682 char o_permitmodify;
1684 char o_pagedresults;
1685 ber_int_t o_pagedresults_size;
1686 PagedResultsState o_pagedresults_state;
1688 #ifdef LDAP_CLIENT_UPDATE
1689 char o_clientupdate;
1690 char o_clientupdate_type;
1691 #define SLAP_LCUP_NONE (0x0)
1692 #define SLAP_LCUP_SYNC (0x1)
1693 #define SLAP_LCUP_PERSIST (0x2)
1694 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1695 ber_int_t o_clientupdate_interval;
1696 struct berval o_clientupdate_state;
1697 LDAP_LIST_HEAD(lss, lcup_search_spec) psearch_spec;
1698 LDAP_LIST_HEAD(pe, psid_entry) premodify_list;
1699 LDAP_LIST_ENTRY(slap_op) link;
1700 #endif /* LDAP_CLIENT_UPDATE */
1702 #ifdef LDAP_CONNECTIONLESS
1703 Sockaddr o_peeraddr; /* UDP peer address */
1705 AuthorizationInformation o_authz;
1707 BerElement *o_ber; /* ber of the request */
1708 #ifdef LDAP_CONNECTIONLESS
1709 BerElement *o_res_ber; /* ber of the reply */
1711 slap_callback *o_callback; /* callback pointers */
1712 LDAPControl **o_ctrls; /* controls */
1714 void *o_threadctx; /* thread pool thread context */
1715 void *o_private; /* anything the backend needs */
1717 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1718 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1720 void *o_pb; /* Netscape plugin */
1724 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1725 #define get_subentries(op) ((int)(op)->o_subentries)
1726 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1727 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
1731 typedef void (*SEND_LDAP_RESULT)(
1732 struct slap_conn *conn,
1735 const char *matched,
1741 #define send_ldap_result( conn, op, err, matched, text, ref, ctrls ) \
1742 (*conn->c_send_ldap_result)( conn, op, err, matched, text, ref, ctrls )
1745 typedef int (*SEND_SEARCH_ENTRY)(
1746 struct slap_backend_db *be,
1747 struct slap_conn *conn,
1749 struct slap_entry *e,
1750 AttributeName *attrs,
1755 #define send_search_entry( be, conn, op, e, attrs, attrsonly, ctrls) \
1756 (*conn->c_send_search_entry)( be, conn, op, e, attrs, attrsonly, ctrls)
1759 typedef void (*SEND_SEARCH_RESULT)(
1760 struct slap_conn *conn,
1763 const char *matched,
1766 LDAPControl **ctrls,
1770 #define send_search_result( conn, op, err, matched, text, refs, ctrls, nentries ) \
1771 (*conn->c_send_search_result)( conn, op, err, matched, text, refs, ctrls, nentries )
1774 typedef int (*SEND_SEARCH_REFERENCE)(
1775 struct slap_backend_db *be,
1776 struct slap_conn *conn,
1778 struct slap_entry *e,
1780 LDAPControl **ctrls,
1784 #define send_search_reference( be, conn, op, e, refs, ctrls, v2refs ) \
1785 (*conn->c_send_search_reference)( be, conn, op, e, refs, ctrls, v2refs )
1788 typedef void (*SEND_LDAP_EXTENDED)(
1789 struct slap_conn *conn,
1792 const char *matched,
1796 struct berval *rspdata,
1800 #define send_ldap_extended( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls) \
1801 (*conn->c_send_ldap_extended)( conn, op, err, matched, text, refs, rspoid, rspdata, ctrls )
1805 * Caches the result of a backend_group check for ACL evaluation
1807 typedef struct slap_gacl {
1808 struct slap_gacl *ga_next;
1811 AttributeDescription *ga_at;
1817 typedef struct slap_listener Listener;
1820 * represents a connection from an ldap client
1822 typedef struct slap_conn {
1823 int c_struct_state; /* structure management state */
1824 int c_conn_state; /* connection state */
1826 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1827 Sockbuf *c_sb; /* ber connection stuff */
1829 /* only can be changed by connect_init */
1830 time_t c_starttime; /* when the connection was opened */
1831 time_t c_activitytime; /* when the connection was last used */
1832 unsigned long c_connid; /* id of this connection for stats*/
1834 struct berval c_peer_domain; /* DNS name of client */
1835 struct berval c_peer_name; /* peer name (trans=addr:port) */
1836 Listener *c_listener;
1837 #define c_listener_url c_listener->sl_url /* listener URL */
1838 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
1840 /* only can be changed by binding thread */
1841 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1842 struct berval c_sasl_bind_mech; /* mech in progress */
1843 struct berval c_sasl_dn; /* temporary storage */
1845 /* authorization backend */
1846 Backend *c_authz_backend;
1848 AuthorizationInformation c_authz;
1849 GroupAssertion *c_groups;
1851 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1853 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1854 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1856 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1857 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1859 BerElement *c_currentber; /* ber we're attempting to read */
1860 int c_writewaiter; /* true if writer is waiting */
1862 #ifdef LDAP_CONNECTIONLESS
1863 int c_is_udp; /* true if this is (C)LDAP over UDP */
1866 int c_is_tls; /* true if this LDAP over raw TLS */
1867 int c_needs_tls_accept; /* true if SSL_accept should be called */
1869 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1870 void *c_sasl_context; /* SASL session context */
1871 void *c_sasl_extra; /* SASL session extra stuff */
1872 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1874 PagedResultsState c_pagedresults_state; /* paged result state */
1876 long c_n_ops_received; /* num of ops received (next op_id) */
1877 long c_n_ops_executing; /* num of ops currently executing */
1878 long c_n_ops_pending; /* num of ops pending execution */
1879 long c_n_ops_completed; /* num of ops completed */
1881 long c_n_get; /* num of get calls */
1882 long c_n_read; /* num of read calls */
1883 long c_n_write; /* num of write calls */
1885 void *c_pb; /* Netscape plugin */
1888 * These are the "callbacks" that are available for back-ends to
1889 * supply data back to connected clients that are connected
1890 * through the "front-end".
1892 SEND_LDAP_RESULT c_send_ldap_result;
1893 SEND_SEARCH_ENTRY c_send_search_entry;
1894 SEND_SEARCH_RESULT c_send_search_result;
1895 SEND_SEARCH_REFERENCE c_send_search_reference;
1896 SEND_LDAP_EXTENDED c_send_ldap_extended;
1900 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1901 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1903 if ( ldap_debug & (level) ) \
1904 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1905 if ( ldap_syslog & (level) ) \
1906 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1909 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
1910 #elif defined(LDAP_DEBUG)
1911 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1913 if ( ldap_debug & (level) ) \
1914 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1916 #define StatslogTest( level ) (ldap_debug & (level))
1917 #elif defined(LDAP_SYSLOG)
1918 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1920 if ( ldap_syslog & (level) ) \
1921 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1924 #define StatslogTest( level ) (ldap_syslog & (level))
1926 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1927 #define StatslogTest( level ) (0)
1931 * listener; need to access it from monitor backend
1933 struct slap_listener {
1934 struct berval sl_url;
1935 struct berval sl_name;
1940 #ifdef LDAP_CONNECTIONLESS
1941 int sl_is_udp; /* UDP listener is also data port */
1945 #define sl_addr sl_sa.sa_in_addr
1948 #ifdef SLAPD_MONITOR
1965 #endif /* SLAPD_MONITOR */
1968 * Better know these all around slapd
1970 #define SLAP_LDAPDN_PRETTY 0x1
1971 #define SLAP_LDAPDN_MAXLEN 8192
1976 #ifdef LDAP_CLIENT_UPDATE
1977 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
1978 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
1979 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
1980 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
1981 #endif /* LDAP_CLIENT_UPDATE */
1985 #include "proto-slap.h"
1987 #endif /* _SLAP_H_ */