1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 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>
56 #include "ldap_pvt_thread.h"
57 #include "ldap_queue.h"
62 * SLAPD Memory allocation macros
64 * Unlike ch_*() routines, these routines do not assert() upon
65 * allocation error. They are intended to be used instead of
66 * ch_*() routines where the caller has implemented proper
67 * checking for and handling of allocation errors.
69 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
71 #define SLAP_MALLOC(s) ber_memalloc((s))
72 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
73 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
74 #define SLAP_FREE(p) ber_memfree((p))
75 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
76 #define SLAP_STRDUP(s) ber_strdup((s))
77 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
80 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
83 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
84 #define SLAPD_ANONYMOUS "cn=anonymous"
86 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
87 * This is a value used internally by the backends. It is needed to allow
88 * adding values that already exist without getting an error as required by
89 * modrdn when the new rdn was already an attribute value itself.
91 #define SLAP_MOD_SOFTADD 0x1000
93 #define MAXREMATCHES (100)
95 #define SLAP_MAX_WORKER_THREADS (16)
97 #define SLAP_MAX_SYNCREPL_THREADS (8)
99 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
100 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
102 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
103 #define SLAP_CONN_MAX_PENDING_AUTH 1000
105 #define SLAP_TEXT_BUFLEN (256)
107 /* psuedo error code indicating abandoned operation */
108 #define SLAPD_ABANDON (-1024)
110 /* psuedo error code indicating disconnect */
111 #define SLAPD_DISCONNECT (-1025)
113 /* unknown config file directive */
114 #define SLAP_CONF_UNKNOWN (-1026)
116 /* We assume "C" locale, that is US-ASCII */
117 #define ASCII_SPACE(c) ( (c) == ' ' )
118 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
119 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
120 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
121 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
122 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
123 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
124 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
125 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
126 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
127 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
129 #define SLAP_NIBBLE(c) ((c)&0x0f)
130 #define SLAP_ESCAPE_CHAR ('\\')
131 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
132 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
134 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
135 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
137 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
138 /* NOTE: for consistency, this macro must only operate
139 * on normalized/pretty DN, such that ';' is never used
140 * as RDN separator, and all occurrences of ';' must be escaped */
141 #define DN_SEPARATOR(c) ((c) == ',')
142 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
143 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
144 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
146 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
147 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
148 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
149 #define OID_SEPARATOR(c) ( (c) == '.' )
150 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
152 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
153 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
155 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
156 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
158 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
160 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
161 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
162 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
163 (c) == '?' || (c) == ' ' || (c) == '=' )
164 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
166 /* must match in schema_init.c */
167 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
168 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
169 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
170 #define SLAPD_GROUP_ATTR "member"
171 #define SLAPD_GROUP_CLASS "groupOfNames"
172 #define SLAPD_ROLE_ATTR "roleOccupant"
173 #define SLAPD_ROLE_CLASS "organizationalRole"
175 #ifdef SLAPD_ACI_ENABLED
176 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
179 /* change this to "OpenLDAPset" */
180 #define SLAPD_ACI_SET_ATTR "template"
182 #define SLAPD_TOP_OID "2.5.6.0"
184 LDAP_SLAPD_V (int) slap_debug;
186 typedef unsigned long slap_mask_t;
188 /* Security Strength Factor */
189 typedef unsigned slap_ssf_t;
191 typedef struct slap_ssf_set {
193 slap_ssf_t sss_transport;
196 slap_ssf_t sss_update_ssf;
197 slap_ssf_t sss_update_transport;
198 slap_ssf_t sss_update_tls;
199 slap_ssf_t sss_update_sasl;
200 slap_ssf_t sss_simple_bind;
203 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
204 #define SLAP_GETDN_AUTHCID 2
205 #define SLAP_GETDN_AUTHZID 4
210 #define SLAP_INDEX_TYPE 0x00FFUL
211 #define SLAP_INDEX_UNDEFINED 0x0001UL
212 #define SLAP_INDEX_PRESENT 0x0002UL
213 #define SLAP_INDEX_EQUALITY 0x0004UL
214 #define SLAP_INDEX_APPROX 0x0008UL
215 #define SLAP_INDEX_SUBSTR 0x0010UL
216 #define SLAP_INDEX_EXTENDED 0x0020UL
218 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
220 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
222 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
224 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
225 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
226 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
227 #define SLAP_INDEX_SUBSTR_DEFAULT \
228 ( SLAP_INDEX_SUBSTR \
229 | SLAP_INDEX_SUBSTR_INITIAL \
230 | SLAP_INDEX_SUBSTR_ANY \
231 | SLAP_INDEX_SUBSTR_FINAL )
233 /* defaults for initial/final substring indices */
234 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
235 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
237 /* defaults for any substring indices */
238 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
239 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
241 #define SLAP_INDEX_FLAGS 0xF000UL
242 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
243 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
246 * there is a single index for each attribute. these prefixes ensure
247 * that there is no collision among keys.
249 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
250 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
251 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
252 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
253 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
254 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
256 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
257 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
258 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
259 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
260 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
263 * represents schema information for a database
265 #define SLAP_SCHERR_OUTOFMEM 1
266 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
267 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
268 #define SLAP_SCHERR_CLASS_BAD_SUP 4
269 #define SLAP_SCHERR_CLASS_DUP 5
270 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
271 #define SLAP_SCHERR_ATTR_BAD_MR 7
272 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
273 #define SLAP_SCHERR_ATTR_BAD_SUP 9
274 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
275 #define SLAP_SCHERR_ATTR_DUP 11
276 #define SLAP_SCHERR_MR_NOT_FOUND 12
277 #define SLAP_SCHERR_MR_INCOMPLETE 13
278 #define SLAP_SCHERR_MR_DUP 14
279 #define SLAP_SCHERR_SYN_NOT_FOUND 15
280 #define SLAP_SCHERR_SYN_DUP 16
281 #define SLAP_SCHERR_NO_NAME 17
282 #define SLAP_SCHERR_NOT_SUPPORTED 18
283 #define SLAP_SCHERR_BAD_DESCR 19
284 #define SLAP_SCHERR_OIDM 20
285 #define SLAP_SCHERR_CR_DUP 21
286 #define SLAP_SCHERR_CR_BAD_STRUCT 22
287 #define SLAP_SCHERR_CR_BAD_AUX 23
288 #define SLAP_SCHERR_CR_BAD_AT 24
289 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
291 typedef union slap_sockaddr {
292 struct sockaddr sa_addr;
293 struct sockaddr_in sa_in_addr;
295 struct sockaddr_storage sa_storage;
296 struct sockaddr_in6 sa_in6_addr;
299 struct sockaddr_un sa_un_addr;
304 extern int slap_inet4or6;
307 typedef struct slap_oid_macro {
308 struct berval som_oid;
310 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
313 /* forward declarations */
315 struct slap_matching_rule;
317 typedef int slap_syntax_validate_func LDAP_P((
318 struct slap_syntax *syntax,
319 struct berval * in));
321 typedef int slap_syntax_transform_func LDAP_P((
322 struct slap_syntax *syntax,
328 #define LDAP_COMP_MATCH
331 #ifdef LDAP_COMP_MATCH
332 typedef void* slap_component_transform_func LDAP_P((
333 struct berval * in ));
334 struct ComponentDesc;
337 typedef struct slap_syntax {
339 #define ssyn_oid ssyn_syn.syn_oid
340 #define ssyn_desc ssyn_syn.syn_desc
341 #define ssyn_extensions ssyn_syn.syn_extensions
344 ber_len_t ssyn_oidlen;
345 * has been replaced by a struct berval that uses the value
346 * provided by ssyn_syn.syn_oid; a macro that expands to
347 * the bv_len field of the berval is provided for backward
348 * compatibility. CAUTION: NEVER FREE THE BERVAL
350 struct berval ssyn_bvoid;
351 #define ssyn_oidlen ssyn_bvoid.bv_len
353 unsigned int ssyn_flags;
355 #define SLAP_SYNTAX_NONE 0x0000U
356 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
357 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
358 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
360 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
362 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
365 slap_syntax_validate_func *ssyn_validate;
366 slap_syntax_transform_func *ssyn_pretty;
368 #ifdef SLAPD_BINARY_CONVERSION
369 /* convert to and from binary */
370 slap_syntax_transform_func *ssyn_ber2str;
371 slap_syntax_transform_func *ssyn_str2ber;
373 #ifdef LDAP_COMP_MATCH
374 slap_component_transform_func *ssyn_attr2comp;
375 struct ComponentDesc* ssync_comp_syntax;
378 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
381 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
382 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
383 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
384 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
385 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
387 typedef struct slap_syntax_defs_rec {
390 slap_syntax_validate_func *sd_validate;
391 slap_syntax_transform_func *sd_pretty;
392 #ifdef SLAPD_BINARY_CONVERSION
393 slap_syntax_transform_func *sd_ber2str;
394 slap_syntax_transform_func *sd_str2ber;
396 } slap_syntax_defs_rec;
398 /* X -> Y Converter */
399 typedef int slap_mr_convert_func LDAP_P((
405 typedef int slap_mr_normalize_func LDAP_P((
407 struct slap_syntax *syntax, /* NULL if in is asserted value */
408 struct slap_matching_rule *mr,
413 /* Match (compare) function */
414 typedef int slap_mr_match_func LDAP_P((
417 struct slap_syntax *syntax, /* syntax of stored value */
418 struct slap_matching_rule *mr,
419 struct berval * value,
420 void * assertValue ));
422 /* Index generation function */
423 typedef int slap_mr_indexer_func LDAP_P((
426 struct slap_syntax *syntax, /* syntax of stored value */
427 struct slap_matching_rule *mr,
428 struct berval *prefix,
433 /* Filter index function */
434 typedef int slap_mr_filter_func LDAP_P((
437 struct slap_syntax *syntax, /* syntax of stored value */
438 struct slap_matching_rule *mr,
439 struct berval *prefix,
444 typedef struct slap_matching_rule_use MatchingRuleUse;
446 typedef struct slap_matching_rule {
447 LDAPMatchingRule smr_mrule;
448 MatchingRuleUse *smr_mru;
449 /* RFC2252 string representation */
450 struct berval smr_str;
453 * ber_len_t smr_oidlen;
454 * has been replaced by a struct berval that uses the value
455 * provided by smr_mrule.mr_oid; a macro that expands to
456 * the bv_len field of the berval is provided for backward
457 * compatibility. CAUTION: NEVER FREE THE BERVAL
459 struct berval smr_bvoid;
460 #define smr_oidlen smr_bvoid.bv_len
462 slap_mask_t smr_usage;
465 #define SLAP_MR_HIDE 0x0000U
467 #define SLAP_MR_HIDE 0x8000U
470 #define SLAP_MR_TYPE_MASK 0x0F00U
471 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
472 #define SLAP_MR_USAGE 0x000FU
474 #define SLAP_MR_NONE 0x0000U
475 #define SLAP_MR_EQUALITY 0x0100U
476 #define SLAP_MR_ORDERING 0x0200U
477 #define SLAP_MR_SUBSTR 0x0400U
478 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
479 #define SLAP_MR_ORDERED_INDEX 0x1000U
480 #ifdef LDAP_COMP_MATCH
481 #define SLAP_MR_COMPONENT 0x2000U
484 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
486 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
487 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
488 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
492 * The asserted value, depending on the particular usage,
493 * is expected to conform to either the assertion syntax
494 * or the attribute syntax. In some cases, the syntax of
495 * the value is known. If so, these flags indicate which
496 * syntax the value is expected to conform to. If not,
497 * neither of these flags is set (until the syntax of the
498 * provided value is determined). If the value is of the
499 * attribute syntax, the flag is changed once a value of
500 * the assertion syntax is derived from the provided value.
502 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
503 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
504 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
506 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
507 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
508 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
509 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
511 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
512 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
514 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
517 /* either or both the asserted value or attribute value
518 * may be provided in normalized form
520 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
521 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
523 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
524 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
525 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
526 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
528 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
529 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
530 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
531 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
532 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
533 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
535 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
536 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
537 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
538 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
541 slap_mr_convert_func *smr_convert;
542 slap_mr_normalize_func *smr_normalize;
543 slap_mr_match_func *smr_match;
544 slap_mr_indexer_func *smr_indexer;
545 slap_mr_filter_func *smr_filter;
548 * null terminated array of syntaxes compatible with this syntax
549 * note: when MS_EXT is set, this MUST NOT contain the assertion
550 * syntax of the rule. When MS_EXT is not set, it MAY.
552 Syntax **smr_compat_syntaxes;
555 * For equality rules, refers to an associated approximate rule.
556 * For non-equality rules, refers to an associated equality rule.
558 struct slap_matching_rule *smr_associated;
560 #define SLAP_MR_ASSOCIATED(mr,amr) \
561 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
563 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
565 #define smr_oid smr_mrule.mr_oid
566 #define smr_names smr_mrule.mr_names
567 #define smr_desc smr_mrule.mr_desc
568 #define smr_obsolete smr_mrule.mr_obsolete
569 #define smr_syntax_oid smr_mrule.mr_syntax_oid
570 #define smr_extensions smr_mrule.mr_extensions
573 struct slap_matching_rule_use {
574 LDAPMatchingRuleUse smru_mruleuse;
575 MatchingRule *smru_mr;
576 /* RFC2252 string representation */
577 struct berval smru_str;
579 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
581 #define smru_oid smru_mruleuse.mru_oid
582 #define smru_names smru_mruleuse.mru_names
583 #define smru_desc smru_mruleuse.mru_desc
584 #define smru_obsolete smru_mruleuse.mru_obsolete
585 #define smru_applies_oids smru_mruleuse.mru_applies_oids
587 #define smru_usage smru_mr->smr_usage
588 } /* MatchingRuleUse */ ;
590 typedef struct slap_mrule_defs_rec {
592 slap_mask_t mrd_usage;
593 char ** mrd_compat_syntaxes;
594 slap_mr_convert_func * mrd_convert;
595 slap_mr_normalize_func * mrd_normalize;
596 slap_mr_match_func * mrd_match;
597 slap_mr_indexer_func * mrd_indexer;
598 slap_mr_filter_func * mrd_filter;
600 /* For equality rule, this may refer to an associated approximate rule */
601 /* For non-equality rule, this may refer to an associated equality rule */
602 char * mrd_associated;
603 } slap_mrule_defs_rec;
605 struct slap_backend_db;
609 typedef int (AttributeTypeSchemaCheckFN)(
610 struct slap_backend_db *be,
611 struct slap_entry *e,
612 struct slap_attr *attr,
614 char *textbuf, size_t textlen );
616 typedef struct slap_attribute_type {
617 LDAPAttributeType sat_atype;
618 struct berval sat_cname;
619 struct slap_attribute_type *sat_sup;
620 struct slap_attribute_type **sat_subtypes;
621 MatchingRule *sat_equality;
622 MatchingRule *sat_approx;
623 MatchingRule *sat_ordering;
624 MatchingRule *sat_substr;
627 AttributeTypeSchemaCheckFN *sat_check;
629 #define SLAP_AT_NONE 0x0000U
630 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
631 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
633 #define SLAP_AT_HIDE 0x0000U /* publish everything */
635 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
637 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
639 slap_mask_t sat_flags;
641 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
643 #define sat_oid sat_atype.at_oid
644 #define sat_names sat_atype.at_names
645 #define sat_desc sat_atype.at_desc
646 #define sat_obsolete sat_atype.at_obsolete
647 #define sat_sup_oid sat_atype.at_sup_oid
648 #define sat_equality_oid sat_atype.at_equality_oid
649 #define sat_ordering_oid sat_atype.at_ordering_oid
650 #define sat_substr_oid sat_atype.at_substr_oid
651 #define sat_syntax_oid sat_atype.at_syntax_oid
652 #define sat_single_value sat_atype.at_single_value
653 #define sat_collective sat_atype.at_collective
654 #define sat_no_user_mod sat_atype.at_no_user_mod
655 #define sat_usage sat_atype.at_usage
656 #define sat_extensions sat_atype.at_extensions
658 struct slap_attr_desc *sat_ad;
659 ldap_pvt_thread_mutex_t sat_ad_mutex;
662 #define is_at_operational(at) ((at)->sat_usage)
663 #define is_at_single_value(at) ((at)->sat_single_value)
664 #define is_at_collective(at) ((at)->sat_collective)
665 #define is_at_obsolete(at) ((at)->sat_obsolete)
666 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
668 struct slap_object_class;
670 typedef int (ObjectClassSchemaCheckFN)(
671 struct slap_backend_db *be,
672 struct slap_entry *e,
673 struct slap_object_class *oc,
675 char *textbuf, size_t textlen );
677 typedef struct slap_object_class {
678 LDAPObjectClass soc_oclass;
679 struct berval soc_cname;
680 struct slap_object_class **soc_sups;
681 AttributeType **soc_required;
682 AttributeType **soc_allowed;
683 ObjectClassSchemaCheckFN *soc_check;
684 slap_mask_t soc_flags;
685 #define soc_oid soc_oclass.oc_oid
686 #define soc_names soc_oclass.oc_names
687 #define soc_desc soc_oclass.oc_desc
688 #define soc_obsolete soc_oclass.oc_obsolete
689 #define soc_sup_oids soc_oclass.oc_sup_oids
690 #define soc_kind soc_oclass.oc_kind
691 #define soc_at_oids_must soc_oclass.oc_at_oids_must
692 #define soc_at_oids_may soc_oclass.oc_at_oids_may
693 #define soc_extensions soc_oclass.oc_extensions
695 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
698 #define SLAP_OC_ALIAS 0x0001
699 #define SLAP_OC_REFERRAL 0x0002
700 #define SLAP_OC_SUBENTRY 0x0004
701 #define SLAP_OC_DYNAMICOBJECT 0x0008
702 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
703 #define SLAP_OC_GLUE 0x0020
704 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
705 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
706 #define SLAP_OC__MASK 0x00FF
707 #define SLAP_OC__END 0x0100
708 #define SLAP_OC_OPERATIONAL 0x4000
710 #define SLAP_OC_HIDE 0x0000
712 #define SLAP_OC_HIDE 0x8000
718 typedef struct slap_content_rule {
719 LDAPContentRule scr_crule;
720 ObjectClass *scr_sclass;
721 ObjectClass **scr_auxiliaries; /* optional */
722 AttributeType **scr_required; /* optional */
723 AttributeType **scr_allowed; /* optional */
724 AttributeType **scr_precluded; /* optional */
725 #define scr_oid scr_crule.cr_oid
726 #define scr_names scr_crule.cr_names
727 #define scr_desc scr_crule.cr_desc
728 #define scr_obsolete scr_crule.cr_obsolete
729 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
730 #define scr_at_oids_must scr_crule.cr_at_oids_must
731 #define scr_at_oids_may scr_crule.cr_at_oids_may
732 #define scr_at_oids_not scr_crule.cr_at_oids_not
734 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
737 /* Represents a recognized attribute description ( type + options ). */
738 typedef struct slap_attr_desc {
739 struct slap_attr_desc *ad_next;
740 AttributeType *ad_type; /* attribute type, must be specified */
741 struct berval ad_cname; /* canonical name, must be specified */
742 struct berval ad_tags; /* empty if no tagging options */
744 #define SLAP_DESC_NONE 0x00U
745 #define SLAP_DESC_BINARY 0x01U
746 #define SLAP_DESC_TAG_RANGE 0x80U
747 } AttributeDescription;
749 typedef struct slap_attr_name {
750 struct berval an_name;
751 AttributeDescription *an_desc;
756 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
757 #define slap_ad_is_tag_range(ad) \
758 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
759 #define slap_ad_is_binary(ad) \
760 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
763 * pointers to schema elements used internally
765 struct slap_internal_schema {
767 ObjectClass *si_oc_top;
768 ObjectClass *si_oc_extensibleObject;
769 ObjectClass *si_oc_alias;
770 ObjectClass *si_oc_referral;
771 ObjectClass *si_oc_rootdse;
772 ObjectClass *si_oc_subentry;
773 ObjectClass *si_oc_subschema;
774 ObjectClass *si_oc_collectiveAttributeSubentry;
775 ObjectClass *si_oc_dynamicObject;
777 ObjectClass *si_oc_glue;
778 ObjectClass *si_oc_syncConsumerSubentry;
779 ObjectClass *si_oc_syncProviderSubentry;
781 /* objectClass attribute descriptions */
782 AttributeDescription *si_ad_objectClass;
784 /* operational attribute descriptions */
785 AttributeDescription *si_ad_structuralObjectClass;
786 AttributeDescription *si_ad_creatorsName;
787 AttributeDescription *si_ad_createTimestamp;
788 AttributeDescription *si_ad_modifiersName;
789 AttributeDescription *si_ad_modifyTimestamp;
790 AttributeDescription *si_ad_hasSubordinates;
791 AttributeDescription *si_ad_subschemaSubentry;
792 AttributeDescription *si_ad_collectiveSubentries;
793 AttributeDescription *si_ad_collectiveExclusions;
794 AttributeDescription *si_ad_entryDN;
795 AttributeDescription *si_ad_entryUUID;
796 AttributeDescription *si_ad_entryCSN;
797 AttributeDescription *si_ad_namingCSN;
799 AttributeDescription *si_ad_dseType;
800 AttributeDescription *si_ad_syncreplCookie;
801 AttributeDescription *si_ad_syncTimestamp;
802 AttributeDescription *si_ad_contextCSN;
804 /* root DSE attribute descriptions */
805 AttributeDescription *si_ad_altServer;
806 AttributeDescription *si_ad_namingContexts;
807 AttributeDescription *si_ad_supportedControl;
808 AttributeDescription *si_ad_supportedExtension;
809 AttributeDescription *si_ad_supportedLDAPVersion;
810 AttributeDescription *si_ad_supportedSASLMechanisms;
811 AttributeDescription *si_ad_supportedFeatures;
812 AttributeDescription *si_ad_monitorContext;
813 AttributeDescription *si_ad_vendorName;
814 AttributeDescription *si_ad_vendorVersion;
816 /* subentry attribute descriptions */
817 AttributeDescription *si_ad_administrativeRole;
818 AttributeDescription *si_ad_subtreeSpecification;
820 /* subschema subentry attribute descriptions */
821 AttributeDescription *si_ad_attributeTypes;
822 AttributeDescription *si_ad_ditContentRules;
823 AttributeDescription *si_ad_ditStructureRules;
824 AttributeDescription *si_ad_ldapSyntaxes;
825 AttributeDescription *si_ad_matchingRules;
826 AttributeDescription *si_ad_matchingRuleUse;
827 AttributeDescription *si_ad_nameForms;
828 AttributeDescription *si_ad_objectClasses;
830 /* Aliases & Referrals */
831 AttributeDescription *si_ad_aliasedObjectName;
832 AttributeDescription *si_ad_ref;
834 /* Access Control Internals */
835 AttributeDescription *si_ad_entry;
836 AttributeDescription *si_ad_children;
837 AttributeDescription *si_ad_saslAuthzTo;
838 AttributeDescription *si_ad_saslAuthzFrom;
839 #ifdef SLAPD_ACI_ENABLED
840 AttributeDescription *si_ad_aci;
843 /* dynamic entries */
844 AttributeDescription *si_ad_entryTtl;
845 AttributeDescription *si_ad_dynamicSubtrees;
847 /* Other attributes descriptions */
848 AttributeDescription *si_ad_distinguishedName;
849 AttributeDescription *si_ad_name;
850 AttributeDescription *si_ad_cn;
851 AttributeDescription *si_ad_uid;
852 AttributeDescription *si_ad_userPassword;
853 AttributeDescription *si_ad_labeledURI;
854 #ifdef SLAPD_AUTHPASSWD
855 AttributeDescription *si_ad_authPassword;
857 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
858 AttributeDescription *si_ad_krbName;
861 /* Undefined Attribute Type */
862 AttributeType *si_at_undefined;
865 MatchingRule *si_mr_distinguishedNameMatch;
866 MatchingRule *si_mr_dnSubtreeMatch;
867 MatchingRule *si_mr_dnOneLevelMatch;
868 MatchingRule *si_mr_dnSubordinateMatch;
869 MatchingRule *si_mr_dnSuperiorMatch;
870 MatchingRule *si_mr_caseExactMatch;
871 MatchingRule *si_mr_caseExactSubstringsMatch;
872 MatchingRule *si_mr_caseExactIA5Match;
873 MatchingRule *si_mr_integerMatch;
874 MatchingRule *si_mr_integerFirstComponentMatch;
875 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
878 Syntax *si_syn_directoryString;
879 Syntax *si_syn_distinguishedName;
880 Syntax *si_syn_integer;
881 Syntax *si_syn_octetString;
883 /* Schema Syntaxes */
884 Syntax *si_syn_attributeTypeDesc;
885 Syntax *si_syn_ditContentRuleDesc;
886 Syntax *si_syn_ditStructureRuleDesc;
887 Syntax *si_syn_ldapSyntaxDesc;
888 Syntax *si_syn_matchingRuleDesc;
889 Syntax *si_syn_matchingRuleUseDesc;
890 Syntax *si_syn_nameFormDesc;
891 Syntax *si_syn_objectClassDesc;
894 typedef struct slap_attr_assertion {
895 AttributeDescription *aa_desc;
896 struct berval aa_value;
897 } AttributeAssertion;
899 typedef struct slap_ss_assertion {
900 AttributeDescription *sa_desc;
901 struct berval sa_initial;
902 struct berval *sa_any;
903 struct berval sa_final;
904 } SubstringsAssertion;
906 #ifdef LDAP_COMP_MATCH
907 struct slap_component_filter;
910 typedef struct slap_mr_assertion {
911 MatchingRule *ma_rule; /* optional */
912 struct berval ma_rule_text; /* optional */
913 AttributeDescription *ma_desc; /* optional */
914 int ma_dnattrs; /* boolean */
915 struct berval ma_value; /* required */
916 #ifdef LDAP_COMP_MATCH
917 struct slap_component_filter* ma_cf; /* component filter */
919 } MatchingRuleAssertion;
922 * represents a search filter
924 typedef struct slap_filter {
925 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
926 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
927 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
928 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
929 #ifdef LDAP_SCOPE_SUBORDINATE
930 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
934 /* precomputed result */
935 ber_int_t f_un_result;
938 struct berval *f_un_dn;
941 AttributeDescription *f_un_desc;
943 /* simple value assertion */
944 AttributeAssertion *f_un_ava;
946 /* substring assertion */
947 SubstringsAssertion *f_un_ssa;
949 /* matching rule assertion */
950 MatchingRuleAssertion *f_un_mra;
952 #define f_dn f_un.f_un_dn
953 #define f_desc f_un.f_un_desc
954 #define f_ava f_un.f_un_ava
955 #define f_av_desc f_un.f_un_ava->aa_desc
956 #define f_av_value f_un.f_un_ava->aa_value
957 #define f_sub f_un.f_un_ssa
958 #define f_sub_desc f_un.f_un_ssa->sa_desc
959 #define f_sub_initial f_un.f_un_ssa->sa_initial
960 #define f_sub_any f_un.f_un_ssa->sa_any
961 #define f_sub_final f_un.f_un_ssa->sa_final
962 #define f_mra f_un.f_un_mra
963 #define f_mr_rule f_un.f_un_mra->ma_rule
964 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
965 #define f_mr_desc f_un.f_un_mra->ma_desc
966 #define f_mr_value f_un.f_un_mra->ma_value
967 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
970 struct slap_filter *f_un_complex;
973 #define f_result f_un.f_un_result
974 #define f_and f_un.f_un_complex
975 #define f_or f_un.f_un_complex
976 #define f_not f_un.f_un_complex
977 #define f_list f_un.f_un_complex
979 struct slap_filter *f_next;
982 /* compare routines can return undefined */
983 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
985 typedef struct slap_valuesreturnfilter {
986 ber_tag_t vrf_choice;
989 /* precomputed result */
990 ber_int_t vrf_un_result;
996 AttributeDescription *vrf_un_desc;
998 /* simple value assertion */
999 AttributeAssertion *vrf_un_ava;
1001 /* substring assertion */
1002 SubstringsAssertion *vrf_un_ssa;
1004 /* matching rule assertion */
1005 MatchingRuleAssertion *vrf_un_mra;
1007 #define vrf_result vrf_un.vrf_un_result
1008 #define vrf_dn vrf_un.vrf_un_dn
1009 #define vrf_desc vrf_un.vrf_un_desc
1010 #define vrf_ava vrf_un.vrf_un_ava
1011 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1012 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1013 #define vrf_ssa vrf_un.vrf_un_ssa
1014 #define vrf_sub vrf_un.vrf_un_ssa
1015 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1016 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1017 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1018 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1019 #define vrf_mra vrf_un.vrf_un_mra
1020 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1021 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1022 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1023 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1024 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1029 struct slap_valuesreturnfilter *vrf_next;
1030 } ValuesReturnFilter;
1032 #ifdef LDAP_COMP_MATCH
1033 struct slap_component_syntax_info;
1034 typedef struct slap_component_data {
1035 void* cd_mem_op;/* nibble memory handler */
1036 struct slap_component_syntax_info** cd_tree;/* component tree */
1041 * represents an attribute (description + values)
1043 typedef struct slap_attr {
1044 AttributeDescription *a_desc;
1045 BerVarray a_vals; /* preserved values */
1046 BerVarray a_nvals; /* normalized values */
1047 #ifdef LDAP_COMP_MATCH
1048 ComponentData *a_comp_data; /* component values */
1050 struct slap_attr *a_next;
1052 #define SLAP_ATTR_IXADD 0x1U
1053 #define SLAP_ATTR_IXDEL 0x2U
1058 * the id used in the indexes to refer to an entry
1060 typedef unsigned long ID;
1061 #define NOID ((ID)~0)
1064 * represents an entry in core
1066 typedef struct slap_entry {
1068 * The ID field should only be changed before entry is
1069 * inserted into a cache. The ID value is backend
1074 struct berval e_name; /* name (DN) of this entry */
1075 struct berval e_nname; /* normalized name (DN) of this entry */
1077 /* for migration purposes */
1078 #define e_dn e_name.bv_val
1079 #define e_ndn e_nname.bv_val
1081 Attribute *e_attrs; /* list of attributes + values */
1083 slap_mask_t e_ocflags;
1085 struct berval e_bv; /* For entry_encode/entry_decode */
1087 /* for use by the backend for any purpose */
1092 * A list of LDAPMods
1094 typedef struct slap_mod {
1096 AttributeDescription *sm_desc;
1097 struct berval sm_type;
1098 BerVarray sm_values;
1099 BerVarray sm_nvalues;
1102 typedef struct slap_mod_list {
1103 Modification sml_mod;
1104 #define sml_op sml_mod.sm_op
1105 #define sml_desc sml_mod.sm_desc
1106 #define sml_type sml_mod.sm_type
1107 #define sml_values sml_mod.sm_values
1108 #define sml_nvalues sml_mod.sm_nvalues
1109 struct slap_mod_list *sml_next;
1112 typedef struct slap_ldap_modlist {
1114 struct slap_ldap_modlist *ml_next;
1115 #define ml_op ml_mod.mod_op
1116 #define ml_type ml_mod.mod_type
1117 #define ml_values ml_mod.mod_values
1121 * represents an access control list
1123 typedef enum slap_access_e {
1124 ACL_INVALID_ACCESS = -1,
1135 typedef enum slap_control_e {
1136 ACL_INVALID_CONTROL = 0,
1142 typedef enum slap_style_e {
1143 ACL_STYLE_REGEX = 0,
1150 ACL_STYLE_ANONYMOUS,
1157 typedef struct slap_authz_info {
1158 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1159 struct berval sai_mech; /* SASL Mechanism */
1160 struct berval sai_dn; /* DN for reporting purposes */
1161 struct berval sai_ndn; /* Normalized DN */
1163 /* Security Strength Factors */
1164 slap_ssf_t sai_ssf; /* Overall SSF */
1165 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1166 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1167 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1168 } AuthorizationInformation;
1173 #endif /* LDAP_DEVEL */
1179 * "dynamic" ACL infrastructure (for ACIs and more)
1181 typedef int (*slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1182 typedef int (*slap_dynacl_print)( void *priv );
1183 typedef int (*slap_dynacl_mask)(
1187 AttributeDescription *desc,
1190 regmatch_t *matches,
1191 slap_access_t *grant,
1192 slap_access_t *deny );
1193 typedef int (*slap_dynacl_destroy)( void *priv );
1195 typedef struct slap_dynacl_t {
1197 slap_dynacl_parse da_parse;
1198 slap_dynacl_print da_print;
1199 slap_dynacl_mask da_mask;
1200 slap_dynacl_destroy da_destroy;
1203 struct slap_dynacl_t *da_next;
1205 #endif /* SLAP_DYNACL */
1208 typedef struct slap_access {
1209 slap_control_t a_type;
1211 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1213 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1214 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1215 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1216 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1217 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1218 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1219 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1220 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1222 #define ACL_PRIV_MASK 0x00ffUL
1225 #define ACL_PRIV_LEVEL 0x1000UL
1226 #define ACL_PRIV_ADDITIVE 0x2000UL
1227 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1230 #define ACL_PRIV_INVALID 0x0UL
1232 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1233 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1234 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1235 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1237 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1238 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1240 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1242 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1244 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1245 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1246 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1248 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1249 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1250 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1251 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1252 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1253 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1254 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1255 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1257 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1258 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1259 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1260 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1261 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1262 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1263 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1264 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1265 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1267 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1268 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1269 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1270 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1271 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1272 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1273 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1274 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1276 slap_mask_t a_access_mask;
1278 AuthorizationInformation a_authz;
1279 #define a_dn_pat a_authz.sai_dn
1281 slap_style_t a_dn_style;
1282 AttributeDescription *a_dn_at;
1286 slap_style_t a_peername_style;
1287 struct berval a_peername_pat;
1288 unsigned long a_peername_addr,
1290 int a_peername_port;
1292 slap_style_t a_sockname_style;
1293 struct berval a_sockname_pat;
1295 slap_style_t a_domain_style;
1296 struct berval a_domain_pat;
1297 int a_domain_expand;
1299 slap_style_t a_sockurl_style;
1300 struct berval a_sockurl_pat;
1301 slap_style_t a_set_style;
1302 struct berval a_set_pat;
1305 slap_dynacl_t *a_dynacl;
1306 #else /* ! SLAP_DYNACL */
1307 #ifdef SLAPD_ACI_ENABLED
1308 AttributeDescription *a_aci_at;
1310 #endif /* SLAP_DYNACL */
1313 slap_style_t a_group_style;
1314 struct berval a_group_pat;
1315 ObjectClass *a_group_oc;
1316 AttributeDescription *a_group_at;
1318 struct slap_access *a_next;
1322 typedef struct slap_acl {
1323 /* "to" part: the entries this acl applies to */
1325 slap_style_t acl_dn_style;
1327 struct berval acl_dn_pat;
1328 AttributeName *acl_attrs;
1329 slap_style_t acl_attrval_style;
1330 regex_t acl_attrval_re;
1331 struct berval acl_attrval;
1333 /* "by" part: list of who has what access to the entries */
1336 struct slap_acl *acl_next;
1339 typedef struct slap_acl_state {
1340 unsigned as_recorded;
1341 #define ACL_STATE_NOT_RECORDED 0x0
1342 #define ACL_STATE_RECORDED_VD 0x1
1343 #define ACL_STATE_RECORDED_NV 0x2
1344 #define ACL_STATE_RECORDED 0x3
1347 AccessControl *as_vd_acl;
1348 AccessControl *as_vi_acl;
1349 slap_mask_t as_vd_acl_mask;
1350 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1351 int as_vd_acl_count;
1353 Access *as_vd_access;
1354 int as_vd_access_count;
1357 AttributeDescription *as_vd_ad;
1358 } AccessControlState;
1359 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1360 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1364 * represents a backend
1367 typedef struct slap_backend_info BackendInfo; /* per backend type */
1368 typedef struct slap_backend_db BackendDB; /* per backend database */
1370 LDAP_SLAPD_V (int) nBackendInfo;
1371 LDAP_SLAPD_V (int) nBackendDB;
1372 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1373 LDAP_SLAPD_V (BackendDB *) backendDB;
1374 LDAP_SLAPD_V (BackendDB *) frontendDB;
1376 LDAP_SLAPD_V (int) slapMode;
1377 #define SLAP_UNDEFINED_MODE 0x0000
1378 #define SLAP_SERVER_MODE 0x0001
1379 #define SLAP_TOOL_MODE 0x0002
1380 #define SLAP_MODE 0x0003
1382 #define SLAP_TRUNCATE_MODE 0x0100
1383 #define SLAP_TOOL_READMAIN 0x0200
1384 #define SLAP_TOOL_READONLY 0x0400
1386 struct slap_replica_info {
1387 char *ri_host; /* supersedes be_replica */
1388 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1389 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1390 int ri_exclude; /* 1 => exclude ri_attrs */
1393 struct slap_limits_set {
1401 int lms_s_unchecked;
1407 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1408 #define SLAP_NO_LIMIT -1
1409 #define SLAP_MAX_LIMIT 2147483647
1411 struct slap_limits {
1412 unsigned lm_flags; /* type of pattern */
1413 #define SLAP_LIMITS_UNDEFINED 0x0000U
1414 #define SLAP_LIMITS_EXACT 0x0001U
1415 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1416 #define SLAP_LIMITS_ONE 0x0002U
1417 #define SLAP_LIMITS_SUBTREE 0x0003U
1418 #define SLAP_LIMITS_CHILDREN 0x0004U
1419 #define SLAP_LIMITS_REGEX 0x0005U
1420 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1421 #define SLAP_LIMITS_USERS 0x0007U
1422 #define SLAP_LIMITS_ANY 0x0008U
1423 #define SLAP_LIMITS_MASK 0x000FU
1425 #define SLAP_LIMITS_TYPE_DN 0x0000U
1426 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1427 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1429 regex_t lm_regex; /* regex data for REGEX */
1432 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1433 * pattern for REGEX; NULL for ANONYMOUS, USERS
1435 struct berval lm_pat;
1437 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1438 * lm_group_oc is objectClass and lm_group_at is attributeType
1439 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1440 * can only be SLAP_LIMITS_EXACT */
1441 ObjectClass *lm_group_oc;
1442 AttributeDescription *lm_group_ad;
1444 struct slap_limits_set lm_limits;
1447 /* temporary aliases */
1448 typedef BackendDB Backend;
1449 #define nbackends nBackendDB
1450 #define backends backendDB
1453 * syncinfo structure for syncrepl
1456 #define SLAP_SYNC_SID_SIZE 3
1457 #define SLAP_SYNC_RID_SIZE 3
1458 #define SLAP_SYNCUUID_SET_SIZE 256
1460 struct nonpresent_entry {
1461 struct berval *npe_name;
1462 struct berval *npe_nname;
1463 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1466 struct sync_cookie {
1467 struct berval *ctxcsn;
1469 struct berval *octet_str;
1471 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1474 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1476 typedef struct syncinfo_s {
1477 struct slap_backend_db *si_be;
1479 char *si_provideruri;
1480 BerVarray si_provideruri_bv;
1481 #define SYNCINFO_TLS_OFF 0
1482 #define SYNCINFO_TLS_ON 1
1483 #define SYNCINFO_TLS_CRITICAL 2
1493 int si_schemachecking;
1494 struct berval si_filterstr;
1495 struct berval si_base;
1498 AttributeName *si_anlist;
1499 AttributeName *si_exanlist;
1506 time_t *si_retryinterval;
1507 int *si_retrynum_init;
1509 struct sync_cookie si_syncCookie;
1513 int si_refreshDelete;
1514 int si_refreshPresent;
1515 Avlnode *si_presentlist;
1517 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1518 LDAP_STAILQ_ENTRY( syncinfo_s ) si_next;
1521 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1523 struct slap_backend_db {
1524 BackendInfo *bd_info; /* pointer to shared backend info */
1526 /* fields in this structure (and routines acting on this structure)
1527 should be renamed from be_ to bd_ */
1529 /* BackendInfo accessors */
1530 #define be_config bd_info->bi_db_config
1531 #define be_type bd_info->bi_type
1533 #define be_bind bd_info->bi_op_bind
1534 #define be_unbind bd_info->bi_op_unbind
1535 #define be_add bd_info->bi_op_add
1536 #define be_compare bd_info->bi_op_compare
1537 #define be_delete bd_info->bi_op_delete
1538 #define be_modify bd_info->bi_op_modify
1539 #define be_modrdn bd_info->bi_op_modrdn
1540 #define be_search bd_info->bi_op_search
1541 #define be_abandon bd_info->bi_op_abandon
1542 #define be_cancel bd_info->bi_op_cancel
1544 #define be_extended bd_info->bi_extended
1546 #define be_chk_referrals bd_info->bi_chk_referrals
1547 #define be_fetch bd_info->bi_entry_get_rw
1548 #define be_release bd_info->bi_entry_release_rw
1549 #define be_group bd_info->bi_acl_group
1550 #define be_attribute bd_info->bi_acl_attribute
1551 #define be_operational bd_info->bi_operational
1554 * define to honor hasSubordinates operational attribute in search filters
1555 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1558 #define be_has_subordinates bd_info->bi_has_subordinates
1560 #define be_controls bd_info->bi_controls
1562 #define be_connection_init bd_info->bi_connection_init
1563 #define be_connection_destroy bd_info->bi_connection_destroy
1566 #define be_entry_open bd_info->bi_tool_entry_open
1567 #define be_entry_close bd_info->bi_tool_entry_close
1568 #define be_entry_first bd_info->bi_tool_entry_first
1569 #define be_entry_next bd_info->bi_tool_entry_next
1570 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1571 #define be_entry_get bd_info->bi_tool_entry_get
1572 #define be_entry_put bd_info->bi_tool_entry_put
1573 #define be_sync bd_info->bi_tool_sync
1574 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1575 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1576 #define be_entry_modify bd_info->bi_tool_entry_modify
1579 /* Database flags */
1580 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1581 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1582 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1583 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1584 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1585 #define SLAP_DBFLAG_OVERLAY 0x0080U /* this db struct is an overlay */
1586 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1587 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1588 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1589 slap_mask_t be_flags;
1590 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1591 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1592 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1593 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1594 #define SLAP_NO_SCHEMA_CHECK(be) \
1595 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1596 #define SLAP_GLUE_INSTANCE(be) \
1597 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1598 #define SLAP_GLUE_SUBORDINATE(be) \
1599 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1600 #define SLAP_GLUE_LINKED(be) \
1601 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1602 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1603 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1604 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1606 slap_mask_t be_restrictops; /* restriction operations */
1607 #define SLAP_RESTRICT_OP_ADD 0x0001U
1608 #define SLAP_RESTRICT_OP_BIND 0x0002U
1609 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1610 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1611 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1612 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1613 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1614 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1615 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1617 #define SLAP_RESTRICT_READONLY 0x80000000U
1619 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1620 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1621 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1622 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1623 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1625 #define SLAP_RESTRICT_OP_READS \
1626 ( SLAP_RESTRICT_OP_COMPARE \
1627 | SLAP_RESTRICT_OP_SEARCH )
1628 #define SLAP_RESTRICT_OP_WRITES \
1629 ( SLAP_RESTRICT_OP_ADD \
1630 | SLAP_RESTRICT_OP_DELETE \
1631 | SLAP_RESTRICT_OP_MODIFY \
1632 | SLAP_RESTRICT_OP_RENAME )
1634 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1635 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1636 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1638 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1640 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1641 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1642 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1644 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1645 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1647 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1649 slap_mask_t be_requires; /* pre-operation requirements */
1650 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1651 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1652 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1653 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1654 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1656 /* Required Security Strength Factor */
1657 slap_ssf_set_t be_ssf_set;
1659 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1660 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1661 struct berval be_schemadn; /* per-backend subschema subentry DN */
1662 struct berval be_schemandn; /* normalized subschema DN */
1663 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1664 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1665 struct berval be_rootpw; /* the magic "root" password for this db */
1666 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1667 #define be_sizelimit be_def_limit.lms_s_soft
1668 #define be_timelimit be_def_limit.lms_t_soft
1669 struct slap_limits_set be_def_limit; /* default limits */
1670 struct slap_limits **be_limits; /* regex-based size and time limits */
1671 AccessControl *be_acl; /* access control list for this backend */
1672 slap_access_t be_dfltaccess; /* access given if no acl matches */
1674 /* Replica Information */
1675 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1676 char *be_replogfile; /* replication log file (in master) */
1677 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1678 BerVarray be_update_refs; /* where to refer modifying clients to */
1679 struct be_pcl *be_pending_csn_list;
1680 ldap_pvt_thread_mutex_t be_pcl_mutex;
1681 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1682 LDAP_STAILQ_HEAD( be_si, syncinfo_s ) be_syncinfo; /* For syncrepl */
1685 void *be_pb; /* Netscape plugin */
1687 void *be_private; /* anything the backend database needs */
1693 /* Backend function typedefs */
1694 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1695 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1696 const char *fname, int lineno,
1697 int argc, char **argv));
1698 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1699 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1700 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1702 typedef int (BI_db_init) LDAP_P((Backend *bd));
1703 typedef int (BI_db_config) LDAP_P((Backend *bd,
1704 const char *fname, int lineno,
1705 int argc, char **argv));
1706 typedef int (BI_db_open) LDAP_P((Backend *bd));
1707 typedef int (BI_db_close) LDAP_P((Backend *bd));
1708 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1710 typedef struct req_bind_s {
1712 struct berval rb_cred;
1713 struct berval rb_edn;
1715 struct berval rb_tmp_mech; /* FIXME: temporary */
1718 typedef struct req_search_s {
1723 /* NULL means be_isroot evaluated to TRUE */
1724 struct slap_limits_set *rs_limit;
1726 AttributeName *rs_attrs;
1728 struct berval rs_filterstr;
1729 int rs_post_search_id;
1732 typedef struct req_compare_s {
1733 AttributeAssertion *rs_ava;
1736 typedef struct req_modify_s {
1737 Modifications *rs_modlist;
1738 int rs_increment; /* FIXME: temporary */
1741 typedef struct req_modrdn_s {
1742 struct berval rs_newrdn;
1743 struct berval rs_nnewrdn;
1744 struct berval *rs_newSup;
1745 struct berval *rs_nnewSup;
1746 int rs_deleteoldrdn;
1749 typedef struct req_add_s {
1751 Modifications *rs_modlist; /* FIXME: temporary */
1754 typedef struct req_abandon_s {
1759 #define SLAP_EXOP_HIDE 0x0000
1761 #define SLAP_EXOP_HIDE 0x8000
1763 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1765 typedef struct req_extended_s {
1766 struct berval rs_reqoid;
1768 struct berval *rs_reqdata;
1771 typedef struct req_pwdexop_s {
1772 struct berval rs_reqoid;
1774 struct berval rs_old;
1775 struct berval rs_new;
1776 Modifications *rs_mods;
1777 Modifications **rs_modtail;
1780 typedef enum slap_reply_e {
1789 typedef struct rep_sasl_s {
1790 struct berval *r_sasldata;
1793 typedef struct rep_extended_s {
1794 const char *r_rspoid;
1795 struct berval *r_rspdata;
1798 typedef struct rep_search_s {
1800 slap_mask_t r_attr_flags;
1801 #define SLAP_ATTRS_UNDEFINED (0x00U)
1802 #define SLAP_OPATTRS_NO (0x01U)
1803 #define SLAP_OPATTRS_YES (0x02U)
1804 #define SLAP_USERATTRS_NO (0x10U)
1805 #define SLAP_USERATTRS_YES (0x20U)
1806 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1807 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1808 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1809 #define SLAP_USERATTRS(f) \
1810 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1812 Attribute *r_operational_attrs;
1813 AttributeName *r_attrs;
1818 typedef struct slap_rep {
1819 slap_reply_t sr_type;
1823 const char *sr_matched;
1824 const char *sr_text;
1826 LDAPControl **sr_ctrls;
1828 rep_sasl_s sru_sasl;
1829 rep_extended_s sru_extended;
1830 rep_search_s sru_search;
1832 slap_mask_t sr_flags;
1833 #define REP_ENTRY_MODIFIABLE 0x0001U
1834 #define REP_ENTRY_MUSTBEFREED 0x0002U
1835 #define REP_MATCHED_MUSTBEFREED 0x0010U
1836 #define REP_REF_MUSTBEFREED 0x0020U
1839 /* short hands for response members */
1840 #define sr_attrs sr_un.sru_search.r_attrs
1841 #define sr_entry sr_un.sru_search.r_entry
1842 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1843 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1844 #define sr_v2ref sr_un.sru_search.r_v2ref
1845 #define sr_nentries sr_un.sru_search.r_nentries
1846 #define sr_rspoid sr_un.sru_extended.r_rspoid
1847 #define sr_rspdata sr_un.sru_extended.r_rspdata
1848 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1850 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1851 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1852 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1853 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1854 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1855 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1856 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1857 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1858 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1859 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1860 typedef int (BI_op_extended) LDAP_P((
1861 struct slap_op *op, struct slap_rep *rs ));
1862 typedef int (BI_chk_referrals) LDAP_P((
1863 struct slap_op *op, struct slap_rep *rs ));
1864 typedef int (BI_entry_release_rw)
1865 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1866 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1867 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1868 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1869 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1870 Entry *e, int *hasSubs ));
1872 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1873 struct slap_conn *c ));
1874 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1875 struct slap_conn *c ));
1877 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1878 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1879 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1880 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1881 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1882 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1883 struct berval *text ));
1884 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1885 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1886 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1887 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1888 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1889 struct berval *text ));
1891 struct slap_backend_info {
1892 char *bi_type; /* type of backend */
1895 * per backend type routines:
1896 * bi_init: called to allocate a backend_info structure,
1897 * called once BEFORE configuration file is read.
1898 * bi_init() initializes this structure hence is
1899 * called directly from be_initialize()
1900 * bi_config: called per 'backend' specific option
1901 * all such options must before any 'database' options
1902 * bi_config() is called only from read_config()
1903 * bi_open: called to open each database, called
1904 * once AFTER configuration file is read but
1905 * BEFORE any bi_db_open() calls.
1906 * bi_open() is called from backend_startup()
1907 * bi_close: called to close each database, called
1908 * once during shutdown after all bi_db_close calls.
1909 * bi_close() is called from backend_shutdown()
1910 * bi_destroy: called to destroy each database, called
1911 * once during shutdown after all bi_db_destroy calls.
1912 * bi_destory() is called from backend_destroy()
1915 BI_config *bi_config;
1918 BI_destroy *bi_destroy;
1921 * per database routines:
1922 * bi_db_init: called to initialize each database,
1923 * called upon reading 'database <type>'
1924 * called only from backend_db_init()
1925 * bi_db_config: called to configure each database,
1926 * called per database to handle per database options
1927 * called only from read_config()
1928 * bi_db_open: called to open each database
1929 * called once per database immediately AFTER bi_open()
1930 * calls but before daemon startup.
1931 * called only by backend_startup()
1932 * bi_db_close: called to close each database
1933 * called once per database during shutdown but BEFORE
1934 * any bi_close call.
1935 * called only by backend_shutdown()
1936 * bi_db_destroy: called to destroy each database
1937 * called once per database during shutdown AFTER all
1938 * bi_close calls but before bi_destory calls.
1939 * called only by backend_destory()
1941 BI_db_init *bi_db_init;
1942 BI_db_config *bi_db_config;
1943 BI_db_open *bi_db_open;
1944 BI_db_close *bi_db_close;
1945 BI_db_destroy *bi_db_destroy;
1947 /* LDAP Operations Handling Routines */
1948 BI_op_bind *bi_op_bind;
1949 BI_op_unbind *bi_op_unbind;
1950 BI_op_search *bi_op_search;
1951 BI_op_compare *bi_op_compare;
1952 BI_op_modify *bi_op_modify;
1953 BI_op_modrdn *bi_op_modrdn;
1954 BI_op_add *bi_op_add;
1955 BI_op_delete *bi_op_delete;
1956 BI_op_abandon *bi_op_abandon;
1957 BI_op_cancel *bi_op_cancel;
1959 /* Extended Operations Helper */
1960 BI_op_extended *bi_extended;
1962 /* Auxilary Functions */
1963 BI_operational *bi_operational;
1964 BI_chk_referrals *bi_chk_referrals;
1965 BI_entry_get_rw *bi_entry_get_rw;
1966 BI_entry_release_rw *bi_entry_release_rw;
1968 BI_has_subordinates *bi_has_subordinates;
1970 BI_connection_init *bi_connection_init;
1971 BI_connection_destroy *bi_connection_destroy;
1973 /* hooks for slap tools */
1974 BI_tool_entry_open *bi_tool_entry_open;
1975 BI_tool_entry_close *bi_tool_entry_close;
1976 BI_tool_entry_first *bi_tool_entry_first;
1977 BI_tool_entry_next *bi_tool_entry_next;
1978 BI_tool_entry_get *bi_tool_entry_get;
1979 BI_tool_entry_put *bi_tool_entry_put;
1980 BI_tool_entry_reindex *bi_tool_entry_reindex;
1981 BI_tool_sync *bi_tool_sync;
1982 BI_tool_dn2id_get *bi_tool_dn2id_get;
1983 BI_tool_id2entry_get *bi_tool_id2entry_get;
1984 BI_tool_entry_modify *bi_tool_entry_modify;
1986 #define SLAP_INDEX_ADD_OP 0x0001
1987 #define SLAP_INDEX_DELETE_OP 0x0002
1989 slap_mask_t bi_flags; /* backend flags */
1990 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
1991 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
1992 #define SLAP_BFLAG_INCREMENT 0x0100U
1993 #define SLAP_BFLAG_ALIASES 0x1000U
1994 #define SLAP_BFLAG_REFERRALS 0x2000U
1995 #define SLAP_BFLAG_SUBENTRIES 0x4000U
1996 #define SLAP_BFLAG_DYNAMIC 0x8000U
1998 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
1999 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2000 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2001 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2002 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2003 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2004 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2005 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2006 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2008 char **bi_controls; /* supported controls */
2010 unsigned int bi_nDB; /* number of databases of this type */
2011 void *bi_private; /* anything the backend type needs */
2014 #define c_authtype c_authz.sai_method
2015 #define c_authmech c_authz.sai_mech
2016 #define c_dn c_authz.sai_dn
2017 #define c_ndn c_authz.sai_ndn
2018 #define c_ssf c_authz.sai_ssf
2019 #define c_transport_ssf c_authz.sai_transport_ssf
2020 #define c_tls_ssf c_authz.sai_tls_ssf
2021 #define c_sasl_ssf c_authz.sai_sasl_ssf
2023 #define o_authtype o_authz.sai_method
2024 #define o_authmech o_authz.sai_mech
2025 #define o_dn o_authz.sai_dn
2026 #define o_ndn o_authz.sai_ndn
2027 #define o_ssf o_authz.sai_ssf
2028 #define o_transport_ssf o_authz.sai_transport_ssf
2029 #define o_tls_ssf o_authz.sai_tls_ssf
2030 #define o_sasl_ssf o_authz.sai_sasl_ssf
2032 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2034 typedef struct slap_callback {
2035 struct slap_callback *sc_next;
2036 slap_response *sc_response;
2037 slap_response *sc_cleanup;
2041 struct slap_overinfo;
2043 typedef struct slap_overinst {
2045 slap_response *on_response;
2046 struct slap_overinfo *on_info;
2047 struct slap_overinst *on_next;
2050 typedef struct slap_overinfo {
2052 BackendInfo *oi_orig;
2053 struct slap_overinst *oi_list;
2056 /* Should successive callbacks in a chain be processed? */
2057 #define SLAP_CB_FREEME 0x4000
2058 #define SLAP_CB_CONTINUE 0x8000
2061 * Paged Results state
2063 typedef unsigned long PagedResultsCookie;
2064 typedef struct slap_paged_state {
2067 PagedResultsCookie ps_cookie;
2069 } PagedResultsState;
2071 #define LDAP_PSEARCH_BY_ADD 0x01
2072 #define LDAP_PSEARCH_BY_DELETE 0x02
2073 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
2074 #define LDAP_PSEARCH_BY_MODIFY 0x04
2075 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
2076 #define LDAP_PSEARCH_BY_PREDELETE 0x06
2078 struct psid_entry { /* DELETE ME */
2079 struct slap_op *ps_op;
2080 LDAP_LIST_ENTRY(psid_entry) ps_link;
2083 #if 0 /* DELETE ME */
2085 struct berval sl_uuid;
2086 struct berval sl_name;
2087 struct berval sl_csn;
2088 LDAP_STAILQ_ENTRY(slog_entry) sl_link;
2092 struct slap_session_entry {
2095 struct berval se_spec;
2096 LDAP_LIST_ENTRY( slap_session_entry ) se_link;
2100 struct slap_csn_entry {
2101 struct berval ce_csn;
2102 unsigned long ce_opid;
2103 unsigned long ce_connid;
2104 #define SLAP_CSN_PENDING 1
2105 #define SLAP_CSN_COMMIT 2
2107 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2113 struct berval pc_csn;
2114 struct berval pc_entryUUID;
2115 struct berval pc_ename;
2116 struct berval pc_enname;
2117 LDAP_TAILQ_ENTRY( pc_entry ) pc_link;
2121 * Caches the result of a backend_group check for ACL evaluation
2123 typedef struct slap_gacl {
2124 struct slap_gacl *ga_next;
2127 AttributeDescription *ga_at;
2133 #ifndef SLAP_MAX_CIDS
2134 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
2137 struct slap_control_ids {
2143 int sc_modifyIncrement;
2145 int sc_pagedResults;
2146 int sc_valuesReturnFilter;
2147 int sc_permissiveModify;
2150 int sc_searchOptions;
2156 * represents an operation pending from an ldap client
2158 typedef struct slap_op_header {
2159 unsigned long oh_opid; /* id of this operation */
2160 unsigned long oh_connid; /* id of conn initiating this op */
2161 struct slap_conn *oh_conn; /* connection spawning this op */
2163 ber_int_t oh_msgid; /* msgid of the request */
2164 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2166 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2168 void *oh_threadctx; /* thread pool thread context */
2169 void *oh_tmpmemctx; /* slab malloc context */
2170 BerMemoryFunctions *oh_tmpmfuncs;
2172 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2175 void *oh_pb; /* NS-SLAPI plugin */
2176 void *oh_extensions; /* NS-SLAPI plugin */
2180 typedef struct slap_op {
2183 #define o_opid o_hdr->oh_opid
2184 #define o_connid o_hdr->oh_connid
2185 #define o_conn o_hdr->oh_conn
2186 #define o_msgid o_hdr->oh_msgid
2187 #define o_protocol o_hdr->oh_protocol
2188 #define o_tid o_hdr->oh_tid
2189 #define o_threadctx o_hdr->oh_threadctx
2190 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2191 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2193 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2194 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2195 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2196 #define o_tmpfree o_tmpmfuncs->bmf_free
2198 #define o_log_prefix o_hdr->oh_log_prefix
2201 #define o_pb o_hdr->oh_pb
2202 #define o_extensions o_hdr->oh_extensions
2205 ber_tag_t o_tag; /* tag of the request */
2206 time_t o_time; /* time op was initiated */
2208 BackendDB *o_bd; /* backend DB processing this op */
2209 struct berval o_req_dn; /* DN of target of request */
2210 struct berval o_req_ndn;
2215 req_compare_s oq_compare;
2216 req_modify_s oq_modify;
2217 req_modrdn_s oq_modrdn;
2218 req_search_s oq_search;
2219 req_abandon_s oq_abandon;
2220 req_abandon_s oq_cancel;
2221 req_extended_s oq_extended;
2222 req_pwdexop_s oq_pwdexop;
2225 /* short hands for union members */
2226 #define oq_add o_request.oq_add
2227 #define oq_bind o_request.oq_bind
2228 #define oq_compare o_request.oq_compare
2229 #define oq_modify o_request.oq_modify
2230 #define oq_modrdn o_request.oq_modrdn
2231 #define oq_search o_request.oq_search
2232 #define oq_abandon o_request.oq_abandon
2233 #define oq_cancel o_request.oq_cancel
2234 #define oq_extended o_request.oq_extended
2235 #define oq_pwdexop o_request.oq_pwdexop
2237 /* short hands for inner request members */
2238 #define orb_method oq_bind.rb_method
2239 #define orb_cred oq_bind.rb_cred
2240 #define orb_edn oq_bind.rb_edn
2241 #define orb_ssf oq_bind.rb_ssf
2242 #define orb_tmp_mech oq_bind.rb_tmp_mech
2244 #define ors_scope oq_search.rs_scope
2245 #define ors_deref oq_search.rs_deref
2246 #define ors_slimit oq_search.rs_slimit
2247 #define ors_tlimit oq_search.rs_tlimit
2248 #define ors_limit oq_search.rs_limit
2249 #define ors_attrsonly oq_search.rs_attrsonly
2250 #define ors_attrs oq_search.rs_attrs
2251 #define ors_filter oq_search.rs_filter
2252 #define ors_filterstr oq_search.rs_filterstr
2253 #define ors_post_search_id oq_search.rs_post_search_id
2255 #define orr_newrdn oq_modrdn.rs_newrdn
2256 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2257 #define orr_newSup oq_modrdn.rs_newSup
2258 #define orr_nnewSup oq_modrdn.rs_nnewSup
2259 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2261 #define orc_ava oq_compare.rs_ava
2262 #define ora_e oq_add.rs_e
2263 #define ora_modlist oq_add.rs_modlist
2264 #define orn_msgid oq_abandon.rs_msgid
2265 #define orm_modlist oq_modify.rs_modlist
2266 #define orm_increment oq_modify.rs_increment
2268 #define ore_reqoid oq_extended.rs_reqoid
2269 #define ore_flags oq_extended.rs_flags
2270 #define ore_reqdata oq_extended.rs_reqdata
2271 volatile sig_atomic_t o_abandon; /* abandon flag */
2272 volatile sig_atomic_t o_cancel; /* cancel flag */
2273 #define SLAP_CANCEL_NONE 0x00
2274 #define SLAP_CANCEL_REQ 0x01
2275 #define SLAP_CANCEL_ACK 0x02
2276 #define SLAP_CANCEL_DONE 0x03
2278 GroupAssertion *o_groups;
2279 char o_do_not_cache; /* don't cache groups from this op */
2280 char o_is_auth_check; /* authorization in progress */
2282 #define SLAP_CONTROL_NONE 0
2283 #define SLAP_CONTROL_IGNORED 1
2284 #define SLAP_CONTROL_NONCRITICAL 2
2285 #define SLAP_CONTROL_CRITICAL 3
2286 #define SLAP_CONTROL_MASK 3
2288 /* spare bits for simple flags */
2289 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2290 #define SLAP_CONTROL_DATA0 0x10
2291 #define SLAP_CONTROL_DATA1 0x20
2292 #define SLAP_CONTROL_DATA2 0x40
2293 #define SLAP_CONTROL_DATA3 0x80
2296 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2298 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2299 void **o_controls; /* per-control state */
2301 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2302 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2304 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2305 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2306 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2308 #define get_subentries(op) _SCM((op)->o_subentries)
2309 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2311 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2312 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2314 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2315 #define get_assert(op) ((int)(op)->o_assert)
2316 #define o_assertion o_controls[slap_cids.sc_assert]
2317 #define get_assertion(op) ((op)->o_assertion)
2319 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2320 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2322 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2323 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2324 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2326 #define get_permissiveModify(op) (0)
2329 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2330 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2331 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2333 #define get_domainScope(op) (0)
2336 #ifdef LDAP_CONTROL_X_TREE_DELETE
2337 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2338 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2340 #define get_treeDelete(op) (0)
2343 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2344 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2346 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2347 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2349 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2350 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2352 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2354 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2357 struct sync_cookie o_sync_state;
2359 struct berval o_sync_cid;
2360 int o_sync_slog_size;
2361 struct berval o_sync_csn;
2362 struct berval o_sync_slog_omitcsn;
2363 int o_sync_slog_len;
2364 LDAP_STAILQ_HEAD(sl, slog_entry) o_sync_slog_list;
2368 LDAP_LIST_ENTRY(slap_op) o_ps_link;
2369 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
2371 int o_refresh_in_progress;
2372 LDAP_TAILQ_HEAD(pc_pre, pc_entry) o_ps_pre_candidates;
2373 LDAP_TAILQ_HEAD(pc_post, pc_entry) o_ps_post_candidates;
2374 Avlnode *o_psearch_finished;
2375 struct pc_entry *o_ps_send_wait;
2376 ldap_pvt_thread_mutex_t o_pcmutex;
2379 AuthorizationInformation o_authz;
2381 BerElement *o_ber; /* ber of the request */
2382 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2383 slap_callback *o_callback; /* callback pointers */
2384 LDAPControl **o_ctrls; /* controls */
2386 void *o_private; /* anything the backend needs */
2388 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2391 int o_delete_glue_parent;
2394 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2396 #define send_ldap_error( op, rs, err, text ) do { \
2397 (rs)->sr_err = err; (rs)->sr_text = text; \
2398 (op->o_conn->c_send_ldap_result)( op, rs ); \
2400 #define send_ldap_discon( op, rs, err, text ) do { \
2401 (rs)->sr_err = err; (rs)->sr_text = text; \
2402 send_ldap_disconnect( op, rs ); \
2405 typedef void (SEND_LDAP_RESULT)(
2406 struct slap_op *op, struct slap_rep *rs);
2407 typedef int (SEND_SEARCH_ENTRY)(
2408 struct slap_op *op, struct slap_rep *rs);
2409 typedef int (SEND_SEARCH_REFERENCE)(
2410 struct slap_op *op, struct slap_rep *rs);
2411 typedef void (SEND_LDAP_EXTENDED)(
2412 struct slap_op *op, struct slap_rep *rs);
2413 typedef void (SEND_LDAP_INTERMEDIATE)(
2414 struct slap_op *op, struct slap_rep *rs);
2416 #define send_ldap_result( op, rs ) \
2417 ((op)->o_conn->c_send_ldap_result)( op, rs )
2418 #define send_search_entry( op, rs ) \
2419 ((op)->o_conn->c_send_search_entry)( op, rs )
2420 #define send_search_reference( op, rs ) \
2421 ((op)->o_conn->c_send_search_reference)( op, rs )
2422 #define send_ldap_extended( op, rs ) \
2423 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2424 #define send_ldap_intermediate( op, rs ) \
2425 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2427 typedef struct slap_listener Listener;
2430 * represents a connection from an ldap client
2432 typedef struct slap_conn {
2433 int c_struct_state; /* structure management state */
2434 int c_conn_state; /* connection state */
2435 int c_conn_idx; /* slot in connections array */
2437 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2438 Sockbuf *c_sb; /* ber connection stuff */
2440 /* only can be changed by connect_init */
2441 time_t c_starttime; /* when the connection was opened */
2442 time_t c_activitytime; /* when the connection was last used */
2443 unsigned long c_connid; /* id of this connection for stats*/
2445 struct berval c_peer_domain; /* DNS name of client */
2446 struct berval c_peer_name; /* peer name (trans=addr:port) */
2447 Listener *c_listener;
2448 #define c_listener_url c_listener->sl_url /* listener URL */
2449 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2451 /* only can be changed by binding thread */
2452 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2453 struct berval c_sasl_bind_mech; /* mech in progress */
2454 struct berval c_sasl_dn; /* temporary storage */
2456 /* authorization backend */
2457 Backend *c_authz_backend;
2459 AuthorizationInformation c_authz;
2461 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2463 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2464 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2466 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2467 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2469 BerElement *c_currentber; /* ber we're attempting to read */
2470 int c_writewaiter; /* true if writer is waiting */
2472 #define CONN_IS_TLS 1
2473 #define CONN_IS_UDP 2
2474 #define CONN_IS_CLIENT 3
2476 #ifdef LDAP_CONNECTIONLESS
2477 int c_is_udp; /* true if this is (C)LDAP over UDP */
2480 int c_is_tls; /* true if this LDAP over raw TLS */
2481 int c_needs_tls_accept; /* true if SSL_accept should be called */
2483 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2484 int c_sasl_done; /* SASL completed once */
2485 void *c_sasl_authctx; /* SASL authentication context */
2486 void *c_sasl_sockctx; /* SASL security layer context */
2487 void *c_sasl_extra; /* SASL session extra stuff */
2488 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2490 PagedResultsState c_pagedresults_state; /* paged result state */
2492 long c_n_ops_received; /* num of ops received (next op_id) */
2493 long c_n_ops_executing; /* num of ops currently executing */
2494 long c_n_ops_pending; /* num of ops pending execution */
2495 long c_n_ops_completed; /* num of ops completed */
2497 long c_n_get; /* num of get calls */
2498 long c_n_read; /* num of read calls */
2499 long c_n_write; /* num of write calls */
2501 void *c_pb; /* Netscape plugin */
2502 void *c_extensions; /* Netscape plugin */
2505 * Client connection handling
2507 ldap_pvt_thread_start_t *c_clientfunc;
2511 * These are the "callbacks" that are available for back-ends to
2512 * supply data back to connected clients that are connected
2513 * through the "front-end".
2515 SEND_LDAP_RESULT *c_send_ldap_result;
2516 SEND_SEARCH_ENTRY *c_send_search_entry;
2517 SEND_SEARCH_REFERENCE *c_send_search_reference;
2518 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2519 #ifdef LDAP_RES_INTERMEDIATE
2520 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2525 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2526 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2528 if ( ldap_debug & (level) ) \
2529 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2530 if ( ldap_syslog & (level) ) \
2531 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2534 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2535 #elif defined(LDAP_DEBUG)
2536 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2538 if ( ldap_debug & (level) ) \
2539 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2541 #define StatslogTest( level ) (ldap_debug & (level))
2543 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2544 #define StatslogTest( level ) (0)
2548 * listener; need to access it from monitor backend
2550 struct slap_listener {
2551 struct berval sl_url;
2552 struct berval sl_name;
2557 #ifdef LDAP_CONNECTIONLESS
2558 int sl_is_udp; /* UDP listener is also data port */
2560 int sl_is_mute; /* Listening is temporarily disabled */
2563 #define sl_addr sl_sa.sa_in_addr
2566 #ifdef SLAPD_MONITOR
2583 #endif /* SLAPD_MONITOR */
2585 typedef struct slap_counters_t {
2586 ldap_pvt_thread_mutex_t sc_sent_mutex;
2587 ldap_pvt_mp_t sc_bytes;
2588 ldap_pvt_mp_t sc_pdu;
2589 ldap_pvt_mp_t sc_entries;
2590 ldap_pvt_mp_t sc_refs;
2592 ldap_pvt_thread_mutex_t sc_ops_mutex;
2593 ldap_pvt_mp_t sc_ops_completed;
2594 ldap_pvt_mp_t sc_ops_initiated;
2595 #ifdef SLAPD_MONITOR
2596 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2597 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2598 #endif /* SLAPD_MONITOR */
2602 * Better know these all around slapd
2604 #define SLAP_LDAPDN_PRETTY 0x1
2605 #define SLAP_LDAPDN_MAXLEN 8192
2607 /* number of response controls supported */
2608 #define SLAP_MAX_RESPONSE_CONTROLS 6
2611 #define SLAP_CTRL_HIDE 0x00000000U
2613 #define SLAP_CTRL_HIDE 0x80000000U
2616 #define SLAP_CTRL_FRONTEND 0x00800000U
2617 #define SLAP_CTRL_FRONTEND_SEARCH 0x00010000U /* for NOOP */
2619 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2620 #define SLAP_CTRL_ABANDON 0x00000001U
2621 #define SLAP_CTRL_ADD 0x00002002U
2622 #define SLAP_CTRL_BIND 0x00000004U
2623 #define SLAP_CTRL_COMPARE 0x00001008U
2624 #define SLAP_CTRL_DELETE 0x00002010U
2625 #define SLAP_CTRL_MODIFY 0x00002020U
2626 #define SLAP_CTRL_RENAME 0x00002040U
2627 #define SLAP_CTRL_SEARCH 0x00001080U
2628 #define SLAP_CTRL_UNBIND 0x00000100U
2630 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2631 #define SLAP_CTRL_UPDATE \
2632 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2633 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2635 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2638 LDAPControl *ctrl ));
2640 #define SLAP_SLAB_SIZE (1024*1024)
2641 #define SLAP_SLAB_STACK 1
2642 #define SLAP_SLAB_SOBLOCK 64
2644 #define SLAP_ZONE_ALLOC 1
2645 #undef SLAP_ZONE_ALLOC
2647 #if defined(LDAP_DEVEL) && defined(ENABLE_REWRITE)
2648 /* use librewrite for sasl-regexp */
2649 #define SLAP_AUTH_REWRITE 1
2650 #endif /* LDAP_DEVEL && ENABLE_REWRITE */
2652 #ifdef LDAP_COMP_MATCH
2654 * Extensible Filter Definition
2656 * MatchingRuleAssertion := SEQUENCE {
2657 * matchingRule [1] MatchingRuleId OPTIONAL,
2658 * type [2] AttributeDescription OPTIONAL,
2659 * matchValue [3] AssertionValue,
2660 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2662 * Following ComponentFilter is contained in matchValue
2664 * ComponentAssertion ::= SEQUENCE {
2665 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2666 * useDefaultValues BOOLEAN DEFAULT TRUE,
2667 * rule MATCHING-RULE.&id,
2668 * value MATCHING-RULE.&AssertionType }
2670 * ComponentFilter ::= CHOICE {
2671 * item [0] ComponentAssertion,
2672 * and [1] SEQUENCE OF ComponentFilter,
2673 * or [2] SEQUENCE OF ComponentFilter,
2674 * not [3] ComponentFilter }
2677 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2678 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2679 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2680 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2681 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2682 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2683 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2684 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2685 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2687 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2688 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2689 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2690 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2691 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2693 typedef struct slap_component_id {
2695 struct slap_component_id *ci_next;
2697 union comp_id_value{
2698 BerValue ci_identifier;
2699 ber_int_t ci_from_beginning;
2701 ber_int_t ci_from_end;
2702 ber_int_t ci_content;
2703 BerValue ci_select_value;
2708 typedef struct slap_component_reference {
2709 ComponentId *cr_list;
2710 ComponentId *cr_curr;
2711 struct berval cr_string;
2713 /* Component Indexing */
2715 slap_mask_t cr_indexmask;
2716 AttributeDescription* cr_ad;
2718 struct slap_component_reference* cr_next;
2719 } ComponentReference;
2721 typedef struct slap_component_assertion {
2722 ComponentReference *ca_comp_ref;
2723 ber_int_t ca_use_def;
2724 MatchingRule *ca_ma_rule;
2725 struct berval ca_ma_value;
2726 ComponentData ca_comp_data; /* componentized assertion */
2727 struct slap_component_filter *ca_cf;
2728 MatchingRuleAssertion *ca_mra;
2729 } ComponentAssertion;
2731 typedef struct slap_component_filter {
2732 ber_tag_t cf_choice;
2734 ber_int_t cf_un_result;
2735 ComponentAssertion *cf_un_ca;
2736 struct slap_component_filter *cf_un_complex;
2739 #define cf_ca cf_un.cf_un_ca
2740 #define cf_result cf_un.cf_un_result
2741 #define cf_and cf_un.cf_un_complex
2742 #define cf_or cf_un.cf_un_complex
2743 #define cf_not cf_un.cf_un_complex
2744 #define cf_any cf_un.cf_un_complex
2746 struct slap_component_filter *cf_next;
2749 typedef struct slap_component_assertion_value {
2753 } ComponentAssertionValue;
2755 typedef int encoder_func LDAP_P((
2759 struct slap_component_syntax_info;
2761 typedef int gser_decoder_func LDAP_P((
2764 struct slap_component_syntax_info** comp_syn_info,
2768 typedef int comp_free_func LDAP_P((
2771 typedef int ber_decoder_func LDAP_P((
2776 struct slap_component_syntax_info* comp_syn_info,
2780 typedef int ber_tag_decoder_func LDAP_P((
2783 struct slap_component_syntax_info* comp_syn_info,
2787 typedef void* extract_component_from_id_func LDAP_P((
2789 ComponentReference* cr,
2792 typedef void* convert_attr_to_comp_func LDAP_P ((
2795 struct berval* bv ));
2797 typedef void* alloc_nibble_func LDAP_P ((
2799 int increment_size ));
2801 typedef void free_nibble_func LDAP_P ((
2804 struct slap_component_syntax_info;
2805 typedef void convert_assert_to_comp_func LDAP_P ((
2807 struct slap_component_syntax_info* csi_attr,
2809 struct slap_component_syntax_info** csi,
2813 typedef int convert_asn_to_ldap_func LDAP_P ((
2814 struct slap_component_syntax_info* csi,
2815 struct berval *bv ));
2817 typedef void free_component_func LDAP_P ((
2820 typedef int test_component_func LDAP_P ((
2822 void* assert_mem_op,
2823 struct slap_component_syntax_info* csi,
2824 struct slap_component_assertion* ca));
2826 typedef void* test_membership_func LDAP_P ((
2829 typedef void* get_component_info_func LDAP_P ((
2832 struct slap_component_syntax_info;
2834 typedef int component_encoder_func LDAP_P ((
2836 struct slap_component_syntax_info* csi,
2837 struct berval* nvals ));
2839 typedef int allcomponent_matching_func LDAP_P((
2841 struct slap_component_syntax_info* comp1,
2842 struct slap_component_syntax_info* comp));
2844 typedef struct slap_component_desc {
2845 /* Don't change the order of following four fields */
2847 AttributeType *cd_comp_type;
2848 struct berval cd_ad_type;/* ad_type, ad_cname */
2849 struct berval cd_ad_cname;/* ad_type, ad_cname */
2850 unsigned cd_flags; /*ad_flags*/
2853 encoder_func *cd_ldap_encoder;
2854 encoder_func *cd_gser_encoder;
2855 encoder_func *cd_ber_encoder;
2856 gser_decoder_func *cd_gser_decoder;
2857 ber_decoder_func *cd_ber_decoder;
2858 comp_free_func *cd_free;
2859 extract_component_from_id_func* cd_extract_i;
2860 allcomponent_matching_func *cd_all_match;
2863 typedef struct slap_component_syntax_info {
2865 ComponentDesc* csi_comp_desc;
2866 } ComponentSyntaxInfo;
2870 /* slab heap data structures */
2872 struct slab_object {
2875 LDAP_LIST_ENTRY(slab_object) so_link;
2884 unsigned char **sh_map;
2885 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2886 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2889 #ifdef SLAP_ZONE_ALLOC
2890 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2891 #define SLAP_ZONE_SHIFT 19
2892 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2893 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2894 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2895 #define SLAP_ZONE_ZOBLOCK 256
2897 struct zone_object {
2902 LDAP_LIST_ENTRY(zone_object) zo_link;
2905 struct zone_latency_history {
2907 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2918 ldap_pvt_thread_rdwr_t *zh_znlock;
2919 Avlnode *zh_zonetree;
2920 unsigned char ***zh_maps;
2922 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2923 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2924 ldap_pvt_thread_mutex_t zh_mutex;
2925 ldap_pvt_thread_rdwr_t zh_lock;
2926 double zh_ema_latency;
2927 unsigned long zh_ema_samples;
2928 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2929 zh_latency_history_queue;
2930 int zh_latency_history_qlen;
2931 int zh_latency_jump;
2936 #define SLAP_BACKEND_INIT_MODULE(b) \
2938 init_module( int argc, char *argv[] ) \
2941 memset( &bi, '\0', sizeof( bi ) ); \
2943 bi.bi_init = b ## _back_initialize; \
2944 backend_add( &bi ); \
2950 #include "proto-slap.h"
2952 #endif /* _SLAP_H_ */