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;
172 #define SLAP_INDEX_TYPE 0x00FFUL
173 #define SLAP_INDEX_UNDEFINED 0x0001UL
174 #define SLAP_INDEX_PRESENT 0x0002UL
175 #define SLAP_INDEX_EQUALITY 0x0004UL
176 #define SLAP_INDEX_APPROX 0x0008UL
177 #define SLAP_INDEX_SUBSTR 0x0010UL
178 #define SLAP_INDEX_EXTENDED 0x0020UL
180 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
182 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
184 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
186 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
187 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
188 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
189 #define SLAP_INDEX_SUBSTR_DEFAULT \
190 ( SLAP_INDEX_SUBSTR \
191 | SLAP_INDEX_SUBSTR_INITIAL \
192 | SLAP_INDEX_SUBSTR_ANY \
193 | SLAP_INDEX_SUBSTR_FINAL )
195 #define SLAP_INDEX_SUBSTR_MINLEN 2
196 #define SLAP_INDEX_SUBSTR_MAXLEN 4
197 #define SLAP_INDEX_SUBSTR_STEP 2
199 #define SLAP_INDEX_FLAGS 0xF000UL
200 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
201 #define SLAP_INDEX_NOLANG 0x2000UL /* don't use index w/ lang */
204 * there is a single index for each attribute. these prefixes ensure
205 * that there is no collision among keys.
207 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
208 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
209 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
210 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
211 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
212 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
214 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
215 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
216 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
218 #ifdef LDAP_CLIENT_UPDATE
219 #define LCUP_COOKIE_OID "1.3.6.1.4.1.4203.666.10.1"
220 #endif /* LDAP_CLIENT_UPDATE */
223 * represents schema information for a database
225 #define SLAP_SCHERR_OUTOFMEM 1
226 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
227 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
228 #define SLAP_SCHERR_CLASS_BAD_SUP 4
229 #define SLAP_SCHERR_CLASS_DUP 5
230 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
231 #define SLAP_SCHERR_ATTR_BAD_MR 7
232 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
233 #define SLAP_SCHERR_ATTR_BAD_SUP 9
234 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
235 #define SLAP_SCHERR_ATTR_DUP 11
236 #define SLAP_SCHERR_MR_NOT_FOUND 12
237 #define SLAP_SCHERR_MR_INCOMPLETE 13
238 #define SLAP_SCHERR_MR_DUP 14
239 #define SLAP_SCHERR_SYN_NOT_FOUND 15
240 #define SLAP_SCHERR_SYN_DUP 16
241 #define SLAP_SCHERR_NO_NAME 17
242 #define SLAP_SCHERR_NOT_SUPPORTED 18
243 #define SLAP_SCHERR_BAD_DESCR 19
244 #define SLAP_SCHERR_OIDM 20
245 #define SLAP_SCHERR_LAST SLAP_SCHERR_OIDM
247 typedef union slap_sockaddr {
248 struct sockaddr sa_addr;
249 struct sockaddr_in sa_in_addr;
251 struct sockaddr_in6 sa_in6_addr;
254 struct sockaddr_un sa_un_addr;
259 extern int slap_inet4or6;
262 typedef struct slap_oid_macro {
263 struct berval som_oid;
265 struct slap_oid_macro *som_next;
268 /* forward declarations */
270 struct slap_matching_rule;
272 typedef int slap_syntax_validate_func LDAP_P((
273 struct slap_syntax *syntax,
274 struct berval * in));
276 typedef int slap_syntax_transform_func LDAP_P((
277 struct slap_syntax *syntax,
279 struct berval * out));
281 typedef struct slap_syntax {
283 #define ssyn_oid ssyn_syn.syn_oid
284 #define ssyn_desc ssyn_syn.syn_desc
285 #define ssyn_extensions ssyn_syn.syn_extensions
288 ber_len_t ssyn_oidlen;
289 * has been replaced by a struct berval that uses the value
290 * provided by ssyn_syn.syn_oid; a macro that expands to
291 * the bv_len field of the berval is provided for backward
292 * compatibility. CAUTION: NEVER FREE THE BERVAL
294 struct berval ssyn_bvoid;
295 #define ssyn_oidlen ssyn_bvoid.bv_len
297 unsigned int ssyn_flags;
299 #define SLAP_SYNTAX_NONE 0x0000U
300 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
301 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
302 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
303 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
305 slap_syntax_validate_func *ssyn_validate;
306 slap_syntax_transform_func *ssyn_normalize;
307 slap_syntax_transform_func *ssyn_pretty;
309 #ifdef SLAPD_BINARY_CONVERSION
310 /* convert to and from binary */
311 slap_syntax_transform_func *ssyn_ber2str;
312 slap_syntax_transform_func *ssyn_str2ber;
315 struct slap_syntax *ssyn_next;
318 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
319 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
320 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
321 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
322 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
324 typedef struct slap_syntax_defs_rec {
327 slap_syntax_validate_func *sd_validate;
328 slap_syntax_transform_func *sd_normalize;
329 slap_syntax_transform_func *sd_pretty;
330 #ifdef SLAPD_BINARY_CONVERSION
331 slap_syntax_transform_func *sd_ber2str;
332 slap_syntax_transform_func *sd_str2ber;
334 } slap_syntax_defs_rec;
336 /* X -> Y Converter */
337 typedef int slap_mr_convert_func LDAP_P((
339 struct berval * out ));
342 typedef int slap_mr_normalize_func LDAP_P((
344 struct slap_syntax *syntax, /* NULL if in is asserted value */
345 struct slap_matching_rule *mr,
347 struct berval * out ));
349 /* Match (compare) function */
350 typedef int slap_mr_match_func LDAP_P((
353 struct slap_syntax *syntax, /* syntax of stored value */
354 struct slap_matching_rule *mr,
355 struct berval * value,
356 void * assertValue ));
358 /* Index generation function */
359 typedef int slap_mr_indexer_func LDAP_P((
362 struct slap_syntax *syntax, /* syntax of stored value */
363 struct slap_matching_rule *mr,
364 struct berval *prefix,
368 /* Filter index function */
369 typedef int slap_mr_filter_func LDAP_P((
372 struct slap_syntax *syntax, /* syntax of stored value */
373 struct slap_matching_rule *mr,
374 struct berval *prefix,
378 typedef struct slap_matching_rule_use MatchingRuleUse;
380 typedef struct slap_matching_rule {
381 LDAPMatchingRule smr_mrule;
382 MatchingRuleUse *smr_mru;
383 /* RFC2252 string representation */
384 struct berval smr_str;
387 ber_len_t smr_oidlen;
388 * has been replaced by a struct berval that uses the value
389 * provided by smr_mrule.mr_oid; a macro that expands to
390 * the bv_len field of the berval is provided for backward
391 * compatibility. CAUTION: NEVER FREE THE BERVAL
393 struct berval smr_bvoid;
394 #define smr_oidlen smr_bvoid.bv_len
396 slap_mask_t smr_usage;
398 #define SLAP_MR_HIDE 0x8000U
400 #define SLAP_MR_TYPE_MASK 0x0F00U
401 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
402 #define SLAP_MR_USAGE 0x000FU
404 #define SLAP_MR_NONE 0x0000U
405 #define SLAP_MR_EQUALITY 0x0100U
406 #define SLAP_MR_ORDERING 0x0200U
407 #define SLAP_MR_SUBSTR 0x0400U
408 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
410 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
411 #define SLAP_MR_DN_FOLD 0x0008U
413 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
414 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
415 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
418 * normally the provided value is expected to conform to
419 * assertion syntax specified in the matching rule, however
420 * at times (such as during individual value modification),
421 * the provided value is expected to conform to the
422 * attribute's value syntax.
424 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
425 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
426 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
428 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
429 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
430 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
431 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
433 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
434 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
435 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
436 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
437 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
438 == SLAP_MR_VALUE_SYNTAX_MATCH)
441 slap_mr_convert_func *smr_convert;
442 slap_mr_normalize_func *smr_normalize;
443 slap_mr_match_func *smr_match;
444 slap_mr_indexer_func *smr_indexer;
445 slap_mr_filter_func *smr_filter;
448 * null terminated list of syntaxes compatible with this syntax
449 * note: when MS_EXT is set, this MUST NOT contain the assertion
450 * syntax of the rule. When MS_EXT is not set, it MAY.
452 Syntax **smr_compat_syntaxes;
454 struct slap_matching_rule *smr_associated;
455 struct slap_matching_rule *smr_next;
457 #define smr_oid smr_mrule.mr_oid
458 #define smr_names smr_mrule.mr_names
459 #define smr_desc smr_mrule.mr_desc
460 #define smr_obsolete smr_mrule.mr_obsolete
461 #define smr_syntax_oid smr_mrule.mr_syntax_oid
462 #define smr_extensions smr_mrule.mr_extensions
465 struct slap_matching_rule_use {
466 LDAPMatchingRuleUse smru_mruleuse;
467 MatchingRule *smru_mr;
468 /* RFC2252 string representation */
469 struct berval smru_str;
471 struct slap_matching_rule_use *smru_next;
473 #define smru_oid smru_mruleuse.mru_oid
474 #define smru_names smru_mruleuse.mru_names
475 #define smru_desc smru_mruleuse.mru_desc
476 #define smru_obsolete smru_mruleuse.mru_obsolete
477 #define smru_applies_oids smru_mruleuse.mru_applies_oids
479 #define smru_usage smru_mr->smr_usage
480 } /* MatchingRuleUse */ ;
482 typedef struct slap_mrule_defs_rec {
484 slap_mask_t mrd_usage;
485 char ** mrd_compat_syntaxes;
486 slap_mr_convert_func * mrd_convert;
487 slap_mr_normalize_func * mrd_normalize;
488 slap_mr_match_func * mrd_match;
489 slap_mr_indexer_func * mrd_indexer;
490 slap_mr_filter_func * mrd_filter;
492 char * mrd_associated;
493 } slap_mrule_defs_rec;
495 struct slap_backend_db;
499 typedef int (AttributeTypeSchemaCheckFN)(
500 struct slap_backend_db *be,
501 struct slap_entry *e,
502 struct slap_attr *attr,
504 char *textbuf, size_t textlen );
506 typedef struct slap_attribute_type {
507 LDAPAttributeType sat_atype;
508 struct berval sat_cname;
509 struct slap_attribute_type *sat_sup;
510 struct slap_attribute_type **sat_subtypes;
511 MatchingRule *sat_equality;
512 MatchingRule *sat_approx;
513 MatchingRule *sat_ordering;
514 MatchingRule *sat_substr;
517 AttributeTypeSchemaCheckFN *sat_check;
519 #define SLAP_AT_NONE 0x0000U
520 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
521 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
522 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
523 slap_mask_t sat_flags;
525 struct slap_attribute_type *sat_next;
527 #define sat_oid sat_atype.at_oid
528 #define sat_names sat_atype.at_names
529 #define sat_desc sat_atype.at_desc
530 #define sat_obsolete sat_atype.at_obsolete
531 #define sat_sup_oid sat_atype.at_sup_oid
532 #define sat_equality_oid sat_atype.at_equality_oid
533 #define sat_ordering_oid sat_atype.at_ordering_oid
534 #define sat_substr_oid sat_atype.at_substr_oid
535 #define sat_syntax_oid sat_atype.at_syntax_oid
536 #define sat_single_value sat_atype.at_single_value
537 #define sat_collective sat_atype.at_collective
538 #define sat_no_user_mod sat_atype.at_no_user_mod
539 #define sat_usage sat_atype.at_usage
540 #define sat_extensions sat_atype.at_extensions
542 struct slap_attr_desc *sat_ad;
543 ldap_pvt_thread_mutex_t sat_ad_mutex;
546 #define is_at_operational(at) ((at)->sat_usage)
547 #define is_at_single_value(at) ((at)->sat_single_value)
548 #define is_at_collective(at) ((at)->sat_collective)
549 #define is_at_obsolete(at) ((at)->sat_obsolete)
550 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
552 struct slap_object_class;
554 typedef int (ObjectClassSchemaCheckFN)(
555 struct slap_backend_db *be,
556 struct slap_entry *e,
557 struct slap_object_class *oc,
559 char *textbuf, size_t textlen );
561 typedef struct slap_object_class {
562 LDAPObjectClass soc_oclass;
563 struct berval soc_cname;
564 struct slap_object_class **soc_sups;
565 AttributeType **soc_required;
566 AttributeType **soc_allowed;
567 ObjectClassSchemaCheckFN *soc_check;
568 slap_mask_t soc_flags;
569 #define soc_oid soc_oclass.oc_oid
570 #define soc_names soc_oclass.oc_names
571 #define soc_desc soc_oclass.oc_desc
572 #define soc_obsolete soc_oclass.oc_obsolete
573 #define soc_sup_oids soc_oclass.oc_sup_oids
574 #define soc_kind soc_oclass.oc_kind
575 #define soc_at_oids_must soc_oclass.oc_at_oids_must
576 #define soc_at_oids_may soc_oclass.oc_at_oids_may
577 #define soc_extensions soc_oclass.oc_extensions
579 struct slap_object_class *soc_next;
582 #define SLAP_OC_ALIAS 0x0001
583 #define SLAP_OC_REFERRAL 0x0002
584 #define SLAP_OC_SUBENTRY 0x0004
585 #define SLAP_OC_DYNAMICOBJECT 0x0008
586 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
587 #define SLAP_OC__MASK 0x001F
588 #define SLAP_OC__END 0x0020
589 #define SLAP_OC_OPERATIONAL 0x4000
590 #define SLAP_OC_HIDE 0x8000
592 #ifdef LDAP_EXTENDED_SCHEMA
596 typedef struct slap_content_rule {
597 LDAPContentRule scr_crule;
598 ObjectClass *scr_sclass;
599 ObjectClass **scr_auxiliaries; /* optional */
600 AttributeType **scr_required; /* optional */
601 AttributeType **scr_allowed; /* optional */
602 AttributeType **scr_precluded; /* optional */
603 #define scr_oid scr_crule.cr_oid
604 #define scr_names scr_crule.cr_names
605 #define scr_desc scr_crule.cr_desc
606 #define scr_obsolete soc_oclass.cr_obsolete
607 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
608 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
609 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
610 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
615 * represents a recognized attribute description ( type + options )
617 typedef struct slap_attr_desc {
618 struct slap_attr_desc *ad_next;
619 AttributeType *ad_type; /* attribute type, must be specified */
620 struct berval ad_cname; /* canonical name, must be specified */
621 struct berval ad_lang; /* empty if no language tags */
623 #define SLAP_DESC_NONE 0x00U
624 #define SLAP_DESC_BINARY 0x01U
625 #define SLAP_DESC_LANG_RANGE 0x80U
626 } AttributeDescription;
628 typedef struct slap_attr_name {
629 struct berval an_name;
630 AttributeDescription *an_desc;
634 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
635 #define slap_ad_is_lang_range(ad) \
636 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
637 #define slap_ad_is_binary(ad) \
638 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
641 * pointers to schema elements used internally
643 struct slap_internal_schema {
645 ObjectClass *si_oc_top;
646 ObjectClass *si_oc_extensibleObject;
647 ObjectClass *si_oc_alias;
648 ObjectClass *si_oc_referral;
649 ObjectClass *si_oc_rootdse;
650 ObjectClass *si_oc_subentry;
651 ObjectClass *si_oc_subschema;
652 ObjectClass *si_oc_monitor;
653 ObjectClass *si_oc_collectiveAttributeSubentry;
654 ObjectClass *si_oc_dynamicObject;
656 /* objectClass attribute descriptions */
657 AttributeDescription *si_ad_objectClass;
659 /* operational attribute descriptions */
660 AttributeDescription *si_ad_structuralObjectClass;
661 AttributeDescription *si_ad_creatorsName;
662 AttributeDescription *si_ad_createTimestamp;
663 AttributeDescription *si_ad_modifiersName;
664 AttributeDescription *si_ad_modifyTimestamp;
665 AttributeDescription *si_ad_hasSubordinates;
666 AttributeDescription *si_ad_subschemaSubentry;
667 AttributeDescription *si_ad_collectiveSubentries;
668 AttributeDescription *si_ad_collectiveExclusions;
669 AttributeDescription *si_ad_entryUUID;
670 AttributeDescription *si_ad_entryCSN;
672 /* root DSE attribute descriptions */
673 AttributeDescription *si_ad_altServer;
674 AttributeDescription *si_ad_namingContexts;
675 AttributeDescription *si_ad_supportedControl;
676 AttributeDescription *si_ad_supportedExtension;
677 AttributeDescription *si_ad_supportedLDAPVersion;
678 AttributeDescription *si_ad_supportedSASLMechanisms;
679 AttributeDescription *si_ad_supportedFeatures;
680 AttributeDescription *si_ad_monitorContext;
681 AttributeDescription *si_ad_vendorName;
682 AttributeDescription *si_ad_vendorVersion;
684 /* subentry attribute descriptions */
685 AttributeDescription *si_ad_administrativeRole;
686 AttributeDescription *si_ad_subtreeSpecification;
688 /* subschema subentry attribute descriptions */
689 AttributeDescription *si_ad_ditStructureRules;
690 AttributeDescription *si_ad_ditContentRules;
691 AttributeDescription *si_ad_nameForms;
692 AttributeDescription *si_ad_objectClasses;
693 AttributeDescription *si_ad_attributeTypes;
694 AttributeDescription *si_ad_ldapSyntaxes;
695 AttributeDescription *si_ad_matchingRules;
696 AttributeDescription *si_ad_matchingRuleUse;
698 /* Aliases & Referrals */
699 AttributeDescription *si_ad_aliasedObjectName;
700 AttributeDescription *si_ad_ref;
702 /* Access Control Internals */
703 AttributeDescription *si_ad_entry;
704 AttributeDescription *si_ad_children;
705 AttributeDescription *si_ad_saslAuthzTo;
706 AttributeDescription *si_ad_saslAuthzFrom;
707 #ifdef SLAPD_ACI_ENABLED
708 AttributeDescription *si_ad_aci;
711 /* dynamic entries */
712 AttributeDescription *si_ad_entryTtl;
713 AttributeDescription *si_ad_dynamicSubtrees;
715 /* Other attributes descriptions */
716 AttributeDescription *si_ad_distinguishedName;
717 AttributeDescription *si_ad_name;
718 AttributeDescription *si_ad_cn;
719 AttributeDescription *si_ad_userPassword;
720 #ifdef SLAPD_AUTHPASSWD
721 AttributeDescription *si_ad_authPassword;
723 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
724 AttributeDescription *si_ad_krbName;
727 /* Undefined Attribute Type */
728 AttributeType *si_at_undefined;
731 MatchingRule *si_mr_distinguishedNameMatch;
732 MatchingRule *si_mr_integerMatch;
735 Syntax *si_syn_octetString;
736 Syntax *si_syn_distinguishedName;
737 Syntax *si_syn_integer;
740 typedef struct slap_attr_assertion {
741 AttributeDescription *aa_desc;
742 struct berval aa_value;
743 } AttributeAssertion;
745 typedef struct slap_ss_assertion {
746 AttributeDescription *sa_desc;
747 struct berval sa_initial;
748 struct berval *sa_any;
749 struct berval sa_final;
750 } SubstringsAssertion;
752 typedef struct slap_mr_assertion {
753 MatchingRule *ma_rule; /* optional */
754 struct berval ma_rule_text; /* optional */
755 AttributeDescription *ma_desc; /* optional */
756 int ma_dnattrs; /* boolean */
757 struct berval ma_value; /* required */
758 } MatchingRuleAssertion;
761 * represents a search filter
763 typedef struct slap_filter {
764 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
765 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
766 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
767 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
770 /* precomputed result */
771 ber_int_t f_un_result;
774 struct berval *f_un_dn;
777 AttributeDescription *f_un_desc;
779 /* simple value assertion */
780 AttributeAssertion *f_un_ava;
782 /* substring assertion */
783 SubstringsAssertion *f_un_ssa;
785 /* matching rule assertion */
786 MatchingRuleAssertion *f_un_mra;
788 #define f_dn f_un.f_un_dn
789 #define f_desc f_un.f_un_desc
790 #define f_ava f_un.f_un_ava
791 #define f_av_desc f_un.f_un_ava->aa_desc
792 #define f_av_value f_un.f_un_ava->aa_value
793 #define f_sub f_un.f_un_ssa
794 #define f_sub_desc f_un.f_un_ssa->sa_desc
795 #define f_sub_initial f_un.f_un_ssa->sa_initial
796 #define f_sub_any f_un.f_un_ssa->sa_any
797 #define f_sub_final f_un.f_un_ssa->sa_final
798 #define f_mra f_un.f_un_mra
799 #define f_mr_rule f_un.f_un_mra->ma_rule
800 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
801 #define f_mr_desc f_un.f_un_mra->ma_desc
802 #define f_mr_value f_un.f_un_mra->ma_value
803 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
806 struct slap_filter *f_un_complex;
809 #define f_result f_un.f_un_result
810 #define f_and f_un.f_un_complex
811 #define f_or f_un.f_un_complex
812 #define f_not f_un.f_un_complex
813 #define f_list f_un.f_un_complex
815 struct slap_filter *f_next;
818 /* compare routines can return undefined */
819 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
821 typedef struct slap_valuesreturnfilter {
825 /* precomputed result */
826 ber_int_t f_un_result;
832 AttributeDescription *f_un_desc;
834 /* simple value assertion */
835 AttributeAssertion *f_un_ava;
837 /* substring assertion */
838 SubstringsAssertion *f_un_ssa;
840 /* matching rule assertion */
841 MatchingRuleAssertion *f_un_mra;
844 struct slap_valuesreturnfilter *f_next;
845 } ValuesReturnFilter;
848 * represents an attribute (description + values)
850 typedef struct slap_attr {
851 AttributeDescription *a_desc;
853 struct slap_attr *a_next;
855 #define SLAP_ATTR_IXADD 0x1U
856 #define SLAP_ATTR_IXDEL 0x2U
861 * the id used in the indexes to refer to an entry
863 typedef unsigned long ID;
864 #define NOID ((ID)~0)
867 * represents an entry in core
869 typedef struct slap_entry {
871 * The ID field should only be changed before entry is
872 * inserted into a cache. The ID value is backend
877 struct berval e_name; /* name (DN) of this entry */
878 struct berval e_nname; /* normalized name (DN) of this entry */
880 /* for migration purposes */
881 #define e_dn e_name.bv_val
882 #define e_ndn e_nname.bv_val
884 Attribute *e_attrs; /* list of attributes + values */
886 slap_mask_t e_ocflags;
888 struct berval e_bv; /* For entry_encode/entry_decode */
890 /* for use by the backend for any purpose */
897 typedef struct slap_mod {
899 AttributeDescription *sm_desc;
900 struct berval sm_type;
901 BerVarray sm_bvalues;
904 typedef struct slap_mod_list {
905 Modification sml_mod;
906 #define sml_op sml_mod.sm_op
907 #define sml_desc sml_mod.sm_desc
908 #define sml_type sml_mod.sm_type
909 #define sml_bvalues sml_mod.sm_bvalues
910 struct slap_mod_list *sml_next;
913 typedef struct slap_ldap_modlist {
915 struct slap_ldap_modlist *ml_next;
916 #define ml_op ml_mod.mod_op
917 #define ml_type ml_mod.mod_type
918 #define ml_values ml_mod.mod_values
919 #define ml_bvalues ml_mod.mod_bvalues
923 * represents an access control list
925 typedef enum slap_access_e {
926 ACL_INVALID_ACCESS = -1,
935 typedef enum slap_control_e {
936 ACL_INVALID_CONTROL = 0,
942 typedef enum slap_style_e {
950 /* alternate names */
951 ACL_STYLE_EXACT = ACL_STYLE_BASE
954 typedef struct slap_authz_info {
955 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
956 struct berval sai_mech; /* SASL Mechanism */
957 struct berval sai_dn; /* DN for reporting purposes */
958 struct berval sai_ndn; /* Normalized DN */
960 /* Security Strength Factors */
961 slap_ssf_t sai_ssf; /* Overall SSF */
962 slap_ssf_t sai_transport_ssf; /* Transport SSF */
963 slap_ssf_t sai_tls_ssf; /* TLS SSF */
964 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
965 } AuthorizationInformation;
968 typedef struct slap_access {
969 slap_control_t a_type;
971 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
973 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
974 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
975 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
976 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
977 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
978 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
980 #define ACL_PRIV_MASK 0x00ffUL
983 #define ACL_PRIV_LEVEL 0x1000UL
984 #define ACL_PRIV_ADDITIVE 0x2000UL
985 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
988 #define ACL_PRIV_INVALID 0x0UL
990 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
991 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
992 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
993 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
995 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
996 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
998 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1000 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1002 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1003 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1004 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1006 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1007 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1008 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1009 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1010 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1011 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1013 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1014 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1015 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1016 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1017 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1018 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1019 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1021 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1022 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1023 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1024 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1025 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1026 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1028 slap_mask_t a_access_mask;
1030 AuthorizationInformation a_authz;
1031 #define a_dn_pat a_authz.sai_dn
1033 slap_style_t a_dn_style;
1034 AttributeDescription *a_dn_at;
1038 slap_style_t a_peername_style;
1039 struct berval a_peername_pat;
1040 slap_style_t a_sockname_style;
1041 struct berval a_sockname_pat;
1043 slap_style_t a_domain_style;
1044 struct berval a_domain_pat;
1045 int a_domain_expand;
1047 slap_style_t a_sockurl_style;
1048 struct berval a_sockurl_pat;
1049 slap_style_t a_set_style;
1050 struct berval a_set_pat;
1052 #ifdef SLAPD_ACI_ENABLED
1053 AttributeDescription *a_aci_at;
1057 slap_style_t a_group_style;
1058 struct berval a_group_pat;
1059 ObjectClass *a_group_oc;
1060 AttributeDescription *a_group_at;
1062 struct slap_access *a_next;
1066 typedef struct slap_acl {
1067 /* "to" part: the entries this acl applies to */
1069 slap_style_t acl_dn_style;
1071 struct berval acl_dn_pat;
1072 AttributeName *acl_attrs;
1074 /* "by" part: list of who has what access to the entries */
1077 struct slap_acl *acl_next;
1080 typedef struct slap_acl_state {
1081 unsigned as_recorded;
1082 #define ACL_STATE_NOT_RECORDED 0x0
1083 #define ACL_STATE_RECORDED_VD 0x1
1084 #define ACL_STATE_RECORDED_NV 0x2
1085 #define ACL_STATE_RECORDED 0x3
1088 AccessControl *as_vd_acl;
1089 slap_mask_t as_vd_acl_mask;
1090 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1091 int as_vd_acl_count;
1093 Access *as_vd_access;
1094 int as_vd_access_count;
1097 } AccessControlState;
1098 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1101 * replog moddn param structure
1103 struct slap_replog_moddn {
1104 struct berval *newrdn;
1106 struct berval *newsup;
1111 * represents a backend
1114 typedef struct slap_backend_info BackendInfo; /* per backend type */
1115 typedef struct slap_backend_db BackendDB; /* per backend database */
1117 LDAP_SLAPD_V (int) nBackendInfo;
1118 LDAP_SLAPD_V (int) nBackendDB;
1119 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1120 LDAP_SLAPD_V (BackendDB *) backendDB;
1122 LDAP_SLAPD_V (int) slapMode;
1123 #define SLAP_UNDEFINED_MODE 0x0000
1124 #define SLAP_SERVER_MODE 0x0001
1125 #define SLAP_TOOL_MODE 0x0002
1126 #define SLAP_MODE 0x0003
1128 #define SLAP_TRUNCATE_MODE 0x0100
1130 struct slap_replica_info {
1131 char *ri_host; /* supersedes be_replica */
1132 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1133 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1134 int ri_exclude; /* 1 => exclude ri_attrs */
1137 struct slap_limits_set {
1145 int lms_s_unchecked;
1148 struct slap_limits {
1149 int lm_type; /* type of pattern */
1150 #define SLAP_LIMITS_UNDEFINED 0x0000
1151 #define SLAP_LIMITS_EXACT 0x0001
1152 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1153 #define SLAP_LIMITS_ONE 0x0002
1154 #define SLAP_LIMITS_SUBTREE 0x0003
1155 #define SLAP_LIMITS_CHILDREN 0x0004
1156 #define SLAP_LIMITS_REGEX 0x0005
1157 #define SLAP_LIMITS_ANONYMOUS 0x0006
1158 #define SLAP_LIMITS_USERS 0x0007
1159 #define SLAP_LIMITS_ANY 0x0008
1160 regex_t lm_dn_regex; /* regex data for REGEX */
1163 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1164 * pattern for REGEX; NULL for ANONYMOUS, USERS
1166 struct berval lm_dn_pat;
1168 struct slap_limits_set lm_limits;
1171 /* temporary aliases */
1172 typedef BackendDB Backend;
1173 #define nbackends nBackendDB
1174 #define backends backendDB
1176 struct slap_backend_db {
1177 BackendInfo *bd_info; /* pointer to shared backend info */
1179 /* BackendInfo accessors */
1180 #define be_config bd_info->bi_db_config
1181 #define be_type bd_info->bi_type
1183 #define be_bind bd_info->bi_op_bind
1184 #define be_unbind bd_info->bi_op_unbind
1185 #define be_add bd_info->bi_op_add
1186 #define be_compare bd_info->bi_op_compare
1187 #define be_delete bd_info->bi_op_delete
1188 #define be_modify bd_info->bi_op_modify
1189 #define be_modrdn bd_info->bi_op_modrdn
1190 #define be_search bd_info->bi_op_search
1192 #define be_extended bd_info->bi_extended
1194 #define be_release bd_info->bi_entry_release_rw
1195 #define be_chk_referrals bd_info->bi_chk_referrals
1196 #define be_group bd_info->bi_acl_group
1197 #define be_attribute bd_info->bi_acl_attribute
1198 #define be_operational bd_info->bi_operational
1200 #define be_controls bd_info->bi_controls
1202 #define be_connection_init bd_info->bi_connection_init
1203 #define be_connection_destroy bd_info->bi_connection_destroy
1206 #define be_entry_open bd_info->bi_tool_entry_open
1207 #define be_entry_close bd_info->bi_tool_entry_close
1208 #define be_entry_first bd_info->bi_tool_entry_first
1209 #define be_entry_next bd_info->bi_tool_entry_next
1210 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1211 #define be_entry_get bd_info->bi_tool_entry_get
1212 #define be_entry_put bd_info->bi_tool_entry_put
1213 #define be_sync bd_info->bi_tool_sync
1216 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1217 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1218 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1219 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1220 #define SLAP_BFLAG_ALIASES 0x0100U
1221 #define SLAP_BFLAG_REFERRALS 0x0200U
1222 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1223 #define SLAP_BFLAG_MONITOR 0x1000U
1224 #define SLAP_BFLAG_DYNAMIC 0x2000U
1225 slap_mask_t be_flags;
1226 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1227 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1228 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1229 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1230 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1231 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1233 slap_mask_t be_restrictops; /* restriction operations */
1234 #define SLAP_RESTRICT_OP_ADD 0x0001U
1235 #define SLAP_RESTRICT_OP_BIND 0x0002U
1236 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1237 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1238 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1239 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1240 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1241 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1243 #define SLAP_RESTRICT_OP_READS \
1244 ( SLAP_RESTRICT_OP_COMPARE \
1245 | SLAP_RESTRICT_OP_SEARCH )
1246 #define SLAP_RESTRICT_OP_WRITES \
1247 ( SLAP_RESTRICT_OP_ADD \
1248 | SLAP_RESTRICT_OP_DELETE \
1249 | SLAP_RESTRICT_OP_MODIFY \
1250 | SLAP_RESTRICT_OP_RENAME )
1252 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1253 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1254 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1256 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1257 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1258 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1259 0x0004U /* unprotected simple auth */
1260 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1262 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1263 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1265 slap_mask_t be_requires; /* pre-operation requirements */
1266 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1267 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1268 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1269 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1270 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1272 /* Required Security Strength Factor */
1273 slap_ssf_set_t be_ssf_set;
1275 /* these should be renamed from be_ to bd_ */
1276 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1277 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1278 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1279 #ifdef SLAPD_SCHEMA_DN
1280 struct berval be_schemadn; /* per-backend subschema subentry DN */
1281 struct berval be_schemandn; /* normalized subschema DN */
1283 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1284 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1285 struct berval be_rootpw; /* the magic "root" password for this db */
1286 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1287 #define be_sizelimit be_def_limit.lms_s_soft
1288 #define be_timelimit be_def_limit.lms_t_soft
1289 struct slap_limits_set be_def_limit; /* default limits */
1290 struct slap_limits **be_limits; /* regex-based size and time limits */
1291 AccessControl *be_acl; /* access control list for this backend */
1292 slap_access_t be_dfltaccess; /* access given if no acl matches */
1293 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1294 char *be_replogfile; /* replication log file (in master) */
1295 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1296 BerVarray be_update_refs; /* where to refer modifying clients to */
1298 void *be_private; /* anything the backend database needs */
1304 /* Backend function typedefs */
1305 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1306 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1307 const char *fname, int lineno,
1308 int argc, char **argv));
1309 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1310 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1311 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1313 typedef int (BI_db_init) LDAP_P((Backend *bd));
1314 typedef int (BI_db_config) LDAP_P((Backend *bd,
1315 const char *fname, int lineno,
1316 int argc, char **argv));
1317 typedef int (BI_db_open) LDAP_P((Backend *bd));
1318 typedef int (BI_db_close) LDAP_P((Backend *bd));
1319 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1321 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1322 struct slap_conn *c, struct slap_op *o,
1323 struct berval *dn, struct berval *ndn, int method,
1324 struct berval *cred, struct berval *edn ));
1325 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1326 struct slap_conn *c, struct slap_op *o ));
1327 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1328 struct slap_conn *c, struct slap_op *o,
1329 struct berval *base, struct berval *nbase,
1330 int scope, int deref,
1331 int slimit, int tlimit,
1332 Filter *f, struct berval *filterstr,
1333 AttributeName *attrs, int attrsonly));
1334 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1335 struct slap_conn *c, struct slap_op *o,
1336 struct berval *dn, struct berval *ndn,
1337 AttributeAssertion *ava));
1338 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1339 struct slap_conn *c, struct slap_op *o,
1340 struct berval *dn, struct berval *ndn,
1342 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1343 struct slap_conn *c, struct slap_op *o,
1344 struct berval *dn, struct berval *ndn,
1345 struct berval *newrdn, struct berval *nnewrdn,
1347 struct berval *newSup, struct berval *nnewSup ));
1348 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1349 struct slap_conn *c, struct slap_op *o,
1351 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1352 struct slap_conn *c, struct slap_op *o,
1353 struct berval *dn, struct berval *ndn));
1354 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1355 struct slap_conn *c, struct slap_op *o,
1358 typedef int (BI_op_extended) LDAP_P((
1360 struct slap_conn *conn,
1363 struct berval * reqdata,
1365 struct berval ** rspdata,
1366 LDAPControl *** rspctrls,
1370 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1371 struct slap_conn *c, struct slap_op *o,
1374 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1375 struct slap_conn *c, struct slap_op *o,
1376 struct berval *dn, struct berval *ndn,
1377 const char **text ));
1379 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1380 struct slap_conn *c, struct slap_op *o,
1384 ObjectClass *group_oc,
1385 AttributeDescription *group_at ));
1387 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1388 struct slap_conn *c, struct slap_op *o,
1389 Entry *e, struct berval *edn,
1390 AttributeDescription *entry_at,
1393 typedef int (BI_operational) LDAP_P((Backend *bd,
1394 struct slap_conn *c, struct slap_op *o,
1395 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1397 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1398 struct slap_conn *c));
1399 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1400 struct slap_conn *c));
1402 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1403 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1404 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1405 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1406 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1407 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1408 struct berval *text ));
1409 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1410 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1412 struct slap_backend_info {
1413 char *bi_type; /* type of backend */
1416 * per backend type routines:
1417 * bi_init: called to allocate a backend_info structure,
1418 * called once BEFORE configuration file is read.
1419 * bi_init() initializes this structure hence is
1420 * called directly from be_initialize()
1421 * bi_config: called per 'backend' specific option
1422 * all such options must before any 'database' options
1423 * bi_config() is called only from read_config()
1424 * bi_open: called to open each database, called
1425 * once AFTER configuration file is read but
1426 * BEFORE any bi_db_open() calls.
1427 * bi_open() is called from backend_startup()
1428 * bi_close: called to close each database, called
1429 * once during shutdown after all bi_db_close calls.
1430 * bi_close() is called from backend_shutdown()
1431 * bi_destroy: called to destroy each database, called
1432 * once during shutdown after all bi_db_destroy calls.
1433 * bi_destory() is called from backend_destroy()
1436 BI_config *bi_config;
1439 BI_destroy *bi_destroy;
1442 * per database routines:
1443 * bi_db_init: called to initialize each database,
1444 * called upon reading 'database <type>'
1445 * called only from backend_db_init()
1446 * bi_db_config: called to configure each database,
1447 * called per database to handle per database options
1448 * called only from read_config()
1449 * bi_db_open: called to open each database
1450 * called once per database immediately AFTER bi_open()
1451 * calls but before daemon startup.
1452 * called only by backend_startup()
1453 * bi_db_close: called to close each database
1454 * called once per database during shutdown but BEFORE
1455 * any bi_close call.
1456 * called only by backend_shutdown()
1457 * bi_db_destroy: called to destroy each database
1458 * called once per database during shutdown AFTER all
1459 * bi_close calls but before bi_destory calls.
1460 * called only by backend_destory()
1462 BI_db_init *bi_db_init;
1463 BI_db_config *bi_db_config;
1464 BI_db_open *bi_db_open;
1465 BI_db_close *bi_db_close;
1466 BI_db_destroy *bi_db_destroy;
1468 /* LDAP Operations Handling Routines */
1469 BI_op_bind *bi_op_bind;
1470 BI_op_unbind *bi_op_unbind;
1471 BI_op_search *bi_op_search;
1472 BI_op_compare *bi_op_compare;
1473 BI_op_modify *bi_op_modify;
1474 BI_op_modrdn *bi_op_modrdn;
1475 BI_op_add *bi_op_add;
1476 BI_op_delete *bi_op_delete;
1477 BI_op_abandon *bi_op_abandon;
1479 /* Extended Operations Helper */
1480 BI_op_extended *bi_extended;
1482 /* Auxilary Functions */
1483 BI_entry_release_rw *bi_entry_release_rw;
1484 BI_chk_referrals *bi_chk_referrals;
1486 BI_acl_group *bi_acl_group;
1487 BI_acl_attribute *bi_acl_attribute;
1489 BI_operational *bi_operational;
1491 BI_connection_init *bi_connection_init;
1492 BI_connection_destroy *bi_connection_destroy;
1494 /* hooks for slap tools */
1495 BI_tool_entry_open *bi_tool_entry_open;
1496 BI_tool_entry_close *bi_tool_entry_close;
1497 BI_tool_entry_first *bi_tool_entry_first;
1498 BI_tool_entry_next *bi_tool_entry_next;
1499 BI_tool_entry_get *bi_tool_entry_get;
1500 BI_tool_entry_put *bi_tool_entry_put;
1501 BI_tool_entry_reindex *bi_tool_entry_reindex;
1502 BI_tool_sync *bi_tool_sync;
1504 #define SLAP_INDEX_ADD_OP 0x0001
1505 #define SLAP_INDEX_DELETE_OP 0x0002
1507 char **bi_controls; /* supported controls */
1509 unsigned int bi_nDB; /* number of databases of this type */
1510 void *bi_private; /* anything the backend type needs */
1513 #define c_authtype c_authz.sai_method
1514 #define c_authmech c_authz.sai_mech
1515 #define c_dn c_authz.sai_dn
1516 #define c_ndn c_authz.sai_ndn
1517 #define c_ssf c_authz.sai_ssf
1518 #define c_transport_ssf c_authz.sai_transport_ssf
1519 #define c_tls_ssf c_authz.sai_tls_ssf
1520 #define c_sasl_ssf c_authz.sai_sasl_ssf
1522 #define o_authtype o_authz.sai_method
1523 #define o_authmech o_authz.sai_mech
1524 #define o_dn o_authz.sai_dn
1525 #define o_ndn o_authz.sai_ndn
1526 #define o_ssf o_authz.sai_ssf
1527 #define o_transport_ssf o_authz.sai_transport_ssf
1528 #define o_tls_ssf o_authz.sai_tls_ssf
1529 #define o_sasl_ssf o_authz.sai_sasl_ssf
1531 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1532 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1533 BerVarray, const char *, struct berval *,
1534 struct berval *, LDAPControl ** );
1536 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1537 ber_int_t, const char *, const char *, BerVarray,
1538 LDAPControl **, int nentries);
1540 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1541 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1543 typedef struct slap_callback {
1544 slap_response *sc_response;
1545 slap_sresult *sc_sresult;
1546 slap_sendentry *sc_sendentry;
1551 * Paged Results state
1553 typedef unsigned long PagedResultsCookie;
1554 typedef struct slap_paged_state {
1556 PagedResultsCookie ps_cookie;
1558 } PagedResultsState;
1561 * represents an operation pending from an ldap client
1563 typedef struct slap_op {
1564 unsigned long o_opid; /* id of this operation */
1565 unsigned long o_connid; /* id of conn initiating this op */
1566 struct slap_conn *o_conn; /* connection spawning this op */
1568 ber_int_t o_msgid; /* msgid of the request */
1569 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1570 ber_tag_t o_tag; /* tag of the request */
1571 time_t o_time; /* time op was initiated */
1573 ldap_pvt_thread_t o_tid; /* thread handling this op */
1575 volatile sig_atomic_t o_abandon; /* abandon flag */
1577 char o_do_not_cache; /* don't cache from this op */
1579 #define SLAP_NO_CONTROL 0
1580 #define SLAP_NONCRITICAL_CONTROL 1
1581 #define SLAP_CRITICAL_CONTROL 2
1585 char o_subentries_visibility;
1586 char o_valuesreturnfilter;
1588 char o_pagedresults;
1589 ber_int_t o_pagedresults_size;
1590 PagedResultsState o_pagedresults_state;
1592 #ifdef LDAP_CLIENT_UPDATE
1593 char o_clientupdate;
1594 char o_clientupdate_type;
1595 #define SLAP_LCUP_NONE (0x0)
1596 #define SLAP_LCUP_SYNC (0x1)
1597 #define SLAP_LCUP_PERSIST (0x2)
1598 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1599 ber_int_t o_clientupdate_interval;
1600 struct berval o_clientupdate_state;
1601 #endif /* LDAP_CLIENT_UPDATE */
1603 #ifdef LDAP_CONNECTIONLESS
1604 Sockaddr o_peeraddr; /* UDP peer address */
1606 AuthorizationInformation o_authz;
1608 BerElement *o_ber; /* ber of the request */
1609 slap_callback *o_callback; /* callback pointers */
1610 LDAPControl **o_ctrls; /* controls */
1612 void *o_threadctx; /* thread pool thread context */
1613 void *o_private; /* anything the backend needs */
1615 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1616 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1619 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1620 #define get_subentries(op) ((int)(op)->o_subentries)
1621 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1624 * Caches the result of a backend_group check for ACL evaluation
1626 typedef struct slap_gacl {
1627 struct slap_gacl *ga_next;
1630 AttributeDescription *ga_at;
1637 * represents a connection from an ldap client
1639 typedef struct slap_conn {
1640 int c_struct_state; /* structure management state */
1641 int c_conn_state; /* connection state */
1643 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1644 Sockbuf *c_sb; /* ber connection stuff */
1646 /* only can be changed by connect_init */
1647 time_t c_starttime; /* when the connection was opened */
1648 time_t c_activitytime; /* when the connection was last used */
1649 unsigned long c_connid; /* id of this connection for stats*/
1651 struct berval c_listener_url; /* listener URL */
1652 struct berval c_peer_domain; /* DNS name of client */
1653 struct berval c_peer_name; /* peer name (trans=addr:port) */
1654 struct berval c_sock_name; /* sock name (trans=addr:port) */
1656 /* only can be changed by binding thread */
1657 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1658 struct berval c_sasl_bind_mech; /* mech in progress */
1659 struct berval c_sasl_dn; /* temporary storage */
1661 /* authorization backend */
1662 Backend *c_authz_backend;
1664 AuthorizationInformation c_authz;
1665 GroupAssertion *c_groups;
1667 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1669 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1670 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1672 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1673 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1675 BerElement *c_currentber; /* ber we're attempting to read */
1676 int c_writewaiter; /* true if writer is waiting */
1678 #ifdef LDAP_CONNECTIONLESS
1679 int c_is_udp; /* true if this is (C)LDAP over UDP */
1682 int c_is_tls; /* true if this LDAP over raw TLS */
1683 int c_needs_tls_accept; /* true if SSL_accept should be called */
1685 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1686 void *c_sasl_context; /* SASL session context */
1687 void *c_sasl_extra; /* SASL session extra stuff */
1688 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1690 PagedResultsState c_pagedresults_state; /* paged result state */
1692 long c_n_ops_received; /* num of ops received (next op_id) */
1693 long c_n_ops_executing; /* num of ops currently executing */
1694 long c_n_ops_pending; /* num of ops pending execution */
1695 long c_n_ops_completed; /* num of ops completed */
1697 long c_n_get; /* num of get calls */
1698 long c_n_read; /* num of read calls */
1699 long c_n_write; /* num of write calls */
1702 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1703 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1705 if ( ldap_debug & (level) ) \
1706 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1707 if ( ldap_syslog & (level) ) \
1708 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1712 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1716 * listener; need to access it from monitor backend
1718 typedef struct slap_listener {
1724 #ifdef LDAP_CONNECTIONLESS
1725 int sl_is_udp; /* UDP listener is also data port */
1729 #define sl_addr sl_sa.sa_in_addr
1732 #ifdef SLAPD_MONITOR
1749 #endif /* SLAPD_MONITOR */
1752 * Better know these all around slapd
1754 #define SLAP_LDAPDN_PRETTY 0x1
1755 #define SLAP_LDAPDN_MAXLEN 8192
1760 #ifdef LDAP_CLIENT_UPDATE
1761 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
1762 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
1763 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
1764 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
1765 #endif /* LDAP_CLIENT_UPDATE */
1769 #include "proto-slap.h"
1771 #endif /* _SLAP_H_ */