]> git.sur5r.net Git - openldap/blob - servers/slapd/slap.h
Fix binary v lang_range typo
[openldap] / servers / slapd / slap.h
1 /* slap.h - stand alone ldap server include file */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6  */
7
8 #ifndef _SLAP_H_
9 #define _SLAP_H_
10
11 #include "ldap_defaults.h"
12
13 #include <stdio.h>
14 #include <ac/stdlib.h>
15
16 #include <sys/types.h>
17 #include <ac/syslog.h>
18 #include <ac/regex.h>
19 #include <ac/socket.h>
20 #include <ac/time.h>
21 #include <ac/param.h>
22
23 #include "avl.h"
24
25 #ifndef ldap_debug
26 #define ldap_debug slap_debug
27 #endif
28
29 #include "ldap_log.h"
30
31 #include <ldap.h>
32 #include <ldap_schema.h>
33
34 #include "ldap_pvt_thread.h"
35 #include "ldap_queue.h"
36
37 LDAP_BEGIN_DECL
38 /*
39  * SLAPD Memory allocation macros
40  *
41  * Unlike ch_*() routines, these routines do not assert() upon
42  * allocation error.  They are intended to be used instead of
43  * ch_*() routines where the caller has implemented proper
44  * checking for and handling of allocation errors.
45  *
46  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
47  */
48 #define SLAP_MALLOC(s)      ber_memalloc((s))
49 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
50 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
51 #define SLAP_FREE(p)        ber_memfree((p))
52 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
53 #define SLAP_STRDUP(s)      ber_strdup((s))
54 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
55
56 #ifdef f_next
57 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
58 #endif
59
60 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
61 #define SLAPD_ANONYMOUS "cn=anonymous"
62
63 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
64  *
65  * This is a value used internally by the backends. It is needed to allow
66  * adding values that already exist without getting an error as required by
67  * modrdn when the new rdn was already an attribute value itself.
68  * JCG 05/1999 (gomez@engr.sgi.com)
69  */
70 #define SLAP_MOD_SOFTADD        0x1000
71
72 #define MAXREMATCHES (10)
73
74 #define SLAP_MAX_WORKER_THREADS         (32)
75
76 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
77 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
78
79 #define SLAP_TEXT_BUFLEN (256)
80
81 /* psuedo error code indicating abandoned operation */
82 #define SLAPD_ABANDON (-1)
83
84 /* psuedo error code indicating disconnect */
85 #define SLAPD_DISCONNECT (-2)
86
87
88 /* We assume "C" locale, that is US-ASCII */
89 #define ASCII_SPACE(c)  ( (c) == ' ' )
90 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
91 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
92 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
93 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
94 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
95 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
96
97 #define SLAP_NIBBLE(c) ((c)&0x0f)
98 #define SLAP_ESCAPE_CHAR ('\\')
99 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
100 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
101
102 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
103         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
104
105 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
106 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
107 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
108 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
109 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
110
111 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
112 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
113 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
114 #define OID_SEPARATOR(c)        ( (c) == '.' )
115 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
116
117 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
118 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
119
120 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
121 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
122
123 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
124
125 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
126         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
127         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
128         (c) == '?' || (c) == ' ' || (c) == '=' )
129 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
130
131 /* must match in schema_init.c */
132 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
133 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
134 #define SLAPD_GROUP_ATTR                "member"
135 #define SLAPD_GROUP_CLASS               "groupOfNames"
136 #define SLAPD_ROLE_ATTR                 "roleOccupant"
137 #define SLAPD_ROLE_CLASS                "organizationalRole"
138
139 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
140 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
141
142 /* change this to "OpenLDAPset" */
143 #define SLAPD_ACI_SET_ATTR              "template"
144
145 #define SLAPD_TOP_OID                   "2.5.6.0"
146
147 LDAP_SLAPD_V (int) slap_debug;
148
149 typedef unsigned long slap_mask_t;
150
151 /* Security Strength Factor */
152 typedef unsigned slap_ssf_t;
153
154 typedef struct slap_ssf_set {
155         slap_ssf_t sss_ssf;
156         slap_ssf_t sss_transport;
157         slap_ssf_t sss_tls;
158         slap_ssf_t sss_sasl;
159         slap_ssf_t sss_update_ssf;
160         slap_ssf_t sss_update_transport;
161         slap_ssf_t sss_update_tls;
162         slap_ssf_t sss_update_sasl;
163 } slap_ssf_set_t;
164
165 /*
166  * Index types
167  */
168 #define SLAP_INDEX_TYPE           0x00FFUL
169 #define SLAP_INDEX_UNDEFINED      0x0001UL
170 #define SLAP_INDEX_PRESENT        0x0002UL
171 #define SLAP_INDEX_EQUALITY       0x0004UL
172 #define SLAP_INDEX_APPROX         0x0008UL
173 #define SLAP_INDEX_SUBSTR         0x0010UL
174 #define SLAP_INDEX_EXTENDED               0x0020UL
175
176 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
177
178 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
179
180 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
181
182 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL ) 
183 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
184 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
185 #define SLAP_INDEX_SUBSTR_DEFAULT \
186         ( SLAP_INDEX_SUBSTR \
187         | SLAP_INDEX_SUBSTR_INITIAL \
188         | SLAP_INDEX_SUBSTR_ANY \
189         | SLAP_INDEX_SUBSTR_FINAL )
190
191 #define SLAP_INDEX_SUBSTR_MINLEN        2
192 #define SLAP_INDEX_SUBSTR_MAXLEN        4
193 #define SLAP_INDEX_SUBSTR_STEP  2
194
195 #define SLAP_INDEX_FLAGS         0xF000UL
196 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
197 #define SLAP_INDEX_NOLANG        0x2000UL /* don't use index w/ lang */
198
199 /*
200  * there is a single index for each attribute.  these prefixes ensure
201  * that there is no collision among keys.
202  */
203 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
204 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
205 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
206 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
207 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
208 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
209
210 #define SLAP_SYNTAX_MATCHINGRULES_OID   "1.3.6.1.4.1.1466.115.121.1.30"
211 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID  "1.3.6.1.4.1.1466.115.121.1.3"
212 #define SLAP_SYNTAX_OBJECTCLASSES_OID   "1.3.6.1.4.1.1466.115.121.1.37"
213
214 /*
215  * represents schema information for a database
216  */
217 #define SLAP_SCHERR_OUTOFMEM            1
218 #define SLAP_SCHERR_CLASS_NOT_FOUND     2
219 #define SLAP_SCHERR_CLASS_BAD_USAGE     3
220 #define SLAP_SCHERR_ATTR_NOT_FOUND      4
221 #define SLAP_SCHERR_ATTR_BAD_USAGE      5
222 #define SLAP_SCHERR_DUP_CLASS           6
223 #define SLAP_SCHERR_DUP_ATTR            7
224 #define SLAP_SCHERR_DUP_SYNTAX          8
225 #define SLAP_SCHERR_DUP_RULE            9
226 #define SLAP_SCHERR_NO_NAME             10
227 #define SLAP_SCHERR_ATTR_INCOMPLETE     11
228 #define SLAP_SCHERR_MR_NOT_FOUND        12
229 #define SLAP_SCHERR_SYN_NOT_FOUND       13
230 #define SLAP_SCHERR_MR_INCOMPLETE       14
231 #define SLAP_SCHERR_NOT_SUPPORTED       15
232 #define SLAP_SCHERR_BAD_DESCR           16
233 #define SLAP_SCHERR_OIDM                        17
234 #define SLAP_SCHERR_LAST                        SLAP_SCHERR_OIDM
235
236 typedef union slap_sockaddr {
237         struct sockaddr sa_addr;
238         struct sockaddr_in sa_in_addr;
239 #ifdef LDAP_PF_INET6
240         struct sockaddr_in6 sa_in6_addr;
241 #endif
242 #ifdef LDAP_PF_LOCAL
243         struct sockaddr_un sa_un_addr;
244 #endif
245 } Sockaddr;
246
247 typedef struct slap_oid_macro {
248         struct berval som_oid;
249         char **som_names;
250         struct slap_oid_macro *som_next;
251 } OidMacro;
252
253 /* forward declarations */
254 struct slap_syntax;
255 struct slap_matching_rule;
256
257 typedef int slap_syntax_validate_func LDAP_P((
258         struct slap_syntax *syntax,
259         struct berval * in));
260
261 typedef int slap_syntax_transform_func LDAP_P((
262         struct slap_syntax *syntax,
263         struct berval * in,
264         struct berval * out));
265
266 typedef struct slap_syntax {
267         LDAPSyntax                      ssyn_syn;
268 #define ssyn_oid                ssyn_syn.syn_oid
269 #define ssyn_desc               ssyn_syn.syn_desc
270 #define ssyn_extensions         ssyn_syn.syn_extensions
271         ber_len_t       ssyn_oidlen;
272
273         unsigned int ssyn_flags;
274
275 #define SLAP_SYNTAX_NONE        0x0000U
276 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
277 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
278 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
279 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
280
281         slap_syntax_validate_func       *ssyn_validate;
282         slap_syntax_transform_func      *ssyn_normalize;
283         slap_syntax_transform_func      *ssyn_pretty;
284
285 #ifdef SLAPD_BINARY_CONVERSION
286         /* convert to and from binary */
287         slap_syntax_transform_func      *ssyn_ber2str;
288         slap_syntax_transform_func      *ssyn_str2ber;
289 #endif
290
291         struct slap_syntax              *ssyn_next;
292 } Syntax;
293
294 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
295 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
296 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
297 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
298 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
299
300 /* X -> Y Converter */
301 typedef int slap_mr_convert_func LDAP_P((
302         struct berval * in,
303         struct berval * out ));
304
305 /* Normalizer */
306 typedef int slap_mr_normalize_func LDAP_P((
307         slap_mask_t use,
308         struct slap_syntax *syntax, /* NULL if in is asserted value */
309         struct slap_matching_rule *mr,
310         struct berval * in,
311         struct berval * out ));
312
313 /* Match (compare) function */
314 typedef int slap_mr_match_func LDAP_P((
315         int *match,
316         slap_mask_t use,
317         struct slap_syntax *syntax,     /* syntax of stored value */
318         struct slap_matching_rule *mr,
319         struct berval * value,
320         void * assertValue ));
321
322 /* Index generation function */
323 typedef int slap_mr_indexer_func LDAP_P((
324         slap_mask_t use,
325         slap_mask_t mask,
326         struct slap_syntax *syntax,     /* syntax of stored value */
327         struct slap_matching_rule *mr,
328         struct berval *prefix,
329         BerVarray values,
330         BerVarray *keys ));
331
332 /* Filter index function */
333 typedef int slap_mr_filter_func LDAP_P((
334         slap_mask_t use,
335         slap_mask_t mask,
336         struct slap_syntax *syntax,     /* syntax of stored value */
337         struct slap_matching_rule *mr,
338         struct berval *prefix,
339         void * assertValue,
340         BerVarray *keys ));
341
342 typedef struct slap_matching_rule {
343         LDAPMatchingRule                smr_mrule;
344         ber_len_t                               smr_oidlen;
345         slap_mask_t                             smr_usage;
346
347 #define SLAP_MR_HIDE                    0x8000U
348
349 #define SLAP_MR_TYPE_MASK               0x0F00U
350 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
351 #define SLAP_MR_USAGE                   0x000FU
352
353 #define SLAP_MR_NONE                    0x0000U
354 #define SLAP_MR_EQUALITY                0x0100U
355 #define SLAP_MR_ORDERING                0x0200U
356 #define SLAP_MR_SUBSTR                  0x0400U
357 #define SLAP_MR_EXT                             0x0800U
358
359 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
360 #define SLAP_MR_DN_FOLD                 0x0008U
361
362 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
363 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
364 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
365
366 /*
367  * normally the provided value is expected to conform to
368  * assertion syntax specified in the matching rule, however
369  * at times (such as during individual value modification),
370  * the provided value is expected to conform to the
371  * attribute's value syntax.
372  */
373 #define SLAP_MR_ASSERTION_SYNTAX_MATCH                  0x0000U
374 #define SLAP_MR_VALUE_SYNTAX_MATCH                              0x0001U
375 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH    0x0003U
376
377 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
378         (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
379 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
380         ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
381
382 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
383         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
384                 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
385 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
386         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
387                 == SLAP_MR_VALUE_SYNTAX_MATCH)
388
389         Syntax                                  *smr_syntax;
390         slap_mr_convert_func    *smr_convert;
391         slap_mr_normalize_func  *smr_normalize;
392         slap_mr_match_func              *smr_match;
393         slap_mr_indexer_func    *smr_indexer;
394         slap_mr_filter_func             *smr_filter;
395
396         struct slap_matching_rule       *smr_associated;
397         struct slap_matching_rule       *smr_next;
398
399 #define smr_oid                         smr_mrule.mr_oid
400 #define smr_names                       smr_mrule.mr_names
401 #define smr_desc                        smr_mrule.mr_desc
402 #define smr_obsolete            smr_mrule.mr_obsolete
403 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
404 #define smr_extensions          smr_mrule.mr_extensions
405 } MatchingRule;
406
407 struct slap_backend_db;
408 struct slap_entry;
409 struct slap_attr;
410
411 typedef int (AttributeTypeSchemaCheckFN)(
412         struct slap_backend_db *be,
413         struct slap_entry *e,
414         struct slap_attr *attr,
415         const char** text,
416         char *textbuf, size_t textlen );
417
418 typedef struct slap_attribute_type {
419         LDAPAttributeType               sat_atype;
420         struct berval                   sat_cname;
421         struct slap_attribute_type      *sat_sup;
422         struct slap_attribute_type      **sat_subtypes;
423         MatchingRule                    *sat_equality;
424         MatchingRule                    *sat_approx;
425         MatchingRule                    *sat_ordering;
426         MatchingRule                    *sat_substr;
427         Syntax                                  *sat_syntax;
428
429         AttributeTypeSchemaCheckFN      *sat_check;
430         slap_mask_t                                     sat_flags;
431
432         struct slap_attribute_type      *sat_next;
433
434 #define sat_oid                         sat_atype.at_oid
435 #define sat_names                       sat_atype.at_names
436 #define sat_desc                        sat_atype.at_desc
437 #define sat_obsolete            sat_atype.at_obsolete
438 #define sat_sup_oid                     sat_atype.at_sup_oid
439 #define sat_equality_oid        sat_atype.at_equality_oid
440 #define sat_ordering_oid        sat_atype.at_ordering_oid
441 #define sat_substr_oid          sat_atype.at_substr_oid
442 #define sat_syntax_oid          sat_atype.at_syntax_oid
443 #define sat_single_value        sat_atype.at_single_value
444 #define sat_collective          sat_atype.at_collective
445 #define sat_no_user_mod         sat_atype.at_no_user_mod
446 #define sat_usage                       sat_atype.at_usage
447 #define sat_extensions          sat_atype.at_extensions
448
449         struct slap_attr_desc           *sat_ad;
450         ldap_pvt_thread_mutex_t         sat_ad_mutex;
451 } AttributeType;
452
453 #define is_at_operational(at)   ((at)->sat_usage)
454 #define is_at_single_value(at)  ((at)->sat_single_value)
455 #define is_at_collective(at)    ((at)->sat_collective)
456 #define is_at_obsolete(at)              ((at)->sat_obsolete)
457 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
458
459 struct slap_object_class;
460
461 typedef int (ObjectClassSchemaCheckFN)(
462         struct slap_backend_db *be,
463         struct slap_entry *e,
464         struct slap_object_class *oc,
465         const char** text,
466         char *textbuf, size_t textlen );
467
468 typedef struct slap_object_class {
469         LDAPObjectClass         soc_oclass;
470         struct slap_object_class        **soc_sups;
471         AttributeType                           **soc_required;
472         AttributeType                           **soc_allowed;
473         ObjectClassSchemaCheckFN        *soc_check;
474         slap_mask_t                                     soc_flags;
475 #define soc_oid                         soc_oclass.oc_oid
476 #define soc_names                       soc_oclass.oc_names
477 #define soc_desc                        soc_oclass.oc_desc
478 #define soc_obsolete            soc_oclass.oc_obsolete
479 #define soc_sup_oids            soc_oclass.oc_sup_oids
480 #define soc_kind                        soc_oclass.oc_kind
481 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
482 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
483 #define soc_extensions          soc_oclass.oc_extensions
484
485         struct slap_object_class        *soc_next;
486 } ObjectClass;
487
488 #define SLAP_OC_ALIAS           0x01
489 #define SLAP_OC_REFERRAL        0x02
490 #define SLAP_OC_SUBENTRY        0x04
491 #define SLAP_OC_DYNAMICOBJECT   0x08
492 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x10
493 #define SLAP_OC__MASK           0x1F
494 #define SLAP_OC__END            0x20
495
496 #ifdef LDAP_EXTENDED_SCHEMA
497 /*
498  * DIT content rule
499  */
500 typedef struct slap_content_rule {
501         LDAPContentRule         scr_crule;
502         ObjectClass                     *scr_sclass;
503         ObjectClass                     **scr_auxiliaries;      /* optional */
504         AttributeType           **scr_required;         /* optional */
505         AttributeType           **scr_allowed;          /* optional */
506         AttributeType           **scr_precluded;        /* optional */
507 #define scr_oid                 scr_crule.cr_oid
508 #define scr_names               scr_crule.cr_names
509 #define scr_desc                scr_crule.cr_desc
510 #define scr_obsolete            soc_oclass.cr_obsolete
511 #define scr_cr_oids_aux         soc_oclass.cr_oc_oids_aux
512 #define scr_cr_oids_must        soc_oclass.cr_at_oids_must
513 #define scr_cr_oids_may         soc_oclass.cr_at_oids_may
514 #define scr_cr_oids_not         soc_oclass.cr_at_oids_not
515 } ContentRule;
516 #endif
517
518 /*
519  * represents a recognized attribute description ( type + options )
520  */
521 typedef struct slap_attr_desc {
522         struct slap_attr_desc *ad_next;
523         AttributeType *ad_type;         /* attribute type, must be specified */
524         struct berval ad_cname;         /* canonical name, must be specified */
525         struct berval ad_lang;          /* empty if no language tags */
526         unsigned ad_flags;
527 #define SLAP_DESC_NONE                  0x00U
528 #define SLAP_DESC_BINARY                0x01U
529 #define SLAP_DESC_LANG_RANGE    0x80U
530 } AttributeDescription;
531
532 typedef struct slap_attr_name {
533         struct berval an_name;
534         AttributeDescription *an_desc;
535         ObjectClass *an_oc;
536 } AttributeName;
537
538 #define slap_ad_is_lang(ad)                     ( (ad)->ad_lang.bv_len != 0 )
539 #define slap_ad_is_lang_range(ad)       \
540         ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
541 #define slap_ad_is_binary(ad)           \
542         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
543
544 /*
545  * pointers to schema elements used internally
546  */
547 struct slap_internal_schema {
548         /* objectClass */
549         ObjectClass *si_oc_top;
550         ObjectClass *si_oc_extensibleObject;
551         ObjectClass *si_oc_alias;
552         ObjectClass *si_oc_referral;
553         ObjectClass *si_oc_rootdse;
554         ObjectClass *si_oc_subentry;
555         ObjectClass *si_oc_subschema;
556         ObjectClass *si_oc_monitor;
557         ObjectClass *si_oc_collectiveAttributeSubentry;
558         ObjectClass *si_oc_dynamicObject;
559
560         /* objectClass attribute descriptions */
561         AttributeDescription *si_ad_objectClass;
562
563         /* operational attribute descriptions */
564         AttributeDescription *si_ad_structuralObjectClass;
565         AttributeDescription *si_ad_creatorsName;
566         AttributeDescription *si_ad_createTimestamp;
567         AttributeDescription *si_ad_modifiersName;
568         AttributeDescription *si_ad_modifyTimestamp;
569         AttributeDescription *si_ad_hasSubordinates;
570         AttributeDescription *si_ad_subschemaSubentry;
571         AttributeDescription *si_ad_collectiveSubentries;
572         AttributeDescription *si_ad_collectiveExclusions;
573         AttributeDescription *si_ad_entryUUID;
574         AttributeDescription *si_ad_entryCSN;
575
576         /* root DSE attribute descriptions */
577         AttributeDescription *si_ad_altServer;
578         AttributeDescription *si_ad_namingContexts;
579         AttributeDescription *si_ad_supportedControl;
580         AttributeDescription *si_ad_supportedExtension;
581         AttributeDescription *si_ad_supportedLDAPVersion;
582         AttributeDescription *si_ad_supportedSASLMechanisms;
583         AttributeDescription *si_ad_supportedFeatures;
584         AttributeDescription *si_ad_vendorName;
585         AttributeDescription *si_ad_vendorVersion;
586
587         /* subentry attribute descriptions */
588         AttributeDescription *si_ad_administrativeRole;
589         AttributeDescription *si_ad_subtreeSpecification;
590
591         /* subschema subentry attribute descriptions */
592         AttributeDescription *si_ad_ditStructureRules;
593         AttributeDescription *si_ad_ditContentRules;
594         AttributeDescription *si_ad_nameForms;
595         AttributeDescription *si_ad_objectClasses;
596         AttributeDescription *si_ad_attributeTypes;
597         AttributeDescription *si_ad_ldapSyntaxes;
598         AttributeDescription *si_ad_matchingRules;
599         AttributeDescription *si_ad_matchingRuleUse;
600
601         /* Aliases & Referrals */
602         AttributeDescription *si_ad_aliasedObjectName;
603         AttributeDescription *si_ad_ref;
604
605         /* Access Control Internals */
606         AttributeDescription *si_ad_entry;
607         AttributeDescription *si_ad_children;
608 #ifdef SLAPD_ACI_ENABLED
609         AttributeDescription *si_ad_aci;
610 #endif
611
612         /* dynamic entries */
613         AttributeDescription *si_ad_entryTtl;
614         AttributeDescription *si_ad_dynamicSubtrees;
615
616         /* Other attributes descriptions */
617         AttributeDescription *si_ad_distinguishedName;
618         AttributeDescription *si_ad_name;
619         AttributeDescription *si_ad_cn;
620         AttributeDescription *si_ad_userPassword;
621 #ifdef SLAPD_AUTHPASSWD
622         AttributeDescription *si_ad_authPassword;
623 #endif
624 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
625         AttributeDescription *si_ad_krbName;
626 #endif
627
628         /* Undefined Attribute Type */
629         AttributeType   *si_at_undefined;
630
631         /* Matching Rules */
632         MatchingRule    *si_mr_distinguishedNameMatch;
633         MatchingRule    *si_mr_integerMatch;
634
635         /* Syntaxes */
636         Syntax          *si_syn_distinguishedName;
637         Syntax          *si_syn_integer;
638 };
639
640 typedef struct slap_attr_assertion {
641         AttributeDescription    *aa_desc;
642         struct berval aa_value;
643 } AttributeAssertion;
644
645 typedef struct slap_ss_assertion {
646         AttributeDescription    *sa_desc;
647         struct berval           sa_initial;
648         struct berval           *sa_any;
649         struct berval           sa_final;
650 } SubstringsAssertion;
651
652 typedef struct slap_mr_assertion {
653         MatchingRule            *ma_rule;       /* optional */
654         struct berval           ma_rule_text;  /* optional */
655         AttributeDescription    *ma_desc;       /* optional */
656         int                                             ma_dnattrs; /* boolean */
657         struct berval           ma_value;       /* required */
658 } MatchingRuleAssertion;
659
660 /*
661  * represents a search filter
662  */
663 typedef struct slap_filter {
664         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
665 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
666 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
667 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
668
669         union f_un_u {
670                 /* precomputed result */
671                 ber_int_t f_un_result;
672
673                 /* DN */
674                 struct berval *f_un_dn;
675
676                 /* present */
677                 AttributeDescription *f_un_desc;
678
679                 /* simple value assertion */
680                 AttributeAssertion *f_un_ava;
681
682                 /* substring assertion */
683                 SubstringsAssertion *f_un_ssa;
684
685                 /* matching rule assertion */
686                 MatchingRuleAssertion *f_un_mra;
687
688 #define f_dn                    f_un.f_un_dn
689 #define f_desc                  f_un.f_un_desc
690 #define f_ava                   f_un.f_un_ava
691 #define f_av_desc               f_un.f_un_ava->aa_desc
692 #define f_av_value              f_un.f_un_ava->aa_value
693 #define f_sub                   f_un.f_un_ssa
694 #define f_sub_desc              f_un.f_un_ssa->sa_desc
695 #define f_sub_initial   f_un.f_un_ssa->sa_initial
696 #define f_sub_any               f_un.f_un_ssa->sa_any
697 #define f_sub_final             f_un.f_un_ssa->sa_final
698 #define f_mra                   f_un.f_un_mra
699 #define f_mr_rule               f_un.f_un_mra->ma_rule
700 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
701 #define f_mr_desc               f_un.f_un_mra->ma_desc
702 #define f_mr_value              f_un.f_un_mra->ma_value
703 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
704
705                 /* and, or, not */
706                 struct slap_filter *f_un_complex;
707         } f_un;
708
709 #define f_result        f_un.f_un_result
710 #define f_and           f_un.f_un_complex
711 #define f_or            f_un.f_un_complex
712 #define f_not           f_un.f_un_complex
713 #define f_list          f_un.f_un_complex
714
715         struct slap_filter      *f_next;
716 } Filter;
717
718 /* compare routines can return undefined */
719 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
720
721 /*
722  * represents an attribute (description + values)
723  */
724 typedef struct slap_attr {
725         AttributeDescription *a_desc;
726         BerVarray       a_vals;
727         struct slap_attr        *a_next;
728         unsigned a_flags;
729 #define SLAP_ATTR_IXADD         0x1U
730 #define SLAP_ATTR_IXDEL         0x2U
731 } Attribute;
732
733
734 /*
735  * the id used in the indexes to refer to an entry
736  */
737 typedef unsigned long   ID;
738 #define NOID    ((ID)~0)
739
740 /*
741  * represents an entry in core
742  */
743 typedef struct slap_entry {
744         /*
745          * The ID field should only be changed before entry is
746          * inserted into a cache.  The ID value is backend
747          * specific.
748          */
749         ID              e_id;
750
751         struct berval e_name;   /* name (DN) of this entry */
752         struct berval e_nname;  /* normalized name (DN) of this entry */
753
754         /* for migration purposes */
755 #define e_dn e_name.bv_val
756 #define e_ndn e_nname.bv_val
757
758         Attribute       *e_attrs;       /* list of attributes + values */
759
760         slap_mask_t     e_ocflags;
761
762         struct berval   e_bv;           /* For entry_encode/entry_decode */
763
764         /* for use by the backend for any purpose */
765         void*   e_private;
766 } Entry;
767
768 /*
769  * A list of LDAPMods
770  */
771 typedef struct slap_mod {
772         int sm_op;
773         AttributeDescription *sm_desc;
774         struct berval sm_type;
775         BerVarray sm_bvalues;
776 } Modification;
777
778 typedef struct slap_mod_list {
779         Modification sml_mod;
780 #define sml_op          sml_mod.sm_op
781 #define sml_desc        sml_mod.sm_desc
782 #define sml_type        sml_mod.sm_type
783 #define sml_bvalues     sml_mod.sm_bvalues
784         struct slap_mod_list *sml_next;
785 } Modifications;
786
787 typedef struct slap_ldap_modlist {
788         LDAPMod ml_mod;
789         struct slap_ldap_modlist *ml_next;
790 #define ml_op           ml_mod.mod_op
791 #define ml_type         ml_mod.mod_type
792 #define ml_values       ml_mod.mod_values
793 #define ml_bvalues      ml_mod.mod_bvalues
794 } LDAPModList;
795
796 /*
797  * represents an access control list
798  */
799 typedef enum slap_access_e {
800         ACL_INVALID_ACCESS = -1,
801         ACL_NONE = 0,
802         ACL_AUTH,
803         ACL_COMPARE,
804         ACL_SEARCH,
805         ACL_READ,
806         ACL_WRITE
807 } slap_access_t;
808
809 typedef enum slap_control_e {
810         ACL_INVALID_CONTROL     = 0,
811         ACL_STOP,
812         ACL_CONTINUE,
813         ACL_BREAK
814 } slap_control_t;
815
816 typedef enum slap_style_e {
817         ACL_STYLE_REGEX = 0,
818         ACL_STYLE_BASE,
819         ACL_STYLE_ONE,
820         ACL_STYLE_SUBTREE,
821         ACL_STYLE_CHILDREN,
822         ACL_STYLE_ATTROF,
823
824         /* alternate names */
825         ACL_STYLE_EXACT = ACL_STYLE_BASE
826 } slap_style_t;
827
828 typedef struct slap_authz_info {
829         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
830         struct berval   sai_mech;               /* SASL Mechanism */
831         struct berval   sai_dn;                 /* DN for reporting purposes */
832         struct berval   sai_ndn;                /* Normalized DN */
833
834         /* Security Strength Factors */
835         slap_ssf_t      sai_ssf;                        /* Overall SSF */
836         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
837         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
838         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
839 } AuthorizationInformation;
840
841 /* the "by" part */
842 typedef struct slap_access {
843         slap_control_t a_type;
844
845 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
846
847 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
848 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
849 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
850 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
851 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
852 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
853
854 #define ACL_PRIV_MASK                   0x00ffUL
855
856 /* priv flags */
857 #define ACL_PRIV_LEVEL                  0x1000UL
858 #define ACL_PRIV_ADDITIVE               0x2000UL
859 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
860
861 /* invalid privs */
862 #define ACL_PRIV_INVALID                0x0UL
863
864 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
865 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
866 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
867 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
868
869 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
870 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
871
872 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
873
874 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
875
876 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
877 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
878 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
879
880 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
881 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
882 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
883 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
884 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
885 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
886
887 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
888 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
889 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
890 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
891 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
892 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
893 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
894
895 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
896 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
897 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
898 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
899 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
900 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
901
902         slap_mask_t     a_access_mask;
903
904         AuthorizationInformation        a_authz;
905 #define a_dn_pat        a_authz.sai_dn
906
907         slap_style_t a_dn_style;
908         AttributeDescription    *a_dn_at;
909         int                     a_dn_self;
910
911         slap_style_t a_peername_style;
912         struct berval   a_peername_pat;
913         slap_style_t a_sockname_style;
914         struct berval   a_sockname_pat;
915
916         slap_style_t a_domain_style;
917         struct berval   a_domain_pat;
918         slap_style_t a_sockurl_style;
919         struct berval   a_sockurl_pat;
920         slap_style_t a_set_style;
921         struct berval   a_set_pat;
922
923 #ifdef SLAPD_ACI_ENABLED
924         AttributeDescription    *a_aci_at;
925 #endif
926
927         /* ACL Groups */
928         slap_style_t a_group_style;
929         struct berval   a_group_pat;
930         ObjectClass                             *a_group_oc;
931         AttributeDescription    *a_group_at;
932
933         struct slap_access      *a_next;
934 } Access;
935
936 /* the "to" part */
937 typedef struct slap_acl {
938         /* "to" part: the entries this acl applies to */
939         Filter          *acl_filter;
940         slap_style_t acl_dn_style;
941         regex_t         acl_dn_re;
942         struct berval   acl_dn_pat;
943         AttributeName   *acl_attrs;
944
945         /* "by" part: list of who has what access to the entries */
946         Access  *acl_access;
947
948         struct slap_acl *acl_next;
949 } AccessControl;
950
951 /*
952  * replog moddn param structure
953  */
954 struct slap_replog_moddn {
955         struct berval *newrdn;
956         int     deloldrdn;
957         struct berval *newsup;
958 };
959
960 /*
961  * Backend-info
962  * represents a backend 
963  */
964
965 typedef struct slap_backend_info BackendInfo;   /* per backend type */
966 typedef struct slap_backend_db BackendDB;               /* per backend database */
967
968 LDAP_SLAPD_V (int) nBackendInfo;
969 LDAP_SLAPD_V (int) nBackendDB;
970 LDAP_SLAPD_V (BackendInfo *) backendInfo;
971 LDAP_SLAPD_V (BackendDB *) backendDB;
972
973 LDAP_SLAPD_V (int) slapMode;    
974 #define SLAP_UNDEFINED_MODE     0x0000
975 #define SLAP_SERVER_MODE        0x0001
976 #define SLAP_TOOL_MODE          0x0002
977 #define SLAP_MODE                       0x0003
978
979 #define SLAP_TRUNCATE_MODE      0x0100
980
981 struct slap_replica_info {
982         char *ri_host;                          /* supersedes be_replica */
983         struct berval **ri_nsuffix;     /* array of suffixes this replica accepts */
984 };
985
986 struct slap_limits_set {
987         /* time limits */
988         int     lms_t_soft;
989         int     lms_t_hard;
990
991         /* size limits */
992         int     lms_s_soft;
993         int     lms_s_hard;
994         int     lms_s_unchecked;
995 };
996
997 struct slap_limits {
998         int     lm_type;        /* type of pattern */
999 #define SLAP_LIMITS_UNDEFINED   0x0000
1000 #define SLAP_LIMITS_EXACT       0x0001
1001 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1002 #define SLAP_LIMITS_ONE         0x0002
1003 #define SLAP_LIMITS_SUBTREE     0x0003
1004 #define SLAP_LIMITS_CHILDREN    0x0004
1005 #define SLAP_LIMITS_REGEX       0x0005
1006 #define SLAP_LIMITS_ANONYMOUS   0x0006
1007 #define SLAP_LIMITS_USERS       0x0007
1008         regex_t lm_dn_regex;            /* regex data for REGEX */
1009
1010         /*
1011          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1012          * pattern for REGEX; NULL for ANONYMOUS, USERS
1013          */
1014         struct berval lm_dn_pat;
1015
1016         struct slap_limits_set  lm_limits;
1017 };
1018
1019 /* temporary aliases */
1020 typedef BackendDB Backend;
1021 #define nbackends nBackendDB
1022 #define backends backendDB
1023
1024 struct slap_backend_db {
1025         BackendInfo     *bd_info;       /* pointer to shared backend info */
1026
1027         /* BackendInfo accessors */
1028 #define         be_config       bd_info->bi_db_config
1029 #define         be_type         bd_info->bi_type
1030
1031 #define         be_bind         bd_info->bi_op_bind
1032 #define         be_unbind       bd_info->bi_op_unbind
1033 #define         be_add          bd_info->bi_op_add
1034 #define         be_compare      bd_info->bi_op_compare
1035 #define         be_delete       bd_info->bi_op_delete
1036 #define         be_modify       bd_info->bi_op_modify
1037 #define         be_modrdn       bd_info->bi_op_modrdn
1038 #define         be_search       bd_info->bi_op_search
1039
1040 #define         be_extended     bd_info->bi_extended
1041
1042 #define         be_release      bd_info->bi_entry_release_rw
1043 #define         be_chk_referrals        bd_info->bi_chk_referrals
1044 #define         be_group        bd_info->bi_acl_group
1045 #define         be_attribute    bd_info->bi_acl_attribute
1046 #define         be_operational  bd_info->bi_operational
1047
1048 #define         be_controls     bd_info->bi_controls
1049
1050 #define         be_connection_init      bd_info->bi_connection_init
1051 #define         be_connection_destroy   bd_info->bi_connection_destroy
1052
1053 #ifdef SLAPD_TOOLS
1054 #define         be_entry_open bd_info->bi_tool_entry_open
1055 #define         be_entry_close bd_info->bi_tool_entry_close
1056 #define         be_entry_first bd_info->bi_tool_entry_first
1057 #define         be_entry_next bd_info->bi_tool_entry_next
1058 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1059 #define         be_entry_get bd_info->bi_tool_entry_get
1060 #define         be_entry_put bd_info->bi_tool_entry_put
1061 #define         be_sync bd_info->bi_tool_sync
1062 #endif
1063
1064 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1065 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1066 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1067 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1068 #define SLAP_BFLAG_ALIASES              0x0100U
1069 #define SLAP_BFLAG_REFERRALS    0x0200U
1070 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1071 #define SLAP_BFLAG_MONITOR              0x1000U
1072 #define SLAP_BFLAG_DYNAMIC              0x2000U
1073         slap_mask_t     be_flags;
1074 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1075 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1076 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1077 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1078 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1079 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1080
1081         slap_mask_t     be_restrictops;         /* restriction operations */
1082 #define SLAP_RESTRICT_OP_ADD            0x0001U
1083 #define SLAP_RESTRICT_OP_BIND           0x0002U
1084 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1085 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1086 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1087 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1088 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1089 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1090
1091 #define SLAP_RESTRICT_OP_READS  \
1092         ( SLAP_RESTRICT_OP_COMPARE    \
1093         | SLAP_RESTRICT_OP_SEARCH )
1094 #define SLAP_RESTRICT_OP_WRITES \
1095         ( SLAP_RESTRICT_OP_ADD    \
1096         | SLAP_RESTRICT_OP_DELETE \
1097         | SLAP_RESTRICT_OP_MODIFY \
1098         | SLAP_RESTRICT_OP_RENAME )
1099
1100 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1101 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1102 #define SLAP_ALLOW_BIND_ANON_DN         0x0003U /* dn should be empty */
1103
1104 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1105 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1106 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1107
1108 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1109 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1110
1111         slap_mask_t     be_requires;    /* pre-operation requirements */
1112 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1113 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1114 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1115 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1116 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1117
1118         /* Required Security Strength Factor */
1119         slap_ssf_set_t be_ssf_set;
1120
1121         /* these should be renamed from be_ to bd_ */
1122         struct berval **be_suffix;      /* the DN suffixes of data in this backend */
1123         struct berval **be_nsuffix;     /* the normalized DN suffixes in this backend */
1124         struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1125         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1126         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1127         struct berval be_rootpw;        /* the magic "root" password for this db        */
1128         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
1129 #define be_sizelimit    be_def_limit.lms_s_soft
1130 #define be_timelimit    be_def_limit.lms_t_soft
1131         struct slap_limits_set be_def_limit; /* default limits */
1132         struct slap_limits **be_limits; /* regex-based size and time limits */
1133         AccessControl *be_acl;  /* access control list for this backend    */
1134         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1135         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1136         char    *be_replogfile; /* replication log file (in master)        */
1137         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1138         BerVarray       be_update_refs; /* where to refer modifying clients to */
1139         char    *be_realm;
1140
1141         void    *be_private;    /* anything the backend database needs     */
1142 };
1143
1144 struct slap_conn;
1145 struct slap_op;
1146
1147 /* Backend function typedefs */
1148 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1149 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1150         const char *fname, int lineno,
1151         int argc, char **argv));
1152 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1153 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1154 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1155
1156 typedef int (BI_db_init) LDAP_P((Backend *bd));
1157 typedef int (BI_db_config) LDAP_P((Backend *bd,
1158         const char *fname, int lineno,
1159         int argc, char **argv));
1160 typedef int (BI_db_open) LDAP_P((Backend *bd));
1161 typedef int (BI_db_close) LDAP_P((Backend *bd));
1162 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1163
1164 typedef int (BI_op_bind)  LDAP_P(( BackendDB *bd,
1165                 struct slap_conn *c, struct slap_op *o,
1166                 struct berval *dn, struct berval *ndn, int method,
1167                 struct berval *cred, struct berval *edn ));
1168 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1169                 struct slap_conn *c, struct slap_op *o ));
1170 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1171                 struct slap_conn *c, struct slap_op *o,
1172                 struct berval *base, struct berval *nbase,
1173                 int scope, int deref,
1174                 int slimit, int tlimit,
1175                 Filter *f, struct berval *filterstr,
1176                 AttributeName *attrs, int attrsonly));
1177 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1178                 struct slap_conn *c, struct slap_op *o,
1179                 struct berval *dn, struct berval *ndn,
1180                 AttributeAssertion *ava));
1181 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1182                 struct slap_conn *c, struct slap_op *o,
1183                 struct berval *dn, struct berval *ndn,
1184                 Modifications *m));
1185 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1186                 struct slap_conn *c, struct slap_op *o,
1187                 struct berval *dn, struct berval *ndn,
1188                 struct berval *newrdn, struct berval *nnewrdn,
1189                 int deleteoldrdn,
1190                 struct berval *newSup, struct berval *nnewSup ));
1191 typedef int (BI_op_add)    LDAP_P((BackendDB *bd,
1192                 struct slap_conn *c, struct slap_op *o,
1193                 Entry *e));
1194 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1195                 struct slap_conn *c, struct slap_op *o,
1196                 struct berval *dn, struct berval *ndn));
1197 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1198                 struct slap_conn *c, struct slap_op *o,
1199                 ber_int_t msgid));
1200
1201 typedef int (BI_op_extended) LDAP_P((
1202     BackendDB           *be,
1203     struct slap_conn    *conn,
1204     struct slap_op              *op,
1205         const char              *reqoid,
1206     struct berval * reqdata,
1207         char            **rspoid,
1208     struct berval ** rspdata,
1209         LDAPControl *** rspctrls,
1210         const char **   text,
1211         BerVarray *refs ));
1212
1213 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1214                 struct slap_conn *c, struct slap_op *o,
1215                 Entry *e, int rw));
1216
1217 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1218                 struct slap_conn *c, struct slap_op *o,
1219                 struct berval *dn, struct berval *ndn,
1220                 const char **text ));
1221
1222 typedef int (BI_acl_group)  LDAP_P((Backend *bd,
1223                 struct slap_conn *c, struct slap_op *o,
1224                 Entry *e,
1225                 struct berval *bdn,
1226                 struct berval *edn,
1227                 ObjectClass *group_oc,
1228                 AttributeDescription *group_at ));
1229
1230 typedef int (BI_acl_attribute)  LDAP_P((Backend *bd,
1231                 struct slap_conn *c, struct slap_op *o,
1232                 Entry *e, struct berval *edn,
1233                 AttributeDescription *entry_at,
1234                 BerVarray *vals ));
1235
1236 typedef int (BI_operational)  LDAP_P((Backend *bd,
1237                 struct slap_conn *c, struct slap_op *o,
1238                 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1239
1240 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1241                 struct slap_conn *c));
1242 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1243                 struct slap_conn *c));
1244
1245 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1246 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1247 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1248 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1249 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1250 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e, 
1251                         struct berval *text ));
1252 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1253 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1254
1255 struct slap_backend_info {
1256         char    *bi_type; /* type of backend */
1257
1258         /*
1259          * per backend type routines:
1260          * bi_init: called to allocate a backend_info structure,
1261          *              called once BEFORE configuration file is read.
1262          *              bi_init() initializes this structure hence is
1263          *              called directly from be_initialize()
1264          * bi_config: called per 'backend' specific option
1265          *              all such options must before any 'database' options
1266          *              bi_config() is called only from read_config()
1267          * bi_open: called to open each database, called
1268          *              once AFTER configuration file is read but
1269          *              BEFORE any bi_db_open() calls.
1270          *              bi_open() is called from backend_startup()
1271          * bi_close: called to close each database, called
1272          *              once during shutdown after all bi_db_close calls.
1273          *              bi_close() is called from backend_shutdown()
1274          * bi_destroy: called to destroy each database, called
1275          *              once during shutdown after all bi_db_destroy calls.
1276          *              bi_destory() is called from backend_destroy()
1277          */
1278         BI_init *bi_init;
1279         BI_config       *bi_config;
1280         BI_open *bi_open;
1281         BI_close        *bi_close;
1282         BI_destroy      *bi_destroy;
1283
1284         /*
1285          * per database routines:
1286          * bi_db_init: called to initialize each database,
1287          *      called upon reading 'database <type>' 
1288          *      called only from backend_db_init()
1289          * bi_db_config: called to configure each database,
1290          *  called per database to handle per database options
1291          *      called only from read_config()
1292          * bi_db_open: called to open each database
1293          *      called once per database immediately AFTER bi_open()
1294          *      calls but before daemon startup.
1295          *  called only by backend_startup()
1296          * bi_db_close: called to close each database
1297          *      called once per database during shutdown but BEFORE
1298          *  any bi_close call.
1299          *  called only by backend_shutdown()
1300          * bi_db_destroy: called to destroy each database
1301          *  called once per database during shutdown AFTER all
1302          *  bi_close calls but before bi_destory calls.
1303          *  called only by backend_destory()
1304          */
1305         BI_db_init      *bi_db_init;
1306         BI_db_config    *bi_db_config;
1307         BI_db_open      *bi_db_open;
1308         BI_db_close     *bi_db_close;
1309         BI_db_destroy   *bi_db_destroy;
1310
1311         /* LDAP Operations Handling Routines */
1312         BI_op_bind      *bi_op_bind;
1313         BI_op_unbind    *bi_op_unbind;
1314         BI_op_search    *bi_op_search;
1315         BI_op_compare   *bi_op_compare;
1316         BI_op_modify    *bi_op_modify;
1317         BI_op_modrdn    *bi_op_modrdn;
1318         BI_op_add       *bi_op_add;
1319         BI_op_delete    *bi_op_delete;
1320         BI_op_abandon   *bi_op_abandon;
1321
1322         /* Extended Operations Helper */
1323         BI_op_extended  *bi_extended;
1324
1325         /* Auxilary Functions */
1326         BI_entry_release_rw     *bi_entry_release_rw;
1327         BI_chk_referrals        *bi_chk_referrals;
1328
1329         BI_acl_group    *bi_acl_group;
1330         BI_acl_attribute        *bi_acl_attribute;
1331
1332         BI_operational  *bi_operational;
1333
1334         BI_connection_init      *bi_connection_init;
1335         BI_connection_destroy   *bi_connection_destroy;
1336
1337         /* hooks for slap tools */
1338         BI_tool_entry_open      *bi_tool_entry_open;
1339         BI_tool_entry_close     *bi_tool_entry_close;
1340         BI_tool_entry_first     *bi_tool_entry_first;
1341         BI_tool_entry_next      *bi_tool_entry_next;
1342         BI_tool_entry_get       *bi_tool_entry_get;
1343         BI_tool_entry_put       *bi_tool_entry_put;
1344         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1345         BI_tool_sync            *bi_tool_sync;
1346
1347 #define SLAP_INDEX_ADD_OP               0x0001
1348 #define SLAP_INDEX_DELETE_OP    0x0002
1349
1350         char **bi_controls;             /* supported controls */
1351
1352         unsigned int bi_nDB;    /* number of databases of this type */
1353         void    *bi_private;    /* anything the backend type needs */
1354 };
1355
1356 #define c_authtype      c_authz.sai_method
1357 #define c_authmech      c_authz.sai_mech
1358 #define c_dn            c_authz.sai_dn
1359 #define c_ndn           c_authz.sai_ndn
1360 #define c_ssf                   c_authz.sai_ssf
1361 #define c_transport_ssf c_authz.sai_transport_ssf
1362 #define c_tls_ssf               c_authz.sai_tls_ssf
1363 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1364
1365 #define o_authtype      o_authz.sai_method
1366 #define o_authmech      o_authz.sai_mech
1367 #define o_dn            o_authz.sai_dn
1368 #define o_ndn           o_authz.sai_ndn
1369 #define o_ssf                   o_authz.sai_ssf
1370 #define o_transport_ssf o_authz.sai_transport_ssf
1371 #define o_tls_ssf               o_authz.sai_tls_ssf
1372 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1373
1374 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1375         ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1376         BerVarray, const char *, struct berval *,
1377         struct berval *, LDAPControl ** );
1378
1379 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1380         ber_int_t, const char *, const char *, BerVarray,
1381         LDAPControl **, int nentries);
1382
1383 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1384         struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1385
1386 typedef struct slap_callback {
1387         slap_response *sc_response;
1388         slap_sresult *sc_sresult;
1389         slap_sendentry *sc_sendentry;
1390         void *sc_private;
1391 } slap_callback;
1392
1393 /*
1394  * represents an operation pending from an ldap client
1395  */
1396 typedef struct slap_op {
1397         ber_int_t       o_opid;         /* id of this operation           */
1398         ber_int_t       o_msgid;        /* msgid of the request           */
1399         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1400         ber_tag_t       o_tag;          /* tag of the request             */
1401         time_t          o_time;         /* time op was initiated          */
1402         unsigned long   o_connid; /* id of conn initiating this op  */
1403         ldap_pvt_thread_t       o_tid;  /* thread handling this op        */
1404
1405 #define SLAP_NO_CONTROL 0
1406 #define SLAP_NONCRITICAL_CONTROL 1
1407 #define SLAP_CRITICAL_CONTROL 2
1408         char o_managedsait;
1409         char o_subentries;
1410         char o_subentries_visibility;
1411         char o_noop;
1412
1413         char o_abandon; /* abandon flag */
1414         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
1415
1416 #ifdef LDAP_CONNECTIONLESS
1417         Sockaddr        o_peeraddr;     /* UDP peer address               */
1418 #endif
1419         AuthorizationInformation o_authz;
1420
1421         BerElement      *o_ber;         /* ber of the request             */
1422         slap_callback   *o_callback;    /* callback pointers */
1423         LDAPControl     **o_ctrls;       /* controls */
1424
1425         void    *o_private;     /* anything the backend needs */
1426
1427         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1428 } Operation;
1429
1430 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1431 #define get_subentries(op)                              ((int)(op)->o_subentries)
1432 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1433
1434 /*
1435  * Caches the result of a backend_group check for ACL evaluation
1436  */
1437 typedef struct slap_gacl {
1438         struct slap_gacl *ga_next;
1439         Backend *ga_be;
1440         ObjectClass *ga_oc;
1441         AttributeDescription *ga_at;
1442         int ga_res;
1443         ber_len_t ga_len;
1444         char ga_ndn[1];
1445 } GroupAssertion;
1446
1447 /*
1448  * represents a connection from an ldap client
1449  */
1450 typedef struct slap_conn {
1451         int                     c_struct_state; /* structure management state */
1452         int                     c_conn_state;   /* connection state */
1453
1454         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1455         Sockbuf         *c_sb;                  /* ber connection stuff           */
1456
1457         /* only can be changed by connect_init */
1458         time_t          c_starttime;    /* when the connection was opened */
1459         time_t          c_activitytime; /* when the connection was last used */
1460         unsigned long           c_connid;       /* id of this connection for stats*/
1461
1462         struct berval   c_listener_url; /* listener URL */
1463         struct berval   c_peer_domain;  /* DNS name of client */
1464         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
1465         struct berval   c_sock_name;    /* sock name (trans=addr:port) */
1466
1467         /* only can be changed by binding thread */
1468         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1469         struct berval   c_sasl_bind_mech;                       /* mech in progress */
1470         struct berval   c_cdn;
1471
1472         /* authentication backend */
1473         Backend *c_authc_backend;
1474
1475         /* authorization backend - normally same as c_authc_backend */
1476         Backend *c_authz_backend;
1477
1478         AuthorizationInformation c_authz;
1479         GroupAssertion *c_groups;
1480
1481         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1482
1483         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
1484         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
1485
1486         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1487         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1488
1489         BerElement      *c_currentber;  /* ber we're attempting to read */
1490         int             c_writewaiter;  /* true if writer is waiting */
1491
1492 #ifdef LDAP_CONNECTIONLESS
1493         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
1494 #endif
1495 #ifdef HAVE_TLS
1496         int     c_is_tls;               /* true if this LDAP over raw TLS */
1497         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1498 #endif
1499         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1500         void    *c_sasl_context;        /* SASL session context */
1501         void    *c_sasl_extra;          /* SASL session extra stuff */
1502
1503         long    c_n_ops_received;       /* num of ops received (next op_id) */
1504         long    c_n_ops_executing;      /* num of ops currently executing */
1505         long    c_n_ops_pending;        /* num of ops pending execution */
1506         long    c_n_ops_completed;      /* num of ops completed */
1507
1508         long    c_n_get;                /* num of get calls */
1509         long    c_n_read;               /* num of read calls */
1510         long    c_n_write;              /* num of write calls */
1511 } Connection;
1512
1513 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1514 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1515         do { \
1516                 if ( ldap_debug & (level) ) \
1517                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1518                 if ( ldap_syslog & (level) ) \
1519                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1520                                 (arg2), (arg3) ); \
1521         } while (0)
1522 #else
1523 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1524 #endif
1525
1526
1527 #define SASLREGEX_REPLACE 10
1528 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1529 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1530
1531 typedef struct sasl_regexp {
1532   char *sr_match;                                                       /* regexp match pattern */
1533   char *sr_replace;                                                     /* regexp replace pattern */
1534   regex_t sr_workspace;                                         /* workspace for regexp engine */
1535   regmatch_t sr_strings[SASLREGEX_REPLACE];     /* strings matching $1,$2 ... */
1536   int sr_offset[SASLREGEX_REPLACE+2];           /* offsets of $1,$2... in *replace */
1537 } SaslRegexp_t;
1538
1539 /*
1540  * listener; need to access it from monitor backend
1541  */
1542 typedef struct slap_listener {
1543         char* sl_url;
1544         char* sl_name;
1545 #ifdef HAVE_TLS
1546         int             sl_is_tls;
1547 #endif
1548 #ifdef LDAP_CONNECTIONLESS
1549         int     sl_is_udp;              /* UDP listener is also data port */
1550 #endif
1551         ber_socket_t sl_sd;
1552         Sockaddr sl_sa;
1553 #define sl_addr sl_sa.sa_in_addr
1554 } Listener;
1555
1556 LDAP_END_DECL
1557
1558 #include "proto-slap.h"
1559
1560 #endif /* _SLAP_H_ */