xref: /netbsd-src/external/bsd/openldap/dist/servers/slapd/slap.h (revision 567219e1d7461bff1b180e494a9674a287b057a7)
1 /*	$NetBSD: slap.h,v 1.1.1.4 2010/12/12 15:22:47 adam Exp $	*/
2 
3 /* slap.h - stand alone ldap server include file */
4 /* OpenLDAP: pkg/ldap/servers/slapd/slap.h,v 1.764.2.68 2010/04/16 20:03:05 quanah Exp */
5 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
6  *
7  * Copyright 1998-2010 The OpenLDAP Foundation.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted only as authorized by the OpenLDAP
12  * Public License.
13  *
14  * A copy of this license is available in the file LICENSE in the
15  * top-level directory of the distribution or, alternatively, at
16  * <http://www.OpenLDAP.org/license.html>.
17  */
18 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
19  * All rights reserved.
20  *
21  * Redistribution and use in source and binary forms are permitted
22  * provided that this notice is preserved and that due credit is given
23  * to the University of Michigan at Ann Arbor. The name of the University
24  * may not be used to endorse or promote products derived from this
25  * software without specific prior written permission. This software
26  * is provided ``as is'' without express or implied warranty.
27  */
28 
29 #ifndef _SLAP_H_
30 #define _SLAP_H_
31 
32 #include "ldap_defaults.h"
33 
34 #include <stdio.h>
35 #include <ac/stdlib.h>
36 
37 #include <sys/types.h>
38 #include <ac/syslog.h>
39 #include <ac/regex.h>
40 #include <ac/signal.h>
41 #include <ac/socket.h>
42 #include <ac/time.h>
43 #include <ac/param.h>
44 
45 #include "avl.h"
46 
47 #ifndef ldap_debug
48 #define ldap_debug slap_debug
49 #endif
50 
51 #include "ldap_log.h"
52 
53 #include <ldap.h>
54 #include <ldap_schema.h>
55 
56 #include "lber_pvt.h"
57 #include "ldap_pvt.h"
58 #include "ldap_pvt_thread.h"
59 #include "ldap_queue.h"
60 
61 LDAP_BEGIN_DECL
62 
63 #ifdef LDAP_DEVEL
64 #define LDAP_COLLECTIVE_ATTRIBUTES
65 #define LDAP_COMP_MATCH
66 #define LDAP_SYNC_TIMESTAMP
67 #define SLAP_CONTROL_X_SESSION_TRACKING
68 #define SLAP_CONTROL_X_WHATFAILED
69 #define SLAP_CONFIG_DELETE
70 #ifndef SLAP_SCHEMA_EXPOSE
71 #define SLAP_SCHEMA_EXPOSE
72 #endif
73 #endif
74 
75 #define LDAP_DYNAMIC_OBJECTS
76 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
77 #define SLAP_DISTPROC
78 
79 #ifdef ENABLE_REWRITE
80 #define SLAP_AUTH_REWRITE	1 /* use librewrite for sasl-regexp */
81 #endif
82 
83 /*
84  * SLAPD Memory allocation macros
85  *
86  * Unlike ch_*() routines, these routines do not assert() upon
87  * allocation error.  They are intended to be used instead of
88  * ch_*() routines where the caller has implemented proper
89  * checking for and handling of allocation errors.
90  *
91  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
92  */
93 #define SLAP_MALLOC(s)      ber_memalloc((s))
94 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
95 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
96 #define SLAP_FREE(p)        ber_memfree((p))
97 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
98 #define SLAP_STRDUP(s)      ber_strdup((s))
99 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
100 
101 #ifdef f_next
102 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
103 #endif
104 
105 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
106 #define SLAPD_ANONYMOUS ""
107 
108 #ifdef HAVE_TCPD
109 # include <tcpd.h>
110 # define SLAP_STRING_UNKNOWN	STRING_UNKNOWN
111 #else /* ! TCP Wrappers */
112 # define SLAP_STRING_UNKNOWN	"unknown"
113 #endif /* ! TCP Wrappers */
114 
115 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
116  * This is a value used internally by the backends. It is needed to allow
117  * adding values that already exist without getting an error as required by
118  * modrdn when the new rdn was already an attribute value itself.
119  */
120 #define SLAP_MOD_SOFTADD	0x1000
121 
122 #define MAXREMATCHES (100)
123 
124 #define SLAP_MAX_WORKER_THREADS		(16)
125 
126 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
127 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
128 
129 #define SLAP_CONN_MAX_PENDING_DEFAULT	100
130 #define SLAP_CONN_MAX_PENDING_AUTH	1000
131 
132 #define SLAP_TEXT_BUFLEN (256)
133 
134 /* psuedo error code indicating abandoned operation */
135 #define SLAPD_ABANDON (-1024)
136 
137 /* psuedo error code indicating disconnect */
138 #define SLAPD_DISCONNECT (-1025)
139 
140 /* unknown config file directive */
141 #define SLAP_CONF_UNKNOWN (-1026)
142 
143 /* We assume "C" locale, that is US-ASCII */
144 #define ASCII_SPACE(c)	( (c) == ' ' )
145 #define ASCII_LOWER(c)	( (c) >= 'a' && (c) <= 'z' )
146 #define ASCII_UPPER(c)	( (c) >= 'A' && (c) <= 'Z' )
147 #define ASCII_ALPHA(c)	( ASCII_LOWER(c) || ASCII_UPPER(c) )
148 #define ASCII_DIGIT(c)	( (c) >= '0' && (c) <= '9' )
149 #define ASCII_HEXLOWER(c)	( (c) >= 'a' && (c) <= 'f' )
150 #define ASCII_HEXUPPER(c)	( (c) >= 'A' && (c) <= 'F' )
151 #define ASCII_HEX(c)	( ASCII_DIGIT(c) || \
152 	ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
153 #define ASCII_ALNUM(c)	( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
154 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
155 
156 #define SLAP_NIBBLE(c) ((c)&0x0f)
157 #define SLAP_ESCAPE_CHAR ('\\')
158 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
159 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
160 
161 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
162 	|| (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
163 
164 #define DN_ESCAPE(c)	((c) == SLAP_ESCAPE_CHAR)
165 /* NOTE: for consistency, this macro must only operate
166  * on normalized/pretty DN, such that ';' is never used
167  * as RDN separator, and all occurrences of ';' must be escaped */
168 #define DN_SEPARATOR(c)	((c) == ',')
169 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */
170 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
171 #define RDN_NEEDSESCAPE(c)	((c) == '\\' || (c) == '"')
172 
173 #define DESC_LEADCHAR(c)	( ASCII_ALPHA(c) )
174 #define DESC_CHAR(c)	( ASCII_ALNUM(c) || (c) == '-' )
175 #define OID_LEADCHAR(c)	( ASCII_DIGIT(c) )
176 #define OID_SEPARATOR(c)	( (c) == '.' )
177 #define OID_CHAR(c)	( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
178 
179 #define ATTR_LEADCHAR(c)	( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
180 #define ATTR_CHAR(c)	( DESC_CHAR((c)) || OID_SEPARATOR(c) )
181 
182 #define AD_LEADCHAR(c)	( ATTR_LEADCHAR(c) )
183 #define AD_CHAR(c)		( ATTR_CHAR(c) || (c) == ';' )
184 
185 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
186 
187 #define SLAP_PRINTABLE(c)	( ASCII_ALNUM(c) || (c) == '\'' || \
188 	(c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
189 	(c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
190 	(c) == '?' || (c) == ' ' || (c) == '=' )
191 #define SLAP_PRINTABLES(c)	( SLAP_PRINTABLE(c) || (c) == '$' )
192 
193 /* must match in schema_init.c */
194 #define SLAPD_DN_SYNTAX			"1.3.6.1.4.1.1466.115.121.1.12"
195 #define SLAPD_NAMEUID_SYNTAX	"1.3.6.1.4.1.1466.115.121.1.34"
196 #define SLAPD_INTEGER_SYNTAX	"1.3.6.1.4.1.1466.115.121.1.27"
197 #define SLAPD_GROUP_ATTR		"member"
198 #define SLAPD_GROUP_CLASS		"groupOfNames"
199 #define SLAPD_ROLE_ATTR			"roleOccupant"
200 #define SLAPD_ROLE_CLASS		"organizationalRole"
201 
202 #define SLAPD_TOP_OID			"2.5.6.0"
203 
204 LDAP_SLAPD_V (int) slap_debug;
205 
206 typedef unsigned long slap_mask_t;
207 
208 /* Security Strength Factor */
209 typedef unsigned slap_ssf_t;
210 
211 typedef struct slap_ssf_set {
212 	slap_ssf_t sss_ssf;
213 	slap_ssf_t sss_transport;
214 	slap_ssf_t sss_tls;
215 	slap_ssf_t sss_sasl;
216 	slap_ssf_t sss_update_ssf;
217 	slap_ssf_t sss_update_transport;
218 	slap_ssf_t sss_update_tls;
219 	slap_ssf_t sss_update_sasl;
220 	slap_ssf_t sss_simple_bind;
221 } slap_ssf_set_t;
222 
223 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
224 #define SLAP_GETDN_AUTHCID 2
225 #define SLAP_GETDN_AUTHZID 4
226 
227 /*
228  * Index types
229  */
230 #define SLAP_INDEX_TYPE           0x00FFUL
231 #define SLAP_INDEX_UNDEFINED      0x0001UL
232 #define SLAP_INDEX_PRESENT        0x0002UL
233 #define SLAP_INDEX_EQUALITY       0x0004UL
234 #define SLAP_INDEX_APPROX         0x0008UL
235 #define SLAP_INDEX_SUBSTR         0x0010UL
236 #define SLAP_INDEX_EXTENDED		  0x0020UL
237 
238 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
239 
240 #define IS_SLAP_INDEX(mask, type)	(((mask) & (type)) == (type))
241 
242 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
243 
244 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
245 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
246 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
247 #define SLAP_INDEX_SUBSTR_DEFAULT \
248 	( SLAP_INDEX_SUBSTR \
249 	| SLAP_INDEX_SUBSTR_INITIAL \
250 	| SLAP_INDEX_SUBSTR_ANY \
251 	| SLAP_INDEX_SUBSTR_FINAL )
252 
253 /* defaults for initial/final substring indices */
254 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT	2
255 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT	4
256 
257 /* defaults for any substring indices */
258 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT		4
259 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT		2
260 
261 /* default for ordered integer index keys */
262 #define SLAP_INDEX_INTLEN_DEFAULT	4
263 
264 #define SLAP_INDEX_FLAGS         0xF000UL
265 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
266 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
267 
268 /*
269  * there is a single index for each attribute.  these prefixes ensure
270  * that there is no collision among keys.
271  */
272 #define SLAP_INDEX_EQUALITY_PREFIX	'=' 	/* prefix for equality keys     */
273 #define SLAP_INDEX_APPROX_PREFIX	'~'		/* prefix for approx keys       */
274 #define SLAP_INDEX_SUBSTR_PREFIX	'*'		/* prefix for substring keys    */
275 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
276 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
277 #define SLAP_INDEX_CONT_PREFIX		'.'		/* prefix for continuation keys */
278 
279 #define SLAP_SYNTAX_MATCHINGRULES_OID	 "1.3.6.1.4.1.1466.115.121.1.30"
280 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID	 "1.3.6.1.4.1.1466.115.121.1.3"
281 #define SLAP_SYNTAX_OBJECTCLASSES_OID	 "1.3.6.1.4.1.1466.115.121.1.37"
282 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
283 #define SLAP_SYNTAX_CONTENTRULE_OID	 "1.3.6.1.4.1.1466.115.121.1.16"
284 
285 /*
286  * represents schema information for a database
287  */
288 enum {
289 	SLAP_SCHERR_OUTOFMEM = 1,
290 	SLAP_SCHERR_CLASS_NOT_FOUND,
291 	SLAP_SCHERR_CLASS_BAD_USAGE,
292 	SLAP_SCHERR_CLASS_BAD_SUP,
293 	SLAP_SCHERR_CLASS_DUP,
294 	SLAP_SCHERR_CLASS_INCONSISTENT,
295 	SLAP_SCHERR_ATTR_NOT_FOUND,
296 	SLAP_SCHERR_ATTR_BAD_MR,
297 	SLAP_SCHERR_ATTR_BAD_USAGE,
298 	SLAP_SCHERR_ATTR_BAD_SUP,
299 	SLAP_SCHERR_ATTR_INCOMPLETE,
300 	SLAP_SCHERR_ATTR_DUP,
301 	SLAP_SCHERR_ATTR_INCONSISTENT,
302 	SLAP_SCHERR_MR_NOT_FOUND,
303 	SLAP_SCHERR_MR_INCOMPLETE,
304 	SLAP_SCHERR_MR_DUP,
305 	SLAP_SCHERR_SYN_NOT_FOUND,
306 	SLAP_SCHERR_SYN_DUP,
307 	SLAP_SCHERR_SYN_SUP_NOT_FOUND,
308 	SLAP_SCHERR_SYN_SUBST_NOT_SPECIFIED,
309 	SLAP_SCHERR_SYN_SUBST_NOT_FOUND,
310 	SLAP_SCHERR_NO_NAME,
311 	SLAP_SCHERR_NOT_SUPPORTED,
312 	SLAP_SCHERR_BAD_DESCR,
313 	SLAP_SCHERR_OIDM,
314 	SLAP_SCHERR_CR_DUP,
315 	SLAP_SCHERR_CR_BAD_STRUCT,
316 	SLAP_SCHERR_CR_BAD_AUX,
317 	SLAP_SCHERR_CR_BAD_AT,
318 
319 	SLAP_SCHERR_LAST
320 };
321 
322 /* forward declarations */
323 typedef struct Syntax Syntax;
324 typedef struct MatchingRule MatchingRule;
325 typedef struct MatchingRuleUse MatchingRuleUse;
326 typedef struct MatchingRuleAssertion MatchingRuleAssertion;
327 typedef struct OidMacro OidMacro;
328 typedef struct ObjectClass ObjectClass;
329 typedef struct AttributeType AttributeType;
330 typedef struct AttributeDescription AttributeDescription;
331 typedef struct AttributeName AttributeName;
332 typedef struct ContentRule ContentRule;
333 
334 typedef struct AttributeAssertion AttributeAssertion;
335 typedef struct SubstringsAssertion SubstringsAssertion;
336 typedef struct Filter Filter;
337 typedef struct ValuesReturnFilter ValuesReturnFilter;
338 typedef struct Attribute Attribute;
339 #ifdef LDAP_COMP_MATCH
340 typedef struct ComponentData ComponentData;
341 typedef struct ComponentFilter ComponentFilter;
342 #endif
343 
344 typedef struct Entry Entry;
345 typedef struct Modification Modification;
346 typedef struct Modifications Modifications;
347 typedef struct LDAPModList LDAPModList;
348 
349 typedef struct BackendInfo BackendInfo;		/* per backend type */
350 typedef struct BackendDB BackendDB;		/* per backend database */
351 
352 typedef struct Connection Connection;
353 typedef struct Operation Operation;
354 typedef struct SlapReply SlapReply;
355 /* end of forward declarations */
356 
357 typedef union Sockaddr {
358 	struct sockaddr sa_addr;
359 	struct sockaddr_in sa_in_addr;
360 #ifdef LDAP_PF_INET6
361 	struct sockaddr_storage sa_storage;
362 	struct sockaddr_in6 sa_in6_addr;
363 #endif
364 #ifdef LDAP_PF_LOCAL
365 	struct sockaddr_un sa_un_addr;
366 #endif
367 } Sockaddr;
368 
369 #ifdef LDAP_PF_INET6
370 extern int slap_inet4or6;
371 #endif
372 
373 struct OidMacro {
374 	struct berval som_oid;
375 	BerVarray som_names;
376 	BerVarray som_subs;
377 #define	SLAP_OM_HARDCODE	0x10000U	/* This is hardcoded schema */
378 	int som_flags;
379 	LDAP_STAILQ_ENTRY(OidMacro) som_next;
380 };
381 
382 typedef int slap_syntax_validate_func LDAP_P((
383 	Syntax *syntax,
384 	struct berval * in));
385 
386 typedef int slap_syntax_transform_func LDAP_P((
387 	Syntax *syntax,
388 	struct berval * in,
389 	struct berval * out,
390 	void *memctx));
391 
392 #ifdef LDAP_COMP_MATCH
393 typedef void* slap_component_transform_func LDAP_P((
394 	struct berval * in ));
395 struct ComponentDesc;
396 #endif
397 
398 struct Syntax {
399 	LDAPSyntax			ssyn_syn;
400 #define ssyn_oid		ssyn_syn.syn_oid
401 #define ssyn_desc		ssyn_syn.syn_desc
402 #define ssyn_extensions	ssyn_syn.syn_extensions
403 	/*
404 	 * Note: the former
405 	ber_len_t	ssyn_oidlen;
406 	 * has been replaced by a struct berval that uses the value
407 	 * provided by ssyn_syn.syn_oid; a macro that expands to
408 	 * the bv_len field of the berval is provided for backward
409 	 * compatibility.  CAUTION: NEVER FREE THE BERVAL
410 	 */
411 	struct berval	ssyn_bvoid;
412 #define	ssyn_oidlen	ssyn_bvoid.bv_len
413 
414 	unsigned int ssyn_flags;
415 
416 #define SLAP_SYNTAX_NONE	0x0000U
417 #define SLAP_SYNTAX_BLOB	0x0001U /* syntax treated as blob (audio) */
418 #define SLAP_SYNTAX_BINARY	0x0002U /* binary transfer required (certificate) */
419 #define SLAP_SYNTAX_BER		0x0004U /* stored in BER encoding (certificate) */
420 #ifdef SLAP_SCHEMA_EXPOSE
421 #define SLAP_SYNTAX_HIDE	0x0000U /* publish everything */
422 #else
423 #define SLAP_SYNTAX_HIDE	0x8000U /* hide (do not publish) */
424 #endif
425 #define	SLAP_SYNTAX_HARDCODE	0x10000U	/* This is hardcoded schema */
426 
427 	Syntax				**ssyn_sups;
428 
429 	slap_syntax_validate_func	*ssyn_validate;
430 	slap_syntax_transform_func	*ssyn_pretty;
431 
432 #ifdef SLAPD_BINARY_CONVERSION
433 	/* convert to and from binary */
434 	slap_syntax_transform_func	*ssyn_ber2str;
435 	slap_syntax_transform_func	*ssyn_str2ber;
436 #endif
437 #ifdef LDAP_COMP_MATCH
438 	slap_component_transform_func *ssyn_attr2comp;
439 	struct ComponentDesc* ssync_comp_syntax;
440 #endif
441 
442 	LDAP_STAILQ_ENTRY(Syntax)	ssyn_next;
443 };
444 
445 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
446 #define slap_syntax_is_blob(s)		slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
447 #define slap_syntax_is_binary(s)	slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
448 #define slap_syntax_is_ber(s)		slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
449 #define slap_syntax_is_hidden(s)	slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
450 
451 typedef struct slap_syntax_defs_rec {
452 	char *sd_desc;
453 	int sd_flags;
454 	char **sd_sups;
455 	slap_syntax_validate_func *sd_validate;
456 	slap_syntax_transform_func *sd_pretty;
457 #ifdef SLAPD_BINARY_CONVERSION
458 	slap_syntax_transform_func *sd_ber2str;
459 	slap_syntax_transform_func *sd_str2ber;
460 #endif
461 } slap_syntax_defs_rec;
462 
463 /* X -> Y Converter */
464 typedef int slap_mr_convert_func LDAP_P((
465 	struct berval * in,
466 	struct berval * out,
467 	void *memctx ));
468 
469 /* Normalizer */
470 typedef int slap_mr_normalize_func LDAP_P((
471 	slap_mask_t use,
472 	Syntax *syntax, /* NULL if in is asserted value */
473 	MatchingRule *mr,
474 	struct berval *in,
475 	struct berval *out,
476 	void *memctx ));
477 
478 /* Match (compare) function */
479 typedef int slap_mr_match_func LDAP_P((
480 	int *match,
481 	slap_mask_t use,
482 	Syntax *syntax,	/* syntax of stored value */
483 	MatchingRule *mr,
484 	struct berval *value,
485 	void *assertValue ));
486 
487 /* Index generation function */
488 typedef int slap_mr_indexer_func LDAP_P((
489 	slap_mask_t use,
490 	slap_mask_t mask,
491 	Syntax *syntax,	/* syntax of stored value */
492 	MatchingRule *mr,
493 	struct berval *prefix,
494 	BerVarray values,
495 	BerVarray *keys,
496 	void *memctx ));
497 
498 /* Filter index function */
499 typedef int slap_mr_filter_func LDAP_P((
500 	slap_mask_t use,
501 	slap_mask_t mask,
502 	Syntax *syntax,	/* syntax of stored value */
503 	MatchingRule *mr,
504 	struct berval *prefix,
505 	void *assertValue,
506 	BerVarray *keys,
507 	void *memctx ));
508 
509 struct MatchingRule {
510 	LDAPMatchingRule		smr_mrule;
511 	MatchingRuleUse			*smr_mru;
512 	/* RFC 4512 string representation */
513 	struct berval			smr_str;
514 	/*
515 	 * Note: the former
516 	 *			ber_len_t	smr_oidlen;
517 	 * has been replaced by a struct berval that uses the value
518 	 * provided by smr_mrule.mr_oid; a macro that expands to
519 	 * the bv_len field of the berval is provided for backward
520 	 * compatibility.  CAUTION: NEVER FREE THE BERVAL
521 	 */
522 	struct berval			smr_bvoid;
523 #define	smr_oidlen			smr_bvoid.bv_len
524 
525 	slap_mask_t			smr_usage;
526 
527 #ifdef SLAP_SCHEMA_EXPOSE
528 #define SLAP_MR_HIDE			0x0000U
529 #else
530 #define SLAP_MR_HIDE			0x8000U
531 #endif
532 
533 #define SLAP_MR_MUTATION_NORMALIZER	0x4000U
534 
535 #define SLAP_MR_TYPE_MASK		0x0F00U
536 #define SLAP_MR_SUBTYPE_MASK		0x00F0U
537 #define SLAP_MR_USAGE			0x000FU
538 
539 #define SLAP_MR_NONE			0x0000U
540 #define SLAP_MR_EQUALITY		0x0100U
541 #define SLAP_MR_ORDERING		0x0200U
542 #define SLAP_MR_SUBSTR			0x0400U
543 #define SLAP_MR_EXT			0x0800U /* implicitly extensible */
544 #define	SLAP_MR_ORDERED_INDEX		0x1000U
545 #ifdef LDAP_COMP_MATCH
546 #define SLAP_MR_COMPONENT		0x2000U
547 #endif
548 
549 #define SLAP_MR_EQUALITY_APPROX	( SLAP_MR_EQUALITY | 0x0010U )
550 
551 #define SLAP_MR_SUBSTR_INITIAL	( SLAP_MR_SUBSTR | 0x0010U )
552 #define SLAP_MR_SUBSTR_ANY	( SLAP_MR_SUBSTR | 0x0020U )
553 #define SLAP_MR_SUBSTR_FINAL	( SLAP_MR_SUBSTR | 0x0040U )
554 
555 
556 /*
557  * The asserted value, depending on the particular usage,
558  * is expected to conform to either the assertion syntax
559  * or the attribute syntax.   In some cases, the syntax of
560  * the value is known.  If so, these flags indicate which
561  * syntax the value is expected to conform to.  If not,
562  * neither of these flags is set (until the syntax of the
563  * provided value is determined).  If the value is of the
564  * attribute syntax, the flag is changed once a value of
565  * the assertion syntax is derived from the provided value.
566  */
567 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX	0x0001U
568 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX	0x0002U
569 #define SLAP_MR_VALUE_OF_SYNTAX			(SLAP_MR_VALUE_OF_ASSERTION_SYNTAX|SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX)
570 #define SLAP_MR_DENORMALIZE			(SLAP_MR_MUTATION_NORMALIZER)
571 
572 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
573 	((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
574 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
575 	((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
576 #ifdef LDAP_DEBUG
577 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
578 	((usage) & SLAP_MR_VALUE_OF_SYNTAX)
579 #else
580 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage )	(1)
581 #endif
582 #define SLAP_MR_IS_DENORMALIZE( usage ) \
583 	((usage) & SLAP_MR_DENORMALIZE )
584 
585 /* either or both the asserted value or attribute value
586  * may be provided in normalized form
587  */
588 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH		0x0004U
589 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH	0x0008U
590 
591 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
592 	(!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
593 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
594 	((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
595 
596 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
597 	(((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
598 		== SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
599 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
600 	(((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
601 		== SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
602 
603 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
604 	((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
605 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
606 	((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
607 
608 	Syntax			*smr_syntax;
609 	slap_mr_convert_func	*smr_convert;
610 	slap_mr_normalize_func	*smr_normalize;
611 	slap_mr_match_func	*smr_match;
612 	slap_mr_indexer_func	*smr_indexer;
613 	slap_mr_filter_func	*smr_filter;
614 
615 	/*
616 	 * null terminated array of syntaxes compatible with this syntax
617 	 * note: when MS_EXT is set, this MUST NOT contain the assertion
618 	 * syntax of the rule.  When MS_EXT is not set, it MAY.
619 	 */
620 	Syntax			**smr_compat_syntaxes;
621 
622 	/*
623 	 * For equality rules, refers to an associated approximate rule.
624 	 * For non-equality rules, refers to an associated equality rule.
625 	 */
626 	MatchingRule	*smr_associated;
627 
628 #define SLAP_MR_ASSOCIATED(mr,amr)	\
629 	(((mr) == (amr)) || ((mr)->smr_associated == (amr)))
630 
631 	LDAP_SLIST_ENTRY(MatchingRule)	smr_next;
632 
633 #define smr_oid				smr_mrule.mr_oid
634 #define smr_names			smr_mrule.mr_names
635 #define smr_desc			smr_mrule.mr_desc
636 #define smr_obsolete		smr_mrule.mr_obsolete
637 #define smr_syntax_oid		smr_mrule.mr_syntax_oid
638 #define smr_extensions		smr_mrule.mr_extensions
639 };
640 
641 struct MatchingRuleUse {
642 	LDAPMatchingRuleUse		smru_mruleuse;
643 	MatchingRule			*smru_mr;
644 	/* RFC 4512 string representation */
645 	struct berval			smru_str;
646 
647 	LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next;
648 
649 #define smru_oid			smru_mruleuse.mru_oid
650 #define smru_names			smru_mruleuse.mru_names
651 #define smru_desc			smru_mruleuse.mru_desc
652 #define smru_obsolete			smru_mruleuse.mru_obsolete
653 #define smru_applies_oids		smru_mruleuse.mru_applies_oids
654 
655 #define smru_usage			smru_mr->smr_usage
656 } /* MatchingRuleUse */ ;
657 
658 typedef struct slap_mrule_defs_rec {
659 	char *						mrd_desc;
660 	slap_mask_t					mrd_usage;
661 	char **						mrd_compat_syntaxes;
662 	slap_mr_convert_func *		mrd_convert;
663 	slap_mr_normalize_func *	mrd_normalize;
664 	slap_mr_match_func *		mrd_match;
665 	slap_mr_indexer_func *		mrd_indexer;
666 	slap_mr_filter_func *		mrd_filter;
667 
668 	/* For equality rule, this may refer to an associated approximate rule */
669 	/* For non-equality rule, this may refer to an associated equality rule */
670 	char *						mrd_associated;
671 } slap_mrule_defs_rec;
672 
673 typedef int (AttributeTypeSchemaCheckFN)(
674 	BackendDB *be,
675 	Entry *e,
676 	Attribute *attr,
677 	const char** text,
678 	char *textbuf, size_t textlen );
679 
680 struct AttributeType {
681 	LDAPAttributeType		sat_atype;
682 	struct berval			sat_cname;
683 	AttributeType			*sat_sup;
684 	AttributeType			**sat_subtypes;
685 	MatchingRule			*sat_equality;
686 	MatchingRule			*sat_approx;
687 	MatchingRule			*sat_ordering;
688 	MatchingRule			*sat_substr;
689 	Syntax				*sat_syntax;
690 
691 	AttributeTypeSchemaCheckFN	*sat_check;
692 	char				*sat_oidmacro;	/* attribute OID */
693 	char				*sat_soidmacro;	/* syntax OID */
694 
695 #define SLAP_AT_NONE			0x0000U
696 #define SLAP_AT_ABSTRACT		0x0100U /* cannot be instantiated */
697 #define SLAP_AT_FINAL			0x0200U /* cannot be subtyped */
698 #ifdef SLAP_SCHEMA_EXPOSE
699 #define SLAP_AT_HIDE			0x0000U /* publish everything */
700 #else
701 #define SLAP_AT_HIDE			0x8000U /* hide attribute */
702 #endif
703 #define	SLAP_AT_DYNAMIC			0x0400U	/* dynamically generated */
704 
705 #define SLAP_AT_MANAGEABLE		0x0800U	/* no-user-mod can be by-passed */
706 
707 /* Note: ORDERED values have an ordering specifically set by the
708  * user, denoted by the {x} ordering prefix on the values.
709  *
710  * SORTED values are simply sorted by memcmp. SORTED values can
711  * be efficiently located by binary search. ORDERED values have no
712  * such advantage. An attribute cannot have both properties.
713  */
714 #define	SLAP_AT_ORDERED_VAL		0x0001U /* values are ordered */
715 #define	SLAP_AT_ORDERED_SIB		0x0002U /* siblings are ordered */
716 #define	SLAP_AT_ORDERED			0x0003U /* value has order index */
717 
718 #define	SLAP_AT_SORTED_VAL		0x0010U	/* values should be sorted */
719 
720 #define	SLAP_AT_HARDCODE		0x10000U	/* hardcoded schema */
721 #define	SLAP_AT_DELETED			0x20000U
722 
723 	slap_mask_t			sat_flags;
724 
725 	LDAP_STAILQ_ENTRY(AttributeType) sat_next;
726 
727 #define sat_oid				sat_atype.at_oid
728 #define sat_names			sat_atype.at_names
729 #define sat_desc			sat_atype.at_desc
730 #define sat_obsolete			sat_atype.at_obsolete
731 #define sat_sup_oid			sat_atype.at_sup_oid
732 #define sat_equality_oid		sat_atype.at_equality_oid
733 #define sat_ordering_oid		sat_atype.at_ordering_oid
734 #define sat_substr_oid			sat_atype.at_substr_oid
735 #define sat_syntax_oid			sat_atype.at_syntax_oid
736 #define sat_single_value		sat_atype.at_single_value
737 #define sat_collective			sat_atype.at_collective
738 #define sat_no_user_mod			sat_atype.at_no_user_mod
739 #define sat_usage			sat_atype.at_usage
740 #define sat_extensions			sat_atype.at_extensions
741 
742 	AttributeDescription		*sat_ad;
743 	ldap_pvt_thread_mutex_t		sat_ad_mutex;
744 };
745 
746 #define is_at_operational(at)	((at)->sat_usage)
747 #define is_at_single_value(at)	((at)->sat_single_value)
748 #define is_at_collective(at)	((at)->sat_collective)
749 #define is_at_obsolete(at)		((at)->sat_obsolete)
750 #define is_at_no_user_mod(at)	((at)->sat_no_user_mod)
751 
752 typedef int (ObjectClassSchemaCheckFN)(
753 	BackendDB *be,
754 	Entry *e,
755 	ObjectClass *oc,
756 	const char** text,
757 	char *textbuf, size_t textlen );
758 
759 struct ObjectClass {
760 	LDAPObjectClass			soc_oclass;
761 	struct berval			soc_cname;
762 	ObjectClass			**soc_sups;
763 	AttributeType			**soc_required;
764 	AttributeType			**soc_allowed;
765 	ObjectClassSchemaCheckFN	*soc_check;
766 	char				*soc_oidmacro;
767 	slap_mask_t			soc_flags;
768 #define soc_oid				soc_oclass.oc_oid
769 #define soc_names			soc_oclass.oc_names
770 #define soc_desc			soc_oclass.oc_desc
771 #define soc_obsolete			soc_oclass.oc_obsolete
772 #define soc_sup_oids			soc_oclass.oc_sup_oids
773 #define soc_kind			soc_oclass.oc_kind
774 #define soc_at_oids_must		soc_oclass.oc_at_oids_must
775 #define soc_at_oids_may			soc_oclass.oc_at_oids_may
776 #define soc_extensions			soc_oclass.oc_extensions
777 
778 	LDAP_STAILQ_ENTRY(ObjectClass)	soc_next;
779 };
780 
781 #define	SLAP_OCF_SET_FLAGS	0x1
782 #define	SLAP_OCF_CHECK_SUP	0x2
783 #define	SLAP_OCF_MASK		(SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
784 
785 #define	SLAP_OC_ALIAS		0x0001
786 #define	SLAP_OC_REFERRAL	0x0002
787 #define	SLAP_OC_SUBENTRY	0x0004
788 #define	SLAP_OC_DYNAMICOBJECT	0x0008
789 #define	SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY	0x0010
790 #define SLAP_OC_GLUE		0x0020
791 #define SLAP_OC_SYNCPROVIDERSUBENTRY		0x0040
792 #define SLAP_OC_SYNCCONSUMERSUBENTRY		0x0080
793 #define	SLAP_OC__MASK		0x00FF
794 #define	SLAP_OC__END		0x0100
795 #define SLAP_OC_OPERATIONAL	0x4000
796 #ifdef SLAP_SCHEMA_EXPOSE
797 #define SLAP_OC_HIDE		0x0000
798 #else
799 #define SLAP_OC_HIDE		0x8000
800 #endif
801 #define	SLAP_OC_HARDCODE	0x10000U	/* This is hardcoded schema */
802 #define	SLAP_OC_DELETED		0x20000U
803 
804 /*
805  * DIT content rule
806  */
807 struct ContentRule {
808 	LDAPContentRule		scr_crule;
809 	ObjectClass		*scr_sclass;
810 	ObjectClass		**scr_auxiliaries;	/* optional */
811 	AttributeType		**scr_required;		/* optional */
812 	AttributeType		**scr_allowed;		/* optional */
813 	AttributeType		**scr_precluded;	/* optional */
814 #define scr_oid			scr_crule.cr_oid
815 #define scr_names		scr_crule.cr_names
816 #define scr_desc		scr_crule.cr_desc
817 #define scr_obsolete		scr_crule.cr_obsolete
818 #define scr_oc_oids_aux		scr_crule.cr_oc_oids_aux
819 #define scr_at_oids_must	scr_crule.cr_at_oids_must
820 #define scr_at_oids_may		scr_crule.cr_at_oids_may
821 #define scr_at_oids_not		scr_crule.cr_at_oids_not
822 
823 	char			*scr_oidmacro;
824 #define	SLAP_CR_HARDCODE	0x10000U
825 	int			scr_flags;
826 
827 	LDAP_STAILQ_ENTRY( ContentRule ) scr_next;
828 };
829 
830 /* Represents a recognized attribute description ( type + options ). */
831 struct AttributeDescription {
832 	AttributeDescription	*ad_next;
833 	AttributeType		*ad_type;	/* attribute type, must be specified */
834 	struct berval		ad_cname;	/* canonical name, must be specified */
835 	struct berval		ad_tags;	/* empty if no tagging options */
836 	unsigned ad_flags;
837 #define SLAP_DESC_NONE		0x00U
838 #define SLAP_DESC_BINARY	0x01U
839 #define SLAP_DESC_TAG_RANGE	0x80U
840 #define SLAP_DESC_TEMPORARY	0x1000U
841 };
842 
843 /* flags to slap_*2undef_ad to register undefined (0, the default)
844  * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
845  * SLAP_AD_NOINSERT is to lookup without insert */
846 #define SLAP_AD_UNDEF		0x00U
847 #define SLAP_AD_PROXIED		0x01U
848 #define	SLAP_AD_NOINSERT	0x02U
849 
850 #define	SLAP_AN_OCEXCLUDE	0x01
851 #define	SLAP_AN_OCINITED	0x02
852 
853 struct AttributeName {
854 	struct berval		an_name;
855 	AttributeDescription	*an_desc;
856 	int			an_flags;
857 	ObjectClass		*an_oc;
858 };
859 
860 #define slap_ad_is_tagged(ad)			( (ad)->ad_tags.bv_len != 0 )
861 #define slap_ad_is_tag_range(ad)	\
862 	( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
863 #define slap_ad_is_binary(ad)		\
864 	( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
865 
866 /*
867  * pointers to schema elements used internally
868  */
869 struct slap_internal_schema {
870 	/* objectClass */
871 	ObjectClass *si_oc_top;
872 	ObjectClass *si_oc_extensibleObject;
873 	ObjectClass *si_oc_alias;
874 	ObjectClass *si_oc_referral;
875 	ObjectClass *si_oc_rootdse;
876 	ObjectClass *si_oc_subentry;
877 	ObjectClass *si_oc_subschema;
878 	ObjectClass *si_oc_collectiveAttributeSubentry;
879 	ObjectClass *si_oc_dynamicObject;
880 
881 	ObjectClass *si_oc_glue;
882 	ObjectClass *si_oc_syncConsumerSubentry;
883 	ObjectClass *si_oc_syncProviderSubentry;
884 
885 	/* objectClass attribute descriptions */
886 	AttributeDescription *si_ad_objectClass;
887 
888 	/* operational attribute descriptions */
889 	AttributeDescription *si_ad_structuralObjectClass;
890 	AttributeDescription *si_ad_creatorsName;
891 	AttributeDescription *si_ad_createTimestamp;
892 	AttributeDescription *si_ad_modifiersName;
893 	AttributeDescription *si_ad_modifyTimestamp;
894 	AttributeDescription *si_ad_hasSubordinates;
895 	AttributeDescription *si_ad_subschemaSubentry;
896 	AttributeDescription *si_ad_collectiveSubentries;
897 	AttributeDescription *si_ad_collectiveExclusions;
898 	AttributeDescription *si_ad_entryDN;
899 	AttributeDescription *si_ad_entryUUID;
900 	AttributeDescription *si_ad_entryCSN;
901 	AttributeDescription *si_ad_namingCSN;
902 
903 	AttributeDescription *si_ad_dseType;
904 	AttributeDescription *si_ad_syncreplCookie;
905 	AttributeDescription *si_ad_syncTimestamp;
906 	AttributeDescription *si_ad_contextCSN;
907 
908 	/* root DSE attribute descriptions */
909 	AttributeDescription *si_ad_altServer;
910 	AttributeDescription *si_ad_namingContexts;
911 	AttributeDescription *si_ad_supportedControl;
912 	AttributeDescription *si_ad_supportedExtension;
913 	AttributeDescription *si_ad_supportedLDAPVersion;
914 	AttributeDescription *si_ad_supportedSASLMechanisms;
915 	AttributeDescription *si_ad_supportedFeatures;
916 	AttributeDescription *si_ad_monitorContext;
917 	AttributeDescription *si_ad_vendorName;
918 	AttributeDescription *si_ad_vendorVersion;
919 	AttributeDescription *si_ad_configContext;
920 
921 	/* subentry attribute descriptions */
922 	AttributeDescription *si_ad_administrativeRole;
923 	AttributeDescription *si_ad_subtreeSpecification;
924 
925 	/* subschema subentry attribute descriptions */
926 	AttributeDescription *si_ad_attributeTypes;
927 	AttributeDescription *si_ad_ditContentRules;
928 	AttributeDescription *si_ad_ditStructureRules;
929 	AttributeDescription *si_ad_ldapSyntaxes;
930 	AttributeDescription *si_ad_matchingRules;
931 	AttributeDescription *si_ad_matchingRuleUse;
932 	AttributeDescription *si_ad_nameForms;
933 	AttributeDescription *si_ad_objectClasses;
934 
935 	/* Aliases & Referrals */
936 	AttributeDescription *si_ad_aliasedObjectName;
937 	AttributeDescription *si_ad_ref;
938 
939 	/* Access Control Internals */
940 	AttributeDescription *si_ad_entry;
941 	AttributeDescription *si_ad_children;
942 	AttributeDescription *si_ad_saslAuthzTo;
943 	AttributeDescription *si_ad_saslAuthzFrom;
944 
945 	/* dynamic entries */
946 	AttributeDescription *si_ad_entryTtl;
947 	AttributeDescription *si_ad_dynamicSubtrees;
948 
949 	/* Other attributes descriptions */
950 	AttributeDescription *si_ad_distinguishedName;
951 	AttributeDescription *si_ad_name;
952 	AttributeDescription *si_ad_cn;
953 	AttributeDescription *si_ad_uid;
954 	AttributeDescription *si_ad_uidNumber;
955 	AttributeDescription *si_ad_gidNumber;
956 	AttributeDescription *si_ad_userPassword;
957 	AttributeDescription *si_ad_labeledURI;
958 #ifdef SLAPD_AUTHPASSWD
959 	AttributeDescription *si_ad_authPassword;
960 	AttributeDescription *si_ad_authPasswordSchemes;
961 #endif
962 	AttributeDescription *si_ad_description;
963 	AttributeDescription *si_ad_seeAlso;
964 
965 	/* Undefined Attribute Type */
966 	AttributeType	*si_at_undefined;
967 
968 	/* "Proxied" Attribute Type */
969 	AttributeType	*si_at_proxied;
970 
971 	/* Matching Rules */
972 	MatchingRule	*si_mr_distinguishedNameMatch;
973 	MatchingRule	*si_mr_dnSubtreeMatch;
974 	MatchingRule	*si_mr_dnOneLevelMatch;
975 	MatchingRule	*si_mr_dnSubordinateMatch;
976 	MatchingRule	*si_mr_dnSuperiorMatch;
977 	MatchingRule    *si_mr_caseExactMatch;
978 	MatchingRule    *si_mr_caseExactSubstringsMatch;
979 	MatchingRule    *si_mr_caseExactIA5Match;
980 	MatchingRule	*si_mr_integerMatch;
981 	MatchingRule    *si_mr_integerFirstComponentMatch;
982 	MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
983 	MatchingRule    *si_mr_caseIgnoreMatch;
984 	MatchingRule    *si_mr_caseIgnoreListMatch;
985 
986 	/* Syntaxes */
987 	Syntax		*si_syn_directoryString;
988 	Syntax		*si_syn_distinguishedName;
989 	Syntax		*si_syn_integer;
990 	Syntax		*si_syn_octetString;
991 
992 	/* Schema Syntaxes */
993 	Syntax		*si_syn_attributeTypeDesc;
994 	Syntax		*si_syn_ditContentRuleDesc;
995 	Syntax		*si_syn_ditStructureRuleDesc;
996 	Syntax		*si_syn_ldapSyntaxDesc;
997 	Syntax		*si_syn_matchingRuleDesc;
998 	Syntax		*si_syn_matchingRuleUseDesc;
999 	Syntax		*si_syn_nameFormDesc;
1000 	Syntax		*si_syn_objectClassDesc;
1001 };
1002 
1003 struct AttributeAssertion {
1004 	AttributeDescription	*aa_desc;
1005 	struct berval		aa_value;
1006 #ifdef LDAP_COMP_MATCH
1007 	ComponentFilter		*aa_cf;		/* for attribute aliasing */
1008 #endif
1009 };
1010 #ifdef LDAP_COMP_MATCH
1011 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL, NULL }
1012 #else
1013 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL }
1014 #endif
1015 
1016 struct SubstringsAssertion {
1017 	AttributeDescription	*sa_desc;
1018 	struct berval		sa_initial;
1019 	struct berval		*sa_any;
1020 	struct berval		sa_final;
1021 };
1022 
1023 struct MatchingRuleAssertion {
1024 	AttributeDescription	*ma_desc;	/* optional */
1025 	struct berval		ma_value;	/* required */
1026 	MatchingRule		*ma_rule;	/* optional */
1027 	struct berval		ma_rule_text;	/* optional */
1028 	int			ma_dnattrs;	/* boolean */
1029 #ifdef LDAP_COMP_MATCH
1030 	ComponentFilter		*ma_cf;	/* component filter */
1031 #endif
1032 };
1033 
1034 /*
1035  * represents a search filter
1036  */
1037 struct Filter {
1038 	ber_tag_t	f_choice;	/* values taken from ldap.h, plus: */
1039 #define SLAPD_FILTER_COMPUTED		0
1040 #define SLAPD_FILTER_MASK			0x7fff
1041 #define SLAPD_FILTER_UNDEFINED		0x8000
1042 
1043 	union f_un_u {
1044 		/* precomputed result */
1045 		ber_int_t		f_un_result;
1046 
1047 		/* present */
1048 		AttributeDescription	*f_un_desc;
1049 
1050 		/* simple value assertion */
1051 		AttributeAssertion	*f_un_ava;
1052 
1053 		/* substring assertion */
1054 		SubstringsAssertion	*f_un_ssa;
1055 
1056 		/* matching rule assertion */
1057 		MatchingRuleAssertion	*f_un_mra;
1058 
1059 #define f_desc			f_un.f_un_desc
1060 #define f_ava			f_un.f_un_ava
1061 #define f_av_desc		f_un.f_un_ava->aa_desc
1062 #define f_av_value		f_un.f_un_ava->aa_value
1063 #define f_sub			f_un.f_un_ssa
1064 #define f_sub_desc		f_un.f_un_ssa->sa_desc
1065 #define f_sub_initial		f_un.f_un_ssa->sa_initial
1066 #define f_sub_any		f_un.f_un_ssa->sa_any
1067 #define f_sub_final		f_un.f_un_ssa->sa_final
1068 #define f_mra			f_un.f_un_mra
1069 #define f_mr_rule		f_un.f_un_mra->ma_rule
1070 #define f_mr_rule_text		f_un.f_un_mra->ma_rule_text
1071 #define f_mr_desc		f_un.f_un_mra->ma_desc
1072 #define f_mr_value		f_un.f_un_mra->ma_value
1073 #define	f_mr_dnattrs		f_un.f_un_mra->ma_dnattrs
1074 
1075 		/* and, or, not */
1076 		Filter			*f_un_complex;
1077 	} f_un;
1078 
1079 #define f_result	f_un.f_un_result
1080 #define f_and		f_un.f_un_complex
1081 #define f_or		f_un.f_un_complex
1082 #define f_not		f_un.f_un_complex
1083 #define f_list		f_un.f_un_complex
1084 
1085 	Filter		*f_next;
1086 };
1087 
1088 /* compare routines can return undefined */
1089 #define SLAPD_COMPARE_UNDEFINED	((ber_int_t) -1)
1090 
1091 struct ValuesReturnFilter {
1092 	ber_tag_t	vrf_choice;
1093 
1094 	union vrf_un_u {
1095 		/* precomputed result */
1096 		ber_int_t vrf_un_result;
1097 
1098 		/* DN */
1099 		char *vrf_un_dn;
1100 
1101 		/* present */
1102 		AttributeDescription *vrf_un_desc;
1103 
1104 		/* simple value assertion */
1105 		AttributeAssertion *vrf_un_ava;
1106 
1107 		/* substring assertion */
1108 		SubstringsAssertion *vrf_un_ssa;
1109 
1110 		/* matching rule assertion */
1111 		MatchingRuleAssertion *vrf_un_mra;
1112 
1113 #define vrf_result		vrf_un.vrf_un_result
1114 #define vrf_dn			vrf_un.vrf_un_dn
1115 #define vrf_desc		vrf_un.vrf_un_desc
1116 #define vrf_ava			vrf_un.vrf_un_ava
1117 #define vrf_av_desc		vrf_un.vrf_un_ava->aa_desc
1118 #define vrf_av_value	vrf_un.vrf_un_ava->aa_value
1119 #define vrf_ssa			vrf_un.vrf_un_ssa
1120 #define vrf_sub			vrf_un.vrf_un_ssa
1121 #define vrf_sub_desc	vrf_un.vrf_un_ssa->sa_desc
1122 #define vrf_sub_initial	vrf_un.vrf_un_ssa->sa_initial
1123 #define vrf_sub_any		vrf_un.vrf_un_ssa->sa_any
1124 #define vrf_sub_final	vrf_un.vrf_un_ssa->sa_final
1125 #define vrf_mra			vrf_un.vrf_un_mra
1126 #define vrf_mr_rule		vrf_un.vrf_un_mra->ma_rule
1127 #define vrf_mr_rule_text	vrf_un.vrf_un_mra->ma_rule_text
1128 #define vrf_mr_desc		vrf_un.vrf_un_mra->ma_desc
1129 #define vrf_mr_value		vrf_un.vrf_un_mra->ma_value
1130 #define	vrf_mr_dnattrs	vrf_un.vrf_un_mra->ma_dnattrs
1131 
1132 
1133 	} vrf_un;
1134 
1135 	ValuesReturnFilter	*vrf_next;
1136 };
1137 
1138 /*
1139  * represents an attribute (description + values)
1140  * desc, vals, nvals, numvals fields must align with Modification
1141  */
1142 struct Attribute {
1143 	AttributeDescription	*a_desc;
1144 	BerVarray		a_vals;		/* preserved values */
1145 	BerVarray		a_nvals;	/* normalized values */
1146 	unsigned		a_numvals;	/* number of vals */
1147 	unsigned		a_flags;
1148 #define SLAP_ATTR_IXADD			0x1U
1149 #define SLAP_ATTR_IXDEL			0x2U
1150 #define SLAP_ATTR_DONT_FREE_DATA	0x4U
1151 #define SLAP_ATTR_DONT_FREE_VALS	0x8U
1152 #define	SLAP_ATTR_SORTED_VALS		0x10U	/* values are sorted */
1153 
1154 /* These flags persist across an attr_dup() */
1155 #define	SLAP_ATTR_PERSISTENT_FLAGS \
1156 	SLAP_ATTR_SORTED_VALS
1157 
1158 	Attribute		*a_next;
1159 #ifdef LDAP_COMP_MATCH
1160 	ComponentData		*a_comp_data;	/* component values */
1161 #endif
1162 };
1163 
1164 
1165 /*
1166  * the id used in the indexes to refer to an entry
1167  */
1168 typedef unsigned long	ID;
1169 #define NOID	((ID)~0)
1170 
1171 typedef struct EntryHeader {
1172 	struct berval bv;
1173 	char *data;
1174 	int nattrs;
1175 	int nvals;
1176 } EntryHeader;
1177 
1178 /*
1179  * represents an entry in core
1180  */
1181 struct Entry {
1182 	/*
1183 	 * The ID field should only be changed before entry is
1184 	 * inserted into a cache.  The ID value is backend
1185 	 * specific.
1186 	 */
1187 	ID		e_id;
1188 
1189 	struct berval e_name;	/* name (DN) of this entry */
1190 	struct berval e_nname;	/* normalized name (DN) of this entry */
1191 
1192 	/* for migration purposes */
1193 #define e_dn e_name.bv_val
1194 #define e_ndn e_nname.bv_val
1195 
1196 	Attribute	*e_attrs;	/* list of attributes + values */
1197 
1198 	slap_mask_t	e_ocflags;
1199 
1200 	struct berval	e_bv;		/* For entry_encode/entry_decode */
1201 
1202 	/* for use by the backend for any purpose */
1203 	void*	e_private;
1204 };
1205 
1206 /*
1207  * A list of LDAPMods
1208  * desc, values, nvalues, numvals must align with Attribute
1209  */
1210 struct Modification {
1211 	AttributeDescription *sm_desc;
1212 	BerVarray sm_values;
1213 	BerVarray sm_nvalues;
1214 	unsigned sm_numvals;
1215 	short sm_op;
1216 	short sm_flags;
1217 /* Set for internal mods, will bypass ACL checks. Only needed when
1218  * running as non-root user, for user modifiable attributes.
1219  */
1220 #define	SLAP_MOD_INTERNAL	0x01
1221 #define	SLAP_MOD_MANAGING	0x02
1222 	struct berval sm_type;
1223 };
1224 
1225 struct Modifications {
1226 	Modification	sml_mod;
1227 #define sml_op		sml_mod.sm_op
1228 #define sml_flags	sml_mod.sm_flags
1229 #define sml_desc	sml_mod.sm_desc
1230 #define	sml_type	sml_mod.sm_type
1231 #define sml_values	sml_mod.sm_values
1232 #define sml_nvalues	sml_mod.sm_nvalues
1233 #define sml_numvals	sml_mod.sm_numvals
1234 	Modifications	*sml_next;
1235 };
1236 
1237 /*
1238  * represents an access control list
1239  */
1240 typedef enum slap_access_t {
1241 	ACL_INVALID_ACCESS = -1,
1242 	ACL_NONE = 0,
1243 	ACL_DISCLOSE,
1244 	ACL_AUTH,
1245 	ACL_COMPARE,
1246 	ACL_SEARCH,
1247 	ACL_READ,
1248 	ACL_WRITE_,
1249 	ACL_MANAGE,
1250 
1251 	/* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1252 	ACL_LAST,
1253 
1254 	/* ACL level mask and modifiers */
1255 	ACL_LEVEL_MASK = 0x000f,
1256 	ACL_QUALIFIER1 = 0x0100,
1257 	ACL_QUALIFIER2 = 0x0200,
1258 	ACL_QUALIFIER3 = 0x0400,
1259 	ACL_QUALIFIER4 = 0x0800,
1260 	ACL_QUALIFIER_MASK = 0x0f00,
1261 
1262 	/* write granularity */
1263 	ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1264 	ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1265 
1266 	ACL_WRITE = ACL_WADD|ACL_WDEL
1267 } slap_access_t;
1268 
1269 typedef enum slap_control_e {
1270 	ACL_INVALID_CONTROL	= 0,
1271 	ACL_STOP,
1272 	ACL_CONTINUE,
1273 	ACL_BREAK
1274 } slap_control_t;
1275 
1276 typedef enum slap_style_e {
1277 	ACL_STYLE_REGEX = 0,
1278 	ACL_STYLE_EXPAND,
1279 	ACL_STYLE_BASE,
1280 	ACL_STYLE_ONE,
1281 	ACL_STYLE_SUBTREE,
1282 	ACL_STYLE_CHILDREN,
1283 	ACL_STYLE_LEVEL,
1284 	ACL_STYLE_ATTROF,
1285 	ACL_STYLE_ANONYMOUS,
1286 	ACL_STYLE_USERS,
1287 	ACL_STYLE_SELF,
1288 	ACL_STYLE_IP,
1289 	ACL_STYLE_IPV6,
1290 	ACL_STYLE_PATH,
1291 
1292 	ACL_STYLE_NONE
1293 } slap_style_t;
1294 
1295 typedef struct AuthorizationInformation {
1296 	ber_tag_t	sai_method;			/* LDAP_AUTH_* from <ldap.h> */
1297 	struct berval	sai_mech;		/* SASL Mechanism */
1298 	struct berval	sai_dn;			/* DN for reporting purposes */
1299 	struct berval	sai_ndn;		/* Normalized DN */
1300 
1301 	/* Security Strength Factors */
1302 	slap_ssf_t	sai_ssf;			/* Overall SSF */
1303 	slap_ssf_t	sai_transport_ssf;	/* Transport SSF */
1304 	slap_ssf_t	sai_tls_ssf;		/* TLS SSF */
1305 	slap_ssf_t	sai_sasl_ssf;		/* SASL SSF */
1306 } AuthorizationInformation;
1307 
1308 #ifdef SLAP_DYNACL
1309 
1310 /*
1311  * "dynamic" ACL infrastructure (for ACIs and more)
1312  */
1313 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1314 	const char *opts, slap_style_t, const char *, void **privp ));
1315 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1316 typedef int (slap_dynacl_mask) LDAP_P((
1317 		void			*priv,
1318 		Operation		*op,
1319 		Entry			*e,
1320 		AttributeDescription	*desc,
1321 		struct berval		*val,
1322 		int			nmatch,
1323 		regmatch_t		*matches,
1324 		slap_access_t		*grant,
1325 		slap_access_t		*deny ));
1326 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1327 
1328 typedef struct slap_dynacl_t {
1329 	char			*da_name;
1330 	slap_dynacl_parse	*da_parse;
1331 	slap_dynacl_unparse	*da_unparse;
1332 	slap_dynacl_mask	*da_mask;
1333 	slap_dynacl_destroy	*da_destroy;
1334 
1335 	void			*da_private;
1336 	struct slap_dynacl_t	*da_next;
1337 } slap_dynacl_t;
1338 #endif /* SLAP_DYNACL */
1339 
1340 /* the DN portion of the "by" part */
1341 typedef struct slap_dn_access {
1342 	/* DN pattern */
1343 	AuthorizationInformation	a_dnauthz;
1344 #define	a_pat			a_dnauthz.sai_dn
1345 
1346 	slap_style_t		a_style;
1347 	int			a_level;
1348 	int			a_self_level;
1349 	AttributeDescription	*a_at;
1350 	int			a_self;
1351 	int 			a_expand;
1352 } slap_dn_access;
1353 
1354 /* the "by" part */
1355 typedef struct Access {
1356 	slap_control_t a_type;
1357 
1358 /* strip qualifiers */
1359 #define ACL_LEVEL(p)			((p) & ACL_LEVEL_MASK)
1360 #define ACL_QUALIFIERS(p)		((p) & ~ACL_LEVEL_MASK)
1361 
1362 #define ACL_ACCESS2PRIV(access)		((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1363 
1364 #define ACL_PRIV_NONE			ACL_ACCESS2PRIV( ACL_NONE )
1365 #define ACL_PRIV_DISCLOSE		ACL_ACCESS2PRIV( ACL_DISCLOSE )
1366 #define ACL_PRIV_AUTH			ACL_ACCESS2PRIV( ACL_AUTH )
1367 #define ACL_PRIV_COMPARE		ACL_ACCESS2PRIV( ACL_COMPARE )
1368 #define ACL_PRIV_SEARCH			ACL_ACCESS2PRIV( ACL_SEARCH )
1369 #define ACL_PRIV_READ			ACL_ACCESS2PRIV( ACL_READ )
1370 #define ACL_PRIV_WADD			ACL_ACCESS2PRIV( ACL_WADD )
1371 #define ACL_PRIV_WDEL			ACL_ACCESS2PRIV( ACL_WDEL )
1372 #define ACL_PRIV_WRITE			( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1373 #define ACL_PRIV_MANAGE			ACL_ACCESS2PRIV( ACL_MANAGE )
1374 
1375 /* NOTE: always use the highest level; current: 0x00ffUL */
1376 #define ACL_PRIV_MASK			((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1377 
1378 /* priv flags */
1379 #define ACL_PRIV_LEVEL			0x1000UL
1380 #define ACL_PRIV_ADDITIVE		0x2000UL
1381 #define ACL_PRIV_SUBSTRACTIVE		0x4000UL
1382 
1383 /* invalid privs */
1384 #define ACL_PRIV_INVALID		0x0UL
1385 
1386 #define ACL_PRIV_ISSET(m,p)		(((m) & (p)) == (p))
1387 #define ACL_PRIV_ASSIGN(m,p)		do { (m)  =  (p); } while(0)
1388 #define ACL_PRIV_SET(m,p)		do { (m) |=  (p); } while(0)
1389 #define ACL_PRIV_CLR(m,p)		do { (m) &= ~(p); } while(0)
1390 
1391 #define ACL_INIT(m)			ACL_PRIV_ASSIGN((m), ACL_PRIV_NONE)
1392 #define ACL_INVALIDATE(m)		ACL_PRIV_ASSIGN((m), ACL_PRIV_INVALID)
1393 
1394 #define ACL_GRANT(m,a)			ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1395 
1396 #define ACL_IS_INVALID(m)		((m) == ACL_PRIV_INVALID)
1397 
1398 #define ACL_IS_LEVEL(m)			ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1399 #define ACL_IS_ADDITIVE(m)		ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1400 #define ACL_IS_SUBTRACTIVE(m)		ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1401 
1402 #define ACL_LVL_NONE			(ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1403 #define ACL_LVL_DISCLOSE		(ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1404 #define ACL_LVL_AUTH			(ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1405 #define ACL_LVL_COMPARE			(ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1406 #define ACL_LVL_SEARCH			(ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1407 #define ACL_LVL_READ			(ACL_PRIV_READ|ACL_LVL_SEARCH)
1408 #define ACL_LVL_WADD			(ACL_PRIV_WADD|ACL_LVL_READ)
1409 #define ACL_LVL_WDEL			(ACL_PRIV_WDEL|ACL_LVL_READ)
1410 #define ACL_LVL_WRITE			(ACL_PRIV_WRITE|ACL_LVL_READ)
1411 #define ACL_LVL_MANAGE			(ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1412 
1413 #define ACL_LVL(m,l)			(((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1414 #define ACL_LVL_IS_NONE(m)		ACL_LVL((m),ACL_LVL_NONE)
1415 #define ACL_LVL_IS_DISCLOSE(m)		ACL_LVL((m),ACL_LVL_DISCLOSE)
1416 #define ACL_LVL_IS_AUTH(m)		ACL_LVL((m),ACL_LVL_AUTH)
1417 #define ACL_LVL_IS_COMPARE(m)		ACL_LVL((m),ACL_LVL_COMPARE)
1418 #define ACL_LVL_IS_SEARCH(m)		ACL_LVL((m),ACL_LVL_SEARCH)
1419 #define ACL_LVL_IS_READ(m)		ACL_LVL((m),ACL_LVL_READ)
1420 #define ACL_LVL_IS_WADD(m)		ACL_LVL((m),ACL_LVL_WADD)
1421 #define ACL_LVL_IS_WDEL(m)		ACL_LVL((m),ACL_LVL_WDEL)
1422 #define ACL_LVL_IS_WRITE(m)		ACL_LVL((m),ACL_LVL_WRITE)
1423 #define ACL_LVL_IS_MANAGE(m)		ACL_LVL((m),ACL_LVL_MANAGE)
1424 
1425 #define ACL_LVL_ASSIGN_NONE(m)		ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1426 #define ACL_LVL_ASSIGN_DISCLOSE(m)	ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1427 #define ACL_LVL_ASSIGN_AUTH(m)		ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1428 #define ACL_LVL_ASSIGN_COMPARE(m)	ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1429 #define ACL_LVL_ASSIGN_SEARCH(m)	ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1430 #define ACL_LVL_ASSIGN_READ(m)		ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1431 #define ACL_LVL_ASSIGN_WADD(m)		ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1432 #define ACL_LVL_ASSIGN_WDEL(m)		ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1433 #define ACL_LVL_ASSIGN_WRITE(m)		ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1434 #define ACL_LVL_ASSIGN_MANAGE(m)	ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1435 
1436 	slap_mask_t	a_access_mask;
1437 
1438 	/* DN pattern */
1439 	slap_dn_access		a_dn;
1440 #define a_dn_pat		a_dn.a_dnauthz.sai_dn
1441 #define	a_dn_at			a_dn.a_at
1442 #define	a_dn_self		a_dn.a_self
1443 
1444 	/* real DN pattern */
1445 	slap_dn_access		a_realdn;
1446 #define a_realdn_pat		a_realdn.a_dnauthz.sai_dn
1447 #define	a_realdn_at		a_realdn.a_at
1448 #define	a_realdn_self		a_realdn.a_self
1449 
1450 	/* used for ssf stuff
1451 	 * NOTE: the ssf stuff in a_realdn is ignored */
1452 #define	a_authz			a_dn.a_dnauthz
1453 
1454 	/* connection related stuff */
1455 	slap_style_t a_peername_style;
1456 	struct berval	a_peername_pat;
1457 #ifdef LDAP_PF_INET6
1458 	union {
1459 		struct in6_addr	ax6;
1460 		unsigned long	ax;
1461 	}	ax_peername_addr,
1462 		ax_peername_mask;
1463 #define	a_peername_addr6	ax_peername_addr.ax6
1464 #define	a_peername_addr		ax_peername_addr.ax
1465 #define	a_peername_mask6	ax_peername_mask.ax6
1466 #define	a_peername_mask		ax_peername_mask.ax
1467 /* apparently, only s6_addr is portable;
1468  * define a portable address mask comparison */
1469 #define	slap_addr6_mask(val, msk, asr) ( \
1470 	(((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \
1471 	&& (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \
1472 	&& (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \
1473 	&& (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \
1474 	&& (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \
1475 	&& (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \
1476 	&& (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \
1477 	&& (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \
1478 	&& (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \
1479 	&& (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \
1480 	&& (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \
1481 	&& (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \
1482 	&& (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \
1483 	&& (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \
1484 	&& (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \
1485 	&& (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \
1486 	)
1487 #else /* ! LDAP_PF_INET6 */
1488 	unsigned long	a_peername_addr,
1489 			a_peername_mask;
1490 #endif /* ! LDAP_PF_INET6 */
1491 	int		a_peername_port;
1492 
1493 	slap_style_t a_sockname_style;
1494 	struct berval	a_sockname_pat;
1495 
1496 	slap_style_t a_domain_style;
1497 	struct berval	a_domain_pat;
1498 	int		a_domain_expand;
1499 
1500 	slap_style_t a_sockurl_style;
1501 	struct berval	a_sockurl_pat;
1502 	slap_style_t a_set_style;
1503 	struct berval	a_set_pat;
1504 
1505 #ifdef SLAP_DYNACL
1506 	slap_dynacl_t		*a_dynacl;
1507 #endif /* SLAP_DYNACL */
1508 
1509 	/* ACL Groups */
1510 	slap_style_t a_group_style;
1511 	struct berval	a_group_pat;
1512 	ObjectClass		*a_group_oc;
1513 	AttributeDescription	*a_group_at;
1514 
1515 	struct Access		*a_next;
1516 } Access;
1517 
1518 /* the "to" part */
1519 typedef struct AccessControl {
1520 	/* "to" part: the entries this acl applies to */
1521 	Filter		*acl_filter;
1522 	slap_style_t acl_dn_style;
1523 	regex_t		acl_dn_re;
1524 	struct berval	acl_dn_pat;
1525 	AttributeName	*acl_attrs;
1526 	MatchingRule	*acl_attrval_mr;
1527 	slap_style_t	acl_attrval_style;
1528 	regex_t		acl_attrval_re;
1529 	struct berval	acl_attrval;
1530 
1531 	/* "by" part: list of who has what access to the entries */
1532 	Access	*acl_access;
1533 
1534 	struct AccessControl	*acl_next;
1535 } AccessControl;
1536 
1537 typedef struct AccessControlState {
1538 	/* Access state */
1539 
1540 	/* The stored state is valid when requesting as_access access
1541 	 * to the as_desc attributes.	 */
1542 	AttributeDescription *as_desc;
1543 	slap_access_t	as_access;
1544 
1545 	/* Value dependent acl where processing can restart */
1546 	AccessControl  *as_vd_acl;
1547 	int as_vd_acl_count;
1548 	slap_mask_t		as_vd_mask;
1549 
1550 	/* The cached result after evaluating a value independent attr.
1551 	 * Only valid when != -1 and as_vd_acl == NULL */
1552 	int as_result;
1553 
1554 	/* True if started to process frontend ACLs */
1555 	int as_fe_done;
1556 } AccessControlState;
1557 #define ACL_STATE_INIT { NULL, ACL_NONE, NULL, 0, ACL_PRIV_NONE, -1, 0 }
1558 
1559 typedef struct AclRegexMatches {
1560 	int dn_count;
1561         regmatch_t dn_data[MAXREMATCHES];
1562 	int val_count;
1563         regmatch_t val_data[MAXREMATCHES];
1564 } AclRegexMatches;
1565 
1566 /*
1567  * Backend-info
1568  * represents a backend
1569  */
1570 
1571 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head;
1572 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head;
1573 
1574 LDAP_SLAPD_V (int) nBackendInfo;
1575 LDAP_SLAPD_V (int) nBackendDB;
1576 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1577 LDAP_SLAPD_V (slap_be_head) backendDB;
1578 LDAP_SLAPD_V (BackendDB *) frontendDB;
1579 
1580 LDAP_SLAPD_V (int) slapMode;
1581 #define SLAP_UNDEFINED_MODE	0x0000
1582 #define SLAP_SERVER_MODE	0x0001
1583 #define SLAP_TOOL_MODE		0x0002
1584 #define SLAP_MODE			0x0003
1585 
1586 #define SLAP_TRUNCATE_MODE	0x0100
1587 #define	SLAP_TOOL_READMAIN	0x0200
1588 #define	SLAP_TOOL_READONLY	0x0400
1589 #define	SLAP_TOOL_QUICK		0x0800
1590 #define SLAP_TOOL_NO_SCHEMA_CHECK	0x1000
1591 
1592 #define SB_TLS_DEFAULT		(-1)
1593 #define SB_TLS_OFF		0
1594 #define SB_TLS_ON		1
1595 #define SB_TLS_CRITICAL		2
1596 
1597 typedef struct slap_keepalive {
1598 	int sk_idle;
1599 	int sk_probes;
1600 	int sk_interval;
1601 } slap_keepalive;
1602 
1603 typedef struct slap_bindconf {
1604 	struct berval sb_uri;
1605 	int sb_version;
1606 	int sb_tls;
1607 	int sb_method;
1608 	int sb_timeout_api;
1609 	int sb_timeout_net;
1610 	struct berval sb_binddn;
1611 	struct berval sb_cred;
1612 	struct berval sb_saslmech;
1613 	char *sb_secprops;
1614 	struct berval sb_realm;
1615 	struct berval sb_authcId;
1616 	struct berval sb_authzId;
1617 	slap_keepalive sb_keepalive;
1618 #ifdef HAVE_TLS
1619 	void *sb_tls_ctx;
1620 	char *sb_tls_cert;
1621 	char *sb_tls_key;
1622 	char *sb_tls_cacert;
1623 	char *sb_tls_cacertdir;
1624 	char *sb_tls_reqcert;
1625 	char *sb_tls_cipher_suite;
1626 	char *sb_tls_protocol_min;
1627 #ifdef HAVE_OPENSSL_CRL
1628 	char *sb_tls_crlcheck;
1629 #endif
1630 	int sb_tls_do_init;
1631 #endif
1632 } slap_bindconf;
1633 
1634 typedef struct slap_verbmasks {
1635 	struct berval word;
1636 	const slap_mask_t mask;
1637 } slap_verbmasks;
1638 
1639 typedef struct slap_cf_aux_table {
1640 	struct berval key;
1641 	int off;
1642 	char type;
1643 	char quote;
1644 	void *aux;
1645 } slap_cf_aux_table;
1646 
1647 typedef int
1648 slap_cf_aux_table_parse_x LDAP_P((
1649 	struct berval *val,
1650 	void *bc,
1651 	slap_cf_aux_table *tab0,
1652 	const char *tabmsg,
1653 	int unparse ));
1654 
1655 #define SLAP_LIMIT_TIME	1
1656 #define SLAP_LIMIT_SIZE	2
1657 
1658 struct slap_limits_set {
1659 	/* time limits */
1660 	int	lms_t_soft;
1661 	int	lms_t_hard;
1662 
1663 	/* size limits */
1664 	int	lms_s_soft;
1665 	int	lms_s_hard;
1666 	int	lms_s_unchecked;
1667 	int	lms_s_pr;
1668 	int	lms_s_pr_hide;
1669 	int	lms_s_pr_total;
1670 };
1671 
1672 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1673 #define SLAP_NO_LIMIT			-1
1674 #define SLAP_MAX_LIMIT			2147483647
1675 
1676 struct slap_limits {
1677 	unsigned		lm_flags;	/* type of pattern */
1678 	/* Values must match lmpats[] in limits.c */
1679 #define SLAP_LIMITS_UNDEFINED		0x0000U
1680 #define SLAP_LIMITS_EXACT		0x0001U
1681 #define SLAP_LIMITS_BASE		SLAP_LIMITS_EXACT
1682 #define SLAP_LIMITS_ONE			0x0002U
1683 #define SLAP_LIMITS_SUBTREE		0x0003U
1684 #define SLAP_LIMITS_CHILDREN		0x0004U
1685 #define SLAP_LIMITS_REGEX		0x0005U
1686 #define SLAP_LIMITS_ANONYMOUS		0x0006U
1687 #define SLAP_LIMITS_USERS		0x0007U
1688 #define SLAP_LIMITS_ANY			0x0008U
1689 #define SLAP_LIMITS_MASK		0x000FU
1690 
1691 #define SLAP_LIMITS_TYPE_SELF		0x0000U
1692 #define SLAP_LIMITS_TYPE_DN		SLAP_LIMITS_TYPE_SELF
1693 #define SLAP_LIMITS_TYPE_GROUP		0x0010U
1694 #define SLAP_LIMITS_TYPE_THIS		0x0020U
1695 #define SLAP_LIMITS_TYPE_MASK		0x00F0U
1696 
1697 	regex_t			lm_regex;	/* regex data for REGEX */
1698 
1699 	/*
1700 	 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1701 	 * pattern for REGEX; NULL for ANONYMOUS, USERS
1702 	 */
1703 	struct berval		lm_pat;
1704 
1705 	/* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1706 	 * lm_group_oc is objectClass and lm_group_at is attributeType
1707 	 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1708 	 * can only be SLAP_LIMITS_EXACT */
1709 	ObjectClass		*lm_group_oc;
1710 	AttributeDescription	*lm_group_ad;
1711 
1712 	struct slap_limits_set	lm_limits;
1713 };
1714 
1715 /* temporary aliases */
1716 typedef BackendDB Backend;
1717 #define nbackends nBackendDB
1718 #define backends backendDB
1719 
1720 /*
1721  * syncinfo structure for syncrepl
1722  */
1723 
1724 struct syncinfo_s;
1725 
1726 #define SLAP_SYNC_RID_MAX	999
1727 #define SLAP_SYNC_SID_MAX	4095	/* based on liblutil/csn.c field width */
1728 
1729 /* fake conn connid constructed as rid; real connids start
1730  * at SLAPD_SYNC_CONN_OFFSET */
1731 #define SLAPD_SYNC_SYNCCONN_OFFSET (SLAP_SYNC_RID_MAX + 1)
1732 #define SLAPD_SYNC_IS_SYNCCONN(connid) ((connid) < SLAPD_SYNC_SYNCCONN_OFFSET)
1733 #define SLAPD_SYNC_RID2SYNCCONN(rid) (rid)
1734 
1735 #define SLAP_SYNCUUID_SET_SIZE 256
1736 
1737 struct sync_cookie {
1738 	struct berval *ctxcsn;
1739 	struct berval octet_str;
1740 	int rid;
1741 	int sid;
1742 	int numcsns;
1743 	int *sids;
1744 	LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1745 };
1746 
1747 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1748 
1749 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1750 
1751 #ifndef SLAP_MAX_CIDS
1752 #define	SLAP_MAX_CIDS	32	/* Maximum number of supported controls */
1753 #endif
1754 
1755 struct ConfigOCs;	/* config.h */
1756 
1757 struct BackendDB {
1758 	BackendInfo	*bd_info;	/* pointer to shared backend info */
1759 	BackendDB	*bd_self;	/* pointer to this struct */
1760 
1761 	/* fields in this structure (and routines acting on this structure)
1762 	   should be renamed from be_ to bd_ */
1763 
1764 	/* BackendInfo accessors */
1765 #define		be_config	bd_info->bi_db_config
1766 #define		be_type		bd_info->bi_type
1767 
1768 #define		be_bind		bd_info->bi_op_bind
1769 #define		be_unbind	bd_info->bi_op_unbind
1770 #define		be_add		bd_info->bi_op_add
1771 #define		be_compare	bd_info->bi_op_compare
1772 #define		be_delete	bd_info->bi_op_delete
1773 #define		be_modify	bd_info->bi_op_modify
1774 #define		be_modrdn	bd_info->bi_op_modrdn
1775 #define		be_search	bd_info->bi_op_search
1776 #define		be_abandon	bd_info->bi_op_abandon
1777 
1778 #define		be_extended	bd_info->bi_extended
1779 #define		be_cancel	bd_info->bi_op_cancel
1780 
1781 #define		be_chk_referrals	bd_info->bi_chk_referrals
1782 #define		be_chk_controls		bd_info->bi_chk_controls
1783 #define		be_fetch	bd_info->bi_entry_get_rw
1784 #define		be_release	bd_info->bi_entry_release_rw
1785 #define		be_group	bd_info->bi_acl_group
1786 #define		be_attribute	bd_info->bi_acl_attribute
1787 #define		be_operational	bd_info->bi_operational
1788 
1789 /*
1790  * define to honor hasSubordinates operational attribute in search filters
1791  * (in previous use there was a flaw with back-bdb; now it is fixed).
1792  */
1793 #define		be_has_subordinates bd_info->bi_has_subordinates
1794 
1795 #define		be_connection_init	bd_info->bi_connection_init
1796 #define		be_connection_destroy	bd_info->bi_connection_destroy
1797 
1798 #ifdef SLAPD_TOOLS
1799 #define		be_entry_open bd_info->bi_tool_entry_open
1800 #define		be_entry_close bd_info->bi_tool_entry_close
1801 #define		be_entry_first bd_info->bi_tool_entry_first
1802 #define		be_entry_first_x bd_info->bi_tool_entry_first_x
1803 #define		be_entry_next bd_info->bi_tool_entry_next
1804 #define		be_entry_reindex bd_info->bi_tool_entry_reindex
1805 #define		be_entry_get bd_info->bi_tool_entry_get
1806 #define		be_entry_put bd_info->bi_tool_entry_put
1807 #define		be_sync bd_info->bi_tool_sync
1808 #define		be_dn2id_get bd_info->bi_tool_dn2id_get
1809 #define		be_entry_modify	bd_info->bi_tool_entry_modify
1810 #endif
1811 
1812 	/* supported controls */
1813 	/* note: set to 0 if the database does not support the control;
1814 	 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1815 	char		be_ctrls[SLAP_MAX_CIDS + 1];
1816 
1817 /* Database flags */
1818 #define SLAP_DBFLAG_NOLASTMOD		0x0001U
1819 #define SLAP_DBFLAG_NO_SCHEMA_CHECK	0x0002U
1820 #define	SLAP_DBFLAG_HIDDEN		0x0004U
1821 #define	SLAP_DBFLAG_ONE_SUFFIX		0x0008U
1822 #define	SLAP_DBFLAG_GLUE_INSTANCE	0x0010U	/* a glue backend */
1823 #define	SLAP_DBFLAG_GLUE_SUBORDINATE	0x0020U	/* child of a glue hierarchy */
1824 #define	SLAP_DBFLAG_GLUE_LINKED		0x0040U	/* child is connected to parent */
1825 #define SLAP_DBFLAG_GLUE_ADVERTISE	0x0080U /* advertise in rootDSE */
1826 #define SLAP_DBFLAG_OVERLAY		0x0100U	/* this db struct is an overlay */
1827 #define	SLAP_DBFLAG_GLOBAL_OVERLAY	0x0200U	/* this db struct is a global overlay */
1828 #define SLAP_DBFLAG_DYNAMIC		0x0400U /* this db allows dynamicObjects */
1829 #define	SLAP_DBFLAG_MONITORING		0x0800U	/* custom monitoring enabled */
1830 #define SLAP_DBFLAG_SHADOW		0x8000U /* a shadow */
1831 #define SLAP_DBFLAG_SINGLE_SHADOW	0x4000U	/* a single-master shadow */
1832 #define SLAP_DBFLAG_SYNC_SHADOW		0x1000U /* a sync shadow */
1833 #define SLAP_DBFLAG_SLURP_SHADOW	0x2000U /* a slurp shadow */
1834 #define SLAP_DBFLAG_SHADOW_MASK		(SLAP_DBFLAG_SHADOW|SLAP_DBFLAG_SINGLE_SHADOW|SLAP_DBFLAG_SYNC_SHADOW|SLAP_DBFLAG_SLURP_SHADOW)
1835 #define SLAP_DBFLAG_CLEAN		0x10000U /* was cleanly shutdown */
1836 #define SLAP_DBFLAG_ACL_ADD		0x20000U /* check attr ACLs on adds */
1837 #define SLAP_DBFLAG_SYNC_SUBENTRY	0x40000U /* use subentry for context */
1838 	slap_mask_t	be_flags;
1839 #define SLAP_DBFLAGS(be)			((be)->be_flags)
1840 #define SLAP_NOLASTMOD(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1841 #define SLAP_LASTMOD(be)			(!SLAP_NOLASTMOD(be))
1842 #define SLAP_DBHIDDEN(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN)
1843 #define SLAP_DB_ONE_SUFFIX(be)		(SLAP_DBFLAGS(be) & SLAP_DBFLAG_ONE_SUFFIX)
1844 #define SLAP_ISOVERLAY(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1845 #define SLAP_ISGLOBALOVERLAY(be)		(SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1846 #define SLAP_DBMONITORING(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING)
1847 #define SLAP_NO_SCHEMA_CHECK(be)	\
1848 	(SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1849 #define	SLAP_GLUE_INSTANCE(be)		\
1850 	(SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1851 #define	SLAP_GLUE_SUBORDINATE(be)	\
1852 	(SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1853 #define	SLAP_GLUE_LINKED(be)		\
1854 	(SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1855 #define	SLAP_GLUE_ADVERTISE(be)	\
1856 	(SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1857 #define SLAP_SHADOW(be)				(SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1858 #define SLAP_SYNC_SHADOW(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1859 #define SLAP_SLURP_SHADOW(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1860 #define SLAP_SINGLE_SHADOW(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW)
1861 #define SLAP_MULTIMASTER(be)			(!SLAP_SINGLE_SHADOW(be))
1862 #define SLAP_DBCLEAN(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_CLEAN)
1863 #define SLAP_DBACL_ADD(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_ACL_ADD)
1864 #define SLAP_SYNC_SUBENTRY(be)			(SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SUBENTRY)
1865 
1866 	slap_mask_t	be_restrictops;		/* restriction operations */
1867 #define SLAP_RESTRICT_OP_ADD		0x0001U
1868 #define	SLAP_RESTRICT_OP_BIND		0x0002U
1869 #define SLAP_RESTRICT_OP_COMPARE	0x0004U
1870 #define SLAP_RESTRICT_OP_DELETE		0x0008U
1871 #define	SLAP_RESTRICT_OP_EXTENDED	0x0010U
1872 #define SLAP_RESTRICT_OP_MODIFY		0x0020U
1873 #define SLAP_RESTRICT_OP_RENAME		0x0040U
1874 #define SLAP_RESTRICT_OP_SEARCH		0x0080U
1875 #define SLAP_RESTRICT_OP_MASK		0x00FFU
1876 
1877 #define	SLAP_RESTRICT_READONLY		0x80000000U
1878 
1879 #define SLAP_RESTRICT_EXOP_START_TLS		0x0100U
1880 #define	SLAP_RESTRICT_EXOP_MODIFY_PASSWD	0x0200U
1881 #define SLAP_RESTRICT_EXOP_WHOAMI		0x0400U
1882 #define SLAP_RESTRICT_EXOP_CANCEL		0x0800U
1883 #define SLAP_RESTRICT_EXOP_MASK			0xFF00U
1884 
1885 #define SLAP_RESTRICT_OP_READS	\
1886 	( SLAP_RESTRICT_OP_COMPARE	\
1887 	| SLAP_RESTRICT_OP_SEARCH )
1888 #define SLAP_RESTRICT_OP_WRITES	\
1889 	( SLAP_RESTRICT_OP_ADD    \
1890 	| SLAP_RESTRICT_OP_DELETE \
1891 	| SLAP_RESTRICT_OP_MODIFY \
1892 	| SLAP_RESTRICT_OP_RENAME )
1893 #define SLAP_RESTRICT_OP_ALL \
1894 	( SLAP_RESTRICT_OP_READS \
1895 	| SLAP_RESTRICT_OP_WRITES \
1896 	| SLAP_RESTRICT_OP_BIND \
1897 	| SLAP_RESTRICT_OP_EXTENDED )
1898 
1899 #define SLAP_ALLOW_BIND_V2		0x0001U	/* LDAPv2 bind */
1900 #define SLAP_ALLOW_BIND_ANON_CRED	0x0002U /* cred should be empty */
1901 #define SLAP_ALLOW_BIND_ANON_DN		0x0004U /* dn should be empty */
1902 
1903 #define SLAP_ALLOW_UPDATE_ANON		0x0008U /* allow anonymous updates */
1904 #define SLAP_ALLOW_PROXY_AUTHZ_ANON	0x0010U /* allow anonymous proxyAuthz */
1905 
1906 #define SLAP_DISALLOW_BIND_ANON		0x0001U /* no anonymous */
1907 #define SLAP_DISALLOW_BIND_SIMPLE	0x0002U	/* simple authentication */
1908 
1909 #define SLAP_DISALLOW_TLS_2_ANON	0x0010U /* StartTLS -> Anonymous */
1910 #define SLAP_DISALLOW_TLS_AUTHC		0x0020U	/* TLS while authenticated */
1911 
1912 #define SLAP_DISALLOW_PROXY_AUTHZ_N_CRIT	0x0100U
1913 #define SLAP_DISALLOW_DONTUSECOPY_N_CRIT	0x0200U
1914 
1915 #define SLAP_DISALLOW_AUX_WO_CR		0x4000U
1916 
1917 	slap_mask_t	be_requires;	/* pre-operation requirements */
1918 #define SLAP_REQUIRE_BIND		0x0001U	/* bind before op */
1919 #define SLAP_REQUIRE_LDAP_V3	0x0002U	/* LDAPv3 before op */
1920 #define SLAP_REQUIRE_AUTHC		0x0004U	/* authentication before op */
1921 #define SLAP_REQUIRE_SASL		0x0008U	/* SASL before op  */
1922 #define SLAP_REQUIRE_STRONG		0x0010U	/* strong authentication before op */
1923 
1924 	/* Required Security Strength Factor */
1925 	slap_ssf_set_t be_ssf_set;
1926 
1927 	BerVarray	be_suffix;	/* the DN suffixes of data in this backend */
1928 	BerVarray	be_nsuffix;	/* the normalized DN suffixes in this backend */
1929 	struct berval be_schemadn;	/* per-backend subschema subentry DN */
1930 	struct berval be_schemandn;	/* normalized subschema DN */
1931 	struct berval be_rootdn;	/* the magic "root" name (DN) for this db */
1932 	struct berval be_rootndn;	/* the magic "root" normalized name (DN) for this db */
1933 	struct berval be_rootpw;	/* the magic "root" password for this db	*/
1934 	unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1935 #define be_sizelimit	be_def_limit.lms_s_soft
1936 #define be_timelimit	be_def_limit.lms_t_soft
1937 	struct slap_limits_set be_def_limit; /* default limits */
1938 	struct slap_limits **be_limits; /* regex-based size and time limits */
1939 	AccessControl *be_acl;	/* access control list for this backend	   */
1940 	slap_access_t	be_dfltaccess;	/* access given if no acl matches	   */
1941 
1942 	/* Replica Information */
1943 	struct berval be_update_ndn;	/* allowed to make changes (in replicas) */
1944 	BerVarray	be_update_refs;	/* where to refer modifying clients to */
1945 	struct		be_pcl	*be_pending_csn_list;
1946 	ldap_pvt_thread_mutex_t					be_pcl_mutex;
1947 	struct syncinfo_s						*be_syncinfo; /* For syncrepl */
1948 
1949 	void    *be_pb;         /* Netscape plugin */
1950 	struct ConfigOCs *be_cf_ocs;
1951 
1952 	void	*be_private;	/* anything the backend database needs 	   */
1953 	LDAP_STAILQ_ENTRY(BackendDB) be_next;
1954 };
1955 
1956 /* Backend function typedefs */
1957 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1958 typedef BI_bi_func BI_init;
1959 typedef BI_bi_func BI_open;
1960 typedef BI_bi_func BI_close;
1961 typedef BI_bi_func BI_destroy;
1962 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1963 	const char *fname, int lineno,
1964 	int argc, char **argv));
1965 
1966 typedef struct config_reply_s ConfigReply; /* config.h */
1967 typedef int (BI_db_func) LDAP_P((Backend *bd, ConfigReply *cr));
1968 typedef BI_db_func BI_db_init;
1969 typedef BI_db_func BI_db_open;
1970 typedef BI_db_func BI_db_close;
1971 typedef BI_db_func BI_db_destroy;
1972 typedef int (BI_db_config) LDAP_P((Backend *bd,
1973 	const char *fname, int lineno,
1974 	int argc, char **argv));
1975 
1976 typedef struct req_bind_s {
1977 	int rb_method;
1978 	struct berval rb_cred;
1979 	struct berval rb_edn;
1980 	slap_ssf_t rb_ssf;
1981 	struct berval rb_mech;
1982 } req_bind_s;
1983 
1984 typedef struct req_search_s {
1985 	int rs_scope;
1986 	int rs_deref;
1987 	int rs_slimit;
1988 	int rs_tlimit;
1989 	/* NULL means be_isroot evaluated to TRUE */
1990 	struct slap_limits_set *rs_limit;
1991 	int rs_attrsonly;
1992 	AttributeName *rs_attrs;
1993 	Filter *rs_filter;
1994 	struct berval rs_filterstr;
1995 } req_search_s;
1996 
1997 typedef struct req_compare_s {
1998 	AttributeAssertion *rs_ava;
1999 } req_compare_s;
2000 
2001 typedef struct req_modifications_s {
2002 	Modifications *rs_modlist;
2003 	char rs_no_opattrs;		/* don't att modify operational attrs */
2004 } req_modifications_s;
2005 
2006 typedef struct req_modify_s {
2007 	req_modifications_s rs_mods;	/* NOTE: must be first in req_modify_s & req_modrdn_s */
2008 	int rs_increment;
2009 } req_modify_s;
2010 
2011 typedef struct req_modrdn_s {
2012 	req_modifications_s rs_mods;	/* NOTE: must be first in req_modify_s & req_modrdn_s */
2013 	int rs_deleteoldrdn;
2014 	struct berval rs_newrdn;
2015 	struct berval rs_nnewrdn;
2016 	struct berval *rs_newSup;
2017 	struct berval *rs_nnewSup;
2018 } req_modrdn_s;
2019 
2020 typedef struct req_add_s {
2021 	Modifications *rs_modlist;
2022 	Entry *rs_e;
2023 } req_add_s;
2024 
2025 typedef struct req_abandon_s {
2026 	ber_int_t rs_msgid;
2027 } req_abandon_s;
2028 
2029 #ifdef SLAP_SCHEMA_EXPOSE
2030 #define SLAP_EXOP_HIDE 0x0000
2031 #else
2032 #define SLAP_EXOP_HIDE 0x8000
2033 #endif
2034 #define SLAP_EXOP_WRITES 0x0001		/* Exop does writes */
2035 
2036 typedef struct req_extended_s {
2037 	struct berval rs_reqoid;
2038 	int rs_flags;
2039 	struct berval *rs_reqdata;
2040 } req_extended_s;
2041 
2042 typedef struct req_pwdexop_s {
2043 	struct req_extended_s rs_extended;
2044 	struct berval rs_old;
2045 	struct berval rs_new;
2046 	Modifications *rs_mods;
2047 	Modifications **rs_modtail;
2048 } req_pwdexop_s;
2049 
2050 typedef enum slap_reply_e {
2051 	REP_RESULT,
2052 	REP_SASL,
2053 	REP_EXTENDED,
2054 	REP_SEARCH,
2055 	REP_SEARCHREF,
2056 	REP_INTERMEDIATE,
2057 	REP_GLUE_RESULT
2058 } slap_reply_t;
2059 
2060 typedef struct rep_sasl_s {
2061 	struct berval *r_sasldata;
2062 } rep_sasl_s;
2063 
2064 typedef struct rep_extended_s {
2065 	const char *r_rspoid;
2066 	struct berval *r_rspdata;
2067 } rep_extended_s;
2068 
2069 typedef struct rep_search_s {
2070 	Entry *r_entry;
2071 	slap_mask_t r_attr_flags;
2072 #define SLAP_ATTRS_UNDEFINED	(0x00U)
2073 #define SLAP_OPATTRS_NO			(0x01U)
2074 #define SLAP_OPATTRS_YES		(0x02U)
2075 #define SLAP_USERATTRS_NO		(0x10U)
2076 #define SLAP_USERATTRS_YES		(0x20U)
2077 #define SLAP_OPATTRS_MASK(f)	((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
2078 #define SLAP_OPATTRS(f)			(((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
2079 #define SLAP_USERATTRS_MASK(f)	((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
2080 #define SLAP_USERATTRS(f)		\
2081 	(((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
2082 
2083 	Attribute *r_operational_attrs;
2084 	AttributeName *r_attrs;
2085 	int r_nentries;
2086 	BerVarray r_v2ref;
2087 } rep_search_s;
2088 
2089 struct SlapReply {
2090 	slap_reply_t sr_type;
2091 	ber_tag_t sr_tag;
2092 	ber_int_t sr_msgid;
2093 	ber_int_t sr_err;
2094 	const char *sr_matched;
2095 	const char *sr_text;
2096 	BerVarray sr_ref;
2097 	LDAPControl **sr_ctrls;
2098 	union sr_u {
2099 		rep_search_s sru_search;
2100 		rep_sasl_s sru_sasl;
2101 		rep_extended_s sru_extended;
2102 	} sr_un;
2103 	slap_mask_t sr_flags;
2104 #define REP_ENTRY_MODIFIABLE	0x0001U
2105 #define REP_ENTRY_MUSTBEFREED	0x0002U
2106 #define REP_ENTRY_MUSTRELEASE	0x0004U
2107 #define	REP_ENTRY_MASK		(REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2108 #define	REP_ENTRY_MUSTFLUSH	(REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2109 
2110 #define REP_MATCHED_MUSTBEFREED	0x0010U
2111 #define	REP_MATCHED_MASK	(REP_MATCHED_MUSTBEFREED)
2112 
2113 #define REP_REF_MUSTBEFREED	0x0020U
2114 #define REP_REF_MASK		(REP_REF_MUSTBEFREED)
2115 
2116 #define REP_CTRLS_MUSTBEFREED	0x0040U
2117 #define REP_CTRLS_MASK		(REP_CTRLS_MUSTBEFREED)
2118 
2119 #define	REP_NO_ENTRYDN		0x1000U
2120 #define	REP_NO_SUBSCHEMA	0x2000U
2121 #define	REP_NO_OPERATIONALS	(REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2122 };
2123 
2124 /* short hands for response members */
2125 #define	sr_attrs sr_un.sru_search.r_attrs
2126 #define	sr_entry sr_un.sru_search.r_entry
2127 #define	sr_operational_attrs sr_un.sru_search.r_operational_attrs
2128 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2129 #define	sr_v2ref sr_un.sru_search.r_v2ref
2130 #define	sr_nentries sr_un.sru_search.r_nentries
2131 #define	sr_rspoid sr_un.sru_extended.r_rspoid
2132 #define	sr_rspdata sr_un.sru_extended.r_rspdata
2133 #define	sr_sasldata sr_un.sru_sasl.r_sasldata
2134 
2135 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs ));
2136 typedef BI_op_func BI_op_bind;
2137 typedef BI_op_func BI_op_unbind;
2138 typedef BI_op_func BI_op_search;
2139 typedef BI_op_func BI_op_compare;
2140 typedef BI_op_func BI_op_modify;
2141 typedef BI_op_func BI_op_modrdn;
2142 typedef BI_op_func BI_op_add;
2143 typedef BI_op_func BI_op_delete;
2144 typedef BI_op_func BI_op_abandon;
2145 typedef BI_op_func BI_op_extended;
2146 typedef BI_op_func BI_op_cancel;
2147 typedef BI_op_func BI_chk_referrals;
2148 typedef BI_op_func BI_chk_controls;
2149 typedef int (BI_entry_release_rw)
2150 	LDAP_P(( Operation *op, Entry *e, int rw ));
2151 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn,
2152 	ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2153 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs ));
2154 typedef int (BI_has_subordinates) LDAP_P(( Operation *op,
2155 	Entry *e, int *hasSubs ));
2156 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e,
2157 	AttributeDescription *desc, struct berval *val, slap_access_t access,
2158 	AccessControlState *state, slap_mask_t *maskp ));
2159 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target,
2160 	struct berval *gr_ndn, struct berval *op_ndn,
2161 	ObjectClass *group_oc, AttributeDescription *group_at ));
2162 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target,
2163 	struct berval *entry_ndn, AttributeDescription *entry_at,
2164 	BerVarray *vals, slap_access_t access ));
2165 
2166 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c ));
2167 typedef BI_conn_func BI_connection_init;
2168 typedef BI_conn_func BI_connection_destroy;
2169 
2170 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2171 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2172 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2173 typedef ID (BI_tool_entry_first_x) LDAP_P(( BackendDB *be, struct berval *base, int scope, Filter *f ));
2174 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2175 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2176 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2177 	struct berval *text ));
2178 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv ));
2179 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2180 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2181 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2182 	struct berval *text ));
2183 
2184 struct BackendInfo {
2185 	char	*bi_type; /* type of backend */
2186 
2187 	/*
2188 	 * per backend type routines:
2189 	 * bi_init: called to allocate a backend_info structure,
2190 	 *		called once BEFORE configuration file is read.
2191 	 *		bi_init() initializes this structure hence is
2192 	 *		called directly from be_initialize()
2193 	 * bi_config: called per 'backend' specific option
2194 	 *		all such options must before any 'database' options
2195 	 *		bi_config() is called only from read_config()
2196 	 * bi_open: called to open each database, called
2197 	 *		once AFTER configuration file is read but
2198 	 *		BEFORE any bi_db_open() calls.
2199 	 *		bi_open() is called from backend_startup()
2200 	 * bi_close: called to close each database, called
2201 	 *		once during shutdown after all bi_db_close calls.
2202 	 *		bi_close() is called from backend_shutdown()
2203 	 * bi_destroy: called to destroy each database, called
2204 	 *		once during shutdown after all bi_db_destroy calls.
2205 	 *		bi_destory() is called from backend_destroy()
2206 	 */
2207 	BI_init	*bi_init;
2208 	BI_config	*bi_config;
2209 	BI_open *bi_open;
2210 	BI_close	*bi_close;
2211 	BI_destroy	*bi_destroy;
2212 
2213 	/*
2214 	 * per database routines:
2215 	 * bi_db_init: called to initialize each database,
2216 	 *	called upon reading 'database <type>'
2217 	 *	called only from backend_db_init()
2218 	 * bi_db_config: called to configure each database,
2219 	 *  called per database to handle per database options
2220 	 *	called only from read_config()
2221 	 * bi_db_open: called to open each database
2222 	 *	called once per database immediately AFTER bi_open()
2223 	 *	calls but before daemon startup.
2224 	 *  called only by backend_startup()
2225 	 * bi_db_close: called to close each database
2226 	 *	called once per database during shutdown but BEFORE
2227 	 *  any bi_close call.
2228 	 *  called only by backend_shutdown()
2229 	 * bi_db_destroy: called to destroy each database
2230 	 *  called once per database during shutdown AFTER all
2231 	 *  bi_close calls but before bi_destory calls.
2232 	 *  called only by backend_destory()
2233 	 */
2234 	BI_db_init	*bi_db_init;
2235 	BI_db_config	*bi_db_config;
2236 	BI_db_open	*bi_db_open;
2237 	BI_db_close	*bi_db_close;
2238 	BI_db_destroy	*bi_db_destroy;
2239 
2240 	/* LDAP Operations Handling Routines */
2241 	BI_op_bind	*bi_op_bind;
2242 	BI_op_unbind	*bi_op_unbind;
2243 	BI_op_search	*bi_op_search;
2244 	BI_op_compare	*bi_op_compare;
2245 	BI_op_modify	*bi_op_modify;
2246 	BI_op_modrdn	*bi_op_modrdn;
2247 	BI_op_add	*bi_op_add;
2248 	BI_op_delete	*bi_op_delete;
2249 	BI_op_abandon	*bi_op_abandon;
2250 
2251 	/* Extended Operations Helper */
2252 	BI_op_extended	*bi_extended;
2253 	BI_op_cancel	*bi_op_cancel;
2254 
2255 	/* Auxilary Functions */
2256 	BI_operational		*bi_operational;
2257 	BI_chk_referrals	*bi_chk_referrals;
2258 	BI_chk_controls		*bi_chk_controls;
2259 	BI_entry_get_rw		*bi_entry_get_rw;
2260 	BI_entry_release_rw	*bi_entry_release_rw;
2261 
2262 	BI_has_subordinates	*bi_has_subordinates;
2263 	BI_access_allowed	*bi_access_allowed;
2264 	BI_acl_group		*bi_acl_group;
2265 	BI_acl_attribute	*bi_acl_attribute;
2266 
2267 	BI_connection_init	*bi_connection_init;
2268 	BI_connection_destroy	*bi_connection_destroy;
2269 
2270 	/* hooks for slap tools */
2271 	BI_tool_entry_open	*bi_tool_entry_open;
2272 	BI_tool_entry_close	*bi_tool_entry_close;
2273 	BI_tool_entry_first	*bi_tool_entry_first;	/* deprecated */
2274 	BI_tool_entry_first_x	*bi_tool_entry_first_x;
2275 	BI_tool_entry_next	*bi_tool_entry_next;
2276 	BI_tool_entry_get	*bi_tool_entry_get;
2277 	BI_tool_entry_put	*bi_tool_entry_put;
2278 	BI_tool_entry_reindex	*bi_tool_entry_reindex;
2279 	BI_tool_sync		*bi_tool_sync;
2280 	BI_tool_dn2id_get	*bi_tool_dn2id_get;
2281 	BI_tool_entry_modify	*bi_tool_entry_modify;
2282 
2283 #define SLAP_INDEX_ADD_OP		0x0001
2284 #define SLAP_INDEX_DELETE_OP	0x0002
2285 
2286 	slap_mask_t	bi_flags; /* backend flags */
2287 #define SLAP_BFLAG_MONITOR			0x0001U /* a monitor backend */
2288 #define SLAP_BFLAG_CONFIG			0x0002U /* a config backend */
2289 #define SLAP_BFLAG_FRONTEND			0x0004U /* the frontendDB */
2290 #define SLAP_BFLAG_NOLASTMODCMD		0x0010U
2291 #define SLAP_BFLAG_INCREMENT		0x0100U
2292 #define SLAP_BFLAG_ALIASES			0x1000U
2293 #define SLAP_BFLAG_REFERRALS		0x2000U
2294 #define SLAP_BFLAG_SUBENTRIES		0x4000U
2295 #define SLAP_BFLAG_DYNAMIC			0x8000U
2296 
2297 /* overlay specific */
2298 #define	SLAPO_BFLAG_SINGLE		0x01000000U
2299 #define	SLAPO_BFLAG_DBONLY		0x02000000U
2300 #define	SLAPO_BFLAG_GLOBONLY		0x04000000U
2301 #define	SLAPO_BFLAG_MASK		0xFF000000U
2302 
2303 #define SLAP_BFLAGS(be)		((be)->bd_info->bi_flags)
2304 #define SLAP_MONITOR(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2305 #define SLAP_CONFIG(be)		(SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2306 #define SLAP_FRONTEND(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2307 #define SLAP_INCREMENT(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2308 #define SLAP_ALIASES(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2309 #define SLAP_REFERRALS(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2310 #define SLAP_SUBENTRIES(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2311 #define SLAP_DYNAMIC(be)	((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC))
2312 #define SLAP_NOLASTMODCMD(be)	(SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2313 #define SLAP_LASTMODCMD(be)	(!SLAP_NOLASTMODCMD(be))
2314 
2315 /* overlay specific */
2316 #define SLAPO_SINGLE(be)	(SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE)
2317 #define SLAPO_DBONLY(be)	(SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY)
2318 #define SLAPO_GLOBONLY(be)	(SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY)
2319 
2320 	char	**bi_controls;		/* supported controls */
2321 	char	bi_ctrls[SLAP_MAX_CIDS + 1];
2322 
2323 	unsigned int bi_nDB;	/* number of databases of this type */
2324 	struct ConfigOCs *bi_cf_ocs;
2325 	char	**bi_obsolete_names;
2326 	void	*bi_extra;		/* backend type-specific APIs */
2327 	void	*bi_private;	/* backend type-specific config data */
2328 	LDAP_STAILQ_ENTRY(BackendInfo) bi_next ;
2329 };
2330 
2331 #define c_authtype	c_authz.sai_method
2332 #define c_authmech	c_authz.sai_mech
2333 #define c_dn		c_authz.sai_dn
2334 #define c_ndn		c_authz.sai_ndn
2335 #define c_ssf		c_authz.sai_ssf
2336 #define c_transport_ssf	c_authz.sai_transport_ssf
2337 #define c_tls_ssf	c_authz.sai_tls_ssf
2338 #define c_sasl_ssf	c_authz.sai_sasl_ssf
2339 
2340 #define o_authtype	o_authz.sai_method
2341 #define o_authmech	o_authz.sai_mech
2342 #define o_dn		o_authz.sai_dn
2343 #define o_ndn		o_authz.sai_ndn
2344 #define o_ssf		o_authz.sai_ssf
2345 #define o_transport_ssf	o_authz.sai_transport_ssf
2346 #define o_tls_ssf	o_authz.sai_tls_ssf
2347 #define o_sasl_ssf	o_authz.sai_sasl_ssf
2348 
2349 typedef int (slap_response)( Operation *, SlapReply * );
2350 
2351 typedef struct slap_callback {
2352 	struct slap_callback *sc_next;
2353 	slap_response *sc_response;
2354 	slap_response *sc_cleanup;
2355 	void *sc_private;
2356 } slap_callback;
2357 
2358 struct slap_overinfo;
2359 
2360 typedef enum slap_operation_e {
2361 	op_bind = 0,
2362 	op_unbind,
2363 	op_search,
2364 	op_compare,
2365 	op_modify,
2366 	op_modrdn,
2367 	op_add,
2368 	op_delete,
2369 	op_abandon,
2370 	op_extended,
2371 	op_cancel,
2372 	op_aux_operational,
2373 	op_aux_chk_referrals,
2374 	op_aux_chk_controls,
2375 	op_last
2376 } slap_operation_t;
2377 
2378 typedef struct slap_overinst {
2379 	BackendInfo on_bi;
2380 	slap_response *on_response;
2381 	struct slap_overinfo *on_info;
2382 	struct slap_overinst *on_next;
2383 } slap_overinst;
2384 
2385 typedef struct slap_overinfo {
2386 	BackendInfo oi_bi;
2387 	BackendInfo *oi_orig;
2388 	BackendDB	*oi_origdb;
2389 	struct slap_overinst *oi_list;
2390 } slap_overinfo;
2391 
2392 /* Should successive callbacks in a chain be processed? */
2393 #define	SLAP_CB_BYPASS		0x08800
2394 #define	SLAP_CB_CONTINUE	0x08000
2395 
2396 /*
2397  * Paged Results state
2398  */
2399 typedef unsigned long PagedResultsCookie;
2400 typedef struct PagedResultsState {
2401 	Backend *ps_be;
2402 	ber_int_t ps_size;
2403 	int ps_count;
2404 	PagedResultsCookie ps_cookie;
2405 	struct berval ps_cookieval;
2406 } PagedResultsState;
2407 
2408 struct slap_csn_entry {
2409 	struct berval ce_csn;
2410 	int ce_sid;
2411 	unsigned long ce_opid;
2412 	unsigned long ce_connid;
2413 #define SLAP_CSN_PENDING	1
2414 #define SLAP_CSN_COMMIT		2
2415 	long ce_state;
2416 	LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2417 };
2418 
2419 /*
2420  * Caches the result of a backend_group check for ACL evaluation
2421  */
2422 typedef struct GroupAssertion {
2423 	struct GroupAssertion *ga_next;
2424 	Backend *ga_be;
2425 	ObjectClass *ga_oc;
2426 	AttributeDescription *ga_at;
2427 	int ga_res;
2428 	ber_len_t ga_len;
2429 	char ga_ndn[1];
2430 } GroupAssertion;
2431 
2432 struct slap_control_ids {
2433 	int sc_LDAPsync;
2434 	int sc_assert;
2435 	int sc_domainScope;
2436 	int sc_dontUseCopy;
2437 	int sc_manageDSAit;
2438 	int sc_modifyIncrement;
2439 	int sc_noOp;
2440 	int sc_pagedResults;
2441 	int sc_permissiveModify;
2442 	int sc_postRead;
2443 	int sc_preRead;
2444 	int sc_proxyAuthz;
2445 	int sc_relax;
2446 	int sc_searchOptions;
2447 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2448 	int sc_sortedResults;
2449 #endif
2450 	int sc_subentries;
2451 #ifdef SLAP_CONTROL_X_TREE_DELETE
2452 	int sc_treeDelete;
2453 #endif
2454 #ifdef LDAP_X_TXN
2455 	int sc_txnSpec;
2456 #endif
2457 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2458 	int sc_sessionTracking;
2459 #endif
2460 	int sc_valuesReturnFilter;
2461 #ifdef SLAP_CONTROL_X_WHATFAILED
2462 	int sc_whatFailed;
2463 #endif
2464 };
2465 
2466 /*
2467  * Operation indices
2468  */
2469 typedef enum {
2470 	SLAP_OP_BIND = 0,
2471 	SLAP_OP_UNBIND,
2472 	SLAP_OP_SEARCH,
2473 	SLAP_OP_COMPARE,
2474 	SLAP_OP_MODIFY,
2475 	SLAP_OP_MODRDN,
2476 	SLAP_OP_ADD,
2477 	SLAP_OP_DELETE,
2478 	SLAP_OP_ABANDON,
2479 	SLAP_OP_EXTENDED,
2480 	SLAP_OP_LAST
2481 } slap_op_t;
2482 
2483 typedef struct slap_counters_t {
2484 	struct slap_counters_t	*sc_next;
2485 	ldap_pvt_thread_mutex_t	sc_mutex;
2486 	ldap_pvt_mp_t		sc_bytes;
2487 	ldap_pvt_mp_t		sc_pdu;
2488 	ldap_pvt_mp_t		sc_entries;
2489 	ldap_pvt_mp_t		sc_refs;
2490 
2491 	ldap_pvt_mp_t		sc_ops_completed;
2492 	ldap_pvt_mp_t		sc_ops_initiated;
2493 #ifdef SLAPD_MONITOR
2494 	ldap_pvt_mp_t		sc_ops_completed_[SLAP_OP_LAST];
2495 	ldap_pvt_mp_t		sc_ops_initiated_[SLAP_OP_LAST];
2496 #endif /* SLAPD_MONITOR */
2497 } slap_counters_t;
2498 
2499 /*
2500  * represents an operation pending from an ldap client
2501  */
2502 typedef struct Opheader {
2503 	unsigned long	oh_opid;	/* id of this operation */
2504 	unsigned long	oh_connid;	/* id of conn initiating this op */
2505 	Connection	*oh_conn;	/* connection spawning this op */
2506 
2507 	ber_int_t	oh_msgid;	/* msgid of the request */
2508 	ber_int_t	oh_protocol;	/* version of the LDAP protocol used by client */
2509 
2510 	ldap_pvt_thread_t	oh_tid;	/* thread handling this op */
2511 
2512 	void	*oh_threadctx;		/* thread pool thread context */
2513 	void	*oh_tmpmemctx;		/* slab malloc context */
2514 	BerMemoryFunctions *oh_tmpmfuncs;
2515 
2516 	slap_counters_t	*oh_counters;
2517 
2518 	char		oh_log_prefix[ /* sizeof("conn= op=") + 2*LDAP_PVT_INTTYPE_CHARS(unsigned long) */ SLAP_TEXT_BUFLEN ];
2519 
2520 #ifdef LDAP_SLAPI
2521 	void	*oh_extensions;		/* NS-SLAPI plugin */
2522 #endif
2523 } Opheader;
2524 
2525 typedef union OpRequest {
2526 	req_add_s oq_add;
2527 	req_bind_s oq_bind;
2528 	req_compare_s oq_compare;
2529 	req_modify_s oq_modify;
2530 	req_modrdn_s oq_modrdn;
2531 	req_search_s oq_search;
2532 	req_abandon_s oq_abandon;
2533 	req_abandon_s oq_cancel;
2534 	req_extended_s oq_extended;
2535 	req_pwdexop_s oq_pwdexop;
2536 } OpRequest;
2537 
2538 /* This is only a header. Actual users should define their own
2539  * structs with the oe_next / oe_key fields at the top and
2540  * whatever else they need following.
2541  */
2542 typedef struct OpExtra {
2543 	LDAP_SLIST_ENTRY(OpExtra) oe_next;
2544 	void *oe_key;
2545 } OpExtra;
2546 
2547 typedef struct OpExtraDB {
2548 	OpExtra oe;
2549 	BackendDB *oe_db;
2550 } OpExtraDB;
2551 
2552 struct Operation {
2553 	Opheader *o_hdr;
2554 
2555 #define o_opid o_hdr->oh_opid
2556 #define o_connid o_hdr->oh_connid
2557 #define o_conn o_hdr->oh_conn
2558 #define o_msgid o_hdr->oh_msgid
2559 #define o_protocol o_hdr->oh_protocol
2560 #define o_tid o_hdr->oh_tid
2561 #define o_threadctx o_hdr->oh_threadctx
2562 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2563 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2564 #define o_counters o_hdr->oh_counters
2565 
2566 #define	o_tmpalloc	o_tmpmfuncs->bmf_malloc
2567 #define o_tmpcalloc	o_tmpmfuncs->bmf_calloc
2568 #define	o_tmprealloc	o_tmpmfuncs->bmf_realloc
2569 #define	o_tmpfree	o_tmpmfuncs->bmf_free
2570 
2571 #define o_log_prefix o_hdr->oh_log_prefix
2572 
2573 	ber_tag_t	o_tag;		/* tag of the request */
2574 	time_t		o_time;		/* time op was initiated */
2575 	int			o_tincr;	/* counter for multiple ops with same o_time */
2576 
2577 	BackendDB	*o_bd;	/* backend DB processing this op */
2578 	struct berval	o_req_dn;	/* DN of target of request */
2579 	struct berval	o_req_ndn;
2580 
2581 	OpRequest o_request;
2582 
2583 /* short hands for union members */
2584 #define oq_add o_request.oq_add
2585 #define oq_bind o_request.oq_bind
2586 #define oq_compare o_request.oq_compare
2587 #define oq_modify o_request.oq_modify
2588 #define oq_modrdn o_request.oq_modrdn
2589 #define oq_search o_request.oq_search
2590 #define oq_abandon o_request.oq_abandon
2591 #define oq_cancel o_request.oq_cancel
2592 #define oq_extended o_request.oq_extended
2593 #define oq_pwdexop o_request.oq_pwdexop
2594 
2595 /* short hands for inner request members */
2596 #define orb_method oq_bind.rb_method
2597 #define orb_cred oq_bind.rb_cred
2598 #define orb_edn oq_bind.rb_edn
2599 #define orb_ssf oq_bind.rb_ssf
2600 #define orb_mech oq_bind.rb_mech
2601 
2602 #define ors_scope oq_search.rs_scope
2603 #define ors_deref oq_search.rs_deref
2604 #define ors_slimit oq_search.rs_slimit
2605 #define ors_tlimit oq_search.rs_tlimit
2606 #define ors_limit oq_search.rs_limit
2607 #define ors_attrsonly oq_search.rs_attrsonly
2608 #define ors_attrs oq_search.rs_attrs
2609 #define ors_filter oq_search.rs_filter
2610 #define ors_filterstr oq_search.rs_filterstr
2611 
2612 #define orr_modlist oq_modrdn.rs_mods.rs_modlist
2613 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs
2614 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2615 #define orr_newrdn oq_modrdn.rs_newrdn
2616 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2617 #define orr_newSup oq_modrdn.rs_newSup
2618 #define orr_nnewSup oq_modrdn.rs_nnewSup
2619 
2620 #define orc_ava oq_compare.rs_ava
2621 
2622 #define ora_e oq_add.rs_e
2623 #define ora_modlist oq_add.rs_modlist
2624 
2625 #define orn_msgid oq_abandon.rs_msgid
2626 
2627 #define orm_modlist oq_modify.rs_mods.rs_modlist
2628 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs
2629 #define orm_increment oq_modify.rs_increment
2630 
2631 #define ore_reqoid oq_extended.rs_reqoid
2632 #define ore_flags oq_extended.rs_flags
2633 #define ore_reqdata oq_extended.rs_reqdata
2634 	volatile sig_atomic_t o_abandon;	/* abandon flag */
2635 	volatile sig_atomic_t o_cancel;		/* cancel flag */
2636 #define SLAP_CANCEL_NONE				0x00
2637 #define SLAP_CANCEL_REQ					0x01
2638 #define SLAP_CANCEL_ACK					0x02
2639 #define SLAP_CANCEL_DONE				0x03
2640 
2641 	GroupAssertion *o_groups;
2642 	char o_do_not_cache;	/* don't cache groups from this op */
2643 	char o_is_auth_check;	/* authorization in progress */
2644 	char o_dont_replicate;
2645 	slap_access_t o_acl_priv;
2646 
2647 	char o_nocaching;
2648 	char o_delete_glue_parent;
2649 	char o_no_schema_check;
2650 #define get_no_schema_check(op)			((op)->o_no_schema_check)
2651 	char o_no_subordinate_glue;
2652 #define get_no_subordinate_glue(op)		((op)->o_no_subordinate_glue)
2653 
2654 #define SLAP_CONTROL_NONE	0
2655 #define SLAP_CONTROL_IGNORED	1
2656 #define SLAP_CONTROL_NONCRITICAL 2
2657 #define SLAP_CONTROL_CRITICAL	3
2658 #define	SLAP_CONTROL_MASK	3
2659 
2660 /* spare bits for simple flags */
2661 #define SLAP_CONTROL_SHIFT	4	/* shift to reach data bits */
2662 #define SLAP_CONTROL_DATA0	0x10
2663 #define SLAP_CONTROL_DATA1	0x20
2664 #define SLAP_CONTROL_DATA2	0x40
2665 #define SLAP_CONTROL_DATA3	0x80
2666 
2667 #define _SCM(x)	((x) & SLAP_CONTROL_MASK)
2668 
2669 	char o_ctrlflag[SLAP_MAX_CIDS];	/* per-control flags */
2670 	void **o_controls;		/* per-control state */
2671 
2672 #define o_dontUseCopy			o_ctrlflag[slap_cids.sc_dontUseCopy]
2673 #define get_dontUseCopy(op)		_SCM((op)->o_dontUseCopy)
2674 
2675 #define o_relax				o_ctrlflag[slap_cids.sc_relax]
2676 #define get_relax(op)		_SCM((op)->o_relax)
2677 
2678 #define o_managedsait	o_ctrlflag[slap_cids.sc_manageDSAit]
2679 #define get_manageDSAit(op)				_SCM((op)->o_managedsait)
2680 
2681 #define o_noop	o_ctrlflag[slap_cids.sc_noOp]
2682 #define o_proxy_authz	o_ctrlflag[slap_cids.sc_proxyAuthz]
2683 #define o_subentries	o_ctrlflag[slap_cids.sc_subentries]
2684 
2685 #define get_subentries(op)				_SCM((op)->o_subentries)
2686 #define	o_subentries_visibility	o_ctrlflag[slap_cids.sc_subentries]
2687 
2688 #define set_subentries_visibility(op)	((op)->o_subentries |= SLAP_CONTROL_DATA0)
2689 #define get_subentries_visibility(op)	(((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2690 
2691 #define o_assert	o_ctrlflag[slap_cids.sc_assert]
2692 #define get_assert(op)					((int)(op)->o_assert)
2693 #define o_assertion	o_controls[slap_cids.sc_assert]
2694 #define get_assertion(op)				((op)->o_assertion)
2695 
2696 #define	o_valuesreturnfilter	o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2697 #define o_vrFilter	o_controls[slap_cids.sc_valuesReturnFilter]
2698 
2699 #define o_permissive_modify	o_ctrlflag[slap_cids.sc_permissiveModify]
2700 #define get_permissiveModify(op)		((int)(op)->o_permissive_modify)
2701 
2702 #define o_domain_scope	o_ctrlflag[slap_cids.sc_domainScope]
2703 #define get_domainScope(op)				((int)(op)->o_domain_scope)
2704 
2705 #ifdef SLAP_CONTROL_X_TREE_DELETE
2706 #define	o_tree_delete	o_ctrlflag[slap_cids.sc_treeDelete]
2707 #define get_treeDelete(op)				((int)(op)->o_tree_delete)
2708 #endif
2709 
2710 #define o_preread	o_ctrlflag[slap_cids.sc_preRead]
2711 #define o_postread	o_ctrlflag[slap_cids.sc_postRead]
2712 
2713 #define	o_preread_attrs	o_controls[slap_cids.sc_preRead]
2714 #define o_postread_attrs	o_controls[slap_cids.sc_postRead]
2715 
2716 #define o_pagedresults	o_ctrlflag[slap_cids.sc_pagedResults]
2717 #define o_pagedresults_state	o_controls[slap_cids.sc_pagedResults]
2718 #define get_pagedresults(op)			((int)(op)->o_pagedresults)
2719 
2720 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2721 #define o_sortedresults		o_ctrlflag[slap_cids.sc_sortedResults]
2722 #endif
2723 
2724 #ifdef LDAP_X_TXN
2725 #define o_txnSpec		o_ctrlflag[slap_cids.sc_txnSpec]
2726 #endif
2727 
2728 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2729 #define o_session_tracking	o_ctrlflag[slap_cids.sc_sessionTracking]
2730 #define o_tracked_sessions	o_controls[slap_cids.sc_sessionTracking]
2731 #define get_sessionTracking(op)			((int)(op)->o_session_tracking)
2732 #endif
2733 
2734 #ifdef SLAP_CONTROL_X_WHATFAILED
2735 #define o_whatFailed o_ctrlflag[slap_cids.sc_whatFailed]
2736 #define get_whatFailed(op)				_SCM((op)->o_whatFailed)
2737 #endif
2738 
2739 #define o_sync			o_ctrlflag[slap_cids.sc_LDAPsync]
2740 
2741 	AuthorizationInformation o_authz;
2742 
2743 	BerElement	*o_ber;		/* ber of the request */
2744 	BerElement	*o_res_ber;	/* ber of the CLDAP reply or readback control */
2745 	slap_callback *o_callback;	/* callback pointers */
2746 	LDAPControl	**o_ctrls;	 /* controls */
2747 	struct berval o_csn;
2748 
2749 	/* DEPRECATE o_private - use o_extra instead */
2750 	void	*o_private;	/* anything the backend needs */
2751 	LDAP_SLIST_HEAD(o_e, OpExtra) o_extra;	/* anything the backend needs */
2752 
2753 	LDAP_STAILQ_ENTRY(Operation)	o_next;	/* next operation in list */
2754 };
2755 
2756 typedef struct OperationBuffer {
2757 	Operation	ob_op;
2758 	Opheader	ob_hdr;
2759 	void		*ob_controls[SLAP_MAX_CIDS];
2760 } OperationBuffer;
2761 
2762 #define send_ldap_error( op, rs, err, text ) do { \
2763 		(rs)->sr_err = err; (rs)->sr_text = text; \
2764 		((op)->o_conn->c_send_ldap_result)( op, rs ); \
2765 	} while (0)
2766 #define send_ldap_discon( op, rs, err, text ) do { \
2767 		(rs)->sr_err = err; (rs)->sr_text = text; \
2768 		send_ldap_disconnect( op, rs ); \
2769 	} while (0)
2770 
2771 typedef void (SEND_LDAP_RESULT)(
2772 	Operation *op, SlapReply *rs);
2773 typedef int (SEND_SEARCH_ENTRY)(
2774 	Operation *op, SlapReply *rs);
2775 typedef int (SEND_SEARCH_REFERENCE)(
2776 	Operation *op, SlapReply *rs);
2777 typedef void (SEND_LDAP_EXTENDED)(
2778 	Operation *op, SlapReply *rs);
2779 typedef void (SEND_LDAP_INTERMEDIATE)(
2780 	Operation *op, SlapReply *rs);
2781 
2782 #define send_ldap_result( op, rs ) \
2783 	((op)->o_conn->c_send_ldap_result)( op, rs )
2784 #define send_search_entry( op, rs ) \
2785 	((op)->o_conn->c_send_search_entry)( op, rs )
2786 #define send_search_reference( op, rs ) \
2787 	((op)->o_conn->c_send_search_reference)( op, rs )
2788 #define send_ldap_extended( op, rs ) \
2789 	((op)->o_conn->c_send_ldap_extended)( op, rs )
2790 #define send_ldap_intermediate( op, rs ) \
2791 	((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2792 
2793 typedef struct Listener Listener;
2794 
2795 /*
2796  * represents a connection from an ldap client
2797  */
2798 /* structure state (protected by connections_mutex) */
2799 enum sc_struct_state {
2800 	SLAP_C_UNINITIALIZED = 0,	/* MUST BE ZERO (0) */
2801 	SLAP_C_UNUSED,
2802 	SLAP_C_USED,
2803 	SLAP_C_PENDING
2804 };
2805 
2806 /* connection state (protected by c_mutex ) */
2807 enum sc_conn_state {
2808 	SLAP_C_INVALID = 0,		/* MUST BE ZERO (0) */
2809 	SLAP_C_INACTIVE,		/* zero threads */
2810 	SLAP_C_CLOSING,			/* closing */
2811 	SLAP_C_ACTIVE,			/* one or more threads */
2812 	SLAP_C_BINDING,			/* binding */
2813 	SLAP_C_CLIENT			/* outbound client conn */
2814 };
2815 struct Connection {
2816 	enum sc_struct_state	c_struct_state; /* structure management state */
2817 	enum sc_conn_state	c_conn_state;	/* connection state */
2818 	int			c_conn_idx;		/* slot in connections array */
2819 	ber_socket_t	c_sd;
2820 	const char	*c_close_reason; /* why connection is closing */
2821 
2822 	ldap_pvt_thread_mutex_t	c_mutex; /* protect the connection */
2823 	Sockbuf		*c_sb;			/* ber connection stuff		  */
2824 
2825 	/* only can be changed by connect_init */
2826 	time_t		c_starttime;	/* when the connection was opened */
2827 	time_t		c_activitytime;	/* when the connection was last used */
2828 	unsigned long		c_connid;	/* id of this connection for stats*/
2829 
2830 	struct berval	c_peer_domain;	/* DNS name of client */
2831 	struct berval	c_peer_name;	/* peer name (trans=addr:port) */
2832 	Listener	*c_listener;
2833 #define c_listener_url c_listener->sl_url	/* listener URL */
2834 #define c_sock_name c_listener->sl_name	/* sock name (trans=addr:port) */
2835 
2836 	/* only can be changed by binding thread */
2837 	struct berval	c_sasl_bind_mech;			/* mech in progress */
2838 	struct berval	c_sasl_dn;	/* temporary storage */
2839 	struct berval	c_sasl_authz_dn;	/* SASL proxy authz */
2840 
2841 	/* authorization backend */
2842 	Backend *c_authz_backend;
2843 	void	*c_authz_cookie;
2844 #define SLAP_IS_AUTHZ_BACKEND( op )	\
2845 	( (op)->o_bd != NULL \
2846 		&& (op)->o_bd->be_private != NULL \
2847 		&& (op)->o_conn != NULL \
2848 		&& (op)->o_conn->c_authz_backend != NULL \
2849 		&& ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2850 			|| (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2851 
2852 	AuthorizationInformation c_authz;
2853 
2854 	ber_int_t	c_protocol;	/* version of the LDAP protocol used by client */
2855 
2856 	LDAP_STAILQ_HEAD(c_o, Operation) c_ops;	/* list of operations being processed */
2857 	LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops;	/* list of pending operations */
2858 
2859 	ldap_pvt_thread_mutex_t	c_write1_mutex;	/* only one pdu written at a time */
2860 	ldap_pvt_thread_cond_t	c_write1_cv;	/* only one pdu written at a time */
2861 	ldap_pvt_thread_mutex_t	c_write2_mutex;	/* used to wait for sd write-ready */
2862 	ldap_pvt_thread_cond_t	c_write2_cv;	/* used to wait for sd write-ready*/
2863 
2864 	BerElement	*c_currentber;	/* ber we're attempting to read */
2865 	int			c_writers;		/* number of writers waiting */
2866 	char		c_writing;		/* someone is writing */
2867 
2868 	char		c_sasl_bind_in_progress;	/* multi-op bind in progress */
2869 	char		c_writewaiter;	/* true if blocked on write */
2870 
2871 
2872 #define	CONN_IS_TLS	1
2873 #define	CONN_IS_UDP	2
2874 #define	CONN_IS_CLIENT	4
2875 #define	CONN_IS_IPC	8
2876 
2877 #ifdef LDAP_CONNECTIONLESS
2878 	char	c_is_udp;		/* true if this is (C)LDAP over UDP */
2879 #endif
2880 #ifdef HAVE_TLS
2881 	char	c_is_tls;		/* true if this LDAP over raw TLS */
2882 	char	c_needs_tls_accept;	/* true if SSL_accept should be called */
2883 #endif
2884 	char	c_sasl_layers;	 /* true if we need to install SASL i/o handlers */
2885 	char	c_sasl_done;		/* SASL completed once */
2886 	void	*c_sasl_authctx;	/* SASL authentication context */
2887 	void	*c_sasl_sockctx;	/* SASL security layer context */
2888 	void	*c_sasl_extra;		/* SASL session extra stuff */
2889 	Operation	*c_sasl_bindop;	/* set to current op if it's a bind */
2890 
2891 #ifdef LDAP_X_TXN
2892 #define CONN_TXN_INACTIVE 0
2893 #define CONN_TXN_SPECIFY 1
2894 #define CONN_TXN_SETTLE -1
2895 	int c_txn;
2896 
2897 	Backend *c_txn_backend;
2898 	LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */
2899 #endif
2900 
2901 	PagedResultsState c_pagedresults_state; /* paged result state */
2902 
2903 	long	c_n_ops_received;	/* num of ops received (next op_id) */
2904 	long	c_n_ops_executing;	/* num of ops currently executing */
2905 	long	c_n_ops_pending;	/* num of ops pending execution */
2906 	long	c_n_ops_completed;	/* num of ops completed */
2907 
2908 	long	c_n_get;		/* num of get calls */
2909 	long	c_n_read;		/* num of read calls */
2910 	long	c_n_write;		/* num of write calls */
2911 
2912 	void	*c_extensions;		/* Netscape plugin */
2913 
2914 	/*
2915 	 * Client connection handling
2916 	 */
2917 	ldap_pvt_thread_start_t	*c_clientfunc;
2918 	void	*c_clientarg;
2919 
2920 	/*
2921 	 * These are the "callbacks" that are available for back-ends to
2922 	 * supply data back to connected clients that are connected
2923 	 * through the "front-end".
2924 	 */
2925 	SEND_LDAP_RESULT *c_send_ldap_result;
2926 	SEND_SEARCH_ENTRY *c_send_search_entry;
2927 	SEND_SEARCH_REFERENCE *c_send_search_reference;
2928 	SEND_LDAP_EXTENDED *c_send_ldap_extended;
2929 	SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2930 };
2931 
2932 #ifdef LDAP_DEBUG
2933 #ifdef LDAP_SYSLOG
2934 #ifdef LOG_LOCAL4
2935 #define SLAP_DEFAULT_SYSLOG_USER	LOG_LOCAL4
2936 #endif /* LOG_LOCAL4 */
2937 
2938 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )	\
2939 	Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2940 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2941 #else /* !LDAP_SYSLOG */
2942 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )	\
2943 	do { \
2944 		if ( ldap_debug & (level) ) \
2945 			lutil_debug( ldap_debug, (level), (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2946 	} while (0)
2947 #define StatslogTest( level ) (ldap_debug & (level))
2948 #endif /* !LDAP_SYSLOG */
2949 #else /* !LDAP_DEBUG */
2950 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0)
2951 #define StatslogTest( level ) (0)
2952 #endif /* !LDAP_DEBUG */
2953 
2954 /*
2955  * listener; need to access it from monitor backend
2956  */
2957 struct Listener {
2958 	struct berval sl_url;
2959 	struct berval sl_name;
2960 	mode_t	sl_perms;
2961 #ifdef HAVE_TLS
2962 	int		sl_is_tls;
2963 #endif
2964 #ifdef LDAP_CONNECTIONLESS
2965 	int	sl_is_udp;		/* UDP listener is also data port */
2966 #endif
2967 	int	sl_mute;	/* Listener is temporarily disabled due to emfile */
2968 	int	sl_busy;	/* Listener is busy (accept thread activated) */
2969 	ber_socket_t sl_sd;
2970 	Sockaddr sl_sa;
2971 #define sl_addr	sl_sa.sa_in_addr
2972 #ifdef LDAP_DEVEL
2973 #define LDAP_TCP_BUFFER
2974 #endif
2975 #ifdef LDAP_TCP_BUFFER
2976 	int	sl_tcp_rmem;	/* custom TCP read buffer size */
2977 	int	sl_tcp_wmem;	/* custom TCP write buffer size */
2978 #endif
2979 };
2980 
2981 /*
2982  * Better know these all around slapd
2983  */
2984 #define SLAP_LDAPDN_PRETTY 0x1
2985 #define SLAP_LDAPDN_MAXLEN 8192
2986 
2987 /* number of response controls supported */
2988 #define SLAP_MAX_RESPONSE_CONTROLS   6
2989 
2990 #ifdef SLAP_SCHEMA_EXPOSE
2991 #define SLAP_CTRL_HIDE				0x00000000U
2992 #else
2993 #define SLAP_CTRL_HIDE				0x80000000U
2994 #endif
2995 
2996 #define SLAP_CTRL_REQUIRES_ROOT		0x40000000U /* for Relax */
2997 
2998 #define SLAP_CTRL_GLOBAL			0x00800000U
2999 #define SLAP_CTRL_GLOBAL_SEARCH		0x00010000U	/* for NOOP */
3000 
3001 #define SLAP_CTRL_OPFLAGS			0x0000FFFFU
3002 #define SLAP_CTRL_ABANDON			0x00000001U
3003 #define SLAP_CTRL_ADD				0x00002002U
3004 #define SLAP_CTRL_BIND				0x00000004U
3005 #define SLAP_CTRL_COMPARE			0x00001008U
3006 #define SLAP_CTRL_DELETE			0x00002010U
3007 #define SLAP_CTRL_MODIFY			0x00002020U
3008 #define SLAP_CTRL_RENAME			0x00002040U
3009 #define SLAP_CTRL_SEARCH			0x00001080U
3010 #define SLAP_CTRL_UNBIND			0x00000100U
3011 
3012 #define SLAP_CTRL_INTROGATE	(SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
3013 #define SLAP_CTRL_UPDATE \
3014 	(SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
3015 #define SLAP_CTRL_ACCESS	(SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
3016 
3017 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
3018 	Operation *op,
3019 	SlapReply *rs,
3020 	LDAPControl *ctrl ));
3021 
3022 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
3023 
3024 #define SLAP_SLAB_SIZE	(1024*1024)
3025 #define SLAP_SLAB_STACK 1
3026 #define SLAP_SLAB_SOBLOCK 64
3027 
3028 #define SLAP_ZONE_ALLOC 1
3029 #undef SLAP_ZONE_ALLOC
3030 
3031 #ifdef LDAP_COMP_MATCH
3032 /*
3033  * Extensible Filter Definition
3034  *
3035  * MatchingRuleAssertion := SEQUENCE {
3036  *	matchingRule	[1] MatchingRuleId OPTIONAL,
3037  *	type		[2] AttributeDescription OPTIONAL,
3038  *	matchValue	[3] AssertionValue,
3039  *	dnAttributes	[4] BOOLEAN DEFAULT FALSE }
3040  *
3041  * Following ComponentFilter is contained in matchValue
3042  *
3043  * ComponentAssertion ::= SEQUENCE {
3044  *	component		ComponentReference (SIZE(1..MAX)) OPTIONAL
3045  *	useDefaultValues	BOOLEAN DEFAULT TRUE,
3046  *	rule			MATCHING-RULE.&id,
3047  *	value			MATCHING-RULE.&AssertionType }
3048  *
3049  * ComponentFilter ::= CHOICE {
3050  *	item	[0] ComponentAssertion,
3051  *	and	[1] SEQUENCE OF ComponentFilter,
3052  *	or	[2] SEQUENCE OF ComponentFilter,
3053  *	not	[3] ComponentFilter }
3054  */
3055 
3056 #define LDAP_COMPREF_IDENTIFIER		((ber_tag_t) 0x80U)
3057 #define LDAP_COMPREF_FROM_BEGINNING	((ber_tag_t) 0x81U)
3058 #define LDAP_COMPREF_COUNT		((ber_tag_t) 0x82U)
3059 #define LDAP_COMPREF_FROM_END		((ber_tag_t) 0x83U)
3060 #define LDAP_COMPREF_CONTENT		((ber_tag_t) 0x84U)
3061 #define LDAP_COMPREF_SELECT		((ber_tag_t) 0x85U)
3062 #define LDAP_COMPREF_ALL		((ber_tag_t) 0x86U)
3063 #define LDAP_COMPREF_DEFINED		((ber_tag_t) 0x87U)
3064 #define LDAP_COMPREF_UNDEFINED		((ber_tag_t) 0x88U)
3065 
3066 #define LDAP_COMP_FILTER_AND		((ber_tag_t) 0xa0U)
3067 #define LDAP_COMP_FILTER_OR		((ber_tag_t) 0xa1U)
3068 #define LDAP_COMP_FILTER_NOT		((ber_tag_t) 0xa2U)
3069 #define LDAP_COMP_FILTER_ITEM		((ber_tag_t) 0xa3U)
3070 #define LDAP_COMP_FILTER_UNDEFINED	((ber_tag_t) 0xa4U)
3071 
3072 typedef struct ComponentId ComponentId;
3073 typedef struct ComponentReference ComponentReference;
3074 typedef struct ComponentAssertion ComponentAssertion;
3075 typedef struct ComponentAssertionValue ComponentAssertionValue;
3076 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo;
3077 typedef struct ComponentDesc ComponentDesc;
3078 
3079 struct ComponentData {
3080 	void			*cd_mem_op;	/* nibble memory handler */
3081 	ComponentSyntaxInfo**	cd_tree;	/* component tree */
3082 };
3083 
3084 struct ComponentId {
3085 	int		ci_type;
3086 	ComponentId	*ci_next;
3087 
3088 	union comp_id_value{
3089 		BerValue	ci_identifier;
3090 		ber_int_t	ci_from_beginning;
3091 		ber_int_t	ci_count;
3092 		ber_int_t	ci_from_end;
3093 		ber_int_t	ci_content;
3094 		BerValue	ci_select_value;
3095 		char		ci_all;
3096 	} ci_val;
3097 };
3098 
3099 struct ComponentReference {
3100 	ComponentId	*cr_list;
3101 	ComponentId	*cr_curr;
3102 	struct berval	cr_string;
3103 	int cr_len;
3104 	/* Component Indexing */
3105 	int		cr_asn_type_id;
3106 	slap_mask_t	cr_indexmask;
3107 	AttributeDescription* cr_ad;
3108 	BerVarray	cr_nvals;
3109 	ComponentReference* cr_next;
3110 };
3111 
3112 struct ComponentAssertion {
3113 	ComponentReference	*ca_comp_ref;
3114 	ber_int_t		ca_use_def;
3115 	MatchingRule		*ca_ma_rule;
3116 	struct berval		ca_ma_value;
3117 	ComponentData		ca_comp_data; /* componentized assertion */
3118 	ComponentFilter		*ca_cf;
3119 	MatchingRuleAssertion   *ca_mra;
3120 };
3121 
3122 struct ComponentFilter {
3123 	ber_tag_t	cf_choice;
3124 	union cf_un_u {
3125 		ber_int_t		cf_un_result;
3126 		ComponentAssertion	*cf_un_ca;
3127 		ComponentFilter		*cf_un_complex;
3128 	} cf_un;
3129 
3130 #define cf_ca		cf_un.cf_un_ca
3131 #define cf_result	cf_un.cf_un_result
3132 #define cf_and		cf_un.cf_un_complex
3133 #define cf_or		cf_un.cf_un_complex
3134 #define cf_not		cf_un.cf_un_complex
3135 #define cf_any		cf_un.cf_un_complex
3136 
3137 	ComponentFilter	*cf_next;
3138 };
3139 
3140 struct ComponentAssertionValue {
3141 	char* cav_buf;
3142 	char* cav_ptr;
3143 	char* cav_end;
3144 };
3145 
3146 typedef int encoder_func LDAP_P((
3147 	void* b,
3148 	void* comp));
3149 
3150 typedef int gser_decoder_func LDAP_P((
3151 	void* mem_op,
3152 	void* b,
3153 	ComponentSyntaxInfo** comp_syn_info,
3154 	int* len,
3155 	int mode));
3156 
3157 typedef int comp_free_func LDAP_P((
3158 	void* b));
3159 
3160 typedef int ber_decoder_func LDAP_P((
3161 	void* mem_op,
3162 	void* b,
3163 	int tag,
3164 	int elmtLen,
3165 	ComponentSyntaxInfo* comp_syn_info,
3166 	int* len,
3167 	int mode));
3168 
3169 typedef int ber_tag_decoder_func LDAP_P((
3170 	void* mem_op,
3171 	void* b,
3172 	ComponentSyntaxInfo* comp_syn_info,
3173 	int* len,
3174 	int mode));
3175 
3176 typedef void* extract_component_from_id_func LDAP_P((
3177 	void* mem_op,
3178 	ComponentReference* cr,
3179 	void* comp ));
3180 
3181 typedef void* convert_attr_to_comp_func LDAP_P ((
3182         Attribute* a,
3183 	Syntax* syn,
3184         struct berval* bv ));
3185 
3186 typedef void* alloc_nibble_func LDAP_P ((
3187 	int initial_size,
3188 	int increment_size ));
3189 
3190 typedef void free_nibble_func LDAP_P ((
3191 	void* nm ));
3192 
3193 typedef void convert_assert_to_comp_func LDAP_P ((
3194 	void *mem_op,
3195         ComponentSyntaxInfo* csi_attr,
3196         struct berval* bv,
3197         ComponentSyntaxInfo** csi,
3198         int* len,
3199         int mode ));
3200 
3201 typedef int convert_asn_to_ldap_func LDAP_P ((
3202         ComponentSyntaxInfo* csi,
3203         struct berval *bv ));
3204 
3205 typedef void free_component_func LDAP_P ((
3206         void* mem_op));
3207 
3208 typedef int test_component_func LDAP_P ((
3209 	void* attr_mem_op,
3210 	void* assert_mem_op,
3211         ComponentSyntaxInfo* csi,
3212 	ComponentAssertion* ca));
3213 
3214 typedef void* test_membership_func LDAP_P ((
3215 	void* in ));
3216 
3217 typedef void* get_component_info_func LDAP_P ((
3218 	int in ));
3219 
3220 typedef int component_encoder_func LDAP_P ((
3221 	void* mem_op,
3222 	ComponentSyntaxInfo* csi,
3223 	struct berval* nvals ));
3224 
3225 typedef int allcomponent_matching_func LDAP_P((
3226 	char* oid,
3227 	ComponentSyntaxInfo* comp1,
3228 	ComponentSyntaxInfo* comp));
3229 
3230 struct ComponentDesc {
3231 	/* Don't change the order of following four fields */
3232 	int				cd_tag;
3233 	AttributeType			*cd_comp_type;
3234 	struct berval			cd_ad_type;	/* ad_type, ad_cname */
3235 	struct berval			cd_ad_cname;	/* ad_type, ad_cname */
3236 	unsigned			cd_flags;	/* ad_flags */
3237 	int				cd_type;
3238 	int				cd_type_id;
3239 	encoder_func			*cd_ldap_encoder;
3240 	encoder_func			*cd_gser_encoder;
3241 	encoder_func			*cd_ber_encoder;
3242 	gser_decoder_func		*cd_gser_decoder;
3243 	ber_decoder_func		*cd_ber_decoder;
3244 	comp_free_func			*cd_free;
3245 	extract_component_from_id_func*  cd_extract_i;
3246 	allcomponent_matching_func	*cd_all_match;
3247 };
3248 
3249 struct ComponentSyntaxInfo {
3250 	Syntax		*csi_syntax;
3251 	ComponentDesc	*csi_comp_desc;
3252 };
3253 
3254 #endif /* LDAP_COMP_MATCH */
3255 
3256 /* slab heap data structures */
3257 
3258 struct slab_object {
3259     void *so_ptr;
3260 	int so_blockhead;
3261     LDAP_LIST_ENTRY(slab_object) so_link;
3262 };
3263 
3264 struct slab_heap {
3265     void *sh_base;
3266     void *sh_last;
3267     void *sh_end;
3268 	int sh_stack;
3269 	int sh_maxorder;
3270     unsigned char **sh_map;
3271     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3272 	LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3273 };
3274 
3275 #ifdef SLAP_ZONE_ALLOC
3276 #define SLAP_ZONE_SIZE 0x80000		/* 512KB */
3277 #define SLAP_ZONE_SHIFT 19
3278 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3279 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3280 #define SLAP_ZONE_DELTA 0x800000	/* 8MB */
3281 #define SLAP_ZONE_ZOBLOCK 256
3282 
3283 struct zone_object {
3284 	void *zo_ptr;
3285 	int zo_siz;
3286 	int zo_idx;
3287 	int zo_blockhead;
3288 	LDAP_LIST_ENTRY(zone_object) zo_link;
3289 };
3290 
3291 struct zone_latency_history {
3292 	double zlh_latency;
3293 	LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3294 };
3295 
3296 struct zone_heap {
3297 	int zh_fd;
3298 	int zh_zonesize;
3299 	int zh_zoneorder;
3300 	int zh_numzones;
3301 	int zh_maxzones;
3302 	int zh_deltazones;
3303 	void **zh_zones;
3304 	ldap_pvt_thread_rdwr_t *zh_znlock;
3305 	Avlnode *zh_zonetree;
3306 	unsigned char ***zh_maps;
3307 	int *zh_seqno;
3308 	LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3309 	LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3310 	ldap_pvt_thread_mutex_t zh_mutex;
3311 	ldap_pvt_thread_rdwr_t zh_lock;
3312 	double zh_ema_latency;
3313 	unsigned long zh_ema_samples;
3314 	LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3315 				zh_latency_history_queue;
3316 	int zh_latency_history_qlen;
3317 	int zh_latency_jump;
3318 	int zh_swapping;
3319 };
3320 #endif
3321 
3322 #define SLAP_BACKEND_INIT_MODULE(b) \
3323 	static BackendInfo bi;	\
3324 	int \
3325 	init_module( int argc, char *argv[] ) \
3326 	{ \
3327 		bi.bi_type = #b ; \
3328 		bi.bi_init = b ## _back_initialize; \
3329 		backend_add( &bi ); \
3330 		return 0; \
3331 	}
3332 
3333 typedef int (OV_init)(void);
3334 typedef struct slap_oinit_t {
3335 	const char	*ov_type;
3336 	OV_init		*ov_init;
3337 } OverlayInit;
3338 
3339 LDAP_END_DECL
3340 
3341 #include "proto-slap.h"
3342 
3343 #endif /* _SLAP_H_ */
3344