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
69 #define LDAP_DYNAMIC_OBJECTS
70 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
74 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
78 * SLAPD Memory allocation macros
80 * Unlike ch_*() routines, these routines do not assert() upon
81 * allocation error. They are intended to be used instead of
82 * ch_*() routines where the caller has implemented proper
83 * checking for and handling of allocation errors.
85 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
87 #define SLAP_MALLOC(s) ber_memalloc((s))
88 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
89 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
90 #define SLAP_FREE(p) ber_memfree((p))
91 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
92 #define SLAP_STRDUP(s) ber_strdup((s))
93 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
96 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
99 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
100 #define SLAPD_ANONYMOUS ""
104 # define SLAP_STRING_UNKNOWN STRING_UNKNOWN
105 #else /* ! TCP Wrappers */
106 # define SLAP_STRING_UNKNOWN "unknown"
107 #endif /* ! TCP Wrappers */
109 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
110 * This is a value used internally by the backends. It is needed to allow
111 * adding values that already exist without getting an error as required by
112 * modrdn when the new rdn was already an attribute value itself.
114 #define SLAP_MOD_SOFTADD 0x1000
116 #define MAXREMATCHES (100)
118 #define SLAP_MAX_WORKER_THREADS (16)
120 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
121 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
123 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
124 #define SLAP_CONN_MAX_PENDING_AUTH 1000
126 #define SLAP_TEXT_BUFLEN (256)
128 /* psuedo error code indicating abandoned operation */
129 #define SLAPD_ABANDON (-1024)
131 /* psuedo error code indicating disconnect */
132 #define SLAPD_DISCONNECT (-1025)
134 /* unknown config file directive */
135 #define SLAP_CONF_UNKNOWN (-1026)
137 /* We assume "C" locale, that is US-ASCII */
138 #define ASCII_SPACE(c) ( (c) == ' ' )
139 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
140 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
141 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
142 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
143 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
144 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
145 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
146 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
147 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
148 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
150 #define SLAP_NIBBLE(c) ((c)&0x0f)
151 #define SLAP_ESCAPE_CHAR ('\\')
152 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
153 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
155 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
156 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
158 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
159 /* NOTE: for consistency, this macro must only operate
160 * on normalized/pretty DN, such that ';' is never used
161 * as RDN separator, and all occurrences of ';' must be escaped */
162 #define DN_SEPARATOR(c) ((c) == ',')
163 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */
164 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
165 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
167 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
168 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
169 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
170 #define OID_SEPARATOR(c) ( (c) == '.' )
171 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
173 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
174 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
176 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
177 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
179 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
181 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
182 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
183 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
184 (c) == '?' || (c) == ' ' || (c) == '=' )
185 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
187 /* must match in schema_init.c */
188 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
189 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
190 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
191 #define SLAPD_GROUP_ATTR "member"
192 #define SLAPD_GROUP_CLASS "groupOfNames"
193 #define SLAPD_ROLE_ATTR "roleOccupant"
194 #define SLAPD_ROLE_CLASS "organizationalRole"
196 #define SLAPD_TOP_OID "2.5.6.0"
198 LDAP_SLAPD_V (int) slap_debug;
200 typedef unsigned long slap_mask_t;
202 /* Security Strength Factor */
203 typedef unsigned slap_ssf_t;
205 typedef struct slap_ssf_set {
207 slap_ssf_t sss_transport;
210 slap_ssf_t sss_update_ssf;
211 slap_ssf_t sss_update_transport;
212 slap_ssf_t sss_update_tls;
213 slap_ssf_t sss_update_sasl;
214 slap_ssf_t sss_simple_bind;
217 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
218 #define SLAP_GETDN_AUTHCID 2
219 #define SLAP_GETDN_AUTHZID 4
224 #define SLAP_INDEX_TYPE 0x00FFUL
225 #define SLAP_INDEX_UNDEFINED 0x0001UL
226 #define SLAP_INDEX_PRESENT 0x0002UL
227 #define SLAP_INDEX_EQUALITY 0x0004UL
228 #define SLAP_INDEX_APPROX 0x0008UL
229 #define SLAP_INDEX_SUBSTR 0x0010UL
230 #define SLAP_INDEX_EXTENDED 0x0020UL
232 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
234 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
236 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
238 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
239 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
240 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
241 #define SLAP_INDEX_SUBSTR_DEFAULT \
242 ( SLAP_INDEX_SUBSTR \
243 | SLAP_INDEX_SUBSTR_INITIAL \
244 | SLAP_INDEX_SUBSTR_ANY \
245 | SLAP_INDEX_SUBSTR_FINAL )
247 /* defaults for initial/final substring indices */
248 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
249 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
251 /* defaults for any substring indices */
252 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
253 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
255 /* default for ordered integer index keys */
256 #define SLAP_INDEX_INTLEN_DEFAULT 4
258 #define SLAP_INDEX_FLAGS 0xF000UL
259 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
260 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
263 * there is a single index for each attribute. these prefixes ensure
264 * that there is no collision among keys.
266 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
267 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
268 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
269 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
270 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
271 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
273 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
274 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
275 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
276 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
277 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
280 * represents schema information for a database
283 SLAP_SCHERR_OUTOFMEM = 1,
284 SLAP_SCHERR_CLASS_NOT_FOUND,
285 SLAP_SCHERR_CLASS_BAD_USAGE,
286 SLAP_SCHERR_CLASS_BAD_SUP,
287 SLAP_SCHERR_CLASS_DUP,
288 SLAP_SCHERR_CLASS_INCONSISTENT,
289 SLAP_SCHERR_ATTR_NOT_FOUND,
290 SLAP_SCHERR_ATTR_BAD_MR,
291 SLAP_SCHERR_ATTR_BAD_USAGE,
292 SLAP_SCHERR_ATTR_BAD_SUP,
293 SLAP_SCHERR_ATTR_INCOMPLETE,
294 SLAP_SCHERR_ATTR_DUP,
295 SLAP_SCHERR_ATTR_INCONSISTENT,
296 SLAP_SCHERR_MR_NOT_FOUND,
297 SLAP_SCHERR_MR_INCOMPLETE,
299 SLAP_SCHERR_SYN_NOT_FOUND,
301 SLAP_SCHERR_SYN_SUP_NOT_FOUND,
303 SLAP_SCHERR_NOT_SUPPORTED,
304 SLAP_SCHERR_BAD_DESCR,
307 SLAP_SCHERR_CR_BAD_STRUCT,
308 SLAP_SCHERR_CR_BAD_AUX,
309 SLAP_SCHERR_CR_BAD_AT,
314 /* forward declarations */
315 typedef struct Syntax Syntax;
316 typedef struct MatchingRule MatchingRule;
317 typedef struct MatchingRuleUse MatchingRuleUse;
318 typedef struct MatchingRuleAssertion MatchingRuleAssertion;
319 typedef struct OidMacro OidMacro;
320 typedef struct ObjectClass ObjectClass;
321 typedef struct AttributeType AttributeType;
322 typedef struct AttributeDescription AttributeDescription;
323 typedef struct AttributeName AttributeName;
324 typedef struct ContentRule ContentRule;
326 typedef struct AttributeAssertion AttributeAssertion;
327 typedef struct SubstringsAssertion SubstringsAssertion;
328 typedef struct Filter Filter;
329 typedef struct ValuesReturnFilter ValuesReturnFilter;
330 typedef struct Attribute Attribute;
331 #ifdef LDAP_COMP_MATCH
332 typedef struct ComponentData ComponentData;
333 typedef struct ComponentFilter ComponentFilter;
336 typedef struct Entry Entry;
337 typedef struct Modification Modification;
338 typedef struct Modifications Modifications;
339 typedef struct LDAPModList LDAPModList;
341 typedef struct BackendInfo BackendInfo; /* per backend type */
342 typedef struct BackendDB BackendDB; /* per backend database */
344 typedef struct Connection Connection;
345 typedef struct Operation Operation;
346 typedef struct SlapReply SlapReply;
347 /* end of forward declarations */
349 typedef union Sockaddr {
350 struct sockaddr sa_addr;
351 struct sockaddr_in sa_in_addr;
353 struct sockaddr_storage sa_storage;
354 struct sockaddr_in6 sa_in6_addr;
357 struct sockaddr_un sa_un_addr;
362 extern int slap_inet4or6;
366 struct berval som_oid;
369 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
371 LDAP_STAILQ_ENTRY(OidMacro) som_next;
374 typedef int slap_syntax_validate_func LDAP_P((
376 struct berval * in));
378 typedef int slap_syntax_transform_func LDAP_P((
384 #ifdef LDAP_COMP_MATCH
385 typedef void* slap_component_transform_func LDAP_P((
386 struct berval * in ));
387 struct ComponentDesc;
392 #define ssyn_oid ssyn_syn.syn_oid
393 #define ssyn_desc ssyn_syn.syn_desc
394 #define ssyn_extensions ssyn_syn.syn_extensions
397 ber_len_t ssyn_oidlen;
398 * has been replaced by a struct berval that uses the value
399 * provided by ssyn_syn.syn_oid; a macro that expands to
400 * the bv_len field of the berval is provided for backward
401 * compatibility. CAUTION: NEVER FREE THE BERVAL
403 struct berval ssyn_bvoid;
404 #define ssyn_oidlen ssyn_bvoid.bv_len
406 unsigned int ssyn_flags;
408 #define SLAP_SYNTAX_NONE 0x0000U
409 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
410 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
411 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
413 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
415 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
420 slap_syntax_validate_func *ssyn_validate;
421 slap_syntax_transform_func *ssyn_pretty;
423 #ifdef SLAPD_BINARY_CONVERSION
424 /* convert to and from binary */
425 slap_syntax_transform_func *ssyn_ber2str;
426 slap_syntax_transform_func *ssyn_str2ber;
428 #ifdef LDAP_COMP_MATCH
429 slap_component_transform_func *ssyn_attr2comp;
430 struct ComponentDesc* ssync_comp_syntax;
433 LDAP_SLIST_ENTRY(Syntax) ssyn_next;
436 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
437 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
438 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
439 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
440 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
442 typedef struct slap_syntax_defs_rec {
446 slap_syntax_validate_func *sd_validate;
447 slap_syntax_transform_func *sd_pretty;
448 #ifdef SLAPD_BINARY_CONVERSION
449 slap_syntax_transform_func *sd_ber2str;
450 slap_syntax_transform_func *sd_str2ber;
452 } slap_syntax_defs_rec;
454 /* X -> Y Converter */
455 typedef int slap_mr_convert_func LDAP_P((
461 typedef int slap_mr_normalize_func LDAP_P((
463 Syntax *syntax, /* NULL if in is asserted value */
469 /* Match (compare) function */
470 typedef int slap_mr_match_func LDAP_P((
473 Syntax *syntax, /* syntax of stored value */
475 struct berval *value,
476 void *assertValue ));
478 /* Index generation function */
479 typedef int slap_mr_indexer_func LDAP_P((
482 Syntax *syntax, /* syntax of stored value */
484 struct berval *prefix,
489 /* Filter index function */
490 typedef int slap_mr_filter_func LDAP_P((
493 Syntax *syntax, /* syntax of stored value */
495 struct berval *prefix,
500 struct MatchingRule {
501 LDAPMatchingRule smr_mrule;
502 MatchingRuleUse *smr_mru;
503 /* RFC 4512 string representation */
504 struct berval smr_str;
507 * ber_len_t smr_oidlen;
508 * has been replaced by a struct berval that uses the value
509 * provided by smr_mrule.mr_oid; a macro that expands to
510 * the bv_len field of the berval is provided for backward
511 * compatibility. CAUTION: NEVER FREE THE BERVAL
513 struct berval smr_bvoid;
514 #define smr_oidlen smr_bvoid.bv_len
516 slap_mask_t smr_usage;
519 #define SLAP_MR_HIDE 0x0000U
521 #define SLAP_MR_HIDE 0x8000U
524 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
526 #define SLAP_MR_TYPE_MASK 0x0F00U
527 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
528 #define SLAP_MR_USAGE 0x000FU
530 #define SLAP_MR_NONE 0x0000U
531 #define SLAP_MR_EQUALITY 0x0100U
532 #define SLAP_MR_ORDERING 0x0200U
533 #define SLAP_MR_SUBSTR 0x0400U
534 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
535 #define SLAP_MR_ORDERED_INDEX 0x1000U
536 #ifdef LDAP_COMP_MATCH
537 #define SLAP_MR_COMPONENT 0x2000U
540 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
542 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
543 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
544 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
548 * The asserted value, depending on the particular usage,
549 * is expected to conform to either the assertion syntax
550 * or the attribute syntax. In some cases, the syntax of
551 * the value is known. If so, these flags indicate which
552 * syntax the value is expected to conform to. If not,
553 * neither of these flags is set (until the syntax of the
554 * provided value is determined). If the value is of the
555 * attribute syntax, the flag is changed once a value of
556 * the assertion syntax is derived from the provided value.
558 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
559 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
560 #define SLAP_MR_VALUE_OF_SYNTAX (SLAP_MR_VALUE_OF_ASSERTION_SYNTAX|SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX)
561 #define SLAP_MR_DENORMALIZE (SLAP_MR_MUTATION_NORMALIZER)
563 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
564 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
565 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
566 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
568 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
569 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
571 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
573 #define SLAP_MR_IS_DENORMALIZE( usage ) \
574 ((usage) & SLAP_MR_DENORMALIZE )
576 /* either or both the asserted value or attribute value
577 * may be provided in normalized form
579 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
580 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
582 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
583 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
584 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
585 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
587 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
588 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
589 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
590 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
591 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
592 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
594 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
595 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
596 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
597 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
600 slap_mr_convert_func *smr_convert;
601 slap_mr_normalize_func *smr_normalize;
602 slap_mr_match_func *smr_match;
603 slap_mr_indexer_func *smr_indexer;
604 slap_mr_filter_func *smr_filter;
607 * null terminated array of syntaxes compatible with this syntax
608 * note: when MS_EXT is set, this MUST NOT contain the assertion
609 * syntax of the rule. When MS_EXT is not set, it MAY.
611 Syntax **smr_compat_syntaxes;
614 * For equality rules, refers to an associated approximate rule.
615 * For non-equality rules, refers to an associated equality rule.
617 MatchingRule *smr_associated;
619 #define SLAP_MR_ASSOCIATED(mr,amr) \
620 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
622 LDAP_SLIST_ENTRY(MatchingRule) smr_next;
624 #define smr_oid smr_mrule.mr_oid
625 #define smr_names smr_mrule.mr_names
626 #define smr_desc smr_mrule.mr_desc
627 #define smr_obsolete smr_mrule.mr_obsolete
628 #define smr_syntax_oid smr_mrule.mr_syntax_oid
629 #define smr_extensions smr_mrule.mr_extensions
632 struct MatchingRuleUse {
633 LDAPMatchingRuleUse smru_mruleuse;
634 MatchingRule *smru_mr;
635 /* RFC 4512 string representation */
636 struct berval smru_str;
638 LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next;
640 #define smru_oid smru_mruleuse.mru_oid
641 #define smru_names smru_mruleuse.mru_names
642 #define smru_desc smru_mruleuse.mru_desc
643 #define smru_obsolete smru_mruleuse.mru_obsolete
644 #define smru_applies_oids smru_mruleuse.mru_applies_oids
646 #define smru_usage smru_mr->smr_usage
647 } /* MatchingRuleUse */ ;
649 typedef struct slap_mrule_defs_rec {
651 slap_mask_t mrd_usage;
652 char ** mrd_compat_syntaxes;
653 slap_mr_convert_func * mrd_convert;
654 slap_mr_normalize_func * mrd_normalize;
655 slap_mr_match_func * mrd_match;
656 slap_mr_indexer_func * mrd_indexer;
657 slap_mr_filter_func * mrd_filter;
659 /* For equality rule, this may refer to an associated approximate rule */
660 /* For non-equality rule, this may refer to an associated equality rule */
661 char * mrd_associated;
662 } slap_mrule_defs_rec;
664 typedef int (AttributeTypeSchemaCheckFN)(
669 char *textbuf, size_t textlen );
671 struct AttributeType {
672 LDAPAttributeType sat_atype;
673 struct berval sat_cname;
674 AttributeType *sat_sup;
675 AttributeType **sat_subtypes;
676 MatchingRule *sat_equality;
677 MatchingRule *sat_approx;
678 MatchingRule *sat_ordering;
679 MatchingRule *sat_substr;
682 AttributeTypeSchemaCheckFN *sat_check;
685 #define SLAP_AT_NONE 0x0000U
686 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
687 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
689 #define SLAP_AT_HIDE 0x0000U /* publish everything */
691 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
693 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
695 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
697 /* Note: ORDERED values have an ordering specifically set by the
698 * user, denoted by the {x} ordering prefix on the values.
700 * SORTED values are simply sorted by memcmp. SORTED values can
701 * be efficiently located by binary search. ORDERED values have no
702 * such advantage. An attribute cannot have both properties.
704 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
705 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
706 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
708 #define SLAP_AT_SORTED_VAL 0x0010U /* values should be sorted */
710 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
711 #define SLAP_AT_DELETED 0x20000U
713 slap_mask_t sat_flags;
715 LDAP_STAILQ_ENTRY(AttributeType) sat_next;
717 #define sat_oid sat_atype.at_oid
718 #define sat_names sat_atype.at_names
719 #define sat_desc sat_atype.at_desc
720 #define sat_obsolete sat_atype.at_obsolete
721 #define sat_sup_oid sat_atype.at_sup_oid
722 #define sat_equality_oid sat_atype.at_equality_oid
723 #define sat_ordering_oid sat_atype.at_ordering_oid
724 #define sat_substr_oid sat_atype.at_substr_oid
725 #define sat_syntax_oid sat_atype.at_syntax_oid
726 #define sat_single_value sat_atype.at_single_value
727 #define sat_collective sat_atype.at_collective
728 #define sat_no_user_mod sat_atype.at_no_user_mod
729 #define sat_usage sat_atype.at_usage
730 #define sat_extensions sat_atype.at_extensions
732 AttributeDescription *sat_ad;
733 ldap_pvt_thread_mutex_t sat_ad_mutex;
736 #define is_at_operational(at) ((at)->sat_usage)
737 #define is_at_single_value(at) ((at)->sat_single_value)
738 #define is_at_collective(at) ((at)->sat_collective)
739 #define is_at_obsolete(at) ((at)->sat_obsolete)
740 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
742 typedef int (ObjectClassSchemaCheckFN)(
747 char *textbuf, size_t textlen );
750 LDAPObjectClass soc_oclass;
751 struct berval soc_cname;
752 ObjectClass **soc_sups;
753 AttributeType **soc_required;
754 AttributeType **soc_allowed;
755 ObjectClassSchemaCheckFN *soc_check;
757 slap_mask_t soc_flags;
758 #define soc_oid soc_oclass.oc_oid
759 #define soc_names soc_oclass.oc_names
760 #define soc_desc soc_oclass.oc_desc
761 #define soc_obsolete soc_oclass.oc_obsolete
762 #define soc_sup_oids soc_oclass.oc_sup_oids
763 #define soc_kind soc_oclass.oc_kind
764 #define soc_at_oids_must soc_oclass.oc_at_oids_must
765 #define soc_at_oids_may soc_oclass.oc_at_oids_may
766 #define soc_extensions soc_oclass.oc_extensions
768 LDAP_STAILQ_ENTRY(ObjectClass) soc_next;
771 #define SLAP_OCF_SET_FLAGS 0x1
772 #define SLAP_OCF_CHECK_SUP 0x2
773 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
775 #define SLAP_OC_ALIAS 0x0001
776 #define SLAP_OC_REFERRAL 0x0002
777 #define SLAP_OC_SUBENTRY 0x0004
778 #define SLAP_OC_DYNAMICOBJECT 0x0008
779 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
780 #define SLAP_OC_GLUE 0x0020
781 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
782 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
783 #define SLAP_OC__MASK 0x00FF
784 #define SLAP_OC__END 0x0100
785 #define SLAP_OC_OPERATIONAL 0x4000
787 #define SLAP_OC_HIDE 0x0000
789 #define SLAP_OC_HIDE 0x8000
791 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
792 #define SLAP_OC_DELETED 0x20000U
798 LDAPContentRule scr_crule;
799 ObjectClass *scr_sclass;
800 ObjectClass **scr_auxiliaries; /* optional */
801 AttributeType **scr_required; /* optional */
802 AttributeType **scr_allowed; /* optional */
803 AttributeType **scr_precluded; /* optional */
804 #define scr_oid scr_crule.cr_oid
805 #define scr_names scr_crule.cr_names
806 #define scr_desc scr_crule.cr_desc
807 #define scr_obsolete scr_crule.cr_obsolete
808 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
809 #define scr_at_oids_must scr_crule.cr_at_oids_must
810 #define scr_at_oids_may scr_crule.cr_at_oids_may
811 #define scr_at_oids_not scr_crule.cr_at_oids_not
814 #define SLAP_CR_HARDCODE 0x10000U
817 LDAP_STAILQ_ENTRY( ContentRule ) scr_next;
820 /* Represents a recognized attribute description ( type + options ). */
821 struct AttributeDescription {
822 AttributeDescription *ad_next;
823 AttributeType *ad_type; /* attribute type, must be specified */
824 struct berval ad_cname; /* canonical name, must be specified */
825 struct berval ad_tags; /* empty if no tagging options */
827 #define SLAP_DESC_NONE 0x00U
828 #define SLAP_DESC_BINARY 0x01U
829 #define SLAP_DESC_TAG_RANGE 0x80U
830 #define SLAP_DESC_TEMPORARY 0x1000U
833 /* flags to slap_*2undef_ad to register undefined (0, the default)
834 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
835 * SLAP_AD_NOINSERT is to lookup without insert */
836 #define SLAP_AD_UNDEF 0x00U
837 #define SLAP_AD_PROXIED 0x01U
838 #define SLAP_AD_NOINSERT 0x02U
840 struct AttributeName {
841 struct berval an_name;
842 AttributeDescription *an_desc;
847 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
848 #define slap_ad_is_tag_range(ad) \
849 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
850 #define slap_ad_is_binary(ad) \
851 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
854 * pointers to schema elements used internally
856 struct slap_internal_schema {
858 ObjectClass *si_oc_top;
859 ObjectClass *si_oc_extensibleObject;
860 ObjectClass *si_oc_alias;
861 ObjectClass *si_oc_referral;
862 ObjectClass *si_oc_rootdse;
863 ObjectClass *si_oc_subentry;
864 ObjectClass *si_oc_subschema;
865 ObjectClass *si_oc_collectiveAttributeSubentry;
866 ObjectClass *si_oc_dynamicObject;
868 ObjectClass *si_oc_glue;
869 ObjectClass *si_oc_syncConsumerSubentry;
870 ObjectClass *si_oc_syncProviderSubentry;
872 /* objectClass attribute descriptions */
873 AttributeDescription *si_ad_objectClass;
875 /* operational attribute descriptions */
876 AttributeDescription *si_ad_structuralObjectClass;
877 AttributeDescription *si_ad_creatorsName;
878 AttributeDescription *si_ad_createTimestamp;
879 AttributeDescription *si_ad_modifiersName;
880 AttributeDescription *si_ad_modifyTimestamp;
881 AttributeDescription *si_ad_hasSubordinates;
882 AttributeDescription *si_ad_subschemaSubentry;
883 AttributeDescription *si_ad_collectiveSubentries;
884 AttributeDescription *si_ad_collectiveExclusions;
885 AttributeDescription *si_ad_entryDN;
886 AttributeDescription *si_ad_entryUUID;
887 AttributeDescription *si_ad_entryCSN;
888 AttributeDescription *si_ad_namingCSN;
890 AttributeDescription *si_ad_dseType;
891 AttributeDescription *si_ad_syncreplCookie;
892 AttributeDescription *si_ad_syncTimestamp;
893 AttributeDescription *si_ad_contextCSN;
895 /* root DSE attribute descriptions */
896 AttributeDescription *si_ad_altServer;
897 AttributeDescription *si_ad_namingContexts;
898 AttributeDescription *si_ad_supportedControl;
899 AttributeDescription *si_ad_supportedExtension;
900 AttributeDescription *si_ad_supportedLDAPVersion;
901 AttributeDescription *si_ad_supportedSASLMechanisms;
902 AttributeDescription *si_ad_supportedFeatures;
903 AttributeDescription *si_ad_monitorContext;
904 AttributeDescription *si_ad_vendorName;
905 AttributeDescription *si_ad_vendorVersion;
906 AttributeDescription *si_ad_configContext;
908 /* subentry attribute descriptions */
909 AttributeDescription *si_ad_administrativeRole;
910 AttributeDescription *si_ad_subtreeSpecification;
912 /* subschema subentry attribute descriptions */
913 AttributeDescription *si_ad_attributeTypes;
914 AttributeDescription *si_ad_ditContentRules;
915 AttributeDescription *si_ad_ditStructureRules;
916 AttributeDescription *si_ad_ldapSyntaxes;
917 AttributeDescription *si_ad_matchingRules;
918 AttributeDescription *si_ad_matchingRuleUse;
919 AttributeDescription *si_ad_nameForms;
920 AttributeDescription *si_ad_objectClasses;
922 /* Aliases & Referrals */
923 AttributeDescription *si_ad_aliasedObjectName;
924 AttributeDescription *si_ad_ref;
926 /* Access Control Internals */
927 AttributeDescription *si_ad_entry;
928 AttributeDescription *si_ad_children;
929 AttributeDescription *si_ad_saslAuthzTo;
930 AttributeDescription *si_ad_saslAuthzFrom;
932 /* dynamic entries */
933 AttributeDescription *si_ad_entryTtl;
934 AttributeDescription *si_ad_dynamicSubtrees;
936 /* Other attributes descriptions */
937 AttributeDescription *si_ad_distinguishedName;
938 AttributeDescription *si_ad_name;
939 AttributeDescription *si_ad_cn;
940 AttributeDescription *si_ad_uid;
941 AttributeDescription *si_ad_uidNumber;
942 AttributeDescription *si_ad_gidNumber;
943 AttributeDescription *si_ad_userPassword;
944 AttributeDescription *si_ad_labeledURI;
945 #ifdef SLAPD_AUTHPASSWD
946 AttributeDescription *si_ad_authPassword;
947 AttributeDescription *si_ad_authPasswordSchemes;
949 AttributeDescription *si_ad_description;
950 AttributeDescription *si_ad_seeAlso;
952 /* Undefined Attribute Type */
953 AttributeType *si_at_undefined;
955 /* "Proxied" Attribute Type */
956 AttributeType *si_at_proxied;
959 MatchingRule *si_mr_distinguishedNameMatch;
960 MatchingRule *si_mr_dnSubtreeMatch;
961 MatchingRule *si_mr_dnOneLevelMatch;
962 MatchingRule *si_mr_dnSubordinateMatch;
963 MatchingRule *si_mr_dnSuperiorMatch;
964 MatchingRule *si_mr_caseExactMatch;
965 MatchingRule *si_mr_caseExactSubstringsMatch;
966 MatchingRule *si_mr_caseExactIA5Match;
967 MatchingRule *si_mr_integerMatch;
968 MatchingRule *si_mr_integerFirstComponentMatch;
969 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
972 Syntax *si_syn_directoryString;
973 Syntax *si_syn_distinguishedName;
974 Syntax *si_syn_integer;
975 Syntax *si_syn_octetString;
977 /* Schema Syntaxes */
978 Syntax *si_syn_attributeTypeDesc;
979 Syntax *si_syn_ditContentRuleDesc;
980 Syntax *si_syn_ditStructureRuleDesc;
981 Syntax *si_syn_ldapSyntaxDesc;
982 Syntax *si_syn_matchingRuleDesc;
983 Syntax *si_syn_matchingRuleUseDesc;
984 Syntax *si_syn_nameFormDesc;
985 Syntax *si_syn_objectClassDesc;
988 struct AttributeAssertion {
989 AttributeDescription *aa_desc;
990 struct berval aa_value;
991 #ifdef LDAP_COMP_MATCH
992 ComponentFilter *aa_cf; /* for attribute aliasing */
995 #ifdef LDAP_COMP_MATCH
996 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL, NULL }
998 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL }
1001 struct SubstringsAssertion {
1002 AttributeDescription *sa_desc;
1003 struct berval sa_initial;
1004 struct berval *sa_any;
1005 struct berval sa_final;
1008 struct MatchingRuleAssertion {
1009 AttributeDescription *ma_desc; /* optional */
1010 struct berval ma_value; /* required */
1011 MatchingRule *ma_rule; /* optional */
1012 struct berval ma_rule_text; /* optional */
1013 int ma_dnattrs; /* boolean */
1014 #ifdef LDAP_COMP_MATCH
1015 ComponentFilter *ma_cf; /* component filter */
1020 * represents a search filter
1023 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
1024 #define SLAPD_FILTER_COMPUTED 0
1025 #define SLAPD_FILTER_MASK 0x7fff
1026 #define SLAPD_FILTER_UNDEFINED 0x8000
1029 /* precomputed result */
1030 ber_int_t f_un_result;
1033 AttributeDescription *f_un_desc;
1035 /* simple value assertion */
1036 AttributeAssertion *f_un_ava;
1038 /* substring assertion */
1039 SubstringsAssertion *f_un_ssa;
1041 /* matching rule assertion */
1042 MatchingRuleAssertion *f_un_mra;
1044 #define f_desc f_un.f_un_desc
1045 #define f_ava f_un.f_un_ava
1046 #define f_av_desc f_un.f_un_ava->aa_desc
1047 #define f_av_value f_un.f_un_ava->aa_value
1048 #define f_sub f_un.f_un_ssa
1049 #define f_sub_desc f_un.f_un_ssa->sa_desc
1050 #define f_sub_initial f_un.f_un_ssa->sa_initial
1051 #define f_sub_any f_un.f_un_ssa->sa_any
1052 #define f_sub_final f_un.f_un_ssa->sa_final
1053 #define f_mra f_un.f_un_mra
1054 #define f_mr_rule f_un.f_un_mra->ma_rule
1055 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1056 #define f_mr_desc f_un.f_un_mra->ma_desc
1057 #define f_mr_value f_un.f_un_mra->ma_value
1058 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1061 Filter *f_un_complex;
1064 #define f_result f_un.f_un_result
1065 #define f_and f_un.f_un_complex
1066 #define f_or f_un.f_un_complex
1067 #define f_not f_un.f_un_complex
1068 #define f_list f_un.f_un_complex
1073 /* compare routines can return undefined */
1074 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1076 struct ValuesReturnFilter {
1077 ber_tag_t vrf_choice;
1080 /* precomputed result */
1081 ber_int_t vrf_un_result;
1087 AttributeDescription *vrf_un_desc;
1089 /* simple value assertion */
1090 AttributeAssertion *vrf_un_ava;
1092 /* substring assertion */
1093 SubstringsAssertion *vrf_un_ssa;
1095 /* matching rule assertion */
1096 MatchingRuleAssertion *vrf_un_mra;
1098 #define vrf_result vrf_un.vrf_un_result
1099 #define vrf_dn vrf_un.vrf_un_dn
1100 #define vrf_desc vrf_un.vrf_un_desc
1101 #define vrf_ava vrf_un.vrf_un_ava
1102 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1103 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1104 #define vrf_ssa vrf_un.vrf_un_ssa
1105 #define vrf_sub vrf_un.vrf_un_ssa
1106 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1107 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1108 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1109 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1110 #define vrf_mra vrf_un.vrf_un_mra
1111 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1112 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1113 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1114 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1115 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1120 ValuesReturnFilter *vrf_next;
1124 * represents an attribute (description + values)
1125 * desc, vals, nvals, numvals fields must align with Modification
1128 AttributeDescription *a_desc;
1129 BerVarray a_vals; /* preserved values */
1130 BerVarray a_nvals; /* normalized values */
1131 unsigned a_numvals; /* number of vals */
1133 #define SLAP_ATTR_IXADD 0x1U
1134 #define SLAP_ATTR_IXDEL 0x2U
1135 #define SLAP_ATTR_DONT_FREE_DATA 0x4U
1136 #define SLAP_ATTR_DONT_FREE_VALS 0x8U
1137 #define SLAP_ATTR_SORTED_VALS 0x10U /* values are sorted */
1139 /* These flags persist across an attr_dup() */
1140 #define SLAP_ATTR_PERSISTENT_FLAGS \
1141 SLAP_ATTR_SORTED_VALS
1144 #ifdef LDAP_COMP_MATCH
1145 ComponentData *a_comp_data; /* component values */
1151 * the id used in the indexes to refer to an entry
1153 typedef unsigned long ID;
1154 #define NOID ((ID)~0)
1156 typedef struct EntryHeader {
1164 * represents an entry in core
1168 * The ID field should only be changed before entry is
1169 * inserted into a cache. The ID value is backend
1174 struct berval e_name; /* name (DN) of this entry */
1175 struct berval e_nname; /* normalized name (DN) of this entry */
1177 /* for migration purposes */
1178 #define e_dn e_name.bv_val
1179 #define e_ndn e_nname.bv_val
1181 Attribute *e_attrs; /* list of attributes + values */
1183 slap_mask_t e_ocflags;
1185 struct berval e_bv; /* For entry_encode/entry_decode */
1187 /* for use by the backend for any purpose */
1192 * A list of LDAPMods
1193 * desc, values, nvalues, numvals must align with Attribute
1195 struct Modification {
1196 AttributeDescription *sm_desc;
1197 BerVarray sm_values;
1198 BerVarray sm_nvalues;
1199 unsigned sm_numvals;
1202 /* Set for internal mods, will bypass ACL checks. Only needed when
1203 * running as non-root user, for user modifiable attributes.
1205 #define SLAP_MOD_INTERNAL 0x01
1206 #define SLAP_MOD_MANAGING 0x02
1207 struct berval sm_type;
1210 struct Modifications {
1211 Modification sml_mod;
1212 #define sml_op sml_mod.sm_op
1213 #define sml_flags sml_mod.sm_flags
1214 #define sml_desc sml_mod.sm_desc
1215 #define sml_type sml_mod.sm_type
1216 #define sml_values sml_mod.sm_values
1217 #define sml_nvalues sml_mod.sm_nvalues
1218 #define sml_numvals sml_mod.sm_numvals
1219 Modifications *sml_next;
1223 * represents an access control list
1225 typedef enum slap_access_t {
1226 ACL_INVALID_ACCESS = -1,
1236 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1239 /* ACL level mask and modifiers */
1240 ACL_LEVEL_MASK = 0x000f,
1241 ACL_QUALIFIER1 = 0x0100,
1242 ACL_QUALIFIER2 = 0x0200,
1243 ACL_QUALIFIER3 = 0x0400,
1244 ACL_QUALIFIER4 = 0x0800,
1245 ACL_QUALIFIER_MASK = 0x0f00,
1247 /* write granularity */
1248 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1249 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1251 ACL_WRITE = ACL_WADD|ACL_WDEL
1254 typedef enum slap_control_e {
1255 ACL_INVALID_CONTROL = 0,
1261 typedef enum slap_style_e {
1262 ACL_STYLE_REGEX = 0,
1270 ACL_STYLE_ANONYMOUS,
1278 typedef struct AuthorizationInformation {
1279 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1280 struct berval sai_mech; /* SASL Mechanism */
1281 struct berval sai_dn; /* DN for reporting purposes */
1282 struct berval sai_ndn; /* Normalized DN */
1284 /* Security Strength Factors */
1285 slap_ssf_t sai_ssf; /* Overall SSF */
1286 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1287 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1288 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1289 } AuthorizationInformation;
1294 * "dynamic" ACL infrastructure (for ACIs and more)
1296 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1297 const char *opts, slap_style_t, const char *, void **privp ));
1298 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1299 typedef int (slap_dynacl_mask) LDAP_P((
1303 AttributeDescription *desc,
1306 regmatch_t *matches,
1307 slap_access_t *grant,
1308 slap_access_t *deny ));
1309 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1311 typedef struct slap_dynacl_t {
1313 slap_dynacl_parse *da_parse;
1314 slap_dynacl_unparse *da_unparse;
1315 slap_dynacl_mask *da_mask;
1316 slap_dynacl_destroy *da_destroy;
1319 struct slap_dynacl_t *da_next;
1321 #endif /* SLAP_DYNACL */
1323 /* the DN portion of the "by" part */
1324 typedef struct slap_dn_access {
1326 AuthorizationInformation a_dnauthz;
1327 #define a_pat a_dnauthz.sai_dn
1329 slap_style_t a_style;
1332 AttributeDescription *a_at;
1338 typedef struct Access {
1339 slap_control_t a_type;
1341 /* strip qualifiers */
1342 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1343 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1345 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1347 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1348 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1349 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1350 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1351 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1352 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1353 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1354 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1355 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1356 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1358 /* NOTE: always use the highest level; current: 0x00ffUL */
1359 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1362 #define ACL_PRIV_LEVEL 0x1000UL
1363 #define ACL_PRIV_ADDITIVE 0x2000UL
1364 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1367 #define ACL_PRIV_INVALID 0x0UL
1369 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1370 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1371 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1372 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1374 #define ACL_INIT(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_NONE)
1375 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_INVALID)
1377 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1379 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1381 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1382 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1383 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1385 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1386 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1387 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1388 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1389 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1390 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1391 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1392 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1393 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1394 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1396 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1397 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1398 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1399 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1400 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1401 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1402 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1403 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1404 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1405 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1406 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1408 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1409 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1410 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1411 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1412 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1413 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1414 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1415 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1416 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1417 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1419 slap_mask_t a_access_mask;
1422 slap_dn_access a_dn;
1423 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1424 #define a_dn_at a_dn.a_at
1425 #define a_dn_self a_dn.a_self
1427 /* real DN pattern */
1428 slap_dn_access a_realdn;
1429 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1430 #define a_realdn_at a_realdn.a_at
1431 #define a_realdn_self a_realdn.a_self
1433 /* used for ssf stuff
1434 * NOTE: the ssf stuff in a_realdn is ignored */
1435 #define a_authz a_dn.a_dnauthz
1437 /* connection related stuff */
1438 slap_style_t a_peername_style;
1439 struct berval a_peername_pat;
1440 #ifdef LDAP_PF_INET6
1442 struct in6_addr ax6;
1446 #define a_peername_addr6 ax_peername_addr.ax6
1447 #define a_peername_addr ax_peername_addr.ax
1448 #define a_peername_mask6 ax_peername_mask.ax6
1449 #define a_peername_mask ax_peername_mask.ax
1450 /* apparently, only s6_addr is portable;
1451 * define a portable address mask comparison */
1452 #define slap_addr6_mask(val, msk, asr) ( \
1453 (((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \
1454 && (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \
1455 && (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \
1456 && (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \
1457 && (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \
1458 && (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \
1459 && (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \
1460 && (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \
1461 && (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \
1462 && (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \
1463 && (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \
1464 && (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \
1465 && (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \
1466 && (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \
1467 && (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \
1468 && (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \
1470 #else /* ! LDAP_PF_INET6 */
1471 unsigned long a_peername_addr,
1473 #endif /* ! LDAP_PF_INET6 */
1474 int a_peername_port;
1476 slap_style_t a_sockname_style;
1477 struct berval a_sockname_pat;
1479 slap_style_t a_domain_style;
1480 struct berval a_domain_pat;
1481 int a_domain_expand;
1483 slap_style_t a_sockurl_style;
1484 struct berval a_sockurl_pat;
1485 slap_style_t a_set_style;
1486 struct berval a_set_pat;
1489 slap_dynacl_t *a_dynacl;
1490 #endif /* SLAP_DYNACL */
1493 slap_style_t a_group_style;
1494 struct berval a_group_pat;
1495 ObjectClass *a_group_oc;
1496 AttributeDescription *a_group_at;
1498 struct Access *a_next;
1502 typedef struct AccessControl {
1503 /* "to" part: the entries this acl applies to */
1505 slap_style_t acl_dn_style;
1507 struct berval acl_dn_pat;
1508 AttributeName *acl_attrs;
1509 MatchingRule *acl_attrval_mr;
1510 slap_style_t acl_attrval_style;
1511 regex_t acl_attrval_re;
1512 struct berval acl_attrval;
1514 /* "by" part: list of who has what access to the entries */
1517 struct AccessControl *acl_next;
1521 ACL_STATE_NOT_RECORDED = 0x0,
1522 ACL_STATE_RECORDED_VD = 0x1,
1523 ACL_STATE_RECORDED_NV = 0x2,
1524 ACL_STATE_RECORDED = ( ACL_STATE_RECORDED_VD | ACL_STATE_RECORDED_NV )
1527 typedef struct AccessControlState {
1529 AccessControl *as_vi_acl;
1530 AccessControl *as_vd_acl;
1531 AttributeDescription *as_vd_ad;
1534 slap_acl_state_t as_recorded;
1535 int as_vd_acl_count;
1537 } AccessControlState;
1538 #define ACL_STATE_INIT { NULL, NULL, NULL, \
1539 ACL_STATE_NOT_RECORDED, 0, 0 }
1543 * represents a backend
1546 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head;
1547 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head;
1549 LDAP_SLAPD_V (int) nBackendInfo;
1550 LDAP_SLAPD_V (int) nBackendDB;
1551 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1552 LDAP_SLAPD_V (slap_be_head) backendDB;
1553 LDAP_SLAPD_V (BackendDB *) frontendDB;
1555 LDAP_SLAPD_V (int) slapMode;
1556 #define SLAP_UNDEFINED_MODE 0x0000
1557 #define SLAP_SERVER_MODE 0x0001
1558 #define SLAP_TOOL_MODE 0x0002
1559 #define SLAP_MODE 0x0003
1561 #define SLAP_TRUNCATE_MODE 0x0100
1562 #define SLAP_TOOL_READMAIN 0x0200
1563 #define SLAP_TOOL_READONLY 0x0400
1564 #define SLAP_TOOL_QUICK 0x0800
1565 #define SLAP_TOOL_NO_SCHEMA_CHECK 0x1000
1567 #define SB_TLS_DEFAULT (-1)
1568 #define SB_TLS_OFF 0
1570 #define SB_TLS_CRITICAL 2
1572 typedef struct slap_bindconf {
1573 struct berval sb_uri;
1579 struct berval sb_binddn;
1580 struct berval sb_cred;
1581 struct berval sb_saslmech;
1583 struct berval sb_realm;
1584 struct berval sb_authcId;
1585 struct berval sb_authzId;
1590 char *sb_tls_cacert;
1591 char *sb_tls_cacertdir;
1592 char *sb_tls_reqcert;
1593 char *sb_tls_cipher_suite;
1594 #ifdef HAVE_OPENSSL_CRL
1595 char *sb_tls_crlcheck;
1601 typedef struct slap_verbmasks {
1603 const slap_mask_t mask;
1606 typedef struct slap_cf_aux_table {
1612 } slap_cf_aux_table;
1614 #define SLAP_LIMIT_TIME 1
1615 #define SLAP_LIMIT_SIZE 2
1617 struct slap_limits_set {
1625 int lms_s_unchecked;
1631 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1632 #define SLAP_NO_LIMIT -1
1633 #define SLAP_MAX_LIMIT 2147483647
1635 struct slap_limits {
1636 unsigned lm_flags; /* type of pattern */
1637 #define SLAP_LIMITS_UNDEFINED 0x0000U
1638 #define SLAP_LIMITS_EXACT 0x0001U
1639 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1640 #define SLAP_LIMITS_ONE 0x0002U
1641 #define SLAP_LIMITS_SUBTREE 0x0003U
1642 #define SLAP_LIMITS_CHILDREN 0x0004U
1643 #define SLAP_LIMITS_REGEX 0x0005U
1644 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1645 #define SLAP_LIMITS_USERS 0x0007U
1646 #define SLAP_LIMITS_ANY 0x0008U
1647 #define SLAP_LIMITS_MASK 0x000FU
1649 #define SLAP_LIMITS_TYPE_DN 0x0000U
1650 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1651 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1653 regex_t lm_regex; /* regex data for REGEX */
1656 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1657 * pattern for REGEX; NULL for ANONYMOUS, USERS
1659 struct berval lm_pat;
1661 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1662 * lm_group_oc is objectClass and lm_group_at is attributeType
1663 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1664 * can only be SLAP_LIMITS_EXACT */
1665 ObjectClass *lm_group_oc;
1666 AttributeDescription *lm_group_ad;
1668 struct slap_limits_set lm_limits;
1671 /* temporary aliases */
1672 typedef BackendDB Backend;
1673 #define nbackends nBackendDB
1674 #define backends backendDB
1677 * syncinfo structure for syncrepl
1682 #define SLAP_SYNC_RID_MAX 999
1683 #define SLAP_SYNC_SID_MAX 4095 /* based on liblutil/csn.c field width */
1684 #define SLAP_SYNCUUID_SET_SIZE 256
1686 #define SLAP_SYNC_UPDATE_MSGID 1
1688 struct sync_cookie {
1689 struct berval *ctxcsn;
1690 struct berval octet_str;
1695 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1698 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1700 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1702 #ifndef SLAP_MAX_CIDS
1703 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1706 struct ConfigOCs; /* config.h */
1709 BackendInfo *bd_info; /* pointer to shared backend info */
1710 BackendDB *bd_self; /* pointer to this struct */
1712 /* fields in this structure (and routines acting on this structure)
1713 should be renamed from be_ to bd_ */
1715 /* BackendInfo accessors */
1716 #define be_config bd_info->bi_db_config
1717 #define be_type bd_info->bi_type
1719 #define be_bind bd_info->bi_op_bind
1720 #define be_unbind bd_info->bi_op_unbind
1721 #define be_add bd_info->bi_op_add
1722 #define be_compare bd_info->bi_op_compare
1723 #define be_delete bd_info->bi_op_delete
1724 #define be_modify bd_info->bi_op_modify
1725 #define be_modrdn bd_info->bi_op_modrdn
1726 #define be_search bd_info->bi_op_search
1727 #define be_abandon bd_info->bi_op_abandon
1729 #define be_extended bd_info->bi_extended
1730 #define be_cancel bd_info->bi_op_cancel
1732 #define be_chk_referrals bd_info->bi_chk_referrals
1733 #define be_chk_controls bd_info->bi_chk_controls
1734 #define be_fetch bd_info->bi_entry_get_rw
1735 #define be_release bd_info->bi_entry_release_rw
1736 #define be_group bd_info->bi_acl_group
1737 #define be_attribute bd_info->bi_acl_attribute
1738 #define be_operational bd_info->bi_operational
1741 * define to honor hasSubordinates operational attribute in search filters
1742 * (in previous use there was a flaw with back-bdb; now it is fixed).
1744 #define be_has_subordinates bd_info->bi_has_subordinates
1746 #define be_connection_init bd_info->bi_connection_init
1747 #define be_connection_destroy bd_info->bi_connection_destroy
1750 #define be_entry_open bd_info->bi_tool_entry_open
1751 #define be_entry_close bd_info->bi_tool_entry_close
1752 #define be_entry_first bd_info->bi_tool_entry_first
1753 #define be_entry_next bd_info->bi_tool_entry_next
1754 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1755 #define be_entry_get bd_info->bi_tool_entry_get
1756 #define be_entry_put bd_info->bi_tool_entry_put
1757 #define be_sync bd_info->bi_tool_sync
1758 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1759 #define be_entry_modify bd_info->bi_tool_entry_modify
1762 /* supported controls */
1763 /* note: set to 0 if the database does not support the control;
1764 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1765 char be_ctrls[SLAP_MAX_CIDS + 1];
1767 /* Database flags */
1768 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1769 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1770 #define SLAP_DBFLAG_HIDDEN 0x0004U
1771 #define SLAP_DBFLAG_ONE_SUFFIX 0x0008U
1772 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1773 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1774 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1775 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1776 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1777 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1778 #define SLAP_DBFLAG_DYNAMIC 0x0400U /* this db allows dynamicObjects */
1779 #define SLAP_DBFLAG_MONITORING 0x0800U /* custom monitoring enabled */
1780 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1781 #define SLAP_DBFLAG_SINGLE_SHADOW 0x4000U /* a single-master shadow */
1782 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1783 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1784 slap_mask_t be_flags;
1785 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1786 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1787 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1788 #define SLAP_DBHIDDEN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN)
1789 #define SLAP_DB_ONE_SUFFIX(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ONE_SUFFIX)
1790 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1791 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1792 #define SLAP_DBMONITORING(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING)
1793 #define SLAP_NO_SCHEMA_CHECK(be) \
1794 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1795 #define SLAP_GLUE_INSTANCE(be) \
1796 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1797 #define SLAP_GLUE_SUBORDINATE(be) \
1798 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1799 #define SLAP_GLUE_LINKED(be) \
1800 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1801 #define SLAP_GLUE_ADVERTISE(be) \
1802 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1803 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1804 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1805 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1806 #define SLAP_SINGLE_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW)
1807 #define SLAP_MULTIMASTER(be) (!SLAP_SINGLE_SHADOW(be))
1809 slap_mask_t be_restrictops; /* restriction operations */
1810 #define SLAP_RESTRICT_OP_ADD 0x0001U
1811 #define SLAP_RESTRICT_OP_BIND 0x0002U
1812 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1813 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1814 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1815 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1816 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1817 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1818 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1820 #define SLAP_RESTRICT_READONLY 0x80000000U
1822 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1823 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1824 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1825 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1826 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1828 #define SLAP_RESTRICT_OP_READS \
1829 ( SLAP_RESTRICT_OP_COMPARE \
1830 | SLAP_RESTRICT_OP_SEARCH )
1831 #define SLAP_RESTRICT_OP_WRITES \
1832 ( SLAP_RESTRICT_OP_ADD \
1833 | SLAP_RESTRICT_OP_DELETE \
1834 | SLAP_RESTRICT_OP_MODIFY \
1835 | SLAP_RESTRICT_OP_RENAME )
1836 #define SLAP_RESTRICT_OP_ALL \
1837 ( SLAP_RESTRICT_OP_READS \
1838 | SLAP_RESTRICT_OP_WRITES \
1839 | SLAP_RESTRICT_OP_BIND \
1840 | SLAP_RESTRICT_OP_EXTENDED )
1842 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1843 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1844 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1846 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1847 #define SLAP_ALLOW_PROXY_AUTHZ_ANON 0x0010U /* allow anonymous proxyAuthz */
1849 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1850 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1852 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1853 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1855 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1857 slap_mask_t be_requires; /* pre-operation requirements */
1858 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1859 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1860 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1861 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1862 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1864 /* Required Security Strength Factor */
1865 slap_ssf_set_t be_ssf_set;
1867 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1868 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1869 struct berval be_schemadn; /* per-backend subschema subentry DN */
1870 struct berval be_schemandn; /* normalized subschema DN */
1871 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1872 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1873 struct berval be_rootpw; /* the magic "root" password for this db */
1874 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1875 #define be_sizelimit be_def_limit.lms_s_soft
1876 #define be_timelimit be_def_limit.lms_t_soft
1877 struct slap_limits_set be_def_limit; /* default limits */
1878 struct slap_limits **be_limits; /* regex-based size and time limits */
1879 AccessControl *be_acl; /* access control list for this backend */
1880 slap_access_t be_dfltaccess; /* access given if no acl matches */
1882 /* Replica Information */
1883 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1884 BerVarray be_update_refs; /* where to refer modifying clients to */
1885 struct be_pcl *be_pending_csn_list;
1886 ldap_pvt_thread_mutex_t be_pcl_mutex;
1887 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1888 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1890 void *be_pb; /* Netscape plugin */
1891 struct ConfigOCs *be_cf_ocs;
1893 void *be_private; /* anything the backend database needs */
1894 LDAP_STAILQ_ENTRY(BackendDB) be_next;
1897 /* Backend function typedefs */
1898 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1899 typedef BI_bi_func BI_init;
1900 typedef BI_bi_func BI_open;
1901 typedef BI_bi_func BI_close;
1902 typedef BI_bi_func BI_destroy;
1903 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1904 const char *fname, int lineno,
1905 int argc, char **argv));
1907 typedef struct config_reply_s ConfigReply; /* config.h */
1908 typedef int (BI_db_func) LDAP_P((Backend *bd, ConfigReply *cr));
1909 typedef BI_db_func BI_db_init;
1910 typedef BI_db_func BI_db_open;
1911 typedef BI_db_func BI_db_close;
1912 typedef BI_db_func BI_db_destroy;
1913 typedef int (BI_db_config) LDAP_P((Backend *bd,
1914 const char *fname, int lineno,
1915 int argc, char **argv));
1917 typedef struct req_bind_s {
1919 struct berval rb_cred;
1920 struct berval rb_edn;
1922 struct berval rb_mech;
1925 typedef struct req_search_s {
1930 /* NULL means be_isroot evaluated to TRUE */
1931 struct slap_limits_set *rs_limit;
1933 AttributeName *rs_attrs;
1935 struct berval rs_filterstr;
1938 typedef struct req_compare_s {
1939 AttributeAssertion *rs_ava;
1942 typedef struct req_modifications_s {
1943 Modifications *rs_modlist;
1944 char rs_no_opattrs; /* don't att modify operational attrs */
1945 } req_modifications_s;
1947 typedef struct req_modify_s {
1948 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1952 typedef struct req_modrdn_s {
1953 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1954 int rs_deleteoldrdn;
1955 struct berval rs_newrdn;
1956 struct berval rs_nnewrdn;
1957 struct berval *rs_newSup;
1958 struct berval *rs_nnewSup;
1961 typedef struct req_add_s {
1962 Modifications *rs_modlist;
1966 typedef struct req_abandon_s {
1971 #define SLAP_EXOP_HIDE 0x0000
1973 #define SLAP_EXOP_HIDE 0x8000
1975 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1977 typedef struct req_extended_s {
1978 struct berval rs_reqoid;
1980 struct berval *rs_reqdata;
1983 typedef struct req_pwdexop_s {
1984 struct req_extended_s rs_extended;
1985 struct berval rs_old;
1986 struct berval rs_new;
1987 Modifications *rs_mods;
1988 Modifications **rs_modtail;
1991 typedef enum slap_reply_e {
2001 typedef struct rep_sasl_s {
2002 struct berval *r_sasldata;
2005 typedef struct rep_extended_s {
2006 const char *r_rspoid;
2007 struct berval *r_rspdata;
2010 typedef struct rep_search_s {
2012 slap_mask_t r_attr_flags;
2013 #define SLAP_ATTRS_UNDEFINED (0x00U)
2014 #define SLAP_OPATTRS_NO (0x01U)
2015 #define SLAP_OPATTRS_YES (0x02U)
2016 #define SLAP_USERATTRS_NO (0x10U)
2017 #define SLAP_USERATTRS_YES (0x20U)
2018 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
2019 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
2020 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
2021 #define SLAP_USERATTRS(f) \
2022 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
2024 Attribute *r_operational_attrs;
2025 AttributeName *r_attrs;
2031 slap_reply_t sr_type;
2035 const char *sr_matched;
2036 const char *sr_text;
2038 LDAPControl **sr_ctrls;
2040 rep_sasl_s sru_sasl;
2041 rep_extended_s sru_extended;
2042 rep_search_s sru_search;
2044 slap_mask_t sr_flags;
2045 #define REP_ENTRY_MODIFIABLE 0x0001U
2046 #define REP_ENTRY_MUSTBEFREED 0x0002U
2047 #define REP_ENTRY_MUSTRELEASE 0x0004U
2048 #define REP_ENTRY_MASK (REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2050 #define REP_MATCHED_MUSTBEFREED 0x0010U
2051 #define REP_MATCHED_MASK (REP_MATCHED_MUSTBEFREED)
2053 #define REP_REF_MUSTBEFREED 0x0020U
2054 #define REP_REF_MASK (REP_REF_MUSTBEFREED)
2056 #define REP_NO_ENTRYDN 0x1000U
2057 #define REP_NO_SUBSCHEMA 0x2000U
2058 #define REP_NO_OPERATIONALS (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2061 /* short hands for response members */
2062 #define sr_attrs sr_un.sru_search.r_attrs
2063 #define sr_entry sr_un.sru_search.r_entry
2064 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2065 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2066 #define sr_v2ref sr_un.sru_search.r_v2ref
2067 #define sr_nentries sr_un.sru_search.r_nentries
2068 #define sr_rspoid sr_un.sru_extended.r_rspoid
2069 #define sr_rspdata sr_un.sru_extended.r_rspdata
2070 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2072 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs ));
2073 typedef BI_op_func BI_op_bind;
2074 typedef BI_op_func BI_op_unbind;
2075 typedef BI_op_func BI_op_search;
2076 typedef BI_op_func BI_op_compare;
2077 typedef BI_op_func BI_op_modify;
2078 typedef BI_op_func BI_op_modrdn;
2079 typedef BI_op_func BI_op_add;
2080 typedef BI_op_func BI_op_delete;
2081 typedef BI_op_func BI_op_abandon;
2082 typedef BI_op_func BI_op_extended;
2083 typedef BI_op_func BI_op_cancel;
2084 typedef BI_op_func BI_chk_referrals;
2085 typedef BI_op_func BI_chk_controls;
2086 typedef int (BI_entry_release_rw)
2087 LDAP_P(( Operation *op, Entry *e, int rw ));
2088 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn,
2089 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2090 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs ));
2091 typedef int (BI_has_subordinates) LDAP_P(( Operation *op,
2092 Entry *e, int *hasSubs ));
2093 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e,
2094 AttributeDescription *desc, struct berval *val, slap_access_t access,
2095 AccessControlState *state, slap_mask_t *maskp ));
2096 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target,
2097 struct berval *gr_ndn, struct berval *op_ndn,
2098 ObjectClass *group_oc, AttributeDescription *group_at ));
2099 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target,
2100 struct berval *entry_ndn, AttributeDescription *entry_at,
2101 BerVarray *vals, slap_access_t access ));
2103 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c ));
2104 typedef BI_conn_func BI_connection_init;
2105 typedef BI_conn_func BI_connection_destroy;
2107 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2108 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2109 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2110 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2111 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2112 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2113 struct berval *text ));
2114 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv ));
2115 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2116 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2117 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2118 struct berval *text ));
2120 struct BackendInfo {
2121 char *bi_type; /* type of backend */
2124 * per backend type routines:
2125 * bi_init: called to allocate a backend_info structure,
2126 * called once BEFORE configuration file is read.
2127 * bi_init() initializes this structure hence is
2128 * called directly from be_initialize()
2129 * bi_config: called per 'backend' specific option
2130 * all such options must before any 'database' options
2131 * bi_config() is called only from read_config()
2132 * bi_open: called to open each database, called
2133 * once AFTER configuration file is read but
2134 * BEFORE any bi_db_open() calls.
2135 * bi_open() is called from backend_startup()
2136 * bi_close: called to close each database, called
2137 * once during shutdown after all bi_db_close calls.
2138 * bi_close() is called from backend_shutdown()
2139 * bi_destroy: called to destroy each database, called
2140 * once during shutdown after all bi_db_destroy calls.
2141 * bi_destory() is called from backend_destroy()
2144 BI_config *bi_config;
2147 BI_destroy *bi_destroy;
2150 * per database routines:
2151 * bi_db_init: called to initialize each database,
2152 * called upon reading 'database <type>'
2153 * called only from backend_db_init()
2154 * bi_db_config: called to configure each database,
2155 * called per database to handle per database options
2156 * called only from read_config()
2157 * bi_db_open: called to open each database
2158 * called once per database immediately AFTER bi_open()
2159 * calls but before daemon startup.
2160 * called only by backend_startup()
2161 * bi_db_close: called to close each database
2162 * called once per database during shutdown but BEFORE
2163 * any bi_close call.
2164 * called only by backend_shutdown()
2165 * bi_db_destroy: called to destroy each database
2166 * called once per database during shutdown AFTER all
2167 * bi_close calls but before bi_destory calls.
2168 * called only by backend_destory()
2170 BI_db_init *bi_db_init;
2171 BI_db_config *bi_db_config;
2172 BI_db_open *bi_db_open;
2173 BI_db_close *bi_db_close;
2174 BI_db_destroy *bi_db_destroy;
2176 /* LDAP Operations Handling Routines */
2177 BI_op_bind *bi_op_bind;
2178 BI_op_unbind *bi_op_unbind;
2179 BI_op_search *bi_op_search;
2180 BI_op_compare *bi_op_compare;
2181 BI_op_modify *bi_op_modify;
2182 BI_op_modrdn *bi_op_modrdn;
2183 BI_op_add *bi_op_add;
2184 BI_op_delete *bi_op_delete;
2185 BI_op_abandon *bi_op_abandon;
2187 /* Extended Operations Helper */
2188 BI_op_extended *bi_extended;
2189 BI_op_cancel *bi_op_cancel;
2191 /* Auxilary Functions */
2192 BI_operational *bi_operational;
2193 BI_chk_referrals *bi_chk_referrals;
2194 BI_chk_controls *bi_chk_controls;
2195 BI_entry_get_rw *bi_entry_get_rw;
2196 BI_entry_release_rw *bi_entry_release_rw;
2198 BI_has_subordinates *bi_has_subordinates;
2199 BI_access_allowed *bi_access_allowed;
2200 BI_acl_group *bi_acl_group;
2201 BI_acl_attribute *bi_acl_attribute;
2203 BI_connection_init *bi_connection_init;
2204 BI_connection_destroy *bi_connection_destroy;
2206 /* hooks for slap tools */
2207 BI_tool_entry_open *bi_tool_entry_open;
2208 BI_tool_entry_close *bi_tool_entry_close;
2209 BI_tool_entry_first *bi_tool_entry_first;
2210 BI_tool_entry_next *bi_tool_entry_next;
2211 BI_tool_entry_get *bi_tool_entry_get;
2212 BI_tool_entry_put *bi_tool_entry_put;
2213 BI_tool_entry_reindex *bi_tool_entry_reindex;
2214 BI_tool_sync *bi_tool_sync;
2215 BI_tool_dn2id_get *bi_tool_dn2id_get;
2216 BI_tool_entry_modify *bi_tool_entry_modify;
2218 #define SLAP_INDEX_ADD_OP 0x0001
2219 #define SLAP_INDEX_DELETE_OP 0x0002
2221 slap_mask_t bi_flags; /* backend flags */
2222 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2223 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2224 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2225 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2226 #define SLAP_BFLAG_INCREMENT 0x0100U
2227 #define SLAP_BFLAG_ALIASES 0x1000U
2228 #define SLAP_BFLAG_REFERRALS 0x2000U
2229 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2230 #define SLAP_BFLAG_DYNAMIC 0x8000U
2232 /* overlay specific */
2233 #define SLAPO_BFLAG_SINGLE 0x01000000U
2234 #define SLAPO_BFLAG_DBONLY 0x02000000U
2235 #define SLAPO_BFLAG_GLOBONLY 0x04000000U
2236 #define SLAPO_BFLAG_MASK 0xFF000000U
2238 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2239 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2240 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2241 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2242 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2243 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2244 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2245 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2246 #define SLAP_DYNAMIC(be) ((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC))
2247 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2248 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2250 /* overlay specific */
2251 #define SLAPO_SINGLE(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE)
2252 #define SLAPO_DBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY)
2253 #define SLAPO_GLOBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY)
2255 char **bi_controls; /* supported controls */
2256 char bi_ctrls[SLAP_MAX_CIDS + 1];
2258 unsigned int bi_nDB; /* number of databases of this type */
2259 struct ConfigOCs *bi_cf_ocs;
2260 char **bi_obsolete_names;
2261 void *bi_extra; /* backend type-specific APIs */
2262 void *bi_private; /* backend type-specific config data */
2263 LDAP_STAILQ_ENTRY(BackendInfo) bi_next ;
2266 #define c_authtype c_authz.sai_method
2267 #define c_authmech c_authz.sai_mech
2268 #define c_dn c_authz.sai_dn
2269 #define c_ndn c_authz.sai_ndn
2270 #define c_ssf c_authz.sai_ssf
2271 #define c_transport_ssf c_authz.sai_transport_ssf
2272 #define c_tls_ssf c_authz.sai_tls_ssf
2273 #define c_sasl_ssf c_authz.sai_sasl_ssf
2275 #define o_authtype o_authz.sai_method
2276 #define o_authmech o_authz.sai_mech
2277 #define o_dn o_authz.sai_dn
2278 #define o_ndn o_authz.sai_ndn
2279 #define o_ssf o_authz.sai_ssf
2280 #define o_transport_ssf o_authz.sai_transport_ssf
2281 #define o_tls_ssf o_authz.sai_tls_ssf
2282 #define o_sasl_ssf o_authz.sai_sasl_ssf
2284 typedef int (slap_response)( Operation *, SlapReply * );
2286 typedef struct slap_callback {
2287 struct slap_callback *sc_next;
2288 slap_response *sc_response;
2289 slap_response *sc_cleanup;
2293 struct slap_overinfo;
2295 typedef enum slap_operation_e {
2308 op_aux_chk_referrals,
2309 op_aux_chk_controls,
2313 typedef struct slap_overinst {
2315 slap_response *on_response;
2316 struct slap_overinfo *on_info;
2317 struct slap_overinst *on_next;
2320 typedef struct slap_overinfo {
2322 BackendInfo *oi_orig;
2323 BackendDB *oi_origdb;
2324 struct slap_overinst *oi_list;
2327 /* Should successive callbacks in a chain be processed? */
2328 #define SLAP_CB_FREEME 0x04000
2329 #define SLAP_CB_BYPASS 0x08800
2330 #define SLAP_CB_CONTINUE 0x08000
2333 * Paged Results state
2335 typedef unsigned long PagedResultsCookie;
2336 typedef struct PagedResultsState {
2340 PagedResultsCookie ps_cookie;
2341 struct berval ps_cookieval;
2342 } PagedResultsState;
2344 struct slap_csn_entry {
2345 struct berval ce_csn;
2346 unsigned long ce_opid;
2347 unsigned long ce_connid;
2348 #define SLAP_CSN_PENDING 1
2349 #define SLAP_CSN_COMMIT 2
2351 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2355 * Caches the result of a backend_group check for ACL evaluation
2357 typedef struct GroupAssertion {
2358 struct GroupAssertion *ga_next;
2361 AttributeDescription *ga_at;
2367 struct slap_control_ids {
2373 int sc_modifyIncrement;
2375 int sc_pagedResults;
2376 int sc_permissiveModify;
2381 int sc_searchOptions;
2382 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2383 int sc_sortedResults;
2386 #ifdef SLAP_CONTROL_X_TREE_DELETE
2392 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2393 int sc_sessionTracking;
2395 int sc_valuesReturnFilter;
2415 typedef struct slap_counters_t {
2416 struct slap_counters_t *sc_next;
2417 ldap_pvt_thread_mutex_t sc_mutex;
2418 ldap_pvt_mp_t sc_bytes;
2419 ldap_pvt_mp_t sc_pdu;
2420 ldap_pvt_mp_t sc_entries;
2421 ldap_pvt_mp_t sc_refs;
2423 ldap_pvt_mp_t sc_ops_completed;
2424 ldap_pvt_mp_t sc_ops_initiated;
2425 #ifdef SLAPD_MONITOR
2426 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2427 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2428 #endif /* SLAPD_MONITOR */
2432 * represents an operation pending from an ldap client
2434 typedef struct Opheader {
2435 unsigned long oh_opid; /* id of this operation */
2436 unsigned long oh_connid; /* id of conn initiating this op */
2437 Connection *oh_conn; /* connection spawning this op */
2439 ber_int_t oh_msgid; /* msgid of the request */
2440 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2442 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2444 void *oh_threadctx; /* thread pool thread context */
2445 void *oh_tmpmemctx; /* slab malloc context */
2446 BerMemoryFunctions *oh_tmpmfuncs;
2448 slap_counters_t *oh_counters;
2450 char oh_log_prefix[ /* sizeof("conn= op=") + 2*LDAP_PVT_INTTYPE_CHARS(unsigned long) */ SLAP_TEXT_BUFLEN ];
2453 void *oh_extensions; /* NS-SLAPI plugin */
2457 typedef union OpRequest {
2460 req_compare_s oq_compare;
2461 req_modify_s oq_modify;
2462 req_modrdn_s oq_modrdn;
2463 req_search_s oq_search;
2464 req_abandon_s oq_abandon;
2465 req_abandon_s oq_cancel;
2466 req_extended_s oq_extended;
2467 req_pwdexop_s oq_pwdexop;
2470 /* This is only a header. Actual users should define their own
2471 * structs with the oe_next / oe_key fields at the top and
2472 * whatever else they need following.
2474 typedef struct OpExtra {
2475 LDAP_SLIST_ENTRY(OpExtra) oe_next;
2479 typedef struct OpExtraDB {
2487 #define o_opid o_hdr->oh_opid
2488 #define o_connid o_hdr->oh_connid
2489 #define o_conn o_hdr->oh_conn
2490 #define o_msgid o_hdr->oh_msgid
2491 #define o_protocol o_hdr->oh_protocol
2492 #define o_tid o_hdr->oh_tid
2493 #define o_threadctx o_hdr->oh_threadctx
2494 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2495 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2496 #define o_counters o_hdr->oh_counters
2498 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2499 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2500 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2501 #define o_tmpfree o_tmpmfuncs->bmf_free
2503 #define o_log_prefix o_hdr->oh_log_prefix
2505 ber_tag_t o_tag; /* tag of the request */
2506 time_t o_time; /* time op was initiated */
2507 int o_tincr; /* counter for multiple ops with same o_time */
2509 BackendDB *o_bd; /* backend DB processing this op */
2510 struct berval o_req_dn; /* DN of target of request */
2511 struct berval o_req_ndn;
2513 OpRequest o_request;
2515 /* short hands for union members */
2516 #define oq_add o_request.oq_add
2517 #define oq_bind o_request.oq_bind
2518 #define oq_compare o_request.oq_compare
2519 #define oq_modify o_request.oq_modify
2520 #define oq_modrdn o_request.oq_modrdn
2521 #define oq_search o_request.oq_search
2522 #define oq_abandon o_request.oq_abandon
2523 #define oq_cancel o_request.oq_cancel
2524 #define oq_extended o_request.oq_extended
2525 #define oq_pwdexop o_request.oq_pwdexop
2527 /* short hands for inner request members */
2528 #define orb_method oq_bind.rb_method
2529 #define orb_cred oq_bind.rb_cred
2530 #define orb_edn oq_bind.rb_edn
2531 #define orb_ssf oq_bind.rb_ssf
2532 #define orb_mech oq_bind.rb_mech
2534 #define ors_scope oq_search.rs_scope
2535 #define ors_deref oq_search.rs_deref
2536 #define ors_slimit oq_search.rs_slimit
2537 #define ors_tlimit oq_search.rs_tlimit
2538 #define ors_limit oq_search.rs_limit
2539 #define ors_attrsonly oq_search.rs_attrsonly
2540 #define ors_attrs oq_search.rs_attrs
2541 #define ors_filter oq_search.rs_filter
2542 #define ors_filterstr oq_search.rs_filterstr
2544 #define orr_modlist oq_modrdn.rs_mods.rs_modlist
2545 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs
2546 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2547 #define orr_newrdn oq_modrdn.rs_newrdn
2548 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2549 #define orr_newSup oq_modrdn.rs_newSup
2550 #define orr_nnewSup oq_modrdn.rs_nnewSup
2552 #define orc_ava oq_compare.rs_ava
2554 #define ora_e oq_add.rs_e
2555 #define ora_modlist oq_add.rs_modlist
2557 #define orn_msgid oq_abandon.rs_msgid
2559 #define orm_modlist oq_modify.rs_mods.rs_modlist
2560 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs
2561 #define orm_increment oq_modify.rs_increment
2563 #define ore_reqoid oq_extended.rs_reqoid
2564 #define ore_flags oq_extended.rs_flags
2565 #define ore_reqdata oq_extended.rs_reqdata
2566 volatile sig_atomic_t o_abandon; /* abandon flag */
2567 volatile sig_atomic_t o_cancel; /* cancel flag */
2568 #define SLAP_CANCEL_NONE 0x00
2569 #define SLAP_CANCEL_REQ 0x01
2570 #define SLAP_CANCEL_ACK 0x02
2571 #define SLAP_CANCEL_DONE 0x03
2573 GroupAssertion *o_groups;
2574 char o_do_not_cache; /* don't cache groups from this op */
2575 char o_is_auth_check; /* authorization in progress */
2576 slap_access_t o_acl_priv;
2579 char o_delete_glue_parent;
2580 char o_no_schema_check;
2581 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2582 char o_no_subordinate_glue;
2583 #define get_no_subordinate_glue(op) ((op)->o_no_subordinate_glue)
2585 #define SLAP_CONTROL_NONE 0
2586 #define SLAP_CONTROL_IGNORED 1
2587 #define SLAP_CONTROL_NONCRITICAL 2
2588 #define SLAP_CONTROL_CRITICAL 3
2589 #define SLAP_CONTROL_MASK 3
2591 /* spare bits for simple flags */
2592 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2593 #define SLAP_CONTROL_DATA0 0x10
2594 #define SLAP_CONTROL_DATA1 0x20
2595 #define SLAP_CONTROL_DATA2 0x40
2596 #define SLAP_CONTROL_DATA3 0x80
2598 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2600 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2601 void **o_controls; /* per-control state */
2603 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2604 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2606 #define o_relax o_ctrlflag[slap_cids.sc_relax]
2607 #define get_relax(op) _SCM((op)->o_relax)
2609 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2610 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2612 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2613 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2614 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2616 #define get_subentries(op) _SCM((op)->o_subentries)
2617 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2619 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2620 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2622 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2623 #define get_assert(op) ((int)(op)->o_assert)
2624 #define o_assertion o_controls[slap_cids.sc_assert]
2625 #define get_assertion(op) ((op)->o_assertion)
2627 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2628 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2630 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2631 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2633 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2634 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2636 #ifdef SLAP_CONTROL_X_TREE_DELETE
2637 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2638 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2641 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2642 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2644 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2645 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2647 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2648 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2649 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2651 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2652 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2656 #define o_txnSpec o_ctrlflag[slap_cids.sc_txnSpec]
2659 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2660 #define o_session_tracking o_ctrlflag[slap_cids.sc_sessionTracking]
2661 #define o_tracked_sessions o_controls[slap_cids.sc_sessionTracking]
2662 #define get_sessionTracking(op) ((int)(op)->o_session_tracking)
2665 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2667 AuthorizationInformation o_authz;
2669 BerElement *o_ber; /* ber of the request */
2670 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2671 slap_callback *o_callback; /* callback pointers */
2672 LDAPControl **o_ctrls; /* controls */
2673 struct berval o_csn;
2675 /* DEPRECATE o_private - use o_extra instead */
2676 void *o_private; /* anything the backend needs */
2677 LDAP_SLIST_HEAD(o_e, OpExtra) o_extra; /* anything the backend needs */
2679 LDAP_STAILQ_ENTRY(Operation) o_next; /* next operation in list */
2682 typedef struct OperationBuffer {
2685 void *ob_controls[SLAP_MAX_CIDS];
2688 #define send_ldap_error( op, rs, err, text ) do { \
2689 (rs)->sr_err = err; (rs)->sr_text = text; \
2690 ((op)->o_conn->c_send_ldap_result)( op, rs ); \
2692 #define send_ldap_discon( op, rs, err, text ) do { \
2693 (rs)->sr_err = err; (rs)->sr_text = text; \
2694 send_ldap_disconnect( op, rs ); \
2697 typedef void (SEND_LDAP_RESULT)(
2698 Operation *op, SlapReply *rs);
2699 typedef int (SEND_SEARCH_ENTRY)(
2700 Operation *op, SlapReply *rs);
2701 typedef int (SEND_SEARCH_REFERENCE)(
2702 Operation *op, SlapReply *rs);
2703 typedef void (SEND_LDAP_EXTENDED)(
2704 Operation *op, SlapReply *rs);
2705 typedef void (SEND_LDAP_INTERMEDIATE)(
2706 Operation *op, SlapReply *rs);
2708 #define send_ldap_result( op, rs ) \
2709 ((op)->o_conn->c_send_ldap_result)( op, rs )
2710 #define send_search_entry( op, rs ) \
2711 ((op)->o_conn->c_send_search_entry)( op, rs )
2712 #define send_search_reference( op, rs ) \
2713 ((op)->o_conn->c_send_search_reference)( op, rs )
2714 #define send_ldap_extended( op, rs ) \
2715 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2716 #define send_ldap_intermediate( op, rs ) \
2717 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2719 typedef struct slap_listener Listener;
2722 * represents a connection from an ldap client
2725 int c_struct_state; /* structure management state */
2726 int c_conn_state; /* connection state */
2727 int c_conn_idx; /* slot in connections array */
2729 const char *c_close_reason; /* why connection is closing */
2731 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2732 Sockbuf *c_sb; /* ber connection stuff */
2734 /* only can be changed by connect_init */
2735 time_t c_starttime; /* when the connection was opened */
2736 time_t c_activitytime; /* when the connection was last used */
2737 unsigned long c_connid; /* id of this connection for stats*/
2739 struct berval c_peer_domain; /* DNS name of client */
2740 struct berval c_peer_name; /* peer name (trans=addr:port) */
2741 Listener *c_listener;
2742 #define c_listener_url c_listener->sl_url /* listener URL */
2743 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2745 /* only can be changed by binding thread */
2746 struct berval c_sasl_bind_mech; /* mech in progress */
2747 struct berval c_sasl_dn; /* temporary storage */
2748 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2750 /* authorization backend */
2751 Backend *c_authz_backend;
2752 void *c_authz_cookie;
2753 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2754 ( (op)->o_bd != NULL \
2755 && (op)->o_bd->be_private != NULL \
2756 && (op)->o_conn != NULL \
2757 && (op)->o_conn->c_authz_backend != NULL \
2758 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2759 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2761 AuthorizationInformation c_authz;
2763 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2765 LDAP_STAILQ_HEAD(c_o, Operation) c_ops; /* list of operations being processed */
2766 LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops; /* list of pending operations */
2768 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2769 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2771 BerElement *c_currentber; /* ber we're attempting to read */
2773 char c_sasl_bind_in_progress; /* multi-op bind in progress */
2775 char c_writewaiter; /* true if writer is waiting */
2777 #define CONN_IS_TLS 1
2778 #define CONN_IS_UDP 2
2779 #define CONN_IS_CLIENT 4
2780 #define CONN_IS_IPC 8
2782 #ifdef LDAP_CONNECTIONLESS
2783 char c_is_udp; /* true if this is (C)LDAP over UDP */
2786 char c_is_tls; /* true if this LDAP over raw TLS */
2787 char c_needs_tls_accept; /* true if SSL_accept should be called */
2789 char c_sasl_layers; /* true if we need to install SASL i/o handlers */
2790 char c_sasl_done; /* SASL completed once */
2791 void *c_sasl_authctx; /* SASL authentication context */
2792 void *c_sasl_sockctx; /* SASL security layer context */
2793 void *c_sasl_extra; /* SASL session extra stuff */
2794 Operation *c_sasl_bindop; /* set to current op if it's a bind */
2797 #define CONN_TXN_INACTIVE 0
2798 #define CONN_TXN_SPECIFY 1
2799 #define CONN_TXN_SETTLE -1
2802 Backend *c_txn_backend;
2803 LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */
2806 PagedResultsState c_pagedresults_state; /* paged result state */
2808 long c_n_ops_received; /* num of ops received (next op_id) */
2809 long c_n_ops_executing; /* num of ops currently executing */
2810 long c_n_ops_pending; /* num of ops pending execution */
2811 long c_n_ops_completed; /* num of ops completed */
2813 long c_n_get; /* num of get calls */
2814 long c_n_read; /* num of read calls */
2815 long c_n_write; /* num of write calls */
2817 void *c_extensions; /* Netscape plugin */
2820 * Client connection handling
2822 ldap_pvt_thread_start_t *c_clientfunc;
2826 * These are the "callbacks" that are available for back-ends to
2827 * supply data back to connected clients that are connected
2828 * through the "front-end".
2830 SEND_LDAP_RESULT *c_send_ldap_result;
2831 SEND_SEARCH_ENTRY *c_send_search_entry;
2832 SEND_SEARCH_REFERENCE *c_send_search_reference;
2833 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2834 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2840 #define SLAP_DEFAULT_SYSLOG_USER LOG_LOCAL4
2841 #endif /* LOG_LOCAL4 */
2843 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2844 Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2845 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2846 #else /* !LDAP_SYSLOG */
2847 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2849 if ( ldap_debug & (level) ) \
2850 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2852 #define StatslogTest( level ) (ldap_debug & (level))
2853 #endif /* !LDAP_SYSLOG */
2854 #else /* !LDAP_DEBUG */
2855 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0)
2856 #define StatslogTest( level ) (0)
2857 #endif /* !LDAP_DEBUG */
2860 * listener; need to access it from monitor backend
2862 struct slap_listener {
2863 struct berval sl_url;
2864 struct berval sl_name;
2869 #ifdef LDAP_CONNECTIONLESS
2870 int sl_is_udp; /* UDP listener is also data port */
2872 int sl_mute; /* Listener is temporarily disabled due to emfile */
2873 int sl_busy; /* Listener is busy (accept thread activated) */
2876 #define sl_addr sl_sa.sa_in_addr
2880 * Better know these all around slapd
2882 #define SLAP_LDAPDN_PRETTY 0x1
2883 #define SLAP_LDAPDN_MAXLEN 8192
2885 /* number of response controls supported */
2886 #define SLAP_MAX_RESPONSE_CONTROLS 6
2889 #define SLAP_CTRL_HIDE 0x00000000U
2891 #define SLAP_CTRL_HIDE 0x80000000U
2894 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for Relax */
2896 #define SLAP_CTRL_GLOBAL 0x00800000U
2897 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2899 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2900 #define SLAP_CTRL_ABANDON 0x00000001U
2901 #define SLAP_CTRL_ADD 0x00002002U
2902 #define SLAP_CTRL_BIND 0x00000004U
2903 #define SLAP_CTRL_COMPARE 0x00001008U
2904 #define SLAP_CTRL_DELETE 0x00002010U
2905 #define SLAP_CTRL_MODIFY 0x00002020U
2906 #define SLAP_CTRL_RENAME 0x00002040U
2907 #define SLAP_CTRL_SEARCH 0x00001080U
2908 #define SLAP_CTRL_UNBIND 0x00000100U
2910 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2911 #define SLAP_CTRL_UPDATE \
2912 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2913 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2915 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2918 LDAPControl *ctrl ));
2920 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
2922 #define SLAP_SLAB_SIZE (1024*1024)
2923 #define SLAP_SLAB_STACK 1
2924 #define SLAP_SLAB_SOBLOCK 64
2926 #define SLAP_ZONE_ALLOC 1
2927 #undef SLAP_ZONE_ALLOC
2929 #ifdef LDAP_COMP_MATCH
2931 * Extensible Filter Definition
2933 * MatchingRuleAssertion := SEQUENCE {
2934 * matchingRule [1] MatchingRuleId OPTIONAL,
2935 * type [2] AttributeDescription OPTIONAL,
2936 * matchValue [3] AssertionValue,
2937 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2939 * Following ComponentFilter is contained in matchValue
2941 * ComponentAssertion ::= SEQUENCE {
2942 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2943 * useDefaultValues BOOLEAN DEFAULT TRUE,
2944 * rule MATCHING-RULE.&id,
2945 * value MATCHING-RULE.&AssertionType }
2947 * ComponentFilter ::= CHOICE {
2948 * item [0] ComponentAssertion,
2949 * and [1] SEQUENCE OF ComponentFilter,
2950 * or [2] SEQUENCE OF ComponentFilter,
2951 * not [3] ComponentFilter }
2954 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2955 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2956 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2957 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2958 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2959 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2960 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2961 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2962 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2964 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2965 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2966 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2967 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2968 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2970 typedef struct ComponentId ComponentId;
2971 typedef struct ComponentReference ComponentReference;
2972 typedef struct ComponentAssertion ComponentAssertion;
2973 typedef struct ComponentAssertionValue ComponentAssertionValue;
2974 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo;
2975 typedef struct ComponentDesc ComponentDesc;
2977 struct ComponentData {
2978 void *cd_mem_op; /* nibble memory handler */
2979 ComponentSyntaxInfo** cd_tree; /* component tree */
2982 struct ComponentId {
2984 ComponentId *ci_next;
2986 union comp_id_value{
2987 BerValue ci_identifier;
2988 ber_int_t ci_from_beginning;
2990 ber_int_t ci_from_end;
2991 ber_int_t ci_content;
2992 BerValue ci_select_value;
2997 struct ComponentReference {
2998 ComponentId *cr_list;
2999 ComponentId *cr_curr;
3000 struct berval cr_string;
3002 /* Component Indexing */
3004 slap_mask_t cr_indexmask;
3005 AttributeDescription* cr_ad;
3007 ComponentReference* cr_next;
3010 struct ComponentAssertion {
3011 ComponentReference *ca_comp_ref;
3012 ber_int_t ca_use_def;
3013 MatchingRule *ca_ma_rule;
3014 struct berval ca_ma_value;
3015 ComponentData ca_comp_data; /* componentized assertion */
3016 ComponentFilter *ca_cf;
3017 MatchingRuleAssertion *ca_mra;
3020 struct ComponentFilter {
3021 ber_tag_t cf_choice;
3023 ber_int_t cf_un_result;
3024 ComponentAssertion *cf_un_ca;
3025 ComponentFilter *cf_un_complex;
3028 #define cf_ca cf_un.cf_un_ca
3029 #define cf_result cf_un.cf_un_result
3030 #define cf_and cf_un.cf_un_complex
3031 #define cf_or cf_un.cf_un_complex
3032 #define cf_not cf_un.cf_un_complex
3033 #define cf_any cf_un.cf_un_complex
3035 ComponentFilter *cf_next;
3038 struct ComponentAssertionValue {
3044 typedef int encoder_func LDAP_P((
3048 typedef int gser_decoder_func LDAP_P((
3051 ComponentSyntaxInfo** comp_syn_info,
3055 typedef int comp_free_func LDAP_P((
3058 typedef int ber_decoder_func LDAP_P((
3063 ComponentSyntaxInfo* comp_syn_info,
3067 typedef int ber_tag_decoder_func LDAP_P((
3070 ComponentSyntaxInfo* comp_syn_info,
3074 typedef void* extract_component_from_id_func LDAP_P((
3076 ComponentReference* cr,
3079 typedef void* convert_attr_to_comp_func LDAP_P ((
3082 struct berval* bv ));
3084 typedef void* alloc_nibble_func LDAP_P ((
3086 int increment_size ));
3088 typedef void free_nibble_func LDAP_P ((
3091 typedef void convert_assert_to_comp_func LDAP_P ((
3093 ComponentSyntaxInfo* csi_attr,
3095 ComponentSyntaxInfo** csi,
3099 typedef int convert_asn_to_ldap_func LDAP_P ((
3100 ComponentSyntaxInfo* csi,
3101 struct berval *bv ));
3103 typedef void free_component_func LDAP_P ((
3106 typedef int test_component_func LDAP_P ((
3108 void* assert_mem_op,
3109 ComponentSyntaxInfo* csi,
3110 ComponentAssertion* ca));
3112 typedef void* test_membership_func LDAP_P ((
3115 typedef void* get_component_info_func LDAP_P ((
3118 typedef int component_encoder_func LDAP_P ((
3120 ComponentSyntaxInfo* csi,
3121 struct berval* nvals ));
3123 typedef int allcomponent_matching_func LDAP_P((
3125 ComponentSyntaxInfo* comp1,
3126 ComponentSyntaxInfo* comp));
3128 struct ComponentDesc {
3129 /* Don't change the order of following four fields */
3131 AttributeType *cd_comp_type;
3132 struct berval cd_ad_type; /* ad_type, ad_cname */
3133 struct berval cd_ad_cname; /* ad_type, ad_cname */
3134 unsigned cd_flags; /* ad_flags */
3137 encoder_func *cd_ldap_encoder;
3138 encoder_func *cd_gser_encoder;
3139 encoder_func *cd_ber_encoder;
3140 gser_decoder_func *cd_gser_decoder;
3141 ber_decoder_func *cd_ber_decoder;
3142 comp_free_func *cd_free;
3143 extract_component_from_id_func* cd_extract_i;
3144 allcomponent_matching_func *cd_all_match;
3147 struct ComponentSyntaxInfo {
3149 ComponentDesc *csi_comp_desc;
3152 #endif /* LDAP_COMP_MATCH */
3154 /* slab heap data structures */
3156 struct slab_object {
3159 LDAP_LIST_ENTRY(slab_object) so_link;
3168 unsigned char **sh_map;
3169 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3170 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3173 #ifdef SLAP_ZONE_ALLOC
3174 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3175 #define SLAP_ZONE_SHIFT 19
3176 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3177 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3178 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3179 #define SLAP_ZONE_ZOBLOCK 256
3181 struct zone_object {
3186 LDAP_LIST_ENTRY(zone_object) zo_link;
3189 struct zone_latency_history {
3191 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3202 ldap_pvt_thread_rdwr_t *zh_znlock;
3203 Avlnode *zh_zonetree;
3204 unsigned char ***zh_maps;
3206 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3207 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3208 ldap_pvt_thread_mutex_t zh_mutex;
3209 ldap_pvt_thread_rdwr_t zh_lock;
3210 double zh_ema_latency;
3211 unsigned long zh_ema_samples;
3212 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3213 zh_latency_history_queue;
3214 int zh_latency_history_qlen;
3215 int zh_latency_jump;
3220 #define SLAP_BACKEND_INIT_MODULE(b) \
3221 static BackendInfo bi; \
3223 init_module( int argc, char *argv[] ) \
3226 bi.bi_init = b ## _back_initialize; \
3227 backend_add( &bi ); \
3231 typedef int (OV_init)(void);
3232 typedef struct slap_oinit_t {
3233 const char *ov_type;
3239 #include "proto-slap.h"
3241 #endif /* _SLAP_H_ */