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 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
77 * SLAPD Memory allocation macros
79 * Unlike ch_*() routines, these routines do not assert() upon
80 * allocation error. They are intended to be used instead of
81 * ch_*() routines where the caller has implemented proper
82 * checking for and handling of allocation errors.
84 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
86 #define SLAP_MALLOC(s) ber_memalloc((s))
87 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
88 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
89 #define SLAP_FREE(p) ber_memfree((p))
90 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
91 #define SLAP_STRDUP(s) ber_strdup((s))
92 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
95 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
98 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
99 #define SLAPD_ANONYMOUS "cn=anonymous"
101 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
102 * This is a value used internally by the backends. It is needed to allow
103 * adding values that already exist without getting an error as required by
104 * modrdn when the new rdn was already an attribute value itself.
106 #define SLAP_MOD_SOFTADD 0x1000
108 #define MAXREMATCHES (100)
110 #define SLAP_MAX_WORKER_THREADS (16)
112 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
113 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
115 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
116 #define SLAP_CONN_MAX_PENDING_AUTH 1000
118 #define SLAP_TEXT_BUFLEN (256)
120 /* psuedo error code indicating abandoned operation */
121 #define SLAPD_ABANDON (-1024)
123 /* psuedo error code indicating disconnect */
124 #define SLAPD_DISCONNECT (-1025)
126 /* unknown config file directive */
127 #define SLAP_CONF_UNKNOWN (-1026)
129 /* We assume "C" locale, that is US-ASCII */
130 #define ASCII_SPACE(c) ( (c) == ' ' )
131 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
132 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
133 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
134 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
135 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
136 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
137 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
138 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
139 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
140 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
142 #define SLAP_NIBBLE(c) ((c)&0x0f)
143 #define SLAP_ESCAPE_CHAR ('\\')
144 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
145 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
147 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
148 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
150 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
151 /* NOTE: for consistency, this macro must only operate
152 * on normalized/pretty DN, such that ';' is never used
153 * as RDN separator, and all occurrences of ';' must be escaped */
154 #define DN_SEPARATOR(c) ((c) == ',')
155 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
156 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
157 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
159 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
160 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
161 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
162 #define OID_SEPARATOR(c) ( (c) == '.' )
163 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
165 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
166 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
168 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
169 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
171 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
173 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
174 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
175 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
176 (c) == '?' || (c) == ' ' || (c) == '=' )
177 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
179 /* must match in schema_init.c */
180 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
181 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
182 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
183 #define SLAPD_GROUP_ATTR "member"
184 #define SLAPD_GROUP_CLASS "groupOfNames"
185 #define SLAPD_ROLE_ATTR "roleOccupant"
186 #define SLAPD_ROLE_CLASS "organizationalRole"
188 #ifdef SLAPD_ACI_ENABLED
189 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
192 /* change this to "OpenLDAPset" */
193 #define SLAPD_ACI_SET_ATTR "template"
195 #define SLAPD_TOP_OID "2.5.6.0"
197 LDAP_SLAPD_V (int) slap_debug;
199 typedef unsigned long slap_mask_t;
201 /* Security Strength Factor */
202 typedef unsigned slap_ssf_t;
204 typedef struct slap_ssf_set {
206 slap_ssf_t sss_transport;
209 slap_ssf_t sss_update_ssf;
210 slap_ssf_t sss_update_transport;
211 slap_ssf_t sss_update_tls;
212 slap_ssf_t sss_update_sasl;
213 slap_ssf_t sss_simple_bind;
216 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
217 #define SLAP_GETDN_AUTHCID 2
218 #define SLAP_GETDN_AUTHZID 4
223 #define SLAP_INDEX_TYPE 0x00FFUL
224 #define SLAP_INDEX_UNDEFINED 0x0001UL
225 #define SLAP_INDEX_PRESENT 0x0002UL
226 #define SLAP_INDEX_EQUALITY 0x0004UL
227 #define SLAP_INDEX_APPROX 0x0008UL
228 #define SLAP_INDEX_SUBSTR 0x0010UL
229 #define SLAP_INDEX_EXTENDED 0x0020UL
231 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
233 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
235 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
237 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
238 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
239 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
240 #define SLAP_INDEX_SUBSTR_DEFAULT \
241 ( SLAP_INDEX_SUBSTR \
242 | SLAP_INDEX_SUBSTR_INITIAL \
243 | SLAP_INDEX_SUBSTR_ANY \
244 | SLAP_INDEX_SUBSTR_FINAL )
246 /* defaults for initial/final substring indices */
247 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
248 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
250 /* defaults for any substring indices */
251 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
252 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
254 #define SLAP_INDEX_FLAGS 0xF000UL
255 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
256 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
259 * there is a single index for each attribute. these prefixes ensure
260 * that there is no collision among keys.
262 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
263 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
264 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
265 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
266 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
267 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
269 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
270 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
271 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
272 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
273 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
276 * represents schema information for a database
278 #define SLAP_SCHERR_OUTOFMEM 1
279 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
280 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
281 #define SLAP_SCHERR_CLASS_BAD_SUP 4
282 #define SLAP_SCHERR_CLASS_DUP 5
283 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
284 #define SLAP_SCHERR_ATTR_BAD_MR 7
285 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
286 #define SLAP_SCHERR_ATTR_BAD_SUP 9
287 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
288 #define SLAP_SCHERR_ATTR_DUP 11
289 #define SLAP_SCHERR_MR_NOT_FOUND 12
290 #define SLAP_SCHERR_MR_INCOMPLETE 13
291 #define SLAP_SCHERR_MR_DUP 14
292 #define SLAP_SCHERR_SYN_NOT_FOUND 15
293 #define SLAP_SCHERR_SYN_DUP 16
294 #define SLAP_SCHERR_NO_NAME 17
295 #define SLAP_SCHERR_NOT_SUPPORTED 18
296 #define SLAP_SCHERR_BAD_DESCR 19
297 #define SLAP_SCHERR_OIDM 20
298 #define SLAP_SCHERR_CR_DUP 21
299 #define SLAP_SCHERR_CR_BAD_STRUCT 22
300 #define SLAP_SCHERR_CR_BAD_AUX 23
301 #define SLAP_SCHERR_CR_BAD_AT 24
302 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
304 typedef union slap_sockaddr {
305 struct sockaddr sa_addr;
306 struct sockaddr_in sa_in_addr;
308 struct sockaddr_storage sa_storage;
309 struct sockaddr_in6 sa_in6_addr;
312 struct sockaddr_un sa_un_addr;
317 extern int slap_inet4or6;
320 typedef struct slap_oid_macro {
321 struct berval som_oid;
324 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
327 /* forward declarations */
329 struct slap_matching_rule;
331 typedef int slap_syntax_validate_func LDAP_P((
332 struct slap_syntax *syntax,
333 struct berval * in));
335 typedef int slap_syntax_transform_func LDAP_P((
336 struct slap_syntax *syntax,
341 #ifdef LDAP_COMP_MATCH
342 typedef void* slap_component_transform_func LDAP_P((
343 struct berval * in ));
344 struct ComponentDesc;
347 typedef struct slap_syntax {
349 #define ssyn_oid ssyn_syn.syn_oid
350 #define ssyn_desc ssyn_syn.syn_desc
351 #define ssyn_extensions ssyn_syn.syn_extensions
354 ber_len_t ssyn_oidlen;
355 * has been replaced by a struct berval that uses the value
356 * provided by ssyn_syn.syn_oid; a macro that expands to
357 * the bv_len field of the berval is provided for backward
358 * compatibility. CAUTION: NEVER FREE THE BERVAL
360 struct berval ssyn_bvoid;
361 #define ssyn_oidlen ssyn_bvoid.bv_len
363 unsigned int ssyn_flags;
365 #define SLAP_SYNTAX_NONE 0x0000U
366 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
367 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
368 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
370 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
372 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
375 slap_syntax_validate_func *ssyn_validate;
376 slap_syntax_transform_func *ssyn_pretty;
378 #ifdef SLAPD_BINARY_CONVERSION
379 /* convert to and from binary */
380 slap_syntax_transform_func *ssyn_ber2str;
381 slap_syntax_transform_func *ssyn_str2ber;
383 #ifdef LDAP_COMP_MATCH
384 slap_component_transform_func *ssyn_attr2comp;
385 struct ComponentDesc* ssync_comp_syntax;
388 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
391 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
392 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
393 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
394 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
395 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
397 typedef struct slap_syntax_defs_rec {
400 slap_syntax_validate_func *sd_validate;
401 slap_syntax_transform_func *sd_pretty;
402 #ifdef SLAPD_BINARY_CONVERSION
403 slap_syntax_transform_func *sd_ber2str;
404 slap_syntax_transform_func *sd_str2ber;
406 } slap_syntax_defs_rec;
408 /* X -> Y Converter */
409 typedef int slap_mr_convert_func LDAP_P((
415 typedef int slap_mr_normalize_func LDAP_P((
417 struct slap_syntax *syntax, /* NULL if in is asserted value */
418 struct slap_matching_rule *mr,
423 /* Match (compare) function */
424 typedef int slap_mr_match_func LDAP_P((
427 struct slap_syntax *syntax, /* syntax of stored value */
428 struct slap_matching_rule *mr,
429 struct berval * value,
430 void * assertValue ));
432 /* Index generation function */
433 typedef int slap_mr_indexer_func LDAP_P((
436 struct slap_syntax *syntax, /* syntax of stored value */
437 struct slap_matching_rule *mr,
438 struct berval *prefix,
443 /* Filter index function */
444 typedef int slap_mr_filter_func LDAP_P((
447 struct slap_syntax *syntax, /* syntax of stored value */
448 struct slap_matching_rule *mr,
449 struct berval *prefix,
454 typedef struct slap_matching_rule_use MatchingRuleUse;
456 typedef struct slap_matching_rule {
457 LDAPMatchingRule smr_mrule;
458 MatchingRuleUse *smr_mru;
459 /* RFC2252 string representation */
460 struct berval smr_str;
463 * ber_len_t smr_oidlen;
464 * has been replaced by a struct berval that uses the value
465 * provided by smr_mrule.mr_oid; a macro that expands to
466 * the bv_len field of the berval is provided for backward
467 * compatibility. CAUTION: NEVER FREE THE BERVAL
469 struct berval smr_bvoid;
470 #define smr_oidlen smr_bvoid.bv_len
472 slap_mask_t smr_usage;
475 #define SLAP_MR_HIDE 0x0000U
477 #define SLAP_MR_HIDE 0x8000U
480 #define SLAP_MR_TYPE_MASK 0x0F00U
481 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
482 #define SLAP_MR_USAGE 0x000FU
484 #define SLAP_MR_NONE 0x0000U
485 #define SLAP_MR_EQUALITY 0x0100U
486 #define SLAP_MR_ORDERING 0x0200U
487 #define SLAP_MR_SUBSTR 0x0400U
488 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
489 #define SLAP_MR_ORDERED_INDEX 0x1000U
490 #ifdef LDAP_COMP_MATCH
491 #define SLAP_MR_COMPONENT 0x2000U
494 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
496 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
497 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
498 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
502 * The asserted value, depending on the particular usage,
503 * is expected to conform to either the assertion syntax
504 * or the attribute syntax. In some cases, the syntax of
505 * the value is known. If so, these flags indicate which
506 * syntax the value is expected to conform to. If not,
507 * neither of these flags is set (until the syntax of the
508 * provided value is determined). If the value is of the
509 * attribute syntax, the flag is changed once a value of
510 * the assertion syntax is derived from the provided value.
512 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
513 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
514 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
516 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
517 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
518 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
519 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
521 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
522 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
524 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
527 /* either or both the asserted value or attribute value
528 * may be provided in normalized form
530 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
531 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
533 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
534 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
535 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
536 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
538 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
539 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
540 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
541 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
542 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
543 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
545 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
546 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
547 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
548 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
551 slap_mr_convert_func *smr_convert;
552 slap_mr_normalize_func *smr_normalize;
553 slap_mr_match_func *smr_match;
554 slap_mr_indexer_func *smr_indexer;
555 slap_mr_filter_func *smr_filter;
558 * null terminated array of syntaxes compatible with this syntax
559 * note: when MS_EXT is set, this MUST NOT contain the assertion
560 * syntax of the rule. When MS_EXT is not set, it MAY.
562 Syntax **smr_compat_syntaxes;
565 * For equality rules, refers to an associated approximate rule.
566 * For non-equality rules, refers to an associated equality rule.
568 struct slap_matching_rule *smr_associated;
570 #define SLAP_MR_ASSOCIATED(mr,amr) \
571 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
573 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
575 #define smr_oid smr_mrule.mr_oid
576 #define smr_names smr_mrule.mr_names
577 #define smr_desc smr_mrule.mr_desc
578 #define smr_obsolete smr_mrule.mr_obsolete
579 #define smr_syntax_oid smr_mrule.mr_syntax_oid
580 #define smr_extensions smr_mrule.mr_extensions
583 struct slap_matching_rule_use {
584 LDAPMatchingRuleUse smru_mruleuse;
585 MatchingRule *smru_mr;
586 /* RFC2252 string representation */
587 struct berval smru_str;
589 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
591 #define smru_oid smru_mruleuse.mru_oid
592 #define smru_names smru_mruleuse.mru_names
593 #define smru_desc smru_mruleuse.mru_desc
594 #define smru_obsolete smru_mruleuse.mru_obsolete
595 #define smru_applies_oids smru_mruleuse.mru_applies_oids
597 #define smru_usage smru_mr->smr_usage
598 } /* MatchingRuleUse */ ;
600 typedef struct slap_mrule_defs_rec {
602 slap_mask_t mrd_usage;
603 char ** mrd_compat_syntaxes;
604 slap_mr_convert_func * mrd_convert;
605 slap_mr_normalize_func * mrd_normalize;
606 slap_mr_match_func * mrd_match;
607 slap_mr_indexer_func * mrd_indexer;
608 slap_mr_filter_func * mrd_filter;
610 /* For equality rule, this may refer to an associated approximate rule */
611 /* For non-equality rule, this may refer to an associated equality rule */
612 char * mrd_associated;
613 } slap_mrule_defs_rec;
615 struct slap_backend_db;
619 typedef int (AttributeTypeSchemaCheckFN)(
620 struct slap_backend_db *be,
621 struct slap_entry *e,
622 struct slap_attr *attr,
624 char *textbuf, size_t textlen );
626 typedef struct slap_attribute_type {
627 LDAPAttributeType sat_atype;
628 struct berval sat_cname;
629 struct slap_attribute_type *sat_sup;
630 struct slap_attribute_type **sat_subtypes;
631 MatchingRule *sat_equality;
632 MatchingRule *sat_approx;
633 MatchingRule *sat_ordering;
634 MatchingRule *sat_substr;
637 AttributeTypeSchemaCheckFN *sat_check;
639 #define SLAP_AT_NONE 0x0000U
640 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
641 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
643 #define SLAP_AT_HIDE 0x0000U /* publish everything */
645 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
647 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
649 slap_mask_t sat_flags;
651 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
653 #define sat_oid sat_atype.at_oid
654 #define sat_names sat_atype.at_names
655 #define sat_desc sat_atype.at_desc
656 #define sat_obsolete sat_atype.at_obsolete
657 #define sat_sup_oid sat_atype.at_sup_oid
658 #define sat_equality_oid sat_atype.at_equality_oid
659 #define sat_ordering_oid sat_atype.at_ordering_oid
660 #define sat_substr_oid sat_atype.at_substr_oid
661 #define sat_syntax_oid sat_atype.at_syntax_oid
662 #define sat_single_value sat_atype.at_single_value
663 #define sat_collective sat_atype.at_collective
664 #define sat_no_user_mod sat_atype.at_no_user_mod
665 #define sat_usage sat_atype.at_usage
666 #define sat_extensions sat_atype.at_extensions
668 struct slap_attr_desc *sat_ad;
669 ldap_pvt_thread_mutex_t sat_ad_mutex;
672 #define is_at_operational(at) ((at)->sat_usage)
673 #define is_at_single_value(at) ((at)->sat_single_value)
674 #define is_at_collective(at) ((at)->sat_collective)
675 #define is_at_obsolete(at) ((at)->sat_obsolete)
676 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
678 struct slap_object_class;
680 typedef int (ObjectClassSchemaCheckFN)(
681 struct slap_backend_db *be,
682 struct slap_entry *e,
683 struct slap_object_class *oc,
685 char *textbuf, size_t textlen );
687 typedef struct slap_object_class {
688 LDAPObjectClass soc_oclass;
689 struct berval soc_cname;
690 struct slap_object_class **soc_sups;
691 AttributeType **soc_required;
692 AttributeType **soc_allowed;
693 ObjectClassSchemaCheckFN *soc_check;
694 slap_mask_t soc_flags;
695 #define soc_oid soc_oclass.oc_oid
696 #define soc_names soc_oclass.oc_names
697 #define soc_desc soc_oclass.oc_desc
698 #define soc_obsolete soc_oclass.oc_obsolete
699 #define soc_sup_oids soc_oclass.oc_sup_oids
700 #define soc_kind soc_oclass.oc_kind
701 #define soc_at_oids_must soc_oclass.oc_at_oids_must
702 #define soc_at_oids_may soc_oclass.oc_at_oids_may
703 #define soc_extensions soc_oclass.oc_extensions
705 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
708 #define SLAP_OC_ALIAS 0x0001
709 #define SLAP_OC_REFERRAL 0x0002
710 #define SLAP_OC_SUBENTRY 0x0004
711 #define SLAP_OC_DYNAMICOBJECT 0x0008
712 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
713 #define SLAP_OC_GLUE 0x0020
714 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
715 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
716 #define SLAP_OC__MASK 0x00FF
717 #define SLAP_OC__END 0x0100
718 #define SLAP_OC_OPERATIONAL 0x4000
720 #define SLAP_OC_HIDE 0x0000
722 #define SLAP_OC_HIDE 0x8000
728 typedef struct slap_content_rule {
729 LDAPContentRule scr_crule;
730 ObjectClass *scr_sclass;
731 ObjectClass **scr_auxiliaries; /* optional */
732 AttributeType **scr_required; /* optional */
733 AttributeType **scr_allowed; /* optional */
734 AttributeType **scr_precluded; /* optional */
735 #define scr_oid scr_crule.cr_oid
736 #define scr_names scr_crule.cr_names
737 #define scr_desc scr_crule.cr_desc
738 #define scr_obsolete scr_crule.cr_obsolete
739 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
740 #define scr_at_oids_must scr_crule.cr_at_oids_must
741 #define scr_at_oids_may scr_crule.cr_at_oids_may
742 #define scr_at_oids_not scr_crule.cr_at_oids_not
744 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
747 /* Represents a recognized attribute description ( type + options ). */
748 typedef struct slap_attr_desc {
749 struct slap_attr_desc *ad_next;
750 AttributeType *ad_type; /* attribute type, must be specified */
751 struct berval ad_cname; /* canonical name, must be specified */
752 struct berval ad_tags; /* empty if no tagging options */
754 #define SLAP_DESC_NONE 0x00U
755 #define SLAP_DESC_BINARY 0x01U
756 #define SLAP_DESC_TAG_RANGE 0x80U
757 } AttributeDescription;
759 typedef struct slap_attr_name {
760 struct berval an_name;
761 AttributeDescription *an_desc;
766 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
767 #define slap_ad_is_tag_range(ad) \
768 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
769 #define slap_ad_is_binary(ad) \
770 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
773 * pointers to schema elements used internally
775 struct slap_internal_schema {
777 ObjectClass *si_oc_top;
778 ObjectClass *si_oc_extensibleObject;
779 ObjectClass *si_oc_alias;
780 ObjectClass *si_oc_referral;
781 ObjectClass *si_oc_rootdse;
782 ObjectClass *si_oc_subentry;
783 ObjectClass *si_oc_subschema;
784 ObjectClass *si_oc_collectiveAttributeSubentry;
785 ObjectClass *si_oc_dynamicObject;
787 ObjectClass *si_oc_glue;
788 ObjectClass *si_oc_syncConsumerSubentry;
789 ObjectClass *si_oc_syncProviderSubentry;
791 /* objectClass attribute descriptions */
792 AttributeDescription *si_ad_objectClass;
794 /* operational attribute descriptions */
795 AttributeDescription *si_ad_structuralObjectClass;
796 AttributeDescription *si_ad_creatorsName;
797 AttributeDescription *si_ad_createTimestamp;
798 AttributeDescription *si_ad_modifiersName;
799 AttributeDescription *si_ad_modifyTimestamp;
800 AttributeDescription *si_ad_hasSubordinates;
801 AttributeDescription *si_ad_subschemaSubentry;
802 AttributeDescription *si_ad_collectiveSubentries;
803 AttributeDescription *si_ad_collectiveExclusions;
804 AttributeDescription *si_ad_entryDN;
805 AttributeDescription *si_ad_entryUUID;
806 AttributeDescription *si_ad_entryCSN;
807 AttributeDescription *si_ad_namingCSN;
809 AttributeDescription *si_ad_dseType;
810 AttributeDescription *si_ad_syncreplCookie;
811 AttributeDescription *si_ad_syncTimestamp;
812 AttributeDescription *si_ad_contextCSN;
814 /* root DSE attribute descriptions */
815 AttributeDescription *si_ad_altServer;
816 AttributeDescription *si_ad_namingContexts;
817 AttributeDescription *si_ad_supportedControl;
818 AttributeDescription *si_ad_supportedExtension;
819 AttributeDescription *si_ad_supportedLDAPVersion;
820 AttributeDescription *si_ad_supportedSASLMechanisms;
821 AttributeDescription *si_ad_supportedFeatures;
822 AttributeDescription *si_ad_monitorContext;
823 AttributeDescription *si_ad_vendorName;
824 AttributeDescription *si_ad_vendorVersion;
825 AttributeDescription *si_ad_configContext;
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 #ifdef LDAP_COMP_MATCH
909 struct slap_component_filter *aa_cf;/* for attribute aliasing */
911 } AttributeAssertion;
913 typedef struct slap_ss_assertion {
914 AttributeDescription *sa_desc;
915 struct berval sa_initial;
916 struct berval *sa_any;
917 struct berval sa_final;
918 } SubstringsAssertion;
920 #ifdef LDAP_COMP_MATCH
921 struct slap_component_filter;
924 typedef struct slap_mr_assertion {
925 MatchingRule *ma_rule; /* optional */
926 struct berval ma_rule_text; /* optional */
927 AttributeDescription *ma_desc; /* optional */
928 int ma_dnattrs; /* boolean */
929 struct berval ma_value; /* required */
930 #ifdef LDAP_COMP_MATCH
931 struct slap_component_filter* ma_cf; /* component filter */
933 } MatchingRuleAssertion;
936 * represents a search filter
938 typedef struct slap_filter {
939 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
940 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
941 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
942 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
943 #ifdef LDAP_SCOPE_SUBORDINATE
944 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
948 /* precomputed result */
949 ber_int_t f_un_result;
952 struct berval *f_un_dn;
955 AttributeDescription *f_un_desc;
957 /* simple value assertion */
958 AttributeAssertion *f_un_ava;
960 /* substring assertion */
961 SubstringsAssertion *f_un_ssa;
963 /* matching rule assertion */
964 MatchingRuleAssertion *f_un_mra;
966 #define f_dn f_un.f_un_dn
967 #define f_desc f_un.f_un_desc
968 #define f_ava f_un.f_un_ava
969 #define f_av_desc f_un.f_un_ava->aa_desc
970 #define f_av_value f_un.f_un_ava->aa_value
971 #define f_sub f_un.f_un_ssa
972 #define f_sub_desc f_un.f_un_ssa->sa_desc
973 #define f_sub_initial f_un.f_un_ssa->sa_initial
974 #define f_sub_any f_un.f_un_ssa->sa_any
975 #define f_sub_final f_un.f_un_ssa->sa_final
976 #define f_mra f_un.f_un_mra
977 #define f_mr_rule f_un.f_un_mra->ma_rule
978 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
979 #define f_mr_desc f_un.f_un_mra->ma_desc
980 #define f_mr_value f_un.f_un_mra->ma_value
981 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
984 struct slap_filter *f_un_complex;
987 #define f_result f_un.f_un_result
988 #define f_and f_un.f_un_complex
989 #define f_or f_un.f_un_complex
990 #define f_not f_un.f_un_complex
991 #define f_list f_un.f_un_complex
993 struct slap_filter *f_next;
996 /* compare routines can return undefined */
997 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
999 typedef struct slap_valuesreturnfilter {
1000 ber_tag_t vrf_choice;
1003 /* precomputed result */
1004 ber_int_t vrf_un_result;
1010 AttributeDescription *vrf_un_desc;
1012 /* simple value assertion */
1013 AttributeAssertion *vrf_un_ava;
1015 /* substring assertion */
1016 SubstringsAssertion *vrf_un_ssa;
1018 /* matching rule assertion */
1019 MatchingRuleAssertion *vrf_un_mra;
1021 #define vrf_result vrf_un.vrf_un_result
1022 #define vrf_dn vrf_un.vrf_un_dn
1023 #define vrf_desc vrf_un.vrf_un_desc
1024 #define vrf_ava vrf_un.vrf_un_ava
1025 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1026 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1027 #define vrf_ssa vrf_un.vrf_un_ssa
1028 #define vrf_sub vrf_un.vrf_un_ssa
1029 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1030 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1031 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1032 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1033 #define vrf_mra vrf_un.vrf_un_mra
1034 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1035 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1036 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1037 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1038 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1043 struct slap_valuesreturnfilter *vrf_next;
1044 } ValuesReturnFilter;
1046 #ifdef LDAP_COMP_MATCH
1047 struct slap_component_syntax_info;
1048 typedef struct slap_component_data {
1049 void* cd_mem_op;/* nibble memory handler */
1050 struct slap_component_syntax_info** cd_tree;/* component tree */
1055 * represents an attribute (description + values)
1057 typedef struct slap_attr {
1058 AttributeDescription *a_desc;
1059 BerVarray a_vals; /* preserved values */
1060 BerVarray a_nvals; /* normalized values */
1061 #ifdef LDAP_COMP_MATCH
1062 ComponentData *a_comp_data; /* component values */
1064 struct slap_attr *a_next;
1066 #define SLAP_ATTR_IXADD 0x1U
1067 #define SLAP_ATTR_IXDEL 0x2U
1072 * the id used in the indexes to refer to an entry
1074 typedef unsigned long ID;
1075 #define NOID ((ID)~0)
1078 * represents an entry in core
1080 typedef struct slap_entry {
1082 * The ID field should only be changed before entry is
1083 * inserted into a cache. The ID value is backend
1088 struct berval e_name; /* name (DN) of this entry */
1089 struct berval e_nname; /* normalized name (DN) of this entry */
1091 /* for migration purposes */
1092 #define e_dn e_name.bv_val
1093 #define e_ndn e_nname.bv_val
1095 Attribute *e_attrs; /* list of attributes + values */
1097 slap_mask_t e_ocflags;
1099 struct berval e_bv; /* For entry_encode/entry_decode */
1101 /* for use by the backend for any purpose */
1106 * A list of LDAPMods
1108 typedef struct slap_mod {
1110 AttributeDescription *sm_desc;
1111 struct berval sm_type;
1112 BerVarray sm_values;
1113 BerVarray sm_nvalues;
1116 typedef struct slap_mod_list {
1117 Modification sml_mod;
1118 #define sml_op sml_mod.sm_op
1119 #define sml_desc sml_mod.sm_desc
1120 #define sml_type sml_mod.sm_type
1121 #define sml_values sml_mod.sm_values
1122 #define sml_nvalues sml_mod.sm_nvalues
1123 struct slap_mod_list *sml_next;
1126 typedef struct slap_ldap_modlist {
1128 struct slap_ldap_modlist *ml_next;
1129 #define ml_op ml_mod.mod_op
1130 #define ml_type ml_mod.mod_type
1131 #define ml_values ml_mod.mod_values
1135 * represents an access control list
1137 typedef enum slap_access_e {
1138 ACL_INVALID_ACCESS = -1,
1149 typedef enum slap_control_e {
1150 ACL_INVALID_CONTROL = 0,
1156 typedef enum slap_style_e {
1157 ACL_STYLE_REGEX = 0,
1164 ACL_STYLE_ANONYMOUS,
1171 typedef struct slap_authz_info {
1172 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1173 struct berval sai_mech; /* SASL Mechanism */
1174 struct berval sai_dn; /* DN for reporting purposes */
1175 struct berval sai_ndn; /* Normalized DN */
1177 /* Security Strength Factors */
1178 slap_ssf_t sai_ssf; /* Overall SSF */
1179 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1180 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1181 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1182 } AuthorizationInformation;
1189 * "dynamic" ACL infrastructure (for ACIs and more)
1191 typedef int (slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1192 typedef int (slap_dynacl_unparse)( void *priv, struct berval *bv );
1193 typedef int (slap_dynacl_mask)(
1197 AttributeDescription *desc,
1200 regmatch_t *matches,
1201 slap_access_t *grant,
1202 slap_access_t *deny );
1203 typedef int (slap_dynacl_destroy)( void *priv );
1205 typedef struct slap_dynacl_t {
1207 slap_dynacl_parse *da_parse;
1208 slap_dynacl_unparse *da_unparse;
1209 slap_dynacl_mask *da_mask;
1210 slap_dynacl_destroy *da_destroy;
1213 struct slap_dynacl_t *da_next;
1215 #endif /* SLAP_DYNACL */
1218 typedef struct slap_access {
1219 slap_control_t a_type;
1221 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1223 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1224 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1225 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1226 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1227 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1228 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1229 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1230 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1232 #define ACL_PRIV_MASK 0x00ffUL
1235 #define ACL_PRIV_LEVEL 0x1000UL
1236 #define ACL_PRIV_ADDITIVE 0x2000UL
1237 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1240 #define ACL_PRIV_INVALID 0x0UL
1242 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1243 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1244 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1245 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1247 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1248 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1250 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1252 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1254 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1255 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1256 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1258 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1259 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1260 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1261 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1262 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1263 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1264 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1265 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1267 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1268 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1269 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1270 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1271 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1272 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1273 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1274 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1275 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1277 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1278 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1279 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1280 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1281 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1282 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1283 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1284 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1286 slap_mask_t a_access_mask;
1288 AuthorizationInformation a_authz;
1289 #define a_dn_pat a_authz.sai_dn
1291 slap_style_t a_dn_style;
1292 AttributeDescription *a_dn_at;
1296 slap_style_t a_peername_style;
1297 struct berval a_peername_pat;
1298 unsigned long a_peername_addr,
1300 int a_peername_port;
1302 slap_style_t a_sockname_style;
1303 struct berval a_sockname_pat;
1305 slap_style_t a_domain_style;
1306 struct berval a_domain_pat;
1307 int a_domain_expand;
1309 slap_style_t a_sockurl_style;
1310 struct berval a_sockurl_pat;
1311 slap_style_t a_set_style;
1312 struct berval a_set_pat;
1315 slap_dynacl_t *a_dynacl;
1316 #else /* ! SLAP_DYNACL */
1317 #ifdef SLAPD_ACI_ENABLED
1318 AttributeDescription *a_aci_at;
1320 #endif /* SLAP_DYNACL */
1323 slap_style_t a_group_style;
1324 struct berval a_group_pat;
1325 ObjectClass *a_group_oc;
1326 AttributeDescription *a_group_at;
1328 struct slap_access *a_next;
1332 typedef struct slap_acl {
1333 /* "to" part: the entries this acl applies to */
1335 slap_style_t acl_dn_style;
1337 struct berval acl_dn_pat;
1338 AttributeName *acl_attrs;
1339 slap_style_t acl_attrval_style;
1340 regex_t acl_attrval_re;
1341 struct berval acl_attrval;
1343 /* "by" part: list of who has what access to the entries */
1346 struct slap_acl *acl_next;
1349 typedef struct slap_acl_state {
1350 unsigned as_recorded;
1351 #define ACL_STATE_NOT_RECORDED 0x0
1352 #define ACL_STATE_RECORDED_VD 0x1
1353 #define ACL_STATE_RECORDED_NV 0x2
1354 #define ACL_STATE_RECORDED 0x3
1357 AccessControl *as_vd_acl;
1358 AccessControl *as_vi_acl;
1359 slap_mask_t as_vd_acl_mask;
1360 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1361 int as_vd_acl_count;
1363 Access *as_vd_access;
1364 int as_vd_access_count;
1367 AttributeDescription *as_vd_ad;
1368 } AccessControlState;
1369 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1370 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1374 * represents a backend
1377 typedef struct slap_backend_info BackendInfo; /* per backend type */
1378 typedef struct slap_backend_db BackendDB; /* per backend database */
1380 LDAP_SLAPD_V (int) nBackendInfo;
1381 LDAP_SLAPD_V (int) nBackendDB;
1382 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1383 LDAP_SLAPD_V (BackendDB *) backendDB;
1384 LDAP_SLAPD_V (BackendDB *) frontendDB;
1386 LDAP_SLAPD_V (int) slapMode;
1387 #define SLAP_UNDEFINED_MODE 0x0000
1388 #define SLAP_SERVER_MODE 0x0001
1389 #define SLAP_TOOL_MODE 0x0002
1390 #define SLAP_MODE 0x0003
1392 #define SLAP_TRUNCATE_MODE 0x0100
1393 #define SLAP_TOOL_READMAIN 0x0200
1394 #define SLAP_TOOL_READONLY 0x0400
1395 #define SLAP_TOOL_QUICK 0x0800
1397 #define SB_TLS_OFF 0
1399 #define SB_TLS_CRITICAL 2
1401 typedef struct slap_bindconf {
1413 struct slap_replica_info {
1414 const char *ri_uri; /* supersedes be_replica */
1415 const char *ri_host; /* points to host part of uri */
1416 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1417 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1418 int ri_exclude; /* 1 => exclude ri_attrs */
1419 slap_bindconf ri_bindconf; /* for back-config */
1422 typedef struct slap_verbmasks {
1427 #define SLAP_LIMIT_TIME 1
1428 #define SLAP_LIMIT_SIZE 2
1430 struct slap_limits_set {
1438 int lms_s_unchecked;
1444 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1445 #define SLAP_NO_LIMIT -1
1446 #define SLAP_MAX_LIMIT 2147483647
1448 struct slap_limits {
1449 unsigned lm_flags; /* type of pattern */
1450 #define SLAP_LIMITS_UNDEFINED 0x0000U
1451 #define SLAP_LIMITS_EXACT 0x0001U
1452 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1453 #define SLAP_LIMITS_ONE 0x0002U
1454 #define SLAP_LIMITS_SUBTREE 0x0003U
1455 #define SLAP_LIMITS_CHILDREN 0x0004U
1456 #define SLAP_LIMITS_REGEX 0x0005U
1457 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1458 #define SLAP_LIMITS_USERS 0x0007U
1459 #define SLAP_LIMITS_ANY 0x0008U
1460 #define SLAP_LIMITS_MASK 0x000FU
1462 #define SLAP_LIMITS_TYPE_DN 0x0000U
1463 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1464 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1466 regex_t lm_regex; /* regex data for REGEX */
1469 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1470 * pattern for REGEX; NULL for ANONYMOUS, USERS
1472 struct berval lm_pat;
1474 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1475 * lm_group_oc is objectClass and lm_group_at is attributeType
1476 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1477 * can only be SLAP_LIMITS_EXACT */
1478 ObjectClass *lm_group_oc;
1479 AttributeDescription *lm_group_ad;
1481 struct slap_limits_set lm_limits;
1484 /* temporary aliases */
1485 typedef BackendDB Backend;
1486 #define nbackends nBackendDB
1487 #define backends backendDB
1490 * syncinfo structure for syncrepl
1493 #define SLAP_SYNC_RID_SIZE 3
1494 #define SLAP_SYNCUUID_SET_SIZE 256
1496 #define SLAP_SYNC_UPDATE_MSGID 2
1498 struct nonpresent_entry {
1499 struct berval *npe_name;
1500 struct berval *npe_nname;
1501 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1504 struct sync_cookie {
1505 struct berval ctxcsn;
1506 struct berval octet_str;
1508 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1511 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1513 typedef struct syncinfo_s {
1514 struct slap_backend_db *si_be;
1516 struct berval si_provideruri;
1517 slap_bindconf si_bindconf;
1518 struct berval si_filterstr;
1519 struct berval si_base;
1523 AttributeName *si_anlist;
1524 AttributeName *si_exanlist;
1529 int si_schemachecking;
1532 time_t *si_retryinterval;
1533 int *si_retrynum_init;
1535 struct sync_cookie si_syncCookie;
1539 int si_refreshDelete;
1540 int si_refreshPresent;
1541 Avlnode *si_presentlist;
1543 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1544 ldap_pvt_thread_mutex_t si_mutex;
1547 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1549 #ifndef SLAP_MAX_CIDS
1550 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1553 struct slap_backend_db {
1554 BackendInfo *bd_info; /* pointer to shared backend info */
1556 /* fields in this structure (and routines acting on this structure)
1557 should be renamed from be_ to bd_ */
1559 /* BackendInfo accessors */
1560 #define be_config bd_info->bi_db_config
1561 #define be_type bd_info->bi_type
1563 #define be_bind bd_info->bi_op_bind
1564 #define be_unbind bd_info->bi_op_unbind
1565 #define be_add bd_info->bi_op_add
1566 #define be_compare bd_info->bi_op_compare
1567 #define be_delete bd_info->bi_op_delete
1568 #define be_modify bd_info->bi_op_modify
1569 #define be_modrdn bd_info->bi_op_modrdn
1570 #define be_search bd_info->bi_op_search
1571 #define be_abandon bd_info->bi_op_abandon
1572 #define be_cancel bd_info->bi_op_cancel
1574 #define be_extended bd_info->bi_extended
1576 #define be_chk_referrals bd_info->bi_chk_referrals
1577 #define be_chk_controls bd_info->bi_chk_controls
1578 #define be_fetch bd_info->bi_entry_get_rw
1579 #define be_release bd_info->bi_entry_release_rw
1580 #define be_group bd_info->bi_acl_group
1581 #define be_attribute bd_info->bi_acl_attribute
1582 #define be_operational bd_info->bi_operational
1585 * define to honor hasSubordinates operational attribute in search filters
1586 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1589 #define be_has_subordinates bd_info->bi_has_subordinates
1591 #define be_connection_init bd_info->bi_connection_init
1592 #define be_connection_destroy bd_info->bi_connection_destroy
1595 #define be_entry_open bd_info->bi_tool_entry_open
1596 #define be_entry_close bd_info->bi_tool_entry_close
1597 #define be_entry_first bd_info->bi_tool_entry_first
1598 #define be_entry_next bd_info->bi_tool_entry_next
1599 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1600 #define be_entry_get bd_info->bi_tool_entry_get
1601 #define be_entry_put bd_info->bi_tool_entry_put
1602 #define be_sync bd_info->bi_tool_sync
1603 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1604 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1605 #define be_entry_modify bd_info->bi_tool_entry_modify
1608 /* supported controls */
1609 /* note: set to 0 if the database does not support the control;
1610 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1611 char be_ctrls[SLAP_MAX_CIDS + 1];
1613 /* Database flags */
1614 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1615 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1616 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1617 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1618 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1619 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1620 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1621 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1622 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1623 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1624 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1625 slap_mask_t be_flags;
1626 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1627 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1628 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1629 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1630 #define SLAP_NO_SCHEMA_CHECK(be) \
1631 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1632 #define SLAP_GLUE_INSTANCE(be) \
1633 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1634 #define SLAP_GLUE_SUBORDINATE(be) \
1635 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1636 #define SLAP_GLUE_LINKED(be) \
1637 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1638 #define SLAP_GLUE_ADVERTISE(be) \
1639 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1640 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1641 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1642 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1644 slap_mask_t be_restrictops; /* restriction operations */
1645 #define SLAP_RESTRICT_OP_ADD 0x0001U
1646 #define SLAP_RESTRICT_OP_BIND 0x0002U
1647 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1648 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1649 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1650 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1651 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1652 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1653 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1655 #define SLAP_RESTRICT_READONLY 0x80000000U
1657 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1658 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1659 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1660 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1661 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1663 #define SLAP_RESTRICT_OP_READS \
1664 ( SLAP_RESTRICT_OP_COMPARE \
1665 | SLAP_RESTRICT_OP_SEARCH )
1666 #define SLAP_RESTRICT_OP_WRITES \
1667 ( SLAP_RESTRICT_OP_ADD \
1668 | SLAP_RESTRICT_OP_DELETE \
1669 | SLAP_RESTRICT_OP_MODIFY \
1670 | SLAP_RESTRICT_OP_RENAME )
1672 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1673 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1674 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1676 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1678 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1679 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1680 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1682 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1683 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1685 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1687 slap_mask_t be_requires; /* pre-operation requirements */
1688 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1689 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1690 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1691 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1692 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1694 /* Required Security Strength Factor */
1695 slap_ssf_set_t be_ssf_set;
1697 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1698 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1699 struct berval be_schemadn; /* per-backend subschema subentry DN */
1700 struct berval be_schemandn; /* normalized subschema DN */
1701 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1702 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1703 struct berval be_rootpw; /* the magic "root" password for this db */
1704 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1705 #define be_sizelimit be_def_limit.lms_s_soft
1706 #define be_timelimit be_def_limit.lms_t_soft
1707 struct slap_limits_set be_def_limit; /* default limits */
1708 struct slap_limits **be_limits; /* regex-based size and time limits */
1709 AccessControl *be_acl; /* access control list for this backend */
1710 slap_access_t be_dfltaccess; /* access given if no acl matches */
1712 /* Replica Information */
1713 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1714 char *be_replogfile; /* replication log file (in master) */
1715 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1716 BerVarray be_update_refs; /* where to refer modifying clients to */
1717 struct be_pcl *be_pending_csn_list;
1718 ldap_pvt_thread_mutex_t be_pcl_mutex;
1719 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1720 syncinfo_t *be_syncinfo; /* For syncrepl */
1722 void *be_pb; /* Netscape plugin */
1723 struct ConfigTable *be_cf_table;
1725 void *be_private; /* anything the backend database needs */
1731 /* Backend function typedefs */
1732 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1733 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1734 const char *fname, int lineno,
1735 int argc, char **argv));
1736 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1737 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1738 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1740 typedef int (BI_db_init) LDAP_P((Backend *bd));
1741 typedef int (BI_db_config) LDAP_P((Backend *bd,
1742 const char *fname, int lineno,
1743 int argc, char **argv));
1744 typedef int (BI_db_open) LDAP_P((Backend *bd));
1745 typedef int (BI_db_close) LDAP_P((Backend *bd));
1746 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1748 typedef struct req_bind_s {
1750 struct berval rb_cred;
1751 struct berval rb_edn;
1753 struct berval rb_tmp_mech; /* FIXME: temporary */
1756 typedef struct req_search_s {
1761 /* NULL means be_isroot evaluated to TRUE */
1762 struct slap_limits_set *rs_limit;
1764 AttributeName *rs_attrs;
1766 struct berval rs_filterstr;
1769 typedef struct req_compare_s {
1770 AttributeAssertion *rs_ava;
1773 typedef struct req_modify_s {
1774 Modifications *rs_modlist;
1775 int rs_increment; /* FIXME: temporary */
1778 typedef struct req_modrdn_s {
1779 struct berval rs_newrdn;
1780 struct berval rs_nnewrdn;
1781 struct berval *rs_newSup;
1782 struct berval *rs_nnewSup;
1783 int rs_deleteoldrdn;
1786 typedef struct req_add_s {
1788 Modifications *rs_modlist; /* FIXME: temporary */
1791 typedef struct req_abandon_s {
1796 #define SLAP_EXOP_HIDE 0x0000
1798 #define SLAP_EXOP_HIDE 0x8000
1800 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1802 typedef struct req_extended_s {
1803 struct berval rs_reqoid;
1805 struct berval *rs_reqdata;
1808 typedef struct req_pwdexop_s {
1809 struct berval rs_reqoid;
1811 struct berval rs_old;
1812 struct berval rs_new;
1813 Modifications *rs_mods;
1814 Modifications **rs_modtail;
1817 typedef enum slap_reply_e {
1826 typedef struct rep_sasl_s {
1827 struct berval *r_sasldata;
1830 typedef struct rep_extended_s {
1831 const char *r_rspoid;
1832 struct berval *r_rspdata;
1835 typedef struct rep_search_s {
1837 slap_mask_t r_attr_flags;
1838 #define SLAP_ATTRS_UNDEFINED (0x00U)
1839 #define SLAP_OPATTRS_NO (0x01U)
1840 #define SLAP_OPATTRS_YES (0x02U)
1841 #define SLAP_USERATTRS_NO (0x10U)
1842 #define SLAP_USERATTRS_YES (0x20U)
1843 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1844 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1845 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1846 #define SLAP_USERATTRS(f) \
1847 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1849 Attribute *r_operational_attrs;
1850 AttributeName *r_attrs;
1855 typedef struct slap_rep {
1856 slap_reply_t sr_type;
1860 const char *sr_matched;
1861 const char *sr_text;
1863 LDAPControl **sr_ctrls;
1865 rep_sasl_s sru_sasl;
1866 rep_extended_s sru_extended;
1867 rep_search_s sru_search;
1869 slap_mask_t sr_flags;
1870 #define REP_ENTRY_MODIFIABLE 0x0001U
1871 #define REP_ENTRY_MUSTBEFREED 0x0002U
1872 #define REP_MATCHED_MUSTBEFREED 0x0010U
1873 #define REP_REF_MUSTBEFREED 0x0020U
1876 /* short hands for response members */
1877 #define sr_attrs sr_un.sru_search.r_attrs
1878 #define sr_entry sr_un.sru_search.r_entry
1879 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1880 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1881 #define sr_v2ref sr_un.sru_search.r_v2ref
1882 #define sr_nentries sr_un.sru_search.r_nentries
1883 #define sr_rspoid sr_un.sru_extended.r_rspoid
1884 #define sr_rspdata sr_un.sru_extended.r_rspdata
1885 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1887 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1888 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1889 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1890 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1891 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1892 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1893 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1894 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1895 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1896 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1897 typedef int (BI_op_extended) LDAP_P((
1898 struct slap_op *op, struct slap_rep *rs ));
1899 typedef int (BI_chk_referrals) LDAP_P((
1900 struct slap_op *op, struct slap_rep *rs ));
1901 typedef int (BI_chk_controls) LDAP_P((
1902 struct slap_op *op, struct slap_rep *rs ));
1903 typedef int (BI_entry_release_rw)
1904 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1905 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1906 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1907 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1908 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1909 Entry *e, int *hasSubs ));
1911 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1912 struct slap_conn *c ));
1913 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1914 struct slap_conn *c ));
1916 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1917 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1918 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1919 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1920 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1921 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1922 struct berval *text ));
1923 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1924 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1925 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1926 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1927 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1928 struct berval *text ));
1930 struct ConfigTable; /* config.h */
1932 struct slap_backend_info {
1933 char *bi_type; /* type of backend */
1936 * per backend type routines:
1937 * bi_init: called to allocate a backend_info structure,
1938 * called once BEFORE configuration file is read.
1939 * bi_init() initializes this structure hence is
1940 * called directly from be_initialize()
1941 * bi_config: called per 'backend' specific option
1942 * all such options must before any 'database' options
1943 * bi_config() is called only from read_config()
1944 * bi_open: called to open each database, called
1945 * once AFTER configuration file is read but
1946 * BEFORE any bi_db_open() calls.
1947 * bi_open() is called from backend_startup()
1948 * bi_close: called to close each database, called
1949 * once during shutdown after all bi_db_close calls.
1950 * bi_close() is called from backend_shutdown()
1951 * bi_destroy: called to destroy each database, called
1952 * once during shutdown after all bi_db_destroy calls.
1953 * bi_destory() is called from backend_destroy()
1956 BI_config *bi_config;
1959 BI_destroy *bi_destroy;
1962 * per database routines:
1963 * bi_db_init: called to initialize each database,
1964 * called upon reading 'database <type>'
1965 * called only from backend_db_init()
1966 * bi_db_config: called to configure each database,
1967 * called per database to handle per database options
1968 * called only from read_config()
1969 * bi_db_open: called to open each database
1970 * called once per database immediately AFTER bi_open()
1971 * calls but before daemon startup.
1972 * called only by backend_startup()
1973 * bi_db_close: called to close each database
1974 * called once per database during shutdown but BEFORE
1975 * any bi_close call.
1976 * called only by backend_shutdown()
1977 * bi_db_destroy: called to destroy each database
1978 * called once per database during shutdown AFTER all
1979 * bi_close calls but before bi_destory calls.
1980 * called only by backend_destory()
1982 BI_db_init *bi_db_init;
1983 BI_db_config *bi_db_config;
1984 BI_db_open *bi_db_open;
1985 BI_db_close *bi_db_close;
1986 BI_db_destroy *bi_db_destroy;
1988 /* LDAP Operations Handling Routines */
1989 BI_op_bind *bi_op_bind;
1990 BI_op_unbind *bi_op_unbind;
1991 BI_op_search *bi_op_search;
1992 BI_op_compare *bi_op_compare;
1993 BI_op_modify *bi_op_modify;
1994 BI_op_modrdn *bi_op_modrdn;
1995 BI_op_add *bi_op_add;
1996 BI_op_delete *bi_op_delete;
1997 BI_op_abandon *bi_op_abandon;
1998 BI_op_cancel *bi_op_cancel;
2000 /* Extended Operations Helper */
2001 BI_op_extended *bi_extended;
2003 /* Auxilary Functions */
2004 BI_operational *bi_operational;
2005 BI_chk_referrals *bi_chk_referrals;
2006 BI_chk_controls *bi_chk_controls;
2007 BI_entry_get_rw *bi_entry_get_rw;
2008 BI_entry_release_rw *bi_entry_release_rw;
2010 BI_has_subordinates *bi_has_subordinates;
2012 BI_connection_init *bi_connection_init;
2013 BI_connection_destroy *bi_connection_destroy;
2015 /* hooks for slap tools */
2016 BI_tool_entry_open *bi_tool_entry_open;
2017 BI_tool_entry_close *bi_tool_entry_close;
2018 BI_tool_entry_first *bi_tool_entry_first;
2019 BI_tool_entry_next *bi_tool_entry_next;
2020 BI_tool_entry_get *bi_tool_entry_get;
2021 BI_tool_entry_put *bi_tool_entry_put;
2022 BI_tool_entry_reindex *bi_tool_entry_reindex;
2023 BI_tool_sync *bi_tool_sync;
2024 BI_tool_dn2id_get *bi_tool_dn2id_get;
2025 BI_tool_id2entry_get *bi_tool_id2entry_get;
2026 BI_tool_entry_modify *bi_tool_entry_modify;
2028 #define SLAP_INDEX_ADD_OP 0x0001
2029 #define SLAP_INDEX_DELETE_OP 0x0002
2031 slap_mask_t bi_flags; /* backend flags */
2032 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2033 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2034 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2035 #define SLAP_BFLAG_INCREMENT 0x0100U
2036 #define SLAP_BFLAG_ALIASES 0x1000U
2037 #define SLAP_BFLAG_REFERRALS 0x2000U
2038 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2039 #define SLAP_BFLAG_DYNAMIC 0x8000U
2041 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2042 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2043 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2044 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2045 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2046 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2047 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2048 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2049 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2050 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2052 char **bi_controls; /* supported controls */
2053 char bi_ctrls[SLAP_MAX_CIDS + 1];
2055 unsigned int bi_nDB; /* number of databases of this type */
2056 struct ConfigTable *bi_cf_table;
2057 void *bi_private; /* anything the backend type needs */
2060 #define c_authtype c_authz.sai_method
2061 #define c_authmech c_authz.sai_mech
2062 #define c_dn c_authz.sai_dn
2063 #define c_ndn c_authz.sai_ndn
2064 #define c_ssf c_authz.sai_ssf
2065 #define c_transport_ssf c_authz.sai_transport_ssf
2066 #define c_tls_ssf c_authz.sai_tls_ssf
2067 #define c_sasl_ssf c_authz.sai_sasl_ssf
2069 #define o_authtype o_authz.sai_method
2070 #define o_authmech o_authz.sai_mech
2071 #define o_dn o_authz.sai_dn
2072 #define o_ndn o_authz.sai_ndn
2073 #define o_ssf o_authz.sai_ssf
2074 #define o_transport_ssf o_authz.sai_transport_ssf
2075 #define o_tls_ssf o_authz.sai_tls_ssf
2076 #define o_sasl_ssf o_authz.sai_sasl_ssf
2078 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2080 typedef struct slap_callback {
2081 struct slap_callback *sc_next;
2082 slap_response *sc_response;
2083 slap_response *sc_cleanup;
2087 struct slap_overinfo;
2089 typedef struct slap_overinst {
2091 slap_response *on_response;
2092 struct slap_overinfo *on_info;
2093 struct slap_overinst *on_next;
2096 typedef struct slap_overinfo {
2098 BackendInfo *oi_orig;
2099 struct slap_overinst *oi_list;
2102 /* Should successive callbacks in a chain be processed? */
2103 #define SLAP_CB_FREEME 0x4000
2104 #define SLAP_CB_CONTINUE 0x8000
2107 * Paged Results state
2109 typedef unsigned long PagedResultsCookie;
2110 typedef struct slap_paged_state {
2113 PagedResultsCookie ps_cookie;
2115 } PagedResultsState;
2117 struct slap_csn_entry {
2118 struct berval ce_csn;
2119 unsigned long ce_opid;
2120 unsigned long ce_connid;
2121 #define SLAP_CSN_PENDING 1
2122 #define SLAP_CSN_COMMIT 2
2124 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2128 * Caches the result of a backend_group check for ACL evaluation
2130 typedef struct slap_gacl {
2131 struct slap_gacl *ga_next;
2134 AttributeDescription *ga_at;
2140 struct slap_control_ids {
2146 int sc_modifyIncrement;
2148 int sc_pagedResults;
2149 int sc_valuesReturnFilter;
2150 int sc_permissiveModify;
2153 int sc_searchOptions;
2159 * represents an operation pending from an ldap client
2161 typedef struct slap_op_header {
2162 unsigned long oh_opid; /* id of this operation */
2163 unsigned long oh_connid; /* id of conn initiating this op */
2164 struct slap_conn *oh_conn; /* connection spawning this op */
2166 ber_int_t oh_msgid; /* msgid of the request */
2167 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2169 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2171 void *oh_threadctx; /* thread pool thread context */
2172 void *oh_tmpmemctx; /* slab malloc context */
2173 BerMemoryFunctions *oh_tmpmfuncs;
2175 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2178 void *oh_pb; /* NS-SLAPI plugin */
2179 void *oh_extensions; /* NS-SLAPI plugin */
2183 typedef struct slap_op {
2186 #define o_opid o_hdr->oh_opid
2187 #define o_connid o_hdr->oh_connid
2188 #define o_conn o_hdr->oh_conn
2189 #define o_msgid o_hdr->oh_msgid
2190 #define o_protocol o_hdr->oh_protocol
2191 #define o_tid o_hdr->oh_tid
2192 #define o_threadctx o_hdr->oh_threadctx
2193 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2194 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2196 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2197 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2198 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2199 #define o_tmpfree o_tmpmfuncs->bmf_free
2201 #define o_log_prefix o_hdr->oh_log_prefix
2204 #define o_pb o_hdr->oh_pb
2205 #define o_extensions o_hdr->oh_extensions
2208 ber_tag_t o_tag; /* tag of the request */
2209 time_t o_time; /* time op was initiated */
2211 BackendDB *o_bd; /* backend DB processing this op */
2212 struct berval o_req_dn; /* DN of target of request */
2213 struct berval o_req_ndn;
2218 req_compare_s oq_compare;
2219 req_modify_s oq_modify;
2220 req_modrdn_s oq_modrdn;
2221 req_search_s oq_search;
2222 req_abandon_s oq_abandon;
2223 req_abandon_s oq_cancel;
2224 req_extended_s oq_extended;
2225 req_pwdexop_s oq_pwdexop;
2228 /* short hands for union members */
2229 #define oq_add o_request.oq_add
2230 #define oq_bind o_request.oq_bind
2231 #define oq_compare o_request.oq_compare
2232 #define oq_modify o_request.oq_modify
2233 #define oq_modrdn o_request.oq_modrdn
2234 #define oq_search o_request.oq_search
2235 #define oq_abandon o_request.oq_abandon
2236 #define oq_cancel o_request.oq_cancel
2237 #define oq_extended o_request.oq_extended
2238 #define oq_pwdexop o_request.oq_pwdexop
2240 /* short hands for inner request members */
2241 #define orb_method oq_bind.rb_method
2242 #define orb_cred oq_bind.rb_cred
2243 #define orb_edn oq_bind.rb_edn
2244 #define orb_ssf oq_bind.rb_ssf
2245 #define orb_tmp_mech oq_bind.rb_tmp_mech
2247 #define ors_scope oq_search.rs_scope
2248 #define ors_deref oq_search.rs_deref
2249 #define ors_slimit oq_search.rs_slimit
2250 #define ors_tlimit oq_search.rs_tlimit
2251 #define ors_limit oq_search.rs_limit
2252 #define ors_attrsonly oq_search.rs_attrsonly
2253 #define ors_attrs oq_search.rs_attrs
2254 #define ors_filter oq_search.rs_filter
2255 #define ors_filterstr oq_search.rs_filterstr
2257 #define orr_newrdn oq_modrdn.rs_newrdn
2258 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2259 #define orr_newSup oq_modrdn.rs_newSup
2260 #define orr_nnewSup oq_modrdn.rs_nnewSup
2261 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2263 #define orc_ava oq_compare.rs_ava
2264 #define ora_e oq_add.rs_e
2265 #define ora_modlist oq_add.rs_modlist
2266 #define orn_msgid oq_abandon.rs_msgid
2267 #define orm_modlist oq_modify.rs_modlist
2268 #define orm_increment oq_modify.rs_increment
2270 #define ore_reqoid oq_extended.rs_reqoid
2271 #define ore_flags oq_extended.rs_flags
2272 #define ore_reqdata oq_extended.rs_reqdata
2273 volatile sig_atomic_t o_abandon; /* abandon flag */
2274 volatile sig_atomic_t o_cancel; /* cancel flag */
2275 #define SLAP_CANCEL_NONE 0x00
2276 #define SLAP_CANCEL_REQ 0x01
2277 #define SLAP_CANCEL_ACK 0x02
2278 #define SLAP_CANCEL_DONE 0x03
2280 GroupAssertion *o_groups;
2281 char o_do_not_cache; /* don't cache groups from this op */
2282 char o_is_auth_check; /* authorization in progress */
2284 #define SLAP_CONTROL_NONE 0
2285 #define SLAP_CONTROL_IGNORED 1
2286 #define SLAP_CONTROL_NONCRITICAL 2
2287 #define SLAP_CONTROL_CRITICAL 3
2288 #define SLAP_CONTROL_MASK 3
2290 /* spare bits for simple flags */
2291 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2292 #define SLAP_CONTROL_DATA0 0x10
2293 #define SLAP_CONTROL_DATA1 0x20
2294 #define SLAP_CONTROL_DATA2 0x40
2295 #define SLAP_CONTROL_DATA3 0x80
2298 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2300 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2301 void **o_controls; /* per-control state */
2303 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2304 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2306 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2307 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2308 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2310 #define get_subentries(op) _SCM((op)->o_subentries)
2311 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2313 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2314 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2316 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2317 #define get_assert(op) ((int)(op)->o_assert)
2318 #define o_assertion o_controls[slap_cids.sc_assert]
2319 #define get_assertion(op) ((op)->o_assertion)
2321 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2322 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2324 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2325 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2326 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2328 #define get_permissiveModify(op) (0)
2331 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2332 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2333 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2335 #define get_domainScope(op) (0)
2338 #ifdef LDAP_CONTROL_X_TREE_DELETE
2339 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2340 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2342 #define get_treeDelete(op) (0)
2345 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2346 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2348 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2349 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2351 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2352 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2354 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2356 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2358 AuthorizationInformation o_authz;
2360 BerElement *o_ber; /* ber of the request */
2361 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2362 slap_callback *o_callback; /* callback pointers */
2363 LDAPControl **o_ctrls; /* controls */
2365 void *o_private; /* anything the backend needs */
2367 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2370 int o_delete_glue_parent;
2373 #define OPERATION_BUFFER_SIZE (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2375 #define send_ldap_error( op, rs, err, text ) do { \
2376 (rs)->sr_err = err; (rs)->sr_text = text; \
2377 (op->o_conn->c_send_ldap_result)( op, rs ); \
2379 #define send_ldap_discon( op, rs, err, text ) do { \
2380 (rs)->sr_err = err; (rs)->sr_text = text; \
2381 send_ldap_disconnect( op, rs ); \
2384 typedef void (SEND_LDAP_RESULT)(
2385 struct slap_op *op, struct slap_rep *rs);
2386 typedef int (SEND_SEARCH_ENTRY)(
2387 struct slap_op *op, struct slap_rep *rs);
2388 typedef int (SEND_SEARCH_REFERENCE)(
2389 struct slap_op *op, struct slap_rep *rs);
2390 typedef void (SEND_LDAP_EXTENDED)(
2391 struct slap_op *op, struct slap_rep *rs);
2392 typedef void (SEND_LDAP_INTERMEDIATE)(
2393 struct slap_op *op, struct slap_rep *rs);
2395 #define send_ldap_result( op, rs ) \
2396 ((op)->o_conn->c_send_ldap_result)( op, rs )
2397 #define send_search_entry( op, rs ) \
2398 ((op)->o_conn->c_send_search_entry)( op, rs )
2399 #define send_search_reference( op, rs ) \
2400 ((op)->o_conn->c_send_search_reference)( op, rs )
2401 #define send_ldap_extended( op, rs ) \
2402 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2403 #define send_ldap_intermediate( op, rs ) \
2404 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2406 typedef struct slap_listener Listener;
2409 * represents a connection from an ldap client
2411 typedef struct slap_conn {
2412 int c_struct_state; /* structure management state */
2413 int c_conn_state; /* connection state */
2414 int c_conn_idx; /* slot in connections array */
2416 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2417 Sockbuf *c_sb; /* ber connection stuff */
2419 /* only can be changed by connect_init */
2420 time_t c_starttime; /* when the connection was opened */
2421 time_t c_activitytime; /* when the connection was last used */
2422 unsigned long c_connid; /* id of this connection for stats*/
2424 struct berval c_peer_domain; /* DNS name of client */
2425 struct berval c_peer_name; /* peer name (trans=addr:port) */
2426 Listener *c_listener;
2427 #define c_listener_url c_listener->sl_url /* listener URL */
2428 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2430 /* only can be changed by binding thread */
2431 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2432 struct berval c_sasl_bind_mech; /* mech in progress */
2433 struct berval c_sasl_dn; /* temporary storage */
2435 /* authorization backend */
2436 Backend *c_authz_backend;
2438 AuthorizationInformation c_authz;
2440 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2442 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2443 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2445 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2446 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2448 BerElement *c_currentber; /* ber we're attempting to read */
2449 int c_writewaiter; /* true if writer is waiting */
2451 #define CONN_IS_TLS 1
2452 #define CONN_IS_UDP 2
2453 #define CONN_IS_CLIENT 3
2455 #ifdef LDAP_CONNECTIONLESS
2456 int c_is_udp; /* true if this is (C)LDAP over UDP */
2459 int c_is_tls; /* true if this LDAP over raw TLS */
2460 int c_needs_tls_accept; /* true if SSL_accept should be called */
2462 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2463 int c_sasl_done; /* SASL completed once */
2464 void *c_sasl_authctx; /* SASL authentication context */
2465 void *c_sasl_sockctx; /* SASL security layer context */
2466 void *c_sasl_extra; /* SASL session extra stuff */
2467 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2469 PagedResultsState c_pagedresults_state; /* paged result state */
2471 long c_n_ops_received; /* num of ops received (next op_id) */
2472 long c_n_ops_executing; /* num of ops currently executing */
2473 long c_n_ops_pending; /* num of ops pending execution */
2474 long c_n_ops_completed; /* num of ops completed */
2476 long c_n_get; /* num of get calls */
2477 long c_n_read; /* num of read calls */
2478 long c_n_write; /* num of write calls */
2480 void *c_pb; /* Netscape plugin */
2481 void *c_extensions; /* Netscape plugin */
2484 * Client connection handling
2486 ldap_pvt_thread_start_t *c_clientfunc;
2490 * These are the "callbacks" that are available for back-ends to
2491 * supply data back to connected clients that are connected
2492 * through the "front-end".
2494 SEND_LDAP_RESULT *c_send_ldap_result;
2495 SEND_SEARCH_ENTRY *c_send_search_entry;
2496 SEND_SEARCH_REFERENCE *c_send_search_reference;
2497 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2498 #ifdef LDAP_RES_INTERMEDIATE
2499 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2504 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2505 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2507 if ( ldap_debug & (level) ) \
2508 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2509 if ( ldap_syslog & (level) ) \
2510 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2513 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2514 #elif defined(LDAP_DEBUG)
2515 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2517 if ( ldap_debug & (level) ) \
2518 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2520 #define StatslogTest( level ) (ldap_debug & (level))
2522 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2523 #define StatslogTest( level ) (0)
2527 * listener; need to access it from monitor backend
2529 struct slap_listener {
2530 struct berval sl_url;
2531 struct berval sl_name;
2536 #ifdef LDAP_CONNECTIONLESS
2537 int sl_is_udp; /* UDP listener is also data port */
2539 int sl_is_mute; /* Listening is temporarily disabled */
2542 #define sl_addr sl_sa.sa_in_addr
2545 #ifdef SLAPD_MONITOR
2562 #endif /* SLAPD_MONITOR */
2564 typedef struct slap_counters_t {
2565 ldap_pvt_thread_mutex_t sc_sent_mutex;
2566 ldap_pvt_mp_t sc_bytes;
2567 ldap_pvt_mp_t sc_pdu;
2568 ldap_pvt_mp_t sc_entries;
2569 ldap_pvt_mp_t sc_refs;
2571 ldap_pvt_thread_mutex_t sc_ops_mutex;
2572 ldap_pvt_mp_t sc_ops_completed;
2573 ldap_pvt_mp_t sc_ops_initiated;
2574 #ifdef SLAPD_MONITOR
2575 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2576 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2577 #endif /* SLAPD_MONITOR */
2581 * Better know these all around slapd
2583 #define SLAP_LDAPDN_PRETTY 0x1
2584 #define SLAP_LDAPDN_MAXLEN 8192
2586 /* number of response controls supported */
2587 #define SLAP_MAX_RESPONSE_CONTROLS 6
2590 #define SLAP_CTRL_HIDE 0x00000000U
2592 #define SLAP_CTRL_HIDE 0x80000000U
2595 #define SLAP_CTRL_GLOBAL 0x00800000U
2596 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2598 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2599 #define SLAP_CTRL_ABANDON 0x00000001U
2600 #define SLAP_CTRL_ADD 0x00002002U
2601 #define SLAP_CTRL_BIND 0x00000004U
2602 #define SLAP_CTRL_COMPARE 0x00001008U
2603 #define SLAP_CTRL_DELETE 0x00002010U
2604 #define SLAP_CTRL_MODIFY 0x00002020U
2605 #define SLAP_CTRL_RENAME 0x00002040U
2606 #define SLAP_CTRL_SEARCH 0x00001080U
2607 #define SLAP_CTRL_UNBIND 0x00000100U
2609 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2610 #define SLAP_CTRL_UPDATE \
2611 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2612 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2614 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2617 LDAPControl *ctrl ));
2619 #define SLAP_SLAB_SIZE (1024*1024)
2620 #define SLAP_SLAB_STACK 1
2621 #define SLAP_SLAB_SOBLOCK 64
2623 #define SLAP_ZONE_ALLOC 1
2624 #undef SLAP_ZONE_ALLOC
2626 #ifdef LDAP_COMP_MATCH
2628 * Extensible Filter Definition
2630 * MatchingRuleAssertion := SEQUENCE {
2631 * matchingRule [1] MatchingRuleId OPTIONAL,
2632 * type [2] AttributeDescription OPTIONAL,
2633 * matchValue [3] AssertionValue,
2634 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2636 * Following ComponentFilter is contained in matchValue
2638 * ComponentAssertion ::= SEQUENCE {
2639 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2640 * useDefaultValues BOOLEAN DEFAULT TRUE,
2641 * rule MATCHING-RULE.&id,
2642 * value MATCHING-RULE.&AssertionType }
2644 * ComponentFilter ::= CHOICE {
2645 * item [0] ComponentAssertion,
2646 * and [1] SEQUENCE OF ComponentFilter,
2647 * or [2] SEQUENCE OF ComponentFilter,
2648 * not [3] ComponentFilter }
2651 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2652 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2653 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2654 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2655 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2656 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2657 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2658 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2659 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2661 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2662 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2663 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2664 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2665 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2667 typedef struct slap_component_id {
2669 struct slap_component_id *ci_next;
2671 union comp_id_value{
2672 BerValue ci_identifier;
2673 ber_int_t ci_from_beginning;
2675 ber_int_t ci_from_end;
2676 ber_int_t ci_content;
2677 BerValue ci_select_value;
2682 typedef struct slap_component_reference {
2683 ComponentId *cr_list;
2684 ComponentId *cr_curr;
2685 struct berval cr_string;
2687 /* Component Indexing */
2689 slap_mask_t cr_indexmask;
2690 AttributeDescription* cr_ad;
2692 struct slap_component_reference* cr_next;
2693 } ComponentReference;
2695 typedef struct slap_component_assertion {
2696 ComponentReference *ca_comp_ref;
2697 ber_int_t ca_use_def;
2698 MatchingRule *ca_ma_rule;
2699 struct berval ca_ma_value;
2700 ComponentData ca_comp_data; /* componentized assertion */
2701 struct slap_component_filter *ca_cf;
2702 MatchingRuleAssertion *ca_mra;
2703 } ComponentAssertion;
2705 typedef struct slap_component_filter {
2706 ber_tag_t cf_choice;
2708 ber_int_t cf_un_result;
2709 ComponentAssertion *cf_un_ca;
2710 struct slap_component_filter *cf_un_complex;
2713 #define cf_ca cf_un.cf_un_ca
2714 #define cf_result cf_un.cf_un_result
2715 #define cf_and cf_un.cf_un_complex
2716 #define cf_or cf_un.cf_un_complex
2717 #define cf_not cf_un.cf_un_complex
2718 #define cf_any cf_un.cf_un_complex
2720 struct slap_component_filter *cf_next;
2723 typedef struct slap_component_assertion_value {
2727 } ComponentAssertionValue;
2729 typedef int encoder_func LDAP_P((
2733 struct slap_component_syntax_info;
2735 typedef int gser_decoder_func LDAP_P((
2738 struct slap_component_syntax_info** comp_syn_info,
2742 typedef int comp_free_func LDAP_P((
2745 typedef int ber_decoder_func LDAP_P((
2750 struct slap_component_syntax_info* comp_syn_info,
2754 typedef int ber_tag_decoder_func LDAP_P((
2757 struct slap_component_syntax_info* comp_syn_info,
2761 typedef void* extract_component_from_id_func LDAP_P((
2763 ComponentReference* cr,
2766 typedef void* convert_attr_to_comp_func LDAP_P ((
2769 struct berval* bv ));
2771 typedef void* alloc_nibble_func LDAP_P ((
2773 int increment_size ));
2775 typedef void free_nibble_func LDAP_P ((
2778 struct slap_component_syntax_info;
2779 typedef void convert_assert_to_comp_func LDAP_P ((
2781 struct slap_component_syntax_info* csi_attr,
2783 struct slap_component_syntax_info** csi,
2787 typedef int convert_asn_to_ldap_func LDAP_P ((
2788 struct slap_component_syntax_info* csi,
2789 struct berval *bv ));
2791 typedef void free_component_func LDAP_P ((
2794 typedef int test_component_func LDAP_P ((
2796 void* assert_mem_op,
2797 struct slap_component_syntax_info* csi,
2798 struct slap_component_assertion* ca));
2800 typedef void* test_membership_func LDAP_P ((
2803 typedef void* get_component_info_func LDAP_P ((
2806 struct slap_component_syntax_info;
2808 typedef int component_encoder_func LDAP_P ((
2810 struct slap_component_syntax_info* csi,
2811 struct berval* nvals ));
2813 typedef int allcomponent_matching_func LDAP_P((
2815 struct slap_component_syntax_info* comp1,
2816 struct slap_component_syntax_info* comp));
2818 typedef struct slap_component_desc {
2819 /* Don't change the order of following four fields */
2821 AttributeType *cd_comp_type;
2822 struct berval cd_ad_type;/* ad_type, ad_cname */
2823 struct berval cd_ad_cname;/* ad_type, ad_cname */
2824 unsigned cd_flags; /*ad_flags*/
2827 encoder_func *cd_ldap_encoder;
2828 encoder_func *cd_gser_encoder;
2829 encoder_func *cd_ber_encoder;
2830 gser_decoder_func *cd_gser_decoder;
2831 ber_decoder_func *cd_ber_decoder;
2832 comp_free_func *cd_free;
2833 extract_component_from_id_func* cd_extract_i;
2834 allcomponent_matching_func *cd_all_match;
2837 typedef struct slap_component_syntax_info {
2839 ComponentDesc* csi_comp_desc;
2840 } ComponentSyntaxInfo;
2844 /* slab heap data structures */
2846 struct slab_object {
2849 LDAP_LIST_ENTRY(slab_object) so_link;
2858 unsigned char **sh_map;
2859 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
2860 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
2863 #ifdef SLAP_ZONE_ALLOC
2864 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
2865 #define SLAP_ZONE_SHIFT 19
2866 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
2867 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
2868 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
2869 #define SLAP_ZONE_ZOBLOCK 256
2871 struct zone_object {
2876 LDAP_LIST_ENTRY(zone_object) zo_link;
2879 struct zone_latency_history {
2881 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
2892 ldap_pvt_thread_rdwr_t *zh_znlock;
2893 Avlnode *zh_zonetree;
2894 unsigned char ***zh_maps;
2896 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
2897 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
2898 ldap_pvt_thread_mutex_t zh_mutex;
2899 ldap_pvt_thread_rdwr_t zh_lock;
2900 double zh_ema_latency;
2901 unsigned long zh_ema_samples;
2902 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
2903 zh_latency_history_queue;
2904 int zh_latency_history_qlen;
2905 int zh_latency_jump;
2910 #define SLAP_BACKEND_INIT_MODULE(b) \
2912 init_module( int argc, char *argv[] ) \
2915 memset( &bi, '\0', sizeof( bi ) ); \
2917 bi.bi_init = b ## _back_initialize; \
2918 backend_add( &bi ); \
2924 #include "proto-slap.h"
2926 #endif /* _SLAP_H_ */