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_storage sa_storage;
252 struct sockaddr_in6 sa_in6_addr;
255 struct sockaddr_un sa_un_addr;
260 extern int slap_inet4or6;
263 typedef struct slap_oid_macro {
264 struct berval som_oid;
266 struct slap_oid_macro *som_next;
269 /* forward declarations */
271 struct slap_matching_rule;
273 typedef int slap_syntax_validate_func LDAP_P((
274 struct slap_syntax *syntax,
275 struct berval * in));
277 typedef int slap_syntax_transform_func LDAP_P((
278 struct slap_syntax *syntax,
280 struct berval * out));
282 typedef struct slap_syntax {
284 #define ssyn_oid ssyn_syn.syn_oid
285 #define ssyn_desc ssyn_syn.syn_desc
286 #define ssyn_extensions ssyn_syn.syn_extensions
289 ber_len_t ssyn_oidlen;
290 * has been replaced by a struct berval that uses the value
291 * provided by ssyn_syn.syn_oid; a macro that expands to
292 * the bv_len field of the berval is provided for backward
293 * compatibility. CAUTION: NEVER FREE THE BERVAL
295 struct berval ssyn_bvoid;
296 #define ssyn_oidlen ssyn_bvoid.bv_len
298 unsigned int ssyn_flags;
300 #define SLAP_SYNTAX_NONE 0x0000U
301 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
302 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
303 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
304 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
306 slap_syntax_validate_func *ssyn_validate;
307 slap_syntax_transform_func *ssyn_normalize;
308 slap_syntax_transform_func *ssyn_pretty;
310 #ifdef SLAPD_BINARY_CONVERSION
311 /* convert to and from binary */
312 slap_syntax_transform_func *ssyn_ber2str;
313 slap_syntax_transform_func *ssyn_str2ber;
316 struct slap_syntax *ssyn_next;
319 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
320 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
321 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
322 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
323 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
325 typedef struct slap_syntax_defs_rec {
328 slap_syntax_validate_func *sd_validate;
329 slap_syntax_transform_func *sd_normalize;
330 slap_syntax_transform_func *sd_pretty;
331 #ifdef SLAPD_BINARY_CONVERSION
332 slap_syntax_transform_func *sd_ber2str;
333 slap_syntax_transform_func *sd_str2ber;
335 } slap_syntax_defs_rec;
337 /* X -> Y Converter */
338 typedef int slap_mr_convert_func LDAP_P((
340 struct berval * out ));
343 typedef int slap_mr_normalize_func LDAP_P((
345 struct slap_syntax *syntax, /* NULL if in is asserted value */
346 struct slap_matching_rule *mr,
348 struct berval * out ));
350 /* Match (compare) function */
351 typedef int slap_mr_match_func LDAP_P((
354 struct slap_syntax *syntax, /* syntax of stored value */
355 struct slap_matching_rule *mr,
356 struct berval * value,
357 void * assertValue ));
359 /* Index generation function */
360 typedef int slap_mr_indexer_func LDAP_P((
363 struct slap_syntax *syntax, /* syntax of stored value */
364 struct slap_matching_rule *mr,
365 struct berval *prefix,
369 /* Filter index function */
370 typedef int slap_mr_filter_func LDAP_P((
373 struct slap_syntax *syntax, /* syntax of stored value */
374 struct slap_matching_rule *mr,
375 struct berval *prefix,
379 typedef struct slap_matching_rule_use MatchingRuleUse;
381 typedef struct slap_matching_rule {
382 LDAPMatchingRule smr_mrule;
383 MatchingRuleUse *smr_mru;
384 /* RFC2252 string representation */
385 struct berval smr_str;
388 ber_len_t smr_oidlen;
389 * has been replaced by a struct berval that uses the value
390 * provided by smr_mrule.mr_oid; a macro that expands to
391 * the bv_len field of the berval is provided for backward
392 * compatibility. CAUTION: NEVER FREE THE BERVAL
394 struct berval smr_bvoid;
395 #define smr_oidlen smr_bvoid.bv_len
397 slap_mask_t smr_usage;
399 #define SLAP_MR_HIDE 0x8000U
401 #define SLAP_MR_TYPE_MASK 0x0F00U
402 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
403 #define SLAP_MR_USAGE 0x000FU
405 #define SLAP_MR_NONE 0x0000U
406 #define SLAP_MR_EQUALITY 0x0100U
407 #define SLAP_MR_ORDERING 0x0200U
408 #define SLAP_MR_SUBSTR 0x0400U
409 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
411 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
412 #define SLAP_MR_DN_FOLD 0x0008U
414 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
415 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
416 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
419 * normally the provided value is expected to conform to
420 * assertion syntax specified in the matching rule, however
421 * at times (such as during individual value modification),
422 * the provided value is expected to conform to the
423 * attribute's value syntax.
425 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
426 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
427 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
429 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
430 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
431 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
432 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
434 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
435 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
436 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
437 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
438 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
439 == SLAP_MR_VALUE_SYNTAX_MATCH)
442 slap_mr_convert_func *smr_convert;
443 slap_mr_normalize_func *smr_normalize;
444 slap_mr_match_func *smr_match;
445 slap_mr_indexer_func *smr_indexer;
446 slap_mr_filter_func *smr_filter;
449 * null terminated list of syntaxes compatible with this syntax
450 * note: when MS_EXT is set, this MUST NOT contain the assertion
451 * syntax of the rule. When MS_EXT is not set, it MAY.
453 Syntax **smr_compat_syntaxes;
455 struct slap_matching_rule *smr_associated;
456 struct slap_matching_rule *smr_next;
458 #define smr_oid smr_mrule.mr_oid
459 #define smr_names smr_mrule.mr_names
460 #define smr_desc smr_mrule.mr_desc
461 #define smr_obsolete smr_mrule.mr_obsolete
462 #define smr_syntax_oid smr_mrule.mr_syntax_oid
463 #define smr_extensions smr_mrule.mr_extensions
466 struct slap_matching_rule_use {
467 LDAPMatchingRuleUse smru_mruleuse;
468 MatchingRule *smru_mr;
469 /* RFC2252 string representation */
470 struct berval smru_str;
472 struct slap_matching_rule_use *smru_next;
474 #define smru_oid smru_mruleuse.mru_oid
475 #define smru_names smru_mruleuse.mru_names
476 #define smru_desc smru_mruleuse.mru_desc
477 #define smru_obsolete smru_mruleuse.mru_obsolete
478 #define smru_applies_oids smru_mruleuse.mru_applies_oids
480 #define smru_usage smru_mr->smr_usage
481 } /* MatchingRuleUse */ ;
483 typedef struct slap_mrule_defs_rec {
485 slap_mask_t mrd_usage;
486 char ** mrd_compat_syntaxes;
487 slap_mr_convert_func * mrd_convert;
488 slap_mr_normalize_func * mrd_normalize;
489 slap_mr_match_func * mrd_match;
490 slap_mr_indexer_func * mrd_indexer;
491 slap_mr_filter_func * mrd_filter;
493 char * mrd_associated;
494 } slap_mrule_defs_rec;
496 struct slap_backend_db;
500 typedef int (AttributeTypeSchemaCheckFN)(
501 struct slap_backend_db *be,
502 struct slap_entry *e,
503 struct slap_attr *attr,
505 char *textbuf, size_t textlen );
507 typedef struct slap_attribute_type {
508 LDAPAttributeType sat_atype;
509 struct berval sat_cname;
510 struct slap_attribute_type *sat_sup;
511 struct slap_attribute_type **sat_subtypes;
512 MatchingRule *sat_equality;
513 MatchingRule *sat_approx;
514 MatchingRule *sat_ordering;
515 MatchingRule *sat_substr;
518 AttributeTypeSchemaCheckFN *sat_check;
520 #define SLAP_AT_NONE 0x0000U
521 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
522 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
523 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
524 slap_mask_t sat_flags;
526 struct slap_attribute_type *sat_next;
528 #define sat_oid sat_atype.at_oid
529 #define sat_names sat_atype.at_names
530 #define sat_desc sat_atype.at_desc
531 #define sat_obsolete sat_atype.at_obsolete
532 #define sat_sup_oid sat_atype.at_sup_oid
533 #define sat_equality_oid sat_atype.at_equality_oid
534 #define sat_ordering_oid sat_atype.at_ordering_oid
535 #define sat_substr_oid sat_atype.at_substr_oid
536 #define sat_syntax_oid sat_atype.at_syntax_oid
537 #define sat_single_value sat_atype.at_single_value
538 #define sat_collective sat_atype.at_collective
539 #define sat_no_user_mod sat_atype.at_no_user_mod
540 #define sat_usage sat_atype.at_usage
541 #define sat_extensions sat_atype.at_extensions
543 struct slap_attr_desc *sat_ad;
544 ldap_pvt_thread_mutex_t sat_ad_mutex;
547 #define is_at_operational(at) ((at)->sat_usage)
548 #define is_at_single_value(at) ((at)->sat_single_value)
549 #define is_at_collective(at) ((at)->sat_collective)
550 #define is_at_obsolete(at) ((at)->sat_obsolete)
551 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
553 struct slap_object_class;
555 typedef int (ObjectClassSchemaCheckFN)(
556 struct slap_backend_db *be,
557 struct slap_entry *e,
558 struct slap_object_class *oc,
560 char *textbuf, size_t textlen );
562 typedef struct slap_object_class {
563 LDAPObjectClass soc_oclass;
564 struct berval soc_cname;
565 struct slap_object_class **soc_sups;
566 AttributeType **soc_required;
567 AttributeType **soc_allowed;
568 ObjectClassSchemaCheckFN *soc_check;
569 slap_mask_t soc_flags;
570 #define soc_oid soc_oclass.oc_oid
571 #define soc_names soc_oclass.oc_names
572 #define soc_desc soc_oclass.oc_desc
573 #define soc_obsolete soc_oclass.oc_obsolete
574 #define soc_sup_oids soc_oclass.oc_sup_oids
575 #define soc_kind soc_oclass.oc_kind
576 #define soc_at_oids_must soc_oclass.oc_at_oids_must
577 #define soc_at_oids_may soc_oclass.oc_at_oids_may
578 #define soc_extensions soc_oclass.oc_extensions
580 struct slap_object_class *soc_next;
583 #define SLAP_OC_ALIAS 0x0001
584 #define SLAP_OC_REFERRAL 0x0002
585 #define SLAP_OC_SUBENTRY 0x0004
586 #define SLAP_OC_DYNAMICOBJECT 0x0008
587 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
588 #define SLAP_OC__MASK 0x001F
589 #define SLAP_OC__END 0x0020
590 #define SLAP_OC_OPERATIONAL 0x4000
591 #define SLAP_OC_HIDE 0x8000
593 #ifdef LDAP_EXTENDED_SCHEMA
597 typedef struct slap_content_rule {
598 LDAPContentRule scr_crule;
599 ObjectClass *scr_sclass;
600 ObjectClass **scr_auxiliaries; /* optional */
601 AttributeType **scr_required; /* optional */
602 AttributeType **scr_allowed; /* optional */
603 AttributeType **scr_precluded; /* optional */
604 #define scr_oid scr_crule.cr_oid
605 #define scr_names scr_crule.cr_names
606 #define scr_desc scr_crule.cr_desc
607 #define scr_obsolete soc_oclass.cr_obsolete
608 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
609 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
610 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
611 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
616 * represents a recognized attribute description ( type + options )
618 typedef struct slap_attr_desc {
619 struct slap_attr_desc *ad_next;
620 AttributeType *ad_type; /* attribute type, must be specified */
621 struct berval ad_cname; /* canonical name, must be specified */
622 struct berval ad_lang; /* empty if no language tags */
624 #define SLAP_DESC_NONE 0x00U
625 #define SLAP_DESC_BINARY 0x01U
626 #define SLAP_DESC_LANG_RANGE 0x80U
627 } AttributeDescription;
629 typedef struct slap_attr_name {
630 struct berval an_name;
631 AttributeDescription *an_desc;
635 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
636 #define slap_ad_is_lang_range(ad) \
637 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
638 #define slap_ad_is_binary(ad) \
639 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
642 * pointers to schema elements used internally
644 struct slap_internal_schema {
646 ObjectClass *si_oc_top;
647 ObjectClass *si_oc_extensibleObject;
648 ObjectClass *si_oc_alias;
649 ObjectClass *si_oc_referral;
650 ObjectClass *si_oc_rootdse;
651 ObjectClass *si_oc_subentry;
652 ObjectClass *si_oc_subschema;
653 ObjectClass *si_oc_monitor;
654 ObjectClass *si_oc_collectiveAttributeSubentry;
655 ObjectClass *si_oc_dynamicObject;
657 /* objectClass attribute descriptions */
658 AttributeDescription *si_ad_objectClass;
660 /* operational attribute descriptions */
661 AttributeDescription *si_ad_structuralObjectClass;
662 AttributeDescription *si_ad_creatorsName;
663 AttributeDescription *si_ad_createTimestamp;
664 AttributeDescription *si_ad_modifiersName;
665 AttributeDescription *si_ad_modifyTimestamp;
666 AttributeDescription *si_ad_hasSubordinates;
667 AttributeDescription *si_ad_subschemaSubentry;
668 AttributeDescription *si_ad_collectiveSubentries;
669 AttributeDescription *si_ad_collectiveExclusions;
670 AttributeDescription *si_ad_entryUUID;
671 AttributeDescription *si_ad_entryCSN;
673 /* root DSE attribute descriptions */
674 AttributeDescription *si_ad_altServer;
675 AttributeDescription *si_ad_namingContexts;
676 AttributeDescription *si_ad_supportedControl;
677 AttributeDescription *si_ad_supportedExtension;
678 AttributeDescription *si_ad_supportedLDAPVersion;
679 AttributeDescription *si_ad_supportedSASLMechanisms;
680 AttributeDescription *si_ad_supportedFeatures;
681 AttributeDescription *si_ad_monitorContext;
682 AttributeDescription *si_ad_vendorName;
683 AttributeDescription *si_ad_vendorVersion;
685 /* subentry attribute descriptions */
686 AttributeDescription *si_ad_administrativeRole;
687 AttributeDescription *si_ad_subtreeSpecification;
689 /* subschema subentry attribute descriptions */
690 AttributeDescription *si_ad_ditStructureRules;
691 AttributeDescription *si_ad_ditContentRules;
692 AttributeDescription *si_ad_nameForms;
693 AttributeDescription *si_ad_objectClasses;
694 AttributeDescription *si_ad_attributeTypes;
695 AttributeDescription *si_ad_ldapSyntaxes;
696 AttributeDescription *si_ad_matchingRules;
697 AttributeDescription *si_ad_matchingRuleUse;
699 /* Aliases & Referrals */
700 AttributeDescription *si_ad_aliasedObjectName;
701 AttributeDescription *si_ad_ref;
703 /* Access Control Internals */
704 AttributeDescription *si_ad_entry;
705 AttributeDescription *si_ad_children;
706 AttributeDescription *si_ad_saslAuthzTo;
707 AttributeDescription *si_ad_saslAuthzFrom;
708 #ifdef SLAPD_ACI_ENABLED
709 AttributeDescription *si_ad_aci;
712 /* dynamic entries */
713 AttributeDescription *si_ad_entryTtl;
714 AttributeDescription *si_ad_dynamicSubtrees;
716 /* Other attributes descriptions */
717 AttributeDescription *si_ad_distinguishedName;
718 AttributeDescription *si_ad_name;
719 AttributeDescription *si_ad_cn;
720 AttributeDescription *si_ad_userPassword;
721 #ifdef SLAPD_AUTHPASSWD
722 AttributeDescription *si_ad_authPassword;
724 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
725 AttributeDescription *si_ad_krbName;
728 /* Undefined Attribute Type */
729 AttributeType *si_at_undefined;
732 MatchingRule *si_mr_distinguishedNameMatch;
733 MatchingRule *si_mr_integerMatch;
736 Syntax *si_syn_octetString;
737 Syntax *si_syn_distinguishedName;
738 Syntax *si_syn_integer;
741 typedef struct slap_attr_assertion {
742 AttributeDescription *aa_desc;
743 struct berval aa_value;
744 } AttributeAssertion;
746 typedef struct slap_ss_assertion {
747 AttributeDescription *sa_desc;
748 struct berval sa_initial;
749 struct berval *sa_any;
750 struct berval sa_final;
751 } SubstringsAssertion;
753 typedef struct slap_mr_assertion {
754 MatchingRule *ma_rule; /* optional */
755 struct berval ma_rule_text; /* optional */
756 AttributeDescription *ma_desc; /* optional */
757 int ma_dnattrs; /* boolean */
758 struct berval ma_value; /* required */
759 } MatchingRuleAssertion;
762 * represents a search filter
764 typedef struct slap_filter {
765 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
766 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
767 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
768 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
771 /* precomputed result */
772 ber_int_t f_un_result;
775 struct berval *f_un_dn;
778 AttributeDescription *f_un_desc;
780 /* simple value assertion */
781 AttributeAssertion *f_un_ava;
783 /* substring assertion */
784 SubstringsAssertion *f_un_ssa;
786 /* matching rule assertion */
787 MatchingRuleAssertion *f_un_mra;
789 #define f_dn f_un.f_un_dn
790 #define f_desc f_un.f_un_desc
791 #define f_ava f_un.f_un_ava
792 #define f_av_desc f_un.f_un_ava->aa_desc
793 #define f_av_value f_un.f_un_ava->aa_value
794 #define f_sub f_un.f_un_ssa
795 #define f_sub_desc f_un.f_un_ssa->sa_desc
796 #define f_sub_initial f_un.f_un_ssa->sa_initial
797 #define f_sub_any f_un.f_un_ssa->sa_any
798 #define f_sub_final f_un.f_un_ssa->sa_final
799 #define f_mra f_un.f_un_mra
800 #define f_mr_rule f_un.f_un_mra->ma_rule
801 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
802 #define f_mr_desc f_un.f_un_mra->ma_desc
803 #define f_mr_value f_un.f_un_mra->ma_value
804 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
807 struct slap_filter *f_un_complex;
810 #define f_result f_un.f_un_result
811 #define f_and f_un.f_un_complex
812 #define f_or f_un.f_un_complex
813 #define f_not f_un.f_un_complex
814 #define f_list f_un.f_un_complex
816 struct slap_filter *f_next;
819 /* compare routines can return undefined */
820 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
822 typedef struct slap_valuesreturnfilter {
826 /* precomputed result */
827 ber_int_t f_un_result;
833 AttributeDescription *f_un_desc;
835 /* simple value assertion */
836 AttributeAssertion *f_un_ava;
838 /* substring assertion */
839 SubstringsAssertion *f_un_ssa;
841 /* matching rule assertion */
842 MatchingRuleAssertion *f_un_mra;
845 struct slap_valuesreturnfilter *f_next;
846 } ValuesReturnFilter;
849 * represents an attribute (description + values)
851 typedef struct slap_attr {
852 AttributeDescription *a_desc;
854 struct slap_attr *a_next;
856 #define SLAP_ATTR_IXADD 0x1U
857 #define SLAP_ATTR_IXDEL 0x2U
862 * the id used in the indexes to refer to an entry
864 typedef unsigned long ID;
865 #define NOID ((ID)~0)
868 * represents an entry in core
870 typedef struct slap_entry {
872 * The ID field should only be changed before entry is
873 * inserted into a cache. The ID value is backend
878 struct berval e_name; /* name (DN) of this entry */
879 struct berval e_nname; /* normalized name (DN) of this entry */
881 /* for migration purposes */
882 #define e_dn e_name.bv_val
883 #define e_ndn e_nname.bv_val
885 Attribute *e_attrs; /* list of attributes + values */
887 slap_mask_t e_ocflags;
889 struct berval e_bv; /* For entry_encode/entry_decode */
891 /* for use by the backend for any purpose */
898 typedef struct slap_mod {
900 AttributeDescription *sm_desc;
901 struct berval sm_type;
902 BerVarray sm_bvalues;
905 typedef struct slap_mod_list {
906 Modification sml_mod;
907 #define sml_op sml_mod.sm_op
908 #define sml_desc sml_mod.sm_desc
909 #define sml_type sml_mod.sm_type
910 #define sml_bvalues sml_mod.sm_bvalues
911 struct slap_mod_list *sml_next;
914 typedef struct slap_ldap_modlist {
916 struct slap_ldap_modlist *ml_next;
917 #define ml_op ml_mod.mod_op
918 #define ml_type ml_mod.mod_type
919 #define ml_values ml_mod.mod_values
920 #define ml_bvalues ml_mod.mod_bvalues
924 * represents an access control list
926 typedef enum slap_access_e {
927 ACL_INVALID_ACCESS = -1,
936 typedef enum slap_control_e {
937 ACL_INVALID_CONTROL = 0,
943 typedef enum slap_style_e {
951 /* alternate names */
952 ACL_STYLE_EXACT = ACL_STYLE_BASE
955 typedef struct slap_authz_info {
956 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
957 struct berval sai_mech; /* SASL Mechanism */
958 struct berval sai_dn; /* DN for reporting purposes */
959 struct berval sai_ndn; /* Normalized DN */
961 /* Security Strength Factors */
962 slap_ssf_t sai_ssf; /* Overall SSF */
963 slap_ssf_t sai_transport_ssf; /* Transport SSF */
964 slap_ssf_t sai_tls_ssf; /* TLS SSF */
965 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
966 } AuthorizationInformation;
969 typedef struct slap_access {
970 slap_control_t a_type;
972 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
974 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
975 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
976 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
977 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
978 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
979 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
981 #define ACL_PRIV_MASK 0x00ffUL
984 #define ACL_PRIV_LEVEL 0x1000UL
985 #define ACL_PRIV_ADDITIVE 0x2000UL
986 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
989 #define ACL_PRIV_INVALID 0x0UL
991 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
992 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
993 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
994 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
996 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
997 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
999 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1001 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1003 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1004 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1005 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1007 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1008 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1009 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1010 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1011 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1012 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1014 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1015 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1016 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1017 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1018 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1019 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1020 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1022 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1023 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1024 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1025 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1026 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1027 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1029 slap_mask_t a_access_mask;
1031 AuthorizationInformation a_authz;
1032 #define a_dn_pat a_authz.sai_dn
1034 slap_style_t a_dn_style;
1035 AttributeDescription *a_dn_at;
1039 slap_style_t a_peername_style;
1040 struct berval a_peername_pat;
1041 slap_style_t a_sockname_style;
1042 struct berval a_sockname_pat;
1044 slap_style_t a_domain_style;
1045 struct berval a_domain_pat;
1046 int a_domain_expand;
1048 slap_style_t a_sockurl_style;
1049 struct berval a_sockurl_pat;
1050 slap_style_t a_set_style;
1051 struct berval a_set_pat;
1053 #ifdef SLAPD_ACI_ENABLED
1054 AttributeDescription *a_aci_at;
1058 slap_style_t a_group_style;
1059 struct berval a_group_pat;
1060 ObjectClass *a_group_oc;
1061 AttributeDescription *a_group_at;
1063 struct slap_access *a_next;
1067 typedef struct slap_acl {
1068 /* "to" part: the entries this acl applies to */
1070 slap_style_t acl_dn_style;
1072 struct berval acl_dn_pat;
1073 AttributeName *acl_attrs;
1075 /* "by" part: list of who has what access to the entries */
1078 struct slap_acl *acl_next;
1081 typedef struct slap_acl_state {
1082 unsigned as_recorded;
1083 #define ACL_STATE_NOT_RECORDED 0x0
1084 #define ACL_STATE_RECORDED_VD 0x1
1085 #define ACL_STATE_RECORDED_NV 0x2
1086 #define ACL_STATE_RECORDED 0x3
1089 AccessControl *as_vd_acl;
1090 slap_mask_t as_vd_acl_mask;
1091 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1092 int as_vd_acl_count;
1094 Access *as_vd_access;
1095 int as_vd_access_count;
1098 } AccessControlState;
1099 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1102 * replog moddn param structure
1104 struct slap_replog_moddn {
1105 struct berval *newrdn;
1107 struct berval *newsup;
1112 * represents a backend
1115 typedef struct slap_backend_info BackendInfo; /* per backend type */
1116 typedef struct slap_backend_db BackendDB; /* per backend database */
1118 LDAP_SLAPD_V (int) nBackendInfo;
1119 LDAP_SLAPD_V (int) nBackendDB;
1120 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1121 LDAP_SLAPD_V (BackendDB *) backendDB;
1123 LDAP_SLAPD_V (int) slapMode;
1124 #define SLAP_UNDEFINED_MODE 0x0000
1125 #define SLAP_SERVER_MODE 0x0001
1126 #define SLAP_TOOL_MODE 0x0002
1127 #define SLAP_MODE 0x0003
1129 #define SLAP_TRUNCATE_MODE 0x0100
1131 struct slap_replica_info {
1132 char *ri_host; /* supersedes be_replica */
1133 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1134 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1135 int ri_exclude; /* 1 => exclude ri_attrs */
1138 struct slap_limits_set {
1146 int lms_s_unchecked;
1149 struct slap_limits {
1150 int lm_type; /* type of pattern */
1151 #define SLAP_LIMITS_UNDEFINED 0x0000
1152 #define SLAP_LIMITS_EXACT 0x0001
1153 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1154 #define SLAP_LIMITS_ONE 0x0002
1155 #define SLAP_LIMITS_SUBTREE 0x0003
1156 #define SLAP_LIMITS_CHILDREN 0x0004
1157 #define SLAP_LIMITS_REGEX 0x0005
1158 #define SLAP_LIMITS_ANONYMOUS 0x0006
1159 #define SLAP_LIMITS_USERS 0x0007
1160 #define SLAP_LIMITS_ANY 0x0008
1161 regex_t lm_dn_regex; /* regex data for REGEX */
1164 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1165 * pattern for REGEX; NULL for ANONYMOUS, USERS
1167 struct berval lm_dn_pat;
1169 struct slap_limits_set lm_limits;
1172 /* temporary aliases */
1173 typedef BackendDB Backend;
1174 #define nbackends nBackendDB
1175 #define backends backendDB
1177 struct slap_backend_db {
1178 BackendInfo *bd_info; /* pointer to shared backend info */
1180 /* BackendInfo accessors */
1181 #define be_config bd_info->bi_db_config
1182 #define be_type bd_info->bi_type
1184 #define be_bind bd_info->bi_op_bind
1185 #define be_unbind bd_info->bi_op_unbind
1186 #define be_add bd_info->bi_op_add
1187 #define be_compare bd_info->bi_op_compare
1188 #define be_delete bd_info->bi_op_delete
1189 #define be_modify bd_info->bi_op_modify
1190 #define be_modrdn bd_info->bi_op_modrdn
1191 #define be_search bd_info->bi_op_search
1193 #define be_extended bd_info->bi_extended
1195 #define be_release bd_info->bi_entry_release_rw
1196 #define be_chk_referrals bd_info->bi_chk_referrals
1197 #define be_group bd_info->bi_acl_group
1198 #define be_attribute bd_info->bi_acl_attribute
1199 #define be_operational bd_info->bi_operational
1201 #define be_controls bd_info->bi_controls
1203 #define be_connection_init bd_info->bi_connection_init
1204 #define be_connection_destroy bd_info->bi_connection_destroy
1207 #define be_entry_open bd_info->bi_tool_entry_open
1208 #define be_entry_close bd_info->bi_tool_entry_close
1209 #define be_entry_first bd_info->bi_tool_entry_first
1210 #define be_entry_next bd_info->bi_tool_entry_next
1211 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1212 #define be_entry_get bd_info->bi_tool_entry_get
1213 #define be_entry_put bd_info->bi_tool_entry_put
1214 #define be_sync bd_info->bi_tool_sync
1217 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1218 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1219 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1220 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1221 #define SLAP_BFLAG_ALIASES 0x0100U
1222 #define SLAP_BFLAG_REFERRALS 0x0200U
1223 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1224 #define SLAP_BFLAG_MONITOR 0x1000U
1225 #define SLAP_BFLAG_DYNAMIC 0x2000U
1226 slap_mask_t be_flags;
1227 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1228 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1229 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1230 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1231 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1232 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1234 slap_mask_t be_restrictops; /* restriction operations */
1235 #define SLAP_RESTRICT_OP_ADD 0x0001U
1236 #define SLAP_RESTRICT_OP_BIND 0x0002U
1237 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1238 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1239 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1240 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1241 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1242 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1244 #define SLAP_RESTRICT_OP_READS \
1245 ( SLAP_RESTRICT_OP_COMPARE \
1246 | SLAP_RESTRICT_OP_SEARCH )
1247 #define SLAP_RESTRICT_OP_WRITES \
1248 ( SLAP_RESTRICT_OP_ADD \
1249 | SLAP_RESTRICT_OP_DELETE \
1250 | SLAP_RESTRICT_OP_MODIFY \
1251 | SLAP_RESTRICT_OP_RENAME )
1253 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1254 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1255 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1257 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1258 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1259 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1260 0x0004U /* unprotected simple auth */
1261 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1263 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1264 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1266 slap_mask_t be_requires; /* pre-operation requirements */
1267 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1268 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1269 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1270 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1271 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1273 /* Required Security Strength Factor */
1274 slap_ssf_set_t be_ssf_set;
1276 /* these should be renamed from be_ to bd_ */
1277 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1278 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1279 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1280 struct berval be_schemadn; /* per-backend subschema subentry DN */
1281 struct berval be_schemandn; /* normalized subschema DN */
1282 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1283 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1284 struct berval be_rootpw; /* the magic "root" password for this db */
1285 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1286 #define be_sizelimit be_def_limit.lms_s_soft
1287 #define be_timelimit be_def_limit.lms_t_soft
1288 struct slap_limits_set be_def_limit; /* default limits */
1289 struct slap_limits **be_limits; /* regex-based size and time limits */
1290 AccessControl *be_acl; /* access control list for this backend */
1291 slap_access_t be_dfltaccess; /* access given if no acl matches */
1292 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1293 char *be_replogfile; /* replication log file (in master) */
1294 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1295 BerVarray be_update_refs; /* where to refer modifying clients to */
1297 void *be_private; /* anything the backend database needs */
1303 /* Backend function typedefs */
1304 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1305 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1306 const char *fname, int lineno,
1307 int argc, char **argv));
1308 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1309 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1310 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1312 typedef int (BI_db_init) LDAP_P((Backend *bd));
1313 typedef int (BI_db_config) LDAP_P((Backend *bd,
1314 const char *fname, int lineno,
1315 int argc, char **argv));
1316 typedef int (BI_db_open) LDAP_P((Backend *bd));
1317 typedef int (BI_db_close) LDAP_P((Backend *bd));
1318 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1320 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1321 struct slap_conn *c, struct slap_op *o,
1322 struct berval *dn, struct berval *ndn, int method,
1323 struct berval *cred, struct berval *edn ));
1324 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1325 struct slap_conn *c, struct slap_op *o ));
1326 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1327 struct slap_conn *c, struct slap_op *o,
1328 struct berval *base, struct berval *nbase,
1329 int scope, int deref,
1330 int slimit, int tlimit,
1331 Filter *f, struct berval *filterstr,
1332 AttributeName *attrs, int attrsonly));
1333 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1334 struct slap_conn *c, struct slap_op *o,
1335 struct berval *dn, struct berval *ndn,
1336 AttributeAssertion *ava));
1337 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1338 struct slap_conn *c, struct slap_op *o,
1339 struct berval *dn, struct berval *ndn,
1341 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1342 struct slap_conn *c, struct slap_op *o,
1343 struct berval *dn, struct berval *ndn,
1344 struct berval *newrdn, struct berval *nnewrdn,
1346 struct berval *newSup, struct berval *nnewSup ));
1347 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1348 struct slap_conn *c, struct slap_op *o,
1350 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1351 struct slap_conn *c, struct slap_op *o,
1352 struct berval *dn, struct berval *ndn));
1353 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1354 struct slap_conn *c, struct slap_op *o,
1357 typedef int (BI_op_extended) LDAP_P((
1359 struct slap_conn *conn,
1362 struct berval * reqdata,
1364 struct berval ** rspdata,
1365 LDAPControl *** rspctrls,
1369 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1370 struct slap_conn *c, struct slap_op *o,
1373 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1374 struct slap_conn *c, struct slap_op *o,
1375 struct berval *dn, struct berval *ndn,
1376 const char **text ));
1378 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1379 struct slap_conn *c, struct slap_op *o,
1383 ObjectClass *group_oc,
1384 AttributeDescription *group_at ));
1386 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1387 struct slap_conn *c, struct slap_op *o,
1388 Entry *e, struct berval *edn,
1389 AttributeDescription *entry_at,
1392 typedef int (BI_operational) LDAP_P((Backend *bd,
1393 struct slap_conn *c, struct slap_op *o,
1394 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1396 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1397 struct slap_conn *c));
1398 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1399 struct slap_conn *c));
1401 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1402 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1403 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1404 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1405 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1406 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1407 struct berval *text ));
1408 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1409 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1411 struct slap_backend_info {
1412 char *bi_type; /* type of backend */
1415 * per backend type routines:
1416 * bi_init: called to allocate a backend_info structure,
1417 * called once BEFORE configuration file is read.
1418 * bi_init() initializes this structure hence is
1419 * called directly from be_initialize()
1420 * bi_config: called per 'backend' specific option
1421 * all such options must before any 'database' options
1422 * bi_config() is called only from read_config()
1423 * bi_open: called to open each database, called
1424 * once AFTER configuration file is read but
1425 * BEFORE any bi_db_open() calls.
1426 * bi_open() is called from backend_startup()
1427 * bi_close: called to close each database, called
1428 * once during shutdown after all bi_db_close calls.
1429 * bi_close() is called from backend_shutdown()
1430 * bi_destroy: called to destroy each database, called
1431 * once during shutdown after all bi_db_destroy calls.
1432 * bi_destory() is called from backend_destroy()
1435 BI_config *bi_config;
1438 BI_destroy *bi_destroy;
1441 * per database routines:
1442 * bi_db_init: called to initialize each database,
1443 * called upon reading 'database <type>'
1444 * called only from backend_db_init()
1445 * bi_db_config: called to configure each database,
1446 * called per database to handle per database options
1447 * called only from read_config()
1448 * bi_db_open: called to open each database
1449 * called once per database immediately AFTER bi_open()
1450 * calls but before daemon startup.
1451 * called only by backend_startup()
1452 * bi_db_close: called to close each database
1453 * called once per database during shutdown but BEFORE
1454 * any bi_close call.
1455 * called only by backend_shutdown()
1456 * bi_db_destroy: called to destroy each database
1457 * called once per database during shutdown AFTER all
1458 * bi_close calls but before bi_destory calls.
1459 * called only by backend_destory()
1461 BI_db_init *bi_db_init;
1462 BI_db_config *bi_db_config;
1463 BI_db_open *bi_db_open;
1464 BI_db_close *bi_db_close;
1465 BI_db_destroy *bi_db_destroy;
1467 /* LDAP Operations Handling Routines */
1468 BI_op_bind *bi_op_bind;
1469 BI_op_unbind *bi_op_unbind;
1470 BI_op_search *bi_op_search;
1471 BI_op_compare *bi_op_compare;
1472 BI_op_modify *bi_op_modify;
1473 BI_op_modrdn *bi_op_modrdn;
1474 BI_op_add *bi_op_add;
1475 BI_op_delete *bi_op_delete;
1476 BI_op_abandon *bi_op_abandon;
1478 /* Extended Operations Helper */
1479 BI_op_extended *bi_extended;
1481 /* Auxilary Functions */
1482 BI_entry_release_rw *bi_entry_release_rw;
1483 BI_chk_referrals *bi_chk_referrals;
1485 BI_acl_group *bi_acl_group;
1486 BI_acl_attribute *bi_acl_attribute;
1488 BI_operational *bi_operational;
1490 BI_connection_init *bi_connection_init;
1491 BI_connection_destroy *bi_connection_destroy;
1493 /* hooks for slap tools */
1494 BI_tool_entry_open *bi_tool_entry_open;
1495 BI_tool_entry_close *bi_tool_entry_close;
1496 BI_tool_entry_first *bi_tool_entry_first;
1497 BI_tool_entry_next *bi_tool_entry_next;
1498 BI_tool_entry_get *bi_tool_entry_get;
1499 BI_tool_entry_put *bi_tool_entry_put;
1500 BI_tool_entry_reindex *bi_tool_entry_reindex;
1501 BI_tool_sync *bi_tool_sync;
1503 #define SLAP_INDEX_ADD_OP 0x0001
1504 #define SLAP_INDEX_DELETE_OP 0x0002
1506 char **bi_controls; /* supported controls */
1508 unsigned int bi_nDB; /* number of databases of this type */
1509 void *bi_private; /* anything the backend type needs */
1512 #define c_authtype c_authz.sai_method
1513 #define c_authmech c_authz.sai_mech
1514 #define c_dn c_authz.sai_dn
1515 #define c_ndn c_authz.sai_ndn
1516 #define c_ssf c_authz.sai_ssf
1517 #define c_transport_ssf c_authz.sai_transport_ssf
1518 #define c_tls_ssf c_authz.sai_tls_ssf
1519 #define c_sasl_ssf c_authz.sai_sasl_ssf
1521 #define o_authtype o_authz.sai_method
1522 #define o_authmech o_authz.sai_mech
1523 #define o_dn o_authz.sai_dn
1524 #define o_ndn o_authz.sai_ndn
1525 #define o_ssf o_authz.sai_ssf
1526 #define o_transport_ssf o_authz.sai_transport_ssf
1527 #define o_tls_ssf o_authz.sai_tls_ssf
1528 #define o_sasl_ssf o_authz.sai_sasl_ssf
1530 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1531 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1532 BerVarray, const char *, struct berval *,
1533 struct berval *, LDAPControl ** );
1535 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1536 ber_int_t, const char *, const char *, BerVarray,
1537 LDAPControl **, int nentries);
1539 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1540 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1542 typedef struct slap_callback {
1543 slap_response *sc_response;
1544 slap_sresult *sc_sresult;
1545 slap_sendentry *sc_sendentry;
1550 * Paged Results state
1552 typedef unsigned long PagedResultsCookie;
1553 typedef struct slap_paged_state {
1555 PagedResultsCookie ps_cookie;
1557 } PagedResultsState;
1560 * represents an operation pending from an ldap client
1562 typedef struct slap_op {
1563 unsigned long o_opid; /* id of this operation */
1564 unsigned long o_connid; /* id of conn initiating this op */
1565 struct slap_conn *o_conn; /* connection spawning this op */
1567 ber_int_t o_msgid; /* msgid of the request */
1568 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1569 ber_tag_t o_tag; /* tag of the request */
1570 time_t o_time; /* time op was initiated */
1572 ldap_pvt_thread_t o_tid; /* thread handling this op */
1574 volatile sig_atomic_t o_abandon; /* abandon flag */
1576 char o_do_not_cache; /* don't cache from this op */
1578 #define SLAP_NO_CONTROL 0
1579 #define SLAP_NONCRITICAL_CONTROL 1
1580 #define SLAP_CRITICAL_CONTROL 2
1584 char o_subentries_visibility;
1585 char o_valuesreturnfilter;
1587 char o_pagedresults;
1588 ber_int_t o_pagedresults_size;
1589 PagedResultsState o_pagedresults_state;
1591 #ifdef LDAP_CLIENT_UPDATE
1592 char o_clientupdate;
1593 char o_clientupdate_type;
1594 #define SLAP_LCUP_NONE (0x0)
1595 #define SLAP_LCUP_SYNC (0x1)
1596 #define SLAP_LCUP_PERSIST (0x2)
1597 #define SLAP_LCUP_SYNC_AND_PERSIST (0x3)
1598 ber_int_t o_clientupdate_interval;
1599 struct berval o_clientupdate_state;
1600 #endif /* LDAP_CLIENT_UPDATE */
1602 #ifdef LDAP_CONNECTIONLESS
1603 Sockaddr o_peeraddr; /* UDP peer address */
1605 AuthorizationInformation o_authz;
1607 BerElement *o_ber; /* ber of the request */
1608 slap_callback *o_callback; /* callback pointers */
1609 LDAPControl **o_ctrls; /* controls */
1611 void *o_threadctx; /* thread pool thread context */
1612 void *o_private; /* anything the backend needs */
1614 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1615 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1618 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1619 #define get_subentries(op) ((int)(op)->o_subentries)
1620 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1623 * Caches the result of a backend_group check for ACL evaluation
1625 typedef struct slap_gacl {
1626 struct slap_gacl *ga_next;
1629 AttributeDescription *ga_at;
1636 * represents a connection from an ldap client
1638 typedef struct slap_conn {
1639 int c_struct_state; /* structure management state */
1640 int c_conn_state; /* connection state */
1642 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1643 Sockbuf *c_sb; /* ber connection stuff */
1645 /* only can be changed by connect_init */
1646 time_t c_starttime; /* when the connection was opened */
1647 time_t c_activitytime; /* when the connection was last used */
1648 unsigned long c_connid; /* id of this connection for stats*/
1650 struct berval c_listener_url; /* listener URL */
1651 struct berval c_peer_domain; /* DNS name of client */
1652 struct berval c_peer_name; /* peer name (trans=addr:port) */
1653 struct berval c_sock_name; /* sock name (trans=addr:port) */
1655 /* only can be changed by binding thread */
1656 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1657 struct berval c_sasl_bind_mech; /* mech in progress */
1658 struct berval c_sasl_dn; /* temporary storage */
1660 /* authorization backend */
1661 Backend *c_authz_backend;
1663 AuthorizationInformation c_authz;
1664 GroupAssertion *c_groups;
1666 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1668 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1669 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1671 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1672 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1674 BerElement *c_currentber; /* ber we're attempting to read */
1675 int c_writewaiter; /* true if writer is waiting */
1677 #ifdef LDAP_CONNECTIONLESS
1678 int c_is_udp; /* true if this is (C)LDAP over UDP */
1681 int c_is_tls; /* true if this LDAP over raw TLS */
1682 int c_needs_tls_accept; /* true if SSL_accept should be called */
1684 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1685 void *c_sasl_context; /* SASL session context */
1686 void *c_sasl_extra; /* SASL session extra stuff */
1687 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1689 PagedResultsState c_pagedresults_state; /* paged result state */
1691 long c_n_ops_received; /* num of ops received (next op_id) */
1692 long c_n_ops_executing; /* num of ops currently executing */
1693 long c_n_ops_pending; /* num of ops pending execution */
1694 long c_n_ops_completed; /* num of ops completed */
1696 long c_n_get; /* num of get calls */
1697 long c_n_read; /* num of read calls */
1698 long c_n_write; /* num of write calls */
1701 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1702 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1704 if ( ldap_debug & (level) ) \
1705 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1706 if ( ldap_syslog & (level) ) \
1707 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1711 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1715 * listener; need to access it from monitor backend
1717 typedef struct slap_listener {
1723 #ifdef LDAP_CONNECTIONLESS
1724 int sl_is_udp; /* UDP listener is also data port */
1728 #define sl_addr sl_sa.sa_in_addr
1731 #ifdef SLAPD_MONITOR
1748 #endif /* SLAPD_MONITOR */
1751 * Better know these all around slapd
1753 #define SLAP_LDAPDN_PRETTY 0x1
1754 #define SLAP_LDAPDN_MAXLEN 8192
1759 #ifdef LDAP_CLIENT_UPDATE
1760 #define SLAP_LCUP_STATE_UPDATE_TRUE 1
1761 #define SLAP_LCUP_STATE_UPDATE_FALSE 0
1762 #define SLAP_LCUP_ENTRY_DELETED_TRUE 1
1763 #define SLAP_LCUP_ENTRY_DELETED_FALSE 0
1764 #endif /* LDAP_CLIENT_UPDATE */
1768 #include "proto-slap.h"
1770 #endif /* _SLAP_H_ */