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