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"
63 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
64 #define SLAP_ACL_HONOR_MANAGE /* not yet implemented */
66 #define SLAP_OVERLAY_ACCESS
67 #define LDAP_COMP_MATCH
68 #define LDAP_DYNAMIC_OBJECTS
69 #define LDAP_SYNC_TIMESTAMP
70 #define LDAP_COLLECTIVE_ATTRIBUTES
71 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
73 #define SLAP_USE_CONFDIR /* partially implemented */
76 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
82 * SLAPD Memory allocation macros
84 * Unlike ch_*() routines, these routines do not assert() upon
85 * allocation error. They are intended to be used instead of
86 * ch_*() routines where the caller has implemented proper
87 * checking for and handling of allocation errors.
89 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
91 #define SLAP_MALLOC(s) ber_memalloc((s))
92 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
93 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
94 #define SLAP_FREE(p) ber_memfree((p))
95 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
96 #define SLAP_STRDUP(s) ber_strdup((s))
97 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
100 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
103 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
104 #define SLAPD_ANONYMOUS "cn=anonymous"
106 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
107 * This is a value used internally by the backends. It is needed to allow
108 * adding values that already exist without getting an error as required by
109 * modrdn when the new rdn was already an attribute value itself.
111 #define SLAP_MOD_SOFTADD 0x1000
113 #define MAXREMATCHES (100)
115 #define SLAP_MAX_WORKER_THREADS (16)
117 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
118 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
120 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
121 #define SLAP_CONN_MAX_PENDING_AUTH 1000
123 #define SLAP_TEXT_BUFLEN (256)
125 /* psuedo error code indicating abandoned operation */
126 #define SLAPD_ABANDON (-1024)
128 /* psuedo error code indicating disconnect */
129 #define SLAPD_DISCONNECT (-1025)
131 /* unknown config file directive */
132 #define SLAP_CONF_UNKNOWN (-1026)
134 /* We assume "C" locale, that is US-ASCII */
135 #define ASCII_SPACE(c) ( (c) == ' ' )
136 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
137 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
138 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
139 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
140 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
141 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
142 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
143 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
144 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
145 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
147 #define SLAP_NIBBLE(c) ((c)&0x0f)
148 #define SLAP_ESCAPE_CHAR ('\\')
149 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
150 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
152 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
153 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
155 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
156 /* NOTE: for consistency, this macro must only operate
157 * on normalized/pretty DN, such that ';' is never used
158 * as RDN separator, and all occurrences of ';' must be escaped */
159 #define DN_SEPARATOR(c) ((c) == ',')
160 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
161 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
162 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
164 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
165 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
166 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
167 #define OID_SEPARATOR(c) ( (c) == '.' )
168 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
170 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
171 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
173 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
174 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
176 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
178 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
179 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
180 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
181 (c) == '?' || (c) == ' ' || (c) == '=' )
182 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
184 /* must match in schema_init.c */
185 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
186 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
187 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
188 #define SLAPD_GROUP_ATTR "member"
189 #define SLAPD_GROUP_CLASS "groupOfNames"
190 #define SLAPD_ROLE_ATTR "roleOccupant"
191 #define SLAPD_ROLE_CLASS "organizationalRole"
193 #ifdef SLAPD_ACI_ENABLED
194 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
195 #endif /* SLAPD_ACI_ENABLED */
197 /* change this to "OpenLDAPset" */
198 #define SLAPD_ACI_SET_ATTR "template"
200 #define SLAPD_TOP_OID "2.5.6.0"
202 LDAP_SLAPD_V (int) slap_debug;
204 typedef unsigned long slap_mask_t;
206 /* Security Strength Factor */
207 typedef unsigned slap_ssf_t;
209 typedef struct slap_ssf_set {
211 slap_ssf_t sss_transport;
214 slap_ssf_t sss_update_ssf;
215 slap_ssf_t sss_update_transport;
216 slap_ssf_t sss_update_tls;
217 slap_ssf_t sss_update_sasl;
218 slap_ssf_t sss_simple_bind;
221 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
222 #define SLAP_GETDN_AUTHCID 2
223 #define SLAP_GETDN_AUTHZID 4
228 #define SLAP_INDEX_TYPE 0x00FFUL
229 #define SLAP_INDEX_UNDEFINED 0x0001UL
230 #define SLAP_INDEX_PRESENT 0x0002UL
231 #define SLAP_INDEX_EQUALITY 0x0004UL
232 #define SLAP_INDEX_APPROX 0x0008UL
233 #define SLAP_INDEX_SUBSTR 0x0010UL
234 #define SLAP_INDEX_EXTENDED 0x0020UL
236 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
238 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
240 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
242 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
243 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
244 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
245 #define SLAP_INDEX_SUBSTR_DEFAULT \
246 ( SLAP_INDEX_SUBSTR \
247 | SLAP_INDEX_SUBSTR_INITIAL \
248 | SLAP_INDEX_SUBSTR_ANY \
249 | SLAP_INDEX_SUBSTR_FINAL )
251 /* defaults for initial/final substring indices */
252 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
253 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
255 /* defaults for any substring indices */
256 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
257 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
259 #define SLAP_INDEX_FLAGS 0xF000UL
260 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
261 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
264 * there is a single index for each attribute. these prefixes ensure
265 * that there is no collision among keys.
267 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
268 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
269 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
270 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
271 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
272 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
274 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
275 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
276 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
277 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
278 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
281 * represents schema information for a database
284 SLAP_SCHERR_OUTOFMEM = 1,
285 SLAP_SCHERR_CLASS_NOT_FOUND,
286 SLAP_SCHERR_CLASS_BAD_USAGE,
287 SLAP_SCHERR_CLASS_BAD_SUP,
288 SLAP_SCHERR_CLASS_DUP,
289 SLAP_SCHERR_CLASS_INCONSISTENT,
290 SLAP_SCHERR_ATTR_NOT_FOUND,
291 SLAP_SCHERR_ATTR_BAD_MR,
292 SLAP_SCHERR_ATTR_BAD_USAGE,
293 SLAP_SCHERR_ATTR_BAD_SUP,
294 SLAP_SCHERR_ATTR_INCOMPLETE,
295 SLAP_SCHERR_ATTR_DUP,
296 SLAP_SCHERR_ATTR_INCONSISTENT,
297 SLAP_SCHERR_MR_NOT_FOUND,
298 SLAP_SCHERR_MR_INCOMPLETE,
300 SLAP_SCHERR_SYN_NOT_FOUND,
303 SLAP_SCHERR_NOT_SUPPORTED,
304 SLAP_SCHERR_BAD_DESCR,
307 SLAP_SCHERR_CR_BAD_STRUCT,
308 SLAP_SCHERR_CR_BAD_AUX,
309 SLAP_SCHERR_CR_BAD_AT,
314 typedef union slap_sockaddr {
315 struct sockaddr sa_addr;
316 struct sockaddr_in sa_in_addr;
318 struct sockaddr_storage sa_storage;
319 struct sockaddr_in6 sa_in6_addr;
322 struct sockaddr_un sa_un_addr;
327 extern int slap_inet4or6;
330 typedef struct slap_oid_macro {
331 struct berval som_oid;
334 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
336 LDAP_STAILQ_ENTRY(slap_oid_macro) som_next;
339 /* forward declarations */
341 struct slap_matching_rule;
343 typedef int slap_syntax_validate_func LDAP_P((
344 struct slap_syntax *syntax,
345 struct berval * in));
347 typedef int slap_syntax_transform_func LDAP_P((
348 struct slap_syntax *syntax,
353 #ifdef LDAP_COMP_MATCH
354 typedef void* slap_component_transform_func LDAP_P((
355 struct berval * in ));
356 struct ComponentDesc;
359 typedef struct slap_syntax {
361 #define ssyn_oid ssyn_syn.syn_oid
362 #define ssyn_desc ssyn_syn.syn_desc
363 #define ssyn_extensions ssyn_syn.syn_extensions
366 ber_len_t ssyn_oidlen;
367 * has been replaced by a struct berval that uses the value
368 * provided by ssyn_syn.syn_oid; a macro that expands to
369 * the bv_len field of the berval is provided for backward
370 * compatibility. CAUTION: NEVER FREE THE BERVAL
372 struct berval ssyn_bvoid;
373 #define ssyn_oidlen ssyn_bvoid.bv_len
375 unsigned int ssyn_flags;
377 #define SLAP_SYNTAX_NONE 0x0000U
378 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
379 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
380 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
382 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
384 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
387 slap_syntax_validate_func *ssyn_validate;
388 slap_syntax_transform_func *ssyn_pretty;
390 #ifdef SLAPD_BINARY_CONVERSION
391 /* convert to and from binary */
392 slap_syntax_transform_func *ssyn_ber2str;
393 slap_syntax_transform_func *ssyn_str2ber;
395 #ifdef LDAP_COMP_MATCH
396 slap_component_transform_func *ssyn_attr2comp;
397 struct ComponentDesc* ssync_comp_syntax;
400 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
403 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
404 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
405 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
406 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
407 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
409 typedef struct slap_syntax_defs_rec {
412 slap_syntax_validate_func *sd_validate;
413 slap_syntax_transform_func *sd_pretty;
414 #ifdef SLAPD_BINARY_CONVERSION
415 slap_syntax_transform_func *sd_ber2str;
416 slap_syntax_transform_func *sd_str2ber;
418 } slap_syntax_defs_rec;
420 /* X -> Y Converter */
421 typedef int slap_mr_convert_func LDAP_P((
427 typedef int slap_mr_normalize_func LDAP_P((
429 struct slap_syntax *syntax, /* NULL if in is asserted value */
430 struct slap_matching_rule *mr,
435 /* Match (compare) function */
436 typedef int slap_mr_match_func LDAP_P((
439 struct slap_syntax *syntax, /* syntax of stored value */
440 struct slap_matching_rule *mr,
441 struct berval * value,
442 void * assertValue ));
444 /* Index generation function */
445 typedef int slap_mr_indexer_func LDAP_P((
448 struct slap_syntax *syntax, /* syntax of stored value */
449 struct slap_matching_rule *mr,
450 struct berval *prefix,
455 /* Filter index function */
456 typedef int slap_mr_filter_func LDAP_P((
459 struct slap_syntax *syntax, /* syntax of stored value */
460 struct slap_matching_rule *mr,
461 struct berval *prefix,
466 typedef struct slap_matching_rule_use MatchingRuleUse;
468 typedef struct slap_matching_rule {
469 LDAPMatchingRule smr_mrule;
470 MatchingRuleUse *smr_mru;
471 /* RFC2252 string representation */
472 struct berval smr_str;
475 * ber_len_t smr_oidlen;
476 * has been replaced by a struct berval that uses the value
477 * provided by smr_mrule.mr_oid; a macro that expands to
478 * the bv_len field of the berval is provided for backward
479 * compatibility. CAUTION: NEVER FREE THE BERVAL
481 struct berval smr_bvoid;
482 #define smr_oidlen smr_bvoid.bv_len
484 slap_mask_t smr_usage;
487 #define SLAP_MR_HIDE 0x0000U
489 #define SLAP_MR_HIDE 0x8000U
492 #define SLAP_MR_TYPE_MASK 0x0F00U
493 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
494 #define SLAP_MR_USAGE 0x000FU
496 #define SLAP_MR_NONE 0x0000U
497 #define SLAP_MR_EQUALITY 0x0100U
498 #define SLAP_MR_ORDERING 0x0200U
499 #define SLAP_MR_SUBSTR 0x0400U
500 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
501 #define SLAP_MR_ORDERED_INDEX 0x1000U
502 #ifdef LDAP_COMP_MATCH
503 #define SLAP_MR_COMPONENT 0x2000U
506 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
508 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
509 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
510 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
514 * The asserted value, depending on the particular usage,
515 * is expected to conform to either the assertion syntax
516 * or the attribute syntax. In some cases, the syntax of
517 * the value is known. If so, these flags indicate which
518 * syntax the value is expected to conform to. If not,
519 * neither of these flags is set (until the syntax of the
520 * provided value is determined). If the value is of the
521 * attribute syntax, the flag is changed once a value of
522 * the assertion syntax is derived from the provided value.
524 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
525 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
526 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
528 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
529 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
530 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
531 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
533 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
534 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
536 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
539 /* either or both the asserted value or attribute value
540 * may be provided in normalized form
542 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
543 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
545 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
546 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
547 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
548 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
550 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
551 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
552 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
553 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
554 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
555 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
557 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
558 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
559 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
560 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
563 slap_mr_convert_func *smr_convert;
564 slap_mr_normalize_func *smr_normalize;
565 slap_mr_match_func *smr_match;
566 slap_mr_indexer_func *smr_indexer;
567 slap_mr_filter_func *smr_filter;
570 * null terminated array of syntaxes compatible with this syntax
571 * note: when MS_EXT is set, this MUST NOT contain the assertion
572 * syntax of the rule. When MS_EXT is not set, it MAY.
574 Syntax **smr_compat_syntaxes;
577 * For equality rules, refers to an associated approximate rule.
578 * For non-equality rules, refers to an associated equality rule.
580 struct slap_matching_rule *smr_associated;
582 #define SLAP_MR_ASSOCIATED(mr,amr) \
583 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
585 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
587 #define smr_oid smr_mrule.mr_oid
588 #define smr_names smr_mrule.mr_names
589 #define smr_desc smr_mrule.mr_desc
590 #define smr_obsolete smr_mrule.mr_obsolete
591 #define smr_syntax_oid smr_mrule.mr_syntax_oid
592 #define smr_extensions smr_mrule.mr_extensions
595 struct slap_matching_rule_use {
596 LDAPMatchingRuleUse smru_mruleuse;
597 MatchingRule *smru_mr;
598 /* RFC2252 string representation */
599 struct berval smru_str;
601 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
603 #define smru_oid smru_mruleuse.mru_oid
604 #define smru_names smru_mruleuse.mru_names
605 #define smru_desc smru_mruleuse.mru_desc
606 #define smru_obsolete smru_mruleuse.mru_obsolete
607 #define smru_applies_oids smru_mruleuse.mru_applies_oids
609 #define smru_usage smru_mr->smr_usage
610 } /* MatchingRuleUse */ ;
612 typedef struct slap_mrule_defs_rec {
614 slap_mask_t mrd_usage;
615 char ** mrd_compat_syntaxes;
616 slap_mr_convert_func * mrd_convert;
617 slap_mr_normalize_func * mrd_normalize;
618 slap_mr_match_func * mrd_match;
619 slap_mr_indexer_func * mrd_indexer;
620 slap_mr_filter_func * mrd_filter;
622 /* For equality rule, this may refer to an associated approximate rule */
623 /* For non-equality rule, this may refer to an associated equality rule */
624 char * mrd_associated;
625 } slap_mrule_defs_rec;
627 struct slap_backend_db;
631 typedef int (AttributeTypeSchemaCheckFN)(
632 struct slap_backend_db *be,
633 struct slap_entry *e,
634 struct slap_attr *attr,
636 char *textbuf, size_t textlen );
638 typedef struct slap_attribute_type {
639 LDAPAttributeType sat_atype;
640 struct berval sat_cname;
641 struct slap_attribute_type *sat_sup;
642 struct slap_attribute_type **sat_subtypes;
643 MatchingRule *sat_equality;
644 MatchingRule *sat_approx;
645 MatchingRule *sat_ordering;
646 MatchingRule *sat_substr;
649 AttributeTypeSchemaCheckFN *sat_check;
652 #define SLAP_AT_NONE 0x0000U
653 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
654 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
656 #define SLAP_AT_HIDE 0x0000U /* publish everything */
658 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
660 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
662 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
663 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
664 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
665 #define SLAP_AT_HARDCODE 0x10000U /* This is hardcoded schema */
667 slap_mask_t sat_flags;
669 LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
671 #define sat_oid sat_atype.at_oid
672 #define sat_names sat_atype.at_names
673 #define sat_desc sat_atype.at_desc
674 #define sat_obsolete sat_atype.at_obsolete
675 #define sat_sup_oid sat_atype.at_sup_oid
676 #define sat_equality_oid sat_atype.at_equality_oid
677 #define sat_ordering_oid sat_atype.at_ordering_oid
678 #define sat_substr_oid sat_atype.at_substr_oid
679 #define sat_syntax_oid sat_atype.at_syntax_oid
680 #define sat_single_value sat_atype.at_single_value
681 #define sat_collective sat_atype.at_collective
682 #define sat_no_user_mod sat_atype.at_no_user_mod
683 #define sat_usage sat_atype.at_usage
684 #define sat_extensions sat_atype.at_extensions
686 struct slap_attr_desc *sat_ad;
687 ldap_pvt_thread_mutex_t sat_ad_mutex;
690 #define is_at_operational(at) ((at)->sat_usage)
691 #define is_at_single_value(at) ((at)->sat_single_value)
692 #define is_at_collective(at) ((at)->sat_collective)
693 #define is_at_obsolete(at) ((at)->sat_obsolete)
694 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
696 struct slap_object_class;
698 typedef int (ObjectClassSchemaCheckFN)(
699 struct slap_backend_db *be,
700 struct slap_entry *e,
701 struct slap_object_class *oc,
703 char *textbuf, size_t textlen );
705 typedef struct slap_object_class {
706 LDAPObjectClass soc_oclass;
707 struct berval soc_cname;
708 struct slap_object_class **soc_sups;
709 AttributeType **soc_required;
710 AttributeType **soc_allowed;
711 ObjectClassSchemaCheckFN *soc_check;
713 slap_mask_t soc_flags;
714 #define soc_oid soc_oclass.oc_oid
715 #define soc_names soc_oclass.oc_names
716 #define soc_desc soc_oclass.oc_desc
717 #define soc_obsolete soc_oclass.oc_obsolete
718 #define soc_sup_oids soc_oclass.oc_sup_oids
719 #define soc_kind soc_oclass.oc_kind
720 #define soc_at_oids_must soc_oclass.oc_at_oids_must
721 #define soc_at_oids_may soc_oclass.oc_at_oids_may
722 #define soc_extensions soc_oclass.oc_extensions
724 LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
727 #define SLAP_OC_ALIAS 0x0001
728 #define SLAP_OC_REFERRAL 0x0002
729 #define SLAP_OC_SUBENTRY 0x0004
730 #define SLAP_OC_DYNAMICOBJECT 0x0008
731 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
732 #define SLAP_OC_GLUE 0x0020
733 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
734 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
735 #define SLAP_OC__MASK 0x00FF
736 #define SLAP_OC__END 0x0100
737 #define SLAP_OC_OPERATIONAL 0x4000
739 #define SLAP_OC_HIDE 0x0000
741 #define SLAP_OC_HIDE 0x8000
743 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
748 typedef struct slap_content_rule {
749 LDAPContentRule scr_crule;
750 ObjectClass *scr_sclass;
751 ObjectClass **scr_auxiliaries; /* optional */
752 AttributeType **scr_required; /* optional */
753 AttributeType **scr_allowed; /* optional */
754 AttributeType **scr_precluded; /* optional */
755 #define scr_oid scr_crule.cr_oid
756 #define scr_names scr_crule.cr_names
757 #define scr_desc scr_crule.cr_desc
758 #define scr_obsolete scr_crule.cr_obsolete
759 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
760 #define scr_at_oids_must scr_crule.cr_at_oids_must
761 #define scr_at_oids_may scr_crule.cr_at_oids_may
762 #define scr_at_oids_not scr_crule.cr_at_oids_not
765 #define SLAP_CR_HARDCODE 0x10000U
768 LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
771 /* Represents a recognized attribute description ( type + options ). */
772 typedef struct slap_attr_desc {
773 struct slap_attr_desc *ad_next;
774 AttributeType *ad_type; /* attribute type, must be specified */
775 struct berval ad_cname; /* canonical name, must be specified */
776 struct berval ad_tags; /* empty if no tagging options */
778 #define SLAP_DESC_NONE 0x00U
779 #define SLAP_DESC_BINARY 0x01U
780 #define SLAP_DESC_TAG_RANGE 0x80U
781 } AttributeDescription;
783 typedef struct slap_attr_name {
784 struct berval an_name;
785 AttributeDescription *an_desc;
790 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
791 #define slap_ad_is_tag_range(ad) \
792 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
793 #define slap_ad_is_binary(ad) \
794 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
797 * pointers to schema elements used internally
799 struct slap_internal_schema {
801 ObjectClass *si_oc_top;
802 ObjectClass *si_oc_extensibleObject;
803 ObjectClass *si_oc_alias;
804 ObjectClass *si_oc_referral;
805 ObjectClass *si_oc_rootdse;
806 ObjectClass *si_oc_subentry;
807 ObjectClass *si_oc_subschema;
808 ObjectClass *si_oc_collectiveAttributeSubentry;
809 ObjectClass *si_oc_dynamicObject;
811 ObjectClass *si_oc_glue;
812 ObjectClass *si_oc_syncConsumerSubentry;
813 ObjectClass *si_oc_syncProviderSubentry;
815 /* objectClass attribute descriptions */
816 AttributeDescription *si_ad_objectClass;
818 /* operational attribute descriptions */
819 AttributeDescription *si_ad_structuralObjectClass;
820 AttributeDescription *si_ad_creatorsName;
821 AttributeDescription *si_ad_createTimestamp;
822 AttributeDescription *si_ad_modifiersName;
823 AttributeDescription *si_ad_modifyTimestamp;
824 AttributeDescription *si_ad_hasSubordinates;
825 AttributeDescription *si_ad_subschemaSubentry;
826 AttributeDescription *si_ad_collectiveSubentries;
827 AttributeDescription *si_ad_collectiveExclusions;
828 AttributeDescription *si_ad_entryDN;
829 AttributeDescription *si_ad_entryUUID;
830 AttributeDescription *si_ad_entryCSN;
831 AttributeDescription *si_ad_namingCSN;
833 AttributeDescription *si_ad_dseType;
834 AttributeDescription *si_ad_syncreplCookie;
835 AttributeDescription *si_ad_syncTimestamp;
836 AttributeDescription *si_ad_contextCSN;
838 /* root DSE attribute descriptions */
839 AttributeDescription *si_ad_altServer;
840 AttributeDescription *si_ad_namingContexts;
841 AttributeDescription *si_ad_supportedControl;
842 AttributeDescription *si_ad_supportedExtension;
843 AttributeDescription *si_ad_supportedLDAPVersion;
844 AttributeDescription *si_ad_supportedSASLMechanisms;
845 AttributeDescription *si_ad_supportedFeatures;
846 AttributeDescription *si_ad_monitorContext;
847 AttributeDescription *si_ad_vendorName;
848 AttributeDescription *si_ad_vendorVersion;
849 AttributeDescription *si_ad_configContext;
851 /* subentry attribute descriptions */
852 AttributeDescription *si_ad_administrativeRole;
853 AttributeDescription *si_ad_subtreeSpecification;
855 /* subschema subentry attribute descriptions */
856 AttributeDescription *si_ad_attributeTypes;
857 AttributeDescription *si_ad_ditContentRules;
858 AttributeDescription *si_ad_ditStructureRules;
859 AttributeDescription *si_ad_ldapSyntaxes;
860 AttributeDescription *si_ad_matchingRules;
861 AttributeDescription *si_ad_matchingRuleUse;
862 AttributeDescription *si_ad_nameForms;
863 AttributeDescription *si_ad_objectClasses;
865 /* Aliases & Referrals */
866 AttributeDescription *si_ad_aliasedObjectName;
867 AttributeDescription *si_ad_ref;
869 /* Access Control Internals */
870 AttributeDescription *si_ad_entry;
871 AttributeDescription *si_ad_children;
872 AttributeDescription *si_ad_saslAuthzTo;
873 AttributeDescription *si_ad_saslAuthzFrom;
874 #ifdef SLAPD_ACI_ENABLED
875 AttributeDescription *si_ad_aci;
876 #endif /* SLAPD_ACI_ENABLED */
878 /* dynamic entries */
879 AttributeDescription *si_ad_entryTtl;
880 AttributeDescription *si_ad_dynamicSubtrees;
882 /* Other attributes descriptions */
883 AttributeDescription *si_ad_distinguishedName;
884 AttributeDescription *si_ad_name;
885 AttributeDescription *si_ad_cn;
886 AttributeDescription *si_ad_uid;
887 AttributeDescription *si_ad_userPassword;
888 AttributeDescription *si_ad_labeledURI;
889 #ifdef SLAPD_AUTHPASSWD
890 AttributeDescription *si_ad_authPassword;
892 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
893 AttributeDescription *si_ad_krbName;
896 /* Undefined Attribute Type */
897 AttributeType *si_at_undefined;
900 MatchingRule *si_mr_distinguishedNameMatch;
901 MatchingRule *si_mr_dnSubtreeMatch;
902 MatchingRule *si_mr_dnOneLevelMatch;
903 MatchingRule *si_mr_dnSubordinateMatch;
904 MatchingRule *si_mr_dnSuperiorMatch;
905 MatchingRule *si_mr_caseExactMatch;
906 MatchingRule *si_mr_caseExactSubstringsMatch;
907 MatchingRule *si_mr_caseExactIA5Match;
908 MatchingRule *si_mr_integerMatch;
909 MatchingRule *si_mr_integerFirstComponentMatch;
910 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
913 Syntax *si_syn_directoryString;
914 Syntax *si_syn_distinguishedName;
915 Syntax *si_syn_integer;
916 Syntax *si_syn_octetString;
918 /* Schema Syntaxes */
919 Syntax *si_syn_attributeTypeDesc;
920 Syntax *si_syn_ditContentRuleDesc;
921 Syntax *si_syn_ditStructureRuleDesc;
922 Syntax *si_syn_ldapSyntaxDesc;
923 Syntax *si_syn_matchingRuleDesc;
924 Syntax *si_syn_matchingRuleUseDesc;
925 Syntax *si_syn_nameFormDesc;
926 Syntax *si_syn_objectClassDesc;
929 typedef struct slap_attr_assertion {
930 AttributeDescription *aa_desc;
931 struct berval aa_value;
932 #ifdef LDAP_COMP_MATCH
933 struct slap_component_filter *aa_cf;/* for attribute aliasing */
935 } AttributeAssertion;
937 typedef struct slap_ss_assertion {
938 AttributeDescription *sa_desc;
939 struct berval sa_initial;
940 struct berval *sa_any;
941 struct berval sa_final;
942 } SubstringsAssertion;
944 #ifdef LDAP_COMP_MATCH
945 struct slap_component_filter;
948 typedef struct slap_mr_assertion {
949 MatchingRule *ma_rule; /* optional */
950 struct berval ma_rule_text; /* optional */
951 AttributeDescription *ma_desc; /* optional */
952 int ma_dnattrs; /* boolean */
953 struct berval ma_value; /* required */
954 #ifdef LDAP_COMP_MATCH
955 struct slap_component_filter* ma_cf; /* component filter */
957 } MatchingRuleAssertion;
960 * represents a search filter
962 typedef struct slap_filter {
963 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
964 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
965 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
966 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
967 #ifdef LDAP_SCOPE_SUBORDINATE
968 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
972 /* precomputed result */
973 ber_int_t f_un_result;
976 struct berval *f_un_dn;
979 AttributeDescription *f_un_desc;
981 /* simple value assertion */
982 AttributeAssertion *f_un_ava;
984 /* substring assertion */
985 SubstringsAssertion *f_un_ssa;
987 /* matching rule assertion */
988 MatchingRuleAssertion *f_un_mra;
990 #define f_dn f_un.f_un_dn
991 #define f_desc f_un.f_un_desc
992 #define f_ava f_un.f_un_ava
993 #define f_av_desc f_un.f_un_ava->aa_desc
994 #define f_av_value f_un.f_un_ava->aa_value
995 #define f_sub f_un.f_un_ssa
996 #define f_sub_desc f_un.f_un_ssa->sa_desc
997 #define f_sub_initial f_un.f_un_ssa->sa_initial
998 #define f_sub_any f_un.f_un_ssa->sa_any
999 #define f_sub_final f_un.f_un_ssa->sa_final
1000 #define f_mra f_un.f_un_mra
1001 #define f_mr_rule f_un.f_un_mra->ma_rule
1002 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1003 #define f_mr_desc f_un.f_un_mra->ma_desc
1004 #define f_mr_value f_un.f_un_mra->ma_value
1005 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1008 struct slap_filter *f_un_complex;
1011 #define f_result f_un.f_un_result
1012 #define f_and f_un.f_un_complex
1013 #define f_or f_un.f_un_complex
1014 #define f_not f_un.f_un_complex
1015 #define f_list f_un.f_un_complex
1017 struct slap_filter *f_next;
1020 /* compare routines can return undefined */
1021 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1023 typedef struct slap_valuesreturnfilter {
1024 ber_tag_t vrf_choice;
1027 /* precomputed result */
1028 ber_int_t vrf_un_result;
1034 AttributeDescription *vrf_un_desc;
1036 /* simple value assertion */
1037 AttributeAssertion *vrf_un_ava;
1039 /* substring assertion */
1040 SubstringsAssertion *vrf_un_ssa;
1042 /* matching rule assertion */
1043 MatchingRuleAssertion *vrf_un_mra;
1045 #define vrf_result vrf_un.vrf_un_result
1046 #define vrf_dn vrf_un.vrf_un_dn
1047 #define vrf_desc vrf_un.vrf_un_desc
1048 #define vrf_ava vrf_un.vrf_un_ava
1049 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1050 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1051 #define vrf_ssa vrf_un.vrf_un_ssa
1052 #define vrf_sub vrf_un.vrf_un_ssa
1053 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1054 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1055 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1056 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1057 #define vrf_mra vrf_un.vrf_un_mra
1058 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1059 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1060 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1061 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1062 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1067 struct slap_valuesreturnfilter *vrf_next;
1068 } ValuesReturnFilter;
1070 #ifdef LDAP_COMP_MATCH
1071 struct slap_component_syntax_info;
1072 typedef struct slap_component_data {
1073 void* cd_mem_op;/* nibble memory handler */
1074 struct slap_component_syntax_info** cd_tree;/* component tree */
1079 * represents an attribute (description + values)
1081 typedef struct slap_attr {
1082 AttributeDescription *a_desc;
1083 BerVarray a_vals; /* preserved values */
1084 BerVarray a_nvals; /* normalized values */
1085 #ifdef LDAP_COMP_MATCH
1086 ComponentData *a_comp_data; /* component values */
1088 struct slap_attr *a_next;
1090 #define SLAP_ATTR_IXADD 0x1U
1091 #define SLAP_ATTR_IXDEL 0x2U
1096 * the id used in the indexes to refer to an entry
1098 typedef unsigned long ID;
1099 #define NOID ((ID)~0)
1102 * represents an entry in core
1104 typedef struct slap_entry {
1106 * The ID field should only be changed before entry is
1107 * inserted into a cache. The ID value is backend
1112 struct berval e_name; /* name (DN) of this entry */
1113 struct berval e_nname; /* normalized name (DN) of this entry */
1115 /* for migration purposes */
1116 #define e_dn e_name.bv_val
1117 #define e_ndn e_nname.bv_val
1119 Attribute *e_attrs; /* list of attributes + values */
1121 slap_mask_t e_ocflags;
1123 struct berval e_bv; /* For entry_encode/entry_decode */
1125 /* for use by the backend for any purpose */
1130 * A list of LDAPMods
1132 typedef struct slap_mod {
1134 AttributeDescription *sm_desc;
1135 struct berval sm_type;
1136 BerVarray sm_values;
1137 BerVarray sm_nvalues;
1140 typedef struct slap_mod_list {
1141 Modification sml_mod;
1142 #define sml_op sml_mod.sm_op
1143 #define sml_desc sml_mod.sm_desc
1144 #define sml_type sml_mod.sm_type
1145 #define sml_values sml_mod.sm_values
1146 #define sml_nvalues sml_mod.sm_nvalues
1147 struct slap_mod_list *sml_next;
1150 typedef struct slap_ldap_modlist {
1152 struct slap_ldap_modlist *ml_next;
1153 #define ml_op ml_mod.mod_op
1154 #define ml_type ml_mod.mod_type
1155 #define ml_values ml_mod.mod_values
1159 * represents an access control list
1161 typedef enum slap_access_e {
1162 ACL_INVALID_ACCESS = -1,
1172 /* ACL level mask and modifiers */
1173 ACL_LEVEL_MASK = 0x000f,
1174 ACL_QUALIFIER1 = 0x0100,
1175 ACL_QUALIFIER2 = 0x0200,
1176 ACL_QUALIFIER3 = 0x0400,
1177 ACL_QUALIFIER4 = 0x0800,
1178 ACL_QUALIFIER_MASK = 0x0f00,
1180 /* write granularity */
1181 ACL_WADD = ACL_WRITE|ACL_QUALIFIER1,
1182 ACL_WDEL = ACL_WRITE|ACL_QUALIFIER2
1185 typedef enum slap_control_e {
1186 ACL_INVALID_CONTROL = 0,
1192 typedef enum slap_style_e {
1193 ACL_STYLE_REGEX = 0,
1201 ACL_STYLE_ANONYMOUS,
1208 typedef struct slap_authz_info {
1209 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1210 struct berval sai_mech; /* SASL Mechanism */
1211 struct berval sai_dn; /* DN for reporting purposes */
1212 struct berval sai_ndn; /* Normalized DN */
1214 /* Security Strength Factors */
1215 slap_ssf_t sai_ssf; /* Overall SSF */
1216 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1217 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1218 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1219 } AuthorizationInformation;
1226 * "dynamic" ACL infrastructure (for ACIs and more)
1228 typedef int (slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1229 typedef int (slap_dynacl_unparse)( void *priv, struct berval *bv );
1230 typedef int (slap_dynacl_mask)(
1234 AttributeDescription *desc,
1237 regmatch_t *matches,
1238 slap_access_t *grant,
1239 slap_access_t *deny );
1240 typedef int (slap_dynacl_destroy)( void *priv );
1242 typedef struct slap_dynacl_t {
1244 slap_dynacl_parse *da_parse;
1245 slap_dynacl_unparse *da_unparse;
1246 slap_dynacl_mask *da_mask;
1247 slap_dynacl_destroy *da_destroy;
1250 struct slap_dynacl_t *da_next;
1252 #endif /* SLAP_DYNACL */
1254 /* the DN portion of the "by" part */
1255 typedef struct slap_dn_access {
1257 AuthorizationInformation a_dnauthz;
1258 #define a_pat a_dnauthz.sai_dn
1260 slap_style_t a_style;
1263 AttributeDescription *a_at;
1269 typedef struct slap_access {
1270 slap_control_t a_type;
1272 /* strip qualifiers */
1273 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1274 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1276 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1278 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1279 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1280 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1281 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1282 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1283 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1284 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1285 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1286 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1287 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1289 /* NOTE: always use the highest level; current: 0x00ffUL */
1290 #define ACL_PRIV_MASK ((ACL_PRIV_MANAGE - 1) | ACL_QUALIFIER_MASK)
1293 #define ACL_PRIV_LEVEL 0x1000UL
1294 #define ACL_PRIV_ADDITIVE 0x2000UL
1295 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1298 #define ACL_PRIV_INVALID 0x0UL
1300 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1301 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1302 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1303 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1305 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1306 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1308 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1310 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1312 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1313 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1314 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1316 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1317 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1318 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1319 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1320 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1321 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1322 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1323 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1324 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1325 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1327 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1328 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1329 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1330 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1331 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1332 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1333 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1334 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1335 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1336 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1337 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1339 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1340 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1341 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1342 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1343 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1344 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1345 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1346 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1347 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1348 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1350 slap_mask_t a_access_mask;
1353 slap_dn_access a_dn;
1354 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1355 #define a_dn_at a_dn.a_at
1356 #define a_dn_self a_dn.a_self
1358 /* real DN pattern */
1359 slap_dn_access a_realdn;
1360 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1361 #define a_realdn_at a_realdn.a_at
1362 #define a_realdn_self a_realdn.a_self
1364 /* used for ssf stuff
1365 * NOTE: the ssf stuff in a_realdn is ignored */
1366 #define a_authz a_dn.a_dnauthz
1368 /* connection related stuff */
1369 slap_style_t a_peername_style;
1370 struct berval a_peername_pat;
1371 unsigned long a_peername_addr,
1373 int a_peername_port;
1375 slap_style_t a_sockname_style;
1376 struct berval a_sockname_pat;
1378 slap_style_t a_domain_style;
1379 struct berval a_domain_pat;
1380 int a_domain_expand;
1382 slap_style_t a_sockurl_style;
1383 struct berval a_sockurl_pat;
1384 slap_style_t a_set_style;
1385 struct berval a_set_pat;
1388 slap_dynacl_t *a_dynacl;
1389 #else /* ! SLAP_DYNACL */
1390 #ifdef SLAPD_ACI_ENABLED
1391 /* NOTE: ACIs have been moved under the "dynacl" interface,
1392 * which is currently built only when LDAP_DEVEL is defined.
1394 * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1395 * is required to enable ACI support.
1397 AttributeDescription *a_aci_at;
1398 #endif /* SLAPD_ACI_ENABLED */
1399 #endif /* SLAP_DYNACL */
1402 slap_style_t a_group_style;
1403 struct berval a_group_pat;
1404 ObjectClass *a_group_oc;
1405 AttributeDescription *a_group_at;
1407 struct slap_access *a_next;
1411 typedef struct slap_acl {
1412 /* "to" part: the entries this acl applies to */
1414 slap_style_t acl_dn_style;
1416 struct berval acl_dn_pat;
1417 AttributeName *acl_attrs;
1418 slap_style_t acl_attrval_style;
1419 regex_t acl_attrval_re;
1420 struct berval acl_attrval;
1422 /* "by" part: list of who has what access to the entries */
1425 struct slap_acl *acl_next;
1428 typedef struct slap_acl_state {
1429 unsigned as_recorded;
1430 #define ACL_STATE_NOT_RECORDED 0x0
1431 #define ACL_STATE_RECORDED_VD 0x1
1432 #define ACL_STATE_RECORDED_NV 0x2
1433 #define ACL_STATE_RECORDED 0x3
1436 AccessControl *as_vd_acl;
1437 AccessControl *as_vi_acl;
1438 slap_mask_t as_vd_acl_mask;
1439 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1440 int as_vd_acl_count;
1442 Access *as_vd_access;
1443 int as_vd_access_count;
1446 AttributeDescription *as_vd_ad;
1447 } AccessControlState;
1448 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1449 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1453 * represents a backend
1456 typedef struct slap_backend_info BackendInfo; /* per backend type */
1457 typedef struct slap_backend_db BackendDB; /* per backend database */
1458 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1459 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1461 LDAP_SLAPD_V (int) nBackendInfo;
1462 LDAP_SLAPD_V (int) nBackendDB;
1463 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1464 LDAP_SLAPD_V (slap_be_head) backendDB;
1465 LDAP_SLAPD_V (BackendDB *) frontendDB;
1467 LDAP_SLAPD_V (int) slapMode;
1468 #define SLAP_UNDEFINED_MODE 0x0000
1469 #define SLAP_SERVER_MODE 0x0001
1470 #define SLAP_TOOL_MODE 0x0002
1471 #define SLAP_MODE 0x0003
1473 #define SLAP_TRUNCATE_MODE 0x0100
1474 #define SLAP_TOOL_READMAIN 0x0200
1475 #define SLAP_TOOL_READONLY 0x0400
1476 #define SLAP_TOOL_QUICK 0x0800
1478 #define SB_TLS_OFF 0
1480 #define SB_TLS_CRITICAL 2
1482 typedef struct slap_bindconf {
1485 struct berval sb_binddn;
1486 struct berval sb_cred;
1487 struct berval sb_saslmech;
1489 struct berval sb_realm;
1490 struct berval sb_authcId;
1491 struct berval sb_authzId;
1494 struct slap_replica_info {
1495 const char *ri_uri; /* supersedes be_replica */
1496 const char *ri_host; /* points to host part of uri */
1497 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1498 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1499 int ri_exclude; /* 1 => exclude ri_attrs */
1500 slap_bindconf ri_bindconf; /* for back-config */
1503 typedef struct slap_verbmasks {
1508 #define SLAP_LIMIT_TIME 1
1509 #define SLAP_LIMIT_SIZE 2
1511 struct slap_limits_set {
1519 int lms_s_unchecked;
1525 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1526 #define SLAP_NO_LIMIT -1
1527 #define SLAP_MAX_LIMIT 2147483647
1529 struct slap_limits {
1530 unsigned lm_flags; /* type of pattern */
1531 #define SLAP_LIMITS_UNDEFINED 0x0000U
1532 #define SLAP_LIMITS_EXACT 0x0001U
1533 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1534 #define SLAP_LIMITS_ONE 0x0002U
1535 #define SLAP_LIMITS_SUBTREE 0x0003U
1536 #define SLAP_LIMITS_CHILDREN 0x0004U
1537 #define SLAP_LIMITS_REGEX 0x0005U
1538 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1539 #define SLAP_LIMITS_USERS 0x0007U
1540 #define SLAP_LIMITS_ANY 0x0008U
1541 #define SLAP_LIMITS_MASK 0x000FU
1543 #define SLAP_LIMITS_TYPE_DN 0x0000U
1544 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1545 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1547 regex_t lm_regex; /* regex data for REGEX */
1550 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1551 * pattern for REGEX; NULL for ANONYMOUS, USERS
1553 struct berval lm_pat;
1555 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1556 * lm_group_oc is objectClass and lm_group_at is attributeType
1557 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1558 * can only be SLAP_LIMITS_EXACT */
1559 ObjectClass *lm_group_oc;
1560 AttributeDescription *lm_group_ad;
1562 struct slap_limits_set lm_limits;
1565 /* temporary aliases */
1566 typedef BackendDB Backend;
1567 #define nbackends nBackendDB
1568 #define backends backendDB
1571 * syncinfo structure for syncrepl
1576 #define SLAP_SYNC_RID_SIZE 3
1577 #define SLAP_SYNCUUID_SET_SIZE 256
1579 #define SLAP_SYNC_UPDATE_MSGID 2
1581 struct sync_cookie {
1582 struct berval ctxcsn;
1583 struct berval octet_str;
1585 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1588 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1590 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1592 #ifndef SLAP_MAX_CIDS
1593 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1596 struct slap_backend_db {
1597 BackendInfo *bd_info; /* pointer to shared backend info */
1599 /* fields in this structure (and routines acting on this structure)
1600 should be renamed from be_ to bd_ */
1602 /* BackendInfo accessors */
1603 #define be_config bd_info->bi_db_config
1604 #define be_type bd_info->bi_type
1606 #define be_bind bd_info->bi_op_bind
1607 #define be_unbind bd_info->bi_op_unbind
1608 #define be_add bd_info->bi_op_add
1609 #define be_compare bd_info->bi_op_compare
1610 #define be_delete bd_info->bi_op_delete
1611 #define be_modify bd_info->bi_op_modify
1612 #define be_modrdn bd_info->bi_op_modrdn
1613 #define be_search bd_info->bi_op_search
1614 #define be_abandon bd_info->bi_op_abandon
1615 #define be_cancel bd_info->bi_op_cancel
1617 #define be_extended bd_info->bi_extended
1619 #define be_chk_referrals bd_info->bi_chk_referrals
1620 #define be_chk_controls bd_info->bi_chk_controls
1621 #define be_fetch bd_info->bi_entry_get_rw
1622 #define be_release bd_info->bi_entry_release_rw
1623 #define be_group bd_info->bi_acl_group
1624 #define be_attribute bd_info->bi_acl_attribute
1625 #define be_operational bd_info->bi_operational
1628 * define to honor hasSubordinates operational attribute in search filters
1629 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1632 #define be_has_subordinates bd_info->bi_has_subordinates
1634 #define be_connection_init bd_info->bi_connection_init
1635 #define be_connection_destroy bd_info->bi_connection_destroy
1638 #define be_entry_open bd_info->bi_tool_entry_open
1639 #define be_entry_close bd_info->bi_tool_entry_close
1640 #define be_entry_first bd_info->bi_tool_entry_first
1641 #define be_entry_next bd_info->bi_tool_entry_next
1642 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1643 #define be_entry_get bd_info->bi_tool_entry_get
1644 #define be_entry_put bd_info->bi_tool_entry_put
1645 #define be_sync bd_info->bi_tool_sync
1646 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1647 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1648 #define be_entry_modify bd_info->bi_tool_entry_modify
1651 /* supported controls */
1652 /* note: set to 0 if the database does not support the control;
1653 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1654 char be_ctrls[SLAP_MAX_CIDS + 1];
1656 /* Database flags */
1657 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1658 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1659 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1660 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1661 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1662 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1663 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1664 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1665 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1666 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1667 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1668 slap_mask_t be_flags;
1669 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1670 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1671 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1672 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1673 #define SLAP_NO_SCHEMA_CHECK(be) \
1674 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1675 #define SLAP_GLUE_INSTANCE(be) \
1676 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1677 #define SLAP_GLUE_SUBORDINATE(be) \
1678 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1679 #define SLAP_GLUE_LINKED(be) \
1680 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1681 #define SLAP_GLUE_ADVERTISE(be) \
1682 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1683 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1684 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1685 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1687 slap_mask_t be_restrictops; /* restriction operations */
1688 #define SLAP_RESTRICT_OP_ADD 0x0001U
1689 #define SLAP_RESTRICT_OP_BIND 0x0002U
1690 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1691 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1692 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1693 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1694 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1695 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1696 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1698 #define SLAP_RESTRICT_READONLY 0x80000000U
1700 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1701 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1702 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1703 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1704 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1706 #define SLAP_RESTRICT_OP_READS \
1707 ( SLAP_RESTRICT_OP_COMPARE \
1708 | SLAP_RESTRICT_OP_SEARCH )
1709 #define SLAP_RESTRICT_OP_WRITES \
1710 ( SLAP_RESTRICT_OP_ADD \
1711 | SLAP_RESTRICT_OP_DELETE \
1712 | SLAP_RESTRICT_OP_MODIFY \
1713 | SLAP_RESTRICT_OP_RENAME )
1715 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1716 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1717 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1719 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1721 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1722 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1723 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1725 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1726 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1728 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1730 slap_mask_t be_requires; /* pre-operation requirements */
1731 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1732 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1733 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1734 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1735 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1737 /* Required Security Strength Factor */
1738 slap_ssf_set_t be_ssf_set;
1740 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1741 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1742 struct berval be_schemadn; /* per-backend subschema subentry DN */
1743 struct berval be_schemandn; /* normalized subschema DN */
1744 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1745 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1746 struct berval be_rootpw; /* the magic "root" password for this db */
1747 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1748 #define be_sizelimit be_def_limit.lms_s_soft
1749 #define be_timelimit be_def_limit.lms_t_soft
1750 struct slap_limits_set be_def_limit; /* default limits */
1751 struct slap_limits **be_limits; /* regex-based size and time limits */
1752 AccessControl *be_acl; /* access control list for this backend */
1753 slap_access_t be_dfltaccess; /* access given if no acl matches */
1755 /* Replica Information */
1756 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1757 char *be_replogfile; /* replication log file (in master) */
1758 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1759 BerVarray be_update_refs; /* where to refer modifying clients to */
1760 struct be_pcl *be_pending_csn_list;
1761 ldap_pvt_thread_mutex_t be_pcl_mutex;
1762 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1763 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1765 void *be_pb; /* Netscape plugin */
1766 struct ConfigTable *be_cf_table;
1768 void *be_private; /* anything the backend database needs */
1769 LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1775 /* Backend function typedefs */
1776 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1777 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1778 const char *fname, int lineno,
1779 int argc, char **argv));
1780 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1781 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1782 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1784 typedef int (BI_db_init) LDAP_P((Backend *bd));
1785 typedef int (BI_db_config) LDAP_P((Backend *bd,
1786 const char *fname, int lineno,
1787 int argc, char **argv));
1788 typedef int (BI_db_open) LDAP_P((Backend *bd));
1789 typedef int (BI_db_close) LDAP_P((Backend *bd));
1790 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1792 typedef struct req_bind_s {
1794 struct berval rb_cred;
1795 struct berval rb_edn;
1797 struct berval rb_tmp_mech; /* FIXME: temporary */
1800 typedef struct req_search_s {
1805 /* NULL means be_isroot evaluated to TRUE */
1806 struct slap_limits_set *rs_limit;
1808 AttributeName *rs_attrs;
1810 struct berval rs_filterstr;
1813 typedef struct req_compare_s {
1814 AttributeAssertion *rs_ava;
1817 typedef struct req_modify_s {
1818 Modifications *rs_modlist;
1819 int rs_increment; /* FIXME: temporary */
1822 typedef struct req_modrdn_s {
1823 struct berval rs_newrdn;
1824 struct berval rs_nnewrdn;
1825 struct berval *rs_newSup;
1826 struct berval *rs_nnewSup;
1827 int rs_deleteoldrdn;
1830 typedef struct req_add_s {
1832 Modifications *rs_modlist; /* FIXME: temporary */
1835 typedef struct req_abandon_s {
1840 #define SLAP_EXOP_HIDE 0x0000
1842 #define SLAP_EXOP_HIDE 0x8000
1844 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1846 typedef struct req_extended_s {
1847 struct berval rs_reqoid;
1849 struct berval *rs_reqdata;
1852 typedef struct req_pwdexop_s {
1853 struct berval rs_reqoid;
1855 struct berval rs_old;
1856 struct berval rs_new;
1857 Modifications *rs_mods;
1858 Modifications **rs_modtail;
1861 typedef enum slap_reply_e {
1870 typedef struct rep_sasl_s {
1871 struct berval *r_sasldata;
1874 typedef struct rep_extended_s {
1875 const char *r_rspoid;
1876 struct berval *r_rspdata;
1879 typedef struct rep_search_s {
1881 slap_mask_t r_attr_flags;
1882 #define SLAP_ATTRS_UNDEFINED (0x00U)
1883 #define SLAP_OPATTRS_NO (0x01U)
1884 #define SLAP_OPATTRS_YES (0x02U)
1885 #define SLAP_USERATTRS_NO (0x10U)
1886 #define SLAP_USERATTRS_YES (0x20U)
1887 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1888 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1889 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1890 #define SLAP_USERATTRS(f) \
1891 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1893 Attribute *r_operational_attrs;
1894 AttributeName *r_attrs;
1899 typedef struct slap_rep {
1900 slap_reply_t sr_type;
1904 const char *sr_matched;
1905 const char *sr_text;
1907 LDAPControl **sr_ctrls;
1909 rep_sasl_s sru_sasl;
1910 rep_extended_s sru_extended;
1911 rep_search_s sru_search;
1913 slap_mask_t sr_flags;
1914 #define REP_ENTRY_MODIFIABLE 0x0001U
1915 #define REP_ENTRY_MUSTBEFREED 0x0002U
1916 #define REP_ENTRY_MUSTRELEASE 0x0004U
1917 #define REP_MATCHED_MUSTBEFREED 0x0010U
1918 #define REP_REF_MUSTBEFREED 0x0020U
1921 /* short hands for response members */
1922 #define sr_attrs sr_un.sru_search.r_attrs
1923 #define sr_entry sr_un.sru_search.r_entry
1924 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1925 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1926 #define sr_v2ref sr_un.sru_search.r_v2ref
1927 #define sr_nentries sr_un.sru_search.r_nentries
1928 #define sr_rspoid sr_un.sru_extended.r_rspoid
1929 #define sr_rspdata sr_un.sru_extended.r_rspdata
1930 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1932 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1933 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1934 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1935 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1936 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1937 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1938 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1939 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1940 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1941 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1942 typedef int (BI_op_extended) LDAP_P((
1943 struct slap_op *op, struct slap_rep *rs ));
1944 typedef int (BI_chk_referrals) LDAP_P((
1945 struct slap_op *op, struct slap_rep *rs ));
1946 typedef int (BI_chk_controls) LDAP_P((
1947 struct slap_op *op, struct slap_rep *rs ));
1948 typedef int (BI_entry_release_rw)
1949 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1950 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1951 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1952 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1953 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1954 Entry *e, int *hasSubs ));
1955 #ifdef SLAP_OVERLAY_ACCESS
1956 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
1957 AttributeDescription *desc, struct berval *val, slap_access_t access,
1958 AccessControlState *state, slap_mask_t *maskp ));
1959 #endif /* SLAP_OVERLAY_ACCESS */
1961 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1962 struct slap_conn *c ));
1963 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1964 struct slap_conn *c ));
1966 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1967 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1968 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1969 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1970 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1971 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1972 struct berval *text ));
1973 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1974 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1975 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1976 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1977 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1978 struct berval *text ));
1980 struct ConfigTable; /* config.h */
1982 struct slap_backend_info {
1983 char *bi_type; /* type of backend */
1986 * per backend type routines:
1987 * bi_init: called to allocate a backend_info structure,
1988 * called once BEFORE configuration file is read.
1989 * bi_init() initializes this structure hence is
1990 * called directly from be_initialize()
1991 * bi_config: called per 'backend' specific option
1992 * all such options must before any 'database' options
1993 * bi_config() is called only from read_config()
1994 * bi_open: called to open each database, called
1995 * once AFTER configuration file is read but
1996 * BEFORE any bi_db_open() calls.
1997 * bi_open() is called from backend_startup()
1998 * bi_close: called to close each database, called
1999 * once during shutdown after all bi_db_close calls.
2000 * bi_close() is called from backend_shutdown()
2001 * bi_destroy: called to destroy each database, called
2002 * once during shutdown after all bi_db_destroy calls.
2003 * bi_destory() is called from backend_destroy()
2006 BI_config *bi_config;
2009 BI_destroy *bi_destroy;
2012 * per database routines:
2013 * bi_db_init: called to initialize each database,
2014 * called upon reading 'database <type>'
2015 * called only from backend_db_init()
2016 * bi_db_config: called to configure each database,
2017 * called per database to handle per database options
2018 * called only from read_config()
2019 * bi_db_open: called to open each database
2020 * called once per database immediately AFTER bi_open()
2021 * calls but before daemon startup.
2022 * called only by backend_startup()
2023 * bi_db_close: called to close each database
2024 * called once per database during shutdown but BEFORE
2025 * any bi_close call.
2026 * called only by backend_shutdown()
2027 * bi_db_destroy: called to destroy each database
2028 * called once per database during shutdown AFTER all
2029 * bi_close calls but before bi_destory calls.
2030 * called only by backend_destory()
2032 BI_db_init *bi_db_init;
2033 BI_db_config *bi_db_config;
2034 BI_db_open *bi_db_open;
2035 BI_db_close *bi_db_close;
2036 BI_db_destroy *bi_db_destroy;
2038 /* LDAP Operations Handling Routines */
2039 BI_op_bind *bi_op_bind;
2040 BI_op_unbind *bi_op_unbind;
2041 BI_op_search *bi_op_search;
2042 BI_op_compare *bi_op_compare;
2043 BI_op_modify *bi_op_modify;
2044 BI_op_modrdn *bi_op_modrdn;
2045 BI_op_add *bi_op_add;
2046 BI_op_delete *bi_op_delete;
2047 BI_op_abandon *bi_op_abandon;
2048 BI_op_cancel *bi_op_cancel;
2050 /* Extended Operations Helper */
2051 BI_op_extended *bi_extended;
2053 /* Auxilary Functions */
2054 BI_operational *bi_operational;
2055 BI_chk_referrals *bi_chk_referrals;
2056 BI_chk_controls *bi_chk_controls;
2057 BI_entry_get_rw *bi_entry_get_rw;
2058 BI_entry_release_rw *bi_entry_release_rw;
2060 BI_has_subordinates *bi_has_subordinates;
2061 #ifdef SLAP_OVERLAY_ACCESS
2062 BI_access_allowed *bi_access_allowed;
2063 #endif /* SLAP_OVERLAY_ACCESS */
2065 BI_connection_init *bi_connection_init;
2066 BI_connection_destroy *bi_connection_destroy;
2068 /* hooks for slap tools */
2069 BI_tool_entry_open *bi_tool_entry_open;
2070 BI_tool_entry_close *bi_tool_entry_close;
2071 BI_tool_entry_first *bi_tool_entry_first;
2072 BI_tool_entry_next *bi_tool_entry_next;
2073 BI_tool_entry_get *bi_tool_entry_get;
2074 BI_tool_entry_put *bi_tool_entry_put;
2075 BI_tool_entry_reindex *bi_tool_entry_reindex;
2076 BI_tool_sync *bi_tool_sync;
2077 BI_tool_dn2id_get *bi_tool_dn2id_get;
2078 BI_tool_id2entry_get *bi_tool_id2entry_get;
2079 BI_tool_entry_modify *bi_tool_entry_modify;
2081 #define SLAP_INDEX_ADD_OP 0x0001
2082 #define SLAP_INDEX_DELETE_OP 0x0002
2084 slap_mask_t bi_flags; /* backend flags */
2085 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2086 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2087 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2088 #define SLAP_BFLAG_INCREMENT 0x0100U
2089 #define SLAP_BFLAG_ALIASES 0x1000U
2090 #define SLAP_BFLAG_REFERRALS 0x2000U
2091 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2092 #define SLAP_BFLAG_DYNAMIC 0x8000U
2094 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2095 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2096 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2097 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2098 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2099 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2100 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2101 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2102 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2103 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2105 char **bi_controls; /* supported controls */
2106 char bi_ctrls[SLAP_MAX_CIDS + 1];
2108 unsigned int bi_nDB; /* number of databases of this type */
2109 struct ConfigTable *bi_cf_table;
2110 void *bi_private; /* anything the backend type needs */
2111 LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2114 #define c_authtype c_authz.sai_method
2115 #define c_authmech c_authz.sai_mech
2116 #define c_dn c_authz.sai_dn
2117 #define c_ndn c_authz.sai_ndn
2118 #define c_ssf c_authz.sai_ssf
2119 #define c_transport_ssf c_authz.sai_transport_ssf
2120 #define c_tls_ssf c_authz.sai_tls_ssf
2121 #define c_sasl_ssf c_authz.sai_sasl_ssf
2123 #define o_authtype o_authz.sai_method
2124 #define o_authmech o_authz.sai_mech
2125 #define o_dn o_authz.sai_dn
2126 #define o_ndn o_authz.sai_ndn
2127 #define o_ssf o_authz.sai_ssf
2128 #define o_transport_ssf o_authz.sai_transport_ssf
2129 #define o_tls_ssf o_authz.sai_tls_ssf
2130 #define o_sasl_ssf o_authz.sai_sasl_ssf
2132 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2134 typedef struct slap_callback {
2135 struct slap_callback *sc_next;
2136 slap_response *sc_response;
2137 slap_response *sc_cleanup;
2141 struct slap_overinfo;
2143 typedef struct slap_overinst {
2145 slap_response *on_response;
2146 struct slap_overinfo *on_info;
2147 struct slap_overinst *on_next;
2150 typedef struct slap_overinfo {
2152 BackendInfo *oi_orig;
2153 struct slap_overinst *oi_list;
2156 /* Should successive callbacks in a chain be processed? */
2157 #define SLAP_CB_FREEME 0x4000
2158 #define SLAP_CB_CONTINUE 0x8000
2161 * Paged Results state
2163 typedef unsigned long PagedResultsCookie;
2164 typedef struct slap_paged_state {
2167 PagedResultsCookie ps_cookie;
2169 } PagedResultsState;
2171 struct slap_csn_entry {
2172 struct berval ce_csn;
2173 unsigned long ce_opid;
2174 unsigned long ce_connid;
2175 #define SLAP_CSN_PENDING 1
2176 #define SLAP_CSN_COMMIT 2
2178 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2182 * Caches the result of a backend_group check for ACL evaluation
2184 typedef struct slap_gacl {
2185 struct slap_gacl *ga_next;
2188 AttributeDescription *ga_at;
2194 struct slap_control_ids {
2200 int sc_modifyIncrement;
2202 int sc_pagedResults;
2204 int sc_sortedResults;
2206 int sc_valuesReturnFilter;
2207 int sc_permissiveModify;
2210 int sc_searchOptions;
2216 * represents an operation pending from an ldap client
2218 typedef struct slap_op_header {
2219 unsigned long oh_opid; /* id of this operation */
2220 unsigned long oh_connid; /* id of conn initiating this op */
2221 struct slap_conn *oh_conn; /* connection spawning this op */
2223 ber_int_t oh_msgid; /* msgid of the request */
2224 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2226 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2228 void *oh_threadctx; /* thread pool thread context */
2229 void *oh_tmpmemctx; /* slab malloc context */
2230 BerMemoryFunctions *oh_tmpmfuncs;
2232 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2235 void *oh_pb; /* NS-SLAPI plugin */
2236 void *oh_extensions; /* NS-SLAPI plugin */
2240 typedef struct slap_op {
2243 #define o_opid o_hdr->oh_opid
2244 #define o_connid o_hdr->oh_connid
2245 #define o_conn o_hdr->oh_conn
2246 #define o_msgid o_hdr->oh_msgid
2247 #define o_protocol o_hdr->oh_protocol
2248 #define o_tid o_hdr->oh_tid
2249 #define o_threadctx o_hdr->oh_threadctx
2250 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2251 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2253 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2254 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2255 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2256 #define o_tmpfree o_tmpmfuncs->bmf_free
2258 #define o_log_prefix o_hdr->oh_log_prefix
2261 #define o_pb o_hdr->oh_pb
2262 #define o_extensions o_hdr->oh_extensions
2265 ber_tag_t o_tag; /* tag of the request */
2266 time_t o_time; /* time op was initiated */
2268 BackendDB *o_bd; /* backend DB processing this op */
2269 struct berval o_req_dn; /* DN of target of request */
2270 struct berval o_req_ndn;
2275 req_compare_s oq_compare;
2276 req_modify_s oq_modify;
2277 req_modrdn_s oq_modrdn;
2278 req_search_s oq_search;
2279 req_abandon_s oq_abandon;
2280 req_abandon_s oq_cancel;
2281 req_extended_s oq_extended;
2282 req_pwdexop_s oq_pwdexop;
2285 /* short hands for union members */
2286 #define oq_add o_request.oq_add
2287 #define oq_bind o_request.oq_bind
2288 #define oq_compare o_request.oq_compare
2289 #define oq_modify o_request.oq_modify
2290 #define oq_modrdn o_request.oq_modrdn
2291 #define oq_search o_request.oq_search
2292 #define oq_abandon o_request.oq_abandon
2293 #define oq_cancel o_request.oq_cancel
2294 #define oq_extended o_request.oq_extended
2295 #define oq_pwdexop o_request.oq_pwdexop
2297 /* short hands for inner request members */
2298 #define orb_method oq_bind.rb_method
2299 #define orb_cred oq_bind.rb_cred
2300 #define orb_edn oq_bind.rb_edn
2301 #define orb_ssf oq_bind.rb_ssf
2302 #define orb_tmp_mech oq_bind.rb_tmp_mech
2304 #define ors_scope oq_search.rs_scope
2305 #define ors_deref oq_search.rs_deref
2306 #define ors_slimit oq_search.rs_slimit
2307 #define ors_tlimit oq_search.rs_tlimit
2308 #define ors_limit oq_search.rs_limit
2309 #define ors_attrsonly oq_search.rs_attrsonly
2310 #define ors_attrs oq_search.rs_attrs
2311 #define ors_filter oq_search.rs_filter
2312 #define ors_filterstr oq_search.rs_filterstr
2314 #define orr_newrdn oq_modrdn.rs_newrdn
2315 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2316 #define orr_newSup oq_modrdn.rs_newSup
2317 #define orr_nnewSup oq_modrdn.rs_nnewSup
2318 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2320 #define orc_ava oq_compare.rs_ava
2321 #define ora_e oq_add.rs_e
2322 #define ora_modlist oq_add.rs_modlist
2323 #define orn_msgid oq_abandon.rs_msgid
2324 #define orm_modlist oq_modify.rs_modlist
2325 #define orm_increment oq_modify.rs_increment
2327 #define ore_reqoid oq_extended.rs_reqoid
2328 #define ore_flags oq_extended.rs_flags
2329 #define ore_reqdata oq_extended.rs_reqdata
2330 volatile sig_atomic_t o_abandon; /* abandon flag */
2331 volatile sig_atomic_t o_cancel; /* cancel flag */
2332 #define SLAP_CANCEL_NONE 0x00
2333 #define SLAP_CANCEL_REQ 0x01
2334 #define SLAP_CANCEL_ACK 0x02
2335 #define SLAP_CANCEL_DONE 0x03
2337 GroupAssertion *o_groups;
2338 char o_do_not_cache; /* don't cache groups from this op */
2339 char o_is_auth_check; /* authorization in progress */
2341 #define SLAP_CONTROL_NONE 0
2342 #define SLAP_CONTROL_IGNORED 1
2343 #define SLAP_CONTROL_NONCRITICAL 2
2344 #define SLAP_CONTROL_CRITICAL 3
2345 #define SLAP_CONTROL_MASK 3
2347 /* spare bits for simple flags */
2348 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2349 #define SLAP_CONTROL_DATA0 0x10
2350 #define SLAP_CONTROL_DATA1 0x20
2351 #define SLAP_CONTROL_DATA2 0x40
2352 #define SLAP_CONTROL_DATA3 0x80
2355 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2357 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2358 void **o_controls; /* per-control state */
2360 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2361 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2363 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2364 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2365 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2367 #define get_subentries(op) _SCM((op)->o_subentries)
2368 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2370 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2371 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2373 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2374 #define get_assert(op) ((int)(op)->o_assert)
2375 #define o_assertion o_controls[slap_cids.sc_assert]
2376 #define get_assertion(op) ((op)->o_assertion)
2378 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2379 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2381 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2382 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2383 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2385 #define get_permissiveModify(op) (0)
2388 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2389 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2390 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2392 #define get_domainScope(op) (0)
2395 #ifdef LDAP_CONTROL_X_TREE_DELETE
2396 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2397 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2399 #define get_treeDelete(op) (0)
2402 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2403 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2405 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2406 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2408 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2409 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2410 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2413 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2416 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2418 AuthorizationInformation o_authz;
2420 BerElement *o_ber; /* ber of the request */
2421 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2422 slap_callback *o_callback; /* callback pointers */
2423 LDAPControl **o_ctrls; /* controls */
2425 void *o_private; /* anything the backend needs */
2427 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2430 int o_delete_glue_parent;
2433 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2435 #define send_ldap_error( op, rs, err, text ) do { \
2436 (rs)->sr_err = err; (rs)->sr_text = text; \
2437 (op->o_conn->c_send_ldap_result)( op, rs ); \
2439 #define send_ldap_discon( op, rs, err, text ) do { \
2440 (rs)->sr_err = err; (rs)->sr_text = text; \
2441 send_ldap_disconnect( op, rs ); \
2444 typedef void (SEND_LDAP_RESULT)(
2445 struct slap_op *op, struct slap_rep *rs);
2446 typedef int (SEND_SEARCH_ENTRY)(
2447 struct slap_op *op, struct slap_rep *rs);
2448 typedef int (SEND_SEARCH_REFERENCE)(
2449 struct slap_op *op, struct slap_rep *rs);
2450 typedef void (SEND_LDAP_EXTENDED)(
2451 struct slap_op *op, struct slap_rep *rs);
2452 typedef void (SEND_LDAP_INTERMEDIATE)(
2453 struct slap_op *op, struct slap_rep *rs);
2455 #define send_ldap_result( op, rs ) \
2456 ((op)->o_conn->c_send_ldap_result)( op, rs )
2457 #define send_search_entry( op, rs ) \
2458 ((op)->o_conn->c_send_search_entry)( op, rs )
2459 #define send_search_reference( op, rs ) \
2460 ((op)->o_conn->c_send_search_reference)( op, rs )
2461 #define send_ldap_extended( op, rs ) \
2462 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2463 #define send_ldap_intermediate( op, rs ) \
2464 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2466 typedef struct slap_listener Listener;
2469 * represents a connection from an ldap client
2471 typedef struct slap_conn {
2472 int c_struct_state; /* structure management state */
2473 int c_conn_state; /* connection state */
2474 int c_conn_idx; /* slot in connections array */
2476 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2477 Sockbuf *c_sb; /* ber connection stuff */
2479 /* only can be changed by connect_init */
2480 time_t c_starttime; /* when the connection was opened */
2481 time_t c_activitytime; /* when the connection was last used */
2482 unsigned long c_connid; /* id of this connection for stats*/
2484 struct berval c_peer_domain; /* DNS name of client */
2485 struct berval c_peer_name; /* peer name (trans=addr:port) */
2486 Listener *c_listener;
2487 #define c_listener_url c_listener->sl_url /* listener URL */
2488 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2490 /* only can be changed by binding thread */
2491 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2492 struct berval c_sasl_bind_mech; /* mech in progress */
2493 struct berval c_sasl_dn; /* temporary storage */
2494 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2496 /* authorization backend */
2497 Backend *c_authz_backend;
2499 AuthorizationInformation c_authz;
2501 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2503 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2504 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2506 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2507 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2509 BerElement *c_currentber; /* ber we're attempting to read */
2510 int c_writewaiter; /* true if writer is waiting */
2512 #define CONN_IS_TLS 1
2513 #define CONN_IS_UDP 2
2514 #define CONN_IS_CLIENT 3
2516 #ifdef LDAP_CONNECTIONLESS
2517 int c_is_udp; /* true if this is (C)LDAP over UDP */
2520 int c_is_tls; /* true if this LDAP over raw TLS */
2521 int c_needs_tls_accept; /* true if SSL_accept should be called */
2523 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2524 int c_sasl_done; /* SASL completed once */
2525 void *c_sasl_authctx; /* SASL authentication context */
2526 void *c_sasl_sockctx; /* SASL security layer context */
2527 void *c_sasl_extra; /* SASL session extra stuff */
2528 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2530 PagedResultsState c_pagedresults_state; /* paged result state */
2532 long c_n_ops_received; /* num of ops received (next op_id) */
2533 long c_n_ops_executing; /* num of ops currently executing */
2534 long c_n_ops_pending; /* num of ops pending execution */
2535 long c_n_ops_completed; /* num of ops completed */
2537 long c_n_get; /* num of get calls */
2538 long c_n_read; /* num of read calls */
2539 long c_n_write; /* num of write calls */
2541 void *c_pb; /* Netscape plugin */
2542 void *c_extensions; /* Netscape plugin */
2545 * Client connection handling
2547 ldap_pvt_thread_start_t *c_clientfunc;
2551 * These are the "callbacks" that are available for back-ends to
2552 * supply data back to connected clients that are connected
2553 * through the "front-end".
2555 SEND_LDAP_RESULT *c_send_ldap_result;
2556 SEND_SEARCH_ENTRY *c_send_search_entry;
2557 SEND_SEARCH_REFERENCE *c_send_search_reference;
2558 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2559 #ifdef LDAP_RES_INTERMEDIATE
2560 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2565 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2566 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2568 if ( ldap_debug & (level) ) \
2569 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2570 if ( ldap_syslog & (level) ) \
2571 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2574 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2575 #elif defined(LDAP_DEBUG)
2576 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2578 if ( ldap_debug & (level) ) \
2579 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2581 #define StatslogTest( level ) (ldap_debug & (level))
2583 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2584 #define StatslogTest( level ) (0)
2588 * listener; need to access it from monitor backend
2590 struct slap_listener {
2591 struct berval sl_url;
2592 struct berval sl_name;
2597 #ifdef LDAP_CONNECTIONLESS
2598 int sl_is_udp; /* UDP listener is also data port */
2600 int sl_is_mute; /* Listening is temporarily disabled */
2603 #define sl_addr sl_sa.sa_in_addr
2606 #ifdef SLAPD_MONITOR
2623 #endif /* SLAPD_MONITOR */
2625 typedef struct slap_counters_t {
2626 ldap_pvt_thread_mutex_t sc_sent_mutex;
2627 ldap_pvt_mp_t sc_bytes;
2628 ldap_pvt_mp_t sc_pdu;
2629 ldap_pvt_mp_t sc_entries;
2630 ldap_pvt_mp_t sc_refs;
2632 ldap_pvt_thread_mutex_t sc_ops_mutex;
2633 ldap_pvt_mp_t sc_ops_completed;
2634 ldap_pvt_mp_t sc_ops_initiated;
2635 #ifdef SLAPD_MONITOR
2636 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2637 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2638 #endif /* SLAPD_MONITOR */
2642 * Better know these all around slapd
2644 #define SLAP_LDAPDN_PRETTY 0x1
2645 #define SLAP_LDAPDN_MAXLEN 8192
2647 /* number of response controls supported */
2648 #define SLAP_MAX_RESPONSE_CONTROLS 6
2651 #define SLAP_CTRL_HIDE 0x00000000U
2653 #define SLAP_CTRL_HIDE 0x80000000U
2656 #define SLAP_CTRL_GLOBAL 0x00800000U
2657 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2659 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2660 #define SLAP_CTRL_ABANDON 0x00000001U
2661 #define SLAP_CTRL_ADD 0x00002002U
2662 #define SLAP_CTRL_BIND 0x00000004U
2663 #define SLAP_CTRL_COMPARE 0x00001008U
2664 #define SLAP_CTRL_DELETE 0x00002010U
2665 #define SLAP_CTRL_MODIFY 0x00002020U
2666 #define SLAP_CTRL_RENAME 0x00002040U
2667 #define SLAP_CTRL_SEARCH 0x00001080U
2668 #define SLAP_CTRL_UNBIND 0x00000100U
2670 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2671 #define SLAP_CTRL_UPDATE \
2672 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2673 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2675 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2678 LDAPControl *ctrl ));
2680 #define SLAP_SLAB_SIZE (1024*1024)
2681 #define SLAP_SLAB_STACK 1
2682 #define SLAP_SLAB_SOBLOCK 64
2684 #define SLAP_ZONE_ALLOC 1
2685 #undef SLAP_ZONE_ALLOC
2687 #ifdef LDAP_COMP_MATCH
2689 * Extensible Filter Definition
2691 * MatchingRuleAssertion := SEQUENCE {
2692 * matchingRule [1] MatchingRuleId OPTIONAL,
2693 * type [2] AttributeDescription OPTIONAL,
2694 * matchValue [3] AssertionValue,
2695 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2697 * Following ComponentFilter is contained in matchValue
2699 * ComponentAssertion ::= SEQUENCE {
2700 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2701 * useDefaultValues BOOLEAN DEFAULT TRUE,
2702 * rule MATCHING-RULE.&id,
2703 * value MATCHING-RULE.&AssertionType }
2705 * ComponentFilter ::= CHOICE {
2706 * item [0] ComponentAssertion,
2707 * and [1] SEQUENCE OF ComponentFilter,
2708 * or [2] SEQUENCE OF ComponentFilter,
2709 * not [3] ComponentFilter }
2712 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2713 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2714 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2715 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2716 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2717 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2718 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2719 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2720 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2722 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2723 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2724 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2725 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2726 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2728 typedef struct slap_component_id {
2730 struct slap_component_id *ci_next;
2732 union comp_id_value{
2733 BerValue ci_identifier;
2734 ber_int_t ci_from_beginning;
2736 ber_int_t ci_from_end;
2737 ber_int_t ci_content;
2738 BerValue ci_select_value;
2743 typedef struct slap_component_reference {
2744 ComponentId *cr_list;
2745 ComponentId *cr_curr;
2746 struct berval cr_string;
2748 /* Component Indexing */
2750 slap_mask_t cr_indexmask;
2751 AttributeDescription* cr_ad;
2753 struct slap_component_reference* cr_next;
2754 } ComponentReference;
2756 typedef struct slap_component_assertion {
2757 ComponentReference *ca_comp_ref;
2758 ber_int_t ca_use_def;
2759 MatchingRule *ca_ma_rule;
2760 struct berval ca_ma_value;
2761 ComponentData ca_comp_data; /* componentized assertion */
2762 struct slap_component_filter *ca_cf;
2763 MatchingRuleAssertion *ca_mra;
2764 } ComponentAssertion;
2766 typedef struct slap_component_filter {
2767 ber_tag_t cf_choice;
2769 ber_int_t cf_un_result;
2770 ComponentAssertion *cf_un_ca;
2771 struct slap_component_filter *cf_un_complex;
2774 #define cf_ca cf_un.cf_un_ca
2775 #define cf_result cf_un.cf_un_result
2776 #define cf_and cf_un.cf_un_complex
2777 #define cf_or cf_un.cf_un_complex
2778 #define cf_not cf_un.cf_un_complex
2779 #define cf_any cf_un.cf_un_complex
2781 struct slap_component_filter *cf_next;
2784 typedef struct slap_component_assertion_value {
2788 } ComponentAssertionValue;
2790 typedef int encoder_func LDAP_P((
2794 struct slap_component_syntax_info;
2796 typedef int gser_decoder_func LDAP_P((
2799 struct slap_component_syntax_info** comp_syn_info,
2803 typedef int comp_free_func LDAP_P((
2806 typedef int ber_decoder_func LDAP_P((
2811 struct slap_component_syntax_info* comp_syn_info,
2815 typedef int ber_tag_decoder_func LDAP_P((
2818 struct slap_component_syntax_info* comp_syn_info,
2822 typedef void* extract_component_from_id_func LDAP_P((
2824 ComponentReference* cr,
2827 typedef void* convert_attr_to_comp_func LDAP_P ((
2830 struct berval* bv ));
2832 typedef void* alloc_nibble_func LDAP_P ((
2834 int increment_size ));
2836 typedef void free_nibble_func LDAP_P ((
2839 struct slap_component_syntax_info;
2840 typedef void convert_assert_to_comp_func LDAP_P ((
2842 struct slap_component_syntax_info* csi_attr,
2844 struct slap_component_syntax_info** csi,
2848 typedef int convert_asn_to_ldap_func LDAP_P ((
2849 struct slap_component_syntax_info* csi,
2850 struct berval *bv ));
2852 typedef void free_component_func LDAP_P ((
2855 typedef int test_component_func LDAP_P ((
2857 void* assert_mem_op,
2858 struct slap_component_syntax_info* csi,
2859 struct slap_component_assertion* ca));
2861 typedef void* test_membership_func LDAP_P ((
2864 typedef void* get_component_info_func LDAP_P ((
2867 struct slap_component_syntax_info;
2869 typedef int component_encoder_func LDAP_P ((
2871 struct slap_component_syntax_info* csi,
2872 struct berval* nvals ));
2874 typedef int allcomponent_matching_func LDAP_P((
2876 struct slap_component_syntax_info* comp1,
2877 struct slap_component_syntax_info* comp));
2879 typedef struct slap_component_desc {
2880 /* Don't change the order of following four fields */
2882 AttributeType *cd_comp_type;
2883 struct berval cd_ad_type;/* ad_type, ad_cname */
2884 struct berval cd_ad_cname;/* ad_type, ad_cname */
2885 unsigned cd_flags; /*ad_flags*/
2888 encoder_func *cd_ldap_encoder;
2889 encoder_func *cd_gser_encoder;
2890 encoder_func *cd_ber_encoder;
2891 gser_decoder_func *cd_gser_decoder;
2892 ber_decoder_func *cd_ber_decoder;
2893 comp_free_func *cd_free;
2894 extract_component_from_id_func* cd_extract_i;
2895 allcomponent_matching_func *cd_all_match;
2898 typedef struct slap_component_syntax_info {
2900 ComponentDesc* csi_comp_desc;
2901 } ComponentSyntaxInfo;
2905 /* slab heap data structures */
2907 struct slab_object {
2910 LDAP_LIST_ENTRY(slab_object) so_link;
2919 unsigned char **sh_map;
2920 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2921 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2924 #ifdef SLAP_ZONE_ALLOC
2925 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2926 #define SLAP_ZONE_SHIFT 19
2927 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2928 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2929 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2930 #define SLAP_ZONE_ZOBLOCK 256
2932 struct zone_object {
2937 LDAP_LIST_ENTRY(zone_object) zo_link;
2940 struct zone_latency_history {
2942 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2953 ldap_pvt_thread_rdwr_t *zh_znlock;
2954 Avlnode *zh_zonetree;
2955 unsigned char ***zh_maps;
2957 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2958 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2959 ldap_pvt_thread_mutex_t zh_mutex;
2960 ldap_pvt_thread_rdwr_t zh_lock;
2961 double zh_ema_latency;
2962 unsigned long zh_ema_samples;
2963 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2964 zh_latency_history_queue;
2965 int zh_latency_history_qlen;
2966 int zh_latency_jump;
2971 #define SLAP_BACKEND_INIT_MODULE(b) \
2972 static BackendInfo bi; \
2974 init_module( int argc, char *argv[] ) \
2977 bi.bi_init = b ## _back_initialize; \
2978 backend_add( &bi ); \
2984 #include "proto-slap.h"
2986 #endif /* _SLAP_H_ */