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_LIGHTWEIGHT_DISPATCHER /* experimental slapd architecture */
64 #define SLAP_MULTI_CONN_ARRAY
65 #ifdef LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL
66 #define SLAP_SEM_LOAD_CONTROL
67 #endif /* LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL */
69 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
70 #define SLAP_ACL_HONOR_MANAGE /* not yet implemented */
72 #define SLAP_OVERLAY_ACCESS
73 #define LDAP_COMP_MATCH
74 #define LDAP_DYNAMIC_OBJECTS
75 #define LDAP_SYNC_TIMESTAMP
76 #define LDAP_COLLECTIVE_ATTRIBUTES
77 #define SLAPD_CONF_UNKNOWN_BAILOUT
78 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
80 #define SLAP_ORDERED_PRETTYNORM
81 #define SLAP_AUTHZ_SYNTAX
84 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
88 #if defined(LDAP_SLAPI) && !defined(SLAP_OVERLAY_ACCESS)
89 #define SLAP_OVERLAY_ACCESS
93 * ITS#3705: bail out if unknown config directives appear in slapd.conf
95 #ifdef SLAPD_CONF_UNKNOWN_BAILOUT
96 #define SLAPD_CONF_UNKNOWN_IGNORED ""
97 #define SLAPD_DEBUG_CONFIG_ERROR LDAP_DEBUG_ANY
98 #else /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
99 #define SLAPD_CONF_UNKNOWN_IGNORED " (ignored)"
100 #define SLAPD_DEBUG_CONFIG_ERROR LDAP_DEBUG_CONFIG
101 #endif /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
104 * SLAPD Memory allocation macros
106 * Unlike ch_*() routines, these routines do not assert() upon
107 * allocation error. They are intended to be used instead of
108 * ch_*() routines where the caller has implemented proper
109 * checking for and handling of allocation errors.
111 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
113 #define SLAP_MALLOC(s) ber_memalloc((s))
114 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
115 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
116 #define SLAP_FREE(p) ber_memfree((p))
117 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
118 #define SLAP_STRDUP(s) ber_strdup((s))
119 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
122 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
125 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
126 #define SLAPD_ANONYMOUS ""
128 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
129 * This is a value used internally by the backends. It is needed to allow
130 * adding values that already exist without getting an error as required by
131 * modrdn when the new rdn was already an attribute value itself.
133 #define SLAP_MOD_SOFTADD 0x1000
135 #define MAXREMATCHES (100)
137 #define SLAP_MAX_WORKER_THREADS (16)
139 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
140 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
142 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
143 #define SLAP_CONN_MAX_PENDING_AUTH 1000
145 #define SLAP_TEXT_BUFLEN (256)
147 /* psuedo error code indicating abandoned operation */
148 #define SLAPD_ABANDON (-1024)
150 /* psuedo error code indicating disconnect */
151 #define SLAPD_DISCONNECT (-1025)
153 /* unknown config file directive */
154 #define SLAP_CONF_UNKNOWN (-1026)
156 /* We assume "C" locale, that is US-ASCII */
157 #define ASCII_SPACE(c) ( (c) == ' ' )
158 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
159 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
160 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
161 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
162 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
163 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
164 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
165 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
166 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
167 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
169 #define SLAP_NIBBLE(c) ((c)&0x0f)
170 #define SLAP_ESCAPE_CHAR ('\\')
171 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
172 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
174 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
175 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
177 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
178 /* NOTE: for consistency, this macro must only operate
179 * on normalized/pretty DN, such that ';' is never used
180 * as RDN separator, and all occurrences of ';' must be escaped */
181 #define DN_SEPARATOR(c) ((c) == ',')
182 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
183 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
184 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
186 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
187 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
188 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
189 #define OID_SEPARATOR(c) ( (c) == '.' )
190 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
192 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
193 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
195 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
196 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
198 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
200 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
201 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
202 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
203 (c) == '?' || (c) == ' ' || (c) == '=' )
204 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
206 /* must match in schema_init.c */
207 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
208 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
209 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
210 #define SLAPD_GROUP_ATTR "member"
211 #define SLAPD_GROUP_CLASS "groupOfNames"
212 #define SLAPD_ROLE_ATTR "roleOccupant"
213 #define SLAPD_ROLE_CLASS "organizationalRole"
215 #ifdef SLAPD_ACI_ENABLED
216 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
217 #endif /* SLAPD_ACI_ENABLED */
219 /* change this to "OpenLDAPset" */
220 #define SLAPD_ACI_SET_ATTR "template"
222 #define SLAPD_TOP_OID "2.5.6.0"
224 LDAP_SLAPD_V (int) slap_debug;
226 typedef unsigned long slap_mask_t;
228 /* Security Strength Factor */
229 typedef unsigned slap_ssf_t;
231 typedef struct slap_ssf_set {
233 slap_ssf_t sss_transport;
236 slap_ssf_t sss_update_ssf;
237 slap_ssf_t sss_update_transport;
238 slap_ssf_t sss_update_tls;
239 slap_ssf_t sss_update_sasl;
240 slap_ssf_t sss_simple_bind;
243 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
244 #define SLAP_GETDN_AUTHCID 2
245 #define SLAP_GETDN_AUTHZID 4
250 #define SLAP_INDEX_TYPE 0x00FFUL
251 #define SLAP_INDEX_UNDEFINED 0x0001UL
252 #define SLAP_INDEX_PRESENT 0x0002UL
253 #define SLAP_INDEX_EQUALITY 0x0004UL
254 #define SLAP_INDEX_APPROX 0x0008UL
255 #define SLAP_INDEX_SUBSTR 0x0010UL
256 #define SLAP_INDEX_EXTENDED 0x0020UL
258 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
260 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
262 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
264 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
265 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
266 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
267 #define SLAP_INDEX_SUBSTR_DEFAULT \
268 ( SLAP_INDEX_SUBSTR \
269 | SLAP_INDEX_SUBSTR_INITIAL \
270 | SLAP_INDEX_SUBSTR_ANY \
271 | SLAP_INDEX_SUBSTR_FINAL )
273 /* defaults for initial/final substring indices */
274 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
275 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
277 /* defaults for any substring indices */
278 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
279 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
281 #define SLAP_INDEX_FLAGS 0xF000UL
282 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
283 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
286 * there is a single index for each attribute. these prefixes ensure
287 * that there is no collision among keys.
289 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
290 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
291 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
292 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
293 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
294 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
296 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
297 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
298 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
299 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
300 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
303 * represents schema information for a database
306 SLAP_SCHERR_OUTOFMEM = 1,
307 SLAP_SCHERR_CLASS_NOT_FOUND,
308 SLAP_SCHERR_CLASS_BAD_USAGE,
309 SLAP_SCHERR_CLASS_BAD_SUP,
310 SLAP_SCHERR_CLASS_DUP,
311 SLAP_SCHERR_CLASS_INCONSISTENT,
312 SLAP_SCHERR_ATTR_NOT_FOUND,
313 SLAP_SCHERR_ATTR_BAD_MR,
314 SLAP_SCHERR_ATTR_BAD_USAGE,
315 SLAP_SCHERR_ATTR_BAD_SUP,
316 SLAP_SCHERR_ATTR_INCOMPLETE,
317 SLAP_SCHERR_ATTR_DUP,
318 SLAP_SCHERR_ATTR_INCONSISTENT,
319 SLAP_SCHERR_MR_NOT_FOUND,
320 SLAP_SCHERR_MR_INCOMPLETE,
322 SLAP_SCHERR_SYN_NOT_FOUND,
325 SLAP_SCHERR_NOT_SUPPORTED,
326 SLAP_SCHERR_BAD_DESCR,
329 SLAP_SCHERR_CR_BAD_STRUCT,
330 SLAP_SCHERR_CR_BAD_AUX,
331 SLAP_SCHERR_CR_BAD_AT,
336 typedef union slap_sockaddr {
337 struct sockaddr sa_addr;
338 struct sockaddr_in sa_in_addr;
340 struct sockaddr_storage sa_storage;
341 struct sockaddr_in6 sa_in6_addr;
344 struct sockaddr_un sa_un_addr;
349 extern int slap_inet4or6;
352 typedef struct slap_oid_macro {
353 struct berval som_oid;
356 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
358 LDAP_STAILQ_ENTRY(slap_oid_macro) som_next;
361 /* forward declarations */
363 struct slap_matching_rule;
365 typedef int slap_syntax_validate_func LDAP_P((
366 struct slap_syntax *syntax,
367 struct berval * in));
369 typedef int slap_syntax_transform_func LDAP_P((
370 struct slap_syntax *syntax,
375 #ifdef LDAP_COMP_MATCH
376 typedef void* slap_component_transform_func LDAP_P((
377 struct berval * in ));
378 struct ComponentDesc;
381 typedef struct slap_syntax {
383 #define ssyn_oid ssyn_syn.syn_oid
384 #define ssyn_desc ssyn_syn.syn_desc
385 #define ssyn_extensions ssyn_syn.syn_extensions
388 ber_len_t ssyn_oidlen;
389 * has been replaced by a struct berval that uses the value
390 * provided by ssyn_syn.syn_oid; a macro that expands to
391 * the bv_len field of the berval is provided for backward
392 * compatibility. CAUTION: NEVER FREE THE BERVAL
394 struct berval ssyn_bvoid;
395 #define ssyn_oidlen ssyn_bvoid.bv_len
397 unsigned int ssyn_flags;
399 #define SLAP_SYNTAX_NONE 0x0000U
400 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
401 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
402 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
404 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
406 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
409 slap_syntax_validate_func *ssyn_validate;
410 slap_syntax_transform_func *ssyn_pretty;
412 #ifdef SLAPD_BINARY_CONVERSION
413 /* convert to and from binary */
414 slap_syntax_transform_func *ssyn_ber2str;
415 slap_syntax_transform_func *ssyn_str2ber;
417 #ifdef LDAP_COMP_MATCH
418 slap_component_transform_func *ssyn_attr2comp;
419 struct ComponentDesc* ssync_comp_syntax;
422 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
425 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
426 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
427 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
428 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
429 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
431 typedef struct slap_syntax_defs_rec {
434 slap_syntax_validate_func *sd_validate;
435 slap_syntax_transform_func *sd_pretty;
436 #ifdef SLAPD_BINARY_CONVERSION
437 slap_syntax_transform_func *sd_ber2str;
438 slap_syntax_transform_func *sd_str2ber;
440 } slap_syntax_defs_rec;
442 /* X -> Y Converter */
443 typedef int slap_mr_convert_func LDAP_P((
449 typedef int slap_mr_normalize_func LDAP_P((
451 struct slap_syntax *syntax, /* NULL if in is asserted value */
452 struct slap_matching_rule *mr,
457 /* Match (compare) function */
458 typedef int slap_mr_match_func LDAP_P((
461 struct slap_syntax *syntax, /* syntax of stored value */
462 struct slap_matching_rule *mr,
463 struct berval * value,
464 void * assertValue ));
466 /* Index generation function */
467 typedef int slap_mr_indexer_func LDAP_P((
470 struct slap_syntax *syntax, /* syntax of stored value */
471 struct slap_matching_rule *mr,
472 struct berval *prefix,
477 /* Filter index function */
478 typedef int slap_mr_filter_func LDAP_P((
481 struct slap_syntax *syntax, /* syntax of stored value */
482 struct slap_matching_rule *mr,
483 struct berval *prefix,
488 typedef struct slap_matching_rule_use MatchingRuleUse;
490 typedef struct slap_matching_rule {
491 LDAPMatchingRule smr_mrule;
492 MatchingRuleUse *smr_mru;
493 /* RFC2252 string representation */
494 struct berval smr_str;
497 * ber_len_t smr_oidlen;
498 * has been replaced by a struct berval that uses the value
499 * provided by smr_mrule.mr_oid; a macro that expands to
500 * the bv_len field of the berval is provided for backward
501 * compatibility. CAUTION: NEVER FREE THE BERVAL
503 struct berval smr_bvoid;
504 #define smr_oidlen smr_bvoid.bv_len
506 slap_mask_t smr_usage;
509 #define SLAP_MR_HIDE 0x0000U
511 #define SLAP_MR_HIDE 0x8000U
514 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
516 #define SLAP_MR_TYPE_MASK 0x0F00U
517 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
518 #define SLAP_MR_USAGE 0x000FU
520 #define SLAP_MR_NONE 0x0000U
521 #define SLAP_MR_EQUALITY 0x0100U
522 #define SLAP_MR_ORDERING 0x0200U
523 #define SLAP_MR_SUBSTR 0x0400U
524 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
525 #define SLAP_MR_ORDERED_INDEX 0x1000U
526 #ifdef LDAP_COMP_MATCH
527 #define SLAP_MR_COMPONENT 0x2000U
530 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
532 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
533 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
534 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
538 * The asserted value, depending on the particular usage,
539 * is expected to conform to either the assertion syntax
540 * or the attribute syntax. In some cases, the syntax of
541 * the value is known. If so, these flags indicate which
542 * syntax the value is expected to conform to. If not,
543 * neither of these flags is set (until the syntax of the
544 * provided value is determined). If the value is of the
545 * attribute syntax, the flag is changed once a value of
546 * the assertion syntax is derived from the provided value.
548 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
549 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
550 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
552 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
553 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
554 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
555 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
557 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
558 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
560 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
563 /* either or both the asserted value or attribute value
564 * may be provided in normalized form
566 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
567 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
569 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
570 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
571 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
572 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
574 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
575 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
576 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
577 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
578 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
579 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
581 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
582 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
583 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
584 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
587 slap_mr_convert_func *smr_convert;
588 slap_mr_normalize_func *smr_normalize;
589 slap_mr_match_func *smr_match;
590 slap_mr_indexer_func *smr_indexer;
591 slap_mr_filter_func *smr_filter;
594 * null terminated array of syntaxes compatible with this syntax
595 * note: when MS_EXT is set, this MUST NOT contain the assertion
596 * syntax of the rule. When MS_EXT is not set, it MAY.
598 Syntax **smr_compat_syntaxes;
601 * For equality rules, refers to an associated approximate rule.
602 * For non-equality rules, refers to an associated equality rule.
604 struct slap_matching_rule *smr_associated;
606 #define SLAP_MR_ASSOCIATED(mr,amr) \
607 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
609 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
611 #define smr_oid smr_mrule.mr_oid
612 #define smr_names smr_mrule.mr_names
613 #define smr_desc smr_mrule.mr_desc
614 #define smr_obsolete smr_mrule.mr_obsolete
615 #define smr_syntax_oid smr_mrule.mr_syntax_oid
616 #define smr_extensions smr_mrule.mr_extensions
619 struct slap_matching_rule_use {
620 LDAPMatchingRuleUse smru_mruleuse;
621 MatchingRule *smru_mr;
622 /* RFC2252 string representation */
623 struct berval smru_str;
625 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
627 #define smru_oid smru_mruleuse.mru_oid
628 #define smru_names smru_mruleuse.mru_names
629 #define smru_desc smru_mruleuse.mru_desc
630 #define smru_obsolete smru_mruleuse.mru_obsolete
631 #define smru_applies_oids smru_mruleuse.mru_applies_oids
633 #define smru_usage smru_mr->smr_usage
634 } /* MatchingRuleUse */ ;
636 typedef struct slap_mrule_defs_rec {
638 slap_mask_t mrd_usage;
639 char ** mrd_compat_syntaxes;
640 slap_mr_convert_func * mrd_convert;
641 slap_mr_normalize_func * mrd_normalize;
642 slap_mr_match_func * mrd_match;
643 slap_mr_indexer_func * mrd_indexer;
644 slap_mr_filter_func * mrd_filter;
646 /* For equality rule, this may refer to an associated approximate rule */
647 /* For non-equality rule, this may refer to an associated equality rule */
648 char * mrd_associated;
649 } slap_mrule_defs_rec;
651 struct slap_backend_db;
655 typedef int (AttributeTypeSchemaCheckFN)(
656 struct slap_backend_db *be,
657 struct slap_entry *e,
658 struct slap_attr *attr,
660 char *textbuf, size_t textlen );
662 typedef struct slap_attribute_type {
663 LDAPAttributeType sat_atype;
664 struct berval sat_cname;
665 struct slap_attribute_type *sat_sup;
666 struct slap_attribute_type **sat_subtypes;
667 MatchingRule *sat_equality;
668 MatchingRule *sat_approx;
669 MatchingRule *sat_ordering;
670 MatchingRule *sat_substr;
673 AttributeTypeSchemaCheckFN *sat_check;
676 #define SLAP_AT_NONE 0x0000U
677 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
678 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
680 #define SLAP_AT_HIDE 0x0000U /* publish everything */
682 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
684 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
686 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
688 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
689 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
690 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
692 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
694 slap_mask_t sat_flags;
696 LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
698 #define sat_oid sat_atype.at_oid
699 #define sat_names sat_atype.at_names
700 #define sat_desc sat_atype.at_desc
701 #define sat_obsolete sat_atype.at_obsolete
702 #define sat_sup_oid sat_atype.at_sup_oid
703 #define sat_equality_oid sat_atype.at_equality_oid
704 #define sat_ordering_oid sat_atype.at_ordering_oid
705 #define sat_substr_oid sat_atype.at_substr_oid
706 #define sat_syntax_oid sat_atype.at_syntax_oid
707 #define sat_single_value sat_atype.at_single_value
708 #define sat_collective sat_atype.at_collective
709 #define sat_no_user_mod sat_atype.at_no_user_mod
710 #define sat_usage sat_atype.at_usage
711 #define sat_extensions sat_atype.at_extensions
713 struct slap_attr_desc *sat_ad;
714 ldap_pvt_thread_mutex_t sat_ad_mutex;
717 #define is_at_operational(at) ((at)->sat_usage)
718 #define is_at_single_value(at) ((at)->sat_single_value)
719 #define is_at_collective(at) ((at)->sat_collective)
720 #define is_at_obsolete(at) ((at)->sat_obsolete)
721 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
723 struct slap_object_class;
725 typedef int (ObjectClassSchemaCheckFN)(
726 struct slap_backend_db *be,
727 struct slap_entry *e,
728 struct slap_object_class *oc,
730 char *textbuf, size_t textlen );
732 typedef struct slap_object_class {
733 LDAPObjectClass soc_oclass;
734 struct berval soc_cname;
735 struct slap_object_class **soc_sups;
736 AttributeType **soc_required;
737 AttributeType **soc_allowed;
738 ObjectClassSchemaCheckFN *soc_check;
740 slap_mask_t soc_flags;
741 #define soc_oid soc_oclass.oc_oid
742 #define soc_names soc_oclass.oc_names
743 #define soc_desc soc_oclass.oc_desc
744 #define soc_obsolete soc_oclass.oc_obsolete
745 #define soc_sup_oids soc_oclass.oc_sup_oids
746 #define soc_kind soc_oclass.oc_kind
747 #define soc_at_oids_must soc_oclass.oc_at_oids_must
748 #define soc_at_oids_may soc_oclass.oc_at_oids_may
749 #define soc_extensions soc_oclass.oc_extensions
751 LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
754 #define SLAP_OCF_SET_FLAGS 0x1
755 #define SLAP_OCF_CHECK_SUP 0x2
756 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
758 #define SLAP_OC_ALIAS 0x0001
759 #define SLAP_OC_REFERRAL 0x0002
760 #define SLAP_OC_SUBENTRY 0x0004
761 #define SLAP_OC_DYNAMICOBJECT 0x0008
762 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
763 #define SLAP_OC_GLUE 0x0020
764 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
765 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
766 #define SLAP_OC__MASK 0x00FF
767 #define SLAP_OC__END 0x0100
768 #define SLAP_OC_OPERATIONAL 0x4000
770 #define SLAP_OC_HIDE 0x0000
772 #define SLAP_OC_HIDE 0x8000
774 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
779 typedef struct slap_content_rule {
780 LDAPContentRule scr_crule;
781 ObjectClass *scr_sclass;
782 ObjectClass **scr_auxiliaries; /* optional */
783 AttributeType **scr_required; /* optional */
784 AttributeType **scr_allowed; /* optional */
785 AttributeType **scr_precluded; /* optional */
786 #define scr_oid scr_crule.cr_oid
787 #define scr_names scr_crule.cr_names
788 #define scr_desc scr_crule.cr_desc
789 #define scr_obsolete scr_crule.cr_obsolete
790 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
791 #define scr_at_oids_must scr_crule.cr_at_oids_must
792 #define scr_at_oids_may scr_crule.cr_at_oids_may
793 #define scr_at_oids_not scr_crule.cr_at_oids_not
796 #define SLAP_CR_HARDCODE 0x10000U
799 LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
802 /* Represents a recognized attribute description ( type + options ). */
803 typedef struct slap_attr_desc {
804 struct slap_attr_desc *ad_next;
805 AttributeType *ad_type; /* attribute type, must be specified */
806 struct berval ad_cname; /* canonical name, must be specified */
807 struct berval ad_tags; /* empty if no tagging options */
809 #define SLAP_DESC_NONE 0x00U
810 #define SLAP_DESC_BINARY 0x01U
811 #define SLAP_DESC_TAG_RANGE 0x80U
812 } AttributeDescription;
814 /* flags to slap_*2undef_ad to register undefined (0, the default)
815 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
816 * SLAP_AD_NOINSERT is to lookup without insert */
817 #define SLAP_AD_UNDEF 0x00U
818 #define SLAP_AD_PROXIED 0x01U
819 #define SLAP_AD_NOINSERT 0x02U
821 typedef struct slap_attr_name {
822 struct berval an_name;
823 AttributeDescription *an_desc;
828 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
829 #define slap_ad_is_tag_range(ad) \
830 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
831 #define slap_ad_is_binary(ad) \
832 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
835 * pointers to schema elements used internally
837 struct slap_internal_schema {
839 ObjectClass *si_oc_top;
840 ObjectClass *si_oc_extensibleObject;
841 ObjectClass *si_oc_alias;
842 ObjectClass *si_oc_referral;
843 ObjectClass *si_oc_rootdse;
844 ObjectClass *si_oc_subentry;
845 ObjectClass *si_oc_subschema;
846 ObjectClass *si_oc_collectiveAttributeSubentry;
847 ObjectClass *si_oc_dynamicObject;
849 ObjectClass *si_oc_glue;
850 ObjectClass *si_oc_syncConsumerSubentry;
851 ObjectClass *si_oc_syncProviderSubentry;
853 /* objectClass attribute descriptions */
854 AttributeDescription *si_ad_objectClass;
856 /* operational attribute descriptions */
857 AttributeDescription *si_ad_structuralObjectClass;
858 AttributeDescription *si_ad_creatorsName;
859 AttributeDescription *si_ad_createTimestamp;
860 AttributeDescription *si_ad_modifiersName;
861 AttributeDescription *si_ad_modifyTimestamp;
862 AttributeDescription *si_ad_hasSubordinates;
863 AttributeDescription *si_ad_subschemaSubentry;
864 AttributeDescription *si_ad_collectiveSubentries;
865 AttributeDescription *si_ad_collectiveExclusions;
866 AttributeDescription *si_ad_entryDN;
867 AttributeDescription *si_ad_entryUUID;
868 AttributeDescription *si_ad_entryCSN;
869 AttributeDescription *si_ad_namingCSN;
871 AttributeDescription *si_ad_dseType;
872 AttributeDescription *si_ad_syncreplCookie;
873 AttributeDescription *si_ad_syncTimestamp;
874 AttributeDescription *si_ad_contextCSN;
876 /* root DSE attribute descriptions */
877 AttributeDescription *si_ad_altServer;
878 AttributeDescription *si_ad_namingContexts;
879 AttributeDescription *si_ad_supportedControl;
880 AttributeDescription *si_ad_supportedExtension;
881 AttributeDescription *si_ad_supportedLDAPVersion;
882 AttributeDescription *si_ad_supportedSASLMechanisms;
883 AttributeDescription *si_ad_supportedFeatures;
884 AttributeDescription *si_ad_monitorContext;
885 AttributeDescription *si_ad_vendorName;
886 AttributeDescription *si_ad_vendorVersion;
887 AttributeDescription *si_ad_configContext;
889 /* subentry attribute descriptions */
890 AttributeDescription *si_ad_administrativeRole;
891 AttributeDescription *si_ad_subtreeSpecification;
893 /* subschema subentry attribute descriptions */
894 AttributeDescription *si_ad_attributeTypes;
895 AttributeDescription *si_ad_ditContentRules;
896 AttributeDescription *si_ad_ditStructureRules;
897 AttributeDescription *si_ad_ldapSyntaxes;
898 AttributeDescription *si_ad_matchingRules;
899 AttributeDescription *si_ad_matchingRuleUse;
900 AttributeDescription *si_ad_nameForms;
901 AttributeDescription *si_ad_objectClasses;
903 /* Aliases & Referrals */
904 AttributeDescription *si_ad_aliasedObjectName;
905 AttributeDescription *si_ad_ref;
907 /* Access Control Internals */
908 AttributeDescription *si_ad_entry;
909 AttributeDescription *si_ad_children;
910 AttributeDescription *si_ad_saslAuthzTo;
911 AttributeDescription *si_ad_saslAuthzFrom;
913 /* dynamic entries */
914 AttributeDescription *si_ad_entryTtl;
915 AttributeDescription *si_ad_dynamicSubtrees;
917 /* Other attributes descriptions */
918 AttributeDescription *si_ad_distinguishedName;
919 AttributeDescription *si_ad_name;
920 AttributeDescription *si_ad_cn;
921 AttributeDescription *si_ad_uid;
922 AttributeDescription *si_ad_uidNumber;
923 AttributeDescription *si_ad_gidNumber;
924 AttributeDescription *si_ad_userPassword;
925 AttributeDescription *si_ad_labeledURI;
926 #ifdef SLAPD_AUTHPASSWD
927 AttributeDescription *si_ad_authPassword;
928 AttributeDescription *si_ad_authPasswordSchemes;
930 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
931 AttributeDescription *si_ad_krbName;
933 AttributeDescription *si_ad_description;
934 AttributeDescription *si_ad_seeAlso;
936 /* Undefined Attribute Type */
937 AttributeType *si_at_undefined;
939 /* "Proxied" Attribute Type */
940 AttributeType *si_at_proxied;
943 MatchingRule *si_mr_distinguishedNameMatch;
944 MatchingRule *si_mr_dnSubtreeMatch;
945 MatchingRule *si_mr_dnOneLevelMatch;
946 MatchingRule *si_mr_dnSubordinateMatch;
947 MatchingRule *si_mr_dnSuperiorMatch;
948 MatchingRule *si_mr_caseExactMatch;
949 MatchingRule *si_mr_caseExactSubstringsMatch;
950 MatchingRule *si_mr_caseExactIA5Match;
951 MatchingRule *si_mr_integerMatch;
952 MatchingRule *si_mr_integerFirstComponentMatch;
953 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
956 Syntax *si_syn_directoryString;
957 Syntax *si_syn_distinguishedName;
958 Syntax *si_syn_integer;
959 Syntax *si_syn_octetString;
961 /* Schema Syntaxes */
962 Syntax *si_syn_attributeTypeDesc;
963 Syntax *si_syn_ditContentRuleDesc;
964 Syntax *si_syn_ditStructureRuleDesc;
965 Syntax *si_syn_ldapSyntaxDesc;
966 Syntax *si_syn_matchingRuleDesc;
967 Syntax *si_syn_matchingRuleUseDesc;
968 Syntax *si_syn_nameFormDesc;
969 Syntax *si_syn_objectClassDesc;
972 typedef struct slap_attr_assertion {
973 AttributeDescription *aa_desc;
974 struct berval aa_value;
975 #ifdef LDAP_COMP_MATCH
976 struct slap_component_filter *aa_cf;/* for attribute aliasing */
978 } AttributeAssertion;
980 typedef struct slap_ss_assertion {
981 AttributeDescription *sa_desc;
982 struct berval sa_initial;
983 struct berval *sa_any;
984 struct berval sa_final;
985 } SubstringsAssertion;
987 #ifdef LDAP_COMP_MATCH
988 struct slap_component_filter;
991 typedef struct slap_mr_assertion {
992 MatchingRule *ma_rule; /* optional */
993 struct berval ma_rule_text; /* optional */
994 AttributeDescription *ma_desc; /* optional */
995 int ma_dnattrs; /* boolean */
996 struct berval ma_value; /* required */
997 #ifdef LDAP_COMP_MATCH
998 struct slap_component_filter* ma_cf; /* component filter */
1000 } MatchingRuleAssertion;
1003 * represents a search filter
1005 typedef struct slap_filter {
1006 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
1007 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
1008 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
1009 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
1010 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
1013 /* precomputed result */
1014 ber_int_t f_un_result;
1017 struct berval *f_un_dn;
1020 AttributeDescription *f_un_desc;
1022 /* simple value assertion */
1023 AttributeAssertion *f_un_ava;
1025 /* substring assertion */
1026 SubstringsAssertion *f_un_ssa;
1028 /* matching rule assertion */
1029 MatchingRuleAssertion *f_un_mra;
1031 #define f_dn f_un.f_un_dn
1032 #define f_desc f_un.f_un_desc
1033 #define f_ava f_un.f_un_ava
1034 #define f_av_desc f_un.f_un_ava->aa_desc
1035 #define f_av_value f_un.f_un_ava->aa_value
1036 #define f_sub f_un.f_un_ssa
1037 #define f_sub_desc f_un.f_un_ssa->sa_desc
1038 #define f_sub_initial f_un.f_un_ssa->sa_initial
1039 #define f_sub_any f_un.f_un_ssa->sa_any
1040 #define f_sub_final f_un.f_un_ssa->sa_final
1041 #define f_mra f_un.f_un_mra
1042 #define f_mr_rule f_un.f_un_mra->ma_rule
1043 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1044 #define f_mr_desc f_un.f_un_mra->ma_desc
1045 #define f_mr_value f_un.f_un_mra->ma_value
1046 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1049 struct slap_filter *f_un_complex;
1052 #define f_result f_un.f_un_result
1053 #define f_and f_un.f_un_complex
1054 #define f_or f_un.f_un_complex
1055 #define f_not f_un.f_un_complex
1056 #define f_list f_un.f_un_complex
1058 struct slap_filter *f_next;
1061 /* compare routines can return undefined */
1062 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1064 typedef struct slap_valuesreturnfilter {
1065 ber_tag_t vrf_choice;
1068 /* precomputed result */
1069 ber_int_t vrf_un_result;
1075 AttributeDescription *vrf_un_desc;
1077 /* simple value assertion */
1078 AttributeAssertion *vrf_un_ava;
1080 /* substring assertion */
1081 SubstringsAssertion *vrf_un_ssa;
1083 /* matching rule assertion */
1084 MatchingRuleAssertion *vrf_un_mra;
1086 #define vrf_result vrf_un.vrf_un_result
1087 #define vrf_dn vrf_un.vrf_un_dn
1088 #define vrf_desc vrf_un.vrf_un_desc
1089 #define vrf_ava vrf_un.vrf_un_ava
1090 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1091 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1092 #define vrf_ssa vrf_un.vrf_un_ssa
1093 #define vrf_sub vrf_un.vrf_un_ssa
1094 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1095 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1096 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1097 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1098 #define vrf_mra vrf_un.vrf_un_mra
1099 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1100 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1101 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1102 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1103 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1108 struct slap_valuesreturnfilter *vrf_next;
1109 } ValuesReturnFilter;
1111 #ifdef LDAP_COMP_MATCH
1112 struct slap_component_syntax_info;
1113 typedef struct slap_component_data {
1114 void* cd_mem_op;/* nibble memory handler */
1115 struct slap_component_syntax_info** cd_tree;/* component tree */
1120 * represents an attribute (description + values)
1122 typedef struct slap_attr {
1123 AttributeDescription *a_desc;
1124 BerVarray a_vals; /* preserved values */
1125 BerVarray a_nvals; /* normalized values */
1126 #ifdef LDAP_COMP_MATCH
1127 ComponentData *a_comp_data; /* component values */
1129 struct slap_attr *a_next;
1131 #define SLAP_ATTR_IXADD 0x1U
1132 #define SLAP_ATTR_IXDEL 0x2U
1137 * the id used in the indexes to refer to an entry
1139 typedef unsigned long ID;
1140 #define NOID ((ID)~0)
1143 * represents an entry in core
1145 typedef struct slap_entry {
1147 * The ID field should only be changed before entry is
1148 * inserted into a cache. The ID value is backend
1153 struct berval e_name; /* name (DN) of this entry */
1154 struct berval e_nname; /* normalized name (DN) of this entry */
1156 /* for migration purposes */
1157 #define e_dn e_name.bv_val
1158 #define e_ndn e_nname.bv_val
1160 Attribute *e_attrs; /* list of attributes + values */
1162 slap_mask_t e_ocflags;
1164 struct berval e_bv; /* For entry_encode/entry_decode */
1166 /* for use by the backend for any purpose */
1171 * A list of LDAPMods
1173 typedef struct slap_mod {
1176 /* Set for internal mods, will bypass ACL checks. Only needed when
1177 * running as non-root user, for user modifiable attributes.
1179 #define SLAP_MOD_INTERNAL 0x01
1180 #define SLAP_MOD_MANAGING 0x02
1182 AttributeDescription *sm_desc;
1183 struct berval sm_type;
1184 BerVarray sm_values;
1185 BerVarray sm_nvalues;
1188 typedef struct slap_mod_list {
1189 Modification sml_mod;
1190 #define sml_op sml_mod.sm_op
1191 #define sml_flags sml_mod.sm_flags
1192 #define sml_desc sml_mod.sm_desc
1193 #define sml_type sml_mod.sm_type
1194 #define sml_values sml_mod.sm_values
1195 #define sml_nvalues sml_mod.sm_nvalues
1196 struct slap_mod_list *sml_next;
1199 typedef struct slap_ldap_modlist {
1201 struct slap_ldap_modlist *ml_next;
1202 #define ml_op ml_mod.mod_op
1203 #define ml_type ml_mod.mod_type
1204 #define ml_values ml_mod.mod_values
1208 * represents an access control list
1210 typedef enum slap_access_e {
1211 ACL_INVALID_ACCESS = -1,
1221 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1224 /* ACL level mask and modifiers */
1225 ACL_LEVEL_MASK = 0x000f,
1226 ACL_QUALIFIER1 = 0x0100,
1227 ACL_QUALIFIER2 = 0x0200,
1228 ACL_QUALIFIER3 = 0x0400,
1229 ACL_QUALIFIER4 = 0x0800,
1230 ACL_QUALIFIER_MASK = 0x0f00,
1232 /* write granularity */
1233 ACL_WADD = ACL_WRITE|ACL_QUALIFIER1,
1234 ACL_WDEL = ACL_WRITE|ACL_QUALIFIER2
1237 typedef enum slap_control_e {
1238 ACL_INVALID_CONTROL = 0,
1244 typedef enum slap_style_e {
1245 ACL_STYLE_REGEX = 0,
1253 ACL_STYLE_ANONYMOUS,
1260 typedef struct slap_authz_info {
1261 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1262 struct berval sai_mech; /* SASL Mechanism */
1263 struct berval sai_dn; /* DN for reporting purposes */
1264 struct berval sai_ndn; /* Normalized DN */
1266 /* Security Strength Factors */
1267 slap_ssf_t sai_ssf; /* Overall SSF */
1268 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1269 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1270 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1271 } AuthorizationInformation;
1278 * "dynamic" ACL infrastructure (for ACIs and more)
1280 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1281 const char *opts, slap_style_t, const char *, void **privp ));
1282 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1283 typedef int (slap_dynacl_mask) LDAP_P((
1287 AttributeDescription *desc,
1290 regmatch_t *matches,
1291 slap_access_t *grant,
1292 slap_access_t *deny ));
1293 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1295 typedef struct slap_dynacl_t {
1297 slap_dynacl_parse *da_parse;
1298 slap_dynacl_unparse *da_unparse;
1299 slap_dynacl_mask *da_mask;
1300 slap_dynacl_destroy *da_destroy;
1303 struct slap_dynacl_t *da_next;
1305 #endif /* SLAP_DYNACL */
1307 /* the DN portion of the "by" part */
1308 typedef struct slap_dn_access {
1310 AuthorizationInformation a_dnauthz;
1311 #define a_pat a_dnauthz.sai_dn
1313 slap_style_t a_style;
1316 AttributeDescription *a_at;
1322 typedef struct slap_access {
1323 slap_control_t a_type;
1325 /* strip qualifiers */
1326 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1327 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1329 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1331 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1332 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1333 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1334 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1335 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1336 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1337 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1338 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1339 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1340 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1342 /* NOTE: always use the highest level; current: 0x00ffUL */
1343 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1346 #define ACL_PRIV_LEVEL 0x1000UL
1347 #define ACL_PRIV_ADDITIVE 0x2000UL
1348 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1351 #define ACL_PRIV_INVALID 0x0UL
1353 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1354 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1355 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1356 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1358 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1359 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1361 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1363 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1365 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1366 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1367 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1369 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1370 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1371 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1372 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1373 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1374 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1375 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1376 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1377 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1378 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1380 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1381 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1382 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1383 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1384 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1385 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1386 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1387 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1388 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1389 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1390 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1392 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1393 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1394 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1395 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1396 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1397 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1398 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1399 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1400 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1401 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1403 slap_mask_t a_access_mask;
1406 slap_dn_access a_dn;
1407 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1408 #define a_dn_at a_dn.a_at
1409 #define a_dn_self a_dn.a_self
1411 /* real DN pattern */
1412 slap_dn_access a_realdn;
1413 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1414 #define a_realdn_at a_realdn.a_at
1415 #define a_realdn_self a_realdn.a_self
1417 /* used for ssf stuff
1418 * NOTE: the ssf stuff in a_realdn is ignored */
1419 #define a_authz a_dn.a_dnauthz
1421 /* connection related stuff */
1422 slap_style_t a_peername_style;
1423 struct berval a_peername_pat;
1424 unsigned long a_peername_addr,
1426 int a_peername_port;
1428 slap_style_t a_sockname_style;
1429 struct berval a_sockname_pat;
1431 slap_style_t a_domain_style;
1432 struct berval a_domain_pat;
1433 int a_domain_expand;
1435 slap_style_t a_sockurl_style;
1436 struct berval a_sockurl_pat;
1437 slap_style_t a_set_style;
1438 struct berval a_set_pat;
1441 slap_dynacl_t *a_dynacl;
1442 #else /* ! SLAP_DYNACL */
1443 #ifdef SLAPD_ACI_ENABLED
1444 /* NOTE: ACIs have been moved under the "dynacl" interface,
1445 * which is currently built only when LDAP_DEVEL is defined.
1447 * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1448 * is required to enable ACI support.
1450 AttributeDescription *a_aci_at;
1451 #endif /* SLAPD_ACI_ENABLED */
1452 #endif /* SLAP_DYNACL */
1455 slap_style_t a_group_style;
1456 struct berval a_group_pat;
1457 ObjectClass *a_group_oc;
1458 AttributeDescription *a_group_at;
1460 struct slap_access *a_next;
1464 typedef struct slap_acl {
1465 /* "to" part: the entries this acl applies to */
1467 slap_style_t acl_dn_style;
1469 struct berval acl_dn_pat;
1470 AttributeName *acl_attrs;
1471 MatchingRule *acl_attrval_mr;
1472 slap_style_t acl_attrval_style;
1473 regex_t acl_attrval_re;
1474 struct berval acl_attrval;
1476 /* "by" part: list of who has what access to the entries */
1479 struct slap_acl *acl_next;
1482 typedef struct slap_acl_state {
1483 unsigned as_recorded;
1484 #define ACL_STATE_NOT_RECORDED 0x0
1485 #define ACL_STATE_RECORDED_VD 0x1
1486 #define ACL_STATE_RECORDED_NV 0x2
1487 #define ACL_STATE_RECORDED 0x3
1490 AccessControl *as_vd_acl;
1491 AccessControl *as_vi_acl;
1492 slap_mask_t as_vd_acl_mask;
1493 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1494 int as_vd_acl_count;
1496 Access *as_vd_access;
1497 int as_vd_access_count;
1500 AttributeDescription *as_vd_ad;
1501 } AccessControlState;
1502 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1503 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1505 #ifdef SLAPD_ACI_ENABLED
1506 typedef enum slap_aci_scope_t {
1507 SLAP_ACI_SCOPE_ENTRY = 0x1,
1508 SLAP_ACI_SCOPE_CHILDREN = 0x2,
1509 SLAP_ACI_SCOPE_SUBTREE = ( SLAP_ACI_SCOPE_ENTRY | SLAP_ACI_SCOPE_CHILDREN )
1511 #endif /* SLAPD_ACI_ENABLED */
1515 * represents a backend
1518 typedef struct slap_backend_info BackendInfo; /* per backend type */
1519 typedef struct slap_backend_db BackendDB; /* per backend database */
1520 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1521 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1523 LDAP_SLAPD_V (int) nBackendInfo;
1524 LDAP_SLAPD_V (int) nBackendDB;
1525 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1526 LDAP_SLAPD_V (slap_be_head) backendDB;
1527 LDAP_SLAPD_V (BackendDB *) frontendDB;
1529 LDAP_SLAPD_V (int) slapMode;
1530 #define SLAP_UNDEFINED_MODE 0x0000
1531 #define SLAP_SERVER_MODE 0x0001
1532 #define SLAP_TOOL_MODE 0x0002
1533 #define SLAP_MODE 0x0003
1535 #define SLAP_TRUNCATE_MODE 0x0100
1536 #define SLAP_TOOL_READMAIN 0x0200
1537 #define SLAP_TOOL_READONLY 0x0400
1538 #define SLAP_TOOL_QUICK 0x0800
1540 #define SB_TLS_DEFAULT (-1)
1541 #define SB_TLS_OFF 0
1543 #define SB_TLS_CRITICAL 2
1545 typedef struct slap_bindconf {
1546 struct berval sb_uri;
1549 struct berval sb_binddn;
1550 struct berval sb_cred;
1551 struct berval sb_saslmech;
1553 struct berval sb_realm;
1554 struct berval sb_authcId;
1555 struct berval sb_authzId;
1558 struct slap_replica_info {
1559 const char *ri_host; /* points to host part of uri */
1560 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1561 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1562 int ri_exclude; /* 1 => exclude ri_attrs */
1563 slap_bindconf ri_bindconf; /* for back-config */
1566 typedef struct slap_verbmasks {
1568 const slap_mask_t mask;
1571 typedef struct slap_cf_aux_table {
1576 slap_verbmasks *aux;
1577 } slap_cf_aux_table;
1579 #define SLAP_LIMIT_TIME 1
1580 #define SLAP_LIMIT_SIZE 2
1582 struct slap_limits_set {
1590 int lms_s_unchecked;
1596 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1597 #define SLAP_NO_LIMIT -1
1598 #define SLAP_MAX_LIMIT 2147483647
1600 struct slap_limits {
1601 unsigned lm_flags; /* type of pattern */
1602 #define SLAP_LIMITS_UNDEFINED 0x0000U
1603 #define SLAP_LIMITS_EXACT 0x0001U
1604 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1605 #define SLAP_LIMITS_ONE 0x0002U
1606 #define SLAP_LIMITS_SUBTREE 0x0003U
1607 #define SLAP_LIMITS_CHILDREN 0x0004U
1608 #define SLAP_LIMITS_REGEX 0x0005U
1609 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1610 #define SLAP_LIMITS_USERS 0x0007U
1611 #define SLAP_LIMITS_ANY 0x0008U
1612 #define SLAP_LIMITS_MASK 0x000FU
1614 #define SLAP_LIMITS_TYPE_DN 0x0000U
1615 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1616 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1618 regex_t lm_regex; /* regex data for REGEX */
1621 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1622 * pattern for REGEX; NULL for ANONYMOUS, USERS
1624 struct berval lm_pat;
1626 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1627 * lm_group_oc is objectClass and lm_group_at is attributeType
1628 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1629 * can only be SLAP_LIMITS_EXACT */
1630 ObjectClass *lm_group_oc;
1631 AttributeDescription *lm_group_ad;
1633 struct slap_limits_set lm_limits;
1636 /* temporary aliases */
1637 typedef BackendDB Backend;
1638 #define nbackends nBackendDB
1639 #define backends backendDB
1642 * syncinfo structure for syncrepl
1647 #define SLAP_SYNC_RID_SIZE 3
1648 #define SLAP_SYNCUUID_SET_SIZE 256
1650 #define SLAP_SYNC_UPDATE_MSGID 1
1652 struct sync_cookie {
1653 struct berval ctxcsn;
1654 struct berval octet_str;
1656 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1659 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1661 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1663 #ifndef SLAP_MAX_CIDS
1664 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1667 struct ConfigOCs; /* config.h */
1669 struct slap_backend_db {
1670 BackendInfo *bd_info; /* pointer to shared backend info */
1672 /* fields in this structure (and routines acting on this structure)
1673 should be renamed from be_ to bd_ */
1675 /* BackendInfo accessors */
1676 #define be_config bd_info->bi_db_config
1677 #define be_type bd_info->bi_type
1679 #define be_bind bd_info->bi_op_bind
1680 #define be_unbind bd_info->bi_op_unbind
1681 #define be_add bd_info->bi_op_add
1682 #define be_compare bd_info->bi_op_compare
1683 #define be_delete bd_info->bi_op_delete
1684 #define be_modify bd_info->bi_op_modify
1685 #define be_modrdn bd_info->bi_op_modrdn
1686 #define be_search bd_info->bi_op_search
1687 #define be_abandon bd_info->bi_op_abandon
1688 #define be_cancel bd_info->bi_op_cancel
1690 #define be_extended bd_info->bi_extended
1692 #define be_chk_referrals bd_info->bi_chk_referrals
1693 #define be_chk_controls bd_info->bi_chk_controls
1694 #define be_fetch bd_info->bi_entry_get_rw
1695 #define be_release bd_info->bi_entry_release_rw
1696 #define be_group bd_info->bi_acl_group
1697 #define be_attribute bd_info->bi_acl_attribute
1698 #define be_operational bd_info->bi_operational
1701 * define to honor hasSubordinates operational attribute in search filters
1702 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1705 #define be_has_subordinates bd_info->bi_has_subordinates
1707 #define be_connection_init bd_info->bi_connection_init
1708 #define be_connection_destroy bd_info->bi_connection_destroy
1711 #define be_entry_open bd_info->bi_tool_entry_open
1712 #define be_entry_close bd_info->bi_tool_entry_close
1713 #define be_entry_first bd_info->bi_tool_entry_first
1714 #define be_entry_next bd_info->bi_tool_entry_next
1715 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1716 #define be_entry_get bd_info->bi_tool_entry_get
1717 #define be_entry_put bd_info->bi_tool_entry_put
1718 #define be_sync bd_info->bi_tool_sync
1719 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1720 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1721 #define be_entry_modify bd_info->bi_tool_entry_modify
1724 /* supported controls */
1725 /* note: set to 0 if the database does not support the control;
1726 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1727 char be_ctrls[SLAP_MAX_CIDS + 1];
1729 /* Database flags */
1730 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1731 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1732 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1733 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1734 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1735 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1736 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1737 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1738 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1739 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1740 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1741 slap_mask_t be_flags;
1742 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1743 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1744 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1745 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1746 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1747 #define SLAP_NO_SCHEMA_CHECK(be) \
1748 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1749 #define SLAP_GLUE_INSTANCE(be) \
1750 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1751 #define SLAP_GLUE_SUBORDINATE(be) \
1752 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1753 #define SLAP_GLUE_LINKED(be) \
1754 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1755 #define SLAP_GLUE_ADVERTISE(be) \
1756 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1757 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1758 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1759 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1761 slap_mask_t be_restrictops; /* restriction operations */
1762 #define SLAP_RESTRICT_OP_ADD 0x0001U
1763 #define SLAP_RESTRICT_OP_BIND 0x0002U
1764 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1765 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1766 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1767 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1768 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1769 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1770 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1772 #define SLAP_RESTRICT_READONLY 0x80000000U
1774 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1775 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1776 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1777 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1778 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1780 #define SLAP_RESTRICT_OP_READS \
1781 ( SLAP_RESTRICT_OP_COMPARE \
1782 | SLAP_RESTRICT_OP_SEARCH )
1783 #define SLAP_RESTRICT_OP_WRITES \
1784 ( SLAP_RESTRICT_OP_ADD \
1785 | SLAP_RESTRICT_OP_DELETE \
1786 | SLAP_RESTRICT_OP_MODIFY \
1787 | SLAP_RESTRICT_OP_RENAME )
1788 #define SLAP_RESTRICT_OP_ALL \
1789 ( SLAP_RESTRICT_OP_READS \
1790 | SLAP_RESTRICT_OP_WRITES \
1791 | SLAP_RESTRICT_OP_BIND \
1792 | SLAP_RESTRICT_OP_EXTENDED )
1794 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1795 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1796 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1798 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1800 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1801 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1802 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1804 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1805 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1807 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1809 slap_mask_t be_requires; /* pre-operation requirements */
1810 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1811 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1812 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1813 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1814 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1816 /* Required Security Strength Factor */
1817 slap_ssf_set_t be_ssf_set;
1819 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1820 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1821 struct berval be_schemadn; /* per-backend subschema subentry DN */
1822 struct berval be_schemandn; /* normalized subschema DN */
1823 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1824 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1825 struct berval be_rootpw; /* the magic "root" password for this db */
1826 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1827 #define be_sizelimit be_def_limit.lms_s_soft
1828 #define be_timelimit be_def_limit.lms_t_soft
1829 struct slap_limits_set be_def_limit; /* default limits */
1830 struct slap_limits **be_limits; /* regex-based size and time limits */
1831 AccessControl *be_acl; /* access control list for this backend */
1832 slap_access_t be_dfltaccess; /* access given if no acl matches */
1834 /* Replica Information */
1835 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1836 char *be_replogfile; /* replication log file (in master) */
1837 char *be_replica_argsfile; /* per-replog replica args file */
1838 char *be_replica_pidfile; /* per-replog replica pid file */
1839 int be_replicationinterval; /* per-replog replicationinterval */
1840 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1841 BerVarray be_update_refs; /* where to refer modifying clients to */
1842 struct be_pcl *be_pending_csn_list;
1843 ldap_pvt_thread_mutex_t be_pcl_mutex;
1844 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1845 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1847 void *be_pb; /* Netscape plugin */
1848 struct ConfigOCs *be_cf_ocs;
1850 void *be_private; /* anything the backend database needs */
1851 LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1857 /* Backend function typedefs */
1858 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1859 typedef BI_bi_func BI_init;
1860 typedef BI_bi_func BI_open;
1861 typedef BI_bi_func BI_close;
1862 typedef BI_bi_func BI_destroy;
1863 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1864 const char *fname, int lineno,
1865 int argc, char **argv));
1867 typedef int (BI_db_func) LDAP_P((Backend *bd));
1868 typedef BI_db_func BI_db_init;
1869 typedef BI_db_func BI_db_open;
1870 typedef BI_db_func BI_db_close;
1871 typedef BI_db_func BI_db_destroy;
1872 typedef int (BI_db_config) LDAP_P((Backend *bd,
1873 const char *fname, int lineno,
1874 int argc, char **argv));
1876 typedef struct req_bind_s {
1878 struct berval rb_cred;
1879 struct berval rb_edn;
1881 struct berval rb_tmp_mech; /* FIXME: temporary */
1884 typedef struct req_search_s {
1889 /* NULL means be_isroot evaluated to TRUE */
1890 struct slap_limits_set *rs_limit;
1892 AttributeName *rs_attrs;
1894 struct berval rs_filterstr;
1897 typedef struct req_compare_s {
1898 AttributeAssertion *rs_ava;
1901 typedef struct req_modify_s {
1902 Modifications *rs_modlist;
1903 int rs_increment; /* FIXME: temporary */
1906 typedef struct req_modrdn_s {
1907 struct berval rs_newrdn;
1908 struct berval rs_nnewrdn;
1909 struct berval *rs_newSup;
1910 struct berval *rs_nnewSup;
1911 int rs_deleteoldrdn;
1912 Modifications *rs_modlist;
1915 typedef struct req_add_s {
1917 Modifications *rs_modlist; /* FIXME: temporary */
1920 typedef struct req_abandon_s {
1925 #define SLAP_EXOP_HIDE 0x0000
1927 #define SLAP_EXOP_HIDE 0x8000
1929 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1931 typedef struct req_extended_s {
1932 struct berval rs_reqoid;
1934 struct berval *rs_reqdata;
1937 typedef struct req_pwdexop_s {
1938 struct req_extended_s rs_extended;
1939 struct berval rs_old;
1940 struct berval rs_new;
1941 Modifications *rs_mods;
1942 Modifications **rs_modtail;
1945 typedef enum slap_reply_e {
1954 typedef struct rep_sasl_s {
1955 struct berval *r_sasldata;
1958 typedef struct rep_extended_s {
1959 const char *r_rspoid;
1960 struct berval *r_rspdata;
1963 typedef struct rep_search_s {
1965 slap_mask_t r_attr_flags;
1966 #define SLAP_ATTRS_UNDEFINED (0x00U)
1967 #define SLAP_OPATTRS_NO (0x01U)
1968 #define SLAP_OPATTRS_YES (0x02U)
1969 #define SLAP_USERATTRS_NO (0x10U)
1970 #define SLAP_USERATTRS_YES (0x20U)
1971 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1972 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1973 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1974 #define SLAP_USERATTRS(f) \
1975 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1977 Attribute *r_operational_attrs;
1978 AttributeName *r_attrs;
1983 typedef struct slap_rep {
1984 slap_reply_t sr_type;
1988 const char *sr_matched;
1989 const char *sr_text;
1991 LDAPControl **sr_ctrls;
1993 rep_sasl_s sru_sasl;
1994 rep_extended_s sru_extended;
1995 rep_search_s sru_search;
1997 slap_mask_t sr_flags;
1998 #define REP_ENTRY_MODIFIABLE 0x0001U
1999 #define REP_ENTRY_MUSTBEFREED 0x0002U
2000 #define REP_ENTRY_MUSTRELEASE 0x0004U
2001 #define REP_MATCHED_MUSTBEFREED 0x0010U
2002 #define REP_REF_MUSTBEFREED 0x0020U
2005 /* short hands for response members */
2006 #define sr_attrs sr_un.sru_search.r_attrs
2007 #define sr_entry sr_un.sru_search.r_entry
2008 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2009 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2010 #define sr_v2ref sr_un.sru_search.r_v2ref
2011 #define sr_nentries sr_un.sru_search.r_nentries
2012 #define sr_rspoid sr_un.sru_extended.r_rspoid
2013 #define sr_rspdata sr_un.sru_extended.r_rspdata
2014 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2016 typedef int (BI_op_func) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2017 typedef BI_op_func BI_op_bind;
2018 typedef BI_op_func BI_op_unbind;
2019 typedef BI_op_func BI_op_search;
2020 typedef BI_op_func BI_op_compare;
2021 typedef BI_op_func BI_op_modify;
2022 typedef BI_op_func BI_op_modrdn;
2023 typedef BI_op_func BI_op_add;
2024 typedef BI_op_func BI_op_delete;
2025 typedef BI_op_func BI_op_abandon;
2026 typedef BI_op_func BI_op_cancel;
2027 typedef BI_op_func BI_op_extended;
2028 typedef BI_op_func BI_chk_referrals;
2029 typedef BI_op_func BI_chk_controls;
2030 typedef int (BI_entry_release_rw)
2031 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
2032 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
2033 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2034 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2035 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
2036 Entry *e, int *hasSubs ));
2037 #ifdef SLAP_OVERLAY_ACCESS
2038 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
2039 AttributeDescription *desc, struct berval *val, slap_access_t access,
2040 AccessControlState *state, slap_mask_t *maskp ));
2041 typedef int (BI_acl_group) LDAP_P(( struct slap_op *op, Entry *target,
2042 struct berval *gr_ndn, struct berval *op_ndn,
2043 ObjectClass *group_oc, AttributeDescription *group_at ));
2044 typedef int (BI_acl_attribute) LDAP_P(( struct slap_op *op, Entry *target,
2045 struct berval *entry_ndn, AttributeDescription *entry_at,
2046 BerVarray *vals, slap_access_t access ));
2047 #endif /* SLAP_OVERLAY_ACCESS */
2049 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, struct slap_conn *c ));
2050 typedef BI_conn_func BI_connection_init;
2051 typedef BI_conn_func BI_connection_destroy;
2053 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2054 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2055 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2056 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2057 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2058 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2059 struct berval *text ));
2060 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
2061 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2062 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2063 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
2064 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2065 struct berval *text ));
2067 struct slap_backend_info {
2068 char *bi_type; /* type of backend */
2071 * per backend type routines:
2072 * bi_init: called to allocate a backend_info structure,
2073 * called once BEFORE configuration file is read.
2074 * bi_init() initializes this structure hence is
2075 * called directly from be_initialize()
2076 * bi_config: called per 'backend' specific option
2077 * all such options must before any 'database' options
2078 * bi_config() is called only from read_config()
2079 * bi_open: called to open each database, called
2080 * once AFTER configuration file is read but
2081 * BEFORE any bi_db_open() calls.
2082 * bi_open() is called from backend_startup()
2083 * bi_close: called to close each database, called
2084 * once during shutdown after all bi_db_close calls.
2085 * bi_close() is called from backend_shutdown()
2086 * bi_destroy: called to destroy each database, called
2087 * once during shutdown after all bi_db_destroy calls.
2088 * bi_destory() is called from backend_destroy()
2091 BI_config *bi_config;
2094 BI_destroy *bi_destroy;
2097 * per database routines:
2098 * bi_db_init: called to initialize each database,
2099 * called upon reading 'database <type>'
2100 * called only from backend_db_init()
2101 * bi_db_config: called to configure each database,
2102 * called per database to handle per database options
2103 * called only from read_config()
2104 * bi_db_open: called to open each database
2105 * called once per database immediately AFTER bi_open()
2106 * calls but before daemon startup.
2107 * called only by backend_startup()
2108 * bi_db_close: called to close each database
2109 * called once per database during shutdown but BEFORE
2110 * any bi_close call.
2111 * called only by backend_shutdown()
2112 * bi_db_destroy: called to destroy each database
2113 * called once per database during shutdown AFTER all
2114 * bi_close calls but before bi_destory calls.
2115 * called only by backend_destory()
2117 BI_db_init *bi_db_init;
2118 BI_db_config *bi_db_config;
2119 BI_db_open *bi_db_open;
2120 BI_db_close *bi_db_close;
2121 BI_db_destroy *bi_db_destroy;
2123 /* LDAP Operations Handling Routines */
2124 BI_op_bind *bi_op_bind;
2125 BI_op_unbind *bi_op_unbind;
2126 BI_op_search *bi_op_search;
2127 BI_op_compare *bi_op_compare;
2128 BI_op_modify *bi_op_modify;
2129 BI_op_modrdn *bi_op_modrdn;
2130 BI_op_add *bi_op_add;
2131 BI_op_delete *bi_op_delete;
2132 BI_op_abandon *bi_op_abandon;
2133 BI_op_cancel *bi_op_cancel;
2135 /* Extended Operations Helper */
2136 BI_op_extended *bi_extended;
2138 /* Auxilary Functions */
2139 BI_operational *bi_operational;
2140 BI_chk_referrals *bi_chk_referrals;
2141 BI_chk_controls *bi_chk_controls;
2142 BI_entry_get_rw *bi_entry_get_rw;
2143 BI_entry_release_rw *bi_entry_release_rw;
2145 BI_has_subordinates *bi_has_subordinates;
2146 #ifdef SLAP_OVERLAY_ACCESS
2147 BI_access_allowed *bi_access_allowed;
2148 BI_acl_group *bi_acl_group;
2149 BI_acl_attribute *bi_acl_attribute;
2150 #endif /* SLAP_OVERLAY_ACCESS */
2152 BI_connection_init *bi_connection_init;
2153 BI_connection_destroy *bi_connection_destroy;
2155 /* hooks for slap tools */
2156 BI_tool_entry_open *bi_tool_entry_open;
2157 BI_tool_entry_close *bi_tool_entry_close;
2158 BI_tool_entry_first *bi_tool_entry_first;
2159 BI_tool_entry_next *bi_tool_entry_next;
2160 BI_tool_entry_get *bi_tool_entry_get;
2161 BI_tool_entry_put *bi_tool_entry_put;
2162 BI_tool_entry_reindex *bi_tool_entry_reindex;
2163 BI_tool_sync *bi_tool_sync;
2164 BI_tool_dn2id_get *bi_tool_dn2id_get;
2165 BI_tool_id2entry_get *bi_tool_id2entry_get;
2166 BI_tool_entry_modify *bi_tool_entry_modify;
2168 #define SLAP_INDEX_ADD_OP 0x0001
2169 #define SLAP_INDEX_DELETE_OP 0x0002
2171 slap_mask_t bi_flags; /* backend flags */
2172 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2173 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2174 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2175 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2176 #define SLAP_BFLAG_INCREMENT 0x0100U
2177 #define SLAP_BFLAG_ALIASES 0x1000U
2178 #define SLAP_BFLAG_REFERRALS 0x2000U
2179 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2180 #define SLAP_BFLAG_DYNAMIC 0x8000U
2182 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2183 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2184 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2185 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2186 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2187 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2188 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2189 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2190 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2191 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2192 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2194 char **bi_controls; /* supported controls */
2195 char bi_ctrls[SLAP_MAX_CIDS + 1];
2197 unsigned int bi_nDB; /* number of databases of this type */
2198 struct ConfigOCs *bi_cf_ocs;
2199 char **bi_obsolete_names;
2200 void *bi_private; /* anything the backend type needs */
2201 LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2204 #define c_authtype c_authz.sai_method
2205 #define c_authmech c_authz.sai_mech
2206 #define c_dn c_authz.sai_dn
2207 #define c_ndn c_authz.sai_ndn
2208 #define c_ssf c_authz.sai_ssf
2209 #define c_transport_ssf c_authz.sai_transport_ssf
2210 #define c_tls_ssf c_authz.sai_tls_ssf
2211 #define c_sasl_ssf c_authz.sai_sasl_ssf
2213 #define o_authtype o_authz.sai_method
2214 #define o_authmech o_authz.sai_mech
2215 #define o_dn o_authz.sai_dn
2216 #define o_ndn o_authz.sai_ndn
2217 #define o_ssf o_authz.sai_ssf
2218 #define o_transport_ssf o_authz.sai_transport_ssf
2219 #define o_tls_ssf o_authz.sai_tls_ssf
2220 #define o_sasl_ssf o_authz.sai_sasl_ssf
2222 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2224 typedef struct slap_callback {
2225 struct slap_callback *sc_next;
2226 slap_response *sc_response;
2227 slap_response *sc_cleanup;
2231 struct slap_overinfo;
2233 typedef enum slap_operation_e {
2246 op_aux_chk_referrals,
2247 op_aux_chk_controls,
2251 typedef struct slap_overinst {
2253 slap_response *on_response;
2254 struct slap_overinfo *on_info;
2255 struct slap_overinst *on_next;
2258 typedef struct slap_overinfo {
2260 BackendInfo *oi_orig;
2261 BackendDB *oi_origdb;
2262 struct slap_overinst *oi_list;
2265 /* Should successive callbacks in a chain be processed? */
2266 #define SLAP_CB_FREEME 0x04000
2267 #define SLAP_CB_CONTINUE 0x08000
2270 * Paged Results state
2272 typedef unsigned long PagedResultsCookie;
2273 typedef struct slap_paged_state {
2276 PagedResultsCookie ps_cookie;
2278 } PagedResultsState;
2280 struct slap_csn_entry {
2281 struct berval ce_csn;
2282 unsigned long ce_opid;
2283 unsigned long ce_connid;
2284 #define SLAP_CSN_PENDING 1
2285 #define SLAP_CSN_COMMIT 2
2287 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2291 * Caches the result of a backend_group check for ACL evaluation
2293 typedef struct slap_gacl {
2294 struct slap_gacl *ga_next;
2297 AttributeDescription *ga_at;
2303 struct slap_control_ids {
2310 int sc_modifyIncrement;
2312 int sc_pagedResults;
2313 int sc_permissiveModify;
2317 int sc_searchOptions;
2319 int sc_sortedResults;
2323 int sc_valuesReturnFilter;
2327 * represents an operation pending from an ldap client
2329 typedef struct slap_op_header {
2330 unsigned long oh_opid; /* id of this operation */
2331 unsigned long oh_connid; /* id of conn initiating this op */
2332 struct slap_conn *oh_conn; /* connection spawning this op */
2334 ber_int_t oh_msgid; /* msgid of the request */
2335 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2337 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2339 void *oh_threadctx; /* thread pool thread context */
2340 void *oh_tmpmemctx; /* slab malloc context */
2341 BerMemoryFunctions *oh_tmpmfuncs;
2343 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2346 void *oh_extensions; /* NS-SLAPI plugin */
2350 typedef struct slap_op {
2353 #define o_opid o_hdr->oh_opid
2354 #define o_connid o_hdr->oh_connid
2355 #define o_conn o_hdr->oh_conn
2356 #define o_msgid o_hdr->oh_msgid
2357 #define o_protocol o_hdr->oh_protocol
2358 #define o_tid o_hdr->oh_tid
2359 #define o_threadctx o_hdr->oh_threadctx
2360 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2361 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2363 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2364 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2365 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2366 #define o_tmpfree o_tmpmfuncs->bmf_free
2368 #define o_log_prefix o_hdr->oh_log_prefix
2370 ber_tag_t o_tag; /* tag of the request */
2371 time_t o_time; /* time op was initiated */
2372 int o_tincr; /* counter for multiple ops with same o_time */
2374 BackendDB *o_bd; /* backend DB processing this op */
2375 struct berval o_req_dn; /* DN of target of request */
2376 struct berval o_req_ndn;
2381 req_compare_s oq_compare;
2382 req_modify_s oq_modify;
2383 req_modrdn_s oq_modrdn;
2384 req_search_s oq_search;
2385 req_abandon_s oq_abandon;
2386 req_abandon_s oq_cancel;
2387 req_extended_s oq_extended;
2388 req_pwdexop_s oq_pwdexop;
2391 /* short hands for union members */
2392 #define oq_add o_request.oq_add
2393 #define oq_bind o_request.oq_bind
2394 #define oq_compare o_request.oq_compare
2395 #define oq_modify o_request.oq_modify
2396 #define oq_modrdn o_request.oq_modrdn
2397 #define oq_search o_request.oq_search
2398 #define oq_abandon o_request.oq_abandon
2399 #define oq_cancel o_request.oq_cancel
2400 #define oq_extended o_request.oq_extended
2401 #define oq_pwdexop o_request.oq_pwdexop
2403 /* short hands for inner request members */
2404 #define orb_method oq_bind.rb_method
2405 #define orb_cred oq_bind.rb_cred
2406 #define orb_edn oq_bind.rb_edn
2407 #define orb_ssf oq_bind.rb_ssf
2408 #define orb_tmp_mech oq_bind.rb_tmp_mech
2410 #define ors_scope oq_search.rs_scope
2411 #define ors_deref oq_search.rs_deref
2412 #define ors_slimit oq_search.rs_slimit
2413 #define ors_tlimit oq_search.rs_tlimit
2414 #define ors_limit oq_search.rs_limit
2415 #define ors_attrsonly oq_search.rs_attrsonly
2416 #define ors_attrs oq_search.rs_attrs
2417 #define ors_filter oq_search.rs_filter
2418 #define ors_filterstr oq_search.rs_filterstr
2420 #define orr_newrdn oq_modrdn.rs_newrdn
2421 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2422 #define orr_newSup oq_modrdn.rs_newSup
2423 #define orr_nnewSup oq_modrdn.rs_nnewSup
2424 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2425 #define orr_modlist oq_modrdn.rs_modlist
2427 #define orc_ava oq_compare.rs_ava
2428 #define ora_e oq_add.rs_e
2429 #define ora_modlist oq_add.rs_modlist
2430 #define orn_msgid oq_abandon.rs_msgid
2431 #define orm_modlist oq_modify.rs_modlist
2432 #define orm_increment oq_modify.rs_increment
2434 #define ore_reqoid oq_extended.rs_reqoid
2435 #define ore_flags oq_extended.rs_flags
2436 #define ore_reqdata oq_extended.rs_reqdata
2437 volatile sig_atomic_t o_abandon; /* abandon flag */
2438 volatile sig_atomic_t o_cancel; /* cancel flag */
2439 #define SLAP_CANCEL_NONE 0x00
2440 #define SLAP_CANCEL_REQ 0x01
2441 #define SLAP_CANCEL_ACK 0x02
2442 #define SLAP_CANCEL_DONE 0x03
2444 GroupAssertion *o_groups;
2445 char o_do_not_cache; /* don't cache groups from this op */
2446 char o_is_auth_check; /* authorization in progress */
2449 char o_delete_glue_parent;
2450 char o_no_schema_check;
2451 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2453 #define SLAP_CONTROL_NONE 0
2454 #define SLAP_CONTROL_IGNORED 1
2455 #define SLAP_CONTROL_NONCRITICAL 2
2456 #define SLAP_CONTROL_CRITICAL 3
2457 #define SLAP_CONTROL_MASK 3
2459 /* spare bits for simple flags */
2460 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2461 #define SLAP_CONTROL_DATA0 0x10
2462 #define SLAP_CONTROL_DATA1 0x20
2463 #define SLAP_CONTROL_DATA2 0x40
2464 #define SLAP_CONTROL_DATA3 0x80
2467 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2469 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2470 void **o_controls; /* per-control state */
2472 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2473 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2475 #define o_managedit o_ctrlflag[slap_cids.sc_manageDIT]
2476 #define get_manageDIT(op) _SCM((op)->o_managedit)
2478 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2479 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2481 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2482 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2483 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2485 #define get_subentries(op) _SCM((op)->o_subentries)
2486 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2488 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2489 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2491 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2492 #define get_assert(op) ((int)(op)->o_assert)
2493 #define o_assertion o_controls[slap_cids.sc_assert]
2494 #define get_assertion(op) ((op)->o_assertion)
2496 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2497 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2499 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2500 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2502 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2503 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2505 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2506 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2508 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2509 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2511 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2512 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2514 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2515 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2516 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2519 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2522 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2524 AuthorizationInformation o_authz;
2526 BerElement *o_ber; /* ber of the request */
2527 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2528 slap_callback *o_callback; /* callback pointers */
2529 LDAPControl **o_ctrls; /* controls */
2530 struct berval o_csn;
2532 void *o_private; /* anything the backend needs */
2534 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2537 #define OPERATION_BUFFER_SIZE ( sizeof(Operation) + sizeof(Opheader) + \
2538 SLAP_MAX_CIDS*sizeof(void *) )
2540 typedef LBER_ALIGNED_BUFFER(operation_buffer_u,OPERATION_BUFFER_SIZE)
2543 #define send_ldap_error( op, rs, err, text ) do { \
2544 (rs)->sr_err = err; (rs)->sr_text = text; \
2545 (op->o_conn->c_send_ldap_result)( op, rs ); \
2547 #define send_ldap_discon( op, rs, err, text ) do { \
2548 (rs)->sr_err = err; (rs)->sr_text = text; \
2549 send_ldap_disconnect( op, rs ); \
2552 typedef void (SEND_LDAP_RESULT)(
2553 struct slap_op *op, struct slap_rep *rs);
2554 typedef int (SEND_SEARCH_ENTRY)(
2555 struct slap_op *op, struct slap_rep *rs);
2556 typedef int (SEND_SEARCH_REFERENCE)(
2557 struct slap_op *op, struct slap_rep *rs);
2558 typedef void (SEND_LDAP_EXTENDED)(
2559 struct slap_op *op, struct slap_rep *rs);
2560 typedef void (SEND_LDAP_INTERMEDIATE)(
2561 struct slap_op *op, struct slap_rep *rs);
2563 #define send_ldap_result( op, rs ) \
2564 ((op)->o_conn->c_send_ldap_result)( op, rs )
2565 #define send_search_entry( op, rs ) \
2566 ((op)->o_conn->c_send_search_entry)( op, rs )
2567 #define send_search_reference( op, rs ) \
2568 ((op)->o_conn->c_send_search_reference)( op, rs )
2569 #define send_ldap_extended( op, rs ) \
2570 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2571 #define send_ldap_intermediate( op, rs ) \
2572 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2574 typedef struct slap_listener Listener;
2577 * represents a connection from an ldap client
2579 typedef struct slap_conn {
2580 int c_struct_state; /* structure management state */
2581 int c_conn_state; /* connection state */
2582 int c_conn_idx; /* slot in connections array */
2583 const char *c_close_reason; /* why connection is closing */
2585 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2586 Sockbuf *c_sb; /* ber connection stuff */
2588 /* only can be changed by connect_init */
2589 time_t c_starttime; /* when the connection was opened */
2590 time_t c_activitytime; /* when the connection was last used */
2591 unsigned long c_connid; /* id of this connection for stats*/
2593 struct berval c_peer_domain; /* DNS name of client */
2594 struct berval c_peer_name; /* peer name (trans=addr:port) */
2595 Listener *c_listener;
2596 #define c_listener_url c_listener->sl_url /* listener URL */
2597 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2599 /* only can be changed by binding thread */
2600 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2601 struct berval c_sasl_bind_mech; /* mech in progress */
2602 struct berval c_sasl_dn; /* temporary storage */
2603 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2605 /* authorization backend */
2606 Backend *c_authz_backend;
2607 void *c_authz_cookie;
2608 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2609 ( (op)->o_bd != NULL \
2610 && (op)->o_bd->be_private != NULL \
2611 && (op)->o_conn != NULL \
2612 && (op)->o_conn->c_authz_backend != NULL \
2613 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2614 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2616 AuthorizationInformation c_authz;
2618 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2620 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2621 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2623 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2624 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2626 BerElement *c_currentber; /* ber we're attempting to read */
2627 int c_writewaiter; /* true if writer is waiting */
2629 #define CONN_IS_TLS 1
2630 #define CONN_IS_UDP 2
2631 #define CONN_IS_CLIENT 3
2633 #ifdef LDAP_CONNECTIONLESS
2634 int c_is_udp; /* true if this is (C)LDAP over UDP */
2637 int c_is_tls; /* true if this LDAP over raw TLS */
2638 int c_needs_tls_accept; /* true if SSL_accept should be called */
2640 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2641 int c_sasl_done; /* SASL completed once */
2642 void *c_sasl_authctx; /* SASL authentication context */
2643 void *c_sasl_sockctx; /* SASL security layer context */
2644 void *c_sasl_extra; /* SASL session extra stuff */
2645 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2647 PagedResultsState c_pagedresults_state; /* paged result state */
2649 long c_n_ops_received; /* num of ops received (next op_id) */
2650 long c_n_ops_executing; /* num of ops currently executing */
2651 long c_n_ops_pending; /* num of ops pending execution */
2652 long c_n_ops_completed; /* num of ops completed */
2654 long c_n_get; /* num of get calls */
2655 long c_n_read; /* num of read calls */
2656 long c_n_write; /* num of write calls */
2658 void *c_pb; /* Netscape plugin */
2659 void *c_extensions; /* Netscape plugin */
2662 * Client connection handling
2664 ldap_pvt_thread_start_t *c_clientfunc;
2668 * These are the "callbacks" that are available for back-ends to
2669 * supply data back to connected clients that are connected
2670 * through the "front-end".
2672 SEND_LDAP_RESULT *c_send_ldap_result;
2673 SEND_SEARCH_ENTRY *c_send_search_entry;
2674 SEND_SEARCH_REFERENCE *c_send_search_reference;
2675 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2676 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2679 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2680 #define Statslog1( level, severity, fmt, connid, opid, arg1 ) \
2682 if ( ldap_debug & (level) ) \
2683 fprintf( stderr, (fmt), (connid), (opid), (arg1) );\
2684 if ( ldap_syslog & (level) ) \
2685 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2688 #define Statslog2( level, severity, fmt, connid, opid, arg1, arg2 ) \
2690 if ( ldap_debug & (level) ) \
2691 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2) );\
2692 if ( ldap_syslog & (level) ) \
2693 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2696 #define Statslog3( level, severity, fmt, connid, opid, arg1, arg2, arg3 ) \
2698 if ( ldap_debug & (level) ) \
2699 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2700 if ( ldap_syslog & (level) ) \
2701 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2702 (arg1), (arg2), (arg3) ); \
2704 #define Statslog4( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4 ) \
2706 if ( ldap_debug & (level) ) \
2707 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4) );\
2708 if ( ldap_syslog & (level) ) \
2709 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2710 (arg1), (arg2), (arg3), (arg4) ); \
2712 #define Statslog5( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4, arg5 ) \
2714 if ( ldap_debug & (level) ) \
2715 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4), (arg5) );\
2716 if ( ldap_syslog & (level) ) \
2717 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2718 (arg1), (arg2), (arg3), (arg4), (arg5) ); \
2720 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2721 Statslog3( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2722 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2723 #elif defined(LDAP_DEBUG)
2724 #define Statslog1( level, severity, fmt, connid, opid, arg1 ) \
2726 if ( ldap_debug & (level) ) \
2727 fprintf( stderr, (fmt), (connid), (opid), (arg1) );\
2729 #define Statslog2( level, severity, fmt, connid, opid, arg1, arg2 ) \
2731 if ( ldap_debug & (level) ) \
2732 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2) );\
2734 #define Statslog3( level, severity, fmt, connid, opid, arg1, arg2, arg3 ) \
2736 if ( ldap_debug & (level) ) \
2737 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2739 #define Statslog4( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4 ) \
2741 if ( ldap_debug & (level) ) \
2742 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4) );\
2744 #define Statslog5( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4, arg5 ) \
2746 if ( ldap_debug & (level) ) \
2747 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4), (arg5) );\
2749 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2751 if ( ldap_debug & (level) ) \
2752 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2754 #define StatslogTest( level ) (ldap_debug & (level))
2756 #define Statslog1( level, severity, fmt, connid, opid, arg1 )
2757 #define Statslog2( level, severity, fmt, connid, opid, arg1, arg2 )
2758 #define Statslog3( level, severity, fmt, connid, opid, arg1, arg2, arg3 )
2759 #define Statslog4( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4 )
2760 #define Statslog5( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4, arg5 )
2761 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2762 #define StatslogTest( level ) (0)
2766 * listener; need to access it from monitor backend
2768 struct slap_listener {
2769 struct berval sl_url;
2770 struct berval sl_name;
2775 #ifdef LDAP_CONNECTIONLESS
2776 int sl_is_udp; /* UDP listener is also data port */
2778 int sl_mute; /* Listener is temporarily disabled due to emfile */
2779 #ifdef SLAP_LIGHTWEIGHT_DISPATCHER
2780 int sl_busy; /* Listener is busy (accept thread activated) */
2784 #define sl_addr sl_sa.sa_in_addr
2804 typedef struct slap_counters_t {
2805 ldap_pvt_thread_mutex_t sc_sent_mutex;
2806 ldap_pvt_mp_t sc_bytes;
2807 ldap_pvt_mp_t sc_pdu;
2808 ldap_pvt_mp_t sc_entries;
2809 ldap_pvt_mp_t sc_refs;
2811 ldap_pvt_thread_mutex_t sc_ops_mutex;
2812 ldap_pvt_mp_t sc_ops_completed;
2813 ldap_pvt_mp_t sc_ops_initiated;
2814 #ifdef SLAPD_MONITOR
2815 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2816 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2817 #endif /* SLAPD_MONITOR */
2821 * Better know these all around slapd
2823 #define SLAP_LDAPDN_PRETTY 0x1
2824 #define SLAP_LDAPDN_MAXLEN 8192
2826 /* number of response controls supported */
2827 #define SLAP_MAX_RESPONSE_CONTROLS 6
2830 #define SLAP_CTRL_HIDE 0x00000000U
2832 #define SLAP_CTRL_HIDE 0x80000000U
2835 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for ManageDIT */
2837 #define SLAP_CTRL_GLOBAL 0x00800000U
2838 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2840 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2841 #define SLAP_CTRL_ABANDON 0x00000001U
2842 #define SLAP_CTRL_ADD 0x00002002U
2843 #define SLAP_CTRL_BIND 0x00000004U
2844 #define SLAP_CTRL_COMPARE 0x00001008U
2845 #define SLAP_CTRL_DELETE 0x00002010U
2846 #define SLAP_CTRL_MODIFY 0x00002020U
2847 #define SLAP_CTRL_RENAME 0x00002040U
2848 #define SLAP_CTRL_SEARCH 0x00001080U
2849 #define SLAP_CTRL_UNBIND 0x00000100U
2851 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2852 #define SLAP_CTRL_UPDATE \
2853 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2854 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2856 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2859 LDAPControl *ctrl ));
2861 #define SLAP_SLAB_SIZE (1024*1024)
2862 #define SLAP_SLAB_STACK 1
2863 #define SLAP_SLAB_SOBLOCK 64
2865 #define SLAP_ZONE_ALLOC 1
2866 #undef SLAP_ZONE_ALLOC
2868 #ifdef LDAP_COMP_MATCH
2870 * Extensible Filter Definition
2872 * MatchingRuleAssertion := SEQUENCE {
2873 * matchingRule [1] MatchingRuleId OPTIONAL,
2874 * type [2] AttributeDescription OPTIONAL,
2875 * matchValue [3] AssertionValue,
2876 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2878 * Following ComponentFilter is contained in matchValue
2880 * ComponentAssertion ::= SEQUENCE {
2881 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2882 * useDefaultValues BOOLEAN DEFAULT TRUE,
2883 * rule MATCHING-RULE.&id,
2884 * value MATCHING-RULE.&AssertionType }
2886 * ComponentFilter ::= CHOICE {
2887 * item [0] ComponentAssertion,
2888 * and [1] SEQUENCE OF ComponentFilter,
2889 * or [2] SEQUENCE OF ComponentFilter,
2890 * not [3] ComponentFilter }
2893 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2894 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2895 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2896 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2897 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2898 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2899 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2900 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2901 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2903 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2904 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2905 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2906 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2907 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2909 typedef struct slap_component_id {
2911 struct slap_component_id *ci_next;
2913 union comp_id_value{
2914 BerValue ci_identifier;
2915 ber_int_t ci_from_beginning;
2917 ber_int_t ci_from_end;
2918 ber_int_t ci_content;
2919 BerValue ci_select_value;
2924 typedef struct slap_component_reference {
2925 ComponentId *cr_list;
2926 ComponentId *cr_curr;
2927 struct berval cr_string;
2929 /* Component Indexing */
2931 slap_mask_t cr_indexmask;
2932 AttributeDescription* cr_ad;
2934 struct slap_component_reference* cr_next;
2935 } ComponentReference;
2937 typedef struct slap_component_assertion {
2938 ComponentReference *ca_comp_ref;
2939 ber_int_t ca_use_def;
2940 MatchingRule *ca_ma_rule;
2941 struct berval ca_ma_value;
2942 ComponentData ca_comp_data; /* componentized assertion */
2943 struct slap_component_filter *ca_cf;
2944 MatchingRuleAssertion *ca_mra;
2945 } ComponentAssertion;
2947 typedef struct slap_component_filter {
2948 ber_tag_t cf_choice;
2950 ber_int_t cf_un_result;
2951 ComponentAssertion *cf_un_ca;
2952 struct slap_component_filter *cf_un_complex;
2955 #define cf_ca cf_un.cf_un_ca
2956 #define cf_result cf_un.cf_un_result
2957 #define cf_and cf_un.cf_un_complex
2958 #define cf_or cf_un.cf_un_complex
2959 #define cf_not cf_un.cf_un_complex
2960 #define cf_any cf_un.cf_un_complex
2962 struct slap_component_filter *cf_next;
2965 typedef struct slap_component_assertion_value {
2969 } ComponentAssertionValue;
2971 typedef int encoder_func LDAP_P((
2975 struct slap_component_syntax_info;
2977 typedef int gser_decoder_func LDAP_P((
2980 struct slap_component_syntax_info** comp_syn_info,
2984 typedef int comp_free_func LDAP_P((
2987 typedef int ber_decoder_func LDAP_P((
2992 struct slap_component_syntax_info* comp_syn_info,
2996 typedef int ber_tag_decoder_func LDAP_P((
2999 struct slap_component_syntax_info* comp_syn_info,
3003 typedef void* extract_component_from_id_func LDAP_P((
3005 ComponentReference* cr,
3008 typedef void* convert_attr_to_comp_func LDAP_P ((
3011 struct berval* bv ));
3013 typedef void* alloc_nibble_func LDAP_P ((
3015 int increment_size ));
3017 typedef void free_nibble_func LDAP_P ((
3020 struct slap_component_syntax_info;
3021 typedef void convert_assert_to_comp_func LDAP_P ((
3023 struct slap_component_syntax_info* csi_attr,
3025 struct slap_component_syntax_info** csi,
3029 typedef int convert_asn_to_ldap_func LDAP_P ((
3030 struct slap_component_syntax_info* csi,
3031 struct berval *bv ));
3033 typedef void free_component_func LDAP_P ((
3036 typedef int test_component_func LDAP_P ((
3038 void* assert_mem_op,
3039 struct slap_component_syntax_info* csi,
3040 struct slap_component_assertion* ca));
3042 typedef void* test_membership_func LDAP_P ((
3045 typedef void* get_component_info_func LDAP_P ((
3048 struct slap_component_syntax_info;
3050 typedef int component_encoder_func LDAP_P ((
3052 struct slap_component_syntax_info* csi,
3053 struct berval* nvals ));
3055 typedef int allcomponent_matching_func LDAP_P((
3057 struct slap_component_syntax_info* comp1,
3058 struct slap_component_syntax_info* comp));
3060 typedef struct slap_component_desc {
3061 /* Don't change the order of following four fields */
3063 AttributeType *cd_comp_type;
3064 struct berval cd_ad_type;/* ad_type, ad_cname */
3065 struct berval cd_ad_cname;/* ad_type, ad_cname */
3066 unsigned cd_flags; /*ad_flags*/
3069 encoder_func *cd_ldap_encoder;
3070 encoder_func *cd_gser_encoder;
3071 encoder_func *cd_ber_encoder;
3072 gser_decoder_func *cd_gser_decoder;
3073 ber_decoder_func *cd_ber_decoder;
3074 comp_free_func *cd_free;
3075 extract_component_from_id_func* cd_extract_i;
3076 allcomponent_matching_func *cd_all_match;
3079 typedef struct slap_component_syntax_info {
3081 ComponentDesc* csi_comp_desc;
3082 } ComponentSyntaxInfo;
3086 /* slab heap data structures */
3088 struct slab_object {
3091 LDAP_LIST_ENTRY(slab_object) so_link;
3100 unsigned char **sh_map;
3101 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3102 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3105 #ifdef SLAP_ZONE_ALLOC
3106 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3107 #define SLAP_ZONE_SHIFT 19
3108 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3109 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3110 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3111 #define SLAP_ZONE_ZOBLOCK 256
3113 struct zone_object {
3118 LDAP_LIST_ENTRY(zone_object) zo_link;
3121 struct zone_latency_history {
3123 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3134 ldap_pvt_thread_rdwr_t *zh_znlock;
3135 Avlnode *zh_zonetree;
3136 unsigned char ***zh_maps;
3138 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3139 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3140 ldap_pvt_thread_mutex_t zh_mutex;
3141 ldap_pvt_thread_rdwr_t zh_lock;
3142 double zh_ema_latency;
3143 unsigned long zh_ema_samples;
3144 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3145 zh_latency_history_queue;
3146 int zh_latency_history_qlen;
3147 int zh_latency_jump;
3152 #define SLAP_BACKEND_INIT_MODULE(b) \
3153 static BackendInfo bi; \
3155 init_module( int argc, char *argv[] ) \
3158 bi.bi_init = b ## _back_initialize; \
3159 backend_add( &bi ); \
3163 typedef int (OV_init)(void);
3164 typedef struct slap_oinit_t {
3165 const char *ov_type;
3171 #include "proto-slap.h"
3173 #endif /* _SLAP_H_ */