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 /* X -> Y Converter */
311 typedef int slap_mr_convert_func LDAP_P((
313 struct berval * out ));
316 typedef int slap_mr_normalize_func LDAP_P((
318 struct slap_syntax *syntax, /* NULL if in is asserted value */
319 struct slap_matching_rule *mr,
321 struct berval * out ));
323 /* Match (compare) function */
324 typedef int slap_mr_match_func LDAP_P((
327 struct slap_syntax *syntax, /* syntax of stored value */
328 struct slap_matching_rule *mr,
329 struct berval * value,
330 void * assertValue ));
332 /* Index generation function */
333 typedef int slap_mr_indexer_func LDAP_P((
336 struct slap_syntax *syntax, /* syntax of stored value */
337 struct slap_matching_rule *mr,
338 struct berval *prefix,
342 /* Filter index function */
343 typedef int slap_mr_filter_func LDAP_P((
346 struct slap_syntax *syntax, /* syntax of stored value */
347 struct slap_matching_rule *mr,
348 struct berval *prefix,
352 typedef struct slap_matching_rule {
353 LDAPMatchingRule smr_mrule;
354 ber_len_t smr_oidlen;
355 slap_mask_t smr_usage;
357 #define SLAP_MR_HIDE 0x8000U
359 #define SLAP_MR_TYPE_MASK 0x0F00U
360 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
361 #define SLAP_MR_USAGE 0x000FU
363 #define SLAP_MR_NONE 0x0000U
364 #define SLAP_MR_EQUALITY 0x0100U
365 #define SLAP_MR_ORDERING 0x0200U
366 #define SLAP_MR_SUBSTR 0x0400U
367 #define SLAP_MR_EXT 0x0800U
369 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
370 #define SLAP_MR_DN_FOLD 0x0008U
372 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
373 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
374 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
377 * normally the provided value is expected to conform to
378 * assertion syntax specified in the matching rule, however
379 * at times (such as during individual value modification),
380 * the provided value is expected to conform to the
381 * attribute's value syntax.
383 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
384 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
385 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
387 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
388 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
389 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
390 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
392 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
393 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
394 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
395 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
396 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
397 == SLAP_MR_VALUE_SYNTAX_MATCH)
400 slap_mr_convert_func *smr_convert;
401 slap_mr_normalize_func *smr_normalize;
402 slap_mr_match_func *smr_match;
403 slap_mr_indexer_func *smr_indexer;
404 slap_mr_filter_func *smr_filter;
406 struct slap_matching_rule *smr_associated;
407 struct slap_matching_rule *smr_next;
409 #define smr_oid smr_mrule.mr_oid
410 #define smr_names smr_mrule.mr_names
411 #define smr_desc smr_mrule.mr_desc
412 #define smr_obsolete smr_mrule.mr_obsolete
413 #define smr_syntax_oid smr_mrule.mr_syntax_oid
414 #define smr_extensions smr_mrule.mr_extensions
417 struct slap_backend_db;
421 typedef int (AttributeTypeSchemaCheckFN)(
422 struct slap_backend_db *be,
423 struct slap_entry *e,
424 struct slap_attr *attr,
426 char *textbuf, size_t textlen );
428 typedef struct slap_attribute_type {
429 LDAPAttributeType sat_atype;
430 struct berval sat_cname;
431 struct slap_attribute_type *sat_sup;
432 struct slap_attribute_type **sat_subtypes;
433 MatchingRule *sat_equality;
434 MatchingRule *sat_approx;
435 MatchingRule *sat_ordering;
436 MatchingRule *sat_substr;
439 AttributeTypeSchemaCheckFN *sat_check;
441 #define SLAP_AT_NONE 0x0000U
442 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
443 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
444 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
445 slap_mask_t sat_flags;
447 struct slap_attribute_type *sat_next;
449 #define sat_oid sat_atype.at_oid
450 #define sat_names sat_atype.at_names
451 #define sat_desc sat_atype.at_desc
452 #define sat_obsolete sat_atype.at_obsolete
453 #define sat_sup_oid sat_atype.at_sup_oid
454 #define sat_equality_oid sat_atype.at_equality_oid
455 #define sat_ordering_oid sat_atype.at_ordering_oid
456 #define sat_substr_oid sat_atype.at_substr_oid
457 #define sat_syntax_oid sat_atype.at_syntax_oid
458 #define sat_single_value sat_atype.at_single_value
459 #define sat_collective sat_atype.at_collective
460 #define sat_no_user_mod sat_atype.at_no_user_mod
461 #define sat_usage sat_atype.at_usage
462 #define sat_extensions sat_atype.at_extensions
464 struct slap_attr_desc *sat_ad;
465 ldap_pvt_thread_mutex_t sat_ad_mutex;
468 #define is_at_operational(at) ((at)->sat_usage)
469 #define is_at_single_value(at) ((at)->sat_single_value)
470 #define is_at_collective(at) ((at)->sat_collective)
471 #define is_at_obsolete(at) ((at)->sat_obsolete)
472 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
474 struct slap_object_class;
476 typedef int (ObjectClassSchemaCheckFN)(
477 struct slap_backend_db *be,
478 struct slap_entry *e,
479 struct slap_object_class *oc,
481 char *textbuf, size_t textlen );
483 typedef struct slap_object_class {
484 LDAPObjectClass soc_oclass;
485 struct slap_object_class **soc_sups;
486 AttributeType **soc_required;
487 AttributeType **soc_allowed;
488 ObjectClassSchemaCheckFN *soc_check;
489 slap_mask_t soc_flags;
490 #define soc_oid soc_oclass.oc_oid
491 #define soc_names soc_oclass.oc_names
492 #define soc_desc soc_oclass.oc_desc
493 #define soc_obsolete soc_oclass.oc_obsolete
494 #define soc_sup_oids soc_oclass.oc_sup_oids
495 #define soc_kind soc_oclass.oc_kind
496 #define soc_at_oids_must soc_oclass.oc_at_oids_must
497 #define soc_at_oids_may soc_oclass.oc_at_oids_may
498 #define soc_extensions soc_oclass.oc_extensions
500 struct slap_object_class *soc_next;
503 #define SLAP_OC_ALIAS 0x0001
504 #define SLAP_OC_REFERRAL 0x0002
505 #define SLAP_OC_SUBENTRY 0x0004
506 #define SLAP_OC_DYNAMICOBJECT 0x0008
507 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
508 #define SLAP_OC__MASK 0x001F
509 #define SLAP_OC__END 0x0020
510 #define SLAP_OC_OPERATIONAL 0x4000
511 #define SLAP_OC_HIDE 0x8000
513 #ifdef LDAP_EXTENDED_SCHEMA
517 typedef struct slap_content_rule {
518 LDAPContentRule scr_crule;
519 ObjectClass *scr_sclass;
520 ObjectClass **scr_auxiliaries; /* optional */
521 AttributeType **scr_required; /* optional */
522 AttributeType **scr_allowed; /* optional */
523 AttributeType **scr_precluded; /* optional */
524 #define scr_oid scr_crule.cr_oid
525 #define scr_names scr_crule.cr_names
526 #define scr_desc scr_crule.cr_desc
527 #define scr_obsolete soc_oclass.cr_obsolete
528 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
529 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
530 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
531 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
536 * represents a recognized attribute description ( type + options )
538 typedef struct slap_attr_desc {
539 struct slap_attr_desc *ad_next;
540 AttributeType *ad_type; /* attribute type, must be specified */
541 struct berval ad_cname; /* canonical name, must be specified */
542 struct berval ad_lang; /* empty if no language tags */
544 #define SLAP_DESC_NONE 0x00U
545 #define SLAP_DESC_BINARY 0x01U
546 #define SLAP_DESC_LANG_RANGE 0x80U
547 } AttributeDescription;
549 typedef struct slap_attr_name {
550 struct berval an_name;
551 AttributeDescription *an_desc;
555 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
556 #define slap_ad_is_lang_range(ad) \
557 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
558 #define slap_ad_is_binary(ad) \
559 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
562 * pointers to schema elements used internally
564 struct slap_internal_schema {
566 ObjectClass *si_oc_top;
567 ObjectClass *si_oc_extensibleObject;
568 ObjectClass *si_oc_alias;
569 ObjectClass *si_oc_referral;
570 ObjectClass *si_oc_rootdse;
571 ObjectClass *si_oc_subentry;
572 ObjectClass *si_oc_subschema;
573 ObjectClass *si_oc_monitor;
575 /* objectClass attribute descriptions */
576 AttributeDescription *si_ad_objectClass;
578 /* operational attribute descriptions */
579 AttributeDescription *si_ad_structuralObjectClass;
580 AttributeDescription *si_ad_creatorsName;
581 AttributeDescription *si_ad_createTimestamp;
582 AttributeDescription *si_ad_modifiersName;
583 AttributeDescription *si_ad_modifyTimestamp;
584 AttributeDescription *si_ad_hasSubordinates;
585 AttributeDescription *si_ad_subschemaSubentry;
586 AttributeDescription *si_ad_entryUUID;
587 AttributeDescription *si_ad_entryCSN;
589 /* root DSE attribute descriptions */
590 AttributeDescription *si_ad_altServer;
591 AttributeDescription *si_ad_namingContexts;
592 AttributeDescription *si_ad_supportedControl;
593 AttributeDescription *si_ad_supportedExtension;
594 AttributeDescription *si_ad_supportedLDAPVersion;
595 AttributeDescription *si_ad_supportedSASLMechanisms;
596 AttributeDescription *si_ad_supportedFeatures;
597 AttributeDescription *si_ad_monitorContext;
598 AttributeDescription *si_ad_vendorName;
599 AttributeDescription *si_ad_vendorVersion;
601 /* subentry attribute descriptions */
602 AttributeDescription *si_ad_administrativeRole;
603 AttributeDescription *si_ad_subtreeSpecification;
605 /* subschema subentry attribute descriptions */
606 AttributeDescription *si_ad_ditStructureRules;
607 AttributeDescription *si_ad_ditContentRules;
608 AttributeDescription *si_ad_nameForms;
609 AttributeDescription *si_ad_objectClasses;
610 AttributeDescription *si_ad_attributeTypes;
611 AttributeDescription *si_ad_ldapSyntaxes;
612 AttributeDescription *si_ad_matchingRules;
613 AttributeDescription *si_ad_matchingRuleUse;
615 /* Aliases & Referrals */
616 AttributeDescription *si_ad_aliasedObjectName;
617 AttributeDescription *si_ad_ref;
619 /* Access Control Internals */
620 AttributeDescription *si_ad_entry;
621 AttributeDescription *si_ad_children;
622 AttributeDescription *si_ad_saslAuthzTo;
623 AttributeDescription *si_ad_saslAuthzFrom;
624 #ifdef SLAPD_ACI_ENABLED
625 AttributeDescription *si_ad_aci;
628 /* Other attributes descriptions */
629 AttributeDescription *si_ad_distinguishedName;
630 AttributeDescription *si_ad_name;
631 AttributeDescription *si_ad_cn;
632 AttributeDescription *si_ad_userPassword;
633 #ifdef SLAPD_AUTHPASSWD
634 AttributeDescription *si_ad_authPassword;
636 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
637 AttributeDescription *si_ad_krbName;
640 /* Undefined Attribute Type */
641 AttributeType *si_at_undefined;
644 MatchingRule *si_mr_distinguishedNameMatch;
645 MatchingRule *si_mr_integerMatch;
648 Syntax *si_syn_octetString;
649 Syntax *si_syn_distinguishedName;
650 Syntax *si_syn_integer;
653 typedef struct slap_attr_assertion {
654 AttributeDescription *aa_desc;
655 struct berval aa_value;
656 } AttributeAssertion;
658 typedef struct slap_ss_assertion {
659 AttributeDescription *sa_desc;
660 struct berval sa_initial;
661 struct berval *sa_any;
662 struct berval sa_final;
663 } SubstringsAssertion;
665 typedef struct slap_mr_assertion {
666 MatchingRule *ma_rule; /* optional */
667 struct berval ma_rule_text; /* optional */
668 AttributeDescription *ma_desc; /* optional */
669 int ma_dnattrs; /* boolean */
670 struct berval ma_value; /* required */
671 } MatchingRuleAssertion;
674 * represents a search filter
676 typedef struct slap_filter {
677 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
678 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
679 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
680 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
683 /* precomputed result */
684 ber_int_t f_un_result;
687 struct berval *f_un_dn;
690 AttributeDescription *f_un_desc;
692 /* simple value assertion */
693 AttributeAssertion *f_un_ava;
695 /* substring assertion */
696 SubstringsAssertion *f_un_ssa;
698 /* matching rule assertion */
699 MatchingRuleAssertion *f_un_mra;
701 #define f_dn f_un.f_un_dn
702 #define f_desc f_un.f_un_desc
703 #define f_ava f_un.f_un_ava
704 #define f_av_desc f_un.f_un_ava->aa_desc
705 #define f_av_value f_un.f_un_ava->aa_value
706 #define f_sub f_un.f_un_ssa
707 #define f_sub_desc f_un.f_un_ssa->sa_desc
708 #define f_sub_initial f_un.f_un_ssa->sa_initial
709 #define f_sub_any f_un.f_un_ssa->sa_any
710 #define f_sub_final f_un.f_un_ssa->sa_final
711 #define f_mra f_un.f_un_mra
712 #define f_mr_rule f_un.f_un_mra->ma_rule
713 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
714 #define f_mr_desc f_un.f_un_mra->ma_desc
715 #define f_mr_value f_un.f_un_mra->ma_value
716 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
719 struct slap_filter *f_un_complex;
722 #define f_result f_un.f_un_result
723 #define f_and f_un.f_un_complex
724 #define f_or f_un.f_un_complex
725 #define f_not f_un.f_un_complex
726 #define f_list f_un.f_un_complex
728 struct slap_filter *f_next;
731 /* compare routines can return undefined */
732 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
734 typedef struct slap_valuesreturnfilter {
738 /* precomputed result */
739 ber_int_t f_un_result;
745 AttributeDescription *f_un_desc;
747 /* simple value assertion */
748 AttributeAssertion *f_un_ava;
750 /* substring assertion */
751 SubstringsAssertion *f_un_ssa;
753 /* matching rule assertion */
754 MatchingRuleAssertion *f_un_mra;
757 struct slap_valuesreturnfilter *f_next;
758 } ValuesReturnFilter;
761 * represents an attribute (description + values)
763 typedef struct slap_attr {
764 AttributeDescription *a_desc;
766 struct slap_attr *a_next;
768 #define SLAP_ATTR_IXADD 0x1U
769 #define SLAP_ATTR_IXDEL 0x2U
774 * the id used in the indexes to refer to an entry
776 typedef unsigned long ID;
777 #define NOID ((ID)~0)
780 * represents an entry in core
782 typedef struct slap_entry {
784 * The ID field should only be changed before entry is
785 * inserted into a cache. The ID value is backend
790 struct berval e_name; /* name (DN) of this entry */
791 struct berval e_nname; /* normalized name (DN) of this entry */
793 /* for migration purposes */
794 #define e_dn e_name.bv_val
795 #define e_ndn e_nname.bv_val
797 Attribute *e_attrs; /* list of attributes + values */
799 slap_mask_t e_ocflags;
801 struct berval e_bv; /* For entry_encode/entry_decode */
803 /* for use by the backend for any purpose */
810 typedef struct slap_mod {
812 AttributeDescription *sm_desc;
813 struct berval sm_type;
814 BerVarray sm_bvalues;
817 typedef struct slap_mod_list {
818 Modification sml_mod;
819 #define sml_op sml_mod.sm_op
820 #define sml_desc sml_mod.sm_desc
821 #define sml_type sml_mod.sm_type
822 #define sml_bvalues sml_mod.sm_bvalues
823 struct slap_mod_list *sml_next;
826 typedef struct slap_ldap_modlist {
828 struct slap_ldap_modlist *ml_next;
829 #define ml_op ml_mod.mod_op
830 #define ml_type ml_mod.mod_type
831 #define ml_values ml_mod.mod_values
832 #define ml_bvalues ml_mod.mod_bvalues
836 * represents an access control list
838 typedef enum slap_access_e {
839 ACL_INVALID_ACCESS = -1,
848 typedef enum slap_control_e {
849 ACL_INVALID_CONTROL = 0,
855 typedef enum slap_style_e {
863 /* alternate names */
864 ACL_STYLE_EXACT = ACL_STYLE_BASE
867 typedef struct slap_authz_info {
868 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
869 struct berval sai_mech; /* SASL Mechanism */
870 struct berval sai_dn; /* DN for reporting purposes */
871 struct berval sai_ndn; /* Normalized DN */
873 /* Security Strength Factors */
874 slap_ssf_t sai_ssf; /* Overall SSF */
875 slap_ssf_t sai_transport_ssf; /* Transport SSF */
876 slap_ssf_t sai_tls_ssf; /* TLS SSF */
877 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
878 } AuthorizationInformation;
881 typedef struct slap_access {
882 slap_control_t a_type;
884 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
886 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
887 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
888 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
889 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
890 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
891 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
893 #define ACL_PRIV_MASK 0x00ffUL
896 #define ACL_PRIV_LEVEL 0x1000UL
897 #define ACL_PRIV_ADDITIVE 0x2000UL
898 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
901 #define ACL_PRIV_INVALID 0x0UL
903 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
904 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
905 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
906 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
908 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
909 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
911 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
913 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
915 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
916 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
917 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
919 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
920 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
921 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
922 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
923 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
924 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
926 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
927 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
928 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
929 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
930 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
931 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
932 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
934 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
935 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
936 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
937 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
938 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
939 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
941 slap_mask_t a_access_mask;
943 AuthorizationInformation a_authz;
944 #define a_dn_pat a_authz.sai_dn
946 slap_style_t a_dn_style;
947 AttributeDescription *a_dn_at;
951 slap_style_t a_peername_style;
952 struct berval a_peername_pat;
953 slap_style_t a_sockname_style;
954 struct berval a_sockname_pat;
956 slap_style_t a_domain_style;
957 struct berval a_domain_pat;
960 slap_style_t a_sockurl_style;
961 struct berval a_sockurl_pat;
962 slap_style_t a_set_style;
963 struct berval a_set_pat;
965 #ifdef SLAPD_ACI_ENABLED
966 AttributeDescription *a_aci_at;
970 slap_style_t a_group_style;
971 struct berval a_group_pat;
972 ObjectClass *a_group_oc;
973 AttributeDescription *a_group_at;
975 struct slap_access *a_next;
979 typedef struct slap_acl {
980 /* "to" part: the entries this acl applies to */
982 slap_style_t acl_dn_style;
984 struct berval acl_dn_pat;
985 AttributeName *acl_attrs;
987 /* "by" part: list of who has what access to the entries */
990 struct slap_acl *acl_next;
993 typedef struct slap_acl_state {
994 unsigned as_recorded;
995 #define ACL_STATE_NOT_RECORDED 0x0
996 #define ACL_STATE_RECORDED_VD 0x1
997 #define ACL_STATE_RECORDED_NV 0x2
998 #define ACL_STATE_RECORDED 0x3
1001 AccessControl *as_vd_acl;
1002 slap_mask_t as_vd_acl_mask;
1003 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1004 int as_vd_acl_count;
1006 Access *as_vd_access;
1007 int as_vd_access_count;
1010 } AccessControlState;
1011 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1014 * replog moddn param structure
1016 struct slap_replog_moddn {
1017 struct berval *newrdn;
1019 struct berval *newsup;
1024 * represents a backend
1027 typedef struct slap_backend_info BackendInfo; /* per backend type */
1028 typedef struct slap_backend_db BackendDB; /* per backend database */
1030 LDAP_SLAPD_V (int) nBackendInfo;
1031 LDAP_SLAPD_V (int) nBackendDB;
1032 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1033 LDAP_SLAPD_V (BackendDB *) backendDB;
1035 LDAP_SLAPD_V (int) slapMode;
1036 #define SLAP_UNDEFINED_MODE 0x0000
1037 #define SLAP_SERVER_MODE 0x0001
1038 #define SLAP_TOOL_MODE 0x0002
1039 #define SLAP_MODE 0x0003
1041 #define SLAP_TRUNCATE_MODE 0x0100
1043 struct slap_replica_info {
1044 char *ri_host; /* supersedes be_replica */
1045 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1046 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1047 int ri_exclude; /* 1 => exclude ri_attrs */
1050 struct slap_limits_set {
1058 int lms_s_unchecked;
1061 struct slap_limits {
1062 int lm_type; /* type of pattern */
1063 #define SLAP_LIMITS_UNDEFINED 0x0000
1064 #define SLAP_LIMITS_EXACT 0x0001
1065 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1066 #define SLAP_LIMITS_ONE 0x0002
1067 #define SLAP_LIMITS_SUBTREE 0x0003
1068 #define SLAP_LIMITS_CHILDREN 0x0004
1069 #define SLAP_LIMITS_REGEX 0x0005
1070 #define SLAP_LIMITS_ANONYMOUS 0x0006
1071 #define SLAP_LIMITS_USERS 0x0007
1072 #define SLAP_LIMITS_ANY 0x0008
1073 regex_t lm_dn_regex; /* regex data for REGEX */
1076 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1077 * pattern for REGEX; NULL for ANONYMOUS, USERS
1079 struct berval lm_dn_pat;
1081 struct slap_limits_set lm_limits;
1084 /* temporary aliases */
1085 typedef BackendDB Backend;
1086 #define nbackends nBackendDB
1087 #define backends backendDB
1089 struct slap_backend_db {
1090 BackendInfo *bd_info; /* pointer to shared backend info */
1092 /* BackendInfo accessors */
1093 #define be_config bd_info->bi_db_config
1094 #define be_type bd_info->bi_type
1096 #define be_bind bd_info->bi_op_bind
1097 #define be_unbind bd_info->bi_op_unbind
1098 #define be_add bd_info->bi_op_add
1099 #define be_compare bd_info->bi_op_compare
1100 #define be_delete bd_info->bi_op_delete
1101 #define be_modify bd_info->bi_op_modify
1102 #define be_modrdn bd_info->bi_op_modrdn
1103 #define be_search bd_info->bi_op_search
1105 #define be_extended bd_info->bi_extended
1107 #define be_release bd_info->bi_entry_release_rw
1108 #define be_chk_referrals bd_info->bi_chk_referrals
1109 #define be_group bd_info->bi_acl_group
1110 #define be_attribute bd_info->bi_acl_attribute
1111 #define be_operational bd_info->bi_operational
1113 #define be_controls bd_info->bi_controls
1115 #define be_connection_init bd_info->bi_connection_init
1116 #define be_connection_destroy bd_info->bi_connection_destroy
1119 #define be_entry_open bd_info->bi_tool_entry_open
1120 #define be_entry_close bd_info->bi_tool_entry_close
1121 #define be_entry_first bd_info->bi_tool_entry_first
1122 #define be_entry_next bd_info->bi_tool_entry_next
1123 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1124 #define be_entry_get bd_info->bi_tool_entry_get
1125 #define be_entry_put bd_info->bi_tool_entry_put
1126 #define be_sync bd_info->bi_tool_sync
1129 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1130 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1131 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1132 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1133 #define SLAP_BFLAG_ALIASES 0x0100U
1134 #define SLAP_BFLAG_REFERRALS 0x0200U
1135 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1136 #define SLAP_BFLAG_MONITOR 0x1000U
1137 #define SLAP_BFLAG_DYNAMIC 0x2000U
1138 slap_mask_t be_flags;
1139 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1140 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1141 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1142 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1143 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1144 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1146 slap_mask_t be_restrictops; /* restriction operations */
1147 #define SLAP_RESTRICT_OP_ADD 0x0001U
1148 #define SLAP_RESTRICT_OP_BIND 0x0002U
1149 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1150 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1151 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1152 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1153 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1154 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1156 #define SLAP_RESTRICT_OP_READS \
1157 ( SLAP_RESTRICT_OP_COMPARE \
1158 | SLAP_RESTRICT_OP_SEARCH )
1159 #define SLAP_RESTRICT_OP_WRITES \
1160 ( SLAP_RESTRICT_OP_ADD \
1161 | SLAP_RESTRICT_OP_DELETE \
1162 | SLAP_RESTRICT_OP_MODIFY \
1163 | SLAP_RESTRICT_OP_RENAME )
1165 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1166 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1167 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1169 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1170 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1171 #define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
1172 0x0004U /* unprotected simple auth */
1173 #define SLAP_DISALLOW_BIND_KRBV4 0x0008U /* Kerberos V4 authentication */
1175 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1176 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1178 slap_mask_t be_requires; /* pre-operation requirements */
1179 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1180 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1181 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1182 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1183 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1185 /* Required Security Strength Factor */
1186 slap_ssf_set_t be_ssf_set;
1188 /* these should be renamed from be_ to bd_ */
1189 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1190 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1191 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1192 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1193 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1194 struct berval be_rootpw; /* the magic "root" password for this db */
1195 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1196 #define be_sizelimit be_def_limit.lms_s_soft
1197 #define be_timelimit be_def_limit.lms_t_soft
1198 struct slap_limits_set be_def_limit; /* default limits */
1199 struct slap_limits **be_limits; /* regex-based size and time limits */
1200 AccessControl *be_acl; /* access control list for this backend */
1201 slap_access_t be_dfltaccess; /* access given if no acl matches */
1202 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1203 char *be_replogfile; /* replication log file (in master) */
1204 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1205 BerVarray be_update_refs; /* where to refer modifying clients to */
1207 void *be_private; /* anything the backend database needs */
1213 /* Backend function typedefs */
1214 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1215 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1216 const char *fname, int lineno,
1217 int argc, char **argv));
1218 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1219 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1220 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1222 typedef int (BI_db_init) LDAP_P((Backend *bd));
1223 typedef int (BI_db_config) LDAP_P((Backend *bd,
1224 const char *fname, int lineno,
1225 int argc, char **argv));
1226 typedef int (BI_db_open) LDAP_P((Backend *bd));
1227 typedef int (BI_db_close) LDAP_P((Backend *bd));
1228 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1230 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1231 struct slap_conn *c, struct slap_op *o,
1232 struct berval *dn, struct berval *ndn, int method,
1233 struct berval *cred, struct berval *edn ));
1234 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1235 struct slap_conn *c, struct slap_op *o ));
1236 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1237 struct slap_conn *c, struct slap_op *o,
1238 struct berval *base, struct berval *nbase,
1239 int scope, int deref,
1240 int slimit, int tlimit,
1241 Filter *f, struct berval *filterstr,
1242 AttributeName *attrs, int attrsonly));
1243 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1244 struct slap_conn *c, struct slap_op *o,
1245 struct berval *dn, struct berval *ndn,
1246 AttributeAssertion *ava));
1247 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1248 struct slap_conn *c, struct slap_op *o,
1249 struct berval *dn, struct berval *ndn,
1251 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1252 struct slap_conn *c, struct slap_op *o,
1253 struct berval *dn, struct berval *ndn,
1254 struct berval *newrdn, struct berval *nnewrdn,
1256 struct berval *newSup, struct berval *nnewSup ));
1257 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1258 struct slap_conn *c, struct slap_op *o,
1260 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1261 struct slap_conn *c, struct slap_op *o,
1262 struct berval *dn, struct berval *ndn));
1263 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1264 struct slap_conn *c, struct slap_op *o,
1267 typedef int (BI_op_extended) LDAP_P((
1269 struct slap_conn *conn,
1272 struct berval * reqdata,
1274 struct berval ** rspdata,
1275 LDAPControl *** rspctrls,
1279 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1280 struct slap_conn *c, struct slap_op *o,
1283 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1284 struct slap_conn *c, struct slap_op *o,
1285 struct berval *dn, struct berval *ndn,
1286 const char **text ));
1288 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1289 struct slap_conn *c, struct slap_op *o,
1293 ObjectClass *group_oc,
1294 AttributeDescription *group_at ));
1296 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1297 struct slap_conn *c, struct slap_op *o,
1298 Entry *e, struct berval *edn,
1299 AttributeDescription *entry_at,
1302 typedef int (BI_operational) LDAP_P((Backend *bd,
1303 struct slap_conn *c, struct slap_op *o,
1304 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1306 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1307 struct slap_conn *c));
1308 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1309 struct slap_conn *c));
1311 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1312 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1313 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1314 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1315 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1316 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1317 struct berval *text ));
1318 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1319 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1321 struct slap_backend_info {
1322 char *bi_type; /* type of backend */
1325 * per backend type routines:
1326 * bi_init: called to allocate a backend_info structure,
1327 * called once BEFORE configuration file is read.
1328 * bi_init() initializes this structure hence is
1329 * called directly from be_initialize()
1330 * bi_config: called per 'backend' specific option
1331 * all such options must before any 'database' options
1332 * bi_config() is called only from read_config()
1333 * bi_open: called to open each database, called
1334 * once AFTER configuration file is read but
1335 * BEFORE any bi_db_open() calls.
1336 * bi_open() is called from backend_startup()
1337 * bi_close: called to close each database, called
1338 * once during shutdown after all bi_db_close calls.
1339 * bi_close() is called from backend_shutdown()
1340 * bi_destroy: called to destroy each database, called
1341 * once during shutdown after all bi_db_destroy calls.
1342 * bi_destory() is called from backend_destroy()
1345 BI_config *bi_config;
1348 BI_destroy *bi_destroy;
1351 * per database routines:
1352 * bi_db_init: called to initialize each database,
1353 * called upon reading 'database <type>'
1354 * called only from backend_db_init()
1355 * bi_db_config: called to configure each database,
1356 * called per database to handle per database options
1357 * called only from read_config()
1358 * bi_db_open: called to open each database
1359 * called once per database immediately AFTER bi_open()
1360 * calls but before daemon startup.
1361 * called only by backend_startup()
1362 * bi_db_close: called to close each database
1363 * called once per database during shutdown but BEFORE
1364 * any bi_close call.
1365 * called only by backend_shutdown()
1366 * bi_db_destroy: called to destroy each database
1367 * called once per database during shutdown AFTER all
1368 * bi_close calls but before bi_destory calls.
1369 * called only by backend_destory()
1371 BI_db_init *bi_db_init;
1372 BI_db_config *bi_db_config;
1373 BI_db_open *bi_db_open;
1374 BI_db_close *bi_db_close;
1375 BI_db_destroy *bi_db_destroy;
1377 /* LDAP Operations Handling Routines */
1378 BI_op_bind *bi_op_bind;
1379 BI_op_unbind *bi_op_unbind;
1380 BI_op_search *bi_op_search;
1381 BI_op_compare *bi_op_compare;
1382 BI_op_modify *bi_op_modify;
1383 BI_op_modrdn *bi_op_modrdn;
1384 BI_op_add *bi_op_add;
1385 BI_op_delete *bi_op_delete;
1386 BI_op_abandon *bi_op_abandon;
1388 /* Extended Operations Helper */
1389 BI_op_extended *bi_extended;
1391 /* Auxilary Functions */
1392 BI_entry_release_rw *bi_entry_release_rw;
1393 BI_chk_referrals *bi_chk_referrals;
1395 BI_acl_group *bi_acl_group;
1396 BI_acl_attribute *bi_acl_attribute;
1398 BI_operational *bi_operational;
1400 BI_connection_init *bi_connection_init;
1401 BI_connection_destroy *bi_connection_destroy;
1403 /* hooks for slap tools */
1404 BI_tool_entry_open *bi_tool_entry_open;
1405 BI_tool_entry_close *bi_tool_entry_close;
1406 BI_tool_entry_first *bi_tool_entry_first;
1407 BI_tool_entry_next *bi_tool_entry_next;
1408 BI_tool_entry_get *bi_tool_entry_get;
1409 BI_tool_entry_put *bi_tool_entry_put;
1410 BI_tool_entry_reindex *bi_tool_entry_reindex;
1411 BI_tool_sync *bi_tool_sync;
1413 #define SLAP_INDEX_ADD_OP 0x0001
1414 #define SLAP_INDEX_DELETE_OP 0x0002
1416 char **bi_controls; /* supported controls */
1418 unsigned int bi_nDB; /* number of databases of this type */
1419 void *bi_private; /* anything the backend type needs */
1422 #define c_authtype c_authz.sai_method
1423 #define c_authmech c_authz.sai_mech
1424 #define c_dn c_authz.sai_dn
1425 #define c_ndn c_authz.sai_ndn
1426 #define c_ssf c_authz.sai_ssf
1427 #define c_transport_ssf c_authz.sai_transport_ssf
1428 #define c_tls_ssf c_authz.sai_tls_ssf
1429 #define c_sasl_ssf c_authz.sai_sasl_ssf
1431 #define o_authtype o_authz.sai_method
1432 #define o_authmech o_authz.sai_mech
1433 #define o_dn o_authz.sai_dn
1434 #define o_ndn o_authz.sai_ndn
1435 #define o_ssf o_authz.sai_ssf
1436 #define o_transport_ssf o_authz.sai_transport_ssf
1437 #define o_tls_ssf o_authz.sai_tls_ssf
1438 #define o_sasl_ssf o_authz.sai_sasl_ssf
1440 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1441 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1442 BerVarray, const char *, struct berval *,
1443 struct berval *, LDAPControl ** );
1445 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1446 ber_int_t, const char *, const char *, BerVarray,
1447 LDAPControl **, int nentries);
1449 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1450 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1452 typedef struct slap_callback {
1453 slap_response *sc_response;
1454 slap_sresult *sc_sresult;
1455 slap_sendentry *sc_sendentry;
1460 * Paged Results state
1462 typedef unsigned long PagedResultsCookie;
1463 typedef struct slap_paged_state {
1465 PagedResultsCookie ps_cookie;
1467 } PagedResultsState;
1470 * represents an operation pending from an ldap client
1472 typedef struct slap_op {
1473 unsigned long o_opid; /* id of this operation */
1474 unsigned long o_connid; /* id of conn initiating this op */
1476 ber_int_t o_msgid; /* msgid of the request */
1477 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1478 ber_tag_t o_tag; /* tag of the request */
1479 time_t o_time; /* time op was initiated */
1481 ldap_pvt_thread_t o_tid; /* thread handling this op */
1483 volatile sig_atomic_t o_abandon; /* abandon flag */
1485 #define SLAP_NO_CONTROL 0
1486 #define SLAP_NONCRITICAL_CONTROL 1
1487 #define SLAP_CRITICAL_CONTROL 2
1491 char o_subentries_visibility;
1492 char o_valuesreturnfilter;
1494 char o_pagedresults;
1495 ber_int_t o_pagedresults_size;
1496 PagedResultsState o_pagedresults_state;
1498 #ifdef LDAP_CONNECTIONLESS
1499 Sockaddr o_peeraddr; /* UDP peer address */
1501 AuthorizationInformation o_authz;
1503 BerElement *o_ber; /* ber of the request */
1504 slap_callback *o_callback; /* callback pointers */
1505 LDAPControl **o_ctrls; /* controls */
1507 void *o_private; /* anything the backend needs */
1509 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1510 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1513 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1514 #define get_subentries(op) ((int)(op)->o_subentries)
1515 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1518 * Caches the result of a backend_group check for ACL evaluation
1520 typedef struct slap_gacl {
1521 struct slap_gacl *ga_next;
1524 AttributeDescription *ga_at;
1531 * represents a connection from an ldap client
1533 typedef struct slap_conn {
1534 int c_struct_state; /* structure management state */
1535 int c_conn_state; /* connection state */
1537 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1538 Sockbuf *c_sb; /* ber connection stuff */
1540 /* only can be changed by connect_init */
1541 time_t c_starttime; /* when the connection was opened */
1542 time_t c_activitytime; /* when the connection was last used */
1543 unsigned long c_connid; /* id of this connection for stats*/
1545 struct berval c_listener_url; /* listener URL */
1546 struct berval c_peer_domain; /* DNS name of client */
1547 struct berval c_peer_name; /* peer name (trans=addr:port) */
1548 struct berval c_sock_name; /* sock name (trans=addr:port) */
1550 /* only can be changed by binding thread */
1551 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1552 struct berval c_sasl_bind_mech; /* mech in progress */
1553 struct berval c_sasl_dn; /* temporary storage */
1555 /* authorization backend */
1556 Backend *c_authz_backend;
1558 AuthorizationInformation c_authz;
1559 GroupAssertion *c_groups;
1561 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1563 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1564 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1566 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1567 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1569 BerElement *c_currentber; /* ber we're attempting to read */
1570 int c_writewaiter; /* true if writer is waiting */
1572 #ifdef LDAP_CONNECTIONLESS
1573 int c_is_udp; /* true if this is (C)LDAP over UDP */
1576 int c_is_tls; /* true if this LDAP over raw TLS */
1577 int c_needs_tls_accept; /* true if SSL_accept should be called */
1579 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1580 void *c_sasl_context; /* SASL session context */
1581 void *c_sasl_extra; /* SASL session extra stuff */
1583 PagedResultsState c_pagedresults_state; /* paged result state */
1585 long c_n_ops_received; /* num of ops received (next op_id) */
1586 long c_n_ops_executing; /* num of ops currently executing */
1587 long c_n_ops_pending; /* num of ops pending execution */
1588 long c_n_ops_completed; /* num of ops completed */
1590 long c_n_get; /* num of get calls */
1591 long c_n_read; /* num of read calls */
1592 long c_n_write; /* num of write calls */
1595 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1596 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1598 if ( ldap_debug & (level) ) \
1599 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1600 if ( ldap_syslog & (level) ) \
1601 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1605 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1609 * listener; need to access it from monitor backend
1611 typedef struct slap_listener {
1617 #ifdef LDAP_CONNECTIONLESS
1618 int sl_is_udp; /* UDP listener is also data port */
1622 #define sl_addr sl_sa.sa_in_addr
1625 #ifdef SLAPD_MONITOR
1642 #endif /* SLAPD_MONITOR */
1646 #include "proto-slap.h"
1648 #endif /* _SLAP_H_ */