1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2004 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
30 #include "ldap_defaults.h"
33 #include <ac/stdlib.h>
35 #include <sys/types.h>
36 #include <ac/syslog.h>
38 #include <ac/signal.h>
39 #include <ac/socket.h>
46 #define ldap_debug slap_debug
52 #include <ldap_schema.h>
55 #include "ldap_pvt_thread.h"
56 #include "ldap_queue.h"
60 * SLAPD Memory allocation macros
62 * Unlike ch_*() routines, these routines do not assert() upon
63 * allocation error. They are intended to be used instead of
64 * ch_*() routines where the caller has implemented proper
65 * checking for and handling of allocation errors.
67 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
69 #define SLAP_MALLOC(s) ber_memalloc((s))
70 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
71 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
72 #define SLAP_FREE(p) ber_memfree((p))
73 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
74 #define SLAP_STRDUP(s) ber_strdup((s))
75 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
78 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
81 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
82 #define SLAPD_ANONYMOUS "cn=anonymous"
84 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
85 * This is a value used internally by the backends. It is needed to allow
86 * adding values that already exist without getting an error as required by
87 * modrdn when the new rdn was already an attribute value itself.
89 #define SLAP_MOD_SOFTADD 0x1000
91 #define MAXREMATCHES (100)
93 #define SLAP_MAX_WORKER_THREADS (16)
95 #define SLAP_MAX_SYNCREPL_THREADS (8)
97 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
98 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
100 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
101 #define SLAP_CONN_MAX_PENDING_AUTH 1000
103 #define SLAP_TEXT_BUFLEN (256)
105 /* psuedo error code indicating abandoned operation */
106 #define SLAPD_ABANDON (-1024)
108 /* psuedo error code indicating disconnect */
109 #define SLAPD_DISCONNECT (-1025)
111 /* unknown config file directive */
112 #define SLAP_CONF_UNKNOWN (-1026)
114 /* We assume "C" locale, that is US-ASCII */
115 #define ASCII_SPACE(c) ( (c) == ' ' )
116 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
117 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
118 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
119 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
120 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
121 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
122 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
123 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
124 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
125 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
127 #define SLAP_NIBBLE(c) ((c)&0x0f)
128 #define SLAP_ESCAPE_CHAR ('\\')
129 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
130 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
132 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
133 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
135 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
136 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
137 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
138 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
139 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
141 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
142 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
143 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
144 #define OID_SEPARATOR(c) ( (c) == '.' )
145 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
147 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
148 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
150 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
151 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
153 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
155 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
156 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
157 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
158 (c) == '?' || (c) == ' ' || (c) == '=' )
159 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
161 /* must match in schema_init.c */
162 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
163 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
164 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
165 #define SLAPD_GROUP_ATTR "member"
166 #define SLAPD_GROUP_CLASS "groupOfNames"
167 #define SLAPD_ROLE_ATTR "roleOccupant"
168 #define SLAPD_ROLE_CLASS "organizationalRole"
170 #ifdef SLAPD_ACI_ENABLED
171 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
174 /* change this to "OpenLDAPset" */
175 #define SLAPD_ACI_SET_ATTR "template"
177 #define SLAPD_TOP_OID "2.5.6.0"
179 LDAP_SLAPD_V (int) slap_debug;
181 typedef unsigned long slap_mask_t;
183 /* Security Strength Factor */
184 typedef unsigned slap_ssf_t;
186 typedef struct slap_ssf_set {
188 slap_ssf_t sss_transport;
191 slap_ssf_t sss_update_ssf;
192 slap_ssf_t sss_update_transport;
193 slap_ssf_t sss_update_tls;
194 slap_ssf_t sss_update_sasl;
195 slap_ssf_t sss_simple_bind;
198 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
199 #define SLAP_GETDN_AUTHCID 2
200 #define SLAP_GETDN_AUTHZID 4
205 #define SLAP_INDEX_TYPE 0x00FFUL
206 #define SLAP_INDEX_UNDEFINED 0x0001UL
207 #define SLAP_INDEX_PRESENT 0x0002UL
208 #define SLAP_INDEX_EQUALITY 0x0004UL
209 #define SLAP_INDEX_APPROX 0x0008UL
210 #define SLAP_INDEX_SUBSTR 0x0010UL
211 #define SLAP_INDEX_EXTENDED 0x0020UL
213 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
215 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
217 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
219 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
220 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
221 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
222 #define SLAP_INDEX_SUBSTR_DEFAULT \
223 ( SLAP_INDEX_SUBSTR \
224 | SLAP_INDEX_SUBSTR_INITIAL \
225 | SLAP_INDEX_SUBSTR_ANY \
226 | SLAP_INDEX_SUBSTR_FINAL )
228 #define SLAP_INDEX_SUBSTR_MINLEN 2
229 #define SLAP_INDEX_SUBSTR_MAXLEN 4
230 #define SLAP_INDEX_SUBSTR_STEP 2
232 #define SLAP_INDEX_FLAGS 0xF000UL
233 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
234 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
237 * there is a single index for each attribute. these prefixes ensure
238 * that there is no collision among keys.
240 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
241 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
242 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
243 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
244 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
245 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
247 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
248 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
249 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
250 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
251 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
254 * represents schema information for a database
256 #define SLAP_SCHERR_OUTOFMEM 1
257 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
258 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
259 #define SLAP_SCHERR_CLASS_BAD_SUP 4
260 #define SLAP_SCHERR_CLASS_DUP 5
261 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
262 #define SLAP_SCHERR_ATTR_BAD_MR 7
263 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
264 #define SLAP_SCHERR_ATTR_BAD_SUP 9
265 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
266 #define SLAP_SCHERR_ATTR_DUP 11
267 #define SLAP_SCHERR_MR_NOT_FOUND 12
268 #define SLAP_SCHERR_MR_INCOMPLETE 13
269 #define SLAP_SCHERR_MR_DUP 14
270 #define SLAP_SCHERR_SYN_NOT_FOUND 15
271 #define SLAP_SCHERR_SYN_DUP 16
272 #define SLAP_SCHERR_NO_NAME 17
273 #define SLAP_SCHERR_NOT_SUPPORTED 18
274 #define SLAP_SCHERR_BAD_DESCR 19
275 #define SLAP_SCHERR_OIDM 20
276 #define SLAP_SCHERR_CR_DUP 21
277 #define SLAP_SCHERR_CR_BAD_STRUCT 22
278 #define SLAP_SCHERR_CR_BAD_AUX 23
279 #define SLAP_SCHERR_CR_BAD_AT 24
280 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
282 typedef union slap_sockaddr {
283 struct sockaddr sa_addr;
284 struct sockaddr_in sa_in_addr;
286 struct sockaddr_storage sa_storage;
287 struct sockaddr_in6 sa_in6_addr;
290 struct sockaddr_un sa_un_addr;
295 extern int slap_inet4or6;
298 typedef struct slap_oid_macro {
299 struct berval som_oid;
301 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
304 /* forward declarations */
306 struct slap_matching_rule;
308 typedef int slap_syntax_validate_func LDAP_P((
309 struct slap_syntax *syntax,
310 struct berval * in));
312 typedef int slap_syntax_transform_func LDAP_P((
313 struct slap_syntax *syntax,
318 typedef struct slap_syntax {
320 #define ssyn_oid ssyn_syn.syn_oid
321 #define ssyn_desc ssyn_syn.syn_desc
322 #define ssyn_extensions ssyn_syn.syn_extensions
325 ber_len_t ssyn_oidlen;
326 * has been replaced by a struct berval that uses the value
327 * provided by ssyn_syn.syn_oid; a macro that expands to
328 * the bv_len field of the berval is provided for backward
329 * compatibility. CAUTION: NEVER FREE THE BERVAL
331 struct berval ssyn_bvoid;
332 #define ssyn_oidlen ssyn_bvoid.bv_len
334 unsigned int ssyn_flags;
336 #define SLAP_SYNTAX_NONE 0x0000U
337 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
338 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
339 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
341 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
343 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
346 slap_syntax_validate_func *ssyn_validate;
347 slap_syntax_transform_func *ssyn_pretty;
349 #ifdef SLAPD_BINARY_CONVERSION
350 /* convert to and from binary */
351 slap_syntax_transform_func *ssyn_ber2str;
352 slap_syntax_transform_func *ssyn_str2ber;
355 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
358 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
359 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
360 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
361 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
362 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
364 typedef struct slap_syntax_defs_rec {
367 slap_syntax_validate_func *sd_validate;
368 slap_syntax_transform_func *sd_pretty;
369 #ifdef SLAPD_BINARY_CONVERSION
370 slap_syntax_transform_func *sd_ber2str;
371 slap_syntax_transform_func *sd_str2ber;
373 } slap_syntax_defs_rec;
375 /* X -> Y Converter */
376 typedef int slap_mr_convert_func LDAP_P((
382 typedef int slap_mr_normalize_func LDAP_P((
384 struct slap_syntax *syntax, /* NULL if in is asserted value */
385 struct slap_matching_rule *mr,
390 /* Match (compare) function */
391 typedef int slap_mr_match_func LDAP_P((
394 struct slap_syntax *syntax, /* syntax of stored value */
395 struct slap_matching_rule *mr,
396 struct berval * value,
397 void * assertValue ));
399 /* Index generation function */
400 typedef int slap_mr_indexer_func LDAP_P((
403 struct slap_syntax *syntax, /* syntax of stored value */
404 struct slap_matching_rule *mr,
405 struct berval *prefix,
410 /* Filter index function */
411 typedef int slap_mr_filter_func LDAP_P((
414 struct slap_syntax *syntax, /* syntax of stored value */
415 struct slap_matching_rule *mr,
416 struct berval *prefix,
421 typedef struct slap_matching_rule_use MatchingRuleUse;
423 typedef struct slap_matching_rule {
424 LDAPMatchingRule smr_mrule;
425 MatchingRuleUse *smr_mru;
426 /* RFC2252 string representation */
427 struct berval smr_str;
430 * ber_len_t smr_oidlen;
431 * has been replaced by a struct berval that uses the value
432 * provided by smr_mrule.mr_oid; a macro that expands to
433 * the bv_len field of the berval is provided for backward
434 * compatibility. CAUTION: NEVER FREE THE BERVAL
436 struct berval smr_bvoid;
437 #define smr_oidlen smr_bvoid.bv_len
439 slap_mask_t smr_usage;
442 #define SLAP_MR_HIDE 0x0000U
444 #define SLAP_MR_HIDE 0x8000U
447 #define SLAP_MR_TYPE_MASK 0x0F00U
448 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
449 #define SLAP_MR_USAGE 0x000FU
451 #define SLAP_MR_NONE 0x0000U
452 #define SLAP_MR_EQUALITY 0x0100U
453 #define SLAP_MR_ORDERING 0x0200U
454 #define SLAP_MR_SUBSTR 0x0400U
455 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
457 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
459 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
460 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
461 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
465 * The asserted value, depending on the particular usage,
466 * is expected to conform to either the assertion syntax
467 * or the attribute syntax. In some cases, the syntax of
468 * the value is known. If so, these flags indicate which
469 * syntax the value is expected to conform to. If not,
470 * neither of these flags is set (until the syntax of the
471 * provided value is determined). If the value is of the
472 * attribute syntax, the flag is changed once a value of
473 * the assertion syntax is derived from the provided value.
475 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
476 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
477 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
479 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
480 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
481 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
482 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
484 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
485 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
487 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
490 /* either or both the asserted value or attribute value
491 * may be provided in normalized form
493 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
494 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
496 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
497 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
498 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
499 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
501 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
502 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
503 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
504 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
505 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
506 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
508 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
509 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
510 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
511 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
514 slap_mr_convert_func *smr_convert;
515 slap_mr_normalize_func *smr_normalize;
516 slap_mr_match_func *smr_match;
517 slap_mr_indexer_func *smr_indexer;
518 slap_mr_filter_func *smr_filter;
521 * null terminated array of syntaxes compatible with this syntax
522 * note: when MS_EXT is set, this MUST NOT contain the assertion
523 * syntax of the rule. When MS_EXT is not set, it MAY.
525 Syntax **smr_compat_syntaxes;
528 * For equality rules, refers to an associated approximate rule.
529 * For non-equality rules, refers to an associated equality rule.
531 struct slap_matching_rule *smr_associated;
533 #define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \
534 ((mr)->smr_associated == (amr)))
536 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
538 #define smr_oid smr_mrule.mr_oid
539 #define smr_names smr_mrule.mr_names
540 #define smr_desc smr_mrule.mr_desc
541 #define smr_obsolete smr_mrule.mr_obsolete
542 #define smr_syntax_oid smr_mrule.mr_syntax_oid
543 #define smr_extensions smr_mrule.mr_extensions
546 struct slap_matching_rule_use {
547 LDAPMatchingRuleUse smru_mruleuse;
548 MatchingRule *smru_mr;
549 /* RFC2252 string representation */
550 struct berval smru_str;
552 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
554 #define smru_oid smru_mruleuse.mru_oid
555 #define smru_names smru_mruleuse.mru_names
556 #define smru_desc smru_mruleuse.mru_desc
557 #define smru_obsolete smru_mruleuse.mru_obsolete
558 #define smru_applies_oids smru_mruleuse.mru_applies_oids
560 #define smru_usage smru_mr->smr_usage
561 } /* MatchingRuleUse */ ;
563 typedef struct slap_mrule_defs_rec {
565 slap_mask_t mrd_usage;
566 char ** mrd_compat_syntaxes;
567 slap_mr_convert_func * mrd_convert;
568 slap_mr_normalize_func * mrd_normalize;
569 slap_mr_match_func * mrd_match;
570 slap_mr_indexer_func * mrd_indexer;
571 slap_mr_filter_func * mrd_filter;
573 /* For equality rule, this may refer to an associated approximate rule */
574 /* For non-equality rule, this may refer to an associated equality rule */
575 char * mrd_associated;
576 } slap_mrule_defs_rec;
578 struct slap_backend_db;
582 typedef int (AttributeTypeSchemaCheckFN)(
583 struct slap_backend_db *be,
584 struct slap_entry *e,
585 struct slap_attr *attr,
587 char *textbuf, size_t textlen );
589 typedef struct slap_attribute_type {
590 LDAPAttributeType sat_atype;
591 struct berval sat_cname;
592 struct slap_attribute_type *sat_sup;
593 struct slap_attribute_type **sat_subtypes;
594 MatchingRule *sat_equality;
595 MatchingRule *sat_approx;
596 MatchingRule *sat_ordering;
597 MatchingRule *sat_substr;
600 AttributeTypeSchemaCheckFN *sat_check;
602 #define SLAP_AT_NONE 0x0000U
603 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
604 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
606 #define SLAP_AT_HIDE 0x0000U /* publish everything */
608 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
610 slap_mask_t sat_flags;
612 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
614 #define sat_oid sat_atype.at_oid
615 #define sat_names sat_atype.at_names
616 #define sat_desc sat_atype.at_desc
617 #define sat_obsolete sat_atype.at_obsolete
618 #define sat_sup_oid sat_atype.at_sup_oid
619 #define sat_equality_oid sat_atype.at_equality_oid
620 #define sat_ordering_oid sat_atype.at_ordering_oid
621 #define sat_substr_oid sat_atype.at_substr_oid
622 #define sat_syntax_oid sat_atype.at_syntax_oid
623 #define sat_single_value sat_atype.at_single_value
624 #define sat_collective sat_atype.at_collective
625 #define sat_no_user_mod sat_atype.at_no_user_mod
626 #define sat_usage sat_atype.at_usage
627 #define sat_extensions sat_atype.at_extensions
629 struct slap_attr_desc *sat_ad;
630 ldap_pvt_thread_mutex_t sat_ad_mutex;
633 #define is_at_operational(at) ((at)->sat_usage)
634 #define is_at_single_value(at) ((at)->sat_single_value)
635 #define is_at_collective(at) ((at)->sat_collective)
636 #define is_at_obsolete(at) ((at)->sat_obsolete)
637 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
639 struct slap_object_class;
641 typedef int (ObjectClassSchemaCheckFN)(
642 struct slap_backend_db *be,
643 struct slap_entry *e,
644 struct slap_object_class *oc,
646 char *textbuf, size_t textlen );
648 typedef struct slap_object_class {
649 LDAPObjectClass soc_oclass;
650 struct berval soc_cname;
651 struct slap_object_class **soc_sups;
652 AttributeType **soc_required;
653 AttributeType **soc_allowed;
654 ObjectClassSchemaCheckFN *soc_check;
655 slap_mask_t soc_flags;
656 #define soc_oid soc_oclass.oc_oid
657 #define soc_names soc_oclass.oc_names
658 #define soc_desc soc_oclass.oc_desc
659 #define soc_obsolete soc_oclass.oc_obsolete
660 #define soc_sup_oids soc_oclass.oc_sup_oids
661 #define soc_kind soc_oclass.oc_kind
662 #define soc_at_oids_must soc_oclass.oc_at_oids_must
663 #define soc_at_oids_may soc_oclass.oc_at_oids_may
664 #define soc_extensions soc_oclass.oc_extensions
666 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
669 #define SLAP_OC_ALIAS 0x0001
670 #define SLAP_OC_REFERRAL 0x0002
671 #define SLAP_OC_SUBENTRY 0x0004
672 #define SLAP_OC_DYNAMICOBJECT 0x0008
673 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
674 #define SLAP_OC_GLUE 0x0020
675 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
676 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
677 #define SLAP_OC__MASK 0x00FF
678 #define SLAP_OC__END 0x0100
679 #define SLAP_OC_OPERATIONAL 0x4000
681 #define SLAP_OC_HIDE 0x0000
683 #define SLAP_OC_HIDE 0x8000
689 typedef struct slap_content_rule {
690 LDAPContentRule scr_crule;
691 ObjectClass *scr_sclass;
692 ObjectClass **scr_auxiliaries; /* optional */
693 AttributeType **scr_required; /* optional */
694 AttributeType **scr_allowed; /* optional */
695 AttributeType **scr_precluded; /* optional */
696 #define scr_oid scr_crule.cr_oid
697 #define scr_names scr_crule.cr_names
698 #define scr_desc scr_crule.cr_desc
699 #define scr_obsolete scr_crule.cr_obsolete
700 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
701 #define scr_at_oids_must scr_crule.cr_at_oids_must
702 #define scr_at_oids_may scr_crule.cr_at_oids_may
703 #define scr_at_oids_not scr_crule.cr_at_oids_not
705 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
708 /* Represents a recognized attribute description ( type + options ). */
709 typedef struct slap_attr_desc {
710 struct slap_attr_desc *ad_next;
711 AttributeType *ad_type; /* attribute type, must be specified */
712 struct berval ad_cname; /* canonical name, must be specified */
713 struct berval ad_tags; /* empty if no tagging options */
715 #define SLAP_DESC_NONE 0x00U
716 #define SLAP_DESC_BINARY 0x01U
717 #define SLAP_DESC_TAG_RANGE 0x80U
718 } AttributeDescription;
720 typedef struct slap_attr_name {
721 struct berval an_name;
722 AttributeDescription *an_desc;
727 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
728 #define slap_ad_is_tag_range(ad) \
729 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
730 #define slap_ad_is_binary(ad) \
731 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
734 * pointers to schema elements used internally
736 struct slap_internal_schema {
738 ObjectClass *si_oc_top;
739 ObjectClass *si_oc_extensibleObject;
740 ObjectClass *si_oc_alias;
741 ObjectClass *si_oc_referral;
742 ObjectClass *si_oc_rootdse;
743 ObjectClass *si_oc_subentry;
744 ObjectClass *si_oc_subschema;
745 ObjectClass *si_oc_collectiveAttributeSubentry;
746 ObjectClass *si_oc_dynamicObject;
748 ObjectClass *si_oc_glue;
749 ObjectClass *si_oc_syncConsumerSubentry;
750 ObjectClass *si_oc_syncProviderSubentry;
752 /* objectClass attribute descriptions */
753 AttributeDescription *si_ad_objectClass;
755 /* operational attribute descriptions */
756 AttributeDescription *si_ad_structuralObjectClass;
757 AttributeDescription *si_ad_creatorsName;
758 AttributeDescription *si_ad_createTimestamp;
759 AttributeDescription *si_ad_modifiersName;
760 AttributeDescription *si_ad_modifyTimestamp;
761 AttributeDescription *si_ad_hasSubordinates;
762 AttributeDescription *si_ad_subschemaSubentry;
763 AttributeDescription *si_ad_collectiveSubentries;
764 AttributeDescription *si_ad_collectiveExclusions;
765 AttributeDescription *si_ad_entryUUID;
766 AttributeDescription *si_ad_entryCSN;
767 AttributeDescription *si_ad_namingCSN;
768 AttributeDescription *si_ad_superiorUUID;
770 AttributeDescription *si_ad_dseType;
771 AttributeDescription *si_ad_syncreplCookie;
772 AttributeDescription *si_ad_syncTimestamp;
773 AttributeDescription *si_ad_contextCSN;
775 /* root DSE attribute descriptions */
776 AttributeDescription *si_ad_altServer;
777 AttributeDescription *si_ad_namingContexts;
778 AttributeDescription *si_ad_supportedControl;
779 AttributeDescription *si_ad_supportedExtension;
780 AttributeDescription *si_ad_supportedLDAPVersion;
781 AttributeDescription *si_ad_supportedSASLMechanisms;
782 AttributeDescription *si_ad_supportedFeatures;
783 AttributeDescription *si_ad_monitorContext;
784 AttributeDescription *si_ad_vendorName;
785 AttributeDescription *si_ad_vendorVersion;
787 /* subentry attribute descriptions */
788 AttributeDescription *si_ad_administrativeRole;
789 AttributeDescription *si_ad_subtreeSpecification;
791 /* subschema subentry attribute descriptions */
792 AttributeDescription *si_ad_ditStructureRules;
793 AttributeDescription *si_ad_ditContentRules;
794 AttributeDescription *si_ad_nameForms;
795 AttributeDescription *si_ad_objectClasses;
796 AttributeDescription *si_ad_attributeTypes;
797 AttributeDescription *si_ad_ldapSyntaxes;
798 AttributeDescription *si_ad_matchingRules;
799 AttributeDescription *si_ad_matchingRuleUse;
801 /* Aliases & Referrals */
802 AttributeDescription *si_ad_aliasedObjectName;
803 AttributeDescription *si_ad_ref;
805 /* Access Control Internals */
806 AttributeDescription *si_ad_entry;
807 AttributeDescription *si_ad_children;
808 AttributeDescription *si_ad_saslAuthzTo;
809 AttributeDescription *si_ad_saslAuthzFrom;
810 #ifdef SLAPD_ACI_ENABLED
811 AttributeDescription *si_ad_aci;
814 /* dynamic entries */
815 AttributeDescription *si_ad_entryTtl;
816 AttributeDescription *si_ad_dynamicSubtrees;
818 /* Other attributes descriptions */
819 AttributeDescription *si_ad_distinguishedName;
820 AttributeDescription *si_ad_name;
821 AttributeDescription *si_ad_cn;
822 AttributeDescription *si_ad_userPassword;
823 AttributeDescription *si_ad_labeledURI;
824 #ifdef SLAPD_AUTHPASSWD
825 AttributeDescription *si_ad_authPassword;
827 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
828 AttributeDescription *si_ad_krbName;
831 /* Undefined Attribute Type */
832 AttributeType *si_at_undefined;
835 MatchingRule *si_mr_distinguishedNameMatch;
836 MatchingRule *si_mr_caseExactMatch;
837 MatchingRule *si_mr_caseExactSubstringsMatch;
838 MatchingRule *si_mr_caseExactIA5Match;
839 MatchingRule *si_mr_integerMatch;
840 MatchingRule *si_mr_integerFirstComponentMatch;
841 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
844 Syntax *si_syn_directoryString;
845 Syntax *si_syn_distinguishedName;
846 Syntax *si_syn_integer;
847 Syntax *si_syn_octetString;
850 typedef struct slap_attr_assertion {
851 AttributeDescription *aa_desc;
852 struct berval aa_value;
853 } AttributeAssertion;
855 typedef struct slap_ss_assertion {
856 AttributeDescription *sa_desc;
857 struct berval sa_initial;
858 struct berval *sa_any;
859 struct berval sa_final;
860 } SubstringsAssertion;
862 typedef struct slap_mr_assertion {
863 MatchingRule *ma_rule; /* optional */
864 struct berval ma_rule_text; /* optional */
865 AttributeDescription *ma_desc; /* optional */
866 int ma_dnattrs; /* boolean */
867 struct berval ma_value; /* required */
868 } MatchingRuleAssertion;
871 * represents a search filter
873 typedef struct slap_filter {
874 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
875 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
876 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
877 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
878 #ifdef LDAP_SCOPE_SUBORDINATE
879 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
883 /* precomputed result */
884 ber_int_t f_un_result;
887 struct berval *f_un_dn;
890 AttributeDescription *f_un_desc;
892 /* simple value assertion */
893 AttributeAssertion *f_un_ava;
895 /* substring assertion */
896 SubstringsAssertion *f_un_ssa;
898 /* matching rule assertion */
899 MatchingRuleAssertion *f_un_mra;
901 #define f_dn f_un.f_un_dn
902 #define f_desc f_un.f_un_desc
903 #define f_ava f_un.f_un_ava
904 #define f_av_desc f_un.f_un_ava->aa_desc
905 #define f_av_value f_un.f_un_ava->aa_value
906 #define f_sub f_un.f_un_ssa
907 #define f_sub_desc f_un.f_un_ssa->sa_desc
908 #define f_sub_initial f_un.f_un_ssa->sa_initial
909 #define f_sub_any f_un.f_un_ssa->sa_any
910 #define f_sub_final f_un.f_un_ssa->sa_final
911 #define f_mra f_un.f_un_mra
912 #define f_mr_rule f_un.f_un_mra->ma_rule
913 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
914 #define f_mr_desc f_un.f_un_mra->ma_desc
915 #define f_mr_value f_un.f_un_mra->ma_value
916 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
919 struct slap_filter *f_un_complex;
922 #define f_result f_un.f_un_result
923 #define f_and f_un.f_un_complex
924 #define f_or f_un.f_un_complex
925 #define f_not f_un.f_un_complex
926 #define f_list f_un.f_un_complex
928 struct slap_filter *f_next;
931 /* compare routines can return undefined */
932 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
934 typedef struct slap_valuesreturnfilter {
935 ber_tag_t vrf_choice;
938 /* precomputed result */
939 ber_int_t vrf_un_result;
945 AttributeDescription *vrf_un_desc;
947 /* simple value assertion */
948 AttributeAssertion *vrf_un_ava;
950 /* substring assertion */
951 SubstringsAssertion *vrf_un_ssa;
953 /* matching rule assertion */
954 MatchingRuleAssertion *vrf_un_mra;
956 #define vrf_result vrf_un.vrf_un_result
957 #define vrf_dn vrf_un.vrf_un_dn
958 #define vrf_desc vrf_un.vrf_un_desc
959 #define vrf_ava vrf_un.vrf_un_ava
960 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
961 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
962 #define vrf_ssa vrf_un.vrf_un_ssa
963 #define vrf_sub vrf_un.vrf_un_ssa
964 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
965 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
966 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
967 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
968 #define vrf_mra vrf_un.vrf_un_mra
969 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
970 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
971 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
972 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
973 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
978 struct slap_valuesreturnfilter *vrf_next;
979 } ValuesReturnFilter;
982 * represents an attribute (description + values)
984 typedef struct slap_attr {
985 AttributeDescription *a_desc;
986 BerVarray a_vals; /* preserved values */
987 BerVarray a_nvals; /* normalized values */
988 struct slap_attr *a_next;
990 #define SLAP_ATTR_IXADD 0x1U
991 #define SLAP_ATTR_IXDEL 0x2U
996 * the id used in the indexes to refer to an entry
998 typedef unsigned long ID;
999 #define NOID ((ID)~0)
1002 * represents an entry in core
1004 typedef struct slap_entry {
1006 * The ID field should only be changed before entry is
1007 * inserted into a cache. The ID value is backend
1012 struct berval e_name; /* name (DN) of this entry */
1013 struct berval e_nname; /* normalized name (DN) of this entry */
1015 /* for migration purposes */
1016 #define e_dn e_name.bv_val
1017 #define e_ndn e_nname.bv_val
1019 Attribute *e_attrs; /* list of attributes + values */
1021 slap_mask_t e_ocflags;
1023 struct berval e_bv; /* For entry_encode/entry_decode */
1025 /* for use by the backend for any purpose */
1030 * A list of LDAPMods
1032 typedef struct slap_mod {
1034 AttributeDescription *sm_desc;
1035 struct berval sm_type;
1036 BerVarray sm_values;
1037 #define sm_bvalues sm_values
1038 BerVarray sm_nvalues;
1041 typedef struct slap_mod_list {
1042 Modification sml_mod;
1043 #define sml_op sml_mod.sm_op
1044 #define sml_desc sml_mod.sm_desc
1045 #define sml_type sml_mod.sm_type
1046 #define sml_bvalues sml_mod.sm_values
1047 #define sml_values sml_mod.sm_values
1048 #define sml_nvalues sml_mod.sm_nvalues
1049 struct slap_mod_list *sml_next;
1052 typedef struct slap_ldap_modlist {
1054 struct slap_ldap_modlist *ml_next;
1055 #define ml_op ml_mod.mod_op
1056 #define ml_type ml_mod.mod_type
1057 #define ml_values ml_mod.mod_values
1058 #define ml_bvalues ml_mod.mod_values
1062 * represents an access control list
1064 typedef enum slap_access_e {
1065 ACL_INVALID_ACCESS = -1,
1074 typedef enum slap_control_e {
1075 ACL_INVALID_CONTROL = 0,
1081 typedef enum slap_style_e {
1082 ACL_STYLE_REGEX = 0,
1093 typedef struct slap_authz_info {
1094 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1095 struct berval sai_mech; /* SASL Mechanism */
1096 struct berval sai_dn; /* DN for reporting purposes */
1097 struct berval sai_ndn; /* Normalized DN */
1099 /* Security Strength Factors */
1100 slap_ssf_t sai_ssf; /* Overall SSF */
1101 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1102 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1103 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1104 } AuthorizationInformation;
1107 typedef struct slap_access {
1108 slap_control_t a_type;
1110 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1112 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1113 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1114 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1115 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1116 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1117 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1119 #define ACL_PRIV_MASK 0x00ffUL
1122 #define ACL_PRIV_LEVEL 0x1000UL
1123 #define ACL_PRIV_ADDITIVE 0x2000UL
1124 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1127 #define ACL_PRIV_INVALID 0x0UL
1129 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1130 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1131 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1132 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1134 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1135 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1137 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1139 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1141 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1142 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1143 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1145 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1146 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1147 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1148 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1149 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1150 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1152 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1153 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1154 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1155 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1156 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1157 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1158 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1160 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1161 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1162 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1163 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1164 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1165 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1167 slap_mask_t a_access_mask;
1169 AuthorizationInformation a_authz;
1170 #define a_dn_pat a_authz.sai_dn
1172 slap_style_t a_dn_style;
1173 AttributeDescription *a_dn_at;
1177 slap_style_t a_peername_style;
1178 struct berval a_peername_pat;
1179 unsigned long a_peername_addr,
1181 int a_peername_port;
1183 slap_style_t a_sockname_style;
1184 struct berval a_sockname_pat;
1186 slap_style_t a_domain_style;
1187 struct berval a_domain_pat;
1188 int a_domain_expand;
1190 slap_style_t a_sockurl_style;
1191 struct berval a_sockurl_pat;
1192 slap_style_t a_set_style;
1193 struct berval a_set_pat;
1195 #ifdef SLAPD_ACI_ENABLED
1196 AttributeDescription *a_aci_at;
1200 slap_style_t a_group_style;
1201 struct berval a_group_pat;
1202 ObjectClass *a_group_oc;
1203 AttributeDescription *a_group_at;
1205 struct slap_access *a_next;
1209 typedef struct slap_acl {
1210 /* "to" part: the entries this acl applies to */
1212 slap_style_t acl_dn_style;
1214 struct berval acl_dn_pat;
1215 AttributeName *acl_attrs;
1216 slap_style_t acl_attrval_style;
1217 regex_t acl_attrval_re;
1218 struct berval acl_attrval;
1220 /* "by" part: list of who has what access to the entries */
1223 struct slap_acl *acl_next;
1226 typedef struct slap_acl_state {
1227 unsigned as_recorded;
1228 #define ACL_STATE_NOT_RECORDED 0x0
1229 #define ACL_STATE_RECORDED_VD 0x1
1230 #define ACL_STATE_RECORDED_NV 0x2
1231 #define ACL_STATE_RECORDED 0x3
1234 AccessControl *as_vd_acl;
1235 AccessControl *as_vi_acl;
1236 slap_mask_t as_vd_acl_mask;
1237 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1238 int as_vd_acl_count;
1240 Access *as_vd_access;
1241 int as_vd_access_count;
1244 AttributeDescription *as_vd_ad;
1245 } AccessControlState;
1246 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1247 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1251 * represents a backend
1254 typedef struct slap_backend_info BackendInfo; /* per backend type */
1255 typedef struct slap_backend_db BackendDB; /* per backend database */
1257 LDAP_SLAPD_V (int) nBackendInfo;
1258 LDAP_SLAPD_V (int) nBackendDB;
1259 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1260 LDAP_SLAPD_V (BackendDB *) backendDB;
1262 LDAP_SLAPD_V (int) slapMode;
1263 #define SLAP_UNDEFINED_MODE 0x0000
1264 #define SLAP_SERVER_MODE 0x0001
1265 #define SLAP_TOOL_MODE 0x0002
1266 #define SLAP_MODE 0x0003
1268 #define SLAP_TRUNCATE_MODE 0x0100
1269 #define SLAP_TOOL_READMAIN 0x0200
1270 #define SLAP_TOOL_READONLY 0x0400
1272 struct slap_replica_info {
1273 char *ri_host; /* supersedes be_replica */
1274 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1275 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1276 int ri_exclude; /* 1 => exclude ri_attrs */
1279 struct slap_limits_set {
1287 int lms_s_unchecked;
1292 struct slap_limits {
1293 unsigned lm_flags; /* type of pattern */
1294 #define SLAP_LIMITS_UNDEFINED 0x0000U
1295 #define SLAP_LIMITS_EXACT 0x0001U
1296 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1297 #define SLAP_LIMITS_ONE 0x0002U
1298 #define SLAP_LIMITS_SUBTREE 0x0003U
1299 #define SLAP_LIMITS_CHILDREN 0x0004U
1300 #define SLAP_LIMITS_REGEX 0x0005U
1301 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1302 #define SLAP_LIMITS_USERS 0x0007U
1303 #define SLAP_LIMITS_ANY 0x0008U
1304 #define SLAP_LIMITS_MASK 0x000FU
1306 #define SLAP_LIMITS_TYPE_DN 0x0000U
1307 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1308 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1310 regex_t lm_regex; /* regex data for REGEX */
1313 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1314 * pattern for REGEX; NULL for ANONYMOUS, USERS
1316 struct berval lm_pat;
1318 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1319 * lm_group_oc is objectClass and lm_group_at is attributeType
1320 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1321 * can only be SLAP_LIMITS_EXACT */
1322 ObjectClass *lm_group_oc;
1323 AttributeDescription *lm_group_ad;
1325 struct slap_limits_set lm_limits;
1328 /* temporary aliases */
1329 typedef BackendDB Backend;
1330 #define nbackends nBackendDB
1331 #define backends backendDB
1334 * syncinfo structure for syncrepl
1337 #define SLAP_SYNC_SID_SIZE 3
1338 #define SLAP_SYNC_RID_SIZE 3
1339 #define SLAP_SYNCUUID_SET_SIZE 256
1341 struct nonpresent_entry {
1342 struct berval *npe_name;
1343 struct berval *npe_nname;
1344 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1347 struct sync_cookie {
1348 struct berval *ctxcsn;
1350 struct berval *octet_str;
1352 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1355 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1357 typedef struct syncinfo_s {
1358 struct slap_backend_db *si_be;
1360 char *si_provideruri;
1361 BerVarray si_provideruri_bv;
1362 #define SYNCINFO_TLS_OFF 0
1363 #define SYNCINFO_TLS_ON 1
1364 #define SYNCINFO_TLS_CRITICAL 2
1366 struct berval si_updatedn;
1375 int si_schemachecking;
1377 struct berval si_filterstr;
1378 struct berval si_base;
1384 struct sync_cookie si_syncCookie;
1388 struct berval si_syncUUID_ndn;
1389 Avlnode *si_presentlist;
1391 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1392 LDAP_STAILQ_ENTRY( syncinfo_s ) si_next;
1395 struct slap_backend_db {
1396 BackendInfo *bd_info; /* pointer to shared backend info */
1398 /* BackendInfo accessors */
1399 #define be_config bd_info->bi_db_config
1400 #define be_type bd_info->bi_type
1402 #define be_bind bd_info->bi_op_bind
1403 #define be_unbind bd_info->bi_op_unbind
1404 #define be_add bd_info->bi_op_add
1405 #define be_compare bd_info->bi_op_compare
1406 #define be_delete bd_info->bi_op_delete
1407 #define be_modify bd_info->bi_op_modify
1408 #define be_modrdn bd_info->bi_op_modrdn
1409 #define be_search bd_info->bi_op_search
1410 #define be_abandon bd_info->bi_op_abandon
1411 #define be_cancel bd_info->bi_op_cancel
1413 #define be_extended bd_info->bi_extended
1415 #define be_fetch bd_info->bi_entry_get_rw
1416 #define be_release bd_info->bi_entry_release_rw
1417 #define be_chk_referrals bd_info->bi_chk_referrals
1418 #define be_group bd_info->bi_acl_group
1419 #define be_attribute bd_info->bi_acl_attribute
1420 #define be_operational bd_info->bi_operational
1423 * define to honor hasSubordinates operational attribute in search filters
1424 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1427 #define be_has_subordinates bd_info->bi_has_subordinates
1429 #define be_controls bd_info->bi_controls
1431 #define be_connection_init bd_info->bi_connection_init
1432 #define be_connection_destroy bd_info->bi_connection_destroy
1435 #define be_entry_open bd_info->bi_tool_entry_open
1436 #define be_entry_close bd_info->bi_tool_entry_close
1437 #define be_entry_first bd_info->bi_tool_entry_first
1438 #define be_entry_next bd_info->bi_tool_entry_next
1439 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1440 #define be_entry_get bd_info->bi_tool_entry_get
1441 #define be_entry_put bd_info->bi_tool_entry_put
1442 #define be_sync bd_info->bi_tool_sync
1443 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1444 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1445 #define be_entry_modify bd_info->bi_tool_entry_modify
1448 #define SLAP_BFLAG_NOLASTMOD 0x0001U
1449 #define SLAP_BFLAG_NO_SCHEMA_CHECK 0x0002U
1450 #define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1451 #define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1452 #define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1453 #define SLAP_BFLAG_MONITOR 0x0080U /* a monitor backend */
1454 #define SLAP_BFLAG_INCREMENT 0x0100U
1455 #define SLAP_BFLAG_ALIASES 0x1000U
1456 #define SLAP_BFLAG_REFERRALS 0x2000U
1457 #define SLAP_BFLAG_SUBENTRIES 0x4000U
1458 #define SLAP_BFLAG_DYNAMIC 0x8000U
1459 slap_mask_t be_flags;
1460 #define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1461 #define SLAP_NO_SCHEMA_CHECK(be) (((be)->be_flags & SLAP_BFLAG_NO_SCHEMA_CHECK))
1462 #define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1463 #define SLAP_GLUE_SUBORDINATE(be) \
1464 ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1465 #define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1467 #define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR)
1468 #define SLAP_INCREMENT(be) ((be)->be_flags & SLAP_BFLAG_INCREMENT)
1470 #define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES)
1471 #define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1472 #define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1473 #define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1476 slap_mask_t be_restrictops; /* restriction operations */
1477 #define SLAP_RESTRICT_OP_ADD 0x0001U
1478 #define SLAP_RESTRICT_OP_BIND 0x0002U
1479 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1480 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1481 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1482 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1483 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1484 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1486 #define SLAP_RESTRICT_OP_READS \
1487 ( SLAP_RESTRICT_OP_COMPARE \
1488 | SLAP_RESTRICT_OP_SEARCH )
1489 #define SLAP_RESTRICT_OP_WRITES \
1490 ( SLAP_RESTRICT_OP_ADD \
1491 | SLAP_RESTRICT_OP_DELETE \
1492 | SLAP_RESTRICT_OP_MODIFY \
1493 | SLAP_RESTRICT_OP_RENAME )
1495 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1496 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1497 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1499 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1501 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1502 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1503 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1505 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1506 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1508 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1510 slap_mask_t be_requires; /* pre-operation requirements */
1511 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1512 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1513 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1514 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1515 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1517 /* Required Security Strength Factor */
1518 slap_ssf_set_t be_ssf_set;
1520 /* these should be renamed from be_ to bd_ */
1521 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1522 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1523 struct berval be_schemadn; /* per-backend subschema subentry DN */
1524 struct berval be_schemandn; /* normalized subschema DN */
1525 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1526 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1527 struct berval be_rootpw; /* the magic "root" password for this db */
1528 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1529 #define be_sizelimit be_def_limit.lms_s_soft
1530 #define be_timelimit be_def_limit.lms_t_soft
1531 struct slap_limits_set be_def_limit; /* default limits */
1532 struct slap_limits **be_limits; /* regex-based size and time limits */
1533 AccessControl *be_acl; /* access control list for this backend */
1534 slap_access_t be_dfltaccess; /* access given if no acl matches */
1535 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1536 char *be_replogfile; /* replication log file (in master) */
1537 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1538 BerVarray be_update_refs; /* where to refer modifying clients to */
1540 void *be_private; /* anything the backend database needs */
1542 void *be_pb; /* Netscape plugin */
1543 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry ) be_pending_csn_list;
1544 ldap_pvt_thread_mutex_t be_pcl_mutex;
1545 struct berval be_context_csn;
1546 ldap_pvt_thread_mutex_t be_context_csn_mutex;
1547 LDAP_STAILQ_HEAD( be_si, syncinfo_s ) be_syncinfo; /* For syncrepl */
1553 /* Backend function typedefs */
1554 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1555 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1556 const char *fname, int lineno,
1557 int argc, char **argv));
1558 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1559 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1560 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1562 typedef int (BI_db_init) LDAP_P((Backend *bd));
1563 typedef int (BI_db_config) LDAP_P((Backend *bd,
1564 const char *fname, int lineno,
1565 int argc, char **argv));
1566 typedef int (BI_db_open) LDAP_P((Backend *bd));
1567 typedef int (BI_db_close) LDAP_P((Backend *bd));
1568 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1570 typedef struct req_bind_s {
1572 struct berval rb_cred;
1573 struct berval rb_edn;
1577 typedef struct req_search_s {
1582 /* NULL means be_isroot evaluated to TRUE */
1583 struct slap_limits_set *rs_limit;
1585 AttributeName *rs_attrs;
1587 struct berval rs_filterstr;
1590 typedef struct req_compare_s {
1591 AttributeAssertion *rs_ava;
1594 typedef struct req_modify_s {
1595 Modifications *rs_modlist;
1598 typedef struct req_modrdn_s {
1599 struct berval rs_newrdn;
1600 struct berval rs_nnewrdn;
1601 struct berval *rs_newSup;
1602 struct berval *rs_nnewSup;
1603 int rs_deleteoldrdn;
1606 typedef struct req_add_s {
1610 typedef struct req_abandon_s {
1614 typedef struct req_extended_s {
1615 struct berval rs_reqoid;
1616 struct berval *rs_reqdata;
1619 typedef struct req_pwdexop_s {
1620 struct berval rs_reqoid;
1621 struct berval rs_old;
1622 struct berval rs_new;
1623 Modifications *rs_mods;
1624 Modifications **rs_modtail;
1627 typedef enum slap_reply_e {
1636 typedef struct rep_sasl_s {
1637 struct berval *r_sasldata;
1640 typedef struct rep_extended_s {
1641 const char *r_rspoid;
1642 struct berval *r_rspdata;
1645 typedef struct rep_search_s {
1647 AttributeName *r_attrs;
1652 typedef struct slap_rep {
1653 slap_reply_t sr_type;
1657 const char *sr_matched;
1658 const char *sr_text;
1660 LDAPControl **sr_ctrls;
1662 rep_sasl_s sru_sasl;
1663 rep_extended_s sru_extended;
1664 rep_search_s sru_search;
1666 slap_mask_t sr_flags;
1667 #define REP_ENTRY_MODIFIABLE 0x00000001
1668 #define REP_ENTRY_MUSTBEFREED 0x00000002
1669 #define REP_MATCHED_MUSTBEFREED 0x00000010
1672 /* short hands for response members */
1673 #define sr_attrs sr_un.sru_search.r_attrs
1674 #define sr_entry sr_un.sru_search.r_entry
1675 #define sr_v2ref sr_un.sru_search.r_v2ref
1676 #define sr_nentries sr_un.sru_search.r_nentries
1677 #define sr_rspoid sr_un.sru_extended.r_rspoid
1678 #define sr_rspdata sr_un.sru_extended.r_rspdata
1679 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1681 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1682 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1683 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1684 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1685 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1686 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1687 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1688 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1689 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1690 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1691 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1692 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1693 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1694 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1695 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1696 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1697 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1699 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1700 struct slap_conn *c));
1701 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1702 struct slap_conn *c));
1704 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1705 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1706 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1707 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1708 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1709 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1710 struct berval *text ));
1711 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1712 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1713 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1714 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1715 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1716 struct berval *text ));
1718 struct slap_backend_info {
1719 char *bi_type; /* type of backend */
1722 * per backend type routines:
1723 * bi_init: called to allocate a backend_info structure,
1724 * called once BEFORE configuration file is read.
1725 * bi_init() initializes this structure hence is
1726 * called directly from be_initialize()
1727 * bi_config: called per 'backend' specific option
1728 * all such options must before any 'database' options
1729 * bi_config() is called only from read_config()
1730 * bi_open: called to open each database, called
1731 * once AFTER configuration file is read but
1732 * BEFORE any bi_db_open() calls.
1733 * bi_open() is called from backend_startup()
1734 * bi_close: called to close each database, called
1735 * once during shutdown after all bi_db_close calls.
1736 * bi_close() is called from backend_shutdown()
1737 * bi_destroy: called to destroy each database, called
1738 * once during shutdown after all bi_db_destroy calls.
1739 * bi_destory() is called from backend_destroy()
1742 BI_config *bi_config;
1745 BI_destroy *bi_destroy;
1748 * per database routines:
1749 * bi_db_init: called to initialize each database,
1750 * called upon reading 'database <type>'
1751 * called only from backend_db_init()
1752 * bi_db_config: called to configure each database,
1753 * called per database to handle per database options
1754 * called only from read_config()
1755 * bi_db_open: called to open each database
1756 * called once per database immediately AFTER bi_open()
1757 * calls but before daemon startup.
1758 * called only by backend_startup()
1759 * bi_db_close: called to close each database
1760 * called once per database during shutdown but BEFORE
1761 * any bi_close call.
1762 * called only by backend_shutdown()
1763 * bi_db_destroy: called to destroy each database
1764 * called once per database during shutdown AFTER all
1765 * bi_close calls but before bi_destory calls.
1766 * called only by backend_destory()
1768 BI_db_init *bi_db_init;
1769 BI_db_config *bi_db_config;
1770 BI_db_open *bi_db_open;
1771 BI_db_close *bi_db_close;
1772 BI_db_destroy *bi_db_destroy;
1774 /* LDAP Operations Handling Routines */
1775 BI_op_bind *bi_op_bind;
1776 BI_op_unbind *bi_op_unbind;
1777 BI_op_search *bi_op_search;
1778 BI_op_compare *bi_op_compare;
1779 BI_op_modify *bi_op_modify;
1780 BI_op_modrdn *bi_op_modrdn;
1781 BI_op_add *bi_op_add;
1782 BI_op_delete *bi_op_delete;
1783 BI_op_abandon *bi_op_abandon;
1784 BI_op_cancel *bi_op_cancel;
1786 /* Extended Operations Helper */
1787 BI_op_extended *bi_extended;
1789 /* Auxilary Functions */
1790 BI_entry_get_rw *bi_entry_get_rw;
1791 BI_entry_release_rw *bi_entry_release_rw;
1792 BI_chk_referrals *bi_chk_referrals;
1794 BI_operational *bi_operational;
1795 BI_has_subordinates *bi_has_subordinates;
1797 BI_connection_init *bi_connection_init;
1798 BI_connection_destroy *bi_connection_destroy;
1800 /* hooks for slap tools */
1801 BI_tool_entry_open *bi_tool_entry_open;
1802 BI_tool_entry_close *bi_tool_entry_close;
1803 BI_tool_entry_first *bi_tool_entry_first;
1804 BI_tool_entry_next *bi_tool_entry_next;
1805 BI_tool_entry_get *bi_tool_entry_get;
1806 BI_tool_entry_put *bi_tool_entry_put;
1807 BI_tool_entry_reindex *bi_tool_entry_reindex;
1808 BI_tool_sync *bi_tool_sync;
1809 BI_tool_dn2id_get *bi_tool_dn2id_get;
1810 BI_tool_id2entry_get *bi_tool_id2entry_get;
1811 BI_tool_entry_modify *bi_tool_entry_modify;
1813 #define SLAP_INDEX_ADD_OP 0x0001
1814 #define SLAP_INDEX_DELETE_OP 0x0002
1816 char **bi_controls; /* supported controls */
1818 unsigned int bi_nDB; /* number of databases of this type */
1819 void *bi_private; /* anything the backend type needs */
1822 #define c_authtype c_authz.sai_method
1823 #define c_authmech c_authz.sai_mech
1824 #define c_dn c_authz.sai_dn
1825 #define c_ndn c_authz.sai_ndn
1826 #define c_ssf c_authz.sai_ssf
1827 #define c_transport_ssf c_authz.sai_transport_ssf
1828 #define c_tls_ssf c_authz.sai_tls_ssf
1829 #define c_sasl_ssf c_authz.sai_sasl_ssf
1831 #define o_authtype o_authz.sai_method
1832 #define o_authmech o_authz.sai_mech
1833 #define o_dn o_authz.sai_dn
1834 #define o_ndn o_authz.sai_ndn
1835 #define o_ssf o_authz.sai_ssf
1836 #define o_transport_ssf o_authz.sai_transport_ssf
1837 #define o_tls_ssf o_authz.sai_tls_ssf
1838 #define o_sasl_ssf o_authz.sai_sasl_ssf
1840 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1842 typedef struct slap_callback {
1843 struct slap_callback *sc_next;
1844 slap_response *sc_response;
1845 slap_response *sc_cleanup;
1849 struct slap_overinfo;
1851 typedef struct slap_overinst {
1853 slap_response *on_response;
1854 struct slap_overinfo *on_info;
1855 struct slap_overinst *on_next;
1858 typedef struct slap_overinfo {
1861 slap_overinst *oi_list;
1864 /* Should successive callbacks in a chain be processed? */
1865 #define SLAP_CB_CONTINUE 0x8000
1868 * Paged Results state
1870 typedef unsigned long PagedResultsCookie;
1871 typedef struct slap_paged_state {
1873 PagedResultsCookie ps_cookie;
1875 } PagedResultsState;
1878 #define LDAP_PSEARCH_BY_ADD 0x01
1879 #define LDAP_PSEARCH_BY_DELETE 0x02
1880 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
1881 #define LDAP_PSEARCH_BY_MODIFY 0x04
1882 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
1885 struct slap_op *ps_op;
1886 LDAP_LIST_ENTRY(psid_entry) ps_link;
1890 struct berval sl_uuid;
1891 struct berval sl_name;
1892 struct berval sl_csn;
1893 LDAP_STAILQ_ENTRY(slog_entry) sl_link;
1897 struct slap_session_entry {
1900 struct berval se_spec;
1901 LDAP_LIST_ENTRY( slap_session_entry ) se_link;
1904 struct slap_csn_entry {
1907 unsigned long connid;
1908 #define SLAP_CSN_PENDING 1
1909 #define SLAP_CSN_COMMIT 2
1911 LDAP_TAILQ_ENTRY (slap_csn_entry) csn_link;
1915 * Caches the result of a backend_group check for ACL evaluation
1917 typedef struct slap_gacl {
1918 struct slap_gacl *ga_next;
1921 AttributeDescription *ga_at;
1928 * represents an operation pending from an ldap client
1930 typedef struct slap_op {
1931 unsigned long o_opid; /* id of this operation */
1932 unsigned long o_connid; /* id of conn initiating this op */
1933 struct slap_conn *o_conn; /* connection spawning this op */
1934 BackendDB *o_bd; /* backend DB processing this op */
1936 ber_int_t o_msgid; /* msgid of the request */
1937 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1938 ber_tag_t o_tag; /* tag of the request */
1939 time_t o_time; /* time op was initiated */
1941 struct berval o_req_dn; /* DN of target of request */
1942 struct berval o_req_ndn;
1947 req_compare_s oq_compare;
1948 req_modify_s oq_modify;
1949 req_modrdn_s oq_modrdn;
1950 req_search_s oq_search;
1951 req_abandon_s oq_abandon;
1952 req_abandon_s oq_cancel;
1953 req_extended_s oq_extended;
1954 req_pwdexop_s oq_pwdexop;
1957 /* short hands for union members */
1958 #define oq_add o_request.oq_add
1959 #define oq_bind o_request.oq_bind
1960 #define oq_compare o_request.oq_compare
1961 #define oq_modify o_request.oq_modify
1962 #define oq_modrdn o_request.oq_modrdn
1963 #define oq_search o_request.oq_search
1964 #define oq_abandon o_request.oq_abandon
1965 #define oq_cancel o_request.oq_cancel
1966 #define oq_extended o_request.oq_extended
1967 #define oq_pwdexop o_request.oq_pwdexop
1969 /* short hands for inner request members */
1970 #define orb_method oq_bind.rb_method
1971 #define orb_cred oq_bind.rb_cred
1972 #define orb_edn oq_bind.rb_edn
1973 #define orb_ssf oq_bind.rb_ssf
1975 #define ors_scope oq_search.rs_scope
1976 #define ors_deref oq_search.rs_deref
1977 #define ors_slimit oq_search.rs_slimit
1978 #define ors_tlimit oq_search.rs_tlimit
1979 #define ors_limit oq_search.rs_limit
1980 #define ors_attrsonly oq_search.rs_attrsonly
1981 #define ors_attrs oq_search.rs_attrs
1982 #define ors_filter oq_search.rs_filter
1983 #define ors_filterstr oq_search.rs_filterstr
1985 #define orr_newrdn oq_modrdn.rs_newrdn
1986 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1987 #define orr_newSup oq_modrdn.rs_newSup
1988 #define orr_nnewSup oq_modrdn.rs_nnewSup
1989 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1991 #define orc_ava oq_compare.rs_ava
1992 #define ora_e oq_add.rs_e
1993 #define orn_msgid oq_abandon.rs_msgid
1994 #define orm_modlist oq_modify.rs_modlist
1996 #define ore_reqoid oq_extended.rs_reqoid
1997 #define ore_reqdata oq_extended.rs_reqdata
1999 ldap_pvt_thread_t o_tid; /* thread handling this op */
2001 volatile sig_atomic_t o_abandon; /* abandon flag */
2002 volatile sig_atomic_t o_cancel; /* cancel flag */
2003 #define SLAP_CANCEL_NONE 0x00
2004 #define SLAP_CANCEL_REQ 0x01
2005 #define SLAP_CANCEL_ACK 0x02
2006 #define SLAP_CANCEL_DONE 0x03
2008 GroupAssertion *o_groups;
2009 char o_do_not_cache; /* don't cache groups from this op */
2010 char o_is_auth_check; /* authorization in progress */
2012 #define SLAP_NO_CONTROL 0
2013 #define SLAP_NONCRITICAL_CONTROL 1
2014 #define SLAP_CRITICAL_CONTROL 2
2016 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
2022 #define get_subentries(op) ((int)(op)->o_subentries)
2023 char o_subentries_visibility;
2024 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
2027 #define get_assert(op) ((int)(op)->o_assert)
2029 char o_valuesreturnfilter;
2031 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2032 char o_permissive_modify;
2033 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2035 #define get_permissiveModify(op) (0)
2038 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2039 char o_domain_scope;
2040 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2042 #define get_domainScope(op) (0)
2045 #ifdef LDAP_CONTROL_X_TREE_DELETE
2047 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2049 #define get_treeDelete(op) (0)
2054 AttributeName *o_preread_attrs;
2055 AttributeName *o_postread_attrs;
2057 char o_pagedresults;
2058 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2059 ber_int_t o_pagedresults_size;
2060 PagedResultsState o_pagedresults_state;
2064 #define SLAP_SYNC_NONE LDAP_SYNC_NONE
2065 #define SLAP_SYNC_REFRESH LDAP_SYNC_REFRESH_ONLY
2066 #define SLAP_SYNC_PERSIST LDAP_SYNC_RESERVED
2067 #define SLAP_SYNC_REFRESH_AND_PERSIST LDAP_SYNC_REFRESH_AND_PERSIST
2068 struct sync_cookie o_sync_state;
2070 struct berval o_sync_cid;
2071 int o_sync_slog_size;
2072 struct berval o_sync_csn;
2073 struct berval o_sync_slog_omitcsn;
2074 int o_sync_slog_len;
2075 LDAP_STAILQ_HEAD(sl, slog_entry) o_sync_slog_list;
2079 LDAP_LIST_ENTRY(slap_op) o_ps_link;
2080 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
2082 AuthorizationInformation o_authz;
2084 BerElement *o_ber; /* ber of the request */
2085 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2086 slap_callback *o_callback; /* callback pointers */
2087 LDAPControl **o_ctrls; /* controls */
2089 void *o_threadctx; /* thread pool thread context */
2090 void *o_tmpmemctx; /* slab malloc context */
2091 BerMemoryFunctions *o_tmpmfuncs;
2092 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2093 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2094 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2095 #define o_tmpfree o_tmpmfuncs->bmf_free
2096 void *o_private; /* anything the backend needs */
2098 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2100 Filter *o_assertion; /* Assert control filter */
2101 #define get_assertion(op) ((op)->o_assertion)
2103 ValuesReturnFilter *o_vrFilter; /* ValuesReturnFilter */
2106 int o_delete_glue_parent;
2109 void *o_pb; /* NS-SLAPI plugin */
2110 void *o_extensions; /* NS-SLAPI plugin */
2114 #define send_ldap_error( op, rs, err, text ) do { \
2115 (rs)->sr_err = err; (rs)->sr_text = text; \
2116 (op->o_conn->c_send_ldap_result)( op, rs ); \
2118 #define send_ldap_discon( op, rs, err, text ) do { \
2119 (rs)->sr_err = err; (rs)->sr_text = text; \
2120 send_ldap_disconnect( op, rs ); \
2123 typedef void (SEND_LDAP_RESULT)(
2124 struct slap_op *op, struct slap_rep *rs);
2125 typedef int (SEND_SEARCH_ENTRY)(
2126 struct slap_op *op, struct slap_rep *rs);
2127 typedef int (SEND_SEARCH_REFERENCE)(
2128 struct slap_op *op, struct slap_rep *rs);
2129 typedef void (SEND_LDAP_EXTENDED)(
2130 struct slap_op *op, struct slap_rep *rs);
2131 typedef void (SEND_LDAP_INTERMEDIATE)(
2132 struct slap_op *op, struct slap_rep *rs);
2134 #define send_ldap_result( op, rs ) \
2135 (op->o_conn->c_send_ldap_result)( op, rs )
2136 #define send_search_entry( op, rs ) \
2137 (op->o_conn->c_send_search_entry)( op, rs )
2138 #define send_search_reference( op, rs ) \
2139 (op->o_conn->c_send_search_reference)( op, rs )
2140 #define send_ldap_extended( op, rs ) \
2141 (op->o_conn->c_send_ldap_extended)( op, rs )
2142 #define send_ldap_intermediate( op, rs ) \
2143 (op->o_conn->c_send_ldap_intermediate)( op, rs )
2145 typedef struct slap_listener Listener;
2148 * represents a connection from an ldap client
2150 typedef struct slap_conn {
2151 int c_struct_state; /* structure management state */
2152 int c_conn_state; /* connection state */
2153 int c_conn_idx; /* slot in connections array */
2155 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2156 Sockbuf *c_sb; /* ber connection stuff */
2158 /* only can be changed by connect_init */
2159 time_t c_starttime; /* when the connection was opened */
2160 time_t c_activitytime; /* when the connection was last used */
2161 unsigned long c_connid; /* id of this connection for stats*/
2163 struct berval c_peer_domain; /* DNS name of client */
2164 struct berval c_peer_name; /* peer name (trans=addr:port) */
2165 Listener *c_listener;
2166 #define c_listener_url c_listener->sl_url /* listener URL */
2167 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2169 /* only can be changed by binding thread */
2170 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2171 struct berval c_sasl_bind_mech; /* mech in progress */
2172 struct berval c_sasl_dn; /* temporary storage */
2174 /* authorization backend */
2175 Backend *c_authz_backend;
2177 AuthorizationInformation c_authz;
2179 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2181 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2182 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2184 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2185 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2187 BerElement *c_currentber; /* ber we're attempting to read */
2188 int c_writewaiter; /* true if writer is waiting */
2190 #define CONN_IS_TLS 1
2191 #define CONN_IS_UDP 2
2192 #define CONN_IS_CLIENT 3
2194 #ifdef LDAP_CONNECTIONLESS
2195 int c_is_udp; /* true if this is (C)LDAP over UDP */
2198 int c_is_tls; /* true if this LDAP over raw TLS */
2199 int c_needs_tls_accept; /* true if SSL_accept should be called */
2201 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2202 int c_sasl_done; /* SASL completed once */
2203 void *c_sasl_authctx; /* SASL authentication context */
2204 void *c_sasl_sockctx; /* SASL security layer context */
2205 void *c_sasl_extra; /* SASL session extra stuff */
2206 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2208 PagedResultsState c_pagedresults_state; /* paged result state */
2210 long c_n_ops_received; /* num of ops received (next op_id) */
2211 long c_n_ops_executing; /* num of ops currently executing */
2212 long c_n_ops_pending; /* num of ops pending execution */
2213 long c_n_ops_completed; /* num of ops completed */
2215 long c_n_get; /* num of get calls */
2216 long c_n_read; /* num of read calls */
2217 long c_n_write; /* num of write calls */
2219 void *c_pb; /* Netscape plugin */
2220 void *c_extensions; /* Netscape plugin */
2223 * Client connection handling
2225 ldap_pvt_thread_start_t *c_clientfunc;
2229 * These are the "callbacks" that are available for back-ends to
2230 * supply data back to connected clients that are connected
2231 * through the "front-end".
2233 SEND_LDAP_RESULT *c_send_ldap_result;
2234 SEND_SEARCH_ENTRY *c_send_search_entry;
2235 SEND_SEARCH_REFERENCE *c_send_search_reference;
2236 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2237 #ifdef LDAP_RES_INTERMEDIATE
2238 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2243 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2244 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2246 if ( ldap_debug & (level) ) \
2247 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2248 if ( ldap_syslog & (level) ) \
2249 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2252 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2253 #elif defined(LDAP_DEBUG)
2254 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2256 if ( ldap_debug & (level) ) \
2257 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2259 #define StatslogTest( level ) (ldap_debug & (level))
2261 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2262 #define StatslogTest( level ) (0)
2266 * listener; need to access it from monitor backend
2268 struct slap_listener {
2269 struct berval sl_url;
2270 struct berval sl_name;
2275 #ifdef LDAP_CONNECTIONLESS
2276 int sl_is_udp; /* UDP listener is also data port */
2278 int sl_is_mute; /* Listening is temporarily disabled */
2281 #define sl_addr sl_sa.sa_in_addr
2284 #ifdef SLAPD_MONITOR
2301 #endif /* SLAPD_MONITOR */
2304 * Better know these all around slapd
2306 #define SLAP_LDAPDN_PRETTY 0x1
2307 #define SLAP_LDAPDN_MAXLEN 8192
2309 /* number of response controls supported */
2310 #define SLAP_MAX_RESPONSE_CONTROLS 6
2313 #define SLAP_CTRL_HIDE 0x00000000U
2315 #define SLAP_CTRL_HIDE 0x80000000U
2318 #define SLAP_CTRL_FRONTEND 0x00800000U
2319 #define SLAP_CTRL_FRONTEND_SEARCH 0x00010000U /* for NOOP */
2321 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2322 #define SLAP_CTRL_ABANDON 0x00000001U
2323 #define SLAP_CTRL_ADD 0x00002002U
2324 #define SLAP_CTRL_BIND 0x00000004U
2325 #define SLAP_CTRL_COMPARE 0x00001008U
2326 #define SLAP_CTRL_DELETE 0x00002010U
2327 #define SLAP_CTRL_MODIFY 0x00002020U
2328 #define SLAP_CTRL_RENAME 0x00002040U
2329 #define SLAP_CTRL_SEARCH 0x00001080U
2330 #define SLAP_CTRL_UNBIND 0x00000100U
2332 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2333 #define SLAP_CTRL_UPDATE \
2334 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2335 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2337 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2340 LDAPControl *ctrl ));
2342 #define SLMALLOC_SLAB_SIZE (1024*1024)
2346 #include "proto-slap.h"
2348 #endif /* _SLAP_H_ */