1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2002 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"
40 * SLAPD Memory allocation macros
42 * Unlike ch_*() routines, these routines do not assert() upon
43 * allocation error. They are intended to be used instead of
44 * ch_*() routines where the caller has implemented proper
45 * checking for and handling of allocation errors.
47 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
49 #define SLAP_MALLOC(s) ber_memalloc((s))
50 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
51 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
52 #define SLAP_FREE(p) ber_memfree((p))
53 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
54 #define SLAP_STRDUP(s) ber_strdup((s))
55 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
58 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
61 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
62 #define SLAPD_ANONYMOUS "cn=anonymous"
64 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
66 * This is a value used internally by the backends. It is needed to allow
67 * adding values that already exist without getting an error as required by
68 * modrdn when the new rdn was already an attribute value itself.
69 * JCG 05/1999 (gomez@engr.sgi.com)
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 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
146 /* change this to "OpenLDAPset" */
147 #define SLAPD_ACI_SET_ATTR "template"
149 #define SLAPD_TOP_OID "2.5.6.0"
151 LDAP_SLAPD_V (int) slap_debug;
153 typedef unsigned long slap_mask_t;
155 /* Security Strength Factor */
156 typedef unsigned slap_ssf_t;
158 typedef struct slap_ssf_set {
160 slap_ssf_t sss_transport;
163 slap_ssf_t sss_update_ssf;
164 slap_ssf_t sss_update_transport;
165 slap_ssf_t sss_update_tls;
166 slap_ssf_t sss_update_sasl;
167 slap_ssf_t sss_simple_bind;
173 #define SLAP_INDEX_TYPE 0x00FFUL
174 #define SLAP_INDEX_UNDEFINED 0x0001UL
175 #define SLAP_INDEX_PRESENT 0x0002UL
176 #define SLAP_INDEX_EQUALITY 0x0004UL
177 #define SLAP_INDEX_APPROX 0x0008UL
178 #define SLAP_INDEX_SUBSTR 0x0010UL
179 #define SLAP_INDEX_EXTENDED 0x0020UL
181 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
183 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
185 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
187 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
188 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
189 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
190 #define SLAP_INDEX_SUBSTR_DEFAULT \
191 ( SLAP_INDEX_SUBSTR \
192 | SLAP_INDEX_SUBSTR_INITIAL \
193 | SLAP_INDEX_SUBSTR_ANY \
194 | SLAP_INDEX_SUBSTR_FINAL )
196 #define SLAP_INDEX_SUBSTR_MINLEN 2
197 #define SLAP_INDEX_SUBSTR_MAXLEN 4
198 #define SLAP_INDEX_SUBSTR_STEP 2
200 #define SLAP_INDEX_FLAGS 0xF000UL
201 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
202 #define SLAP_INDEX_NOLANG 0x2000UL /* don't use index w/ lang */
205 * there is a single index for each attribute. these prefixes ensure
206 * that there is no collision among keys.
208 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
209 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
210 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
211 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
212 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
213 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
215 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
216 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
217 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
218 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
219 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
221 #ifdef LDAP_CLIENT_UPDATE
222 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
223 #endif /* LDAP_CLIENT_UPDATE */
226 * represents schema information for a database
228 #define SLAP_SCHERR_OUTOFMEM 1
229 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
230 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
231 #define SLAP_SCHERR_CLASS_BAD_SUP 4
232 #define SLAP_SCHERR_CLASS_DUP 5
233 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
234 #define SLAP_SCHERR_ATTR_BAD_MR 7
235 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
236 #define SLAP_SCHERR_ATTR_BAD_SUP 9
237 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
238 #define SLAP_SCHERR_ATTR_DUP 11
239 #define SLAP_SCHERR_MR_NOT_FOUND 12
240 #define SLAP_SCHERR_MR_INCOMPLETE 13
241 #define SLAP_SCHERR_MR_DUP 14
242 #define SLAP_SCHERR_SYN_NOT_FOUND 15
243 #define SLAP_SCHERR_SYN_DUP 16
244 #define SLAP_SCHERR_NO_NAME 17
245 #define SLAP_SCHERR_NOT_SUPPORTED 18
246 #define SLAP_SCHERR_BAD_DESCR 19
247 #define SLAP_SCHERR_OIDM 20
248 #define SLAP_SCHERR_CR_DUP 21
249 #define SLAP_SCHERR_CR_BAD_STRUCT 22
250 #define SLAP_SCHERR_CR_BAD_AUX 23
251 #define SLAP_SCHERR_CR_BAD_AT 24
252 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
254 typedef union slap_sockaddr {
255 struct sockaddr sa_addr;
256 struct sockaddr_in sa_in_addr;
258 struct sockaddr_storage sa_storage;
259 struct sockaddr_in6 sa_in6_addr;
262 struct sockaddr_un sa_un_addr;
267 extern int slap_inet4or6;
270 typedef struct slap_oid_macro {
271 struct berval som_oid;
273 struct slap_oid_macro *som_next;
276 /* forward declarations */
278 struct slap_matching_rule;
280 typedef int slap_syntax_validate_func LDAP_P((
281 struct slap_syntax *syntax,
282 struct berval * in));
284 typedef int slap_syntax_transform_func LDAP_P((
285 struct slap_syntax *syntax,
287 struct berval * out));
289 typedef struct slap_syntax {
291 #define ssyn_oid ssyn_syn.syn_oid
292 #define ssyn_desc ssyn_syn.syn_desc
293 #define ssyn_extensions ssyn_syn.syn_extensions
296 ber_len_t ssyn_oidlen;
297 * has been replaced by a struct berval that uses the value
298 * provided by ssyn_syn.syn_oid; a macro that expands to
299 * the bv_len field of the berval is provided for backward
300 * compatibility. CAUTION: NEVER FREE THE BERVAL
302 struct berval ssyn_bvoid;
303 #define ssyn_oidlen ssyn_bvoid.bv_len
305 unsigned int ssyn_flags;
307 #define SLAP_SYNTAX_NONE 0x0000U
308 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
309 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
310 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
311 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
313 slap_syntax_validate_func *ssyn_validate;
314 slap_syntax_transform_func *ssyn_normalize;
315 slap_syntax_transform_func *ssyn_pretty;
317 #ifdef SLAPD_BINARY_CONVERSION
318 /* convert to and from binary */
319 slap_syntax_transform_func *ssyn_ber2str;
320 slap_syntax_transform_func *ssyn_str2ber;
323 struct slap_syntax *ssyn_next;
326 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
327 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
328 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
329 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
330 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
332 typedef struct slap_syntax_defs_rec {
335 slap_syntax_validate_func *sd_validate;
336 slap_syntax_transform_func *sd_normalize;
337 slap_syntax_transform_func *sd_pretty;
338 #ifdef SLAPD_BINARY_CONVERSION
339 slap_syntax_transform_func *sd_ber2str;
340 slap_syntax_transform_func *sd_str2ber;
342 } slap_syntax_defs_rec;
344 /* X -> Y Converter */
345 typedef int slap_mr_convert_func LDAP_P((
347 struct berval * out ));
350 typedef int slap_mr_normalize_func LDAP_P((
352 struct slap_syntax *syntax, /* NULL if in is asserted value */
353 struct slap_matching_rule *mr,
355 struct berval * out ));
357 /* Match (compare) function */
358 typedef int slap_mr_match_func LDAP_P((
361 struct slap_syntax *syntax, /* syntax of stored value */
362 struct slap_matching_rule *mr,
363 struct berval * value,
364 void * assertValue ));
366 /* Index generation function */
367 typedef int slap_mr_indexer_func LDAP_P((
370 struct slap_syntax *syntax, /* syntax of stored value */
371 struct slap_matching_rule *mr,
372 struct berval *prefix,
376 /* Filter index function */
377 typedef int slap_mr_filter_func LDAP_P((
380 struct slap_syntax *syntax, /* syntax of stored value */
381 struct slap_matching_rule *mr,
382 struct berval *prefix,
386 typedef struct slap_matching_rule_use MatchingRuleUse;
388 typedef struct slap_matching_rule {
389 LDAPMatchingRule smr_mrule;
390 MatchingRuleUse *smr_mru;
391 /* RFC2252 string representation */
392 struct berval smr_str;
395 ber_len_t smr_oidlen;
396 * has been replaced by a struct berval that uses the value
397 * provided by smr_mrule.mr_oid; a macro that expands to
398 * the bv_len field of the berval is provided for backward
399 * compatibility. CAUTION: NEVER FREE THE BERVAL
401 struct berval smr_bvoid;
402 #define smr_oidlen smr_bvoid.bv_len
404 slap_mask_t smr_usage;
406 #define SLAP_MR_HIDE 0x8000U
408 #define SLAP_MR_TYPE_MASK 0x0F00U
409 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
410 #define SLAP_MR_USAGE 0x000FU
412 #define SLAP_MR_NONE 0x0000U
413 #define SLAP_MR_EQUALITY 0x0100U
414 #define SLAP_MR_ORDERING 0x0200U
415 #define SLAP_MR_SUBSTR 0x0400U
416 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
418 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
419 #define SLAP_MR_DN_FOLD 0x0008U
421 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
422 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
423 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
426 * normally the provided value is expected to conform to
427 * assertion syntax specified in the matching rule, however
428 * at times (such as during individual value modification),
429 * the provided value is expected to conform to the
430 * attribute's value syntax.
432 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
433 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
434 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
436 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
437 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
438 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
439 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
441 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
442 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
443 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
444 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
445 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
446 == SLAP_MR_VALUE_SYNTAX_MATCH)
449 slap_mr_convert_func *smr_convert;
450 slap_mr_normalize_func *smr_normalize;
451 slap_mr_match_func *smr_match;
452 slap_mr_indexer_func *smr_indexer;
453 slap_mr_filter_func *smr_filter;
456 * null terminated list of syntaxes compatible with this syntax
457 * note: when MS_EXT is set, this MUST NOT contain the assertion
458 * syntax of the rule. When MS_EXT is not set, it MAY.
460 Syntax **smr_compat_syntaxes;
462 struct slap_matching_rule *smr_associated;
463 struct slap_matching_rule *smr_next;
465 #define smr_oid smr_mrule.mr_oid
466 #define smr_names smr_mrule.mr_names
467 #define smr_desc smr_mrule.mr_desc
468 #define smr_obsolete smr_mrule.mr_obsolete
469 #define smr_syntax_oid smr_mrule.mr_syntax_oid
470 #define smr_extensions smr_mrule.mr_extensions
473 struct slap_matching_rule_use {
474 LDAPMatchingRuleUse smru_mruleuse;
475 MatchingRule *smru_mr;
476 /* RFC2252 string representation */
477 struct berval smru_str;
479 struct slap_matching_rule_use *smru_next;
481 #define smru_oid smru_mruleuse.mru_oid
482 #define smru_names smru_mruleuse.mru_names
483 #define smru_desc smru_mruleuse.mru_desc
484 #define smru_obsolete smru_mruleuse.mru_obsolete
485 #define smru_applies_oids smru_mruleuse.mru_applies_oids
487 #define smru_usage smru_mr->smr_usage
488 } /* MatchingRuleUse */ ;
490 typedef struct slap_mrule_defs_rec {
492 slap_mask_t mrd_usage;
493 char ** mrd_compat_syntaxes;
494 slap_mr_convert_func * mrd_convert;
495 slap_mr_normalize_func * mrd_normalize;
496 slap_mr_match_func * mrd_match;
497 slap_mr_indexer_func * mrd_indexer;
498 slap_mr_filter_func * mrd_filter;
500 char * mrd_associated;
501 } slap_mrule_defs_rec;
503 struct slap_backend_db;
507 typedef int (AttributeTypeSchemaCheckFN)(
508 struct slap_backend_db *be,
509 struct slap_entry *e,
510 struct slap_attr *attr,
512 char *textbuf, size_t textlen );
514 typedef struct slap_attribute_type {
515 LDAPAttributeType sat_atype;
516 struct berval sat_cname;
517 struct slap_attribute_type *sat_sup;
518 struct slap_attribute_type **sat_subtypes;
519 MatchingRule *sat_equality;
520 MatchingRule *sat_approx;
521 MatchingRule *sat_ordering;
522 MatchingRule *sat_substr;
525 AttributeTypeSchemaCheckFN *sat_check;
527 #define SLAP_AT_NONE 0x0000U
528 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
529 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
530 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
531 slap_mask_t sat_flags;
533 struct slap_attribute_type *sat_next;
535 #define sat_oid sat_atype.at_oid
536 #define sat_names sat_atype.at_names
537 #define sat_desc sat_atype.at_desc
538 #define sat_obsolete sat_atype.at_obsolete
539 #define sat_sup_oid sat_atype.at_sup_oid
540 #define sat_equality_oid sat_atype.at_equality_oid
541 #define sat_ordering_oid sat_atype.at_ordering_oid
542 #define sat_substr_oid sat_atype.at_substr_oid
543 #define sat_syntax_oid sat_atype.at_syntax_oid
544 #define sat_single_value sat_atype.at_single_value
545 #define sat_collective sat_atype.at_collective
546 #define sat_no_user_mod sat_atype.at_no_user_mod
547 #define sat_usage sat_atype.at_usage
548 #define sat_extensions sat_atype.at_extensions
550 struct slap_attr_desc *sat_ad;
551 ldap_pvt_thread_mutex_t sat_ad_mutex;
554 #define is_at_operational(at) ((at)->sat_usage)
555 #define is_at_single_value(at) ((at)->sat_single_value)
556 #define is_at_collective(at) ((at)->sat_collective)
557 #define is_at_obsolete(at) ((at)->sat_obsolete)
558 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
560 struct slap_object_class;
562 typedef int (ObjectClassSchemaCheckFN)(
563 struct slap_backend_db *be,
564 struct slap_entry *e,
565 struct slap_object_class *oc,
567 char *textbuf, size_t textlen );
569 typedef struct slap_object_class {
570 LDAPObjectClass soc_oclass;
571 struct berval soc_cname;
572 struct slap_object_class **soc_sups;
573 AttributeType **soc_required;
574 AttributeType **soc_allowed;
575 ObjectClassSchemaCheckFN *soc_check;
576 slap_mask_t soc_flags;
577 #define soc_oid soc_oclass.oc_oid
578 #define soc_names soc_oclass.oc_names
579 #define soc_desc soc_oclass.oc_desc
580 #define soc_obsolete soc_oclass.oc_obsolete
581 #define soc_sup_oids soc_oclass.oc_sup_oids
582 #define soc_kind soc_oclass.oc_kind
583 #define soc_at_oids_must soc_oclass.oc_at_oids_must
584 #define soc_at_oids_may soc_oclass.oc_at_oids_may
585 #define soc_extensions soc_oclass.oc_extensions
587 struct slap_object_class *soc_next;
590 #define SLAP_OC_ALIAS 0x0001
591 #define SLAP_OC_REFERRAL 0x0002
592 #define SLAP_OC_SUBENTRY 0x0004
593 #define SLAP_OC_DYNAMICOBJECT 0x0008
594 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
595 #define SLAP_OC__MASK 0x001F
596 #define SLAP_OC__END 0x0020
597 #define SLAP_OC_OPERATIONAL 0x4000
598 #define SLAP_OC_HIDE 0x8000
603 typedef struct slap_content_rule {
604 LDAPContentRule scr_crule;
605 ObjectClass *scr_sclass;
606 ObjectClass **scr_auxiliaries; /* optional */
607 AttributeType **scr_required; /* optional */
608 AttributeType **scr_allowed; /* optional */
609 AttributeType **scr_precluded; /* optional */
610 #define scr_oid scr_crule.cr_oid
611 #define scr_names scr_crule.cr_names
612 #define scr_desc scr_crule.cr_desc
613 #define scr_obsolete scr_crule.cr_obsolete
614 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
615 #define scr_at_oids_must scr_crule.cr_at_oids_must
616 #define scr_at_oids_may scr_crule.cr_at_oids_may
617 #define scr_at_oids_not scr_crule.cr_at_oids_not
619 struct slap_content_rule *scr_next;
623 * represents a recognized attribute description ( type + options )
625 typedef struct slap_attr_desc {
626 struct slap_attr_desc *ad_next;
627 AttributeType *ad_type; /* attribute type, must be specified */
628 struct berval ad_cname; /* canonical name, must be specified */
629 struct berval ad_lang; /* empty if no language tags */
631 #define SLAP_DESC_NONE 0x00U
632 #define SLAP_DESC_BINARY 0x01U
633 #define SLAP_DESC_LANG_RANGE 0x80U
634 } AttributeDescription;
636 typedef struct slap_attr_name {
637 struct berval an_name;
638 AttributeDescription *an_desc;
642 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
643 #define slap_ad_is_lang_range(ad) \
644 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
645 #define slap_ad_is_binary(ad) \
646 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
649 * pointers to schema elements used internally
651 struct slap_internal_schema {
653 ObjectClass *si_oc_top;
654 ObjectClass *si_oc_extensibleObject;
655 ObjectClass *si_oc_alias;
656 ObjectClass *si_oc_referral;
657 ObjectClass *si_oc_rootdse;
658 ObjectClass *si_oc_subentry;
659 ObjectClass *si_oc_subschema;
660 ObjectClass *si_oc_monitor;
661 ObjectClass *si_oc_collectiveAttributeSubentry;
662 ObjectClass *si_oc_dynamicObject;
664 /* objectClass attribute descriptions */
665 AttributeDescription *si_ad_objectClass;
667 /* operational attribute descriptions */
668 AttributeDescription *si_ad_structuralObjectClass;
669 AttributeDescription *si_ad_creatorsName;
670 AttributeDescription *si_ad_createTimestamp;
671 AttributeDescription *si_ad_modifiersName;
672 AttributeDescription *si_ad_modifyTimestamp;
673 AttributeDescription *si_ad_hasSubordinates;
674 AttributeDescription *si_ad_subschemaSubentry;
675 AttributeDescription *si_ad_collectiveSubentries;
676 AttributeDescription *si_ad_collectiveExclusions;
677 AttributeDescription *si_ad_entryUUID;
678 AttributeDescription *si_ad_entryCSN;
680 /* root DSE attribute descriptions */
681 AttributeDescription *si_ad_altServer;
682 AttributeDescription *si_ad_namingContexts;
683 AttributeDescription *si_ad_supportedControl;
684 AttributeDescription *si_ad_supportedExtension;
685 AttributeDescription *si_ad_supportedLDAPVersion;
686 AttributeDescription *si_ad_supportedSASLMechanisms;
687 AttributeDescription *si_ad_supportedFeatures;
688 AttributeDescription *si_ad_monitorContext;
689 AttributeDescription *si_ad_vendorName;
690 AttributeDescription *si_ad_vendorVersion;
692 /* subentry attribute descriptions */
693 AttributeDescription *si_ad_administrativeRole;
694 AttributeDescription *si_ad_subtreeSpecification;
696 /* subschema subentry attribute descriptions */
697 AttributeDescription *si_ad_ditStructureRules;
698 AttributeDescription *si_ad_ditContentRules;
699 AttributeDescription *si_ad_nameForms;
700 AttributeDescription *si_ad_objectClasses;
701 AttributeDescription *si_ad_attributeTypes;
702 AttributeDescription *si_ad_ldapSyntaxes;
703 AttributeDescription *si_ad_matchingRules;
704 AttributeDescription *si_ad_matchingRuleUse;
706 /* Aliases & Referrals */
707 AttributeDescription *si_ad_aliasedObjectName;
708 AttributeDescription *si_ad_ref;
710 /* Access Control Internals */
711 AttributeDescription *si_ad_entry;
712 AttributeDescription *si_ad_children;
713 AttributeDescription *si_ad_saslAuthzTo;
714 AttributeDescription *si_ad_saslAuthzFrom;
715 #ifdef SLAPD_ACI_ENABLED
716 AttributeDescription *si_ad_aci;
719 /* dynamic entries */
720 AttributeDescription *si_ad_entryTtl;
721 AttributeDescription *si_ad_dynamicSubtrees;
723 /* Other attributes descriptions */
724 AttributeDescription *si_ad_distinguishedName;
725 AttributeDescription *si_ad_name;
726 AttributeDescription *si_ad_cn;
727 AttributeDescription *si_ad_userPassword;
728 #ifdef SLAPD_AUTHPASSWD
729 AttributeDescription *si_ad_authPassword;
731 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
732 AttributeDescription *si_ad_krbName;
735 /* Undefined Attribute Type */
736 AttributeType *si_at_undefined;
739 MatchingRule *si_mr_distinguishedNameMatch;
740 MatchingRule *si_mr_integerMatch;
743 Syntax *si_syn_octetString;
744 Syntax *si_syn_distinguishedName;
745 Syntax *si_syn_integer;
748 typedef struct slap_attr_assertion {
749 AttributeDescription *aa_desc;
750 struct berval aa_value;
751 } AttributeAssertion;
753 typedef struct slap_ss_assertion {
754 AttributeDescription *sa_desc;
755 struct berval sa_initial;
756 struct berval *sa_any;
757 struct berval sa_final;
758 } SubstringsAssertion;
760 typedef struct slap_mr_assertion {
761 MatchingRule *ma_rule; /* optional */
762 struct berval ma_rule_text; /* optional */
763 AttributeDescription *ma_desc; /* optional */
764 int ma_dnattrs; /* boolean */
765 struct berval ma_value; /* required */
766 } MatchingRuleAssertion;
769 * represents a search filter
771 typedef struct slap_filter {
772 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
773 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
774 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
775 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
778 /* precomputed result */
779 ber_int_t f_un_result;
782 struct berval *f_un_dn;
785 AttributeDescription *f_un_desc;
787 /* simple value assertion */
788 AttributeAssertion *f_un_ava;
790 /* substring assertion */
791 SubstringsAssertion *f_un_ssa;
793 /* matching rule assertion */
794 MatchingRuleAssertion *f_un_mra;
796 #define f_dn f_un.f_un_dn
797 #define f_desc f_un.f_un_desc
798 #define f_ava f_un.f_un_ava
799 #define f_av_desc f_un.f_un_ava->aa_desc
800 #define f_av_value f_un.f_un_ava->aa_value
801 #define f_sub f_un.f_un_ssa
802 #define f_sub_desc f_un.f_un_ssa->sa_desc
803 #define f_sub_initial f_un.f_un_ssa->sa_initial
804 #define f_sub_any f_un.f_un_ssa->sa_any
805 #define f_sub_final f_un.f_un_ssa->sa_final
806 #define f_mra f_un.f_un_mra
807 #define f_mr_rule f_un.f_un_mra->ma_rule
808 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
809 #define f_mr_desc f_un.f_un_mra->ma_desc
810 #define f_mr_value f_un.f_un_mra->ma_value
811 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
814 struct slap_filter *f_un_complex;
817 #define f_result f_un.f_un_result
818 #define f_and f_un.f_un_complex
819 #define f_or f_un.f_un_complex
820 #define f_not f_un.f_un_complex
821 #define f_list f_un.f_un_complex
823 struct slap_filter *f_next;
826 /* compare routines can return undefined */
827 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
829 typedef struct slap_valuesreturnfilter {
833 /* precomputed result */
834 ber_int_t f_un_result;
840 AttributeDescription *f_un_desc;
842 /* simple value assertion */
843 AttributeAssertion *f_un_ava;
845 /* substring assertion */
846 SubstringsAssertion *f_un_ssa;
848 /* matching rule assertion */
849 MatchingRuleAssertion *f_un_mra;
852 struct slap_valuesreturnfilter *f_next;
853 } ValuesReturnFilter;
856 * represents an attribute (description + values)
858 typedef struct slap_attr {
859 AttributeDescription *a_desc;
861 struct slap_attr *a_next;
863 #define SLAP_ATTR_IXADD 0x1U
864 #define SLAP_ATTR_IXDEL 0x2U
869 * the id used in the indexes to refer to an entry
871 typedef unsigned long ID;
872 #define NOID ((ID)~0)
875 * represents an entry in core
877 typedef struct slap_entry {
879 * The ID field should only be changed before entry is
880 * inserted into a cache. The ID value is backend
885 struct berval e_name; /* name (DN) of this entry */
886 struct berval e_nname; /* normalized name (DN) of this entry */
888 /* for migration purposes */
889 #define e_dn e_name.bv_val
890 #define e_ndn e_nname.bv_val
892 Attribute *e_attrs; /* list of attributes + values */
894 slap_mask_t e_ocflags;
896 struct berval e_bv; /* For entry_encode/entry_decode */
898 /* for use by the backend for any purpose */
905 typedef struct slap_mod {
907 AttributeDescription *sm_desc;
908 struct berval sm_type;
909 BerVarray sm_bvalues;
912 typedef struct slap_mod_list {
913 Modification sml_mod;
914 #define sml_op sml_mod.sm_op
915 #define sml_desc sml_mod.sm_desc
916 #define sml_type sml_mod.sm_type
917 #define sml_bvalues sml_mod.sm_bvalues
918 struct slap_mod_list *sml_next;
921 typedef struct slap_ldap_modlist {
923 struct slap_ldap_modlist *ml_next;
924 #define ml_op ml_mod.mod_op
925 #define ml_type ml_mod.mod_type
926 #define ml_values ml_mod.mod_values
927 #define ml_bvalues ml_mod.mod_bvalues
931 * represents an access control list
933 typedef enum slap_access_e {
934 ACL_INVALID_ACCESS = -1,
943 typedef enum slap_control_e {
944 ACL_INVALID_CONTROL = 0,
950 typedef enum slap_style_e {
958 /* alternate names */
959 ACL_STYLE_EXACT = ACL_STYLE_BASE
962 typedef struct slap_authz_info {
963 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
964 struct berval sai_mech; /* SASL Mechanism */
965 struct berval sai_dn; /* DN for reporting purposes */
966 struct berval sai_ndn; /* Normalized DN */
968 /* Security Strength Factors */
969 slap_ssf_t sai_ssf; /* Overall SSF */
970 slap_ssf_t sai_transport_ssf; /* Transport SSF */
971 slap_ssf_t sai_tls_ssf; /* TLS SSF */
972 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
973 } AuthorizationInformation;
976 typedef struct slap_access {
977 slap_control_t a_type;
979 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
981 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
982 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
983 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
984 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
985 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
986 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
988 #define ACL_PRIV_MASK 0x00ffUL
991 #define ACL_PRIV_LEVEL 0x1000UL
992 #define ACL_PRIV_ADDITIVE 0x2000UL
993 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
996 #define ACL_PRIV_INVALID 0x0UL
998 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
999 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1000 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1001 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1003 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1004 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1006 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1008 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1010 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1011 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1012 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1014 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1015 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1016 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1017 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1018 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1019 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1021 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1022 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1023 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1024 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1025 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1026 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1027 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1029 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1030 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1031 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1032 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1033 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1034 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1036 slap_mask_t a_access_mask;
1038 AuthorizationInformation a_authz;
1039 #define a_dn_pat a_authz.sai_dn
1041 slap_style_t a_dn_style;
1042 AttributeDescription *a_dn_at;
1046 slap_style_t a_peername_style;
1047 struct berval a_peername_pat;
1048 slap_style_t a_sockname_style;
1049 struct berval a_sockname_pat;
1051 slap_style_t a_domain_style;
1052 struct berval a_domain_pat;
1053 int a_domain_expand;
1055 slap_style_t a_sockurl_style;
1056 struct berval a_sockurl_pat;
1057 slap_style_t a_set_style;
1058 struct berval a_set_pat;
1060 #ifdef SLAPD_ACI_ENABLED
1061 AttributeDescription *a_aci_at;
1065 slap_style_t a_group_style;
1066 struct berval a_group_pat;
1067 ObjectClass *a_group_oc;
1068 AttributeDescription *a_group_at;
1070 struct slap_access *a_next;
1074 typedef struct slap_acl {
1075 /* "to" part: the entries this acl applies to */
1077 slap_style_t acl_dn_style;
1079 struct berval acl_dn_pat;
1080 AttributeName *acl_attrs;
1082 /* "by" part: list of who has what access to the entries */
1085 struct slap_acl *acl_next;
1088 typedef struct slap_acl_state {
1089 unsigned as_recorded;
1090 #define ACL_STATE_NOT_RECORDED 0x0
1091 #define ACL_STATE_RECORDED_VD 0x1
1092 #define ACL_STATE_RECORDED_NV 0x2
1093 #define ACL_STATE_RECORDED 0x3
1096 AccessControl *as_vd_acl;
1097 slap_mask_t as_vd_acl_mask;
1098 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1099 int as_vd_acl_count;
1101 Access *as_vd_access;
1102 int as_vd_access_count;
1105 } AccessControlState;
1106 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1109 * replog moddn param structure
1111 struct slap_replog_moddn {
1112 struct berval *newrdn;
1114 struct berval *newsup;
1119 * represents a backend
1122 typedef struct slap_backend_info BackendInfo; /* per backend type */
1123 typedef struct slap_backend_db BackendDB; /* per backend database */
1125 LDAP_SLAPD_V (int) nBackendInfo;
1126 LDAP_SLAPD_V (int) nBackendDB;
1127 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1128 LDAP_SLAPD_V (BackendDB *) backendDB;
1130 LDAP_SLAPD_V (int) slapMode;
1131 #define SLAP_UNDEFINED_MODE 0x0000
1132 #define SLAP_SERVER_MODE 0x0001
1133 #define SLAP_TOOL_MODE 0x0002
1134 #define SLAP_MODE 0x0003
1136 #define SLAP_TRUNCATE_MODE 0x0100
1138 struct slap_replica_info {
1139 char *ri_host; /* supersedes be_replica */
1140 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1141 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1142 int ri_exclude; /* 1 => exclude ri_attrs */
1145 struct slap_limits_set {
1153 int lms_s_unchecked;
1156 struct slap_limits {
1157 int lm_type; /* type of pattern */
1158 #define SLAP_LIMITS_UNDEFINED 0x0000
1159 #define SLAP_LIMITS_EXACT 0x0001
1160 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1161 #define SLAP_LIMITS_ONE 0x0002
1162 #define SLAP_LIMITS_SUBTREE 0x0003
1163 #define SLAP_LIMITS_CHILDREN 0x0004
1164 #define SLAP_LIMITS_REGEX 0x0005
1165 #define SLAP_LIMITS_ANONYMOUS 0x0006
1166 #define SLAP_LIMITS_USERS 0x0007
1167 #define SLAP_LIMITS_ANY 0x0008
1168 regex_t lm_dn_regex; /* regex data for REGEX */
1171 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1172 * pattern for REGEX; NULL for ANONYMOUS, USERS
1174 struct berval lm_dn_pat;
1176 struct slap_limits_set lm_limits;
1179 /* temporary aliases */
1180 typedef BackendDB Backend;
1181 #define nbackends nBackendDB
1182 #define backends backendDB
1184 struct slap_backend_db {
1185 BackendInfo *bd_info; /* pointer to shared backend info */
1187 /* BackendInfo accessors */
1188 #define be_config bd_info->bi_db_config
1189 #define be_type bd_info->bi_type
1191 #define be_bind bd_info->bi_op_bind
1192 #define be_unbind bd_info->bi_op_unbind
1193 #define be_add bd_info->bi_op_add
1194 #define be_compare bd_info->bi_op_compare
1195 #define be_delete bd_info->bi_op_delete
1196 #define be_modify bd_info->bi_op_modify
1197 #define be_modrdn bd_info->bi_op_modrdn
1198 #define be_search bd_info->bi_op_search
1200 #define be_extended bd_info->bi_extended
1202 #define be_release bd_info->bi_entry_release_rw
1203 #define be_chk_referrals bd_info->bi_chk_referrals
1204 #define be_group bd_info->bi_acl_group
1205 #define be_attribute bd_info->bi_acl_attribute
1206 #define be_operational bd_info->bi_operational
1208 #define be_controls bd_info->bi_controls
1210 #define be_connection_init bd_info->bi_connection_init
1211 #define be_connection_destroy bd_info->bi_connection_destroy
1214 #define be_entry_open bd_info->bi_tool_entry_open
1215 #define be_entry_close bd_info->bi_tool_entry_close
1216 #define be_entry_first bd_info->bi_tool_entry_first
1217 #define be_entry_next bd_info->bi_tool_entry_next
1218 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1219 #define be_entry_get bd_info->bi_tool_entry_get
1220 #define be_entry_put bd_info->bi_tool_entry_put
1221 #define be_sync bd_info->bi_tool_sync
1224 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1225 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1226 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1227 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1228 #define SLAP_BFLAG_ALIASES 0x0100U
1229 #define SLAP_BFLAG_REFERRALS 0x0200U
1230 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1231 #define SLAP_BFLAG_MONITOR 0x1000U
1232 #define SLAP_BFLAG_DYNAMIC 0x2000U
1233 slap_mask_t be_flags;
1234 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1235 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1236 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1237 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1238 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1239 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1241 slap_mask_t be_restrictops; /* restriction operations */
1242 #define SLAP_RESTRICT_OP_ADD 0x0001U
1243 #define SLAP_RESTRICT_OP_BIND 0x0002U
1244 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1245 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1246 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1247 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1248 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1249 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1251 #define SLAP_RESTRICT_OP_READS \
1252 ( SLAP_RESTRICT_OP_COMPARE \
1253 | SLAP_RESTRICT_OP_SEARCH )
1254 #define SLAP_RESTRICT_OP_WRITES \
1255 ( SLAP_RESTRICT_OP_ADD \
1256 | SLAP_RESTRICT_OP_DELETE \
1257 | SLAP_RESTRICT_OP_MODIFY \
1258 | SLAP_RESTRICT_OP_RENAME )
1260 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1261 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1262 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1264 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1265 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1266 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1267 0x0004U /* unprotected simple auth */
1268 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1270 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1271 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1273 slap_mask_t be_requires; /* pre-operation requirements */
1274 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1275 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1276 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1277 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1278 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1280 /* Required Security Strength Factor */
1281 slap_ssf_set_t be_ssf_set;
1283 /* these should be renamed from be_ to bd_ */
1284 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1285 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1286 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1287 struct berval be_schemadn; /* per-backend subschema subentry DN */
1288 struct berval be_schemandn; /* normalized subschema DN */
1289 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1290 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1291 struct berval be_rootpw; /* the magic "root" password for this db */
1292 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1293 #define be_sizelimit be_def_limit.lms_s_soft
1294 #define be_timelimit be_def_limit.lms_t_soft
1295 struct slap_limits_set be_def_limit; /* default limits */
1296 struct slap_limits **be_limits; /* regex-based size and time limits */
1297 AccessControl *be_acl; /* access control list for this backend */
1298 slap_access_t be_dfltaccess; /* access given if no acl matches */
1299 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1300 char *be_replogfile; /* replication log file (in master) */
1301 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1302 BerVarray be_update_refs; /* where to refer modifying clients to */
1304 void *be_private; /* anything the backend database needs */
1310 /* Backend function typedefs */
1311 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1312 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1313 const char *fname, int lineno,
1314 int argc, char **argv));
1315 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1316 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1317 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1319 typedef int (BI_db_init) LDAP_P((Backend *bd));
1320 typedef int (BI_db_config) LDAP_P((Backend *bd,
1321 const char *fname, int lineno,
1322 int argc, char **argv));
1323 typedef int (BI_db_open) LDAP_P((Backend *bd));
1324 typedef int (BI_db_close) LDAP_P((Backend *bd));
1325 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1327 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1328 struct slap_conn *c, struct slap_op *o,
1329 struct berval *dn, struct berval *ndn, int method,
1330 struct berval *cred, struct berval *edn ));
1331 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1332 struct slap_conn *c, struct slap_op *o ));
1333 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1334 struct slap_conn *c, struct slap_op *o,
1335 struct berval *base, struct berval *nbase,
1336 int scope, int deref,
1337 int slimit, int tlimit,
1338 Filter *f, struct berval *filterstr,
1339 AttributeName *attrs, int attrsonly));
1340 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1341 struct slap_conn *c, struct slap_op *o,
1342 struct berval *dn, struct berval *ndn,
1343 AttributeAssertion *ava));
1344 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1345 struct slap_conn *c, struct slap_op *o,
1346 struct berval *dn, struct berval *ndn,
1348 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1349 struct slap_conn *c, struct slap_op *o,
1350 struct berval *dn, struct berval *ndn,
1351 struct berval *newrdn, struct berval *nnewrdn,
1353 struct berval *newSup, struct berval *nnewSup ));
1354 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1355 struct slap_conn *c, struct slap_op *o,
1357 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1358 struct slap_conn *c, struct slap_op *o,
1359 struct berval *dn, struct berval *ndn));
1360 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1361 struct slap_conn *c, struct slap_op *o,
1364 typedef int (BI_op_extended) LDAP_P((
1366 struct slap_conn *conn,
1369 struct berval * reqdata,
1371 struct berval ** rspdata,
1372 LDAPControl *** rspctrls,
1376 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1377 struct slap_conn *c, struct slap_op *o,
1380 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1381 struct slap_conn *c, struct slap_op *o,
1382 struct berval *dn, struct berval *ndn,
1383 const char **text ));
1385 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1386 struct slap_conn *c, struct slap_op *o,
1390 ObjectClass *group_oc,
1391 AttributeDescription *group_at ));
1393 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1394 struct slap_conn *c, struct slap_op *o,
1395 Entry *e, struct berval *edn,
1396 AttributeDescription *entry_at,
1399 typedef int (BI_operational) LDAP_P((Backend *bd,
1400 struct slap_conn *c, struct slap_op *o,
1401 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1403 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1404 struct slap_conn *c));
1405 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1406 struct slap_conn *c));
1408 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1409 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1410 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1411 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1412 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1413 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1414 struct berval *text ));
1415 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1416 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1418 struct slap_backend_info {
1419 char *bi_type; /* type of backend */
1422 * per backend type routines:
1423 * bi_init: called to allocate a backend_info structure,
1424 * called once BEFORE configuration file is read.
1425 * bi_init() initializes this structure hence is
1426 * called directly from be_initialize()
1427 * bi_config: called per 'backend' specific option
1428 * all such options must before any 'database' options
1429 * bi_config() is called only from read_config()
1430 * bi_open: called to open each database, called
1431 * once AFTER configuration file is read but
1432 * BEFORE any bi_db_open() calls.
1433 * bi_open() is called from backend_startup()
1434 * bi_close: called to close each database, called
1435 * once during shutdown after all bi_db_close calls.
1436 * bi_close() is called from backend_shutdown()
1437 * bi_destroy: called to destroy each database, called
1438 * once during shutdown after all bi_db_destroy calls.
1439 * bi_destory() is called from backend_destroy()
1442 BI_config *bi_config;
1445 BI_destroy *bi_destroy;
1448 * per database routines:
1449 * bi_db_init: called to initialize each database,
1450 * called upon reading 'database <type>'
1451 * called only from backend_db_init()
1452 * bi_db_config: called to configure each database,
1453 * called per database to handle per database options
1454 * called only from read_config()
1455 * bi_db_open: called to open each database
1456 * called once per database immediately AFTER bi_open()
1457 * calls but before daemon startup.
1458 * called only by backend_startup()
1459 * bi_db_close: called to close each database
1460 * called once per database during shutdown but BEFORE
1461 * any bi_close call.
1462 * called only by backend_shutdown()
1463 * bi_db_destroy: called to destroy each database
1464 * called once per database during shutdown AFTER all
1465 * bi_close calls but before bi_destory calls.
1466 * called only by backend_destory()
1468 BI_db_init *bi_db_init;
1469 BI_db_config *bi_db_config;
1470 BI_db_open *bi_db_open;
1471 BI_db_close *bi_db_close;
1472 BI_db_destroy *bi_db_destroy;
1474 /* LDAP Operations Handling Routines */
1475 BI_op_bind *bi_op_bind;
1476 BI_op_unbind *bi_op_unbind;
1477 BI_op_search *bi_op_search;
1478 BI_op_compare *bi_op_compare;
1479 BI_op_modify *bi_op_modify;
1480 BI_op_modrdn *bi_op_modrdn;
1481 BI_op_add *bi_op_add;
1482 BI_op_delete *bi_op_delete;
1483 BI_op_abandon *bi_op_abandon;
1485 /* Extended Operations Helper */
1486 BI_op_extended *bi_extended;
1488 /* Auxilary Functions */
1489 BI_entry_release_rw *bi_entry_release_rw;
1490 BI_chk_referrals *bi_chk_referrals;
1492 BI_acl_group *bi_acl_group;
1493 BI_acl_attribute *bi_acl_attribute;
1495 BI_operational *bi_operational;
1497 BI_connection_init *bi_connection_init;
1498 BI_connection_destroy *bi_connection_destroy;
1500 /* hooks for slap tools */
1501 BI_tool_entry_open *bi_tool_entry_open;
1502 BI_tool_entry_close *bi_tool_entry_close;
1503 BI_tool_entry_first *bi_tool_entry_first;
1504 BI_tool_entry_next *bi_tool_entry_next;
1505 BI_tool_entry_get *bi_tool_entry_get;
1506 BI_tool_entry_put *bi_tool_entry_put;
1507 BI_tool_entry_reindex *bi_tool_entry_reindex;
1508 BI_tool_sync *bi_tool_sync;
1510 #define SLAP_INDEX_ADD_OP 0x0001
1511 #define SLAP_INDEX_DELETE_OP 0x0002
1513 char **bi_controls; /* supported controls */
1515 unsigned int bi_nDB; /* number of databases of this type */
1516 void *bi_private; /* anything the backend type needs */
1519 #define c_authtype c_authz.sai_method
1520 #define c_authmech c_authz.sai_mech
1521 #define c_dn c_authz.sai_dn
1522 #define c_ndn c_authz.sai_ndn
1523 #define c_ssf c_authz.sai_ssf
1524 #define c_transport_ssf c_authz.sai_transport_ssf
1525 #define c_tls_ssf c_authz.sai_tls_ssf
1526 #define c_sasl_ssf c_authz.sai_sasl_ssf
1528 #define o_authtype o_authz.sai_method
1529 #define o_authmech o_authz.sai_mech
1530 #define o_dn o_authz.sai_dn
1531 #define o_ndn o_authz.sai_ndn
1532 #define o_ssf o_authz.sai_ssf
1533 #define o_transport_ssf o_authz.sai_transport_ssf
1534 #define o_tls_ssf o_authz.sai_tls_ssf
1535 #define o_sasl_ssf o_authz.sai_sasl_ssf
1537 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1538 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1539 BerVarray, const char *, struct berval *,
1540 struct berval *, LDAPControl ** );
1542 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1543 ber_int_t, const char *, const char *, BerVarray,
1544 LDAPControl **, int nentries);
1546 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1547 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1549 typedef struct slap_callback {
1550 slap_response *sc_response;
1551 slap_sresult *sc_sresult;
1552 slap_sendentry *sc_sendentry;
1557 * Paged Results state
1559 typedef unsigned long PagedResultsCookie;
1560 typedef struct slap_paged_state {
1562 PagedResultsCookie ps_cookie;
1564 } PagedResultsState;
1567 * represents an operation pending from an ldap client
1569 typedef struct slap_op {
1570 unsigned long o_opid; /* id of this operation */
1571 unsigned long o_connid; /* id of conn initiating this op */
1572 struct slap_conn *o_conn; /* connection spawning this op */
1574 ber_int_t o_msgid; /* msgid of the request */
1575 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1576 ber_tag_t o_tag; /* tag of the request */
1577 time_t o_time; /* time op was initiated */
1579 ldap_pvt_thread_t o_tid; /* thread handling this op */
1581 volatile sig_atomic_t o_abandon; /* abandon flag */
1583 char o_do_not_cache; /* don't cache from this op */
1585 #define SLAP_NO_CONTROL 0
1586 #define SLAP_NONCRITICAL_CONTROL 1
1587 #define SLAP_CRITICAL_CONTROL 2
1591 char o_subentries_visibility;
1592 char o_valuesreturnfilter;
1594 char o_pagedresults;
1595 ber_int_t o_pagedresults_size;
1596 PagedResultsState o_pagedresults_state;
1598 #ifdef LDAP_CLIENT_UPDATE
1599 char o_clientupdate;
1600 char o_clientupdate_type;
1601 #define SLAP_LCUP_NONE (0x0)
1602 #define SLAP_LCUP_SYNC (0x1)
1603 #define SLAP_LCUP_PERSIST (0x2)
1604 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1605 ber_int_t o_clientupdate_interval;
1606 struct berval o_clientupdate_state;
1607 #endif /* LDAP_CLIENT_UPDATE */
1609 #ifdef LDAP_CONNECTIONLESS
1610 Sockaddr o_peeraddr; /* UDP peer address */
1612 AuthorizationInformation o_authz;
1614 BerElement *o_ber; /* ber of the request */
1615 slap_callback *o_callback; /* callback pointers */
1616 LDAPControl **o_ctrls; /* controls */
1618 void *o_threadctx; /* thread pool thread context */
1619 void *o_private; /* anything the backend needs */
1621 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1622 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1625 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1626 #define get_subentries(op) ((int)(op)->o_subentries)
1627 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1630 * Caches the result of a backend_group check for ACL evaluation
1632 typedef struct slap_gacl {
1633 struct slap_gacl *ga_next;
1636 AttributeDescription *ga_at;
1643 * represents a connection from an ldap client
1645 typedef struct slap_conn {
1646 int c_struct_state; /* structure management state */
1647 int c_conn_state; /* connection state */
1649 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1650 Sockbuf *c_sb; /* ber connection stuff */
1652 /* only can be changed by connect_init */
1653 time_t c_starttime; /* when the connection was opened */
1654 time_t c_activitytime; /* when the connection was last used */
1655 unsigned long c_connid; /* id of this connection for stats*/
1657 struct berval c_listener_url; /* listener URL */
1658 struct berval c_peer_domain; /* DNS name of client */
1659 struct berval c_peer_name; /* peer name (trans=addr:port) */
1660 struct berval c_sock_name; /* sock name (trans=addr:port) */
1662 /* only can be changed by binding thread */
1663 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1664 struct berval c_sasl_bind_mech; /* mech in progress */
1665 struct berval c_sasl_dn; /* temporary storage */
1667 /* authorization backend */
1668 Backend *c_authz_backend;
1670 AuthorizationInformation c_authz;
1671 GroupAssertion *c_groups;
1673 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1675 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1676 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1678 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1679 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1681 BerElement *c_currentber; /* ber we're attempting to read */
1682 int c_writewaiter; /* true if writer is waiting */
1684 #ifdef LDAP_CONNECTIONLESS
1685 int c_is_udp; /* true if this is (C)LDAP over UDP */
1688 int c_is_tls; /* true if this LDAP over raw TLS */
1689 int c_needs_tls_accept; /* true if SSL_accept should be called */
1691 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1692 void *c_sasl_context; /* SASL session context */
1693 void *c_sasl_extra; /* SASL session extra stuff */
1694 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1696 PagedResultsState c_pagedresults_state; /* paged result state */
1698 long c_n_ops_received; /* num of ops received (next op_id) */
1699 long c_n_ops_executing; /* num of ops currently executing */
1700 long c_n_ops_pending; /* num of ops pending execution */
1701 long c_n_ops_completed; /* num of ops completed */
1703 long c_n_get; /* num of get calls */
1704 long c_n_read; /* num of read calls */
1705 long c_n_write; /* num of write calls */
1708 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1709 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1711 if ( ldap_debug & (level) ) \
1712 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1713 if ( ldap_syslog & (level) ) \
1714 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1718 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1722 * listener; need to access it from monitor backend
1724 typedef struct slap_listener {
1730 #ifdef LDAP_CONNECTIONLESS
1731 int sl_is_udp; /* UDP listener is also data port */
1735 #define sl_addr sl_sa.sa_in_addr
1738 #ifdef SLAPD_MONITOR
1755 #endif /* SLAPD_MONITOR */
1758 * Better know these all around slapd
1760 #define SLAP_LDAPDN_PRETTY 0x1
1761 #define SLAP_LDAPDN_MAXLEN 8192
1766 #ifdef LDAP_CLIENT_UPDATE
1767 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
1768 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
1769 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
1770 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
1771 #endif /* LDAP_CLIENT_UPDATE */
1775 #include "proto-slap.h"
1777 #endif /* _SLAP_H_ */