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_USAGE 7
228 #define SLAP_SCHERR_ATTR_BAD_SUP 8
229 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
230 #define SLAP_SCHERR_ATTR_DUP 10
231 #define SLAP_SCHERR_MR_NOT_FOUND 11
232 #define SLAP_SCHERR_MR_INCOMPLETE 12
233 #define SLAP_SCHERR_MR_DUP 13
234 #define SLAP_SCHERR_SYN_NOT_FOUND 14
235 #define SLAP_SCHERR_SYN_DUP 15
236 #define SLAP_SCHERR_NO_NAME 16
237 #define SLAP_SCHERR_NOT_SUPPORTED 17
238 #define SLAP_SCHERR_BAD_DESCR 18
239 #define SLAP_SCHERR_OIDM 19
240 #define SLAP_SCHERR_LAST SLAP_SCHERR_OIDM
242 typedef union slap_sockaddr {
243 struct sockaddr sa_addr;
244 struct sockaddr_in sa_in_addr;
246 struct sockaddr_in6 sa_in6_addr;
249 struct sockaddr_un sa_un_addr;
254 extern int slap_inet4or6;
257 typedef struct slap_oid_macro {
258 struct berval som_oid;
260 struct slap_oid_macro *som_next;
263 /* forward declarations */
265 struct slap_matching_rule;
267 typedef int slap_syntax_validate_func LDAP_P((
268 struct slap_syntax *syntax,
269 struct berval * in));
271 typedef int slap_syntax_transform_func LDAP_P((
272 struct slap_syntax *syntax,
274 struct berval * out));
276 typedef struct slap_syntax {
278 #define ssyn_oid ssyn_syn.syn_oid
279 #define ssyn_desc ssyn_syn.syn_desc
280 #define ssyn_extensions ssyn_syn.syn_extensions
281 ber_len_t ssyn_oidlen;
283 unsigned int ssyn_flags;
285 #define SLAP_SYNTAX_NONE 0x0000U
286 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
287 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
288 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
289 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
291 slap_syntax_validate_func *ssyn_validate;
292 slap_syntax_transform_func *ssyn_normalize;
293 slap_syntax_transform_func *ssyn_pretty;
295 #ifdef SLAPD_BINARY_CONVERSION
296 /* convert to and from binary */
297 slap_syntax_transform_func *ssyn_ber2str;
298 slap_syntax_transform_func *ssyn_str2ber;
301 struct slap_syntax *ssyn_next;
304 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
305 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
306 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
307 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
308 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
310 typedef struct slap_syntax_defs_rec {
313 slap_syntax_validate_func *sd_validate;
314 slap_syntax_transform_func *sd_normalize;
315 slap_syntax_transform_func *sd_pretty;
316 #ifdef SLAPD_BINARY_CONVERSION
317 slap_syntax_transform_func *sd_ber2str;
318 slap_syntax_transform_func *sd_str2ber;
320 } slap_syntax_defs_rec;
322 /* X -> Y Converter */
323 typedef int slap_mr_convert_func LDAP_P((
325 struct berval * out ));
328 typedef int slap_mr_normalize_func LDAP_P((
330 struct slap_syntax *syntax, /* NULL if in is asserted value */
331 struct slap_matching_rule *mr,
333 struct berval * out ));
335 /* Match (compare) function */
336 typedef int slap_mr_match_func LDAP_P((
339 struct slap_syntax *syntax, /* syntax of stored value */
340 struct slap_matching_rule *mr,
341 struct berval * value,
342 void * assertValue ));
344 /* Index generation function */
345 typedef int slap_mr_indexer_func LDAP_P((
348 struct slap_syntax *syntax, /* syntax of stored value */
349 struct slap_matching_rule *mr,
350 struct berval *prefix,
354 /* Filter index function */
355 typedef int slap_mr_filter_func LDAP_P((
358 struct slap_syntax *syntax, /* syntax of stored value */
359 struct slap_matching_rule *mr,
360 struct berval *prefix,
364 typedef struct slap_matching_rule {
365 LDAPMatchingRule smr_mrule;
366 ber_len_t smr_oidlen;
367 slap_mask_t smr_usage;
369 #define SLAP_MR_HIDE 0x8000U
371 #define SLAP_MR_TYPE_MASK 0x0F00U
372 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
373 #define SLAP_MR_USAGE 0x000FU
375 #define SLAP_MR_NONE 0x0000U
376 #define SLAP_MR_EQUALITY 0x0100U
377 #define SLAP_MR_ORDERING 0x0200U
378 #define SLAP_MR_SUBSTR 0x0400U
379 #define SLAP_MR_EXT 0x0800U
381 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
382 #define SLAP_MR_DN_FOLD 0x0008U
384 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
385 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
386 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
389 * normally the provided value is expected to conform to
390 * assertion syntax specified in the matching rule, however
391 * at times (such as during individual value modification),
392 * the provided value is expected to conform to the
393 * attribute's value syntax.
395 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
396 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
397 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
399 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
400 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
401 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
402 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
404 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
405 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
406 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
407 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
408 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
409 == SLAP_MR_VALUE_SYNTAX_MATCH)
412 slap_mr_convert_func *smr_convert;
413 slap_mr_normalize_func *smr_normalize;
414 slap_mr_match_func *smr_match;
415 slap_mr_indexer_func *smr_indexer;
416 slap_mr_filter_func *smr_filter;
418 struct slap_matching_rule *smr_associated;
419 struct slap_matching_rule *smr_next;
421 #define smr_oid smr_mrule.mr_oid
422 #define smr_names smr_mrule.mr_names
423 #define smr_desc smr_mrule.mr_desc
424 #define smr_obsolete smr_mrule.mr_obsolete
425 #define smr_syntax_oid smr_mrule.mr_syntax_oid
426 #define smr_extensions smr_mrule.mr_extensions
429 typedef struct slap_mrule_defs_rec {
431 slap_mask_t mrd_usage;
432 slap_mr_convert_func * mrd_convert;
433 slap_mr_normalize_func * mrd_normalize;
434 slap_mr_match_func * mrd_match;
435 slap_mr_indexer_func * mrd_indexer;
436 slap_mr_filter_func * mrd_filter;
438 char * mrd_associated;
439 } slap_mrule_defs_rec;
441 struct slap_backend_db;
445 typedef int (AttributeTypeSchemaCheckFN)(
446 struct slap_backend_db *be,
447 struct slap_entry *e,
448 struct slap_attr *attr,
450 char *textbuf, size_t textlen );
452 typedef struct slap_attribute_type {
453 LDAPAttributeType sat_atype;
454 struct berval sat_cname;
455 struct slap_attribute_type *sat_sup;
456 struct slap_attribute_type **sat_subtypes;
457 MatchingRule *sat_equality;
458 MatchingRule *sat_approx;
459 MatchingRule *sat_ordering;
460 MatchingRule *sat_substr;
463 AttributeTypeSchemaCheckFN *sat_check;
465 #define SLAP_AT_NONE 0x0000U
466 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
467 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
468 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
469 slap_mask_t sat_flags;
471 struct slap_attribute_type *sat_next;
473 #define sat_oid sat_atype.at_oid
474 #define sat_names sat_atype.at_names
475 #define sat_desc sat_atype.at_desc
476 #define sat_obsolete sat_atype.at_obsolete
477 #define sat_sup_oid sat_atype.at_sup_oid
478 #define sat_equality_oid sat_atype.at_equality_oid
479 #define sat_ordering_oid sat_atype.at_ordering_oid
480 #define sat_substr_oid sat_atype.at_substr_oid
481 #define sat_syntax_oid sat_atype.at_syntax_oid
482 #define sat_single_value sat_atype.at_single_value
483 #define sat_collective sat_atype.at_collective
484 #define sat_no_user_mod sat_atype.at_no_user_mod
485 #define sat_usage sat_atype.at_usage
486 #define sat_extensions sat_atype.at_extensions
488 struct slap_attr_desc *sat_ad;
489 ldap_pvt_thread_mutex_t sat_ad_mutex;
492 #define is_at_operational(at) ((at)->sat_usage)
493 #define is_at_single_value(at) ((at)->sat_single_value)
494 #define is_at_collective(at) ((at)->sat_collective)
495 #define is_at_obsolete(at) ((at)->sat_obsolete)
496 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
498 struct slap_object_class;
500 typedef int (ObjectClassSchemaCheckFN)(
501 struct slap_backend_db *be,
502 struct slap_entry *e,
503 struct slap_object_class *oc,
505 char *textbuf, size_t textlen );
507 typedef struct slap_object_class {
508 LDAPObjectClass soc_oclass;
509 struct slap_object_class **soc_sups;
510 AttributeType **soc_required;
511 AttributeType **soc_allowed;
512 ObjectClassSchemaCheckFN *soc_check;
513 slap_mask_t soc_flags;
514 #define soc_oid soc_oclass.oc_oid
515 #define soc_names soc_oclass.oc_names
516 #define soc_desc soc_oclass.oc_desc
517 #define soc_obsolete soc_oclass.oc_obsolete
518 #define soc_sup_oids soc_oclass.oc_sup_oids
519 #define soc_kind soc_oclass.oc_kind
520 #define soc_at_oids_must soc_oclass.oc_at_oids_must
521 #define soc_at_oids_may soc_oclass.oc_at_oids_may
522 #define soc_extensions soc_oclass.oc_extensions
524 struct slap_object_class *soc_next;
527 #define SLAP_OC_ALIAS 0x0001
528 #define SLAP_OC_REFERRAL 0x0002
529 #define SLAP_OC_SUBENTRY 0x0004
530 #define SLAP_OC_DYNAMICOBJECT 0x0008
531 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
532 #define SLAP_OC__MASK 0x001F
533 #define SLAP_OC__END 0x0020
534 #define SLAP_OC_OPERATIONAL 0x4000
535 #define SLAP_OC_HIDE 0x8000
537 #ifdef LDAP_EXTENDED_SCHEMA
541 typedef struct slap_content_rule {
542 LDAPContentRule scr_crule;
543 ObjectClass *scr_sclass;
544 ObjectClass **scr_auxiliaries; /* optional */
545 AttributeType **scr_required; /* optional */
546 AttributeType **scr_allowed; /* optional */
547 AttributeType **scr_precluded; /* optional */
548 #define scr_oid scr_crule.cr_oid
549 #define scr_names scr_crule.cr_names
550 #define scr_desc scr_crule.cr_desc
551 #define scr_obsolete soc_oclass.cr_obsolete
552 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
553 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
554 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
555 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
560 * represents a recognized attribute description ( type + options )
562 typedef struct slap_attr_desc {
563 struct slap_attr_desc *ad_next;
564 AttributeType *ad_type; /* attribute type, must be specified */
565 struct berval ad_cname; /* canonical name, must be specified */
566 struct berval ad_lang; /* empty if no language tags */
568 #define SLAP_DESC_NONE 0x00U
569 #define SLAP_DESC_BINARY 0x01U
570 #define SLAP_DESC_LANG_RANGE 0x80U
571 } AttributeDescription;
573 typedef struct slap_attr_name {
574 struct berval an_name;
575 AttributeDescription *an_desc;
579 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
580 #define slap_ad_is_lang_range(ad) \
581 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
582 #define slap_ad_is_binary(ad) \
583 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
586 * pointers to schema elements used internally
588 struct slap_internal_schema {
590 ObjectClass *si_oc_top;
591 ObjectClass *si_oc_extensibleObject;
592 ObjectClass *si_oc_alias;
593 ObjectClass *si_oc_referral;
594 ObjectClass *si_oc_rootdse;
595 ObjectClass *si_oc_subentry;
596 ObjectClass *si_oc_subschema;
597 ObjectClass *si_oc_monitor;
598 ObjectClass *si_oc_collectiveAttributeSubentry;
599 ObjectClass *si_oc_dynamicObject;
601 /* objectClass attribute descriptions */
602 AttributeDescription *si_ad_objectClass;
604 /* operational attribute descriptions */
605 AttributeDescription *si_ad_structuralObjectClass;
606 AttributeDescription *si_ad_creatorsName;
607 AttributeDescription *si_ad_createTimestamp;
608 AttributeDescription *si_ad_modifiersName;
609 AttributeDescription *si_ad_modifyTimestamp;
610 AttributeDescription *si_ad_hasSubordinates;
611 AttributeDescription *si_ad_subschemaSubentry;
612 AttributeDescription *si_ad_collectiveSubentries;
613 AttributeDescription *si_ad_collectiveExclusions;
614 AttributeDescription *si_ad_entryUUID;
615 AttributeDescription *si_ad_entryCSN;
617 /* root DSE attribute descriptions */
618 AttributeDescription *si_ad_altServer;
619 AttributeDescription *si_ad_namingContexts;
620 AttributeDescription *si_ad_supportedControl;
621 AttributeDescription *si_ad_supportedExtension;
622 AttributeDescription *si_ad_supportedLDAPVersion;
623 AttributeDescription *si_ad_supportedSASLMechanisms;
624 AttributeDescription *si_ad_supportedFeatures;
625 AttributeDescription *si_ad_monitorContext;
626 AttributeDescription *si_ad_vendorName;
627 AttributeDescription *si_ad_vendorVersion;
629 /* subentry attribute descriptions */
630 AttributeDescription *si_ad_administrativeRole;
631 AttributeDescription *si_ad_subtreeSpecification;
633 /* subschema subentry attribute descriptions */
634 AttributeDescription *si_ad_ditStructureRules;
635 AttributeDescription *si_ad_ditContentRules;
636 AttributeDescription *si_ad_nameForms;
637 AttributeDescription *si_ad_objectClasses;
638 AttributeDescription *si_ad_attributeTypes;
639 AttributeDescription *si_ad_ldapSyntaxes;
640 AttributeDescription *si_ad_matchingRules;
641 AttributeDescription *si_ad_matchingRuleUse;
643 /* Aliases & Referrals */
644 AttributeDescription *si_ad_aliasedObjectName;
645 AttributeDescription *si_ad_ref;
647 /* Access Control Internals */
648 AttributeDescription *si_ad_entry;
649 AttributeDescription *si_ad_children;
650 AttributeDescription *si_ad_saslAuthzTo;
651 AttributeDescription *si_ad_saslAuthzFrom;
652 #ifdef SLAPD_ACI_ENABLED
653 AttributeDescription *si_ad_aci;
656 /* dynamic entries */
657 AttributeDescription *si_ad_entryTtl;
658 AttributeDescription *si_ad_dynamicSubtrees;
660 /* Other attributes descriptions */
661 AttributeDescription *si_ad_distinguishedName;
662 AttributeDescription *si_ad_name;
663 AttributeDescription *si_ad_cn;
664 AttributeDescription *si_ad_userPassword;
665 #ifdef SLAPD_AUTHPASSWD
666 AttributeDescription *si_ad_authPassword;
668 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
669 AttributeDescription *si_ad_krbName;
672 /* Undefined Attribute Type */
673 AttributeType *si_at_undefined;
676 MatchingRule *si_mr_distinguishedNameMatch;
677 MatchingRule *si_mr_integerMatch;
680 Syntax *si_syn_octetString;
681 Syntax *si_syn_distinguishedName;
682 Syntax *si_syn_integer;
685 typedef struct slap_attr_assertion {
686 AttributeDescription *aa_desc;
687 struct berval aa_value;
688 } AttributeAssertion;
690 typedef struct slap_ss_assertion {
691 AttributeDescription *sa_desc;
692 struct berval sa_initial;
693 struct berval *sa_any;
694 struct berval sa_final;
695 } SubstringsAssertion;
697 typedef struct slap_mr_assertion {
698 MatchingRule *ma_rule; /* optional */
699 struct berval ma_rule_text; /* optional */
700 AttributeDescription *ma_desc; /* optional */
701 int ma_dnattrs; /* boolean */
702 struct berval ma_value; /* required */
703 } MatchingRuleAssertion;
706 * represents a search filter
708 typedef struct slap_filter {
709 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
710 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
711 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
712 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
715 /* precomputed result */
716 ber_int_t f_un_result;
719 struct berval *f_un_dn;
722 AttributeDescription *f_un_desc;
724 /* simple value assertion */
725 AttributeAssertion *f_un_ava;
727 /* substring assertion */
728 SubstringsAssertion *f_un_ssa;
730 /* matching rule assertion */
731 MatchingRuleAssertion *f_un_mra;
733 #define f_dn f_un.f_un_dn
734 #define f_desc f_un.f_un_desc
735 #define f_ava f_un.f_un_ava
736 #define f_av_desc f_un.f_un_ava->aa_desc
737 #define f_av_value f_un.f_un_ava->aa_value
738 #define f_sub f_un.f_un_ssa
739 #define f_sub_desc f_un.f_un_ssa->sa_desc
740 #define f_sub_initial f_un.f_un_ssa->sa_initial
741 #define f_sub_any f_un.f_un_ssa->sa_any
742 #define f_sub_final f_un.f_un_ssa->sa_final
743 #define f_mra f_un.f_un_mra
744 #define f_mr_rule f_un.f_un_mra->ma_rule
745 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
746 #define f_mr_desc f_un.f_un_mra->ma_desc
747 #define f_mr_value f_un.f_un_mra->ma_value
748 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
751 struct slap_filter *f_un_complex;
754 #define f_result f_un.f_un_result
755 #define f_and f_un.f_un_complex
756 #define f_or f_un.f_un_complex
757 #define f_not f_un.f_un_complex
758 #define f_list f_un.f_un_complex
760 struct slap_filter *f_next;
763 /* compare routines can return undefined */
764 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
766 typedef struct slap_valuesreturnfilter {
770 /* precomputed result */
771 ber_int_t f_un_result;
777 AttributeDescription *f_un_desc;
779 /* simple value assertion */
780 AttributeAssertion *f_un_ava;
782 /* substring assertion */
783 SubstringsAssertion *f_un_ssa;
785 /* matching rule assertion */
786 MatchingRuleAssertion *f_un_mra;
789 struct slap_valuesreturnfilter *f_next;
790 } ValuesReturnFilter;
793 * represents an attribute (description + values)
795 typedef struct slap_attr {
796 AttributeDescription *a_desc;
798 struct slap_attr *a_next;
800 #define SLAP_ATTR_IXADD 0x1U
801 #define SLAP_ATTR_IXDEL 0x2U
806 * the id used in the indexes to refer to an entry
808 typedef unsigned long ID;
809 #define NOID ((ID)~0)
812 * represents an entry in core
814 typedef struct slap_entry {
816 * The ID field should only be changed before entry is
817 * inserted into a cache. The ID value is backend
822 struct berval e_name; /* name (DN) of this entry */
823 struct berval e_nname; /* normalized name (DN) of this entry */
825 /* for migration purposes */
826 #define e_dn e_name.bv_val
827 #define e_ndn e_nname.bv_val
829 Attribute *e_attrs; /* list of attributes + values */
831 slap_mask_t e_ocflags;
833 struct berval e_bv; /* For entry_encode/entry_decode */
835 /* for use by the backend for any purpose */
842 typedef struct slap_mod {
844 AttributeDescription *sm_desc;
845 struct berval sm_type;
846 BerVarray sm_bvalues;
849 typedef struct slap_mod_list {
850 Modification sml_mod;
851 #define sml_op sml_mod.sm_op
852 #define sml_desc sml_mod.sm_desc
853 #define sml_type sml_mod.sm_type
854 #define sml_bvalues sml_mod.sm_bvalues
855 struct slap_mod_list *sml_next;
858 typedef struct slap_ldap_modlist {
860 struct slap_ldap_modlist *ml_next;
861 #define ml_op ml_mod.mod_op
862 #define ml_type ml_mod.mod_type
863 #define ml_values ml_mod.mod_values
864 #define ml_bvalues ml_mod.mod_bvalues
868 * represents an access control list
870 typedef enum slap_access_e {
871 ACL_INVALID_ACCESS = -1,
880 typedef enum slap_control_e {
881 ACL_INVALID_CONTROL = 0,
887 typedef enum slap_style_e {
895 /* alternate names */
896 ACL_STYLE_EXACT = ACL_STYLE_BASE
899 typedef struct slap_authz_info {
900 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
901 struct berval sai_mech; /* SASL Mechanism */
902 struct berval sai_dn; /* DN for reporting purposes */
903 struct berval sai_ndn; /* Normalized DN */
905 /* Security Strength Factors */
906 slap_ssf_t sai_ssf; /* Overall SSF */
907 slap_ssf_t sai_transport_ssf; /* Transport SSF */
908 slap_ssf_t sai_tls_ssf; /* TLS SSF */
909 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
910 } AuthorizationInformation;
913 typedef struct slap_access {
914 slap_control_t a_type;
916 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
918 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
919 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
920 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
921 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
922 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
923 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
925 #define ACL_PRIV_MASK 0x00ffUL
928 #define ACL_PRIV_LEVEL 0x1000UL
929 #define ACL_PRIV_ADDITIVE 0x2000UL
930 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
933 #define ACL_PRIV_INVALID 0x0UL
935 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
936 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
937 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
938 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
940 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
941 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
943 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
945 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
947 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
948 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
949 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
951 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
952 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
953 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
954 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
955 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
956 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
958 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
959 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
960 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
961 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
962 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
963 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
964 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
966 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
967 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
968 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
969 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
970 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
971 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
973 slap_mask_t a_access_mask;
975 AuthorizationInformation a_authz;
976 #define a_dn_pat a_authz.sai_dn
978 slap_style_t a_dn_style;
979 AttributeDescription *a_dn_at;
983 slap_style_t a_peername_style;
984 struct berval a_peername_pat;
985 slap_style_t a_sockname_style;
986 struct berval a_sockname_pat;
988 slap_style_t a_domain_style;
989 struct berval a_domain_pat;
992 slap_style_t a_sockurl_style;
993 struct berval a_sockurl_pat;
994 slap_style_t a_set_style;
995 struct berval a_set_pat;
997 #ifdef SLAPD_ACI_ENABLED
998 AttributeDescription *a_aci_at;
1002 slap_style_t a_group_style;
1003 struct berval a_group_pat;
1004 ObjectClass *a_group_oc;
1005 AttributeDescription *a_group_at;
1007 struct slap_access *a_next;
1011 typedef struct slap_acl {
1012 /* "to" part: the entries this acl applies to */
1014 slap_style_t acl_dn_style;
1016 struct berval acl_dn_pat;
1017 AttributeName *acl_attrs;
1019 /* "by" part: list of who has what access to the entries */
1022 struct slap_acl *acl_next;
1025 typedef struct slap_acl_state {
1026 unsigned as_recorded;
1027 #define ACL_STATE_NOT_RECORDED 0x0
1028 #define ACL_STATE_RECORDED_VD 0x1
1029 #define ACL_STATE_RECORDED_NV 0x2
1030 #define ACL_STATE_RECORDED 0x3
1033 AccessControl *as_vd_acl;
1034 slap_mask_t as_vd_acl_mask;
1035 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1036 int as_vd_acl_count;
1038 Access *as_vd_access;
1039 int as_vd_access_count;
1042 } AccessControlState;
1043 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1046 * replog moddn param structure
1048 struct slap_replog_moddn {
1049 struct berval *newrdn;
1051 struct berval *newsup;
1056 * represents a backend
1059 typedef struct slap_backend_info BackendInfo; /* per backend type */
1060 typedef struct slap_backend_db BackendDB; /* per backend database */
1062 LDAP_SLAPD_V (int) nBackendInfo;
1063 LDAP_SLAPD_V (int) nBackendDB;
1064 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1065 LDAP_SLAPD_V (BackendDB *) backendDB;
1067 LDAP_SLAPD_V (int) slapMode;
1068 #define SLAP_UNDEFINED_MODE 0x0000
1069 #define SLAP_SERVER_MODE 0x0001
1070 #define SLAP_TOOL_MODE 0x0002
1071 #define SLAP_MODE 0x0003
1073 #define SLAP_TRUNCATE_MODE 0x0100
1075 struct slap_replica_info {
1076 char *ri_host; /* supersedes be_replica */
1077 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1078 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1079 int ri_exclude; /* 1 => exclude ri_attrs */
1082 struct slap_limits_set {
1090 int lms_s_unchecked;
1093 struct slap_limits {
1094 int lm_type; /* type of pattern */
1095 #define SLAP_LIMITS_UNDEFINED 0x0000
1096 #define SLAP_LIMITS_EXACT 0x0001
1097 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1098 #define SLAP_LIMITS_ONE 0x0002
1099 #define SLAP_LIMITS_SUBTREE 0x0003
1100 #define SLAP_LIMITS_CHILDREN 0x0004
1101 #define SLAP_LIMITS_REGEX 0x0005
1102 #define SLAP_LIMITS_ANONYMOUS 0x0006
1103 #define SLAP_LIMITS_USERS 0x0007
1104 #define SLAP_LIMITS_ANY 0x0008
1105 regex_t lm_dn_regex; /* regex data for REGEX */
1108 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1109 * pattern for REGEX; NULL for ANONYMOUS, USERS
1111 struct berval lm_dn_pat;
1113 struct slap_limits_set lm_limits;
1116 /* temporary aliases */
1117 typedef BackendDB Backend;
1118 #define nbackends nBackendDB
1119 #define backends backendDB
1121 struct slap_backend_db {
1122 BackendInfo *bd_info; /* pointer to shared backend info */
1124 /* BackendInfo accessors */
1125 #define be_config bd_info->bi_db_config
1126 #define be_type bd_info->bi_type
1128 #define be_bind bd_info->bi_op_bind
1129 #define be_unbind bd_info->bi_op_unbind
1130 #define be_add bd_info->bi_op_add
1131 #define be_compare bd_info->bi_op_compare
1132 #define be_delete bd_info->bi_op_delete
1133 #define be_modify bd_info->bi_op_modify
1134 #define be_modrdn bd_info->bi_op_modrdn
1135 #define be_search bd_info->bi_op_search
1137 #define be_extended bd_info->bi_extended
1139 #define be_release bd_info->bi_entry_release_rw
1140 #define be_chk_referrals bd_info->bi_chk_referrals
1141 #define be_group bd_info->bi_acl_group
1142 #define be_attribute bd_info->bi_acl_attribute
1143 #define be_operational bd_info->bi_operational
1145 #define be_controls bd_info->bi_controls
1147 #define be_connection_init bd_info->bi_connection_init
1148 #define be_connection_destroy bd_info->bi_connection_destroy
1151 #define be_entry_open bd_info->bi_tool_entry_open
1152 #define be_entry_close bd_info->bi_tool_entry_close
1153 #define be_entry_first bd_info->bi_tool_entry_first
1154 #define be_entry_next bd_info->bi_tool_entry_next
1155 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1156 #define be_entry_get bd_info->bi_tool_entry_get
1157 #define be_entry_put bd_info->bi_tool_entry_put
1158 #define be_sync bd_info->bi_tool_sync
1161 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1162 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1163 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1164 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1165 #define SLAP_BFLAG_ALIASES 0x0100U
1166 #define SLAP_BFLAG_REFERRALS 0x0200U
1167 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1168 #define SLAP_BFLAG_MONITOR 0x1000U
1169 #define SLAP_BFLAG_DYNAMIC 0x2000U
1170 slap_mask_t be_flags;
1171 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1172 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1173 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1174 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1175 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1176 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1178 slap_mask_t be_restrictops; /* restriction operations */
1179 #define SLAP_RESTRICT_OP_ADD 0x0001U
1180 #define SLAP_RESTRICT_OP_BIND 0x0002U
1181 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1182 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1183 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1184 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1185 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1186 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1188 #define SLAP_RESTRICT_OP_READS \
1189 ( SLAP_RESTRICT_OP_COMPARE \
1190 | SLAP_RESTRICT_OP_SEARCH )
1191 #define SLAP_RESTRICT_OP_WRITES \
1192 ( SLAP_RESTRICT_OP_ADD \
1193 | SLAP_RESTRICT_OP_DELETE \
1194 | SLAP_RESTRICT_OP_MODIFY \
1195 | SLAP_RESTRICT_OP_RENAME )
1197 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1198 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1199 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1201 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1202 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1203 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1204 0x0004U /* unprotected simple auth */
1205 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1207 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1208 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1210 slap_mask_t be_requires; /* pre-operation requirements */
1211 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1212 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1213 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1214 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1215 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1217 /* Required Security Strength Factor */
1218 slap_ssf_set_t be_ssf_set;
1220 /* these should be renamed from be_ to bd_ */
1221 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1222 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1223 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1224 #ifdef SLAPD_SCHEMA_DN
1225 struct berval be_schemadn; /* per-backend subschema subentry DN */
1226 struct berval be_schemandn; /* normalized subschema DN */
1228 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1229 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1230 struct berval be_rootpw; /* the magic "root" password for this db */
1231 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1232 #define be_sizelimit be_def_limit.lms_s_soft
1233 #define be_timelimit be_def_limit.lms_t_soft
1234 struct slap_limits_set be_def_limit; /* default limits */
1235 struct slap_limits **be_limits; /* regex-based size and time limits */
1236 AccessControl *be_acl; /* access control list for this backend */
1237 slap_access_t be_dfltaccess; /* access given if no acl matches */
1238 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1239 char *be_replogfile; /* replication log file (in master) */
1240 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1241 BerVarray be_update_refs; /* where to refer modifying clients to */
1243 void *be_private; /* anything the backend database needs */
1249 /* Backend function typedefs */
1250 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1251 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1252 const char *fname, int lineno,
1253 int argc, char **argv));
1254 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1255 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1256 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1258 typedef int (BI_db_init) LDAP_P((Backend *bd));
1259 typedef int (BI_db_config) LDAP_P((Backend *bd,
1260 const char *fname, int lineno,
1261 int argc, char **argv));
1262 typedef int (BI_db_open) LDAP_P((Backend *bd));
1263 typedef int (BI_db_close) LDAP_P((Backend *bd));
1264 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1266 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1267 struct slap_conn *c, struct slap_op *o,
1268 struct berval *dn, struct berval *ndn, int method,
1269 struct berval *cred, struct berval *edn ));
1270 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1271 struct slap_conn *c, struct slap_op *o ));
1272 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1273 struct slap_conn *c, struct slap_op *o,
1274 struct berval *base, struct berval *nbase,
1275 int scope, int deref,
1276 int slimit, int tlimit,
1277 Filter *f, struct berval *filterstr,
1278 AttributeName *attrs, int attrsonly));
1279 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1280 struct slap_conn *c, struct slap_op *o,
1281 struct berval *dn, struct berval *ndn,
1282 AttributeAssertion *ava));
1283 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1284 struct slap_conn *c, struct slap_op *o,
1285 struct berval *dn, struct berval *ndn,
1287 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1288 struct slap_conn *c, struct slap_op *o,
1289 struct berval *dn, struct berval *ndn,
1290 struct berval *newrdn, struct berval *nnewrdn,
1292 struct berval *newSup, struct berval *nnewSup ));
1293 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1294 struct slap_conn *c, struct slap_op *o,
1296 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1297 struct slap_conn *c, struct slap_op *o,
1298 struct berval *dn, struct berval *ndn));
1299 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1300 struct slap_conn *c, struct slap_op *o,
1303 typedef int (BI_op_extended) LDAP_P((
1305 struct slap_conn *conn,
1308 struct berval * reqdata,
1310 struct berval ** rspdata,
1311 LDAPControl *** rspctrls,
1315 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1316 struct slap_conn *c, struct slap_op *o,
1319 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1320 struct slap_conn *c, struct slap_op *o,
1321 struct berval *dn, struct berval *ndn,
1322 const char **text ));
1324 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1325 struct slap_conn *c, struct slap_op *o,
1329 ObjectClass *group_oc,
1330 AttributeDescription *group_at ));
1332 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1333 struct slap_conn *c, struct slap_op *o,
1334 Entry *e, struct berval *edn,
1335 AttributeDescription *entry_at,
1338 typedef int (BI_operational) LDAP_P((Backend *bd,
1339 struct slap_conn *c, struct slap_op *o,
1340 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1342 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1343 struct slap_conn *c));
1344 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1345 struct slap_conn *c));
1347 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1348 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1349 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1350 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1351 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1352 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1353 struct berval *text ));
1354 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1355 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1357 struct slap_backend_info {
1358 char *bi_type; /* type of backend */
1361 * per backend type routines:
1362 * bi_init: called to allocate a backend_info structure,
1363 * called once BEFORE configuration file is read.
1364 * bi_init() initializes this structure hence is
1365 * called directly from be_initialize()
1366 * bi_config: called per 'backend' specific option
1367 * all such options must before any 'database' options
1368 * bi_config() is called only from read_config()
1369 * bi_open: called to open each database, called
1370 * once AFTER configuration file is read but
1371 * BEFORE any bi_db_open() calls.
1372 * bi_open() is called from backend_startup()
1373 * bi_close: called to close each database, called
1374 * once during shutdown after all bi_db_close calls.
1375 * bi_close() is called from backend_shutdown()
1376 * bi_destroy: called to destroy each database, called
1377 * once during shutdown after all bi_db_destroy calls.
1378 * bi_destory() is called from backend_destroy()
1381 BI_config *bi_config;
1384 BI_destroy *bi_destroy;
1387 * per database routines:
1388 * bi_db_init: called to initialize each database,
1389 * called upon reading 'database <type>'
1390 * called only from backend_db_init()
1391 * bi_db_config: called to configure each database,
1392 * called per database to handle per database options
1393 * called only from read_config()
1394 * bi_db_open: called to open each database
1395 * called once per database immediately AFTER bi_open()
1396 * calls but before daemon startup.
1397 * called only by backend_startup()
1398 * bi_db_close: called to close each database
1399 * called once per database during shutdown but BEFORE
1400 * any bi_close call.
1401 * called only by backend_shutdown()
1402 * bi_db_destroy: called to destroy each database
1403 * called once per database during shutdown AFTER all
1404 * bi_close calls but before bi_destory calls.
1405 * called only by backend_destory()
1407 BI_db_init *bi_db_init;
1408 BI_db_config *bi_db_config;
1409 BI_db_open *bi_db_open;
1410 BI_db_close *bi_db_close;
1411 BI_db_destroy *bi_db_destroy;
1413 /* LDAP Operations Handling Routines */
1414 BI_op_bind *bi_op_bind;
1415 BI_op_unbind *bi_op_unbind;
1416 BI_op_search *bi_op_search;
1417 BI_op_compare *bi_op_compare;
1418 BI_op_modify *bi_op_modify;
1419 BI_op_modrdn *bi_op_modrdn;
1420 BI_op_add *bi_op_add;
1421 BI_op_delete *bi_op_delete;
1422 BI_op_abandon *bi_op_abandon;
1424 /* Extended Operations Helper */
1425 BI_op_extended *bi_extended;
1427 /* Auxilary Functions */
1428 BI_entry_release_rw *bi_entry_release_rw;
1429 BI_chk_referrals *bi_chk_referrals;
1431 BI_acl_group *bi_acl_group;
1432 BI_acl_attribute *bi_acl_attribute;
1434 BI_operational *bi_operational;
1436 BI_connection_init *bi_connection_init;
1437 BI_connection_destroy *bi_connection_destroy;
1439 /* hooks for slap tools */
1440 BI_tool_entry_open *bi_tool_entry_open;
1441 BI_tool_entry_close *bi_tool_entry_close;
1442 BI_tool_entry_first *bi_tool_entry_first;
1443 BI_tool_entry_next *bi_tool_entry_next;
1444 BI_tool_entry_get *bi_tool_entry_get;
1445 BI_tool_entry_put *bi_tool_entry_put;
1446 BI_tool_entry_reindex *bi_tool_entry_reindex;
1447 BI_tool_sync *bi_tool_sync;
1449 #define SLAP_INDEX_ADD_OP 0x0001
1450 #define SLAP_INDEX_DELETE_OP 0x0002
1452 char **bi_controls; /* supported controls */
1454 unsigned int bi_nDB; /* number of databases of this type */
1455 void *bi_private; /* anything the backend type needs */
1458 #define c_authtype c_authz.sai_method
1459 #define c_authmech c_authz.sai_mech
1460 #define c_dn c_authz.sai_dn
1461 #define c_ndn c_authz.sai_ndn
1462 #define c_ssf c_authz.sai_ssf
1463 #define c_transport_ssf c_authz.sai_transport_ssf
1464 #define c_tls_ssf c_authz.sai_tls_ssf
1465 #define c_sasl_ssf c_authz.sai_sasl_ssf
1467 #define o_authtype o_authz.sai_method
1468 #define o_authmech o_authz.sai_mech
1469 #define o_dn o_authz.sai_dn
1470 #define o_ndn o_authz.sai_ndn
1471 #define o_ssf o_authz.sai_ssf
1472 #define o_transport_ssf o_authz.sai_transport_ssf
1473 #define o_tls_ssf o_authz.sai_tls_ssf
1474 #define o_sasl_ssf o_authz.sai_sasl_ssf
1476 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1477 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1478 BerVarray, const char *, struct berval *,
1479 struct berval *, LDAPControl ** );
1481 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1482 ber_int_t, const char *, const char *, BerVarray,
1483 LDAPControl **, int nentries);
1485 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1486 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1488 typedef struct slap_callback {
1489 slap_response *sc_response;
1490 slap_sresult *sc_sresult;
1491 slap_sendentry *sc_sendentry;
1496 * Paged Results state
1498 typedef unsigned long PagedResultsCookie;
1499 typedef struct slap_paged_state {
1501 PagedResultsCookie ps_cookie;
1503 } PagedResultsState;
1506 * represents an operation pending from an ldap client
1508 typedef struct slap_op {
1509 unsigned long o_opid; /* id of this operation */
1510 unsigned long o_connid; /* id of conn initiating this op */
1512 ber_int_t o_msgid; /* msgid of the request */
1513 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1514 ber_tag_t o_tag; /* tag of the request */
1515 time_t o_time; /* time op was initiated */
1517 ldap_pvt_thread_t o_tid; /* thread handling this op */
1519 volatile sig_atomic_t o_abandon; /* abandon flag */
1521 char o_do_not_cache; /* don't cache from this op */
1523 #define SLAP_NO_CONTROL 0
1524 #define SLAP_NONCRITICAL_CONTROL 1
1525 #define SLAP_CRITICAL_CONTROL 2
1529 char o_subentries_visibility;
1530 char o_valuesreturnfilter;
1532 char o_pagedresults;
1533 ber_int_t o_pagedresults_size;
1534 PagedResultsState o_pagedresults_state;
1536 #ifdef LDAP_CONNECTIONLESS
1537 Sockaddr o_peeraddr; /* UDP peer address */
1539 AuthorizationInformation o_authz;
1541 BerElement *o_ber; /* ber of the request */
1542 slap_callback *o_callback; /* callback pointers */
1543 LDAPControl **o_ctrls; /* controls */
1545 void *o_threadctx; /* thread pool thread context */
1546 void *o_private; /* anything the backend needs */
1548 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1549 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1552 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1553 #define get_subentries(op) ((int)(op)->o_subentries)
1554 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1557 * Caches the result of a backend_group check for ACL evaluation
1559 typedef struct slap_gacl {
1560 struct slap_gacl *ga_next;
1563 AttributeDescription *ga_at;
1570 * represents a connection from an ldap client
1572 typedef struct slap_conn {
1573 int c_struct_state; /* structure management state */
1574 int c_conn_state; /* connection state */
1576 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1577 Sockbuf *c_sb; /* ber connection stuff */
1579 /* only can be changed by connect_init */
1580 time_t c_starttime; /* when the connection was opened */
1581 time_t c_activitytime; /* when the connection was last used */
1582 unsigned long c_connid; /* id of this connection for stats*/
1584 struct berval c_listener_url; /* listener URL */
1585 struct berval c_peer_domain; /* DNS name of client */
1586 struct berval c_peer_name; /* peer name (trans=addr:port) */
1587 struct berval c_sock_name; /* sock name (trans=addr:port) */
1589 /* only can be changed by binding thread */
1590 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1591 struct berval c_sasl_bind_mech; /* mech in progress */
1592 struct berval c_sasl_dn; /* temporary storage */
1594 /* authorization backend */
1595 Backend *c_authz_backend;
1597 AuthorizationInformation c_authz;
1598 GroupAssertion *c_groups;
1600 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1602 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1603 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1605 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1606 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1608 BerElement *c_currentber; /* ber we're attempting to read */
1609 int c_writewaiter; /* true if writer is waiting */
1611 #ifdef LDAP_CONNECTIONLESS
1612 int c_is_udp; /* true if this is (C)LDAP over UDP */
1615 int c_is_tls; /* true if this LDAP over raw TLS */
1616 int c_needs_tls_accept; /* true if SSL_accept should be called */
1618 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1619 void *c_sasl_context; /* SASL session context */
1620 void *c_sasl_extra; /* SASL session extra stuff */
1621 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
1622 ldap_pvt_thread_mutex_t c_sasl_bindmutex; /* lock for bindop */
1624 PagedResultsState c_pagedresults_state; /* paged result state */
1626 long c_n_ops_received; /* num of ops received (next op_id) */
1627 long c_n_ops_executing; /* num of ops currently executing */
1628 long c_n_ops_pending; /* num of ops pending execution */
1629 long c_n_ops_completed; /* num of ops completed */
1631 long c_n_get; /* num of get calls */
1632 long c_n_read; /* num of read calls */
1633 long c_n_write; /* num of write calls */
1636 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1637 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1639 if ( ldap_debug & (level) ) \
1640 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1641 if ( ldap_syslog & (level) ) \
1642 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1646 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1650 * listener; need to access it from monitor backend
1652 typedef struct slap_listener {
1658 #ifdef LDAP_CONNECTIONLESS
1659 int sl_is_udp; /* UDP listener is also data port */
1663 #define sl_addr sl_sa.sa_in_addr
1666 #ifdef SLAPD_MONITOR
1683 #endif /* SLAPD_MONITOR */
1687 #include "proto-slap.h"
1689 #endif /* _SLAP_H_ */