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"
219 * represents schema information for a database
221 #define SLAP_SCHERR_OUTOFMEM 1
222 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
223 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
224 #define SLAP_SCHERR_CLASS_BAD_SUP 4
225 #define SLAP_SCHERR_CLASS_DUP 5
226 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
227 #define SLAP_SCHERR_ATTR_BAD_MR 7
228 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
229 #define SLAP_SCHERR_ATTR_BAD_SUP 9
230 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
231 #define SLAP_SCHERR_ATTR_DUP 11
232 #define SLAP_SCHERR_MR_NOT_FOUND 12
233 #define SLAP_SCHERR_MR_INCOMPLETE 13
234 #define SLAP_SCHERR_MR_DUP 14
235 #define SLAP_SCHERR_SYN_NOT_FOUND 15
236 #define SLAP_SCHERR_SYN_DUP 16
237 #define SLAP_SCHERR_NO_NAME 17
238 #define SLAP_SCHERR_NOT_SUPPORTED 18
239 #define SLAP_SCHERR_BAD_DESCR 19
240 #define SLAP_SCHERR_OIDM 20
241 #define SLAP_SCHERR_LAST SLAP_SCHERR_OIDM
243 typedef union slap_sockaddr {
244 struct sockaddr sa_addr;
245 struct sockaddr_in sa_in_addr;
247 struct sockaddr_in6 sa_in6_addr;
250 struct sockaddr_un sa_un_addr;
255 extern int slap_inet4or6;
258 typedef struct slap_oid_macro {
259 struct berval som_oid;
261 struct slap_oid_macro *som_next;
264 /* forward declarations */
266 struct slap_matching_rule;
268 typedef int slap_syntax_validate_func LDAP_P((
269 struct slap_syntax *syntax,
270 struct berval * in));
272 typedef int slap_syntax_transform_func LDAP_P((
273 struct slap_syntax *syntax,
275 struct berval * out));
277 typedef struct slap_syntax {
279 #define ssyn_oid ssyn_syn.syn_oid
280 #define ssyn_desc ssyn_syn.syn_desc
281 #define ssyn_extensions ssyn_syn.syn_extensions
284 ber_len_t ssyn_oidlen;
285 * has been replaced by a struct berval that uses the value
286 * provided by ssyn_syn.syn_oid; a macro that expands to
287 * the bv_len field of the berval is provided for backward
288 * compatibility. CAUTION: NEVER FREE THE BERVAL
290 struct berval ssyn_bvoid;
291 #define ssyn_oidlen ssyn_bvoid.bv_len
293 unsigned int ssyn_flags;
295 #define SLAP_SYNTAX_NONE 0x0000U
296 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
297 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
298 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
299 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
301 slap_syntax_validate_func *ssyn_validate;
302 slap_syntax_transform_func *ssyn_normalize;
303 slap_syntax_transform_func *ssyn_pretty;
305 #ifdef SLAPD_BINARY_CONVERSION
306 /* convert to and from binary */
307 slap_syntax_transform_func *ssyn_ber2str;
308 slap_syntax_transform_func *ssyn_str2ber;
311 struct slap_syntax *ssyn_next;
314 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
315 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
316 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
317 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
318 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
320 typedef struct slap_syntax_defs_rec {
323 slap_syntax_validate_func *sd_validate;
324 slap_syntax_transform_func *sd_normalize;
325 slap_syntax_transform_func *sd_pretty;
326 #ifdef SLAPD_BINARY_CONVERSION
327 slap_syntax_transform_func *sd_ber2str;
328 slap_syntax_transform_func *sd_str2ber;
330 } slap_syntax_defs_rec;
332 /* X -> Y Converter */
333 typedef int slap_mr_convert_func LDAP_P((
335 struct berval * out ));
338 typedef int slap_mr_normalize_func LDAP_P((
340 struct slap_syntax *syntax, /* NULL if in is asserted value */
341 struct slap_matching_rule *mr,
343 struct berval * out ));
345 /* Match (compare) function */
346 typedef int slap_mr_match_func LDAP_P((
349 struct slap_syntax *syntax, /* syntax of stored value */
350 struct slap_matching_rule *mr,
351 struct berval * value,
352 void * assertValue ));
354 /* Index generation function */
355 typedef int slap_mr_indexer_func LDAP_P((
358 struct slap_syntax *syntax, /* syntax of stored value */
359 struct slap_matching_rule *mr,
360 struct berval *prefix,
364 /* Filter index function */
365 typedef int slap_mr_filter_func LDAP_P((
368 struct slap_syntax *syntax, /* syntax of stored value */
369 struct slap_matching_rule *mr,
370 struct berval *prefix,
374 typedef struct slap_matching_rule_use MatchingRuleUse;
376 typedef struct slap_matching_rule {
377 LDAPMatchingRule smr_mrule;
378 MatchingRuleUse *smr_mru;
379 /* RFC2252 string representation */
380 struct berval smr_str;
383 ber_len_t smr_oidlen;
384 * has been replaced by a struct berval that uses the value
385 * provided by smr_mrule.mr_oid; a macro that expands to
386 * the bv_len field of the berval is provided for backward
387 * compatibility. CAUTION: NEVER FREE THE BERVAL
389 struct berval smr_bvoid;
390 #define smr_oidlen smr_bvoid.bv_len
392 slap_mask_t smr_usage;
394 #define SLAP_MR_HIDE 0x8000U
396 #define SLAP_MR_TYPE_MASK 0x0F00U
397 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
398 #define SLAP_MR_USAGE 0x000FU
400 #define SLAP_MR_NONE 0x0000U
401 #define SLAP_MR_EQUALITY 0x0100U
402 #define SLAP_MR_ORDERING 0x0200U
403 #define SLAP_MR_SUBSTR 0x0400U
404 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
406 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
407 #define SLAP_MR_DN_FOLD 0x0008U
409 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
410 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
411 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
414 * normally the provided value is expected to conform to
415 * assertion syntax specified in the matching rule, however
416 * at times (such as during individual value modification),
417 * the provided value is expected to conform to the
418 * attribute's value syntax.
420 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
421 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
422 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
424 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
425 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
426 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
427 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
429 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
430 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
431 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
432 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
433 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
434 == SLAP_MR_VALUE_SYNTAX_MATCH)
437 slap_mr_convert_func *smr_convert;
438 slap_mr_normalize_func *smr_normalize;
439 slap_mr_match_func *smr_match;
440 slap_mr_indexer_func *smr_indexer;
441 slap_mr_filter_func *smr_filter;
444 * null terminated list of syntaxes compatible with this syntax
445 * note: when MS_EXT is set, this MUST NOT contain the assertion
446 * syntax of the rule. When MS_EXT is not set, it MAY.
448 Syntax **smr_compat_syntaxes;
450 struct slap_matching_rule *smr_associated;
451 struct slap_matching_rule *smr_next;
453 #define smr_oid smr_mrule.mr_oid
454 #define smr_names smr_mrule.mr_names
455 #define smr_desc smr_mrule.mr_desc
456 #define smr_obsolete smr_mrule.mr_obsolete
457 #define smr_syntax_oid smr_mrule.mr_syntax_oid
458 #define smr_extensions smr_mrule.mr_extensions
461 struct slap_matching_rule_use {
462 LDAPMatchingRuleUse smru_mruleuse;
463 MatchingRule *smru_mr;
464 /* RFC2252 string representation */
465 struct berval smru_str;
467 struct slap_matching_rule_use *smru_next;
469 #define smru_oid smru_mruleuse.mru_oid
470 #define smru_names smru_mruleuse.mru_names
471 #define smru_desc smru_mruleuse.mru_desc
472 #define smru_obsolete smru_mruleuse.mru_obsolete
473 #define smru_applies_oids smru_mruleuse.mru_applies_oids
475 #define smru_usage smru_mr->smr_usage
476 } /* MatchingRuleUse */ ;
478 typedef struct slap_mrule_defs_rec {
480 slap_mask_t mrd_usage;
481 char ** mrd_compat_syntaxes;
482 slap_mr_convert_func * mrd_convert;
483 slap_mr_normalize_func * mrd_normalize;
484 slap_mr_match_func * mrd_match;
485 slap_mr_indexer_func * mrd_indexer;
486 slap_mr_filter_func * mrd_filter;
488 char * mrd_associated;
489 } slap_mrule_defs_rec;
491 struct slap_backend_db;
495 typedef int (AttributeTypeSchemaCheckFN)(
496 struct slap_backend_db *be,
497 struct slap_entry *e,
498 struct slap_attr *attr,
500 char *textbuf, size_t textlen );
502 typedef struct slap_attribute_type {
503 LDAPAttributeType sat_atype;
504 struct berval sat_cname;
505 struct slap_attribute_type *sat_sup;
506 struct slap_attribute_type **sat_subtypes;
507 MatchingRule *sat_equality;
508 MatchingRule *sat_approx;
509 MatchingRule *sat_ordering;
510 MatchingRule *sat_substr;
513 AttributeTypeSchemaCheckFN *sat_check;
515 #define SLAP_AT_NONE 0x0000U
516 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
517 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
518 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
519 slap_mask_t sat_flags;
521 struct slap_attribute_type *sat_next;
523 #define sat_oid sat_atype.at_oid
524 #define sat_names sat_atype.at_names
525 #define sat_desc sat_atype.at_desc
526 #define sat_obsolete sat_atype.at_obsolete
527 #define sat_sup_oid sat_atype.at_sup_oid
528 #define sat_equality_oid sat_atype.at_equality_oid
529 #define sat_ordering_oid sat_atype.at_ordering_oid
530 #define sat_substr_oid sat_atype.at_substr_oid
531 #define sat_syntax_oid sat_atype.at_syntax_oid
532 #define sat_single_value sat_atype.at_single_value
533 #define sat_collective sat_atype.at_collective
534 #define sat_no_user_mod sat_atype.at_no_user_mod
535 #define sat_usage sat_atype.at_usage
536 #define sat_extensions sat_atype.at_extensions
538 struct slap_attr_desc *sat_ad;
539 ldap_pvt_thread_mutex_t sat_ad_mutex;
542 #define is_at_operational(at) ((at)->sat_usage)
543 #define is_at_single_value(at) ((at)->sat_single_value)
544 #define is_at_collective(at) ((at)->sat_collective)
545 #define is_at_obsolete(at) ((at)->sat_obsolete)
546 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
548 struct slap_object_class;
550 typedef int (ObjectClassSchemaCheckFN)(
551 struct slap_backend_db *be,
552 struct slap_entry *e,
553 struct slap_object_class *oc,
555 char *textbuf, size_t textlen );
557 typedef struct slap_object_class {
558 LDAPObjectClass soc_oclass;
559 struct berval soc_cname;
560 struct slap_object_class **soc_sups;
561 AttributeType **soc_required;
562 AttributeType **soc_allowed;
563 ObjectClassSchemaCheckFN *soc_check;
564 slap_mask_t soc_flags;
565 #define soc_oid soc_oclass.oc_oid
566 #define soc_names soc_oclass.oc_names
567 #define soc_desc soc_oclass.oc_desc
568 #define soc_obsolete soc_oclass.oc_obsolete
569 #define soc_sup_oids soc_oclass.oc_sup_oids
570 #define soc_kind soc_oclass.oc_kind
571 #define soc_at_oids_must soc_oclass.oc_at_oids_must
572 #define soc_at_oids_may soc_oclass.oc_at_oids_may
573 #define soc_extensions soc_oclass.oc_extensions
575 struct slap_object_class *soc_next;
578 #define SLAP_OC_ALIAS 0x0001
579 #define SLAP_OC_REFERRAL 0x0002
580 #define SLAP_OC_SUBENTRY 0x0004
581 #define SLAP_OC_DYNAMICOBJECT 0x0008
582 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
583 #define SLAP_OC__MASK 0x001F
584 #define SLAP_OC__END 0x0020
585 #define SLAP_OC_OPERATIONAL 0x4000
586 #define SLAP_OC_HIDE 0x8000
588 #ifdef LDAP_EXTENDED_SCHEMA
592 typedef struct slap_content_rule {
593 LDAPContentRule scr_crule;
594 ObjectClass *scr_sclass;
595 ObjectClass **scr_auxiliaries; /* optional */
596 AttributeType **scr_required; /* optional */
597 AttributeType **scr_allowed; /* optional */
598 AttributeType **scr_precluded; /* optional */
599 #define scr_oid scr_crule.cr_oid
600 #define scr_names scr_crule.cr_names
601 #define scr_desc scr_crule.cr_desc
602 #define scr_obsolete soc_oclass.cr_obsolete
603 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
604 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
605 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
606 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
611 * represents a recognized attribute description ( type + options )
613 typedef struct slap_attr_desc {
614 struct slap_attr_desc *ad_next;
615 AttributeType *ad_type; /* attribute type, must be specified */
616 struct berval ad_cname; /* canonical name, must be specified */
617 struct berval ad_lang; /* empty if no language tags */
619 #define SLAP_DESC_NONE 0x00U
620 #define SLAP_DESC_BINARY 0x01U
621 #define SLAP_DESC_LANG_RANGE 0x80U
622 } AttributeDescription;
624 typedef struct slap_attr_name {
625 struct berval an_name;
626 AttributeDescription *an_desc;
630 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
631 #define slap_ad_is_lang_range(ad) \
632 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
633 #define slap_ad_is_binary(ad) \
634 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
637 * pointers to schema elements used internally
639 struct slap_internal_schema {
641 ObjectClass *si_oc_top;
642 ObjectClass *si_oc_extensibleObject;
643 ObjectClass *si_oc_alias;
644 ObjectClass *si_oc_referral;
645 ObjectClass *si_oc_rootdse;
646 ObjectClass *si_oc_subentry;
647 ObjectClass *si_oc_subschema;
648 ObjectClass *si_oc_monitor;
649 ObjectClass *si_oc_collectiveAttributeSubentry;
650 ObjectClass *si_oc_dynamicObject;
652 /* objectClass attribute descriptions */
653 AttributeDescription *si_ad_objectClass;
655 /* operational attribute descriptions */
656 AttributeDescription *si_ad_structuralObjectClass;
657 AttributeDescription *si_ad_creatorsName;
658 AttributeDescription *si_ad_createTimestamp;
659 AttributeDescription *si_ad_modifiersName;
660 AttributeDescription *si_ad_modifyTimestamp;
661 AttributeDescription *si_ad_hasSubordinates;
662 AttributeDescription *si_ad_subschemaSubentry;
663 AttributeDescription *si_ad_collectiveSubentries;
664 AttributeDescription *si_ad_collectiveExclusions;
665 AttributeDescription *si_ad_entryUUID;
666 AttributeDescription *si_ad_entryCSN;
668 /* root DSE attribute descriptions */
669 AttributeDescription *si_ad_altServer;
670 AttributeDescription *si_ad_namingContexts;
671 AttributeDescription *si_ad_supportedControl;
672 AttributeDescription *si_ad_supportedExtension;
673 AttributeDescription *si_ad_supportedLDAPVersion;
674 AttributeDescription *si_ad_supportedSASLMechanisms;
675 AttributeDescription *si_ad_supportedFeatures;
676 AttributeDescription *si_ad_monitorContext;
677 AttributeDescription *si_ad_vendorName;
678 AttributeDescription *si_ad_vendorVersion;
680 /* subentry attribute descriptions */
681 AttributeDescription *si_ad_administrativeRole;
682 AttributeDescription *si_ad_subtreeSpecification;
684 /* subschema subentry attribute descriptions */
685 AttributeDescription *si_ad_ditStructureRules;
686 AttributeDescription *si_ad_ditContentRules;
687 AttributeDescription *si_ad_nameForms;
688 AttributeDescription *si_ad_objectClasses;
689 AttributeDescription *si_ad_attributeTypes;
690 AttributeDescription *si_ad_ldapSyntaxes;
691 AttributeDescription *si_ad_matchingRules;
692 AttributeDescription *si_ad_matchingRuleUse;
694 /* Aliases & Referrals */
695 AttributeDescription *si_ad_aliasedObjectName;
696 AttributeDescription *si_ad_ref;
698 /* Access Control Internals */
699 AttributeDescription *si_ad_entry;
700 AttributeDescription *si_ad_children;
701 AttributeDescription *si_ad_saslAuthzTo;
702 AttributeDescription *si_ad_saslAuthzFrom;
703 #ifdef SLAPD_ACI_ENABLED
704 AttributeDescription *si_ad_aci;
707 /* dynamic entries */
708 AttributeDescription *si_ad_entryTtl;
709 AttributeDescription *si_ad_dynamicSubtrees;
711 /* Other attributes descriptions */
712 AttributeDescription *si_ad_distinguishedName;
713 AttributeDescription *si_ad_name;
714 AttributeDescription *si_ad_cn;
715 AttributeDescription *si_ad_userPassword;
716 #ifdef SLAPD_AUTHPASSWD
717 AttributeDescription *si_ad_authPassword;
719 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
720 AttributeDescription *si_ad_krbName;
723 /* Undefined Attribute Type */
724 AttributeType *si_at_undefined;
727 MatchingRule *si_mr_distinguishedNameMatch;
728 MatchingRule *si_mr_integerMatch;
731 Syntax *si_syn_octetString;
732 Syntax *si_syn_distinguishedName;
733 Syntax *si_syn_integer;
736 typedef struct slap_attr_assertion {
737 AttributeDescription *aa_desc;
738 struct berval aa_value;
739 } AttributeAssertion;
741 typedef struct slap_ss_assertion {
742 AttributeDescription *sa_desc;
743 struct berval sa_initial;
744 struct berval *sa_any;
745 struct berval sa_final;
746 } SubstringsAssertion;
748 typedef struct slap_mr_assertion {
749 MatchingRule *ma_rule; /* optional */
750 struct berval ma_rule_text; /* optional */
751 AttributeDescription *ma_desc; /* optional */
752 int ma_dnattrs; /* boolean */
753 struct berval ma_value; /* required */
754 } MatchingRuleAssertion;
757 * represents a search filter
759 typedef struct slap_filter {
760 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
761 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
762 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
763 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
766 /* precomputed result */
767 ber_int_t f_un_result;
770 struct berval *f_un_dn;
773 AttributeDescription *f_un_desc;
775 /* simple value assertion */
776 AttributeAssertion *f_un_ava;
778 /* substring assertion */
779 SubstringsAssertion *f_un_ssa;
781 /* matching rule assertion */
782 MatchingRuleAssertion *f_un_mra;
784 #define f_dn f_un.f_un_dn
785 #define f_desc f_un.f_un_desc
786 #define f_ava f_un.f_un_ava
787 #define f_av_desc f_un.f_un_ava->aa_desc
788 #define f_av_value f_un.f_un_ava->aa_value
789 #define f_sub f_un.f_un_ssa
790 #define f_sub_desc f_un.f_un_ssa->sa_desc
791 #define f_sub_initial f_un.f_un_ssa->sa_initial
792 #define f_sub_any f_un.f_un_ssa->sa_any
793 #define f_sub_final f_un.f_un_ssa->sa_final
794 #define f_mra f_un.f_un_mra
795 #define f_mr_rule f_un.f_un_mra->ma_rule
796 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
797 #define f_mr_desc f_un.f_un_mra->ma_desc
798 #define f_mr_value f_un.f_un_mra->ma_value
799 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
802 struct slap_filter *f_un_complex;
805 #define f_result f_un.f_un_result
806 #define f_and f_un.f_un_complex
807 #define f_or f_un.f_un_complex
808 #define f_not f_un.f_un_complex
809 #define f_list f_un.f_un_complex
811 struct slap_filter *f_next;
814 /* compare routines can return undefined */
815 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
817 typedef struct slap_valuesreturnfilter {
821 /* precomputed result */
822 ber_int_t f_un_result;
828 AttributeDescription *f_un_desc;
830 /* simple value assertion */
831 AttributeAssertion *f_un_ava;
833 /* substring assertion */
834 SubstringsAssertion *f_un_ssa;
836 /* matching rule assertion */
837 MatchingRuleAssertion *f_un_mra;
840 struct slap_valuesreturnfilter *f_next;
841 } ValuesReturnFilter;
844 * represents an attribute (description + values)
846 typedef struct slap_attr {
847 AttributeDescription *a_desc;
849 struct slap_attr *a_next;
851 #define SLAP_ATTR_IXADD 0x1U
852 #define SLAP_ATTR_IXDEL 0x2U
857 * the id used in the indexes to refer to an entry
859 typedef unsigned long ID;
860 #define NOID ((ID)~0)
863 * represents an entry in core
865 typedef struct slap_entry {
867 * The ID field should only be changed before entry is
868 * inserted into a cache. The ID value is backend
873 struct berval e_name; /* name (DN) of this entry */
874 struct berval e_nname; /* normalized name (DN) of this entry */
876 /* for migration purposes */
877 #define e_dn e_name.bv_val
878 #define e_ndn e_nname.bv_val
880 Attribute *e_attrs; /* list of attributes + values */
882 slap_mask_t e_ocflags;
884 struct berval e_bv; /* For entry_encode/entry_decode */
886 /* for use by the backend for any purpose */
893 typedef struct slap_mod {
895 AttributeDescription *sm_desc;
896 struct berval sm_type;
897 BerVarray sm_bvalues;
900 typedef struct slap_mod_list {
901 Modification sml_mod;
902 #define sml_op sml_mod.sm_op
903 #define sml_desc sml_mod.sm_desc
904 #define sml_type sml_mod.sm_type
905 #define sml_bvalues sml_mod.sm_bvalues
906 struct slap_mod_list *sml_next;
909 typedef struct slap_ldap_modlist {
911 struct slap_ldap_modlist *ml_next;
912 #define ml_op ml_mod.mod_op
913 #define ml_type ml_mod.mod_type
914 #define ml_values ml_mod.mod_values
915 #define ml_bvalues ml_mod.mod_bvalues
919 * represents an access control list
921 typedef enum slap_access_e {
922 ACL_INVALID_ACCESS = -1,
931 typedef enum slap_control_e {
932 ACL_INVALID_CONTROL = 0,
938 typedef enum slap_style_e {
946 /* alternate names */
947 ACL_STYLE_EXACT = ACL_STYLE_BASE
950 typedef struct slap_authz_info {
951 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
952 struct berval sai_mech; /* SASL Mechanism */
953 struct berval sai_dn; /* DN for reporting purposes */
954 struct berval sai_ndn; /* Normalized DN */
956 /* Security Strength Factors */
957 slap_ssf_t sai_ssf; /* Overall SSF */
958 slap_ssf_t sai_transport_ssf; /* Transport SSF */
959 slap_ssf_t sai_tls_ssf; /* TLS SSF */
960 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
961 } AuthorizationInformation;
964 typedef struct slap_access {
965 slap_control_t a_type;
967 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
969 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
970 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
971 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
972 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
973 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
974 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
976 #define ACL_PRIV_MASK 0x00ffUL
979 #define ACL_PRIV_LEVEL 0x1000UL
980 #define ACL_PRIV_ADDITIVE 0x2000UL
981 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
984 #define ACL_PRIV_INVALID 0x0UL
986 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
987 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
988 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
989 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
991 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
992 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
994 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
996 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
998 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
999 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1000 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1002 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1003 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1004 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1005 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1006 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1007 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1009 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1010 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1011 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1012 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1013 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1014 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1015 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1017 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1018 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1019 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1020 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1021 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1022 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1024 slap_mask_t a_access_mask;
1026 AuthorizationInformation a_authz;
1027 #define a_dn_pat a_authz.sai_dn
1029 slap_style_t a_dn_style;
1030 AttributeDescription *a_dn_at;
1034 slap_style_t a_peername_style;
1035 struct berval a_peername_pat;
1036 slap_style_t a_sockname_style;
1037 struct berval a_sockname_pat;
1039 slap_style_t a_domain_style;
1040 struct berval a_domain_pat;
1041 int a_domain_expand;
1043 slap_style_t a_sockurl_style;
1044 struct berval a_sockurl_pat;
1045 slap_style_t a_set_style;
1046 struct berval a_set_pat;
1048 #ifdef SLAPD_ACI_ENABLED
1049 AttributeDescription *a_aci_at;
1053 slap_style_t a_group_style;
1054 struct berval a_group_pat;
1055 ObjectClass *a_group_oc;
1056 AttributeDescription *a_group_at;
1058 struct slap_access *a_next;
1062 typedef struct slap_acl {
1063 /* "to" part: the entries this acl applies to */
1065 slap_style_t acl_dn_style;
1067 struct berval acl_dn_pat;
1068 AttributeName *acl_attrs;
1070 /* "by" part: list of who has what access to the entries */
1073 struct slap_acl *acl_next;
1076 typedef struct slap_acl_state {
1077 unsigned as_recorded;
1078 #define ACL_STATE_NOT_RECORDED 0x0
1079 #define ACL_STATE_RECORDED_VD 0x1
1080 #define ACL_STATE_RECORDED_NV 0x2
1081 #define ACL_STATE_RECORDED 0x3
1084 AccessControl *as_vd_acl;
1085 slap_mask_t as_vd_acl_mask;
1086 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1087 int as_vd_acl_count;
1089 Access *as_vd_access;
1090 int as_vd_access_count;
1093 } AccessControlState;
1094 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1097 * replog moddn param structure
1099 struct slap_replog_moddn {
1100 struct berval *newrdn;
1102 struct berval *newsup;
1107 * represents a backend
1110 typedef struct slap_backend_info BackendInfo; /* per backend type */
1111 typedef struct slap_backend_db BackendDB; /* per backend database */
1113 LDAP_SLAPD_V (int) nBackendInfo;
1114 LDAP_SLAPD_V (int) nBackendDB;
1115 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1116 LDAP_SLAPD_V (BackendDB *) backendDB;
1118 LDAP_SLAPD_V (int) slapMode;
1119 #define SLAP_UNDEFINED_MODE 0x0000
1120 #define SLAP_SERVER_MODE 0x0001
1121 #define SLAP_TOOL_MODE 0x0002
1122 #define SLAP_MODE 0x0003
1124 #define SLAP_TRUNCATE_MODE 0x0100
1126 struct slap_replica_info {
1127 char *ri_host; /* supersedes be_replica */
1128 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1129 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1130 int ri_exclude; /* 1 => exclude ri_attrs */
1133 struct slap_limits_set {
1141 int lms_s_unchecked;
1144 struct slap_limits {
1145 int lm_type; /* type of pattern */
1146 #define SLAP_LIMITS_UNDEFINED 0x0000
1147 #define SLAP_LIMITS_EXACT 0x0001
1148 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1149 #define SLAP_LIMITS_ONE 0x0002
1150 #define SLAP_LIMITS_SUBTREE 0x0003
1151 #define SLAP_LIMITS_CHILDREN 0x0004
1152 #define SLAP_LIMITS_REGEX 0x0005
1153 #define SLAP_LIMITS_ANONYMOUS 0x0006
1154 #define SLAP_LIMITS_USERS 0x0007
1155 #define SLAP_LIMITS_ANY 0x0008
1156 regex_t lm_dn_regex; /* regex data for REGEX */
1159 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1160 * pattern for REGEX; NULL for ANONYMOUS, USERS
1162 struct berval lm_dn_pat;
1164 struct slap_limits_set lm_limits;
1167 /* temporary aliases */
1168 typedef BackendDB Backend;
1169 #define nbackends nBackendDB
1170 #define backends backendDB
1172 struct slap_backend_db {
1173 BackendInfo *bd_info; /* pointer to shared backend info */
1175 /* BackendInfo accessors */
1176 #define be_config bd_info->bi_db_config
1177 #define be_type bd_info->bi_type
1179 #define be_bind bd_info->bi_op_bind
1180 #define be_unbind bd_info->bi_op_unbind
1181 #define be_add bd_info->bi_op_add
1182 #define be_compare bd_info->bi_op_compare
1183 #define be_delete bd_info->bi_op_delete
1184 #define be_modify bd_info->bi_op_modify
1185 #define be_modrdn bd_info->bi_op_modrdn
1186 #define be_search bd_info->bi_op_search
1188 #define be_extended bd_info->bi_extended
1190 #define be_release bd_info->bi_entry_release_rw
1191 #define be_chk_referrals bd_info->bi_chk_referrals
1192 #define be_group bd_info->bi_acl_group
1193 #define be_attribute bd_info->bi_acl_attribute
1194 #define be_operational bd_info->bi_operational
1196 #define be_controls bd_info->bi_controls
1198 #define be_connection_init bd_info->bi_connection_init
1199 #define be_connection_destroy bd_info->bi_connection_destroy
1202 #define be_entry_open bd_info->bi_tool_entry_open
1203 #define be_entry_close bd_info->bi_tool_entry_close
1204 #define be_entry_first bd_info->bi_tool_entry_first
1205 #define be_entry_next bd_info->bi_tool_entry_next
1206 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1207 #define be_entry_get bd_info->bi_tool_entry_get
1208 #define be_entry_put bd_info->bi_tool_entry_put
1209 #define be_sync bd_info->bi_tool_sync
1212 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1213 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1214 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1215 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1216 #define SLAP_BFLAG_ALIASES 0x0100U
1217 #define SLAP_BFLAG_REFERRALS 0x0200U
1218 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1219 #define SLAP_BFLAG_MONITOR 0x1000U
1220 #define SLAP_BFLAG_DYNAMIC 0x2000U
1221 slap_mask_t be_flags;
1222 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1223 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1224 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1225 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1226 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1227 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1229 slap_mask_t be_restrictops; /* restriction operations */
1230 #define SLAP_RESTRICT_OP_ADD 0x0001U
1231 #define SLAP_RESTRICT_OP_BIND 0x0002U
1232 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1233 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1234 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1235 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1236 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1237 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1239 #define SLAP_RESTRICT_OP_READS \
1240 ( SLAP_RESTRICT_OP_COMPARE \
1241 | SLAP_RESTRICT_OP_SEARCH )
1242 #define SLAP_RESTRICT_OP_WRITES \
1243 ( SLAP_RESTRICT_OP_ADD \
1244 | SLAP_RESTRICT_OP_DELETE \
1245 | SLAP_RESTRICT_OP_MODIFY \
1246 | SLAP_RESTRICT_OP_RENAME )
1248 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1249 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1250 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1252 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1253 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1254 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1255 0x0004U /* unprotected simple auth */
1256 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1258 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1259 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1261 slap_mask_t be_requires; /* pre-operation requirements */
1262 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1263 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1264 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1265 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1266 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1268 /* Required Security Strength Factor */
1269 slap_ssf_set_t be_ssf_set;
1271 /* these should be renamed from be_ to bd_ */
1272 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1273 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1274 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1275 #ifdef SLAPD_SCHEMA_DN
1276 struct berval be_schemadn; /* per-backend subschema subentry DN */
1277 struct berval be_schemandn; /* normalized subschema DN */
1279 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1280 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1281 struct berval be_rootpw; /* the magic "root" password for this db */
1282 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1283 #define be_sizelimit be_def_limit.lms_s_soft
1284 #define be_timelimit be_def_limit.lms_t_soft
1285 struct slap_limits_set be_def_limit; /* default limits */
1286 struct slap_limits **be_limits; /* regex-based size and time limits */
1287 AccessControl *be_acl; /* access control list for this backend */
1288 slap_access_t be_dfltaccess; /* access given if no acl matches */
1289 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1290 char *be_replogfile; /* replication log file (in master) */
1291 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1292 BerVarray be_update_refs; /* where to refer modifying clients to */
1294 void *be_private; /* anything the backend database needs */
1300 /* Backend function typedefs */
1301 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1302 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1303 const char *fname, int lineno,
1304 int argc, char **argv));
1305 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1306 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1307 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1309 typedef int (BI_db_init) LDAP_P((Backend *bd));
1310 typedef int (BI_db_config) LDAP_P((Backend *bd,
1311 const char *fname, int lineno,
1312 int argc, char **argv));
1313 typedef int (BI_db_open) LDAP_P((Backend *bd));
1314 typedef int (BI_db_close) LDAP_P((Backend *bd));
1315 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1317 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1318 struct slap_conn *c, struct slap_op *o,
1319 struct berval *dn, struct berval *ndn, int method,
1320 struct berval *cred, struct berval *edn ));
1321 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1322 struct slap_conn *c, struct slap_op *o ));
1323 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1324 struct slap_conn *c, struct slap_op *o,
1325 struct berval *base, struct berval *nbase,
1326 int scope, int deref,
1327 int slimit, int tlimit,
1328 Filter *f, struct berval *filterstr,
1329 AttributeName *attrs, int attrsonly));
1330 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1331 struct slap_conn *c, struct slap_op *o,
1332 struct berval *dn, struct berval *ndn,
1333 AttributeAssertion *ava));
1334 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1335 struct slap_conn *c, struct slap_op *o,
1336 struct berval *dn, struct berval *ndn,
1338 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1339 struct slap_conn *c, struct slap_op *o,
1340 struct berval *dn, struct berval *ndn,
1341 struct berval *newrdn, struct berval *nnewrdn,
1343 struct berval *newSup, struct berval *nnewSup ));
1344 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1345 struct slap_conn *c, struct slap_op *o,
1347 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1348 struct slap_conn *c, struct slap_op *o,
1349 struct berval *dn, struct berval *ndn));
1350 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1351 struct slap_conn *c, struct slap_op *o,
1354 typedef int (BI_op_extended) LDAP_P((
1356 struct slap_conn *conn,
1359 struct berval * reqdata,
1361 struct berval ** rspdata,
1362 LDAPControl *** rspctrls,
1366 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1367 struct slap_conn *c, struct slap_op *o,
1370 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1371 struct slap_conn *c, struct slap_op *o,
1372 struct berval *dn, struct berval *ndn,
1373 const char **text ));
1375 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1376 struct slap_conn *c, struct slap_op *o,
1380 ObjectClass *group_oc,
1381 AttributeDescription *group_at ));
1383 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1384 struct slap_conn *c, struct slap_op *o,
1385 Entry *e, struct berval *edn,
1386 AttributeDescription *entry_at,
1389 typedef int (BI_operational) LDAP_P((Backend *bd,
1390 struct slap_conn *c, struct slap_op *o,
1391 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1393 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1394 struct slap_conn *c));
1395 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1396 struct slap_conn *c));
1398 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1399 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1400 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1401 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1402 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1403 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1404 struct berval *text ));
1405 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1406 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1408 struct slap_backend_info {
1409 char *bi_type; /* type of backend */
1412 * per backend type routines:
1413 * bi_init: called to allocate a backend_info structure,
1414 * called once BEFORE configuration file is read.
1415 * bi_init() initializes this structure hence is
1416 * called directly from be_initialize()
1417 * bi_config: called per 'backend' specific option
1418 * all such options must before any 'database' options
1419 * bi_config() is called only from read_config()
1420 * bi_open: called to open each database, called
1421 * once AFTER configuration file is read but
1422 * BEFORE any bi_db_open() calls.
1423 * bi_open() is called from backend_startup()
1424 * bi_close: called to close each database, called
1425 * once during shutdown after all bi_db_close calls.
1426 * bi_close() is called from backend_shutdown()
1427 * bi_destroy: called to destroy each database, called
1428 * once during shutdown after all bi_db_destroy calls.
1429 * bi_destory() is called from backend_destroy()
1432 BI_config *bi_config;
1435 BI_destroy *bi_destroy;
1438 * per database routines:
1439 * bi_db_init: called to initialize each database,
1440 * called upon reading 'database <type>'
1441 * called only from backend_db_init()
1442 * bi_db_config: called to configure each database,
1443 * called per database to handle per database options
1444 * called only from read_config()
1445 * bi_db_open: called to open each database
1446 * called once per database immediately AFTER bi_open()
1447 * calls but before daemon startup.
1448 * called only by backend_startup()
1449 * bi_db_close: called to close each database
1450 * called once per database during shutdown but BEFORE
1451 * any bi_close call.
1452 * called only by backend_shutdown()
1453 * bi_db_destroy: called to destroy each database
1454 * called once per database during shutdown AFTER all
1455 * bi_close calls but before bi_destory calls.
1456 * called only by backend_destory()
1458 BI_db_init *bi_db_init;
1459 BI_db_config *bi_db_config;
1460 BI_db_open *bi_db_open;
1461 BI_db_close *bi_db_close;
1462 BI_db_destroy *bi_db_destroy;
1464 /* LDAP Operations Handling Routines */
1465 BI_op_bind *bi_op_bind;
1466 BI_op_unbind *bi_op_unbind;
1467 BI_op_search *bi_op_search;
1468 BI_op_compare *bi_op_compare;
1469 BI_op_modify *bi_op_modify;
1470 BI_op_modrdn *bi_op_modrdn;
1471 BI_op_add *bi_op_add;
1472 BI_op_delete *bi_op_delete;
1473 BI_op_abandon *bi_op_abandon;
1475 /* Extended Operations Helper */
1476 BI_op_extended *bi_extended;
1478 /* Auxilary Functions */
1479 BI_entry_release_rw *bi_entry_release_rw;
1480 BI_chk_referrals *bi_chk_referrals;
1482 BI_acl_group *bi_acl_group;
1483 BI_acl_attribute *bi_acl_attribute;
1485 BI_operational *bi_operational;
1487 BI_connection_init *bi_connection_init;
1488 BI_connection_destroy *bi_connection_destroy;
1490 /* hooks for slap tools */
1491 BI_tool_entry_open *bi_tool_entry_open;
1492 BI_tool_entry_close *bi_tool_entry_close;
1493 BI_tool_entry_first *bi_tool_entry_first;
1494 BI_tool_entry_next *bi_tool_entry_next;
1495 BI_tool_entry_get *bi_tool_entry_get;
1496 BI_tool_entry_put *bi_tool_entry_put;
1497 BI_tool_entry_reindex *bi_tool_entry_reindex;
1498 BI_tool_sync *bi_tool_sync;
1500 #define SLAP_INDEX_ADD_OP 0x0001
1501 #define SLAP_INDEX_DELETE_OP 0x0002
1503 char **bi_controls; /* supported controls */
1505 unsigned int bi_nDB; /* number of databases of this type */
1506 void *bi_private; /* anything the backend type needs */
1509 #define c_authtype c_authz.sai_method
1510 #define c_authmech c_authz.sai_mech
1511 #define c_dn c_authz.sai_dn
1512 #define c_ndn c_authz.sai_ndn
1513 #define c_ssf c_authz.sai_ssf
1514 #define c_transport_ssf c_authz.sai_transport_ssf
1515 #define c_tls_ssf c_authz.sai_tls_ssf
1516 #define c_sasl_ssf c_authz.sai_sasl_ssf
1518 #define o_authtype o_authz.sai_method
1519 #define o_authmech o_authz.sai_mech
1520 #define o_dn o_authz.sai_dn
1521 #define o_ndn o_authz.sai_ndn
1522 #define o_ssf o_authz.sai_ssf
1523 #define o_transport_ssf o_authz.sai_transport_ssf
1524 #define o_tls_ssf o_authz.sai_tls_ssf
1525 #define o_sasl_ssf o_authz.sai_sasl_ssf
1527 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1528 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1529 BerVarray, const char *, struct berval *,
1530 struct berval *, LDAPControl ** );
1532 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1533 ber_int_t, const char *, const char *, BerVarray,
1534 LDAPControl **, int nentries);
1536 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1537 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1539 typedef struct slap_callback {
1540 slap_response *sc_response;
1541 slap_sresult *sc_sresult;
1542 slap_sendentry *sc_sendentry;
1547 * Paged Results state
1549 typedef unsigned long PagedResultsCookie;
1550 typedef struct slap_paged_state {
1552 PagedResultsCookie ps_cookie;
1554 } PagedResultsState;
1557 * represents an operation pending from an ldap client
1559 typedef struct slap_op {
1560 unsigned long o_opid; /* id of this operation */
1561 unsigned long o_connid; /* id of conn initiating this op */
1562 struct slap_conn *o_conn; /* connection spawning this op */
1564 ber_int_t o_msgid; /* msgid of the request */
1565 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1566 ber_tag_t o_tag; /* tag of the request */
1567 time_t o_time; /* time op was initiated */
1569 ldap_pvt_thread_t o_tid; /* thread handling this op */
1571 volatile sig_atomic_t o_abandon; /* abandon flag */
1573 char o_do_not_cache; /* don't cache from this op */
1575 #define SLAP_NO_CONTROL 0
1576 #define SLAP_NONCRITICAL_CONTROL 1
1577 #define SLAP_CRITICAL_CONTROL 2
1581 char o_subentries_visibility;
1582 char o_valuesreturnfilter;
1584 char o_pagedresults;
1585 ber_int_t o_pagedresults_size;
1586 PagedResultsState o_pagedresults_state;
1588 #ifdef LDAP_CONNECTIONLESS
1589 Sockaddr o_peeraddr; /* UDP peer address */
1591 AuthorizationInformation o_authz;
1593 BerElement *o_ber; /* ber of the request */
1594 slap_callback *o_callback; /* callback pointers */
1595 LDAPControl **o_ctrls; /* controls */
1597 void *o_threadctx; /* thread pool thread context */
1598 void *o_private; /* anything the backend needs */
1600 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1601 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1604 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1605 #define get_subentries(op) ((int)(op)->o_subentries)
1606 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1609 * Caches the result of a backend_group check for ACL evaluation
1611 typedef struct slap_gacl {
1612 struct slap_gacl *ga_next;
1615 AttributeDescription *ga_at;
1622 * represents a connection from an ldap client
1624 typedef struct slap_conn {
1625 int c_struct_state; /* structure management state */
1626 int c_conn_state; /* connection state */
1628 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1629 Sockbuf *c_sb; /* ber connection stuff */
1631 /* only can be changed by connect_init */
1632 time_t c_starttime; /* when the connection was opened */
1633 time_t c_activitytime; /* when the connection was last used */
1634 unsigned long c_connid; /* id of this connection for stats*/
1636 struct berval c_listener_url; /* listener URL */
1637 struct berval c_peer_domain; /* DNS name of client */
1638 struct berval c_peer_name; /* peer name (trans=addr:port) */
1639 struct berval c_sock_name; /* sock name (trans=addr:port) */
1641 /* only can be changed by binding thread */
1642 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1643 struct berval c_sasl_bind_mech; /* mech in progress */
1644 struct berval c_sasl_dn; /* temporary storage */
1646 /* authorization backend */
1647 Backend *c_authz_backend;
1649 AuthorizationInformation c_authz;
1650 GroupAssertion *c_groups;
1652 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1654 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1655 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1657 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1658 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1660 BerElement *c_currentber; /* ber we're attempting to read */
1661 int c_writewaiter; /* true if writer is waiting */
1663 #ifdef LDAP_CONNECTIONLESS
1664 int c_is_udp; /* true if this is (C)LDAP over UDP */
1667 int c_is_tls; /* true if this LDAP over raw TLS */
1668 int c_needs_tls_accept; /* true if SSL_accept should be called */
1670 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1671 void *c_sasl_context; /* SASL session context */
1672 void *c_sasl_extra; /* SASL session extra stuff */
1673 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1675 PagedResultsState c_pagedresults_state; /* paged result state */
1677 long c_n_ops_received; /* num of ops received (next op_id) */
1678 long c_n_ops_executing; /* num of ops currently executing */
1679 long c_n_ops_pending; /* num of ops pending execution */
1680 long c_n_ops_completed; /* num of ops completed */
1682 long c_n_get; /* num of get calls */
1683 long c_n_read; /* num of read calls */
1684 long c_n_write; /* num of write calls */
1687 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1688 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1690 if ( ldap_debug & (level) ) \
1691 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1692 if ( ldap_syslog & (level) ) \
1693 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1697 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1701 * listener; need to access it from monitor backend
1703 typedef struct slap_listener {
1709 #ifdef LDAP_CONNECTIONLESS
1710 int sl_is_udp; /* UDP listener is also data port */
1714 #define sl_addr sl_sa.sa_in_addr
1717 #ifdef SLAPD_MONITOR
1734 #endif /* SLAPD_MONITOR */
1737 * Better know these all around slapd
1739 #define SLAP_LDAPDN_PRETTY 0x1
1740 #define SLAP_LDAPDN_MAXLEN 8192
1744 #include "proto-slap.h"
1746 #endif /* _SLAP_H_ */