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_MAX_SYNCREPL_THREADS (8)
114 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
115 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
117 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
118 #define SLAP_CONN_MAX_PENDING_AUTH 1000
120 #define SLAP_TEXT_BUFLEN (256)
122 /* psuedo error code indicating abandoned operation */
123 #define SLAPD_ABANDON (-1024)
125 /* psuedo error code indicating disconnect */
126 #define SLAPD_DISCONNECT (-1025)
128 /* unknown config file directive */
129 #define SLAP_CONF_UNKNOWN (-1026)
131 /* We assume "C" locale, that is US-ASCII */
132 #define ASCII_SPACE(c) ( (c) == ' ' )
133 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
134 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
135 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
136 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
137 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
138 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
139 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
140 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
141 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
142 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
144 #define SLAP_NIBBLE(c) ((c)&0x0f)
145 #define SLAP_ESCAPE_CHAR ('\\')
146 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
147 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
149 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
150 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
152 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
153 /* NOTE: for consistency, this macro must only operate
154 * on normalized/pretty DN, such that ';' is never used
155 * as RDN separator, and all occurrences of ';' must be escaped */
156 #define DN_SEPARATOR(c) ((c) == ',')
157 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
158 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
159 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
161 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
162 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
163 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
164 #define OID_SEPARATOR(c) ( (c) == '.' )
165 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
167 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
168 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
170 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
171 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
173 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
175 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
176 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
177 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
178 (c) == '?' || (c) == ' ' || (c) == '=' )
179 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
181 /* must match in schema_init.c */
182 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
183 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
184 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
185 #define SLAPD_GROUP_ATTR "member"
186 #define SLAPD_GROUP_CLASS "groupOfNames"
187 #define SLAPD_ROLE_ATTR "roleOccupant"
188 #define SLAPD_ROLE_CLASS "organizationalRole"
190 #ifdef SLAPD_ACI_ENABLED
191 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
194 /* change this to "OpenLDAPset" */
195 #define SLAPD_ACI_SET_ATTR "template"
197 #define SLAPD_TOP_OID "2.5.6.0"
199 LDAP_SLAPD_V (int) slap_debug;
201 typedef unsigned long slap_mask_t;
203 /* Security Strength Factor */
204 typedef unsigned slap_ssf_t;
206 typedef struct slap_ssf_set {
208 slap_ssf_t sss_transport;
211 slap_ssf_t sss_update_ssf;
212 slap_ssf_t sss_update_transport;
213 slap_ssf_t sss_update_tls;
214 slap_ssf_t sss_update_sasl;
215 slap_ssf_t sss_simple_bind;
218 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
219 #define SLAP_GETDN_AUTHCID 2
220 #define SLAP_GETDN_AUTHZID 4
225 #define SLAP_INDEX_TYPE 0x00FFUL
226 #define SLAP_INDEX_UNDEFINED 0x0001UL
227 #define SLAP_INDEX_PRESENT 0x0002UL
228 #define SLAP_INDEX_EQUALITY 0x0004UL
229 #define SLAP_INDEX_APPROX 0x0008UL
230 #define SLAP_INDEX_SUBSTR 0x0010UL
231 #define SLAP_INDEX_EXTENDED 0x0020UL
233 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
235 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
237 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
239 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
240 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
241 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
242 #define SLAP_INDEX_SUBSTR_DEFAULT \
243 ( SLAP_INDEX_SUBSTR \
244 | SLAP_INDEX_SUBSTR_INITIAL \
245 | SLAP_INDEX_SUBSTR_ANY \
246 | SLAP_INDEX_SUBSTR_FINAL )
248 /* defaults for initial/final substring indices */
249 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
250 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
252 /* defaults for any substring indices */
253 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
254 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
256 #define SLAP_INDEX_FLAGS 0xF000UL
257 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
258 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
261 * there is a single index for each attribute. these prefixes ensure
262 * that there is no collision among keys.
264 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
265 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
266 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
267 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
268 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
269 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
271 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
272 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
273 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
274 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
275 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
278 * represents schema information for a database
280 #define SLAP_SCHERR_OUTOFMEM 1
281 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
282 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
283 #define SLAP_SCHERR_CLASS_BAD_SUP 4
284 #define SLAP_SCHERR_CLASS_DUP 5
285 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
286 #define SLAP_SCHERR_ATTR_BAD_MR 7
287 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
288 #define SLAP_SCHERR_ATTR_BAD_SUP 9
289 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
290 #define SLAP_SCHERR_ATTR_DUP 11
291 #define SLAP_SCHERR_MR_NOT_FOUND 12
292 #define SLAP_SCHERR_MR_INCOMPLETE 13
293 #define SLAP_SCHERR_MR_DUP 14
294 #define SLAP_SCHERR_SYN_NOT_FOUND 15
295 #define SLAP_SCHERR_SYN_DUP 16
296 #define SLAP_SCHERR_NO_NAME 17
297 #define SLAP_SCHERR_NOT_SUPPORTED 18
298 #define SLAP_SCHERR_BAD_DESCR 19
299 #define SLAP_SCHERR_OIDM 20
300 #define SLAP_SCHERR_CR_DUP 21
301 #define SLAP_SCHERR_CR_BAD_STRUCT 22
302 #define SLAP_SCHERR_CR_BAD_AUX 23
303 #define SLAP_SCHERR_CR_BAD_AT 24
304 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
306 typedef union slap_sockaddr {
307 struct sockaddr sa_addr;
308 struct sockaddr_in sa_in_addr;
310 struct sockaddr_storage sa_storage;
311 struct sockaddr_in6 sa_in6_addr;
314 struct sockaddr_un sa_un_addr;
319 extern int slap_inet4or6;
322 typedef struct slap_oid_macro {
323 struct berval som_oid;
325 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
328 /* forward declarations */
330 struct slap_matching_rule;
332 typedef int slap_syntax_validate_func LDAP_P((
333 struct slap_syntax *syntax,
334 struct berval * in));
336 typedef int slap_syntax_transform_func LDAP_P((
337 struct slap_syntax *syntax,
342 #ifdef LDAP_COMP_MATCH
343 typedef void* slap_component_transform_func LDAP_P((
344 struct berval * in ));
345 struct ComponentDesc;
348 typedef struct slap_syntax {
350 #define ssyn_oid ssyn_syn.syn_oid
351 #define ssyn_desc ssyn_syn.syn_desc
352 #define ssyn_extensions ssyn_syn.syn_extensions
355 ber_len_t ssyn_oidlen;
356 * has been replaced by a struct berval that uses the value
357 * provided by ssyn_syn.syn_oid; a macro that expands to
358 * the bv_len field of the berval is provided for backward
359 * compatibility. CAUTION: NEVER FREE THE BERVAL
361 struct berval ssyn_bvoid;
362 #define ssyn_oidlen ssyn_bvoid.bv_len
364 unsigned int ssyn_flags;
366 #define SLAP_SYNTAX_NONE 0x0000U
367 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
368 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
369 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
371 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
373 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
376 slap_syntax_validate_func *ssyn_validate;
377 slap_syntax_transform_func *ssyn_pretty;
379 #ifdef SLAPD_BINARY_CONVERSION
380 /* convert to and from binary */
381 slap_syntax_transform_func *ssyn_ber2str;
382 slap_syntax_transform_func *ssyn_str2ber;
384 #ifdef LDAP_COMP_MATCH
385 slap_component_transform_func *ssyn_attr2comp;
386 struct ComponentDesc* ssync_comp_syntax;
389 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
392 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
393 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
394 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
395 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
396 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
398 typedef struct slap_syntax_defs_rec {
401 slap_syntax_validate_func *sd_validate;
402 slap_syntax_transform_func *sd_pretty;
403 #ifdef SLAPD_BINARY_CONVERSION
404 slap_syntax_transform_func *sd_ber2str;
405 slap_syntax_transform_func *sd_str2ber;
407 } slap_syntax_defs_rec;
409 /* X -> Y Converter */
410 typedef int slap_mr_convert_func LDAP_P((
416 typedef int slap_mr_normalize_func LDAP_P((
418 struct slap_syntax *syntax, /* NULL if in is asserted value */
419 struct slap_matching_rule *mr,
424 /* Match (compare) function */
425 typedef int slap_mr_match_func LDAP_P((
428 struct slap_syntax *syntax, /* syntax of stored value */
429 struct slap_matching_rule *mr,
430 struct berval * value,
431 void * assertValue ));
433 /* Index generation function */
434 typedef int slap_mr_indexer_func LDAP_P((
437 struct slap_syntax *syntax, /* syntax of stored value */
438 struct slap_matching_rule *mr,
439 struct berval *prefix,
444 /* Filter index function */
445 typedef int slap_mr_filter_func LDAP_P((
448 struct slap_syntax *syntax, /* syntax of stored value */
449 struct slap_matching_rule *mr,
450 struct berval *prefix,
455 typedef struct slap_matching_rule_use MatchingRuleUse;
457 typedef struct slap_matching_rule {
458 LDAPMatchingRule smr_mrule;
459 MatchingRuleUse *smr_mru;
460 /* RFC2252 string representation */
461 struct berval smr_str;
464 * ber_len_t smr_oidlen;
465 * has been replaced by a struct berval that uses the value
466 * provided by smr_mrule.mr_oid; a macro that expands to
467 * the bv_len field of the berval is provided for backward
468 * compatibility. CAUTION: NEVER FREE THE BERVAL
470 struct berval smr_bvoid;
471 #define smr_oidlen smr_bvoid.bv_len
473 slap_mask_t smr_usage;
476 #define SLAP_MR_HIDE 0x0000U
478 #define SLAP_MR_HIDE 0x8000U
481 #define SLAP_MR_TYPE_MASK 0x0F00U
482 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
483 #define SLAP_MR_USAGE 0x000FU
485 #define SLAP_MR_NONE 0x0000U
486 #define SLAP_MR_EQUALITY 0x0100U
487 #define SLAP_MR_ORDERING 0x0200U
488 #define SLAP_MR_SUBSTR 0x0400U
489 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
490 #define SLAP_MR_ORDERED_INDEX 0x1000U
491 #ifdef LDAP_COMP_MATCH
492 #define SLAP_MR_COMPONENT 0x2000U
495 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
497 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
498 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
499 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
503 * The asserted value, depending on the particular usage,
504 * is expected to conform to either the assertion syntax
505 * or the attribute syntax. In some cases, the syntax of
506 * the value is known. If so, these flags indicate which
507 * syntax the value is expected to conform to. If not,
508 * neither of these flags is set (until the syntax of the
509 * provided value is determined). If the value is of the
510 * attribute syntax, the flag is changed once a value of
511 * the assertion syntax is derived from the provided value.
513 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
514 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
515 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
517 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
518 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
519 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
520 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
522 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
523 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
525 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
528 /* either or both the asserted value or attribute value
529 * may be provided in normalized form
531 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
532 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
534 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
535 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
536 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
537 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
539 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
540 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
541 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
542 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
543 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
544 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
546 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
547 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
548 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
549 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
552 slap_mr_convert_func *smr_convert;
553 slap_mr_normalize_func *smr_normalize;
554 slap_mr_match_func *smr_match;
555 slap_mr_indexer_func *smr_indexer;
556 slap_mr_filter_func *smr_filter;
559 * null terminated array of syntaxes compatible with this syntax
560 * note: when MS_EXT is set, this MUST NOT contain the assertion
561 * syntax of the rule. When MS_EXT is not set, it MAY.
563 Syntax **smr_compat_syntaxes;
566 * For equality rules, refers to an associated approximate rule.
567 * For non-equality rules, refers to an associated equality rule.
569 struct slap_matching_rule *smr_associated;
571 #define SLAP_MR_ASSOCIATED(mr,amr) \
572 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
574 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
576 #define smr_oid smr_mrule.mr_oid
577 #define smr_names smr_mrule.mr_names
578 #define smr_desc smr_mrule.mr_desc
579 #define smr_obsolete smr_mrule.mr_obsolete
580 #define smr_syntax_oid smr_mrule.mr_syntax_oid
581 #define smr_extensions smr_mrule.mr_extensions
584 struct slap_matching_rule_use {
585 LDAPMatchingRuleUse smru_mruleuse;
586 MatchingRule *smru_mr;
587 /* RFC2252 string representation */
588 struct berval smru_str;
590 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
592 #define smru_oid smru_mruleuse.mru_oid
593 #define smru_names smru_mruleuse.mru_names
594 #define smru_desc smru_mruleuse.mru_desc
595 #define smru_obsolete smru_mruleuse.mru_obsolete
596 #define smru_applies_oids smru_mruleuse.mru_applies_oids
598 #define smru_usage smru_mr->smr_usage
599 } /* MatchingRuleUse */ ;
601 typedef struct slap_mrule_defs_rec {
603 slap_mask_t mrd_usage;
604 char ** mrd_compat_syntaxes;
605 slap_mr_convert_func * mrd_convert;
606 slap_mr_normalize_func * mrd_normalize;
607 slap_mr_match_func * mrd_match;
608 slap_mr_indexer_func * mrd_indexer;
609 slap_mr_filter_func * mrd_filter;
611 /* For equality rule, this may refer to an associated approximate rule */
612 /* For non-equality rule, this may refer to an associated equality rule */
613 char * mrd_associated;
614 } slap_mrule_defs_rec;
616 struct slap_backend_db;
620 typedef int (AttributeTypeSchemaCheckFN)(
621 struct slap_backend_db *be,
622 struct slap_entry *e,
623 struct slap_attr *attr,
625 char *textbuf, size_t textlen );
627 typedef struct slap_attribute_type {
628 LDAPAttributeType sat_atype;
629 struct berval sat_cname;
630 struct slap_attribute_type *sat_sup;
631 struct slap_attribute_type **sat_subtypes;
632 MatchingRule *sat_equality;
633 MatchingRule *sat_approx;
634 MatchingRule *sat_ordering;
635 MatchingRule *sat_substr;
638 AttributeTypeSchemaCheckFN *sat_check;
640 #define SLAP_AT_NONE 0x0000U
641 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
642 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
644 #define SLAP_AT_HIDE 0x0000U /* publish everything */
646 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
648 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
650 slap_mask_t sat_flags;
652 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
654 #define sat_oid sat_atype.at_oid
655 #define sat_names sat_atype.at_names
656 #define sat_desc sat_atype.at_desc
657 #define sat_obsolete sat_atype.at_obsolete
658 #define sat_sup_oid sat_atype.at_sup_oid
659 #define sat_equality_oid sat_atype.at_equality_oid
660 #define sat_ordering_oid sat_atype.at_ordering_oid
661 #define sat_substr_oid sat_atype.at_substr_oid
662 #define sat_syntax_oid sat_atype.at_syntax_oid
663 #define sat_single_value sat_atype.at_single_value
664 #define sat_collective sat_atype.at_collective
665 #define sat_no_user_mod sat_atype.at_no_user_mod
666 #define sat_usage sat_atype.at_usage
667 #define sat_extensions sat_atype.at_extensions
669 struct slap_attr_desc *sat_ad;
670 ldap_pvt_thread_mutex_t sat_ad_mutex;
673 #define is_at_operational(at) ((at)->sat_usage)
674 #define is_at_single_value(at) ((at)->sat_single_value)
675 #define is_at_collective(at) ((at)->sat_collective)
676 #define is_at_obsolete(at) ((at)->sat_obsolete)
677 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
679 struct slap_object_class;
681 typedef int (ObjectClassSchemaCheckFN)(
682 struct slap_backend_db *be,
683 struct slap_entry *e,
684 struct slap_object_class *oc,
686 char *textbuf, size_t textlen );
688 typedef struct slap_object_class {
689 LDAPObjectClass soc_oclass;
690 struct berval soc_cname;
691 struct slap_object_class **soc_sups;
692 AttributeType **soc_required;
693 AttributeType **soc_allowed;
694 ObjectClassSchemaCheckFN *soc_check;
695 slap_mask_t soc_flags;
696 #define soc_oid soc_oclass.oc_oid
697 #define soc_names soc_oclass.oc_names
698 #define soc_desc soc_oclass.oc_desc
699 #define soc_obsolete soc_oclass.oc_obsolete
700 #define soc_sup_oids soc_oclass.oc_sup_oids
701 #define soc_kind soc_oclass.oc_kind
702 #define soc_at_oids_must soc_oclass.oc_at_oids_must
703 #define soc_at_oids_may soc_oclass.oc_at_oids_may
704 #define soc_extensions soc_oclass.oc_extensions
706 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
709 #define SLAP_OC_ALIAS 0x0001
710 #define SLAP_OC_REFERRAL 0x0002
711 #define SLAP_OC_SUBENTRY 0x0004
712 #define SLAP_OC_DYNAMICOBJECT 0x0008
713 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
714 #define SLAP_OC_GLUE 0x0020
715 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
716 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
717 #define SLAP_OC__MASK 0x00FF
718 #define SLAP_OC__END 0x0100
719 #define SLAP_OC_OPERATIONAL 0x4000
721 #define SLAP_OC_HIDE 0x0000
723 #define SLAP_OC_HIDE 0x8000
729 typedef struct slap_content_rule {
730 LDAPContentRule scr_crule;
731 ObjectClass *scr_sclass;
732 ObjectClass **scr_auxiliaries; /* optional */
733 AttributeType **scr_required; /* optional */
734 AttributeType **scr_allowed; /* optional */
735 AttributeType **scr_precluded; /* optional */
736 #define scr_oid scr_crule.cr_oid
737 #define scr_names scr_crule.cr_names
738 #define scr_desc scr_crule.cr_desc
739 #define scr_obsolete scr_crule.cr_obsolete
740 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
741 #define scr_at_oids_must scr_crule.cr_at_oids_must
742 #define scr_at_oids_may scr_crule.cr_at_oids_may
743 #define scr_at_oids_not scr_crule.cr_at_oids_not
745 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
748 /* Represents a recognized attribute description ( type + options ). */
749 typedef struct slap_attr_desc {
750 struct slap_attr_desc *ad_next;
751 AttributeType *ad_type; /* attribute type, must be specified */
752 struct berval ad_cname; /* canonical name, must be specified */
753 struct berval ad_tags; /* empty if no tagging options */
755 #define SLAP_DESC_NONE 0x00U
756 #define SLAP_DESC_BINARY 0x01U
757 #define SLAP_DESC_TAG_RANGE 0x80U
758 } AttributeDescription;
760 typedef struct slap_attr_name {
761 struct berval an_name;
762 AttributeDescription *an_desc;
767 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
768 #define slap_ad_is_tag_range(ad) \
769 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
770 #define slap_ad_is_binary(ad) \
771 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
774 * pointers to schema elements used internally
776 struct slap_internal_schema {
778 ObjectClass *si_oc_top;
779 ObjectClass *si_oc_extensibleObject;
780 ObjectClass *si_oc_alias;
781 ObjectClass *si_oc_referral;
782 ObjectClass *si_oc_rootdse;
783 ObjectClass *si_oc_subentry;
784 ObjectClass *si_oc_subschema;
785 ObjectClass *si_oc_collectiveAttributeSubentry;
786 ObjectClass *si_oc_dynamicObject;
788 ObjectClass *si_oc_glue;
789 ObjectClass *si_oc_syncConsumerSubentry;
790 ObjectClass *si_oc_syncProviderSubentry;
792 /* objectClass attribute descriptions */
793 AttributeDescription *si_ad_objectClass;
795 /* operational attribute descriptions */
796 AttributeDescription *si_ad_structuralObjectClass;
797 AttributeDescription *si_ad_creatorsName;
798 AttributeDescription *si_ad_createTimestamp;
799 AttributeDescription *si_ad_modifiersName;
800 AttributeDescription *si_ad_modifyTimestamp;
801 AttributeDescription *si_ad_hasSubordinates;
802 AttributeDescription *si_ad_subschemaSubentry;
803 AttributeDescription *si_ad_collectiveSubentries;
804 AttributeDescription *si_ad_collectiveExclusions;
805 AttributeDescription *si_ad_entryDN;
806 AttributeDescription *si_ad_entryUUID;
807 AttributeDescription *si_ad_entryCSN;
808 AttributeDescription *si_ad_namingCSN;
810 AttributeDescription *si_ad_dseType;
811 AttributeDescription *si_ad_syncreplCookie;
812 AttributeDescription *si_ad_syncTimestamp;
813 AttributeDescription *si_ad_contextCSN;
815 /* root DSE attribute descriptions */
816 AttributeDescription *si_ad_altServer;
817 AttributeDescription *si_ad_namingContexts;
818 AttributeDescription *si_ad_supportedControl;
819 AttributeDescription *si_ad_supportedExtension;
820 AttributeDescription *si_ad_supportedLDAPVersion;
821 AttributeDescription *si_ad_supportedSASLMechanisms;
822 AttributeDescription *si_ad_supportedFeatures;
823 AttributeDescription *si_ad_monitorContext;
824 AttributeDescription *si_ad_vendorName;
825 AttributeDescription *si_ad_vendorVersion;
827 /* subentry attribute descriptions */
828 AttributeDescription *si_ad_administrativeRole;
829 AttributeDescription *si_ad_subtreeSpecification;
831 /* subschema subentry attribute descriptions */
832 AttributeDescription *si_ad_attributeTypes;
833 AttributeDescription *si_ad_ditContentRules;
834 AttributeDescription *si_ad_ditStructureRules;
835 AttributeDescription *si_ad_ldapSyntaxes;
836 AttributeDescription *si_ad_matchingRules;
837 AttributeDescription *si_ad_matchingRuleUse;
838 AttributeDescription *si_ad_nameForms;
839 AttributeDescription *si_ad_objectClasses;
841 /* Aliases & Referrals */
842 AttributeDescription *si_ad_aliasedObjectName;
843 AttributeDescription *si_ad_ref;
845 /* Access Control Internals */
846 AttributeDescription *si_ad_entry;
847 AttributeDescription *si_ad_children;
848 AttributeDescription *si_ad_saslAuthzTo;
849 AttributeDescription *si_ad_saslAuthzFrom;
850 #ifdef SLAPD_ACI_ENABLED
851 AttributeDescription *si_ad_aci;
854 /* dynamic entries */
855 AttributeDescription *si_ad_entryTtl;
856 AttributeDescription *si_ad_dynamicSubtrees;
858 /* Other attributes descriptions */
859 AttributeDescription *si_ad_distinguishedName;
860 AttributeDescription *si_ad_name;
861 AttributeDescription *si_ad_cn;
862 AttributeDescription *si_ad_uid;
863 AttributeDescription *si_ad_userPassword;
864 AttributeDescription *si_ad_labeledURI;
865 #ifdef SLAPD_AUTHPASSWD
866 AttributeDescription *si_ad_authPassword;
868 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
869 AttributeDescription *si_ad_krbName;
872 /* Undefined Attribute Type */
873 AttributeType *si_at_undefined;
876 MatchingRule *si_mr_distinguishedNameMatch;
877 MatchingRule *si_mr_dnSubtreeMatch;
878 MatchingRule *si_mr_dnOneLevelMatch;
879 MatchingRule *si_mr_dnSubordinateMatch;
880 MatchingRule *si_mr_dnSuperiorMatch;
881 MatchingRule *si_mr_caseExactMatch;
882 MatchingRule *si_mr_caseExactSubstringsMatch;
883 MatchingRule *si_mr_caseExactIA5Match;
884 MatchingRule *si_mr_integerMatch;
885 MatchingRule *si_mr_integerFirstComponentMatch;
886 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
889 Syntax *si_syn_directoryString;
890 Syntax *si_syn_distinguishedName;
891 Syntax *si_syn_integer;
892 Syntax *si_syn_octetString;
894 /* Schema Syntaxes */
895 Syntax *si_syn_attributeTypeDesc;
896 Syntax *si_syn_ditContentRuleDesc;
897 Syntax *si_syn_ditStructureRuleDesc;
898 Syntax *si_syn_ldapSyntaxDesc;
899 Syntax *si_syn_matchingRuleDesc;
900 Syntax *si_syn_matchingRuleUseDesc;
901 Syntax *si_syn_nameFormDesc;
902 Syntax *si_syn_objectClassDesc;
905 typedef struct slap_attr_assertion {
906 AttributeDescription *aa_desc;
907 struct berval aa_value;
908 } AttributeAssertion;
910 typedef struct slap_ss_assertion {
911 AttributeDescription *sa_desc;
912 struct berval sa_initial;
913 struct berval *sa_any;
914 struct berval sa_final;
915 } SubstringsAssertion;
917 #ifdef LDAP_COMP_MATCH
918 struct slap_component_filter;
921 typedef struct slap_mr_assertion {
922 MatchingRule *ma_rule; /* optional */
923 struct berval ma_rule_text; /* optional */
924 AttributeDescription *ma_desc; /* optional */
925 int ma_dnattrs; /* boolean */
926 struct berval ma_value; /* required */
927 #ifdef LDAP_COMP_MATCH
928 struct slap_component_filter* ma_cf; /* component filter */
930 } MatchingRuleAssertion;
933 * represents a search filter
935 typedef struct slap_filter {
936 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
937 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
938 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
939 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
940 #ifdef LDAP_SCOPE_SUBORDINATE
941 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
945 /* precomputed result */
946 ber_int_t f_un_result;
949 struct berval *f_un_dn;
952 AttributeDescription *f_un_desc;
954 /* simple value assertion */
955 AttributeAssertion *f_un_ava;
957 /* substring assertion */
958 SubstringsAssertion *f_un_ssa;
960 /* matching rule assertion */
961 MatchingRuleAssertion *f_un_mra;
963 #define f_dn f_un.f_un_dn
964 #define f_desc f_un.f_un_desc
965 #define f_ava f_un.f_un_ava
966 #define f_av_desc f_un.f_un_ava->aa_desc
967 #define f_av_value f_un.f_un_ava->aa_value
968 #define f_sub f_un.f_un_ssa
969 #define f_sub_desc f_un.f_un_ssa->sa_desc
970 #define f_sub_initial f_un.f_un_ssa->sa_initial
971 #define f_sub_any f_un.f_un_ssa->sa_any
972 #define f_sub_final f_un.f_un_ssa->sa_final
973 #define f_mra f_un.f_un_mra
974 #define f_mr_rule f_un.f_un_mra->ma_rule
975 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
976 #define f_mr_desc f_un.f_un_mra->ma_desc
977 #define f_mr_value f_un.f_un_mra->ma_value
978 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
981 struct slap_filter *f_un_complex;
984 #define f_result f_un.f_un_result
985 #define f_and f_un.f_un_complex
986 #define f_or f_un.f_un_complex
987 #define f_not f_un.f_un_complex
988 #define f_list f_un.f_un_complex
990 struct slap_filter *f_next;
993 /* compare routines can return undefined */
994 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
996 typedef struct slap_valuesreturnfilter {
997 ber_tag_t vrf_choice;
1000 /* precomputed result */
1001 ber_int_t vrf_un_result;
1007 AttributeDescription *vrf_un_desc;
1009 /* simple value assertion */
1010 AttributeAssertion *vrf_un_ava;
1012 /* substring assertion */
1013 SubstringsAssertion *vrf_un_ssa;
1015 /* matching rule assertion */
1016 MatchingRuleAssertion *vrf_un_mra;
1018 #define vrf_result vrf_un.vrf_un_result
1019 #define vrf_dn vrf_un.vrf_un_dn
1020 #define vrf_desc vrf_un.vrf_un_desc
1021 #define vrf_ava vrf_un.vrf_un_ava
1022 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1023 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1024 #define vrf_ssa vrf_un.vrf_un_ssa
1025 #define vrf_sub vrf_un.vrf_un_ssa
1026 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1027 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1028 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1029 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1030 #define vrf_mra vrf_un.vrf_un_mra
1031 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1032 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1033 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1034 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1035 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1040 struct slap_valuesreturnfilter *vrf_next;
1041 } ValuesReturnFilter;
1043 #ifdef LDAP_COMP_MATCH
1044 struct slap_component_syntax_info;
1045 typedef struct slap_component_data {
1046 void* cd_mem_op;/* nibble memory handler */
1047 struct slap_component_syntax_info** cd_tree;/* component tree */
1052 * represents an attribute (description + values)
1054 typedef struct slap_attr {
1055 AttributeDescription *a_desc;
1056 BerVarray a_vals; /* preserved values */
1057 BerVarray a_nvals; /* normalized values */
1058 #ifdef LDAP_COMP_MATCH
1059 ComponentData *a_comp_data; /* component values */
1061 struct slap_attr *a_next;
1063 #define SLAP_ATTR_IXADD 0x1U
1064 #define SLAP_ATTR_IXDEL 0x2U
1069 * the id used in the indexes to refer to an entry
1071 typedef unsigned long ID;
1072 #define NOID ((ID)~0)
1075 * represents an entry in core
1077 typedef struct slap_entry {
1079 * The ID field should only be changed before entry is
1080 * inserted into a cache. The ID value is backend
1085 struct berval e_name; /* name (DN) of this entry */
1086 struct berval e_nname; /* normalized name (DN) of this entry */
1088 /* for migration purposes */
1089 #define e_dn e_name.bv_val
1090 #define e_ndn e_nname.bv_val
1092 Attribute *e_attrs; /* list of attributes + values */
1094 slap_mask_t e_ocflags;
1096 struct berval e_bv; /* For entry_encode/entry_decode */
1098 /* for use by the backend for any purpose */
1103 * A list of LDAPMods
1105 typedef struct slap_mod {
1107 AttributeDescription *sm_desc;
1108 struct berval sm_type;
1109 BerVarray sm_values;
1110 BerVarray sm_nvalues;
1113 typedef struct slap_mod_list {
1114 Modification sml_mod;
1115 #define sml_op sml_mod.sm_op
1116 #define sml_desc sml_mod.sm_desc
1117 #define sml_type sml_mod.sm_type
1118 #define sml_values sml_mod.sm_values
1119 #define sml_nvalues sml_mod.sm_nvalues
1120 struct slap_mod_list *sml_next;
1123 typedef struct slap_ldap_modlist {
1125 struct slap_ldap_modlist *ml_next;
1126 #define ml_op ml_mod.mod_op
1127 #define ml_type ml_mod.mod_type
1128 #define ml_values ml_mod.mod_values
1132 * represents an access control list
1134 typedef enum slap_access_e {
1135 ACL_INVALID_ACCESS = -1,
1146 typedef enum slap_control_e {
1147 ACL_INVALID_CONTROL = 0,
1153 typedef enum slap_style_e {
1154 ACL_STYLE_REGEX = 0,
1161 ACL_STYLE_ANONYMOUS,
1168 typedef struct slap_authz_info {
1169 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1170 struct berval sai_mech; /* SASL Mechanism */
1171 struct berval sai_dn; /* DN for reporting purposes */
1172 struct berval sai_ndn; /* Normalized DN */
1174 /* Security Strength Factors */
1175 slap_ssf_t sai_ssf; /* Overall SSF */
1176 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1177 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1178 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1179 } AuthorizationInformation;
1186 * "dynamic" ACL infrastructure (for ACIs and more)
1188 typedef int (*slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1189 typedef int (*slap_dynacl_print)( void *priv );
1190 typedef int (*slap_dynacl_mask)(
1194 AttributeDescription *desc,
1197 regmatch_t *matches,
1198 slap_access_t *grant,
1199 slap_access_t *deny );
1200 typedef int (*slap_dynacl_destroy)( void *priv );
1202 typedef struct slap_dynacl_t {
1204 slap_dynacl_parse da_parse;
1205 slap_dynacl_print da_print;
1206 slap_dynacl_mask da_mask;
1207 slap_dynacl_destroy da_destroy;
1210 struct slap_dynacl_t *da_next;
1212 #endif /* SLAP_DYNACL */
1215 typedef struct slap_access {
1216 slap_control_t a_type;
1218 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1220 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1221 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1222 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1223 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1224 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1225 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1226 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1227 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1229 #define ACL_PRIV_MASK 0x00ffUL
1232 #define ACL_PRIV_LEVEL 0x1000UL
1233 #define ACL_PRIV_ADDITIVE 0x2000UL
1234 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1237 #define ACL_PRIV_INVALID 0x0UL
1239 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1240 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1241 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1242 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1244 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1245 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1247 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1249 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1251 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1252 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1253 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1255 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1256 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1257 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1258 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1259 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1260 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1261 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1262 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1264 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1265 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1266 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1267 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1268 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1269 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1270 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1271 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1272 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1274 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1275 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1276 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1277 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1278 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1279 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1280 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1281 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1283 slap_mask_t a_access_mask;
1285 AuthorizationInformation a_authz;
1286 #define a_dn_pat a_authz.sai_dn
1288 slap_style_t a_dn_style;
1289 AttributeDescription *a_dn_at;
1293 slap_style_t a_peername_style;
1294 struct berval a_peername_pat;
1295 unsigned long a_peername_addr,
1297 int a_peername_port;
1299 slap_style_t a_sockname_style;
1300 struct berval a_sockname_pat;
1302 slap_style_t a_domain_style;
1303 struct berval a_domain_pat;
1304 int a_domain_expand;
1306 slap_style_t a_sockurl_style;
1307 struct berval a_sockurl_pat;
1308 slap_style_t a_set_style;
1309 struct berval a_set_pat;
1312 slap_dynacl_t *a_dynacl;
1313 #else /* ! SLAP_DYNACL */
1314 #ifdef SLAPD_ACI_ENABLED
1315 AttributeDescription *a_aci_at;
1317 #endif /* SLAP_DYNACL */
1320 slap_style_t a_group_style;
1321 struct berval a_group_pat;
1322 ObjectClass *a_group_oc;
1323 AttributeDescription *a_group_at;
1325 struct slap_access *a_next;
1329 typedef struct slap_acl {
1330 /* "to" part: the entries this acl applies to */
1332 slap_style_t acl_dn_style;
1334 struct berval acl_dn_pat;
1335 AttributeName *acl_attrs;
1336 slap_style_t acl_attrval_style;
1337 regex_t acl_attrval_re;
1338 struct berval acl_attrval;
1340 /* "by" part: list of who has what access to the entries */
1343 struct slap_acl *acl_next;
1346 typedef struct slap_acl_state {
1347 unsigned as_recorded;
1348 #define ACL_STATE_NOT_RECORDED 0x0
1349 #define ACL_STATE_RECORDED_VD 0x1
1350 #define ACL_STATE_RECORDED_NV 0x2
1351 #define ACL_STATE_RECORDED 0x3
1354 AccessControl *as_vd_acl;
1355 AccessControl *as_vi_acl;
1356 slap_mask_t as_vd_acl_mask;
1357 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1358 int as_vd_acl_count;
1360 Access *as_vd_access;
1361 int as_vd_access_count;
1364 AttributeDescription *as_vd_ad;
1365 } AccessControlState;
1366 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1367 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1371 * represents a backend
1374 typedef struct slap_backend_info BackendInfo; /* per backend type */
1375 typedef struct slap_backend_db BackendDB; /* per backend database */
1377 LDAP_SLAPD_V (int) nBackendInfo;
1378 LDAP_SLAPD_V (int) nBackendDB;
1379 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1380 LDAP_SLAPD_V (BackendDB *) backendDB;
1381 LDAP_SLAPD_V (BackendDB *) frontendDB;
1383 LDAP_SLAPD_V (int) slapMode;
1384 #define SLAP_UNDEFINED_MODE 0x0000
1385 #define SLAP_SERVER_MODE 0x0001
1386 #define SLAP_TOOL_MODE 0x0002
1387 #define SLAP_MODE 0x0003
1389 #define SLAP_TRUNCATE_MODE 0x0100
1390 #define SLAP_TOOL_READMAIN 0x0200
1391 #define SLAP_TOOL_READONLY 0x0400
1392 #define SLAP_TOOL_QUICK 0x0800
1394 struct slap_replica_info {
1395 char *ri_host; /* supersedes be_replica */
1396 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1397 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1398 int ri_exclude; /* 1 => exclude ri_attrs */
1401 struct slap_limits_set {
1409 int lms_s_unchecked;
1415 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1416 #define SLAP_NO_LIMIT -1
1417 #define SLAP_MAX_LIMIT 2147483647
1419 struct slap_limits {
1420 unsigned lm_flags; /* type of pattern */
1421 #define SLAP_LIMITS_UNDEFINED 0x0000U
1422 #define SLAP_LIMITS_EXACT 0x0001U
1423 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1424 #define SLAP_LIMITS_ONE 0x0002U
1425 #define SLAP_LIMITS_SUBTREE 0x0003U
1426 #define SLAP_LIMITS_CHILDREN 0x0004U
1427 #define SLAP_LIMITS_REGEX 0x0005U
1428 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1429 #define SLAP_LIMITS_USERS 0x0007U
1430 #define SLAP_LIMITS_ANY 0x0008U
1431 #define SLAP_LIMITS_MASK 0x000FU
1433 #define SLAP_LIMITS_TYPE_DN 0x0000U
1434 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1435 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1437 regex_t lm_regex; /* regex data for REGEX */
1440 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1441 * pattern for REGEX; NULL for ANONYMOUS, USERS
1443 struct berval lm_pat;
1445 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1446 * lm_group_oc is objectClass and lm_group_at is attributeType
1447 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1448 * can only be SLAP_LIMITS_EXACT */
1449 ObjectClass *lm_group_oc;
1450 AttributeDescription *lm_group_ad;
1452 struct slap_limits_set lm_limits;
1455 /* temporary aliases */
1456 typedef BackendDB Backend;
1457 #define nbackends nBackendDB
1458 #define backends backendDB
1461 * syncinfo structure for syncrepl
1464 #define SLAP_SYNC_SID_SIZE 3
1465 #define SLAP_SYNC_RID_SIZE 3
1466 #define SLAP_SYNCUUID_SET_SIZE 256
1468 #define SLAP_SYNC_UPDATE_MSGID 2
1470 struct nonpresent_entry {
1471 struct berval *npe_name;
1472 struct berval *npe_nname;
1473 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1476 struct sync_cookie {
1477 struct berval ctxcsn;
1478 struct berval octet_str;
1480 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1483 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1485 typedef struct syncinfo_s {
1486 struct slap_backend_db *si_be;
1488 struct berval si_provideruri;
1489 #define SYNCINFO_TLS_OFF 0
1490 #define SYNCINFO_TLS_ON 1
1491 #define SYNCINFO_TLS_CRITICAL 2
1501 int si_schemachecking;
1502 struct berval si_filterstr;
1503 struct berval si_base;
1506 AttributeName *si_anlist;
1507 AttributeName *si_exanlist;
1514 time_t *si_retryinterval;
1515 int *si_retrynum_init;
1517 struct sync_cookie si_syncCookie;
1521 int si_refreshDelete;
1522 int si_refreshPresent;
1523 Avlnode *si_presentlist;
1525 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1528 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1530 struct slap_backend_db {
1531 BackendInfo *bd_info; /* pointer to shared backend info */
1533 /* fields in this structure (and routines acting on this structure)
1534 should be renamed from be_ to bd_ */
1536 /* BackendInfo accessors */
1537 #define be_config bd_info->bi_db_config
1538 #define be_type bd_info->bi_type
1540 #define be_bind bd_info->bi_op_bind
1541 #define be_unbind bd_info->bi_op_unbind
1542 #define be_add bd_info->bi_op_add
1543 #define be_compare bd_info->bi_op_compare
1544 #define be_delete bd_info->bi_op_delete
1545 #define be_modify bd_info->bi_op_modify
1546 #define be_modrdn bd_info->bi_op_modrdn
1547 #define be_search bd_info->bi_op_search
1548 #define be_abandon bd_info->bi_op_abandon
1549 #define be_cancel bd_info->bi_op_cancel
1551 #define be_extended bd_info->bi_extended
1553 #define be_chk_referrals bd_info->bi_chk_referrals
1554 #define be_fetch bd_info->bi_entry_get_rw
1555 #define be_release bd_info->bi_entry_release_rw
1556 #define be_group bd_info->bi_acl_group
1557 #define be_attribute bd_info->bi_acl_attribute
1558 #define be_operational bd_info->bi_operational
1561 * define to honor hasSubordinates operational attribute in search filters
1562 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1565 #define be_has_subordinates bd_info->bi_has_subordinates
1567 #define be_controls bd_info->bi_controls
1569 #define be_connection_init bd_info->bi_connection_init
1570 #define be_connection_destroy bd_info->bi_connection_destroy
1573 #define be_entry_open bd_info->bi_tool_entry_open
1574 #define be_entry_close bd_info->bi_tool_entry_close
1575 #define be_entry_first bd_info->bi_tool_entry_first
1576 #define be_entry_next bd_info->bi_tool_entry_next
1577 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1578 #define be_entry_get bd_info->bi_tool_entry_get
1579 #define be_entry_put bd_info->bi_tool_entry_put
1580 #define be_sync bd_info->bi_tool_sync
1581 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1582 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1583 #define be_entry_modify bd_info->bi_tool_entry_modify
1586 /* Database flags */
1587 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1588 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1589 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1590 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1591 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1592 #define SLAP_DBFLAG_OVERLAY 0x0080U /* this db struct is an overlay */
1593 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1594 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1595 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1596 slap_mask_t be_flags;
1597 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1598 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1599 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1600 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1601 #define SLAP_NO_SCHEMA_CHECK(be) \
1602 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1603 #define SLAP_GLUE_INSTANCE(be) \
1604 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1605 #define SLAP_GLUE_SUBORDINATE(be) \
1606 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1607 #define SLAP_GLUE_LINKED(be) \
1608 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1609 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1610 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1611 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1613 slap_mask_t be_restrictops; /* restriction operations */
1614 #define SLAP_RESTRICT_OP_ADD 0x0001U
1615 #define SLAP_RESTRICT_OP_BIND 0x0002U
1616 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1617 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1618 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1619 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1620 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1621 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1622 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1624 #define SLAP_RESTRICT_READONLY 0x80000000U
1626 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1627 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1628 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1629 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1630 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1632 #define SLAP_RESTRICT_OP_READS \
1633 ( SLAP_RESTRICT_OP_COMPARE \
1634 | SLAP_RESTRICT_OP_SEARCH )
1635 #define SLAP_RESTRICT_OP_WRITES \
1636 ( SLAP_RESTRICT_OP_ADD \
1637 | SLAP_RESTRICT_OP_DELETE \
1638 | SLAP_RESTRICT_OP_MODIFY \
1639 | SLAP_RESTRICT_OP_RENAME )
1641 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1642 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1643 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1645 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1647 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1648 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1649 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1651 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1652 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1654 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1656 slap_mask_t be_requires; /* pre-operation requirements */
1657 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1658 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1659 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1660 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1661 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1663 /* Required Security Strength Factor */
1664 slap_ssf_set_t be_ssf_set;
1666 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1667 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1668 struct berval be_schemadn; /* per-backend subschema subentry DN */
1669 struct berval be_schemandn; /* normalized subschema DN */
1670 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1671 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1672 struct berval be_rootpw; /* the magic "root" password for this db */
1673 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1674 #define be_sizelimit be_def_limit.lms_s_soft
1675 #define be_timelimit be_def_limit.lms_t_soft
1676 struct slap_limits_set be_def_limit; /* default limits */
1677 struct slap_limits **be_limits; /* regex-based size and time limits */
1678 AccessControl *be_acl; /* access control list for this backend */
1679 slap_access_t be_dfltaccess; /* access given if no acl matches */
1681 /* Replica Information */
1682 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1683 char *be_replogfile; /* replication log file (in master) */
1684 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1685 BerVarray be_update_refs; /* where to refer modifying clients to */
1686 struct be_pcl *be_pending_csn_list;
1687 ldap_pvt_thread_mutex_t be_pcl_mutex;
1688 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1689 syncinfo_t *be_syncinfo; /* For syncrepl */
1692 void *be_pb; /* Netscape plugin */
1694 void *be_private; /* anything the backend database needs */
1700 /* Backend function typedefs */
1701 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1702 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1703 const char *fname, int lineno,
1704 int argc, char **argv));
1705 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1706 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1707 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1709 typedef int (BI_db_init) LDAP_P((Backend *bd));
1710 typedef int (BI_db_config) LDAP_P((Backend *bd,
1711 const char *fname, int lineno,
1712 int argc, char **argv));
1713 typedef int (BI_db_open) LDAP_P((Backend *bd));
1714 typedef int (BI_db_close) LDAP_P((Backend *bd));
1715 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1717 typedef struct req_bind_s {
1719 struct berval rb_cred;
1720 struct berval rb_edn;
1722 struct berval rb_tmp_mech; /* FIXME: temporary */
1725 typedef struct req_search_s {
1730 /* NULL means be_isroot evaluated to TRUE */
1731 struct slap_limits_set *rs_limit;
1733 AttributeName *rs_attrs;
1735 struct berval rs_filterstr;
1736 int rs_post_search_id;
1739 typedef struct req_compare_s {
1740 AttributeAssertion *rs_ava;
1743 typedef struct req_modify_s {
1744 Modifications *rs_modlist;
1745 int rs_increment; /* FIXME: temporary */
1748 typedef struct req_modrdn_s {
1749 struct berval rs_newrdn;
1750 struct berval rs_nnewrdn;
1751 struct berval *rs_newSup;
1752 struct berval *rs_nnewSup;
1753 int rs_deleteoldrdn;
1756 typedef struct req_add_s {
1758 Modifications *rs_modlist; /* FIXME: temporary */
1761 typedef struct req_abandon_s {
1766 #define SLAP_EXOP_HIDE 0x0000
1768 #define SLAP_EXOP_HIDE 0x8000
1770 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1772 typedef struct req_extended_s {
1773 struct berval rs_reqoid;
1775 struct berval *rs_reqdata;
1778 typedef struct req_pwdexop_s {
1779 struct berval rs_reqoid;
1781 struct berval rs_old;
1782 struct berval rs_new;
1783 Modifications *rs_mods;
1784 Modifications **rs_modtail;
1787 typedef enum slap_reply_e {
1796 typedef struct rep_sasl_s {
1797 struct berval *r_sasldata;
1800 typedef struct rep_extended_s {
1801 const char *r_rspoid;
1802 struct berval *r_rspdata;
1805 typedef struct rep_search_s {
1807 slap_mask_t r_attr_flags;
1808 #define SLAP_ATTRS_UNDEFINED (0x00U)
1809 #define SLAP_OPATTRS_NO (0x01U)
1810 #define SLAP_OPATTRS_YES (0x02U)
1811 #define SLAP_USERATTRS_NO (0x10U)
1812 #define SLAP_USERATTRS_YES (0x20U)
1813 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1814 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1815 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1816 #define SLAP_USERATTRS(f) \
1817 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1819 Attribute *r_operational_attrs;
1820 AttributeName *r_attrs;
1825 typedef struct slap_rep {
1826 slap_reply_t sr_type;
1830 const char *sr_matched;
1831 const char *sr_text;
1833 LDAPControl **sr_ctrls;
1835 rep_sasl_s sru_sasl;
1836 rep_extended_s sru_extended;
1837 rep_search_s sru_search;
1839 slap_mask_t sr_flags;
1840 #define REP_ENTRY_MODIFIABLE 0x0001U
1841 #define REP_ENTRY_MUSTBEFREED 0x0002U
1842 #define REP_MATCHED_MUSTBEFREED 0x0010U
1843 #define REP_REF_MUSTBEFREED 0x0020U
1846 /* short hands for response members */
1847 #define sr_attrs sr_un.sru_search.r_attrs
1848 #define sr_entry sr_un.sru_search.r_entry
1849 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1850 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1851 #define sr_v2ref sr_un.sru_search.r_v2ref
1852 #define sr_nentries sr_un.sru_search.r_nentries
1853 #define sr_rspoid sr_un.sru_extended.r_rspoid
1854 #define sr_rspdata sr_un.sru_extended.r_rspdata
1855 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1857 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1858 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1859 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1860 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1861 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1862 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1863 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1864 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1865 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1866 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1867 typedef int (BI_op_extended) LDAP_P((
1868 struct slap_op *op, struct slap_rep *rs ));
1869 typedef int (BI_chk_referrals) LDAP_P((
1870 struct slap_op *op, struct slap_rep *rs ));
1871 typedef int (BI_entry_release_rw)
1872 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1873 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1874 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1875 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1876 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1877 Entry *e, int *hasSubs ));
1879 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1880 struct slap_conn *c ));
1881 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1882 struct slap_conn *c ));
1884 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1885 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1886 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1887 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1888 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1889 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1890 struct berval *text ));
1891 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1892 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1893 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1894 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1895 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1896 struct berval *text ));
1898 struct slap_backend_info {
1899 char *bi_type; /* type of backend */
1902 * per backend type routines:
1903 * bi_init: called to allocate a backend_info structure,
1904 * called once BEFORE configuration file is read.
1905 * bi_init() initializes this structure hence is
1906 * called directly from be_initialize()
1907 * bi_config: called per 'backend' specific option
1908 * all such options must before any 'database' options
1909 * bi_config() is called only from read_config()
1910 * bi_open: called to open each database, called
1911 * once AFTER configuration file is read but
1912 * BEFORE any bi_db_open() calls.
1913 * bi_open() is called from backend_startup()
1914 * bi_close: called to close each database, called
1915 * once during shutdown after all bi_db_close calls.
1916 * bi_close() is called from backend_shutdown()
1917 * bi_destroy: called to destroy each database, called
1918 * once during shutdown after all bi_db_destroy calls.
1919 * bi_destory() is called from backend_destroy()
1922 BI_config *bi_config;
1925 BI_destroy *bi_destroy;
1928 * per database routines:
1929 * bi_db_init: called to initialize each database,
1930 * called upon reading 'database <type>'
1931 * called only from backend_db_init()
1932 * bi_db_config: called to configure each database,
1933 * called per database to handle per database options
1934 * called only from read_config()
1935 * bi_db_open: called to open each database
1936 * called once per database immediately AFTER bi_open()
1937 * calls but before daemon startup.
1938 * called only by backend_startup()
1939 * bi_db_close: called to close each database
1940 * called once per database during shutdown but BEFORE
1941 * any bi_close call.
1942 * called only by backend_shutdown()
1943 * bi_db_destroy: called to destroy each database
1944 * called once per database during shutdown AFTER all
1945 * bi_close calls but before bi_destory calls.
1946 * called only by backend_destory()
1948 BI_db_init *bi_db_init;
1949 BI_db_config *bi_db_config;
1950 BI_db_open *bi_db_open;
1951 BI_db_close *bi_db_close;
1952 BI_db_destroy *bi_db_destroy;
1954 /* LDAP Operations Handling Routines */
1955 BI_op_bind *bi_op_bind;
1956 BI_op_unbind *bi_op_unbind;
1957 BI_op_search *bi_op_search;
1958 BI_op_compare *bi_op_compare;
1959 BI_op_modify *bi_op_modify;
1960 BI_op_modrdn *bi_op_modrdn;
1961 BI_op_add *bi_op_add;
1962 BI_op_delete *bi_op_delete;
1963 BI_op_abandon *bi_op_abandon;
1964 BI_op_cancel *bi_op_cancel;
1966 /* Extended Operations Helper */
1967 BI_op_extended *bi_extended;
1969 /* Auxilary Functions */
1970 BI_operational *bi_operational;
1971 BI_chk_referrals *bi_chk_referrals;
1972 BI_entry_get_rw *bi_entry_get_rw;
1973 BI_entry_release_rw *bi_entry_release_rw;
1975 BI_has_subordinates *bi_has_subordinates;
1977 BI_connection_init *bi_connection_init;
1978 BI_connection_destroy *bi_connection_destroy;
1980 /* hooks for slap tools */
1981 BI_tool_entry_open *bi_tool_entry_open;
1982 BI_tool_entry_close *bi_tool_entry_close;
1983 BI_tool_entry_first *bi_tool_entry_first;
1984 BI_tool_entry_next *bi_tool_entry_next;
1985 BI_tool_entry_get *bi_tool_entry_get;
1986 BI_tool_entry_put *bi_tool_entry_put;
1987 BI_tool_entry_reindex *bi_tool_entry_reindex;
1988 BI_tool_sync *bi_tool_sync;
1989 BI_tool_dn2id_get *bi_tool_dn2id_get;
1990 BI_tool_id2entry_get *bi_tool_id2entry_get;
1991 BI_tool_entry_modify *bi_tool_entry_modify;
1993 #define SLAP_INDEX_ADD_OP 0x0001
1994 #define SLAP_INDEX_DELETE_OP 0x0002
1996 slap_mask_t bi_flags; /* backend flags */
1997 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
1998 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
1999 #define SLAP_BFLAG_INCREMENT 0x0100U
2000 #define SLAP_BFLAG_ALIASES 0x1000U
2001 #define SLAP_BFLAG_REFERRALS 0x2000U
2002 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2003 #define SLAP_BFLAG_DYNAMIC 0x8000U
2005 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2006 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2007 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2008 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2009 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2010 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2011 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2012 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2013 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2015 char **bi_controls; /* supported controls */
2017 unsigned int bi_nDB; /* number of databases of this type */
2018 void *bi_private; /* anything the backend type needs */
2021 #define c_authtype c_authz.sai_method
2022 #define c_authmech c_authz.sai_mech
2023 #define c_dn c_authz.sai_dn
2024 #define c_ndn c_authz.sai_ndn
2025 #define c_ssf c_authz.sai_ssf
2026 #define c_transport_ssf c_authz.sai_transport_ssf
2027 #define c_tls_ssf c_authz.sai_tls_ssf
2028 #define c_sasl_ssf c_authz.sai_sasl_ssf
2030 #define o_authtype o_authz.sai_method
2031 #define o_authmech o_authz.sai_mech
2032 #define o_dn o_authz.sai_dn
2033 #define o_ndn o_authz.sai_ndn
2034 #define o_ssf o_authz.sai_ssf
2035 #define o_transport_ssf o_authz.sai_transport_ssf
2036 #define o_tls_ssf o_authz.sai_tls_ssf
2037 #define o_sasl_ssf o_authz.sai_sasl_ssf
2039 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2041 typedef struct slap_callback {
2042 struct slap_callback *sc_next;
2043 slap_response *sc_response;
2044 slap_response *sc_cleanup;
2048 struct slap_overinfo;
2050 typedef struct slap_overinst {
2052 slap_response *on_response;
2053 struct slap_overinfo *on_info;
2054 struct slap_overinst *on_next;
2057 typedef struct slap_overinfo {
2059 BackendInfo *oi_orig;
2060 struct slap_overinst *oi_list;
2063 /* Should successive callbacks in a chain be processed? */
2064 #define SLAP_CB_FREEME 0x4000
2065 #define SLAP_CB_CONTINUE 0x8000
2068 * Paged Results state
2070 typedef unsigned long PagedResultsCookie;
2071 typedef struct slap_paged_state {
2074 PagedResultsCookie ps_cookie;
2076 } PagedResultsState;
2078 struct slap_csn_entry {
2079 struct berval ce_csn;
2080 unsigned long ce_opid;
2081 unsigned long ce_connid;
2082 #define SLAP_CSN_PENDING 1
2083 #define SLAP_CSN_COMMIT 2
2085 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2089 * Caches the result of a backend_group check for ACL evaluation
2091 typedef struct slap_gacl {
2092 struct slap_gacl *ga_next;
2095 AttributeDescription *ga_at;
2101 #ifndef SLAP_MAX_CIDS
2102 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
2105 struct slap_control_ids {
2111 int sc_modifyIncrement;
2113 int sc_pagedResults;
2114 int sc_valuesReturnFilter;
2115 int sc_permissiveModify;
2118 int sc_searchOptions;
2124 * represents an operation pending from an ldap client
2126 typedef struct slap_op_header {
2127 unsigned long oh_opid; /* id of this operation */
2128 unsigned long oh_connid; /* id of conn initiating this op */
2129 struct slap_conn *oh_conn; /* connection spawning this op */
2131 ber_int_t oh_msgid; /* msgid of the request */
2132 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2134 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2136 void *oh_threadctx; /* thread pool thread context */
2137 void *oh_tmpmemctx; /* slab malloc context */
2138 BerMemoryFunctions *oh_tmpmfuncs;
2140 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2143 void *oh_pb; /* NS-SLAPI plugin */
2144 void *oh_extensions; /* NS-SLAPI plugin */
2148 typedef struct slap_op {
2151 #define o_opid o_hdr->oh_opid
2152 #define o_connid o_hdr->oh_connid
2153 #define o_conn o_hdr->oh_conn
2154 #define o_msgid o_hdr->oh_msgid
2155 #define o_protocol o_hdr->oh_protocol
2156 #define o_tid o_hdr->oh_tid
2157 #define o_threadctx o_hdr->oh_threadctx
2158 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2159 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2161 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2162 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2163 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2164 #define o_tmpfree o_tmpmfuncs->bmf_free
2166 #define o_log_prefix o_hdr->oh_log_prefix
2169 #define o_pb o_hdr->oh_pb
2170 #define o_extensions o_hdr->oh_extensions
2173 ber_tag_t o_tag; /* tag of the request */
2174 time_t o_time; /* time op was initiated */
2176 BackendDB *o_bd; /* backend DB processing this op */
2177 struct berval o_req_dn; /* DN of target of request */
2178 struct berval o_req_ndn;
2183 req_compare_s oq_compare;
2184 req_modify_s oq_modify;
2185 req_modrdn_s oq_modrdn;
2186 req_search_s oq_search;
2187 req_abandon_s oq_abandon;
2188 req_abandon_s oq_cancel;
2189 req_extended_s oq_extended;
2190 req_pwdexop_s oq_pwdexop;
2193 /* short hands for union members */
2194 #define oq_add o_request.oq_add
2195 #define oq_bind o_request.oq_bind
2196 #define oq_compare o_request.oq_compare
2197 #define oq_modify o_request.oq_modify
2198 #define oq_modrdn o_request.oq_modrdn
2199 #define oq_search o_request.oq_search
2200 #define oq_abandon o_request.oq_abandon
2201 #define oq_cancel o_request.oq_cancel
2202 #define oq_extended o_request.oq_extended
2203 #define oq_pwdexop o_request.oq_pwdexop
2205 /* short hands for inner request members */
2206 #define orb_method oq_bind.rb_method
2207 #define orb_cred oq_bind.rb_cred
2208 #define orb_edn oq_bind.rb_edn
2209 #define orb_ssf oq_bind.rb_ssf
2210 #define orb_tmp_mech oq_bind.rb_tmp_mech
2212 #define ors_scope oq_search.rs_scope
2213 #define ors_deref oq_search.rs_deref
2214 #define ors_slimit oq_search.rs_slimit
2215 #define ors_tlimit oq_search.rs_tlimit
2216 #define ors_limit oq_search.rs_limit
2217 #define ors_attrsonly oq_search.rs_attrsonly
2218 #define ors_attrs oq_search.rs_attrs
2219 #define ors_filter oq_search.rs_filter
2220 #define ors_filterstr oq_search.rs_filterstr
2221 #define ors_post_search_id oq_search.rs_post_search_id
2223 #define orr_newrdn oq_modrdn.rs_newrdn
2224 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2225 #define orr_newSup oq_modrdn.rs_newSup
2226 #define orr_nnewSup oq_modrdn.rs_nnewSup
2227 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2229 #define orc_ava oq_compare.rs_ava
2230 #define ora_e oq_add.rs_e
2231 #define ora_modlist oq_add.rs_modlist
2232 #define orn_msgid oq_abandon.rs_msgid
2233 #define orm_modlist oq_modify.rs_modlist
2234 #define orm_increment oq_modify.rs_increment
2236 #define ore_reqoid oq_extended.rs_reqoid
2237 #define ore_flags oq_extended.rs_flags
2238 #define ore_reqdata oq_extended.rs_reqdata
2239 volatile sig_atomic_t o_abandon; /* abandon flag */
2240 volatile sig_atomic_t o_cancel; /* cancel flag */
2241 #define SLAP_CANCEL_NONE 0x00
2242 #define SLAP_CANCEL_REQ 0x01
2243 #define SLAP_CANCEL_ACK 0x02
2244 #define SLAP_CANCEL_DONE 0x03
2246 GroupAssertion *o_groups;
2247 char o_do_not_cache; /* don't cache groups from this op */
2248 char o_is_auth_check; /* authorization in progress */
2250 #define SLAP_CONTROL_NONE 0
2251 #define SLAP_CONTROL_IGNORED 1
2252 #define SLAP_CONTROL_NONCRITICAL 2
2253 #define SLAP_CONTROL_CRITICAL 3
2254 #define SLAP_CONTROL_MASK 3
2256 /* spare bits for simple flags */
2257 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2258 #define SLAP_CONTROL_DATA0 0x10
2259 #define SLAP_CONTROL_DATA1 0x20
2260 #define SLAP_CONTROL_DATA2 0x40
2261 #define SLAP_CONTROL_DATA3 0x80
2264 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2266 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2267 void **o_controls; /* per-control state */
2269 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2270 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2272 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2273 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2274 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2276 #define get_subentries(op) _SCM((op)->o_subentries)
2277 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2279 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2280 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2282 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2283 #define get_assert(op) ((int)(op)->o_assert)
2284 #define o_assertion o_controls[slap_cids.sc_assert]
2285 #define get_assertion(op) ((op)->o_assertion)
2287 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2288 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2290 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2291 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2292 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2294 #define get_permissiveModify(op) (0)
2297 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2298 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2299 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2301 #define get_domainScope(op) (0)
2304 #ifdef LDAP_CONTROL_X_TREE_DELETE
2305 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2306 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2308 #define get_treeDelete(op) (0)
2311 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2312 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2314 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2315 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2317 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2318 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2320 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2322 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2324 AuthorizationInformation o_authz;
2326 BerElement *o_ber; /* ber of the request */
2327 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2328 slap_callback *o_callback; /* callback pointers */
2329 LDAPControl **o_ctrls; /* controls */
2331 void *o_private; /* anything the backend needs */
2333 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2336 int o_delete_glue_parent;
2339 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2341 #define send_ldap_error( op, rs, err, text ) do { \
2342 (rs)->sr_err = err; (rs)->sr_text = text; \
2343 (op->o_conn->c_send_ldap_result)( op, rs ); \
2345 #define send_ldap_discon( op, rs, err, text ) do { \
2346 (rs)->sr_err = err; (rs)->sr_text = text; \
2347 send_ldap_disconnect( op, rs ); \
2350 typedef void (SEND_LDAP_RESULT)(
2351 struct slap_op *op, struct slap_rep *rs);
2352 typedef int (SEND_SEARCH_ENTRY)(
2353 struct slap_op *op, struct slap_rep *rs);
2354 typedef int (SEND_SEARCH_REFERENCE)(
2355 struct slap_op *op, struct slap_rep *rs);
2356 typedef void (SEND_LDAP_EXTENDED)(
2357 struct slap_op *op, struct slap_rep *rs);
2358 typedef void (SEND_LDAP_INTERMEDIATE)(
2359 struct slap_op *op, struct slap_rep *rs);
2361 #define send_ldap_result( op, rs ) \
2362 ((op)->o_conn->c_send_ldap_result)( op, rs )
2363 #define send_search_entry( op, rs ) \
2364 ((op)->o_conn->c_send_search_entry)( op, rs )
2365 #define send_search_reference( op, rs ) \
2366 ((op)->o_conn->c_send_search_reference)( op, rs )
2367 #define send_ldap_extended( op, rs ) \
2368 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2369 #define send_ldap_intermediate( op, rs ) \
2370 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2372 typedef struct slap_listener Listener;
2375 * represents a connection from an ldap client
2377 typedef struct slap_conn {
2378 int c_struct_state; /* structure management state */
2379 int c_conn_state; /* connection state */
2380 int c_conn_idx; /* slot in connections array */
2382 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2383 Sockbuf *c_sb; /* ber connection stuff */
2385 /* only can be changed by connect_init */
2386 time_t c_starttime; /* when the connection was opened */
2387 time_t c_activitytime; /* when the connection was last used */
2388 unsigned long c_connid; /* id of this connection for stats*/
2390 struct berval c_peer_domain; /* DNS name of client */
2391 struct berval c_peer_name; /* peer name (trans=addr:port) */
2392 Listener *c_listener;
2393 #define c_listener_url c_listener->sl_url /* listener URL */
2394 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2396 /* only can be changed by binding thread */
2397 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2398 struct berval c_sasl_bind_mech; /* mech in progress */
2399 struct berval c_sasl_dn; /* temporary storage */
2401 /* authorization backend */
2402 Backend *c_authz_backend;
2404 AuthorizationInformation c_authz;
2406 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2408 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2409 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2411 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2412 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2414 BerElement *c_currentber; /* ber we're attempting to read */
2415 int c_writewaiter; /* true if writer is waiting */
2417 #define CONN_IS_TLS 1
2418 #define CONN_IS_UDP 2
2419 #define CONN_IS_CLIENT 3
2421 #ifdef LDAP_CONNECTIONLESS
2422 int c_is_udp; /* true if this is (C)LDAP over UDP */
2425 int c_is_tls; /* true if this LDAP over raw TLS */
2426 int c_needs_tls_accept; /* true if SSL_accept should be called */
2428 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2429 int c_sasl_done; /* SASL completed once */
2430 void *c_sasl_authctx; /* SASL authentication context */
2431 void *c_sasl_sockctx; /* SASL security layer context */
2432 void *c_sasl_extra; /* SASL session extra stuff */
2433 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2435 PagedResultsState c_pagedresults_state; /* paged result state */
2437 long c_n_ops_received; /* num of ops received (next op_id) */
2438 long c_n_ops_executing; /* num of ops currently executing */
2439 long c_n_ops_pending; /* num of ops pending execution */
2440 long c_n_ops_completed; /* num of ops completed */
2442 long c_n_get; /* num of get calls */
2443 long c_n_read; /* num of read calls */
2444 long c_n_write; /* num of write calls */
2446 void *c_pb; /* Netscape plugin */
2447 void *c_extensions; /* Netscape plugin */
2450 * Client connection handling
2452 ldap_pvt_thread_start_t *c_clientfunc;
2456 * These are the "callbacks" that are available for back-ends to
2457 * supply data back to connected clients that are connected
2458 * through the "front-end".
2460 SEND_LDAP_RESULT *c_send_ldap_result;
2461 SEND_SEARCH_ENTRY *c_send_search_entry;
2462 SEND_SEARCH_REFERENCE *c_send_search_reference;
2463 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2464 #ifdef LDAP_RES_INTERMEDIATE
2465 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2470 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2471 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2473 if ( ldap_debug & (level) ) \
2474 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2475 if ( ldap_syslog & (level) ) \
2476 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2479 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2480 #elif defined(LDAP_DEBUG)
2481 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2483 if ( ldap_debug & (level) ) \
2484 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2486 #define StatslogTest( level ) (ldap_debug & (level))
2488 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2489 #define StatslogTest( level ) (0)
2493 * listener; need to access it from monitor backend
2495 struct slap_listener {
2496 struct berval sl_url;
2497 struct berval sl_name;
2502 #ifdef LDAP_CONNECTIONLESS
2503 int sl_is_udp; /* UDP listener is also data port */
2505 int sl_is_mute; /* Listening is temporarily disabled */
2508 #define sl_addr sl_sa.sa_in_addr
2511 #ifdef SLAPD_MONITOR
2528 #endif /* SLAPD_MONITOR */
2530 typedef struct slap_counters_t {
2531 ldap_pvt_thread_mutex_t sc_sent_mutex;
2532 ldap_pvt_mp_t sc_bytes;
2533 ldap_pvt_mp_t sc_pdu;
2534 ldap_pvt_mp_t sc_entries;
2535 ldap_pvt_mp_t sc_refs;
2537 ldap_pvt_thread_mutex_t sc_ops_mutex;
2538 ldap_pvt_mp_t sc_ops_completed;
2539 ldap_pvt_mp_t sc_ops_initiated;
2540 #ifdef SLAPD_MONITOR
2541 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2542 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2543 #endif /* SLAPD_MONITOR */
2547 * Better know these all around slapd
2549 #define SLAP_LDAPDN_PRETTY 0x1
2550 #define SLAP_LDAPDN_MAXLEN 8192
2552 /* number of response controls supported */
2553 #define SLAP_MAX_RESPONSE_CONTROLS 6
2556 #define SLAP_CTRL_HIDE 0x00000000U
2558 #define SLAP_CTRL_HIDE 0x80000000U
2561 #define SLAP_CTRL_FRONTEND 0x00800000U
2562 #define SLAP_CTRL_FRONTEND_SEARCH 0x00010000U /* for NOOP */
2564 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2565 #define SLAP_CTRL_ABANDON 0x00000001U
2566 #define SLAP_CTRL_ADD 0x00002002U
2567 #define SLAP_CTRL_BIND 0x00000004U
2568 #define SLAP_CTRL_COMPARE 0x00001008U
2569 #define SLAP_CTRL_DELETE 0x00002010U
2570 #define SLAP_CTRL_MODIFY 0x00002020U
2571 #define SLAP_CTRL_RENAME 0x00002040U
2572 #define SLAP_CTRL_SEARCH 0x00001080U
2573 #define SLAP_CTRL_UNBIND 0x00000100U
2575 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2576 #define SLAP_CTRL_UPDATE \
2577 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2578 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2580 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2583 LDAPControl *ctrl ));
2585 #define SLAP_SLAB_SIZE (1024*1024)
2586 #define SLAP_SLAB_STACK 1
2587 #define SLAP_SLAB_SOBLOCK 64
2589 #define SLAP_ZONE_ALLOC 1
2590 #undef SLAP_ZONE_ALLOC
2592 #ifdef LDAP_COMP_MATCH
2594 * Extensible Filter Definition
2596 * MatchingRuleAssertion := SEQUENCE {
2597 * matchingRule [1] MatchingRuleId OPTIONAL,
2598 * type [2] AttributeDescription OPTIONAL,
2599 * matchValue [3] AssertionValue,
2600 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2602 * Following ComponentFilter is contained in matchValue
2604 * ComponentAssertion ::= SEQUENCE {
2605 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2606 * useDefaultValues BOOLEAN DEFAULT TRUE,
2607 * rule MATCHING-RULE.&id,
2608 * value MATCHING-RULE.&AssertionType }
2610 * ComponentFilter ::= CHOICE {
2611 * item [0] ComponentAssertion,
2612 * and [1] SEQUENCE OF ComponentFilter,
2613 * or [2] SEQUENCE OF ComponentFilter,
2614 * not [3] ComponentFilter }
2617 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2618 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2619 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2620 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2621 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2622 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2623 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2624 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2625 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2627 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2628 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2629 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2630 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2631 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2633 typedef struct slap_component_id {
2635 struct slap_component_id *ci_next;
2637 union comp_id_value{
2638 BerValue ci_identifier;
2639 ber_int_t ci_from_beginning;
2641 ber_int_t ci_from_end;
2642 ber_int_t ci_content;
2643 BerValue ci_select_value;
2648 typedef struct slap_component_reference {
2649 ComponentId *cr_list;
2650 ComponentId *cr_curr;
2651 struct berval cr_string;
2653 /* Component Indexing */
2655 slap_mask_t cr_indexmask;
2656 AttributeDescription* cr_ad;
2658 struct slap_component_reference* cr_next;
2659 } ComponentReference;
2661 typedef struct slap_component_assertion {
2662 ComponentReference *ca_comp_ref;
2663 ber_int_t ca_use_def;
2664 MatchingRule *ca_ma_rule;
2665 struct berval ca_ma_value;
2666 ComponentData ca_comp_data; /* componentized assertion */
2667 struct slap_component_filter *ca_cf;
2668 MatchingRuleAssertion *ca_mra;
2669 } ComponentAssertion;
2671 typedef struct slap_component_filter {
2672 ber_tag_t cf_choice;
2674 ber_int_t cf_un_result;
2675 ComponentAssertion *cf_un_ca;
2676 struct slap_component_filter *cf_un_complex;
2679 #define cf_ca cf_un.cf_un_ca
2680 #define cf_result cf_un.cf_un_result
2681 #define cf_and cf_un.cf_un_complex
2682 #define cf_or cf_un.cf_un_complex
2683 #define cf_not cf_un.cf_un_complex
2684 #define cf_any cf_un.cf_un_complex
2686 struct slap_component_filter *cf_next;
2689 typedef struct slap_component_assertion_value {
2693 } ComponentAssertionValue;
2695 typedef int encoder_func LDAP_P((
2699 struct slap_component_syntax_info;
2701 typedef int gser_decoder_func LDAP_P((
2704 struct slap_component_syntax_info** comp_syn_info,
2708 typedef int comp_free_func LDAP_P((
2711 typedef int ber_decoder_func LDAP_P((
2716 struct slap_component_syntax_info* comp_syn_info,
2720 typedef int ber_tag_decoder_func LDAP_P((
2723 struct slap_component_syntax_info* comp_syn_info,
2727 typedef void* extract_component_from_id_func LDAP_P((
2729 ComponentReference* cr,
2732 typedef void* convert_attr_to_comp_func LDAP_P ((
2735 struct berval* bv ));
2737 typedef void* alloc_nibble_func LDAP_P ((
2739 int increment_size ));
2741 typedef void free_nibble_func LDAP_P ((
2744 struct slap_component_syntax_info;
2745 typedef void convert_assert_to_comp_func LDAP_P ((
2747 struct slap_component_syntax_info* csi_attr,
2749 struct slap_component_syntax_info** csi,
2753 typedef int convert_asn_to_ldap_func LDAP_P ((
2754 struct slap_component_syntax_info* csi,
2755 struct berval *bv ));
2757 typedef void free_component_func LDAP_P ((
2760 typedef int test_component_func LDAP_P ((
2762 void* assert_mem_op,
2763 struct slap_component_syntax_info* csi,
2764 struct slap_component_assertion* ca));
2766 typedef void* test_membership_func LDAP_P ((
2769 typedef void* get_component_info_func LDAP_P ((
2772 struct slap_component_syntax_info;
2774 typedef int component_encoder_func LDAP_P ((
2776 struct slap_component_syntax_info* csi,
2777 struct berval* nvals ));
2779 typedef int allcomponent_matching_func LDAP_P((
2781 struct slap_component_syntax_info* comp1,
2782 struct slap_component_syntax_info* comp));
2784 typedef struct slap_component_desc {
2785 /* Don't change the order of following four fields */
2787 AttributeType *cd_comp_type;
2788 struct berval cd_ad_type;/* ad_type, ad_cname */
2789 struct berval cd_ad_cname;/* ad_type, ad_cname */
2790 unsigned cd_flags; /*ad_flags*/
2793 encoder_func *cd_ldap_encoder;
2794 encoder_func *cd_gser_encoder;
2795 encoder_func *cd_ber_encoder;
2796 gser_decoder_func *cd_gser_decoder;
2797 ber_decoder_func *cd_ber_decoder;
2798 comp_free_func *cd_free;
2799 extract_component_from_id_func* cd_extract_i;
2800 allcomponent_matching_func *cd_all_match;
2803 typedef struct slap_component_syntax_info {
2805 ComponentDesc* csi_comp_desc;
2806 } ComponentSyntaxInfo;
2810 /* slab heap data structures */
2812 struct slab_object {
2815 LDAP_LIST_ENTRY(slab_object) so_link;
2824 unsigned char **sh_map;
2825 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2826 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2829 #ifdef SLAP_ZONE_ALLOC
2830 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2831 #define SLAP_ZONE_SHIFT 19
2832 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2833 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2834 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2835 #define SLAP_ZONE_ZOBLOCK 256
2837 struct zone_object {
2842 LDAP_LIST_ENTRY(zone_object) zo_link;
2845 struct zone_latency_history {
2847 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2858 ldap_pvt_thread_rdwr_t *zh_znlock;
2859 Avlnode *zh_zonetree;
2860 unsigned char ***zh_maps;
2862 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2863 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2864 ldap_pvt_thread_mutex_t zh_mutex;
2865 ldap_pvt_thread_rdwr_t zh_lock;
2866 double zh_ema_latency;
2867 unsigned long zh_ema_samples;
2868 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2869 zh_latency_history_queue;
2870 int zh_latency_history_qlen;
2871 int zh_latency_jump;
2876 #define SLAP_BACKEND_INIT_MODULE(b) \
2878 init_module( int argc, char *argv[] ) \
2881 memset( &bi, '\0', sizeof( bi ) ); \
2883 bi.bi_init = b ## _back_initialize; \
2884 backend_add( &bi ); \
2890 #include "proto-slap.h"
2892 #endif /* _SLAP_H_ */