1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2007 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"
61 #define SLAP_LIGHTWEIGHT_DISPATCHER /* experimental slapd architecture */
64 #define LDAP_COLLECTIVE_ATTRIBUTES
65 #define LDAP_COMP_MATCH
66 #define LDAP_SYNC_TIMESTAMP
67 #define SLAP_CONTROL_X_SORTEDRESULTS
68 #define SLAP_CONTROL_X_SESSION_TRACKING
71 #define LDAP_DYNAMIC_OBJECTS
72 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
76 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
80 * SLAPD Memory allocation macros
82 * Unlike ch_*() routines, these routines do not assert() upon
83 * allocation error. They are intended to be used instead of
84 * ch_*() routines where the caller has implemented proper
85 * checking for and handling of allocation errors.
87 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
89 #define SLAP_MALLOC(s) ber_memalloc((s))
90 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
91 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
92 #define SLAP_FREE(p) ber_memfree((p))
93 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
94 #define SLAP_STRDUP(s) ber_strdup((s))
95 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
98 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
101 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
102 #define SLAPD_ANONYMOUS ""
104 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
105 * This is a value used internally by the backends. It is needed to allow
106 * adding values that already exist without getting an error as required by
107 * modrdn when the new rdn was already an attribute value itself.
109 #define SLAP_MOD_SOFTADD 0x1000
111 #define MAXREMATCHES (100)
113 #define SLAP_MAX_WORKER_THREADS (16)
115 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
116 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
118 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
119 #define SLAP_CONN_MAX_PENDING_AUTH 1000
121 #define SLAP_TEXT_BUFLEN (256)
123 /* psuedo error code indicating abandoned operation */
124 #define SLAPD_ABANDON (-1024)
126 /* psuedo error code indicating disconnect */
127 #define SLAPD_DISCONNECT (-1025)
129 /* unknown config file directive */
130 #define SLAP_CONF_UNKNOWN (-1026)
132 /* We assume "C" locale, that is US-ASCII */
133 #define ASCII_SPACE(c) ( (c) == ' ' )
134 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
135 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
136 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
137 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
138 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
139 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
140 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
141 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
142 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
143 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
145 #define SLAP_NIBBLE(c) ((c)&0x0f)
146 #define SLAP_ESCAPE_CHAR ('\\')
147 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
148 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
150 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
151 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
153 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
154 /* NOTE: for consistency, this macro must only operate
155 * on normalized/pretty DN, such that ';' is never used
156 * as RDN separator, and all occurrences of ';' must be escaped */
157 #define DN_SEPARATOR(c) ((c) == ',')
158 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */
159 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
160 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
162 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
163 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
164 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
165 #define OID_SEPARATOR(c) ( (c) == '.' )
166 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
168 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
169 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
171 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
172 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
174 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
176 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
177 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
178 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
179 (c) == '?' || (c) == ' ' || (c) == '=' )
180 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
182 /* must match in schema_init.c */
183 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
184 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
185 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
186 #define SLAPD_GROUP_ATTR "member"
187 #define SLAPD_GROUP_CLASS "groupOfNames"
188 #define SLAPD_ROLE_ATTR "roleOccupant"
189 #define SLAPD_ROLE_CLASS "organizationalRole"
191 #define SLAPD_TOP_OID "2.5.6.0"
193 LDAP_SLAPD_V (int) slap_debug;
195 typedef unsigned long slap_mask_t;
197 /* Security Strength Factor */
198 typedef unsigned slap_ssf_t;
200 typedef struct slap_ssf_set {
202 slap_ssf_t sss_transport;
205 slap_ssf_t sss_update_ssf;
206 slap_ssf_t sss_update_transport;
207 slap_ssf_t sss_update_tls;
208 slap_ssf_t sss_update_sasl;
209 slap_ssf_t sss_simple_bind;
212 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
213 #define SLAP_GETDN_AUTHCID 2
214 #define SLAP_GETDN_AUTHZID 4
219 #define SLAP_INDEX_TYPE 0x00FFUL
220 #define SLAP_INDEX_UNDEFINED 0x0001UL
221 #define SLAP_INDEX_PRESENT 0x0002UL
222 #define SLAP_INDEX_EQUALITY 0x0004UL
223 #define SLAP_INDEX_APPROX 0x0008UL
224 #define SLAP_INDEX_SUBSTR 0x0010UL
225 #define SLAP_INDEX_EXTENDED 0x0020UL
227 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
229 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
231 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
233 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
234 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
235 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
236 #define SLAP_INDEX_SUBSTR_DEFAULT \
237 ( SLAP_INDEX_SUBSTR \
238 | SLAP_INDEX_SUBSTR_INITIAL \
239 | SLAP_INDEX_SUBSTR_ANY \
240 | SLAP_INDEX_SUBSTR_FINAL )
242 /* defaults for initial/final substring indices */
243 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
244 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
246 /* defaults for any substring indices */
247 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
248 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
250 #define SLAP_INDEX_FLAGS 0xF000UL
251 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
252 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
255 * there is a single index for each attribute. these prefixes ensure
256 * that there is no collision among keys.
258 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
259 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
260 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
261 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
262 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
263 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
265 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
266 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
267 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
268 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
269 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
272 * represents schema information for a database
275 SLAP_SCHERR_OUTOFMEM = 1,
276 SLAP_SCHERR_CLASS_NOT_FOUND,
277 SLAP_SCHERR_CLASS_BAD_USAGE,
278 SLAP_SCHERR_CLASS_BAD_SUP,
279 SLAP_SCHERR_CLASS_DUP,
280 SLAP_SCHERR_CLASS_INCONSISTENT,
281 SLAP_SCHERR_ATTR_NOT_FOUND,
282 SLAP_SCHERR_ATTR_BAD_MR,
283 SLAP_SCHERR_ATTR_BAD_USAGE,
284 SLAP_SCHERR_ATTR_BAD_SUP,
285 SLAP_SCHERR_ATTR_INCOMPLETE,
286 SLAP_SCHERR_ATTR_DUP,
287 SLAP_SCHERR_ATTR_INCONSISTENT,
288 SLAP_SCHERR_MR_NOT_FOUND,
289 SLAP_SCHERR_MR_INCOMPLETE,
291 SLAP_SCHERR_SYN_NOT_FOUND,
293 SLAP_SCHERR_SYN_SUP_NOT_FOUND,
295 SLAP_SCHERR_NOT_SUPPORTED,
296 SLAP_SCHERR_BAD_DESCR,
299 SLAP_SCHERR_CR_BAD_STRUCT,
300 SLAP_SCHERR_CR_BAD_AUX,
301 SLAP_SCHERR_CR_BAD_AT,
306 /* forward declarations */
307 typedef struct Syntax Syntax;
308 typedef struct MatchingRule MatchingRule;
309 typedef struct MatchingRuleUse MatchingRuleUse;
310 typedef struct MatchingRuleAssertion MatchingRuleAssertion;
311 typedef struct OidMacro OidMacro;
312 typedef struct ObjectClass ObjectClass;
313 typedef struct AttributeType AttributeType;
314 typedef struct AttributeDescription AttributeDescription;
315 typedef struct AttributeName AttributeName;
316 typedef struct ContentRule ContentRule;
318 typedef struct AttributeAssertion AttributeAssertion;
319 typedef struct SubstringsAssertion SubstringsAssertion;
320 typedef struct Filter Filter;
321 typedef struct ValuesReturnFilter ValuesReturnFilter;
322 typedef struct Attribute Attribute;
323 #ifdef LDAP_COMP_MATCH
324 typedef struct ComponentData ComponentData;
325 typedef struct ComponentFilter ComponentFilter;
328 typedef struct Entry Entry;
329 typedef struct Modification Modification;
330 typedef struct Modifications Modifications;
331 typedef struct LDAPModList LDAPModList;
333 typedef struct BackendInfo BackendInfo; /* per backend type */
334 typedef struct BackendDB BackendDB; /* per backend database */
336 typedef struct Connection Connection;
337 typedef struct Operation Operation;
338 typedef struct SlapReply SlapReply;
339 /* end of forward declarations */
341 typedef union Sockaddr {
342 struct sockaddr sa_addr;
343 struct sockaddr_in sa_in_addr;
345 struct sockaddr_storage sa_storage;
346 struct sockaddr_in6 sa_in6_addr;
349 struct sockaddr_un sa_un_addr;
354 extern int slap_inet4or6;
358 struct berval som_oid;
361 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
363 LDAP_STAILQ_ENTRY(OidMacro) som_next;
366 typedef int slap_syntax_validate_func LDAP_P((
368 struct berval * in));
370 typedef int slap_syntax_transform_func LDAP_P((
376 #ifdef LDAP_COMP_MATCH
377 typedef void* slap_component_transform_func LDAP_P((
378 struct berval * in ));
379 struct ComponentDesc;
384 #define ssyn_oid ssyn_syn.syn_oid
385 #define ssyn_desc ssyn_syn.syn_desc
386 #define ssyn_extensions ssyn_syn.syn_extensions
389 ber_len_t ssyn_oidlen;
390 * has been replaced by a struct berval that uses the value
391 * provided by ssyn_syn.syn_oid; a macro that expands to
392 * the bv_len field of the berval is provided for backward
393 * compatibility. CAUTION: NEVER FREE THE BERVAL
395 struct berval ssyn_bvoid;
396 #define ssyn_oidlen ssyn_bvoid.bv_len
398 unsigned int ssyn_flags;
400 #define SLAP_SYNTAX_NONE 0x0000U
401 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
402 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
403 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
405 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
407 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
412 slap_syntax_validate_func *ssyn_validate;
413 slap_syntax_transform_func *ssyn_pretty;
415 #ifdef SLAPD_BINARY_CONVERSION
416 /* convert to and from binary */
417 slap_syntax_transform_func *ssyn_ber2str;
418 slap_syntax_transform_func *ssyn_str2ber;
420 #ifdef LDAP_COMP_MATCH
421 slap_component_transform_func *ssyn_attr2comp;
422 struct ComponentDesc* ssync_comp_syntax;
425 LDAP_SLIST_ENTRY(Syntax) ssyn_next;
428 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
429 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
430 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
431 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
432 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
434 typedef struct slap_syntax_defs_rec {
438 slap_syntax_validate_func *sd_validate;
439 slap_syntax_transform_func *sd_pretty;
440 #ifdef SLAPD_BINARY_CONVERSION
441 slap_syntax_transform_func *sd_ber2str;
442 slap_syntax_transform_func *sd_str2ber;
444 } slap_syntax_defs_rec;
446 /* X -> Y Converter */
447 typedef int slap_mr_convert_func LDAP_P((
453 typedef int slap_mr_normalize_func LDAP_P((
455 Syntax *syntax, /* NULL if in is asserted value */
461 /* Match (compare) function */
462 typedef int slap_mr_match_func LDAP_P((
465 Syntax *syntax, /* syntax of stored value */
467 struct berval *value,
468 void *assertValue ));
470 /* Index generation function */
471 typedef int slap_mr_indexer_func LDAP_P((
474 Syntax *syntax, /* syntax of stored value */
476 struct berval *prefix,
481 /* Filter index function */
482 typedef int slap_mr_filter_func LDAP_P((
485 Syntax *syntax, /* syntax of stored value */
487 struct berval *prefix,
492 struct MatchingRule {
493 LDAPMatchingRule smr_mrule;
494 MatchingRuleUse *smr_mru;
495 /* RFC 4512 string representation */
496 struct berval smr_str;
499 * ber_len_t smr_oidlen;
500 * has been replaced by a struct berval that uses the value
501 * provided by smr_mrule.mr_oid; a macro that expands to
502 * the bv_len field of the berval is provided for backward
503 * compatibility. CAUTION: NEVER FREE THE BERVAL
505 struct berval smr_bvoid;
506 #define smr_oidlen smr_bvoid.bv_len
508 slap_mask_t smr_usage;
511 #define SLAP_MR_HIDE 0x0000U
513 #define SLAP_MR_HIDE 0x8000U
516 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
518 #define SLAP_MR_TYPE_MASK 0x0F00U
519 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
520 #define SLAP_MR_USAGE 0x000FU
522 #define SLAP_MR_NONE 0x0000U
523 #define SLAP_MR_EQUALITY 0x0100U
524 #define SLAP_MR_ORDERING 0x0200U
525 #define SLAP_MR_SUBSTR 0x0400U
526 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
527 #define SLAP_MR_ORDERED_INDEX 0x1000U
528 #ifdef LDAP_COMP_MATCH
529 #define SLAP_MR_COMPONENT 0x2000U
532 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
534 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
535 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
536 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
540 * The asserted value, depending on the particular usage,
541 * is expected to conform to either the assertion syntax
542 * or the attribute syntax. In some cases, the syntax of
543 * the value is known. If so, these flags indicate which
544 * syntax the value is expected to conform to. If not,
545 * neither of these flags is set (until the syntax of the
546 * provided value is determined). If the value is of the
547 * attribute syntax, the flag is changed once a value of
548 * the assertion syntax is derived from the provided value.
550 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
551 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
552 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
554 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
555 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
556 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
557 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
559 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
560 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
562 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
565 /* either or both the asserted value or attribute value
566 * may be provided in normalized form
568 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
569 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
571 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
572 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
573 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
574 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
576 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
577 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
578 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
579 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
580 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
581 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
583 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
584 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
585 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
586 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
589 slap_mr_convert_func *smr_convert;
590 slap_mr_normalize_func *smr_normalize;
591 slap_mr_match_func *smr_match;
592 slap_mr_indexer_func *smr_indexer;
593 slap_mr_filter_func *smr_filter;
596 * null terminated array of syntaxes compatible with this syntax
597 * note: when MS_EXT is set, this MUST NOT contain the assertion
598 * syntax of the rule. When MS_EXT is not set, it MAY.
600 Syntax **smr_compat_syntaxes;
603 * For equality rules, refers to an associated approximate rule.
604 * For non-equality rules, refers to an associated equality rule.
606 MatchingRule *smr_associated;
608 #define SLAP_MR_ASSOCIATED(mr,amr) \
609 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
611 LDAP_SLIST_ENTRY(MatchingRule) smr_next;
613 #define smr_oid smr_mrule.mr_oid
614 #define smr_names smr_mrule.mr_names
615 #define smr_desc smr_mrule.mr_desc
616 #define smr_obsolete smr_mrule.mr_obsolete
617 #define smr_syntax_oid smr_mrule.mr_syntax_oid
618 #define smr_extensions smr_mrule.mr_extensions
621 struct MatchingRuleUse {
622 LDAPMatchingRuleUse smru_mruleuse;
623 MatchingRule *smru_mr;
624 /* RFC 4512 string representation */
625 struct berval smru_str;
627 LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next;
629 #define smru_oid smru_mruleuse.mru_oid
630 #define smru_names smru_mruleuse.mru_names
631 #define smru_desc smru_mruleuse.mru_desc
632 #define smru_obsolete smru_mruleuse.mru_obsolete
633 #define smru_applies_oids smru_mruleuse.mru_applies_oids
635 #define smru_usage smru_mr->smr_usage
636 } /* MatchingRuleUse */ ;
638 typedef struct slap_mrule_defs_rec {
640 slap_mask_t mrd_usage;
641 char ** mrd_compat_syntaxes;
642 slap_mr_convert_func * mrd_convert;
643 slap_mr_normalize_func * mrd_normalize;
644 slap_mr_match_func * mrd_match;
645 slap_mr_indexer_func * mrd_indexer;
646 slap_mr_filter_func * mrd_filter;
648 /* For equality rule, this may refer to an associated approximate rule */
649 /* For non-equality rule, this may refer to an associated equality rule */
650 char * mrd_associated;
651 } slap_mrule_defs_rec;
653 typedef int (AttributeTypeSchemaCheckFN)(
658 char *textbuf, size_t textlen );
660 struct AttributeType {
661 LDAPAttributeType sat_atype;
662 struct berval sat_cname;
663 AttributeType *sat_sup;
664 AttributeType **sat_subtypes;
665 MatchingRule *sat_equality;
666 MatchingRule *sat_approx;
667 MatchingRule *sat_ordering;
668 MatchingRule *sat_substr;
671 AttributeTypeSchemaCheckFN *sat_check;
674 #define SLAP_AT_NONE 0x0000U
675 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
676 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
678 #define SLAP_AT_HIDE 0x0000U /* publish everything */
680 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
682 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
684 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
686 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
687 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
688 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
690 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
691 #define SLAP_AT_DELETED 0x20000U
693 slap_mask_t sat_flags;
695 LDAP_STAILQ_ENTRY(AttributeType) sat_next;
697 #define sat_oid sat_atype.at_oid
698 #define sat_names sat_atype.at_names
699 #define sat_desc sat_atype.at_desc
700 #define sat_obsolete sat_atype.at_obsolete
701 #define sat_sup_oid sat_atype.at_sup_oid
702 #define sat_equality_oid sat_atype.at_equality_oid
703 #define sat_ordering_oid sat_atype.at_ordering_oid
704 #define sat_substr_oid sat_atype.at_substr_oid
705 #define sat_syntax_oid sat_atype.at_syntax_oid
706 #define sat_single_value sat_atype.at_single_value
707 #define sat_collective sat_atype.at_collective
708 #define sat_no_user_mod sat_atype.at_no_user_mod
709 #define sat_usage sat_atype.at_usage
710 #define sat_extensions sat_atype.at_extensions
712 AttributeDescription *sat_ad;
713 ldap_pvt_thread_mutex_t sat_ad_mutex;
716 #define is_at_operational(at) ((at)->sat_usage)
717 #define is_at_single_value(at) ((at)->sat_single_value)
718 #define is_at_collective(at) ((at)->sat_collective)
719 #define is_at_obsolete(at) ((at)->sat_obsolete)
720 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
722 typedef int (ObjectClassSchemaCheckFN)(
727 char *textbuf, size_t textlen );
730 LDAPObjectClass soc_oclass;
731 struct berval soc_cname;
732 ObjectClass **soc_sups;
733 AttributeType **soc_required;
734 AttributeType **soc_allowed;
735 ObjectClassSchemaCheckFN *soc_check;
737 slap_mask_t soc_flags;
738 #define soc_oid soc_oclass.oc_oid
739 #define soc_names soc_oclass.oc_names
740 #define soc_desc soc_oclass.oc_desc
741 #define soc_obsolete soc_oclass.oc_obsolete
742 #define soc_sup_oids soc_oclass.oc_sup_oids
743 #define soc_kind soc_oclass.oc_kind
744 #define soc_at_oids_must soc_oclass.oc_at_oids_must
745 #define soc_at_oids_may soc_oclass.oc_at_oids_may
746 #define soc_extensions soc_oclass.oc_extensions
748 LDAP_STAILQ_ENTRY(ObjectClass) soc_next;
751 #define SLAP_OCF_SET_FLAGS 0x1
752 #define SLAP_OCF_CHECK_SUP 0x2
753 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
755 #define SLAP_OC_ALIAS 0x0001
756 #define SLAP_OC_REFERRAL 0x0002
757 #define SLAP_OC_SUBENTRY 0x0004
758 #define SLAP_OC_DYNAMICOBJECT 0x0008
759 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
760 #define SLAP_OC_GLUE 0x0020
761 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
762 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
763 #define SLAP_OC__MASK 0x00FF
764 #define SLAP_OC__END 0x0100
765 #define SLAP_OC_OPERATIONAL 0x4000
767 #define SLAP_OC_HIDE 0x0000
769 #define SLAP_OC_HIDE 0x8000
771 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
772 #define SLAP_OC_DELETED 0x20000U
778 LDAPContentRule scr_crule;
779 ObjectClass *scr_sclass;
780 ObjectClass **scr_auxiliaries; /* optional */
781 AttributeType **scr_required; /* optional */
782 AttributeType **scr_allowed; /* optional */
783 AttributeType **scr_precluded; /* optional */
784 #define scr_oid scr_crule.cr_oid
785 #define scr_names scr_crule.cr_names
786 #define scr_desc scr_crule.cr_desc
787 #define scr_obsolete scr_crule.cr_obsolete
788 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
789 #define scr_at_oids_must scr_crule.cr_at_oids_must
790 #define scr_at_oids_may scr_crule.cr_at_oids_may
791 #define scr_at_oids_not scr_crule.cr_at_oids_not
794 #define SLAP_CR_HARDCODE 0x10000U
797 LDAP_STAILQ_ENTRY( ContentRule ) scr_next;
800 /* Represents a recognized attribute description ( type + options ). */
801 struct AttributeDescription {
802 AttributeDescription *ad_next;
803 AttributeType *ad_type; /* attribute type, must be specified */
804 struct berval ad_cname; /* canonical name, must be specified */
805 struct berval ad_tags; /* empty if no tagging options */
807 #define SLAP_DESC_NONE 0x00U
808 #define SLAP_DESC_BINARY 0x01U
809 #define SLAP_DESC_TAG_RANGE 0x80U
810 #define SLAP_DESC_TEMPORARY 0x1000U
813 /* flags to slap_*2undef_ad to register undefined (0, the default)
814 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
815 * SLAP_AD_NOINSERT is to lookup without insert */
816 #define SLAP_AD_UNDEF 0x00U
817 #define SLAP_AD_PROXIED 0x01U
818 #define SLAP_AD_NOINSERT 0x02U
820 struct AttributeName {
821 struct berval an_name;
822 AttributeDescription *an_desc;
827 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
828 #define slap_ad_is_tag_range(ad) \
829 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
830 #define slap_ad_is_binary(ad) \
831 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
834 * pointers to schema elements used internally
836 struct slap_internal_schema {
838 ObjectClass *si_oc_top;
839 ObjectClass *si_oc_extensibleObject;
840 ObjectClass *si_oc_alias;
841 ObjectClass *si_oc_referral;
842 ObjectClass *si_oc_rootdse;
843 ObjectClass *si_oc_subentry;
844 ObjectClass *si_oc_subschema;
845 ObjectClass *si_oc_collectiveAttributeSubentry;
846 ObjectClass *si_oc_dynamicObject;
848 ObjectClass *si_oc_glue;
849 ObjectClass *si_oc_syncConsumerSubentry;
850 ObjectClass *si_oc_syncProviderSubentry;
852 /* objectClass attribute descriptions */
853 AttributeDescription *si_ad_objectClass;
855 /* operational attribute descriptions */
856 AttributeDescription *si_ad_structuralObjectClass;
857 AttributeDescription *si_ad_creatorsName;
858 AttributeDescription *si_ad_createTimestamp;
859 AttributeDescription *si_ad_modifiersName;
860 AttributeDescription *si_ad_modifyTimestamp;
861 AttributeDescription *si_ad_hasSubordinates;
862 AttributeDescription *si_ad_subschemaSubentry;
863 AttributeDescription *si_ad_collectiveSubentries;
864 AttributeDescription *si_ad_collectiveExclusions;
865 AttributeDescription *si_ad_entryDN;
866 AttributeDescription *si_ad_entryUUID;
867 AttributeDescription *si_ad_entryCSN;
868 AttributeDescription *si_ad_namingCSN;
870 AttributeDescription *si_ad_dseType;
871 AttributeDescription *si_ad_syncreplCookie;
872 AttributeDescription *si_ad_syncTimestamp;
873 AttributeDescription *si_ad_contextCSN;
875 /* root DSE attribute descriptions */
876 AttributeDescription *si_ad_altServer;
877 AttributeDescription *si_ad_namingContexts;
878 AttributeDescription *si_ad_supportedControl;
879 AttributeDescription *si_ad_supportedExtension;
880 AttributeDescription *si_ad_supportedLDAPVersion;
881 AttributeDescription *si_ad_supportedSASLMechanisms;
882 AttributeDescription *si_ad_supportedFeatures;
883 AttributeDescription *si_ad_monitorContext;
884 AttributeDescription *si_ad_vendorName;
885 AttributeDescription *si_ad_vendorVersion;
886 AttributeDescription *si_ad_configContext;
888 /* subentry attribute descriptions */
889 AttributeDescription *si_ad_administrativeRole;
890 AttributeDescription *si_ad_subtreeSpecification;
892 /* subschema subentry attribute descriptions */
893 AttributeDescription *si_ad_attributeTypes;
894 AttributeDescription *si_ad_ditContentRules;
895 AttributeDescription *si_ad_ditStructureRules;
896 AttributeDescription *si_ad_ldapSyntaxes;
897 AttributeDescription *si_ad_matchingRules;
898 AttributeDescription *si_ad_matchingRuleUse;
899 AttributeDescription *si_ad_nameForms;
900 AttributeDescription *si_ad_objectClasses;
902 /* Aliases & Referrals */
903 AttributeDescription *si_ad_aliasedObjectName;
904 AttributeDescription *si_ad_ref;
906 /* Access Control Internals */
907 AttributeDescription *si_ad_entry;
908 AttributeDescription *si_ad_children;
909 AttributeDescription *si_ad_saslAuthzTo;
910 AttributeDescription *si_ad_saslAuthzFrom;
912 /* dynamic entries */
913 AttributeDescription *si_ad_entryTtl;
914 AttributeDescription *si_ad_dynamicSubtrees;
916 /* Other attributes descriptions */
917 AttributeDescription *si_ad_distinguishedName;
918 AttributeDescription *si_ad_name;
919 AttributeDescription *si_ad_cn;
920 AttributeDescription *si_ad_uid;
921 AttributeDescription *si_ad_uidNumber;
922 AttributeDescription *si_ad_gidNumber;
923 AttributeDescription *si_ad_userPassword;
924 AttributeDescription *si_ad_labeledURI;
925 #ifdef SLAPD_AUTHPASSWD
926 AttributeDescription *si_ad_authPassword;
927 AttributeDescription *si_ad_authPasswordSchemes;
929 AttributeDescription *si_ad_description;
930 AttributeDescription *si_ad_seeAlso;
932 /* Undefined Attribute Type */
933 AttributeType *si_at_undefined;
935 /* "Proxied" Attribute Type */
936 AttributeType *si_at_proxied;
939 MatchingRule *si_mr_distinguishedNameMatch;
940 MatchingRule *si_mr_dnSubtreeMatch;
941 MatchingRule *si_mr_dnOneLevelMatch;
942 MatchingRule *si_mr_dnSubordinateMatch;
943 MatchingRule *si_mr_dnSuperiorMatch;
944 MatchingRule *si_mr_caseExactMatch;
945 MatchingRule *si_mr_caseExactSubstringsMatch;
946 MatchingRule *si_mr_caseExactIA5Match;
947 MatchingRule *si_mr_integerMatch;
948 MatchingRule *si_mr_integerFirstComponentMatch;
949 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
952 Syntax *si_syn_directoryString;
953 Syntax *si_syn_distinguishedName;
954 Syntax *si_syn_integer;
955 Syntax *si_syn_octetString;
957 /* Schema Syntaxes */
958 Syntax *si_syn_attributeTypeDesc;
959 Syntax *si_syn_ditContentRuleDesc;
960 Syntax *si_syn_ditStructureRuleDesc;
961 Syntax *si_syn_ldapSyntaxDesc;
962 Syntax *si_syn_matchingRuleDesc;
963 Syntax *si_syn_matchingRuleUseDesc;
964 Syntax *si_syn_nameFormDesc;
965 Syntax *si_syn_objectClassDesc;
968 struct AttributeAssertion {
969 AttributeDescription *aa_desc;
970 struct berval aa_value;
971 #ifdef LDAP_COMP_MATCH
972 ComponentFilter *aa_cf; /* for attribute aliasing */
976 struct SubstringsAssertion {
977 AttributeDescription *sa_desc;
978 struct berval sa_initial;
979 struct berval *sa_any;
980 struct berval sa_final;
983 struct MatchingRuleAssertion {
984 MatchingRule *ma_rule; /* optional */
985 struct berval ma_rule_text; /* optional */
986 AttributeDescription *ma_desc; /* optional */
987 int ma_dnattrs; /* boolean */
988 struct berval ma_value; /* required */
989 #ifdef LDAP_COMP_MATCH
990 ComponentFilter *ma_cf; /* component filter */
995 * represents a search filter
998 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
999 #define SLAPD_FILTER_COMPUTED 0
1000 #define SLAPD_FILTER_MASK 0x7fff
1001 #define SLAPD_FILTER_UNDEFINED 0x8000
1004 /* precomputed result */
1005 ber_int_t f_un_result;
1008 AttributeDescription *f_un_desc;
1010 /* simple value assertion */
1011 AttributeAssertion *f_un_ava;
1013 /* substring assertion */
1014 SubstringsAssertion *f_un_ssa;
1016 /* matching rule assertion */
1017 MatchingRuleAssertion *f_un_mra;
1019 #define f_desc f_un.f_un_desc
1020 #define f_ava f_un.f_un_ava
1021 #define f_av_desc f_un.f_un_ava->aa_desc
1022 #define f_av_value f_un.f_un_ava->aa_value
1023 #define f_sub f_un.f_un_ssa
1024 #define f_sub_desc f_un.f_un_ssa->sa_desc
1025 #define f_sub_initial f_un.f_un_ssa->sa_initial
1026 #define f_sub_any f_un.f_un_ssa->sa_any
1027 #define f_sub_final f_un.f_un_ssa->sa_final
1028 #define f_mra f_un.f_un_mra
1029 #define f_mr_rule f_un.f_un_mra->ma_rule
1030 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1031 #define f_mr_desc f_un.f_un_mra->ma_desc
1032 #define f_mr_value f_un.f_un_mra->ma_value
1033 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1036 Filter *f_un_complex;
1039 #define f_result f_un.f_un_result
1040 #define f_and f_un.f_un_complex
1041 #define f_or f_un.f_un_complex
1042 #define f_not f_un.f_un_complex
1043 #define f_list f_un.f_un_complex
1048 /* compare routines can return undefined */
1049 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1051 struct ValuesReturnFilter {
1052 ber_tag_t vrf_choice;
1055 /* precomputed result */
1056 ber_int_t vrf_un_result;
1062 AttributeDescription *vrf_un_desc;
1064 /* simple value assertion */
1065 AttributeAssertion *vrf_un_ava;
1067 /* substring assertion */
1068 SubstringsAssertion *vrf_un_ssa;
1070 /* matching rule assertion */
1071 MatchingRuleAssertion *vrf_un_mra;
1073 #define vrf_result vrf_un.vrf_un_result
1074 #define vrf_dn vrf_un.vrf_un_dn
1075 #define vrf_desc vrf_un.vrf_un_desc
1076 #define vrf_ava vrf_un.vrf_un_ava
1077 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1078 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1079 #define vrf_ssa vrf_un.vrf_un_ssa
1080 #define vrf_sub vrf_un.vrf_un_ssa
1081 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1082 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1083 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1084 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1085 #define vrf_mra vrf_un.vrf_un_mra
1086 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1087 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1088 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1089 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1090 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1095 ValuesReturnFilter *vrf_next;
1099 * represents an attribute (description + values)
1102 AttributeDescription *a_desc;
1103 BerVarray a_vals; /* preserved values */
1104 BerVarray a_nvals; /* normalized values */
1105 #ifdef LDAP_COMP_MATCH
1106 ComponentData *a_comp_data; /* component values */
1110 #define SLAP_ATTR_IXADD 0x1U
1111 #define SLAP_ATTR_IXDEL 0x2U
1112 #define SLAP_ATTR_DONT_FREE_DATA 0x4U
1113 #define SLAP_ATTR_DONT_FREE_VALS 0x8U
1118 * the id used in the indexes to refer to an entry
1120 typedef unsigned long ID;
1121 #define NOID ((ID)~0)
1123 typedef struct EntryHeader {
1131 * represents an entry in core
1135 * The ID field should only be changed before entry is
1136 * inserted into a cache. The ID value is backend
1141 struct berval e_name; /* name (DN) of this entry */
1142 struct berval e_nname; /* normalized name (DN) of this entry */
1144 /* for migration purposes */
1145 #define e_dn e_name.bv_val
1146 #define e_ndn e_nname.bv_val
1148 Attribute *e_attrs; /* list of attributes + values */
1150 slap_mask_t e_ocflags;
1152 struct berval e_bv; /* For entry_encode/entry_decode */
1154 /* for use by the backend for any purpose */
1159 * A list of LDAPMods
1161 struct Modification {
1164 /* Set for internal mods, will bypass ACL checks. Only needed when
1165 * running as non-root user, for user modifiable attributes.
1167 #define SLAP_MOD_INTERNAL 0x01
1168 #define SLAP_MOD_MANAGING 0x02
1170 AttributeDescription *sm_desc;
1171 struct berval sm_type;
1172 BerVarray sm_values;
1173 BerVarray sm_nvalues;
1176 struct Modifications {
1177 Modification sml_mod;
1178 #define sml_op sml_mod.sm_op
1179 #define sml_flags sml_mod.sm_flags
1180 #define sml_desc sml_mod.sm_desc
1181 #define sml_type sml_mod.sm_type
1182 #define sml_values sml_mod.sm_values
1183 #define sml_nvalues sml_mod.sm_nvalues
1184 Modifications *sml_next;
1187 struct LDAPModList {
1189 LDAPModList *ml_next;
1190 #define ml_op ml_mod.mod_op
1191 #define ml_type ml_mod.mod_type
1192 #define ml_values ml_mod.mod_values
1196 * represents an access control list
1198 typedef enum slap_access_t {
1199 ACL_INVALID_ACCESS = -1,
1209 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1212 /* ACL level mask and modifiers */
1213 ACL_LEVEL_MASK = 0x000f,
1214 ACL_QUALIFIER1 = 0x0100,
1215 ACL_QUALIFIER2 = 0x0200,
1216 ACL_QUALIFIER3 = 0x0400,
1217 ACL_QUALIFIER4 = 0x0800,
1218 ACL_QUALIFIER_MASK = 0x0f00,
1220 /* write granularity */
1221 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1222 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1224 ACL_WRITE = ACL_WADD|ACL_WDEL
1227 typedef enum slap_control_e {
1228 ACL_INVALID_CONTROL = 0,
1234 typedef enum slap_style_e {
1235 ACL_STYLE_REGEX = 0,
1243 ACL_STYLE_ANONYMOUS,
1251 typedef struct AuthorizationInformation {
1252 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1253 struct berval sai_mech; /* SASL Mechanism */
1254 struct berval sai_dn; /* DN for reporting purposes */
1255 struct berval sai_ndn; /* Normalized DN */
1257 /* Security Strength Factors */
1258 slap_ssf_t sai_ssf; /* Overall SSF */
1259 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1260 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1261 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1262 } AuthorizationInformation;
1267 * "dynamic" ACL infrastructure (for ACIs and more)
1269 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1270 const char *opts, slap_style_t, const char *, void **privp ));
1271 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1272 typedef int (slap_dynacl_mask) LDAP_P((
1276 AttributeDescription *desc,
1279 regmatch_t *matches,
1280 slap_access_t *grant,
1281 slap_access_t *deny ));
1282 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1284 typedef struct slap_dynacl_t {
1286 slap_dynacl_parse *da_parse;
1287 slap_dynacl_unparse *da_unparse;
1288 slap_dynacl_mask *da_mask;
1289 slap_dynacl_destroy *da_destroy;
1292 struct slap_dynacl_t *da_next;
1294 #endif /* SLAP_DYNACL */
1296 /* the DN portion of the "by" part */
1297 typedef struct slap_dn_access {
1299 AuthorizationInformation a_dnauthz;
1300 #define a_pat a_dnauthz.sai_dn
1302 slap_style_t a_style;
1305 AttributeDescription *a_at;
1311 typedef struct Access {
1312 slap_control_t a_type;
1314 /* strip qualifiers */
1315 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1316 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1318 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1320 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1321 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1322 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1323 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1324 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1325 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1326 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1327 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1328 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1329 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1331 /* NOTE: always use the highest level; current: 0x00ffUL */
1332 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1335 #define ACL_PRIV_LEVEL 0x1000UL
1336 #define ACL_PRIV_ADDITIVE 0x2000UL
1337 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1340 #define ACL_PRIV_INVALID 0x0UL
1342 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1343 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1344 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1345 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1347 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1348 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1350 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1352 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1354 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1355 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1356 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1358 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1359 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1360 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1361 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1362 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1363 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1364 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1365 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1366 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1367 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1369 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1370 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1371 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1372 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1373 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1374 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1375 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1376 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1377 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1378 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1379 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1381 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1382 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1383 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1384 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1385 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1386 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1387 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1388 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1389 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1390 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1392 slap_mask_t a_access_mask;
1395 slap_dn_access a_dn;
1396 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1397 #define a_dn_at a_dn.a_at
1398 #define a_dn_self a_dn.a_self
1400 /* real DN pattern */
1401 slap_dn_access a_realdn;
1402 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1403 #define a_realdn_at a_realdn.a_at
1404 #define a_realdn_self a_realdn.a_self
1406 /* used for ssf stuff
1407 * NOTE: the ssf stuff in a_realdn is ignored */
1408 #define a_authz a_dn.a_dnauthz
1410 /* connection related stuff */
1411 slap_style_t a_peername_style;
1412 struct berval a_peername_pat;
1413 #ifdef LDAP_PF_INET6
1415 struct in6_addr ax6;
1419 #define a_peername_addr6 ax_peername_addr.ax6
1420 #define a_peername_addr ax_peername_addr.ax
1421 #define a_peername_mask6 ax_peername_mask.ax6
1422 #define a_peername_mask ax_peername_mask.ax
1423 /* apparently, only s6_addr is portable;
1424 * define a portable address mask comparison */
1425 #define slap_addr6_mask(val, msk, asr) ( \
1426 (((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \
1427 && (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \
1428 && (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \
1429 && (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \
1430 && (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \
1431 && (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \
1432 && (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \
1433 && (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \
1434 && (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \
1435 && (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \
1436 && (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \
1437 && (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \
1438 && (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \
1439 && (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \
1440 && (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \
1441 && (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \
1443 #else /* ! LDAP_PF_INET6 */
1444 unsigned long a_peername_addr,
1446 #endif /* ! LDAP_PF_INET6 */
1447 int a_peername_port;
1449 slap_style_t a_sockname_style;
1450 struct berval a_sockname_pat;
1452 slap_style_t a_domain_style;
1453 struct berval a_domain_pat;
1454 int a_domain_expand;
1456 slap_style_t a_sockurl_style;
1457 struct berval a_sockurl_pat;
1458 slap_style_t a_set_style;
1459 struct berval a_set_pat;
1462 slap_dynacl_t *a_dynacl;
1463 #endif /* SLAP_DYNACL */
1466 slap_style_t a_group_style;
1467 struct berval a_group_pat;
1468 ObjectClass *a_group_oc;
1469 AttributeDescription *a_group_at;
1471 struct Access *a_next;
1475 typedef struct AccessControl {
1476 /* "to" part: the entries this acl applies to */
1478 slap_style_t acl_dn_style;
1480 struct berval acl_dn_pat;
1481 AttributeName *acl_attrs;
1482 MatchingRule *acl_attrval_mr;
1483 slap_style_t acl_attrval_style;
1484 regex_t acl_attrval_re;
1485 struct berval acl_attrval;
1487 /* "by" part: list of who has what access to the entries */
1490 struct AccessControl *acl_next;
1494 ACL_STATE_NOT_RECORDED = 0x0,
1495 ACL_STATE_RECORDED_VD = 0x1,
1496 ACL_STATE_RECORDED_NV = 0x2,
1497 ACL_STATE_RECORDED = ( ACL_STATE_RECORDED_VD | ACL_STATE_RECORDED_NV )
1500 typedef struct AccessControlState {
1502 AccessControl *as_vi_acl;
1503 AccessControl *as_vd_acl;
1504 AttributeDescription *as_vd_ad;
1507 slap_acl_state_t as_recorded;
1508 int as_vd_acl_count;
1510 } AccessControlState;
1511 #define ACL_STATE_INIT { NULL, NULL, NULL, \
1512 ACL_STATE_NOT_RECORDED, 0, 0 }
1516 * represents a backend
1519 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head;
1520 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head;
1522 LDAP_SLAPD_V (int) nBackendInfo;
1523 LDAP_SLAPD_V (int) nBackendDB;
1524 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1525 LDAP_SLAPD_V (slap_be_head) backendDB;
1526 LDAP_SLAPD_V (BackendDB *) frontendDB;
1528 LDAP_SLAPD_V (int) slapMode;
1529 #define SLAP_UNDEFINED_MODE 0x0000
1530 #define SLAP_SERVER_MODE 0x0001
1531 #define SLAP_TOOL_MODE 0x0002
1532 #define SLAP_MODE 0x0003
1534 #define SLAP_TRUNCATE_MODE 0x0100
1535 #define SLAP_TOOL_READMAIN 0x0200
1536 #define SLAP_TOOL_READONLY 0x0400
1537 #define SLAP_TOOL_QUICK 0x0800
1538 #define SLAP_TOOL_NO_SCHEMA_CHECK 0x1000
1540 #define SB_TLS_DEFAULT (-1)
1541 #define SB_TLS_OFF 0
1543 #define SB_TLS_CRITICAL 2
1545 typedef struct slap_bindconf {
1546 struct berval sb_uri;
1552 struct berval sb_binddn;
1553 struct berval sb_cred;
1554 struct berval sb_saslmech;
1556 struct berval sb_realm;
1557 struct berval sb_authcId;
1558 struct berval sb_authzId;
1563 char *sb_tls_cacert;
1564 char *sb_tls_cacertdir;
1565 char *sb_tls_reqcert;
1566 char *sb_tls_cipher_suite;
1567 #ifdef HAVE_OPENSSL_CRL
1568 char *sb_tls_crlcheck;
1574 typedef struct slap_verbmasks {
1576 const slap_mask_t mask;
1579 typedef struct slap_cf_aux_table {
1585 } slap_cf_aux_table;
1587 #define SLAP_LIMIT_TIME 1
1588 #define SLAP_LIMIT_SIZE 2
1590 struct slap_limits_set {
1598 int lms_s_unchecked;
1604 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1605 #define SLAP_NO_LIMIT -1
1606 #define SLAP_MAX_LIMIT 2147483647
1608 struct slap_limits {
1609 unsigned lm_flags; /* type of pattern */
1610 #define SLAP_LIMITS_UNDEFINED 0x0000U
1611 #define SLAP_LIMITS_EXACT 0x0001U
1612 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1613 #define SLAP_LIMITS_ONE 0x0002U
1614 #define SLAP_LIMITS_SUBTREE 0x0003U
1615 #define SLAP_LIMITS_CHILDREN 0x0004U
1616 #define SLAP_LIMITS_REGEX 0x0005U
1617 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1618 #define SLAP_LIMITS_USERS 0x0007U
1619 #define SLAP_LIMITS_ANY 0x0008U
1620 #define SLAP_LIMITS_MASK 0x000FU
1622 #define SLAP_LIMITS_TYPE_DN 0x0000U
1623 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1624 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1626 regex_t lm_regex; /* regex data for REGEX */
1629 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1630 * pattern for REGEX; NULL for ANONYMOUS, USERS
1632 struct berval lm_pat;
1634 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1635 * lm_group_oc is objectClass and lm_group_at is attributeType
1636 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1637 * can only be SLAP_LIMITS_EXACT */
1638 ObjectClass *lm_group_oc;
1639 AttributeDescription *lm_group_ad;
1641 struct slap_limits_set lm_limits;
1644 /* temporary aliases */
1645 typedef BackendDB Backend;
1646 #define nbackends nBackendDB
1647 #define backends backendDB
1650 * syncinfo structure for syncrepl
1655 #define SLAP_SYNC_RID_SIZE 3
1656 #define SLAP_SYNC_SID_MAX 4095 /* based on liblutil/csn.c field width */
1657 #define SLAP_SYNCUUID_SET_SIZE 256
1659 #define SLAP_SYNC_UPDATE_MSGID 1
1661 struct sync_cookie {
1662 struct berval *ctxcsn;
1663 struct berval octet_str;
1668 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1671 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1673 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1675 #ifndef SLAP_MAX_CIDS
1676 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1679 struct ConfigOCs; /* config.h */
1682 BackendInfo *bd_info; /* pointer to shared backend info */
1684 /* fields in this structure (and routines acting on this structure)
1685 should be renamed from be_ to bd_ */
1687 /* BackendInfo accessors */
1688 #define be_config bd_info->bi_db_config
1689 #define be_type bd_info->bi_type
1691 #define be_bind bd_info->bi_op_bind
1692 #define be_unbind bd_info->bi_op_unbind
1693 #define be_add bd_info->bi_op_add
1694 #define be_compare bd_info->bi_op_compare
1695 #define be_delete bd_info->bi_op_delete
1696 #define be_modify bd_info->bi_op_modify
1697 #define be_modrdn bd_info->bi_op_modrdn
1698 #define be_search bd_info->bi_op_search
1699 #define be_abandon bd_info->bi_op_abandon
1701 #define be_extended bd_info->bi_extended
1702 #define be_cancel bd_info->bi_op_cancel
1704 #define be_chk_referrals bd_info->bi_chk_referrals
1705 #define be_chk_controls bd_info->bi_chk_controls
1706 #define be_fetch bd_info->bi_entry_get_rw
1707 #define be_release bd_info->bi_entry_release_rw
1708 #define be_group bd_info->bi_acl_group
1709 #define be_attribute bd_info->bi_acl_attribute
1710 #define be_operational bd_info->bi_operational
1713 * define to honor hasSubordinates operational attribute in search filters
1714 * (in previous use there was a flaw with back-bdb; now it is fixed).
1716 #define be_has_subordinates bd_info->bi_has_subordinates
1718 #define be_connection_init bd_info->bi_connection_init
1719 #define be_connection_destroy bd_info->bi_connection_destroy
1722 #define be_entry_open bd_info->bi_tool_entry_open
1723 #define be_entry_close bd_info->bi_tool_entry_close
1724 #define be_entry_first bd_info->bi_tool_entry_first
1725 #define be_entry_next bd_info->bi_tool_entry_next
1726 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1727 #define be_entry_get bd_info->bi_tool_entry_get
1728 #define be_entry_put bd_info->bi_tool_entry_put
1729 #define be_sync bd_info->bi_tool_sync
1730 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1731 #define be_entry_modify bd_info->bi_tool_entry_modify
1734 /* supported controls */
1735 /* note: set to 0 if the database does not support the control;
1736 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1737 char be_ctrls[SLAP_MAX_CIDS + 1];
1739 /* Database flags */
1740 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1741 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1742 #define SLAP_DBFLAG_HIDDEN 0x0004U
1743 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1744 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1745 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1746 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1747 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1748 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1749 #define SLAP_DBFLAG_DYNAMIC 0x0400U /* this db allows dynamicObjects */
1750 #define SLAP_DBFLAG_MONITORING 0x0800U /* custom monitoring enabled */
1751 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1752 #define SLAP_DBFLAG_SINGLE_SHADOW 0x4000U /* a single-master shadow */
1753 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1754 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1755 slap_mask_t be_flags;
1756 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1757 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1758 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1759 #define SLAP_DBHIDDEN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN)
1760 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1761 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1762 #define SLAP_DBMONITORING(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING)
1763 #define SLAP_NO_SCHEMA_CHECK(be) \
1764 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1765 #define SLAP_GLUE_INSTANCE(be) \
1766 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1767 #define SLAP_GLUE_SUBORDINATE(be) \
1768 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1769 #define SLAP_GLUE_LINKED(be) \
1770 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1771 #define SLAP_GLUE_ADVERTISE(be) \
1772 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1773 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1774 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1775 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1776 #define SLAP_SINGLE_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW)
1777 #define SLAP_MULTIMASTER(be) (!SLAP_SINGLE_SHADOW(be))
1779 slap_mask_t be_restrictops; /* restriction operations */
1780 #define SLAP_RESTRICT_OP_ADD 0x0001U
1781 #define SLAP_RESTRICT_OP_BIND 0x0002U
1782 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1783 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1784 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1785 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1786 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1787 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1788 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1790 #define SLAP_RESTRICT_READONLY 0x80000000U
1792 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1793 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1794 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1795 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1796 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1798 #define SLAP_RESTRICT_OP_READS \
1799 ( SLAP_RESTRICT_OP_COMPARE \
1800 | SLAP_RESTRICT_OP_SEARCH )
1801 #define SLAP_RESTRICT_OP_WRITES \
1802 ( SLAP_RESTRICT_OP_ADD \
1803 | SLAP_RESTRICT_OP_DELETE \
1804 | SLAP_RESTRICT_OP_MODIFY \
1805 | SLAP_RESTRICT_OP_RENAME )
1806 #define SLAP_RESTRICT_OP_ALL \
1807 ( SLAP_RESTRICT_OP_READS \
1808 | SLAP_RESTRICT_OP_WRITES \
1809 | SLAP_RESTRICT_OP_BIND \
1810 | SLAP_RESTRICT_OP_EXTENDED )
1812 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1813 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1814 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1816 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1817 #define SLAP_ALLOW_PROXY_AUTHZ_ANON 0x0010U /* allow anonymous proxyAuthz */
1819 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1820 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1822 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1823 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1825 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1827 slap_mask_t be_requires; /* pre-operation requirements */
1828 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1829 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1830 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1831 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1832 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1834 /* Required Security Strength Factor */
1835 slap_ssf_set_t be_ssf_set;
1837 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1838 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1839 struct berval be_schemadn; /* per-backend subschema subentry DN */
1840 struct berval be_schemandn; /* normalized subschema DN */
1841 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1842 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1843 struct berval be_rootpw; /* the magic "root" password for this db */
1844 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1845 #define be_sizelimit be_def_limit.lms_s_soft
1846 #define be_timelimit be_def_limit.lms_t_soft
1847 struct slap_limits_set be_def_limit; /* default limits */
1848 struct slap_limits **be_limits; /* regex-based size and time limits */
1849 AccessControl *be_acl; /* access control list for this backend */
1850 slap_access_t be_dfltaccess; /* access given if no acl matches */
1852 /* Replica Information */
1853 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1854 BerVarray be_update_refs; /* where to refer modifying clients to */
1855 struct be_pcl *be_pending_csn_list;
1856 ldap_pvt_thread_mutex_t be_pcl_mutex;
1857 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1858 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1860 void *be_pb; /* Netscape plugin */
1861 struct ConfigOCs *be_cf_ocs;
1863 void *be_private; /* anything the backend database needs */
1864 LDAP_STAILQ_ENTRY(BackendDB) be_next;
1867 /* Backend function typedefs */
1868 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1869 typedef BI_bi_func BI_init;
1870 typedef BI_bi_func BI_open;
1871 typedef BI_bi_func BI_close;
1872 typedef BI_bi_func BI_destroy;
1873 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1874 const char *fname, int lineno,
1875 int argc, char **argv));
1877 struct config_reply_s ; /* config.h */
1878 typedef int (BI_db_func) LDAP_P((Backend *bd, struct config_reply_s *c));
1879 typedef BI_db_func BI_db_init;
1880 typedef BI_db_func BI_db_open;
1881 typedef BI_db_func BI_db_close;
1882 typedef BI_db_func BI_db_destroy;
1883 typedef int (BI_db_config) LDAP_P((Backend *bd,
1884 const char *fname, int lineno,
1885 int argc, char **argv));
1887 typedef struct req_bind_s {
1889 struct berval rb_cred;
1890 struct berval rb_edn;
1892 struct berval rb_mech;
1895 typedef struct req_search_s {
1900 /* NULL means be_isroot evaluated to TRUE */
1901 struct slap_limits_set *rs_limit;
1903 AttributeName *rs_attrs;
1905 struct berval rs_filterstr;
1908 typedef struct req_compare_s {
1909 AttributeAssertion *rs_ava;
1912 typedef struct req_modifications_s {
1913 Modifications *rs_modlist;
1914 char rs_no_opattrs; /* don't att modify operational attrs */
1915 } req_modifications_s;
1917 typedef struct req_modify_s {
1918 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1922 typedef struct req_modrdn_s {
1923 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1924 int rs_deleteoldrdn;
1925 struct berval rs_newrdn;
1926 struct berval rs_nnewrdn;
1927 struct berval *rs_newSup;
1928 struct berval *rs_nnewSup;
1931 typedef struct req_add_s {
1932 Modifications *rs_modlist;
1936 typedef struct req_abandon_s {
1941 #define SLAP_EXOP_HIDE 0x0000
1943 #define SLAP_EXOP_HIDE 0x8000
1945 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1947 typedef struct req_extended_s {
1948 struct berval rs_reqoid;
1950 struct berval *rs_reqdata;
1953 typedef struct req_pwdexop_s {
1954 struct req_extended_s rs_extended;
1955 struct berval rs_old;
1956 struct berval rs_new;
1957 Modifications *rs_mods;
1958 Modifications **rs_modtail;
1961 typedef enum slap_reply_e {
1971 typedef struct rep_sasl_s {
1972 struct berval *r_sasldata;
1975 typedef struct rep_extended_s {
1976 const char *r_rspoid;
1977 struct berval *r_rspdata;
1980 typedef struct rep_search_s {
1982 slap_mask_t r_attr_flags;
1983 #define SLAP_ATTRS_UNDEFINED (0x00U)
1984 #define SLAP_OPATTRS_NO (0x01U)
1985 #define SLAP_OPATTRS_YES (0x02U)
1986 #define SLAP_USERATTRS_NO (0x10U)
1987 #define SLAP_USERATTRS_YES (0x20U)
1988 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1989 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1990 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1991 #define SLAP_USERATTRS(f) \
1992 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1994 Attribute *r_operational_attrs;
1995 AttributeName *r_attrs;
2001 slap_reply_t sr_type;
2005 const char *sr_matched;
2006 const char *sr_text;
2008 LDAPControl **sr_ctrls;
2010 rep_sasl_s sru_sasl;
2011 rep_extended_s sru_extended;
2012 rep_search_s sru_search;
2014 slap_mask_t sr_flags;
2015 #define REP_ENTRY_MODIFIABLE 0x0001U
2016 #define REP_ENTRY_MUSTBEFREED 0x0002U
2017 #define REP_ENTRY_MUSTRELEASE 0x0004U
2018 #define REP_ENTRY_MASK (REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2020 #define REP_MATCHED_MUSTBEFREED 0x0010U
2021 #define REP_MATCHED_MASK (REP_MATCHED_MUSTBEFREED)
2023 #define REP_REF_MUSTBEFREED 0x0020U
2024 #define REP_REF_MASK (REP_REF_MUSTBEFREED)
2026 #define REP_NO_ENTRYDN 0x1000U
2027 #define REP_NO_SUBSCHEMA 0x2000U
2028 #define REP_NO_OPERATIONALS (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2031 /* short hands for response members */
2032 #define sr_attrs sr_un.sru_search.r_attrs
2033 #define sr_entry sr_un.sru_search.r_entry
2034 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2035 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2036 #define sr_v2ref sr_un.sru_search.r_v2ref
2037 #define sr_nentries sr_un.sru_search.r_nentries
2038 #define sr_rspoid sr_un.sru_extended.r_rspoid
2039 #define sr_rspdata sr_un.sru_extended.r_rspdata
2040 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2042 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs ));
2043 typedef BI_op_func BI_op_bind;
2044 typedef BI_op_func BI_op_unbind;
2045 typedef BI_op_func BI_op_search;
2046 typedef BI_op_func BI_op_compare;
2047 typedef BI_op_func BI_op_modify;
2048 typedef BI_op_func BI_op_modrdn;
2049 typedef BI_op_func BI_op_add;
2050 typedef BI_op_func BI_op_delete;
2051 typedef BI_op_func BI_op_abandon;
2052 typedef BI_op_func BI_op_extended;
2053 typedef BI_op_func BI_op_cancel;
2054 typedef BI_op_func BI_chk_referrals;
2055 typedef BI_op_func BI_chk_controls;
2056 typedef int (BI_entry_release_rw)
2057 LDAP_P(( Operation *op, Entry *e, int rw ));
2058 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn,
2059 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2060 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs ));
2061 typedef int (BI_has_subordinates) LDAP_P(( Operation *op,
2062 Entry *e, int *hasSubs ));
2063 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e,
2064 AttributeDescription *desc, struct berval *val, slap_access_t access,
2065 AccessControlState *state, slap_mask_t *maskp ));
2066 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target,
2067 struct berval *gr_ndn, struct berval *op_ndn,
2068 ObjectClass *group_oc, AttributeDescription *group_at ));
2069 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target,
2070 struct berval *entry_ndn, AttributeDescription *entry_at,
2071 BerVarray *vals, slap_access_t access ));
2073 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c ));
2074 typedef BI_conn_func BI_connection_init;
2075 typedef BI_conn_func BI_connection_destroy;
2077 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2078 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2079 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2080 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2081 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2082 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2083 struct berval *text ));
2084 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv ));
2085 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2086 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2087 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2088 struct berval *text ));
2090 struct BackendInfo {
2091 char *bi_type; /* type of backend */
2094 * per backend type routines:
2095 * bi_init: called to allocate a backend_info structure,
2096 * called once BEFORE configuration file is read.
2097 * bi_init() initializes this structure hence is
2098 * called directly from be_initialize()
2099 * bi_config: called per 'backend' specific option
2100 * all such options must before any 'database' options
2101 * bi_config() is called only from read_config()
2102 * bi_open: called to open each database, called
2103 * once AFTER configuration file is read but
2104 * BEFORE any bi_db_open() calls.
2105 * bi_open() is called from backend_startup()
2106 * bi_close: called to close each database, called
2107 * once during shutdown after all bi_db_close calls.
2108 * bi_close() is called from backend_shutdown()
2109 * bi_destroy: called to destroy each database, called
2110 * once during shutdown after all bi_db_destroy calls.
2111 * bi_destory() is called from backend_destroy()
2114 BI_config *bi_config;
2117 BI_destroy *bi_destroy;
2120 * per database routines:
2121 * bi_db_init: called to initialize each database,
2122 * called upon reading 'database <type>'
2123 * called only from backend_db_init()
2124 * bi_db_config: called to configure each database,
2125 * called per database to handle per database options
2126 * called only from read_config()
2127 * bi_db_open: called to open each database
2128 * called once per database immediately AFTER bi_open()
2129 * calls but before daemon startup.
2130 * called only by backend_startup()
2131 * bi_db_close: called to close each database
2132 * called once per database during shutdown but BEFORE
2133 * any bi_close call.
2134 * called only by backend_shutdown()
2135 * bi_db_destroy: called to destroy each database
2136 * called once per database during shutdown AFTER all
2137 * bi_close calls but before bi_destory calls.
2138 * called only by backend_destory()
2140 BI_db_init *bi_db_init;
2141 BI_db_config *bi_db_config;
2142 BI_db_open *bi_db_open;
2143 BI_db_close *bi_db_close;
2144 BI_db_destroy *bi_db_destroy;
2146 /* LDAP Operations Handling Routines */
2147 BI_op_bind *bi_op_bind;
2148 BI_op_unbind *bi_op_unbind;
2149 BI_op_search *bi_op_search;
2150 BI_op_compare *bi_op_compare;
2151 BI_op_modify *bi_op_modify;
2152 BI_op_modrdn *bi_op_modrdn;
2153 BI_op_add *bi_op_add;
2154 BI_op_delete *bi_op_delete;
2155 BI_op_abandon *bi_op_abandon;
2157 /* Extended Operations Helper */
2158 BI_op_extended *bi_extended;
2159 BI_op_cancel *bi_op_cancel;
2161 /* Auxilary Functions */
2162 BI_operational *bi_operational;
2163 BI_chk_referrals *bi_chk_referrals;
2164 BI_chk_controls *bi_chk_controls;
2165 BI_entry_get_rw *bi_entry_get_rw;
2166 BI_entry_release_rw *bi_entry_release_rw;
2168 BI_has_subordinates *bi_has_subordinates;
2169 BI_access_allowed *bi_access_allowed;
2170 BI_acl_group *bi_acl_group;
2171 BI_acl_attribute *bi_acl_attribute;
2173 BI_connection_init *bi_connection_init;
2174 BI_connection_destroy *bi_connection_destroy;
2176 /* hooks for slap tools */
2177 BI_tool_entry_open *bi_tool_entry_open;
2178 BI_tool_entry_close *bi_tool_entry_close;
2179 BI_tool_entry_first *bi_tool_entry_first;
2180 BI_tool_entry_next *bi_tool_entry_next;
2181 BI_tool_entry_get *bi_tool_entry_get;
2182 BI_tool_entry_put *bi_tool_entry_put;
2183 BI_tool_entry_reindex *bi_tool_entry_reindex;
2184 BI_tool_sync *bi_tool_sync;
2185 BI_tool_dn2id_get *bi_tool_dn2id_get;
2186 BI_tool_entry_modify *bi_tool_entry_modify;
2188 #define SLAP_INDEX_ADD_OP 0x0001
2189 #define SLAP_INDEX_DELETE_OP 0x0002
2191 slap_mask_t bi_flags; /* backend flags */
2192 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2193 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2194 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2195 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2196 #define SLAP_BFLAG_INCREMENT 0x0100U
2197 #define SLAP_BFLAG_ALIASES 0x1000U
2198 #define SLAP_BFLAG_REFERRALS 0x2000U
2199 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2200 #define SLAP_BFLAG_DYNAMIC 0x8000U
2202 /* overlay specific */
2203 #define SLAPO_BFLAG_SINGLE 0x01000000U
2204 #define SLAPO_BFLAG_DBONLY 0x02000000U
2205 #define SLAPO_BFLAG_GLOBONLY 0x04000000U
2206 #define SLAPO_BFLAG_MASK 0xFF000000U
2208 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2209 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2210 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2211 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2212 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2213 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2214 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2215 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2216 #define SLAP_DYNAMIC(be) ((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC))
2217 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2218 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2220 /* overlay specific */
2221 #define SLAPO_SINGLE(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE)
2222 #define SLAPO_DBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY)
2223 #define SLAPO_GLOBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY)
2225 char **bi_controls; /* supported controls */
2226 char bi_ctrls[SLAP_MAX_CIDS + 1];
2228 unsigned int bi_nDB; /* number of databases of this type */
2229 struct ConfigOCs *bi_cf_ocs;
2230 char **bi_obsolete_names;
2231 void *bi_extra; /* backend type-specific APIs */
2232 void *bi_private; /* backend type-specific config data */
2233 LDAP_STAILQ_ENTRY(BackendInfo) bi_next ;
2236 #define c_authtype c_authz.sai_method
2237 #define c_authmech c_authz.sai_mech
2238 #define c_dn c_authz.sai_dn
2239 #define c_ndn c_authz.sai_ndn
2240 #define c_ssf c_authz.sai_ssf
2241 #define c_transport_ssf c_authz.sai_transport_ssf
2242 #define c_tls_ssf c_authz.sai_tls_ssf
2243 #define c_sasl_ssf c_authz.sai_sasl_ssf
2245 #define o_authtype o_authz.sai_method
2246 #define o_authmech o_authz.sai_mech
2247 #define o_dn o_authz.sai_dn
2248 #define o_ndn o_authz.sai_ndn
2249 #define o_ssf o_authz.sai_ssf
2250 #define o_transport_ssf o_authz.sai_transport_ssf
2251 #define o_tls_ssf o_authz.sai_tls_ssf
2252 #define o_sasl_ssf o_authz.sai_sasl_ssf
2254 typedef int (slap_response)( Operation *, SlapReply * );
2256 typedef struct slap_callback {
2257 struct slap_callback *sc_next;
2258 slap_response *sc_response;
2259 slap_response *sc_cleanup;
2263 struct slap_overinfo;
2265 typedef enum slap_operation_e {
2278 op_aux_chk_referrals,
2279 op_aux_chk_controls,
2283 typedef struct slap_overinst {
2285 slap_response *on_response;
2286 struct slap_overinfo *on_info;
2287 struct slap_overinst *on_next;
2290 typedef struct slap_overinfo {
2292 BackendInfo *oi_orig;
2293 BackendDB *oi_origdb;
2294 struct slap_overinst *oi_list;
2297 /* Should successive callbacks in a chain be processed? */
2298 #define SLAP_CB_FREEME 0x04000
2299 #define SLAP_CB_BYPASS 0x08800
2300 #define SLAP_CB_CONTINUE 0x08000
2303 * Paged Results state
2305 typedef unsigned long PagedResultsCookie;
2306 typedef struct PagedResultsState {
2309 PagedResultsCookie ps_cookie;
2311 } PagedResultsState;
2313 struct slap_csn_entry {
2314 struct berval ce_csn;
2315 unsigned long ce_opid;
2316 unsigned long ce_connid;
2317 #define SLAP_CSN_PENDING 1
2318 #define SLAP_CSN_COMMIT 2
2320 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2324 * Caches the result of a backend_group check for ACL evaluation
2326 typedef struct GroupAssertion {
2327 struct GroupAssertion *ga_next;
2330 AttributeDescription *ga_at;
2336 struct slap_control_ids {
2342 int sc_modifyIncrement;
2344 int sc_pagedResults;
2345 int sc_permissiveModify;
2350 int sc_searchOptions;
2351 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2352 int sc_sortedResults;
2355 #ifdef SLAP_CONTROL_X_TREE_DELETE
2361 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2362 int sc_sessionTracking;
2364 int sc_valuesReturnFilter;
2368 * represents an operation pending from an ldap client
2370 typedef struct Opheader {
2371 unsigned long oh_opid; /* id of this operation */
2372 unsigned long oh_connid; /* id of conn initiating this op */
2373 Connection *oh_conn; /* connection spawning this op */
2375 ber_int_t oh_msgid; /* msgid of the request */
2376 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2378 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2380 void *oh_threadctx; /* thread pool thread context */
2381 void *oh_tmpmemctx; /* slab malloc context */
2382 BerMemoryFunctions *oh_tmpmfuncs;
2384 char oh_log_prefix[ /* sizeof("conn=18446744073709551615 op=18446744073709551615") */ SLAP_TEXT_BUFLEN ];
2387 void *oh_extensions; /* NS-SLAPI plugin */
2391 typedef union OpRequest {
2394 req_compare_s oq_compare;
2395 req_modify_s oq_modify;
2396 req_modrdn_s oq_modrdn;
2397 req_search_s oq_search;
2398 req_abandon_s oq_abandon;
2399 req_abandon_s oq_cancel;
2400 req_extended_s oq_extended;
2401 req_pwdexop_s oq_pwdexop;
2407 #define o_opid o_hdr->oh_opid
2408 #define o_connid o_hdr->oh_connid
2409 #define o_conn o_hdr->oh_conn
2410 #define o_msgid o_hdr->oh_msgid
2411 #define o_protocol o_hdr->oh_protocol
2412 #define o_tid o_hdr->oh_tid
2413 #define o_threadctx o_hdr->oh_threadctx
2414 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2415 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2417 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2418 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2419 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2420 #define o_tmpfree o_tmpmfuncs->bmf_free
2422 #define o_log_prefix o_hdr->oh_log_prefix
2424 ber_tag_t o_tag; /* tag of the request */
2425 time_t o_time; /* time op was initiated */
2426 int o_tincr; /* counter for multiple ops with same o_time */
2428 BackendDB *o_bd; /* backend DB processing this op */
2429 struct berval o_req_dn; /* DN of target of request */
2430 struct berval o_req_ndn;
2432 OpRequest o_request;
2434 /* short hands for union members */
2435 #define oq_add o_request.oq_add
2436 #define oq_bind o_request.oq_bind
2437 #define oq_compare o_request.oq_compare
2438 #define oq_modify o_request.oq_modify
2439 #define oq_modrdn o_request.oq_modrdn
2440 #define oq_search o_request.oq_search
2441 #define oq_abandon o_request.oq_abandon
2442 #define oq_cancel o_request.oq_cancel
2443 #define oq_extended o_request.oq_extended
2444 #define oq_pwdexop o_request.oq_pwdexop
2446 /* short hands for inner request members */
2447 #define orb_method oq_bind.rb_method
2448 #define orb_cred oq_bind.rb_cred
2449 #define orb_edn oq_bind.rb_edn
2450 #define orb_ssf oq_bind.rb_ssf
2451 #define orb_mech oq_bind.rb_mech
2453 #define ors_scope oq_search.rs_scope
2454 #define ors_deref oq_search.rs_deref
2455 #define ors_slimit oq_search.rs_slimit
2456 #define ors_tlimit oq_search.rs_tlimit
2457 #define ors_limit oq_search.rs_limit
2458 #define ors_attrsonly oq_search.rs_attrsonly
2459 #define ors_attrs oq_search.rs_attrs
2460 #define ors_filter oq_search.rs_filter
2461 #define ors_filterstr oq_search.rs_filterstr
2463 #define orr_modlist oq_modrdn.rs_mods.rs_modlist
2464 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs
2465 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2466 #define orr_newrdn oq_modrdn.rs_newrdn
2467 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2468 #define orr_newSup oq_modrdn.rs_newSup
2469 #define orr_nnewSup oq_modrdn.rs_nnewSup
2471 #define orc_ava oq_compare.rs_ava
2473 #define ora_e oq_add.rs_e
2474 #define ora_modlist oq_add.rs_modlist
2476 #define orn_msgid oq_abandon.rs_msgid
2478 #define orm_modlist oq_modify.rs_mods.rs_modlist
2479 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs
2480 #define orm_increment oq_modify.rs_increment
2482 #define ore_reqoid oq_extended.rs_reqoid
2483 #define ore_flags oq_extended.rs_flags
2484 #define ore_reqdata oq_extended.rs_reqdata
2485 volatile sig_atomic_t o_abandon; /* abandon flag */
2486 volatile sig_atomic_t o_cancel; /* cancel flag */
2487 #define SLAP_CANCEL_NONE 0x00
2488 #define SLAP_CANCEL_REQ 0x01
2489 #define SLAP_CANCEL_ACK 0x02
2490 #define SLAP_CANCEL_DONE 0x03
2492 GroupAssertion *o_groups;
2493 char o_do_not_cache; /* don't cache groups from this op */
2494 char o_is_auth_check; /* authorization in progress */
2495 slap_access_t o_acl_priv;
2498 char o_delete_glue_parent;
2499 char o_no_schema_check;
2500 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2501 char o_no_subordinate_glue;
2502 #define get_no_subordinate_glue(op) ((op)->o_no_subordinate_glue)
2504 #define SLAP_CONTROL_NONE 0
2505 #define SLAP_CONTROL_IGNORED 1
2506 #define SLAP_CONTROL_NONCRITICAL 2
2507 #define SLAP_CONTROL_CRITICAL 3
2508 #define SLAP_CONTROL_MASK 3
2510 /* spare bits for simple flags */
2511 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2512 #define SLAP_CONTROL_DATA0 0x10
2513 #define SLAP_CONTROL_DATA1 0x20
2514 #define SLAP_CONTROL_DATA2 0x40
2515 #define SLAP_CONTROL_DATA3 0x80
2517 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2519 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2520 void **o_controls; /* per-control state */
2522 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2523 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2525 #define o_relax o_ctrlflag[slap_cids.sc_relax]
2526 #define get_relax(op) _SCM((op)->o_relax)
2528 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2529 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2531 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2532 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2533 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2535 #define get_subentries(op) _SCM((op)->o_subentries)
2536 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2538 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2539 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2541 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2542 #define get_assert(op) ((int)(op)->o_assert)
2543 #define o_assertion o_controls[slap_cids.sc_assert]
2544 #define get_assertion(op) ((op)->o_assertion)
2546 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2547 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2549 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2550 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2552 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2553 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2555 #ifdef SLAP_CONTROL_X_TREE_DELETE
2556 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2557 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2560 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2561 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2563 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2564 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2566 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2567 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2568 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2570 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2571 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2575 #define o_txnSpec o_ctrlflag[slap_cids.sc_txnSpec]
2578 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2579 #define o_session_tracking o_ctrlflag[slap_cids.sc_sessionTracking]
2580 #define o_tracked_sessions o_controls[slap_cids.sc_sessionTracking]
2581 #define get_sessionTracking(op) ((int)(op)->o_session_tracking)
2584 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2586 AuthorizationInformation o_authz;
2588 BerElement *o_ber; /* ber of the request */
2589 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2590 slap_callback *o_callback; /* callback pointers */
2591 LDAPControl **o_ctrls; /* controls */
2592 struct berval o_csn;
2594 void *o_private; /* anything the backend needs */
2596 LDAP_STAILQ_ENTRY(Operation) o_next; /* next operation in list */
2599 typedef struct OperationBuffer {
2602 void *ob_controls[SLAP_MAX_CIDS];
2605 #define send_ldap_error( op, rs, err, text ) do { \
2606 (rs)->sr_err = err; (rs)->sr_text = text; \
2607 (op->o_conn->c_send_ldap_result)( op, rs ); \
2609 #define send_ldap_discon( op, rs, err, text ) do { \
2610 (rs)->sr_err = err; (rs)->sr_text = text; \
2611 send_ldap_disconnect( op, rs ); \
2614 typedef void (SEND_LDAP_RESULT)(
2615 Operation *op, SlapReply *rs);
2616 typedef int (SEND_SEARCH_ENTRY)(
2617 Operation *op, SlapReply *rs);
2618 typedef int (SEND_SEARCH_REFERENCE)(
2619 Operation *op, SlapReply *rs);
2620 typedef void (SEND_LDAP_EXTENDED)(
2621 Operation *op, SlapReply *rs);
2622 typedef void (SEND_LDAP_INTERMEDIATE)(
2623 Operation *op, SlapReply *rs);
2625 #define send_ldap_result( op, rs ) \
2626 ((op)->o_conn->c_send_ldap_result)( op, rs )
2627 #define send_search_entry( op, rs ) \
2628 ((op)->o_conn->c_send_search_entry)( op, rs )
2629 #define send_search_reference( op, rs ) \
2630 ((op)->o_conn->c_send_search_reference)( op, rs )
2631 #define send_ldap_extended( op, rs ) \
2632 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2633 #define send_ldap_intermediate( op, rs ) \
2634 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2636 typedef struct slap_listener Listener;
2639 * represents a connection from an ldap client
2642 int c_struct_state; /* structure management state */
2643 int c_conn_state; /* connection state */
2644 int c_conn_idx; /* slot in connections array */
2645 const char *c_close_reason; /* why connection is closing */
2647 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2648 Sockbuf *c_sb; /* ber connection stuff */
2650 /* only can be changed by connect_init */
2651 time_t c_starttime; /* when the connection was opened */
2652 time_t c_activitytime; /* when the connection was last used */
2653 unsigned long c_connid; /* id of this connection for stats*/
2655 struct berval c_peer_domain; /* DNS name of client */
2656 struct berval c_peer_name; /* peer name (trans=addr:port) */
2657 Listener *c_listener;
2658 #define c_listener_url c_listener->sl_url /* listener URL */
2659 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2661 /* only can be changed by binding thread */
2662 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2663 struct berval c_sasl_bind_mech; /* mech in progress */
2664 struct berval c_sasl_dn; /* temporary storage */
2665 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2667 /* authorization backend */
2668 Backend *c_authz_backend;
2669 void *c_authz_cookie;
2670 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2671 ( (op)->o_bd != NULL \
2672 && (op)->o_bd->be_private != NULL \
2673 && (op)->o_conn != NULL \
2674 && (op)->o_conn->c_authz_backend != NULL \
2675 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2676 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2678 AuthorizationInformation c_authz;
2680 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2682 LDAP_STAILQ_HEAD(c_o, Operation) c_ops; /* list of operations being processed */
2683 LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops; /* list of pending operations */
2685 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2686 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2688 BerElement *c_currentber; /* ber we're attempting to read */
2689 int c_writewaiter; /* true if writer is waiting */
2691 #define CONN_IS_TLS 1
2692 #define CONN_IS_UDP 2
2693 #define CONN_IS_CLIENT 4
2694 #define CONN_IS_IPC 8
2696 #ifdef LDAP_CONNECTIONLESS
2697 int c_is_udp; /* true if this is (C)LDAP over UDP */
2700 int c_is_tls; /* true if this LDAP over raw TLS */
2701 int c_needs_tls_accept; /* true if SSL_accept should be called */
2703 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2704 int c_sasl_done; /* SASL completed once */
2705 void *c_sasl_authctx; /* SASL authentication context */
2706 void *c_sasl_sockctx; /* SASL security layer context */
2707 void *c_sasl_extra; /* SASL session extra stuff */
2708 Operation *c_sasl_bindop; /* set to current op if it's a bind */
2711 #define CONN_TXN_INACTIVE 0
2712 #define CONN_TXN_SPECIFY 1
2713 #define CONN_TXN_SETTLE -1
2716 Backend *c_txn_backend;
2717 LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */
2720 PagedResultsState c_pagedresults_state; /* paged result state */
2722 long c_n_ops_received; /* num of ops received (next op_id) */
2723 long c_n_ops_executing; /* num of ops currently executing */
2724 long c_n_ops_pending; /* num of ops pending execution */
2725 long c_n_ops_completed; /* num of ops completed */
2727 long c_n_get; /* num of get calls */
2728 long c_n_read; /* num of read calls */
2729 long c_n_write; /* num of write calls */
2731 void *c_extensions; /* Netscape plugin */
2734 * Client connection handling
2736 ldap_pvt_thread_start_t *c_clientfunc;
2740 * These are the "callbacks" that are available for back-ends to
2741 * supply data back to connected clients that are connected
2742 * through the "front-end".
2744 SEND_LDAP_RESULT *c_send_ldap_result;
2745 SEND_SEARCH_ENTRY *c_send_search_entry;
2746 SEND_SEARCH_REFERENCE *c_send_search_reference;
2747 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2748 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2754 #define SLAP_DEFAULT_SYSLOG_USER LOG_LOCAL4
2755 #endif /* LOG_LOCAL4 */
2757 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2758 Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2759 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2760 #else /* !LDAP_SYSLOG */
2761 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2763 if ( ldap_debug & (level) ) \
2764 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2766 #define StatslogTest( level ) (ldap_debug & (level))
2767 #endif /* !LDAP_SYSLOG */
2768 #else /* !LDAP_DEBUG */
2769 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0)
2770 #define StatslogTest( level ) (0)
2771 #endif /* !LDAP_DEBUG */
2774 * listener; need to access it from monitor backend
2776 struct slap_listener {
2777 struct berval sl_url;
2778 struct berval sl_name;
2783 #ifdef LDAP_CONNECTIONLESS
2784 int sl_is_udp; /* UDP listener is also data port */
2786 int sl_mute; /* Listener is temporarily disabled due to emfile */
2787 #ifdef SLAP_LIGHTWEIGHT_DISPATCHER
2788 int sl_busy; /* Listener is busy (accept thread activated) */
2792 #define sl_addr sl_sa.sa_in_addr
2812 typedef struct slap_counters_t {
2813 ldap_pvt_thread_mutex_t sc_sent_mutex;
2814 ldap_pvt_mp_t sc_bytes;
2815 ldap_pvt_mp_t sc_pdu;
2816 ldap_pvt_mp_t sc_entries;
2817 ldap_pvt_mp_t sc_refs;
2819 ldap_pvt_thread_mutex_t sc_ops_mutex;
2820 ldap_pvt_mp_t sc_ops_completed;
2821 ldap_pvt_mp_t sc_ops_initiated;
2822 #ifdef SLAPD_MONITOR
2823 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2824 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2825 #endif /* SLAPD_MONITOR */
2829 * Better know these all around slapd
2831 #define SLAP_LDAPDN_PRETTY 0x1
2832 #define SLAP_LDAPDN_MAXLEN 8192
2834 /* number of response controls supported */
2835 #define SLAP_MAX_RESPONSE_CONTROLS 6
2838 #define SLAP_CTRL_HIDE 0x00000000U
2840 #define SLAP_CTRL_HIDE 0x80000000U
2843 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for Relax */
2845 #define SLAP_CTRL_GLOBAL 0x00800000U
2846 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2848 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2849 #define SLAP_CTRL_ABANDON 0x00000001U
2850 #define SLAP_CTRL_ADD 0x00002002U
2851 #define SLAP_CTRL_BIND 0x00000004U
2852 #define SLAP_CTRL_COMPARE 0x00001008U
2853 #define SLAP_CTRL_DELETE 0x00002010U
2854 #define SLAP_CTRL_MODIFY 0x00002020U
2855 #define SLAP_CTRL_RENAME 0x00002040U
2856 #define SLAP_CTRL_SEARCH 0x00001080U
2857 #define SLAP_CTRL_UNBIND 0x00000100U
2859 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2860 #define SLAP_CTRL_UPDATE \
2861 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2862 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2864 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2867 LDAPControl *ctrl ));
2869 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
2871 #define SLAP_SLAB_SIZE (1024*1024)
2872 #define SLAP_SLAB_STACK 1
2873 #define SLAP_SLAB_SOBLOCK 64
2875 #define SLAP_ZONE_ALLOC 1
2876 #undef SLAP_ZONE_ALLOC
2878 #ifdef LDAP_COMP_MATCH
2880 * Extensible Filter Definition
2882 * MatchingRuleAssertion := SEQUENCE {
2883 * matchingRule [1] MatchingRuleId OPTIONAL,
2884 * type [2] AttributeDescription OPTIONAL,
2885 * matchValue [3] AssertionValue,
2886 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2888 * Following ComponentFilter is contained in matchValue
2890 * ComponentAssertion ::= SEQUENCE {
2891 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2892 * useDefaultValues BOOLEAN DEFAULT TRUE,
2893 * rule MATCHING-RULE.&id,
2894 * value MATCHING-RULE.&AssertionType }
2896 * ComponentFilter ::= CHOICE {
2897 * item [0] ComponentAssertion,
2898 * and [1] SEQUENCE OF ComponentFilter,
2899 * or [2] SEQUENCE OF ComponentFilter,
2900 * not [3] ComponentFilter }
2903 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2904 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2905 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2906 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2907 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2908 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2909 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2910 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2911 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2913 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2914 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2915 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2916 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2917 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2919 typedef struct ComponentId ComponentId;
2920 typedef struct ComponentReference ComponentReference;
2921 typedef struct ComponentAssertion ComponentAssertion;
2922 typedef struct ComponentAssertionValue ComponentAssertionValue;
2923 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo;
2924 typedef struct ComponentDesc ComponentDesc;
2926 struct ComponentData {
2927 void *cd_mem_op; /* nibble memory handler */
2928 ComponentSyntaxInfo** cd_tree; /* component tree */
2931 struct ComponentId {
2933 ComponentId *ci_next;
2935 union comp_id_value{
2936 BerValue ci_identifier;
2937 ber_int_t ci_from_beginning;
2939 ber_int_t ci_from_end;
2940 ber_int_t ci_content;
2941 BerValue ci_select_value;
2946 struct ComponentReference {
2947 ComponentId *cr_list;
2948 ComponentId *cr_curr;
2949 struct berval cr_string;
2951 /* Component Indexing */
2953 slap_mask_t cr_indexmask;
2954 AttributeDescription* cr_ad;
2956 ComponentReference* cr_next;
2959 struct ComponentAssertion {
2960 ComponentReference *ca_comp_ref;
2961 ber_int_t ca_use_def;
2962 MatchingRule *ca_ma_rule;
2963 struct berval ca_ma_value;
2964 ComponentData ca_comp_data; /* componentized assertion */
2965 ComponentFilter *ca_cf;
2966 MatchingRuleAssertion *ca_mra;
2969 struct ComponentFilter {
2970 ber_tag_t cf_choice;
2972 ber_int_t cf_un_result;
2973 ComponentAssertion *cf_un_ca;
2974 ComponentFilter *cf_un_complex;
2977 #define cf_ca cf_un.cf_un_ca
2978 #define cf_result cf_un.cf_un_result
2979 #define cf_and cf_un.cf_un_complex
2980 #define cf_or cf_un.cf_un_complex
2981 #define cf_not cf_un.cf_un_complex
2982 #define cf_any cf_un.cf_un_complex
2984 ComponentFilter *cf_next;
2987 struct ComponentAssertionValue {
2993 typedef int encoder_func LDAP_P((
2997 typedef int gser_decoder_func LDAP_P((
3000 ComponentSyntaxInfo** comp_syn_info,
3004 typedef int comp_free_func LDAP_P((
3007 typedef int ber_decoder_func LDAP_P((
3012 ComponentSyntaxInfo* comp_syn_info,
3016 typedef int ber_tag_decoder_func LDAP_P((
3019 ComponentSyntaxInfo* comp_syn_info,
3023 typedef void* extract_component_from_id_func LDAP_P((
3025 ComponentReference* cr,
3028 typedef void* convert_attr_to_comp_func LDAP_P ((
3031 struct berval* bv ));
3033 typedef void* alloc_nibble_func LDAP_P ((
3035 int increment_size ));
3037 typedef void free_nibble_func LDAP_P ((
3040 typedef void convert_assert_to_comp_func LDAP_P ((
3042 ComponentSyntaxInfo* csi_attr,
3044 ComponentSyntaxInfo** csi,
3048 typedef int convert_asn_to_ldap_func LDAP_P ((
3049 ComponentSyntaxInfo* csi,
3050 struct berval *bv ));
3052 typedef void free_component_func LDAP_P ((
3055 typedef int test_component_func LDAP_P ((
3057 void* assert_mem_op,
3058 ComponentSyntaxInfo* csi,
3059 ComponentAssertion* ca));
3061 typedef void* test_membership_func LDAP_P ((
3064 typedef void* get_component_info_func LDAP_P ((
3067 typedef int component_encoder_func LDAP_P ((
3069 ComponentSyntaxInfo* csi,
3070 struct berval* nvals ));
3072 typedef int allcomponent_matching_func LDAP_P((
3074 ComponentSyntaxInfo* comp1,
3075 ComponentSyntaxInfo* comp));
3077 struct ComponentDesc {
3078 /* Don't change the order of following four fields */
3080 AttributeType *cd_comp_type;
3081 struct berval cd_ad_type; /* ad_type, ad_cname */
3082 struct berval cd_ad_cname; /* ad_type, ad_cname */
3083 unsigned cd_flags; /* ad_flags */
3086 encoder_func *cd_ldap_encoder;
3087 encoder_func *cd_gser_encoder;
3088 encoder_func *cd_ber_encoder;
3089 gser_decoder_func *cd_gser_decoder;
3090 ber_decoder_func *cd_ber_decoder;
3091 comp_free_func *cd_free;
3092 extract_component_from_id_func* cd_extract_i;
3093 allcomponent_matching_func *cd_all_match;
3096 struct ComponentSyntaxInfo {
3098 ComponentDesc *csi_comp_desc;
3101 #endif /* LDAP_COMP_MATCH */
3103 /* slab heap data structures */
3105 struct slab_object {
3108 LDAP_LIST_ENTRY(slab_object) so_link;
3117 unsigned char **sh_map;
3118 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3119 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3122 #ifdef SLAP_ZONE_ALLOC
3123 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3124 #define SLAP_ZONE_SHIFT 19
3125 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3126 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3127 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3128 #define SLAP_ZONE_ZOBLOCK 256
3130 struct zone_object {
3135 LDAP_LIST_ENTRY(zone_object) zo_link;
3138 struct zone_latency_history {
3140 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3151 ldap_pvt_thread_rdwr_t *zh_znlock;
3152 Avlnode *zh_zonetree;
3153 unsigned char ***zh_maps;
3155 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3156 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3157 ldap_pvt_thread_mutex_t zh_mutex;
3158 ldap_pvt_thread_rdwr_t zh_lock;
3159 double zh_ema_latency;
3160 unsigned long zh_ema_samples;
3161 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3162 zh_latency_history_queue;
3163 int zh_latency_history_qlen;
3164 int zh_latency_jump;
3169 #define SLAP_BACKEND_INIT_MODULE(b) \
3170 static BackendInfo bi; \
3172 init_module( int argc, char *argv[] ) \
3175 bi.bi_init = b ## _back_initialize; \
3176 backend_add( &bi ); \
3180 typedef int (OV_init)(void);
3181 typedef struct slap_oinit_t {
3182 const char *ov_type;
3188 #include "proto-slap.h"
3190 #endif /* _SLAP_H_ */