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