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