1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2008 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
30 #include "ldap_defaults.h"
33 #include <ac/stdlib.h>
35 #include <sys/types.h>
36 #include <ac/syslog.h>
38 #include <ac/signal.h>
39 #include <ac/socket.h>
46 #define ldap_debug slap_debug
52 #include <ldap_schema.h>
56 #include "ldap_pvt_thread.h"
57 #include "ldap_queue.h"
62 #define LDAP_COLLECTIVE_ATTRIBUTES
63 #define LDAP_COMP_MATCH
64 #define LDAP_SYNC_TIMESTAMP
65 #define SLAP_CONTROL_X_SORTEDRESULTS
66 #define SLAP_CONTROL_X_SESSION_TRACKING
67 #define SLAP_CONTROL_X_WHATFAILED
68 #define SLAP_CONFIG_DELETE
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 ""
106 # define SLAP_STRING_UNKNOWN STRING_UNKNOWN
107 #else /* ! TCP Wrappers */
108 # define SLAP_STRING_UNKNOWN "unknown"
109 #endif /* ! TCP Wrappers */
111 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
112 * This is a value used internally by the backends. It is needed to allow
113 * adding values that already exist without getting an error as required by
114 * modrdn when the new rdn was already an attribute value itself.
116 #define SLAP_MOD_SOFTADD 0x1000
118 #define MAXREMATCHES (100)
120 #define SLAP_MAX_WORKER_THREADS (16)
122 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
123 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
125 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
126 #define SLAP_CONN_MAX_PENDING_AUTH 1000
128 #define SLAP_TEXT_BUFLEN (256)
130 /* psuedo error code indicating abandoned operation */
131 #define SLAPD_ABANDON (-1024)
133 /* psuedo error code indicating disconnect */
134 #define SLAPD_DISCONNECT (-1025)
136 /* unknown config file directive */
137 #define SLAP_CONF_UNKNOWN (-1026)
139 /* We assume "C" locale, that is US-ASCII */
140 #define ASCII_SPACE(c) ( (c) == ' ' )
141 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
142 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
143 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
144 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
145 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
146 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
147 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
148 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
149 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
150 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
152 #define SLAP_NIBBLE(c) ((c)&0x0f)
153 #define SLAP_ESCAPE_CHAR ('\\')
154 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
155 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
157 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
158 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
160 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
161 /* NOTE: for consistency, this macro must only operate
162 * on normalized/pretty DN, such that ';' is never used
163 * as RDN separator, and all occurrences of ';' must be escaped */
164 #define DN_SEPARATOR(c) ((c) == ',')
165 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */
166 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
167 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
169 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
170 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
171 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
172 #define OID_SEPARATOR(c) ( (c) == '.' )
173 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
175 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
176 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
178 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
179 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
181 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
183 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
184 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
185 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
186 (c) == '?' || (c) == ' ' || (c) == '=' )
187 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
189 /* must match in schema_init.c */
190 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
191 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
192 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
193 #define SLAPD_GROUP_ATTR "member"
194 #define SLAPD_GROUP_CLASS "groupOfNames"
195 #define SLAPD_ROLE_ATTR "roleOccupant"
196 #define SLAPD_ROLE_CLASS "organizationalRole"
198 #define SLAPD_TOP_OID "2.5.6.0"
200 LDAP_SLAPD_V (int) slap_debug;
202 typedef unsigned long slap_mask_t;
204 /* Security Strength Factor */
205 typedef unsigned slap_ssf_t;
207 typedef struct slap_ssf_set {
209 slap_ssf_t sss_transport;
212 slap_ssf_t sss_update_ssf;
213 slap_ssf_t sss_update_transport;
214 slap_ssf_t sss_update_tls;
215 slap_ssf_t sss_update_sasl;
216 slap_ssf_t sss_simple_bind;
219 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
220 #define SLAP_GETDN_AUTHCID 2
221 #define SLAP_GETDN_AUTHZID 4
226 #define SLAP_INDEX_TYPE 0x00FFUL
227 #define SLAP_INDEX_UNDEFINED 0x0001UL
228 #define SLAP_INDEX_PRESENT 0x0002UL
229 #define SLAP_INDEX_EQUALITY 0x0004UL
230 #define SLAP_INDEX_APPROX 0x0008UL
231 #define SLAP_INDEX_SUBSTR 0x0010UL
232 #define SLAP_INDEX_EXTENDED 0x0020UL
234 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
236 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
238 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
240 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
241 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
242 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
243 #define SLAP_INDEX_SUBSTR_DEFAULT \
244 ( SLAP_INDEX_SUBSTR \
245 | SLAP_INDEX_SUBSTR_INITIAL \
246 | SLAP_INDEX_SUBSTR_ANY \
247 | SLAP_INDEX_SUBSTR_FINAL )
249 /* defaults for initial/final substring indices */
250 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
251 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
253 /* defaults for any substring indices */
254 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
255 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
257 /* default for ordered integer index keys */
258 #define SLAP_INDEX_INTLEN_DEFAULT 4
260 #define SLAP_INDEX_FLAGS 0xF000UL
261 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
262 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
265 * there is a single index for each attribute. these prefixes ensure
266 * that there is no collision among keys.
268 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
269 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
270 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
271 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
272 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
273 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
275 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
276 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
277 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
278 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
279 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
282 * represents schema information for a database
285 SLAP_SCHERR_OUTOFMEM = 1,
286 SLAP_SCHERR_CLASS_NOT_FOUND,
287 SLAP_SCHERR_CLASS_BAD_USAGE,
288 SLAP_SCHERR_CLASS_BAD_SUP,
289 SLAP_SCHERR_CLASS_DUP,
290 SLAP_SCHERR_CLASS_INCONSISTENT,
291 SLAP_SCHERR_ATTR_NOT_FOUND,
292 SLAP_SCHERR_ATTR_BAD_MR,
293 SLAP_SCHERR_ATTR_BAD_USAGE,
294 SLAP_SCHERR_ATTR_BAD_SUP,
295 SLAP_SCHERR_ATTR_INCOMPLETE,
296 SLAP_SCHERR_ATTR_DUP,
297 SLAP_SCHERR_ATTR_INCONSISTENT,
298 SLAP_SCHERR_MR_NOT_FOUND,
299 SLAP_SCHERR_MR_INCOMPLETE,
301 SLAP_SCHERR_SYN_NOT_FOUND,
303 SLAP_SCHERR_SYN_SUP_NOT_FOUND,
304 SLAP_SCHERR_SYN_SUBST_NOT_SPECIFIED,
305 SLAP_SCHERR_SYN_SUBST_NOT_FOUND,
307 SLAP_SCHERR_NOT_SUPPORTED,
308 SLAP_SCHERR_BAD_DESCR,
311 SLAP_SCHERR_CR_BAD_STRUCT,
312 SLAP_SCHERR_CR_BAD_AUX,
313 SLAP_SCHERR_CR_BAD_AT,
318 /* forward declarations */
319 typedef struct Syntax Syntax;
320 typedef struct MatchingRule MatchingRule;
321 typedef struct MatchingRuleUse MatchingRuleUse;
322 typedef struct MatchingRuleAssertion MatchingRuleAssertion;
323 typedef struct OidMacro OidMacro;
324 typedef struct ObjectClass ObjectClass;
325 typedef struct AttributeType AttributeType;
326 typedef struct AttributeDescription AttributeDescription;
327 typedef struct AttributeName AttributeName;
328 typedef struct ContentRule ContentRule;
330 typedef struct AttributeAssertion AttributeAssertion;
331 typedef struct SubstringsAssertion SubstringsAssertion;
332 typedef struct Filter Filter;
333 typedef struct ValuesReturnFilter ValuesReturnFilter;
334 typedef struct Attribute Attribute;
335 #ifdef LDAP_COMP_MATCH
336 typedef struct ComponentData ComponentData;
337 typedef struct ComponentFilter ComponentFilter;
340 typedef struct Entry Entry;
341 typedef struct Modification Modification;
342 typedef struct Modifications Modifications;
343 typedef struct LDAPModList LDAPModList;
345 typedef struct BackendInfo BackendInfo; /* per backend type */
346 typedef struct BackendDB BackendDB; /* per backend database */
348 typedef struct Connection Connection;
349 typedef struct Operation Operation;
350 typedef struct SlapReply SlapReply;
351 /* end of forward declarations */
353 typedef union Sockaddr {
354 struct sockaddr sa_addr;
355 struct sockaddr_in sa_in_addr;
357 struct sockaddr_storage sa_storage;
358 struct sockaddr_in6 sa_in6_addr;
361 struct sockaddr_un sa_un_addr;
366 extern int slap_inet4or6;
370 struct berval som_oid;
373 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
375 LDAP_STAILQ_ENTRY(OidMacro) som_next;
378 typedef int slap_syntax_validate_func LDAP_P((
380 struct berval * in));
382 typedef int slap_syntax_transform_func LDAP_P((
388 #ifdef LDAP_COMP_MATCH
389 typedef void* slap_component_transform_func LDAP_P((
390 struct berval * in ));
391 struct ComponentDesc;
396 #define ssyn_oid ssyn_syn.syn_oid
397 #define ssyn_desc ssyn_syn.syn_desc
398 #define ssyn_extensions ssyn_syn.syn_extensions
401 ber_len_t ssyn_oidlen;
402 * has been replaced by a struct berval that uses the value
403 * provided by ssyn_syn.syn_oid; a macro that expands to
404 * the bv_len field of the berval is provided for backward
405 * compatibility. CAUTION: NEVER FREE THE BERVAL
407 struct berval ssyn_bvoid;
408 #define ssyn_oidlen ssyn_bvoid.bv_len
410 unsigned int ssyn_flags;
412 #define SLAP_SYNTAX_NONE 0x0000U
413 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
414 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
415 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
417 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
419 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
421 #define SLAP_SYNTAX_HARDCODE 0x10000U /* This is hardcoded schema */
425 slap_syntax_validate_func *ssyn_validate;
426 slap_syntax_transform_func *ssyn_pretty;
428 #ifdef SLAPD_BINARY_CONVERSION
429 /* convert to and from binary */
430 slap_syntax_transform_func *ssyn_ber2str;
431 slap_syntax_transform_func *ssyn_str2ber;
433 #ifdef LDAP_COMP_MATCH
434 slap_component_transform_func *ssyn_attr2comp;
435 struct ComponentDesc* ssync_comp_syntax;
438 LDAP_STAILQ_ENTRY(Syntax) ssyn_next;
441 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
442 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
443 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
444 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
445 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
447 typedef struct slap_syntax_defs_rec {
451 slap_syntax_validate_func *sd_validate;
452 slap_syntax_transform_func *sd_pretty;
453 #ifdef SLAPD_BINARY_CONVERSION
454 slap_syntax_transform_func *sd_ber2str;
455 slap_syntax_transform_func *sd_str2ber;
457 } slap_syntax_defs_rec;
459 /* X -> Y Converter */
460 typedef int slap_mr_convert_func LDAP_P((
466 typedef int slap_mr_normalize_func LDAP_P((
468 Syntax *syntax, /* NULL if in is asserted value */
474 /* Match (compare) function */
475 typedef int slap_mr_match_func LDAP_P((
478 Syntax *syntax, /* syntax of stored value */
480 struct berval *value,
481 void *assertValue ));
483 /* Index generation function */
484 typedef int slap_mr_indexer_func LDAP_P((
487 Syntax *syntax, /* syntax of stored value */
489 struct berval *prefix,
494 /* Filter index function */
495 typedef int slap_mr_filter_func LDAP_P((
498 Syntax *syntax, /* syntax of stored value */
500 struct berval *prefix,
505 struct MatchingRule {
506 LDAPMatchingRule smr_mrule;
507 MatchingRuleUse *smr_mru;
508 /* RFC 4512 string representation */
509 struct berval smr_str;
512 * ber_len_t smr_oidlen;
513 * has been replaced by a struct berval that uses the value
514 * provided by smr_mrule.mr_oid; a macro that expands to
515 * the bv_len field of the berval is provided for backward
516 * compatibility. CAUTION: NEVER FREE THE BERVAL
518 struct berval smr_bvoid;
519 #define smr_oidlen smr_bvoid.bv_len
521 slap_mask_t smr_usage;
524 #define SLAP_MR_HIDE 0x0000U
526 #define SLAP_MR_HIDE 0x8000U
529 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
531 #define SLAP_MR_TYPE_MASK 0x0F00U
532 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
533 #define SLAP_MR_USAGE 0x000FU
535 #define SLAP_MR_NONE 0x0000U
536 #define SLAP_MR_EQUALITY 0x0100U
537 #define SLAP_MR_ORDERING 0x0200U
538 #define SLAP_MR_SUBSTR 0x0400U
539 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
540 #define SLAP_MR_ORDERED_INDEX 0x1000U
541 #ifdef LDAP_COMP_MATCH
542 #define SLAP_MR_COMPONENT 0x2000U
545 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
547 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
548 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
549 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
553 * The asserted value, depending on the particular usage,
554 * is expected to conform to either the assertion syntax
555 * or the attribute syntax. In some cases, the syntax of
556 * the value is known. If so, these flags indicate which
557 * syntax the value is expected to conform to. If not,
558 * neither of these flags is set (until the syntax of the
559 * provided value is determined). If the value is of the
560 * attribute syntax, the flag is changed once a value of
561 * the assertion syntax is derived from the provided value.
563 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
564 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
565 #define SLAP_MR_VALUE_OF_SYNTAX (SLAP_MR_VALUE_OF_ASSERTION_SYNTAX|SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX)
566 #define SLAP_MR_DENORMALIZE (SLAP_MR_MUTATION_NORMALIZER)
568 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
569 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
570 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
571 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
573 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
574 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
576 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
578 #define SLAP_MR_IS_DENORMALIZE( usage ) \
579 ((usage) & SLAP_MR_DENORMALIZE )
581 /* either or both the asserted value or attribute value
582 * may be provided in normalized form
584 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
585 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
587 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
588 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
589 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
590 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
592 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
593 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
594 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
595 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
596 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
597 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
599 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
600 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
601 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
602 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
605 slap_mr_convert_func *smr_convert;
606 slap_mr_normalize_func *smr_normalize;
607 slap_mr_match_func *smr_match;
608 slap_mr_indexer_func *smr_indexer;
609 slap_mr_filter_func *smr_filter;
612 * null terminated array of syntaxes compatible with this syntax
613 * note: when MS_EXT is set, this MUST NOT contain the assertion
614 * syntax of the rule. When MS_EXT is not set, it MAY.
616 Syntax **smr_compat_syntaxes;
619 * For equality rules, refers to an associated approximate rule.
620 * For non-equality rules, refers to an associated equality rule.
622 MatchingRule *smr_associated;
624 #define SLAP_MR_ASSOCIATED(mr,amr) \
625 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
627 LDAP_SLIST_ENTRY(MatchingRule) smr_next;
629 #define smr_oid smr_mrule.mr_oid
630 #define smr_names smr_mrule.mr_names
631 #define smr_desc smr_mrule.mr_desc
632 #define smr_obsolete smr_mrule.mr_obsolete
633 #define smr_syntax_oid smr_mrule.mr_syntax_oid
634 #define smr_extensions smr_mrule.mr_extensions
637 struct MatchingRuleUse {
638 LDAPMatchingRuleUse smru_mruleuse;
639 MatchingRule *smru_mr;
640 /* RFC 4512 string representation */
641 struct berval smru_str;
643 LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next;
645 #define smru_oid smru_mruleuse.mru_oid
646 #define smru_names smru_mruleuse.mru_names
647 #define smru_desc smru_mruleuse.mru_desc
648 #define smru_obsolete smru_mruleuse.mru_obsolete
649 #define smru_applies_oids smru_mruleuse.mru_applies_oids
651 #define smru_usage smru_mr->smr_usage
652 } /* MatchingRuleUse */ ;
654 typedef struct slap_mrule_defs_rec {
656 slap_mask_t mrd_usage;
657 char ** mrd_compat_syntaxes;
658 slap_mr_convert_func * mrd_convert;
659 slap_mr_normalize_func * mrd_normalize;
660 slap_mr_match_func * mrd_match;
661 slap_mr_indexer_func * mrd_indexer;
662 slap_mr_filter_func * mrd_filter;
664 /* For equality rule, this may refer to an associated approximate rule */
665 /* For non-equality rule, this may refer to an associated equality rule */
666 char * mrd_associated;
667 } slap_mrule_defs_rec;
669 typedef int (AttributeTypeSchemaCheckFN)(
674 char *textbuf, size_t textlen );
676 struct AttributeType {
677 LDAPAttributeType sat_atype;
678 struct berval sat_cname;
679 AttributeType *sat_sup;
680 AttributeType **sat_subtypes;
681 MatchingRule *sat_equality;
682 MatchingRule *sat_approx;
683 MatchingRule *sat_ordering;
684 MatchingRule *sat_substr;
687 AttributeTypeSchemaCheckFN *sat_check;
688 char *sat_oidmacro; /* attribute OID */
689 char *sat_soidmacro; /* syntax OID */
691 #define SLAP_AT_NONE 0x0000U
692 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
693 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
695 #define SLAP_AT_HIDE 0x0000U /* publish everything */
697 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
699 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
701 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
703 /* Note: ORDERED values have an ordering specifically set by the
704 * user, denoted by the {x} ordering prefix on the values.
706 * SORTED values are simply sorted by memcmp. SORTED values can
707 * be efficiently located by binary search. ORDERED values have no
708 * such advantage. An attribute cannot have both properties.
710 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
711 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
712 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
714 #define SLAP_AT_SORTED_VAL 0x0010U /* values should be sorted */
716 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
717 #define SLAP_AT_DELETED 0x20000U
719 slap_mask_t sat_flags;
721 LDAP_STAILQ_ENTRY(AttributeType) sat_next;
723 #define sat_oid sat_atype.at_oid
724 #define sat_names sat_atype.at_names
725 #define sat_desc sat_atype.at_desc
726 #define sat_obsolete sat_atype.at_obsolete
727 #define sat_sup_oid sat_atype.at_sup_oid
728 #define sat_equality_oid sat_atype.at_equality_oid
729 #define sat_ordering_oid sat_atype.at_ordering_oid
730 #define sat_substr_oid sat_atype.at_substr_oid
731 #define sat_syntax_oid sat_atype.at_syntax_oid
732 #define sat_single_value sat_atype.at_single_value
733 #define sat_collective sat_atype.at_collective
734 #define sat_no_user_mod sat_atype.at_no_user_mod
735 #define sat_usage sat_atype.at_usage
736 #define sat_extensions sat_atype.at_extensions
738 AttributeDescription *sat_ad;
739 ldap_pvt_thread_mutex_t sat_ad_mutex;
742 #define is_at_operational(at) ((at)->sat_usage)
743 #define is_at_single_value(at) ((at)->sat_single_value)
744 #define is_at_collective(at) ((at)->sat_collective)
745 #define is_at_obsolete(at) ((at)->sat_obsolete)
746 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
748 typedef int (ObjectClassSchemaCheckFN)(
753 char *textbuf, size_t textlen );
756 LDAPObjectClass soc_oclass;
757 struct berval soc_cname;
758 ObjectClass **soc_sups;
759 AttributeType **soc_required;
760 AttributeType **soc_allowed;
761 ObjectClassSchemaCheckFN *soc_check;
763 slap_mask_t soc_flags;
764 #define soc_oid soc_oclass.oc_oid
765 #define soc_names soc_oclass.oc_names
766 #define soc_desc soc_oclass.oc_desc
767 #define soc_obsolete soc_oclass.oc_obsolete
768 #define soc_sup_oids soc_oclass.oc_sup_oids
769 #define soc_kind soc_oclass.oc_kind
770 #define soc_at_oids_must soc_oclass.oc_at_oids_must
771 #define soc_at_oids_may soc_oclass.oc_at_oids_may
772 #define soc_extensions soc_oclass.oc_extensions
774 LDAP_STAILQ_ENTRY(ObjectClass) soc_next;
777 #define SLAP_OCF_SET_FLAGS 0x1
778 #define SLAP_OCF_CHECK_SUP 0x2
779 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
781 #define SLAP_OC_ALIAS 0x0001
782 #define SLAP_OC_REFERRAL 0x0002
783 #define SLAP_OC_SUBENTRY 0x0004
784 #define SLAP_OC_DYNAMICOBJECT 0x0008
785 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
786 #define SLAP_OC_GLUE 0x0020
787 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
788 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
789 #define SLAP_OC__MASK 0x00FF
790 #define SLAP_OC__END 0x0100
791 #define SLAP_OC_OPERATIONAL 0x4000
793 #define SLAP_OC_HIDE 0x0000
795 #define SLAP_OC_HIDE 0x8000
797 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
798 #define SLAP_OC_DELETED 0x20000U
804 LDAPContentRule scr_crule;
805 ObjectClass *scr_sclass;
806 ObjectClass **scr_auxiliaries; /* optional */
807 AttributeType **scr_required; /* optional */
808 AttributeType **scr_allowed; /* optional */
809 AttributeType **scr_precluded; /* optional */
810 #define scr_oid scr_crule.cr_oid
811 #define scr_names scr_crule.cr_names
812 #define scr_desc scr_crule.cr_desc
813 #define scr_obsolete scr_crule.cr_obsolete
814 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
815 #define scr_at_oids_must scr_crule.cr_at_oids_must
816 #define scr_at_oids_may scr_crule.cr_at_oids_may
817 #define scr_at_oids_not scr_crule.cr_at_oids_not
820 #define SLAP_CR_HARDCODE 0x10000U
823 LDAP_STAILQ_ENTRY( ContentRule ) scr_next;
826 /* Represents a recognized attribute description ( type + options ). */
827 struct AttributeDescription {
828 AttributeDescription *ad_next;
829 AttributeType *ad_type; /* attribute type, must be specified */
830 struct berval ad_cname; /* canonical name, must be specified */
831 struct berval ad_tags; /* empty if no tagging options */
833 #define SLAP_DESC_NONE 0x00U
834 #define SLAP_DESC_BINARY 0x01U
835 #define SLAP_DESC_TAG_RANGE 0x80U
836 #define SLAP_DESC_TEMPORARY 0x1000U
839 /* flags to slap_*2undef_ad to register undefined (0, the default)
840 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
841 * SLAP_AD_NOINSERT is to lookup without insert */
842 #define SLAP_AD_UNDEF 0x00U
843 #define SLAP_AD_PROXIED 0x01U
844 #define SLAP_AD_NOINSERT 0x02U
846 struct AttributeName {
847 struct berval an_name;
848 AttributeDescription *an_desc;
853 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
854 #define slap_ad_is_tag_range(ad) \
855 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
856 #define slap_ad_is_binary(ad) \
857 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
860 * pointers to schema elements used internally
862 struct slap_internal_schema {
864 ObjectClass *si_oc_top;
865 ObjectClass *si_oc_extensibleObject;
866 ObjectClass *si_oc_alias;
867 ObjectClass *si_oc_referral;
868 ObjectClass *si_oc_rootdse;
869 ObjectClass *si_oc_subentry;
870 ObjectClass *si_oc_subschema;
871 ObjectClass *si_oc_collectiveAttributeSubentry;
872 ObjectClass *si_oc_dynamicObject;
874 ObjectClass *si_oc_glue;
875 ObjectClass *si_oc_syncConsumerSubentry;
876 ObjectClass *si_oc_syncProviderSubentry;
878 /* objectClass attribute descriptions */
879 AttributeDescription *si_ad_objectClass;
881 /* operational attribute descriptions */
882 AttributeDescription *si_ad_structuralObjectClass;
883 AttributeDescription *si_ad_creatorsName;
884 AttributeDescription *si_ad_createTimestamp;
885 AttributeDescription *si_ad_modifiersName;
886 AttributeDescription *si_ad_modifyTimestamp;
887 AttributeDescription *si_ad_hasSubordinates;
888 AttributeDescription *si_ad_subschemaSubentry;
889 AttributeDescription *si_ad_collectiveSubentries;
890 AttributeDescription *si_ad_collectiveExclusions;
891 AttributeDescription *si_ad_entryDN;
892 AttributeDescription *si_ad_entryUUID;
893 AttributeDescription *si_ad_entryCSN;
894 AttributeDescription *si_ad_namingCSN;
896 AttributeDescription *si_ad_dseType;
897 AttributeDescription *si_ad_syncreplCookie;
898 AttributeDescription *si_ad_syncTimestamp;
899 AttributeDescription *si_ad_contextCSN;
901 /* root DSE attribute descriptions */
902 AttributeDescription *si_ad_altServer;
903 AttributeDescription *si_ad_namingContexts;
904 AttributeDescription *si_ad_supportedControl;
905 AttributeDescription *si_ad_supportedExtension;
906 AttributeDescription *si_ad_supportedLDAPVersion;
907 AttributeDescription *si_ad_supportedSASLMechanisms;
908 AttributeDescription *si_ad_supportedFeatures;
909 AttributeDescription *si_ad_monitorContext;
910 AttributeDescription *si_ad_vendorName;
911 AttributeDescription *si_ad_vendorVersion;
912 AttributeDescription *si_ad_configContext;
914 /* subentry attribute descriptions */
915 AttributeDescription *si_ad_administrativeRole;
916 AttributeDescription *si_ad_subtreeSpecification;
918 /* subschema subentry attribute descriptions */
919 AttributeDescription *si_ad_attributeTypes;
920 AttributeDescription *si_ad_ditContentRules;
921 AttributeDescription *si_ad_ditStructureRules;
922 AttributeDescription *si_ad_ldapSyntaxes;
923 AttributeDescription *si_ad_matchingRules;
924 AttributeDescription *si_ad_matchingRuleUse;
925 AttributeDescription *si_ad_nameForms;
926 AttributeDescription *si_ad_objectClasses;
928 /* Aliases & Referrals */
929 AttributeDescription *si_ad_aliasedObjectName;
930 AttributeDescription *si_ad_ref;
932 /* Access Control Internals */
933 AttributeDescription *si_ad_entry;
934 AttributeDescription *si_ad_children;
935 AttributeDescription *si_ad_saslAuthzTo;
936 AttributeDescription *si_ad_saslAuthzFrom;
938 /* dynamic entries */
939 AttributeDescription *si_ad_entryTtl;
940 AttributeDescription *si_ad_dynamicSubtrees;
942 /* Other attributes descriptions */
943 AttributeDescription *si_ad_distinguishedName;
944 AttributeDescription *si_ad_name;
945 AttributeDescription *si_ad_cn;
946 AttributeDescription *si_ad_uid;
947 AttributeDescription *si_ad_uidNumber;
948 AttributeDescription *si_ad_gidNumber;
949 AttributeDescription *si_ad_userPassword;
950 AttributeDescription *si_ad_labeledURI;
951 #ifdef SLAPD_AUTHPASSWD
952 AttributeDescription *si_ad_authPassword;
953 AttributeDescription *si_ad_authPasswordSchemes;
955 AttributeDescription *si_ad_description;
956 AttributeDescription *si_ad_seeAlso;
958 /* Undefined Attribute Type */
959 AttributeType *si_at_undefined;
961 /* "Proxied" Attribute Type */
962 AttributeType *si_at_proxied;
965 MatchingRule *si_mr_distinguishedNameMatch;
966 MatchingRule *si_mr_dnSubtreeMatch;
967 MatchingRule *si_mr_dnOneLevelMatch;
968 MatchingRule *si_mr_dnSubordinateMatch;
969 MatchingRule *si_mr_dnSuperiorMatch;
970 MatchingRule *si_mr_caseExactMatch;
971 MatchingRule *si_mr_caseExactSubstringsMatch;
972 MatchingRule *si_mr_caseExactIA5Match;
973 MatchingRule *si_mr_integerMatch;
974 MatchingRule *si_mr_integerFirstComponentMatch;
975 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
976 MatchingRule *si_mr_caseIgnoreMatch;
977 MatchingRule *si_mr_caseIgnoreListMatch;
980 Syntax *si_syn_directoryString;
981 Syntax *si_syn_distinguishedName;
982 Syntax *si_syn_integer;
983 Syntax *si_syn_octetString;
985 /* Schema Syntaxes */
986 Syntax *si_syn_attributeTypeDesc;
987 Syntax *si_syn_ditContentRuleDesc;
988 Syntax *si_syn_ditStructureRuleDesc;
989 Syntax *si_syn_ldapSyntaxDesc;
990 Syntax *si_syn_matchingRuleDesc;
991 Syntax *si_syn_matchingRuleUseDesc;
992 Syntax *si_syn_nameFormDesc;
993 Syntax *si_syn_objectClassDesc;
996 struct AttributeAssertion {
997 AttributeDescription *aa_desc;
998 struct berval aa_value;
999 #ifdef LDAP_COMP_MATCH
1000 ComponentFilter *aa_cf; /* for attribute aliasing */
1003 #ifdef LDAP_COMP_MATCH
1004 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL, NULL }
1006 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL }
1009 struct SubstringsAssertion {
1010 AttributeDescription *sa_desc;
1011 struct berval sa_initial;
1012 struct berval *sa_any;
1013 struct berval sa_final;
1016 struct MatchingRuleAssertion {
1017 AttributeDescription *ma_desc; /* optional */
1018 struct berval ma_value; /* required */
1019 MatchingRule *ma_rule; /* optional */
1020 struct berval ma_rule_text; /* optional */
1021 int ma_dnattrs; /* boolean */
1022 #ifdef LDAP_COMP_MATCH
1023 ComponentFilter *ma_cf; /* component filter */
1028 * represents a search filter
1031 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
1032 #define SLAPD_FILTER_COMPUTED 0
1033 #define SLAPD_FILTER_MASK 0x7fff
1034 #define SLAPD_FILTER_UNDEFINED 0x8000
1037 /* precomputed result */
1038 ber_int_t f_un_result;
1041 AttributeDescription *f_un_desc;
1043 /* simple value assertion */
1044 AttributeAssertion *f_un_ava;
1046 /* substring assertion */
1047 SubstringsAssertion *f_un_ssa;
1049 /* matching rule assertion */
1050 MatchingRuleAssertion *f_un_mra;
1052 #define f_desc f_un.f_un_desc
1053 #define f_ava f_un.f_un_ava
1054 #define f_av_desc f_un.f_un_ava->aa_desc
1055 #define f_av_value f_un.f_un_ava->aa_value
1056 #define f_sub f_un.f_un_ssa
1057 #define f_sub_desc f_un.f_un_ssa->sa_desc
1058 #define f_sub_initial f_un.f_un_ssa->sa_initial
1059 #define f_sub_any f_un.f_un_ssa->sa_any
1060 #define f_sub_final f_un.f_un_ssa->sa_final
1061 #define f_mra f_un.f_un_mra
1062 #define f_mr_rule f_un.f_un_mra->ma_rule
1063 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1064 #define f_mr_desc f_un.f_un_mra->ma_desc
1065 #define f_mr_value f_un.f_un_mra->ma_value
1066 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1069 Filter *f_un_complex;
1072 #define f_result f_un.f_un_result
1073 #define f_and f_un.f_un_complex
1074 #define f_or f_un.f_un_complex
1075 #define f_not f_un.f_un_complex
1076 #define f_list f_un.f_un_complex
1081 /* compare routines can return undefined */
1082 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1084 struct ValuesReturnFilter {
1085 ber_tag_t vrf_choice;
1088 /* precomputed result */
1089 ber_int_t vrf_un_result;
1095 AttributeDescription *vrf_un_desc;
1097 /* simple value assertion */
1098 AttributeAssertion *vrf_un_ava;
1100 /* substring assertion */
1101 SubstringsAssertion *vrf_un_ssa;
1103 /* matching rule assertion */
1104 MatchingRuleAssertion *vrf_un_mra;
1106 #define vrf_result vrf_un.vrf_un_result
1107 #define vrf_dn vrf_un.vrf_un_dn
1108 #define vrf_desc vrf_un.vrf_un_desc
1109 #define vrf_ava vrf_un.vrf_un_ava
1110 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1111 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1112 #define vrf_ssa vrf_un.vrf_un_ssa
1113 #define vrf_sub vrf_un.vrf_un_ssa
1114 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1115 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1116 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1117 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1118 #define vrf_mra vrf_un.vrf_un_mra
1119 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1120 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1121 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1122 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1123 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1128 ValuesReturnFilter *vrf_next;
1132 * represents an attribute (description + values)
1133 * desc, vals, nvals, numvals fields must align with Modification
1136 AttributeDescription *a_desc;
1137 BerVarray a_vals; /* preserved values */
1138 BerVarray a_nvals; /* normalized values */
1139 unsigned a_numvals; /* number of vals */
1141 #define SLAP_ATTR_IXADD 0x1U
1142 #define SLAP_ATTR_IXDEL 0x2U
1143 #define SLAP_ATTR_DONT_FREE_DATA 0x4U
1144 #define SLAP_ATTR_DONT_FREE_VALS 0x8U
1145 #define SLAP_ATTR_SORTED_VALS 0x10U /* values are sorted */
1147 /* These flags persist across an attr_dup() */
1148 #define SLAP_ATTR_PERSISTENT_FLAGS \
1149 SLAP_ATTR_SORTED_VALS
1152 #ifdef LDAP_COMP_MATCH
1153 ComponentData *a_comp_data; /* component values */
1159 * the id used in the indexes to refer to an entry
1161 typedef unsigned long ID;
1162 #define NOID ((ID)~0)
1164 typedef struct EntryHeader {
1172 * represents an entry in core
1176 * The ID field should only be changed before entry is
1177 * inserted into a cache. The ID value is backend
1182 struct berval e_name; /* name (DN) of this entry */
1183 struct berval e_nname; /* normalized name (DN) of this entry */
1185 /* for migration purposes */
1186 #define e_dn e_name.bv_val
1187 #define e_ndn e_nname.bv_val
1189 Attribute *e_attrs; /* list of attributes + values */
1191 slap_mask_t e_ocflags;
1193 struct berval e_bv; /* For entry_encode/entry_decode */
1195 /* for use by the backend for any purpose */
1200 * A list of LDAPMods
1201 * desc, values, nvalues, numvals must align with Attribute
1203 struct Modification {
1204 AttributeDescription *sm_desc;
1205 BerVarray sm_values;
1206 BerVarray sm_nvalues;
1207 unsigned sm_numvals;
1210 /* Set for internal mods, will bypass ACL checks. Only needed when
1211 * running as non-root user, for user modifiable attributes.
1213 #define SLAP_MOD_INTERNAL 0x01
1214 #define SLAP_MOD_MANAGING 0x02
1215 struct berval sm_type;
1218 struct Modifications {
1219 Modification sml_mod;
1220 #define sml_op sml_mod.sm_op
1221 #define sml_flags sml_mod.sm_flags
1222 #define sml_desc sml_mod.sm_desc
1223 #define sml_type sml_mod.sm_type
1224 #define sml_values sml_mod.sm_values
1225 #define sml_nvalues sml_mod.sm_nvalues
1226 #define sml_numvals sml_mod.sm_numvals
1227 Modifications *sml_next;
1231 * represents an access control list
1233 typedef enum slap_access_t {
1234 ACL_INVALID_ACCESS = -1,
1244 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1247 /* ACL level mask and modifiers */
1248 ACL_LEVEL_MASK = 0x000f,
1249 ACL_QUALIFIER1 = 0x0100,
1250 ACL_QUALIFIER2 = 0x0200,
1251 ACL_QUALIFIER3 = 0x0400,
1252 ACL_QUALIFIER4 = 0x0800,
1253 ACL_QUALIFIER_MASK = 0x0f00,
1255 /* write granularity */
1256 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1257 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1259 ACL_WRITE = ACL_WADD|ACL_WDEL
1262 typedef enum slap_control_e {
1263 ACL_INVALID_CONTROL = 0,
1269 typedef enum slap_style_e {
1270 ACL_STYLE_REGEX = 0,
1278 ACL_STYLE_ANONYMOUS,
1286 typedef struct AuthorizationInformation {
1287 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1288 struct berval sai_mech; /* SASL Mechanism */
1289 struct berval sai_dn; /* DN for reporting purposes */
1290 struct berval sai_ndn; /* Normalized DN */
1292 /* Security Strength Factors */
1293 slap_ssf_t sai_ssf; /* Overall SSF */
1294 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1295 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1296 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1297 } AuthorizationInformation;
1302 * "dynamic" ACL infrastructure (for ACIs and more)
1304 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1305 const char *opts, slap_style_t, const char *, void **privp ));
1306 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1307 typedef int (slap_dynacl_mask) LDAP_P((
1311 AttributeDescription *desc,
1314 regmatch_t *matches,
1315 slap_access_t *grant,
1316 slap_access_t *deny ));
1317 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1319 typedef struct slap_dynacl_t {
1321 slap_dynacl_parse *da_parse;
1322 slap_dynacl_unparse *da_unparse;
1323 slap_dynacl_mask *da_mask;
1324 slap_dynacl_destroy *da_destroy;
1327 struct slap_dynacl_t *da_next;
1329 #endif /* SLAP_DYNACL */
1331 /* the DN portion of the "by" part */
1332 typedef struct slap_dn_access {
1334 AuthorizationInformation a_dnauthz;
1335 #define a_pat a_dnauthz.sai_dn
1337 slap_style_t a_style;
1340 AttributeDescription *a_at;
1346 typedef struct Access {
1347 slap_control_t a_type;
1349 /* strip qualifiers */
1350 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1351 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1353 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1355 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1356 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1357 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1358 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1359 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1360 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1361 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1362 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1363 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1364 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1366 /* NOTE: always use the highest level; current: 0x00ffUL */
1367 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1370 #define ACL_PRIV_LEVEL 0x1000UL
1371 #define ACL_PRIV_ADDITIVE 0x2000UL
1372 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1375 #define ACL_PRIV_INVALID 0x0UL
1377 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1378 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1379 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1380 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1382 #define ACL_INIT(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_NONE)
1383 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_INVALID)
1385 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1387 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1389 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1390 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1391 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1393 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1394 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1395 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1396 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1397 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1398 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1399 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1400 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1401 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1402 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1404 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1405 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1406 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1407 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1408 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1409 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1410 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1411 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1412 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1413 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1414 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1416 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1417 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1418 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1419 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1420 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1421 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1422 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1423 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1424 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1425 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1427 slap_mask_t a_access_mask;
1430 slap_dn_access a_dn;
1431 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1432 #define a_dn_at a_dn.a_at
1433 #define a_dn_self a_dn.a_self
1435 /* real DN pattern */
1436 slap_dn_access a_realdn;
1437 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1438 #define a_realdn_at a_realdn.a_at
1439 #define a_realdn_self a_realdn.a_self
1441 /* used for ssf stuff
1442 * NOTE: the ssf stuff in a_realdn is ignored */
1443 #define a_authz a_dn.a_dnauthz
1445 /* connection related stuff */
1446 slap_style_t a_peername_style;
1447 struct berval a_peername_pat;
1448 #ifdef LDAP_PF_INET6
1450 struct in6_addr ax6;
1454 #define a_peername_addr6 ax_peername_addr.ax6
1455 #define a_peername_addr ax_peername_addr.ax
1456 #define a_peername_mask6 ax_peername_mask.ax6
1457 #define a_peername_mask ax_peername_mask.ax
1458 /* apparently, only s6_addr is portable;
1459 * define a portable address mask comparison */
1460 #define slap_addr6_mask(val, msk, asr) ( \
1461 (((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \
1462 && (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \
1463 && (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \
1464 && (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \
1465 && (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \
1466 && (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \
1467 && (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \
1468 && (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \
1469 && (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \
1470 && (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \
1471 && (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \
1472 && (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \
1473 && (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \
1474 && (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \
1475 && (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \
1476 && (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \
1478 #else /* ! LDAP_PF_INET6 */
1479 unsigned long a_peername_addr,
1481 #endif /* ! LDAP_PF_INET6 */
1482 int a_peername_port;
1484 slap_style_t a_sockname_style;
1485 struct berval a_sockname_pat;
1487 slap_style_t a_domain_style;
1488 struct berval a_domain_pat;
1489 int a_domain_expand;
1491 slap_style_t a_sockurl_style;
1492 struct berval a_sockurl_pat;
1493 slap_style_t a_set_style;
1494 struct berval a_set_pat;
1497 slap_dynacl_t *a_dynacl;
1498 #endif /* SLAP_DYNACL */
1501 slap_style_t a_group_style;
1502 struct berval a_group_pat;
1503 ObjectClass *a_group_oc;
1504 AttributeDescription *a_group_at;
1506 struct Access *a_next;
1510 typedef struct AccessControl {
1511 /* "to" part: the entries this acl applies to */
1513 slap_style_t acl_dn_style;
1515 struct berval acl_dn_pat;
1516 AttributeName *acl_attrs;
1517 MatchingRule *acl_attrval_mr;
1518 slap_style_t acl_attrval_style;
1519 regex_t acl_attrval_re;
1520 struct berval acl_attrval;
1522 /* "by" part: list of who has what access to the entries */
1525 struct AccessControl *acl_next;
1529 ACL_STATE_NOT_RECORDED = 0x0,
1530 ACL_STATE_RECORDED_VD = 0x1,
1531 ACL_STATE_RECORDED_NV = 0x2,
1532 ACL_STATE_RECORDED = ( ACL_STATE_RECORDED_VD | ACL_STATE_RECORDED_NV )
1535 typedef struct AccessControlState {
1537 AccessControl *as_vi_acl;
1538 AccessControl *as_vd_acl;
1539 AttributeDescription *as_vd_ad;
1542 slap_acl_state_t as_recorded;
1543 int as_vd_acl_count;
1546 } AccessControlState;
1547 #define ACL_STATE_INIT { NULL, NULL, NULL, \
1548 ACL_STATE_NOT_RECORDED, 0, 0, 0 }
1550 typedef struct AclRegexMatches {
1552 regmatch_t dn_data[MAXREMATCHES];
1554 regmatch_t val_data[MAXREMATCHES];
1559 * represents a backend
1562 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head;
1563 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head;
1565 LDAP_SLAPD_V (int) nBackendInfo;
1566 LDAP_SLAPD_V (int) nBackendDB;
1567 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1568 LDAP_SLAPD_V (slap_be_head) backendDB;
1569 LDAP_SLAPD_V (BackendDB *) frontendDB;
1571 LDAP_SLAPD_V (int) slapMode;
1572 #define SLAP_UNDEFINED_MODE 0x0000
1573 #define SLAP_SERVER_MODE 0x0001
1574 #define SLAP_TOOL_MODE 0x0002
1575 #define SLAP_MODE 0x0003
1577 #define SLAP_TRUNCATE_MODE 0x0100
1578 #define SLAP_TOOL_READMAIN 0x0200
1579 #define SLAP_TOOL_READONLY 0x0400
1580 #define SLAP_TOOL_QUICK 0x0800
1581 #define SLAP_TOOL_NO_SCHEMA_CHECK 0x1000
1583 #define SB_TLS_DEFAULT (-1)
1584 #define SB_TLS_OFF 0
1586 #define SB_TLS_CRITICAL 2
1588 typedef struct slap_bindconf {
1589 struct berval sb_uri;
1595 struct berval sb_binddn;
1596 struct berval sb_cred;
1597 struct berval sb_saslmech;
1599 struct berval sb_realm;
1600 struct berval sb_authcId;
1601 struct berval sb_authzId;
1606 char *sb_tls_cacert;
1607 char *sb_tls_cacertdir;
1608 char *sb_tls_reqcert;
1609 char *sb_tls_cipher_suite;
1610 #ifdef HAVE_OPENSSL_CRL
1611 char *sb_tls_crlcheck;
1617 typedef struct slap_verbmasks {
1619 const slap_mask_t mask;
1622 typedef struct slap_cf_aux_table {
1628 } slap_cf_aux_table;
1630 #define SLAP_LIMIT_TIME 1
1631 #define SLAP_LIMIT_SIZE 2
1633 struct slap_limits_set {
1641 int lms_s_unchecked;
1647 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1648 #define SLAP_NO_LIMIT -1
1649 #define SLAP_MAX_LIMIT 2147483647
1651 struct slap_limits {
1652 unsigned lm_flags; /* type of pattern */
1653 /* Values must match lmpats[] in limits.c */
1654 #define SLAP_LIMITS_UNDEFINED 0x0000U
1655 #define SLAP_LIMITS_EXACT 0x0001U
1656 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1657 #define SLAP_LIMITS_ONE 0x0002U
1658 #define SLAP_LIMITS_SUBTREE 0x0003U
1659 #define SLAP_LIMITS_CHILDREN 0x0004U
1660 #define SLAP_LIMITS_REGEX 0x0005U
1661 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1662 #define SLAP_LIMITS_USERS 0x0007U
1663 #define SLAP_LIMITS_ANY 0x0008U
1664 #define SLAP_LIMITS_MASK 0x000FU
1666 #define SLAP_LIMITS_TYPE_SELF 0x0000U
1667 #define SLAP_LIMITS_TYPE_DN SLAP_LIMITS_TYPE_SELF
1668 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1669 #define SLAP_LIMITS_TYPE_THIS 0x0020U
1670 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1672 regex_t lm_regex; /* regex data for REGEX */
1675 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1676 * pattern for REGEX; NULL for ANONYMOUS, USERS
1678 struct berval lm_pat;
1680 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1681 * lm_group_oc is objectClass and lm_group_at is attributeType
1682 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1683 * can only be SLAP_LIMITS_EXACT */
1684 ObjectClass *lm_group_oc;
1685 AttributeDescription *lm_group_ad;
1687 struct slap_limits_set lm_limits;
1690 /* temporary aliases */
1691 typedef BackendDB Backend;
1692 #define nbackends nBackendDB
1693 #define backends backendDB
1696 * syncinfo structure for syncrepl
1701 #define SLAP_SYNC_RID_MAX 999
1702 #define SLAP_SYNC_SID_MAX 4095 /* based on liblutil/csn.c field width */
1703 #define SLAP_SYNCUUID_SET_SIZE 256
1705 struct sync_cookie {
1706 struct berval *ctxcsn;
1707 struct berval octet_str;
1712 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1715 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1717 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1719 #ifndef SLAP_MAX_CIDS
1720 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1723 struct ConfigOCs; /* config.h */
1726 BackendInfo *bd_info; /* pointer to shared backend info */
1727 BackendDB *bd_self; /* pointer to this struct */
1729 /* fields in this structure (and routines acting on this structure)
1730 should be renamed from be_ to bd_ */
1732 /* BackendInfo accessors */
1733 #define be_config bd_info->bi_db_config
1734 #define be_type bd_info->bi_type
1736 #define be_bind bd_info->bi_op_bind
1737 #define be_unbind bd_info->bi_op_unbind
1738 #define be_add bd_info->bi_op_add
1739 #define be_compare bd_info->bi_op_compare
1740 #define be_delete bd_info->bi_op_delete
1741 #define be_modify bd_info->bi_op_modify
1742 #define be_modrdn bd_info->bi_op_modrdn
1743 #define be_search bd_info->bi_op_search
1744 #define be_abandon bd_info->bi_op_abandon
1746 #define be_extended bd_info->bi_extended
1747 #define be_cancel bd_info->bi_op_cancel
1749 #define be_chk_referrals bd_info->bi_chk_referrals
1750 #define be_chk_controls bd_info->bi_chk_controls
1751 #define be_fetch bd_info->bi_entry_get_rw
1752 #define be_release bd_info->bi_entry_release_rw
1753 #define be_group bd_info->bi_acl_group
1754 #define be_attribute bd_info->bi_acl_attribute
1755 #define be_operational bd_info->bi_operational
1758 * define to honor hasSubordinates operational attribute in search filters
1759 * (in previous use there was a flaw with back-bdb; now it is fixed).
1761 #define be_has_subordinates bd_info->bi_has_subordinates
1763 #define be_connection_init bd_info->bi_connection_init
1764 #define be_connection_destroy bd_info->bi_connection_destroy
1767 #define be_entry_open bd_info->bi_tool_entry_open
1768 #define be_entry_close bd_info->bi_tool_entry_close
1769 #define be_entry_first bd_info->bi_tool_entry_first
1770 #define be_entry_next bd_info->bi_tool_entry_next
1771 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1772 #define be_entry_get bd_info->bi_tool_entry_get
1773 #define be_entry_put bd_info->bi_tool_entry_put
1774 #define be_sync bd_info->bi_tool_sync
1775 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1776 #define be_entry_modify bd_info->bi_tool_entry_modify
1779 /* supported controls */
1780 /* note: set to 0 if the database does not support the control;
1781 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1782 char be_ctrls[SLAP_MAX_CIDS + 1];
1784 /* Database flags */
1785 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1786 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1787 #define SLAP_DBFLAG_HIDDEN 0x0004U
1788 #define SLAP_DBFLAG_ONE_SUFFIX 0x0008U
1789 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1790 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1791 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1792 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1793 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1794 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1795 #define SLAP_DBFLAG_DYNAMIC 0x0400U /* this db allows dynamicObjects */
1796 #define SLAP_DBFLAG_MONITORING 0x0800U /* custom monitoring enabled */
1797 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1798 #define SLAP_DBFLAG_SINGLE_SHADOW 0x4000U /* a single-master shadow */
1799 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1800 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1801 #define SLAP_DBFLAG_SHADOW_MASK (SLAP_DBFLAG_SHADOW|SLAP_DBFLAG_SINGLE_SHADOW|SLAP_DBFLAG_SYNC_SHADOW|SLAP_DBFLAG_SLURP_SHADOW)
1802 #define SLAP_DBFLAG_CLEAN 0x10000U /* was cleanly shutdown */
1803 #define SLAP_DBFLAG_ACL_ADD 0x20000U /* check attr ACLs on adds */
1804 slap_mask_t be_flags;
1805 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1806 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1807 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1808 #define SLAP_DBHIDDEN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN)
1809 #define SLAP_DB_ONE_SUFFIX(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ONE_SUFFIX)
1810 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1811 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1812 #define SLAP_DBMONITORING(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING)
1813 #define SLAP_NO_SCHEMA_CHECK(be) \
1814 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1815 #define SLAP_GLUE_INSTANCE(be) \
1816 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1817 #define SLAP_GLUE_SUBORDINATE(be) \
1818 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1819 #define SLAP_GLUE_LINKED(be) \
1820 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1821 #define SLAP_GLUE_ADVERTISE(be) \
1822 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1823 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1824 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1825 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1826 #define SLAP_SINGLE_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW)
1827 #define SLAP_MULTIMASTER(be) (!SLAP_SINGLE_SHADOW(be))
1828 #define SLAP_DBCLEAN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_CLEAN)
1829 #define SLAP_DBACL_ADD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ACL_ADD)
1831 slap_mask_t be_restrictops; /* restriction operations */
1832 #define SLAP_RESTRICT_OP_ADD 0x0001U
1833 #define SLAP_RESTRICT_OP_BIND 0x0002U
1834 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1835 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1836 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1837 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1838 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1839 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1840 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1842 #define SLAP_RESTRICT_READONLY 0x80000000U
1844 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1845 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1846 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1847 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1848 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1850 #define SLAP_RESTRICT_OP_READS \
1851 ( SLAP_RESTRICT_OP_COMPARE \
1852 | SLAP_RESTRICT_OP_SEARCH )
1853 #define SLAP_RESTRICT_OP_WRITES \
1854 ( SLAP_RESTRICT_OP_ADD \
1855 | SLAP_RESTRICT_OP_DELETE \
1856 | SLAP_RESTRICT_OP_MODIFY \
1857 | SLAP_RESTRICT_OP_RENAME )
1858 #define SLAP_RESTRICT_OP_ALL \
1859 ( SLAP_RESTRICT_OP_READS \
1860 | SLAP_RESTRICT_OP_WRITES \
1861 | SLAP_RESTRICT_OP_BIND \
1862 | SLAP_RESTRICT_OP_EXTENDED )
1864 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1865 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1866 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1868 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1869 #define SLAP_ALLOW_PROXY_AUTHZ_ANON 0x0010U /* allow anonymous proxyAuthz */
1871 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1872 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1874 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1875 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1877 #define SLAP_DISALLOW_PROXY_AUTHZ_N_CRIT 0x0100U
1878 #define SLAP_DISALLOW_DONTUSECOPY_N_CRIT 0x0200U
1880 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1882 slap_mask_t be_requires; /* pre-operation requirements */
1883 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1884 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1885 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1886 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1887 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1889 /* Required Security Strength Factor */
1890 slap_ssf_set_t be_ssf_set;
1892 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1893 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1894 struct berval be_schemadn; /* per-backend subschema subentry DN */
1895 struct berval be_schemandn; /* normalized subschema DN */
1896 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1897 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1898 struct berval be_rootpw; /* the magic "root" password for this db */
1899 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1900 #define be_sizelimit be_def_limit.lms_s_soft
1901 #define be_timelimit be_def_limit.lms_t_soft
1902 struct slap_limits_set be_def_limit; /* default limits */
1903 struct slap_limits **be_limits; /* regex-based size and time limits */
1904 AccessControl *be_acl; /* access control list for this backend */
1905 slap_access_t be_dfltaccess; /* access given if no acl matches */
1907 /* Replica Information */
1908 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1909 BerVarray be_update_refs; /* where to refer modifying clients to */
1910 struct be_pcl *be_pending_csn_list;
1911 ldap_pvt_thread_mutex_t be_pcl_mutex;
1912 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1914 void *be_pb; /* Netscape plugin */
1915 struct ConfigOCs *be_cf_ocs;
1917 void *be_private; /* anything the backend database needs */
1918 LDAP_STAILQ_ENTRY(BackendDB) be_next;
1921 /* Backend function typedefs */
1922 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1923 typedef BI_bi_func BI_init;
1924 typedef BI_bi_func BI_open;
1925 typedef BI_bi_func BI_close;
1926 typedef BI_bi_func BI_destroy;
1927 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1928 const char *fname, int lineno,
1929 int argc, char **argv));
1931 typedef struct config_reply_s ConfigReply; /* config.h */
1932 typedef int (BI_db_func) LDAP_P((Backend *bd, ConfigReply *cr));
1933 typedef BI_db_func BI_db_init;
1934 typedef BI_db_func BI_db_open;
1935 typedef BI_db_func BI_db_close;
1936 typedef BI_db_func BI_db_destroy;
1937 typedef int (BI_db_config) LDAP_P((Backend *bd,
1938 const char *fname, int lineno,
1939 int argc, char **argv));
1941 typedef struct req_bind_s {
1943 struct berval rb_cred;
1944 struct berval rb_edn;
1946 struct berval rb_mech;
1949 typedef struct req_search_s {
1954 /* NULL means be_isroot evaluated to TRUE */
1955 struct slap_limits_set *rs_limit;
1957 AttributeName *rs_attrs;
1959 struct berval rs_filterstr;
1962 typedef struct req_compare_s {
1963 AttributeAssertion *rs_ava;
1966 typedef struct req_modifications_s {
1967 Modifications *rs_modlist;
1968 char rs_no_opattrs; /* don't att modify operational attrs */
1969 } req_modifications_s;
1971 typedef struct req_modify_s {
1972 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1976 typedef struct req_modrdn_s {
1977 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1978 int rs_deleteoldrdn;
1979 struct berval rs_newrdn;
1980 struct berval rs_nnewrdn;
1981 struct berval *rs_newSup;
1982 struct berval *rs_nnewSup;
1985 typedef struct req_add_s {
1986 Modifications *rs_modlist;
1990 typedef struct req_abandon_s {
1995 #define SLAP_EXOP_HIDE 0x0000
1997 #define SLAP_EXOP_HIDE 0x8000
1999 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
2001 typedef struct req_extended_s {
2002 struct berval rs_reqoid;
2004 struct berval *rs_reqdata;
2007 typedef struct req_pwdexop_s {
2008 struct req_extended_s rs_extended;
2009 struct berval rs_old;
2010 struct berval rs_new;
2011 Modifications *rs_mods;
2012 Modifications **rs_modtail;
2015 typedef enum slap_reply_e {
2025 typedef struct rep_sasl_s {
2026 struct berval *r_sasldata;
2029 typedef struct rep_extended_s {
2030 const char *r_rspoid;
2031 struct berval *r_rspdata;
2034 typedef struct rep_search_s {
2036 slap_mask_t r_attr_flags;
2037 #define SLAP_ATTRS_UNDEFINED (0x00U)
2038 #define SLAP_OPATTRS_NO (0x01U)
2039 #define SLAP_OPATTRS_YES (0x02U)
2040 #define SLAP_USERATTRS_NO (0x10U)
2041 #define SLAP_USERATTRS_YES (0x20U)
2042 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
2043 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
2044 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
2045 #define SLAP_USERATTRS(f) \
2046 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
2048 Attribute *r_operational_attrs;
2049 AttributeName *r_attrs;
2055 slap_reply_t sr_type;
2059 const char *sr_matched;
2060 const char *sr_text;
2062 LDAPControl **sr_ctrls;
2064 rep_sasl_s sru_sasl;
2065 rep_extended_s sru_extended;
2066 rep_search_s sru_search;
2068 slap_mask_t sr_flags;
2069 #define REP_ENTRY_MODIFIABLE 0x0001U
2070 #define REP_ENTRY_MUSTBEFREED 0x0002U
2071 #define REP_ENTRY_MUSTRELEASE 0x0004U
2072 #define REP_ENTRY_MASK (REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2074 #define REP_MATCHED_MUSTBEFREED 0x0010U
2075 #define REP_MATCHED_MASK (REP_MATCHED_MUSTBEFREED)
2077 #define REP_REF_MUSTBEFREED 0x0020U
2078 #define REP_REF_MASK (REP_REF_MUSTBEFREED)
2080 #define REP_CTRLS_MUSTBEFREED 0x0040U
2081 #define REP_CTRLS_MASK (REP_CTRLS_MUSTBEFREED)
2083 #define REP_NO_ENTRYDN 0x1000U
2084 #define REP_NO_SUBSCHEMA 0x2000U
2085 #define REP_NO_OPERATIONALS (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2088 /* short hands for response members */
2089 #define sr_attrs sr_un.sru_search.r_attrs
2090 #define sr_entry sr_un.sru_search.r_entry
2091 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2092 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2093 #define sr_v2ref sr_un.sru_search.r_v2ref
2094 #define sr_nentries sr_un.sru_search.r_nentries
2095 #define sr_rspoid sr_un.sru_extended.r_rspoid
2096 #define sr_rspdata sr_un.sru_extended.r_rspdata
2097 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2099 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs ));
2100 typedef BI_op_func BI_op_bind;
2101 typedef BI_op_func BI_op_unbind;
2102 typedef BI_op_func BI_op_search;
2103 typedef BI_op_func BI_op_compare;
2104 typedef BI_op_func BI_op_modify;
2105 typedef BI_op_func BI_op_modrdn;
2106 typedef BI_op_func BI_op_add;
2107 typedef BI_op_func BI_op_delete;
2108 typedef BI_op_func BI_op_abandon;
2109 typedef BI_op_func BI_op_extended;
2110 typedef BI_op_func BI_op_cancel;
2111 typedef BI_op_func BI_chk_referrals;
2112 typedef BI_op_func BI_chk_controls;
2113 typedef int (BI_entry_release_rw)
2114 LDAP_P(( Operation *op, Entry *e, int rw ));
2115 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn,
2116 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2117 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs ));
2118 typedef int (BI_has_subordinates) LDAP_P(( Operation *op,
2119 Entry *e, int *hasSubs ));
2120 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e,
2121 AttributeDescription *desc, struct berval *val, slap_access_t access,
2122 AccessControlState *state, slap_mask_t *maskp ));
2123 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target,
2124 struct berval *gr_ndn, struct berval *op_ndn,
2125 ObjectClass *group_oc, AttributeDescription *group_at ));
2126 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target,
2127 struct berval *entry_ndn, AttributeDescription *entry_at,
2128 BerVarray *vals, slap_access_t access ));
2130 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c ));
2131 typedef BI_conn_func BI_connection_init;
2132 typedef BI_conn_func BI_connection_destroy;
2134 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2135 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2136 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2137 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2138 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2139 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2140 struct berval *text ));
2141 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv ));
2142 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2143 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2144 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2145 struct berval *text ));
2147 struct BackendInfo {
2148 char *bi_type; /* type of backend */
2151 * per backend type routines:
2152 * bi_init: called to allocate a backend_info structure,
2153 * called once BEFORE configuration file is read.
2154 * bi_init() initializes this structure hence is
2155 * called directly from be_initialize()
2156 * bi_config: called per 'backend' specific option
2157 * all such options must before any 'database' options
2158 * bi_config() is called only from read_config()
2159 * bi_open: called to open each database, called
2160 * once AFTER configuration file is read but
2161 * BEFORE any bi_db_open() calls.
2162 * bi_open() is called from backend_startup()
2163 * bi_close: called to close each database, called
2164 * once during shutdown after all bi_db_close calls.
2165 * bi_close() is called from backend_shutdown()
2166 * bi_destroy: called to destroy each database, called
2167 * once during shutdown after all bi_db_destroy calls.
2168 * bi_destory() is called from backend_destroy()
2171 BI_config *bi_config;
2174 BI_destroy *bi_destroy;
2177 * per database routines:
2178 * bi_db_init: called to initialize each database,
2179 * called upon reading 'database <type>'
2180 * called only from backend_db_init()
2181 * bi_db_config: called to configure each database,
2182 * called per database to handle per database options
2183 * called only from read_config()
2184 * bi_db_open: called to open each database
2185 * called once per database immediately AFTER bi_open()
2186 * calls but before daemon startup.
2187 * called only by backend_startup()
2188 * bi_db_close: called to close each database
2189 * called once per database during shutdown but BEFORE
2190 * any bi_close call.
2191 * called only by backend_shutdown()
2192 * bi_db_destroy: called to destroy each database
2193 * called once per database during shutdown AFTER all
2194 * bi_close calls but before bi_destory calls.
2195 * called only by backend_destory()
2197 BI_db_init *bi_db_init;
2198 BI_db_config *bi_db_config;
2199 BI_db_open *bi_db_open;
2200 BI_db_close *bi_db_close;
2201 BI_db_destroy *bi_db_destroy;
2203 /* LDAP Operations Handling Routines */
2204 BI_op_bind *bi_op_bind;
2205 BI_op_unbind *bi_op_unbind;
2206 BI_op_search *bi_op_search;
2207 BI_op_compare *bi_op_compare;
2208 BI_op_modify *bi_op_modify;
2209 BI_op_modrdn *bi_op_modrdn;
2210 BI_op_add *bi_op_add;
2211 BI_op_delete *bi_op_delete;
2212 BI_op_abandon *bi_op_abandon;
2214 /* Extended Operations Helper */
2215 BI_op_extended *bi_extended;
2216 BI_op_cancel *bi_op_cancel;
2218 /* Auxilary Functions */
2219 BI_operational *bi_operational;
2220 BI_chk_referrals *bi_chk_referrals;
2221 BI_chk_controls *bi_chk_controls;
2222 BI_entry_get_rw *bi_entry_get_rw;
2223 BI_entry_release_rw *bi_entry_release_rw;
2225 BI_has_subordinates *bi_has_subordinates;
2226 BI_access_allowed *bi_access_allowed;
2227 BI_acl_group *bi_acl_group;
2228 BI_acl_attribute *bi_acl_attribute;
2230 BI_connection_init *bi_connection_init;
2231 BI_connection_destroy *bi_connection_destroy;
2233 /* hooks for slap tools */
2234 BI_tool_entry_open *bi_tool_entry_open;
2235 BI_tool_entry_close *bi_tool_entry_close;
2236 BI_tool_entry_first *bi_tool_entry_first;
2237 BI_tool_entry_next *bi_tool_entry_next;
2238 BI_tool_entry_get *bi_tool_entry_get;
2239 BI_tool_entry_put *bi_tool_entry_put;
2240 BI_tool_entry_reindex *bi_tool_entry_reindex;
2241 BI_tool_sync *bi_tool_sync;
2242 BI_tool_dn2id_get *bi_tool_dn2id_get;
2243 BI_tool_entry_modify *bi_tool_entry_modify;
2245 #define SLAP_INDEX_ADD_OP 0x0001
2246 #define SLAP_INDEX_DELETE_OP 0x0002
2248 slap_mask_t bi_flags; /* backend flags */
2249 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2250 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2251 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2252 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2253 #define SLAP_BFLAG_INCREMENT 0x0100U
2254 #define SLAP_BFLAG_ALIASES 0x1000U
2255 #define SLAP_BFLAG_REFERRALS 0x2000U
2256 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2257 #define SLAP_BFLAG_DYNAMIC 0x8000U
2259 /* overlay specific */
2260 #define SLAPO_BFLAG_SINGLE 0x01000000U
2261 #define SLAPO_BFLAG_DBONLY 0x02000000U
2262 #define SLAPO_BFLAG_GLOBONLY 0x04000000U
2263 #define SLAPO_BFLAG_MASK 0xFF000000U
2265 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2266 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2267 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2268 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2269 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2270 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2271 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2272 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2273 #define SLAP_DYNAMIC(be) ((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC))
2274 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2275 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2277 /* overlay specific */
2278 #define SLAPO_SINGLE(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE)
2279 #define SLAPO_DBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY)
2280 #define SLAPO_GLOBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY)
2282 char **bi_controls; /* supported controls */
2283 char bi_ctrls[SLAP_MAX_CIDS + 1];
2285 unsigned int bi_nDB; /* number of databases of this type */
2286 struct ConfigOCs *bi_cf_ocs;
2287 char **bi_obsolete_names;
2288 void *bi_extra; /* backend type-specific APIs */
2289 void *bi_private; /* backend type-specific config data */
2290 LDAP_STAILQ_ENTRY(BackendInfo) bi_next ;
2293 #define c_authtype c_authz.sai_method
2294 #define c_authmech c_authz.sai_mech
2295 #define c_dn c_authz.sai_dn
2296 #define c_ndn c_authz.sai_ndn
2297 #define c_ssf c_authz.sai_ssf
2298 #define c_transport_ssf c_authz.sai_transport_ssf
2299 #define c_tls_ssf c_authz.sai_tls_ssf
2300 #define c_sasl_ssf c_authz.sai_sasl_ssf
2302 #define o_authtype o_authz.sai_method
2303 #define o_authmech o_authz.sai_mech
2304 #define o_dn o_authz.sai_dn
2305 #define o_ndn o_authz.sai_ndn
2306 #define o_ssf o_authz.sai_ssf
2307 #define o_transport_ssf o_authz.sai_transport_ssf
2308 #define o_tls_ssf o_authz.sai_tls_ssf
2309 #define o_sasl_ssf o_authz.sai_sasl_ssf
2311 typedef int (slap_response)( Operation *, SlapReply * );
2313 typedef struct slap_callback {
2314 struct slap_callback *sc_next;
2315 slap_response *sc_response;
2316 slap_response *sc_cleanup;
2320 struct slap_overinfo;
2322 typedef enum slap_operation_e {
2335 op_aux_chk_referrals,
2336 op_aux_chk_controls,
2340 typedef struct slap_overinst {
2342 slap_response *on_response;
2343 struct slap_overinfo *on_info;
2344 struct slap_overinst *on_next;
2347 typedef struct slap_overinfo {
2349 BackendInfo *oi_orig;
2350 BackendDB *oi_origdb;
2351 struct slap_overinst *oi_list;
2354 /* Should successive callbacks in a chain be processed? */
2355 #define SLAP_CB_FREEME 0x04000
2356 #define SLAP_CB_BYPASS 0x08800
2357 #define SLAP_CB_CONTINUE 0x08000
2360 * Paged Results state
2362 typedef unsigned long PagedResultsCookie;
2363 typedef struct PagedResultsState {
2367 PagedResultsCookie ps_cookie;
2368 struct berval ps_cookieval;
2369 } PagedResultsState;
2371 struct slap_csn_entry {
2372 struct berval ce_csn;
2373 unsigned long ce_opid;
2374 unsigned long ce_connid;
2375 #define SLAP_CSN_PENDING 1
2376 #define SLAP_CSN_COMMIT 2
2378 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2382 * Caches the result of a backend_group check for ACL evaluation
2384 typedef struct GroupAssertion {
2385 struct GroupAssertion *ga_next;
2388 AttributeDescription *ga_at;
2394 struct slap_control_ids {
2400 int sc_modifyIncrement;
2402 int sc_pagedResults;
2403 int sc_permissiveModify;
2408 int sc_searchOptions;
2409 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2410 int sc_sortedResults;
2413 #ifdef SLAP_CONTROL_X_TREE_DELETE
2419 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2420 int sc_sessionTracking;
2422 int sc_valuesReturnFilter;
2423 #ifdef SLAP_CONTROL_X_WHATFAILED
2445 typedef struct slap_counters_t {
2446 struct slap_counters_t *sc_next;
2447 ldap_pvt_thread_mutex_t sc_mutex;
2448 ldap_pvt_mp_t sc_bytes;
2449 ldap_pvt_mp_t sc_pdu;
2450 ldap_pvt_mp_t sc_entries;
2451 ldap_pvt_mp_t sc_refs;
2453 ldap_pvt_mp_t sc_ops_completed;
2454 ldap_pvt_mp_t sc_ops_initiated;
2455 #ifdef SLAPD_MONITOR
2456 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2457 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2458 #endif /* SLAPD_MONITOR */
2462 * represents an operation pending from an ldap client
2464 typedef struct Opheader {
2465 unsigned long oh_opid; /* id of this operation */
2466 unsigned long oh_connid; /* id of conn initiating this op */
2467 Connection *oh_conn; /* connection spawning this op */
2469 ber_int_t oh_msgid; /* msgid of the request */
2470 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2472 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2474 void *oh_threadctx; /* thread pool thread context */
2475 void *oh_tmpmemctx; /* slab malloc context */
2476 BerMemoryFunctions *oh_tmpmfuncs;
2478 slap_counters_t *oh_counters;
2480 char oh_log_prefix[ /* sizeof("conn= op=") + 2*LDAP_PVT_INTTYPE_CHARS(unsigned long) */ SLAP_TEXT_BUFLEN ];
2483 void *oh_extensions; /* NS-SLAPI plugin */
2487 typedef union OpRequest {
2490 req_compare_s oq_compare;
2491 req_modify_s oq_modify;
2492 req_modrdn_s oq_modrdn;
2493 req_search_s oq_search;
2494 req_abandon_s oq_abandon;
2495 req_abandon_s oq_cancel;
2496 req_extended_s oq_extended;
2497 req_pwdexop_s oq_pwdexop;
2500 /* This is only a header. Actual users should define their own
2501 * structs with the oe_next / oe_key fields at the top and
2502 * whatever else they need following.
2504 typedef struct OpExtra {
2505 LDAP_SLIST_ENTRY(OpExtra) oe_next;
2509 typedef struct OpExtraDB {
2517 #define o_opid o_hdr->oh_opid
2518 #define o_connid o_hdr->oh_connid
2519 #define o_conn o_hdr->oh_conn
2520 #define o_msgid o_hdr->oh_msgid
2521 #define o_protocol o_hdr->oh_protocol
2522 #define o_tid o_hdr->oh_tid
2523 #define o_threadctx o_hdr->oh_threadctx
2524 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2525 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2526 #define o_counters o_hdr->oh_counters
2528 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2529 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2530 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2531 #define o_tmpfree o_tmpmfuncs->bmf_free
2533 #define o_log_prefix o_hdr->oh_log_prefix
2535 ber_tag_t o_tag; /* tag of the request */
2536 time_t o_time; /* time op was initiated */
2537 int o_tincr; /* counter for multiple ops with same o_time */
2539 BackendDB *o_bd; /* backend DB processing this op */
2540 struct berval o_req_dn; /* DN of target of request */
2541 struct berval o_req_ndn;
2543 OpRequest o_request;
2545 /* short hands for union members */
2546 #define oq_add o_request.oq_add
2547 #define oq_bind o_request.oq_bind
2548 #define oq_compare o_request.oq_compare
2549 #define oq_modify o_request.oq_modify
2550 #define oq_modrdn o_request.oq_modrdn
2551 #define oq_search o_request.oq_search
2552 #define oq_abandon o_request.oq_abandon
2553 #define oq_cancel o_request.oq_cancel
2554 #define oq_extended o_request.oq_extended
2555 #define oq_pwdexop o_request.oq_pwdexop
2557 /* short hands for inner request members */
2558 #define orb_method oq_bind.rb_method
2559 #define orb_cred oq_bind.rb_cred
2560 #define orb_edn oq_bind.rb_edn
2561 #define orb_ssf oq_bind.rb_ssf
2562 #define orb_mech oq_bind.rb_mech
2564 #define ors_scope oq_search.rs_scope
2565 #define ors_deref oq_search.rs_deref
2566 #define ors_slimit oq_search.rs_slimit
2567 #define ors_tlimit oq_search.rs_tlimit
2568 #define ors_limit oq_search.rs_limit
2569 #define ors_attrsonly oq_search.rs_attrsonly
2570 #define ors_attrs oq_search.rs_attrs
2571 #define ors_filter oq_search.rs_filter
2572 #define ors_filterstr oq_search.rs_filterstr
2574 #define orr_modlist oq_modrdn.rs_mods.rs_modlist
2575 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs
2576 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2577 #define orr_newrdn oq_modrdn.rs_newrdn
2578 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2579 #define orr_newSup oq_modrdn.rs_newSup
2580 #define orr_nnewSup oq_modrdn.rs_nnewSup
2582 #define orc_ava oq_compare.rs_ava
2584 #define ora_e oq_add.rs_e
2585 #define ora_modlist oq_add.rs_modlist
2587 #define orn_msgid oq_abandon.rs_msgid
2589 #define orm_modlist oq_modify.rs_mods.rs_modlist
2590 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs
2591 #define orm_increment oq_modify.rs_increment
2593 #define ore_reqoid oq_extended.rs_reqoid
2594 #define ore_flags oq_extended.rs_flags
2595 #define ore_reqdata oq_extended.rs_reqdata
2596 volatile sig_atomic_t o_abandon; /* abandon flag */
2597 volatile sig_atomic_t o_cancel; /* cancel flag */
2598 #define SLAP_CANCEL_NONE 0x00
2599 #define SLAP_CANCEL_REQ 0x01
2600 #define SLAP_CANCEL_ACK 0x02
2601 #define SLAP_CANCEL_DONE 0x03
2603 GroupAssertion *o_groups;
2604 char o_do_not_cache; /* don't cache groups from this op */
2605 char o_is_auth_check; /* authorization in progress */
2606 char o_dont_replicate;
2607 slap_access_t o_acl_priv;
2610 char o_delete_glue_parent;
2611 char o_no_schema_check;
2612 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2613 char o_no_subordinate_glue;
2614 #define get_no_subordinate_glue(op) ((op)->o_no_subordinate_glue)
2616 #define SLAP_CONTROL_NONE 0
2617 #define SLAP_CONTROL_IGNORED 1
2618 #define SLAP_CONTROL_NONCRITICAL 2
2619 #define SLAP_CONTROL_CRITICAL 3
2620 #define SLAP_CONTROL_MASK 3
2622 /* spare bits for simple flags */
2623 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2624 #define SLAP_CONTROL_DATA0 0x10
2625 #define SLAP_CONTROL_DATA1 0x20
2626 #define SLAP_CONTROL_DATA2 0x40
2627 #define SLAP_CONTROL_DATA3 0x80
2629 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2631 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2632 void **o_controls; /* per-control state */
2634 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2635 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2637 #define o_relax o_ctrlflag[slap_cids.sc_relax]
2638 #define get_relax(op) _SCM((op)->o_relax)
2640 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2641 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2643 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2644 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2645 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2647 #define get_subentries(op) _SCM((op)->o_subentries)
2648 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2650 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2651 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2653 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2654 #define get_assert(op) ((int)(op)->o_assert)
2655 #define o_assertion o_controls[slap_cids.sc_assert]
2656 #define get_assertion(op) ((op)->o_assertion)
2658 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2659 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2661 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2662 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2664 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2665 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2667 #ifdef SLAP_CONTROL_X_TREE_DELETE
2668 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2669 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2672 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2673 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2675 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2676 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2678 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2679 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2680 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2682 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2683 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2687 #define o_txnSpec o_ctrlflag[slap_cids.sc_txnSpec]
2690 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2691 #define o_session_tracking o_ctrlflag[slap_cids.sc_sessionTracking]
2692 #define o_tracked_sessions o_controls[slap_cids.sc_sessionTracking]
2693 #define get_sessionTracking(op) ((int)(op)->o_session_tracking)
2696 #ifdef SLAP_CONTROL_X_WHATFAILED
2697 #define o_whatFailed o_ctrlflag[slap_cids.sc_whatFailed]
2698 #define get_whatFailed(op) _SCM((op)->o_whatFailed)
2701 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2703 AuthorizationInformation o_authz;
2705 BerElement *o_ber; /* ber of the request */
2706 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2707 slap_callback *o_callback; /* callback pointers */
2708 LDAPControl **o_ctrls; /* controls */
2709 struct berval o_csn;
2711 /* DEPRECATE o_private - use o_extra instead */
2712 void *o_private; /* anything the backend needs */
2713 LDAP_SLIST_HEAD(o_e, OpExtra) o_extra; /* anything the backend needs */
2715 LDAP_STAILQ_ENTRY(Operation) o_next; /* next operation in list */
2718 typedef struct OperationBuffer {
2721 void *ob_controls[SLAP_MAX_CIDS];
2724 #define send_ldap_error( op, rs, err, text ) do { \
2725 (rs)->sr_err = err; (rs)->sr_text = text; \
2726 ((op)->o_conn->c_send_ldap_result)( op, rs ); \
2728 #define send_ldap_discon( op, rs, err, text ) do { \
2729 (rs)->sr_err = err; (rs)->sr_text = text; \
2730 send_ldap_disconnect( op, rs ); \
2733 typedef void (SEND_LDAP_RESULT)(
2734 Operation *op, SlapReply *rs);
2735 typedef int (SEND_SEARCH_ENTRY)(
2736 Operation *op, SlapReply *rs);
2737 typedef int (SEND_SEARCH_REFERENCE)(
2738 Operation *op, SlapReply *rs);
2739 typedef void (SEND_LDAP_EXTENDED)(
2740 Operation *op, SlapReply *rs);
2741 typedef void (SEND_LDAP_INTERMEDIATE)(
2742 Operation *op, SlapReply *rs);
2744 #define send_ldap_result( op, rs ) \
2745 ((op)->o_conn->c_send_ldap_result)( op, rs )
2746 #define send_search_entry( op, rs ) \
2747 ((op)->o_conn->c_send_search_entry)( op, rs )
2748 #define send_search_reference( op, rs ) \
2749 ((op)->o_conn->c_send_search_reference)( op, rs )
2750 #define send_ldap_extended( op, rs ) \
2751 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2752 #define send_ldap_intermediate( op, rs ) \
2753 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2755 typedef struct slap_listener Listener;
2758 * represents a connection from an ldap client
2761 int c_struct_state; /* structure management state */
2762 int c_conn_state; /* connection state */
2763 int c_conn_idx; /* slot in connections array */
2765 const char *c_close_reason; /* why connection is closing */
2767 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2768 Sockbuf *c_sb; /* ber connection stuff */
2770 /* only can be changed by connect_init */
2771 time_t c_starttime; /* when the connection was opened */
2772 time_t c_activitytime; /* when the connection was last used */
2773 unsigned long c_connid; /* id of this connection for stats*/
2775 struct berval c_peer_domain; /* DNS name of client */
2776 struct berval c_peer_name; /* peer name (trans=addr:port) */
2777 Listener *c_listener;
2778 #define c_listener_url c_listener->sl_url /* listener URL */
2779 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2781 /* only can be changed by binding thread */
2782 struct berval c_sasl_bind_mech; /* mech in progress */
2783 struct berval c_sasl_dn; /* temporary storage */
2784 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2786 /* authorization backend */
2787 Backend *c_authz_backend;
2788 void *c_authz_cookie;
2789 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2790 ( (op)->o_bd != NULL \
2791 && (op)->o_bd->be_private != NULL \
2792 && (op)->o_conn != NULL \
2793 && (op)->o_conn->c_authz_backend != NULL \
2794 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2795 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2797 AuthorizationInformation c_authz;
2799 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2801 LDAP_STAILQ_HEAD(c_o, Operation) c_ops; /* list of operations being processed */
2802 LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops; /* list of pending operations */
2804 ldap_pvt_thread_mutex_t c_write1_mutex; /* only one pdu written at a time */
2805 ldap_pvt_thread_cond_t c_write1_cv; /* only one pdu written at a time */
2806 ldap_pvt_thread_mutex_t c_write2_mutex; /* used to wait for sd write-ready */
2807 ldap_pvt_thread_cond_t c_write2_cv; /* used to wait for sd write-ready*/
2809 BerElement *c_currentber; /* ber we're attempting to read */
2810 int c_writers; /* number of writers waiting */
2812 char c_sasl_bind_in_progress; /* multi-op bind in progress */
2813 char c_writewaiter; /* true if blocked on write */
2816 #define CONN_IS_TLS 1
2817 #define CONN_IS_UDP 2
2818 #define CONN_IS_CLIENT 4
2819 #define CONN_IS_IPC 8
2821 #ifdef LDAP_CONNECTIONLESS
2822 char c_is_udp; /* true if this is (C)LDAP over UDP */
2825 char c_is_tls; /* true if this LDAP over raw TLS */
2826 char c_needs_tls_accept; /* true if SSL_accept should be called */
2828 char c_sasl_layers; /* true if we need to install SASL i/o handlers */
2829 char c_sasl_done; /* SASL completed once */
2830 void *c_sasl_authctx; /* SASL authentication context */
2831 void *c_sasl_sockctx; /* SASL security layer context */
2832 void *c_sasl_extra; /* SASL session extra stuff */
2833 Operation *c_sasl_bindop; /* set to current op if it's a bind */
2836 #define CONN_TXN_INACTIVE 0
2837 #define CONN_TXN_SPECIFY 1
2838 #define CONN_TXN_SETTLE -1
2841 Backend *c_txn_backend;
2842 LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */
2845 PagedResultsState c_pagedresults_state; /* paged result state */
2847 long c_n_ops_received; /* num of ops received (next op_id) */
2848 long c_n_ops_executing; /* num of ops currently executing */
2849 long c_n_ops_pending; /* num of ops pending execution */
2850 long c_n_ops_completed; /* num of ops completed */
2852 long c_n_get; /* num of get calls */
2853 long c_n_read; /* num of read calls */
2854 long c_n_write; /* num of write calls */
2856 void *c_extensions; /* Netscape plugin */
2859 * Client connection handling
2861 ldap_pvt_thread_start_t *c_clientfunc;
2865 * These are the "callbacks" that are available for back-ends to
2866 * supply data back to connected clients that are connected
2867 * through the "front-end".
2869 SEND_LDAP_RESULT *c_send_ldap_result;
2870 SEND_SEARCH_ENTRY *c_send_search_entry;
2871 SEND_SEARCH_REFERENCE *c_send_search_reference;
2872 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2873 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2879 #define SLAP_DEFAULT_SYSLOG_USER LOG_LOCAL4
2880 #endif /* LOG_LOCAL4 */
2882 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2883 Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2884 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2885 #else /* !LDAP_SYSLOG */
2886 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2888 if ( ldap_debug & (level) ) \
2889 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2891 #define StatslogTest( level ) (ldap_debug & (level))
2892 #endif /* !LDAP_SYSLOG */
2893 #else /* !LDAP_DEBUG */
2894 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0)
2895 #define StatslogTest( level ) (0)
2896 #endif /* !LDAP_DEBUG */
2899 * listener; need to access it from monitor backend
2901 struct slap_listener {
2902 struct berval sl_url;
2903 struct berval sl_name;
2908 #ifdef LDAP_CONNECTIONLESS
2909 int sl_is_udp; /* UDP listener is also data port */
2911 int sl_mute; /* Listener is temporarily disabled due to emfile */
2912 int sl_busy; /* Listener is busy (accept thread activated) */
2915 #define sl_addr sl_sa.sa_in_addr
2919 * Better know these all around slapd
2921 #define SLAP_LDAPDN_PRETTY 0x1
2922 #define SLAP_LDAPDN_MAXLEN 8192
2924 /* number of response controls supported */
2925 #define SLAP_MAX_RESPONSE_CONTROLS 6
2928 #define SLAP_CTRL_HIDE 0x00000000U
2930 #define SLAP_CTRL_HIDE 0x80000000U
2933 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for Relax */
2935 #define SLAP_CTRL_GLOBAL 0x00800000U
2936 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2938 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2939 #define SLAP_CTRL_ABANDON 0x00000001U
2940 #define SLAP_CTRL_ADD 0x00002002U
2941 #define SLAP_CTRL_BIND 0x00000004U
2942 #define SLAP_CTRL_COMPARE 0x00001008U
2943 #define SLAP_CTRL_DELETE 0x00002010U
2944 #define SLAP_CTRL_MODIFY 0x00002020U
2945 #define SLAP_CTRL_RENAME 0x00002040U
2946 #define SLAP_CTRL_SEARCH 0x00001080U
2947 #define SLAP_CTRL_UNBIND 0x00000100U
2949 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2950 #define SLAP_CTRL_UPDATE \
2951 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2952 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2954 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2957 LDAPControl *ctrl ));
2959 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
2961 #define SLAP_SLAB_SIZE (1024*1024)
2962 #define SLAP_SLAB_STACK 1
2963 #define SLAP_SLAB_SOBLOCK 64
2965 #define SLAP_ZONE_ALLOC 1
2966 #undef SLAP_ZONE_ALLOC
2968 #ifdef LDAP_COMP_MATCH
2970 * Extensible Filter Definition
2972 * MatchingRuleAssertion := SEQUENCE {
2973 * matchingRule [1] MatchingRuleId OPTIONAL,
2974 * type [2] AttributeDescription OPTIONAL,
2975 * matchValue [3] AssertionValue,
2976 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2978 * Following ComponentFilter is contained in matchValue
2980 * ComponentAssertion ::= SEQUENCE {
2981 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2982 * useDefaultValues BOOLEAN DEFAULT TRUE,
2983 * rule MATCHING-RULE.&id,
2984 * value MATCHING-RULE.&AssertionType }
2986 * ComponentFilter ::= CHOICE {
2987 * item [0] ComponentAssertion,
2988 * and [1] SEQUENCE OF ComponentFilter,
2989 * or [2] SEQUENCE OF ComponentFilter,
2990 * not [3] ComponentFilter }
2993 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2994 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2995 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2996 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2997 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2998 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2999 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
3000 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
3001 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
3003 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
3004 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
3005 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
3006 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
3007 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
3009 typedef struct ComponentId ComponentId;
3010 typedef struct ComponentReference ComponentReference;
3011 typedef struct ComponentAssertion ComponentAssertion;
3012 typedef struct ComponentAssertionValue ComponentAssertionValue;
3013 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo;
3014 typedef struct ComponentDesc ComponentDesc;
3016 struct ComponentData {
3017 void *cd_mem_op; /* nibble memory handler */
3018 ComponentSyntaxInfo** cd_tree; /* component tree */
3021 struct ComponentId {
3023 ComponentId *ci_next;
3025 union comp_id_value{
3026 BerValue ci_identifier;
3027 ber_int_t ci_from_beginning;
3029 ber_int_t ci_from_end;
3030 ber_int_t ci_content;
3031 BerValue ci_select_value;
3036 struct ComponentReference {
3037 ComponentId *cr_list;
3038 ComponentId *cr_curr;
3039 struct berval cr_string;
3041 /* Component Indexing */
3043 slap_mask_t cr_indexmask;
3044 AttributeDescription* cr_ad;
3046 ComponentReference* cr_next;
3049 struct ComponentAssertion {
3050 ComponentReference *ca_comp_ref;
3051 ber_int_t ca_use_def;
3052 MatchingRule *ca_ma_rule;
3053 struct berval ca_ma_value;
3054 ComponentData ca_comp_data; /* componentized assertion */
3055 ComponentFilter *ca_cf;
3056 MatchingRuleAssertion *ca_mra;
3059 struct ComponentFilter {
3060 ber_tag_t cf_choice;
3062 ber_int_t cf_un_result;
3063 ComponentAssertion *cf_un_ca;
3064 ComponentFilter *cf_un_complex;
3067 #define cf_ca cf_un.cf_un_ca
3068 #define cf_result cf_un.cf_un_result
3069 #define cf_and cf_un.cf_un_complex
3070 #define cf_or cf_un.cf_un_complex
3071 #define cf_not cf_un.cf_un_complex
3072 #define cf_any cf_un.cf_un_complex
3074 ComponentFilter *cf_next;
3077 struct ComponentAssertionValue {
3083 typedef int encoder_func LDAP_P((
3087 typedef int gser_decoder_func LDAP_P((
3090 ComponentSyntaxInfo** comp_syn_info,
3094 typedef int comp_free_func LDAP_P((
3097 typedef int ber_decoder_func LDAP_P((
3102 ComponentSyntaxInfo* comp_syn_info,
3106 typedef int ber_tag_decoder_func LDAP_P((
3109 ComponentSyntaxInfo* comp_syn_info,
3113 typedef void* extract_component_from_id_func LDAP_P((
3115 ComponentReference* cr,
3118 typedef void* convert_attr_to_comp_func LDAP_P ((
3121 struct berval* bv ));
3123 typedef void* alloc_nibble_func LDAP_P ((
3125 int increment_size ));
3127 typedef void free_nibble_func LDAP_P ((
3130 typedef void convert_assert_to_comp_func LDAP_P ((
3132 ComponentSyntaxInfo* csi_attr,
3134 ComponentSyntaxInfo** csi,
3138 typedef int convert_asn_to_ldap_func LDAP_P ((
3139 ComponentSyntaxInfo* csi,
3140 struct berval *bv ));
3142 typedef void free_component_func LDAP_P ((
3145 typedef int test_component_func LDAP_P ((
3147 void* assert_mem_op,
3148 ComponentSyntaxInfo* csi,
3149 ComponentAssertion* ca));
3151 typedef void* test_membership_func LDAP_P ((
3154 typedef void* get_component_info_func LDAP_P ((
3157 typedef int component_encoder_func LDAP_P ((
3159 ComponentSyntaxInfo* csi,
3160 struct berval* nvals ));
3162 typedef int allcomponent_matching_func LDAP_P((
3164 ComponentSyntaxInfo* comp1,
3165 ComponentSyntaxInfo* comp));
3167 struct ComponentDesc {
3168 /* Don't change the order of following four fields */
3170 AttributeType *cd_comp_type;
3171 struct berval cd_ad_type; /* ad_type, ad_cname */
3172 struct berval cd_ad_cname; /* ad_type, ad_cname */
3173 unsigned cd_flags; /* ad_flags */
3176 encoder_func *cd_ldap_encoder;
3177 encoder_func *cd_gser_encoder;
3178 encoder_func *cd_ber_encoder;
3179 gser_decoder_func *cd_gser_decoder;
3180 ber_decoder_func *cd_ber_decoder;
3181 comp_free_func *cd_free;
3182 extract_component_from_id_func* cd_extract_i;
3183 allcomponent_matching_func *cd_all_match;
3186 struct ComponentSyntaxInfo {
3188 ComponentDesc *csi_comp_desc;
3191 #endif /* LDAP_COMP_MATCH */
3193 /* slab heap data structures */
3195 struct slab_object {
3198 LDAP_LIST_ENTRY(slab_object) so_link;
3207 unsigned char **sh_map;
3208 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3209 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3212 #ifdef SLAP_ZONE_ALLOC
3213 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3214 #define SLAP_ZONE_SHIFT 19
3215 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3216 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3217 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3218 #define SLAP_ZONE_ZOBLOCK 256
3220 struct zone_object {
3225 LDAP_LIST_ENTRY(zone_object) zo_link;
3228 struct zone_latency_history {
3230 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3241 ldap_pvt_thread_rdwr_t *zh_znlock;
3242 Avlnode *zh_zonetree;
3243 unsigned char ***zh_maps;
3245 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3246 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3247 ldap_pvt_thread_mutex_t zh_mutex;
3248 ldap_pvt_thread_rdwr_t zh_lock;
3249 double zh_ema_latency;
3250 unsigned long zh_ema_samples;
3251 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3252 zh_latency_history_queue;
3253 int zh_latency_history_qlen;
3254 int zh_latency_jump;
3259 #define SLAP_BACKEND_INIT_MODULE(b) \
3260 static BackendInfo bi; \
3262 init_module( int argc, char *argv[] ) \
3265 bi.bi_init = b ## _back_initialize; \
3266 backend_add( &bi ); \
3270 typedef int (OV_init)(void);
3271 typedef struct slap_oinit_t {
3272 const char *ov_type;
3278 #include "proto-slap.h"
3280 #endif /* _SLAP_H_ */