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"
61 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
65 #define LDAP_COMP_MATCH
66 #define LDAP_DYNAMIC_OBJECTS
67 #define LDAP_SYNC_TIMESTAMP
68 #define LDAP_COLLECTIVE_ATTRIBUTES
69 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
72 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
78 * SLAPD Memory allocation macros
80 * Unlike ch_*() routines, these routines do not assert() upon
81 * allocation error. They are intended to be used instead of
82 * ch_*() routines where the caller has implemented proper
83 * checking for and handling of allocation errors.
85 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
87 #define SLAP_MALLOC(s) ber_memalloc((s))
88 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
89 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
90 #define SLAP_FREE(p) ber_memfree((p))
91 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
92 #define SLAP_STRDUP(s) ber_strdup((s))
93 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
96 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
99 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
100 #define SLAPD_ANONYMOUS "cn=anonymous"
102 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
103 * This is a value used internally by the backends. It is needed to allow
104 * adding values that already exist without getting an error as required by
105 * modrdn when the new rdn was already an attribute value itself.
107 #define SLAP_MOD_SOFTADD 0x1000
109 #define MAXREMATCHES (100)
111 #define SLAP_MAX_WORKER_THREADS (16)
113 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
114 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
116 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
117 #define SLAP_CONN_MAX_PENDING_AUTH 1000
119 #define SLAP_TEXT_BUFLEN (256)
121 /* psuedo error code indicating abandoned operation */
122 #define SLAPD_ABANDON (-1024)
124 /* psuedo error code indicating disconnect */
125 #define SLAPD_DISCONNECT (-1025)
127 /* unknown config file directive */
128 #define SLAP_CONF_UNKNOWN (-1026)
130 /* We assume "C" locale, that is US-ASCII */
131 #define ASCII_SPACE(c) ( (c) == ' ' )
132 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
133 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
134 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
135 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
136 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
137 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
138 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
139 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
140 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
141 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
143 #define SLAP_NIBBLE(c) ((c)&0x0f)
144 #define SLAP_ESCAPE_CHAR ('\\')
145 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
146 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
148 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
149 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
151 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
152 /* NOTE: for consistency, this macro must only operate
153 * on normalized/pretty DN, such that ';' is never used
154 * as RDN separator, and all occurrences of ';' must be escaped */
155 #define DN_SEPARATOR(c) ((c) == ',')
156 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
157 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
158 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
160 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
161 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
162 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
163 #define OID_SEPARATOR(c) ( (c) == '.' )
164 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
166 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
167 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
169 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
170 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
172 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
174 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
175 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
176 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
177 (c) == '?' || (c) == ' ' || (c) == '=' )
178 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
180 /* must match in schema_init.c */
181 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
182 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
183 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
184 #define SLAPD_GROUP_ATTR "member"
185 #define SLAPD_GROUP_CLASS "groupOfNames"
186 #define SLAPD_ROLE_ATTR "roleOccupant"
187 #define SLAPD_ROLE_CLASS "organizationalRole"
189 #ifdef SLAPD_ACI_ENABLED
190 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
193 /* change this to "OpenLDAPset" */
194 #define SLAPD_ACI_SET_ATTR "template"
196 #define SLAPD_TOP_OID "2.5.6.0"
198 LDAP_SLAPD_V (int) slap_debug;
200 typedef unsigned long slap_mask_t;
202 /* Security Strength Factor */
203 typedef unsigned slap_ssf_t;
205 typedef struct slap_ssf_set {
207 slap_ssf_t sss_transport;
210 slap_ssf_t sss_update_ssf;
211 slap_ssf_t sss_update_transport;
212 slap_ssf_t sss_update_tls;
213 slap_ssf_t sss_update_sasl;
214 slap_ssf_t sss_simple_bind;
217 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
218 #define SLAP_GETDN_AUTHCID 2
219 #define SLAP_GETDN_AUTHZID 4
224 #define SLAP_INDEX_TYPE 0x00FFUL
225 #define SLAP_INDEX_UNDEFINED 0x0001UL
226 #define SLAP_INDEX_PRESENT 0x0002UL
227 #define SLAP_INDEX_EQUALITY 0x0004UL
228 #define SLAP_INDEX_APPROX 0x0008UL
229 #define SLAP_INDEX_SUBSTR 0x0010UL
230 #define SLAP_INDEX_EXTENDED 0x0020UL
232 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
234 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
236 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
238 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
239 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
240 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
241 #define SLAP_INDEX_SUBSTR_DEFAULT \
242 ( SLAP_INDEX_SUBSTR \
243 | SLAP_INDEX_SUBSTR_INITIAL \
244 | SLAP_INDEX_SUBSTR_ANY \
245 | SLAP_INDEX_SUBSTR_FINAL )
247 /* defaults for initial/final substring indices */
248 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
249 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
251 /* defaults for any substring indices */
252 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
253 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
255 #define SLAP_INDEX_FLAGS 0xF000UL
256 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
257 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
260 * there is a single index for each attribute. these prefixes ensure
261 * that there is no collision among keys.
263 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
264 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
265 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
266 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
267 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
268 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
270 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
271 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
272 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
273 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
274 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
277 * represents schema information for a database
279 #define SLAP_SCHERR_OUTOFMEM 1
280 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
281 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
282 #define SLAP_SCHERR_CLASS_BAD_SUP 4
283 #define SLAP_SCHERR_CLASS_DUP 5
284 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
285 #define SLAP_SCHERR_ATTR_BAD_MR 7
286 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
287 #define SLAP_SCHERR_ATTR_BAD_SUP 9
288 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
289 #define SLAP_SCHERR_ATTR_DUP 11
290 #define SLAP_SCHERR_MR_NOT_FOUND 12
291 #define SLAP_SCHERR_MR_INCOMPLETE 13
292 #define SLAP_SCHERR_MR_DUP 14
293 #define SLAP_SCHERR_SYN_NOT_FOUND 15
294 #define SLAP_SCHERR_SYN_DUP 16
295 #define SLAP_SCHERR_NO_NAME 17
296 #define SLAP_SCHERR_NOT_SUPPORTED 18
297 #define SLAP_SCHERR_BAD_DESCR 19
298 #define SLAP_SCHERR_OIDM 20
299 #define SLAP_SCHERR_CR_DUP 21
300 #define SLAP_SCHERR_CR_BAD_STRUCT 22
301 #define SLAP_SCHERR_CR_BAD_AUX 23
302 #define SLAP_SCHERR_CR_BAD_AT 24
303 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
305 typedef union slap_sockaddr {
306 struct sockaddr sa_addr;
307 struct sockaddr_in sa_in_addr;
309 struct sockaddr_storage sa_storage;
310 struct sockaddr_in6 sa_in6_addr;
313 struct sockaddr_un sa_un_addr;
318 extern int slap_inet4or6;
321 typedef struct slap_oid_macro {
322 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;
826 AttributeDescription *si_ad_configContext;
828 /* subentry attribute descriptions */
829 AttributeDescription *si_ad_administrativeRole;
830 AttributeDescription *si_ad_subtreeSpecification;
832 /* subschema subentry attribute descriptions */
833 AttributeDescription *si_ad_attributeTypes;
834 AttributeDescription *si_ad_ditContentRules;
835 AttributeDescription *si_ad_ditStructureRules;
836 AttributeDescription *si_ad_ldapSyntaxes;
837 AttributeDescription *si_ad_matchingRules;
838 AttributeDescription *si_ad_matchingRuleUse;
839 AttributeDescription *si_ad_nameForms;
840 AttributeDescription *si_ad_objectClasses;
842 /* Aliases & Referrals */
843 AttributeDescription *si_ad_aliasedObjectName;
844 AttributeDescription *si_ad_ref;
846 /* Access Control Internals */
847 AttributeDescription *si_ad_entry;
848 AttributeDescription *si_ad_children;
849 AttributeDescription *si_ad_saslAuthzTo;
850 AttributeDescription *si_ad_saslAuthzFrom;
851 #ifdef SLAPD_ACI_ENABLED
852 AttributeDescription *si_ad_aci;
855 /* dynamic entries */
856 AttributeDescription *si_ad_entryTtl;
857 AttributeDescription *si_ad_dynamicSubtrees;
859 /* Other attributes descriptions */
860 AttributeDescription *si_ad_distinguishedName;
861 AttributeDescription *si_ad_name;
862 AttributeDescription *si_ad_cn;
863 AttributeDescription *si_ad_uid;
864 AttributeDescription *si_ad_userPassword;
865 AttributeDescription *si_ad_labeledURI;
866 #ifdef SLAPD_AUTHPASSWD
867 AttributeDescription *si_ad_authPassword;
869 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
870 AttributeDescription *si_ad_krbName;
873 /* Undefined Attribute Type */
874 AttributeType *si_at_undefined;
877 MatchingRule *si_mr_distinguishedNameMatch;
878 MatchingRule *si_mr_dnSubtreeMatch;
879 MatchingRule *si_mr_dnOneLevelMatch;
880 MatchingRule *si_mr_dnSubordinateMatch;
881 MatchingRule *si_mr_dnSuperiorMatch;
882 MatchingRule *si_mr_caseExactMatch;
883 MatchingRule *si_mr_caseExactSubstringsMatch;
884 MatchingRule *si_mr_caseExactIA5Match;
885 MatchingRule *si_mr_integerMatch;
886 MatchingRule *si_mr_integerFirstComponentMatch;
887 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
890 Syntax *si_syn_directoryString;
891 Syntax *si_syn_distinguishedName;
892 Syntax *si_syn_integer;
893 Syntax *si_syn_octetString;
895 /* Schema Syntaxes */
896 Syntax *si_syn_attributeTypeDesc;
897 Syntax *si_syn_ditContentRuleDesc;
898 Syntax *si_syn_ditStructureRuleDesc;
899 Syntax *si_syn_ldapSyntaxDesc;
900 Syntax *si_syn_matchingRuleDesc;
901 Syntax *si_syn_matchingRuleUseDesc;
902 Syntax *si_syn_nameFormDesc;
903 Syntax *si_syn_objectClassDesc;
906 typedef struct slap_attr_assertion {
907 AttributeDescription *aa_desc;
908 struct berval aa_value;
909 #ifdef LDAP_COMP_MATCH
910 struct slap_component_filter *aa_cf;/* for attribute aliasing */
912 } AttributeAssertion;
914 typedef struct slap_ss_assertion {
915 AttributeDescription *sa_desc;
916 struct berval sa_initial;
917 struct berval *sa_any;
918 struct berval sa_final;
919 } SubstringsAssertion;
921 #ifdef LDAP_COMP_MATCH
922 struct slap_component_filter;
925 typedef struct slap_mr_assertion {
926 MatchingRule *ma_rule; /* optional */
927 struct berval ma_rule_text; /* optional */
928 AttributeDescription *ma_desc; /* optional */
929 int ma_dnattrs; /* boolean */
930 struct berval ma_value; /* required */
931 #ifdef LDAP_COMP_MATCH
932 struct slap_component_filter* ma_cf; /* component filter */
934 } MatchingRuleAssertion;
937 * represents a search filter
939 typedef struct slap_filter {
940 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
941 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
942 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
943 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
944 #ifdef LDAP_SCOPE_SUBORDINATE
945 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
949 /* precomputed result */
950 ber_int_t f_un_result;
953 struct berval *f_un_dn;
956 AttributeDescription *f_un_desc;
958 /* simple value assertion */
959 AttributeAssertion *f_un_ava;
961 /* substring assertion */
962 SubstringsAssertion *f_un_ssa;
964 /* matching rule assertion */
965 MatchingRuleAssertion *f_un_mra;
967 #define f_dn f_un.f_un_dn
968 #define f_desc f_un.f_un_desc
969 #define f_ava f_un.f_un_ava
970 #define f_av_desc f_un.f_un_ava->aa_desc
971 #define f_av_value f_un.f_un_ava->aa_value
972 #define f_sub f_un.f_un_ssa
973 #define f_sub_desc f_un.f_un_ssa->sa_desc
974 #define f_sub_initial f_un.f_un_ssa->sa_initial
975 #define f_sub_any f_un.f_un_ssa->sa_any
976 #define f_sub_final f_un.f_un_ssa->sa_final
977 #define f_mra f_un.f_un_mra
978 #define f_mr_rule f_un.f_un_mra->ma_rule
979 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
980 #define f_mr_desc f_un.f_un_mra->ma_desc
981 #define f_mr_value f_un.f_un_mra->ma_value
982 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
985 struct slap_filter *f_un_complex;
988 #define f_result f_un.f_un_result
989 #define f_and f_un.f_un_complex
990 #define f_or f_un.f_un_complex
991 #define f_not f_un.f_un_complex
992 #define f_list f_un.f_un_complex
994 struct slap_filter *f_next;
997 /* compare routines can return undefined */
998 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1000 typedef struct slap_valuesreturnfilter {
1001 ber_tag_t vrf_choice;
1004 /* precomputed result */
1005 ber_int_t vrf_un_result;
1011 AttributeDescription *vrf_un_desc;
1013 /* simple value assertion */
1014 AttributeAssertion *vrf_un_ava;
1016 /* substring assertion */
1017 SubstringsAssertion *vrf_un_ssa;
1019 /* matching rule assertion */
1020 MatchingRuleAssertion *vrf_un_mra;
1022 #define vrf_result vrf_un.vrf_un_result
1023 #define vrf_dn vrf_un.vrf_un_dn
1024 #define vrf_desc vrf_un.vrf_un_desc
1025 #define vrf_ava vrf_un.vrf_un_ava
1026 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1027 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1028 #define vrf_ssa vrf_un.vrf_un_ssa
1029 #define vrf_sub vrf_un.vrf_un_ssa
1030 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1031 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1032 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1033 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1034 #define vrf_mra vrf_un.vrf_un_mra
1035 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1036 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1037 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1038 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1039 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1044 struct slap_valuesreturnfilter *vrf_next;
1045 } ValuesReturnFilter;
1047 #ifdef LDAP_COMP_MATCH
1048 struct slap_component_syntax_info;
1049 typedef struct slap_component_data {
1050 void* cd_mem_op;/* nibble memory handler */
1051 struct slap_component_syntax_info** cd_tree;/* component tree */
1056 * represents an attribute (description + values)
1058 typedef struct slap_attr {
1059 AttributeDescription *a_desc;
1060 BerVarray a_vals; /* preserved values */
1061 BerVarray a_nvals; /* normalized values */
1062 #ifdef LDAP_COMP_MATCH
1063 ComponentData *a_comp_data; /* component values */
1065 struct slap_attr *a_next;
1067 #define SLAP_ATTR_IXADD 0x1U
1068 #define SLAP_ATTR_IXDEL 0x2U
1073 * the id used in the indexes to refer to an entry
1075 typedef unsigned long ID;
1076 #define NOID ((ID)~0)
1079 * represents an entry in core
1081 typedef struct slap_entry {
1083 * The ID field should only be changed before entry is
1084 * inserted into a cache. The ID value is backend
1089 struct berval e_name; /* name (DN) of this entry */
1090 struct berval e_nname; /* normalized name (DN) of this entry */
1092 /* for migration purposes */
1093 #define e_dn e_name.bv_val
1094 #define e_ndn e_nname.bv_val
1096 Attribute *e_attrs; /* list of attributes + values */
1098 slap_mask_t e_ocflags;
1100 struct berval e_bv; /* For entry_encode/entry_decode */
1102 /* for use by the backend for any purpose */
1107 * A list of LDAPMods
1109 typedef struct slap_mod {
1111 AttributeDescription *sm_desc;
1112 struct berval sm_type;
1113 BerVarray sm_values;
1114 BerVarray sm_nvalues;
1117 typedef struct slap_mod_list {
1118 Modification sml_mod;
1119 #define sml_op sml_mod.sm_op
1120 #define sml_desc sml_mod.sm_desc
1121 #define sml_type sml_mod.sm_type
1122 #define sml_values sml_mod.sm_values
1123 #define sml_nvalues sml_mod.sm_nvalues
1124 struct slap_mod_list *sml_next;
1127 typedef struct slap_ldap_modlist {
1129 struct slap_ldap_modlist *ml_next;
1130 #define ml_op ml_mod.mod_op
1131 #define ml_type ml_mod.mod_type
1132 #define ml_values ml_mod.mod_values
1136 * represents an access control list
1138 typedef enum slap_access_e {
1139 ACL_INVALID_ACCESS = -1,
1150 typedef enum slap_control_e {
1151 ACL_INVALID_CONTROL = 0,
1157 typedef enum slap_style_e {
1158 ACL_STYLE_REGEX = 0,
1165 ACL_STYLE_ANONYMOUS,
1172 typedef struct slap_authz_info {
1173 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1174 struct berval sai_mech; /* SASL Mechanism */
1175 struct berval sai_dn; /* DN for reporting purposes */
1176 struct berval sai_ndn; /* Normalized DN */
1178 /* Security Strength Factors */
1179 slap_ssf_t sai_ssf; /* Overall SSF */
1180 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1181 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1182 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1183 } AuthorizationInformation;
1190 * "dynamic" ACL infrastructure (for ACIs and more)
1192 typedef int (slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1193 typedef int (slap_dynacl_unparse)( void *priv, struct berval *bv );
1194 typedef int (slap_dynacl_mask)(
1198 AttributeDescription *desc,
1201 regmatch_t *matches,
1202 slap_access_t *grant,
1203 slap_access_t *deny );
1204 typedef int (slap_dynacl_destroy)( void *priv );
1206 typedef struct slap_dynacl_t {
1208 slap_dynacl_parse *da_parse;
1209 slap_dynacl_unparse *da_unparse;
1210 slap_dynacl_mask *da_mask;
1211 slap_dynacl_destroy *da_destroy;
1214 struct slap_dynacl_t *da_next;
1216 #endif /* SLAP_DYNACL */
1219 typedef struct slap_access {
1220 slap_control_t a_type;
1222 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1224 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1225 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1226 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1227 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1228 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1229 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1230 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1231 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1233 #define ACL_PRIV_MASK 0x00ffUL
1236 #define ACL_PRIV_LEVEL 0x1000UL
1237 #define ACL_PRIV_ADDITIVE 0x2000UL
1238 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1241 #define ACL_PRIV_INVALID 0x0UL
1243 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1244 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1245 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1246 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1248 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1249 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1251 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1253 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1255 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1256 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1257 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1259 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1260 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1261 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1262 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1263 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1264 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1265 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1266 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1268 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1269 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1270 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1271 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1272 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1273 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1274 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1275 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1276 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1278 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1279 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1280 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1281 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1282 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1283 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1284 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1285 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1287 slap_mask_t a_access_mask;
1289 AuthorizationInformation a_authz;
1290 #define a_dn_pat a_authz.sai_dn
1292 slap_style_t a_dn_style;
1293 AttributeDescription *a_dn_at;
1297 slap_style_t a_peername_style;
1298 struct berval a_peername_pat;
1299 unsigned long a_peername_addr,
1301 int a_peername_port;
1303 slap_style_t a_sockname_style;
1304 struct berval a_sockname_pat;
1306 slap_style_t a_domain_style;
1307 struct berval a_domain_pat;
1308 int a_domain_expand;
1310 slap_style_t a_sockurl_style;
1311 struct berval a_sockurl_pat;
1312 slap_style_t a_set_style;
1313 struct berval a_set_pat;
1316 slap_dynacl_t *a_dynacl;
1317 #else /* ! SLAP_DYNACL */
1318 #ifdef SLAPD_ACI_ENABLED
1319 AttributeDescription *a_aci_at;
1321 #endif /* SLAP_DYNACL */
1324 slap_style_t a_group_style;
1325 struct berval a_group_pat;
1326 ObjectClass *a_group_oc;
1327 AttributeDescription *a_group_at;
1329 struct slap_access *a_next;
1333 typedef struct slap_acl {
1334 /* "to" part: the entries this acl applies to */
1336 slap_style_t acl_dn_style;
1338 struct berval acl_dn_pat;
1339 AttributeName *acl_attrs;
1340 slap_style_t acl_attrval_style;
1341 regex_t acl_attrval_re;
1342 struct berval acl_attrval;
1344 /* "by" part: list of who has what access to the entries */
1347 struct slap_acl *acl_next;
1350 typedef struct slap_acl_state {
1351 unsigned as_recorded;
1352 #define ACL_STATE_NOT_RECORDED 0x0
1353 #define ACL_STATE_RECORDED_VD 0x1
1354 #define ACL_STATE_RECORDED_NV 0x2
1355 #define ACL_STATE_RECORDED 0x3
1358 AccessControl *as_vd_acl;
1359 AccessControl *as_vi_acl;
1360 slap_mask_t as_vd_acl_mask;
1361 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1362 int as_vd_acl_count;
1364 Access *as_vd_access;
1365 int as_vd_access_count;
1368 AttributeDescription *as_vd_ad;
1369 } AccessControlState;
1370 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1371 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1375 * represents a backend
1378 typedef struct slap_backend_info BackendInfo; /* per backend type */
1379 typedef struct slap_backend_db BackendDB; /* per backend database */
1381 LDAP_SLAPD_V (int) nBackendInfo;
1382 LDAP_SLAPD_V (int) nBackendDB;
1383 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1384 LDAP_SLAPD_V (BackendDB *) backendDB;
1385 LDAP_SLAPD_V (BackendDB *) frontendDB;
1387 LDAP_SLAPD_V (int) slapMode;
1388 #define SLAP_UNDEFINED_MODE 0x0000
1389 #define SLAP_SERVER_MODE 0x0001
1390 #define SLAP_TOOL_MODE 0x0002
1391 #define SLAP_MODE 0x0003
1393 #define SLAP_TRUNCATE_MODE 0x0100
1394 #define SLAP_TOOL_READMAIN 0x0200
1395 #define SLAP_TOOL_READONLY 0x0400
1396 #define SLAP_TOOL_QUICK 0x0800
1398 #define SB_TLS_OFF 0
1400 #define SB_TLS_CRITICAL 2
1402 typedef struct slap_bindconf {
1414 struct slap_replica_info {
1415 const char *ri_uri; /* supersedes be_replica */
1416 const char *ri_host; /* points to host part of uri */
1417 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1418 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1419 int ri_exclude; /* 1 => exclude ri_attrs */
1420 slap_bindconf ri_bindconf; /* for back-config */
1423 typedef struct slap_verbmasks {
1428 #define SLAP_LIMIT_TIME 1
1429 #define SLAP_LIMIT_SIZE 2
1431 struct slap_limits_set {
1439 int lms_s_unchecked;
1445 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1446 #define SLAP_NO_LIMIT -1
1447 #define SLAP_MAX_LIMIT 2147483647
1449 struct slap_limits {
1450 unsigned lm_flags; /* type of pattern */
1451 #define SLAP_LIMITS_UNDEFINED 0x0000U
1452 #define SLAP_LIMITS_EXACT 0x0001U
1453 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1454 #define SLAP_LIMITS_ONE 0x0002U
1455 #define SLAP_LIMITS_SUBTREE 0x0003U
1456 #define SLAP_LIMITS_CHILDREN 0x0004U
1457 #define SLAP_LIMITS_REGEX 0x0005U
1458 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1459 #define SLAP_LIMITS_USERS 0x0007U
1460 #define SLAP_LIMITS_ANY 0x0008U
1461 #define SLAP_LIMITS_MASK 0x000FU
1463 #define SLAP_LIMITS_TYPE_DN 0x0000U
1464 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1465 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1467 regex_t lm_regex; /* regex data for REGEX */
1470 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1471 * pattern for REGEX; NULL for ANONYMOUS, USERS
1473 struct berval lm_pat;
1475 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1476 * lm_group_oc is objectClass and lm_group_at is attributeType
1477 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1478 * can only be SLAP_LIMITS_EXACT */
1479 ObjectClass *lm_group_oc;
1480 AttributeDescription *lm_group_ad;
1482 struct slap_limits_set lm_limits;
1485 /* temporary aliases */
1486 typedef BackendDB Backend;
1487 #define nbackends nBackendDB
1488 #define backends backendDB
1491 * syncinfo structure for syncrepl
1494 #define SLAP_SYNC_RID_SIZE 3
1495 #define SLAP_SYNCUUID_SET_SIZE 256
1497 #define SLAP_SYNC_UPDATE_MSGID 2
1499 struct nonpresent_entry {
1500 struct berval *npe_name;
1501 struct berval *npe_nname;
1502 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1505 struct sync_cookie {
1506 struct berval ctxcsn;
1507 struct berval octet_str;
1509 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1512 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1514 typedef struct syncinfo_s {
1515 struct slap_backend_db *si_be;
1517 struct berval si_provideruri;
1518 slap_bindconf si_bindconf;
1519 struct berval si_filterstr;
1520 struct berval si_base;
1524 AttributeName *si_anlist;
1525 AttributeName *si_exanlist;
1530 int si_schemachecking;
1533 time_t *si_retryinterval;
1534 int *si_retrynum_init;
1536 struct sync_cookie si_syncCookie;
1540 int si_refreshDelete;
1541 int si_refreshPresent;
1542 Avlnode *si_presentlist;
1544 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1545 ldap_pvt_thread_mutex_t si_mutex;
1548 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1550 #ifndef SLAP_MAX_CIDS
1551 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1554 struct slap_backend_db {
1555 BackendInfo *bd_info; /* pointer to shared backend info */
1557 /* fields in this structure (and routines acting on this structure)
1558 should be renamed from be_ to bd_ */
1560 /* BackendInfo accessors */
1561 #define be_config bd_info->bi_db_config
1562 #define be_type bd_info->bi_type
1564 #define be_bind bd_info->bi_op_bind
1565 #define be_unbind bd_info->bi_op_unbind
1566 #define be_add bd_info->bi_op_add
1567 #define be_compare bd_info->bi_op_compare
1568 #define be_delete bd_info->bi_op_delete
1569 #define be_modify bd_info->bi_op_modify
1570 #define be_modrdn bd_info->bi_op_modrdn
1571 #define be_search bd_info->bi_op_search
1572 #define be_abandon bd_info->bi_op_abandon
1573 #define be_cancel bd_info->bi_op_cancel
1575 #define be_extended bd_info->bi_extended
1577 #define be_chk_referrals bd_info->bi_chk_referrals
1578 #define be_chk_controls bd_info->bi_chk_controls
1579 #define be_fetch bd_info->bi_entry_get_rw
1580 #define be_release bd_info->bi_entry_release_rw
1581 #define be_group bd_info->bi_acl_group
1582 #define be_attribute bd_info->bi_acl_attribute
1583 #define be_operational bd_info->bi_operational
1586 * define to honor hasSubordinates operational attribute in search filters
1587 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1590 #define be_has_subordinates bd_info->bi_has_subordinates
1592 #define be_connection_init bd_info->bi_connection_init
1593 #define be_connection_destroy bd_info->bi_connection_destroy
1596 #define be_entry_open bd_info->bi_tool_entry_open
1597 #define be_entry_close bd_info->bi_tool_entry_close
1598 #define be_entry_first bd_info->bi_tool_entry_first
1599 #define be_entry_next bd_info->bi_tool_entry_next
1600 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1601 #define be_entry_get bd_info->bi_tool_entry_get
1602 #define be_entry_put bd_info->bi_tool_entry_put
1603 #define be_sync bd_info->bi_tool_sync
1604 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1605 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1606 #define be_entry_modify bd_info->bi_tool_entry_modify
1609 /* supported controls */
1610 /* note: set to 0 if the database does not support the control;
1611 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1612 char be_ctrls[SLAP_MAX_CIDS + 1];
1614 /* Database flags */
1615 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1616 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1617 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1618 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1619 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1620 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1621 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1622 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1623 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1624 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1625 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1626 slap_mask_t be_flags;
1627 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1628 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1629 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1630 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1631 #define SLAP_NO_SCHEMA_CHECK(be) \
1632 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1633 #define SLAP_GLUE_INSTANCE(be) \
1634 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1635 #define SLAP_GLUE_SUBORDINATE(be) \
1636 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1637 #define SLAP_GLUE_LINKED(be) \
1638 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1639 #define SLAP_GLUE_ADVERTISE(be) \
1640 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1641 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1642 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1643 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1645 slap_mask_t be_restrictops; /* restriction operations */
1646 #define SLAP_RESTRICT_OP_ADD 0x0001U
1647 #define SLAP_RESTRICT_OP_BIND 0x0002U
1648 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1649 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1650 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1651 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1652 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1653 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1654 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1656 #define SLAP_RESTRICT_READONLY 0x80000000U
1658 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1659 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1660 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1661 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1662 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1664 #define SLAP_RESTRICT_OP_READS \
1665 ( SLAP_RESTRICT_OP_COMPARE \
1666 | SLAP_RESTRICT_OP_SEARCH )
1667 #define SLAP_RESTRICT_OP_WRITES \
1668 ( SLAP_RESTRICT_OP_ADD \
1669 | SLAP_RESTRICT_OP_DELETE \
1670 | SLAP_RESTRICT_OP_MODIFY \
1671 | SLAP_RESTRICT_OP_RENAME )
1673 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1674 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1675 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1677 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1679 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1680 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1681 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1683 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1684 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1686 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1688 slap_mask_t be_requires; /* pre-operation requirements */
1689 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1690 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1691 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1692 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1693 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1695 /* Required Security Strength Factor */
1696 slap_ssf_set_t be_ssf_set;
1698 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1699 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1700 struct berval be_schemadn; /* per-backend subschema subentry DN */
1701 struct berval be_schemandn; /* normalized subschema DN */
1702 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1703 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1704 struct berval be_rootpw; /* the magic "root" password for this db */
1705 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1706 #define be_sizelimit be_def_limit.lms_s_soft
1707 #define be_timelimit be_def_limit.lms_t_soft
1708 struct slap_limits_set be_def_limit; /* default limits */
1709 struct slap_limits **be_limits; /* regex-based size and time limits */
1710 AccessControl *be_acl; /* access control list for this backend */
1711 slap_access_t be_dfltaccess; /* access given if no acl matches */
1713 /* Replica Information */
1714 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1715 char *be_replogfile; /* replication log file (in master) */
1716 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1717 BerVarray be_update_refs; /* where to refer modifying clients to */
1718 struct be_pcl *be_pending_csn_list;
1719 ldap_pvt_thread_mutex_t be_pcl_mutex;
1720 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1721 syncinfo_t *be_syncinfo; /* For syncrepl */
1723 void *be_pb; /* Netscape plugin */
1724 struct ConfigTable *be_cf_table;
1726 void *be_private; /* anything the backend database needs */
1732 /* Backend function typedefs */
1733 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1734 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1735 const char *fname, int lineno,
1736 int argc, char **argv));
1737 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1738 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1739 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1741 typedef int (BI_db_init) LDAP_P((Backend *bd));
1742 typedef int (BI_db_config) LDAP_P((Backend *bd,
1743 const char *fname, int lineno,
1744 int argc, char **argv));
1745 typedef int (BI_db_open) LDAP_P((Backend *bd));
1746 typedef int (BI_db_close) LDAP_P((Backend *bd));
1747 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1749 typedef struct req_bind_s {
1751 struct berval rb_cred;
1752 struct berval rb_edn;
1754 struct berval rb_tmp_mech; /* FIXME: temporary */
1757 typedef struct req_search_s {
1762 /* NULL means be_isroot evaluated to TRUE */
1763 struct slap_limits_set *rs_limit;
1765 AttributeName *rs_attrs;
1767 struct berval rs_filterstr;
1770 typedef struct req_compare_s {
1771 AttributeAssertion *rs_ava;
1774 typedef struct req_modify_s {
1775 Modifications *rs_modlist;
1776 int rs_increment; /* FIXME: temporary */
1779 typedef struct req_modrdn_s {
1780 struct berval rs_newrdn;
1781 struct berval rs_nnewrdn;
1782 struct berval *rs_newSup;
1783 struct berval *rs_nnewSup;
1784 int rs_deleteoldrdn;
1787 typedef struct req_add_s {
1789 Modifications *rs_modlist; /* FIXME: temporary */
1792 typedef struct req_abandon_s {
1797 #define SLAP_EXOP_HIDE 0x0000
1799 #define SLAP_EXOP_HIDE 0x8000
1801 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1803 typedef struct req_extended_s {
1804 struct berval rs_reqoid;
1806 struct berval *rs_reqdata;
1809 typedef struct req_pwdexop_s {
1810 struct berval rs_reqoid;
1812 struct berval rs_old;
1813 struct berval rs_new;
1814 Modifications *rs_mods;
1815 Modifications **rs_modtail;
1818 typedef enum slap_reply_e {
1827 typedef struct rep_sasl_s {
1828 struct berval *r_sasldata;
1831 typedef struct rep_extended_s {
1832 const char *r_rspoid;
1833 struct berval *r_rspdata;
1836 typedef struct rep_search_s {
1838 slap_mask_t r_attr_flags;
1839 #define SLAP_ATTRS_UNDEFINED (0x00U)
1840 #define SLAP_OPATTRS_NO (0x01U)
1841 #define SLAP_OPATTRS_YES (0x02U)
1842 #define SLAP_USERATTRS_NO (0x10U)
1843 #define SLAP_USERATTRS_YES (0x20U)
1844 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1845 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1846 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1847 #define SLAP_USERATTRS(f) \
1848 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1850 Attribute *r_operational_attrs;
1851 AttributeName *r_attrs;
1856 typedef struct slap_rep {
1857 slap_reply_t sr_type;
1861 const char *sr_matched;
1862 const char *sr_text;
1864 LDAPControl **sr_ctrls;
1866 rep_sasl_s sru_sasl;
1867 rep_extended_s sru_extended;
1868 rep_search_s sru_search;
1870 slap_mask_t sr_flags;
1871 #define REP_ENTRY_MODIFIABLE 0x0001U
1872 #define REP_ENTRY_MUSTBEFREED 0x0002U
1873 #define REP_MATCHED_MUSTBEFREED 0x0010U
1874 #define REP_REF_MUSTBEFREED 0x0020U
1877 /* short hands for response members */
1878 #define sr_attrs sr_un.sru_search.r_attrs
1879 #define sr_entry sr_un.sru_search.r_entry
1880 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1881 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1882 #define sr_v2ref sr_un.sru_search.r_v2ref
1883 #define sr_nentries sr_un.sru_search.r_nentries
1884 #define sr_rspoid sr_un.sru_extended.r_rspoid
1885 #define sr_rspdata sr_un.sru_extended.r_rspdata
1886 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1888 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1889 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1890 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1891 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1892 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1893 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1894 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1895 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1896 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1897 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1898 typedef int (BI_op_extended) LDAP_P((
1899 struct slap_op *op, struct slap_rep *rs ));
1900 typedef int (BI_chk_referrals) LDAP_P((
1901 struct slap_op *op, struct slap_rep *rs ));
1902 typedef int (BI_chk_controls) LDAP_P((
1903 struct slap_op *op, struct slap_rep *rs ));
1904 typedef int (BI_entry_release_rw)
1905 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1906 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1907 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1908 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1909 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1910 Entry *e, int *hasSubs ));
1912 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1913 struct slap_conn *c ));
1914 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1915 struct slap_conn *c ));
1917 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1918 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1919 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1920 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1921 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1922 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1923 struct berval *text ));
1924 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1925 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1926 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1927 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1928 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1929 struct berval *text ));
1931 struct ConfigTable; /* config.h */
1933 struct slap_backend_info {
1934 char *bi_type; /* type of backend */
1937 * per backend type routines:
1938 * bi_init: called to allocate a backend_info structure,
1939 * called once BEFORE configuration file is read.
1940 * bi_init() initializes this structure hence is
1941 * called directly from be_initialize()
1942 * bi_config: called per 'backend' specific option
1943 * all such options must before any 'database' options
1944 * bi_config() is called only from read_config()
1945 * bi_open: called to open each database, called
1946 * once AFTER configuration file is read but
1947 * BEFORE any bi_db_open() calls.
1948 * bi_open() is called from backend_startup()
1949 * bi_close: called to close each database, called
1950 * once during shutdown after all bi_db_close calls.
1951 * bi_close() is called from backend_shutdown()
1952 * bi_destroy: called to destroy each database, called
1953 * once during shutdown after all bi_db_destroy calls.
1954 * bi_destory() is called from backend_destroy()
1957 BI_config *bi_config;
1960 BI_destroy *bi_destroy;
1963 * per database routines:
1964 * bi_db_init: called to initialize each database,
1965 * called upon reading 'database <type>'
1966 * called only from backend_db_init()
1967 * bi_db_config: called to configure each database,
1968 * called per database to handle per database options
1969 * called only from read_config()
1970 * bi_db_open: called to open each database
1971 * called once per database immediately AFTER bi_open()
1972 * calls but before daemon startup.
1973 * called only by backend_startup()
1974 * bi_db_close: called to close each database
1975 * called once per database during shutdown but BEFORE
1976 * any bi_close call.
1977 * called only by backend_shutdown()
1978 * bi_db_destroy: called to destroy each database
1979 * called once per database during shutdown AFTER all
1980 * bi_close calls but before bi_destory calls.
1981 * called only by backend_destory()
1983 BI_db_init *bi_db_init;
1984 BI_db_config *bi_db_config;
1985 BI_db_open *bi_db_open;
1986 BI_db_close *bi_db_close;
1987 BI_db_destroy *bi_db_destroy;
1989 /* LDAP Operations Handling Routines */
1990 BI_op_bind *bi_op_bind;
1991 BI_op_unbind *bi_op_unbind;
1992 BI_op_search *bi_op_search;
1993 BI_op_compare *bi_op_compare;
1994 BI_op_modify *bi_op_modify;
1995 BI_op_modrdn *bi_op_modrdn;
1996 BI_op_add *bi_op_add;
1997 BI_op_delete *bi_op_delete;
1998 BI_op_abandon *bi_op_abandon;
1999 BI_op_cancel *bi_op_cancel;
2001 /* Extended Operations Helper */
2002 BI_op_extended *bi_extended;
2004 /* Auxilary Functions */
2005 BI_operational *bi_operational;
2006 BI_chk_referrals *bi_chk_referrals;
2007 BI_chk_controls *bi_chk_controls;
2008 BI_entry_get_rw *bi_entry_get_rw;
2009 BI_entry_release_rw *bi_entry_release_rw;
2011 BI_has_subordinates *bi_has_subordinates;
2013 BI_connection_init *bi_connection_init;
2014 BI_connection_destroy *bi_connection_destroy;
2016 /* hooks for slap tools */
2017 BI_tool_entry_open *bi_tool_entry_open;
2018 BI_tool_entry_close *bi_tool_entry_close;
2019 BI_tool_entry_first *bi_tool_entry_first;
2020 BI_tool_entry_next *bi_tool_entry_next;
2021 BI_tool_entry_get *bi_tool_entry_get;
2022 BI_tool_entry_put *bi_tool_entry_put;
2023 BI_tool_entry_reindex *bi_tool_entry_reindex;
2024 BI_tool_sync *bi_tool_sync;
2025 BI_tool_dn2id_get *bi_tool_dn2id_get;
2026 BI_tool_id2entry_get *bi_tool_id2entry_get;
2027 BI_tool_entry_modify *bi_tool_entry_modify;
2029 #define SLAP_INDEX_ADD_OP 0x0001
2030 #define SLAP_INDEX_DELETE_OP 0x0002
2032 slap_mask_t bi_flags; /* backend flags */
2033 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2034 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2035 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2036 #define SLAP_BFLAG_INCREMENT 0x0100U
2037 #define SLAP_BFLAG_ALIASES 0x1000U
2038 #define SLAP_BFLAG_REFERRALS 0x2000U
2039 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2040 #define SLAP_BFLAG_DYNAMIC 0x8000U
2042 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2043 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2044 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2045 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2046 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2047 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2048 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2049 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2050 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2051 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2053 char **bi_controls; /* supported controls */
2054 char bi_ctrls[SLAP_MAX_CIDS + 1];
2056 unsigned int bi_nDB; /* number of databases of this type */
2057 struct ConfigTable *bi_cf_table;
2058 void *bi_private; /* anything the backend type needs */
2061 #define c_authtype c_authz.sai_method
2062 #define c_authmech c_authz.sai_mech
2063 #define c_dn c_authz.sai_dn
2064 #define c_ndn c_authz.sai_ndn
2065 #define c_ssf c_authz.sai_ssf
2066 #define c_transport_ssf c_authz.sai_transport_ssf
2067 #define c_tls_ssf c_authz.sai_tls_ssf
2068 #define c_sasl_ssf c_authz.sai_sasl_ssf
2070 #define o_authtype o_authz.sai_method
2071 #define o_authmech o_authz.sai_mech
2072 #define o_dn o_authz.sai_dn
2073 #define o_ndn o_authz.sai_ndn
2074 #define o_ssf o_authz.sai_ssf
2075 #define o_transport_ssf o_authz.sai_transport_ssf
2076 #define o_tls_ssf o_authz.sai_tls_ssf
2077 #define o_sasl_ssf o_authz.sai_sasl_ssf
2079 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2081 typedef struct slap_callback {
2082 struct slap_callback *sc_next;
2083 slap_response *sc_response;
2084 slap_response *sc_cleanup;
2088 struct slap_overinfo;
2090 typedef struct slap_overinst {
2092 slap_response *on_response;
2093 struct slap_overinfo *on_info;
2094 struct slap_overinst *on_next;
2097 typedef struct slap_overinfo {
2099 BackendInfo *oi_orig;
2100 struct slap_overinst *oi_list;
2103 /* Should successive callbacks in a chain be processed? */
2104 #define SLAP_CB_FREEME 0x4000
2105 #define SLAP_CB_CONTINUE 0x8000
2108 * Paged Results state
2110 typedef unsigned long PagedResultsCookie;
2111 typedef struct slap_paged_state {
2114 PagedResultsCookie ps_cookie;
2116 } PagedResultsState;
2118 struct slap_csn_entry {
2119 struct berval ce_csn;
2120 unsigned long ce_opid;
2121 unsigned long ce_connid;
2122 #define SLAP_CSN_PENDING 1
2123 #define SLAP_CSN_COMMIT 2
2125 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2129 * Caches the result of a backend_group check for ACL evaluation
2131 typedef struct slap_gacl {
2132 struct slap_gacl *ga_next;
2135 AttributeDescription *ga_at;
2141 struct slap_control_ids {
2147 int sc_modifyIncrement;
2149 int sc_pagedResults;
2150 int sc_valuesReturnFilter;
2151 int sc_permissiveModify;
2154 int sc_searchOptions;
2160 * represents an operation pending from an ldap client
2162 typedef struct slap_op_header {
2163 unsigned long oh_opid; /* id of this operation */
2164 unsigned long oh_connid; /* id of conn initiating this op */
2165 struct slap_conn *oh_conn; /* connection spawning this op */
2167 ber_int_t oh_msgid; /* msgid of the request */
2168 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2170 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2172 void *oh_threadctx; /* thread pool thread context */
2173 void *oh_tmpmemctx; /* slab malloc context */
2174 BerMemoryFunctions *oh_tmpmfuncs;
2176 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2179 void *oh_pb; /* NS-SLAPI plugin */
2180 void *oh_extensions; /* NS-SLAPI plugin */
2184 typedef struct slap_op {
2187 #define o_opid o_hdr->oh_opid
2188 #define o_connid o_hdr->oh_connid
2189 #define o_conn o_hdr->oh_conn
2190 #define o_msgid o_hdr->oh_msgid
2191 #define o_protocol o_hdr->oh_protocol
2192 #define o_tid o_hdr->oh_tid
2193 #define o_threadctx o_hdr->oh_threadctx
2194 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2195 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2197 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2198 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2199 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2200 #define o_tmpfree o_tmpmfuncs->bmf_free
2202 #define o_log_prefix o_hdr->oh_log_prefix
2205 #define o_pb o_hdr->oh_pb
2206 #define o_extensions o_hdr->oh_extensions
2209 ber_tag_t o_tag; /* tag of the request */
2210 time_t o_time; /* time op was initiated */
2212 BackendDB *o_bd; /* backend DB processing this op */
2213 struct berval o_req_dn; /* DN of target of request */
2214 struct berval o_req_ndn;
2219 req_compare_s oq_compare;
2220 req_modify_s oq_modify;
2221 req_modrdn_s oq_modrdn;
2222 req_search_s oq_search;
2223 req_abandon_s oq_abandon;
2224 req_abandon_s oq_cancel;
2225 req_extended_s oq_extended;
2226 req_pwdexop_s oq_pwdexop;
2229 /* short hands for union members */
2230 #define oq_add o_request.oq_add
2231 #define oq_bind o_request.oq_bind
2232 #define oq_compare o_request.oq_compare
2233 #define oq_modify o_request.oq_modify
2234 #define oq_modrdn o_request.oq_modrdn
2235 #define oq_search o_request.oq_search
2236 #define oq_abandon o_request.oq_abandon
2237 #define oq_cancel o_request.oq_cancel
2238 #define oq_extended o_request.oq_extended
2239 #define oq_pwdexop o_request.oq_pwdexop
2241 /* short hands for inner request members */
2242 #define orb_method oq_bind.rb_method
2243 #define orb_cred oq_bind.rb_cred
2244 #define orb_edn oq_bind.rb_edn
2245 #define orb_ssf oq_bind.rb_ssf
2246 #define orb_tmp_mech oq_bind.rb_tmp_mech
2248 #define ors_scope oq_search.rs_scope
2249 #define ors_deref oq_search.rs_deref
2250 #define ors_slimit oq_search.rs_slimit
2251 #define ors_tlimit oq_search.rs_tlimit
2252 #define ors_limit oq_search.rs_limit
2253 #define ors_attrsonly oq_search.rs_attrsonly
2254 #define ors_attrs oq_search.rs_attrs
2255 #define ors_filter oq_search.rs_filter
2256 #define ors_filterstr oq_search.rs_filterstr
2258 #define orr_newrdn oq_modrdn.rs_newrdn
2259 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2260 #define orr_newSup oq_modrdn.rs_newSup
2261 #define orr_nnewSup oq_modrdn.rs_nnewSup
2262 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2264 #define orc_ava oq_compare.rs_ava
2265 #define ora_e oq_add.rs_e
2266 #define ora_modlist oq_add.rs_modlist
2267 #define orn_msgid oq_abandon.rs_msgid
2268 #define orm_modlist oq_modify.rs_modlist
2269 #define orm_increment oq_modify.rs_increment
2271 #define ore_reqoid oq_extended.rs_reqoid
2272 #define ore_flags oq_extended.rs_flags
2273 #define ore_reqdata oq_extended.rs_reqdata
2274 volatile sig_atomic_t o_abandon; /* abandon flag */
2275 volatile sig_atomic_t o_cancel; /* cancel flag */
2276 #define SLAP_CANCEL_NONE 0x00
2277 #define SLAP_CANCEL_REQ 0x01
2278 #define SLAP_CANCEL_ACK 0x02
2279 #define SLAP_CANCEL_DONE 0x03
2281 GroupAssertion *o_groups;
2282 char o_do_not_cache; /* don't cache groups from this op */
2283 char o_is_auth_check; /* authorization in progress */
2285 #define SLAP_CONTROL_NONE 0
2286 #define SLAP_CONTROL_IGNORED 1
2287 #define SLAP_CONTROL_NONCRITICAL 2
2288 #define SLAP_CONTROL_CRITICAL 3
2289 #define SLAP_CONTROL_MASK 3
2291 /* spare bits for simple flags */
2292 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2293 #define SLAP_CONTROL_DATA0 0x10
2294 #define SLAP_CONTROL_DATA1 0x20
2295 #define SLAP_CONTROL_DATA2 0x40
2296 #define SLAP_CONTROL_DATA3 0x80
2299 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2301 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2302 void **o_controls; /* per-control state */
2304 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2305 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2307 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2308 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2309 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2311 #define get_subentries(op) _SCM((op)->o_subentries)
2312 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2314 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2315 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2317 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2318 #define get_assert(op) ((int)(op)->o_assert)
2319 #define o_assertion o_controls[slap_cids.sc_assert]
2320 #define get_assertion(op) ((op)->o_assertion)
2322 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2323 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2325 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2326 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2327 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2329 #define get_permissiveModify(op) (0)
2332 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2333 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2334 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2336 #define get_domainScope(op) (0)
2339 #ifdef LDAP_CONTROL_X_TREE_DELETE
2340 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2341 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2343 #define get_treeDelete(op) (0)
2346 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2347 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2349 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2350 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2352 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2353 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2355 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2357 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2359 AuthorizationInformation o_authz;
2361 BerElement *o_ber; /* ber of the request */
2362 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2363 slap_callback *o_callback; /* callback pointers */
2364 LDAPControl **o_ctrls; /* controls */
2366 void *o_private; /* anything the backend needs */
2368 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2371 int o_delete_glue_parent;
2374 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2376 #define send_ldap_error( op, rs, err, text ) do { \
2377 (rs)->sr_err = err; (rs)->sr_text = text; \
2378 (op->o_conn->c_send_ldap_result)( op, rs ); \
2380 #define send_ldap_discon( op, rs, err, text ) do { \
2381 (rs)->sr_err = err; (rs)->sr_text = text; \
2382 send_ldap_disconnect( op, rs ); \
2385 typedef void (SEND_LDAP_RESULT)(
2386 struct slap_op *op, struct slap_rep *rs);
2387 typedef int (SEND_SEARCH_ENTRY)(
2388 struct slap_op *op, struct slap_rep *rs);
2389 typedef int (SEND_SEARCH_REFERENCE)(
2390 struct slap_op *op, struct slap_rep *rs);
2391 typedef void (SEND_LDAP_EXTENDED)(
2392 struct slap_op *op, struct slap_rep *rs);
2393 typedef void (SEND_LDAP_INTERMEDIATE)(
2394 struct slap_op *op, struct slap_rep *rs);
2396 #define send_ldap_result( op, rs ) \
2397 ((op)->o_conn->c_send_ldap_result)( op, rs )
2398 #define send_search_entry( op, rs ) \
2399 ((op)->o_conn->c_send_search_entry)( op, rs )
2400 #define send_search_reference( op, rs ) \
2401 ((op)->o_conn->c_send_search_reference)( op, rs )
2402 #define send_ldap_extended( op, rs ) \
2403 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2404 #define send_ldap_intermediate( op, rs ) \
2405 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2407 typedef struct slap_listener Listener;
2410 * represents a connection from an ldap client
2412 typedef struct slap_conn {
2413 int c_struct_state; /* structure management state */
2414 int c_conn_state; /* connection state */
2415 int c_conn_idx; /* slot in connections array */
2417 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2418 Sockbuf *c_sb; /* ber connection stuff */
2420 /* only can be changed by connect_init */
2421 time_t c_starttime; /* when the connection was opened */
2422 time_t c_activitytime; /* when the connection was last used */
2423 unsigned long c_connid; /* id of this connection for stats*/
2425 struct berval c_peer_domain; /* DNS name of client */
2426 struct berval c_peer_name; /* peer name (trans=addr:port) */
2427 Listener *c_listener;
2428 #define c_listener_url c_listener->sl_url /* listener URL */
2429 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2431 /* only can be changed by binding thread */
2432 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2433 struct berval c_sasl_bind_mech; /* mech in progress */
2434 struct berval c_sasl_dn; /* temporary storage */
2436 /* authorization backend */
2437 Backend *c_authz_backend;
2439 AuthorizationInformation c_authz;
2441 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2443 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2444 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2446 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2447 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2449 BerElement *c_currentber; /* ber we're attempting to read */
2450 int c_writewaiter; /* true if writer is waiting */
2452 #define CONN_IS_TLS 1
2453 #define CONN_IS_UDP 2
2454 #define CONN_IS_CLIENT 3
2456 #ifdef LDAP_CONNECTIONLESS
2457 int c_is_udp; /* true if this is (C)LDAP over UDP */
2460 int c_is_tls; /* true if this LDAP over raw TLS */
2461 int c_needs_tls_accept; /* true if SSL_accept should be called */
2463 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2464 int c_sasl_done; /* SASL completed once */
2465 void *c_sasl_authctx; /* SASL authentication context */
2466 void *c_sasl_sockctx; /* SASL security layer context */
2467 void *c_sasl_extra; /* SASL session extra stuff */
2468 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2470 PagedResultsState c_pagedresults_state; /* paged result state */
2472 long c_n_ops_received; /* num of ops received (next op_id) */
2473 long c_n_ops_executing; /* num of ops currently executing */
2474 long c_n_ops_pending; /* num of ops pending execution */
2475 long c_n_ops_completed; /* num of ops completed */
2477 long c_n_get; /* num of get calls */
2478 long c_n_read; /* num of read calls */
2479 long c_n_write; /* num of write calls */
2481 void *c_pb; /* Netscape plugin */
2482 void *c_extensions; /* Netscape plugin */
2485 * Client connection handling
2487 ldap_pvt_thread_start_t *c_clientfunc;
2491 * These are the "callbacks" that are available for back-ends to
2492 * supply data back to connected clients that are connected
2493 * through the "front-end".
2495 SEND_LDAP_RESULT *c_send_ldap_result;
2496 SEND_SEARCH_ENTRY *c_send_search_entry;
2497 SEND_SEARCH_REFERENCE *c_send_search_reference;
2498 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2499 #ifdef LDAP_RES_INTERMEDIATE
2500 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2505 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2506 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2508 if ( ldap_debug & (level) ) \
2509 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2510 if ( ldap_syslog & (level) ) \
2511 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2514 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2515 #elif defined(LDAP_DEBUG)
2516 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2518 if ( ldap_debug & (level) ) \
2519 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2521 #define StatslogTest( level ) (ldap_debug & (level))
2523 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2524 #define StatslogTest( level ) (0)
2528 * listener; need to access it from monitor backend
2530 struct slap_listener {
2531 struct berval sl_url;
2532 struct berval sl_name;
2537 #ifdef LDAP_CONNECTIONLESS
2538 int sl_is_udp; /* UDP listener is also data port */
2540 int sl_is_mute; /* Listening is temporarily disabled */
2543 #define sl_addr sl_sa.sa_in_addr
2546 #ifdef SLAPD_MONITOR
2563 #endif /* SLAPD_MONITOR */
2565 typedef struct slap_counters_t {
2566 ldap_pvt_thread_mutex_t sc_sent_mutex;
2567 ldap_pvt_mp_t sc_bytes;
2568 ldap_pvt_mp_t sc_pdu;
2569 ldap_pvt_mp_t sc_entries;
2570 ldap_pvt_mp_t sc_refs;
2572 ldap_pvt_thread_mutex_t sc_ops_mutex;
2573 ldap_pvt_mp_t sc_ops_completed;
2574 ldap_pvt_mp_t sc_ops_initiated;
2575 #ifdef SLAPD_MONITOR
2576 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2577 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2578 #endif /* SLAPD_MONITOR */
2582 * Better know these all around slapd
2584 #define SLAP_LDAPDN_PRETTY 0x1
2585 #define SLAP_LDAPDN_MAXLEN 8192
2587 /* number of response controls supported */
2588 #define SLAP_MAX_RESPONSE_CONTROLS 6
2591 #define SLAP_CTRL_HIDE 0x00000000U
2593 #define SLAP_CTRL_HIDE 0x80000000U
2596 #define SLAP_CTRL_GLOBAL 0x00800000U
2597 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2599 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2600 #define SLAP_CTRL_ABANDON 0x00000001U
2601 #define SLAP_CTRL_ADD 0x00002002U
2602 #define SLAP_CTRL_BIND 0x00000004U
2603 #define SLAP_CTRL_COMPARE 0x00001008U
2604 #define SLAP_CTRL_DELETE 0x00002010U
2605 #define SLAP_CTRL_MODIFY 0x00002020U
2606 #define SLAP_CTRL_RENAME 0x00002040U
2607 #define SLAP_CTRL_SEARCH 0x00001080U
2608 #define SLAP_CTRL_UNBIND 0x00000100U
2610 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2611 #define SLAP_CTRL_UPDATE \
2612 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2613 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2615 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2618 LDAPControl *ctrl ));
2620 #define SLAP_SLAB_SIZE (1024*1024)
2621 #define SLAP_SLAB_STACK 1
2622 #define SLAP_SLAB_SOBLOCK 64
2624 #define SLAP_ZONE_ALLOC 1
2625 #undef SLAP_ZONE_ALLOC
2627 #ifdef LDAP_COMP_MATCH
2629 * Extensible Filter Definition
2631 * MatchingRuleAssertion := SEQUENCE {
2632 * matchingRule [1] MatchingRuleId OPTIONAL,
2633 * type [2] AttributeDescription OPTIONAL,
2634 * matchValue [3] AssertionValue,
2635 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2637 * Following ComponentFilter is contained in matchValue
2639 * ComponentAssertion ::= SEQUENCE {
2640 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2641 * useDefaultValues BOOLEAN DEFAULT TRUE,
2642 * rule MATCHING-RULE.&id,
2643 * value MATCHING-RULE.&AssertionType }
2645 * ComponentFilter ::= CHOICE {
2646 * item [0] ComponentAssertion,
2647 * and [1] SEQUENCE OF ComponentFilter,
2648 * or [2] SEQUENCE OF ComponentFilter,
2649 * not [3] ComponentFilter }
2652 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2653 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2654 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2655 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2656 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2657 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2658 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2659 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2660 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2662 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2663 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2664 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2665 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2666 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2668 typedef struct slap_component_id {
2670 struct slap_component_id *ci_next;
2672 union comp_id_value{
2673 BerValue ci_identifier;
2674 ber_int_t ci_from_beginning;
2676 ber_int_t ci_from_end;
2677 ber_int_t ci_content;
2678 BerValue ci_select_value;
2683 typedef struct slap_component_reference {
2684 ComponentId *cr_list;
2685 ComponentId *cr_curr;
2686 struct berval cr_string;
2688 /* Component Indexing */
2690 slap_mask_t cr_indexmask;
2691 AttributeDescription* cr_ad;
2693 struct slap_component_reference* cr_next;
2694 } ComponentReference;
2696 typedef struct slap_component_assertion {
2697 ComponentReference *ca_comp_ref;
2698 ber_int_t ca_use_def;
2699 MatchingRule *ca_ma_rule;
2700 struct berval ca_ma_value;
2701 ComponentData ca_comp_data; /* componentized assertion */
2702 struct slap_component_filter *ca_cf;
2703 MatchingRuleAssertion *ca_mra;
2704 } ComponentAssertion;
2706 typedef struct slap_component_filter {
2707 ber_tag_t cf_choice;
2709 ber_int_t cf_un_result;
2710 ComponentAssertion *cf_un_ca;
2711 struct slap_component_filter *cf_un_complex;
2714 #define cf_ca cf_un.cf_un_ca
2715 #define cf_result cf_un.cf_un_result
2716 #define cf_and cf_un.cf_un_complex
2717 #define cf_or cf_un.cf_un_complex
2718 #define cf_not cf_un.cf_un_complex
2719 #define cf_any cf_un.cf_un_complex
2721 struct slap_component_filter *cf_next;
2724 typedef struct slap_component_assertion_value {
2728 } ComponentAssertionValue;
2730 typedef int encoder_func LDAP_P((
2734 struct slap_component_syntax_info;
2736 typedef int gser_decoder_func LDAP_P((
2739 struct slap_component_syntax_info** comp_syn_info,
2743 typedef int comp_free_func LDAP_P((
2746 typedef int ber_decoder_func LDAP_P((
2751 struct slap_component_syntax_info* comp_syn_info,
2755 typedef int ber_tag_decoder_func LDAP_P((
2758 struct slap_component_syntax_info* comp_syn_info,
2762 typedef void* extract_component_from_id_func LDAP_P((
2764 ComponentReference* cr,
2767 typedef void* convert_attr_to_comp_func LDAP_P ((
2770 struct berval* bv ));
2772 typedef void* alloc_nibble_func LDAP_P ((
2774 int increment_size ));
2776 typedef void free_nibble_func LDAP_P ((
2779 struct slap_component_syntax_info;
2780 typedef void convert_assert_to_comp_func LDAP_P ((
2782 struct slap_component_syntax_info* csi_attr,
2784 struct slap_component_syntax_info** csi,
2788 typedef int convert_asn_to_ldap_func LDAP_P ((
2789 struct slap_component_syntax_info* csi,
2790 struct berval *bv ));
2792 typedef void free_component_func LDAP_P ((
2795 typedef int test_component_func LDAP_P ((
2797 void* assert_mem_op,
2798 struct slap_component_syntax_info* csi,
2799 struct slap_component_assertion* ca));
2801 typedef void* test_membership_func LDAP_P ((
2804 typedef void* get_component_info_func LDAP_P ((
2807 struct slap_component_syntax_info;
2809 typedef int component_encoder_func LDAP_P ((
2811 struct slap_component_syntax_info* csi,
2812 struct berval* nvals ));
2814 typedef int allcomponent_matching_func LDAP_P((
2816 struct slap_component_syntax_info* comp1,
2817 struct slap_component_syntax_info* comp));
2819 typedef struct slap_component_desc {
2820 /* Don't change the order of following four fields */
2822 AttributeType *cd_comp_type;
2823 struct berval cd_ad_type;/* ad_type, ad_cname */
2824 struct berval cd_ad_cname;/* ad_type, ad_cname */
2825 unsigned cd_flags; /*ad_flags*/
2828 encoder_func *cd_ldap_encoder;
2829 encoder_func *cd_gser_encoder;
2830 encoder_func *cd_ber_encoder;
2831 gser_decoder_func *cd_gser_decoder;
2832 ber_decoder_func *cd_ber_decoder;
2833 comp_free_func *cd_free;
2834 extract_component_from_id_func* cd_extract_i;
2835 allcomponent_matching_func *cd_all_match;
2838 typedef struct slap_component_syntax_info {
2840 ComponentDesc* csi_comp_desc;
2841 } ComponentSyntaxInfo;
2845 /* slab heap data structures */
2847 struct slab_object {
2850 LDAP_LIST_ENTRY(slab_object) so_link;
2859 unsigned char **sh_map;
2860 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2861 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2864 #ifdef SLAP_ZONE_ALLOC
2865 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2866 #define SLAP_ZONE_SHIFT 19
2867 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2868 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2869 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2870 #define SLAP_ZONE_ZOBLOCK 256
2872 struct zone_object {
2877 LDAP_LIST_ENTRY(zone_object) zo_link;
2880 struct zone_latency_history {
2882 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2893 ldap_pvt_thread_rdwr_t *zh_znlock;
2894 Avlnode *zh_zonetree;
2895 unsigned char ***zh_maps;
2897 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2898 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2899 ldap_pvt_thread_mutex_t zh_mutex;
2900 ldap_pvt_thread_rdwr_t zh_lock;
2901 double zh_ema_latency;
2902 unsigned long zh_ema_samples;
2903 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2904 zh_latency_history_queue;
2905 int zh_latency_history_qlen;
2906 int zh_latency_jump;
2911 #define SLAP_BACKEND_INIT_MODULE(b) \
2913 init_module( int argc, char *argv[] ) \
2916 memset( &bi, '\0', sizeof( bi ) ); \
2918 bi.bi_init = b ## _back_initialize; \
2919 backend_add( &bi ); \
2925 #include "proto-slap.h"
2927 #endif /* _SLAP_H_ */