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