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