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"
63 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
64 #define SLAP_ACL_HONOR_MANAGE /* not yet implemented */
66 #define LDAP_COMP_MATCH
67 #define LDAP_DYNAMIC_OBJECTS
68 #define LDAP_SYNC_TIMESTAMP
69 #define LDAP_COLLECTIVE_ATTRIBUTES
70 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
72 #define SLAP_USE_CONFDIR /* partially implemented */
75 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
81 * SLAPD Memory allocation macros
83 * Unlike ch_*() routines, these routines do not assert() upon
84 * allocation error. They are intended to be used instead of
85 * ch_*() routines where the caller has implemented proper
86 * checking for and handling of allocation errors.
88 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
90 #define SLAP_MALLOC(s) ber_memalloc((s))
91 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
92 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
93 #define SLAP_FREE(p) ber_memfree((p))
94 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
95 #define SLAP_STRDUP(s) ber_strdup((s))
96 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
99 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
102 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
103 #define SLAPD_ANONYMOUS "cn=anonymous"
105 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
106 * This is a value used internally by the backends. It is needed to allow
107 * adding values that already exist without getting an error as required by
108 * modrdn when the new rdn was already an attribute value itself.
110 #define SLAP_MOD_SOFTADD 0x1000
112 #define MAXREMATCHES (100)
114 #define SLAP_MAX_WORKER_THREADS (16)
116 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
117 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
119 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
120 #define SLAP_CONN_MAX_PENDING_AUTH 1000
122 #define SLAP_TEXT_BUFLEN (256)
124 /* psuedo error code indicating abandoned operation */
125 #define SLAPD_ABANDON (-1024)
127 /* psuedo error code indicating disconnect */
128 #define SLAPD_DISCONNECT (-1025)
130 /* unknown config file directive */
131 #define SLAP_CONF_UNKNOWN (-1026)
133 /* We assume "C" locale, that is US-ASCII */
134 #define ASCII_SPACE(c) ( (c) == ' ' )
135 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
136 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
137 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
138 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
139 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
140 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
141 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
142 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
143 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
144 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
146 #define SLAP_NIBBLE(c) ((c)&0x0f)
147 #define SLAP_ESCAPE_CHAR ('\\')
148 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
149 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
151 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
152 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
154 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
155 /* NOTE: for consistency, this macro must only operate
156 * on normalized/pretty DN, such that ';' is never used
157 * as RDN separator, and all occurrences of ';' must be escaped */
158 #define DN_SEPARATOR(c) ((c) == ',')
159 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
160 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
161 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
163 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
164 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
165 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
166 #define OID_SEPARATOR(c) ( (c) == '.' )
167 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
169 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
170 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
172 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
173 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
175 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
177 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
178 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
179 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
180 (c) == '?' || (c) == ' ' || (c) == '=' )
181 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
183 /* must match in schema_init.c */
184 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
185 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
186 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
187 #define SLAPD_GROUP_ATTR "member"
188 #define SLAPD_GROUP_CLASS "groupOfNames"
189 #define SLAPD_ROLE_ATTR "roleOccupant"
190 #define SLAPD_ROLE_CLASS "organizationalRole"
192 #ifdef SLAPD_ACI_ENABLED
193 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
196 /* change this to "OpenLDAPset" */
197 #define SLAPD_ACI_SET_ATTR "template"
199 #define SLAPD_TOP_OID "2.5.6.0"
201 LDAP_SLAPD_V (int) slap_debug;
203 typedef unsigned long slap_mask_t;
205 /* Security Strength Factor */
206 typedef unsigned slap_ssf_t;
208 typedef struct slap_ssf_set {
210 slap_ssf_t sss_transport;
213 slap_ssf_t sss_update_ssf;
214 slap_ssf_t sss_update_transport;
215 slap_ssf_t sss_update_tls;
216 slap_ssf_t sss_update_sasl;
217 slap_ssf_t sss_simple_bind;
220 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
221 #define SLAP_GETDN_AUTHCID 2
222 #define SLAP_GETDN_AUTHZID 4
227 #define SLAP_INDEX_TYPE 0x00FFUL
228 #define SLAP_INDEX_UNDEFINED 0x0001UL
229 #define SLAP_INDEX_PRESENT 0x0002UL
230 #define SLAP_INDEX_EQUALITY 0x0004UL
231 #define SLAP_INDEX_APPROX 0x0008UL
232 #define SLAP_INDEX_SUBSTR 0x0010UL
233 #define SLAP_INDEX_EXTENDED 0x0020UL
235 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
237 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
239 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
241 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
242 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
243 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
244 #define SLAP_INDEX_SUBSTR_DEFAULT \
245 ( SLAP_INDEX_SUBSTR \
246 | SLAP_INDEX_SUBSTR_INITIAL \
247 | SLAP_INDEX_SUBSTR_ANY \
248 | SLAP_INDEX_SUBSTR_FINAL )
250 /* defaults for initial/final substring indices */
251 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
252 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
254 /* defaults for any substring indices */
255 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
256 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
258 #define SLAP_INDEX_FLAGS 0xF000UL
259 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
260 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
263 * there is a single index for each attribute. these prefixes ensure
264 * that there is no collision among keys.
266 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
267 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
268 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
269 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
270 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
271 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
273 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
274 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
275 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
276 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
277 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
280 * represents schema information for a database
282 #define SLAP_SCHERR_OUTOFMEM 1
283 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
284 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
285 #define SLAP_SCHERR_CLASS_BAD_SUP 4
286 #define SLAP_SCHERR_CLASS_DUP 5
287 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
288 #define SLAP_SCHERR_ATTR_BAD_MR 7
289 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
290 #define SLAP_SCHERR_ATTR_BAD_SUP 9
291 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
292 #define SLAP_SCHERR_ATTR_DUP 11
293 #define SLAP_SCHERR_MR_NOT_FOUND 12
294 #define SLAP_SCHERR_MR_INCOMPLETE 13
295 #define SLAP_SCHERR_MR_DUP 14
296 #define SLAP_SCHERR_SYN_NOT_FOUND 15
297 #define SLAP_SCHERR_SYN_DUP 16
298 #define SLAP_SCHERR_NO_NAME 17
299 #define SLAP_SCHERR_NOT_SUPPORTED 18
300 #define SLAP_SCHERR_BAD_DESCR 19
301 #define SLAP_SCHERR_OIDM 20
302 #define SLAP_SCHERR_CR_DUP 21
303 #define SLAP_SCHERR_CR_BAD_STRUCT 22
304 #define SLAP_SCHERR_CR_BAD_AUX 23
305 #define SLAP_SCHERR_CR_BAD_AT 24
306 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
308 typedef union slap_sockaddr {
309 struct sockaddr sa_addr;
310 struct sockaddr_in sa_in_addr;
312 struct sockaddr_storage sa_storage;
313 struct sockaddr_in6 sa_in6_addr;
316 struct sockaddr_un sa_un_addr;
321 extern int slap_inet4or6;
324 typedef struct slap_oid_macro {
325 struct berval som_oid;
328 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
330 LDAP_STAILQ_ENTRY(slap_oid_macro) som_next;
333 /* forward declarations */
335 struct slap_matching_rule;
337 typedef int slap_syntax_validate_func LDAP_P((
338 struct slap_syntax *syntax,
339 struct berval * in));
341 typedef int slap_syntax_transform_func LDAP_P((
342 struct slap_syntax *syntax,
347 #ifdef LDAP_COMP_MATCH
348 typedef void* slap_component_transform_func LDAP_P((
349 struct berval * in ));
350 struct ComponentDesc;
353 typedef struct slap_syntax {
355 #define ssyn_oid ssyn_syn.syn_oid
356 #define ssyn_desc ssyn_syn.syn_desc
357 #define ssyn_extensions ssyn_syn.syn_extensions
360 ber_len_t ssyn_oidlen;
361 * has been replaced by a struct berval that uses the value
362 * provided by ssyn_syn.syn_oid; a macro that expands to
363 * the bv_len field of the berval is provided for backward
364 * compatibility. CAUTION: NEVER FREE THE BERVAL
366 struct berval ssyn_bvoid;
367 #define ssyn_oidlen ssyn_bvoid.bv_len
369 unsigned int ssyn_flags;
371 #define SLAP_SYNTAX_NONE 0x0000U
372 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
373 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
374 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
376 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
378 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
381 slap_syntax_validate_func *ssyn_validate;
382 slap_syntax_transform_func *ssyn_pretty;
384 #ifdef SLAPD_BINARY_CONVERSION
385 /* convert to and from binary */
386 slap_syntax_transform_func *ssyn_ber2str;
387 slap_syntax_transform_func *ssyn_str2ber;
389 #ifdef LDAP_COMP_MATCH
390 slap_component_transform_func *ssyn_attr2comp;
391 struct ComponentDesc* ssync_comp_syntax;
394 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
397 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
398 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
399 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
400 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
401 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
403 typedef struct slap_syntax_defs_rec {
406 slap_syntax_validate_func *sd_validate;
407 slap_syntax_transform_func *sd_pretty;
408 #ifdef SLAPD_BINARY_CONVERSION
409 slap_syntax_transform_func *sd_ber2str;
410 slap_syntax_transform_func *sd_str2ber;
412 } slap_syntax_defs_rec;
414 /* X -> Y Converter */
415 typedef int slap_mr_convert_func LDAP_P((
421 typedef int slap_mr_normalize_func LDAP_P((
423 struct slap_syntax *syntax, /* NULL if in is asserted value */
424 struct slap_matching_rule *mr,
429 /* Match (compare) function */
430 typedef int slap_mr_match_func LDAP_P((
433 struct slap_syntax *syntax, /* syntax of stored value */
434 struct slap_matching_rule *mr,
435 struct berval * value,
436 void * assertValue ));
438 /* Index generation function */
439 typedef int slap_mr_indexer_func LDAP_P((
442 struct slap_syntax *syntax, /* syntax of stored value */
443 struct slap_matching_rule *mr,
444 struct berval *prefix,
449 /* Filter index function */
450 typedef int slap_mr_filter_func LDAP_P((
453 struct slap_syntax *syntax, /* syntax of stored value */
454 struct slap_matching_rule *mr,
455 struct berval *prefix,
460 typedef struct slap_matching_rule_use MatchingRuleUse;
462 typedef struct slap_matching_rule {
463 LDAPMatchingRule smr_mrule;
464 MatchingRuleUse *smr_mru;
465 /* RFC2252 string representation */
466 struct berval smr_str;
469 * ber_len_t smr_oidlen;
470 * has been replaced by a struct berval that uses the value
471 * provided by smr_mrule.mr_oid; a macro that expands to
472 * the bv_len field of the berval is provided for backward
473 * compatibility. CAUTION: NEVER FREE THE BERVAL
475 struct berval smr_bvoid;
476 #define smr_oidlen smr_bvoid.bv_len
478 slap_mask_t smr_usage;
481 #define SLAP_MR_HIDE 0x0000U
483 #define SLAP_MR_HIDE 0x8000U
486 #define SLAP_MR_TYPE_MASK 0x0F00U
487 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
488 #define SLAP_MR_USAGE 0x000FU
490 #define SLAP_MR_NONE 0x0000U
491 #define SLAP_MR_EQUALITY 0x0100U
492 #define SLAP_MR_ORDERING 0x0200U
493 #define SLAP_MR_SUBSTR 0x0400U
494 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
495 #define SLAP_MR_ORDERED_INDEX 0x1000U
496 #ifdef LDAP_COMP_MATCH
497 #define SLAP_MR_COMPONENT 0x2000U
500 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
502 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
503 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
504 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
508 * The asserted value, depending on the particular usage,
509 * is expected to conform to either the assertion syntax
510 * or the attribute syntax. In some cases, the syntax of
511 * the value is known. If so, these flags indicate which
512 * syntax the value is expected to conform to. If not,
513 * neither of these flags is set (until the syntax of the
514 * provided value is determined). If the value is of the
515 * attribute syntax, the flag is changed once a value of
516 * the assertion syntax is derived from the provided value.
518 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
519 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
520 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
522 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
523 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
524 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
525 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
527 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
528 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
530 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
533 /* either or both the asserted value or attribute value
534 * may be provided in normalized form
536 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
537 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
539 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
540 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
541 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
542 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
544 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
545 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
546 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
547 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
548 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
549 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
551 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
552 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
553 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
554 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
557 slap_mr_convert_func *smr_convert;
558 slap_mr_normalize_func *smr_normalize;
559 slap_mr_match_func *smr_match;
560 slap_mr_indexer_func *smr_indexer;
561 slap_mr_filter_func *smr_filter;
564 * null terminated array of syntaxes compatible with this syntax
565 * note: when MS_EXT is set, this MUST NOT contain the assertion
566 * syntax of the rule. When MS_EXT is not set, it MAY.
568 Syntax **smr_compat_syntaxes;
571 * For equality rules, refers to an associated approximate rule.
572 * For non-equality rules, refers to an associated equality rule.
574 struct slap_matching_rule *smr_associated;
576 #define SLAP_MR_ASSOCIATED(mr,amr) \
577 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
579 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
581 #define smr_oid smr_mrule.mr_oid
582 #define smr_names smr_mrule.mr_names
583 #define smr_desc smr_mrule.mr_desc
584 #define smr_obsolete smr_mrule.mr_obsolete
585 #define smr_syntax_oid smr_mrule.mr_syntax_oid
586 #define smr_extensions smr_mrule.mr_extensions
589 struct slap_matching_rule_use {
590 LDAPMatchingRuleUse smru_mruleuse;
591 MatchingRule *smru_mr;
592 /* RFC2252 string representation */
593 struct berval smru_str;
595 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
597 #define smru_oid smru_mruleuse.mru_oid
598 #define smru_names smru_mruleuse.mru_names
599 #define smru_desc smru_mruleuse.mru_desc
600 #define smru_obsolete smru_mruleuse.mru_obsolete
601 #define smru_applies_oids smru_mruleuse.mru_applies_oids
603 #define smru_usage smru_mr->smr_usage
604 } /* MatchingRuleUse */ ;
606 typedef struct slap_mrule_defs_rec {
608 slap_mask_t mrd_usage;
609 char ** mrd_compat_syntaxes;
610 slap_mr_convert_func * mrd_convert;
611 slap_mr_normalize_func * mrd_normalize;
612 slap_mr_match_func * mrd_match;
613 slap_mr_indexer_func * mrd_indexer;
614 slap_mr_filter_func * mrd_filter;
616 /* For equality rule, this may refer to an associated approximate rule */
617 /* For non-equality rule, this may refer to an associated equality rule */
618 char * mrd_associated;
619 } slap_mrule_defs_rec;
621 struct slap_backend_db;
625 typedef int (AttributeTypeSchemaCheckFN)(
626 struct slap_backend_db *be,
627 struct slap_entry *e,
628 struct slap_attr *attr,
630 char *textbuf, size_t textlen );
632 typedef struct slap_attribute_type {
633 LDAPAttributeType sat_atype;
634 struct berval sat_cname;
635 struct slap_attribute_type *sat_sup;
636 struct slap_attribute_type **sat_subtypes;
637 MatchingRule *sat_equality;
638 MatchingRule *sat_approx;
639 MatchingRule *sat_ordering;
640 MatchingRule *sat_substr;
643 AttributeTypeSchemaCheckFN *sat_check;
645 #define SLAP_AT_NONE 0x0000U
646 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
647 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
649 #define SLAP_AT_HIDE 0x0000U /* publish everything */
651 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
653 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
655 #define SLAP_AT_ORDERED 0x0001U /* values are ordered */
656 #define SLAP_AT_HARDCODE 0x10000U /* This is hardcoded schema */
658 slap_mask_t sat_flags;
660 LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
662 #define sat_oid sat_atype.at_oid
663 #define sat_names sat_atype.at_names
664 #define sat_desc sat_atype.at_desc
665 #define sat_obsolete sat_atype.at_obsolete
666 #define sat_sup_oid sat_atype.at_sup_oid
667 #define sat_equality_oid sat_atype.at_equality_oid
668 #define sat_ordering_oid sat_atype.at_ordering_oid
669 #define sat_substr_oid sat_atype.at_substr_oid
670 #define sat_syntax_oid sat_atype.at_syntax_oid
671 #define sat_single_value sat_atype.at_single_value
672 #define sat_collective sat_atype.at_collective
673 #define sat_no_user_mod sat_atype.at_no_user_mod
674 #define sat_usage sat_atype.at_usage
675 #define sat_extensions sat_atype.at_extensions
677 struct slap_attr_desc *sat_ad;
678 ldap_pvt_thread_mutex_t sat_ad_mutex;
681 #define is_at_operational(at) ((at)->sat_usage)
682 #define is_at_single_value(at) ((at)->sat_single_value)
683 #define is_at_collective(at) ((at)->sat_collective)
684 #define is_at_obsolete(at) ((at)->sat_obsolete)
685 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
687 struct slap_object_class;
689 typedef int (ObjectClassSchemaCheckFN)(
690 struct slap_backend_db *be,
691 struct slap_entry *e,
692 struct slap_object_class *oc,
694 char *textbuf, size_t textlen );
696 typedef struct slap_object_class {
697 LDAPObjectClass soc_oclass;
698 struct berval soc_cname;
699 struct slap_object_class **soc_sups;
700 AttributeType **soc_required;
701 AttributeType **soc_allowed;
702 ObjectClassSchemaCheckFN *soc_check;
703 slap_mask_t soc_flags;
704 #define soc_oid soc_oclass.oc_oid
705 #define soc_names soc_oclass.oc_names
706 #define soc_desc soc_oclass.oc_desc
707 #define soc_obsolete soc_oclass.oc_obsolete
708 #define soc_sup_oids soc_oclass.oc_sup_oids
709 #define soc_kind soc_oclass.oc_kind
710 #define soc_at_oids_must soc_oclass.oc_at_oids_must
711 #define soc_at_oids_may soc_oclass.oc_at_oids_may
712 #define soc_extensions soc_oclass.oc_extensions
714 LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
717 #define SLAP_OC_ALIAS 0x0001
718 #define SLAP_OC_REFERRAL 0x0002
719 #define SLAP_OC_SUBENTRY 0x0004
720 #define SLAP_OC_DYNAMICOBJECT 0x0008
721 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
722 #define SLAP_OC_GLUE 0x0020
723 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
724 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
725 #define SLAP_OC__MASK 0x00FF
726 #define SLAP_OC__END 0x0100
727 #define SLAP_OC_OPERATIONAL 0x4000
729 #define SLAP_OC_HIDE 0x0000
731 #define SLAP_OC_HIDE 0x8000
733 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
738 typedef struct slap_content_rule {
739 LDAPContentRule scr_crule;
740 ObjectClass *scr_sclass;
741 ObjectClass **scr_auxiliaries; /* optional */
742 AttributeType **scr_required; /* optional */
743 AttributeType **scr_allowed; /* optional */
744 AttributeType **scr_precluded; /* optional */
745 #define scr_oid scr_crule.cr_oid
746 #define scr_names scr_crule.cr_names
747 #define scr_desc scr_crule.cr_desc
748 #define scr_obsolete scr_crule.cr_obsolete
749 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
750 #define scr_at_oids_must scr_crule.cr_at_oids_must
751 #define scr_at_oids_may scr_crule.cr_at_oids_may
752 #define scr_at_oids_not scr_crule.cr_at_oids_not
754 #define SLAP_CR_HARDCODE 0x10000U
757 LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
760 /* Represents a recognized attribute description ( type + options ). */
761 typedef struct slap_attr_desc {
762 struct slap_attr_desc *ad_next;
763 AttributeType *ad_type; /* attribute type, must be specified */
764 struct berval ad_cname; /* canonical name, must be specified */
765 struct berval ad_tags; /* empty if no tagging options */
767 #define SLAP_DESC_NONE 0x00U
768 #define SLAP_DESC_BINARY 0x01U
769 #define SLAP_DESC_TAG_RANGE 0x80U
770 } AttributeDescription;
772 typedef struct slap_attr_name {
773 struct berval an_name;
774 AttributeDescription *an_desc;
779 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
780 #define slap_ad_is_tag_range(ad) \
781 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
782 #define slap_ad_is_binary(ad) \
783 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
786 * pointers to schema elements used internally
788 struct slap_internal_schema {
790 ObjectClass *si_oc_top;
791 ObjectClass *si_oc_extensibleObject;
792 ObjectClass *si_oc_alias;
793 ObjectClass *si_oc_referral;
794 ObjectClass *si_oc_rootdse;
795 ObjectClass *si_oc_subentry;
796 ObjectClass *si_oc_subschema;
797 ObjectClass *si_oc_collectiveAttributeSubentry;
798 ObjectClass *si_oc_dynamicObject;
800 ObjectClass *si_oc_glue;
801 ObjectClass *si_oc_syncConsumerSubentry;
802 ObjectClass *si_oc_syncProviderSubentry;
804 /* objectClass attribute descriptions */
805 AttributeDescription *si_ad_objectClass;
807 /* operational attribute descriptions */
808 AttributeDescription *si_ad_structuralObjectClass;
809 AttributeDescription *si_ad_creatorsName;
810 AttributeDescription *si_ad_createTimestamp;
811 AttributeDescription *si_ad_modifiersName;
812 AttributeDescription *si_ad_modifyTimestamp;
813 AttributeDescription *si_ad_hasSubordinates;
814 AttributeDescription *si_ad_subschemaSubentry;
815 AttributeDescription *si_ad_collectiveSubentries;
816 AttributeDescription *si_ad_collectiveExclusions;
817 AttributeDescription *si_ad_entryDN;
818 AttributeDescription *si_ad_entryUUID;
819 AttributeDescription *si_ad_entryCSN;
820 AttributeDescription *si_ad_namingCSN;
822 AttributeDescription *si_ad_dseType;
823 AttributeDescription *si_ad_syncreplCookie;
824 AttributeDescription *si_ad_syncTimestamp;
825 AttributeDescription *si_ad_contextCSN;
827 /* root DSE attribute descriptions */
828 AttributeDescription *si_ad_altServer;
829 AttributeDescription *si_ad_namingContexts;
830 AttributeDescription *si_ad_supportedControl;
831 AttributeDescription *si_ad_supportedExtension;
832 AttributeDescription *si_ad_supportedLDAPVersion;
833 AttributeDescription *si_ad_supportedSASLMechanisms;
834 AttributeDescription *si_ad_supportedFeatures;
835 AttributeDescription *si_ad_monitorContext;
836 AttributeDescription *si_ad_vendorName;
837 AttributeDescription *si_ad_vendorVersion;
838 AttributeDescription *si_ad_configContext;
840 /* subentry attribute descriptions */
841 AttributeDescription *si_ad_administrativeRole;
842 AttributeDescription *si_ad_subtreeSpecification;
844 /* subschema subentry attribute descriptions */
845 AttributeDescription *si_ad_attributeTypes;
846 AttributeDescription *si_ad_ditContentRules;
847 AttributeDescription *si_ad_ditStructureRules;
848 AttributeDescription *si_ad_ldapSyntaxes;
849 AttributeDescription *si_ad_matchingRules;
850 AttributeDescription *si_ad_matchingRuleUse;
851 AttributeDescription *si_ad_nameForms;
852 AttributeDescription *si_ad_objectClasses;
854 /* Aliases & Referrals */
855 AttributeDescription *si_ad_aliasedObjectName;
856 AttributeDescription *si_ad_ref;
858 /* Access Control Internals */
859 AttributeDescription *si_ad_entry;
860 AttributeDescription *si_ad_children;
861 AttributeDescription *si_ad_saslAuthzTo;
862 AttributeDescription *si_ad_saslAuthzFrom;
863 #ifdef SLAPD_ACI_ENABLED
864 AttributeDescription *si_ad_aci;
867 /* dynamic entries */
868 AttributeDescription *si_ad_entryTtl;
869 AttributeDescription *si_ad_dynamicSubtrees;
871 /* Other attributes descriptions */
872 AttributeDescription *si_ad_distinguishedName;
873 AttributeDescription *si_ad_name;
874 AttributeDescription *si_ad_cn;
875 AttributeDescription *si_ad_uid;
876 AttributeDescription *si_ad_userPassword;
877 AttributeDescription *si_ad_labeledURI;
878 #ifdef SLAPD_AUTHPASSWD
879 AttributeDescription *si_ad_authPassword;
881 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
882 AttributeDescription *si_ad_krbName;
885 /* Undefined Attribute Type */
886 AttributeType *si_at_undefined;
889 MatchingRule *si_mr_distinguishedNameMatch;
890 MatchingRule *si_mr_dnSubtreeMatch;
891 MatchingRule *si_mr_dnOneLevelMatch;
892 MatchingRule *si_mr_dnSubordinateMatch;
893 MatchingRule *si_mr_dnSuperiorMatch;
894 MatchingRule *si_mr_caseExactMatch;
895 MatchingRule *si_mr_caseExactSubstringsMatch;
896 MatchingRule *si_mr_caseExactIA5Match;
897 MatchingRule *si_mr_integerMatch;
898 MatchingRule *si_mr_integerFirstComponentMatch;
899 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
902 Syntax *si_syn_directoryString;
903 Syntax *si_syn_distinguishedName;
904 Syntax *si_syn_integer;
905 Syntax *si_syn_octetString;
907 /* Schema Syntaxes */
908 Syntax *si_syn_attributeTypeDesc;
909 Syntax *si_syn_ditContentRuleDesc;
910 Syntax *si_syn_ditStructureRuleDesc;
911 Syntax *si_syn_ldapSyntaxDesc;
912 Syntax *si_syn_matchingRuleDesc;
913 Syntax *si_syn_matchingRuleUseDesc;
914 Syntax *si_syn_nameFormDesc;
915 Syntax *si_syn_objectClassDesc;
918 typedef struct slap_attr_assertion {
919 AttributeDescription *aa_desc;
920 struct berval aa_value;
921 #ifdef LDAP_COMP_MATCH
922 struct slap_component_filter *aa_cf;/* for attribute aliasing */
924 } AttributeAssertion;
926 typedef struct slap_ss_assertion {
927 AttributeDescription *sa_desc;
928 struct berval sa_initial;
929 struct berval *sa_any;
930 struct berval sa_final;
931 } SubstringsAssertion;
933 #ifdef LDAP_COMP_MATCH
934 struct slap_component_filter;
937 typedef struct slap_mr_assertion {
938 MatchingRule *ma_rule; /* optional */
939 struct berval ma_rule_text; /* optional */
940 AttributeDescription *ma_desc; /* optional */
941 int ma_dnattrs; /* boolean */
942 struct berval ma_value; /* required */
943 #ifdef LDAP_COMP_MATCH
944 struct slap_component_filter* ma_cf; /* component filter */
946 } MatchingRuleAssertion;
949 * represents a search filter
951 typedef struct slap_filter {
952 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
953 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
954 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
955 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
956 #ifdef LDAP_SCOPE_SUBORDINATE
957 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
961 /* precomputed result */
962 ber_int_t f_un_result;
965 struct berval *f_un_dn;
968 AttributeDescription *f_un_desc;
970 /* simple value assertion */
971 AttributeAssertion *f_un_ava;
973 /* substring assertion */
974 SubstringsAssertion *f_un_ssa;
976 /* matching rule assertion */
977 MatchingRuleAssertion *f_un_mra;
979 #define f_dn f_un.f_un_dn
980 #define f_desc f_un.f_un_desc
981 #define f_ava f_un.f_un_ava
982 #define f_av_desc f_un.f_un_ava->aa_desc
983 #define f_av_value f_un.f_un_ava->aa_value
984 #define f_sub f_un.f_un_ssa
985 #define f_sub_desc f_un.f_un_ssa->sa_desc
986 #define f_sub_initial f_un.f_un_ssa->sa_initial
987 #define f_sub_any f_un.f_un_ssa->sa_any
988 #define f_sub_final f_un.f_un_ssa->sa_final
989 #define f_mra f_un.f_un_mra
990 #define f_mr_rule f_un.f_un_mra->ma_rule
991 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
992 #define f_mr_desc f_un.f_un_mra->ma_desc
993 #define f_mr_value f_un.f_un_mra->ma_value
994 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
997 struct slap_filter *f_un_complex;
1000 #define f_result f_un.f_un_result
1001 #define f_and f_un.f_un_complex
1002 #define f_or f_un.f_un_complex
1003 #define f_not f_un.f_un_complex
1004 #define f_list f_un.f_un_complex
1006 struct slap_filter *f_next;
1009 /* compare routines can return undefined */
1010 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1012 typedef struct slap_valuesreturnfilter {
1013 ber_tag_t vrf_choice;
1016 /* precomputed result */
1017 ber_int_t vrf_un_result;
1023 AttributeDescription *vrf_un_desc;
1025 /* simple value assertion */
1026 AttributeAssertion *vrf_un_ava;
1028 /* substring assertion */
1029 SubstringsAssertion *vrf_un_ssa;
1031 /* matching rule assertion */
1032 MatchingRuleAssertion *vrf_un_mra;
1034 #define vrf_result vrf_un.vrf_un_result
1035 #define vrf_dn vrf_un.vrf_un_dn
1036 #define vrf_desc vrf_un.vrf_un_desc
1037 #define vrf_ava vrf_un.vrf_un_ava
1038 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1039 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1040 #define vrf_ssa vrf_un.vrf_un_ssa
1041 #define vrf_sub vrf_un.vrf_un_ssa
1042 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1043 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1044 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1045 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1046 #define vrf_mra vrf_un.vrf_un_mra
1047 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1048 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1049 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1050 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1051 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1056 struct slap_valuesreturnfilter *vrf_next;
1057 } ValuesReturnFilter;
1059 #ifdef LDAP_COMP_MATCH
1060 struct slap_component_syntax_info;
1061 typedef struct slap_component_data {
1062 void* cd_mem_op;/* nibble memory handler */
1063 struct slap_component_syntax_info** cd_tree;/* component tree */
1068 * represents an attribute (description + values)
1070 typedef struct slap_attr {
1071 AttributeDescription *a_desc;
1072 BerVarray a_vals; /* preserved values */
1073 BerVarray a_nvals; /* normalized values */
1074 #ifdef LDAP_COMP_MATCH
1075 ComponentData *a_comp_data; /* component values */
1077 struct slap_attr *a_next;
1079 #define SLAP_ATTR_IXADD 0x1U
1080 #define SLAP_ATTR_IXDEL 0x2U
1085 * the id used in the indexes to refer to an entry
1087 typedef unsigned long ID;
1088 #define NOID ((ID)~0)
1091 * represents an entry in core
1093 typedef struct slap_entry {
1095 * The ID field should only be changed before entry is
1096 * inserted into a cache. The ID value is backend
1101 struct berval e_name; /* name (DN) of this entry */
1102 struct berval e_nname; /* normalized name (DN) of this entry */
1104 /* for migration purposes */
1105 #define e_dn e_name.bv_val
1106 #define e_ndn e_nname.bv_val
1108 Attribute *e_attrs; /* list of attributes + values */
1110 slap_mask_t e_ocflags;
1112 struct berval e_bv; /* For entry_encode/entry_decode */
1114 /* for use by the backend for any purpose */
1119 * A list of LDAPMods
1121 typedef struct slap_mod {
1123 AttributeDescription *sm_desc;
1124 struct berval sm_type;
1125 BerVarray sm_values;
1126 BerVarray sm_nvalues;
1129 typedef struct slap_mod_list {
1130 Modification sml_mod;
1131 #define sml_op sml_mod.sm_op
1132 #define sml_desc sml_mod.sm_desc
1133 #define sml_type sml_mod.sm_type
1134 #define sml_values sml_mod.sm_values
1135 #define sml_nvalues sml_mod.sm_nvalues
1136 struct slap_mod_list *sml_next;
1139 typedef struct slap_ldap_modlist {
1141 struct slap_ldap_modlist *ml_next;
1142 #define ml_op ml_mod.mod_op
1143 #define ml_type ml_mod.mod_type
1144 #define ml_values ml_mod.mod_values
1148 * represents an access control list
1150 typedef enum slap_access_e {
1151 ACL_INVALID_ACCESS = -1,
1162 typedef enum slap_control_e {
1163 ACL_INVALID_CONTROL = 0,
1169 typedef enum slap_style_e {
1170 ACL_STYLE_REGEX = 0,
1177 ACL_STYLE_ANONYMOUS,
1184 typedef struct slap_authz_info {
1185 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1186 struct berval sai_mech; /* SASL Mechanism */
1187 struct berval sai_dn; /* DN for reporting purposes */
1188 struct berval sai_ndn; /* Normalized DN */
1190 /* Security Strength Factors */
1191 slap_ssf_t sai_ssf; /* Overall SSF */
1192 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1193 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1194 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1195 } AuthorizationInformation;
1202 * "dynamic" ACL infrastructure (for ACIs and more)
1204 typedef int (slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1205 typedef int (slap_dynacl_unparse)( void *priv, struct berval *bv );
1206 typedef int (slap_dynacl_mask)(
1210 AttributeDescription *desc,
1213 regmatch_t *matches,
1214 slap_access_t *grant,
1215 slap_access_t *deny );
1216 typedef int (slap_dynacl_destroy)( void *priv );
1218 typedef struct slap_dynacl_t {
1220 slap_dynacl_parse *da_parse;
1221 slap_dynacl_unparse *da_unparse;
1222 slap_dynacl_mask *da_mask;
1223 slap_dynacl_destroy *da_destroy;
1226 struct slap_dynacl_t *da_next;
1228 #endif /* SLAP_DYNACL */
1231 typedef struct slap_access {
1232 slap_control_t a_type;
1234 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1236 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1237 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1238 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1239 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1240 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1241 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1242 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1243 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1245 #define ACL_PRIV_MASK 0x00ffUL
1248 #define ACL_PRIV_LEVEL 0x1000UL
1249 #define ACL_PRIV_ADDITIVE 0x2000UL
1250 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1253 #define ACL_PRIV_INVALID 0x0UL
1255 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1256 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1257 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1258 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1260 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1261 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1263 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1265 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1267 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1268 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1269 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1271 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1272 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1273 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1274 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1275 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1276 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1277 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1278 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1280 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1281 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1282 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1283 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1284 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1285 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1286 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1287 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1288 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1290 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1291 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1292 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1293 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1294 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1295 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1296 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1297 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1299 slap_mask_t a_access_mask;
1301 AuthorizationInformation a_authz;
1302 #define a_dn_pat a_authz.sai_dn
1304 slap_style_t a_dn_style;
1305 AttributeDescription *a_dn_at;
1309 slap_style_t a_peername_style;
1310 struct berval a_peername_pat;
1311 unsigned long a_peername_addr,
1313 int a_peername_port;
1315 slap_style_t a_sockname_style;
1316 struct berval a_sockname_pat;
1318 slap_style_t a_domain_style;
1319 struct berval a_domain_pat;
1320 int a_domain_expand;
1322 slap_style_t a_sockurl_style;
1323 struct berval a_sockurl_pat;
1324 slap_style_t a_set_style;
1325 struct berval a_set_pat;
1328 slap_dynacl_t *a_dynacl;
1329 #else /* ! SLAP_DYNACL */
1330 #ifdef SLAPD_ACI_ENABLED
1331 AttributeDescription *a_aci_at;
1333 #endif /* SLAP_DYNACL */
1336 slap_style_t a_group_style;
1337 struct berval a_group_pat;
1338 ObjectClass *a_group_oc;
1339 AttributeDescription *a_group_at;
1341 struct slap_access *a_next;
1345 typedef struct slap_acl {
1346 /* "to" part: the entries this acl applies to */
1348 slap_style_t acl_dn_style;
1350 struct berval acl_dn_pat;
1351 AttributeName *acl_attrs;
1352 slap_style_t acl_attrval_style;
1353 regex_t acl_attrval_re;
1354 struct berval acl_attrval;
1356 /* "by" part: list of who has what access to the entries */
1359 struct slap_acl *acl_next;
1362 typedef struct slap_acl_state {
1363 unsigned as_recorded;
1364 #define ACL_STATE_NOT_RECORDED 0x0
1365 #define ACL_STATE_RECORDED_VD 0x1
1366 #define ACL_STATE_RECORDED_NV 0x2
1367 #define ACL_STATE_RECORDED 0x3
1370 AccessControl *as_vd_acl;
1371 AccessControl *as_vi_acl;
1372 slap_mask_t as_vd_acl_mask;
1373 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1374 int as_vd_acl_count;
1376 Access *as_vd_access;
1377 int as_vd_access_count;
1380 AttributeDescription *as_vd_ad;
1381 } AccessControlState;
1382 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1383 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1387 * represents a backend
1390 typedef struct slap_backend_info BackendInfo; /* per backend type */
1391 typedef struct slap_backend_db BackendDB; /* per backend database */
1393 LDAP_SLAPD_V (int) nBackendInfo;
1394 LDAP_SLAPD_V (int) nBackendDB;
1395 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1396 LDAP_SLAPD_V (BackendDB *) backendDB;
1397 LDAP_SLAPD_V (BackendDB *) frontendDB;
1399 LDAP_SLAPD_V (int) slapMode;
1400 #define SLAP_UNDEFINED_MODE 0x0000
1401 #define SLAP_SERVER_MODE 0x0001
1402 #define SLAP_TOOL_MODE 0x0002
1403 #define SLAP_MODE 0x0003
1405 #define SLAP_TRUNCATE_MODE 0x0100
1406 #define SLAP_TOOL_READMAIN 0x0200
1407 #define SLAP_TOOL_READONLY 0x0400
1408 #define SLAP_TOOL_QUICK 0x0800
1410 #define SB_TLS_OFF 0
1412 #define SB_TLS_CRITICAL 2
1414 typedef struct slap_bindconf {
1426 struct slap_replica_info {
1427 const char *ri_uri; /* supersedes be_replica */
1428 const char *ri_host; /* points to host part of uri */
1429 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1430 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1431 int ri_exclude; /* 1 => exclude ri_attrs */
1432 slap_bindconf ri_bindconf; /* for back-config */
1435 typedef struct slap_verbmasks {
1440 #define SLAP_LIMIT_TIME 1
1441 #define SLAP_LIMIT_SIZE 2
1443 struct slap_limits_set {
1451 int lms_s_unchecked;
1457 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1458 #define SLAP_NO_LIMIT -1
1459 #define SLAP_MAX_LIMIT 2147483647
1461 struct slap_limits {
1462 unsigned lm_flags; /* type of pattern */
1463 #define SLAP_LIMITS_UNDEFINED 0x0000U
1464 #define SLAP_LIMITS_EXACT 0x0001U
1465 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1466 #define SLAP_LIMITS_ONE 0x0002U
1467 #define SLAP_LIMITS_SUBTREE 0x0003U
1468 #define SLAP_LIMITS_CHILDREN 0x0004U
1469 #define SLAP_LIMITS_REGEX 0x0005U
1470 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1471 #define SLAP_LIMITS_USERS 0x0007U
1472 #define SLAP_LIMITS_ANY 0x0008U
1473 #define SLAP_LIMITS_MASK 0x000FU
1475 #define SLAP_LIMITS_TYPE_DN 0x0000U
1476 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1477 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1479 regex_t lm_regex; /* regex data for REGEX */
1482 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1483 * pattern for REGEX; NULL for ANONYMOUS, USERS
1485 struct berval lm_pat;
1487 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1488 * lm_group_oc is objectClass and lm_group_at is attributeType
1489 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1490 * can only be SLAP_LIMITS_EXACT */
1491 ObjectClass *lm_group_oc;
1492 AttributeDescription *lm_group_ad;
1494 struct slap_limits_set lm_limits;
1497 /* temporary aliases */
1498 typedef BackendDB Backend;
1499 #define nbackends nBackendDB
1500 #define backends backendDB
1503 * syncinfo structure for syncrepl
1506 #define SLAP_SYNC_RID_SIZE 3
1507 #define SLAP_SYNCUUID_SET_SIZE 256
1509 #define SLAP_SYNC_UPDATE_MSGID 2
1511 struct nonpresent_entry {
1512 struct berval *npe_name;
1513 struct berval *npe_nname;
1514 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1517 struct sync_cookie {
1518 struct berval ctxcsn;
1519 struct berval octet_str;
1521 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1524 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1526 typedef struct syncinfo_s {
1527 struct slap_backend_db *si_be;
1529 struct berval si_provideruri;
1530 slap_bindconf si_bindconf;
1531 struct berval si_filterstr;
1532 struct berval si_base;
1536 AttributeName *si_anlist;
1537 AttributeName *si_exanlist;
1542 int si_schemachecking;
1545 time_t *si_retryinterval;
1546 int *si_retrynum_init;
1548 struct sync_cookie si_syncCookie;
1552 int si_refreshDelete;
1553 int si_refreshPresent;
1554 Avlnode *si_presentlist;
1556 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1557 ldap_pvt_thread_mutex_t si_mutex;
1560 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1562 #ifndef SLAP_MAX_CIDS
1563 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1566 struct slap_backend_db {
1567 BackendInfo *bd_info; /* pointer to shared backend info */
1569 /* fields in this structure (and routines acting on this structure)
1570 should be renamed from be_ to bd_ */
1572 /* BackendInfo accessors */
1573 #define be_config bd_info->bi_db_config
1574 #define be_type bd_info->bi_type
1576 #define be_bind bd_info->bi_op_bind
1577 #define be_unbind bd_info->bi_op_unbind
1578 #define be_add bd_info->bi_op_add
1579 #define be_compare bd_info->bi_op_compare
1580 #define be_delete bd_info->bi_op_delete
1581 #define be_modify bd_info->bi_op_modify
1582 #define be_modrdn bd_info->bi_op_modrdn
1583 #define be_search bd_info->bi_op_search
1584 #define be_abandon bd_info->bi_op_abandon
1585 #define be_cancel bd_info->bi_op_cancel
1587 #define be_extended bd_info->bi_extended
1589 #define be_chk_referrals bd_info->bi_chk_referrals
1590 #define be_chk_controls bd_info->bi_chk_controls
1591 #define be_fetch bd_info->bi_entry_get_rw
1592 #define be_release bd_info->bi_entry_release_rw
1593 #define be_group bd_info->bi_acl_group
1594 #define be_attribute bd_info->bi_acl_attribute
1595 #define be_operational bd_info->bi_operational
1598 * define to honor hasSubordinates operational attribute in search filters
1599 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1602 #define be_has_subordinates bd_info->bi_has_subordinates
1604 #define be_connection_init bd_info->bi_connection_init
1605 #define be_connection_destroy bd_info->bi_connection_destroy
1608 #define be_entry_open bd_info->bi_tool_entry_open
1609 #define be_entry_close bd_info->bi_tool_entry_close
1610 #define be_entry_first bd_info->bi_tool_entry_first
1611 #define be_entry_next bd_info->bi_tool_entry_next
1612 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1613 #define be_entry_get bd_info->bi_tool_entry_get
1614 #define be_entry_put bd_info->bi_tool_entry_put
1615 #define be_sync bd_info->bi_tool_sync
1616 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1617 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1618 #define be_entry_modify bd_info->bi_tool_entry_modify
1621 /* supported controls */
1622 /* note: set to 0 if the database does not support the control;
1623 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1624 char be_ctrls[SLAP_MAX_CIDS + 1];
1626 /* Database flags */
1627 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1628 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1629 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1630 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1631 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1632 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1633 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1634 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1635 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1636 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1637 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1638 slap_mask_t be_flags;
1639 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1640 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1641 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1642 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1643 #define SLAP_NO_SCHEMA_CHECK(be) \
1644 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1645 #define SLAP_GLUE_INSTANCE(be) \
1646 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1647 #define SLAP_GLUE_SUBORDINATE(be) \
1648 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1649 #define SLAP_GLUE_LINKED(be) \
1650 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1651 #define SLAP_GLUE_ADVERTISE(be) \
1652 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1653 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1654 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1655 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1657 slap_mask_t be_restrictops; /* restriction operations */
1658 #define SLAP_RESTRICT_OP_ADD 0x0001U
1659 #define SLAP_RESTRICT_OP_BIND 0x0002U
1660 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1661 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1662 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1663 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1664 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1665 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1666 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1668 #define SLAP_RESTRICT_READONLY 0x80000000U
1670 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1671 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1672 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1673 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1674 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1676 #define SLAP_RESTRICT_OP_READS \
1677 ( SLAP_RESTRICT_OP_COMPARE \
1678 | SLAP_RESTRICT_OP_SEARCH )
1679 #define SLAP_RESTRICT_OP_WRITES \
1680 ( SLAP_RESTRICT_OP_ADD \
1681 | SLAP_RESTRICT_OP_DELETE \
1682 | SLAP_RESTRICT_OP_MODIFY \
1683 | SLAP_RESTRICT_OP_RENAME )
1685 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1686 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1687 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1689 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1691 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1692 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1693 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1695 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1696 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1698 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1700 slap_mask_t be_requires; /* pre-operation requirements */
1701 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1702 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1703 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1704 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1705 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1707 /* Required Security Strength Factor */
1708 slap_ssf_set_t be_ssf_set;
1710 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1711 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1712 struct berval be_schemadn; /* per-backend subschema subentry DN */
1713 struct berval be_schemandn; /* normalized subschema DN */
1714 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1715 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1716 struct berval be_rootpw; /* the magic "root" password for this db */
1717 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1718 #define be_sizelimit be_def_limit.lms_s_soft
1719 #define be_timelimit be_def_limit.lms_t_soft
1720 struct slap_limits_set be_def_limit; /* default limits */
1721 struct slap_limits **be_limits; /* regex-based size and time limits */
1722 AccessControl *be_acl; /* access control list for this backend */
1723 slap_access_t be_dfltaccess; /* access given if no acl matches */
1725 /* Replica Information */
1726 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1727 char *be_replogfile; /* replication log file (in master) */
1728 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1729 BerVarray be_update_refs; /* where to refer modifying clients to */
1730 struct be_pcl *be_pending_csn_list;
1731 ldap_pvt_thread_mutex_t be_pcl_mutex;
1732 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1733 syncinfo_t *be_syncinfo; /* For syncrepl */
1735 void *be_pb; /* Netscape plugin */
1736 struct ConfigTable *be_cf_table;
1738 void *be_private; /* anything the backend database needs */
1744 /* Backend function typedefs */
1745 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1746 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1747 const char *fname, int lineno,
1748 int argc, char **argv));
1749 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1750 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1751 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1753 typedef int (BI_db_init) LDAP_P((Backend *bd));
1754 typedef int (BI_db_config) LDAP_P((Backend *bd,
1755 const char *fname, int lineno,
1756 int argc, char **argv));
1757 typedef int (BI_db_open) LDAP_P((Backend *bd));
1758 typedef int (BI_db_close) LDAP_P((Backend *bd));
1759 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1761 typedef struct req_bind_s {
1763 struct berval rb_cred;
1764 struct berval rb_edn;
1766 struct berval rb_tmp_mech; /* FIXME: temporary */
1769 typedef struct req_search_s {
1774 /* NULL means be_isroot evaluated to TRUE */
1775 struct slap_limits_set *rs_limit;
1777 AttributeName *rs_attrs;
1779 struct berval rs_filterstr;
1782 typedef struct req_compare_s {
1783 AttributeAssertion *rs_ava;
1786 typedef struct req_modify_s {
1787 Modifications *rs_modlist;
1788 int rs_increment; /* FIXME: temporary */
1791 typedef struct req_modrdn_s {
1792 struct berval rs_newrdn;
1793 struct berval rs_nnewrdn;
1794 struct berval *rs_newSup;
1795 struct berval *rs_nnewSup;
1796 int rs_deleteoldrdn;
1799 typedef struct req_add_s {
1801 Modifications *rs_modlist; /* FIXME: temporary */
1804 typedef struct req_abandon_s {
1809 #define SLAP_EXOP_HIDE 0x0000
1811 #define SLAP_EXOP_HIDE 0x8000
1813 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1815 typedef struct req_extended_s {
1816 struct berval rs_reqoid;
1818 struct berval *rs_reqdata;
1821 typedef struct req_pwdexop_s {
1822 struct berval rs_reqoid;
1824 struct berval rs_old;
1825 struct berval rs_new;
1826 Modifications *rs_mods;
1827 Modifications **rs_modtail;
1830 typedef enum slap_reply_e {
1839 typedef struct rep_sasl_s {
1840 struct berval *r_sasldata;
1843 typedef struct rep_extended_s {
1844 const char *r_rspoid;
1845 struct berval *r_rspdata;
1848 typedef struct rep_search_s {
1850 slap_mask_t r_attr_flags;
1851 #define SLAP_ATTRS_UNDEFINED (0x00U)
1852 #define SLAP_OPATTRS_NO (0x01U)
1853 #define SLAP_OPATTRS_YES (0x02U)
1854 #define SLAP_USERATTRS_NO (0x10U)
1855 #define SLAP_USERATTRS_YES (0x20U)
1856 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1857 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1858 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1859 #define SLAP_USERATTRS(f) \
1860 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1862 Attribute *r_operational_attrs;
1863 AttributeName *r_attrs;
1868 typedef struct slap_rep {
1869 slap_reply_t sr_type;
1873 const char *sr_matched;
1874 const char *sr_text;
1876 LDAPControl **sr_ctrls;
1878 rep_sasl_s sru_sasl;
1879 rep_extended_s sru_extended;
1880 rep_search_s sru_search;
1882 slap_mask_t sr_flags;
1883 #define REP_ENTRY_MODIFIABLE 0x0001U
1884 #define REP_ENTRY_MUSTBEFREED 0x0002U
1885 #define REP_MATCHED_MUSTBEFREED 0x0010U
1886 #define REP_REF_MUSTBEFREED 0x0020U
1889 /* short hands for response members */
1890 #define sr_attrs sr_un.sru_search.r_attrs
1891 #define sr_entry sr_un.sru_search.r_entry
1892 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1893 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1894 #define sr_v2ref sr_un.sru_search.r_v2ref
1895 #define sr_nentries sr_un.sru_search.r_nentries
1896 #define sr_rspoid sr_un.sru_extended.r_rspoid
1897 #define sr_rspdata sr_un.sru_extended.r_rspdata
1898 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1900 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1901 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1902 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1903 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1904 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1905 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1906 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1907 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1908 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1909 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1910 typedef int (BI_op_extended) LDAP_P((
1911 struct slap_op *op, struct slap_rep *rs ));
1912 typedef int (BI_chk_referrals) LDAP_P((
1913 struct slap_op *op, struct slap_rep *rs ));
1914 typedef int (BI_chk_controls) LDAP_P((
1915 struct slap_op *op, struct slap_rep *rs ));
1916 typedef int (BI_entry_release_rw)
1917 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1918 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1919 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1920 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1921 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1922 Entry *e, int *hasSubs ));
1924 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1925 struct slap_conn *c ));
1926 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1927 struct slap_conn *c ));
1929 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1930 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1931 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1932 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1933 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1934 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1935 struct berval *text ));
1936 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1937 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1938 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1939 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1940 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1941 struct berval *text ));
1943 struct ConfigTable; /* config.h */
1945 struct slap_backend_info {
1946 char *bi_type; /* type of backend */
1949 * per backend type routines:
1950 * bi_init: called to allocate a backend_info structure,
1951 * called once BEFORE configuration file is read.
1952 * bi_init() initializes this structure hence is
1953 * called directly from be_initialize()
1954 * bi_config: called per 'backend' specific option
1955 * all such options must before any 'database' options
1956 * bi_config() is called only from read_config()
1957 * bi_open: called to open each database, called
1958 * once AFTER configuration file is read but
1959 * BEFORE any bi_db_open() calls.
1960 * bi_open() is called from backend_startup()
1961 * bi_close: called to close each database, called
1962 * once during shutdown after all bi_db_close calls.
1963 * bi_close() is called from backend_shutdown()
1964 * bi_destroy: called to destroy each database, called
1965 * once during shutdown after all bi_db_destroy calls.
1966 * bi_destory() is called from backend_destroy()
1969 BI_config *bi_config;
1972 BI_destroy *bi_destroy;
1975 * per database routines:
1976 * bi_db_init: called to initialize each database,
1977 * called upon reading 'database <type>'
1978 * called only from backend_db_init()
1979 * bi_db_config: called to configure each database,
1980 * called per database to handle per database options
1981 * called only from read_config()
1982 * bi_db_open: called to open each database
1983 * called once per database immediately AFTER bi_open()
1984 * calls but before daemon startup.
1985 * called only by backend_startup()
1986 * bi_db_close: called to close each database
1987 * called once per database during shutdown but BEFORE
1988 * any bi_close call.
1989 * called only by backend_shutdown()
1990 * bi_db_destroy: called to destroy each database
1991 * called once per database during shutdown AFTER all
1992 * bi_close calls but before bi_destory calls.
1993 * called only by backend_destory()
1995 BI_db_init *bi_db_init;
1996 BI_db_config *bi_db_config;
1997 BI_db_open *bi_db_open;
1998 BI_db_close *bi_db_close;
1999 BI_db_destroy *bi_db_destroy;
2001 /* LDAP Operations Handling Routines */
2002 BI_op_bind *bi_op_bind;
2003 BI_op_unbind *bi_op_unbind;
2004 BI_op_search *bi_op_search;
2005 BI_op_compare *bi_op_compare;
2006 BI_op_modify *bi_op_modify;
2007 BI_op_modrdn *bi_op_modrdn;
2008 BI_op_add *bi_op_add;
2009 BI_op_delete *bi_op_delete;
2010 BI_op_abandon *bi_op_abandon;
2011 BI_op_cancel *bi_op_cancel;
2013 /* Extended Operations Helper */
2014 BI_op_extended *bi_extended;
2016 /* Auxilary Functions */
2017 BI_operational *bi_operational;
2018 BI_chk_referrals *bi_chk_referrals;
2019 BI_chk_controls *bi_chk_controls;
2020 BI_entry_get_rw *bi_entry_get_rw;
2021 BI_entry_release_rw *bi_entry_release_rw;
2023 BI_has_subordinates *bi_has_subordinates;
2025 BI_connection_init *bi_connection_init;
2026 BI_connection_destroy *bi_connection_destroy;
2028 /* hooks for slap tools */
2029 BI_tool_entry_open *bi_tool_entry_open;
2030 BI_tool_entry_close *bi_tool_entry_close;
2031 BI_tool_entry_first *bi_tool_entry_first;
2032 BI_tool_entry_next *bi_tool_entry_next;
2033 BI_tool_entry_get *bi_tool_entry_get;
2034 BI_tool_entry_put *bi_tool_entry_put;
2035 BI_tool_entry_reindex *bi_tool_entry_reindex;
2036 BI_tool_sync *bi_tool_sync;
2037 BI_tool_dn2id_get *bi_tool_dn2id_get;
2038 BI_tool_id2entry_get *bi_tool_id2entry_get;
2039 BI_tool_entry_modify *bi_tool_entry_modify;
2041 #define SLAP_INDEX_ADD_OP 0x0001
2042 #define SLAP_INDEX_DELETE_OP 0x0002
2044 slap_mask_t bi_flags; /* backend flags */
2045 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2046 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2047 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2048 #define SLAP_BFLAG_INCREMENT 0x0100U
2049 #define SLAP_BFLAG_ALIASES 0x1000U
2050 #define SLAP_BFLAG_REFERRALS 0x2000U
2051 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2052 #define SLAP_BFLAG_DYNAMIC 0x8000U
2054 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2055 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2056 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2057 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2058 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2059 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2060 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2061 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2062 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2063 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2065 char **bi_controls; /* supported controls */
2066 char bi_ctrls[SLAP_MAX_CIDS + 1];
2068 unsigned int bi_nDB; /* number of databases of this type */
2069 struct ConfigTable *bi_cf_table;
2070 void *bi_private; /* anything the backend type needs */
2073 #define c_authtype c_authz.sai_method
2074 #define c_authmech c_authz.sai_mech
2075 #define c_dn c_authz.sai_dn
2076 #define c_ndn c_authz.sai_ndn
2077 #define c_ssf c_authz.sai_ssf
2078 #define c_transport_ssf c_authz.sai_transport_ssf
2079 #define c_tls_ssf c_authz.sai_tls_ssf
2080 #define c_sasl_ssf c_authz.sai_sasl_ssf
2082 #define o_authtype o_authz.sai_method
2083 #define o_authmech o_authz.sai_mech
2084 #define o_dn o_authz.sai_dn
2085 #define o_ndn o_authz.sai_ndn
2086 #define o_ssf o_authz.sai_ssf
2087 #define o_transport_ssf o_authz.sai_transport_ssf
2088 #define o_tls_ssf o_authz.sai_tls_ssf
2089 #define o_sasl_ssf o_authz.sai_sasl_ssf
2091 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2093 typedef struct slap_callback {
2094 struct slap_callback *sc_next;
2095 slap_response *sc_response;
2096 slap_response *sc_cleanup;
2100 struct slap_overinfo;
2102 typedef struct slap_overinst {
2104 slap_response *on_response;
2105 struct slap_overinfo *on_info;
2106 struct slap_overinst *on_next;
2109 typedef struct slap_overinfo {
2111 BackendInfo *oi_orig;
2112 struct slap_overinst *oi_list;
2115 /* Should successive callbacks in a chain be processed? */
2116 #define SLAP_CB_FREEME 0x4000
2117 #define SLAP_CB_CONTINUE 0x8000
2120 * Paged Results state
2122 typedef unsigned long PagedResultsCookie;
2123 typedef struct slap_paged_state {
2126 PagedResultsCookie ps_cookie;
2128 } PagedResultsState;
2130 struct slap_csn_entry {
2131 struct berval ce_csn;
2132 unsigned long ce_opid;
2133 unsigned long ce_connid;
2134 #define SLAP_CSN_PENDING 1
2135 #define SLAP_CSN_COMMIT 2
2137 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2141 * Caches the result of a backend_group check for ACL evaluation
2143 typedef struct slap_gacl {
2144 struct slap_gacl *ga_next;
2147 AttributeDescription *ga_at;
2153 struct slap_control_ids {
2159 int sc_modifyIncrement;
2161 int sc_pagedResults;
2162 int sc_valuesReturnFilter;
2163 int sc_permissiveModify;
2166 int sc_searchOptions;
2172 * represents an operation pending from an ldap client
2174 typedef struct slap_op_header {
2175 unsigned long oh_opid; /* id of this operation */
2176 unsigned long oh_connid; /* id of conn initiating this op */
2177 struct slap_conn *oh_conn; /* connection spawning this op */
2179 ber_int_t oh_msgid; /* msgid of the request */
2180 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2182 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2184 void *oh_threadctx; /* thread pool thread context */
2185 void *oh_tmpmemctx; /* slab malloc context */
2186 BerMemoryFunctions *oh_tmpmfuncs;
2188 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2191 void *oh_pb; /* NS-SLAPI plugin */
2192 void *oh_extensions; /* NS-SLAPI plugin */
2196 typedef struct slap_op {
2199 #define o_opid o_hdr->oh_opid
2200 #define o_connid o_hdr->oh_connid
2201 #define o_conn o_hdr->oh_conn
2202 #define o_msgid o_hdr->oh_msgid
2203 #define o_protocol o_hdr->oh_protocol
2204 #define o_tid o_hdr->oh_tid
2205 #define o_threadctx o_hdr->oh_threadctx
2206 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2207 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2209 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2210 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2211 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2212 #define o_tmpfree o_tmpmfuncs->bmf_free
2214 #define o_log_prefix o_hdr->oh_log_prefix
2217 #define o_pb o_hdr->oh_pb
2218 #define o_extensions o_hdr->oh_extensions
2221 ber_tag_t o_tag; /* tag of the request */
2222 time_t o_time; /* time op was initiated */
2224 BackendDB *o_bd; /* backend DB processing this op */
2225 struct berval o_req_dn; /* DN of target of request */
2226 struct berval o_req_ndn;
2231 req_compare_s oq_compare;
2232 req_modify_s oq_modify;
2233 req_modrdn_s oq_modrdn;
2234 req_search_s oq_search;
2235 req_abandon_s oq_abandon;
2236 req_abandon_s oq_cancel;
2237 req_extended_s oq_extended;
2238 req_pwdexop_s oq_pwdexop;
2241 /* short hands for union members */
2242 #define oq_add o_request.oq_add
2243 #define oq_bind o_request.oq_bind
2244 #define oq_compare o_request.oq_compare
2245 #define oq_modify o_request.oq_modify
2246 #define oq_modrdn o_request.oq_modrdn
2247 #define oq_search o_request.oq_search
2248 #define oq_abandon o_request.oq_abandon
2249 #define oq_cancel o_request.oq_cancel
2250 #define oq_extended o_request.oq_extended
2251 #define oq_pwdexop o_request.oq_pwdexop
2253 /* short hands for inner request members */
2254 #define orb_method oq_bind.rb_method
2255 #define orb_cred oq_bind.rb_cred
2256 #define orb_edn oq_bind.rb_edn
2257 #define orb_ssf oq_bind.rb_ssf
2258 #define orb_tmp_mech oq_bind.rb_tmp_mech
2260 #define ors_scope oq_search.rs_scope
2261 #define ors_deref oq_search.rs_deref
2262 #define ors_slimit oq_search.rs_slimit
2263 #define ors_tlimit oq_search.rs_tlimit
2264 #define ors_limit oq_search.rs_limit
2265 #define ors_attrsonly oq_search.rs_attrsonly
2266 #define ors_attrs oq_search.rs_attrs
2267 #define ors_filter oq_search.rs_filter
2268 #define ors_filterstr oq_search.rs_filterstr
2270 #define orr_newrdn oq_modrdn.rs_newrdn
2271 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2272 #define orr_newSup oq_modrdn.rs_newSup
2273 #define orr_nnewSup oq_modrdn.rs_nnewSup
2274 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2276 #define orc_ava oq_compare.rs_ava
2277 #define ora_e oq_add.rs_e
2278 #define ora_modlist oq_add.rs_modlist
2279 #define orn_msgid oq_abandon.rs_msgid
2280 #define orm_modlist oq_modify.rs_modlist
2281 #define orm_increment oq_modify.rs_increment
2283 #define ore_reqoid oq_extended.rs_reqoid
2284 #define ore_flags oq_extended.rs_flags
2285 #define ore_reqdata oq_extended.rs_reqdata
2286 volatile sig_atomic_t o_abandon; /* abandon flag */
2287 volatile sig_atomic_t o_cancel; /* cancel flag */
2288 #define SLAP_CANCEL_NONE 0x00
2289 #define SLAP_CANCEL_REQ 0x01
2290 #define SLAP_CANCEL_ACK 0x02
2291 #define SLAP_CANCEL_DONE 0x03
2293 GroupAssertion *o_groups;
2294 char o_do_not_cache; /* don't cache groups from this op */
2295 char o_is_auth_check; /* authorization in progress */
2297 #define SLAP_CONTROL_NONE 0
2298 #define SLAP_CONTROL_IGNORED 1
2299 #define SLAP_CONTROL_NONCRITICAL 2
2300 #define SLAP_CONTROL_CRITICAL 3
2301 #define SLAP_CONTROL_MASK 3
2303 /* spare bits for simple flags */
2304 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2305 #define SLAP_CONTROL_DATA0 0x10
2306 #define SLAP_CONTROL_DATA1 0x20
2307 #define SLAP_CONTROL_DATA2 0x40
2308 #define SLAP_CONTROL_DATA3 0x80
2311 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2313 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2314 void **o_controls; /* per-control state */
2316 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2317 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2319 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2320 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2321 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2323 #define get_subentries(op) _SCM((op)->o_subentries)
2324 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2326 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2327 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2329 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2330 #define get_assert(op) ((int)(op)->o_assert)
2331 #define o_assertion o_controls[slap_cids.sc_assert]
2332 #define get_assertion(op) ((op)->o_assertion)
2334 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2335 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2337 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2338 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2339 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2341 #define get_permissiveModify(op) (0)
2344 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2345 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2346 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2348 #define get_domainScope(op) (0)
2351 #ifdef LDAP_CONTROL_X_TREE_DELETE
2352 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2353 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2355 #define get_treeDelete(op) (0)
2358 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2359 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2361 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2362 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2364 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2365 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2367 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2369 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2371 AuthorizationInformation o_authz;
2373 BerElement *o_ber; /* ber of the request */
2374 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2375 slap_callback *o_callback; /* callback pointers */
2376 LDAPControl **o_ctrls; /* controls */
2378 void *o_private; /* anything the backend needs */
2380 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2383 int o_delete_glue_parent;
2386 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2388 #define send_ldap_error( op, rs, err, text ) do { \
2389 (rs)->sr_err = err; (rs)->sr_text = text; \
2390 (op->o_conn->c_send_ldap_result)( op, rs ); \
2392 #define send_ldap_discon( op, rs, err, text ) do { \
2393 (rs)->sr_err = err; (rs)->sr_text = text; \
2394 send_ldap_disconnect( op, rs ); \
2397 typedef void (SEND_LDAP_RESULT)(
2398 struct slap_op *op, struct slap_rep *rs);
2399 typedef int (SEND_SEARCH_ENTRY)(
2400 struct slap_op *op, struct slap_rep *rs);
2401 typedef int (SEND_SEARCH_REFERENCE)(
2402 struct slap_op *op, struct slap_rep *rs);
2403 typedef void (SEND_LDAP_EXTENDED)(
2404 struct slap_op *op, struct slap_rep *rs);
2405 typedef void (SEND_LDAP_INTERMEDIATE)(
2406 struct slap_op *op, struct slap_rep *rs);
2408 #define send_ldap_result( op, rs ) \
2409 ((op)->o_conn->c_send_ldap_result)( op, rs )
2410 #define send_search_entry( op, rs ) \
2411 ((op)->o_conn->c_send_search_entry)( op, rs )
2412 #define send_search_reference( op, rs ) \
2413 ((op)->o_conn->c_send_search_reference)( op, rs )
2414 #define send_ldap_extended( op, rs ) \
2415 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2416 #define send_ldap_intermediate( op, rs ) \
2417 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2419 typedef struct slap_listener Listener;
2422 * represents a connection from an ldap client
2424 typedef struct slap_conn {
2425 int c_struct_state; /* structure management state */
2426 int c_conn_state; /* connection state */
2427 int c_conn_idx; /* slot in connections array */
2429 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2430 Sockbuf *c_sb; /* ber connection stuff */
2432 /* only can be changed by connect_init */
2433 time_t c_starttime; /* when the connection was opened */
2434 time_t c_activitytime; /* when the connection was last used */
2435 unsigned long c_connid; /* id of this connection for stats*/
2437 struct berval c_peer_domain; /* DNS name of client */
2438 struct berval c_peer_name; /* peer name (trans=addr:port) */
2439 Listener *c_listener;
2440 #define c_listener_url c_listener->sl_url /* listener URL */
2441 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2443 /* only can be changed by binding thread */
2444 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2445 struct berval c_sasl_bind_mech; /* mech in progress */
2446 struct berval c_sasl_dn; /* temporary storage */
2448 /* authorization backend */
2449 Backend *c_authz_backend;
2451 AuthorizationInformation c_authz;
2453 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2455 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2456 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2458 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2459 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2461 BerElement *c_currentber; /* ber we're attempting to read */
2462 int c_writewaiter; /* true if writer is waiting */
2464 #define CONN_IS_TLS 1
2465 #define CONN_IS_UDP 2
2466 #define CONN_IS_CLIENT 3
2468 #ifdef LDAP_CONNECTIONLESS
2469 int c_is_udp; /* true if this is (C)LDAP over UDP */
2472 int c_is_tls; /* true if this LDAP over raw TLS */
2473 int c_needs_tls_accept; /* true if SSL_accept should be called */
2475 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2476 int c_sasl_done; /* SASL completed once */
2477 void *c_sasl_authctx; /* SASL authentication context */
2478 void *c_sasl_sockctx; /* SASL security layer context */
2479 void *c_sasl_extra; /* SASL session extra stuff */
2480 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2482 PagedResultsState c_pagedresults_state; /* paged result state */
2484 long c_n_ops_received; /* num of ops received (next op_id) */
2485 long c_n_ops_executing; /* num of ops currently executing */
2486 long c_n_ops_pending; /* num of ops pending execution */
2487 long c_n_ops_completed; /* num of ops completed */
2489 long c_n_get; /* num of get calls */
2490 long c_n_read; /* num of read calls */
2491 long c_n_write; /* num of write calls */
2493 void *c_pb; /* Netscape plugin */
2494 void *c_extensions; /* Netscape plugin */
2497 * Client connection handling
2499 ldap_pvt_thread_start_t *c_clientfunc;
2503 * These are the "callbacks" that are available for back-ends to
2504 * supply data back to connected clients that are connected
2505 * through the "front-end".
2507 SEND_LDAP_RESULT *c_send_ldap_result;
2508 SEND_SEARCH_ENTRY *c_send_search_entry;
2509 SEND_SEARCH_REFERENCE *c_send_search_reference;
2510 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2511 #ifdef LDAP_RES_INTERMEDIATE
2512 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2517 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2518 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2520 if ( ldap_debug & (level) ) \
2521 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2522 if ( ldap_syslog & (level) ) \
2523 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2526 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2527 #elif defined(LDAP_DEBUG)
2528 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2530 if ( ldap_debug & (level) ) \
2531 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2533 #define StatslogTest( level ) (ldap_debug & (level))
2535 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2536 #define StatslogTest( level ) (0)
2540 * listener; need to access it from monitor backend
2542 struct slap_listener {
2543 struct berval sl_url;
2544 struct berval sl_name;
2549 #ifdef LDAP_CONNECTIONLESS
2550 int sl_is_udp; /* UDP listener is also data port */
2552 int sl_is_mute; /* Listening is temporarily disabled */
2555 #define sl_addr sl_sa.sa_in_addr
2558 #ifdef SLAPD_MONITOR
2575 #endif /* SLAPD_MONITOR */
2577 typedef struct slap_counters_t {
2578 ldap_pvt_thread_mutex_t sc_sent_mutex;
2579 ldap_pvt_mp_t sc_bytes;
2580 ldap_pvt_mp_t sc_pdu;
2581 ldap_pvt_mp_t sc_entries;
2582 ldap_pvt_mp_t sc_refs;
2584 ldap_pvt_thread_mutex_t sc_ops_mutex;
2585 ldap_pvt_mp_t sc_ops_completed;
2586 ldap_pvt_mp_t sc_ops_initiated;
2587 #ifdef SLAPD_MONITOR
2588 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2589 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2590 #endif /* SLAPD_MONITOR */
2594 * Better know these all around slapd
2596 #define SLAP_LDAPDN_PRETTY 0x1
2597 #define SLAP_LDAPDN_MAXLEN 8192
2599 /* number of response controls supported */
2600 #define SLAP_MAX_RESPONSE_CONTROLS 6
2603 #define SLAP_CTRL_HIDE 0x00000000U
2605 #define SLAP_CTRL_HIDE 0x80000000U
2608 #define SLAP_CTRL_GLOBAL 0x00800000U
2609 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2611 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2612 #define SLAP_CTRL_ABANDON 0x00000001U
2613 #define SLAP_CTRL_ADD 0x00002002U
2614 #define SLAP_CTRL_BIND 0x00000004U
2615 #define SLAP_CTRL_COMPARE 0x00001008U
2616 #define SLAP_CTRL_DELETE 0x00002010U
2617 #define SLAP_CTRL_MODIFY 0x00002020U
2618 #define SLAP_CTRL_RENAME 0x00002040U
2619 #define SLAP_CTRL_SEARCH 0x00001080U
2620 #define SLAP_CTRL_UNBIND 0x00000100U
2622 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2623 #define SLAP_CTRL_UPDATE \
2624 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2625 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2627 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2630 LDAPControl *ctrl ));
2632 #define SLAP_SLAB_SIZE (1024*1024)
2633 #define SLAP_SLAB_STACK 1
2634 #define SLAP_SLAB_SOBLOCK 64
2636 #define SLAP_ZONE_ALLOC 1
2637 #undef SLAP_ZONE_ALLOC
2639 #ifdef LDAP_COMP_MATCH
2641 * Extensible Filter Definition
2643 * MatchingRuleAssertion := SEQUENCE {
2644 * matchingRule [1] MatchingRuleId OPTIONAL,
2645 * type [2] AttributeDescription OPTIONAL,
2646 * matchValue [3] AssertionValue,
2647 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2649 * Following ComponentFilter is contained in matchValue
2651 * ComponentAssertion ::= SEQUENCE {
2652 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2653 * useDefaultValues BOOLEAN DEFAULT TRUE,
2654 * rule MATCHING-RULE.&id,
2655 * value MATCHING-RULE.&AssertionType }
2657 * ComponentFilter ::= CHOICE {
2658 * item [0] ComponentAssertion,
2659 * and [1] SEQUENCE OF ComponentFilter,
2660 * or [2] SEQUENCE OF ComponentFilter,
2661 * not [3] ComponentFilter }
2664 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2665 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2666 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2667 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2668 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2669 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2670 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2671 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2672 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2674 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2675 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2676 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2677 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2678 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2680 typedef struct slap_component_id {
2682 struct slap_component_id *ci_next;
2684 union comp_id_value{
2685 BerValue ci_identifier;
2686 ber_int_t ci_from_beginning;
2688 ber_int_t ci_from_end;
2689 ber_int_t ci_content;
2690 BerValue ci_select_value;
2695 typedef struct slap_component_reference {
2696 ComponentId *cr_list;
2697 ComponentId *cr_curr;
2698 struct berval cr_string;
2700 /* Component Indexing */
2702 slap_mask_t cr_indexmask;
2703 AttributeDescription* cr_ad;
2705 struct slap_component_reference* cr_next;
2706 } ComponentReference;
2708 typedef struct slap_component_assertion {
2709 ComponentReference *ca_comp_ref;
2710 ber_int_t ca_use_def;
2711 MatchingRule *ca_ma_rule;
2712 struct berval ca_ma_value;
2713 ComponentData ca_comp_data; /* componentized assertion */
2714 struct slap_component_filter *ca_cf;
2715 MatchingRuleAssertion *ca_mra;
2716 } ComponentAssertion;
2718 typedef struct slap_component_filter {
2719 ber_tag_t cf_choice;
2721 ber_int_t cf_un_result;
2722 ComponentAssertion *cf_un_ca;
2723 struct slap_component_filter *cf_un_complex;
2726 #define cf_ca cf_un.cf_un_ca
2727 #define cf_result cf_un.cf_un_result
2728 #define cf_and cf_un.cf_un_complex
2729 #define cf_or cf_un.cf_un_complex
2730 #define cf_not cf_un.cf_un_complex
2731 #define cf_any cf_un.cf_un_complex
2733 struct slap_component_filter *cf_next;
2736 typedef struct slap_component_assertion_value {
2740 } ComponentAssertionValue;
2742 typedef int encoder_func LDAP_P((
2746 struct slap_component_syntax_info;
2748 typedef int gser_decoder_func LDAP_P((
2751 struct slap_component_syntax_info** comp_syn_info,
2755 typedef int comp_free_func LDAP_P((
2758 typedef int ber_decoder_func LDAP_P((
2763 struct slap_component_syntax_info* comp_syn_info,
2767 typedef int ber_tag_decoder_func LDAP_P((
2770 struct slap_component_syntax_info* comp_syn_info,
2774 typedef void* extract_component_from_id_func LDAP_P((
2776 ComponentReference* cr,
2779 typedef void* convert_attr_to_comp_func LDAP_P ((
2782 struct berval* bv ));
2784 typedef void* alloc_nibble_func LDAP_P ((
2786 int increment_size ));
2788 typedef void free_nibble_func LDAP_P ((
2791 struct slap_component_syntax_info;
2792 typedef void convert_assert_to_comp_func LDAP_P ((
2794 struct slap_component_syntax_info* csi_attr,
2796 struct slap_component_syntax_info** csi,
2800 typedef int convert_asn_to_ldap_func LDAP_P ((
2801 struct slap_component_syntax_info* csi,
2802 struct berval *bv ));
2804 typedef void free_component_func LDAP_P ((
2807 typedef int test_component_func LDAP_P ((
2809 void* assert_mem_op,
2810 struct slap_component_syntax_info* csi,
2811 struct slap_component_assertion* ca));
2813 typedef void* test_membership_func LDAP_P ((
2816 typedef void* get_component_info_func LDAP_P ((
2819 struct slap_component_syntax_info;
2821 typedef int component_encoder_func LDAP_P ((
2823 struct slap_component_syntax_info* csi,
2824 struct berval* nvals ));
2826 typedef int allcomponent_matching_func LDAP_P((
2828 struct slap_component_syntax_info* comp1,
2829 struct slap_component_syntax_info* comp));
2831 typedef struct slap_component_desc {
2832 /* Don't change the order of following four fields */
2834 AttributeType *cd_comp_type;
2835 struct berval cd_ad_type;/* ad_type, ad_cname */
2836 struct berval cd_ad_cname;/* ad_type, ad_cname */
2837 unsigned cd_flags; /*ad_flags*/
2840 encoder_func *cd_ldap_encoder;
2841 encoder_func *cd_gser_encoder;
2842 encoder_func *cd_ber_encoder;
2843 gser_decoder_func *cd_gser_decoder;
2844 ber_decoder_func *cd_ber_decoder;
2845 comp_free_func *cd_free;
2846 extract_component_from_id_func* cd_extract_i;
2847 allcomponent_matching_func *cd_all_match;
2850 typedef struct slap_component_syntax_info {
2852 ComponentDesc* csi_comp_desc;
2853 } ComponentSyntaxInfo;
2857 /* slab heap data structures */
2859 struct slab_object {
2862 LDAP_LIST_ENTRY(slab_object) so_link;
2871 unsigned char **sh_map;
2872 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2873 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2876 #ifdef SLAP_ZONE_ALLOC
2877 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2878 #define SLAP_ZONE_SHIFT 19
2879 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2880 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2881 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2882 #define SLAP_ZONE_ZOBLOCK 256
2884 struct zone_object {
2889 LDAP_LIST_ENTRY(zone_object) zo_link;
2892 struct zone_latency_history {
2894 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2905 ldap_pvt_thread_rdwr_t *zh_znlock;
2906 Avlnode *zh_zonetree;
2907 unsigned char ***zh_maps;
2909 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2910 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2911 ldap_pvt_thread_mutex_t zh_mutex;
2912 ldap_pvt_thread_rdwr_t zh_lock;
2913 double zh_ema_latency;
2914 unsigned long zh_ema_samples;
2915 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2916 zh_latency_history_queue;
2917 int zh_latency_history_qlen;
2918 int zh_latency_jump;
2923 #define SLAP_BACKEND_INIT_MODULE(b) \
2925 init_module( int argc, char *argv[] ) \
2928 memset( &bi, '\0', sizeof( bi ) ); \
2930 bi.bi_init = b ## _back_initialize; \
2931 backend_add( &bi ); \
2937 #include "proto-slap.h"
2939 #endif /* _SLAP_H_ */