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;
253 typedef struct slap_oid_macro {
254 struct berval som_oid;
256 struct slap_oid_macro *som_next;
259 /* forward declarations */
261 struct slap_matching_rule;
263 typedef int slap_syntax_validate_func LDAP_P((
264 struct slap_syntax *syntax,
265 struct berval * in));
267 typedef int slap_syntax_transform_func LDAP_P((
268 struct slap_syntax *syntax,
270 struct berval * out));
272 typedef struct slap_syntax {
274 #define ssyn_oid ssyn_syn.syn_oid
275 #define ssyn_desc ssyn_syn.syn_desc
276 #define ssyn_extensions ssyn_syn.syn_extensions
277 ber_len_t ssyn_oidlen;
279 unsigned int ssyn_flags;
281 #define SLAP_SYNTAX_NONE 0x0000U
282 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
283 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
284 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
285 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
287 slap_syntax_validate_func *ssyn_validate;
288 slap_syntax_transform_func *ssyn_normalize;
289 slap_syntax_transform_func *ssyn_pretty;
291 #ifdef SLAPD_BINARY_CONVERSION
292 /* convert to and from binary */
293 slap_syntax_transform_func *ssyn_ber2str;
294 slap_syntax_transform_func *ssyn_str2ber;
297 struct slap_syntax *ssyn_next;
300 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
301 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
302 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
303 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
304 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
306 /* X -> Y Converter */
307 typedef int slap_mr_convert_func LDAP_P((
309 struct berval * out ));
312 typedef int slap_mr_normalize_func LDAP_P((
314 struct slap_syntax *syntax, /* NULL if in is asserted value */
315 struct slap_matching_rule *mr,
317 struct berval * out ));
319 /* Match (compare) function */
320 typedef int slap_mr_match_func LDAP_P((
323 struct slap_syntax *syntax, /* syntax of stored value */
324 struct slap_matching_rule *mr,
325 struct berval * value,
326 void * assertValue ));
328 /* Index generation function */
329 typedef int slap_mr_indexer_func LDAP_P((
332 struct slap_syntax *syntax, /* syntax of stored value */
333 struct slap_matching_rule *mr,
334 struct berval *prefix,
338 /* Filter index function */
339 typedef int slap_mr_filter_func LDAP_P((
342 struct slap_syntax *syntax, /* syntax of stored value */
343 struct slap_matching_rule *mr,
344 struct berval *prefix,
348 typedef struct slap_matching_rule {
349 LDAPMatchingRule smr_mrule;
350 ber_len_t smr_oidlen;
351 slap_mask_t smr_usage;
353 #define SLAP_MR_HIDE 0x8000U
355 #define SLAP_MR_TYPE_MASK 0x0F00U
356 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
357 #define SLAP_MR_USAGE 0x000FU
359 #define SLAP_MR_NONE 0x0000U
360 #define SLAP_MR_EQUALITY 0x0100U
361 #define SLAP_MR_ORDERING 0x0200U
362 #define SLAP_MR_SUBSTR 0x0400U
363 #define SLAP_MR_EXT 0x0800U
365 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
366 #define SLAP_MR_DN_FOLD 0x0008U
368 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
369 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
370 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
373 * normally the provided value is expected to conform to
374 * assertion syntax specified in the matching rule, however
375 * at times (such as during individual value modification),
376 * the provided value is expected to conform to the
377 * attribute's value syntax.
379 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
380 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
381 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
383 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
384 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
385 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
386 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
388 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
389 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
390 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
391 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
392 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
393 == SLAP_MR_VALUE_SYNTAX_MATCH)
396 slap_mr_convert_func *smr_convert;
397 slap_mr_normalize_func *smr_normalize;
398 slap_mr_match_func *smr_match;
399 slap_mr_indexer_func *smr_indexer;
400 slap_mr_filter_func *smr_filter;
402 struct slap_matching_rule *smr_associated;
403 struct slap_matching_rule *smr_next;
405 #define smr_oid smr_mrule.mr_oid
406 #define smr_names smr_mrule.mr_names
407 #define smr_desc smr_mrule.mr_desc
408 #define smr_obsolete smr_mrule.mr_obsolete
409 #define smr_syntax_oid smr_mrule.mr_syntax_oid
410 #define smr_extensions smr_mrule.mr_extensions
413 struct slap_backend_db;
417 typedef int (AttributeTypeSchemaCheckFN)(
418 struct slap_backend_db *be,
419 struct slap_entry *e,
420 struct slap_attr *attr,
422 char *textbuf, size_t textlen );
424 typedef struct slap_attribute_type {
425 LDAPAttributeType sat_atype;
426 struct berval sat_cname;
427 struct slap_attribute_type *sat_sup;
428 struct slap_attribute_type **sat_subtypes;
429 MatchingRule *sat_equality;
430 MatchingRule *sat_approx;
431 MatchingRule *sat_ordering;
432 MatchingRule *sat_substr;
435 AttributeTypeSchemaCheckFN *sat_check;
437 #define SLAP_AT_NONE 0x0000U
438 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
439 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
440 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
441 slap_mask_t sat_flags;
443 struct slap_attribute_type *sat_next;
445 #define sat_oid sat_atype.at_oid
446 #define sat_names sat_atype.at_names
447 #define sat_desc sat_atype.at_desc
448 #define sat_obsolete sat_atype.at_obsolete
449 #define sat_sup_oid sat_atype.at_sup_oid
450 #define sat_equality_oid sat_atype.at_equality_oid
451 #define sat_ordering_oid sat_atype.at_ordering_oid
452 #define sat_substr_oid sat_atype.at_substr_oid
453 #define sat_syntax_oid sat_atype.at_syntax_oid
454 #define sat_single_value sat_atype.at_single_value
455 #define sat_collective sat_atype.at_collective
456 #define sat_no_user_mod sat_atype.at_no_user_mod
457 #define sat_usage sat_atype.at_usage
458 #define sat_extensions sat_atype.at_extensions
460 struct slap_attr_desc *sat_ad;
461 ldap_pvt_thread_mutex_t sat_ad_mutex;
464 #define is_at_operational(at) ((at)->sat_usage)
465 #define is_at_single_value(at) ((at)->sat_single_value)
466 #define is_at_collective(at) ((at)->sat_collective)
467 #define is_at_obsolete(at) ((at)->sat_obsolete)
468 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
470 struct slap_object_class;
472 typedef int (ObjectClassSchemaCheckFN)(
473 struct slap_backend_db *be,
474 struct slap_entry *e,
475 struct slap_object_class *oc,
477 char *textbuf, size_t textlen );
479 typedef struct slap_object_class {
480 LDAPObjectClass soc_oclass;
481 struct slap_object_class **soc_sups;
482 AttributeType **soc_required;
483 AttributeType **soc_allowed;
484 ObjectClassSchemaCheckFN *soc_check;
485 slap_mask_t soc_flags;
486 #define soc_oid soc_oclass.oc_oid
487 #define soc_names soc_oclass.oc_names
488 #define soc_desc soc_oclass.oc_desc
489 #define soc_obsolete soc_oclass.oc_obsolete
490 #define soc_sup_oids soc_oclass.oc_sup_oids
491 #define soc_kind soc_oclass.oc_kind
492 #define soc_at_oids_must soc_oclass.oc_at_oids_must
493 #define soc_at_oids_may soc_oclass.oc_at_oids_may
494 #define soc_extensions soc_oclass.oc_extensions
496 struct slap_object_class *soc_next;
499 #define SLAP_OC_ALIAS 0x0001
500 #define SLAP_OC_REFERRAL 0x0002
501 #define SLAP_OC_SUBENTRY 0x0004
502 #define SLAP_OC_DYNAMICOBJECT 0x0008
503 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
504 #define SLAP_OC__MASK 0x001F
505 #define SLAP_OC__END 0x0020
506 #define SLAP_OC_OPERATIONAL 0x4000
507 #define SLAP_OC_HIDE 0x8000
509 #ifdef LDAP_EXTENDED_SCHEMA
513 typedef struct slap_content_rule {
514 LDAPContentRule scr_crule;
515 ObjectClass *scr_sclass;
516 ObjectClass **scr_auxiliaries; /* optional */
517 AttributeType **scr_required; /* optional */
518 AttributeType **scr_allowed; /* optional */
519 AttributeType **scr_precluded; /* optional */
520 #define scr_oid scr_crule.cr_oid
521 #define scr_names scr_crule.cr_names
522 #define scr_desc scr_crule.cr_desc
523 #define scr_obsolete soc_oclass.cr_obsolete
524 #define scr_cr_oids_aux soc_oclass.cr_oc_oids_aux
525 #define scr_cr_oids_must soc_oclass.cr_at_oids_must
526 #define scr_cr_oids_may soc_oclass.cr_at_oids_may
527 #define scr_cr_oids_not soc_oclass.cr_at_oids_not
532 * represents a recognized attribute description ( type + options )
534 typedef struct slap_attr_desc {
535 struct slap_attr_desc *ad_next;
536 AttributeType *ad_type; /* attribute type, must be specified */
537 struct berval ad_cname; /* canonical name, must be specified */
538 struct berval ad_lang; /* empty if no language tags */
540 #define SLAP_DESC_NONE 0x00U
541 #define SLAP_DESC_BINARY 0x01U
542 #define SLAP_DESC_LANG_RANGE 0x80U
543 } AttributeDescription;
545 typedef struct slap_attr_name {
546 struct berval an_name;
547 AttributeDescription *an_desc;
551 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
552 #define slap_ad_is_lang_range(ad) \
553 ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
554 #define slap_ad_is_binary(ad) \
555 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
558 * pointers to schema elements used internally
560 struct slap_internal_schema {
562 ObjectClass *si_oc_top;
563 ObjectClass *si_oc_extensibleObject;
564 ObjectClass *si_oc_alias;
565 ObjectClass *si_oc_referral;
566 ObjectClass *si_oc_rootdse;
567 ObjectClass *si_oc_subentry;
568 ObjectClass *si_oc_subschema;
569 ObjectClass *si_oc_monitor;
570 ObjectClass *si_oc_collectiveAttributeSubentry;
571 ObjectClass *si_oc_dynamicObject;
573 /* objectClass attribute descriptions */
574 AttributeDescription *si_ad_objectClass;
576 /* operational attribute descriptions */
577 AttributeDescription *si_ad_structuralObjectClass;
578 AttributeDescription *si_ad_creatorsName;
579 AttributeDescription *si_ad_createTimestamp;
580 AttributeDescription *si_ad_modifiersName;
581 AttributeDescription *si_ad_modifyTimestamp;
582 AttributeDescription *si_ad_hasSubordinates;
583 AttributeDescription *si_ad_subschemaSubentry;
584 AttributeDescription *si_ad_collectiveSubentries;
585 AttributeDescription *si_ad_collectiveExclusions;
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_vendorName;
598 AttributeDescription *si_ad_vendorVersion;
600 /* subentry attribute descriptions */
601 AttributeDescription *si_ad_administrativeRole;
602 AttributeDescription *si_ad_subtreeSpecification;
604 /* subschema subentry attribute descriptions */
605 AttributeDescription *si_ad_ditStructureRules;
606 AttributeDescription *si_ad_ditContentRules;
607 AttributeDescription *si_ad_nameForms;
608 AttributeDescription *si_ad_objectClasses;
609 AttributeDescription *si_ad_attributeTypes;
610 AttributeDescription *si_ad_ldapSyntaxes;
611 AttributeDescription *si_ad_matchingRules;
612 AttributeDescription *si_ad_matchingRuleUse;
614 /* Aliases & Referrals */
615 AttributeDescription *si_ad_aliasedObjectName;
616 AttributeDescription *si_ad_ref;
618 /* Access Control Internals */
619 AttributeDescription *si_ad_entry;
620 AttributeDescription *si_ad_children;
621 #ifdef SLAPD_ACI_ENABLED
622 AttributeDescription *si_ad_aci;
625 /* dynamic entries */
626 AttributeDescription *si_ad_entryTtl;
627 AttributeDescription *si_ad_dynamicSubtrees;
629 /* Other attributes descriptions */
630 AttributeDescription *si_ad_distinguishedName;
631 AttributeDescription *si_ad_name;
632 AttributeDescription *si_ad_cn;
633 AttributeDescription *si_ad_userPassword;
634 #ifdef SLAPD_AUTHPASSWD
635 AttributeDescription *si_ad_authPassword;
637 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
638 AttributeDescription *si_ad_krbName;
641 /* Undefined Attribute Type */
642 AttributeType *si_at_undefined;
645 MatchingRule *si_mr_distinguishedNameMatch;
646 MatchingRule *si_mr_integerMatch;
649 Syntax *si_syn_octetString;
650 Syntax *si_syn_distinguishedName;
651 Syntax *si_syn_integer;
654 typedef struct slap_attr_assertion {
655 AttributeDescription *aa_desc;
656 struct berval aa_value;
657 } AttributeAssertion;
659 typedef struct slap_ss_assertion {
660 AttributeDescription *sa_desc;
661 struct berval sa_initial;
662 struct berval *sa_any;
663 struct berval sa_final;
664 } SubstringsAssertion;
666 typedef struct slap_mr_assertion {
667 MatchingRule *ma_rule; /* optional */
668 struct berval ma_rule_text; /* optional */
669 AttributeDescription *ma_desc; /* optional */
670 int ma_dnattrs; /* boolean */
671 struct berval ma_value; /* required */
672 } MatchingRuleAssertion;
675 * represents a search filter
677 typedef struct slap_filter {
678 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
679 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
680 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
681 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
684 /* precomputed result */
685 ber_int_t f_un_result;
688 struct berval *f_un_dn;
691 AttributeDescription *f_un_desc;
693 /* simple value assertion */
694 AttributeAssertion *f_un_ava;
696 /* substring assertion */
697 SubstringsAssertion *f_un_ssa;
699 /* matching rule assertion */
700 MatchingRuleAssertion *f_un_mra;
702 #define f_dn f_un.f_un_dn
703 #define f_desc f_un.f_un_desc
704 #define f_ava f_un.f_un_ava
705 #define f_av_desc f_un.f_un_ava->aa_desc
706 #define f_av_value f_un.f_un_ava->aa_value
707 #define f_sub f_un.f_un_ssa
708 #define f_sub_desc f_un.f_un_ssa->sa_desc
709 #define f_sub_initial f_un.f_un_ssa->sa_initial
710 #define f_sub_any f_un.f_un_ssa->sa_any
711 #define f_sub_final f_un.f_un_ssa->sa_final
712 #define f_mra f_un.f_un_mra
713 #define f_mr_rule f_un.f_un_mra->ma_rule
714 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
715 #define f_mr_desc f_un.f_un_mra->ma_desc
716 #define f_mr_value f_un.f_un_mra->ma_value
717 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
720 struct slap_filter *f_un_complex;
723 #define f_result f_un.f_un_result
724 #define f_and f_un.f_un_complex
725 #define f_or f_un.f_un_complex
726 #define f_not f_un.f_un_complex
727 #define f_list f_un.f_un_complex
729 struct slap_filter *f_next;
732 /* compare routines can return undefined */
733 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
735 typedef struct slap_valuesreturnfilter {
739 /* precomputed result */
740 ber_int_t f_un_result;
746 AttributeDescription *f_un_desc;
748 /* simple value assertion */
749 AttributeAssertion *f_un_ava;
751 /* substring assertion */
752 SubstringsAssertion *f_un_ssa;
754 /* matching rule assertion */
755 MatchingRuleAssertion *f_un_mra;
758 struct slap_valuesreturnfilter *f_next;
759 } ValuesReturnFilter;
762 * represents an attribute (description + values)
764 typedef struct slap_attr {
765 AttributeDescription *a_desc;
767 struct slap_attr *a_next;
769 #define SLAP_ATTR_IXADD 0x1U
770 #define SLAP_ATTR_IXDEL 0x2U
775 * the id used in the indexes to refer to an entry
777 typedef unsigned long ID;
778 #define NOID ((ID)~0)
781 * represents an entry in core
783 typedef struct slap_entry {
785 * The ID field should only be changed before entry is
786 * inserted into a cache. The ID value is backend
791 struct berval e_name; /* name (DN) of this entry */
792 struct berval e_nname; /* normalized name (DN) of this entry */
794 /* for migration purposes */
795 #define e_dn e_name.bv_val
796 #define e_ndn e_nname.bv_val
798 Attribute *e_attrs; /* list of attributes + values */
800 slap_mask_t e_ocflags;
802 struct berval e_bv; /* For entry_encode/entry_decode */
804 /* for use by the backend for any purpose */
811 typedef struct slap_mod {
813 AttributeDescription *sm_desc;
814 struct berval sm_type;
815 BerVarray sm_bvalues;
818 typedef struct slap_mod_list {
819 Modification sml_mod;
820 #define sml_op sml_mod.sm_op
821 #define sml_desc sml_mod.sm_desc
822 #define sml_type sml_mod.sm_type
823 #define sml_bvalues sml_mod.sm_bvalues
824 struct slap_mod_list *sml_next;
827 typedef struct slap_ldap_modlist {
829 struct slap_ldap_modlist *ml_next;
830 #define ml_op ml_mod.mod_op
831 #define ml_type ml_mod.mod_type
832 #define ml_values ml_mod.mod_values
833 #define ml_bvalues ml_mod.mod_bvalues
837 * represents an access control list
839 typedef enum slap_access_e {
840 ACL_INVALID_ACCESS = -1,
849 typedef enum slap_control_e {
850 ACL_INVALID_CONTROL = 0,
856 typedef enum slap_style_e {
864 /* alternate names */
865 ACL_STYLE_EXACT = ACL_STYLE_BASE
868 typedef struct slap_authz_info {
869 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
870 struct berval sai_mech; /* SASL Mechanism */
871 struct berval sai_dn; /* DN for reporting purposes */
872 struct berval sai_ndn; /* Normalized DN */
874 /* Security Strength Factors */
875 slap_ssf_t sai_ssf; /* Overall SSF */
876 slap_ssf_t sai_transport_ssf; /* Transport SSF */
877 slap_ssf_t sai_tls_ssf; /* TLS SSF */
878 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
879 } AuthorizationInformation;
882 typedef struct slap_access {
883 slap_control_t a_type;
885 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
887 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
888 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
889 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
890 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
891 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
892 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
894 #define ACL_PRIV_MASK 0x00ffUL
897 #define ACL_PRIV_LEVEL 0x1000UL
898 #define ACL_PRIV_ADDITIVE 0x2000UL
899 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
902 #define ACL_PRIV_INVALID 0x0UL
904 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
905 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
906 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
907 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
909 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
910 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
912 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
914 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
916 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
917 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
918 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
920 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
921 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
922 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
923 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
924 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
925 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
927 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
928 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
929 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
930 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
931 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
932 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
933 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
935 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
936 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
937 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
938 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
939 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
940 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
942 slap_mask_t a_access_mask;
944 AuthorizationInformation a_authz;
945 #define a_dn_pat a_authz.sai_dn
947 slap_style_t a_dn_style;
948 AttributeDescription *a_dn_at;
952 slap_style_t a_peername_style;
953 struct berval a_peername_pat;
954 slap_style_t a_sockname_style;
955 struct berval a_sockname_pat;
957 slap_style_t a_domain_style;
958 struct berval a_domain_pat;
961 slap_style_t a_sockurl_style;
962 struct berval a_sockurl_pat;
963 slap_style_t a_set_style;
964 struct berval a_set_pat;
966 #ifdef SLAPD_ACI_ENABLED
967 AttributeDescription *a_aci_at;
971 slap_style_t a_group_style;
972 struct berval a_group_pat;
973 ObjectClass *a_group_oc;
974 AttributeDescription *a_group_at;
976 struct slap_access *a_next;
980 typedef struct slap_acl {
981 /* "to" part: the entries this acl applies to */
983 slap_style_t acl_dn_style;
985 struct berval acl_dn_pat;
986 AttributeName *acl_attrs;
988 /* "by" part: list of who has what access to the entries */
991 struct slap_acl *acl_next;
994 typedef struct slap_acl_state {
995 unsigned as_recorded;
996 #define ACL_STATE_NOT_RECORDED 0x0
997 #define ACL_STATE_RECORDED_VD 0x1
998 #define ACL_STATE_RECORDED_NV 0x2
999 #define ACL_STATE_RECORDED 0x3
1002 AccessControl *as_vd_acl;
1003 slap_mask_t as_vd_acl_mask;
1004 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1005 int as_vd_acl_count;
1007 Access *as_vd_access;
1008 int as_vd_access_count;
1011 } AccessControlState;
1012 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1015 * replog moddn param structure
1017 struct slap_replog_moddn {
1018 struct berval *newrdn;
1020 struct berval *newsup;
1025 * represents a backend
1028 typedef struct slap_backend_info BackendInfo; /* per backend type */
1029 typedef struct slap_backend_db BackendDB; /* per backend database */
1031 LDAP_SLAPD_V (int) nBackendInfo;
1032 LDAP_SLAPD_V (int) nBackendDB;
1033 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1034 LDAP_SLAPD_V (BackendDB *) backendDB;
1036 LDAP_SLAPD_V (int) slapMode;
1037 #define SLAP_UNDEFINED_MODE 0x0000
1038 #define SLAP_SERVER_MODE 0x0001
1039 #define SLAP_TOOL_MODE 0x0002
1040 #define SLAP_MODE 0x0003
1042 #define SLAP_TRUNCATE_MODE 0x0100
1044 struct slap_replica_info {
1045 char *ri_host; /* supersedes be_replica */
1046 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1047 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1048 int ri_exclude; /* 1 => exclude ri_attrs */
1051 struct slap_limits_set {
1059 int lms_s_unchecked;
1062 struct slap_limits {
1063 int lm_type; /* type of pattern */
1064 #define SLAP_LIMITS_UNDEFINED 0x0000
1065 #define SLAP_LIMITS_EXACT 0x0001
1066 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1067 #define SLAP_LIMITS_ONE 0x0002
1068 #define SLAP_LIMITS_SUBTREE 0x0003
1069 #define SLAP_LIMITS_CHILDREN 0x0004
1070 #define SLAP_LIMITS_REGEX 0x0005
1071 #define SLAP_LIMITS_ANONYMOUS 0x0006
1072 #define SLAP_LIMITS_USERS 0x0007
1073 #define SLAP_LIMITS_ANY 0x0008
1074 regex_t lm_dn_regex; /* regex data for REGEX */
1077 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1078 * pattern for REGEX; NULL for ANONYMOUS, USERS
1080 struct berval lm_dn_pat;
1082 struct slap_limits_set lm_limits;
1085 /* temporary aliases */
1086 typedef BackendDB Backend;
1087 #define nbackends nBackendDB
1088 #define backends backendDB
1090 struct slap_backend_db {
1091 BackendInfo *bd_info; /* pointer to shared backend info */
1093 /* BackendInfo accessors */
1094 #define be_config bd_info->bi_db_config
1095 #define be_type bd_info->bi_type
1097 #define be_bind bd_info->bi_op_bind
1098 #define be_unbind bd_info->bi_op_unbind
1099 #define be_add bd_info->bi_op_add
1100 #define be_compare bd_info->bi_op_compare
1101 #define be_delete bd_info->bi_op_delete
1102 #define be_modify bd_info->bi_op_modify
1103 #define be_modrdn bd_info->bi_op_modrdn
1104 #define be_search bd_info->bi_op_search
1106 #define be_extended bd_info->bi_extended
1108 #define be_release bd_info->bi_entry_release_rw
1109 #define be_chk_referrals bd_info->bi_chk_referrals
1110 #define be_group bd_info->bi_acl_group
1111 #define be_attribute bd_info->bi_acl_attribute
1112 #define be_operational bd_info->bi_operational
1114 #define be_controls bd_info->bi_controls
1116 #define be_connection_init bd_info->bi_connection_init
1117 #define be_connection_destroy bd_info->bi_connection_destroy
1120 #define be_entry_open bd_info->bi_tool_entry_open
1121 #define be_entry_close bd_info->bi_tool_entry_close
1122 #define be_entry_first bd_info->bi_tool_entry_first
1123 #define be_entry_next bd_info->bi_tool_entry_next
1124 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1125 #define be_entry_get bd_info->bi_tool_entry_get
1126 #define be_entry_put bd_info->bi_tool_entry_put
1127 #define be_sync bd_info->bi_tool_sync
1130 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1131 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1132 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1133 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1134 #define SLAP_BFLAG_ALIASES 0x0100U
1135 #define SLAP_BFLAG_REFERRALS 0x0200U
1136 #define SLAP_BFLAG_SUBENTRIES 0x0400U
1137 #define SLAP_BFLAG_MONITOR 0x1000U
1138 #define SLAP_BFLAG_DYNAMIC 0x2000U
1139 slap_mask_t be_flags;
1140 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1141 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1142 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1143 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1144 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1145 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1147 slap_mask_t be_restrictops; /* restriction operations */
1148 #define SLAP_RESTRICT_OP_ADD 0x0001U
1149 #define SLAP_RESTRICT_OP_BIND 0x0002U
1150 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1151 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1152 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1153 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1154 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1155 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1157 #define SLAP_RESTRICT_OP_READS \
1158 ( SLAP_RESTRICT_OP_COMPARE \
1159 | SLAP_RESTRICT_OP_SEARCH )
1160 #define SLAP_RESTRICT_OP_WRITES \
1161 ( SLAP_RESTRICT_OP_ADD \
1162 | SLAP_RESTRICT_OP_DELETE \
1163 | SLAP_RESTRICT_OP_MODIFY \
1164 | SLAP_RESTRICT_OP_RENAME )
1166 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1167 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1168 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
1170 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1171 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1172 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1174 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1175 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1177 slap_mask_t be_requires; /* pre-operation requirements */
1178 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1179 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1180 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1181 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1182 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1184 /* Required Security Strength Factor */
1185 slap_ssf_set_t be_ssf_set;
1187 /* these should be renamed from be_ to bd_ */
1188 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1189 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1190 BerVarray be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1191 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1192 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1193 struct berval be_rootpw; /* the magic "root" password for this db */
1194 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1195 #define be_sizelimit be_def_limit.lms_s_soft
1196 #define be_timelimit be_def_limit.lms_t_soft
1197 struct slap_limits_set be_def_limit; /* default limits */
1198 struct slap_limits **be_limits; /* regex-based size and time limits */
1199 AccessControl *be_acl; /* access control list for this backend */
1200 slap_access_t be_dfltaccess; /* access given if no acl matches */
1201 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1202 char *be_replogfile; /* replication log file (in master) */
1203 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1204 BerVarray be_update_refs; /* where to refer modifying clients to */
1206 void *be_private; /* anything the backend database needs */
1212 /* Backend function typedefs */
1213 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1214 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1215 const char *fname, int lineno,
1216 int argc, char **argv));
1217 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1218 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1219 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1221 typedef int (BI_db_init) LDAP_P((Backend *bd));
1222 typedef int (BI_db_config) LDAP_P((Backend *bd,
1223 const char *fname, int lineno,
1224 int argc, char **argv));
1225 typedef int (BI_db_open) LDAP_P((Backend *bd));
1226 typedef int (BI_db_close) LDAP_P((Backend *bd));
1227 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1229 typedef int (BI_op_bind) LDAP_P(( BackendDB *bd,
1230 struct slap_conn *c, struct slap_op *o,
1231 struct berval *dn, struct berval *ndn, int method,
1232 struct berval *cred, struct berval *edn ));
1233 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1234 struct slap_conn *c, struct slap_op *o ));
1235 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1236 struct slap_conn *c, struct slap_op *o,
1237 struct berval *base, struct berval *nbase,
1238 int scope, int deref,
1239 int slimit, int tlimit,
1240 Filter *f, struct berval *filterstr,
1241 AttributeName *attrs, int attrsonly));
1242 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1243 struct slap_conn *c, struct slap_op *o,
1244 struct berval *dn, struct berval *ndn,
1245 AttributeAssertion *ava));
1246 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1247 struct slap_conn *c, struct slap_op *o,
1248 struct berval *dn, struct berval *ndn,
1250 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1251 struct slap_conn *c, struct slap_op *o,
1252 struct berval *dn, struct berval *ndn,
1253 struct berval *newrdn, struct berval *nnewrdn,
1255 struct berval *newSup, struct berval *nnewSup ));
1256 typedef int (BI_op_add) LDAP_P((BackendDB *bd,
1257 struct slap_conn *c, struct slap_op *o,
1259 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1260 struct slap_conn *c, struct slap_op *o,
1261 struct berval *dn, struct berval *ndn));
1262 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1263 struct slap_conn *c, struct slap_op *o,
1266 typedef int (BI_op_extended) LDAP_P((
1268 struct slap_conn *conn,
1271 struct berval * reqdata,
1273 struct berval ** rspdata,
1274 LDAPControl *** rspctrls,
1278 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1279 struct slap_conn *c, struct slap_op *o,
1282 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1283 struct slap_conn *c, struct slap_op *o,
1284 struct berval *dn, struct berval *ndn,
1285 const char **text ));
1287 typedef int (BI_acl_group) LDAP_P((Backend *bd,
1288 struct slap_conn *c, struct slap_op *o,
1292 ObjectClass *group_oc,
1293 AttributeDescription *group_at ));
1295 typedef int (BI_acl_attribute) LDAP_P((Backend *bd,
1296 struct slap_conn *c, struct slap_op *o,
1297 Entry *e, struct berval *edn,
1298 AttributeDescription *entry_at,
1301 typedef int (BI_operational) LDAP_P((Backend *bd,
1302 struct slap_conn *c, struct slap_op *o,
1303 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1305 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1306 struct slap_conn *c));
1307 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1308 struct slap_conn *c));
1310 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1311 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1312 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1313 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1314 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1315 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1316 struct berval *text ));
1317 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1318 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1320 struct slap_backend_info {
1321 char *bi_type; /* type of backend */
1324 * per backend type routines:
1325 * bi_init: called to allocate a backend_info structure,
1326 * called once BEFORE configuration file is read.
1327 * bi_init() initializes this structure hence is
1328 * called directly from be_initialize()
1329 * bi_config: called per 'backend' specific option
1330 * all such options must before any 'database' options
1331 * bi_config() is called only from read_config()
1332 * bi_open: called to open each database, called
1333 * once AFTER configuration file is read but
1334 * BEFORE any bi_db_open() calls.
1335 * bi_open() is called from backend_startup()
1336 * bi_close: called to close each database, called
1337 * once during shutdown after all bi_db_close calls.
1338 * bi_close() is called from backend_shutdown()
1339 * bi_destroy: called to destroy each database, called
1340 * once during shutdown after all bi_db_destroy calls.
1341 * bi_destory() is called from backend_destroy()
1344 BI_config *bi_config;
1347 BI_destroy *bi_destroy;
1350 * per database routines:
1351 * bi_db_init: called to initialize each database,
1352 * called upon reading 'database <type>'
1353 * called only from backend_db_init()
1354 * bi_db_config: called to configure each database,
1355 * called per database to handle per database options
1356 * called only from read_config()
1357 * bi_db_open: called to open each database
1358 * called once per database immediately AFTER bi_open()
1359 * calls but before daemon startup.
1360 * called only by backend_startup()
1361 * bi_db_close: called to close each database
1362 * called once per database during shutdown but BEFORE
1363 * any bi_close call.
1364 * called only by backend_shutdown()
1365 * bi_db_destroy: called to destroy each database
1366 * called once per database during shutdown AFTER all
1367 * bi_close calls but before bi_destory calls.
1368 * called only by backend_destory()
1370 BI_db_init *bi_db_init;
1371 BI_db_config *bi_db_config;
1372 BI_db_open *bi_db_open;
1373 BI_db_close *bi_db_close;
1374 BI_db_destroy *bi_db_destroy;
1376 /* LDAP Operations Handling Routines */
1377 BI_op_bind *bi_op_bind;
1378 BI_op_unbind *bi_op_unbind;
1379 BI_op_search *bi_op_search;
1380 BI_op_compare *bi_op_compare;
1381 BI_op_modify *bi_op_modify;
1382 BI_op_modrdn *bi_op_modrdn;
1383 BI_op_add *bi_op_add;
1384 BI_op_delete *bi_op_delete;
1385 BI_op_abandon *bi_op_abandon;
1387 /* Extended Operations Helper */
1388 BI_op_extended *bi_extended;
1390 /* Auxilary Functions */
1391 BI_entry_release_rw *bi_entry_release_rw;
1392 BI_chk_referrals *bi_chk_referrals;
1394 BI_acl_group *bi_acl_group;
1395 BI_acl_attribute *bi_acl_attribute;
1397 BI_operational *bi_operational;
1399 BI_connection_init *bi_connection_init;
1400 BI_connection_destroy *bi_connection_destroy;
1402 /* hooks for slap tools */
1403 BI_tool_entry_open *bi_tool_entry_open;
1404 BI_tool_entry_close *bi_tool_entry_close;
1405 BI_tool_entry_first *bi_tool_entry_first;
1406 BI_tool_entry_next *bi_tool_entry_next;
1407 BI_tool_entry_get *bi_tool_entry_get;
1408 BI_tool_entry_put *bi_tool_entry_put;
1409 BI_tool_entry_reindex *bi_tool_entry_reindex;
1410 BI_tool_sync *bi_tool_sync;
1412 #define SLAP_INDEX_ADD_OP 0x0001
1413 #define SLAP_INDEX_DELETE_OP 0x0002
1415 char **bi_controls; /* supported controls */
1417 unsigned int bi_nDB; /* number of databases of this type */
1418 void *bi_private; /* anything the backend type needs */
1421 #define c_authtype c_authz.sai_method
1422 #define c_authmech c_authz.sai_mech
1423 #define c_dn c_authz.sai_dn
1424 #define c_ndn c_authz.sai_ndn
1425 #define c_ssf c_authz.sai_ssf
1426 #define c_transport_ssf c_authz.sai_transport_ssf
1427 #define c_tls_ssf c_authz.sai_tls_ssf
1428 #define c_sasl_ssf c_authz.sai_sasl_ssf
1430 #define o_authtype o_authz.sai_method
1431 #define o_authmech o_authz.sai_mech
1432 #define o_dn o_authz.sai_dn
1433 #define o_ndn o_authz.sai_ndn
1434 #define o_ssf o_authz.sai_ssf
1435 #define o_transport_ssf o_authz.sai_transport_ssf
1436 #define o_tls_ssf o_authz.sai_tls_ssf
1437 #define o_sasl_ssf o_authz.sai_sasl_ssf
1439 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1440 ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1441 BerVarray, const char *, struct berval *,
1442 struct berval *, LDAPControl ** );
1444 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1445 ber_int_t, const char *, const char *, BerVarray,
1446 LDAPControl **, int nentries);
1448 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1449 struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1451 typedef struct slap_callback {
1452 slap_response *sc_response;
1453 slap_sresult *sc_sresult;
1454 slap_sendentry *sc_sendentry;
1459 * Paged Results state
1461 typedef unsigned long PagedResultsCookie;
1462 typedef struct slap_paged_state {
1464 PagedResultsCookie ps_cookie;
1466 } PagedResultsState;
1469 * represents an operation pending from an ldap client
1471 typedef struct slap_op {
1472 unsigned long o_opid; /* id of this operation */
1473 unsigned long o_connid; /* id of conn initiating this op */
1475 ber_int_t o_msgid; /* msgid of the request */
1476 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1477 ber_tag_t o_tag; /* tag of the request */
1478 time_t o_time; /* time op was initiated */
1480 ldap_pvt_thread_t o_tid; /* thread handling this op */
1482 volatile sig_atomic_t o_abandon; /* abandon flag */
1484 #define SLAP_NO_CONTROL 0
1485 #define SLAP_NONCRITICAL_CONTROL 1
1486 #define SLAP_CRITICAL_CONTROL 2
1490 char o_subentries_visibility;
1491 char o_valuesreturnfilter;
1493 char o_pagedresults;
1494 ber_int_t o_pagedresults_size;
1495 PagedResultsState o_pagedresults_state;
1497 #ifdef LDAP_CONNECTIONLESS
1498 Sockaddr o_peeraddr; /* UDP peer address */
1500 AuthorizationInformation o_authz;
1502 BerElement *o_ber; /* ber of the request */
1503 slap_callback *o_callback; /* callback pointers */
1504 LDAPControl **o_ctrls; /* controls */
1506 void *o_private; /* anything the backend needs */
1508 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
1509 ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1512 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
1513 #define get_subentries(op) ((int)(op)->o_subentries)
1514 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
1517 * Caches the result of a backend_group check for ACL evaluation
1519 typedef struct slap_gacl {
1520 struct slap_gacl *ga_next;
1523 AttributeDescription *ga_at;
1530 * represents a connection from an ldap client
1532 typedef struct slap_conn {
1533 int c_struct_state; /* structure management state */
1534 int c_conn_state; /* connection state */
1536 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1537 Sockbuf *c_sb; /* ber connection stuff */
1539 /* only can be changed by connect_init */
1540 time_t c_starttime; /* when the connection was opened */
1541 time_t c_activitytime; /* when the connection was last used */
1542 unsigned long c_connid; /* id of this connection for stats*/
1544 struct berval c_listener_url; /* listener URL */
1545 struct berval c_peer_domain; /* DNS name of client */
1546 struct berval c_peer_name; /* peer name (trans=addr:port) */
1547 struct berval c_sock_name; /* sock name (trans=addr:port) */
1549 /* only can be changed by binding thread */
1550 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1551 struct berval c_sasl_bind_mech; /* mech in progress */
1552 struct berval c_cdn;
1554 /* authorization backend */
1555 Backend *c_authz_backend;
1557 AuthorizationInformation c_authz;
1558 GroupAssertion *c_groups;
1560 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1562 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
1563 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
1565 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1566 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1568 BerElement *c_currentber; /* ber we're attempting to read */
1569 int c_writewaiter; /* true if writer is waiting */
1571 #ifdef LDAP_CONNECTIONLESS
1572 int c_is_udp; /* true if this is (C)LDAP over UDP */
1575 int c_is_tls; /* true if this LDAP over raw TLS */
1576 int c_needs_tls_accept; /* true if SSL_accept should be called */
1578 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1579 void *c_sasl_context; /* SASL session context */
1580 void *c_sasl_extra; /* SASL session extra stuff */
1582 PagedResultsState c_pagedresults_state; /* paged result state */
1584 long c_n_ops_received; /* num of ops received (next op_id) */
1585 long c_n_ops_executing; /* num of ops currently executing */
1586 long c_n_ops_pending; /* num of ops pending execution */
1587 long c_n_ops_completed; /* num of ops completed */
1589 long c_n_get; /* num of get calls */
1590 long c_n_read; /* num of read calls */
1591 long c_n_write; /* num of write calls */
1594 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1595 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1597 if ( ldap_debug & (level) ) \
1598 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1599 if ( ldap_syslog & (level) ) \
1600 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1604 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1608 #define SASLREGEX_REPLACE 10
1609 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1610 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1612 typedef struct sasl_uri {
1614 struct berval filter;
1618 typedef struct sasl_regexp {
1619 char *sr_match; /* regexp match pattern */
1620 SaslUri_t sr_replace; /* regexp replace pattern */
1621 regex_t sr_workspace; /* workspace for regexp engine */
1622 regmatch_t sr_strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1623 int sr_dn_offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1624 int sr_fi_offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1628 * listener; need to access it from monitor backend
1630 typedef struct slap_listener {
1636 #ifdef LDAP_CONNECTIONLESS
1637 int sl_is_udp; /* UDP listener is also data port */
1641 #define sl_addr sl_sa.sa_in_addr
1644 #ifdef SLAPD_MONITOR
1661 #endif /* SLAPD_MONITOR */
1665 #include "proto-slap.h"
1667 #endif /* _SLAP_H_ */