1 /* slap.h - stand alone ldap server include file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2004 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 * SLAPD Memory allocation macros
64 * Unlike ch_*() routines, these routines do not assert() upon
65 * allocation error. They are intended to be used instead of
66 * ch_*() routines where the caller has implemented proper
67 * checking for and handling of allocation errors.
69 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
71 #define SLAP_MALLOC(s) ber_memalloc((s))
72 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
73 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
74 #define SLAP_FREE(p) ber_memfree((p))
75 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
76 #define SLAP_STRDUP(s) ber_strdup((s))
77 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
80 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
83 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
84 #define SLAPD_ANONYMOUS "cn=anonymous"
86 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
87 * This is a value used internally by the backends. It is needed to allow
88 * adding values that already exist without getting an error as required by
89 * modrdn when the new rdn was already an attribute value itself.
91 #define SLAP_MOD_SOFTADD 0x1000
93 #define MAXREMATCHES (100)
95 #define SLAP_MAX_WORKER_THREADS (16)
97 #define SLAP_MAX_SYNCREPL_THREADS (8)
99 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
100 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
102 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
103 #define SLAP_CONN_MAX_PENDING_AUTH 1000
105 #define SLAP_TEXT_BUFLEN (256)
107 /* psuedo error code indicating abandoned operation */
108 #define SLAPD_ABANDON (-1024)
110 /* psuedo error code indicating disconnect */
111 #define SLAPD_DISCONNECT (-1025)
113 /* unknown config file directive */
114 #define SLAP_CONF_UNKNOWN (-1026)
116 /* We assume "C" locale, that is US-ASCII */
117 #define ASCII_SPACE(c) ( (c) == ' ' )
118 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
119 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
120 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
121 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
122 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
123 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
124 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
125 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
126 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
127 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
129 #define SLAP_NIBBLE(c) ((c)&0x0f)
130 #define SLAP_ESCAPE_CHAR ('\\')
131 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
132 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
134 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
135 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
137 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
138 /* NOTE: for consistency, this macro must only operate
139 * on normalized/pretty DN, such that ';' is never used
140 * as RDN separator, and all occurrences of ';' must be escaped */
141 #define DN_SEPARATOR(c) ((c) == ',')
142 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
143 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
144 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
146 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
147 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
148 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
149 #define OID_SEPARATOR(c) ( (c) == '.' )
150 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
152 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
153 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
155 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
156 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
158 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
160 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
161 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
162 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
163 (c) == '?' || (c) == ' ' || (c) == '=' )
164 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
166 /* must match in schema_init.c */
167 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
168 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
169 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
170 #define SLAPD_GROUP_ATTR "member"
171 #define SLAPD_GROUP_CLASS "groupOfNames"
172 #define SLAPD_ROLE_ATTR "roleOccupant"
173 #define SLAPD_ROLE_CLASS "organizationalRole"
175 #ifdef SLAPD_ACI_ENABLED
176 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
179 /* change this to "OpenLDAPset" */
180 #define SLAPD_ACI_SET_ATTR "template"
182 #define SLAPD_TOP_OID "2.5.6.0"
184 LDAP_SLAPD_V (int) slap_debug;
186 typedef unsigned long slap_mask_t;
188 /* Security Strength Factor */
189 typedef unsigned slap_ssf_t;
191 typedef struct slap_ssf_set {
193 slap_ssf_t sss_transport;
196 slap_ssf_t sss_update_ssf;
197 slap_ssf_t sss_update_transport;
198 slap_ssf_t sss_update_tls;
199 slap_ssf_t sss_update_sasl;
200 slap_ssf_t sss_simple_bind;
203 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
204 #define SLAP_GETDN_AUTHCID 2
205 #define SLAP_GETDN_AUTHZID 4
210 #define SLAP_INDEX_TYPE 0x00FFUL
211 #define SLAP_INDEX_UNDEFINED 0x0001UL
212 #define SLAP_INDEX_PRESENT 0x0002UL
213 #define SLAP_INDEX_EQUALITY 0x0004UL
214 #define SLAP_INDEX_APPROX 0x0008UL
215 #define SLAP_INDEX_SUBSTR 0x0010UL
216 #define SLAP_INDEX_EXTENDED 0x0020UL
218 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
220 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
222 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
224 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
225 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
226 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
227 #define SLAP_INDEX_SUBSTR_DEFAULT \
228 ( SLAP_INDEX_SUBSTR \
229 | SLAP_INDEX_SUBSTR_INITIAL \
230 | SLAP_INDEX_SUBSTR_ANY \
231 | SLAP_INDEX_SUBSTR_FINAL )
233 /* constants for initial/final substrings indices */
234 #ifndef SLAP_INDEX_SUBSTR_IF_MINLEN
235 # define SLAP_INDEX_SUBSTR_IF_MINLEN 2
237 #ifndef SLAP_INDEX_SUBSTR_IF_MAXLEN
238 # define SLAP_INDEX_SUBSTR_IF_MAXLEN 4
241 /* constants for any substrings indices */
242 #ifndef SLAP_INDEX_SUBSTR_ANY_LEN
243 # define SLAP_INDEX_SUBSTR_ANY_LEN 4
245 #ifndef SLAP_INDEX_SUBSTR_ANY_STEP
246 # define SLAP_INDEX_SUBSTR_ANY_STEP 2
249 #define SLAP_INDEX_FLAGS 0xF000UL
250 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
251 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
254 * there is a single index for each attribute. these prefixes ensure
255 * that there is no collision among keys.
257 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
258 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
259 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
260 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
261 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
262 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
264 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
265 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
266 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
267 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
268 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
271 * represents schema information for a database
273 #define SLAP_SCHERR_OUTOFMEM 1
274 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
275 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
276 #define SLAP_SCHERR_CLASS_BAD_SUP 4
277 #define SLAP_SCHERR_CLASS_DUP 5
278 #define SLAP_SCHERR_ATTR_NOT_FOUND 6
279 #define SLAP_SCHERR_ATTR_BAD_MR 7
280 #define SLAP_SCHERR_ATTR_BAD_USAGE 8
281 #define SLAP_SCHERR_ATTR_BAD_SUP 9
282 #define SLAP_SCHERR_ATTR_INCOMPLETE 10
283 #define SLAP_SCHERR_ATTR_DUP 11
284 #define SLAP_SCHERR_MR_NOT_FOUND 12
285 #define SLAP_SCHERR_MR_INCOMPLETE 13
286 #define SLAP_SCHERR_MR_DUP 14
287 #define SLAP_SCHERR_SYN_NOT_FOUND 15
288 #define SLAP_SCHERR_SYN_DUP 16
289 #define SLAP_SCHERR_NO_NAME 17
290 #define SLAP_SCHERR_NOT_SUPPORTED 18
291 #define SLAP_SCHERR_BAD_DESCR 19
292 #define SLAP_SCHERR_OIDM 20
293 #define SLAP_SCHERR_CR_DUP 21
294 #define SLAP_SCHERR_CR_BAD_STRUCT 22
295 #define SLAP_SCHERR_CR_BAD_AUX 23
296 #define SLAP_SCHERR_CR_BAD_AT 24
297 #define SLAP_SCHERR_LAST SLAP_SCHERR_CR_BAD_AT
299 typedef union slap_sockaddr {
300 struct sockaddr sa_addr;
301 struct sockaddr_in sa_in_addr;
303 struct sockaddr_storage sa_storage;
304 struct sockaddr_in6 sa_in6_addr;
307 struct sockaddr_un sa_un_addr;
312 extern int slap_inet4or6;
315 typedef struct slap_oid_macro {
316 struct berval som_oid;
318 LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
321 /* forward declarations */
323 struct slap_matching_rule;
325 typedef int slap_syntax_validate_func LDAP_P((
326 struct slap_syntax *syntax,
327 struct berval * in));
329 typedef int slap_syntax_transform_func LDAP_P((
330 struct slap_syntax *syntax,
336 #define LDAP_COMP_MATCH
339 #ifdef LDAP_COMP_MATCH
340 typedef void* slap_component_transform_func LDAP_P((
341 struct berval * in ));
342 struct ComponentDesc;
345 typedef struct slap_syntax {
347 #define ssyn_oid ssyn_syn.syn_oid
348 #define ssyn_desc ssyn_syn.syn_desc
349 #define ssyn_extensions ssyn_syn.syn_extensions
352 ber_len_t ssyn_oidlen;
353 * has been replaced by a struct berval that uses the value
354 * provided by ssyn_syn.syn_oid; a macro that expands to
355 * the bv_len field of the berval is provided for backward
356 * compatibility. CAUTION: NEVER FREE THE BERVAL
358 struct berval ssyn_bvoid;
359 #define ssyn_oidlen ssyn_bvoid.bv_len
361 unsigned int ssyn_flags;
363 #define SLAP_SYNTAX_NONE 0x0000U
364 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
365 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
366 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
368 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
370 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
373 slap_syntax_validate_func *ssyn_validate;
374 slap_syntax_transform_func *ssyn_pretty;
376 #ifdef SLAPD_BINARY_CONVERSION
377 /* convert to and from binary */
378 slap_syntax_transform_func *ssyn_ber2str;
379 slap_syntax_transform_func *ssyn_str2ber;
381 #ifdef LDAP_COMP_MATCH
382 slap_component_transform_func *ssyn_attr2comp;
383 struct ComponentDesc* ssync_comp_syntax;
386 LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
389 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
390 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
391 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
392 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
393 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
395 typedef struct slap_syntax_defs_rec {
398 slap_syntax_validate_func *sd_validate;
399 slap_syntax_transform_func *sd_pretty;
400 #ifdef SLAPD_BINARY_CONVERSION
401 slap_syntax_transform_func *sd_ber2str;
402 slap_syntax_transform_func *sd_str2ber;
404 } slap_syntax_defs_rec;
406 /* X -> Y Converter */
407 typedef int slap_mr_convert_func LDAP_P((
413 typedef int slap_mr_normalize_func LDAP_P((
415 struct slap_syntax *syntax, /* NULL if in is asserted value */
416 struct slap_matching_rule *mr,
421 /* Match (compare) function */
422 typedef int slap_mr_match_func LDAP_P((
425 struct slap_syntax *syntax, /* syntax of stored value */
426 struct slap_matching_rule *mr,
427 struct berval * value,
428 void * assertValue ));
430 /* Index generation function */
431 typedef int slap_mr_indexer_func LDAP_P((
434 struct slap_syntax *syntax, /* syntax of stored value */
435 struct slap_matching_rule *mr,
436 struct berval *prefix,
441 /* Filter index function */
442 typedef int slap_mr_filter_func LDAP_P((
445 struct slap_syntax *syntax, /* syntax of stored value */
446 struct slap_matching_rule *mr,
447 struct berval *prefix,
452 typedef struct slap_matching_rule_use MatchingRuleUse;
454 typedef struct slap_matching_rule {
455 LDAPMatchingRule smr_mrule;
456 MatchingRuleUse *smr_mru;
457 /* RFC2252 string representation */
458 struct berval smr_str;
461 * ber_len_t smr_oidlen;
462 * has been replaced by a struct berval that uses the value
463 * provided by smr_mrule.mr_oid; a macro that expands to
464 * the bv_len field of the berval is provided for backward
465 * compatibility. CAUTION: NEVER FREE THE BERVAL
467 struct berval smr_bvoid;
468 #define smr_oidlen smr_bvoid.bv_len
470 slap_mask_t smr_usage;
473 #define SLAP_MR_HIDE 0x0000U
475 #define SLAP_MR_HIDE 0x8000U
478 #define SLAP_MR_TYPE_MASK 0x0F00U
479 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
480 #define SLAP_MR_USAGE 0x000FU
482 #define SLAP_MR_NONE 0x0000U
483 #define SLAP_MR_EQUALITY 0x0100U
484 #define SLAP_MR_ORDERING 0x0200U
485 #define SLAP_MR_SUBSTR 0x0400U
486 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
487 #ifdef LDAP_COMP_MATCH
488 #define SLAP_MR_COMPONENT 0x1000U
491 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
493 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
494 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
495 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
499 * The asserted value, depending on the particular usage,
500 * is expected to conform to either the assertion syntax
501 * or the attribute syntax. In some cases, the syntax of
502 * the value is known. If so, these flags indicate which
503 * syntax the value is expected to conform to. If not,
504 * neither of these flags is set (until the syntax of the
505 * provided value is determined). If the value is of the
506 * attribute syntax, the flag is changed once a value of
507 * the assertion syntax is derived from the provided value.
509 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
510 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
511 #define SLAP_MR_VALUE_OF_SYNTAX 0x0003U
513 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
514 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
515 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
516 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
518 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
519 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
521 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
524 /* either or both the asserted value or attribute value
525 * may be provided in normalized form
527 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
528 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
530 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
531 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
532 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
533 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
535 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
536 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
537 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
538 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
539 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
540 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
542 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
543 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
544 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
545 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
548 slap_mr_convert_func *smr_convert;
549 slap_mr_normalize_func *smr_normalize;
550 slap_mr_match_func *smr_match;
551 slap_mr_indexer_func *smr_indexer;
552 slap_mr_filter_func *smr_filter;
555 * null terminated array of syntaxes compatible with this syntax
556 * note: when MS_EXT is set, this MUST NOT contain the assertion
557 * syntax of the rule. When MS_EXT is not set, it MAY.
559 Syntax **smr_compat_syntaxes;
562 * For equality rules, refers to an associated approximate rule.
563 * For non-equality rules, refers to an associated equality rule.
565 struct slap_matching_rule *smr_associated;
567 #define SLAP_MR_ASSOCIATED(mr,amr) \
568 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
570 LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
572 #define smr_oid smr_mrule.mr_oid
573 #define smr_names smr_mrule.mr_names
574 #define smr_desc smr_mrule.mr_desc
575 #define smr_obsolete smr_mrule.mr_obsolete
576 #define smr_syntax_oid smr_mrule.mr_syntax_oid
577 #define smr_extensions smr_mrule.mr_extensions
580 struct slap_matching_rule_use {
581 LDAPMatchingRuleUse smru_mruleuse;
582 MatchingRule *smru_mr;
583 /* RFC2252 string representation */
584 struct berval smru_str;
586 LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
588 #define smru_oid smru_mruleuse.mru_oid
589 #define smru_names smru_mruleuse.mru_names
590 #define smru_desc smru_mruleuse.mru_desc
591 #define smru_obsolete smru_mruleuse.mru_obsolete
592 #define smru_applies_oids smru_mruleuse.mru_applies_oids
594 #define smru_usage smru_mr->smr_usage
595 } /* MatchingRuleUse */ ;
597 typedef struct slap_mrule_defs_rec {
599 slap_mask_t mrd_usage;
600 char ** mrd_compat_syntaxes;
601 slap_mr_convert_func * mrd_convert;
602 slap_mr_normalize_func * mrd_normalize;
603 slap_mr_match_func * mrd_match;
604 slap_mr_indexer_func * mrd_indexer;
605 slap_mr_filter_func * mrd_filter;
607 /* For equality rule, this may refer to an associated approximate rule */
608 /* For non-equality rule, this may refer to an associated equality rule */
609 char * mrd_associated;
610 } slap_mrule_defs_rec;
612 struct slap_backend_db;
616 typedef int (AttributeTypeSchemaCheckFN)(
617 struct slap_backend_db *be,
618 struct slap_entry *e,
619 struct slap_attr *attr,
621 char *textbuf, size_t textlen );
623 typedef struct slap_attribute_type {
624 LDAPAttributeType sat_atype;
625 struct berval sat_cname;
626 struct slap_attribute_type *sat_sup;
627 struct slap_attribute_type **sat_subtypes;
628 MatchingRule *sat_equality;
629 MatchingRule *sat_approx;
630 MatchingRule *sat_ordering;
631 MatchingRule *sat_substr;
634 AttributeTypeSchemaCheckFN *sat_check;
636 #define SLAP_AT_NONE 0x0000U
637 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
638 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
640 #define SLAP_AT_HIDE 0x0000U /* publish everything */
642 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
644 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
646 slap_mask_t sat_flags;
648 LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
650 #define sat_oid sat_atype.at_oid
651 #define sat_names sat_atype.at_names
652 #define sat_desc sat_atype.at_desc
653 #define sat_obsolete sat_atype.at_obsolete
654 #define sat_sup_oid sat_atype.at_sup_oid
655 #define sat_equality_oid sat_atype.at_equality_oid
656 #define sat_ordering_oid sat_atype.at_ordering_oid
657 #define sat_substr_oid sat_atype.at_substr_oid
658 #define sat_syntax_oid sat_atype.at_syntax_oid
659 #define sat_single_value sat_atype.at_single_value
660 #define sat_collective sat_atype.at_collective
661 #define sat_no_user_mod sat_atype.at_no_user_mod
662 #define sat_usage sat_atype.at_usage
663 #define sat_extensions sat_atype.at_extensions
665 struct slap_attr_desc *sat_ad;
666 ldap_pvt_thread_mutex_t sat_ad_mutex;
669 #define is_at_operational(at) ((at)->sat_usage)
670 #define is_at_single_value(at) ((at)->sat_single_value)
671 #define is_at_collective(at) ((at)->sat_collective)
672 #define is_at_obsolete(at) ((at)->sat_obsolete)
673 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
675 struct slap_object_class;
677 typedef int (ObjectClassSchemaCheckFN)(
678 struct slap_backend_db *be,
679 struct slap_entry *e,
680 struct slap_object_class *oc,
682 char *textbuf, size_t textlen );
684 typedef struct slap_object_class {
685 LDAPObjectClass soc_oclass;
686 struct berval soc_cname;
687 struct slap_object_class **soc_sups;
688 AttributeType **soc_required;
689 AttributeType **soc_allowed;
690 ObjectClassSchemaCheckFN *soc_check;
691 slap_mask_t soc_flags;
692 #define soc_oid soc_oclass.oc_oid
693 #define soc_names soc_oclass.oc_names
694 #define soc_desc soc_oclass.oc_desc
695 #define soc_obsolete soc_oclass.oc_obsolete
696 #define soc_sup_oids soc_oclass.oc_sup_oids
697 #define soc_kind soc_oclass.oc_kind
698 #define soc_at_oids_must soc_oclass.oc_at_oids_must
699 #define soc_at_oids_may soc_oclass.oc_at_oids_may
700 #define soc_extensions soc_oclass.oc_extensions
702 LDAP_SLIST_ENTRY(slap_object_class) soc_next;
705 #define SLAP_OC_ALIAS 0x0001
706 #define SLAP_OC_REFERRAL 0x0002
707 #define SLAP_OC_SUBENTRY 0x0004
708 #define SLAP_OC_DYNAMICOBJECT 0x0008
709 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
710 #define SLAP_OC_GLUE 0x0020
711 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
712 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
713 #define SLAP_OC__MASK 0x00FF
714 #define SLAP_OC__END 0x0100
715 #define SLAP_OC_OPERATIONAL 0x4000
717 #define SLAP_OC_HIDE 0x0000
719 #define SLAP_OC_HIDE 0x8000
725 typedef struct slap_content_rule {
726 LDAPContentRule scr_crule;
727 ObjectClass *scr_sclass;
728 ObjectClass **scr_auxiliaries; /* optional */
729 AttributeType **scr_required; /* optional */
730 AttributeType **scr_allowed; /* optional */
731 AttributeType **scr_precluded; /* optional */
732 #define scr_oid scr_crule.cr_oid
733 #define scr_names scr_crule.cr_names
734 #define scr_desc scr_crule.cr_desc
735 #define scr_obsolete scr_crule.cr_obsolete
736 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
737 #define scr_at_oids_must scr_crule.cr_at_oids_must
738 #define scr_at_oids_may scr_crule.cr_at_oids_may
739 #define scr_at_oids_not scr_crule.cr_at_oids_not
741 LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
744 /* Represents a recognized attribute description ( type + options ). */
745 typedef struct slap_attr_desc {
746 struct slap_attr_desc *ad_next;
747 AttributeType *ad_type; /* attribute type, must be specified */
748 struct berval ad_cname; /* canonical name, must be specified */
749 struct berval ad_tags; /* empty if no tagging options */
751 #define SLAP_DESC_NONE 0x00U
752 #define SLAP_DESC_BINARY 0x01U
753 #define SLAP_DESC_TAG_RANGE 0x80U
754 } AttributeDescription;
756 typedef struct slap_attr_name {
757 struct berval an_name;
758 AttributeDescription *an_desc;
763 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
764 #define slap_ad_is_tag_range(ad) \
765 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
766 #define slap_ad_is_binary(ad) \
767 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
770 * pointers to schema elements used internally
772 struct slap_internal_schema {
774 ObjectClass *si_oc_top;
775 ObjectClass *si_oc_extensibleObject;
776 ObjectClass *si_oc_alias;
777 ObjectClass *si_oc_referral;
778 ObjectClass *si_oc_rootdse;
779 ObjectClass *si_oc_subentry;
780 ObjectClass *si_oc_subschema;
781 ObjectClass *si_oc_collectiveAttributeSubentry;
782 ObjectClass *si_oc_dynamicObject;
784 ObjectClass *si_oc_glue;
785 ObjectClass *si_oc_syncConsumerSubentry;
786 ObjectClass *si_oc_syncProviderSubentry;
788 /* objectClass attribute descriptions */
789 AttributeDescription *si_ad_objectClass;
791 /* operational attribute descriptions */
792 AttributeDescription *si_ad_structuralObjectClass;
793 AttributeDescription *si_ad_creatorsName;
794 AttributeDescription *si_ad_createTimestamp;
795 AttributeDescription *si_ad_modifiersName;
796 AttributeDescription *si_ad_modifyTimestamp;
797 AttributeDescription *si_ad_hasSubordinates;
798 AttributeDescription *si_ad_subschemaSubentry;
799 AttributeDescription *si_ad_collectiveSubentries;
800 AttributeDescription *si_ad_collectiveExclusions;
801 AttributeDescription *si_ad_entryDN;
802 AttributeDescription *si_ad_entryUUID;
803 AttributeDescription *si_ad_entryCSN;
804 AttributeDescription *si_ad_namingCSN;
806 AttributeDescription *si_ad_dseType;
807 AttributeDescription *si_ad_syncreplCookie;
808 AttributeDescription *si_ad_syncTimestamp;
809 AttributeDescription *si_ad_contextCSN;
811 /* root DSE attribute descriptions */
812 AttributeDescription *si_ad_altServer;
813 AttributeDescription *si_ad_namingContexts;
814 AttributeDescription *si_ad_supportedControl;
815 AttributeDescription *si_ad_supportedExtension;
816 AttributeDescription *si_ad_supportedLDAPVersion;
817 AttributeDescription *si_ad_supportedSASLMechanisms;
818 AttributeDescription *si_ad_supportedFeatures;
819 AttributeDescription *si_ad_monitorContext;
820 AttributeDescription *si_ad_vendorName;
821 AttributeDescription *si_ad_vendorVersion;
823 /* subentry attribute descriptions */
824 AttributeDescription *si_ad_administrativeRole;
825 AttributeDescription *si_ad_subtreeSpecification;
827 /* subschema subentry attribute descriptions */
828 AttributeDescription *si_ad_attributeTypes;
829 AttributeDescription *si_ad_ditContentRules;
830 AttributeDescription *si_ad_ditStructureRules;
831 AttributeDescription *si_ad_ldapSyntaxes;
832 AttributeDescription *si_ad_matchingRules;
833 AttributeDescription *si_ad_matchingRuleUse;
834 AttributeDescription *si_ad_nameForms;
835 AttributeDescription *si_ad_objectClasses;
837 /* Aliases & Referrals */
838 AttributeDescription *si_ad_aliasedObjectName;
839 AttributeDescription *si_ad_ref;
841 /* Access Control Internals */
842 AttributeDescription *si_ad_entry;
843 AttributeDescription *si_ad_children;
844 AttributeDescription *si_ad_saslAuthzTo;
845 AttributeDescription *si_ad_saslAuthzFrom;
846 #ifdef SLAPD_ACI_ENABLED
847 AttributeDescription *si_ad_aci;
850 /* dynamic entries */
851 AttributeDescription *si_ad_entryTtl;
852 AttributeDescription *si_ad_dynamicSubtrees;
854 /* Other attributes descriptions */
855 AttributeDescription *si_ad_distinguishedName;
856 AttributeDescription *si_ad_name;
857 AttributeDescription *si_ad_cn;
858 AttributeDescription *si_ad_userPassword;
859 AttributeDescription *si_ad_labeledURI;
860 #ifdef SLAPD_AUTHPASSWD
861 AttributeDescription *si_ad_authPassword;
863 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
864 AttributeDescription *si_ad_krbName;
867 /* Undefined Attribute Type */
868 AttributeType *si_at_undefined;
871 MatchingRule *si_mr_distinguishedNameMatch;
872 MatchingRule *si_mr_dnSubtreeMatch;
873 MatchingRule *si_mr_dnOneLevelMatch;
874 MatchingRule *si_mr_dnSubordinateMatch;
875 MatchingRule *si_mr_dnSuperiorMatch;
876 MatchingRule *si_mr_caseExactMatch;
877 MatchingRule *si_mr_caseExactSubstringsMatch;
878 MatchingRule *si_mr_caseExactIA5Match;
879 MatchingRule *si_mr_integerMatch;
880 MatchingRule *si_mr_integerFirstComponentMatch;
881 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
884 Syntax *si_syn_directoryString;
885 Syntax *si_syn_distinguishedName;
886 Syntax *si_syn_integer;
887 Syntax *si_syn_octetString;
889 /* Schema Syntaxes */
890 Syntax *si_syn_attributeTypeDesc;
891 Syntax *si_syn_ditContentRuleDesc;
892 Syntax *si_syn_ditStructureRuleDesc;
893 Syntax *si_syn_ldapSyntaxDesc;
894 Syntax *si_syn_matchingRuleDesc;
895 Syntax *si_syn_matchingRuleUseDesc;
896 Syntax *si_syn_nameFormDesc;
897 Syntax *si_syn_objectClassDesc;
900 typedef struct slap_attr_assertion {
901 AttributeDescription *aa_desc;
902 struct berval aa_value;
903 } AttributeAssertion;
905 typedef struct slap_ss_assertion {
906 AttributeDescription *sa_desc;
907 struct berval sa_initial;
908 struct berval *sa_any;
909 struct berval sa_final;
910 } SubstringsAssertion;
912 #ifdef LDAP_COMP_MATCH
913 struct slap_component_filter;
916 typedef struct slap_mr_assertion {
917 MatchingRule *ma_rule; /* optional */
918 struct berval ma_rule_text; /* optional */
919 AttributeDescription *ma_desc; /* optional */
920 int ma_dnattrs; /* boolean */
921 struct berval ma_value; /* required */
922 #ifdef LDAP_COMP_MATCH
923 struct slap_component_filter* ma_cf; /* component filter */
925 } MatchingRuleAssertion;
928 * represents a search filter
930 typedef struct slap_filter {
931 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
932 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
933 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
934 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
935 #ifdef LDAP_SCOPE_SUBORDINATE
936 #define SLAPD_FILTER_DN_CHILDREN ((ber_tag_t) -4)
940 /* precomputed result */
941 ber_int_t f_un_result;
944 struct berval *f_un_dn;
947 AttributeDescription *f_un_desc;
949 /* simple value assertion */
950 AttributeAssertion *f_un_ava;
952 /* substring assertion */
953 SubstringsAssertion *f_un_ssa;
955 /* matching rule assertion */
956 MatchingRuleAssertion *f_un_mra;
958 #define f_dn f_un.f_un_dn
959 #define f_desc f_un.f_un_desc
960 #define f_ava f_un.f_un_ava
961 #define f_av_desc f_un.f_un_ava->aa_desc
962 #define f_av_value f_un.f_un_ava->aa_value
963 #define f_sub f_un.f_un_ssa
964 #define f_sub_desc f_un.f_un_ssa->sa_desc
965 #define f_sub_initial f_un.f_un_ssa->sa_initial
966 #define f_sub_any f_un.f_un_ssa->sa_any
967 #define f_sub_final f_un.f_un_ssa->sa_final
968 #define f_mra f_un.f_un_mra
969 #define f_mr_rule f_un.f_un_mra->ma_rule
970 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
971 #define f_mr_desc f_un.f_un_mra->ma_desc
972 #define f_mr_value f_un.f_un_mra->ma_value
973 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
976 struct slap_filter *f_un_complex;
979 #define f_result f_un.f_un_result
980 #define f_and f_un.f_un_complex
981 #define f_or f_un.f_un_complex
982 #define f_not f_un.f_un_complex
983 #define f_list f_un.f_un_complex
985 struct slap_filter *f_next;
988 /* compare routines can return undefined */
989 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
991 typedef struct slap_valuesreturnfilter {
992 ber_tag_t vrf_choice;
995 /* precomputed result */
996 ber_int_t vrf_un_result;
1002 AttributeDescription *vrf_un_desc;
1004 /* simple value assertion */
1005 AttributeAssertion *vrf_un_ava;
1007 /* substring assertion */
1008 SubstringsAssertion *vrf_un_ssa;
1010 /* matching rule assertion */
1011 MatchingRuleAssertion *vrf_un_mra;
1013 #define vrf_result vrf_un.vrf_un_result
1014 #define vrf_dn vrf_un.vrf_un_dn
1015 #define vrf_desc vrf_un.vrf_un_desc
1016 #define vrf_ava vrf_un.vrf_un_ava
1017 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1018 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1019 #define vrf_ssa vrf_un.vrf_un_ssa
1020 #define vrf_sub vrf_un.vrf_un_ssa
1021 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1022 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1023 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1024 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1025 #define vrf_mra vrf_un.vrf_un_mra
1026 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1027 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1028 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1029 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1030 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1035 struct slap_valuesreturnfilter *vrf_next;
1036 } ValuesReturnFilter;
1039 * represents an attribute (description + values)
1041 typedef struct slap_attr {
1042 AttributeDescription *a_desc;
1043 BerVarray a_vals; /* preserved values */
1044 BerVarray a_nvals; /* normalized values */
1045 struct slap_attr *a_next;
1047 #define SLAP_ATTR_IXADD 0x1U
1048 #define SLAP_ATTR_IXDEL 0x2U
1049 #ifdef LDAP_COMP_MATCH
1050 void* a_component_values; /* component values */
1056 * the id used in the indexes to refer to an entry
1058 typedef unsigned long ID;
1059 #define NOID ((ID)~0)
1062 * represents an entry in core
1064 typedef struct slap_entry {
1066 * The ID field should only be changed before entry is
1067 * inserted into a cache. The ID value is backend
1072 struct berval e_name; /* name (DN) of this entry */
1073 struct berval e_nname; /* normalized name (DN) of this entry */
1075 /* for migration purposes */
1076 #define e_dn e_name.bv_val
1077 #define e_ndn e_nname.bv_val
1079 Attribute *e_attrs; /* list of attributes + values */
1081 slap_mask_t e_ocflags;
1083 struct berval e_bv; /* For entry_encode/entry_decode */
1085 /* for use by the backend for any purpose */
1090 * A list of LDAPMods
1092 typedef struct slap_mod {
1094 AttributeDescription *sm_desc;
1095 struct berval sm_type;
1096 BerVarray sm_values;
1097 BerVarray sm_nvalues;
1100 typedef struct slap_mod_list {
1101 Modification sml_mod;
1102 #define sml_op sml_mod.sm_op
1103 #define sml_desc sml_mod.sm_desc
1104 #define sml_type sml_mod.sm_type
1105 #define sml_values sml_mod.sm_values
1106 #define sml_nvalues sml_mod.sm_nvalues
1107 struct slap_mod_list *sml_next;
1110 typedef struct slap_ldap_modlist {
1112 struct slap_ldap_modlist *ml_next;
1113 #define ml_op ml_mod.mod_op
1114 #define ml_type ml_mod.mod_type
1115 #define ml_values ml_mod.mod_values
1119 * represents an access control list
1121 typedef enum slap_access_e {
1122 ACL_INVALID_ACCESS = -1,
1131 typedef enum slap_control_e {
1132 ACL_INVALID_CONTROL = 0,
1138 typedef enum slap_style_e {
1139 ACL_STYLE_REGEX = 0,
1150 typedef struct slap_authz_info {
1151 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1152 struct berval sai_mech; /* SASL Mechanism */
1153 struct berval sai_dn; /* DN for reporting purposes */
1154 struct berval sai_ndn; /* Normalized DN */
1156 /* Security Strength Factors */
1157 slap_ssf_t sai_ssf; /* Overall SSF */
1158 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1159 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1160 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1161 } AuthorizationInformation;
1164 typedef struct slap_access {
1165 slap_control_t a_type;
1167 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1169 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1170 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1171 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1172 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1173 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1174 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
1176 #define ACL_PRIV_MASK 0x00ffUL
1179 #define ACL_PRIV_LEVEL 0x1000UL
1180 #define ACL_PRIV_ADDITIVE 0x2000UL
1181 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1184 #define ACL_PRIV_INVALID 0x0UL
1186 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1187 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1188 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1189 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1191 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1192 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1194 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1196 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1198 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1199 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1200 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1202 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1203 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
1204 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1205 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1206 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1207 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1209 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1210 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1211 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1212 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1213 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1214 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1215 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1217 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1218 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1219 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1220 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1221 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1222 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1224 slap_mask_t a_access_mask;
1226 AuthorizationInformation a_authz;
1227 #define a_dn_pat a_authz.sai_dn
1229 slap_style_t a_dn_style;
1230 AttributeDescription *a_dn_at;
1234 slap_style_t a_peername_style;
1235 struct berval a_peername_pat;
1236 unsigned long a_peername_addr,
1238 int a_peername_port;
1240 slap_style_t a_sockname_style;
1241 struct berval a_sockname_pat;
1243 slap_style_t a_domain_style;
1244 struct berval a_domain_pat;
1245 int a_domain_expand;
1247 slap_style_t a_sockurl_style;
1248 struct berval a_sockurl_pat;
1249 slap_style_t a_set_style;
1250 struct berval a_set_pat;
1252 #ifdef SLAPD_ACI_ENABLED
1253 AttributeDescription *a_aci_at;
1257 slap_style_t a_group_style;
1258 struct berval a_group_pat;
1259 ObjectClass *a_group_oc;
1260 AttributeDescription *a_group_at;
1262 struct slap_access *a_next;
1266 typedef struct slap_acl {
1267 /* "to" part: the entries this acl applies to */
1269 slap_style_t acl_dn_style;
1271 struct berval acl_dn_pat;
1272 AttributeName *acl_attrs;
1273 slap_style_t acl_attrval_style;
1274 regex_t acl_attrval_re;
1275 struct berval acl_attrval;
1277 /* "by" part: list of who has what access to the entries */
1280 struct slap_acl *acl_next;
1283 typedef struct slap_acl_state {
1284 unsigned as_recorded;
1285 #define ACL_STATE_NOT_RECORDED 0x0
1286 #define ACL_STATE_RECORDED_VD 0x1
1287 #define ACL_STATE_RECORDED_NV 0x2
1288 #define ACL_STATE_RECORDED 0x3
1291 AccessControl *as_vd_acl;
1292 AccessControl *as_vi_acl;
1293 slap_mask_t as_vd_acl_mask;
1294 regmatch_t as_vd_acl_matches[MAXREMATCHES];
1295 int as_vd_acl_count;
1297 Access *as_vd_access;
1298 int as_vd_access_count;
1301 AttributeDescription *as_vd_ad;
1302 } AccessControlState;
1303 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1304 { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1308 * represents a backend
1311 typedef struct slap_backend_info BackendInfo; /* per backend type */
1312 typedef struct slap_backend_db BackendDB; /* per backend database */
1314 LDAP_SLAPD_V (int) nBackendInfo;
1315 LDAP_SLAPD_V (int) nBackendDB;
1316 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1317 LDAP_SLAPD_V (BackendDB *) backendDB;
1318 LDAP_SLAPD_V (BackendDB *) frontendDB;
1320 LDAP_SLAPD_V (int) slapMode;
1321 #define SLAP_UNDEFINED_MODE 0x0000
1322 #define SLAP_SERVER_MODE 0x0001
1323 #define SLAP_TOOL_MODE 0x0002
1324 #define SLAP_MODE 0x0003
1326 #define SLAP_TRUNCATE_MODE 0x0100
1327 #define SLAP_TOOL_READMAIN 0x0200
1328 #define SLAP_TOOL_READONLY 0x0400
1330 struct slap_replica_info {
1331 char *ri_host; /* supersedes be_replica */
1332 BerVarray ri_nsuffix; /* array of suffixes this replica accepts */
1333 AttributeName *ri_attrs; /* attrs to replicate, NULL=all */
1334 int ri_exclude; /* 1 => exclude ri_attrs */
1337 struct slap_limits_set {
1345 int lms_s_unchecked;
1351 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1352 #define SLAP_NO_LIMIT -1
1353 #define SLAP_MAX_LIMIT 2147483647
1355 struct slap_limits {
1356 unsigned lm_flags; /* type of pattern */
1357 #define SLAP_LIMITS_UNDEFINED 0x0000U
1358 #define SLAP_LIMITS_EXACT 0x0001U
1359 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1360 #define SLAP_LIMITS_ONE 0x0002U
1361 #define SLAP_LIMITS_SUBTREE 0x0003U
1362 #define SLAP_LIMITS_CHILDREN 0x0004U
1363 #define SLAP_LIMITS_REGEX 0x0005U
1364 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1365 #define SLAP_LIMITS_USERS 0x0007U
1366 #define SLAP_LIMITS_ANY 0x0008U
1367 #define SLAP_LIMITS_MASK 0x000FU
1369 #define SLAP_LIMITS_TYPE_DN 0x0000U
1370 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1371 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1373 regex_t lm_regex; /* regex data for REGEX */
1376 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1377 * pattern for REGEX; NULL for ANONYMOUS, USERS
1379 struct berval lm_pat;
1381 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1382 * lm_group_oc is objectClass and lm_group_at is attributeType
1383 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1384 * can only be SLAP_LIMITS_EXACT */
1385 ObjectClass *lm_group_oc;
1386 AttributeDescription *lm_group_ad;
1388 struct slap_limits_set lm_limits;
1391 /* temporary aliases */
1392 typedef BackendDB Backend;
1393 #define nbackends nBackendDB
1394 #define backends backendDB
1397 * syncinfo structure for syncrepl
1400 #define SLAP_SYNC_SID_SIZE 3
1401 #define SLAP_SYNC_RID_SIZE 3
1402 #define SLAP_SYNCUUID_SET_SIZE 256
1404 struct nonpresent_entry {
1405 struct berval *npe_name;
1406 struct berval *npe_nname;
1407 LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1410 struct sync_cookie {
1411 struct berval *ctxcsn;
1413 struct berval *octet_str;
1415 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1418 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1420 typedef struct syncinfo_s {
1421 struct slap_backend_db *si_be;
1423 char *si_provideruri;
1424 BerVarray si_provideruri_bv;
1425 #define SYNCINFO_TLS_OFF 0
1426 #define SYNCINFO_TLS_ON 1
1427 #define SYNCINFO_TLS_CRITICAL 2
1429 struct berval si_updatedn;
1438 int si_schemachecking;
1439 struct berval si_filterstr;
1440 struct berval si_base;
1443 AttributeName *si_anlist;
1444 AttributeName *si_exanlist;
1451 time_t *si_retryinterval;
1452 int *si_retrynum_init;
1454 struct sync_cookie si_syncCookie;
1458 struct berval si_syncUUID_ndn;
1459 Avlnode *si_presentlist;
1461 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1462 LDAP_STAILQ_ENTRY( syncinfo_s ) si_next;
1465 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1467 struct slap_backend_db {
1468 BackendInfo *bd_info; /* pointer to shared backend info */
1470 /* fields in this structure (and routines acting on this structure)
1471 should be renamed from be_ to bd_ */
1473 /* BackendInfo accessors */
1474 #define be_config bd_info->bi_db_config
1475 #define be_type bd_info->bi_type
1477 #define be_bind bd_info->bi_op_bind
1478 #define be_unbind bd_info->bi_op_unbind
1479 #define be_add bd_info->bi_op_add
1480 #define be_compare bd_info->bi_op_compare
1481 #define be_delete bd_info->bi_op_delete
1482 #define be_modify bd_info->bi_op_modify
1483 #define be_modrdn bd_info->bi_op_modrdn
1484 #define be_search bd_info->bi_op_search
1485 #define be_abandon bd_info->bi_op_abandon
1486 #define be_cancel bd_info->bi_op_cancel
1488 #define be_extended bd_info->bi_extended
1490 #define be_chk_referrals bd_info->bi_chk_referrals
1491 #define be_fetch bd_info->bi_entry_get_rw
1492 #define be_release bd_info->bi_entry_release_rw
1493 #define be_group bd_info->bi_acl_group
1494 #define be_attribute bd_info->bi_acl_attribute
1495 #define be_operational bd_info->bi_operational
1498 * define to honor hasSubordinates operational attribute in search filters
1499 * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1502 #define be_has_subordinates bd_info->bi_has_subordinates
1504 #define be_controls bd_info->bi_controls
1506 #define be_connection_init bd_info->bi_connection_init
1507 #define be_connection_destroy bd_info->bi_connection_destroy
1510 #define be_entry_open bd_info->bi_tool_entry_open
1511 #define be_entry_close bd_info->bi_tool_entry_close
1512 #define be_entry_first bd_info->bi_tool_entry_first
1513 #define be_entry_next bd_info->bi_tool_entry_next
1514 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1515 #define be_entry_get bd_info->bi_tool_entry_get
1516 #define be_entry_put bd_info->bi_tool_entry_put
1517 #define be_sync bd_info->bi_tool_sync
1518 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1519 #define be_id2entry_get bd_info->bi_tool_id2entry_get
1520 #define be_entry_modify bd_info->bi_tool_entry_modify
1523 /* Database flags */
1524 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1525 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1526 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1527 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1528 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1529 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1530 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1531 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1532 slap_mask_t be_flags;
1533 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1534 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1535 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1536 #define SLAP_NO_SCHEMA_CHECK(be) \
1537 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1538 #define SLAP_GLUE_INSTANCE(be) \
1539 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1540 #define SLAP_GLUE_SUBORDINATE(be) \
1541 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1542 #define SLAP_GLUE_LINKED(be) \
1543 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1544 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1545 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1546 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1548 slap_mask_t be_restrictops; /* restriction operations */
1549 #define SLAP_RESTRICT_OP_ADD 0x0001U
1550 #define SLAP_RESTRICT_OP_BIND 0x0002U
1551 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1552 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1553 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1554 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1555 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1556 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1557 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1559 #define SLAP_RESTRICT_READONLY 0x80000000U
1561 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1562 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1563 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1564 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1565 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1567 #define SLAP_RESTRICT_OP_READS \
1568 ( SLAP_RESTRICT_OP_COMPARE \
1569 | SLAP_RESTRICT_OP_SEARCH )
1570 #define SLAP_RESTRICT_OP_WRITES \
1571 ( SLAP_RESTRICT_OP_ADD \
1572 | SLAP_RESTRICT_OP_DELETE \
1573 | SLAP_RESTRICT_OP_MODIFY \
1574 | SLAP_RESTRICT_OP_RENAME )
1576 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1577 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1578 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1580 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1582 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1583 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1584 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
1586 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1587 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1589 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1591 slap_mask_t be_requires; /* pre-operation requirements */
1592 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1593 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1594 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1595 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1596 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1598 /* Required Security Strength Factor */
1599 slap_ssf_set_t be_ssf_set;
1601 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1602 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1603 struct berval be_schemadn; /* per-backend subschema subentry DN */
1604 struct berval be_schemandn; /* normalized subschema DN */
1605 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1606 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1607 struct berval be_rootpw; /* the magic "root" password for this db */
1608 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1609 #define be_sizelimit be_def_limit.lms_s_soft
1610 #define be_timelimit be_def_limit.lms_t_soft
1611 struct slap_limits_set be_def_limit; /* default limits */
1612 struct slap_limits **be_limits; /* regex-based size and time limits */
1613 AccessControl *be_acl; /* access control list for this backend */
1614 slap_access_t be_dfltaccess; /* access given if no acl matches */
1616 /* Replica Information */
1617 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
1618 char *be_replogfile; /* replication log file (in master) */
1619 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1620 BerVarray be_update_refs; /* where to refer modifying clients to */
1621 struct be_pcl *be_pending_csn_list;
1622 ldap_pvt_thread_mutex_t be_pcl_mutex;
1623 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1624 struct berval be_context_csn;
1625 LDAP_STAILQ_HEAD( be_si, syncinfo_s ) be_syncinfo; /* For syncrepl */
1628 void *be_pb; /* Netscape plugin */
1630 void *be_private; /* anything the backend database needs */
1636 /* Backend function typedefs */
1637 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1638 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1639 const char *fname, int lineno,
1640 int argc, char **argv));
1641 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1642 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1643 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1645 typedef int (BI_db_init) LDAP_P((Backend *bd));
1646 typedef int (BI_db_config) LDAP_P((Backend *bd,
1647 const char *fname, int lineno,
1648 int argc, char **argv));
1649 typedef int (BI_db_open) LDAP_P((Backend *bd));
1650 typedef int (BI_db_close) LDAP_P((Backend *bd));
1651 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1653 typedef struct req_bind_s {
1655 struct berval rb_cred;
1656 struct berval rb_edn;
1658 struct berval rb_tmp_mech; /* FIXME: temporary */
1661 typedef struct req_search_s {
1666 /* NULL means be_isroot evaluated to TRUE */
1667 struct slap_limits_set *rs_limit;
1669 AttributeName *rs_attrs;
1671 struct berval rs_filterstr;
1674 typedef struct req_compare_s {
1675 AttributeAssertion *rs_ava;
1678 typedef struct req_modify_s {
1679 Modifications *rs_modlist;
1680 int rs_increment; /* FIXME: temporary */
1683 typedef struct req_modrdn_s {
1684 struct berval rs_newrdn;
1685 struct berval rs_nnewrdn;
1686 struct berval *rs_newSup;
1687 struct berval *rs_nnewSup;
1688 int rs_deleteoldrdn;
1691 typedef struct req_add_s {
1693 Modifications *rs_modlist; /* FIXME: temporary */
1696 typedef struct req_abandon_s {
1700 typedef struct req_extended_s {
1701 struct berval rs_reqoid;
1702 struct berval *rs_reqdata;
1705 typedef struct req_pwdexop_s {
1706 struct berval rs_reqoid;
1707 struct berval rs_old;
1708 struct berval rs_new;
1709 Modifications *rs_mods;
1710 Modifications **rs_modtail;
1713 typedef enum slap_reply_e {
1722 typedef struct rep_sasl_s {
1723 struct berval *r_sasldata;
1726 typedef struct rep_extended_s {
1727 const char *r_rspoid;
1728 struct berval *r_rspdata;
1731 typedef struct rep_search_s {
1733 slap_mask_t r_attr_flags;
1734 #define SLAP_ATTRS_UNDEFINED (0x00U)
1735 #define SLAP_OPATTRS_NO (0x01U)
1736 #define SLAP_OPATTRS_YES (0x02U)
1737 #define SLAP_USERATTRS_NO (0x10U)
1738 #define SLAP_USERATTRS_YES (0x20U)
1739 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1740 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1741 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1742 #define SLAP_USERATTRS(f) \
1743 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1745 Attribute *r_operational_attrs;
1746 AttributeName *r_attrs;
1751 typedef struct slap_rep {
1752 slap_reply_t sr_type;
1756 const char *sr_matched;
1757 const char *sr_text;
1759 LDAPControl **sr_ctrls;
1761 rep_sasl_s sru_sasl;
1762 rep_extended_s sru_extended;
1763 rep_search_s sru_search;
1765 slap_mask_t sr_flags;
1766 #define REP_ENTRY_MODIFIABLE 0x0001U
1767 #define REP_ENTRY_MUSTBEFREED 0x0002U
1768 #define REP_MATCHED_MUSTBEFREED 0x0010U
1769 #define REP_REF_MUSTBEFREED 0x0020U
1772 /* short hands for response members */
1773 #define sr_attrs sr_un.sru_search.r_attrs
1774 #define sr_entry sr_un.sru_search.r_entry
1775 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
1776 #define sr_attr_flags sr_un.sru_search.r_attr_flags
1777 #define sr_v2ref sr_un.sru_search.r_v2ref
1778 #define sr_nentries sr_un.sru_search.r_nentries
1779 #define sr_rspoid sr_un.sru_extended.r_rspoid
1780 #define sr_rspdata sr_un.sru_extended.r_rspdata
1781 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1783 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1784 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1785 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1786 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1787 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1788 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1789 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1790 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1791 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1792 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1793 typedef int (BI_op_extended) LDAP_P((
1794 struct slap_op *op, struct slap_rep *rs ));
1795 typedef int (BI_chk_referrals) LDAP_P((
1796 struct slap_op *op, struct slap_rep *rs ));
1797 typedef int (BI_entry_release_rw)
1798 LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1799 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1800 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1801 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1802 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
1803 Entry *e, int *hasSubs ));
1805 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
1806 struct slap_conn *c ));
1807 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
1808 struct slap_conn *c ));
1810 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1811 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1812 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1813 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1814 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1815 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1816 struct berval *text ));
1817 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1818 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1819 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1820 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1821 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1822 struct berval *text ));
1824 struct slap_backend_info {
1825 char *bi_type; /* type of backend */
1828 * per backend type routines:
1829 * bi_init: called to allocate a backend_info structure,
1830 * called once BEFORE configuration file is read.
1831 * bi_init() initializes this structure hence is
1832 * called directly from be_initialize()
1833 * bi_config: called per 'backend' specific option
1834 * all such options must before any 'database' options
1835 * bi_config() is called only from read_config()
1836 * bi_open: called to open each database, called
1837 * once AFTER configuration file is read but
1838 * BEFORE any bi_db_open() calls.
1839 * bi_open() is called from backend_startup()
1840 * bi_close: called to close each database, called
1841 * once during shutdown after all bi_db_close calls.
1842 * bi_close() is called from backend_shutdown()
1843 * bi_destroy: called to destroy each database, called
1844 * once during shutdown after all bi_db_destroy calls.
1845 * bi_destory() is called from backend_destroy()
1848 BI_config *bi_config;
1851 BI_destroy *bi_destroy;
1854 * per database routines:
1855 * bi_db_init: called to initialize each database,
1856 * called upon reading 'database <type>'
1857 * called only from backend_db_init()
1858 * bi_db_config: called to configure each database,
1859 * called per database to handle per database options
1860 * called only from read_config()
1861 * bi_db_open: called to open each database
1862 * called once per database immediately AFTER bi_open()
1863 * calls but before daemon startup.
1864 * called only by backend_startup()
1865 * bi_db_close: called to close each database
1866 * called once per database during shutdown but BEFORE
1867 * any bi_close call.
1868 * called only by backend_shutdown()
1869 * bi_db_destroy: called to destroy each database
1870 * called once per database during shutdown AFTER all
1871 * bi_close calls but before bi_destory calls.
1872 * called only by backend_destory()
1874 BI_db_init *bi_db_init;
1875 BI_db_config *bi_db_config;
1876 BI_db_open *bi_db_open;
1877 BI_db_close *bi_db_close;
1878 BI_db_destroy *bi_db_destroy;
1880 /* LDAP Operations Handling Routines */
1881 BI_op_bind *bi_op_bind;
1882 BI_op_unbind *bi_op_unbind;
1883 BI_op_search *bi_op_search;
1884 BI_op_compare *bi_op_compare;
1885 BI_op_modify *bi_op_modify;
1886 BI_op_modrdn *bi_op_modrdn;
1887 BI_op_add *bi_op_add;
1888 BI_op_delete *bi_op_delete;
1889 BI_op_abandon *bi_op_abandon;
1890 BI_op_cancel *bi_op_cancel;
1892 /* Extended Operations Helper */
1893 BI_op_extended *bi_extended;
1895 /* Auxilary Functions */
1896 BI_operational *bi_operational;
1897 BI_chk_referrals *bi_chk_referrals;
1898 BI_entry_get_rw *bi_entry_get_rw;
1899 BI_entry_release_rw *bi_entry_release_rw;
1901 BI_has_subordinates *bi_has_subordinates;
1903 BI_connection_init *bi_connection_init;
1904 BI_connection_destroy *bi_connection_destroy;
1906 /* hooks for slap tools */
1907 BI_tool_entry_open *bi_tool_entry_open;
1908 BI_tool_entry_close *bi_tool_entry_close;
1909 BI_tool_entry_first *bi_tool_entry_first;
1910 BI_tool_entry_next *bi_tool_entry_next;
1911 BI_tool_entry_get *bi_tool_entry_get;
1912 BI_tool_entry_put *bi_tool_entry_put;
1913 BI_tool_entry_reindex *bi_tool_entry_reindex;
1914 BI_tool_sync *bi_tool_sync;
1915 BI_tool_dn2id_get *bi_tool_dn2id_get;
1916 BI_tool_id2entry_get *bi_tool_id2entry_get;
1917 BI_tool_entry_modify *bi_tool_entry_modify;
1919 #define SLAP_INDEX_ADD_OP 0x0001
1920 #define SLAP_INDEX_DELETE_OP 0x0002
1922 slap_mask_t bi_flags; /* backend flags */
1923 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
1924 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
1925 #define SLAP_BFLAG_INCREMENT 0x0100U
1926 #define SLAP_BFLAG_ALIASES 0x1000U
1927 #define SLAP_BFLAG_REFERRALS 0x2000U
1928 #define SLAP_BFLAG_SUBENTRIES 0x4000U
1929 #define SLAP_BFLAG_DYNAMIC 0x8000U
1931 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
1932 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
1933 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
1934 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
1935 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
1936 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
1937 #define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
1938 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
1939 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
1941 char **bi_controls; /* supported controls */
1943 unsigned int bi_nDB; /* number of databases of this type */
1944 void *bi_private; /* anything the backend type needs */
1947 #define c_authtype c_authz.sai_method
1948 #define c_authmech c_authz.sai_mech
1949 #define c_dn c_authz.sai_dn
1950 #define c_ndn c_authz.sai_ndn
1951 #define c_ssf c_authz.sai_ssf
1952 #define c_transport_ssf c_authz.sai_transport_ssf
1953 #define c_tls_ssf c_authz.sai_tls_ssf
1954 #define c_sasl_ssf c_authz.sai_sasl_ssf
1956 #define o_authtype o_authz.sai_method
1957 #define o_authmech o_authz.sai_mech
1958 #define o_dn o_authz.sai_dn
1959 #define o_ndn o_authz.sai_ndn
1960 #define o_ssf o_authz.sai_ssf
1961 #define o_transport_ssf o_authz.sai_transport_ssf
1962 #define o_tls_ssf o_authz.sai_tls_ssf
1963 #define o_sasl_ssf o_authz.sai_sasl_ssf
1965 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1967 typedef struct slap_callback {
1968 struct slap_callback *sc_next;
1969 slap_response *sc_response;
1970 slap_response *sc_cleanup;
1974 struct slap_overinfo;
1976 typedef struct slap_overinst {
1978 slap_response *on_response;
1979 struct slap_overinfo *on_info;
1980 struct slap_overinst *on_next;
1983 typedef struct slap_overinfo {
1985 BackendInfo *oi_orig;
1986 struct slap_overinst *oi_list;
1989 /* Should successive callbacks in a chain be processed? */
1990 #define SLAP_CB_FREEME 0x4000
1991 #define SLAP_CB_CONTINUE 0x8000
1994 * Paged Results state
1996 typedef unsigned long PagedResultsCookie;
1997 typedef struct slap_paged_state {
1999 PagedResultsCookie ps_cookie;
2001 } PagedResultsState;
2003 #define LDAP_PSEARCH_BY_ADD 0x01
2004 #define LDAP_PSEARCH_BY_DELETE 0x02
2005 #define LDAP_PSEARCH_BY_PREMODIFY 0x03
2006 #define LDAP_PSEARCH_BY_MODIFY 0x04
2007 #define LDAP_PSEARCH_BY_SCOPEOUT 0x05
2010 struct slap_op *ps_op;
2011 LDAP_LIST_ENTRY(psid_entry) ps_link;
2015 struct berval sl_uuid;
2016 struct berval sl_name;
2017 struct berval sl_csn;
2018 LDAP_STAILQ_ENTRY(slog_entry) sl_link;
2022 struct slap_session_entry {
2025 struct berval se_spec;
2026 LDAP_LIST_ENTRY( slap_session_entry ) se_link;
2029 struct slap_csn_entry {
2030 struct berval *ce_csn;
2031 unsigned long ce_opid;
2032 unsigned long ce_connid;
2033 #define SLAP_CSN_PENDING 1
2034 #define SLAP_CSN_COMMIT 2
2036 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2040 * Caches the result of a backend_group check for ACL evaluation
2042 typedef struct slap_gacl {
2043 struct slap_gacl *ga_next;
2046 AttributeDescription *ga_at;
2053 * represents an operation pending from an ldap client
2055 typedef struct slap_op {
2056 unsigned long o_opid; /* id of this operation */
2057 unsigned long o_connid; /* id of conn initiating this op */
2058 struct slap_conn *o_conn; /* connection spawning this op */
2059 BackendDB *o_bd; /* backend DB processing this op */
2061 ber_int_t o_msgid; /* msgid of the request */
2062 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
2063 ber_tag_t o_tag; /* tag of the request */
2064 time_t o_time; /* time op was initiated */
2066 struct berval o_req_dn; /* DN of target of request */
2067 struct berval o_req_ndn;
2072 req_compare_s oq_compare;
2073 req_modify_s oq_modify;
2074 req_modrdn_s oq_modrdn;
2075 req_search_s oq_search;
2076 req_abandon_s oq_abandon;
2077 req_abandon_s oq_cancel;
2078 req_extended_s oq_extended;
2079 req_pwdexop_s oq_pwdexop;
2082 /* short hands for union members */
2083 #define oq_add o_request.oq_add
2084 #define oq_bind o_request.oq_bind
2085 #define oq_compare o_request.oq_compare
2086 #define oq_modify o_request.oq_modify
2087 #define oq_modrdn o_request.oq_modrdn
2088 #define oq_search o_request.oq_search
2089 #define oq_abandon o_request.oq_abandon
2090 #define oq_cancel o_request.oq_cancel
2091 #define oq_extended o_request.oq_extended
2092 #define oq_pwdexop o_request.oq_pwdexop
2094 /* short hands for inner request members */
2095 #define orb_method oq_bind.rb_method
2096 #define orb_cred oq_bind.rb_cred
2097 #define orb_edn oq_bind.rb_edn
2098 #define orb_ssf oq_bind.rb_ssf
2099 #define orb_tmp_mech oq_bind.rb_tmp_mech
2101 #define ors_scope oq_search.rs_scope
2102 #define ors_deref oq_search.rs_deref
2103 #define ors_slimit oq_search.rs_slimit
2104 #define ors_tlimit oq_search.rs_tlimit
2105 #define ors_limit oq_search.rs_limit
2106 #define ors_attrsonly oq_search.rs_attrsonly
2107 #define ors_attrs oq_search.rs_attrs
2108 #define ors_filter oq_search.rs_filter
2109 #define ors_filterstr oq_search.rs_filterstr
2111 #define orr_newrdn oq_modrdn.rs_newrdn
2112 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2113 #define orr_newSup oq_modrdn.rs_newSup
2114 #define orr_nnewSup oq_modrdn.rs_nnewSup
2115 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2117 #define orc_ava oq_compare.rs_ava
2118 #define ora_e oq_add.rs_e
2119 #define ora_modlist oq_add.rs_modlist
2120 #define orn_msgid oq_abandon.rs_msgid
2121 #define orm_modlist oq_modify.rs_modlist
2122 #define orm_increment oq_modify.rs_increment
2124 #define ore_reqoid oq_extended.rs_reqoid
2125 #define ore_reqdata oq_extended.rs_reqdata
2127 ldap_pvt_thread_t o_tid; /* thread handling this op */
2129 volatile sig_atomic_t o_abandon; /* abandon flag */
2130 volatile sig_atomic_t o_cancel; /* cancel flag */
2131 #define SLAP_CANCEL_NONE 0x00
2132 #define SLAP_CANCEL_REQ 0x01
2133 #define SLAP_CANCEL_ACK 0x02
2134 #define SLAP_CANCEL_DONE 0x03
2136 GroupAssertion *o_groups;
2137 char o_do_not_cache; /* don't cache groups from this op */
2138 char o_is_auth_check; /* authorization in progress */
2140 #define SLAP_IGNORED_CONTROL -1
2141 #define SLAP_NO_CONTROL 0
2142 #define SLAP_NONCRITICAL_CONTROL 1
2143 #define SLAP_CRITICAL_CONTROL 2
2145 #define get_manageDSAit(op) ((int)(op)->o_managedsait)
2151 #define get_subentries(op) ((int)(op)->o_subentries)
2152 char o_subentries_visibility;
2153 #define get_subentries_visibility(op) ((int)(op)->o_subentries_visibility)
2156 #define get_assert(op) ((int)(op)->o_assert)
2158 char o_valuesreturnfilter;
2160 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2161 char o_permissive_modify;
2162 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2164 #define get_permissiveModify(op) (0)
2167 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2168 char o_domain_scope;
2169 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2171 #define get_domainScope(op) (0)
2174 #ifdef LDAP_CONTROL_X_TREE_DELETE
2176 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2178 #define get_treeDelete(op) (0)
2183 AttributeName *o_preread_attrs;
2184 AttributeName *o_postread_attrs;
2186 char o_pagedresults;
2187 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2188 ber_int_t o_pagedresults_size;
2189 PagedResultsState o_pagedresults_state;
2193 #define SLAP_SYNC_NONE LDAP_SYNC_NONE
2194 #define SLAP_SYNC_REFRESH LDAP_SYNC_REFRESH_ONLY
2195 #define SLAP_SYNC_PERSIST LDAP_SYNC_RESERVED
2196 #define SLAP_SYNC_REFRESH_AND_PERSIST LDAP_SYNC_REFRESH_AND_PERSIST
2197 struct sync_cookie o_sync_state;
2199 struct berval o_sync_cid;
2200 int o_sync_slog_size;
2201 struct berval o_sync_csn;
2202 struct berval o_sync_slog_omitcsn;
2203 int o_sync_slog_len;
2204 LDAP_STAILQ_HEAD(sl, slog_entry) o_sync_slog_list;
2208 LDAP_LIST_ENTRY(slap_op) o_ps_link;
2209 LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
2211 AuthorizationInformation o_authz;
2213 BerElement *o_ber; /* ber of the request */
2214 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2215 slap_callback *o_callback; /* callback pointers */
2216 LDAPControl **o_ctrls; /* controls */
2218 void *o_threadctx; /* thread pool thread context */
2219 void *o_tmpmemctx; /* slab malloc context */
2220 BerMemoryFunctions *o_tmpmfuncs;
2221 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2222 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2223 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2224 #define o_tmpfree o_tmpmfuncs->bmf_free
2225 void *o_private; /* anything the backend needs */
2227 LDAP_STAILQ_ENTRY(slap_op) o_next; /* next operation in list */
2229 Filter *o_assertion; /* Assert control filter */
2230 #define get_assertion(op) ((op)->o_assertion)
2232 ValuesReturnFilter *o_vrFilter; /* ValuesReturnFilter */
2235 int o_delete_glue_parent;
2238 void *o_pb; /* NS-SLAPI plugin */
2239 void *o_extensions; /* NS-SLAPI plugin */
2243 #define send_ldap_error( op, rs, err, text ) do { \
2244 (rs)->sr_err = err; (rs)->sr_text = text; \
2245 (op->o_conn->c_send_ldap_result)( op, rs ); \
2247 #define send_ldap_discon( op, rs, err, text ) do { \
2248 (rs)->sr_err = err; (rs)->sr_text = text; \
2249 send_ldap_disconnect( op, rs ); \
2252 typedef void (SEND_LDAP_RESULT)(
2253 struct slap_op *op, struct slap_rep *rs);
2254 typedef int (SEND_SEARCH_ENTRY)(
2255 struct slap_op *op, struct slap_rep *rs);
2256 typedef int (SEND_SEARCH_REFERENCE)(
2257 struct slap_op *op, struct slap_rep *rs);
2258 typedef void (SEND_LDAP_EXTENDED)(
2259 struct slap_op *op, struct slap_rep *rs);
2260 typedef void (SEND_LDAP_INTERMEDIATE)(
2261 struct slap_op *op, struct slap_rep *rs);
2263 #define send_ldap_result( op, rs ) \
2264 (op->o_conn->c_send_ldap_result)( op, rs )
2265 #define send_search_entry( op, rs ) \
2266 (op->o_conn->c_send_search_entry)( op, rs )
2267 #define send_search_reference( op, rs ) \
2268 (op->o_conn->c_send_search_reference)( op, rs )
2269 #define send_ldap_extended( op, rs ) \
2270 (op->o_conn->c_send_ldap_extended)( op, rs )
2271 #define send_ldap_intermediate( op, rs ) \
2272 (op->o_conn->c_send_ldap_intermediate)( op, rs )
2274 typedef struct slap_listener Listener;
2277 * represents a connection from an ldap client
2279 typedef struct slap_conn {
2280 int c_struct_state; /* structure management state */
2281 int c_conn_state; /* connection state */
2282 int c_conn_idx; /* slot in connections array */
2284 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2285 Sockbuf *c_sb; /* ber connection stuff */
2287 /* only can be changed by connect_init */
2288 time_t c_starttime; /* when the connection was opened */
2289 time_t c_activitytime; /* when the connection was last used */
2290 unsigned long c_connid; /* id of this connection for stats*/
2292 struct berval c_peer_domain; /* DNS name of client */
2293 struct berval c_peer_name; /* peer name (trans=addr:port) */
2294 Listener *c_listener;
2295 #define c_listener_url c_listener->sl_url /* listener URL */
2296 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2298 /* only can be changed by binding thread */
2299 int c_sasl_bind_in_progress; /* multi-op bind in progress */
2300 struct berval c_sasl_bind_mech; /* mech in progress */
2301 struct berval c_sasl_dn; /* temporary storage */
2303 /* authorization backend */
2304 Backend *c_authz_backend;
2306 AuthorizationInformation c_authz;
2308 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2310 LDAP_STAILQ_HEAD(c_o, slap_op) c_ops; /* list of operations being processed */
2311 LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops; /* list of pending operations */
2313 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2314 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2316 BerElement *c_currentber; /* ber we're attempting to read */
2317 int c_writewaiter; /* true if writer is waiting */
2319 #define CONN_IS_TLS 1
2320 #define CONN_IS_UDP 2
2321 #define CONN_IS_CLIENT 3
2323 #ifdef LDAP_CONNECTIONLESS
2324 int c_is_udp; /* true if this is (C)LDAP over UDP */
2327 int c_is_tls; /* true if this LDAP over raw TLS */
2328 int c_needs_tls_accept; /* true if SSL_accept should be called */
2330 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
2331 int c_sasl_done; /* SASL completed once */
2332 void *c_sasl_authctx; /* SASL authentication context */
2333 void *c_sasl_sockctx; /* SASL security layer context */
2334 void *c_sasl_extra; /* SASL session extra stuff */
2335 struct slap_op *c_sasl_bindop; /* set to current op if it's a bind */
2337 PagedResultsState c_pagedresults_state; /* paged result state */
2339 long c_n_ops_received; /* num of ops received (next op_id) */
2340 long c_n_ops_executing; /* num of ops currently executing */
2341 long c_n_ops_pending; /* num of ops pending execution */
2342 long c_n_ops_completed; /* num of ops completed */
2344 long c_n_get; /* num of get calls */
2345 long c_n_read; /* num of read calls */
2346 long c_n_write; /* num of write calls */
2348 void *c_pb; /* Netscape plugin */
2349 void *c_extensions; /* Netscape plugin */
2352 * Client connection handling
2354 ldap_pvt_thread_start_t *c_clientfunc;
2358 * These are the "callbacks" that are available for back-ends to
2359 * supply data back to connected clients that are connected
2360 * through the "front-end".
2362 SEND_LDAP_RESULT *c_send_ldap_result;
2363 SEND_SEARCH_ENTRY *c_send_search_entry;
2364 SEND_SEARCH_REFERENCE *c_send_search_reference;
2365 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2366 #ifdef LDAP_RES_INTERMEDIATE
2367 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2372 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2373 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2375 if ( ldap_debug & (level) ) \
2376 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2377 if ( ldap_syslog & (level) ) \
2378 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2381 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2382 #elif defined(LDAP_DEBUG)
2383 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2385 if ( ldap_debug & (level) ) \
2386 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2388 #define StatslogTest( level ) (ldap_debug & (level))
2390 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2391 #define StatslogTest( level ) (0)
2395 * listener; need to access it from monitor backend
2397 struct slap_listener {
2398 struct berval sl_url;
2399 struct berval sl_name;
2404 #ifdef LDAP_CONNECTIONLESS
2405 int sl_is_udp; /* UDP listener is also data port */
2407 int sl_is_mute; /* Listening is temporarily disabled */
2410 #define sl_addr sl_sa.sa_in_addr
2413 #ifdef SLAPD_MONITOR
2430 #endif /* SLAPD_MONITOR */
2432 typedef struct slap_counters_t {
2433 ldap_pvt_thread_mutex_t sc_sent_mutex;
2434 ldap_pvt_mp_t sc_bytes;
2435 ldap_pvt_mp_t sc_pdu;
2436 ldap_pvt_mp_t sc_entries;
2437 ldap_pvt_mp_t sc_refs;
2439 ldap_pvt_thread_mutex_t sc_ops_mutex;
2440 ldap_pvt_mp_t sc_ops_completed;
2441 ldap_pvt_mp_t sc_ops_initiated;
2442 #ifdef SLAPD_MONITOR
2443 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2444 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2445 #endif /* SLAPD_MONITOR */
2449 * Better know these all around slapd
2451 #define SLAP_LDAPDN_PRETTY 0x1
2452 #define SLAP_LDAPDN_MAXLEN 8192
2454 /* number of response controls supported */
2455 #define SLAP_MAX_RESPONSE_CONTROLS 6
2458 #define SLAP_CTRL_HIDE 0x00000000U
2460 #define SLAP_CTRL_HIDE 0x80000000U
2463 #define SLAP_CTRL_FRONTEND 0x00800000U
2464 #define SLAP_CTRL_FRONTEND_SEARCH 0x00010000U /* for NOOP */
2466 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2467 #define SLAP_CTRL_ABANDON 0x00000001U
2468 #define SLAP_CTRL_ADD 0x00002002U
2469 #define SLAP_CTRL_BIND 0x00000004U
2470 #define SLAP_CTRL_COMPARE 0x00001008U
2471 #define SLAP_CTRL_DELETE 0x00002010U
2472 #define SLAP_CTRL_MODIFY 0x00002020U
2473 #define SLAP_CTRL_RENAME 0x00002040U
2474 #define SLAP_CTRL_SEARCH 0x00001080U
2475 #define SLAP_CTRL_UNBIND 0x00000100U
2477 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2478 #define SLAP_CTRL_UPDATE \
2479 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2480 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2482 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2485 LDAPControl *ctrl ));
2487 #define SLAP_SLAB_SIZE (1024*1024)
2489 #if defined(LDAP_DEVEL) && defined(ENABLE_REWRITE)
2490 /* use librewrite for sasl-regexp */
2491 #define SLAP_AUTH_REWRITE 1
2492 #endif /* LDAP_DEVEL && ENABLE_REWRITE */
2494 #ifdef LDAP_COMP_MATCH
2496 * Extensible Filter Definition
2498 * MatchingRuleAssertion := SEQUENCE {
2499 * matchingRule [1] MatchingRuleId OPTIONAL,
2500 * type [2] AttributeDescription OPTIONAL,
2501 * matchValue [3] AssertionValue,
2502 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2504 * Following ComponentFilter is contained in matchValue
2506 * ComponentAssertion ::= SEQUENCE {
2507 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2508 * useDefaultValues BOOLEAN DEFAULT TRUE,
2509 * rule MATCHING-RULE.&id,
2510 * value MATCHING-RULE.&AssertionType }
2512 * ComponentFilter ::= CHOICE {
2513 * item [0] ComponentAssertion,
2514 * and [1] SEQUENCE OF ComponentFilter,
2515 * or [2] SEQUENCE OF ComponentFilter,
2516 * not [3] ComponentFilter }
2519 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2520 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2521 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2522 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2523 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2524 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2525 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2526 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2527 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2529 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2530 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2531 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2532 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2533 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2535 typedef struct slap_component_id{
2537 struct slap_component_id *ci_next;
2539 union comp_id_value{
2540 BerValue ci_identifier;
2541 ber_int_t ci_from_beginning;
2543 ber_int_t ci_from_end;
2544 BerValue ci_select_value;
2549 typedef struct slap_component_reference {
2550 ComponentId *cr_list;
2551 ComponentId *cr_curr;
2552 struct berval cr_string;
2554 } ComponentReference;
2556 typedef struct slap_component_assertion {
2557 ComponentReference *ca_comp_ref;
2558 ber_int_t ca_use_def;
2559 MatchingRule *ca_ma_rule;
2560 struct berval ca_ma_value;
2561 struct slap_component_filter *ca_cf;
2562 MatchingRuleAssertion *ca_mra;
2563 } ComponentAssertion;
2565 typedef struct slap_component_filter {
2566 ber_tag_t cf_choice;
2568 ber_int_t cf_un_result;
2569 ComponentAssertion *cf_un_ca;
2570 struct slap_component_filter *cf_un_complex;
2573 #define cf_ca cf_un.cf_un_ca
2574 #define cf_result cf_un.cf_un_result
2575 #define cf_and cf_un.cf_un_complex
2576 #define cf_or cf_un.cf_un_complex
2577 #define cf_not cf_un.cf_un_complex
2579 struct slap_component_filter *cf_next;
2582 typedef struct slap_component_assertion_value {
2586 } ComponentAssertionValue;
2590 typedef int encoder_func LDAP_P((
2594 struct slap_component_syntax_info;
2596 typedef int decoder_func LDAP_P((
2598 struct slap_component_syntax_info** comp_syn_info,
2602 typedef void* extract_component_from_tag_func LDAP_P((
2605 typedef void* extract_component_from_id_func LDAP_P((
2606 ComponentReference* cr,
2609 typedef int allcomponent_matching_func LDAP_P((
2612 void* component2 ));
2614 typedef struct slap_component_desc{
2616 ComponentId* cd_identifier;
2617 encoder_func *cd_encoder;
2618 decoder_func *cd_decoder;
2619 extract_component_from_tag_func* cd_extract_t;
2620 extract_component_from_id_func* cd_extract_i;
2622 AsnTypeId cd_type_id;
2623 allcomponent_matching_func* cd_all_match;
2626 typedef struct slap_component_syntax_info {
2628 ComponentDesc* csi_comp_desc;
2629 } ComponentSyntaxInfo;
2631 typedef struct asntype_to_matchingrule {
2632 AsnTypeId atmr_typeId;
2634 MatchingRule *atmr_mr;
2635 } AsnTypetoMatchingRule;
2637 typedef struct asntype_to_matchingrule_table {
2639 struct asntype_to_matchingrule atmr_table[ASNTYPE_END];
2640 struct asntype_to_matchingrule_table* atmr_table_next;
2641 } AsnTypetoMatchingRuleTable;
2646 #include "proto-slap.h"
2648 #endif /* _SLAP_H_ */