]> git.sur5r.net Git - openldap/blob - servers/slapd/slap.h
further ACI factoring out & confinement
[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_OCF_SET_FLAGS      0x1
747 #define SLAP_OCF_CHECK_SUP      0x2
748 #define SLAP_OCF_MASK           (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
749
750 #define SLAP_OC_ALIAS           0x0001
751 #define SLAP_OC_REFERRAL        0x0002
752 #define SLAP_OC_SUBENTRY        0x0004
753 #define SLAP_OC_DYNAMICOBJECT   0x0008
754 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
755 #define SLAP_OC_GLUE            0x0020
756 #define SLAP_OC_SYNCPROVIDERSUBENTRY            0x0040
757 #define SLAP_OC_SYNCCONSUMERSUBENTRY            0x0080
758 #define SLAP_OC__MASK           0x00FF
759 #define SLAP_OC__END            0x0100
760 #define SLAP_OC_OPERATIONAL     0x4000
761 #ifdef LDAP_DEVEL
762 #define SLAP_OC_HIDE            0x0000
763 #else
764 #define SLAP_OC_HIDE            0x8000
765 #endif
766 #define SLAP_OC_HARDCODE        0x10000U        /* This is hardcoded schema */
767
768 /*
769  * DIT content rule
770  */
771 typedef struct slap_content_rule {
772         LDAPContentRule         scr_crule;
773         ObjectClass                     *scr_sclass;
774         ObjectClass                     **scr_auxiliaries;      /* optional */
775         AttributeType           **scr_required;         /* optional */
776         AttributeType           **scr_allowed;          /* optional */
777         AttributeType           **scr_precluded;        /* optional */
778 #define scr_oid                         scr_crule.cr_oid
779 #define scr_names                       scr_crule.cr_names
780 #define scr_desc                        scr_crule.cr_desc
781 #define scr_obsolete            scr_crule.cr_obsolete
782 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
783 #define scr_at_oids_must        scr_crule.cr_at_oids_must
784 #define scr_at_oids_may         scr_crule.cr_at_oids_may
785 #define scr_at_oids_not         scr_crule.cr_at_oids_not
786
787         char                            *scr_oidmacro;
788 #define         SLAP_CR_HARDCODE        0x10000U
789         int     scr_flags;
790
791         LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
792 } ContentRule;
793
794 /* Represents a recognized attribute description ( type + options ). */
795 typedef struct slap_attr_desc {
796         struct slap_attr_desc *ad_next;
797         AttributeType *ad_type;         /* attribute type, must be specified */
798         struct berval ad_cname;         /* canonical name, must be specified */
799         struct berval ad_tags;          /* empty if no tagging options */
800         unsigned ad_flags;
801 #define SLAP_DESC_NONE                  0x00U
802 #define SLAP_DESC_BINARY                0x01U
803 #define SLAP_DESC_TAG_RANGE             0x80U
804 } AttributeDescription;
805
806 typedef struct slap_attr_name {
807         struct berval an_name;
808         AttributeDescription *an_desc;
809         int an_oc_exclude;
810         ObjectClass *an_oc;
811 } AttributeName;
812
813 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
814 #define slap_ad_is_tag_range(ad)        \
815         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
816 #define slap_ad_is_binary(ad)           \
817         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
818
819 /*
820  * pointers to schema elements used internally
821  */
822 struct slap_internal_schema {
823         /* objectClass */
824         ObjectClass *si_oc_top;
825         ObjectClass *si_oc_extensibleObject;
826         ObjectClass *si_oc_alias;
827         ObjectClass *si_oc_referral;
828         ObjectClass *si_oc_rootdse;
829         ObjectClass *si_oc_subentry;
830         ObjectClass *si_oc_subschema;
831         ObjectClass *si_oc_collectiveAttributeSubentry;
832         ObjectClass *si_oc_dynamicObject;
833
834         ObjectClass *si_oc_glue;
835         ObjectClass *si_oc_syncConsumerSubentry;
836         ObjectClass *si_oc_syncProviderSubentry;
837
838         /* objectClass attribute descriptions */
839         AttributeDescription *si_ad_objectClass;
840
841         /* operational attribute descriptions */
842         AttributeDescription *si_ad_structuralObjectClass;
843         AttributeDescription *si_ad_creatorsName;
844         AttributeDescription *si_ad_createTimestamp;
845         AttributeDescription *si_ad_modifiersName;
846         AttributeDescription *si_ad_modifyTimestamp;
847         AttributeDescription *si_ad_hasSubordinates;
848         AttributeDescription *si_ad_subschemaSubentry;
849         AttributeDescription *si_ad_collectiveSubentries;
850         AttributeDescription *si_ad_collectiveExclusions;
851         AttributeDescription *si_ad_entryDN;
852         AttributeDescription *si_ad_entryUUID;
853         AttributeDescription *si_ad_entryCSN;
854         AttributeDescription *si_ad_namingCSN;
855
856         AttributeDescription *si_ad_dseType;
857         AttributeDescription *si_ad_syncreplCookie;
858         AttributeDescription *si_ad_syncTimestamp;
859         AttributeDescription *si_ad_contextCSN;
860
861         /* root DSE attribute descriptions */
862         AttributeDescription *si_ad_altServer;
863         AttributeDescription *si_ad_namingContexts;
864         AttributeDescription *si_ad_supportedControl;
865         AttributeDescription *si_ad_supportedExtension;
866         AttributeDescription *si_ad_supportedLDAPVersion;
867         AttributeDescription *si_ad_supportedSASLMechanisms;
868         AttributeDescription *si_ad_supportedFeatures;
869         AttributeDescription *si_ad_monitorContext;
870         AttributeDescription *si_ad_vendorName;
871         AttributeDescription *si_ad_vendorVersion;
872         AttributeDescription *si_ad_configContext;
873
874         /* subentry attribute descriptions */
875         AttributeDescription *si_ad_administrativeRole;
876         AttributeDescription *si_ad_subtreeSpecification;
877
878         /* subschema subentry attribute descriptions */
879         AttributeDescription *si_ad_attributeTypes;
880         AttributeDescription *si_ad_ditContentRules;
881         AttributeDescription *si_ad_ditStructureRules;
882         AttributeDescription *si_ad_ldapSyntaxes;
883         AttributeDescription *si_ad_matchingRules;
884         AttributeDescription *si_ad_matchingRuleUse;
885         AttributeDescription *si_ad_nameForms;
886         AttributeDescription *si_ad_objectClasses;
887
888         /* Aliases & Referrals */
889         AttributeDescription *si_ad_aliasedObjectName;
890         AttributeDescription *si_ad_ref;
891
892         /* Access Control Internals */
893         AttributeDescription *si_ad_entry;
894         AttributeDescription *si_ad_children;
895         AttributeDescription *si_ad_saslAuthzTo;
896         AttributeDescription *si_ad_saslAuthzFrom;
897
898         /* dynamic entries */
899         AttributeDescription *si_ad_entryTtl;
900         AttributeDescription *si_ad_dynamicSubtrees;
901
902         /* Other attributes descriptions */
903         AttributeDescription *si_ad_distinguishedName;
904         AttributeDescription *si_ad_name;
905         AttributeDescription *si_ad_cn;
906         AttributeDescription *si_ad_uid;
907         AttributeDescription *si_ad_userPassword;
908         AttributeDescription *si_ad_labeledURI;
909 #ifdef SLAPD_AUTHPASSWD
910         AttributeDescription *si_ad_authPassword;
911         AttributeDescription *si_ad_authPasswordSchemes;
912 #endif
913 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
914         AttributeDescription *si_ad_krbName;
915 #endif
916         AttributeDescription *si_ad_description;
917         AttributeDescription *si_ad_seeAlso;
918
919         /* Undefined Attribute Type */
920         AttributeType   *si_at_undefined;
921
922         /* Matching Rules */
923         MatchingRule    *si_mr_distinguishedNameMatch;
924         MatchingRule    *si_mr_dnSubtreeMatch;
925         MatchingRule    *si_mr_dnOneLevelMatch;
926         MatchingRule    *si_mr_dnSubordinateMatch;
927         MatchingRule    *si_mr_dnSuperiorMatch;
928         MatchingRule    *si_mr_caseExactMatch;
929         MatchingRule    *si_mr_caseExactSubstringsMatch;
930         MatchingRule    *si_mr_caseExactIA5Match;
931         MatchingRule    *si_mr_integerMatch;
932         MatchingRule    *si_mr_integerFirstComponentMatch;
933         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
934
935         /* Syntaxes */
936         Syntax          *si_syn_directoryString;
937         Syntax          *si_syn_distinguishedName;
938         Syntax          *si_syn_integer;
939         Syntax          *si_syn_octetString;
940
941         /* Schema Syntaxes */
942         Syntax          *si_syn_attributeTypeDesc;
943         Syntax          *si_syn_ditContentRuleDesc;
944         Syntax          *si_syn_ditStructureRuleDesc;
945         Syntax          *si_syn_ldapSyntaxDesc;
946         Syntax          *si_syn_matchingRuleDesc;
947         Syntax          *si_syn_matchingRuleUseDesc;
948         Syntax          *si_syn_nameFormDesc;
949         Syntax          *si_syn_objectClassDesc;
950 };
951
952 typedef struct slap_attr_assertion {
953         AttributeDescription    *aa_desc;
954         struct berval aa_value;
955 #ifdef LDAP_COMP_MATCH
956         struct slap_component_filter *aa_cf;/* for attribute aliasing */
957 #endif
958 } AttributeAssertion;
959
960 typedef struct slap_ss_assertion {
961         AttributeDescription    *sa_desc;
962         struct berval           sa_initial;
963         struct berval           *sa_any;
964         struct berval           sa_final;
965 } SubstringsAssertion;
966
967 #ifdef LDAP_COMP_MATCH
968 struct slap_component_filter;
969 #endif
970
971 typedef struct slap_mr_assertion {
972         MatchingRule            *ma_rule;       /* optional */
973         struct berval           ma_rule_text;  /* optional */
974         AttributeDescription    *ma_desc;       /* optional */
975         int                                             ma_dnattrs; /* boolean */
976         struct berval           ma_value;       /* required */
977 #ifdef LDAP_COMP_MATCH
978         struct slap_component_filter* ma_cf; /* component filter */
979 #endif
980 } MatchingRuleAssertion;
981
982 /*
983  * represents a search filter
984  */
985 typedef struct slap_filter {
986         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
987 #define SLAPD_FILTER_COMPUTED           ((ber_tag_t) -1)
988 #define SLAPD_FILTER_DN_ONE                     ((ber_tag_t) -2)
989 #define SLAPD_FILTER_DN_SUBTREE         ((ber_tag_t) -3)
990 #ifdef LDAP_SCOPE_SUBORDINATE
991 #define SLAPD_FILTER_DN_CHILDREN        ((ber_tag_t) -4)
992 #endif
993
994         union f_un_u {
995                 /* precomputed result */
996                 ber_int_t f_un_result;
997
998                 /* DN */
999                 struct berval *f_un_dn;
1000
1001                 /* present */
1002                 AttributeDescription *f_un_desc;
1003
1004                 /* simple value assertion */
1005                 AttributeAssertion *f_un_ava;
1006
1007                 /* substring assertion */
1008                 SubstringsAssertion *f_un_ssa;
1009
1010                 /* matching rule assertion */
1011                 MatchingRuleAssertion *f_un_mra;
1012
1013 #define f_dn                    f_un.f_un_dn
1014 #define f_desc                  f_un.f_un_desc
1015 #define f_ava                   f_un.f_un_ava
1016 #define f_av_desc               f_un.f_un_ava->aa_desc
1017 #define f_av_value              f_un.f_un_ava->aa_value
1018 #define f_sub                   f_un.f_un_ssa
1019 #define f_sub_desc              f_un.f_un_ssa->sa_desc
1020 #define f_sub_initial   f_un.f_un_ssa->sa_initial
1021 #define f_sub_any               f_un.f_un_ssa->sa_any
1022 #define f_sub_final             f_un.f_un_ssa->sa_final
1023 #define f_mra                   f_un.f_un_mra
1024 #define f_mr_rule               f_un.f_un_mra->ma_rule
1025 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
1026 #define f_mr_desc               f_un.f_un_mra->ma_desc
1027 #define f_mr_value              f_un.f_un_mra->ma_value
1028 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
1029
1030                 /* and, or, not */
1031                 struct slap_filter *f_un_complex;
1032         } f_un;
1033
1034 #define f_result        f_un.f_un_result
1035 #define f_and           f_un.f_un_complex
1036 #define f_or            f_un.f_un_complex
1037 #define f_not           f_un.f_un_complex
1038 #define f_list          f_un.f_un_complex
1039
1040         struct slap_filter      *f_next;
1041 } Filter;
1042
1043 /* compare routines can return undefined */
1044 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1045
1046 typedef struct slap_valuesreturnfilter {
1047         ber_tag_t       vrf_choice;
1048
1049         union vrf_un_u {
1050                 /* precomputed result */
1051                 ber_int_t vrf_un_result;
1052
1053                 /* DN */
1054                 char *vrf_un_dn;
1055
1056                 /* present */
1057                 AttributeDescription *vrf_un_desc;
1058
1059                 /* simple value assertion */
1060                 AttributeAssertion *vrf_un_ava;
1061
1062                 /* substring assertion */
1063                 SubstringsAssertion *vrf_un_ssa;
1064
1065                 /* matching rule assertion */
1066                 MatchingRuleAssertion *vrf_un_mra;
1067
1068 #define vrf_result              vrf_un.vrf_un_result
1069 #define vrf_dn                  vrf_un.vrf_un_dn
1070 #define vrf_desc                vrf_un.vrf_un_desc
1071 #define vrf_ava                 vrf_un.vrf_un_ava
1072 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
1073 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
1074 #define vrf_ssa                 vrf_un.vrf_un_ssa
1075 #define vrf_sub                 vrf_un.vrf_un_ssa
1076 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
1077 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1078 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
1079 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
1080 #define vrf_mra                 vrf_un.vrf_un_mra
1081 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
1082 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
1083 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
1084 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
1085 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
1086
1087
1088         } vrf_un;
1089
1090         struct slap_valuesreturnfilter  *vrf_next;
1091 } ValuesReturnFilter;
1092
1093 #ifdef LDAP_COMP_MATCH
1094 struct slap_component_syntax_info;
1095 typedef struct  slap_component_data {
1096         void* cd_mem_op;/* nibble memory handler */
1097         struct slap_component_syntax_info** cd_tree;/* component tree */
1098 } ComponentData;
1099 #endif
1100
1101 /*
1102  * represents an attribute (description + values)
1103  */
1104 typedef struct slap_attr {
1105         AttributeDescription *a_desc;
1106         BerVarray       a_vals;         /* preserved values */
1107         BerVarray       a_nvals;        /* normalized values */
1108 #ifdef LDAP_COMP_MATCH
1109         ComponentData   *a_comp_data; /* component values */
1110 #endif
1111         struct slap_attr *a_next;
1112         unsigned a_flags;
1113 #define SLAP_ATTR_IXADD         0x1U
1114 #define SLAP_ATTR_IXDEL         0x2U
1115 } Attribute;
1116
1117
1118 /*
1119  * the id used in the indexes to refer to an entry
1120  */
1121 typedef unsigned long   ID;
1122 #define NOID    ((ID)~0)
1123
1124 /*
1125  * represents an entry in core
1126  */
1127 typedef struct slap_entry {
1128         /*
1129          * The ID field should only be changed before entry is
1130          * inserted into a cache.  The ID value is backend
1131          * specific.
1132          */
1133         ID              e_id;
1134
1135         struct berval e_name;   /* name (DN) of this entry */
1136         struct berval e_nname;  /* normalized name (DN) of this entry */
1137
1138         /* for migration purposes */
1139 #define e_dn e_name.bv_val
1140 #define e_ndn e_nname.bv_val
1141
1142         Attribute       *e_attrs;       /* list of attributes + values */
1143
1144         slap_mask_t     e_ocflags;
1145
1146         struct berval   e_bv;           /* For entry_encode/entry_decode */
1147
1148         /* for use by the backend for any purpose */
1149         void*   e_private;
1150 } Entry;
1151
1152 /*
1153  * A list of LDAPMods
1154  */
1155 typedef struct slap_mod {
1156         short sm_op;
1157         short sm_flags;
1158 /* Set for internal mods, will bypass ACL checks. Only needed when
1159  * running as non-root user, for user modifiable attributes.
1160  */
1161 #define SLAP_MOD_INTERNAL       0x01
1162 #define SLAP_MOD_MANAGING       0x02
1163
1164         AttributeDescription *sm_desc;
1165         struct berval sm_type;
1166         BerVarray sm_values;
1167         BerVarray sm_nvalues;
1168 } Modification;
1169
1170 typedef struct slap_mod_list {
1171         Modification sml_mod;
1172 #define sml_op          sml_mod.sm_op
1173 #define sml_flags       sml_mod.sm_flags
1174 #define sml_desc        sml_mod.sm_desc
1175 #define sml_type        sml_mod.sm_type
1176 #define sml_values      sml_mod.sm_values
1177 #define sml_nvalues     sml_mod.sm_nvalues
1178         struct slap_mod_list *sml_next;
1179 } Modifications;
1180
1181 typedef struct slap_ldap_modlist {
1182         LDAPMod ml_mod;
1183         struct slap_ldap_modlist *ml_next;
1184 #define ml_op           ml_mod.mod_op
1185 #define ml_type         ml_mod.mod_type
1186 #define ml_values       ml_mod.mod_values
1187 } LDAPModList;
1188
1189 /*
1190  * represents an access control list
1191  */
1192 typedef enum slap_access_e {
1193         ACL_INVALID_ACCESS = -1,
1194         ACL_NONE = 0,
1195         ACL_DISCLOSE,
1196         ACL_AUTH,
1197         ACL_COMPARE,
1198         ACL_SEARCH,
1199         ACL_READ,
1200         ACL_WRITE,
1201         ACL_MANAGE,
1202
1203         /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1204         ACL_LAST,
1205
1206         /* ACL level mask and modifiers */
1207         ACL_LEVEL_MASK = 0x000f,
1208         ACL_QUALIFIER1 = 0x0100,
1209         ACL_QUALIFIER2 = 0x0200,
1210         ACL_QUALIFIER3 = 0x0400,
1211         ACL_QUALIFIER4 = 0x0800,
1212         ACL_QUALIFIER_MASK = 0x0f00,
1213
1214         /* write granularity */
1215         ACL_WADD = ACL_WRITE|ACL_QUALIFIER1,
1216         ACL_WDEL = ACL_WRITE|ACL_QUALIFIER2
1217 } slap_access_t;
1218
1219 typedef enum slap_control_e {
1220         ACL_INVALID_CONTROL     = 0,
1221         ACL_STOP,
1222         ACL_CONTINUE,
1223         ACL_BREAK
1224 } slap_control_t;
1225
1226 typedef enum slap_style_e {
1227         ACL_STYLE_REGEX = 0,
1228         ACL_STYLE_EXPAND,
1229         ACL_STYLE_BASE,
1230         ACL_STYLE_ONE,
1231         ACL_STYLE_SUBTREE,
1232         ACL_STYLE_CHILDREN,
1233         ACL_STYLE_LEVEL,
1234         ACL_STYLE_ATTROF,
1235         ACL_STYLE_ANONYMOUS,
1236         ACL_STYLE_USERS,
1237         ACL_STYLE_SELF,
1238         ACL_STYLE_IP,
1239         ACL_STYLE_PATH
1240 } slap_style_t;
1241
1242 typedef struct slap_authz_info {
1243         ber_tag_t       sai_method;                     /* LDAP_AUTH_* from <ldap.h> */
1244         struct berval   sai_mech;               /* SASL Mechanism */
1245         struct berval   sai_dn;                 /* DN for reporting purposes */
1246         struct berval   sai_ndn;                /* Normalized DN */
1247
1248         /* Security Strength Factors */
1249         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1250         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1251         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1252         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1253 } AuthorizationInformation;
1254
1255
1256 #ifdef SLAP_DYNACL
1257 struct slap_op;
1258
1259 /*
1260  * "dynamic" ACL infrastructure (for ACIs and more)
1261  */
1262 typedef int (slap_dynacl_parse)( const char *fname, int lineno, slap_style_t, const char *, void **privp );
1263 typedef int (slap_dynacl_unparse)( void *priv, struct berval *bv );
1264 typedef int (slap_dynacl_mask)(
1265                 void                    *priv,
1266                 struct slap_op          *op,
1267                 Entry                   *e,
1268                 AttributeDescription    *desc,
1269                 struct berval           *val,
1270                 int                     nmatch,
1271                 regmatch_t              *matches,
1272                 slap_access_t           *grant,
1273                 slap_access_t           *deny );
1274 typedef int (slap_dynacl_destroy)( void *priv );
1275
1276 typedef struct slap_dynacl_t {
1277         char                    *da_name;
1278         slap_dynacl_parse       *da_parse;
1279         slap_dynacl_unparse     *da_unparse;
1280         slap_dynacl_mask        *da_mask;
1281         slap_dynacl_destroy     *da_destroy;
1282         
1283         void                    *da_private;
1284         struct slap_dynacl_t    *da_next;
1285 } slap_dynacl_t;
1286 #endif /* SLAP_DYNACL */
1287
1288 /* the DN portion of the "by" part */
1289 typedef struct slap_dn_access {
1290         /* DN pattern */
1291         AuthorizationInformation        a_dnauthz;
1292 #define a_pat                   a_dnauthz.sai_dn
1293
1294         slap_style_t            a_style;
1295         int                     a_level;
1296         int                     a_self_level;
1297         AttributeDescription    *a_at;
1298         int                     a_self;
1299         int                     a_expand;
1300 } slap_dn_access;
1301
1302 /* the "by" part */
1303 typedef struct slap_access {
1304         slap_control_t a_type;
1305
1306 /* strip qualifiers */
1307 #define ACL_LEVEL(p)                    ((p) & ACL_LEVEL_MASK)
1308 #define ACL_QUALIFIERS(p)               ((p) & ~ACL_LEVEL_MASK)
1309
1310 #define ACL_ACCESS2PRIV(access)         ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1311
1312 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1313 #define ACL_PRIV_DISCLOSE               ACL_ACCESS2PRIV( ACL_DISCLOSE )
1314 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1315 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1316 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1317 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1318 #define ACL_PRIV_WADD                   ACL_ACCESS2PRIV( ACL_WADD )
1319 #define ACL_PRIV_WDEL                   ACL_ACCESS2PRIV( ACL_WDEL )
1320 #define ACL_PRIV_WRITE                  ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1321 #define ACL_PRIV_MANAGE                 ACL_ACCESS2PRIV( ACL_MANAGE )
1322
1323 /* NOTE: always use the highest level; current: 0x00ffUL */
1324 #define ACL_PRIV_MASK                   ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1325
1326 /* priv flags */
1327 #define ACL_PRIV_LEVEL                  0x1000UL
1328 #define ACL_PRIV_ADDITIVE               0x2000UL
1329 #define ACL_PRIV_SUBSTRACTIVE           0x4000UL
1330
1331 /* invalid privs */
1332 #define ACL_PRIV_INVALID                0x0UL
1333
1334 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1335 #define ACL_PRIV_ASSIGN(m,p)            do { (m)  =  (p); } while(0)
1336 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1337 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1338
1339 #define ACL_INIT(m)                     ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1340 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1341
1342 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1343
1344 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1345
1346 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1347 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1348 #define ACL_IS_SUBTRACTIVE(m)           ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1349
1350 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1351 #define ACL_LVL_DISCLOSE                (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1352 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1353 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1354 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1355 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1356 #define ACL_LVL_WADD                    (ACL_PRIV_WADD|ACL_LVL_READ)
1357 #define ACL_LVL_WDEL                    (ACL_PRIV_WDEL|ACL_LVL_READ)
1358 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1359 #define ACL_LVL_MANAGE                  (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1360
1361 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1362 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1363 #define ACL_LVL_IS_DISCLOSE(m)          ACL_LVL((m),ACL_LVL_DISCLOSE)
1364 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1365 #define ACL_LVL_IS_COMPARE(m)           ACL_LVL((m),ACL_LVL_COMPARE)
1366 #define ACL_LVL_IS_SEARCH(m)            ACL_LVL((m),ACL_LVL_SEARCH)
1367 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1368 #define ACL_LVL_IS_WADD(m)              ACL_LVL((m),ACL_LVL_WADD)
1369 #define ACL_LVL_IS_WDEL(m)              ACL_LVL((m),ACL_LVL_WDEL)
1370 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1371 #define ACL_LVL_IS_MANAGE(m)            ACL_LVL((m),ACL_LVL_MANAGE)
1372
1373 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1374 #define ACL_LVL_ASSIGN_DISCLOSE(m)      ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1375 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1376 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1377 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1378 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1379 #define ACL_LVL_ASSIGN_WADD(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1380 #define ACL_LVL_ASSIGN_WDEL(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1381 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1382 #define ACL_LVL_ASSIGN_MANAGE(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1383
1384         slap_mask_t     a_access_mask;
1385
1386         /* DN pattern */
1387         slap_dn_access          a_dn;
1388 #define a_dn_pat                a_dn.a_dnauthz.sai_dn
1389 #define a_dn_at                 a_dn.a_at
1390 #define a_dn_self               a_dn.a_self
1391
1392         /* real DN pattern */
1393         slap_dn_access          a_realdn;
1394 #define a_realdn_pat            a_realdn.a_dnauthz.sai_dn
1395 #define a_realdn_at             a_realdn.a_at
1396 #define a_realdn_self           a_realdn.a_self
1397
1398         /* used for ssf stuff
1399          * NOTE: the ssf stuff in a_realdn is ignored */
1400 #define a_authz                 a_dn.a_dnauthz
1401
1402         /* connection related stuff */
1403         slap_style_t a_peername_style;
1404         struct berval   a_peername_pat;
1405         unsigned long   a_peername_addr,
1406                         a_peername_mask;
1407         int             a_peername_port;
1408
1409         slap_style_t a_sockname_style;
1410         struct berval   a_sockname_pat;
1411
1412         slap_style_t a_domain_style;
1413         struct berval   a_domain_pat;
1414         int             a_domain_expand;
1415
1416         slap_style_t a_sockurl_style;
1417         struct berval   a_sockurl_pat;
1418         slap_style_t a_set_style;
1419         struct berval   a_set_pat;
1420
1421 #ifdef SLAP_DYNACL
1422         slap_dynacl_t           *a_dynacl;
1423 #else /* ! SLAP_DYNACL */
1424 #ifdef SLAPD_ACI_ENABLED
1425         /* NOTE: ACIs have been moved under the "dynacl" interface,
1426          * which is currently built only when LDAP_DEVEL is defined.
1427          *
1428          * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1429          * is required to enable ACI support.
1430          */
1431         AttributeDescription    *a_aci_at;
1432 #endif /* SLAPD_ACI_ENABLED */
1433 #endif /* SLAP_DYNACL */
1434
1435         /* ACL Groups */
1436         slap_style_t a_group_style;
1437         struct berval   a_group_pat;
1438         ObjectClass                             *a_group_oc;
1439         AttributeDescription    *a_group_at;
1440
1441         struct slap_access      *a_next;
1442 } Access;
1443
1444 /* the "to" part */
1445 typedef struct slap_acl {
1446         /* "to" part: the entries this acl applies to */
1447         Filter          *acl_filter;
1448         slap_style_t acl_dn_style;
1449         regex_t         acl_dn_re;
1450         struct berval   acl_dn_pat;
1451         AttributeName   *acl_attrs;
1452         MatchingRule    *acl_attrval_mr;
1453         slap_style_t    acl_attrval_style;
1454         regex_t         acl_attrval_re;
1455         struct berval   acl_attrval;
1456
1457         /* "by" part: list of who has what access to the entries */
1458         Access  *acl_access;
1459
1460         struct slap_acl *acl_next;
1461 } AccessControl;
1462
1463 typedef struct slap_acl_state {
1464         unsigned as_recorded;
1465 #define ACL_STATE_NOT_RECORDED                  0x0
1466 #define ACL_STATE_RECORDED_VD                   0x1
1467 #define ACL_STATE_RECORDED_NV                   0x2
1468 #define ACL_STATE_RECORDED                              0x3
1469
1470         /* Access state */
1471         AccessControl *as_vd_acl;
1472         AccessControl *as_vi_acl;
1473         slap_mask_t as_vd_acl_mask;
1474         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1475         int as_vd_acl_count;
1476
1477         Access *as_vd_access;
1478         int as_vd_access_count;
1479
1480         int as_result;
1481         AttributeDescription *as_vd_ad;
1482 } AccessControlState;
1483 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1484         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1485
1486 #ifdef SLAPD_ACI_ENABLED
1487 typedef enum slap_aci_scope_t {
1488         SLAP_ACI_SCOPE_ENTRY            = 0x1,
1489         SLAP_ACI_SCOPE_CHILDREN         = 0x2,
1490         SLAP_ACI_SCOPE_SUBTREE          = ( SLAP_ACI_SCOPE_ENTRY | SLAP_ACI_SCOPE_CHILDREN )
1491 } slap_aci_scope_t;
1492 #endif /* SLAPD_ACI_ENABLED */
1493
1494 enum {
1495         ACI_BV_ENTRY,
1496         ACI_BV_CHILDREN,
1497         ACI_BV_ONELEVEL,
1498         ACI_BV_SUBTREE,
1499         ACI_BV_BR_ENTRY,
1500         ACI_BV_BR_ALL,
1501         ACI_BV_ACCESS_ID,
1502 #if 0
1503         ACI_BV_ANONYMOUS        = BER_BVC("anonymous"),
1504 #endif
1505         ACI_BV_PUBLIC,
1506         ACI_BV_USERS,
1507         ACI_BV_SELF,
1508         ACI_BV_DNATTR,
1509         ACI_BV_GROUP,
1510         ACI_BV_ROLE,
1511         ACI_BV_SET,
1512         ACI_BV_SET_REF,
1513         ACI_BV_GRANT,
1514         ACI_BV_DENY,
1515
1516         ACI_BV_IP_EQ,
1517 #ifdef LDAP_PF_LOCAL
1518         ACI_BV_PATH_EQ,
1519 #if 0
1520         ACI_BV_DIRSEP,
1521 #endif
1522 #endif /* LDAP_PF_LOCAL */
1523         
1524         ACI_BV_GROUP_CLASS,
1525         ACI_BV_GROUP_ATTR,
1526         ACI_BV_ROLE_CLASS,
1527         ACI_BV_ROLE_ATTR,
1528         ACI_BV_SET_ATTR,
1529
1530         ACI_BV_LAST
1531 };
1532
1533 /*
1534  * Backend-info
1535  * represents a backend 
1536  */
1537
1538 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1539 typedef struct slap_backend_db BackendDB;               /* per backend database */
1540 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1541 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1542
1543 LDAP_SLAPD_V (int) nBackendInfo;
1544 LDAP_SLAPD_V (int) nBackendDB;
1545 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1546 LDAP_SLAPD_V (slap_be_head) backendDB;
1547 LDAP_SLAPD_V (BackendDB *) frontendDB;
1548
1549 LDAP_SLAPD_V (int) slapMode;    
1550 #define SLAP_UNDEFINED_MODE     0x0000
1551 #define SLAP_SERVER_MODE        0x0001
1552 #define SLAP_TOOL_MODE          0x0002
1553 #define SLAP_MODE                       0x0003
1554
1555 #define SLAP_TRUNCATE_MODE      0x0100
1556 #define SLAP_TOOL_READMAIN      0x0200
1557 #define SLAP_TOOL_READONLY      0x0400
1558 #define SLAP_TOOL_QUICK         0x0800
1559
1560 #define SB_TLS_DEFAULT          (-1)
1561 #define SB_TLS_OFF              0
1562 #define SB_TLS_ON               1
1563 #define SB_TLS_CRITICAL         2
1564
1565 typedef struct slap_bindconf {
1566         int sb_tls;
1567         int sb_method;
1568         struct berval sb_binddn;
1569         struct berval sb_cred;
1570         struct berval sb_saslmech;
1571         char *sb_secprops;
1572         struct berval sb_realm;
1573         struct berval sb_authcId;
1574         struct berval sb_authzId;
1575 } slap_bindconf;
1576
1577 struct slap_replica_info {
1578         const char *ri_uri;                     /* supersedes be_replica */
1579         const char *ri_host;            /* points to host part of uri */
1580         BerVarray ri_nsuffix;           /* array of suffixes this replica accepts */
1581         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1582         int ri_exclude;                         /* 1 => exclude ri_attrs */
1583         slap_bindconf ri_bindconf;      /* for back-config */
1584 };
1585
1586 typedef struct slap_verbmasks {
1587         struct berval word;
1588         const slap_mask_t mask;
1589 } slap_verbmasks;
1590
1591 #define SLAP_LIMIT_TIME 1
1592 #define SLAP_LIMIT_SIZE 2
1593
1594 struct slap_limits_set {
1595         /* time limits */
1596         int     lms_t_soft;
1597         int     lms_t_hard;
1598
1599         /* size limits */
1600         int     lms_s_soft;
1601         int     lms_s_hard;
1602         int     lms_s_unchecked;
1603         int     lms_s_pr;
1604         int     lms_s_pr_hide;
1605         int     lms_s_pr_total;
1606 };
1607
1608 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1609 #define SLAP_NO_LIMIT                   -1
1610 #define SLAP_MAX_LIMIT                  2147483647
1611
1612 struct slap_limits {
1613         unsigned                lm_flags;       /* type of pattern */
1614 #define SLAP_LIMITS_UNDEFINED           0x0000U
1615 #define SLAP_LIMITS_EXACT               0x0001U
1616 #define SLAP_LIMITS_BASE                SLAP_LIMITS_EXACT
1617 #define SLAP_LIMITS_ONE                 0x0002U
1618 #define SLAP_LIMITS_SUBTREE             0x0003U
1619 #define SLAP_LIMITS_CHILDREN            0x0004U
1620 #define SLAP_LIMITS_REGEX               0x0005U
1621 #define SLAP_LIMITS_ANONYMOUS           0x0006U
1622 #define SLAP_LIMITS_USERS               0x0007U
1623 #define SLAP_LIMITS_ANY                 0x0008U
1624 #define SLAP_LIMITS_MASK                0x000FU
1625
1626 #define SLAP_LIMITS_TYPE_DN             0x0000U
1627 #define SLAP_LIMITS_TYPE_GROUP          0x0010U
1628 #define SLAP_LIMITS_TYPE_MASK           0x00F0U
1629
1630         regex_t                 lm_regex;       /* regex data for REGEX */
1631
1632         /*
1633          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1634          * pattern for REGEX; NULL for ANONYMOUS, USERS
1635          */
1636         struct berval           lm_pat;
1637
1638         /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1639          * lm_group_oc is objectClass and lm_group_at is attributeType
1640          * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1641          * can only be SLAP_LIMITS_EXACT */
1642         ObjectClass             *lm_group_oc;
1643         AttributeDescription    *lm_group_ad;
1644
1645         struct slap_limits_set  lm_limits;
1646 };
1647
1648 /* temporary aliases */
1649 typedef BackendDB Backend;
1650 #define nbackends nBackendDB
1651 #define backends backendDB
1652
1653 /*
1654  * syncinfo structure for syncrepl
1655  */
1656
1657 struct syncinfo_s;
1658
1659 #define SLAP_SYNC_RID_SIZE      3
1660 #define SLAP_SYNCUUID_SET_SIZE 256
1661
1662 #define SLAP_SYNC_UPDATE_MSGID  2
1663
1664 struct sync_cookie {
1665         struct berval ctxcsn;
1666         struct berval octet_str;
1667         long rid;
1668         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1669 };
1670
1671 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1672
1673 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1674
1675 #ifndef SLAP_MAX_CIDS
1676 #define SLAP_MAX_CIDS   32      /* Maximum number of supported controls */
1677 #endif
1678
1679 struct ConfigOCs;       /* config.h */
1680
1681 struct slap_backend_db {
1682         BackendInfo     *bd_info;       /* pointer to shared backend info */
1683
1684         /* fields in this structure (and routines acting on this structure)
1685            should be renamed from be_ to bd_ */
1686
1687         /* BackendInfo accessors */
1688 #define         be_config       bd_info->bi_db_config
1689 #define         be_type         bd_info->bi_type
1690
1691 #define         be_bind         bd_info->bi_op_bind
1692 #define         be_unbind       bd_info->bi_op_unbind
1693 #define         be_add          bd_info->bi_op_add
1694 #define         be_compare      bd_info->bi_op_compare
1695 #define         be_delete       bd_info->bi_op_delete
1696 #define         be_modify       bd_info->bi_op_modify
1697 #define         be_modrdn       bd_info->bi_op_modrdn
1698 #define         be_search       bd_info->bi_op_search
1699 #define         be_abandon      bd_info->bi_op_abandon
1700 #define         be_cancel       bd_info->bi_op_cancel
1701
1702 #define         be_extended     bd_info->bi_extended
1703
1704 #define         be_chk_referrals        bd_info->bi_chk_referrals
1705 #define         be_chk_controls         bd_info->bi_chk_controls
1706 #define         be_fetch        bd_info->bi_entry_get_rw
1707 #define         be_release      bd_info->bi_entry_release_rw
1708 #define         be_group        bd_info->bi_acl_group
1709 #define         be_attribute    bd_info->bi_acl_attribute
1710 #define         be_operational  bd_info->bi_operational
1711
1712 /*
1713  * define to honor hasSubordinates operational attribute in search filters
1714  * (in previous use there was a flaw with back-bdb and back-ldbm; now it 
1715  * is fixed).
1716  */
1717 #define         be_has_subordinates bd_info->bi_has_subordinates
1718
1719 #define         be_connection_init      bd_info->bi_connection_init
1720 #define         be_connection_destroy   bd_info->bi_connection_destroy
1721
1722 #ifdef SLAPD_TOOLS
1723 #define         be_entry_open bd_info->bi_tool_entry_open
1724 #define         be_entry_close bd_info->bi_tool_entry_close
1725 #define         be_entry_first bd_info->bi_tool_entry_first
1726 #define         be_entry_next bd_info->bi_tool_entry_next
1727 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1728 #define         be_entry_get bd_info->bi_tool_entry_get
1729 #define         be_entry_put bd_info->bi_tool_entry_put
1730 #define         be_sync bd_info->bi_tool_sync
1731 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1732 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1733 #define         be_entry_modify bd_info->bi_tool_entry_modify
1734 #endif
1735
1736         /* supported controls */
1737         /* note: set to 0 if the database does not support the control;
1738          * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1739         char            be_ctrls[SLAP_MAX_CIDS + 1];
1740
1741 /* Database flags */
1742 #define SLAP_DBFLAG_NOLASTMOD           0x0001U
1743 #define SLAP_DBFLAG_NO_SCHEMA_CHECK     0x0002U
1744 #define SLAP_DBFLAG_GLUE_INSTANCE       0x0010U /* a glue backend */
1745 #define SLAP_DBFLAG_GLUE_SUBORDINATE    0x0020U /* child of a glue hierarchy */
1746 #define SLAP_DBFLAG_GLUE_LINKED         0x0040U /* child is connected to parent */
1747 #define SLAP_DBFLAG_GLUE_ADVERTISE      0x0080U /* advertise in rootDSE */
1748 #define SLAP_DBFLAG_OVERLAY             0x0100U /* this db struct is an overlay */
1749 #define SLAP_DBFLAG_GLOBAL_OVERLAY      0x0200U /* this db struct is a global overlay */
1750 #define SLAP_DBFLAG_SHADOW              0x8000U /* a shadow */
1751 #define SLAP_DBFLAG_SYNC_SHADOW         0x1000U /* a sync shadow */
1752 #define SLAP_DBFLAG_SLURP_SHADOW        0x2000U /* a slurp shadow */
1753         slap_mask_t     be_flags;
1754 #define SLAP_DBFLAGS(be)                        ((be)->be_flags)
1755 #define SLAP_NOLASTMOD(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1756 #define SLAP_LASTMOD(be)                        (!SLAP_NOLASTMOD(be))
1757 #define SLAP_ISOVERLAY(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1758 #define SLAP_NO_SCHEMA_CHECK(be)        \
1759         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1760 #define SLAP_GLUE_INSTANCE(be)          \
1761         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1762 #define SLAP_GLUE_SUBORDINATE(be)       \
1763         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1764 #define SLAP_GLUE_LINKED(be)            \
1765         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1766 #define SLAP_GLUE_ADVERTISE(be) \
1767         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1768 #define SLAP_SHADOW(be)                         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1769 #define SLAP_SYNC_SHADOW(be)                    (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1770 #define SLAP_SLURP_SHADOW(be)                   (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1771
1772         slap_mask_t     be_restrictops;         /* restriction operations */
1773 #define SLAP_RESTRICT_OP_ADD            0x0001U
1774 #define SLAP_RESTRICT_OP_BIND           0x0002U
1775 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1776 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1777 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1778 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1779 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1780 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1781 #define SLAP_RESTRICT_OP_MASK           0x00FFU
1782
1783 #define SLAP_RESTRICT_READONLY          0x80000000U
1784
1785 #define SLAP_RESTRICT_EXOP_START_TLS            0x0100U
1786 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD        0x0200U
1787 #define SLAP_RESTRICT_EXOP_WHOAMI               0x0400U
1788 #define SLAP_RESTRICT_EXOP_CANCEL               0x0800U
1789 #define SLAP_RESTRICT_EXOP_MASK                 0xFF00U
1790
1791 #define SLAP_RESTRICT_OP_READS  \
1792         ( SLAP_RESTRICT_OP_COMPARE      \
1793         | SLAP_RESTRICT_OP_SEARCH )
1794 #define SLAP_RESTRICT_OP_WRITES \
1795         ( SLAP_RESTRICT_OP_ADD    \
1796         | SLAP_RESTRICT_OP_DELETE \
1797         | SLAP_RESTRICT_OP_MODIFY \
1798         | SLAP_RESTRICT_OP_RENAME )
1799
1800 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1801 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1802 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1803
1804 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1805
1806 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1807 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1808 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1809
1810 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1811 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1812
1813 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1814
1815         slap_mask_t     be_requires;    /* pre-operation requirements */
1816 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1817 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1818 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1819 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1820 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1821
1822         /* Required Security Strength Factor */
1823         slap_ssf_set_t be_ssf_set;
1824
1825         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1826         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1827         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1828         struct berval be_schemandn;     /* normalized subschema DN */
1829         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1830         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1831         struct berval be_rootpw;        /* the magic "root" password for this db        */
1832         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1833 #define be_sizelimit    be_def_limit.lms_s_soft
1834 #define be_timelimit    be_def_limit.lms_t_soft
1835         struct slap_limits_set be_def_limit; /* default limits */
1836         struct slap_limits **be_limits; /* regex-based size and time limits */
1837         AccessControl *be_acl;  /* access control list for this backend    */
1838         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1839
1840         /* Replica Information */
1841         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1842         char    *be_replogfile; /* replication log file (in master)        */
1843         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1844         BerVarray       be_update_refs; /* where to refer modifying clients to */
1845         struct          be_pcl  *be_pending_csn_list;
1846         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1847         ldap_pvt_thread_mutex_t                                 *be_pcl_mutexp;
1848         struct syncinfo_s                                               *be_syncinfo; /* For syncrepl */
1849
1850         void    *be_pb;         /* Netscape plugin */
1851         struct ConfigOCs *be_cf_ocs;
1852
1853         void    *be_private;    /* anything the backend database needs     */
1854         LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1855 };
1856
1857 struct slap_conn;
1858 struct slap_op;
1859
1860 /* Backend function typedefs */
1861 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1862 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1863         const char *fname, int lineno,
1864         int argc, char **argv));
1865 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1866 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1867 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1868
1869 typedef int (BI_db_init) LDAP_P((Backend *bd));
1870 typedef int (BI_db_config) LDAP_P((Backend *bd,
1871         const char *fname, int lineno,
1872         int argc, char **argv));
1873 typedef int (BI_db_open) LDAP_P((Backend *bd));
1874 typedef int (BI_db_close) LDAP_P((Backend *bd));
1875 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1876
1877 typedef struct req_bind_s {
1878         int rb_method;
1879         struct berval rb_cred;
1880         struct berval rb_edn;
1881         slap_ssf_t rb_ssf;
1882         struct berval rb_tmp_mech;      /* FIXME: temporary */
1883 } req_bind_s;
1884
1885 typedef struct req_search_s {
1886         int rs_scope;
1887         int rs_deref;
1888         int rs_slimit;
1889         int rs_tlimit;
1890         /* NULL means be_isroot evaluated to TRUE */
1891         struct slap_limits_set *rs_limit;
1892         int rs_attrsonly;
1893         AttributeName *rs_attrs;
1894         Filter *rs_filter;
1895         struct berval rs_filterstr;
1896 } req_search_s;
1897
1898 typedef struct req_compare_s {
1899         AttributeAssertion *rs_ava;
1900 } req_compare_s;
1901
1902 typedef struct req_modify_s {
1903         Modifications *rs_modlist;
1904         int rs_increment;               /* FIXME: temporary */
1905 } req_modify_s;
1906
1907 typedef struct req_modrdn_s {
1908         struct berval rs_newrdn;
1909         struct berval rs_nnewrdn;
1910         struct berval *rs_newSup;
1911         struct berval *rs_nnewSup;
1912         int rs_deleteoldrdn;
1913 } req_modrdn_s;
1914
1915 typedef struct req_add_s {
1916         Entry *rs_e;
1917         Modifications *rs_modlist;      /* FIXME: temporary */
1918 } req_add_s;
1919
1920 typedef struct req_abandon_s {
1921         ber_int_t rs_msgid;
1922 } req_abandon_s;
1923
1924 #ifdef LDAP_DEVEL
1925 #define SLAP_EXOP_HIDE 0x0000
1926 #else
1927 #define SLAP_EXOP_HIDE 0x8000
1928 #endif
1929 #define SLAP_EXOP_WRITES 0x0001         /* Exop does writes */
1930
1931 typedef struct req_extended_s {
1932         struct berval rs_reqoid;
1933         int rs_flags;
1934         struct berval *rs_reqdata;
1935 } req_extended_s;
1936
1937 typedef struct req_pwdexop_s {
1938         struct berval rs_reqoid;
1939         int rs_flags;
1940         struct berval rs_old;
1941         struct berval rs_new;
1942         Modifications *rs_mods;
1943         Modifications **rs_modtail;
1944 } req_pwdexop_s;
1945
1946 typedef enum slap_reply_e {
1947         REP_RESULT,
1948         REP_SASL,
1949         REP_EXTENDED,
1950         REP_SEARCH,
1951         REP_SEARCHREF,
1952         REP_INTERMEDIATE
1953 } slap_reply_t;
1954
1955 typedef struct rep_sasl_s {
1956         struct berval *r_sasldata;
1957 } rep_sasl_s;
1958
1959 typedef struct rep_extended_s {
1960         const char *r_rspoid;
1961         struct berval *r_rspdata;
1962 } rep_extended_s;
1963
1964 typedef struct rep_search_s {
1965         Entry *r_entry;
1966         slap_mask_t r_attr_flags;
1967 #define SLAP_ATTRS_UNDEFINED    (0x00U)
1968 #define SLAP_OPATTRS_NO                 (0x01U)
1969 #define SLAP_OPATTRS_YES                (0x02U)
1970 #define SLAP_USERATTRS_NO               (0x10U)
1971 #define SLAP_USERATTRS_YES              (0x20U)
1972 #define SLAP_OPATTRS_MASK(f)    ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1973 #define SLAP_OPATTRS(f)                 (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1974 #define SLAP_USERATTRS_MASK(f)  ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1975 #define SLAP_USERATTRS(f)               \
1976         (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1977
1978         Attribute *r_operational_attrs;
1979         AttributeName *r_attrs;
1980         int r_nentries;
1981         BerVarray r_v2ref;
1982 } rep_search_s;
1983
1984 typedef struct slap_rep {
1985         slap_reply_t sr_type;
1986         ber_tag_t sr_tag;
1987         ber_int_t sr_msgid;
1988         ber_int_t sr_err;
1989         const char *sr_matched;
1990         const char *sr_text;
1991         BerVarray sr_ref;
1992         LDAPControl **sr_ctrls;
1993         union sr_u {
1994                 rep_sasl_s sru_sasl;
1995                 rep_extended_s sru_extended;
1996                 rep_search_s sru_search;
1997         } sr_un;
1998         slap_mask_t sr_flags;
1999 #define REP_ENTRY_MODIFIABLE    0x0001U
2000 #define REP_ENTRY_MUSTBEFREED   0x0002U
2001 #define REP_ENTRY_MUSTRELEASE   0x0004U
2002 #define REP_MATCHED_MUSTBEFREED 0x0010U
2003 #define REP_REF_MUSTBEFREED             0x0020U
2004 } SlapReply;
2005
2006 /* short hands for response members */
2007 #define sr_attrs sr_un.sru_search.r_attrs
2008 #define sr_entry sr_un.sru_search.r_entry
2009 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2010 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2011 #define sr_v2ref sr_un.sru_search.r_v2ref
2012 #define sr_nentries sr_un.sru_search.r_nentries
2013 #define sr_rspoid sr_un.sru_extended.r_rspoid
2014 #define sr_rspdata sr_un.sru_extended.r_rspdata
2015 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2016
2017 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2018 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2019 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2020 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2021 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2022 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2023 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2024 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2025 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2026 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2027 typedef int (BI_op_extended) LDAP_P((
2028         struct slap_op *op, struct slap_rep *rs ));
2029 typedef int (BI_chk_referrals) LDAP_P((
2030         struct slap_op *op, struct slap_rep *rs ));
2031 typedef int (BI_chk_controls) LDAP_P((
2032         struct slap_op *op, struct slap_rep *rs ));
2033 typedef int (BI_entry_release_rw)
2034         LDAP_P(( struct slap_op *op, Entry *e, int rw ));
2035 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
2036         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2037 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2038 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
2039         Entry *e, int *hasSubs ));
2040 #ifdef SLAP_OVERLAY_ACCESS
2041 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
2042         AttributeDescription *desc, struct berval *val, slap_access_t access,
2043         AccessControlState *state, slap_mask_t *maskp ));
2044 typedef int (BI_acl_group) LDAP_P(( struct slap_op *op, Entry *target,
2045         struct berval *gr_ndn, struct berval *op_ndn,
2046         ObjectClass *group_oc, AttributeDescription *group_at ));
2047 typedef int (BI_acl_attribute) LDAP_P(( struct slap_op *op, Entry *target,
2048         struct berval *entry_ndn, AttributeDescription *entry_at,
2049         BerVarray *vals, slap_access_t access ));
2050 #endif /* SLAP_OVERLAY_ACCESS */
2051
2052 typedef int (BI_connection_init) LDAP_P(( BackendDB *bd,
2053         struct slap_conn *c ));
2054 typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd,
2055         struct slap_conn *c ));
2056
2057 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2058 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2059 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2060 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2061 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2062 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e, 
2063         struct berval *text ));
2064 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
2065 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2066 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2067 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
2068 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e, 
2069         struct berval *text ));
2070
2071 struct slap_backend_info {
2072         char    *bi_type; /* type of backend */
2073
2074         /*
2075          * per backend type routines:
2076          * bi_init: called to allocate a backend_info structure,
2077          *              called once BEFORE configuration file is read.
2078          *              bi_init() initializes this structure hence is
2079          *              called directly from be_initialize()
2080          * bi_config: called per 'backend' specific option
2081          *              all such options must before any 'database' options
2082          *              bi_config() is called only from read_config()
2083          * bi_open: called to open each database, called
2084          *              once AFTER configuration file is read but
2085          *              BEFORE any bi_db_open() calls.
2086          *              bi_open() is called from backend_startup()
2087          * bi_close: called to close each database, called
2088          *              once during shutdown after all bi_db_close calls.
2089          *              bi_close() is called from backend_shutdown()
2090          * bi_destroy: called to destroy each database, called
2091          *              once during shutdown after all bi_db_destroy calls.
2092          *              bi_destory() is called from backend_destroy()
2093          */
2094         BI_init *bi_init;
2095         BI_config       *bi_config;
2096         BI_open *bi_open;
2097         BI_close        *bi_close;
2098         BI_destroy      *bi_destroy;
2099
2100         /*
2101          * per database routines:
2102          * bi_db_init: called to initialize each database,
2103          *      called upon reading 'database <type>' 
2104          *      called only from backend_db_init()
2105          * bi_db_config: called to configure each database,
2106          *  called per database to handle per database options
2107          *      called only from read_config()
2108          * bi_db_open: called to open each database
2109          *      called once per database immediately AFTER bi_open()
2110          *      calls but before daemon startup.
2111          *  called only by backend_startup()
2112          * bi_db_close: called to close each database
2113          *      called once per database during shutdown but BEFORE
2114          *  any bi_close call.
2115          *  called only by backend_shutdown()
2116          * bi_db_destroy: called to destroy each database
2117          *  called once per database during shutdown AFTER all
2118          *  bi_close calls but before bi_destory calls.
2119          *  called only by backend_destory()
2120          */
2121         BI_db_init      *bi_db_init;
2122         BI_db_config    *bi_db_config;
2123         BI_db_open      *bi_db_open;
2124         BI_db_close     *bi_db_close;
2125         BI_db_destroy   *bi_db_destroy;
2126
2127         /* LDAP Operations Handling Routines */
2128         BI_op_bind      *bi_op_bind;
2129         BI_op_unbind    *bi_op_unbind;
2130         BI_op_search    *bi_op_search;
2131         BI_op_compare   *bi_op_compare;
2132         BI_op_modify    *bi_op_modify;
2133         BI_op_modrdn    *bi_op_modrdn;
2134         BI_op_add       *bi_op_add;
2135         BI_op_delete    *bi_op_delete;
2136         BI_op_abandon   *bi_op_abandon;
2137         BI_op_cancel    *bi_op_cancel;
2138
2139         /* Extended Operations Helper */
2140         BI_op_extended  *bi_extended;
2141
2142         /* Auxilary Functions */
2143         BI_operational          *bi_operational;
2144         BI_chk_referrals        *bi_chk_referrals;
2145         BI_chk_controls         *bi_chk_controls;
2146         BI_entry_get_rw         *bi_entry_get_rw;
2147         BI_entry_release_rw     *bi_entry_release_rw;
2148
2149         BI_has_subordinates     *bi_has_subordinates;
2150 #ifdef SLAP_OVERLAY_ACCESS
2151         BI_access_allowed       *bi_access_allowed;
2152         BI_acl_group            *bi_acl_group;
2153         BI_acl_attribute        *bi_acl_attribute;
2154 #endif /* SLAP_OVERLAY_ACCESS */
2155
2156         BI_connection_init      *bi_connection_init;
2157         BI_connection_destroy   *bi_connection_destroy;
2158
2159         /* hooks for slap tools */
2160         BI_tool_entry_open      *bi_tool_entry_open;
2161         BI_tool_entry_close     *bi_tool_entry_close;
2162         BI_tool_entry_first     *bi_tool_entry_first;
2163         BI_tool_entry_next      *bi_tool_entry_next;
2164         BI_tool_entry_get       *bi_tool_entry_get;
2165         BI_tool_entry_put       *bi_tool_entry_put;
2166         BI_tool_entry_reindex   *bi_tool_entry_reindex;
2167         BI_tool_sync            *bi_tool_sync;
2168         BI_tool_dn2id_get       *bi_tool_dn2id_get;
2169         BI_tool_id2entry_get    *bi_tool_id2entry_get;
2170         BI_tool_entry_modify    *bi_tool_entry_modify;
2171
2172 #define SLAP_INDEX_ADD_OP               0x0001
2173 #define SLAP_INDEX_DELETE_OP    0x0002
2174
2175         slap_mask_t     bi_flags; /* backend flags */
2176 #define SLAP_BFLAG_MONITOR                      0x0001U /* a monitor backend */
2177 #define SLAP_BFLAG_CONFIG                       0x0002U /* a config backend */
2178 #define SLAP_BFLAG_FRONTEND                     0x0004U /* the frontendDB */
2179 #define SLAP_BFLAG_NOLASTMODCMD         0x0010U
2180 #define SLAP_BFLAG_INCREMENT            0x0100U
2181 #define SLAP_BFLAG_ALIASES                      0x1000U
2182 #define SLAP_BFLAG_REFERRALS            0x2000U
2183 #define SLAP_BFLAG_SUBENTRIES           0x4000U
2184 #define SLAP_BFLAG_DYNAMIC                      0x8000U
2185
2186 #define SLAP_BFLAGS(be)         ((be)->bd_info->bi_flags)
2187 #define SLAP_MONITOR(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2188 #define SLAP_CONFIG(be)         (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2189 #define SLAP_FRONTEND(be)       (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2190 #define SLAP_INCREMENT(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2191 #define SLAP_ALIASES(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2192 #define SLAP_REFERRALS(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2193 #define SLAP_SUBENTRIES(be)     (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2194 #define SLAP_DYNAMIC(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2195 #define SLAP_NOLASTMODCMD(be)   (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2196 #define SLAP_LASTMODCMD(be)     (!SLAP_NOLASTMODCMD(be))
2197
2198         char    **bi_controls;          /* supported controls */
2199         char    bi_ctrls[SLAP_MAX_CIDS + 1];
2200
2201         unsigned int bi_nDB;    /* number of databases of this type */
2202         struct ConfigOCs *bi_cf_ocs;
2203         void    *bi_private;    /* anything the backend type needs */
2204         LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2205 };
2206
2207 #define c_authtype      c_authz.sai_method
2208 #define c_authmech      c_authz.sai_mech
2209 #define c_dn            c_authz.sai_dn
2210 #define c_ndn           c_authz.sai_ndn
2211 #define c_ssf                   c_authz.sai_ssf
2212 #define c_transport_ssf c_authz.sai_transport_ssf
2213 #define c_tls_ssf               c_authz.sai_tls_ssf
2214 #define c_sasl_ssf              c_authz.sai_sasl_ssf
2215
2216 #define o_authtype      o_authz.sai_method
2217 #define o_authmech      o_authz.sai_mech
2218 #define o_dn            o_authz.sai_dn
2219 #define o_ndn           o_authz.sai_ndn
2220 #define o_ssf                   o_authz.sai_ssf
2221 #define o_transport_ssf o_authz.sai_transport_ssf
2222 #define o_tls_ssf               o_authz.sai_tls_ssf
2223 #define o_sasl_ssf              o_authz.sai_sasl_ssf
2224
2225 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2226
2227 typedef struct slap_callback {
2228         struct slap_callback *sc_next;
2229         slap_response *sc_response;
2230         slap_response *sc_cleanup;
2231         void *sc_private;
2232 } slap_callback;
2233
2234 struct slap_overinfo;
2235
2236 typedef enum slap_operation_e {
2237         op_bind = 0,
2238         op_unbind,
2239         op_search,
2240         op_compare,
2241         op_modify,
2242         op_modrdn,
2243         op_add,
2244         op_delete,
2245         op_abandon,
2246         op_cancel,
2247         op_extended,
2248         op_aux_operational,
2249         op_aux_chk_referrals,
2250         op_aux_chk_controls,
2251         op_last
2252 } slap_operation_t;
2253
2254 typedef struct slap_overinst {
2255         BackendInfo on_bi;
2256         slap_response *on_response;
2257         struct slap_overinfo *on_info;
2258         struct slap_overinst *on_next;
2259 } slap_overinst;
2260
2261 typedef struct slap_overinfo {
2262         BackendInfo oi_bi;
2263         BackendInfo *oi_orig;
2264         struct slap_overinst *oi_list;
2265 } slap_overinfo;
2266
2267 /* Should successive callbacks in a chain be processed? */
2268 #define SLAP_CB_FREEME          0x4000
2269 #define SLAP_CB_CONTINUE        0x8000
2270
2271 /*
2272  * Paged Results state
2273  */
2274 typedef unsigned long PagedResultsCookie;
2275 typedef struct slap_paged_state {
2276         Backend *ps_be;
2277         ber_int_t ps_size;
2278         PagedResultsCookie ps_cookie;
2279         int ps_count;
2280 } PagedResultsState;
2281
2282 struct slap_csn_entry {
2283         struct berval ce_csn;
2284         unsigned long ce_opid;
2285         unsigned long ce_connid;
2286 #define SLAP_CSN_PENDING        1
2287 #define SLAP_CSN_COMMIT         2
2288         long ce_state;
2289         LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2290 };
2291
2292 /*
2293  * Caches the result of a backend_group check for ACL evaluation
2294  */
2295 typedef struct slap_gacl {
2296         struct slap_gacl *ga_next;
2297         Backend *ga_be;
2298         ObjectClass *ga_oc;
2299         AttributeDescription *ga_at;
2300         int ga_res;
2301         ber_len_t ga_len;
2302         char ga_ndn[1];
2303 } GroupAssertion;
2304
2305 struct slap_control_ids {
2306         int sc_assert;
2307         int sc_preRead;
2308         int sc_postRead;
2309         int sc_proxyAuthz;
2310         int sc_manageDIT;
2311         int sc_manageDSAit;
2312         int sc_modifyIncrement;
2313         int sc_noOp;
2314         int sc_pagedResults;
2315 #ifdef LDAP_DEVEL
2316         int sc_sortedResults;
2317 #endif
2318         int sc_valuesReturnFilter;
2319         int sc_permissiveModify;
2320         int sc_domainScope;
2321         int sc_treeDelete;
2322         int sc_searchOptions;
2323         int sc_subentries;
2324         int sc_LDAPsync;
2325 };
2326
2327 /*
2328  * represents an operation pending from an ldap client
2329  */
2330 typedef struct slap_op_header {
2331         unsigned long oh_opid;  /* id of this operation */
2332         unsigned long oh_connid; /* id of conn initiating this op */
2333         struct slap_conn *oh_conn;      /* connection spawning this op */
2334
2335         ber_int_t       oh_msgid;       /* msgid of the request */
2336         ber_int_t       oh_protocol;    /* version of the LDAP protocol used by client */
2337
2338         ldap_pvt_thread_t       oh_tid; /* thread handling this op */
2339
2340         void    *oh_threadctx;          /* thread pool thread context */
2341         void    *oh_tmpmemctx;          /* slab malloc context */
2342         BerMemoryFunctions *oh_tmpmfuncs;
2343
2344         char            oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2345
2346 #ifdef LDAP_SLAPI
2347         void    *oh_extensions;         /* NS-SLAPI plugin */
2348 #endif
2349 } Opheader;
2350
2351 typedef struct slap_op {
2352         Opheader *o_hdr;
2353
2354 #define o_opid o_hdr->oh_opid
2355 #define o_connid o_hdr->oh_connid
2356 #define o_conn o_hdr->oh_conn
2357 #define o_msgid o_hdr->oh_msgid
2358 #define o_protocol o_hdr->oh_protocol
2359 #define o_tid o_hdr->oh_tid
2360 #define o_threadctx o_hdr->oh_threadctx
2361 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2362 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2363
2364 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2365 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2366 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2367 #define o_tmpfree       o_tmpmfuncs->bmf_free
2368
2369 #define o_log_prefix o_hdr->oh_log_prefix
2370
2371         ber_tag_t       o_tag;          /* tag of the request */
2372         time_t          o_time;         /* time op was initiated */
2373         int                     o_tincr;        /* counter for multiple ops with same o_time */
2374
2375         BackendDB       *o_bd;  /* backend DB processing this op */
2376         struct berval   o_req_dn;       /* DN of target of request */
2377         struct berval   o_req_ndn;
2378
2379         union o_req_u {
2380                 req_add_s oq_add;
2381                 req_bind_s oq_bind;
2382                 req_compare_s oq_compare;
2383                 req_modify_s oq_modify;
2384                 req_modrdn_s oq_modrdn;
2385                 req_search_s oq_search;
2386                 req_abandon_s oq_abandon;
2387                 req_abandon_s oq_cancel;
2388                 req_extended_s oq_extended;
2389                 req_pwdexop_s oq_pwdexop;
2390         } o_request;
2391
2392 /* short hands for union members */
2393 #define oq_add o_request.oq_add
2394 #define oq_bind o_request.oq_bind
2395 #define oq_compare o_request.oq_compare
2396 #define oq_modify o_request.oq_modify
2397 #define oq_modrdn o_request.oq_modrdn
2398 #define oq_search o_request.oq_search
2399 #define oq_abandon o_request.oq_abandon
2400 #define oq_cancel o_request.oq_cancel
2401 #define oq_extended o_request.oq_extended
2402 #define oq_pwdexop o_request.oq_pwdexop
2403
2404 /* short hands for inner request members */
2405 #define orb_method oq_bind.rb_method
2406 #define orb_cred oq_bind.rb_cred
2407 #define orb_edn oq_bind.rb_edn
2408 #define orb_ssf oq_bind.rb_ssf
2409 #define orb_tmp_mech oq_bind.rb_tmp_mech
2410
2411 #define ors_scope oq_search.rs_scope
2412 #define ors_deref oq_search.rs_deref
2413 #define ors_slimit oq_search.rs_slimit
2414 #define ors_tlimit oq_search.rs_tlimit
2415 #define ors_limit oq_search.rs_limit
2416 #define ors_attrsonly oq_search.rs_attrsonly
2417 #define ors_attrs oq_search.rs_attrs
2418 #define ors_filter oq_search.rs_filter
2419 #define ors_filterstr oq_search.rs_filterstr
2420
2421 #define orr_newrdn oq_modrdn.rs_newrdn
2422 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2423 #define orr_newSup oq_modrdn.rs_newSup
2424 #define orr_nnewSup oq_modrdn.rs_nnewSup
2425 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2426
2427 #define orc_ava oq_compare.rs_ava
2428 #define ora_e oq_add.rs_e
2429 #define ora_modlist oq_add.rs_modlist
2430 #define orn_msgid oq_abandon.rs_msgid
2431 #define orm_modlist oq_modify.rs_modlist
2432 #define orm_increment oq_modify.rs_increment
2433
2434 #define ore_reqoid oq_extended.rs_reqoid
2435 #define ore_flags oq_extended.rs_flags
2436 #define ore_reqdata oq_extended.rs_reqdata
2437         volatile sig_atomic_t o_abandon;        /* abandon flag */
2438         volatile sig_atomic_t o_cancel;         /* cancel flag */
2439 #define SLAP_CANCEL_NONE                                0x00
2440 #define SLAP_CANCEL_REQ                                 0x01
2441 #define SLAP_CANCEL_ACK                                 0x02
2442 #define SLAP_CANCEL_DONE                                0x03
2443
2444         GroupAssertion *o_groups;
2445         char o_do_not_cache;    /* don't cache groups from this op */
2446         char o_is_auth_check;   /* authorization in progress */
2447
2448         char o_nocaching;
2449         char o_delete_glue_parent;
2450         char o_no_schema_check;
2451 #define get_no_schema_check(op)                 ((op)->o_no_schema_check)
2452
2453 #define SLAP_CONTROL_NONE       0
2454 #define SLAP_CONTROL_IGNORED    1
2455 #define SLAP_CONTROL_NONCRITICAL 2
2456 #define SLAP_CONTROL_CRITICAL   3
2457 #define SLAP_CONTROL_MASK       3
2458
2459 /* spare bits for simple flags */
2460 #define SLAP_CONTROL_SHIFT      4       /* shift to reach data bits */
2461 #define SLAP_CONTROL_DATA0      0x10
2462 #define SLAP_CONTROL_DATA1      0x20
2463 #define SLAP_CONTROL_DATA2      0x40
2464 #define SLAP_CONTROL_DATA3      0x80
2465
2466
2467 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2468
2469         char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2470         void **o_controls;              /* per-control state */
2471
2472 #define o_managedit                             o_ctrlflag[slap_cids.sc_manageDIT]
2473 #define get_manageDIT(op)               _SCM((op)->o_managedit)
2474
2475 #define o_managedsait   o_ctrlflag[slap_cids.sc_manageDSAit]
2476 #define get_manageDSAit(op)                             _SCM((op)->o_managedsait)
2477
2478 #define o_noop  o_ctrlflag[slap_cids.sc_noOp]
2479 #define o_proxy_authz   o_ctrlflag[slap_cids.sc_proxyAuthz]
2480 #define o_subentries    o_ctrlflag[slap_cids.sc_subentries]
2481
2482 #define get_subentries(op)                              _SCM((op)->o_subentries)
2483 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2484
2485 #define set_subentries_visibility(op)   ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2486 #define get_subentries_visibility(op)   (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2487
2488 #define o_assert        o_ctrlflag[slap_cids.sc_assert]
2489 #define get_assert(op)                                  ((int)(op)->o_assert)
2490 #define o_assertion     o_controls[slap_cids.sc_assert]
2491 #define get_assertion(op)                               ((op)->o_assertion)
2492
2493 #define o_valuesreturnfilter    o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2494 #define o_vrFilter      o_controls[slap_cids.sc_valuesReturnFilter]
2495
2496 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
2497 #define o_permissive_modify     o_ctrlflag[slap_cids.sc_permissiveModify]
2498 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
2499 #else
2500 #define get_permissiveModify(op)                (0)
2501 #endif
2502
2503 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
2504 #define o_domain_scope  o_ctrlflag[slap_cids.sc_domainScope]
2505 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
2506 #else
2507 #define get_domainScope(op)                             (0)
2508 #endif
2509
2510 #ifdef SLAP_CONTROL_X_TREE_DELETE
2511 #define o_tree_delete   o_ctrlflag[slap_cids.sc_treeDelete]
2512 #define get_treeDelete(op)                              ((int)(op)->o_tree_delete)
2513 #else
2514 #define get_treeDelete(op)                              (0)
2515 #endif
2516
2517 #define o_preread       o_ctrlflag[slap_cids.sc_preRead]
2518 #define o_postread      o_ctrlflag[slap_cids.sc_postRead]
2519
2520 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2521 #define o_postread_attrs        o_controls[slap_cids.sc_postRead]
2522
2523 #define o_pagedresults  o_ctrlflag[slap_cids.sc_pagedResults]
2524 #define o_pagedresults_state    o_controls[slap_cids.sc_pagedResults]
2525 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2526
2527 #ifdef LDAP_DEVEL
2528 #define o_sortedresults         o_ctrlflag[slap_cids.sc_sortedResults]
2529 #endif
2530
2531 #define o_sync                  o_ctrlflag[slap_cids.sc_LDAPsync]
2532
2533         AuthorizationInformation o_authz;
2534
2535         BerElement      *o_ber;         /* ber of the request */
2536         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2537         slap_callback *o_callback;      /* callback pointers */
2538         LDAPControl     **o_ctrls;       /* controls */
2539
2540         void    *o_private;     /* anything the backend needs */
2541
2542         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2543
2544 } Operation;
2545 #define OPERATION_BUFFER_SIZE   (sizeof(Operation)+sizeof(Opheader)+SLAP_MAX_CIDS*sizeof(void *))
2546
2547 #define send_ldap_error( op, rs, err, text ) do { \
2548                 (rs)->sr_err = err; (rs)->sr_text = text; \
2549                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2550         } while (0)
2551 #define send_ldap_discon( op, rs, err, text ) do { \
2552                 (rs)->sr_err = err; (rs)->sr_text = text; \
2553                 send_ldap_disconnect( op, rs ); \
2554         } while (0)
2555
2556 typedef void (SEND_LDAP_RESULT)(
2557         struct slap_op *op, struct slap_rep *rs);
2558 typedef int (SEND_SEARCH_ENTRY)(
2559         struct slap_op *op, struct slap_rep *rs);
2560 typedef int (SEND_SEARCH_REFERENCE)(
2561         struct slap_op *op, struct slap_rep *rs);
2562 typedef void (SEND_LDAP_EXTENDED)(
2563         struct slap_op *op, struct slap_rep *rs);
2564 typedef void (SEND_LDAP_INTERMEDIATE)(
2565         struct slap_op *op, struct slap_rep *rs);
2566
2567 #define send_ldap_result( op, rs ) \
2568         ((op)->o_conn->c_send_ldap_result)( op, rs )
2569 #define send_search_entry( op, rs ) \
2570         ((op)->o_conn->c_send_search_entry)( op, rs )
2571 #define send_search_reference( op, rs ) \
2572         ((op)->o_conn->c_send_search_reference)( op, rs )
2573 #define send_ldap_extended( op, rs ) \
2574         ((op)->o_conn->c_send_ldap_extended)( op, rs )
2575 #define send_ldap_intermediate( op, rs ) \
2576         ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2577
2578 typedef struct slap_listener Listener;
2579
2580 /*
2581  * represents a connection from an ldap client
2582  */
2583 typedef struct slap_conn {
2584         int                     c_struct_state; /* structure management state */
2585         int                     c_conn_state;   /* connection state */
2586         int                     c_conn_idx;             /* slot in connections array */
2587         const char      *c_close_reason; /* why connection is closing */
2588
2589         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2590         Sockbuf         *c_sb;                  /* ber connection stuff           */
2591
2592         /* only can be changed by connect_init */
2593         time_t          c_starttime;    /* when the connection was opened */
2594         time_t          c_activitytime; /* when the connection was last used */
2595         unsigned long           c_connid;       /* id of this connection for stats*/
2596
2597         struct berval   c_peer_domain;  /* DNS name of client */
2598         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2599         Listener        *c_listener;
2600 #define c_listener_url c_listener->sl_url       /* listener URL */
2601 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2602
2603         /* only can be changed by binding thread */
2604         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2605         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2606         struct berval   c_sasl_dn;      /* temporary storage */
2607         struct berval   c_sasl_authz_dn;        /* SASL proxy authz */
2608
2609         /* authorization backend */
2610         Backend *c_authz_backend;
2611
2612         AuthorizationInformation c_authz;
2613
2614         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2615
2616         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2617         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2618
2619         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2620         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2621
2622         BerElement      *c_currentber;  /* ber we're attempting to read */
2623         int             c_writewaiter;  /* true if writer is waiting */
2624
2625 #define CONN_IS_TLS     1
2626 #define CONN_IS_UDP     2
2627 #define CONN_IS_CLIENT  3
2628
2629 #ifdef LDAP_CONNECTIONLESS
2630         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2631 #endif
2632 #ifdef HAVE_TLS
2633         int     c_is_tls;               /* true if this LDAP over raw TLS */
2634         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2635 #endif
2636         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2637         int     c_sasl_done;            /* SASL completed once */
2638         void    *c_sasl_authctx;        /* SASL authentication context */
2639         void    *c_sasl_sockctx;        /* SASL security layer context */
2640         void    *c_sasl_extra;          /* SASL session extra stuff */
2641         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2642
2643         PagedResultsState c_pagedresults_state; /* paged result state */
2644
2645         long    c_n_ops_received;       /* num of ops received (next op_id) */
2646         long    c_n_ops_executing;      /* num of ops currently executing */
2647         long    c_n_ops_pending;        /* num of ops pending execution */
2648         long    c_n_ops_completed;      /* num of ops completed */
2649
2650         long    c_n_get;                /* num of get calls */
2651         long    c_n_read;               /* num of read calls */
2652         long    c_n_write;              /* num of write calls */
2653
2654         void    *c_pb;                  /* Netscape plugin */
2655         void    *c_extensions;          /* Netscape plugin */
2656
2657         /*
2658          * Client connection handling
2659          */
2660         ldap_pvt_thread_start_t *c_clientfunc;
2661         void    *c_clientarg;
2662
2663         /*
2664          * These are the "callbacks" that are available for back-ends to
2665          * supply data back to connected clients that are connected
2666          * through the "front-end".
2667          */
2668         SEND_LDAP_RESULT *c_send_ldap_result;
2669         SEND_SEARCH_ENTRY *c_send_search_entry;
2670         SEND_SEARCH_REFERENCE *c_send_search_reference;
2671         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2672 #ifdef LDAP_RES_INTERMEDIATE
2673         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2674 #endif
2675
2676 } Connection;
2677
2678 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2679 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2680         do { \
2681                 if ( ldap_debug & (level) ) \
2682                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2683                 if ( ldap_syslog & (level) ) \
2684                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2685                                 (arg2), (arg3) ); \
2686         } while (0)
2687 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2688 #elif defined(LDAP_DEBUG)
2689 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2690         do { \
2691                 if ( ldap_debug & (level) ) \
2692                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2693         } while (0)
2694 #define StatslogTest( level ) (ldap_debug & (level))
2695 #else
2696 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2697 #define StatslogTest( level ) (0)
2698 #endif
2699
2700 /*
2701  * listener; need to access it from monitor backend
2702  */
2703 struct slap_listener {
2704         struct berval sl_url;
2705         struct berval sl_name;
2706         mode_t  sl_perms;
2707 #ifdef HAVE_TLS
2708         int             sl_is_tls;
2709 #endif
2710 #ifdef LDAP_CONNECTIONLESS
2711         int     sl_is_udp;              /* UDP listener is also data port */
2712 #endif
2713         int     sl_is_mute;     /* Listening is temporarily disabled */
2714         ber_socket_t sl_sd;
2715         Sockaddr sl_sa;
2716 #define sl_addr sl_sa.sa_in_addr
2717 };
2718
2719 /*
2720  * Operation indices
2721  */
2722 enum {
2723         SLAP_OP_BIND = 0,
2724         SLAP_OP_UNBIND,
2725         SLAP_OP_ADD,
2726         SLAP_OP_DELETE,
2727         SLAP_OP_MODRDN,
2728         SLAP_OP_MODIFY,
2729         SLAP_OP_COMPARE,
2730         SLAP_OP_SEARCH,
2731         SLAP_OP_ABANDON,
2732         SLAP_OP_EXTENDED,
2733         SLAP_OP_LAST
2734 };
2735
2736 typedef struct slap_counters_t {
2737         ldap_pvt_thread_mutex_t sc_sent_mutex;
2738         ldap_pvt_mp_t           sc_bytes;
2739         ldap_pvt_mp_t           sc_pdu;
2740         ldap_pvt_mp_t           sc_entries;
2741         ldap_pvt_mp_t           sc_refs;
2742
2743         ldap_pvt_thread_mutex_t sc_ops_mutex;
2744         ldap_pvt_mp_t           sc_ops_completed;
2745         ldap_pvt_mp_t           sc_ops_initiated;
2746 #ifdef SLAPD_MONITOR
2747         ldap_pvt_mp_t           sc_ops_completed_[SLAP_OP_LAST];
2748         ldap_pvt_mp_t           sc_ops_initiated_[SLAP_OP_LAST];
2749 #endif /* SLAPD_MONITOR */
2750 } slap_counters_t;
2751
2752 /*
2753  * Better know these all around slapd
2754  */
2755 #define SLAP_LDAPDN_PRETTY 0x1
2756 #define SLAP_LDAPDN_MAXLEN 8192
2757
2758 /* number of response controls supported */
2759 #define SLAP_MAX_RESPONSE_CONTROLS   6
2760
2761 #ifdef LDAP_DEVEL
2762 #define SLAP_CTRL_HIDE                          0x00000000U
2763 #else
2764 #define SLAP_CTRL_HIDE                          0x80000000U
2765 #endif
2766
2767 #define SLAP_CTRL_REQUIRES_ROOT         0x40000000U /* for ManageDIT */
2768
2769 #define SLAP_CTRL_GLOBAL                        0x00800000U
2770 #define SLAP_CTRL_GLOBAL_SEARCH         0x00010000U     /* for NOOP */
2771
2772 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2773 #define SLAP_CTRL_ABANDON                       0x00000001U
2774 #define SLAP_CTRL_ADD                           0x00002002U
2775 #define SLAP_CTRL_BIND                          0x00000004U
2776 #define SLAP_CTRL_COMPARE                       0x00001008U
2777 #define SLAP_CTRL_DELETE                        0x00002010U
2778 #define SLAP_CTRL_MODIFY                        0x00002020U
2779 #define SLAP_CTRL_RENAME                        0x00002040U
2780 #define SLAP_CTRL_SEARCH                        0x00001080U
2781 #define SLAP_CTRL_UNBIND                        0x00000100U
2782
2783 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2784 #define SLAP_CTRL_UPDATE \
2785         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2786 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2787
2788 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2789         Operation *op,
2790         SlapReply *rs,
2791         LDAPControl *ctrl ));
2792
2793 #define SLAP_SLAB_SIZE  (1024*1024)
2794 #define SLAP_SLAB_STACK 1
2795 #define SLAP_SLAB_SOBLOCK 64
2796
2797 #define SLAP_ZONE_ALLOC 1
2798 #undef SLAP_ZONE_ALLOC
2799
2800 #ifdef LDAP_COMP_MATCH
2801 /*
2802  * Extensible Filter Definition
2803  *
2804  * MatchingRuleAssertion := SEQUENCE {
2805  *      matchingRule    [1] MatchingRuleId OPTIONAL,
2806  *      type            [2] AttributeDescription OPTIONAL,
2807  *      matchValue      [3] AssertionValue,
2808  *      dnAttributes    [4] BOOLEAN DEFAULT FALSE }
2809  *
2810  * Following ComponentFilter is contained in matchValue
2811  *
2812  * ComponentAssertion ::= SEQUENCE {
2813  *      component               ComponentReference (SIZE(1..MAX)) OPTIONAL
2814  *      useDefaultValues        BOOLEAN DEFAULT TRUE,
2815  *      rule                    MATCHING-RULE.&id,
2816  *      value                   MATCHING-RULE.&AssertionType }
2817  *
2818  * ComponentFilter ::= CHOICE {
2819  *      item    [0] ComponentAssertion,
2820  *      and     [1] SEQUENCE OF ComponentFilter,
2821  *      or      [2] SEQUENCE OF ComponentFilter,
2822  *      not     [3] ComponentFilter }
2823  */
2824
2825 #define LDAP_COMPREF_IDENTIFIER         ((ber_tag_t) 0x80U)
2826 #define LDAP_COMPREF_FROM_BEGINNING     ((ber_tag_t) 0x81U)
2827 #define LDAP_COMPREF_COUNT              ((ber_tag_t) 0x82U)
2828 #define LDAP_COMPREF_FROM_END           ((ber_tag_t) 0x83U)
2829 #define LDAP_COMPREF_CONTENT            ((ber_tag_t) 0x84U)
2830 #define LDAP_COMPREF_SELECT             ((ber_tag_t) 0x85U)
2831 #define LDAP_COMPREF_ALL                ((ber_tag_t) 0x86U)
2832 #define LDAP_COMPREF_DEFINED            ((ber_tag_t) 0x87U)
2833 #define LDAP_COMPREF_UNDEFINED          ((ber_tag_t) 0x88U)
2834
2835 #define LDAP_COMP_FILTER_AND            ((ber_tag_t) 0xa0U)
2836 #define LDAP_COMP_FILTER_OR             ((ber_tag_t) 0xa1U)
2837 #define LDAP_COMP_FILTER_NOT            ((ber_tag_t) 0xa2U)
2838 #define LDAP_COMP_FILTER_ITEM           ((ber_tag_t) 0xa3U)
2839 #define LDAP_COMP_FILTER_UNDEFINED      ((ber_tag_t) 0xa4U)
2840
2841 typedef struct slap_component_id {
2842         int     ci_type;
2843         struct slap_component_id *ci_next;
2844
2845         union comp_id_value{
2846                 BerValue        ci_identifier;
2847                 ber_int_t       ci_from_beginning;
2848                 ber_int_t       ci_count;
2849                 ber_int_t       ci_from_end;
2850                 ber_int_t       ci_content;
2851                 BerValue        ci_select_value;
2852                 char            ci_all;
2853         } ci_val;
2854 } ComponentId;
2855
2856 typedef struct slap_component_reference {
2857         ComponentId     *cr_list;
2858         ComponentId     *cr_curr;
2859         struct berval   cr_string;
2860         int cr_len;
2861         /* Component Indexing */
2862         int             cr_asn_type_id;
2863         slap_mask_t     cr_indexmask;
2864         AttributeDescription* cr_ad;
2865         BerVarray       cr_nvals;
2866         struct slap_component_reference* cr_next;
2867 } ComponentReference;
2868
2869 typedef struct slap_component_assertion {
2870         ComponentReference      *ca_comp_ref;
2871         ber_int_t               ca_use_def;
2872         MatchingRule            *ca_ma_rule;
2873         struct berval           ca_ma_value;
2874         ComponentData           ca_comp_data; /* componentized assertion */
2875         struct slap_component_filter    *ca_cf;
2876         MatchingRuleAssertion   *ca_mra;
2877 } ComponentAssertion;
2878
2879 typedef struct slap_component_filter {
2880         ber_tag_t cf_choice;
2881         union cf_un_u {
2882                 ber_int_t cf_un_result;
2883                 ComponentAssertion *cf_un_ca;
2884                 struct slap_component_filter *cf_un_complex;
2885         } cf_un;
2886
2887 #define cf_ca           cf_un.cf_un_ca
2888 #define cf_result       cf_un.cf_un_result
2889 #define cf_and          cf_un.cf_un_complex
2890 #define cf_or           cf_un.cf_un_complex
2891 #define cf_not          cf_un.cf_un_complex
2892 #define cf_any          cf_un.cf_un_complex
2893         
2894         struct slap_component_filter *cf_next;
2895 } ComponentFilter;
2896
2897 typedef struct slap_component_assertion_value {
2898         char* cav_buf;
2899         char* cav_ptr;
2900         char* cav_end;
2901 } ComponentAssertionValue;
2902
2903 typedef int encoder_func LDAP_P((
2904         void* b,
2905         void* comp));
2906
2907 struct slap_component_syntax_info;
2908
2909 typedef int gser_decoder_func LDAP_P((
2910         void* mem_op,
2911         void* b,
2912         struct slap_component_syntax_info** comp_syn_info,
2913         int* len,
2914         int mode));
2915
2916 typedef int comp_free_func LDAP_P((
2917         void* b));
2918
2919 typedef int ber_decoder_func LDAP_P((
2920         void* mem_op,
2921         void* b,
2922         int tag,
2923         int elmtLen,
2924         struct slap_component_syntax_info* comp_syn_info,
2925         int* len,
2926         int mode));
2927
2928 typedef int ber_tag_decoder_func LDAP_P((
2929         void* mem_op,
2930         void* b,
2931         struct slap_component_syntax_info* comp_syn_info,
2932         int* len,
2933         int mode));
2934
2935 typedef void* extract_component_from_id_func LDAP_P((
2936         void* mem_op,
2937         ComponentReference* cr,
2938         void* comp ));
2939
2940 typedef void* convert_attr_to_comp_func LDAP_P ((
2941         Attribute* a,
2942         Syntax* syn,
2943         struct berval* bv ));
2944
2945 typedef void* alloc_nibble_func LDAP_P ((
2946         int initial_size,
2947         int increment_size ));
2948
2949 typedef void free_nibble_func LDAP_P ((
2950         void* nm ));
2951
2952 struct slap_component_syntax_info;                                                                          
2953 typedef void convert_assert_to_comp_func LDAP_P ((
2954         void *mem_op,
2955         struct slap_component_syntax_info* csi_attr,
2956         struct berval* bv,
2957         struct slap_component_syntax_info** csi,
2958         int* len,
2959         int mode ));
2960                                                                           
2961 typedef int convert_asn_to_ldap_func LDAP_P ((
2962         struct slap_component_syntax_info* csi,
2963         struct berval *bv ));
2964
2965 typedef void free_component_func LDAP_P ((
2966         void* mem_op));
2967
2968 typedef int test_component_func LDAP_P ((
2969         void* attr_mem_op,
2970         void* assert_mem_op,
2971         struct slap_component_syntax_info* csi,
2972         struct slap_component_assertion* ca));
2973
2974 typedef void* test_membership_func LDAP_P ((
2975         void* in ));
2976
2977 typedef void* get_component_info_func LDAP_P ((
2978         int in ));
2979
2980 struct slap_component_syntax_info;
2981
2982 typedef int component_encoder_func LDAP_P ((
2983         void* mem_op,
2984         struct slap_component_syntax_info* csi,
2985         struct berval* nvals ));
2986         
2987 typedef int allcomponent_matching_func LDAP_P((
2988         char* oid,
2989         struct slap_component_syntax_info* comp1,
2990         struct slap_component_syntax_info* comp));
2991
2992 typedef struct slap_component_desc {
2993         /* Don't change the order of following four fields */
2994         int             cd_tag;
2995         AttributeType   *cd_comp_type;
2996         struct berval   cd_ad_type;/* ad_type, ad_cname */
2997         struct berval   cd_ad_cname;/* ad_type, ad_cname */
2998         unsigned        cd_flags; /*ad_flags*/
2999         int             cd_type;
3000         int             cd_type_id;
3001         encoder_func            *cd_ldap_encoder;
3002         encoder_func            *cd_gser_encoder;
3003         encoder_func            *cd_ber_encoder;
3004         gser_decoder_func       *cd_gser_decoder;
3005         ber_decoder_func        *cd_ber_decoder;
3006         comp_free_func          *cd_free;
3007         extract_component_from_id_func*  cd_extract_i;
3008         allcomponent_matching_func      *cd_all_match;
3009 } ComponentDesc;
3010
3011 typedef struct slap_component_syntax_info {
3012         Syntax* csi_syntax;
3013         ComponentDesc* csi_comp_desc;
3014 } ComponentSyntaxInfo;
3015
3016 #endif
3017
3018 /* slab heap data structures */
3019
3020 struct slab_object {
3021     void *so_ptr;
3022         int so_blockhead;
3023     LDAP_LIST_ENTRY(slab_object) so_link;
3024 };
3025
3026 struct slab_heap {
3027     void *sh_base;
3028     void *sh_last;
3029     void *sh_end;
3030         int sh_stack;
3031         int sh_maxorder;
3032     unsigned char **sh_map;
3033     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3034         LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3035 };
3036
3037 #ifdef SLAP_ZONE_ALLOC
3038 #define SLAP_ZONE_SIZE 0x80000          /* 512KB */
3039 #define SLAP_ZONE_SHIFT 19
3040 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3041 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3042 #define SLAP_ZONE_DELTA 0x800000        /* 8MB */
3043 #define SLAP_ZONE_ZOBLOCK 256
3044
3045 struct zone_object {
3046         void *zo_ptr;
3047         int zo_siz;
3048         int zo_idx;
3049         int zo_blockhead;
3050         LDAP_LIST_ENTRY(zone_object) zo_link;
3051 };
3052
3053 struct zone_latency_history {
3054         double zlh_latency;
3055         LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3056 };
3057
3058 struct zone_heap {
3059         int zh_fd;
3060         int zh_zonesize;
3061         int zh_zoneorder;
3062         int zh_numzones;
3063         int zh_maxzones;
3064         int zh_deltazones;
3065         void **zh_zones;
3066         ldap_pvt_thread_rdwr_t *zh_znlock;
3067         Avlnode *zh_zonetree;
3068         unsigned char ***zh_maps;
3069         int *zh_seqno;
3070         LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3071         LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3072         ldap_pvt_thread_mutex_t zh_mutex;
3073         ldap_pvt_thread_rdwr_t zh_lock;
3074         double zh_ema_latency;
3075         unsigned long zh_ema_samples;
3076         LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3077                                 zh_latency_history_queue;
3078         int zh_latency_history_qlen;
3079         int zh_latency_jump;
3080         int zh_swapping;
3081 };
3082 #endif
3083
3084 #define SLAP_BACKEND_INIT_MODULE(b) \
3085         static BackendInfo bi;  \
3086         int \
3087         init_module( int argc, char *argv[] ) \
3088         { \
3089                 bi.bi_type = #b ; \
3090                 bi.bi_init = b ## _back_initialize; \
3091                 backend_add( &bi ); \
3092                 return 0; \
3093         }
3094
3095 LDAP_END_DECL
3096
3097 #include "proto-slap.h"
3098
3099 #endif /* _SLAP_H_ */