1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
30 #include "ldap_defaults.h"
33 #include <ac/stdlib.h>
35 #include <sys/types.h>
36 #include <ac/syslog.h>
38 #include <ac/signal.h>
39 #include <ac/socket.h>
46 #define ldap_debug slap_debug
52 #include <ldap_schema.h>
56 #include "ldap_pvt_thread.h"
57 #include "ldap_queue.h"
62 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
64 #define LDAP_COMP_MATCH /* experimental */
65 #define LDAP_DYNAMIC_OBJECTS
66 #define LDAP_SYNC_TIMESTAMP
67 #define LDAP_COLLECTIVE_ATTRIBUTES
68 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
71 #if defined(LDAP_DEVEL) && defined(ENABLE_REWRITE)
72 /* use librewrite for sasl-regexp */
73 #define SLAP_AUTH_REWRITE 1
74 #endif /* LDAP_DEVEL && ENABLE_REWRITE */
77 * SLAPD Memory allocation macros
79 * Unlike ch_*() routines, these routines do not assert() upon
80 * allocation error. They are intended to be used instead of
81 * ch_*() routines where the caller has implemented proper
82 * checking for and handling of allocation errors.
84 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
86 #define SLAP_MALLOC(s) ber_memalloc((s))
87 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
88 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
89 #define SLAP_FREE(p) ber_memfree((p))
90 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
91 #define SLAP_STRDUP(s) ber_strdup((s))
92 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
95 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
98 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
99 #define SLAPD_ANONYMOUS "cn=anonymous"
101 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
102 * This is a value used internally by the backends. It is needed to allow
103 * adding values that already exist without getting an error as required by
104 * modrdn when the new rdn was already an attribute value itself.
106 #define SLAP_MOD_SOFTADD 0x1000
108 #define MAXREMATCHES (100)
110 #define SLAP_MAX_WORKER_THREADS (16)
112 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
113 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
115 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
116 #define SLAP_CONN_MAX_PENDING_AUTH 1000
118 #define SLAP_TEXT_BUFLEN (256)
120 /* psuedo error code indicating abandoned operation */
121 #define SLAPD_ABANDON (-1024)
123 /* psuedo error code indicating disconnect */
124 #define SLAPD_DISCONNECT (-1025)
126 /* unknown config file directive */
127 #define SLAP_CONF_UNKNOWN (-1026)
129 /* We assume "C" locale, that is US-ASCII */
130 #define ASCII_SPACE(c) ( (c) == ' ' )
131 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
132 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
133 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
134 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
135 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
136 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
137 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
138 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
139 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
140 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
142 #define SLAP_NIBBLE(c) ((c)&0x0f)
143 #define SLAP_ESCAPE_CHAR ('\\')
144 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
145 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
147 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
148 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
150 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
151 /* NOTE: for consistency, this macro must only operate
152 * on normalized/pretty DN, such that ';' is never used
153 * as RDN separator, and all occurrences of ';' must be escaped */
154 #define DN_SEPARATOR(c) ((c) == ',')
155 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
156 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
157 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
159 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
160 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
161 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
162 #define OID_SEPARATOR(c) ( (c) == '.' )
163 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
165 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
166 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
168 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
169 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
171 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
173 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
174 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
175 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
176 (c) == '?' || (c) == ' ' || (c) == '=' )
177 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
179 /* must match in schema_init.c */
180 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
181 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
182 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
183 #define SLAPD_GROUP_ATTR "member"
184 #define SLAPD_GROUP_CLASS "groupOfNames"
185 #define SLAPD_ROLE_ATTR "roleOccupant"
186 #define SLAPD_ROLE_CLASS "organizationalRole"
188 #ifdef SLAPD_ACI_ENABLED
189 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
192 /* change this to "OpenLDAPset" */
193 #define SLAPD_ACI_SET_ATTR "template"
195 #define SLAPD_TOP_OID "2.5.6.0"
197 LDAP_SLAPD_V (int) slap_debug;
199 typedef unsigned long slap_mask_t;
201 /* Security Strength Factor */
202 typedef unsigned slap_ssf_t;
204 typedef struct slap_ssf_set {
206 slap_ssf_t sss_transport;
209 slap_ssf_t sss_update_ssf;
210 slap_ssf_t sss_update_transport;
211 slap_ssf_t sss_update_tls;
212 slap_ssf_t sss_update_sasl;
213 slap_ssf_t sss_simple_bind;
216 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
217 #define SLAP_GETDN_AUTHCID 2
218 #define SLAP_GETDN_AUTHZID 4
223 #define SLAP_INDEX_TYPE 0x00FFUL
224 #define SLAP_INDEX_UNDEFINED 0x0001UL
225 #define SLAP_INDEX_PRESENT 0x0002UL
226 #define SLAP_INDEX_EQUALITY 0x0004UL
227 #define SLAP_INDEX_APPROX 0x0008UL
228 #define SLAP_INDEX_SUBSTR 0x0010UL
229 #define SLAP_INDEX_EXTENDED 0x0020UL
231 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
233 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
235 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
237 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
238 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
239 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
240 #define SLAP_INDEX_SUBSTR_DEFAULT \
241 ( SLAP_INDEX_SUBSTR \
242 | SLAP_INDEX_SUBSTR_INITIAL \
243 | SLAP_INDEX_SUBSTR_ANY \
244 | SLAP_INDEX_SUBSTR_FINAL )
246 /* defaults for initial/final substring indices */
247 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
248 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
250 /* defaults for any substring indices */
251 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
252 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
254 #define SLAP_INDEX_FLAGS 0xF000UL
255 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
256 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
259 * there is a single index for each attribute. these prefixes ensure
260 * that there is no collision among keys.
262 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
263 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
264 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
265 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
266 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
267 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
269 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
270 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
271 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
272 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
273 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
276 * represents schema information for a database
278 #define SLAP_SCHERR_OUTOFMEM 1
279 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
280 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
281 #define SLAP_SCHERR_CLASS_BAD_SUP 4
282 #define SLAP_SCHERR_CLASS_DUP 5
283 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
284 #define SLAP_SCHERR_ATTR_BAD_MR 7
285 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
286 #define SLAP_SCHERR_ATTR_BAD_SUP 9
287 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
288 #define SLAP_SCHERR_ATTR_DUP 11
289 #define SLAP_SCHERR_MR_NOT_FOUND 12
290 #define SLAP_SCHERR_MR_INCOMPLETE 13
291 #define SLAP_SCHERR_MR_DUP 14
292 #define SLAP_SCHERR_SYN_NOT_FOUND 15
293 #define SLAP_SCHERR_SYN_DUP 16
294 #define SLAP_SCHERR_NO_NAME 17
295 #define SLAP_SCHERR_NOT_SUPPORTED 18
296 #define SLAP_SCHERR_BAD_DESCR 19
297 #define SLAP_SCHERR_OIDM 20
298 #define SLAP_SCHERR_CR_DUP 21
299 #define SLAP_SCHERR_CR_BAD_STRUCT 22
300 #define SLAP_SCHERR_CR_BAD_AUX 23
301 #define SLAP_SCHERR_CR_BAD_AT 24
302 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
304 typedef union slap_sockaddr {
305 struct sockaddr sa_addr;
306 struct sockaddr_in sa_in_addr;
308 struct sockaddr_storage sa_storage;
309 struct sockaddr_in6 sa_in6_addr;
312 struct sockaddr_un sa_un_addr;
317 extern int slap_inet4or6;
320 typedef struct slap_oid_macro {
321 struct berval som_oid;
323 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
326 /* forward declarations */
328 struct slap_matching_rule;
330 typedef int slap_syntax_validate_func LDAP_P((
331 struct slap_syntax *syntax,
332 struct berval * in));
334 typedef int slap_syntax_transform_func LDAP_P((
335 struct slap_syntax *syntax,
340 #ifdef LDAP_COMP_MATCH
341 typedef void* slap_component_transform_func LDAP_P((
342 struct berval * in ));
343 struct ComponentDesc;
346 typedef struct slap_syntax {
348 #define ssyn_oid ssyn_syn.syn_oid
349 #define ssyn_desc ssyn_syn.syn_desc
350 #define ssyn_extensions ssyn_syn.syn_extensions
353 ber_len_t ssyn_oidlen;
354 * has been replaced by a struct berval that uses the value
355 * provided by ssyn_syn.syn_oid; a macro that expands to
356 * the bv_len field of the berval is provided for backward
357 * compatibility. CAUTION: NEVER FREE THE BERVAL
359 struct berval ssyn_bvoid;
360 #define ssyn_oidlen ssyn_bvoid.bv_len
362 unsigned int ssyn_flags;
364 #define SLAP_SYNTAX_NONE 0x0000U
365 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
366 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
367 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
369 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
371 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
374 slap_syntax_validate_func *ssyn_validate;
375 slap_syntax_transform_func *ssyn_pretty;
377 #ifdef SLAPD_BINARY_CONVERSION
378 /* convert to and from binary */
379 slap_syntax_transform_func *ssyn_ber2str;
380 slap_syntax_transform_func *ssyn_str2ber;
382 #ifdef LDAP_COMP_MATCH
383 slap_component_transform_func *ssyn_attr2comp;
384 struct ComponentDesc* ssync_comp_syntax;
387 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
390 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
391 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
392 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
393 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
394 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
396 typedef struct slap_syntax_defs_rec {
399 slap_syntax_validate_func *sd_validate;
400 slap_syntax_transform_func *sd_pretty;
401 #ifdef SLAPD_BINARY_CONVERSION
402 slap_syntax_transform_func *sd_ber2str;
403 slap_syntax_transform_func *sd_str2ber;
405 } slap_syntax_defs_rec;
407 /* X -> Y Converter */
408 typedef int slap_mr_convert_func LDAP_P((
414 typedef int slap_mr_normalize_func LDAP_P((
416 struct slap_syntax *syntax, /* NULL if in is asserted value */
417 struct slap_matching_rule *mr,
422 /* Match (compare) function */
423 typedef int slap_mr_match_func LDAP_P((
426 struct slap_syntax *syntax, /* syntax of stored value */
427 struct slap_matching_rule *mr,
428 struct berval * value,
429 void * assertValue ));
431 /* Index generation function */
432 typedef int slap_mr_indexer_func LDAP_P((
435 struct slap_syntax *syntax, /* syntax of stored value */
436 struct slap_matching_rule *mr,
437 struct berval *prefix,
442 /* Filter index function */
443 typedef int slap_mr_filter_func LDAP_P((
446 struct slap_syntax *syntax, /* syntax of stored value */
447 struct slap_matching_rule *mr,
448 struct berval *prefix,
453 typedef struct slap_matching_rule_use MatchingRuleUse;
455 typedef struct slap_matching_rule {
456 LDAPMatchingRule smr_mrule;
457 MatchingRuleUse *smr_mru;
458 /* RFC2252 string representation */
459 struct berval smr_str;
462 * ber_len_t smr_oidlen;
463 * has been replaced by a struct berval that uses the value
464 * provided by smr_mrule.mr_oid; a macro that expands to
465 * the bv_len field of the berval is provided for backward
466 * compatibility. CAUTION: NEVER FREE THE BERVAL
468 struct berval smr_bvoid;
469 #define smr_oidlen smr_bvoid.bv_len
471 slap_mask_t smr_usage;
474 #define SLAP_MR_HIDE 0x0000U
476 #define SLAP_MR_HIDE 0x8000U
479 #define SLAP_MR_TYPE_MASK 0x0F00U
480 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
481 #define SLAP_MR_USAGE 0x000FU
483 #define SLAP_MR_NONE 0x0000U
484 #define SLAP_MR_EQUALITY 0x0100U
485 #define SLAP_MR_ORDERING 0x0200U
486 #define SLAP_MR_SUBSTR 0x0400U
487 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
488 #define SLAP_MR_ORDERED_INDEX 0x1000U
489 #ifdef LDAP_COMP_MATCH
490 #define SLAP_MR_COMPONENT 0x2000U
493 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
495 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
496 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
497 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
501 * The asserted value, depending on the particular usage,
502 * is expected to conform to either the assertion syntax
503 * or the attribute syntax. In some cases, the syntax of
504 * the value is known. If so, these flags indicate which
505 * syntax the value is expected to conform to. If not,
506 * neither of these flags is set (until the syntax of the
507 * provided value is determined). If the value is of the
508 * attribute syntax, the flag is changed once a value of
509 * the assertion syntax is derived from the provided value.
511 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
512 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
513 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
515 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
516 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
517 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
518 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
520 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
521 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
523 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
526 /* either or both the asserted value or attribute value
527 * may be provided in normalized form
529 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
530 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
532 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
533 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
534 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
535 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
537 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
538 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
539 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
540 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
541 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
542 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
544 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
545 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
546 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
547 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
550 slap_mr_convert_func *smr_convert;
551 slap_mr_normalize_func *smr_normalize;
552 slap_mr_match_func *smr_match;
553 slap_mr_indexer_func *smr_indexer;
554 slap_mr_filter_func *smr_filter;
557 * null terminated array of syntaxes compatible with this syntax
558 * note: when MS_EXT is set, this MUST NOT contain the assertion
559 * syntax of the rule. When MS_EXT is not set, it MAY.
561 Syntax **smr_compat_syntaxes;
564 * For equality rules, refers to an associated approximate rule.
565 * For non-equality rules, refers to an associated equality rule.
567 struct slap_matching_rule *smr_associated;
569 #define SLAP_MR_ASSOCIATED(mr,amr) \
570 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
572 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
574 #define smr_oid smr_mrule.mr_oid
575 #define smr_names smr_mrule.mr_names
576 #define smr_desc smr_mrule.mr_desc
577 #define smr_obsolete smr_mrule.mr_obsolete
578 #define smr_syntax_oid smr_mrule.mr_syntax_oid
579 #define smr_extensions smr_mrule.mr_extensions
582 struct slap_matching_rule_use {
583 LDAPMatchingRuleUse smru_mruleuse;
584 MatchingRule *smru_mr;
585 /* RFC2252 string representation */
586 struct berval smru_str;
588 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
590 #define smru_oid smru_mruleuse.mru_oid
591 #define smru_names smru_mruleuse.mru_names
592 #define smru_desc smru_mruleuse.mru_desc
593 #define smru_obsolete smru_mruleuse.mru_obsolete
594 #define smru_applies_oids smru_mruleuse.mru_applies_oids
596 #define smru_usage smru_mr->smr_usage
597 } /* MatchingRuleUse */ ;
599 typedef struct slap_mrule_defs_rec {
601 slap_mask_t mrd_usage;
602 char ** mrd_compat_syntaxes;
603 slap_mr_convert_func * mrd_convert;
604 slap_mr_normalize_func * mrd_normalize;
605 slap_mr_match_func * mrd_match;
606 slap_mr_indexer_func * mrd_indexer;
607 slap_mr_filter_func * mrd_filter;
609 /* For equality rule, this may refer to an associated approximate rule */
610 /* For non-equality rule, this may refer to an associated equality rule */
611 char * mrd_associated;
612 } slap_mrule_defs_rec;
614 struct slap_backend_db;
618 typedef int (AttributeTypeSchemaCheckFN)(
619 struct slap_backend_db *be,
620 struct slap_entry *e,
621 struct slap_attr *attr,
623 char *textbuf, size_t textlen );
625 typedef struct slap_attribute_type {
626 LDAPAttributeType sat_atype;
627 struct berval sat_cname;
628 struct slap_attribute_type *sat_sup;
629 struct slap_attribute_type **sat_subtypes;
630 MatchingRule *sat_equality;
631 MatchingRule *sat_approx;
632 MatchingRule *sat_ordering;
633 MatchingRule *sat_substr;
636 AttributeTypeSchemaCheckFN *sat_check;
638 #define SLAP_AT_NONE 0x0000U
639 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
640 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
642 #define SLAP_AT_HIDE 0x0000U /* publish everything */
644 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
646 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
648 slap_mask_t sat_flags;
650 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
652 #define sat_oid sat_atype.at_oid
653 #define sat_names sat_atype.at_names
654 #define sat_desc sat_atype.at_desc
655 #define sat_obsolete sat_atype.at_obsolete
656 #define sat_sup_oid sat_atype.at_sup_oid
657 #define sat_equality_oid sat_atype.at_equality_oid
658 #define sat_ordering_oid sat_atype.at_ordering_oid
659 #define sat_substr_oid sat_atype.at_substr_oid
660 #define sat_syntax_oid sat_atype.at_syntax_oid
661 #define sat_single_value sat_atype.at_single_value
662 #define sat_collective sat_atype.at_collective
663 #define sat_no_user_mod sat_atype.at_no_user_mod
664 #define sat_usage sat_atype.at_usage
665 #define sat_extensions sat_atype.at_extensions
667 struct slap_attr_desc *sat_ad;
668 ldap_pvt_thread_mutex_t sat_ad_mutex;
671 #define is_at_operational(at) ((at)->sat_usage)
672 #define is_at_single_value(at) ((at)->sat_single_value)
673 #define is_at_collective(at) ((at)->sat_collective)
674 #define is_at_obsolete(at) ((at)->sat_obsolete)
675 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
677 struct slap_object_class;
679 typedef int (ObjectClassSchemaCheckFN)(
680 struct slap_backend_db *be,
681 struct slap_entry *e,
682 struct slap_object_class *oc,
684 char *textbuf, size_t textlen );
686 typedef struct slap_object_class {
687 LDAPObjectClass soc_oclass;
688 struct berval soc_cname;
689 struct slap_object_class **soc_sups;
690 AttributeType **soc_required;
691 AttributeType **soc_allowed;
692 ObjectClassSchemaCheckFN *soc_check;
693 slap_mask_t soc_flags;
694 #define soc_oid soc_oclass.oc_oid
695 #define soc_names soc_oclass.oc_names
696 #define soc_desc soc_oclass.oc_desc
697 #define soc_obsolete soc_oclass.oc_obsolete
698 #define soc_sup_oids soc_oclass.oc_sup_oids
699 #define soc_kind soc_oclass.oc_kind
700 #define soc_at_oids_must soc_oclass.oc_at_oids_must
701 #define soc_at_oids_may soc_oclass.oc_at_oids_may
702 #define soc_extensions soc_oclass.oc_extensions
704 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
707 #define SLAP_OC_ALIAS 0x0001
708 #define SLAP_OC_REFERRAL 0x0002
709 #define SLAP_OC_SUBENTRY 0x0004
710 #define SLAP_OC_DYNAMICOBJECT 0x0008
711 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
712 #define SLAP_OC_GLUE 0x0020
713 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
714 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
715 #define SLAP_OC__MASK 0x00FF
716 #define SLAP_OC__END 0x0100
717 #define SLAP_OC_OPERATIONAL 0x4000
719 #define SLAP_OC_HIDE 0x0000
721 #define SLAP_OC_HIDE 0x8000
727 typedef struct slap_content_rule {
728 LDAPContentRule scr_crule;
729 ObjectClass *scr_sclass;
730 ObjectClass **scr_auxiliaries; /* optional */
731 AttributeType **scr_required; /* optional */
732 AttributeType **scr_allowed; /* optional */
733 AttributeType **scr_precluded; /* optional */
734 #define scr_oid scr_crule.cr_oid
735 #define scr_names scr_crule.cr_names
736 #define scr_desc scr_crule.cr_desc
737 #define scr_obsolete scr_crule.cr_obsolete
738 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
739 #define scr_at_oids_must scr_crule.cr_at_oids_must
740 #define scr_at_oids_may scr_crule.cr_at_oids_may
741 #define scr_at_oids_not scr_crule.cr_at_oids_not
743 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
746 /* Represents a recognized attribute description ( type + options ). */
747 typedef struct slap_attr_desc {
748 struct slap_attr_desc *ad_next;
749 AttributeType *ad_type; /* attribute type, must be specified */
750 struct berval ad_cname; /* canonical name, must be specified */
751 struct berval ad_tags; /* empty if no tagging options */
753 #define SLAP_DESC_NONE 0x00U
754 #define SLAP_DESC_BINARY 0x01U
755 #define SLAP_DESC_TAG_RANGE 0x80U
756 } AttributeDescription;
758 typedef struct slap_attr_name {
759 struct berval an_name;
760 AttributeDescription *an_desc;
765 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
766 #define slap_ad_is_tag_range(ad) \
767 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
768 #define slap_ad_is_binary(ad) \
769 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
772 * pointers to schema elements used internally
774 struct slap_internal_schema {
776 ObjectClass *si_oc_top;
777 ObjectClass *si_oc_extensibleObject;
778 ObjectClass *si_oc_alias;
779 ObjectClass *si_oc_referral;
780 ObjectClass *si_oc_rootdse;
781 ObjectClass *si_oc_subentry;
782 ObjectClass *si_oc_subschema;
783 ObjectClass *si_oc_collectiveAttributeSubentry;
784 ObjectClass *si_oc_dynamicObject;
786 ObjectClass *si_oc_glue;
787 ObjectClass *si_oc_syncConsumerSubentry;
788 ObjectClass *si_oc_syncProviderSubentry;
790 /* objectClass attribute descriptions */
791 AttributeDescription *si_ad_objectClass;
793 /* operational attribute descriptions */
794 AttributeDescription *si_ad_structuralObjectClass;
795 AttributeDescription *si_ad_creatorsName;
796 AttributeDescription *si_ad_createTimestamp;
797 AttributeDescription *si_ad_modifiersName;
798 AttributeDescription *si_ad_modifyTimestamp;
799 AttributeDescription *si_ad_hasSubordinates;
800 AttributeDescription *si_ad_subschemaSubentry;
801 AttributeDescription *si_ad_collectiveSubentries;
802 AttributeDescription *si_ad_collectiveExclusions;
803 AttributeDescription *si_ad_entryDN;
804 AttributeDescription *si_ad_entryUUID;
805 AttributeDescription *si_ad_entryCSN;
806 AttributeDescription *si_ad_namingCSN;
808 AttributeDescription *si_ad_dseType;
809 AttributeDescription *si_ad_syncreplCookie;
810 AttributeDescription *si_ad_syncTimestamp;
811 AttributeDescription *si_ad_contextCSN;
813 /* root DSE attribute descriptions */
814 AttributeDescription *si_ad_altServer;
815 AttributeDescription *si_ad_namingContexts;
816 AttributeDescription *si_ad_supportedControl;
817 AttributeDescription *si_ad_supportedExtension;
818 AttributeDescription *si_ad_supportedLDAPVersion;
819 AttributeDescription *si_ad_supportedSASLMechanisms;
820 AttributeDescription *si_ad_supportedFeatures;
821 AttributeDescription *si_ad_monitorContext;
822 AttributeDescription *si_ad_vendorName;
823 AttributeDescription *si_ad_vendorVersion;
825 /* subentry attribute descriptions */
826 AttributeDescription *si_ad_administrativeRole;
827 AttributeDescription *si_ad_subtreeSpecification;
829 /* subschema subentry attribute descriptions */
830 AttributeDescription *si_ad_attributeTypes;
831 AttributeDescription *si_ad_ditContentRules;
832 AttributeDescription *si_ad_ditStructureRules;
833 AttributeDescription *si_ad_ldapSyntaxes;
834 AttributeDescription *si_ad_matchingRules;
835 AttributeDescription *si_ad_matchingRuleUse;
836 AttributeDescription *si_ad_nameForms;
837 AttributeDescription *si_ad_objectClasses;
839 /* Aliases & Referrals */
840 AttributeDescription *si_ad_aliasedObjectName;
841 AttributeDescription *si_ad_ref;
843 /* Access Control Internals */
844 AttributeDescription *si_ad_entry;
845 AttributeDescription *si_ad_children;
846 AttributeDescription *si_ad_saslAuthzTo;
847 AttributeDescription *si_ad_saslAuthzFrom;
848 #ifdef SLAPD_ACI_ENABLED
849 AttributeDescription *si_ad_aci;
852 /* dynamic entries */
853 AttributeDescription *si_ad_entryTtl;
854 AttributeDescription *si_ad_dynamicSubtrees;
856 /* Other attributes descriptions */
857 AttributeDescription *si_ad_distinguishedName;
858 AttributeDescription *si_ad_name;
859 AttributeDescription *si_ad_cn;
860 AttributeDescription *si_ad_uid;
861 AttributeDescription *si_ad_userPassword;
862 AttributeDescription *si_ad_labeledURI;
863 #ifdef SLAPD_AUTHPASSWD
864 AttributeDescription *si_ad_authPassword;
866 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
867 AttributeDescription *si_ad_krbName;
870 /* Undefined Attribute Type */
871 AttributeType *si_at_undefined;
874 MatchingRule *si_mr_distinguishedNameMatch;
875 MatchingRule *si_mr_dnSubtreeMatch;
876 MatchingRule *si_mr_dnOneLevelMatch;
877 MatchingRule *si_mr_dnSubordinateMatch;
878 MatchingRule *si_mr_dnSuperiorMatch;
879 MatchingRule *si_mr_caseExactMatch;
880 MatchingRule *si_mr_caseExactSubstringsMatch;
881 MatchingRule *si_mr_caseExactIA5Match;
882 MatchingRule *si_mr_integerMatch;
883 MatchingRule *si_mr_integerFirstComponentMatch;
884 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
887 Syntax *si_syn_directoryString;
888 Syntax *si_syn_distinguishedName;
889 Syntax *si_syn_integer;
890 Syntax *si_syn_octetString;
892 /* Schema Syntaxes */
893 Syntax *si_syn_attributeTypeDesc;
894 Syntax *si_syn_ditContentRuleDesc;
895 Syntax *si_syn_ditStructureRuleDesc;
896 Syntax *si_syn_ldapSyntaxDesc;
897 Syntax *si_syn_matchingRuleDesc;
898 Syntax *si_syn_matchingRuleUseDesc;
899 Syntax *si_syn_nameFormDesc;
900 Syntax *si_syn_objectClassDesc;
903 typedef struct slap_attr_assertion {
904 AttributeDescription *aa_desc;
905 struct berval aa_value;
906 #ifdef LDAP_COMP_MATCH
907 struct slap_component_filter *aa_cf;/* for attribute aliasing */
909 } AttributeAssertion;
911 typedef struct slap_ss_assertion {
912 AttributeDescription *sa_desc;
913 struct berval sa_initial;
914 struct berval *sa_any;
915 struct berval sa_final;
916 } SubstringsAssertion;
918 #ifdef LDAP_COMP_MATCH
919 struct slap_component_filter;
922 typedef struct slap_mr_assertion {
923 MatchingRule *ma_rule; /* optional */
924 struct berval ma_rule_text; /* optional */
925 AttributeDescription *ma_desc; /* optional */
926 int ma_dnattrs; /* boolean */
927 struct berval ma_value; /* required */
928 #ifdef LDAP_COMP_MATCH
929 struct slap_component_filter* ma_cf; /* component filter */
931 } MatchingRuleAssertion;
934 * represents a search filter
936 typedef struct slap_filter {
937 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
938 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
939 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
940 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
941 #ifdef LDAP_SCOPE_SUBORDINATE
942 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
946 /* precomputed result */
947 ber_int_t f_un_result;
950 struct berval *f_un_dn;
953 AttributeDescription *f_un_desc;
955 /* simple value assertion */
956 AttributeAssertion *f_un_ava;
958 /* substring assertion */
959 SubstringsAssertion *f_un_ssa;
961 /* matching rule assertion */
962 MatchingRuleAssertion *f_un_mra;
964 #define f_dn f_un.f_un_dn
965 #define f_desc f_un.f_un_desc
966 #define f_ava f_un.f_un_ava
967 #define f_av_desc f_un.f_un_ava->aa_desc
968 #define f_av_value f_un.f_un_ava->aa_value
969 #define f_sub f_un.f_un_ssa
970 #define f_sub_desc f_un.f_un_ssa->sa_desc
971 #define f_sub_initial f_un.f_un_ssa->sa_initial
972 #define f_sub_any f_un.f_un_ssa->sa_any
973 #define f_sub_final f_un.f_un_ssa->sa_final
974 #define f_mra f_un.f_un_mra
975 #define f_mr_rule f_un.f_un_mra->ma_rule
976 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
977 #define f_mr_desc f_un.f_un_mra->ma_desc
978 #define f_mr_value f_un.f_un_mra->ma_value
979 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
982 struct slap_filter *f_un_complex;
985 #define f_result f_un.f_un_result
986 #define f_and f_un.f_un_complex
987 #define f_or f_un.f_un_complex
988 #define f_not f_un.f_un_complex
989 #define f_list f_un.f_un_complex
991 struct slap_filter *f_next;
994 /* compare routines can return undefined */
995 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
997 typedef struct slap_valuesreturnfilter {
998 ber_tag_t vrf_choice;
1001 /* precomputed result */
1002 ber_int_t vrf_un_result;
1008 AttributeDescription *vrf_un_desc;
1010 /* simple value assertion */
1011 AttributeAssertion *vrf_un_ava;
1013 /* substring assertion */
1014 SubstringsAssertion *vrf_un_ssa;
1016 /* matching rule assertion */
1017 MatchingRuleAssertion *vrf_un_mra;
1019 #define vrf_result vrf_un.vrf_un_result
1020 #define vrf_dn vrf_un.vrf_un_dn
1021 #define vrf_desc vrf_un.vrf_un_desc
1022 #define vrf_ava vrf_un.vrf_un_ava
1023 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1024 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1025 #define vrf_ssa vrf_un.vrf_un_ssa
1026 #define vrf_sub vrf_un.vrf_un_ssa
1027 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1028 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1029 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1030 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1031 #define vrf_mra vrf_un.vrf_un_mra
1032 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1033 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1034 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1035 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1036 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1041 struct slap_valuesreturnfilter *vrf_next;
1042 } ValuesReturnFilter;
1044 #ifdef LDAP_COMP_MATCH
1045 struct slap_component_syntax_info;
1046 typedef struct slap_component_data {
1047 void* cd_mem_op;/* nibble memory handler */
1048 struct slap_component_syntax_info** cd_tree;/* component tree */
1053 * represents an attribute (description + values)
1055 typedef struct slap_attr {
1056 AttributeDescription *a_desc;
1057 BerVarray a_vals; /* preserved values */
1058 BerVarray a_nvals; /* normalized values */
1059 #ifdef LDAP_COMP_MATCH
1060 ComponentData *a_comp_data; /* component values */
1062 struct slap_attr *a_next;
1064 #define SLAP_ATTR_IXADD 0x1U
1065 #define SLAP_ATTR_IXDEL 0x2U
1070 * the id used in the indexes to refer to an entry
1072 typedef unsigned long ID;
1073 #define NOID ((ID)~0)
1076 * represents an entry in core
1078 typedef struct slap_entry {
1080 * The ID field should only be changed before entry is
1081 * inserted into a cache. The ID value is backend
1086 struct berval e_name; /* name (DN) of this entry */
1087 struct berval e_nname; /* normalized name (DN) of this entry */
1089 /* for migration purposes */
1090 #define e_dn e_name.bv_val
1091 #define e_ndn e_nname.bv_val
1093 Attribute *e_attrs; /* list of attributes + values */
1095 slap_mask_t e_ocflags;
1097 struct berval e_bv; /* For entry_encode/entry_decode */
1099 /* for use by the backend for any purpose */
1104 * A list of LDAPMods
1106 typedef struct slap_mod {
1108 AttributeDescription *sm_desc;
1109 struct berval sm_type;
1110 BerVarray sm_values;
1111 BerVarray sm_nvalues;
1114 typedef struct slap_mod_list {
1115 Modification sml_mod;
1116 #define sml_op sml_mod.sm_op
1117 #define sml_desc sml_mod.sm_desc
1118 #define sml_type sml_mod.sm_type
1119 #define sml_values sml_mod.sm_values
1120 #define sml_nvalues sml_mod.sm_nvalues
1121 struct slap_mod_list *sml_next;
1124 typedef struct slap_ldap_modlist {
1126 struct slap_ldap_modlist *ml_next;
1127 #define ml_op ml_mod.mod_op
1128 #define ml_type ml_mod.mod_type
1129 #define ml_values ml_mod.mod_values
1133 * represents an access control list
1135 typedef enum slap_access_e {
1136 ACL_INVALID_ACCESS = -1,
1147 typedef enum slap_control_e {
1148 ACL_INVALID_CONTROL = 0,
1154 typedef enum slap_style_e {
1155 ACL_STYLE_REGEX = 0,
1162 ACL_STYLE_ANONYMOUS,
1169 typedef struct slap_authz_info {
1170 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1171 struct berval sai_mech; /* SASL Mechanism */
1172 struct berval sai_dn; /* DN for reporting purposes */
1173 struct berval sai_ndn; /* Normalized DN */
1175 /* Security Strength Factors */
1176 slap_ssf_t sai_ssf; /* Overall SSF */
1177 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1178 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1179 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1180 } AuthorizationInformation;
1187 * "dynamic" ACL infrastructure (for ACIs and more)
1189 typedef int (*slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1190 typedef int (*slap_dynacl_print)( void *priv );
1191 typedef int (*slap_dynacl_mask)(
1195 AttributeDescription *desc,
1198 regmatch_t *matches,
1199 slap_access_t *grant,
1200 slap_access_t *deny );
1201 typedef int (*slap_dynacl_destroy)( void *priv );
1203 typedef struct slap_dynacl_t {
1205 slap_dynacl_parse da_parse;
1206 slap_dynacl_print da_print;
1207 slap_dynacl_mask da_mask;
1208 slap_dynacl_destroy da_destroy;
1211 struct slap_dynacl_t *da_next;
1213 #endif /* SLAP_DYNACL */
1216 typedef struct slap_access {
1217 slap_control_t a_type;
1219 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1221 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1222 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1223 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1224 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1225 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1226 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1227 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1228 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1230 #define ACL_PRIV_MASK 0x00ffUL
1233 #define ACL_PRIV_LEVEL 0x1000UL
1234 #define ACL_PRIV_ADDITIVE 0x2000UL
1235 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1238 #define ACL_PRIV_INVALID 0x0UL
1240 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1241 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1242 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1243 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1245 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1246 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1248 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1250 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1252 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1253 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1254 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1256 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1257 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1258 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1259 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1260 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1261 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1262 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1263 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1265 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1266 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1267 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1268 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1269 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1270 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1271 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1272 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1273 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1275 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1276 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1277 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1278 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1279 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1280 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1281 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1282 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1284 slap_mask_t a_access_mask;
1286 AuthorizationInformation a_authz;
1287 #define a_dn_pat a_authz.sai_dn
1289 slap_style_t a_dn_style;
1290 AttributeDescription *a_dn_at;
1294 slap_style_t a_peername_style;
1295 struct berval a_peername_pat;
1296 unsigned long a_peername_addr,
1298 int a_peername_port;
1300 slap_style_t a_sockname_style;
1301 struct berval a_sockname_pat;
1303 slap_style_t a_domain_style;
1304 struct berval a_domain_pat;
1305 int a_domain_expand;
1307 slap_style_t a_sockurl_style;
1308 struct berval a_sockurl_pat;
1309 slap_style_t a_set_style;
1310 struct berval a_set_pat;
1313 slap_dynacl_t *a_dynacl;
1314 #else /* ! SLAP_DYNACL */
1315 #ifdef SLAPD_ACI_ENABLED
1316 AttributeDescription *a_aci_at;
1318 #endif /* SLAP_DYNACL */
1321 slap_style_t a_group_style;
1322 struct berval a_group_pat;
1323 ObjectClass *a_group_oc;
1324 AttributeDescription *a_group_at;
1326 struct slap_access *a_next;
1330 typedef struct slap_acl {
1331 /* "to" part: the entries this acl applies to */
1333 slap_style_t acl_dn_style;
1335 struct berval acl_dn_pat;
1336 AttributeName *acl_attrs;
1337 slap_style_t acl_attrval_style;
1338 regex_t acl_attrval_re;
1339 struct berval acl_attrval;
1341 /* "by" part: list of who has what access to the entries */
1344 struct slap_acl *acl_next;
1347 typedef struct slap_acl_state {
1348 unsigned as_recorded;
1349 #define ACL_STATE_NOT_RECORDED 0x0
1350 #define ACL_STATE_RECORDED_VD 0x1
1351 #define ACL_STATE_RECORDED_NV 0x2
1352 #define ACL_STATE_RECORDED 0x3
1355 AccessControl *as_vd_acl;
1356 AccessControl *as_vi_acl;
1357 slap_mask_t as_vd_acl_mask;
1358 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1359 int as_vd_acl_count;
1361 Access *as_vd_access;
1362 int as_vd_access_count;
1365 AttributeDescription *as_vd_ad;
1366 } AccessControlState;
1367 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1368 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1372 * represents a backend
1375 typedef struct slap_backend_info BackendInfo; /* per backend type */
1376 typedef struct slap_backend_db BackendDB; /* per backend database */
1378 LDAP_SLAPD_V (int) nBackendInfo;
1379 LDAP_SLAPD_V (int) nBackendDB;
1380 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1381 LDAP_SLAPD_V (BackendDB *) backendDB;
1382 LDAP_SLAPD_V (BackendDB *) frontendDB;
1384 LDAP_SLAPD_V (int) slapMode;
1385 #define SLAP_UNDEFINED_MODE 0x0000
1386 #define SLAP_SERVER_MODE 0x0001
1387 #define SLAP_TOOL_MODE 0x0002
1388 #define SLAP_MODE 0x0003
1390 #define SLAP_TRUNCATE_MODE 0x0100
1391 #define SLAP_TOOL_READMAIN 0x0200
1392 #define SLAP_TOOL_READONLY 0x0400
1393 #define SLAP_TOOL_QUICK 0x0800
1395 struct slap_replica_info {
1396 char *ri_host; /* supersedes be_replica */
1397 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1398 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1399 int ri_exclude; /* 1 => exclude ri_attrs */
1402 struct slap_limits_set {
1410 int lms_s_unchecked;
1416 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1417 #define SLAP_NO_LIMIT -1
1418 #define SLAP_MAX_LIMIT 2147483647
1420 struct slap_limits {
1421 unsigned lm_flags; /* type of pattern */
1422 #define SLAP_LIMITS_UNDEFINED 0x0000U
1423 #define SLAP_LIMITS_EXACT 0x0001U
1424 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1425 #define SLAP_LIMITS_ONE 0x0002U
1426 #define SLAP_LIMITS_SUBTREE 0x0003U
1427 #define SLAP_LIMITS_CHILDREN 0x0004U
1428 #define SLAP_LIMITS_REGEX 0x0005U
1429 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1430 #define SLAP_LIMITS_USERS 0x0007U
1431 #define SLAP_LIMITS_ANY 0x0008U
1432 #define SLAP_LIMITS_MASK 0x000FU
1434 #define SLAP_LIMITS_TYPE_DN 0x0000U
1435 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1436 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1438 regex_t lm_regex; /* regex data for REGEX */
1441 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1442 * pattern for REGEX; NULL for ANONYMOUS, USERS
1444 struct berval lm_pat;
1446 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1447 * lm_group_oc is objectClass and lm_group_at is attributeType
1448 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1449 * can only be SLAP_LIMITS_EXACT */
1450 ObjectClass *lm_group_oc;
1451 AttributeDescription *lm_group_ad;
1453 struct slap_limits_set lm_limits;
1456 /* temporary aliases */
1457 typedef BackendDB Backend;
1458 #define nbackends nBackendDB
1459 #define backends backendDB
1462 * syncinfo structure for syncrepl
1465 #define SLAP_SYNC_SID_SIZE 3
1466 #define SLAP_SYNC_RID_SIZE 3
1467 #define SLAP_SYNCUUID_SET_SIZE 256
1469 #define SLAP_SYNC_UPDATE_MSGID 2
1471 struct nonpresent_entry {
1472 struct berval *npe_name;
1473 struct berval *npe_nname;
1474 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1477 struct sync_cookie {
1478 struct berval ctxcsn;
1479 struct berval octet_str;
1481 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1484 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1486 typedef struct syncinfo_s {
1487 struct slap_backend_db *si_be;
1489 struct berval si_provideruri;
1490 #define SYNCINFO_TLS_OFF 0
1491 #define SYNCINFO_TLS_ON 1
1492 #define SYNCINFO_TLS_CRITICAL 2
1502 int si_schemachecking;
1503 struct berval si_filterstr;
1504 struct berval si_base;
1507 AttributeName *si_anlist;
1508 AttributeName *si_exanlist;
1515 time_t *si_retryinterval;
1516 int *si_retrynum_init;
1518 struct sync_cookie si_syncCookie;
1522 int si_refreshDelete;
1523 int si_refreshPresent;
1524 Avlnode *si_presentlist;
1526 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1527 ldap_pvt_thread_mutex_t si_mutex;
1530 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1532 #ifndef SLAP_MAX_CIDS
1533 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1536 struct slap_backend_db {
1537 BackendInfo *bd_info; /* pointer to shared backend info */
1539 /* fields in this structure (and routines acting on this structure)
1540 should be renamed from be_ to bd_ */
1542 /* BackendInfo accessors */
1543 #define be_config bd_info->bi_db_config
1544 #define be_type bd_info->bi_type
1546 #define be_bind bd_info->bi_op_bind
1547 #define be_unbind bd_info->bi_op_unbind
1548 #define be_add bd_info->bi_op_add
1549 #define be_compare bd_info->bi_op_compare
1550 #define be_delete bd_info->bi_op_delete
1551 #define be_modify bd_info->bi_op_modify
1552 #define be_modrdn bd_info->bi_op_modrdn
1553 #define be_search bd_info->bi_op_search
1554 #define be_abandon bd_info->bi_op_abandon
1555 #define be_cancel bd_info->bi_op_cancel
1557 #define be_extended bd_info->bi_extended
1559 #define be_chk_referrals bd_info->bi_chk_referrals
1560 #define be_chk_controls bd_info->bi_chk_controls
1561 #define be_fetch bd_info->bi_entry_get_rw
1562 #define be_release bd_info->bi_entry_release_rw
1563 #define be_group bd_info->bi_acl_group
1564 #define be_attribute bd_info->bi_acl_attribute
1565 #define be_operational bd_info->bi_operational
1568 * define to honor hasSubordinates operational attribute in search filters
1569 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1572 #define be_has_subordinates bd_info->bi_has_subordinates
1574 #define be_connection_init bd_info->bi_connection_init
1575 #define be_connection_destroy bd_info->bi_connection_destroy
1578 #define be_entry_open bd_info->bi_tool_entry_open
1579 #define be_entry_close bd_info->bi_tool_entry_close
1580 #define be_entry_first bd_info->bi_tool_entry_first
1581 #define be_entry_next bd_info->bi_tool_entry_next
1582 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1583 #define be_entry_get bd_info->bi_tool_entry_get
1584 #define be_entry_put bd_info->bi_tool_entry_put
1585 #define be_sync bd_info->bi_tool_sync
1586 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1587 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1588 #define be_entry_modify bd_info->bi_tool_entry_modify
1591 /* supported controls */
1592 /* note: set to 0 if the database does not support the control;
1593 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1594 char be_ctrls[SLAP_MAX_CIDS + 1];
1596 /* Database flags */
1597 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1598 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1599 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1600 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1601 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1602 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1603 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1604 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1605 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1606 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1607 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1608 slap_mask_t be_flags;
1609 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1610 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1611 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1612 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1613 #define SLAP_NO_SCHEMA_CHECK(be) \
1614 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1615 #define SLAP_GLUE_INSTANCE(be) \
1616 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1617 #define SLAP_GLUE_SUBORDINATE(be) \
1618 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1619 #define SLAP_GLUE_LINKED(be) \
1620 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1621 #define SLAP_GLUE_ADVERTISE(be) \
1622 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1623 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1624 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1625 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1627 slap_mask_t be_restrictops; /* restriction operations */
1628 #define SLAP_RESTRICT_OP_ADD 0x0001U
1629 #define SLAP_RESTRICT_OP_BIND 0x0002U
1630 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1631 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1632 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1633 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1634 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1635 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1636 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1638 #define SLAP_RESTRICT_READONLY 0x80000000U
1640 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1641 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1642 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1643 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1644 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1646 #define SLAP_RESTRICT_OP_READS \
1647 ( SLAP_RESTRICT_OP_COMPARE \
1648 | SLAP_RESTRICT_OP_SEARCH )
1649 #define SLAP_RESTRICT_OP_WRITES \
1650 ( SLAP_RESTRICT_OP_ADD \
1651 | SLAP_RESTRICT_OP_DELETE \
1652 | SLAP_RESTRICT_OP_MODIFY \
1653 | SLAP_RESTRICT_OP_RENAME )
1655 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1656 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1657 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1659 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1661 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1662 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1663 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1665 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1666 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1668 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1670 slap_mask_t be_requires; /* pre-operation requirements */
1671 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1672 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1673 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1674 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1675 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1677 /* Required Security Strength Factor */
1678 slap_ssf_set_t be_ssf_set;
1680 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1681 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1682 struct berval be_schemadn; /* per-backend subschema subentry DN */
1683 struct berval be_schemandn; /* normalized subschema DN */
1684 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1685 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1686 struct berval be_rootpw; /* the magic "root" password for this db */
1687 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1688 #define be_sizelimit be_def_limit.lms_s_soft
1689 #define be_timelimit be_def_limit.lms_t_soft
1690 struct slap_limits_set be_def_limit; /* default limits */
1691 struct slap_limits **be_limits; /* regex-based size and time limits */
1692 AccessControl *be_acl; /* access control list for this backend */
1693 slap_access_t be_dfltaccess; /* access given if no acl matches */
1695 /* Replica Information */
1696 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1697 char *be_replogfile; /* replication log file (in master) */
1698 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1699 BerVarray be_update_refs; /* where to refer modifying clients to */
1700 struct be_pcl *be_pending_csn_list;
1701 ldap_pvt_thread_mutex_t be_pcl_mutex;
1702 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1703 syncinfo_t *be_syncinfo; /* For syncrepl */
1706 void *be_pb; /* Netscape plugin */
1707 struct ConfigTable *be_cf_table;
1709 void *be_private; /* anything the backend database needs */
1715 /* Backend function typedefs */
1716 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1717 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1718 const char *fname, int lineno,
1719 int argc, char **argv));
1720 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1721 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1722 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1724 typedef int (BI_db_init) LDAP_P((Backend *bd));
1725 typedef int (BI_db_config) LDAP_P((Backend *bd,
1726 const char *fname, int lineno,
1727 int argc, char **argv));
1728 typedef int (BI_db_open) LDAP_P((Backend *bd));
1729 typedef int (BI_db_close) LDAP_P((Backend *bd));
1730 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1732 typedef struct req_bind_s {
1734 struct berval rb_cred;
1735 struct berval rb_edn;
1737 struct berval rb_tmp_mech; /* FIXME: temporary */
1740 typedef struct req_search_s {
1745 /* NULL means be_isroot evaluated to TRUE */
1746 struct slap_limits_set *rs_limit;
1748 AttributeName *rs_attrs;
1750 struct berval rs_filterstr;
1751 int rs_post_search_id;
1754 typedef struct req_compare_s {
1755 AttributeAssertion *rs_ava;
1758 typedef struct req_modify_s {
1759 Modifications *rs_modlist;
1760 int rs_increment; /* FIXME: temporary */
1763 typedef struct req_modrdn_s {
1764 struct berval rs_newrdn;
1765 struct berval rs_nnewrdn;
1766 struct berval *rs_newSup;
1767 struct berval *rs_nnewSup;
1768 int rs_deleteoldrdn;
1771 typedef struct req_add_s {
1773 Modifications *rs_modlist; /* FIXME: temporary */
1776 typedef struct req_abandon_s {
1781 #define SLAP_EXOP_HIDE 0x0000
1783 #define SLAP_EXOP_HIDE 0x8000
1785 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1787 typedef struct req_extended_s {
1788 struct berval rs_reqoid;
1790 struct berval *rs_reqdata;
1793 typedef struct req_pwdexop_s {
1794 struct berval rs_reqoid;
1796 struct berval rs_old;
1797 struct berval rs_new;
1798 Modifications *rs_mods;
1799 Modifications **rs_modtail;
1802 typedef enum slap_reply_e {
1811 typedef struct rep_sasl_s {
1812 struct berval *r_sasldata;
1815 typedef struct rep_extended_s {
1816 const char *r_rspoid;
1817 struct berval *r_rspdata;
1820 typedef struct rep_search_s {
1822 slap_mask_t r_attr_flags;
1823 #define SLAP_ATTRS_UNDEFINED (0x00U)
1824 #define SLAP_OPATTRS_NO (0x01U)
1825 #define SLAP_OPATTRS_YES (0x02U)
1826 #define SLAP_USERATTRS_NO (0x10U)
1827 #define SLAP_USERATTRS_YES (0x20U)
1828 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1829 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1830 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1831 #define SLAP_USERATTRS(f) \
1832 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1834 Attribute *r_operational_attrs;
1835 AttributeName *r_attrs;
1840 typedef struct slap_rep {
1841 slap_reply_t sr_type;
1845 const char *sr_matched;
1846 const char *sr_text;
1848 LDAPControl **sr_ctrls;
1850 rep_sasl_s sru_sasl;
1851 rep_extended_s sru_extended;
1852 rep_search_s sru_search;
1854 slap_mask_t sr_flags;
1855 #define REP_ENTRY_MODIFIABLE 0x0001U
1856 #define REP_ENTRY_MUSTBEFREED 0x0002U
1857 #define REP_MATCHED_MUSTBEFREED 0x0010U
1858 #define REP_REF_MUSTBEFREED 0x0020U
1861 /* short hands for response members */
1862 #define sr_attrs sr_un.sru_search.r_attrs
1863 #define sr_entry sr_un.sru_search.r_entry
1864 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1865 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1866 #define sr_v2ref sr_un.sru_search.r_v2ref
1867 #define sr_nentries sr_un.sru_search.r_nentries
1868 #define sr_rspoid sr_un.sru_extended.r_rspoid
1869 #define sr_rspdata sr_un.sru_extended.r_rspdata
1870 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1872 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1873 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1874 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1875 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1876 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1877 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1878 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1879 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1880 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1881 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1882 typedef int (BI_op_extended) LDAP_P((
1883 struct slap_op *op, struct slap_rep *rs ));
1884 typedef int (BI_chk_referrals) LDAP_P((
1885 struct slap_op *op, struct slap_rep *rs ));
1886 typedef int (BI_chk_controls) LDAP_P((
1887 struct slap_op *op, struct slap_rep *rs ));
1888 typedef int (BI_entry_release_rw)
1889 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1890 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1891 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1892 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1893 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1894 Entry *e, int *hasSubs ));
1896 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1897 struct slap_conn *c ));
1898 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1899 struct slap_conn *c ));
1901 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1902 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1903 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1904 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1905 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1906 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1907 struct berval *text ));
1908 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1909 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1910 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1911 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1912 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1913 struct berval *text ));
1915 struct ConfigTable; /* config.h */
1917 struct slap_backend_info {
1918 char *bi_type; /* type of backend */
1921 * per backend type routines:
1922 * bi_init: called to allocate a backend_info structure,
1923 * called once BEFORE configuration file is read.
1924 * bi_init() initializes this structure hence is
1925 * called directly from be_initialize()
1926 * bi_config: called per 'backend' specific option
1927 * all such options must before any 'database' options
1928 * bi_config() is called only from read_config()
1929 * bi_open: called to open each database, called
1930 * once AFTER configuration file is read but
1931 * BEFORE any bi_db_open() calls.
1932 * bi_open() is called from backend_startup()
1933 * bi_close: called to close each database, called
1934 * once during shutdown after all bi_db_close calls.
1935 * bi_close() is called from backend_shutdown()
1936 * bi_destroy: called to destroy each database, called
1937 * once during shutdown after all bi_db_destroy calls.
1938 * bi_destory() is called from backend_destroy()
1941 BI_config *bi_config;
1944 BI_destroy *bi_destroy;
1947 * per database routines:
1948 * bi_db_init: called to initialize each database,
1949 * called upon reading 'database <type>'
1950 * called only from backend_db_init()
1951 * bi_db_config: called to configure each database,
1952 * called per database to handle per database options
1953 * called only from read_config()
1954 * bi_db_open: called to open each database
1955 * called once per database immediately AFTER bi_open()
1956 * calls but before daemon startup.
1957 * called only by backend_startup()
1958 * bi_db_close: called to close each database
1959 * called once per database during shutdown but BEFORE
1960 * any bi_close call.
1961 * called only by backend_shutdown()
1962 * bi_db_destroy: called to destroy each database
1963 * called once per database during shutdown AFTER all
1964 * bi_close calls but before bi_destory calls.
1965 * called only by backend_destory()
1967 BI_db_init *bi_db_init;
1968 BI_db_config *bi_db_config;
1969 BI_db_open *bi_db_open;
1970 BI_db_close *bi_db_close;
1971 BI_db_destroy *bi_db_destroy;
1973 /* LDAP Operations Handling Routines */
1974 BI_op_bind *bi_op_bind;
1975 BI_op_unbind *bi_op_unbind;
1976 BI_op_search *bi_op_search;
1977 BI_op_compare *bi_op_compare;
1978 BI_op_modify *bi_op_modify;
1979 BI_op_modrdn *bi_op_modrdn;
1980 BI_op_add *bi_op_add;
1981 BI_op_delete *bi_op_delete;
1982 BI_op_abandon *bi_op_abandon;
1983 BI_op_cancel *bi_op_cancel;
1985 /* Extended Operations Helper */
1986 BI_op_extended *bi_extended;
1988 /* Auxilary Functions */
1989 BI_operational *bi_operational;
1990 BI_chk_referrals *bi_chk_referrals;
1991 BI_chk_controls *bi_chk_controls;
1992 BI_entry_get_rw *bi_entry_get_rw;
1993 BI_entry_release_rw *bi_entry_release_rw;
1995 BI_has_subordinates *bi_has_subordinates;
1997 BI_connection_init *bi_connection_init;
1998 BI_connection_destroy *bi_connection_destroy;
2000 /* hooks for slap tools */
2001 BI_tool_entry_open *bi_tool_entry_open;
2002 BI_tool_entry_close *bi_tool_entry_close;
2003 BI_tool_entry_first *bi_tool_entry_first;
2004 BI_tool_entry_next *bi_tool_entry_next;
2005 BI_tool_entry_get *bi_tool_entry_get;
2006 BI_tool_entry_put *bi_tool_entry_put;
2007 BI_tool_entry_reindex *bi_tool_entry_reindex;
2008 BI_tool_sync *bi_tool_sync;
2009 BI_tool_dn2id_get *bi_tool_dn2id_get;
2010 BI_tool_id2entry_get *bi_tool_id2entry_get;
2011 BI_tool_entry_modify *bi_tool_entry_modify;
2013 #define SLAP_INDEX_ADD_OP 0x0001
2014 #define SLAP_INDEX_DELETE_OP 0x0002
2016 slap_mask_t bi_flags; /* backend flags */
2017 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2018 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2019 #define SLAP_BFLAG_INCREMENT 0x0100U
2020 #define SLAP_BFLAG_ALIASES 0x1000U
2021 #define SLAP_BFLAG_REFERRALS 0x2000U
2022 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2023 #define SLAP_BFLAG_DYNAMIC 0x8000U
2025 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2026 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2027 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2028 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2029 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2030 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2031 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2032 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2033 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2035 char **bi_controls; /* supported controls */
2036 char bi_ctrls[SLAP_MAX_CIDS + 1];
2038 unsigned int bi_nDB; /* number of databases of this type */
2039 struct ConfigTable *bi_cf_table;
2040 void *bi_private; /* anything the backend type needs */
2043 #define c_authtype c_authz.sai_method
2044 #define c_authmech c_authz.sai_mech
2045 #define c_dn c_authz.sai_dn
2046 #define c_ndn c_authz.sai_ndn
2047 #define c_ssf c_authz.sai_ssf
2048 #define c_transport_ssf c_authz.sai_transport_ssf
2049 #define c_tls_ssf c_authz.sai_tls_ssf
2050 #define c_sasl_ssf c_authz.sai_sasl_ssf
2052 #define o_authtype o_authz.sai_method
2053 #define o_authmech o_authz.sai_mech
2054 #define o_dn o_authz.sai_dn
2055 #define o_ndn o_authz.sai_ndn
2056 #define o_ssf o_authz.sai_ssf
2057 #define o_transport_ssf o_authz.sai_transport_ssf
2058 #define o_tls_ssf o_authz.sai_tls_ssf
2059 #define o_sasl_ssf o_authz.sai_sasl_ssf
2061 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2063 typedef struct slap_callback {
2064 struct slap_callback *sc_next;
2065 slap_response *sc_response;
2066 slap_response *sc_cleanup;
2070 struct slap_overinfo;
2072 typedef struct slap_overinst {
2074 slap_response *on_response;
2075 struct slap_overinfo *on_info;
2076 struct slap_overinst *on_next;
2079 typedef struct slap_overinfo {
2081 BackendInfo *oi_orig;
2082 struct slap_overinst *oi_list;
2085 /* Should successive callbacks in a chain be processed? */
2086 #define SLAP_CB_FREEME 0x4000
2087 #define SLAP_CB_CONTINUE 0x8000
2090 * Paged Results state
2092 typedef unsigned long PagedResultsCookie;
2093 typedef struct slap_paged_state {
2096 PagedResultsCookie ps_cookie;
2098 } PagedResultsState;
2100 struct slap_csn_entry {
2101 struct berval ce_csn;
2102 unsigned long ce_opid;
2103 unsigned long ce_connid;
2104 #define SLAP_CSN_PENDING 1
2105 #define SLAP_CSN_COMMIT 2
2107 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2111 * Caches the result of a backend_group check for ACL evaluation
2113 typedef struct slap_gacl {
2114 struct slap_gacl *ga_next;
2117 AttributeDescription *ga_at;
2123 struct slap_control_ids {
2129 int sc_modifyIncrement;
2131 int sc_pagedResults;
2132 int sc_valuesReturnFilter;
2133 int sc_permissiveModify;
2136 int sc_searchOptions;
2142 * represents an operation pending from an ldap client
2144 typedef struct slap_op_header {
2145 unsigned long oh_opid; /* id of this operation */
2146 unsigned long oh_connid; /* id of conn initiating this op */
2147 struct slap_conn *oh_conn; /* connection spawning this op */
2149 ber_int_t oh_msgid; /* msgid of the request */
2150 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2152 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2154 void *oh_threadctx; /* thread pool thread context */
2155 void *oh_tmpmemctx; /* slab malloc context */
2156 BerMemoryFunctions *oh_tmpmfuncs;
2158 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2161 void *oh_pb; /* NS-SLAPI plugin */
2162 void *oh_extensions; /* NS-SLAPI plugin */
2166 typedef struct slap_op {
2169 #define o_opid o_hdr->oh_opid
2170 #define o_connid o_hdr->oh_connid
2171 #define o_conn o_hdr->oh_conn
2172 #define o_msgid o_hdr->oh_msgid
2173 #define o_protocol o_hdr->oh_protocol
2174 #define o_tid o_hdr->oh_tid
2175 #define o_threadctx o_hdr->oh_threadctx
2176 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2177 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2179 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2180 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2181 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2182 #define o_tmpfree o_tmpmfuncs->bmf_free
2184 #define o_log_prefix o_hdr->oh_log_prefix
2187 #define o_pb o_hdr->oh_pb
2188 #define o_extensions o_hdr->oh_extensions
2191 ber_tag_t o_tag; /* tag of the request */
2192 time_t o_time; /* time op was initiated */
2194 BackendDB *o_bd; /* backend DB processing this op */
2195 struct berval o_req_dn; /* DN of target of request */
2196 struct berval o_req_ndn;
2201 req_compare_s oq_compare;
2202 req_modify_s oq_modify;
2203 req_modrdn_s oq_modrdn;
2204 req_search_s oq_search;
2205 req_abandon_s oq_abandon;
2206 req_abandon_s oq_cancel;
2207 req_extended_s oq_extended;
2208 req_pwdexop_s oq_pwdexop;
2211 /* short hands for union members */
2212 #define oq_add o_request.oq_add
2213 #define oq_bind o_request.oq_bind
2214 #define oq_compare o_request.oq_compare
2215 #define oq_modify o_request.oq_modify
2216 #define oq_modrdn o_request.oq_modrdn
2217 #define oq_search o_request.oq_search
2218 #define oq_abandon o_request.oq_abandon
2219 #define oq_cancel o_request.oq_cancel
2220 #define oq_extended o_request.oq_extended
2221 #define oq_pwdexop o_request.oq_pwdexop
2223 /* short hands for inner request members */
2224 #define orb_method oq_bind.rb_method
2225 #define orb_cred oq_bind.rb_cred
2226 #define orb_edn oq_bind.rb_edn
2227 #define orb_ssf oq_bind.rb_ssf
2228 #define orb_tmp_mech oq_bind.rb_tmp_mech
2230 #define ors_scope oq_search.rs_scope
2231 #define ors_deref oq_search.rs_deref
2232 #define ors_slimit oq_search.rs_slimit
2233 #define ors_tlimit oq_search.rs_tlimit
2234 #define ors_limit oq_search.rs_limit
2235 #define ors_attrsonly oq_search.rs_attrsonly
2236 #define ors_attrs oq_search.rs_attrs
2237 #define ors_filter oq_search.rs_filter
2238 #define ors_filterstr oq_search.rs_filterstr
2239 #define ors_post_search_id oq_search.rs_post_search_id
2241 #define orr_newrdn oq_modrdn.rs_newrdn
2242 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2243 #define orr_newSup oq_modrdn.rs_newSup
2244 #define orr_nnewSup oq_modrdn.rs_nnewSup
2245 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2247 #define orc_ava oq_compare.rs_ava
2248 #define ora_e oq_add.rs_e
2249 #define ora_modlist oq_add.rs_modlist
2250 #define orn_msgid oq_abandon.rs_msgid
2251 #define orm_modlist oq_modify.rs_modlist
2252 #define orm_increment oq_modify.rs_increment
2254 #define ore_reqoid oq_extended.rs_reqoid
2255 #define ore_flags oq_extended.rs_flags
2256 #define ore_reqdata oq_extended.rs_reqdata
2257 volatile sig_atomic_t o_abandon; /* abandon flag */
2258 volatile sig_atomic_t o_cancel; /* cancel flag */
2259 #define SLAP_CANCEL_NONE 0x00
2260 #define SLAP_CANCEL_REQ 0x01
2261 #define SLAP_CANCEL_ACK 0x02
2262 #define SLAP_CANCEL_DONE 0x03
2264 GroupAssertion *o_groups;
2265 char o_do_not_cache; /* don't cache groups from this op */
2266 char o_is_auth_check; /* authorization in progress */
2268 #define SLAP_CONTROL_NONE 0
2269 #define SLAP_CONTROL_IGNORED 1
2270 #define SLAP_CONTROL_NONCRITICAL 2
2271 #define SLAP_CONTROL_CRITICAL 3
2272 #define SLAP_CONTROL_MASK 3
2274 /* spare bits for simple flags */
2275 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2276 #define SLAP_CONTROL_DATA0 0x10
2277 #define SLAP_CONTROL_DATA1 0x20
2278 #define SLAP_CONTROL_DATA2 0x40
2279 #define SLAP_CONTROL_DATA3 0x80
2282 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2284 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2285 void **o_controls; /* per-control state */
2287 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2288 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2290 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2291 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2292 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2294 #define get_subentries(op) _SCM((op)->o_subentries)
2295 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2297 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2298 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2300 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2301 #define get_assert(op) ((int)(op)->o_assert)
2302 #define o_assertion o_controls[slap_cids.sc_assert]
2303 #define get_assertion(op) ((op)->o_assertion)
2305 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2306 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2308 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2309 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2310 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2312 #define get_permissiveModify(op) (0)
2315 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2316 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2317 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2319 #define get_domainScope(op) (0)
2322 #ifdef LDAP_CONTROL_X_TREE_DELETE
2323 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2324 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2326 #define get_treeDelete(op) (0)
2329 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2330 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2332 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2333 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2335 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2336 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2338 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2340 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2342 AuthorizationInformation o_authz;
2344 BerElement *o_ber; /* ber of the request */
2345 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2346 slap_callback *o_callback; /* callback pointers */
2347 LDAPControl **o_ctrls; /* controls */
2349 void *o_private; /* anything the backend needs */
2351 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2354 int o_delete_glue_parent;
2357 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2359 #define send_ldap_error( op, rs, err, text ) do { \
2360 (rs)->sr_err = err; (rs)->sr_text = text; \
2361 (op->o_conn->c_send_ldap_result)( op, rs ); \
2363 #define send_ldap_discon( op, rs, err, text ) do { \
2364 (rs)->sr_err = err; (rs)->sr_text = text; \
2365 send_ldap_disconnect( op, rs ); \
2368 typedef void (SEND_LDAP_RESULT)(
2369 struct slap_op *op, struct slap_rep *rs);
2370 typedef int (SEND_SEARCH_ENTRY)(
2371 struct slap_op *op, struct slap_rep *rs);
2372 typedef int (SEND_SEARCH_REFERENCE)(
2373 struct slap_op *op, struct slap_rep *rs);
2374 typedef void (SEND_LDAP_EXTENDED)(
2375 struct slap_op *op, struct slap_rep *rs);
2376 typedef void (SEND_LDAP_INTERMEDIATE)(
2377 struct slap_op *op, struct slap_rep *rs);
2379 #define send_ldap_result( op, rs ) \
2380 ((op)->o_conn->c_send_ldap_result)( op, rs )
2381 #define send_search_entry( op, rs ) \
2382 ((op)->o_conn->c_send_search_entry)( op, rs )
2383 #define send_search_reference( op, rs ) \
2384 ((op)->o_conn->c_send_search_reference)( op, rs )
2385 #define send_ldap_extended( op, rs ) \
2386 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2387 #define send_ldap_intermediate( op, rs ) \
2388 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2390 typedef struct slap_listener Listener;
2393 * represents a connection from an ldap client
2395 typedef struct slap_conn {
2396 int c_struct_state; /* structure management state */
2397 int c_conn_state; /* connection state */
2398 int c_conn_idx; /* slot in connections array */
2400 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2401 Sockbuf *c_sb; /* ber connection stuff */
2403 /* only can be changed by connect_init */
2404 time_t c_starttime; /* when the connection was opened */
2405 time_t c_activitytime; /* when the connection was last used */
2406 unsigned long c_connid; /* id of this connection for stats*/
2408 struct berval c_peer_domain; /* DNS name of client */
2409 struct berval c_peer_name; /* peer name (trans=addr:port) */
2410 Listener *c_listener;
2411 #define c_listener_url c_listener->sl_url /* listener URL */
2412 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2414 /* only can be changed by binding thread */
2415 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2416 struct berval c_sasl_bind_mech; /* mech in progress */
2417 struct berval c_sasl_dn; /* temporary storage */
2419 /* authorization backend */
2420 Backend *c_authz_backend;
2422 AuthorizationInformation c_authz;
2424 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2426 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2427 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2429 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2430 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2432 BerElement *c_currentber; /* ber we're attempting to read */
2433 int c_writewaiter; /* true if writer is waiting */
2435 #define CONN_IS_TLS 1
2436 #define CONN_IS_UDP 2
2437 #define CONN_IS_CLIENT 3
2439 #ifdef LDAP_CONNECTIONLESS
2440 int c_is_udp; /* true if this is (C)LDAP over UDP */
2443 int c_is_tls; /* true if this LDAP over raw TLS */
2444 int c_needs_tls_accept; /* true if SSL_accept should be called */
2446 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2447 int c_sasl_done; /* SASL completed once */
2448 void *c_sasl_authctx; /* SASL authentication context */
2449 void *c_sasl_sockctx; /* SASL security layer context */
2450 void *c_sasl_extra; /* SASL session extra stuff */
2451 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2453 PagedResultsState c_pagedresults_state; /* paged result state */
2455 long c_n_ops_received; /* num of ops received (next op_id) */
2456 long c_n_ops_executing; /* num of ops currently executing */
2457 long c_n_ops_pending; /* num of ops pending execution */
2458 long c_n_ops_completed; /* num of ops completed */
2460 long c_n_get; /* num of get calls */
2461 long c_n_read; /* num of read calls */
2462 long c_n_write; /* num of write calls */
2464 void *c_pb; /* Netscape plugin */
2465 void *c_extensions; /* Netscape plugin */
2468 * Client connection handling
2470 ldap_pvt_thread_start_t *c_clientfunc;
2474 * These are the "callbacks" that are available for back-ends to
2475 * supply data back to connected clients that are connected
2476 * through the "front-end".
2478 SEND_LDAP_RESULT *c_send_ldap_result;
2479 SEND_SEARCH_ENTRY *c_send_search_entry;
2480 SEND_SEARCH_REFERENCE *c_send_search_reference;
2481 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2482 #ifdef LDAP_RES_INTERMEDIATE
2483 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2488 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2489 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2491 if ( ldap_debug & (level) ) \
2492 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2493 if ( ldap_syslog & (level) ) \
2494 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2497 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2498 #elif defined(LDAP_DEBUG)
2499 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2501 if ( ldap_debug & (level) ) \
2502 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2504 #define StatslogTest( level ) (ldap_debug & (level))
2506 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2507 #define StatslogTest( level ) (0)
2511 * listener; need to access it from monitor backend
2513 struct slap_listener {
2514 struct berval sl_url;
2515 struct berval sl_name;
2520 #ifdef LDAP_CONNECTIONLESS
2521 int sl_is_udp; /* UDP listener is also data port */
2523 int sl_is_mute; /* Listening is temporarily disabled */
2526 #define sl_addr sl_sa.sa_in_addr
2529 #ifdef SLAPD_MONITOR
2546 #endif /* SLAPD_MONITOR */
2548 typedef struct slap_counters_t {
2549 ldap_pvt_thread_mutex_t sc_sent_mutex;
2550 ldap_pvt_mp_t sc_bytes;
2551 ldap_pvt_mp_t sc_pdu;
2552 ldap_pvt_mp_t sc_entries;
2553 ldap_pvt_mp_t sc_refs;
2555 ldap_pvt_thread_mutex_t sc_ops_mutex;
2556 ldap_pvt_mp_t sc_ops_completed;
2557 ldap_pvt_mp_t sc_ops_initiated;
2558 #ifdef SLAPD_MONITOR
2559 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2560 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2561 #endif /* SLAPD_MONITOR */
2565 * Better know these all around slapd
2567 #define SLAP_LDAPDN_PRETTY 0x1
2568 #define SLAP_LDAPDN_MAXLEN 8192
2570 /* number of response controls supported */
2571 #define SLAP_MAX_RESPONSE_CONTROLS 6
2574 #define SLAP_CTRL_HIDE 0x00000000U
2576 #define SLAP_CTRL_HIDE 0x80000000U
2579 #define SLAP_CTRL_GLOBAL 0x00800000U
2580 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2582 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2583 #define SLAP_CTRL_ABANDON 0x00000001U
2584 #define SLAP_CTRL_ADD 0x00002002U
2585 #define SLAP_CTRL_BIND 0x00000004U
2586 #define SLAP_CTRL_COMPARE 0x00001008U
2587 #define SLAP_CTRL_DELETE 0x00002010U
2588 #define SLAP_CTRL_MODIFY 0x00002020U
2589 #define SLAP_CTRL_RENAME 0x00002040U
2590 #define SLAP_CTRL_SEARCH 0x00001080U
2591 #define SLAP_CTRL_UNBIND 0x00000100U
2593 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2594 #define SLAP_CTRL_UPDATE \
2595 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2596 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2598 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2601 LDAPControl *ctrl ));
2603 #define SLAP_SLAB_SIZE (1024*1024)
2604 #define SLAP_SLAB_STACK 1
2605 #define SLAP_SLAB_SOBLOCK 64
2607 #define SLAP_ZONE_ALLOC 1
2608 #undef SLAP_ZONE_ALLOC
2610 #ifdef LDAP_COMP_MATCH
2612 * Extensible Filter Definition
2614 * MatchingRuleAssertion := SEQUENCE {
2615 * matchingRule [1] MatchingRuleId OPTIONAL,
2616 * type [2] AttributeDescription OPTIONAL,
2617 * matchValue [3] AssertionValue,
2618 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2620 * Following ComponentFilter is contained in matchValue
2622 * ComponentAssertion ::= SEQUENCE {
2623 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2624 * useDefaultValues BOOLEAN DEFAULT TRUE,
2625 * rule MATCHING-RULE.&id,
2626 * value MATCHING-RULE.&AssertionType }
2628 * ComponentFilter ::= CHOICE {
2629 * item [0] ComponentAssertion,
2630 * and [1] SEQUENCE OF ComponentFilter,
2631 * or [2] SEQUENCE OF ComponentFilter,
2632 * not [3] ComponentFilter }
2635 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2636 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2637 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2638 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2639 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2640 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2641 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2642 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2643 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2645 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2646 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2647 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2648 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2649 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2651 typedef struct slap_component_id {
2653 struct slap_component_id *ci_next;
2655 union comp_id_value{
2656 BerValue ci_identifier;
2657 ber_int_t ci_from_beginning;
2659 ber_int_t ci_from_end;
2660 ber_int_t ci_content;
2661 BerValue ci_select_value;
2666 typedef struct slap_component_reference {
2667 ComponentId *cr_list;
2668 ComponentId *cr_curr;
2669 struct berval cr_string;
2671 /* Component Indexing */
2673 slap_mask_t cr_indexmask;
2674 AttributeDescription* cr_ad;
2676 struct slap_component_reference* cr_next;
2677 } ComponentReference;
2679 typedef struct slap_component_assertion {
2680 ComponentReference *ca_comp_ref;
2681 ber_int_t ca_use_def;
2682 MatchingRule *ca_ma_rule;
2683 struct berval ca_ma_value;
2684 ComponentData ca_comp_data; /* componentized assertion */
2685 struct slap_component_filter *ca_cf;
2686 MatchingRuleAssertion *ca_mra;
2687 } ComponentAssertion;
2689 typedef struct slap_component_filter {
2690 ber_tag_t cf_choice;
2692 ber_int_t cf_un_result;
2693 ComponentAssertion *cf_un_ca;
2694 struct slap_component_filter *cf_un_complex;
2697 #define cf_ca cf_un.cf_un_ca
2698 #define cf_result cf_un.cf_un_result
2699 #define cf_and cf_un.cf_un_complex
2700 #define cf_or cf_un.cf_un_complex
2701 #define cf_not cf_un.cf_un_complex
2702 #define cf_any cf_un.cf_un_complex
2704 struct slap_component_filter *cf_next;
2707 typedef struct slap_component_assertion_value {
2711 } ComponentAssertionValue;
2713 typedef int encoder_func LDAP_P((
2717 struct slap_component_syntax_info;
2719 typedef int gser_decoder_func LDAP_P((
2722 struct slap_component_syntax_info** comp_syn_info,
2726 typedef int comp_free_func LDAP_P((
2729 typedef int ber_decoder_func LDAP_P((
2734 struct slap_component_syntax_info* comp_syn_info,
2738 typedef int ber_tag_decoder_func LDAP_P((
2741 struct slap_component_syntax_info* comp_syn_info,
2745 typedef void* extract_component_from_id_func LDAP_P((
2747 ComponentReference* cr,
2750 typedef void* convert_attr_to_comp_func LDAP_P ((
2753 struct berval* bv ));
2755 typedef void* alloc_nibble_func LDAP_P ((
2757 int increment_size ));
2759 typedef void free_nibble_func LDAP_P ((
2762 struct slap_component_syntax_info;
2763 typedef void convert_assert_to_comp_func LDAP_P ((
2765 struct slap_component_syntax_info* csi_attr,
2767 struct slap_component_syntax_info** csi,
2771 typedef int convert_asn_to_ldap_func LDAP_P ((
2772 struct slap_component_syntax_info* csi,
2773 struct berval *bv ));
2775 typedef void free_component_func LDAP_P ((
2778 typedef int test_component_func LDAP_P ((
2780 void* assert_mem_op,
2781 struct slap_component_syntax_info* csi,
2782 struct slap_component_assertion* ca));
2784 typedef void* test_membership_func LDAP_P ((
2787 typedef void* get_component_info_func LDAP_P ((
2790 struct slap_component_syntax_info;
2792 typedef int component_encoder_func LDAP_P ((
2794 struct slap_component_syntax_info* csi,
2795 struct berval* nvals ));
2797 typedef int allcomponent_matching_func LDAP_P((
2799 struct slap_component_syntax_info* comp1,
2800 struct slap_component_syntax_info* comp));
2802 typedef struct slap_component_desc {
2803 /* Don't change the order of following four fields */
2805 AttributeType *cd_comp_type;
2806 struct berval cd_ad_type;/* ad_type, ad_cname */
2807 struct berval cd_ad_cname;/* ad_type, ad_cname */
2808 unsigned cd_flags; /*ad_flags*/
2811 encoder_func *cd_ldap_encoder;
2812 encoder_func *cd_gser_encoder;
2813 encoder_func *cd_ber_encoder;
2814 gser_decoder_func *cd_gser_decoder;
2815 ber_decoder_func *cd_ber_decoder;
2816 comp_free_func *cd_free;
2817 extract_component_from_id_func* cd_extract_i;
2818 allcomponent_matching_func *cd_all_match;
2821 typedef struct slap_component_syntax_info {
2823 ComponentDesc* csi_comp_desc;
2824 } ComponentSyntaxInfo;
2828 /* slab heap data structures */
2830 struct slab_object {
2833 LDAP_LIST_ENTRY(slab_object) so_link;
2842 unsigned char **sh_map;
2843 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2844 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2847 #ifdef SLAP_ZONE_ALLOC
2848 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2849 #define SLAP_ZONE_SHIFT 19
2850 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2851 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2852 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2853 #define SLAP_ZONE_ZOBLOCK 256
2855 struct zone_object {
2860 LDAP_LIST_ENTRY(zone_object) zo_link;
2863 struct zone_latency_history {
2865 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2876 ldap_pvt_thread_rdwr_t *zh_znlock;
2877 Avlnode *zh_zonetree;
2878 unsigned char ***zh_maps;
2880 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2881 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2882 ldap_pvt_thread_mutex_t zh_mutex;
2883 ldap_pvt_thread_rdwr_t zh_lock;
2884 double zh_ema_latency;
2885 unsigned long zh_ema_samples;
2886 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2887 zh_latency_history_queue;
2888 int zh_latency_history_qlen;
2889 int zh_latency_jump;
2894 #define SLAP_BACKEND_INIT_MODULE(b) \
2896 init_module( int argc, char *argv[] ) \
2899 memset( &bi, '\0', sizeof( bi ) ); \
2901 bi.bi_init = b ## _back_initialize; \
2902 backend_add( &bi ); \
2908 #include "proto-slap.h"
2910 #endif /* _SLAP_H_ */