1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2008 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
30 #include "ldap_defaults.h"
33 #include <ac/stdlib.h>
35 #include <sys/types.h>
36 #include <ac/syslog.h>
38 #include <ac/signal.h>
39 #include <ac/socket.h>
46 #define ldap_debug slap_debug
52 #include <ldap_schema.h>
56 #include "ldap_pvt_thread.h"
57 #include "ldap_queue.h"
62 #define LDAP_COLLECTIVE_ATTRIBUTES
63 #define LDAP_COMP_MATCH
64 #define LDAP_SYNC_TIMESTAMP
65 #define SLAP_CONTROL_X_SORTEDRESULTS
66 #define SLAP_CONTROL_X_SESSION_TRACKING
67 #define SLAP_CONFIG_DELETE
70 #define LDAP_DYNAMIC_OBJECTS
71 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
75 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
79 * SLAPD Memory allocation macros
81 * Unlike ch_*() routines, these routines do not assert() upon
82 * allocation error. They are intended to be used instead of
83 * ch_*() routines where the caller has implemented proper
84 * checking for and handling of allocation errors.
86 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
88 #define SLAP_MALLOC(s) ber_memalloc((s))
89 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
90 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
91 #define SLAP_FREE(p) ber_memfree((p))
92 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
93 #define SLAP_STRDUP(s) ber_strdup((s))
94 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
97 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
100 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
101 #define SLAPD_ANONYMOUS ""
105 # define SLAP_STRING_UNKNOWN STRING_UNKNOWN
106 #else /* ! TCP Wrappers */
107 # define SLAP_STRING_UNKNOWN "unknown"
108 #endif /* ! TCP Wrappers */
110 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
111 * This is a value used internally by the backends. It is needed to allow
112 * adding values that already exist without getting an error as required by
113 * modrdn when the new rdn was already an attribute value itself.
115 #define SLAP_MOD_SOFTADD 0x1000
117 #define MAXREMATCHES (100)
119 #define SLAP_MAX_WORKER_THREADS (16)
121 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
122 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
124 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
125 #define SLAP_CONN_MAX_PENDING_AUTH 1000
127 #define SLAP_TEXT_BUFLEN (256)
129 /* psuedo error code indicating abandoned operation */
130 #define SLAPD_ABANDON (-1024)
132 /* psuedo error code indicating disconnect */
133 #define SLAPD_DISCONNECT (-1025)
135 /* unknown config file directive */
136 #define SLAP_CONF_UNKNOWN (-1026)
138 /* We assume "C" locale, that is US-ASCII */
139 #define ASCII_SPACE(c) ( (c) == ' ' )
140 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
141 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
142 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
143 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
144 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
145 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
146 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
147 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
148 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
149 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
151 #define SLAP_NIBBLE(c) ((c)&0x0f)
152 #define SLAP_ESCAPE_CHAR ('\\')
153 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
154 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
156 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
157 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
159 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
160 /* NOTE: for consistency, this macro must only operate
161 * on normalized/pretty DN, such that ';' is never used
162 * as RDN separator, and all occurrences of ';' must be escaped */
163 #define DN_SEPARATOR(c) ((c) == ',')
164 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */
165 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
166 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
168 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
169 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
170 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
171 #define OID_SEPARATOR(c) ( (c) == '.' )
172 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
174 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
175 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
177 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
178 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
180 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
182 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
183 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
184 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
185 (c) == '?' || (c) == ' ' || (c) == '=' )
186 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
188 /* must match in schema_init.c */
189 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
190 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
191 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
192 #define SLAPD_GROUP_ATTR "member"
193 #define SLAPD_GROUP_CLASS "groupOfNames"
194 #define SLAPD_ROLE_ATTR "roleOccupant"
195 #define SLAPD_ROLE_CLASS "organizationalRole"
197 #define SLAPD_TOP_OID "2.5.6.0"
199 LDAP_SLAPD_V (int) slap_debug;
201 typedef unsigned long slap_mask_t;
203 /* Security Strength Factor */
204 typedef unsigned slap_ssf_t;
206 typedef struct slap_ssf_set {
208 slap_ssf_t sss_transport;
211 slap_ssf_t sss_update_ssf;
212 slap_ssf_t sss_update_transport;
213 slap_ssf_t sss_update_tls;
214 slap_ssf_t sss_update_sasl;
215 slap_ssf_t sss_simple_bind;
218 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
219 #define SLAP_GETDN_AUTHCID 2
220 #define SLAP_GETDN_AUTHZID 4
225 #define SLAP_INDEX_TYPE 0x00FFUL
226 #define SLAP_INDEX_UNDEFINED 0x0001UL
227 #define SLAP_INDEX_PRESENT 0x0002UL
228 #define SLAP_INDEX_EQUALITY 0x0004UL
229 #define SLAP_INDEX_APPROX 0x0008UL
230 #define SLAP_INDEX_SUBSTR 0x0010UL
231 #define SLAP_INDEX_EXTENDED 0x0020UL
233 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
235 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
237 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
239 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
240 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
241 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
242 #define SLAP_INDEX_SUBSTR_DEFAULT \
243 ( SLAP_INDEX_SUBSTR \
244 | SLAP_INDEX_SUBSTR_INITIAL \
245 | SLAP_INDEX_SUBSTR_ANY \
246 | SLAP_INDEX_SUBSTR_FINAL )
248 /* defaults for initial/final substring indices */
249 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
250 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
252 /* defaults for any substring indices */
253 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
254 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
256 /* default for ordered integer index keys */
257 #define SLAP_INDEX_INTLEN_DEFAULT 4
259 #define SLAP_INDEX_FLAGS 0xF000UL
260 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
261 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
264 * there is a single index for each attribute. these prefixes ensure
265 * that there is no collision among keys.
267 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
268 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
269 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
270 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
271 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
272 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
274 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
275 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
276 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
277 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
278 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
281 * represents schema information for a database
284 SLAP_SCHERR_OUTOFMEM = 1,
285 SLAP_SCHERR_CLASS_NOT_FOUND,
286 SLAP_SCHERR_CLASS_BAD_USAGE,
287 SLAP_SCHERR_CLASS_BAD_SUP,
288 SLAP_SCHERR_CLASS_DUP,
289 SLAP_SCHERR_CLASS_INCONSISTENT,
290 SLAP_SCHERR_ATTR_NOT_FOUND,
291 SLAP_SCHERR_ATTR_BAD_MR,
292 SLAP_SCHERR_ATTR_BAD_USAGE,
293 SLAP_SCHERR_ATTR_BAD_SUP,
294 SLAP_SCHERR_ATTR_INCOMPLETE,
295 SLAP_SCHERR_ATTR_DUP,
296 SLAP_SCHERR_ATTR_INCONSISTENT,
297 SLAP_SCHERR_MR_NOT_FOUND,
298 SLAP_SCHERR_MR_INCOMPLETE,
300 SLAP_SCHERR_SYN_NOT_FOUND,
302 SLAP_SCHERR_SYN_SUP_NOT_FOUND,
303 SLAP_SCHERR_SYN_SUBST_NOT_SPECIFIED,
304 SLAP_SCHERR_SYN_SUBST_NOT_FOUND,
306 SLAP_SCHERR_NOT_SUPPORTED,
307 SLAP_SCHERR_BAD_DESCR,
310 SLAP_SCHERR_CR_BAD_STRUCT,
311 SLAP_SCHERR_CR_BAD_AUX,
312 SLAP_SCHERR_CR_BAD_AT,
317 /* forward declarations */
318 typedef struct Syntax Syntax;
319 typedef struct MatchingRule MatchingRule;
320 typedef struct MatchingRuleUse MatchingRuleUse;
321 typedef struct MatchingRuleAssertion MatchingRuleAssertion;
322 typedef struct OidMacro OidMacro;
323 typedef struct ObjectClass ObjectClass;
324 typedef struct AttributeType AttributeType;
325 typedef struct AttributeDescription AttributeDescription;
326 typedef struct AttributeName AttributeName;
327 typedef struct ContentRule ContentRule;
329 typedef struct AttributeAssertion AttributeAssertion;
330 typedef struct SubstringsAssertion SubstringsAssertion;
331 typedef struct Filter Filter;
332 typedef struct ValuesReturnFilter ValuesReturnFilter;
333 typedef struct Attribute Attribute;
334 #ifdef LDAP_COMP_MATCH
335 typedef struct ComponentData ComponentData;
336 typedef struct ComponentFilter ComponentFilter;
339 typedef struct Entry Entry;
340 typedef struct Modification Modification;
341 typedef struct Modifications Modifications;
342 typedef struct LDAPModList LDAPModList;
344 typedef struct BackendInfo BackendInfo; /* per backend type */
345 typedef struct BackendDB BackendDB; /* per backend database */
347 typedef struct Connection Connection;
348 typedef struct Operation Operation;
349 typedef struct SlapReply SlapReply;
350 /* end of forward declarations */
352 typedef union Sockaddr {
353 struct sockaddr sa_addr;
354 struct sockaddr_in sa_in_addr;
356 struct sockaddr_storage sa_storage;
357 struct sockaddr_in6 sa_in6_addr;
360 struct sockaddr_un sa_un_addr;
365 extern int slap_inet4or6;
369 struct berval som_oid;
372 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
374 LDAP_STAILQ_ENTRY(OidMacro) som_next;
377 typedef int slap_syntax_validate_func LDAP_P((
379 struct berval * in));
381 typedef int slap_syntax_transform_func LDAP_P((
387 #ifdef LDAP_COMP_MATCH
388 typedef void* slap_component_transform_func LDAP_P((
389 struct berval * in ));
390 struct ComponentDesc;
395 #define ssyn_oid ssyn_syn.syn_oid
396 #define ssyn_desc ssyn_syn.syn_desc
397 #define ssyn_extensions ssyn_syn.syn_extensions
400 ber_len_t ssyn_oidlen;
401 * has been replaced by a struct berval that uses the value
402 * provided by ssyn_syn.syn_oid; a macro that expands to
403 * the bv_len field of the berval is provided for backward
404 * compatibility. CAUTION: NEVER FREE THE BERVAL
406 struct berval ssyn_bvoid;
407 #define ssyn_oidlen ssyn_bvoid.bv_len
409 unsigned int ssyn_flags;
411 #define SLAP_SYNTAX_NONE 0x0000U
412 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
413 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
414 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
416 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
418 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
423 slap_syntax_validate_func *ssyn_validate;
424 slap_syntax_transform_func *ssyn_pretty;
426 #ifdef SLAPD_BINARY_CONVERSION
427 /* convert to and from binary */
428 slap_syntax_transform_func *ssyn_ber2str;
429 slap_syntax_transform_func *ssyn_str2ber;
431 #ifdef LDAP_COMP_MATCH
432 slap_component_transform_func *ssyn_attr2comp;
433 struct ComponentDesc* ssync_comp_syntax;
436 LDAP_SLIST_ENTRY(Syntax) ssyn_next;
439 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
440 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
441 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
442 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
443 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
445 typedef struct slap_syntax_defs_rec {
449 slap_syntax_validate_func *sd_validate;
450 slap_syntax_transform_func *sd_pretty;
451 #ifdef SLAPD_BINARY_CONVERSION
452 slap_syntax_transform_func *sd_ber2str;
453 slap_syntax_transform_func *sd_str2ber;
455 } slap_syntax_defs_rec;
457 /* X -> Y Converter */
458 typedef int slap_mr_convert_func LDAP_P((
464 typedef int slap_mr_normalize_func LDAP_P((
466 Syntax *syntax, /* NULL if in is asserted value */
472 /* Match (compare) function */
473 typedef int slap_mr_match_func LDAP_P((
476 Syntax *syntax, /* syntax of stored value */
478 struct berval *value,
479 void *assertValue ));
481 /* Index generation function */
482 typedef int slap_mr_indexer_func LDAP_P((
485 Syntax *syntax, /* syntax of stored value */
487 struct berval *prefix,
492 /* Filter index function */
493 typedef int slap_mr_filter_func LDAP_P((
496 Syntax *syntax, /* syntax of stored value */
498 struct berval *prefix,
503 struct MatchingRule {
504 LDAPMatchingRule smr_mrule;
505 MatchingRuleUse *smr_mru;
506 /* RFC 4512 string representation */
507 struct berval smr_str;
510 * ber_len_t smr_oidlen;
511 * has been replaced by a struct berval that uses the value
512 * provided by smr_mrule.mr_oid; a macro that expands to
513 * the bv_len field of the berval is provided for backward
514 * compatibility. CAUTION: NEVER FREE THE BERVAL
516 struct berval smr_bvoid;
517 #define smr_oidlen smr_bvoid.bv_len
519 slap_mask_t smr_usage;
522 #define SLAP_MR_HIDE 0x0000U
524 #define SLAP_MR_HIDE 0x8000U
527 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
529 #define SLAP_MR_TYPE_MASK 0x0F00U
530 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
531 #define SLAP_MR_USAGE 0x000FU
533 #define SLAP_MR_NONE 0x0000U
534 #define SLAP_MR_EQUALITY 0x0100U
535 #define SLAP_MR_ORDERING 0x0200U
536 #define SLAP_MR_SUBSTR 0x0400U
537 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
538 #define SLAP_MR_ORDERED_INDEX 0x1000U
539 #ifdef LDAP_COMP_MATCH
540 #define SLAP_MR_COMPONENT 0x2000U
543 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
545 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
546 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
547 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
551 * The asserted value, depending on the particular usage,
552 * is expected to conform to either the assertion syntax
553 * or the attribute syntax. In some cases, the syntax of
554 * the value is known. If so, these flags indicate which
555 * syntax the value is expected to conform to. If not,
556 * neither of these flags is set (until the syntax of the
557 * provided value is determined). If the value is of the
558 * attribute syntax, the flag is changed once a value of
559 * the assertion syntax is derived from the provided value.
561 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
562 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
563 #define SLAP_MR_VALUE_OF_SYNTAX (SLAP_MR_VALUE_OF_ASSERTION_SYNTAX|SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX)
564 #define SLAP_MR_DENORMALIZE (SLAP_MR_MUTATION_NORMALIZER)
566 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
567 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
568 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
569 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
571 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
572 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
574 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
576 #define SLAP_MR_IS_DENORMALIZE( usage ) \
577 ((usage) & SLAP_MR_DENORMALIZE )
579 /* either or both the asserted value or attribute value
580 * may be provided in normalized form
582 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
583 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
585 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
586 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
587 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
588 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
590 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
591 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
592 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
593 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
594 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
595 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
597 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
598 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
599 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
600 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
603 slap_mr_convert_func *smr_convert;
604 slap_mr_normalize_func *smr_normalize;
605 slap_mr_match_func *smr_match;
606 slap_mr_indexer_func *smr_indexer;
607 slap_mr_filter_func *smr_filter;
610 * null terminated array of syntaxes compatible with this syntax
611 * note: when MS_EXT is set, this MUST NOT contain the assertion
612 * syntax of the rule. When MS_EXT is not set, it MAY.
614 Syntax **smr_compat_syntaxes;
617 * For equality rules, refers to an associated approximate rule.
618 * For non-equality rules, refers to an associated equality rule.
620 MatchingRule *smr_associated;
622 #define SLAP_MR_ASSOCIATED(mr,amr) \
623 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
625 LDAP_SLIST_ENTRY(MatchingRule) smr_next;
627 #define smr_oid smr_mrule.mr_oid
628 #define smr_names smr_mrule.mr_names
629 #define smr_desc smr_mrule.mr_desc
630 #define smr_obsolete smr_mrule.mr_obsolete
631 #define smr_syntax_oid smr_mrule.mr_syntax_oid
632 #define smr_extensions smr_mrule.mr_extensions
635 struct MatchingRuleUse {
636 LDAPMatchingRuleUse smru_mruleuse;
637 MatchingRule *smru_mr;
638 /* RFC 4512 string representation */
639 struct berval smru_str;
641 LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next;
643 #define smru_oid smru_mruleuse.mru_oid
644 #define smru_names smru_mruleuse.mru_names
645 #define smru_desc smru_mruleuse.mru_desc
646 #define smru_obsolete smru_mruleuse.mru_obsolete
647 #define smru_applies_oids smru_mruleuse.mru_applies_oids
649 #define smru_usage smru_mr->smr_usage
650 } /* MatchingRuleUse */ ;
652 typedef struct slap_mrule_defs_rec {
654 slap_mask_t mrd_usage;
655 char ** mrd_compat_syntaxes;
656 slap_mr_convert_func * mrd_convert;
657 slap_mr_normalize_func * mrd_normalize;
658 slap_mr_match_func * mrd_match;
659 slap_mr_indexer_func * mrd_indexer;
660 slap_mr_filter_func * mrd_filter;
662 /* For equality rule, this may refer to an associated approximate rule */
663 /* For non-equality rule, this may refer to an associated equality rule */
664 char * mrd_associated;
665 } slap_mrule_defs_rec;
667 typedef int (AttributeTypeSchemaCheckFN)(
672 char *textbuf, size_t textlen );
674 struct AttributeType {
675 LDAPAttributeType sat_atype;
676 struct berval sat_cname;
677 AttributeType *sat_sup;
678 AttributeType **sat_subtypes;
679 MatchingRule *sat_equality;
680 MatchingRule *sat_approx;
681 MatchingRule *sat_ordering;
682 MatchingRule *sat_substr;
685 AttributeTypeSchemaCheckFN *sat_check;
686 char *sat_oidmacro; /* attribute OID */
687 char *sat_soidmacro; /* syntax OID */
689 #define SLAP_AT_NONE 0x0000U
690 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
691 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
693 #define SLAP_AT_HIDE 0x0000U /* publish everything */
695 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
697 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
699 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
701 /* Note: ORDERED values have an ordering specifically set by the
702 * user, denoted by the {x} ordering prefix on the values.
704 * SORTED values are simply sorted by memcmp. SORTED values can
705 * be efficiently located by binary search. ORDERED values have no
706 * such advantage. An attribute cannot have both properties.
708 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
709 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
710 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
712 #define SLAP_AT_SORTED_VAL 0x0010U /* values should be sorted */
714 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
715 #define SLAP_AT_DELETED 0x20000U
717 slap_mask_t sat_flags;
719 LDAP_STAILQ_ENTRY(AttributeType) sat_next;
721 #define sat_oid sat_atype.at_oid
722 #define sat_names sat_atype.at_names
723 #define sat_desc sat_atype.at_desc
724 #define sat_obsolete sat_atype.at_obsolete
725 #define sat_sup_oid sat_atype.at_sup_oid
726 #define sat_equality_oid sat_atype.at_equality_oid
727 #define sat_ordering_oid sat_atype.at_ordering_oid
728 #define sat_substr_oid sat_atype.at_substr_oid
729 #define sat_syntax_oid sat_atype.at_syntax_oid
730 #define sat_single_value sat_atype.at_single_value
731 #define sat_collective sat_atype.at_collective
732 #define sat_no_user_mod sat_atype.at_no_user_mod
733 #define sat_usage sat_atype.at_usage
734 #define sat_extensions sat_atype.at_extensions
736 AttributeDescription *sat_ad;
737 ldap_pvt_thread_mutex_t sat_ad_mutex;
740 #define is_at_operational(at) ((at)->sat_usage)
741 #define is_at_single_value(at) ((at)->sat_single_value)
742 #define is_at_collective(at) ((at)->sat_collective)
743 #define is_at_obsolete(at) ((at)->sat_obsolete)
744 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
746 typedef int (ObjectClassSchemaCheckFN)(
751 char *textbuf, size_t textlen );
754 LDAPObjectClass soc_oclass;
755 struct berval soc_cname;
756 ObjectClass **soc_sups;
757 AttributeType **soc_required;
758 AttributeType **soc_allowed;
759 ObjectClassSchemaCheckFN *soc_check;
761 slap_mask_t soc_flags;
762 #define soc_oid soc_oclass.oc_oid
763 #define soc_names soc_oclass.oc_names
764 #define soc_desc soc_oclass.oc_desc
765 #define soc_obsolete soc_oclass.oc_obsolete
766 #define soc_sup_oids soc_oclass.oc_sup_oids
767 #define soc_kind soc_oclass.oc_kind
768 #define soc_at_oids_must soc_oclass.oc_at_oids_must
769 #define soc_at_oids_may soc_oclass.oc_at_oids_may
770 #define soc_extensions soc_oclass.oc_extensions
772 LDAP_STAILQ_ENTRY(ObjectClass) soc_next;
775 #define SLAP_OCF_SET_FLAGS 0x1
776 #define SLAP_OCF_CHECK_SUP 0x2
777 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
779 #define SLAP_OC_ALIAS 0x0001
780 #define SLAP_OC_REFERRAL 0x0002
781 #define SLAP_OC_SUBENTRY 0x0004
782 #define SLAP_OC_DYNAMICOBJECT 0x0008
783 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
784 #define SLAP_OC_GLUE 0x0020
785 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
786 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
787 #define SLAP_OC__MASK 0x00FF
788 #define SLAP_OC__END 0x0100
789 #define SLAP_OC_OPERATIONAL 0x4000
791 #define SLAP_OC_HIDE 0x0000
793 #define SLAP_OC_HIDE 0x8000
795 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
796 #define SLAP_OC_DELETED 0x20000U
802 LDAPContentRule scr_crule;
803 ObjectClass *scr_sclass;
804 ObjectClass **scr_auxiliaries; /* optional */
805 AttributeType **scr_required; /* optional */
806 AttributeType **scr_allowed; /* optional */
807 AttributeType **scr_precluded; /* optional */
808 #define scr_oid scr_crule.cr_oid
809 #define scr_names scr_crule.cr_names
810 #define scr_desc scr_crule.cr_desc
811 #define scr_obsolete scr_crule.cr_obsolete
812 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
813 #define scr_at_oids_must scr_crule.cr_at_oids_must
814 #define scr_at_oids_may scr_crule.cr_at_oids_may
815 #define scr_at_oids_not scr_crule.cr_at_oids_not
818 #define SLAP_CR_HARDCODE 0x10000U
821 LDAP_STAILQ_ENTRY( ContentRule ) scr_next;
824 /* Represents a recognized attribute description ( type + options ). */
825 struct AttributeDescription {
826 AttributeDescription *ad_next;
827 AttributeType *ad_type; /* attribute type, must be specified */
828 struct berval ad_cname; /* canonical name, must be specified */
829 struct berval ad_tags; /* empty if no tagging options */
831 #define SLAP_DESC_NONE 0x00U
832 #define SLAP_DESC_BINARY 0x01U
833 #define SLAP_DESC_TAG_RANGE 0x80U
834 #define SLAP_DESC_TEMPORARY 0x1000U
837 /* flags to slap_*2undef_ad to register undefined (0, the default)
838 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
839 * SLAP_AD_NOINSERT is to lookup without insert */
840 #define SLAP_AD_UNDEF 0x00U
841 #define SLAP_AD_PROXIED 0x01U
842 #define SLAP_AD_NOINSERT 0x02U
844 struct AttributeName {
845 struct berval an_name;
846 AttributeDescription *an_desc;
851 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
852 #define slap_ad_is_tag_range(ad) \
853 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
854 #define slap_ad_is_binary(ad) \
855 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
858 * pointers to schema elements used internally
860 struct slap_internal_schema {
862 ObjectClass *si_oc_top;
863 ObjectClass *si_oc_extensibleObject;
864 ObjectClass *si_oc_alias;
865 ObjectClass *si_oc_referral;
866 ObjectClass *si_oc_rootdse;
867 ObjectClass *si_oc_subentry;
868 ObjectClass *si_oc_subschema;
869 ObjectClass *si_oc_collectiveAttributeSubentry;
870 ObjectClass *si_oc_dynamicObject;
872 ObjectClass *si_oc_glue;
873 ObjectClass *si_oc_syncConsumerSubentry;
874 ObjectClass *si_oc_syncProviderSubentry;
876 /* objectClass attribute descriptions */
877 AttributeDescription *si_ad_objectClass;
879 /* operational attribute descriptions */
880 AttributeDescription *si_ad_structuralObjectClass;
881 AttributeDescription *si_ad_creatorsName;
882 AttributeDescription *si_ad_createTimestamp;
883 AttributeDescription *si_ad_modifiersName;
884 AttributeDescription *si_ad_modifyTimestamp;
885 AttributeDescription *si_ad_hasSubordinates;
886 AttributeDescription *si_ad_subschemaSubentry;
887 AttributeDescription *si_ad_collectiveSubentries;
888 AttributeDescription *si_ad_collectiveExclusions;
889 AttributeDescription *si_ad_entryDN;
890 AttributeDescription *si_ad_entryUUID;
891 AttributeDescription *si_ad_entryCSN;
892 AttributeDescription *si_ad_namingCSN;
894 AttributeDescription *si_ad_dseType;
895 AttributeDescription *si_ad_syncreplCookie;
896 AttributeDescription *si_ad_syncTimestamp;
897 AttributeDescription *si_ad_contextCSN;
899 /* root DSE attribute descriptions */
900 AttributeDescription *si_ad_altServer;
901 AttributeDescription *si_ad_namingContexts;
902 AttributeDescription *si_ad_supportedControl;
903 AttributeDescription *si_ad_supportedExtension;
904 AttributeDescription *si_ad_supportedLDAPVersion;
905 AttributeDescription *si_ad_supportedSASLMechanisms;
906 AttributeDescription *si_ad_supportedFeatures;
907 AttributeDescription *si_ad_monitorContext;
908 AttributeDescription *si_ad_vendorName;
909 AttributeDescription *si_ad_vendorVersion;
910 AttributeDescription *si_ad_configContext;
912 /* subentry attribute descriptions */
913 AttributeDescription *si_ad_administrativeRole;
914 AttributeDescription *si_ad_subtreeSpecification;
916 /* subschema subentry attribute descriptions */
917 AttributeDescription *si_ad_attributeTypes;
918 AttributeDescription *si_ad_ditContentRules;
919 AttributeDescription *si_ad_ditStructureRules;
920 AttributeDescription *si_ad_ldapSyntaxes;
921 AttributeDescription *si_ad_matchingRules;
922 AttributeDescription *si_ad_matchingRuleUse;
923 AttributeDescription *si_ad_nameForms;
924 AttributeDescription *si_ad_objectClasses;
926 /* Aliases & Referrals */
927 AttributeDescription *si_ad_aliasedObjectName;
928 AttributeDescription *si_ad_ref;
930 /* Access Control Internals */
931 AttributeDescription *si_ad_entry;
932 AttributeDescription *si_ad_children;
933 AttributeDescription *si_ad_saslAuthzTo;
934 AttributeDescription *si_ad_saslAuthzFrom;
936 /* dynamic entries */
937 AttributeDescription *si_ad_entryTtl;
938 AttributeDescription *si_ad_dynamicSubtrees;
940 /* Other attributes descriptions */
941 AttributeDescription *si_ad_distinguishedName;
942 AttributeDescription *si_ad_name;
943 AttributeDescription *si_ad_cn;
944 AttributeDescription *si_ad_uid;
945 AttributeDescription *si_ad_uidNumber;
946 AttributeDescription *si_ad_gidNumber;
947 AttributeDescription *si_ad_userPassword;
948 AttributeDescription *si_ad_labeledURI;
949 #ifdef SLAPD_AUTHPASSWD
950 AttributeDescription *si_ad_authPassword;
951 AttributeDescription *si_ad_authPasswordSchemes;
953 AttributeDescription *si_ad_description;
954 AttributeDescription *si_ad_seeAlso;
956 /* Undefined Attribute Type */
957 AttributeType *si_at_undefined;
959 /* "Proxied" Attribute Type */
960 AttributeType *si_at_proxied;
963 MatchingRule *si_mr_distinguishedNameMatch;
964 MatchingRule *si_mr_dnSubtreeMatch;
965 MatchingRule *si_mr_dnOneLevelMatch;
966 MatchingRule *si_mr_dnSubordinateMatch;
967 MatchingRule *si_mr_dnSuperiorMatch;
968 MatchingRule *si_mr_caseExactMatch;
969 MatchingRule *si_mr_caseExactSubstringsMatch;
970 MatchingRule *si_mr_caseExactIA5Match;
971 MatchingRule *si_mr_integerMatch;
972 MatchingRule *si_mr_integerFirstComponentMatch;
973 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
974 MatchingRule *si_mr_caseIgnoreMatch;
975 MatchingRule *si_mr_caseIgnoreListMatch;
978 Syntax *si_syn_directoryString;
979 Syntax *si_syn_distinguishedName;
980 Syntax *si_syn_integer;
981 Syntax *si_syn_octetString;
983 /* Schema Syntaxes */
984 Syntax *si_syn_attributeTypeDesc;
985 Syntax *si_syn_ditContentRuleDesc;
986 Syntax *si_syn_ditStructureRuleDesc;
987 Syntax *si_syn_ldapSyntaxDesc;
988 Syntax *si_syn_matchingRuleDesc;
989 Syntax *si_syn_matchingRuleUseDesc;
990 Syntax *si_syn_nameFormDesc;
991 Syntax *si_syn_objectClassDesc;
994 struct AttributeAssertion {
995 AttributeDescription *aa_desc;
996 struct berval aa_value;
997 #ifdef LDAP_COMP_MATCH
998 ComponentFilter *aa_cf; /* for attribute aliasing */
1001 #ifdef LDAP_COMP_MATCH
1002 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL, NULL }
1004 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL }
1007 struct SubstringsAssertion {
1008 AttributeDescription *sa_desc;
1009 struct berval sa_initial;
1010 struct berval *sa_any;
1011 struct berval sa_final;
1014 struct MatchingRuleAssertion {
1015 AttributeDescription *ma_desc; /* optional */
1016 struct berval ma_value; /* required */
1017 MatchingRule *ma_rule; /* optional */
1018 struct berval ma_rule_text; /* optional */
1019 int ma_dnattrs; /* boolean */
1020 #ifdef LDAP_COMP_MATCH
1021 ComponentFilter *ma_cf; /* component filter */
1026 * represents a search filter
1029 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
1030 #define SLAPD_FILTER_COMPUTED 0
1031 #define SLAPD_FILTER_MASK 0x7fff
1032 #define SLAPD_FILTER_UNDEFINED 0x8000
1035 /* precomputed result */
1036 ber_int_t f_un_result;
1039 AttributeDescription *f_un_desc;
1041 /* simple value assertion */
1042 AttributeAssertion *f_un_ava;
1044 /* substring assertion */
1045 SubstringsAssertion *f_un_ssa;
1047 /* matching rule assertion */
1048 MatchingRuleAssertion *f_un_mra;
1050 #define f_desc f_un.f_un_desc
1051 #define f_ava f_un.f_un_ava
1052 #define f_av_desc f_un.f_un_ava->aa_desc
1053 #define f_av_value f_un.f_un_ava->aa_value
1054 #define f_sub f_un.f_un_ssa
1055 #define f_sub_desc f_un.f_un_ssa->sa_desc
1056 #define f_sub_initial f_un.f_un_ssa->sa_initial
1057 #define f_sub_any f_un.f_un_ssa->sa_any
1058 #define f_sub_final f_un.f_un_ssa->sa_final
1059 #define f_mra f_un.f_un_mra
1060 #define f_mr_rule f_un.f_un_mra->ma_rule
1061 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1062 #define f_mr_desc f_un.f_un_mra->ma_desc
1063 #define f_mr_value f_un.f_un_mra->ma_value
1064 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1067 Filter *f_un_complex;
1070 #define f_result f_un.f_un_result
1071 #define f_and f_un.f_un_complex
1072 #define f_or f_un.f_un_complex
1073 #define f_not f_un.f_un_complex
1074 #define f_list f_un.f_un_complex
1079 /* compare routines can return undefined */
1080 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1082 struct ValuesReturnFilter {
1083 ber_tag_t vrf_choice;
1086 /* precomputed result */
1087 ber_int_t vrf_un_result;
1093 AttributeDescription *vrf_un_desc;
1095 /* simple value assertion */
1096 AttributeAssertion *vrf_un_ava;
1098 /* substring assertion */
1099 SubstringsAssertion *vrf_un_ssa;
1101 /* matching rule assertion */
1102 MatchingRuleAssertion *vrf_un_mra;
1104 #define vrf_result vrf_un.vrf_un_result
1105 #define vrf_dn vrf_un.vrf_un_dn
1106 #define vrf_desc vrf_un.vrf_un_desc
1107 #define vrf_ava vrf_un.vrf_un_ava
1108 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1109 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1110 #define vrf_ssa vrf_un.vrf_un_ssa
1111 #define vrf_sub vrf_un.vrf_un_ssa
1112 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1113 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1114 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1115 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1116 #define vrf_mra vrf_un.vrf_un_mra
1117 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1118 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1119 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1120 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1121 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1126 ValuesReturnFilter *vrf_next;
1130 * represents an attribute (description + values)
1131 * desc, vals, nvals, numvals fields must align with Modification
1134 AttributeDescription *a_desc;
1135 BerVarray a_vals; /* preserved values */
1136 BerVarray a_nvals; /* normalized values */
1137 unsigned a_numvals; /* number of vals */
1139 #define SLAP_ATTR_IXADD 0x1U
1140 #define SLAP_ATTR_IXDEL 0x2U
1141 #define SLAP_ATTR_DONT_FREE_DATA 0x4U
1142 #define SLAP_ATTR_DONT_FREE_VALS 0x8U
1143 #define SLAP_ATTR_SORTED_VALS 0x10U /* values are sorted */
1145 /* These flags persist across an attr_dup() */
1146 #define SLAP_ATTR_PERSISTENT_FLAGS \
1147 SLAP_ATTR_SORTED_VALS
1150 #ifdef LDAP_COMP_MATCH
1151 ComponentData *a_comp_data; /* component values */
1157 * the id used in the indexes to refer to an entry
1159 typedef unsigned long ID;
1160 #define NOID ((ID)~0)
1162 typedef struct EntryHeader {
1170 * represents an entry in core
1174 * The ID field should only be changed before entry is
1175 * inserted into a cache. The ID value is backend
1180 struct berval e_name; /* name (DN) of this entry */
1181 struct berval e_nname; /* normalized name (DN) of this entry */
1183 /* for migration purposes */
1184 #define e_dn e_name.bv_val
1185 #define e_ndn e_nname.bv_val
1187 Attribute *e_attrs; /* list of attributes + values */
1189 slap_mask_t e_ocflags;
1191 struct berval e_bv; /* For entry_encode/entry_decode */
1193 /* for use by the backend for any purpose */
1198 * A list of LDAPMods
1199 * desc, values, nvalues, numvals must align with Attribute
1201 struct Modification {
1202 AttributeDescription *sm_desc;
1203 BerVarray sm_values;
1204 BerVarray sm_nvalues;
1205 unsigned sm_numvals;
1208 /* Set for internal mods, will bypass ACL checks. Only needed when
1209 * running as non-root user, for user modifiable attributes.
1211 #define SLAP_MOD_INTERNAL 0x01
1212 #define SLAP_MOD_MANAGING 0x02
1213 struct berval sm_type;
1216 struct Modifications {
1217 Modification sml_mod;
1218 #define sml_op sml_mod.sm_op
1219 #define sml_flags sml_mod.sm_flags
1220 #define sml_desc sml_mod.sm_desc
1221 #define sml_type sml_mod.sm_type
1222 #define sml_values sml_mod.sm_values
1223 #define sml_nvalues sml_mod.sm_nvalues
1224 #define sml_numvals sml_mod.sm_numvals
1225 Modifications *sml_next;
1229 * represents an access control list
1231 typedef enum slap_access_t {
1232 ACL_INVALID_ACCESS = -1,
1242 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1245 /* ACL level mask and modifiers */
1246 ACL_LEVEL_MASK = 0x000f,
1247 ACL_QUALIFIER1 = 0x0100,
1248 ACL_QUALIFIER2 = 0x0200,
1249 ACL_QUALIFIER3 = 0x0400,
1250 ACL_QUALIFIER4 = 0x0800,
1251 ACL_QUALIFIER_MASK = 0x0f00,
1253 /* write granularity */
1254 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1255 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1257 ACL_WRITE = ACL_WADD|ACL_WDEL
1260 typedef enum slap_control_e {
1261 ACL_INVALID_CONTROL = 0,
1267 typedef enum slap_style_e {
1268 ACL_STYLE_REGEX = 0,
1276 ACL_STYLE_ANONYMOUS,
1284 typedef struct AuthorizationInformation {
1285 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1286 struct berval sai_mech; /* SASL Mechanism */
1287 struct berval sai_dn; /* DN for reporting purposes */
1288 struct berval sai_ndn; /* Normalized DN */
1290 /* Security Strength Factors */
1291 slap_ssf_t sai_ssf; /* Overall SSF */
1292 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1293 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1294 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1295 } AuthorizationInformation;
1300 * "dynamic" ACL infrastructure (for ACIs and more)
1302 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1303 const char *opts, slap_style_t, const char *, void **privp ));
1304 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1305 typedef int (slap_dynacl_mask) LDAP_P((
1309 AttributeDescription *desc,
1312 regmatch_t *matches,
1313 slap_access_t *grant,
1314 slap_access_t *deny ));
1315 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1317 typedef struct slap_dynacl_t {
1319 slap_dynacl_parse *da_parse;
1320 slap_dynacl_unparse *da_unparse;
1321 slap_dynacl_mask *da_mask;
1322 slap_dynacl_destroy *da_destroy;
1325 struct slap_dynacl_t *da_next;
1327 #endif /* SLAP_DYNACL */
1329 /* the DN portion of the "by" part */
1330 typedef struct slap_dn_access {
1332 AuthorizationInformation a_dnauthz;
1333 #define a_pat a_dnauthz.sai_dn
1335 slap_style_t a_style;
1338 AttributeDescription *a_at;
1344 typedef struct Access {
1345 slap_control_t a_type;
1347 /* strip qualifiers */
1348 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1349 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1351 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1353 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1354 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1355 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1356 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1357 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1358 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1359 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1360 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1361 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1362 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1364 /* NOTE: always use the highest level; current: 0x00ffUL */
1365 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1368 #define ACL_PRIV_LEVEL 0x1000UL
1369 #define ACL_PRIV_ADDITIVE 0x2000UL
1370 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1373 #define ACL_PRIV_INVALID 0x0UL
1375 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1376 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1377 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1378 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1380 #define ACL_INIT(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_NONE)
1381 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_INVALID)
1383 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1385 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1387 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1388 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1389 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1391 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1392 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1393 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1394 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1395 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1396 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1397 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1398 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1399 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1400 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1402 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1403 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1404 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1405 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1406 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1407 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1408 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1409 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1410 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1411 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1412 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1414 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1415 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1416 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1417 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1418 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1419 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1420 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1421 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1422 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1423 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1425 slap_mask_t a_access_mask;
1428 slap_dn_access a_dn;
1429 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1430 #define a_dn_at a_dn.a_at
1431 #define a_dn_self a_dn.a_self
1433 /* real DN pattern */
1434 slap_dn_access a_realdn;
1435 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1436 #define a_realdn_at a_realdn.a_at
1437 #define a_realdn_self a_realdn.a_self
1439 /* used for ssf stuff
1440 * NOTE: the ssf stuff in a_realdn is ignored */
1441 #define a_authz a_dn.a_dnauthz
1443 /* connection related stuff */
1444 slap_style_t a_peername_style;
1445 struct berval a_peername_pat;
1446 #ifdef LDAP_PF_INET6
1448 struct in6_addr ax6;
1452 #define a_peername_addr6 ax_peername_addr.ax6
1453 #define a_peername_addr ax_peername_addr.ax
1454 #define a_peername_mask6 ax_peername_mask.ax6
1455 #define a_peername_mask ax_peername_mask.ax
1456 /* apparently, only s6_addr is portable;
1457 * define a portable address mask comparison */
1458 #define slap_addr6_mask(val, msk, asr) ( \
1459 (((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \
1460 && (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \
1461 && (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \
1462 && (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \
1463 && (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \
1464 && (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \
1465 && (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \
1466 && (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \
1467 && (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \
1468 && (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \
1469 && (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \
1470 && (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \
1471 && (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \
1472 && (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \
1473 && (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \
1474 && (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \
1476 #else /* ! LDAP_PF_INET6 */
1477 unsigned long a_peername_addr,
1479 #endif /* ! LDAP_PF_INET6 */
1480 int a_peername_port;
1482 slap_style_t a_sockname_style;
1483 struct berval a_sockname_pat;
1485 slap_style_t a_domain_style;
1486 struct berval a_domain_pat;
1487 int a_domain_expand;
1489 slap_style_t a_sockurl_style;
1490 struct berval a_sockurl_pat;
1491 slap_style_t a_set_style;
1492 struct berval a_set_pat;
1495 slap_dynacl_t *a_dynacl;
1496 #endif /* SLAP_DYNACL */
1499 slap_style_t a_group_style;
1500 struct berval a_group_pat;
1501 ObjectClass *a_group_oc;
1502 AttributeDescription *a_group_at;
1504 struct Access *a_next;
1508 typedef struct AccessControl {
1509 /* "to" part: the entries this acl applies to */
1511 slap_style_t acl_dn_style;
1513 struct berval acl_dn_pat;
1514 AttributeName *acl_attrs;
1515 MatchingRule *acl_attrval_mr;
1516 slap_style_t acl_attrval_style;
1517 regex_t acl_attrval_re;
1518 struct berval acl_attrval;
1520 /* "by" part: list of who has what access to the entries */
1523 struct AccessControl *acl_next;
1527 ACL_STATE_NOT_RECORDED = 0x0,
1528 ACL_STATE_RECORDED_VD = 0x1,
1529 ACL_STATE_RECORDED_NV = 0x2,
1530 ACL_STATE_RECORDED = ( ACL_STATE_RECORDED_VD | ACL_STATE_RECORDED_NV )
1533 typedef struct AccessControlState {
1535 AccessControl *as_vi_acl;
1536 AccessControl *as_vd_acl;
1537 AttributeDescription *as_vd_ad;
1540 slap_acl_state_t as_recorded;
1541 int as_vd_acl_count;
1543 } AccessControlState;
1544 #define ACL_STATE_INIT { NULL, NULL, NULL, \
1545 ACL_STATE_NOT_RECORDED, 0, 0 }
1549 * represents a backend
1552 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head;
1553 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head;
1555 LDAP_SLAPD_V (int) nBackendInfo;
1556 LDAP_SLAPD_V (int) nBackendDB;
1557 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1558 LDAP_SLAPD_V (slap_be_head) backendDB;
1559 LDAP_SLAPD_V (BackendDB *) frontendDB;
1561 LDAP_SLAPD_V (int) slapMode;
1562 #define SLAP_UNDEFINED_MODE 0x0000
1563 #define SLAP_SERVER_MODE 0x0001
1564 #define SLAP_TOOL_MODE 0x0002
1565 #define SLAP_MODE 0x0003
1567 #define SLAP_TRUNCATE_MODE 0x0100
1568 #define SLAP_TOOL_READMAIN 0x0200
1569 #define SLAP_TOOL_READONLY 0x0400
1570 #define SLAP_TOOL_QUICK 0x0800
1571 #define SLAP_TOOL_NO_SCHEMA_CHECK 0x1000
1573 #define SB_TLS_DEFAULT (-1)
1574 #define SB_TLS_OFF 0
1576 #define SB_TLS_CRITICAL 2
1578 typedef struct slap_bindconf {
1579 struct berval sb_uri;
1585 struct berval sb_binddn;
1586 struct berval sb_cred;
1587 struct berval sb_saslmech;
1589 struct berval sb_realm;
1590 struct berval sb_authcId;
1591 struct berval sb_authzId;
1596 char *sb_tls_cacert;
1597 char *sb_tls_cacertdir;
1598 char *sb_tls_reqcert;
1599 char *sb_tls_cipher_suite;
1600 #ifdef HAVE_OPENSSL_CRL
1601 char *sb_tls_crlcheck;
1607 typedef struct slap_verbmasks {
1609 const slap_mask_t mask;
1612 typedef struct slap_cf_aux_table {
1618 } slap_cf_aux_table;
1620 #define SLAP_LIMIT_TIME 1
1621 #define SLAP_LIMIT_SIZE 2
1623 struct slap_limits_set {
1631 int lms_s_unchecked;
1637 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1638 #define SLAP_NO_LIMIT -1
1639 #define SLAP_MAX_LIMIT 2147483647
1641 struct slap_limits {
1642 unsigned lm_flags; /* type of pattern */
1643 #define SLAP_LIMITS_UNDEFINED 0x0000U
1644 #define SLAP_LIMITS_EXACT 0x0001U
1645 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1646 #define SLAP_LIMITS_ONE 0x0002U
1647 #define SLAP_LIMITS_SUBTREE 0x0003U
1648 #define SLAP_LIMITS_CHILDREN 0x0004U
1649 #define SLAP_LIMITS_REGEX 0x0005U
1650 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1651 #define SLAP_LIMITS_USERS 0x0007U
1652 #define SLAP_LIMITS_ANY 0x0008U
1653 #define SLAP_LIMITS_MASK 0x000FU
1655 #define SLAP_LIMITS_TYPE_DN 0x0000U
1656 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1657 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1659 regex_t lm_regex; /* regex data for REGEX */
1662 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1663 * pattern for REGEX; NULL for ANONYMOUS, USERS
1665 struct berval lm_pat;
1667 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1668 * lm_group_oc is objectClass and lm_group_at is attributeType
1669 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1670 * can only be SLAP_LIMITS_EXACT */
1671 ObjectClass *lm_group_oc;
1672 AttributeDescription *lm_group_ad;
1674 struct slap_limits_set lm_limits;
1677 /* temporary aliases */
1678 typedef BackendDB Backend;
1679 #define nbackends nBackendDB
1680 #define backends backendDB
1683 * syncinfo structure for syncrepl
1688 #define SLAP_SYNC_RID_MAX 999
1689 #define SLAP_SYNC_SID_MAX 4095 /* based on liblutil/csn.c field width */
1690 #define SLAP_SYNCUUID_SET_SIZE 256
1692 #define SLAP_SYNC_UPDATE_MSGID 1
1694 struct sync_cookie {
1695 struct berval *ctxcsn;
1696 struct berval octet_str;
1701 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1704 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1706 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1708 #ifndef SLAP_MAX_CIDS
1709 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1712 struct ConfigOCs; /* config.h */
1715 BackendInfo *bd_info; /* pointer to shared backend info */
1716 BackendDB *bd_self; /* pointer to this struct */
1718 /* fields in this structure (and routines acting on this structure)
1719 should be renamed from be_ to bd_ */
1721 /* BackendInfo accessors */
1722 #define be_config bd_info->bi_db_config
1723 #define be_type bd_info->bi_type
1725 #define be_bind bd_info->bi_op_bind
1726 #define be_unbind bd_info->bi_op_unbind
1727 #define be_add bd_info->bi_op_add
1728 #define be_compare bd_info->bi_op_compare
1729 #define be_delete bd_info->bi_op_delete
1730 #define be_modify bd_info->bi_op_modify
1731 #define be_modrdn bd_info->bi_op_modrdn
1732 #define be_search bd_info->bi_op_search
1733 #define be_abandon bd_info->bi_op_abandon
1735 #define be_extended bd_info->bi_extended
1736 #define be_cancel bd_info->bi_op_cancel
1738 #define be_chk_referrals bd_info->bi_chk_referrals
1739 #define be_chk_controls bd_info->bi_chk_controls
1740 #define be_fetch bd_info->bi_entry_get_rw
1741 #define be_release bd_info->bi_entry_release_rw
1742 #define be_group bd_info->bi_acl_group
1743 #define be_attribute bd_info->bi_acl_attribute
1744 #define be_operational bd_info->bi_operational
1747 * define to honor hasSubordinates operational attribute in search filters
1748 * (in previous use there was a flaw with back-bdb; now it is fixed).
1750 #define be_has_subordinates bd_info->bi_has_subordinates
1752 #define be_connection_init bd_info->bi_connection_init
1753 #define be_connection_destroy bd_info->bi_connection_destroy
1756 #define be_entry_open bd_info->bi_tool_entry_open
1757 #define be_entry_close bd_info->bi_tool_entry_close
1758 #define be_entry_first bd_info->bi_tool_entry_first
1759 #define be_entry_next bd_info->bi_tool_entry_next
1760 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1761 #define be_entry_get bd_info->bi_tool_entry_get
1762 #define be_entry_put bd_info->bi_tool_entry_put
1763 #define be_sync bd_info->bi_tool_sync
1764 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1765 #define be_entry_modify bd_info->bi_tool_entry_modify
1768 /* supported controls */
1769 /* note: set to 0 if the database does not support the control;
1770 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1771 char be_ctrls[SLAP_MAX_CIDS + 1];
1773 /* Database flags */
1774 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1775 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1776 #define SLAP_DBFLAG_HIDDEN 0x0004U
1777 #define SLAP_DBFLAG_ONE_SUFFIX 0x0008U
1778 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1779 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1780 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1781 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1782 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1783 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1784 #define SLAP_DBFLAG_DYNAMIC 0x0400U /* this db allows dynamicObjects */
1785 #define SLAP_DBFLAG_MONITORING 0x0800U /* custom monitoring enabled */
1786 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1787 #define SLAP_DBFLAG_SINGLE_SHADOW 0x4000U /* a single-master shadow */
1788 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1789 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1790 slap_mask_t be_flags;
1791 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1792 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1793 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1794 #define SLAP_DBHIDDEN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN)
1795 #define SLAP_DB_ONE_SUFFIX(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ONE_SUFFIX)
1796 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1797 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1798 #define SLAP_DBMONITORING(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING)
1799 #define SLAP_NO_SCHEMA_CHECK(be) \
1800 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1801 #define SLAP_GLUE_INSTANCE(be) \
1802 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1803 #define SLAP_GLUE_SUBORDINATE(be) \
1804 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1805 #define SLAP_GLUE_LINKED(be) \
1806 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1807 #define SLAP_GLUE_ADVERTISE(be) \
1808 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1809 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1810 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1811 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1812 #define SLAP_SINGLE_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW)
1813 #define SLAP_MULTIMASTER(be) (!SLAP_SINGLE_SHADOW(be))
1815 slap_mask_t be_restrictops; /* restriction operations */
1816 #define SLAP_RESTRICT_OP_ADD 0x0001U
1817 #define SLAP_RESTRICT_OP_BIND 0x0002U
1818 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1819 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1820 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1821 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1822 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1823 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1824 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1826 #define SLAP_RESTRICT_READONLY 0x80000000U
1828 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1829 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1830 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1831 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1832 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1834 #define SLAP_RESTRICT_OP_READS \
1835 ( SLAP_RESTRICT_OP_COMPARE \
1836 | SLAP_RESTRICT_OP_SEARCH )
1837 #define SLAP_RESTRICT_OP_WRITES \
1838 ( SLAP_RESTRICT_OP_ADD \
1839 | SLAP_RESTRICT_OP_DELETE \
1840 | SLAP_RESTRICT_OP_MODIFY \
1841 | SLAP_RESTRICT_OP_RENAME )
1842 #define SLAP_RESTRICT_OP_ALL \
1843 ( SLAP_RESTRICT_OP_READS \
1844 | SLAP_RESTRICT_OP_WRITES \
1845 | SLAP_RESTRICT_OP_BIND \
1846 | SLAP_RESTRICT_OP_EXTENDED )
1848 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1849 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1850 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1852 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1853 #define SLAP_ALLOW_PROXY_AUTHZ_ANON 0x0010U /* allow anonymous proxyAuthz */
1855 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1856 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1858 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1859 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1861 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1863 slap_mask_t be_requires; /* pre-operation requirements */
1864 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1865 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1866 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1867 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1868 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1870 /* Required Security Strength Factor */
1871 slap_ssf_set_t be_ssf_set;
1873 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1874 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1875 struct berval be_schemadn; /* per-backend subschema subentry DN */
1876 struct berval be_schemandn; /* normalized subschema DN */
1877 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1878 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1879 struct berval be_rootpw; /* the magic "root" password for this db */
1880 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1881 #define be_sizelimit be_def_limit.lms_s_soft
1882 #define be_timelimit be_def_limit.lms_t_soft
1883 struct slap_limits_set be_def_limit; /* default limits */
1884 struct slap_limits **be_limits; /* regex-based size and time limits */
1885 AccessControl *be_acl; /* access control list for this backend */
1886 slap_access_t be_dfltaccess; /* access given if no acl matches */
1888 /* Replica Information */
1889 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1890 BerVarray be_update_refs; /* where to refer modifying clients to */
1891 struct be_pcl *be_pending_csn_list;
1892 ldap_pvt_thread_mutex_t be_pcl_mutex;
1893 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1894 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1896 void *be_pb; /* Netscape plugin */
1897 struct ConfigOCs *be_cf_ocs;
1899 void *be_private; /* anything the backend database needs */
1900 LDAP_STAILQ_ENTRY(BackendDB) be_next;
1903 /* Backend function typedefs */
1904 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1905 typedef BI_bi_func BI_init;
1906 typedef BI_bi_func BI_open;
1907 typedef BI_bi_func BI_close;
1908 typedef BI_bi_func BI_destroy;
1909 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1910 const char *fname, int lineno,
1911 int argc, char **argv));
1913 typedef struct config_reply_s ConfigReply; /* config.h */
1914 typedef int (BI_db_func) LDAP_P((Backend *bd, ConfigReply *cr));
1915 typedef BI_db_func BI_db_init;
1916 typedef BI_db_func BI_db_open;
1917 typedef BI_db_func BI_db_close;
1918 typedef BI_db_func BI_db_destroy;
1919 typedef int (BI_db_config) LDAP_P((Backend *bd,
1920 const char *fname, int lineno,
1921 int argc, char **argv));
1923 typedef struct req_bind_s {
1925 struct berval rb_cred;
1926 struct berval rb_edn;
1928 struct berval rb_mech;
1931 typedef struct req_search_s {
1936 /* NULL means be_isroot evaluated to TRUE */
1937 struct slap_limits_set *rs_limit;
1939 AttributeName *rs_attrs;
1941 struct berval rs_filterstr;
1944 typedef struct req_compare_s {
1945 AttributeAssertion *rs_ava;
1948 typedef struct req_modifications_s {
1949 Modifications *rs_modlist;
1950 char rs_no_opattrs; /* don't att modify operational attrs */
1951 } req_modifications_s;
1953 typedef struct req_modify_s {
1954 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1958 typedef struct req_modrdn_s {
1959 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1960 int rs_deleteoldrdn;
1961 struct berval rs_newrdn;
1962 struct berval rs_nnewrdn;
1963 struct berval *rs_newSup;
1964 struct berval *rs_nnewSup;
1967 typedef struct req_add_s {
1968 Modifications *rs_modlist;
1972 typedef struct req_abandon_s {
1977 #define SLAP_EXOP_HIDE 0x0000
1979 #define SLAP_EXOP_HIDE 0x8000
1981 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1983 typedef struct req_extended_s {
1984 struct berval rs_reqoid;
1986 struct berval *rs_reqdata;
1989 typedef struct req_pwdexop_s {
1990 struct req_extended_s rs_extended;
1991 struct berval rs_old;
1992 struct berval rs_new;
1993 Modifications *rs_mods;
1994 Modifications **rs_modtail;
1997 typedef enum slap_reply_e {
2007 typedef struct rep_sasl_s {
2008 struct berval *r_sasldata;
2011 typedef struct rep_extended_s {
2012 const char *r_rspoid;
2013 struct berval *r_rspdata;
2016 typedef struct rep_search_s {
2018 slap_mask_t r_attr_flags;
2019 #define SLAP_ATTRS_UNDEFINED (0x00U)
2020 #define SLAP_OPATTRS_NO (0x01U)
2021 #define SLAP_OPATTRS_YES (0x02U)
2022 #define SLAP_USERATTRS_NO (0x10U)
2023 #define SLAP_USERATTRS_YES (0x20U)
2024 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
2025 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
2026 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
2027 #define SLAP_USERATTRS(f) \
2028 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
2030 Attribute *r_operational_attrs;
2031 AttributeName *r_attrs;
2037 slap_reply_t sr_type;
2041 const char *sr_matched;
2042 const char *sr_text;
2044 LDAPControl **sr_ctrls;
2046 rep_sasl_s sru_sasl;
2047 rep_extended_s sru_extended;
2048 rep_search_s sru_search;
2050 slap_mask_t sr_flags;
2051 #define REP_ENTRY_MODIFIABLE 0x0001U
2052 #define REP_ENTRY_MUSTBEFREED 0x0002U
2053 #define REP_ENTRY_MUSTRELEASE 0x0004U
2054 #define REP_ENTRY_MASK (REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2056 #define REP_MATCHED_MUSTBEFREED 0x0010U
2057 #define REP_MATCHED_MASK (REP_MATCHED_MUSTBEFREED)
2059 #define REP_REF_MUSTBEFREED 0x0020U
2060 #define REP_REF_MASK (REP_REF_MUSTBEFREED)
2062 #define REP_NO_ENTRYDN 0x1000U
2063 #define REP_NO_SUBSCHEMA 0x2000U
2064 #define REP_NO_OPERATIONALS (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2067 /* short hands for response members */
2068 #define sr_attrs sr_un.sru_search.r_attrs
2069 #define sr_entry sr_un.sru_search.r_entry
2070 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2071 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2072 #define sr_v2ref sr_un.sru_search.r_v2ref
2073 #define sr_nentries sr_un.sru_search.r_nentries
2074 #define sr_rspoid sr_un.sru_extended.r_rspoid
2075 #define sr_rspdata sr_un.sru_extended.r_rspdata
2076 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2078 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs ));
2079 typedef BI_op_func BI_op_bind;
2080 typedef BI_op_func BI_op_unbind;
2081 typedef BI_op_func BI_op_search;
2082 typedef BI_op_func BI_op_compare;
2083 typedef BI_op_func BI_op_modify;
2084 typedef BI_op_func BI_op_modrdn;
2085 typedef BI_op_func BI_op_add;
2086 typedef BI_op_func BI_op_delete;
2087 typedef BI_op_func BI_op_abandon;
2088 typedef BI_op_func BI_op_extended;
2089 typedef BI_op_func BI_op_cancel;
2090 typedef BI_op_func BI_chk_referrals;
2091 typedef BI_op_func BI_chk_controls;
2092 typedef int (BI_entry_release_rw)
2093 LDAP_P(( Operation *op, Entry *e, int rw ));
2094 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn,
2095 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2096 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs ));
2097 typedef int (BI_has_subordinates) LDAP_P(( Operation *op,
2098 Entry *e, int *hasSubs ));
2099 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e,
2100 AttributeDescription *desc, struct berval *val, slap_access_t access,
2101 AccessControlState *state, slap_mask_t *maskp ));
2102 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target,
2103 struct berval *gr_ndn, struct berval *op_ndn,
2104 ObjectClass *group_oc, AttributeDescription *group_at ));
2105 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target,
2106 struct berval *entry_ndn, AttributeDescription *entry_at,
2107 BerVarray *vals, slap_access_t access ));
2109 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c ));
2110 typedef BI_conn_func BI_connection_init;
2111 typedef BI_conn_func BI_connection_destroy;
2113 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2114 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2115 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2116 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2117 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2118 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2119 struct berval *text ));
2120 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv ));
2121 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2122 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2123 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2124 struct berval *text ));
2126 struct BackendInfo {
2127 char *bi_type; /* type of backend */
2130 * per backend type routines:
2131 * bi_init: called to allocate a backend_info structure,
2132 * called once BEFORE configuration file is read.
2133 * bi_init() initializes this structure hence is
2134 * called directly from be_initialize()
2135 * bi_config: called per 'backend' specific option
2136 * all such options must before any 'database' options
2137 * bi_config() is called only from read_config()
2138 * bi_open: called to open each database, called
2139 * once AFTER configuration file is read but
2140 * BEFORE any bi_db_open() calls.
2141 * bi_open() is called from backend_startup()
2142 * bi_close: called to close each database, called
2143 * once during shutdown after all bi_db_close calls.
2144 * bi_close() is called from backend_shutdown()
2145 * bi_destroy: called to destroy each database, called
2146 * once during shutdown after all bi_db_destroy calls.
2147 * bi_destory() is called from backend_destroy()
2150 BI_config *bi_config;
2153 BI_destroy *bi_destroy;
2156 * per database routines:
2157 * bi_db_init: called to initialize each database,
2158 * called upon reading 'database <type>'
2159 * called only from backend_db_init()
2160 * bi_db_config: called to configure each database,
2161 * called per database to handle per database options
2162 * called only from read_config()
2163 * bi_db_open: called to open each database
2164 * called once per database immediately AFTER bi_open()
2165 * calls but before daemon startup.
2166 * called only by backend_startup()
2167 * bi_db_close: called to close each database
2168 * called once per database during shutdown but BEFORE
2169 * any bi_close call.
2170 * called only by backend_shutdown()
2171 * bi_db_destroy: called to destroy each database
2172 * called once per database during shutdown AFTER all
2173 * bi_close calls but before bi_destory calls.
2174 * called only by backend_destory()
2176 BI_db_init *bi_db_init;
2177 BI_db_config *bi_db_config;
2178 BI_db_open *bi_db_open;
2179 BI_db_close *bi_db_close;
2180 BI_db_destroy *bi_db_destroy;
2182 /* LDAP Operations Handling Routines */
2183 BI_op_bind *bi_op_bind;
2184 BI_op_unbind *bi_op_unbind;
2185 BI_op_search *bi_op_search;
2186 BI_op_compare *bi_op_compare;
2187 BI_op_modify *bi_op_modify;
2188 BI_op_modrdn *bi_op_modrdn;
2189 BI_op_add *bi_op_add;
2190 BI_op_delete *bi_op_delete;
2191 BI_op_abandon *bi_op_abandon;
2193 /* Extended Operations Helper */
2194 BI_op_extended *bi_extended;
2195 BI_op_cancel *bi_op_cancel;
2197 /* Auxilary Functions */
2198 BI_operational *bi_operational;
2199 BI_chk_referrals *bi_chk_referrals;
2200 BI_chk_controls *bi_chk_controls;
2201 BI_entry_get_rw *bi_entry_get_rw;
2202 BI_entry_release_rw *bi_entry_release_rw;
2204 BI_has_subordinates *bi_has_subordinates;
2205 BI_access_allowed *bi_access_allowed;
2206 BI_acl_group *bi_acl_group;
2207 BI_acl_attribute *bi_acl_attribute;
2209 BI_connection_init *bi_connection_init;
2210 BI_connection_destroy *bi_connection_destroy;
2212 /* hooks for slap tools */
2213 BI_tool_entry_open *bi_tool_entry_open;
2214 BI_tool_entry_close *bi_tool_entry_close;
2215 BI_tool_entry_first *bi_tool_entry_first;
2216 BI_tool_entry_next *bi_tool_entry_next;
2217 BI_tool_entry_get *bi_tool_entry_get;
2218 BI_tool_entry_put *bi_tool_entry_put;
2219 BI_tool_entry_reindex *bi_tool_entry_reindex;
2220 BI_tool_sync *bi_tool_sync;
2221 BI_tool_dn2id_get *bi_tool_dn2id_get;
2222 BI_tool_entry_modify *bi_tool_entry_modify;
2224 #define SLAP_INDEX_ADD_OP 0x0001
2225 #define SLAP_INDEX_DELETE_OP 0x0002
2227 slap_mask_t bi_flags; /* backend flags */
2228 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2229 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2230 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2231 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2232 #define SLAP_BFLAG_INCREMENT 0x0100U
2233 #define SLAP_BFLAG_ALIASES 0x1000U
2234 #define SLAP_BFLAG_REFERRALS 0x2000U
2235 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2236 #define SLAP_BFLAG_DYNAMIC 0x8000U
2238 /* overlay specific */
2239 #define SLAPO_BFLAG_SINGLE 0x01000000U
2240 #define SLAPO_BFLAG_DBONLY 0x02000000U
2241 #define SLAPO_BFLAG_GLOBONLY 0x04000000U
2242 #define SLAPO_BFLAG_MASK 0xFF000000U
2244 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2245 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2246 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2247 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2248 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2249 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2250 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2251 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2252 #define SLAP_DYNAMIC(be) ((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC))
2253 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2254 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2256 /* overlay specific */
2257 #define SLAPO_SINGLE(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE)
2258 #define SLAPO_DBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY)
2259 #define SLAPO_GLOBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY)
2261 char **bi_controls; /* supported controls */
2262 char bi_ctrls[SLAP_MAX_CIDS + 1];
2264 unsigned int bi_nDB; /* number of databases of this type */
2265 struct ConfigOCs *bi_cf_ocs;
2266 char **bi_obsolete_names;
2267 void *bi_extra; /* backend type-specific APIs */
2268 void *bi_private; /* backend type-specific config data */
2269 LDAP_STAILQ_ENTRY(BackendInfo) bi_next ;
2272 #define c_authtype c_authz.sai_method
2273 #define c_authmech c_authz.sai_mech
2274 #define c_dn c_authz.sai_dn
2275 #define c_ndn c_authz.sai_ndn
2276 #define c_ssf c_authz.sai_ssf
2277 #define c_transport_ssf c_authz.sai_transport_ssf
2278 #define c_tls_ssf c_authz.sai_tls_ssf
2279 #define c_sasl_ssf c_authz.sai_sasl_ssf
2281 #define o_authtype o_authz.sai_method
2282 #define o_authmech o_authz.sai_mech
2283 #define o_dn o_authz.sai_dn
2284 #define o_ndn o_authz.sai_ndn
2285 #define o_ssf o_authz.sai_ssf
2286 #define o_transport_ssf o_authz.sai_transport_ssf
2287 #define o_tls_ssf o_authz.sai_tls_ssf
2288 #define o_sasl_ssf o_authz.sai_sasl_ssf
2290 typedef int (slap_response)( Operation *, SlapReply * );
2292 typedef struct slap_callback {
2293 struct slap_callback *sc_next;
2294 slap_response *sc_response;
2295 slap_response *sc_cleanup;
2299 struct slap_overinfo;
2301 typedef enum slap_operation_e {
2314 op_aux_chk_referrals,
2315 op_aux_chk_controls,
2319 typedef struct slap_overinst {
2321 slap_response *on_response;
2322 struct slap_overinfo *on_info;
2323 struct slap_overinst *on_next;
2326 typedef struct slap_overinfo {
2328 BackendInfo *oi_orig;
2329 BackendDB *oi_origdb;
2330 struct slap_overinst *oi_list;
2333 /* Should successive callbacks in a chain be processed? */
2334 #define SLAP_CB_FREEME 0x04000
2335 #define SLAP_CB_BYPASS 0x08800
2336 #define SLAP_CB_CONTINUE 0x08000
2339 * Paged Results state
2341 typedef unsigned long PagedResultsCookie;
2342 typedef struct PagedResultsState {
2346 PagedResultsCookie ps_cookie;
2347 struct berval ps_cookieval;
2348 } PagedResultsState;
2350 struct slap_csn_entry {
2351 struct berval ce_csn;
2352 unsigned long ce_opid;
2353 unsigned long ce_connid;
2354 #define SLAP_CSN_PENDING 1
2355 #define SLAP_CSN_COMMIT 2
2357 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2361 * Caches the result of a backend_group check for ACL evaluation
2363 typedef struct GroupAssertion {
2364 struct GroupAssertion *ga_next;
2367 AttributeDescription *ga_at;
2373 struct slap_control_ids {
2379 int sc_modifyIncrement;
2381 int sc_pagedResults;
2382 int sc_permissiveModify;
2387 int sc_searchOptions;
2388 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2389 int sc_sortedResults;
2392 #ifdef SLAP_CONTROL_X_TREE_DELETE
2398 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2399 int sc_sessionTracking;
2401 int sc_valuesReturnFilter;
2421 typedef struct slap_counters_t {
2422 struct slap_counters_t *sc_next;
2423 ldap_pvt_thread_mutex_t sc_mutex;
2424 ldap_pvt_mp_t sc_bytes;
2425 ldap_pvt_mp_t sc_pdu;
2426 ldap_pvt_mp_t sc_entries;
2427 ldap_pvt_mp_t sc_refs;
2429 ldap_pvt_mp_t sc_ops_completed;
2430 ldap_pvt_mp_t sc_ops_initiated;
2431 #ifdef SLAPD_MONITOR
2432 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2433 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2434 #endif /* SLAPD_MONITOR */
2438 * represents an operation pending from an ldap client
2440 typedef struct Opheader {
2441 unsigned long oh_opid; /* id of this operation */
2442 unsigned long oh_connid; /* id of conn initiating this op */
2443 Connection *oh_conn; /* connection spawning this op */
2445 ber_int_t oh_msgid; /* msgid of the request */
2446 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2448 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2450 void *oh_threadctx; /* thread pool thread context */
2451 void *oh_tmpmemctx; /* slab malloc context */
2452 BerMemoryFunctions *oh_tmpmfuncs;
2454 slap_counters_t *oh_counters;
2456 char oh_log_prefix[ /* sizeof("conn= op=") + 2*LDAP_PVT_INTTYPE_CHARS(unsigned long) */ SLAP_TEXT_BUFLEN ];
2459 void *oh_extensions; /* NS-SLAPI plugin */
2463 typedef union OpRequest {
2466 req_compare_s oq_compare;
2467 req_modify_s oq_modify;
2468 req_modrdn_s oq_modrdn;
2469 req_search_s oq_search;
2470 req_abandon_s oq_abandon;
2471 req_abandon_s oq_cancel;
2472 req_extended_s oq_extended;
2473 req_pwdexop_s oq_pwdexop;
2476 /* This is only a header. Actual users should define their own
2477 * structs with the oe_next / oe_key fields at the top and
2478 * whatever else they need following.
2480 typedef struct OpExtra {
2481 LDAP_SLIST_ENTRY(OpExtra) oe_next;
2485 typedef struct OpExtraDB {
2493 #define o_opid o_hdr->oh_opid
2494 #define o_connid o_hdr->oh_connid
2495 #define o_conn o_hdr->oh_conn
2496 #define o_msgid o_hdr->oh_msgid
2497 #define o_protocol o_hdr->oh_protocol
2498 #define o_tid o_hdr->oh_tid
2499 #define o_threadctx o_hdr->oh_threadctx
2500 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2501 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2502 #define o_counters o_hdr->oh_counters
2504 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2505 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2506 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2507 #define o_tmpfree o_tmpmfuncs->bmf_free
2509 #define o_log_prefix o_hdr->oh_log_prefix
2511 ber_tag_t o_tag; /* tag of the request */
2512 time_t o_time; /* time op was initiated */
2513 int o_tincr; /* counter for multiple ops with same o_time */
2515 BackendDB *o_bd; /* backend DB processing this op */
2516 struct berval o_req_dn; /* DN of target of request */
2517 struct berval o_req_ndn;
2519 OpRequest o_request;
2521 /* short hands for union members */
2522 #define oq_add o_request.oq_add
2523 #define oq_bind o_request.oq_bind
2524 #define oq_compare o_request.oq_compare
2525 #define oq_modify o_request.oq_modify
2526 #define oq_modrdn o_request.oq_modrdn
2527 #define oq_search o_request.oq_search
2528 #define oq_abandon o_request.oq_abandon
2529 #define oq_cancel o_request.oq_cancel
2530 #define oq_extended o_request.oq_extended
2531 #define oq_pwdexop o_request.oq_pwdexop
2533 /* short hands for inner request members */
2534 #define orb_method oq_bind.rb_method
2535 #define orb_cred oq_bind.rb_cred
2536 #define orb_edn oq_bind.rb_edn
2537 #define orb_ssf oq_bind.rb_ssf
2538 #define orb_mech oq_bind.rb_mech
2540 #define ors_scope oq_search.rs_scope
2541 #define ors_deref oq_search.rs_deref
2542 #define ors_slimit oq_search.rs_slimit
2543 #define ors_tlimit oq_search.rs_tlimit
2544 #define ors_limit oq_search.rs_limit
2545 #define ors_attrsonly oq_search.rs_attrsonly
2546 #define ors_attrs oq_search.rs_attrs
2547 #define ors_filter oq_search.rs_filter
2548 #define ors_filterstr oq_search.rs_filterstr
2550 #define orr_modlist oq_modrdn.rs_mods.rs_modlist
2551 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs
2552 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2553 #define orr_newrdn oq_modrdn.rs_newrdn
2554 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2555 #define orr_newSup oq_modrdn.rs_newSup
2556 #define orr_nnewSup oq_modrdn.rs_nnewSup
2558 #define orc_ava oq_compare.rs_ava
2560 #define ora_e oq_add.rs_e
2561 #define ora_modlist oq_add.rs_modlist
2563 #define orn_msgid oq_abandon.rs_msgid
2565 #define orm_modlist oq_modify.rs_mods.rs_modlist
2566 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs
2567 #define orm_increment oq_modify.rs_increment
2569 #define ore_reqoid oq_extended.rs_reqoid
2570 #define ore_flags oq_extended.rs_flags
2571 #define ore_reqdata oq_extended.rs_reqdata
2572 volatile sig_atomic_t o_abandon; /* abandon flag */
2573 volatile sig_atomic_t o_cancel; /* cancel flag */
2574 #define SLAP_CANCEL_NONE 0x00
2575 #define SLAP_CANCEL_REQ 0x01
2576 #define SLAP_CANCEL_ACK 0x02
2577 #define SLAP_CANCEL_DONE 0x03
2579 GroupAssertion *o_groups;
2580 char o_do_not_cache; /* don't cache groups from this op */
2581 char o_is_auth_check; /* authorization in progress */
2582 slap_access_t o_acl_priv;
2585 char o_delete_glue_parent;
2586 char o_no_schema_check;
2587 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2588 char o_no_subordinate_glue;
2589 #define get_no_subordinate_glue(op) ((op)->o_no_subordinate_glue)
2591 #define SLAP_CONTROL_NONE 0
2592 #define SLAP_CONTROL_IGNORED 1
2593 #define SLAP_CONTROL_NONCRITICAL 2
2594 #define SLAP_CONTROL_CRITICAL 3
2595 #define SLAP_CONTROL_MASK 3
2597 /* spare bits for simple flags */
2598 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2599 #define SLAP_CONTROL_DATA0 0x10
2600 #define SLAP_CONTROL_DATA1 0x20
2601 #define SLAP_CONTROL_DATA2 0x40
2602 #define SLAP_CONTROL_DATA3 0x80
2604 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2606 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2607 void **o_controls; /* per-control state */
2609 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2610 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2612 #define o_relax o_ctrlflag[slap_cids.sc_relax]
2613 #define get_relax(op) _SCM((op)->o_relax)
2615 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2616 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2618 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2619 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2620 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2622 #define get_subentries(op) _SCM((op)->o_subentries)
2623 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2625 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2626 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2628 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2629 #define get_assert(op) ((int)(op)->o_assert)
2630 #define o_assertion o_controls[slap_cids.sc_assert]
2631 #define get_assertion(op) ((op)->o_assertion)
2633 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2634 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2636 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2637 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2639 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2640 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2642 #ifdef SLAP_CONTROL_X_TREE_DELETE
2643 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2644 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2647 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2648 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2650 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2651 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2653 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2654 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2655 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2657 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2658 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2662 #define o_txnSpec o_ctrlflag[slap_cids.sc_txnSpec]
2665 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2666 #define o_session_tracking o_ctrlflag[slap_cids.sc_sessionTracking]
2667 #define o_tracked_sessions o_controls[slap_cids.sc_sessionTracking]
2668 #define get_sessionTracking(op) ((int)(op)->o_session_tracking)
2671 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2673 AuthorizationInformation o_authz;
2675 BerElement *o_ber; /* ber of the request */
2676 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2677 slap_callback *o_callback; /* callback pointers */
2678 LDAPControl **o_ctrls; /* controls */
2679 struct berval o_csn;
2681 /* DEPRECATE o_private - use o_extra instead */
2682 void *o_private; /* anything the backend needs */
2683 LDAP_SLIST_HEAD(o_e, OpExtra) o_extra; /* anything the backend needs */
2685 LDAP_STAILQ_ENTRY(Operation) o_next; /* next operation in list */
2688 typedef struct OperationBuffer {
2691 void *ob_controls[SLAP_MAX_CIDS];
2694 #define send_ldap_error( op, rs, err, text ) do { \
2695 (rs)->sr_err = err; (rs)->sr_text = text; \
2696 ((op)->o_conn->c_send_ldap_result)( op, rs ); \
2698 #define send_ldap_discon( op, rs, err, text ) do { \
2699 (rs)->sr_err = err; (rs)->sr_text = text; \
2700 send_ldap_disconnect( op, rs ); \
2703 typedef void (SEND_LDAP_RESULT)(
2704 Operation *op, SlapReply *rs);
2705 typedef int (SEND_SEARCH_ENTRY)(
2706 Operation *op, SlapReply *rs);
2707 typedef int (SEND_SEARCH_REFERENCE)(
2708 Operation *op, SlapReply *rs);
2709 typedef void (SEND_LDAP_EXTENDED)(
2710 Operation *op, SlapReply *rs);
2711 typedef void (SEND_LDAP_INTERMEDIATE)(
2712 Operation *op, SlapReply *rs);
2714 #define send_ldap_result( op, rs ) \
2715 ((op)->o_conn->c_send_ldap_result)( op, rs )
2716 #define send_search_entry( op, rs ) \
2717 ((op)->o_conn->c_send_search_entry)( op, rs )
2718 #define send_search_reference( op, rs ) \
2719 ((op)->o_conn->c_send_search_reference)( op, rs )
2720 #define send_ldap_extended( op, rs ) \
2721 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2722 #define send_ldap_intermediate( op, rs ) \
2723 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2725 typedef struct slap_listener Listener;
2728 * represents a connection from an ldap client
2731 int c_struct_state; /* structure management state */
2732 int c_conn_state; /* connection state */
2733 int c_conn_idx; /* slot in connections array */
2735 const char *c_close_reason; /* why connection is closing */
2737 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2738 Sockbuf *c_sb; /* ber connection stuff */
2740 /* only can be changed by connect_init */
2741 time_t c_starttime; /* when the connection was opened */
2742 time_t c_activitytime; /* when the connection was last used */
2743 unsigned long c_connid; /* id of this connection for stats*/
2745 struct berval c_peer_domain; /* DNS name of client */
2746 struct berval c_peer_name; /* peer name (trans=addr:port) */
2747 Listener *c_listener;
2748 #define c_listener_url c_listener->sl_url /* listener URL */
2749 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2751 /* only can be changed by binding thread */
2752 struct berval c_sasl_bind_mech; /* mech in progress */
2753 struct berval c_sasl_dn; /* temporary storage */
2754 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2756 /* authorization backend */
2757 Backend *c_authz_backend;
2758 void *c_authz_cookie;
2759 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2760 ( (op)->o_bd != NULL \
2761 && (op)->o_bd->be_private != NULL \
2762 && (op)->o_conn != NULL \
2763 && (op)->o_conn->c_authz_backend != NULL \
2764 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2765 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2767 AuthorizationInformation c_authz;
2769 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2771 LDAP_STAILQ_HEAD(c_o, Operation) c_ops; /* list of operations being processed */
2772 LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops; /* list of pending operations */
2774 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2775 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2777 BerElement *c_currentber; /* ber we're attempting to read */
2779 char c_sasl_bind_in_progress; /* multi-op bind in progress */
2781 char c_writewaiter; /* true if writer is waiting */
2783 #define CONN_IS_TLS 1
2784 #define CONN_IS_UDP 2
2785 #define CONN_IS_CLIENT 4
2786 #define CONN_IS_IPC 8
2788 #ifdef LDAP_CONNECTIONLESS
2789 char c_is_udp; /* true if this is (C)LDAP over UDP */
2792 char c_is_tls; /* true if this LDAP over raw TLS */
2793 char c_needs_tls_accept; /* true if SSL_accept should be called */
2795 char c_sasl_layers; /* true if we need to install SASL i/o handlers */
2796 char c_sasl_done; /* SASL completed once */
2797 void *c_sasl_authctx; /* SASL authentication context */
2798 void *c_sasl_sockctx; /* SASL security layer context */
2799 void *c_sasl_extra; /* SASL session extra stuff */
2800 Operation *c_sasl_bindop; /* set to current op if it's a bind */
2803 #define CONN_TXN_INACTIVE 0
2804 #define CONN_TXN_SPECIFY 1
2805 #define CONN_TXN_SETTLE -1
2808 Backend *c_txn_backend;
2809 LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */
2812 PagedResultsState c_pagedresults_state; /* paged result state */
2814 long c_n_ops_received; /* num of ops received (next op_id) */
2815 long c_n_ops_executing; /* num of ops currently executing */
2816 long c_n_ops_pending; /* num of ops pending execution */
2817 long c_n_ops_completed; /* num of ops completed */
2819 long c_n_get; /* num of get calls */
2820 long c_n_read; /* num of read calls */
2821 long c_n_write; /* num of write calls */
2823 void *c_extensions; /* Netscape plugin */
2826 * Client connection handling
2828 ldap_pvt_thread_start_t *c_clientfunc;
2832 * These are the "callbacks" that are available for back-ends to
2833 * supply data back to connected clients that are connected
2834 * through the "front-end".
2836 SEND_LDAP_RESULT *c_send_ldap_result;
2837 SEND_SEARCH_ENTRY *c_send_search_entry;
2838 SEND_SEARCH_REFERENCE *c_send_search_reference;
2839 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2840 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2846 #define SLAP_DEFAULT_SYSLOG_USER LOG_LOCAL4
2847 #endif /* LOG_LOCAL4 */
2849 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2850 Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2851 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2852 #else /* !LDAP_SYSLOG */
2853 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2855 if ( ldap_debug & (level) ) \
2856 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2858 #define StatslogTest( level ) (ldap_debug & (level))
2859 #endif /* !LDAP_SYSLOG */
2860 #else /* !LDAP_DEBUG */
2861 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0)
2862 #define StatslogTest( level ) (0)
2863 #endif /* !LDAP_DEBUG */
2866 * listener; need to access it from monitor backend
2868 struct slap_listener {
2869 struct berval sl_url;
2870 struct berval sl_name;
2875 #ifdef LDAP_CONNECTIONLESS
2876 int sl_is_udp; /* UDP listener is also data port */
2878 int sl_mute; /* Listener is temporarily disabled due to emfile */
2879 int sl_busy; /* Listener is busy (accept thread activated) */
2882 #define sl_addr sl_sa.sa_in_addr
2886 * Better know these all around slapd
2888 #define SLAP_LDAPDN_PRETTY 0x1
2889 #define SLAP_LDAPDN_MAXLEN 8192
2891 /* number of response controls supported */
2892 #define SLAP_MAX_RESPONSE_CONTROLS 6
2895 #define SLAP_CTRL_HIDE 0x00000000U
2897 #define SLAP_CTRL_HIDE 0x80000000U
2900 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for Relax */
2902 #define SLAP_CTRL_GLOBAL 0x00800000U
2903 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2905 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2906 #define SLAP_CTRL_ABANDON 0x00000001U
2907 #define SLAP_CTRL_ADD 0x00002002U
2908 #define SLAP_CTRL_BIND 0x00000004U
2909 #define SLAP_CTRL_COMPARE 0x00001008U
2910 #define SLAP_CTRL_DELETE 0x00002010U
2911 #define SLAP_CTRL_MODIFY 0x00002020U
2912 #define SLAP_CTRL_RENAME 0x00002040U
2913 #define SLAP_CTRL_SEARCH 0x00001080U
2914 #define SLAP_CTRL_UNBIND 0x00000100U
2916 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2917 #define SLAP_CTRL_UPDATE \
2918 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2919 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2921 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2924 LDAPControl *ctrl ));
2926 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
2928 #define SLAP_SLAB_SIZE (1024*1024)
2929 #define SLAP_SLAB_STACK 1
2930 #define SLAP_SLAB_SOBLOCK 64
2932 #define SLAP_ZONE_ALLOC 1
2933 #undef SLAP_ZONE_ALLOC
2935 #ifdef LDAP_COMP_MATCH
2937 * Extensible Filter Definition
2939 * MatchingRuleAssertion := SEQUENCE {
2940 * matchingRule [1] MatchingRuleId OPTIONAL,
2941 * type [2] AttributeDescription OPTIONAL,
2942 * matchValue [3] AssertionValue,
2943 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2945 * Following ComponentFilter is contained in matchValue
2947 * ComponentAssertion ::= SEQUENCE {
2948 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2949 * useDefaultValues BOOLEAN DEFAULT TRUE,
2950 * rule MATCHING-RULE.&id,
2951 * value MATCHING-RULE.&AssertionType }
2953 * ComponentFilter ::= CHOICE {
2954 * item [0] ComponentAssertion,
2955 * and [1] SEQUENCE OF ComponentFilter,
2956 * or [2] SEQUENCE OF ComponentFilter,
2957 * not [3] ComponentFilter }
2960 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2961 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2962 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2963 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2964 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2965 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2966 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2967 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2968 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2970 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2971 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2972 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2973 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2974 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2976 typedef struct ComponentId ComponentId;
2977 typedef struct ComponentReference ComponentReference;
2978 typedef struct ComponentAssertion ComponentAssertion;
2979 typedef struct ComponentAssertionValue ComponentAssertionValue;
2980 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo;
2981 typedef struct ComponentDesc ComponentDesc;
2983 struct ComponentData {
2984 void *cd_mem_op; /* nibble memory handler */
2985 ComponentSyntaxInfo** cd_tree; /* component tree */
2988 struct ComponentId {
2990 ComponentId *ci_next;
2992 union comp_id_value{
2993 BerValue ci_identifier;
2994 ber_int_t ci_from_beginning;
2996 ber_int_t ci_from_end;
2997 ber_int_t ci_content;
2998 BerValue ci_select_value;
3003 struct ComponentReference {
3004 ComponentId *cr_list;
3005 ComponentId *cr_curr;
3006 struct berval cr_string;
3008 /* Component Indexing */
3010 slap_mask_t cr_indexmask;
3011 AttributeDescription* cr_ad;
3013 ComponentReference* cr_next;
3016 struct ComponentAssertion {
3017 ComponentReference *ca_comp_ref;
3018 ber_int_t ca_use_def;
3019 MatchingRule *ca_ma_rule;
3020 struct berval ca_ma_value;
3021 ComponentData ca_comp_data; /* componentized assertion */
3022 ComponentFilter *ca_cf;
3023 MatchingRuleAssertion *ca_mra;
3026 struct ComponentFilter {
3027 ber_tag_t cf_choice;
3029 ber_int_t cf_un_result;
3030 ComponentAssertion *cf_un_ca;
3031 ComponentFilter *cf_un_complex;
3034 #define cf_ca cf_un.cf_un_ca
3035 #define cf_result cf_un.cf_un_result
3036 #define cf_and cf_un.cf_un_complex
3037 #define cf_or cf_un.cf_un_complex
3038 #define cf_not cf_un.cf_un_complex
3039 #define cf_any cf_un.cf_un_complex
3041 ComponentFilter *cf_next;
3044 struct ComponentAssertionValue {
3050 typedef int encoder_func LDAP_P((
3054 typedef int gser_decoder_func LDAP_P((
3057 ComponentSyntaxInfo** comp_syn_info,
3061 typedef int comp_free_func LDAP_P((
3064 typedef int ber_decoder_func LDAP_P((
3069 ComponentSyntaxInfo* comp_syn_info,
3073 typedef int ber_tag_decoder_func LDAP_P((
3076 ComponentSyntaxInfo* comp_syn_info,
3080 typedef void* extract_component_from_id_func LDAP_P((
3082 ComponentReference* cr,
3085 typedef void* convert_attr_to_comp_func LDAP_P ((
3088 struct berval* bv ));
3090 typedef void* alloc_nibble_func LDAP_P ((
3092 int increment_size ));
3094 typedef void free_nibble_func LDAP_P ((
3097 typedef void convert_assert_to_comp_func LDAP_P ((
3099 ComponentSyntaxInfo* csi_attr,
3101 ComponentSyntaxInfo** csi,
3105 typedef int convert_asn_to_ldap_func LDAP_P ((
3106 ComponentSyntaxInfo* csi,
3107 struct berval *bv ));
3109 typedef void free_component_func LDAP_P ((
3112 typedef int test_component_func LDAP_P ((
3114 void* assert_mem_op,
3115 ComponentSyntaxInfo* csi,
3116 ComponentAssertion* ca));
3118 typedef void* test_membership_func LDAP_P ((
3121 typedef void* get_component_info_func LDAP_P ((
3124 typedef int component_encoder_func LDAP_P ((
3126 ComponentSyntaxInfo* csi,
3127 struct berval* nvals ));
3129 typedef int allcomponent_matching_func LDAP_P((
3131 ComponentSyntaxInfo* comp1,
3132 ComponentSyntaxInfo* comp));
3134 struct ComponentDesc {
3135 /* Don't change the order of following four fields */
3137 AttributeType *cd_comp_type;
3138 struct berval cd_ad_type; /* ad_type, ad_cname */
3139 struct berval cd_ad_cname; /* ad_type, ad_cname */
3140 unsigned cd_flags; /* ad_flags */
3143 encoder_func *cd_ldap_encoder;
3144 encoder_func *cd_gser_encoder;
3145 encoder_func *cd_ber_encoder;
3146 gser_decoder_func *cd_gser_decoder;
3147 ber_decoder_func *cd_ber_decoder;
3148 comp_free_func *cd_free;
3149 extract_component_from_id_func* cd_extract_i;
3150 allcomponent_matching_func *cd_all_match;
3153 struct ComponentSyntaxInfo {
3155 ComponentDesc *csi_comp_desc;
3158 #endif /* LDAP_COMP_MATCH */
3160 /* slab heap data structures */
3162 struct slab_object {
3165 LDAP_LIST_ENTRY(slab_object) so_link;
3174 unsigned char **sh_map;
3175 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3176 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3179 #ifdef SLAP_ZONE_ALLOC
3180 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3181 #define SLAP_ZONE_SHIFT 19
3182 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3183 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3184 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3185 #define SLAP_ZONE_ZOBLOCK 256
3187 struct zone_object {
3192 LDAP_LIST_ENTRY(zone_object) zo_link;
3195 struct zone_latency_history {
3197 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3208 ldap_pvt_thread_rdwr_t *zh_znlock;
3209 Avlnode *zh_zonetree;
3210 unsigned char ***zh_maps;
3212 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3213 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3214 ldap_pvt_thread_mutex_t zh_mutex;
3215 ldap_pvt_thread_rdwr_t zh_lock;
3216 double zh_ema_latency;
3217 unsigned long zh_ema_samples;
3218 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3219 zh_latency_history_queue;
3220 int zh_latency_history_qlen;
3221 int zh_latency_jump;
3226 #define SLAP_BACKEND_INIT_MODULE(b) \
3227 static BackendInfo bi; \
3229 init_module( int argc, char *argv[] ) \
3232 bi.bi_init = b ## _back_initialize; \
3233 backend_add( &bi ); \
3237 typedef int (OV_init)(void);
3238 typedef struct slap_oinit_t {
3239 const char *ov_type;
3245 #include "proto-slap.h"
3247 #endif /* _SLAP_H_ */