1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2006 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_LIGHTWEIGHT_DISPATCHER /* experimental slapd architecture */
63 #define SLAP_MULTI_CONN_ARRAY
64 #ifdef LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL
65 #define SLAP_SEM_LOAD_CONTROL
66 #endif /* LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL */
68 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
69 #define SLAP_ACL_HONOR_MANAGE /* not yet implemented */
71 #define SLAP_OVERLAY_ACCESS
72 #define LDAP_COMP_MATCH
73 #define LDAP_DYNAMIC_OBJECTS
74 #define LDAP_SYNC_TIMESTAMP
75 #define LDAP_COLLECTIVE_ATTRIBUTES
76 #define SLAPD_CONF_UNKNOWN_BAILOUT
77 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
79 #define SLAP_ORDERED_PRETTYNORM
80 #define SLAP_AUTHZ_SYNTAX
83 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
87 #if defined(LDAP_SLAPI) && !defined(SLAP_OVERLAY_ACCESS)
88 #define SLAP_OVERLAY_ACCESS
92 * ITS#3705: bail out if unknown config directives appear in slapd.conf
94 #ifdef SLAPD_CONF_UNKNOWN_BAILOUT
95 #define SLAPD_CONF_UNKNOWN_IGNORED ""
96 #define SLAPD_DEBUG_CONFIG_ERROR LDAP_DEBUG_ANY
97 #else /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
98 #define SLAPD_CONF_UNKNOWN_IGNORED " (ignored)"
99 #define SLAPD_DEBUG_CONFIG_ERROR LDAP_DEBUG_CONFIG
100 #endif /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
103 * SLAPD Memory allocation macros
105 * Unlike ch_*() routines, these routines do not assert() upon
106 * allocation error. They are intended to be used instead of
107 * ch_*() routines where the caller has implemented proper
108 * checking for and handling of allocation errors.
110 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
112 #define SLAP_MALLOC(s) ber_memalloc((s))
113 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
114 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
115 #define SLAP_FREE(p) ber_memfree((p))
116 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
117 #define SLAP_STRDUP(s) ber_strdup((s))
118 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
121 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
124 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
125 #define SLAPD_ANONYMOUS ""
127 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
128 * This is a value used internally by the backends. It is needed to allow
129 * adding values that already exist without getting an error as required by
130 * modrdn when the new rdn was already an attribute value itself.
132 #define SLAP_MOD_SOFTADD 0x1000
134 #define MAXREMATCHES (100)
136 #define SLAP_MAX_WORKER_THREADS (16)
138 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
139 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
141 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
142 #define SLAP_CONN_MAX_PENDING_AUTH 1000
144 #define SLAP_TEXT_BUFLEN (256)
146 /* psuedo error code indicating abandoned operation */
147 #define SLAPD_ABANDON (-1024)
149 /* psuedo error code indicating disconnect */
150 #define SLAPD_DISCONNECT (-1025)
152 /* unknown config file directive */
153 #define SLAP_CONF_UNKNOWN (-1026)
155 /* We assume "C" locale, that is US-ASCII */
156 #define ASCII_SPACE(c) ( (c) == ' ' )
157 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
158 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
159 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
160 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
161 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
162 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
163 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
164 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
165 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
166 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
168 #define SLAP_NIBBLE(c) ((c)&0x0f)
169 #define SLAP_ESCAPE_CHAR ('\\')
170 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
171 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
173 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
174 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
176 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
177 /* NOTE: for consistency, this macro must only operate
178 * on normalized/pretty DN, such that ';' is never used
179 * as RDN separator, and all occurrences of ';' must be escaped */
180 #define DN_SEPARATOR(c) ((c) == ',')
181 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
182 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
183 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
185 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
186 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
187 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
188 #define OID_SEPARATOR(c) ( (c) == '.' )
189 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
191 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
192 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
194 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
195 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
197 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
199 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
200 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
201 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
202 (c) == '?' || (c) == ' ' || (c) == '=' )
203 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
205 /* must match in schema_init.c */
206 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
207 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
208 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
209 #define SLAPD_GROUP_ATTR "member"
210 #define SLAPD_GROUP_CLASS "groupOfNames"
211 #define SLAPD_ROLE_ATTR "roleOccupant"
212 #define SLAPD_ROLE_CLASS "organizationalRole"
214 #ifdef SLAPD_ACI_ENABLED
215 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
216 #endif /* SLAPD_ACI_ENABLED */
218 /* change this to "OpenLDAPset" */
219 #define SLAPD_ACI_SET_ATTR "template"
221 #define SLAPD_TOP_OID "2.5.6.0"
223 LDAP_SLAPD_V (int) slap_debug;
225 typedef unsigned long slap_mask_t;
227 /* Security Strength Factor */
228 typedef unsigned slap_ssf_t;
230 typedef struct slap_ssf_set {
232 slap_ssf_t sss_transport;
235 slap_ssf_t sss_update_ssf;
236 slap_ssf_t sss_update_transport;
237 slap_ssf_t sss_update_tls;
238 slap_ssf_t sss_update_sasl;
239 slap_ssf_t sss_simple_bind;
242 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
243 #define SLAP_GETDN_AUTHCID 2
244 #define SLAP_GETDN_AUTHZID 4
249 #define SLAP_INDEX_TYPE 0x00FFUL
250 #define SLAP_INDEX_UNDEFINED 0x0001UL
251 #define SLAP_INDEX_PRESENT 0x0002UL
252 #define SLAP_INDEX_EQUALITY 0x0004UL
253 #define SLAP_INDEX_APPROX 0x0008UL
254 #define SLAP_INDEX_SUBSTR 0x0010UL
255 #define SLAP_INDEX_EXTENDED 0x0020UL
257 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
259 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
261 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
263 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
264 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
265 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
266 #define SLAP_INDEX_SUBSTR_DEFAULT \
267 ( SLAP_INDEX_SUBSTR \
268 | SLAP_INDEX_SUBSTR_INITIAL \
269 | SLAP_INDEX_SUBSTR_ANY \
270 | SLAP_INDEX_SUBSTR_FINAL )
272 /* defaults for initial/final substring indices */
273 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
274 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
276 /* defaults for any substring indices */
277 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
278 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
280 #define SLAP_INDEX_FLAGS 0xF000UL
281 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
282 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
285 * there is a single index for each attribute. these prefixes ensure
286 * that there is no collision among keys.
288 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
289 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
290 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
291 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
292 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
293 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
295 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
296 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
297 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
298 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
299 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
302 * represents schema information for a database
305 SLAP_SCHERR_OUTOFMEM = 1,
306 SLAP_SCHERR_CLASS_NOT_FOUND,
307 SLAP_SCHERR_CLASS_BAD_USAGE,
308 SLAP_SCHERR_CLASS_BAD_SUP,
309 SLAP_SCHERR_CLASS_DUP,
310 SLAP_SCHERR_CLASS_INCONSISTENT,
311 SLAP_SCHERR_ATTR_NOT_FOUND,
312 SLAP_SCHERR_ATTR_BAD_MR,
313 SLAP_SCHERR_ATTR_BAD_USAGE,
314 SLAP_SCHERR_ATTR_BAD_SUP,
315 SLAP_SCHERR_ATTR_INCOMPLETE,
316 SLAP_SCHERR_ATTR_DUP,
317 SLAP_SCHERR_ATTR_INCONSISTENT,
318 SLAP_SCHERR_MR_NOT_FOUND,
319 SLAP_SCHERR_MR_INCOMPLETE,
321 SLAP_SCHERR_SYN_NOT_FOUND,
324 SLAP_SCHERR_NOT_SUPPORTED,
325 SLAP_SCHERR_BAD_DESCR,
328 SLAP_SCHERR_CR_BAD_STRUCT,
329 SLAP_SCHERR_CR_BAD_AUX,
330 SLAP_SCHERR_CR_BAD_AT,
335 typedef union slap_sockaddr {
336 struct sockaddr sa_addr;
337 struct sockaddr_in sa_in_addr;
339 struct sockaddr_storage sa_storage;
340 struct sockaddr_in6 sa_in6_addr;
343 struct sockaddr_un sa_un_addr;
348 extern int slap_inet4or6;
351 typedef struct slap_oid_macro {
352 struct berval som_oid;
355 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
357 LDAP_STAILQ_ENTRY(slap_oid_macro) som_next;
360 /* forward declarations */
362 struct slap_matching_rule;
364 typedef int slap_syntax_validate_func LDAP_P((
365 struct slap_syntax *syntax,
366 struct berval * in));
368 typedef int slap_syntax_transform_func LDAP_P((
369 struct slap_syntax *syntax,
374 #ifdef LDAP_COMP_MATCH
375 typedef void* slap_component_transform_func LDAP_P((
376 struct berval * in ));
377 struct ComponentDesc;
380 typedef struct slap_syntax {
382 #define ssyn_oid ssyn_syn.syn_oid
383 #define ssyn_desc ssyn_syn.syn_desc
384 #define ssyn_extensions ssyn_syn.syn_extensions
387 ber_len_t ssyn_oidlen;
388 * has been replaced by a struct berval that uses the value
389 * provided by ssyn_syn.syn_oid; a macro that expands to
390 * the bv_len field of the berval is provided for backward
391 * compatibility. CAUTION: NEVER FREE THE BERVAL
393 struct berval ssyn_bvoid;
394 #define ssyn_oidlen ssyn_bvoid.bv_len
396 unsigned int ssyn_flags;
398 #define SLAP_SYNTAX_NONE 0x0000U
399 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
400 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
401 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
403 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
405 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
408 slap_syntax_validate_func *ssyn_validate;
409 slap_syntax_transform_func *ssyn_pretty;
411 #ifdef SLAPD_BINARY_CONVERSION
412 /* convert to and from binary */
413 slap_syntax_transform_func *ssyn_ber2str;
414 slap_syntax_transform_func *ssyn_str2ber;
416 #ifdef LDAP_COMP_MATCH
417 slap_component_transform_func *ssyn_attr2comp;
418 struct ComponentDesc* ssync_comp_syntax;
421 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
424 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
425 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
426 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
427 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
428 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
430 typedef struct slap_syntax_defs_rec {
433 slap_syntax_validate_func *sd_validate;
434 slap_syntax_transform_func *sd_pretty;
435 #ifdef SLAPD_BINARY_CONVERSION
436 slap_syntax_transform_func *sd_ber2str;
437 slap_syntax_transform_func *sd_str2ber;
439 } slap_syntax_defs_rec;
441 /* X -> Y Converter */
442 typedef int slap_mr_convert_func LDAP_P((
448 typedef int slap_mr_normalize_func LDAP_P((
450 struct slap_syntax *syntax, /* NULL if in is asserted value */
451 struct slap_matching_rule *mr,
456 /* Match (compare) function */
457 typedef int slap_mr_match_func LDAP_P((
460 struct slap_syntax *syntax, /* syntax of stored value */
461 struct slap_matching_rule *mr,
462 struct berval * value,
463 void * assertValue ));
465 /* Index generation function */
466 typedef int slap_mr_indexer_func LDAP_P((
469 struct slap_syntax *syntax, /* syntax of stored value */
470 struct slap_matching_rule *mr,
471 struct berval *prefix,
476 /* Filter index function */
477 typedef int slap_mr_filter_func LDAP_P((
480 struct slap_syntax *syntax, /* syntax of stored value */
481 struct slap_matching_rule *mr,
482 struct berval *prefix,
487 typedef struct slap_matching_rule_use MatchingRuleUse;
489 typedef struct slap_matching_rule {
490 LDAPMatchingRule smr_mrule;
491 MatchingRuleUse *smr_mru;
492 /* RFC2252 string representation */
493 struct berval smr_str;
496 * ber_len_t smr_oidlen;
497 * has been replaced by a struct berval that uses the value
498 * provided by smr_mrule.mr_oid; a macro that expands to
499 * the bv_len field of the berval is provided for backward
500 * compatibility. CAUTION: NEVER FREE THE BERVAL
502 struct berval smr_bvoid;
503 #define smr_oidlen smr_bvoid.bv_len
505 slap_mask_t smr_usage;
508 #define SLAP_MR_HIDE 0x0000U
510 #define SLAP_MR_HIDE 0x8000U
513 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
515 #define SLAP_MR_TYPE_MASK 0x0F00U
516 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
517 #define SLAP_MR_USAGE 0x000FU
519 #define SLAP_MR_NONE 0x0000U
520 #define SLAP_MR_EQUALITY 0x0100U
521 #define SLAP_MR_ORDERING 0x0200U
522 #define SLAP_MR_SUBSTR 0x0400U
523 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
524 #define SLAP_MR_ORDERED_INDEX 0x1000U
525 #ifdef LDAP_COMP_MATCH
526 #define SLAP_MR_COMPONENT 0x2000U
529 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
531 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
532 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
533 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
537 * The asserted value, depending on the particular usage,
538 * is expected to conform to either the assertion syntax
539 * or the attribute syntax. In some cases, the syntax of
540 * the value is known. If so, these flags indicate which
541 * syntax the value is expected to conform to. If not,
542 * neither of these flags is set (until the syntax of the
543 * provided value is determined). If the value is of the
544 * attribute syntax, the flag is changed once a value of
545 * the assertion syntax is derived from the provided value.
547 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
548 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
549 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
551 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
552 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
553 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
554 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
556 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
557 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
559 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
562 /* either or both the asserted value or attribute value
563 * may be provided in normalized form
565 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
566 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
568 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
569 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
570 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
571 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
573 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
574 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
575 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
576 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
577 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
578 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
580 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
581 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
582 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
583 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
586 slap_mr_convert_func *smr_convert;
587 slap_mr_normalize_func *smr_normalize;
588 slap_mr_match_func *smr_match;
589 slap_mr_indexer_func *smr_indexer;
590 slap_mr_filter_func *smr_filter;
593 * null terminated array of syntaxes compatible with this syntax
594 * note: when MS_EXT is set, this MUST NOT contain the assertion
595 * syntax of the rule. When MS_EXT is not set, it MAY.
597 Syntax **smr_compat_syntaxes;
600 * For equality rules, refers to an associated approximate rule.
601 * For non-equality rules, refers to an associated equality rule.
603 struct slap_matching_rule *smr_associated;
605 #define SLAP_MR_ASSOCIATED(mr,amr) \
606 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
608 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
610 #define smr_oid smr_mrule.mr_oid
611 #define smr_names smr_mrule.mr_names
612 #define smr_desc smr_mrule.mr_desc
613 #define smr_obsolete smr_mrule.mr_obsolete
614 #define smr_syntax_oid smr_mrule.mr_syntax_oid
615 #define smr_extensions smr_mrule.mr_extensions
618 struct slap_matching_rule_use {
619 LDAPMatchingRuleUse smru_mruleuse;
620 MatchingRule *smru_mr;
621 /* RFC2252 string representation */
622 struct berval smru_str;
624 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
626 #define smru_oid smru_mruleuse.mru_oid
627 #define smru_names smru_mruleuse.mru_names
628 #define smru_desc smru_mruleuse.mru_desc
629 #define smru_obsolete smru_mruleuse.mru_obsolete
630 #define smru_applies_oids smru_mruleuse.mru_applies_oids
632 #define smru_usage smru_mr->smr_usage
633 } /* MatchingRuleUse */ ;
635 typedef struct slap_mrule_defs_rec {
637 slap_mask_t mrd_usage;
638 char ** mrd_compat_syntaxes;
639 slap_mr_convert_func * mrd_convert;
640 slap_mr_normalize_func * mrd_normalize;
641 slap_mr_match_func * mrd_match;
642 slap_mr_indexer_func * mrd_indexer;
643 slap_mr_filter_func * mrd_filter;
645 /* For equality rule, this may refer to an associated approximate rule */
646 /* For non-equality rule, this may refer to an associated equality rule */
647 char * mrd_associated;
648 } slap_mrule_defs_rec;
650 struct slap_backend_db;
654 typedef int (AttributeTypeSchemaCheckFN)(
655 struct slap_backend_db *be,
656 struct slap_entry *e,
657 struct slap_attr *attr,
659 char *textbuf, size_t textlen );
661 typedef struct slap_attribute_type {
662 LDAPAttributeType sat_atype;
663 struct berval sat_cname;
664 struct slap_attribute_type *sat_sup;
665 struct slap_attribute_type **sat_subtypes;
666 MatchingRule *sat_equality;
667 MatchingRule *sat_approx;
668 MatchingRule *sat_ordering;
669 MatchingRule *sat_substr;
672 AttributeTypeSchemaCheckFN *sat_check;
675 #define SLAP_AT_NONE 0x0000U
676 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
677 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
679 #define SLAP_AT_HIDE 0x0000U /* publish everything */
681 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
683 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
685 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
687 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
688 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
689 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
691 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
693 slap_mask_t sat_flags;
695 LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
697 #define sat_oid sat_atype.at_oid
698 #define sat_names sat_atype.at_names
699 #define sat_desc sat_atype.at_desc
700 #define sat_obsolete sat_atype.at_obsolete
701 #define sat_sup_oid sat_atype.at_sup_oid
702 #define sat_equality_oid sat_atype.at_equality_oid
703 #define sat_ordering_oid sat_atype.at_ordering_oid
704 #define sat_substr_oid sat_atype.at_substr_oid
705 #define sat_syntax_oid sat_atype.at_syntax_oid
706 #define sat_single_value sat_atype.at_single_value
707 #define sat_collective sat_atype.at_collective
708 #define sat_no_user_mod sat_atype.at_no_user_mod
709 #define sat_usage sat_atype.at_usage
710 #define sat_extensions sat_atype.at_extensions
712 struct slap_attr_desc *sat_ad;
713 ldap_pvt_thread_mutex_t sat_ad_mutex;
716 #define is_at_operational(at) ((at)->sat_usage)
717 #define is_at_single_value(at) ((at)->sat_single_value)
718 #define is_at_collective(at) ((at)->sat_collective)
719 #define is_at_obsolete(at) ((at)->sat_obsolete)
720 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
722 struct slap_object_class;
724 typedef int (ObjectClassSchemaCheckFN)(
725 struct slap_backend_db *be,
726 struct slap_entry *e,
727 struct slap_object_class *oc,
729 char *textbuf, size_t textlen );
731 typedef struct slap_object_class {
732 LDAPObjectClass soc_oclass;
733 struct berval soc_cname;
734 struct slap_object_class **soc_sups;
735 AttributeType **soc_required;
736 AttributeType **soc_allowed;
737 ObjectClassSchemaCheckFN *soc_check;
739 slap_mask_t soc_flags;
740 #define soc_oid soc_oclass.oc_oid
741 #define soc_names soc_oclass.oc_names
742 #define soc_desc soc_oclass.oc_desc
743 #define soc_obsolete soc_oclass.oc_obsolete
744 #define soc_sup_oids soc_oclass.oc_sup_oids
745 #define soc_kind soc_oclass.oc_kind
746 #define soc_at_oids_must soc_oclass.oc_at_oids_must
747 #define soc_at_oids_may soc_oclass.oc_at_oids_may
748 #define soc_extensions soc_oclass.oc_extensions
750 LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
753 #define SLAP_OCF_SET_FLAGS 0x1
754 #define SLAP_OCF_CHECK_SUP 0x2
755 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
757 #define SLAP_OC_ALIAS 0x0001
758 #define SLAP_OC_REFERRAL 0x0002
759 #define SLAP_OC_SUBENTRY 0x0004
760 #define SLAP_OC_DYNAMICOBJECT 0x0008
761 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
762 #define SLAP_OC_GLUE 0x0020
763 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
764 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
765 #define SLAP_OC__MASK 0x00FF
766 #define SLAP_OC__END 0x0100
767 #define SLAP_OC_OPERATIONAL 0x4000
769 #define SLAP_OC_HIDE 0x0000
771 #define SLAP_OC_HIDE 0x8000
773 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
778 typedef struct slap_content_rule {
779 LDAPContentRule scr_crule;
780 ObjectClass *scr_sclass;
781 ObjectClass **scr_auxiliaries; /* optional */
782 AttributeType **scr_required; /* optional */
783 AttributeType **scr_allowed; /* optional */
784 AttributeType **scr_precluded; /* optional */
785 #define scr_oid scr_crule.cr_oid
786 #define scr_names scr_crule.cr_names
787 #define scr_desc scr_crule.cr_desc
788 #define scr_obsolete scr_crule.cr_obsolete
789 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
790 #define scr_at_oids_must scr_crule.cr_at_oids_must
791 #define scr_at_oids_may scr_crule.cr_at_oids_may
792 #define scr_at_oids_not scr_crule.cr_at_oids_not
795 #define SLAP_CR_HARDCODE 0x10000U
798 LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
801 /* Represents a recognized attribute description ( type + options ). */
802 typedef struct slap_attr_desc {
803 struct slap_attr_desc *ad_next;
804 AttributeType *ad_type; /* attribute type, must be specified */
805 struct berval ad_cname; /* canonical name, must be specified */
806 struct berval ad_tags; /* empty if no tagging options */
808 #define SLAP_DESC_NONE 0x00U
809 #define SLAP_DESC_BINARY 0x01U
810 #define SLAP_DESC_TAG_RANGE 0x80U
811 } AttributeDescription;
813 /* flags to slap_*2undef_ad to register undefined (0, the default)
814 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
815 * SLAP_AD_NOINSERT is to lookup without insert */
816 #define SLAP_AD_UNDEF 0x00U
817 #define SLAP_AD_PROXIED 0x01U
818 #define SLAP_AD_NOINSERT 0x02U
820 typedef struct slap_attr_name {
821 struct berval an_name;
822 AttributeDescription *an_desc;
827 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
828 #define slap_ad_is_tag_range(ad) \
829 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
830 #define slap_ad_is_binary(ad) \
831 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
834 * pointers to schema elements used internally
836 struct slap_internal_schema {
838 ObjectClass *si_oc_top;
839 ObjectClass *si_oc_extensibleObject;
840 ObjectClass *si_oc_alias;
841 ObjectClass *si_oc_referral;
842 ObjectClass *si_oc_rootdse;
843 ObjectClass *si_oc_subentry;
844 ObjectClass *si_oc_subschema;
845 ObjectClass *si_oc_collectiveAttributeSubentry;
846 ObjectClass *si_oc_dynamicObject;
848 ObjectClass *si_oc_glue;
849 ObjectClass *si_oc_syncConsumerSubentry;
850 ObjectClass *si_oc_syncProviderSubentry;
852 /* objectClass attribute descriptions */
853 AttributeDescription *si_ad_objectClass;
855 /* operational attribute descriptions */
856 AttributeDescription *si_ad_structuralObjectClass;
857 AttributeDescription *si_ad_creatorsName;
858 AttributeDescription *si_ad_createTimestamp;
859 AttributeDescription *si_ad_modifiersName;
860 AttributeDescription *si_ad_modifyTimestamp;
861 AttributeDescription *si_ad_hasSubordinates;
862 AttributeDescription *si_ad_subschemaSubentry;
863 AttributeDescription *si_ad_collectiveSubentries;
864 AttributeDescription *si_ad_collectiveExclusions;
865 AttributeDescription *si_ad_entryDN;
866 AttributeDescription *si_ad_entryUUID;
867 AttributeDescription *si_ad_entryCSN;
868 AttributeDescription *si_ad_namingCSN;
870 AttributeDescription *si_ad_dseType;
871 AttributeDescription *si_ad_syncreplCookie;
872 AttributeDescription *si_ad_syncTimestamp;
873 AttributeDescription *si_ad_contextCSN;
875 /* root DSE attribute descriptions */
876 AttributeDescription *si_ad_altServer;
877 AttributeDescription *si_ad_namingContexts;
878 AttributeDescription *si_ad_supportedControl;
879 AttributeDescription *si_ad_supportedExtension;
880 AttributeDescription *si_ad_supportedLDAPVersion;
881 AttributeDescription *si_ad_supportedSASLMechanisms;
882 AttributeDescription *si_ad_supportedFeatures;
883 AttributeDescription *si_ad_monitorContext;
884 AttributeDescription *si_ad_vendorName;
885 AttributeDescription *si_ad_vendorVersion;
886 AttributeDescription *si_ad_configContext;
888 /* subentry attribute descriptions */
889 AttributeDescription *si_ad_administrativeRole;
890 AttributeDescription *si_ad_subtreeSpecification;
892 /* subschema subentry attribute descriptions */
893 AttributeDescription *si_ad_attributeTypes;
894 AttributeDescription *si_ad_ditContentRules;
895 AttributeDescription *si_ad_ditStructureRules;
896 AttributeDescription *si_ad_ldapSyntaxes;
897 AttributeDescription *si_ad_matchingRules;
898 AttributeDescription *si_ad_matchingRuleUse;
899 AttributeDescription *si_ad_nameForms;
900 AttributeDescription *si_ad_objectClasses;
902 /* Aliases & Referrals */
903 AttributeDescription *si_ad_aliasedObjectName;
904 AttributeDescription *si_ad_ref;
906 /* Access Control Internals */
907 AttributeDescription *si_ad_entry;
908 AttributeDescription *si_ad_children;
909 AttributeDescription *si_ad_saslAuthzTo;
910 AttributeDescription *si_ad_saslAuthzFrom;
912 /* dynamic entries */
913 AttributeDescription *si_ad_entryTtl;
914 AttributeDescription *si_ad_dynamicSubtrees;
916 /* Other attributes descriptions */
917 AttributeDescription *si_ad_distinguishedName;
918 AttributeDescription *si_ad_name;
919 AttributeDescription *si_ad_cn;
920 AttributeDescription *si_ad_uid;
921 AttributeDescription *si_ad_uidNumber;
922 AttributeDescription *si_ad_gidNumber;
923 AttributeDescription *si_ad_userPassword;
924 AttributeDescription *si_ad_labeledURI;
925 #ifdef SLAPD_AUTHPASSWD
926 AttributeDescription *si_ad_authPassword;
927 AttributeDescription *si_ad_authPasswordSchemes;
929 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
930 AttributeDescription *si_ad_krbName;
932 AttributeDescription *si_ad_description;
933 AttributeDescription *si_ad_seeAlso;
935 /* Undefined Attribute Type */
936 AttributeType *si_at_undefined;
938 /* "Proxied" Attribute Type */
939 AttributeType *si_at_proxied;
942 MatchingRule *si_mr_distinguishedNameMatch;
943 MatchingRule *si_mr_dnSubtreeMatch;
944 MatchingRule *si_mr_dnOneLevelMatch;
945 MatchingRule *si_mr_dnSubordinateMatch;
946 MatchingRule *si_mr_dnSuperiorMatch;
947 MatchingRule *si_mr_caseExactMatch;
948 MatchingRule *si_mr_caseExactSubstringsMatch;
949 MatchingRule *si_mr_caseExactIA5Match;
950 MatchingRule *si_mr_integerMatch;
951 MatchingRule *si_mr_integerFirstComponentMatch;
952 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
955 Syntax *si_syn_directoryString;
956 Syntax *si_syn_distinguishedName;
957 Syntax *si_syn_integer;
958 Syntax *si_syn_octetString;
960 /* Schema Syntaxes */
961 Syntax *si_syn_attributeTypeDesc;
962 Syntax *si_syn_ditContentRuleDesc;
963 Syntax *si_syn_ditStructureRuleDesc;
964 Syntax *si_syn_ldapSyntaxDesc;
965 Syntax *si_syn_matchingRuleDesc;
966 Syntax *si_syn_matchingRuleUseDesc;
967 Syntax *si_syn_nameFormDesc;
968 Syntax *si_syn_objectClassDesc;
971 typedef struct slap_attr_assertion {
972 AttributeDescription *aa_desc;
973 struct berval aa_value;
974 #ifdef LDAP_COMP_MATCH
975 struct slap_component_filter *aa_cf;/* for attribute aliasing */
977 } AttributeAssertion;
979 typedef struct slap_ss_assertion {
980 AttributeDescription *sa_desc;
981 struct berval sa_initial;
982 struct berval *sa_any;
983 struct berval sa_final;
984 } SubstringsAssertion;
986 #ifdef LDAP_COMP_MATCH
987 struct slap_component_filter;
990 typedef struct slap_mr_assertion {
991 MatchingRule *ma_rule; /* optional */
992 struct berval ma_rule_text; /* optional */
993 AttributeDescription *ma_desc; /* optional */
994 int ma_dnattrs; /* boolean */
995 struct berval ma_value; /* required */
996 #ifdef LDAP_COMP_MATCH
997 struct slap_component_filter* ma_cf; /* component filter */
999 } MatchingRuleAssertion;
1002 * represents a search filter
1004 typedef struct slap_filter {
1005 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
1006 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
1007 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
1008 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
1009 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
1012 /* precomputed result */
1013 ber_int_t f_un_result;
1016 struct berval *f_un_dn;
1019 AttributeDescription *f_un_desc;
1021 /* simple value assertion */
1022 AttributeAssertion *f_un_ava;
1024 /* substring assertion */
1025 SubstringsAssertion *f_un_ssa;
1027 /* matching rule assertion */
1028 MatchingRuleAssertion *f_un_mra;
1030 #define f_dn f_un.f_un_dn
1031 #define f_desc f_un.f_un_desc
1032 #define f_ava f_un.f_un_ava
1033 #define f_av_desc f_un.f_un_ava->aa_desc
1034 #define f_av_value f_un.f_un_ava->aa_value
1035 #define f_sub f_un.f_un_ssa
1036 #define f_sub_desc f_un.f_un_ssa->sa_desc
1037 #define f_sub_initial f_un.f_un_ssa->sa_initial
1038 #define f_sub_any f_un.f_un_ssa->sa_any
1039 #define f_sub_final f_un.f_un_ssa->sa_final
1040 #define f_mra f_un.f_un_mra
1041 #define f_mr_rule f_un.f_un_mra->ma_rule
1042 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1043 #define f_mr_desc f_un.f_un_mra->ma_desc
1044 #define f_mr_value f_un.f_un_mra->ma_value
1045 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1048 struct slap_filter *f_un_complex;
1051 #define f_result f_un.f_un_result
1052 #define f_and f_un.f_un_complex
1053 #define f_or f_un.f_un_complex
1054 #define f_not f_un.f_un_complex
1055 #define f_list f_un.f_un_complex
1057 struct slap_filter *f_next;
1060 /* compare routines can return undefined */
1061 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1063 typedef struct slap_valuesreturnfilter {
1064 ber_tag_t vrf_choice;
1067 /* precomputed result */
1068 ber_int_t vrf_un_result;
1074 AttributeDescription *vrf_un_desc;
1076 /* simple value assertion */
1077 AttributeAssertion *vrf_un_ava;
1079 /* substring assertion */
1080 SubstringsAssertion *vrf_un_ssa;
1082 /* matching rule assertion */
1083 MatchingRuleAssertion *vrf_un_mra;
1085 #define vrf_result vrf_un.vrf_un_result
1086 #define vrf_dn vrf_un.vrf_un_dn
1087 #define vrf_desc vrf_un.vrf_un_desc
1088 #define vrf_ava vrf_un.vrf_un_ava
1089 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1090 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1091 #define vrf_ssa vrf_un.vrf_un_ssa
1092 #define vrf_sub vrf_un.vrf_un_ssa
1093 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1094 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1095 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1096 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1097 #define vrf_mra vrf_un.vrf_un_mra
1098 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1099 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1100 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1101 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1102 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1107 struct slap_valuesreturnfilter *vrf_next;
1108 } ValuesReturnFilter;
1110 #ifdef LDAP_COMP_MATCH
1111 struct slap_component_syntax_info;
1112 typedef struct slap_component_data {
1113 void* cd_mem_op;/* nibble memory handler */
1114 struct slap_component_syntax_info** cd_tree;/* component tree */
1119 * represents an attribute (description + values)
1121 typedef struct slap_attr {
1122 AttributeDescription *a_desc;
1123 BerVarray a_vals; /* preserved values */
1124 BerVarray a_nvals; /* normalized values */
1125 #ifdef LDAP_COMP_MATCH
1126 ComponentData *a_comp_data; /* component values */
1128 struct slap_attr *a_next;
1130 #define SLAP_ATTR_IXADD 0x1U
1131 #define SLAP_ATTR_IXDEL 0x2U
1136 * the id used in the indexes to refer to an entry
1138 typedef unsigned long ID;
1139 #define NOID ((ID)~0)
1142 * represents an entry in core
1144 typedef struct slap_entry {
1146 * The ID field should only be changed before entry is
1147 * inserted into a cache. The ID value is backend
1152 struct berval e_name; /* name (DN) of this entry */
1153 struct berval e_nname; /* normalized name (DN) of this entry */
1155 /* for migration purposes */
1156 #define e_dn e_name.bv_val
1157 #define e_ndn e_nname.bv_val
1159 Attribute *e_attrs; /* list of attributes + values */
1161 slap_mask_t e_ocflags;
1163 struct berval e_bv; /* For entry_encode/entry_decode */
1165 /* for use by the backend for any purpose */
1170 * A list of LDAPMods
1172 typedef struct slap_mod {
1175 /* Set for internal mods, will bypass ACL checks. Only needed when
1176 * running as non-root user, for user modifiable attributes.
1178 #define SLAP_MOD_INTERNAL 0x01
1179 #define SLAP_MOD_MANAGING 0x02
1181 AttributeDescription *sm_desc;
1182 struct berval sm_type;
1183 BerVarray sm_values;
1184 BerVarray sm_nvalues;
1187 typedef struct slap_mod_list {
1188 Modification sml_mod;
1189 #define sml_op sml_mod.sm_op
1190 #define sml_flags sml_mod.sm_flags
1191 #define sml_desc sml_mod.sm_desc
1192 #define sml_type sml_mod.sm_type
1193 #define sml_values sml_mod.sm_values
1194 #define sml_nvalues sml_mod.sm_nvalues
1195 struct slap_mod_list *sml_next;
1198 typedef struct slap_ldap_modlist {
1200 struct slap_ldap_modlist *ml_next;
1201 #define ml_op ml_mod.mod_op
1202 #define ml_type ml_mod.mod_type
1203 #define ml_values ml_mod.mod_values
1207 * represents an access control list
1209 typedef enum slap_access_e {
1210 ACL_INVALID_ACCESS = -1,
1220 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1223 /* ACL level mask and modifiers */
1224 ACL_LEVEL_MASK = 0x000f,
1225 ACL_QUALIFIER1 = 0x0100,
1226 ACL_QUALIFIER2 = 0x0200,
1227 ACL_QUALIFIER3 = 0x0400,
1228 ACL_QUALIFIER4 = 0x0800,
1229 ACL_QUALIFIER_MASK = 0x0f00,
1231 /* write granularity */
1232 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1233 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1235 ACL_WRITE = ACL_WADD|ACL_WDEL
1238 typedef enum slap_control_e {
1239 ACL_INVALID_CONTROL = 0,
1245 typedef enum slap_style_e {
1246 ACL_STYLE_REGEX = 0,
1254 ACL_STYLE_ANONYMOUS,
1261 typedef struct slap_authz_info {
1262 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1263 struct berval sai_mech; /* SASL Mechanism */
1264 struct berval sai_dn; /* DN for reporting purposes */
1265 struct berval sai_ndn; /* Normalized DN */
1267 /* Security Strength Factors */
1268 slap_ssf_t sai_ssf; /* Overall SSF */
1269 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1270 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1271 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1272 } AuthorizationInformation;
1279 * "dynamic" ACL infrastructure (for ACIs and more)
1281 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1282 const char *opts, slap_style_t, const char *, void **privp ));
1283 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1284 typedef int (slap_dynacl_mask) LDAP_P((
1288 AttributeDescription *desc,
1291 regmatch_t *matches,
1292 slap_access_t *grant,
1293 slap_access_t *deny ));
1294 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1296 typedef struct slap_dynacl_t {
1298 slap_dynacl_parse *da_parse;
1299 slap_dynacl_unparse *da_unparse;
1300 slap_dynacl_mask *da_mask;
1301 slap_dynacl_destroy *da_destroy;
1304 struct slap_dynacl_t *da_next;
1306 #endif /* SLAP_DYNACL */
1308 /* the DN portion of the "by" part */
1309 typedef struct slap_dn_access {
1311 AuthorizationInformation a_dnauthz;
1312 #define a_pat a_dnauthz.sai_dn
1314 slap_style_t a_style;
1317 AttributeDescription *a_at;
1323 typedef struct slap_access {
1324 slap_control_t a_type;
1326 /* strip qualifiers */
1327 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1328 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1330 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1332 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1333 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1334 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1335 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1336 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1337 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1338 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1339 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1340 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1341 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1343 /* NOTE: always use the highest level; current: 0x00ffUL */
1344 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1347 #define ACL_PRIV_LEVEL 0x1000UL
1348 #define ACL_PRIV_ADDITIVE 0x2000UL
1349 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1352 #define ACL_PRIV_INVALID 0x0UL
1354 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1355 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1356 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1357 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1359 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1360 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1362 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1364 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1366 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1367 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1368 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1370 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1371 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1372 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1373 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1374 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1375 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1376 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1377 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1378 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1379 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1381 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1382 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1383 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1384 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1385 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1386 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1387 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1388 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1389 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1390 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1391 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1393 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1394 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1395 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1396 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1397 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1398 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1399 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1400 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1401 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1402 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1404 slap_mask_t a_access_mask;
1407 slap_dn_access a_dn;
1408 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1409 #define a_dn_at a_dn.a_at
1410 #define a_dn_self a_dn.a_self
1412 /* real DN pattern */
1413 slap_dn_access a_realdn;
1414 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1415 #define a_realdn_at a_realdn.a_at
1416 #define a_realdn_self a_realdn.a_self
1418 /* used for ssf stuff
1419 * NOTE: the ssf stuff in a_realdn is ignored */
1420 #define a_authz a_dn.a_dnauthz
1422 /* connection related stuff */
1423 slap_style_t a_peername_style;
1424 struct berval a_peername_pat;
1425 unsigned long a_peername_addr,
1427 int a_peername_port;
1429 slap_style_t a_sockname_style;
1430 struct berval a_sockname_pat;
1432 slap_style_t a_domain_style;
1433 struct berval a_domain_pat;
1434 int a_domain_expand;
1436 slap_style_t a_sockurl_style;
1437 struct berval a_sockurl_pat;
1438 slap_style_t a_set_style;
1439 struct berval a_set_pat;
1442 slap_dynacl_t *a_dynacl;
1443 #else /* ! SLAP_DYNACL */
1444 #ifdef SLAPD_ACI_ENABLED
1445 /* NOTE: ACIs have been moved under the "dynacl" interface,
1446 * which is currently built only when LDAP_DEVEL is defined.
1448 * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1449 * is required to enable ACI support.
1451 AttributeDescription *a_aci_at;
1452 #endif /* SLAPD_ACI_ENABLED */
1453 #endif /* SLAP_DYNACL */
1456 slap_style_t a_group_style;
1457 struct berval a_group_pat;
1458 ObjectClass *a_group_oc;
1459 AttributeDescription *a_group_at;
1461 struct slap_access *a_next;
1465 typedef struct slap_acl {
1466 /* "to" part: the entries this acl applies to */
1468 slap_style_t acl_dn_style;
1470 struct berval acl_dn_pat;
1471 AttributeName *acl_attrs;
1472 MatchingRule *acl_attrval_mr;
1473 slap_style_t acl_attrval_style;
1474 regex_t acl_attrval_re;
1475 struct berval acl_attrval;
1477 /* "by" part: list of who has what access to the entries */
1480 struct slap_acl *acl_next;
1483 typedef struct slap_acl_state {
1484 unsigned as_recorded;
1485 #define ACL_STATE_NOT_RECORDED 0x0
1486 #define ACL_STATE_RECORDED_VD 0x1
1487 #define ACL_STATE_RECORDED_NV 0x2
1488 #define ACL_STATE_RECORDED 0x3
1491 AccessControl *as_vd_acl;
1492 AccessControl *as_vi_acl;
1493 slap_mask_t as_vd_acl_mask;
1494 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1495 int as_vd_acl_count;
1497 Access *as_vd_access;
1498 int as_vd_access_count;
1501 AttributeDescription *as_vd_ad;
1502 } AccessControlState;
1503 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1504 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1506 #ifdef SLAPD_ACI_ENABLED
1507 typedef enum slap_aci_scope_t {
1508 SLAP_ACI_SCOPE_ENTRY = 0x1,
1509 SLAP_ACI_SCOPE_CHILDREN = 0x2,
1510 SLAP_ACI_SCOPE_SUBTREE = ( SLAP_ACI_SCOPE_ENTRY | SLAP_ACI_SCOPE_CHILDREN )
1512 #endif /* SLAPD_ACI_ENABLED */
1516 * represents a backend
1519 typedef struct slap_backend_info BackendInfo; /* per backend type */
1520 typedef struct slap_backend_db BackendDB; /* per backend database */
1521 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1522 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1524 LDAP_SLAPD_V (int) nBackendInfo;
1525 LDAP_SLAPD_V (int) nBackendDB;
1526 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1527 LDAP_SLAPD_V (slap_be_head) backendDB;
1528 LDAP_SLAPD_V (BackendDB *) frontendDB;
1530 LDAP_SLAPD_V (int) slapMode;
1531 #define SLAP_UNDEFINED_MODE 0x0000
1532 #define SLAP_SERVER_MODE 0x0001
1533 #define SLAP_TOOL_MODE 0x0002
1534 #define SLAP_MODE 0x0003
1536 #define SLAP_TRUNCATE_MODE 0x0100
1537 #define SLAP_TOOL_READMAIN 0x0200
1538 #define SLAP_TOOL_READONLY 0x0400
1539 #define SLAP_TOOL_QUICK 0x0800
1541 #define SB_TLS_DEFAULT (-1)
1542 #define SB_TLS_OFF 0
1544 #define SB_TLS_CRITICAL 2
1546 typedef struct slap_bindconf {
1547 struct berval sb_uri;
1550 struct berval sb_binddn;
1551 struct berval sb_cred;
1552 struct berval sb_saslmech;
1554 struct berval sb_realm;
1555 struct berval sb_authcId;
1556 struct berval sb_authzId;
1559 struct slap_replica_info {
1560 const char *ri_host; /* points to host part of uri */
1561 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1562 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1563 int ri_exclude; /* 1 => exclude ri_attrs */
1564 slap_bindconf ri_bindconf; /* for back-config */
1567 typedef struct slap_verbmasks {
1569 const slap_mask_t mask;
1572 typedef struct slap_cf_aux_table {
1577 slap_verbmasks *aux;
1578 } slap_cf_aux_table;
1580 #define SLAP_LIMIT_TIME 1
1581 #define SLAP_LIMIT_SIZE 2
1583 struct slap_limits_set {
1591 int lms_s_unchecked;
1597 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1598 #define SLAP_NO_LIMIT -1
1599 #define SLAP_MAX_LIMIT 2147483647
1601 struct slap_limits {
1602 unsigned lm_flags; /* type of pattern */
1603 #define SLAP_LIMITS_UNDEFINED 0x0000U
1604 #define SLAP_LIMITS_EXACT 0x0001U
1605 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1606 #define SLAP_LIMITS_ONE 0x0002U
1607 #define SLAP_LIMITS_SUBTREE 0x0003U
1608 #define SLAP_LIMITS_CHILDREN 0x0004U
1609 #define SLAP_LIMITS_REGEX 0x0005U
1610 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1611 #define SLAP_LIMITS_USERS 0x0007U
1612 #define SLAP_LIMITS_ANY 0x0008U
1613 #define SLAP_LIMITS_MASK 0x000FU
1615 #define SLAP_LIMITS_TYPE_DN 0x0000U
1616 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1617 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1619 regex_t lm_regex; /* regex data for REGEX */
1622 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1623 * pattern for REGEX; NULL for ANONYMOUS, USERS
1625 struct berval lm_pat;
1627 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1628 * lm_group_oc is objectClass and lm_group_at is attributeType
1629 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1630 * can only be SLAP_LIMITS_EXACT */
1631 ObjectClass *lm_group_oc;
1632 AttributeDescription *lm_group_ad;
1634 struct slap_limits_set lm_limits;
1637 /* temporary aliases */
1638 typedef BackendDB Backend;
1639 #define nbackends nBackendDB
1640 #define backends backendDB
1643 * syncinfo structure for syncrepl
1648 #define SLAP_SYNC_RID_SIZE 3
1649 #define SLAP_SYNCUUID_SET_SIZE 256
1651 #define SLAP_SYNC_UPDATE_MSGID 1
1653 struct sync_cookie {
1654 struct berval ctxcsn;
1655 struct berval octet_str;
1657 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1660 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1662 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1664 #ifndef SLAP_MAX_CIDS
1665 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1668 struct ConfigOCs; /* config.h */
1670 struct slap_backend_db {
1671 BackendInfo *bd_info; /* pointer to shared backend info */
1673 /* fields in this structure (and routines acting on this structure)
1674 should be renamed from be_ to bd_ */
1676 /* BackendInfo accessors */
1677 #define be_config bd_info->bi_db_config
1678 #define be_type bd_info->bi_type
1680 #define be_bind bd_info->bi_op_bind
1681 #define be_unbind bd_info->bi_op_unbind
1682 #define be_add bd_info->bi_op_add
1683 #define be_compare bd_info->bi_op_compare
1684 #define be_delete bd_info->bi_op_delete
1685 #define be_modify bd_info->bi_op_modify
1686 #define be_modrdn bd_info->bi_op_modrdn
1687 #define be_search bd_info->bi_op_search
1688 #define be_abandon bd_info->bi_op_abandon
1689 #define be_cancel bd_info->bi_op_cancel
1691 #define be_extended bd_info->bi_extended
1693 #define be_chk_referrals bd_info->bi_chk_referrals
1694 #define be_chk_controls bd_info->bi_chk_controls
1695 #define be_fetch bd_info->bi_entry_get_rw
1696 #define be_release bd_info->bi_entry_release_rw
1697 #define be_group bd_info->bi_acl_group
1698 #define be_attribute bd_info->bi_acl_attribute
1699 #define be_operational bd_info->bi_operational
1702 * define to honor hasSubordinates operational attribute in search filters
1703 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1706 #define be_has_subordinates bd_info->bi_has_subordinates
1708 #define be_connection_init bd_info->bi_connection_init
1709 #define be_connection_destroy bd_info->bi_connection_destroy
1712 #define be_entry_open bd_info->bi_tool_entry_open
1713 #define be_entry_close bd_info->bi_tool_entry_close
1714 #define be_entry_first bd_info->bi_tool_entry_first
1715 #define be_entry_next bd_info->bi_tool_entry_next
1716 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1717 #define be_entry_get bd_info->bi_tool_entry_get
1718 #define be_entry_put bd_info->bi_tool_entry_put
1719 #define be_sync bd_info->bi_tool_sync
1720 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1721 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1722 #define be_entry_modify bd_info->bi_tool_entry_modify
1725 /* supported controls */
1726 /* note: set to 0 if the database does not support the control;
1727 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1728 char be_ctrls[SLAP_MAX_CIDS + 1];
1730 /* Database flags */
1731 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1732 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1733 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1734 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1735 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1736 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1737 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1738 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1739 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1740 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1741 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1742 slap_mask_t be_flags;
1743 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1744 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1745 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1746 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1747 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1748 #define SLAP_NO_SCHEMA_CHECK(be) \
1749 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1750 #define SLAP_GLUE_INSTANCE(be) \
1751 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1752 #define SLAP_GLUE_SUBORDINATE(be) \
1753 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1754 #define SLAP_GLUE_LINKED(be) \
1755 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1756 #define SLAP_GLUE_ADVERTISE(be) \
1757 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1758 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1759 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1760 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1762 slap_mask_t be_restrictops; /* restriction operations */
1763 #define SLAP_RESTRICT_OP_ADD 0x0001U
1764 #define SLAP_RESTRICT_OP_BIND 0x0002U
1765 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1766 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1767 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1768 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1769 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1770 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1771 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1773 #define SLAP_RESTRICT_READONLY 0x80000000U
1775 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1776 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1777 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1778 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1779 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1781 #define SLAP_RESTRICT_OP_READS \
1782 ( SLAP_RESTRICT_OP_COMPARE \
1783 | SLAP_RESTRICT_OP_SEARCH )
1784 #define SLAP_RESTRICT_OP_WRITES \
1785 ( SLAP_RESTRICT_OP_ADD \
1786 | SLAP_RESTRICT_OP_DELETE \
1787 | SLAP_RESTRICT_OP_MODIFY \
1788 | SLAP_RESTRICT_OP_RENAME )
1789 #define SLAP_RESTRICT_OP_ALL \
1790 ( SLAP_RESTRICT_OP_READS \
1791 | SLAP_RESTRICT_OP_WRITES \
1792 | SLAP_RESTRICT_OP_BIND \
1793 | SLAP_RESTRICT_OP_EXTENDED )
1795 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1796 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1797 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1799 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1801 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1802 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1803 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1805 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1806 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1808 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1810 slap_mask_t be_requires; /* pre-operation requirements */
1811 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1812 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1813 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1814 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1815 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1817 /* Required Security Strength Factor */
1818 slap_ssf_set_t be_ssf_set;
1820 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1821 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1822 struct berval be_schemadn; /* per-backend subschema subentry DN */
1823 struct berval be_schemandn; /* normalized subschema DN */
1824 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1825 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1826 struct berval be_rootpw; /* the magic "root" password for this db */
1827 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1828 #define be_sizelimit be_def_limit.lms_s_soft
1829 #define be_timelimit be_def_limit.lms_t_soft
1830 struct slap_limits_set be_def_limit; /* default limits */
1831 struct slap_limits **be_limits; /* regex-based size and time limits */
1832 AccessControl *be_acl; /* access control list for this backend */
1833 slap_access_t be_dfltaccess; /* access given if no acl matches */
1835 /* Replica Information */
1836 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1837 char *be_replogfile; /* replication log file (in master) */
1838 char *be_replica_argsfile; /* per-replog replica args file */
1839 char *be_replica_pidfile; /* per-replog replica pid file */
1840 int be_replicationinterval; /* per-replog replicationinterval */
1841 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1842 BerVarray be_update_refs; /* where to refer modifying clients to */
1843 struct be_pcl *be_pending_csn_list;
1844 ldap_pvt_thread_mutex_t be_pcl_mutex;
1845 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1846 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1848 void *be_pb; /* Netscape plugin */
1849 struct ConfigOCs *be_cf_ocs;
1851 void *be_private; /* anything the backend database needs */
1852 LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1858 /* Backend function typedefs */
1859 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1860 typedef BI_bi_func BI_init;
1861 typedef BI_bi_func BI_open;
1862 typedef BI_bi_func BI_close;
1863 typedef BI_bi_func BI_destroy;
1864 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1865 const char *fname, int lineno,
1866 int argc, char **argv));
1868 typedef int (BI_db_func) LDAP_P((Backend *bd));
1869 typedef BI_db_func BI_db_init;
1870 typedef BI_db_func BI_db_open;
1871 typedef BI_db_func BI_db_close;
1872 typedef BI_db_func BI_db_destroy;
1873 typedef int (BI_db_config) LDAP_P((Backend *bd,
1874 const char *fname, int lineno,
1875 int argc, char **argv));
1877 typedef struct req_bind_s {
1879 struct berval rb_cred;
1880 struct berval rb_edn;
1882 struct berval rb_tmp_mech; /* FIXME: temporary */
1885 typedef struct req_search_s {
1890 /* NULL means be_isroot evaluated to TRUE */
1891 struct slap_limits_set *rs_limit;
1893 AttributeName *rs_attrs;
1895 struct berval rs_filterstr;
1898 typedef struct req_compare_s {
1899 AttributeAssertion *rs_ava;
1902 typedef struct req_modify_s {
1903 Modifications *rs_modlist;
1904 int rs_increment; /* FIXME: temporary */
1907 typedef struct req_modrdn_s {
1908 struct berval rs_newrdn;
1909 struct berval rs_nnewrdn;
1910 struct berval *rs_newSup;
1911 struct berval *rs_nnewSup;
1912 int rs_deleteoldrdn;
1913 Modifications *rs_modlist;
1916 typedef struct req_add_s {
1918 Modifications *rs_modlist; /* FIXME: temporary */
1921 typedef struct req_abandon_s {
1926 #define SLAP_EXOP_HIDE 0x0000
1928 #define SLAP_EXOP_HIDE 0x8000
1930 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1932 typedef struct req_extended_s {
1933 struct berval rs_reqoid;
1935 struct berval *rs_reqdata;
1938 typedef struct req_pwdexop_s {
1939 struct req_extended_s rs_extended;
1940 struct berval rs_old;
1941 struct berval rs_new;
1942 Modifications *rs_mods;
1943 Modifications **rs_modtail;
1946 typedef enum slap_reply_e {
1955 typedef struct rep_sasl_s {
1956 struct berval *r_sasldata;
1959 typedef struct rep_extended_s {
1960 const char *r_rspoid;
1961 struct berval *r_rspdata;
1964 typedef struct rep_search_s {
1966 slap_mask_t r_attr_flags;
1967 #define SLAP_ATTRS_UNDEFINED (0x00U)
1968 #define SLAP_OPATTRS_NO (0x01U)
1969 #define SLAP_OPATTRS_YES (0x02U)
1970 #define SLAP_USERATTRS_NO (0x10U)
1971 #define SLAP_USERATTRS_YES (0x20U)
1972 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1973 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1974 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1975 #define SLAP_USERATTRS(f) \
1976 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1978 Attribute *r_operational_attrs;
1979 AttributeName *r_attrs;
1984 typedef struct slap_rep {
1985 slap_reply_t sr_type;
1989 const char *sr_matched;
1990 const char *sr_text;
1992 LDAPControl **sr_ctrls;
1994 rep_sasl_s sru_sasl;
1995 rep_extended_s sru_extended;
1996 rep_search_s sru_search;
1998 slap_mask_t sr_flags;
1999 #define REP_ENTRY_MODIFIABLE 0x0001U
2000 #define REP_ENTRY_MUSTBEFREED 0x0002U
2001 #define REP_ENTRY_MUSTRELEASE 0x0004U
2002 #define REP_MATCHED_MUSTBEFREED 0x0010U
2003 #define REP_REF_MUSTBEFREED 0x0020U
2006 /* short hands for response members */
2007 #define sr_attrs sr_un.sru_search.r_attrs
2008 #define sr_entry sr_un.sru_search.r_entry
2009 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2010 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2011 #define sr_v2ref sr_un.sru_search.r_v2ref
2012 #define sr_nentries sr_un.sru_search.r_nentries
2013 #define sr_rspoid sr_un.sru_extended.r_rspoid
2014 #define sr_rspdata sr_un.sru_extended.r_rspdata
2015 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2017 typedef int (BI_op_func) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2018 typedef BI_op_func BI_op_bind;
2019 typedef BI_op_func BI_op_unbind;
2020 typedef BI_op_func BI_op_search;
2021 typedef BI_op_func BI_op_compare;
2022 typedef BI_op_func BI_op_modify;
2023 typedef BI_op_func BI_op_modrdn;
2024 typedef BI_op_func BI_op_add;
2025 typedef BI_op_func BI_op_delete;
2026 typedef BI_op_func BI_op_abandon;
2027 typedef BI_op_func BI_op_cancel;
2028 typedef BI_op_func BI_op_extended;
2029 typedef BI_op_func BI_chk_referrals;
2030 typedef BI_op_func BI_chk_controls;
2031 typedef int (BI_entry_release_rw)
2032 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
2033 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
2034 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2035 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2036 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
2037 Entry *e, int *hasSubs ));
2038 #ifdef SLAP_OVERLAY_ACCESS
2039 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
2040 AttributeDescription *desc, struct berval *val, slap_access_t access,
2041 AccessControlState *state, slap_mask_t *maskp ));
2042 typedef int (BI_acl_group) LDAP_P(( struct slap_op *op, Entry *target,
2043 struct berval *gr_ndn, struct berval *op_ndn,
2044 ObjectClass *group_oc, AttributeDescription *group_at ));
2045 typedef int (BI_acl_attribute) LDAP_P(( struct slap_op *op, Entry *target,
2046 struct berval *entry_ndn, AttributeDescription *entry_at,
2047 BerVarray *vals, slap_access_t access ));
2048 #endif /* SLAP_OVERLAY_ACCESS */
2050 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, struct slap_conn *c ));
2051 typedef BI_conn_func BI_connection_init;
2052 typedef BI_conn_func BI_connection_destroy;
2054 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2055 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2056 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2057 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2058 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2059 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2060 struct berval *text ));
2061 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
2062 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2063 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2064 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
2065 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2066 struct berval *text ));
2068 struct slap_backend_info {
2069 char *bi_type; /* type of backend */
2072 * per backend type routines:
2073 * bi_init: called to allocate a backend_info structure,
2074 * called once BEFORE configuration file is read.
2075 * bi_init() initializes this structure hence is
2076 * called directly from be_initialize()
2077 * bi_config: called per 'backend' specific option
2078 * all such options must before any 'database' options
2079 * bi_config() is called only from read_config()
2080 * bi_open: called to open each database, called
2081 * once AFTER configuration file is read but
2082 * BEFORE any bi_db_open() calls.
2083 * bi_open() is called from backend_startup()
2084 * bi_close: called to close each database, called
2085 * once during shutdown after all bi_db_close calls.
2086 * bi_close() is called from backend_shutdown()
2087 * bi_destroy: called to destroy each database, called
2088 * once during shutdown after all bi_db_destroy calls.
2089 * bi_destory() is called from backend_destroy()
2092 BI_config *bi_config;
2095 BI_destroy *bi_destroy;
2098 * per database routines:
2099 * bi_db_init: called to initialize each database,
2100 * called upon reading 'database <type>'
2101 * called only from backend_db_init()
2102 * bi_db_config: called to configure each database,
2103 * called per database to handle per database options
2104 * called only from read_config()
2105 * bi_db_open: called to open each database
2106 * called once per database immediately AFTER bi_open()
2107 * calls but before daemon startup.
2108 * called only by backend_startup()
2109 * bi_db_close: called to close each database
2110 * called once per database during shutdown but BEFORE
2111 * any bi_close call.
2112 * called only by backend_shutdown()
2113 * bi_db_destroy: called to destroy each database
2114 * called once per database during shutdown AFTER all
2115 * bi_close calls but before bi_destory calls.
2116 * called only by backend_destory()
2118 BI_db_init *bi_db_init;
2119 BI_db_config *bi_db_config;
2120 BI_db_open *bi_db_open;
2121 BI_db_close *bi_db_close;
2122 BI_db_destroy *bi_db_destroy;
2124 /* LDAP Operations Handling Routines */
2125 BI_op_bind *bi_op_bind;
2126 BI_op_unbind *bi_op_unbind;
2127 BI_op_search *bi_op_search;
2128 BI_op_compare *bi_op_compare;
2129 BI_op_modify *bi_op_modify;
2130 BI_op_modrdn *bi_op_modrdn;
2131 BI_op_add *bi_op_add;
2132 BI_op_delete *bi_op_delete;
2133 BI_op_abandon *bi_op_abandon;
2134 BI_op_cancel *bi_op_cancel;
2136 /* Extended Operations Helper */
2137 BI_op_extended *bi_extended;
2139 /* Auxilary Functions */
2140 BI_operational *bi_operational;
2141 BI_chk_referrals *bi_chk_referrals;
2142 BI_chk_controls *bi_chk_controls;
2143 BI_entry_get_rw *bi_entry_get_rw;
2144 BI_entry_release_rw *bi_entry_release_rw;
2146 BI_has_subordinates *bi_has_subordinates;
2147 #ifdef SLAP_OVERLAY_ACCESS
2148 BI_access_allowed *bi_access_allowed;
2149 BI_acl_group *bi_acl_group;
2150 BI_acl_attribute *bi_acl_attribute;
2151 #endif /* SLAP_OVERLAY_ACCESS */
2153 BI_connection_init *bi_connection_init;
2154 BI_connection_destroy *bi_connection_destroy;
2156 /* hooks for slap tools */
2157 BI_tool_entry_open *bi_tool_entry_open;
2158 BI_tool_entry_close *bi_tool_entry_close;
2159 BI_tool_entry_first *bi_tool_entry_first;
2160 BI_tool_entry_next *bi_tool_entry_next;
2161 BI_tool_entry_get *bi_tool_entry_get;
2162 BI_tool_entry_put *bi_tool_entry_put;
2163 BI_tool_entry_reindex *bi_tool_entry_reindex;
2164 BI_tool_sync *bi_tool_sync;
2165 BI_tool_dn2id_get *bi_tool_dn2id_get;
2166 BI_tool_id2entry_get *bi_tool_id2entry_get;
2167 BI_tool_entry_modify *bi_tool_entry_modify;
2169 #define SLAP_INDEX_ADD_OP 0x0001
2170 #define SLAP_INDEX_DELETE_OP 0x0002
2172 slap_mask_t bi_flags; /* backend flags */
2173 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2174 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2175 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2176 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2177 #define SLAP_BFLAG_INCREMENT 0x0100U
2178 #define SLAP_BFLAG_ALIASES 0x1000U
2179 #define SLAP_BFLAG_REFERRALS 0x2000U
2180 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2181 #define SLAP_BFLAG_DYNAMIC 0x8000U
2183 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2184 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2185 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2186 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2187 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2188 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2189 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2190 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2191 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2192 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2193 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2195 char **bi_controls; /* supported controls */
2196 char bi_ctrls[SLAP_MAX_CIDS + 1];
2198 unsigned int bi_nDB; /* number of databases of this type */
2199 struct ConfigOCs *bi_cf_ocs;
2200 char **bi_obsolete_names;
2201 void *bi_private; /* anything the backend type needs */
2202 LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2205 #define c_authtype c_authz.sai_method
2206 #define c_authmech c_authz.sai_mech
2207 #define c_dn c_authz.sai_dn
2208 #define c_ndn c_authz.sai_ndn
2209 #define c_ssf c_authz.sai_ssf
2210 #define c_transport_ssf c_authz.sai_transport_ssf
2211 #define c_tls_ssf c_authz.sai_tls_ssf
2212 #define c_sasl_ssf c_authz.sai_sasl_ssf
2214 #define o_authtype o_authz.sai_method
2215 #define o_authmech o_authz.sai_mech
2216 #define o_dn o_authz.sai_dn
2217 #define o_ndn o_authz.sai_ndn
2218 #define o_ssf o_authz.sai_ssf
2219 #define o_transport_ssf o_authz.sai_transport_ssf
2220 #define o_tls_ssf o_authz.sai_tls_ssf
2221 #define o_sasl_ssf o_authz.sai_sasl_ssf
2223 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2225 typedef struct slap_callback {
2226 struct slap_callback *sc_next;
2227 slap_response *sc_response;
2228 slap_response *sc_cleanup;
2232 struct slap_overinfo;
2234 typedef enum slap_operation_e {
2247 op_aux_chk_referrals,
2248 op_aux_chk_controls,
2252 typedef struct slap_overinst {
2254 slap_response *on_response;
2255 struct slap_overinfo *on_info;
2256 struct slap_overinst *on_next;
2259 typedef struct slap_overinfo {
2261 BackendInfo *oi_orig;
2262 BackendDB *oi_origdb;
2263 struct slap_overinst *oi_list;
2266 /* Should successive callbacks in a chain be processed? */
2267 #define SLAP_CB_FREEME 0x04000
2268 #define SLAP_CB_CONTINUE 0x08000
2271 * Paged Results state
2273 typedef unsigned long PagedResultsCookie;
2274 typedef struct slap_paged_state {
2277 PagedResultsCookie ps_cookie;
2279 } PagedResultsState;
2281 struct slap_csn_entry {
2282 struct berval ce_csn;
2283 unsigned long ce_opid;
2284 unsigned long ce_connid;
2285 #define SLAP_CSN_PENDING 1
2286 #define SLAP_CSN_COMMIT 2
2288 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2292 * Caches the result of a backend_group check for ACL evaluation
2294 typedef struct slap_gacl {
2295 struct slap_gacl *ga_next;
2298 AttributeDescription *ga_at;
2304 struct slap_control_ids {
2311 int sc_modifyIncrement;
2313 int sc_pagedResults;
2314 int sc_permissiveModify;
2318 int sc_searchOptions;
2320 int sc_sortedResults;
2324 int sc_valuesReturnFilter;
2328 * represents an operation pending from an ldap client
2330 typedef struct slap_op_header {
2331 unsigned long oh_opid; /* id of this operation */
2332 unsigned long oh_connid; /* id of conn initiating this op */
2333 struct slap_conn *oh_conn; /* connection spawning this op */
2335 ber_int_t oh_msgid; /* msgid of the request */
2336 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2338 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2340 void *oh_threadctx; /* thread pool thread context */
2341 void *oh_tmpmemctx; /* slab malloc context */
2342 BerMemoryFunctions *oh_tmpmfuncs;
2344 char oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2347 void *oh_extensions; /* NS-SLAPI plugin */
2351 typedef struct slap_op {
2354 #define o_opid o_hdr->oh_opid
2355 #define o_connid o_hdr->oh_connid
2356 #define o_conn o_hdr->oh_conn
2357 #define o_msgid o_hdr->oh_msgid
2358 #define o_protocol o_hdr->oh_protocol
2359 #define o_tid o_hdr->oh_tid
2360 #define o_threadctx o_hdr->oh_threadctx
2361 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2362 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2364 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2365 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2366 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2367 #define o_tmpfree o_tmpmfuncs->bmf_free
2369 #define o_log_prefix o_hdr->oh_log_prefix
2371 ber_tag_t o_tag; /* tag of the request */
2372 time_t o_time; /* time op was initiated */
2373 int o_tincr; /* counter for multiple ops with same o_time */
2375 BackendDB *o_bd; /* backend DB processing this op */
2376 struct berval o_req_dn; /* DN of target of request */
2377 struct berval o_req_ndn;
2382 req_compare_s oq_compare;
2383 req_modify_s oq_modify;
2384 req_modrdn_s oq_modrdn;
2385 req_search_s oq_search;
2386 req_abandon_s oq_abandon;
2387 req_abandon_s oq_cancel;
2388 req_extended_s oq_extended;
2389 req_pwdexop_s oq_pwdexop;
2392 /* short hands for union members */
2393 #define oq_add o_request.oq_add
2394 #define oq_bind o_request.oq_bind
2395 #define oq_compare o_request.oq_compare
2396 #define oq_modify o_request.oq_modify
2397 #define oq_modrdn o_request.oq_modrdn
2398 #define oq_search o_request.oq_search
2399 #define oq_abandon o_request.oq_abandon
2400 #define oq_cancel o_request.oq_cancel
2401 #define oq_extended o_request.oq_extended
2402 #define oq_pwdexop o_request.oq_pwdexop
2404 /* short hands for inner request members */
2405 #define orb_method oq_bind.rb_method
2406 #define orb_cred oq_bind.rb_cred
2407 #define orb_edn oq_bind.rb_edn
2408 #define orb_ssf oq_bind.rb_ssf
2409 #define orb_tmp_mech oq_bind.rb_tmp_mech
2411 #define ors_scope oq_search.rs_scope
2412 #define ors_deref oq_search.rs_deref
2413 #define ors_slimit oq_search.rs_slimit
2414 #define ors_tlimit oq_search.rs_tlimit
2415 #define ors_limit oq_search.rs_limit
2416 #define ors_attrsonly oq_search.rs_attrsonly
2417 #define ors_attrs oq_search.rs_attrs
2418 #define ors_filter oq_search.rs_filter
2419 #define ors_filterstr oq_search.rs_filterstr
2421 #define orr_newrdn oq_modrdn.rs_newrdn
2422 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2423 #define orr_newSup oq_modrdn.rs_newSup
2424 #define orr_nnewSup oq_modrdn.rs_nnewSup
2425 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2426 #define orr_modlist oq_modrdn.rs_modlist
2428 #define orc_ava oq_compare.rs_ava
2429 #define ora_e oq_add.rs_e
2430 #define ora_modlist oq_add.rs_modlist
2431 #define orn_msgid oq_abandon.rs_msgid
2432 #define orm_modlist oq_modify.rs_modlist
2433 #define orm_increment oq_modify.rs_increment
2435 #define ore_reqoid oq_extended.rs_reqoid
2436 #define ore_flags oq_extended.rs_flags
2437 #define ore_reqdata oq_extended.rs_reqdata
2438 volatile sig_atomic_t o_abandon; /* abandon flag */
2439 volatile sig_atomic_t o_cancel; /* cancel flag */
2440 #define SLAP_CANCEL_NONE 0x00
2441 #define SLAP_CANCEL_REQ 0x01
2442 #define SLAP_CANCEL_ACK 0x02
2443 #define SLAP_CANCEL_DONE 0x03
2445 GroupAssertion *o_groups;
2446 char o_do_not_cache; /* don't cache groups from this op */
2447 char o_is_auth_check; /* authorization in progress */
2450 char o_delete_glue_parent;
2451 char o_no_schema_check;
2452 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2454 #define SLAP_CONTROL_NONE 0
2455 #define SLAP_CONTROL_IGNORED 1
2456 #define SLAP_CONTROL_NONCRITICAL 2
2457 #define SLAP_CONTROL_CRITICAL 3
2458 #define SLAP_CONTROL_MASK 3
2460 /* spare bits for simple flags */
2461 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2462 #define SLAP_CONTROL_DATA0 0x10
2463 #define SLAP_CONTROL_DATA1 0x20
2464 #define SLAP_CONTROL_DATA2 0x40
2465 #define SLAP_CONTROL_DATA3 0x80
2468 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2470 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2471 void **o_controls; /* per-control state */
2473 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2474 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2476 #define o_managedit o_ctrlflag[slap_cids.sc_manageDIT]
2477 #define get_manageDIT(op) _SCM((op)->o_managedit)
2479 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2480 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2482 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2483 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2484 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2486 #define get_subentries(op) _SCM((op)->o_subentries)
2487 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2489 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2490 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2492 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2493 #define get_assert(op) ((int)(op)->o_assert)
2494 #define o_assertion o_controls[slap_cids.sc_assert]
2495 #define get_assertion(op) ((op)->o_assertion)
2497 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2498 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2500 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2501 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2503 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2504 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2506 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2507 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2509 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2510 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2512 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2513 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2515 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2516 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2517 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2520 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2523 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2525 AuthorizationInformation o_authz;
2527 BerElement *o_ber; /* ber of the request */
2528 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2529 slap_callback *o_callback; /* callback pointers */
2530 LDAPControl **o_ctrls; /* controls */
2531 struct berval o_csn;
2533 void *o_private; /* anything the backend needs */
2535 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2538 #define OPERATION_BUFFER_SIZE ( sizeof(Operation) + sizeof(Opheader) + \
2539 SLAP_MAX_CIDS*sizeof(void *) )
2541 typedef LBER_ALIGNED_BUFFER(operation_buffer_u,OPERATION_BUFFER_SIZE)
2544 #define send_ldap_error( op, rs, err, text ) do { \
2545 (rs)->sr_err = err; (rs)->sr_text = text; \
2546 (op->o_conn->c_send_ldap_result)( op, rs ); \
2548 #define send_ldap_discon( op, rs, err, text ) do { \
2549 (rs)->sr_err = err; (rs)->sr_text = text; \
2550 send_ldap_disconnect( op, rs ); \
2553 typedef void (SEND_LDAP_RESULT)(
2554 struct slap_op *op, struct slap_rep *rs);
2555 typedef int (SEND_SEARCH_ENTRY)(
2556 struct slap_op *op, struct slap_rep *rs);
2557 typedef int (SEND_SEARCH_REFERENCE)(
2558 struct slap_op *op, struct slap_rep *rs);
2559 typedef void (SEND_LDAP_EXTENDED)(
2560 struct slap_op *op, struct slap_rep *rs);
2561 typedef void (SEND_LDAP_INTERMEDIATE)(
2562 struct slap_op *op, struct slap_rep *rs);
2564 #define send_ldap_result( op, rs ) \
2565 ((op)->o_conn->c_send_ldap_result)( op, rs )
2566 #define send_search_entry( op, rs ) \
2567 ((op)->o_conn->c_send_search_entry)( op, rs )
2568 #define send_search_reference( op, rs ) \
2569 ((op)->o_conn->c_send_search_reference)( op, rs )
2570 #define send_ldap_extended( op, rs ) \
2571 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2572 #define send_ldap_intermediate( op, rs ) \
2573 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2575 typedef struct slap_listener Listener;
2578 * represents a connection from an ldap client
2580 typedef struct slap_conn {
2581 int c_struct_state; /* structure management state */
2582 int c_conn_state; /* connection state */
2583 int c_conn_idx; /* slot in connections array */
2584 const char *c_close_reason; /* why connection is closing */
2586 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2587 Sockbuf *c_sb; /* ber connection stuff */
2589 /* only can be changed by connect_init */
2590 time_t c_starttime; /* when the connection was opened */
2591 time_t c_activitytime; /* when the connection was last used */
2592 unsigned long c_connid; /* id of this connection for stats*/
2594 struct berval c_peer_domain; /* DNS name of client */
2595 struct berval c_peer_name; /* peer name (trans=addr:port) */
2596 Listener *c_listener;
2597 #define c_listener_url c_listener->sl_url /* listener URL */
2598 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2600 /* only can be changed by binding thread */
2601 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2602 struct berval c_sasl_bind_mech; /* mech in progress */
2603 struct berval c_sasl_dn; /* temporary storage */
2604 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2606 /* authorization backend */
2607 Backend *c_authz_backend;
2608 void *c_authz_cookie;
2609 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2610 ( (op)->o_bd != NULL \
2611 && (op)->o_bd->be_private != NULL \
2612 && (op)->o_conn != NULL \
2613 && (op)->o_conn->c_authz_backend != NULL \
2614 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2615 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2617 AuthorizationInformation c_authz;
2619 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2621 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2622 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2624 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2625 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2627 BerElement *c_currentber; /* ber we're attempting to read */
2628 int c_writewaiter; /* true if writer is waiting */
2630 #define CONN_IS_TLS 1
2631 #define CONN_IS_UDP 2
2632 #define CONN_IS_CLIENT 3
2634 #ifdef LDAP_CONNECTIONLESS
2635 int c_is_udp; /* true if this is (C)LDAP over UDP */
2638 int c_is_tls; /* true if this LDAP over raw TLS */
2639 int c_needs_tls_accept; /* true if SSL_accept should be called */
2641 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2642 int c_sasl_done; /* SASL completed once */
2643 void *c_sasl_authctx; /* SASL authentication context */
2644 void *c_sasl_sockctx; /* SASL security layer context */
2645 void *c_sasl_extra; /* SASL session extra stuff */
2646 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2648 PagedResultsState c_pagedresults_state; /* paged result state */
2650 long c_n_ops_received; /* num of ops received (next op_id) */
2651 long c_n_ops_executing; /* num of ops currently executing */
2652 long c_n_ops_pending; /* num of ops pending execution */
2653 long c_n_ops_completed; /* num of ops completed */
2655 long c_n_get; /* num of get calls */
2656 long c_n_read; /* num of read calls */
2657 long c_n_write; /* num of write calls */
2659 void *c_pb; /* Netscape plugin */
2660 void *c_extensions; /* Netscape plugin */
2663 * Client connection handling
2665 ldap_pvt_thread_start_t *c_clientfunc;
2669 * These are the "callbacks" that are available for back-ends to
2670 * supply data back to connected clients that are connected
2671 * through the "front-end".
2673 SEND_LDAP_RESULT *c_send_ldap_result;
2674 SEND_SEARCH_ENTRY *c_send_search_entry;
2675 SEND_SEARCH_REFERENCE *c_send_search_reference;
2676 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2677 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2680 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2681 #define Statslog1( level, severity, fmt, connid, opid, arg1 ) \
2683 if ( ldap_debug & (level) ) \
2684 fprintf( stderr, (fmt), (connid), (opid), (arg1) );\
2685 if ( ldap_syslog & (level) ) \
2686 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2689 #define Statslog2( level, severity, fmt, connid, opid, arg1, arg2 ) \
2691 if ( ldap_debug & (level) ) \
2692 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2) );\
2693 if ( ldap_syslog & (level) ) \
2694 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2697 #define Statslog3( level, severity, fmt, connid, opid, arg1, arg2, arg3 ) \
2699 if ( ldap_debug & (level) ) \
2700 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2701 if ( ldap_syslog & (level) ) \
2702 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2703 (arg1), (arg2), (arg3) ); \
2705 #define Statslog4( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4 ) \
2707 if ( ldap_debug & (level) ) \
2708 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4) );\
2709 if ( ldap_syslog & (level) ) \
2710 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2711 (arg1), (arg2), (arg3), (arg4) ); \
2713 #define Statslog5( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4, arg5 ) \
2715 if ( ldap_debug & (level) ) \
2716 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4), (arg5) );\
2717 if ( ldap_syslog & (level) ) \
2718 syslog( LDAP_LEVEL_MASK((severity)), (fmt), (connid), (opid), \
2719 (arg1), (arg2), (arg3), (arg4), (arg5) ); \
2721 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2722 Statslog3( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2723 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2724 #elif defined(LDAP_DEBUG)
2725 #define Statslog1( level, severity, fmt, connid, opid, arg1 ) \
2727 if ( ldap_debug & (level) ) \
2728 fprintf( stderr, (fmt), (connid), (opid), (arg1) );\
2730 #define Statslog2( level, severity, fmt, connid, opid, arg1, arg2 ) \
2732 if ( ldap_debug & (level) ) \
2733 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2) );\
2735 #define Statslog3( level, severity, fmt, connid, opid, arg1, arg2, arg3 ) \
2737 if ( ldap_debug & (level) ) \
2738 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2740 #define Statslog4( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4 ) \
2742 if ( ldap_debug & (level) ) \
2743 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4) );\
2745 #define Statslog5( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4, arg5 ) \
2747 if ( ldap_debug & (level) ) \
2748 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3), (arg4), (arg5) );\
2750 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2752 if ( ldap_debug & (level) ) \
2753 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2755 #define StatslogTest( level ) (ldap_debug & (level))
2757 #define Statslog1( level, severity, fmt, connid, opid, arg1 )
2758 #define Statslog2( level, severity, fmt, connid, opid, arg1, arg2 )
2759 #define Statslog3( level, severity, fmt, connid, opid, arg1, arg2, arg3 )
2760 #define Statslog4( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4 )
2761 #define Statslog5( level, severity, fmt, connid, opid, arg1, arg2, arg3, arg4, arg5 )
2762 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2763 #define StatslogTest( level ) (0)
2767 * listener; need to access it from monitor backend
2769 struct slap_listener {
2770 struct berval sl_url;
2771 struct berval sl_name;
2776 #ifdef LDAP_CONNECTIONLESS
2777 int sl_is_udp; /* UDP listener is also data port */
2779 int sl_mute; /* Listener is temporarily disabled due to emfile */
2780 #ifdef SLAP_LIGHTWEIGHT_DISPATCHER
2781 int sl_busy; /* Listener is busy (accept thread activated) */
2785 #define sl_addr sl_sa.sa_in_addr
2805 typedef struct slap_counters_t {
2806 ldap_pvt_thread_mutex_t sc_sent_mutex;
2807 ldap_pvt_mp_t sc_bytes;
2808 ldap_pvt_mp_t sc_pdu;
2809 ldap_pvt_mp_t sc_entries;
2810 ldap_pvt_mp_t sc_refs;
2812 ldap_pvt_thread_mutex_t sc_ops_mutex;
2813 ldap_pvt_mp_t sc_ops_completed;
2814 ldap_pvt_mp_t sc_ops_initiated;
2815 #ifdef SLAPD_MONITOR
2816 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2817 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2818 #endif /* SLAPD_MONITOR */
2822 * Better know these all around slapd
2824 #define SLAP_LDAPDN_PRETTY 0x1
2825 #define SLAP_LDAPDN_MAXLEN 8192
2827 /* number of response controls supported */
2828 #define SLAP_MAX_RESPONSE_CONTROLS 6
2831 #define SLAP_CTRL_HIDE 0x00000000U
2833 #define SLAP_CTRL_HIDE 0x80000000U
2836 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for ManageDIT */
2838 #define SLAP_CTRL_GLOBAL 0x00800000U
2839 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2841 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2842 #define SLAP_CTRL_ABANDON 0x00000001U
2843 #define SLAP_CTRL_ADD 0x00002002U
2844 #define SLAP_CTRL_BIND 0x00000004U
2845 #define SLAP_CTRL_COMPARE 0x00001008U
2846 #define SLAP_CTRL_DELETE 0x00002010U
2847 #define SLAP_CTRL_MODIFY 0x00002020U
2848 #define SLAP_CTRL_RENAME 0x00002040U
2849 #define SLAP_CTRL_SEARCH 0x00001080U
2850 #define SLAP_CTRL_UNBIND 0x00000100U
2852 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2853 #define SLAP_CTRL_UPDATE \
2854 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2855 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2857 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2860 LDAPControl *ctrl ));
2862 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
2864 #define SLAP_SLAB_SIZE (1024*1024)
2865 #define SLAP_SLAB_STACK 1
2866 #define SLAP_SLAB_SOBLOCK 64
2868 #define SLAP_ZONE_ALLOC 1
2869 #undef SLAP_ZONE_ALLOC
2871 #ifdef LDAP_COMP_MATCH
2873 * Extensible Filter Definition
2875 * MatchingRuleAssertion := SEQUENCE {
2876 * matchingRule [1] MatchingRuleId OPTIONAL,
2877 * type [2] AttributeDescription OPTIONAL,
2878 * matchValue [3] AssertionValue,
2879 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2881 * Following ComponentFilter is contained in matchValue
2883 * ComponentAssertion ::= SEQUENCE {
2884 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2885 * useDefaultValues BOOLEAN DEFAULT TRUE,
2886 * rule MATCHING-RULE.&id,
2887 * value MATCHING-RULE.&AssertionType }
2889 * ComponentFilter ::= CHOICE {
2890 * item [0] ComponentAssertion,
2891 * and [1] SEQUENCE OF ComponentFilter,
2892 * or [2] SEQUENCE OF ComponentFilter,
2893 * not [3] ComponentFilter }
2896 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2897 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2898 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2899 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2900 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2901 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2902 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2903 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2904 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2906 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2907 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2908 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2909 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2910 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2912 typedef struct slap_component_id {
2914 struct slap_component_id *ci_next;
2916 union comp_id_value{
2917 BerValue ci_identifier;
2918 ber_int_t ci_from_beginning;
2920 ber_int_t ci_from_end;
2921 ber_int_t ci_content;
2922 BerValue ci_select_value;
2927 typedef struct slap_component_reference {
2928 ComponentId *cr_list;
2929 ComponentId *cr_curr;
2930 struct berval cr_string;
2932 /* Component Indexing */
2934 slap_mask_t cr_indexmask;
2935 AttributeDescription* cr_ad;
2937 struct slap_component_reference* cr_next;
2938 } ComponentReference;
2940 typedef struct slap_component_assertion {
2941 ComponentReference *ca_comp_ref;
2942 ber_int_t ca_use_def;
2943 MatchingRule *ca_ma_rule;
2944 struct berval ca_ma_value;
2945 ComponentData ca_comp_data; /* componentized assertion */
2946 struct slap_component_filter *ca_cf;
2947 MatchingRuleAssertion *ca_mra;
2948 } ComponentAssertion;
2950 typedef struct slap_component_filter {
2951 ber_tag_t cf_choice;
2953 ber_int_t cf_un_result;
2954 ComponentAssertion *cf_un_ca;
2955 struct slap_component_filter *cf_un_complex;
2958 #define cf_ca cf_un.cf_un_ca
2959 #define cf_result cf_un.cf_un_result
2960 #define cf_and cf_un.cf_un_complex
2961 #define cf_or cf_un.cf_un_complex
2962 #define cf_not cf_un.cf_un_complex
2963 #define cf_any cf_un.cf_un_complex
2965 struct slap_component_filter *cf_next;
2968 typedef struct slap_component_assertion_value {
2972 } ComponentAssertionValue;
2974 typedef int encoder_func LDAP_P((
2978 struct slap_component_syntax_info;
2980 typedef int gser_decoder_func LDAP_P((
2983 struct slap_component_syntax_info** comp_syn_info,
2987 typedef int comp_free_func LDAP_P((
2990 typedef int ber_decoder_func LDAP_P((
2995 struct slap_component_syntax_info* comp_syn_info,
2999 typedef int ber_tag_decoder_func LDAP_P((
3002 struct slap_component_syntax_info* comp_syn_info,
3006 typedef void* extract_component_from_id_func LDAP_P((
3008 ComponentReference* cr,
3011 typedef void* convert_attr_to_comp_func LDAP_P ((
3014 struct berval* bv ));
3016 typedef void* alloc_nibble_func LDAP_P ((
3018 int increment_size ));
3020 typedef void free_nibble_func LDAP_P ((
3023 struct slap_component_syntax_info;
3024 typedef void convert_assert_to_comp_func LDAP_P ((
3026 struct slap_component_syntax_info* csi_attr,
3028 struct slap_component_syntax_info** csi,
3032 typedef int convert_asn_to_ldap_func LDAP_P ((
3033 struct slap_component_syntax_info* csi,
3034 struct berval *bv ));
3036 typedef void free_component_func LDAP_P ((
3039 typedef int test_component_func LDAP_P ((
3041 void* assert_mem_op,
3042 struct slap_component_syntax_info* csi,
3043 struct slap_component_assertion* ca));
3045 typedef void* test_membership_func LDAP_P ((
3048 typedef void* get_component_info_func LDAP_P ((
3051 struct slap_component_syntax_info;
3053 typedef int component_encoder_func LDAP_P ((
3055 struct slap_component_syntax_info* csi,
3056 struct berval* nvals ));
3058 typedef int allcomponent_matching_func LDAP_P((
3060 struct slap_component_syntax_info* comp1,
3061 struct slap_component_syntax_info* comp));
3063 typedef struct slap_component_desc {
3064 /* Don't change the order of following four fields */
3066 AttributeType *cd_comp_type;
3067 struct berval cd_ad_type;/* ad_type, ad_cname */
3068 struct berval cd_ad_cname;/* ad_type, ad_cname */
3069 unsigned cd_flags; /*ad_flags*/
3072 encoder_func *cd_ldap_encoder;
3073 encoder_func *cd_gser_encoder;
3074 encoder_func *cd_ber_encoder;
3075 gser_decoder_func *cd_gser_decoder;
3076 ber_decoder_func *cd_ber_decoder;
3077 comp_free_func *cd_free;
3078 extract_component_from_id_func* cd_extract_i;
3079 allcomponent_matching_func *cd_all_match;
3082 typedef struct slap_component_syntax_info {
3084 ComponentDesc* csi_comp_desc;
3085 } ComponentSyntaxInfo;
3089 /* slab heap data structures */
3091 struct slab_object {
3094 LDAP_LIST_ENTRY(slab_object) so_link;
3103 unsigned char **sh_map;
3104 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3105 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3108 #ifdef SLAP_ZONE_ALLOC
3109 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3110 #define SLAP_ZONE_SHIFT 19
3111 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3112 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3113 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3114 #define SLAP_ZONE_ZOBLOCK 256
3116 struct zone_object {
3121 LDAP_LIST_ENTRY(zone_object) zo_link;
3124 struct zone_latency_history {
3126 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3137 ldap_pvt_thread_rdwr_t *zh_znlock;
3138 Avlnode *zh_zonetree;
3139 unsigned char ***zh_maps;
3141 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3142 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3143 ldap_pvt_thread_mutex_t zh_mutex;
3144 ldap_pvt_thread_rdwr_t zh_lock;
3145 double zh_ema_latency;
3146 unsigned long zh_ema_samples;
3147 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3148 zh_latency_history_queue;
3149 int zh_latency_history_qlen;
3150 int zh_latency_jump;
3155 #define SLAP_BACKEND_INIT_MODULE(b) \
3156 static BackendInfo bi; \
3158 init_module( int argc, char *argv[] ) \
3161 bi.bi_init = b ## _back_initialize; \
3162 backend_add( &bi ); \
3166 typedef int (OV_init)(void);
3167 typedef struct slap_oinit_t {
3168 const char *ov_type;
3174 #include "proto-slap.h"
3176 #endif /* _SLAP_H_ */