]> git.sur5r.net Git - openldap/blob - servers/slapd/slap.h
Add search no-op support.
[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        *soc_check;
475         slap_mask_t                                     soc_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 #define SLAP_OC_ALIAS           0x01
490 #define SLAP_OC_REFERRAL        0x02
491 #define SLAP_OC_SUBENTRY        0x04
492 #define SLAP_OC_DYNAMICOBJECT   0x08
493 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x10
494 #define SLAP_OC__MASK           0x1F
495 #define SLAP_OC__END            0x20
496
497 #ifdef LDAP_EXTENDED_SCHEMA
498 /*
499  * DIT content rule
500  */
501 typedef struct slap_content_rule {
502         LDAPContentRule         scr_crule;
503         ObjectClass                     *scr_sclass;
504         ObjectClass                     **scr_auxiliaries;      /* optional */
505         AttributeType           **scr_required;         /* optional */
506         AttributeType           **scr_allowed;          /* optional */
507         AttributeType           **scr_precluded;        /* optional */
508 #define scr_oid                 scr_crule.cr_oid
509 #define scr_names               scr_crule.cr_names
510 #define scr_desc                scr_crule.cr_desc
511 #define scr_obsolete            soc_oclass.cr_obsolete
512 #define scr_cr_oids_aux         soc_oclass.cr_oc_oids_aux
513 #define scr_cr_oids_must        soc_oclass.cr_at_oids_must
514 #define scr_cr_oids_may         soc_oclass.cr_at_oids_may
515 #define scr_cr_oids_not         soc_oclass.cr_at_oids_not
516 } ContentRule;
517 #endif
518
519 /*
520  * represents a recognized attribute description ( type + options )
521  */
522 typedef struct slap_attr_desc {
523         struct slap_attr_desc *ad_next;
524         AttributeType *ad_type;         /* attribute type, must be specified */
525         struct berval ad_cname;         /* canonical name, must be specified */
526         struct berval ad_lang;          /* empty if no language tags */
527         unsigned ad_flags;
528 #define SLAP_DESC_NONE                  0x00U
529 #define SLAP_DESC_BINARY                0x01U
530 #define SLAP_DESC_LANG_RANGE    0x80U
531 } AttributeDescription;
532
533 typedef struct slap_attr_name {
534         struct berval an_name;
535         AttributeDescription *an_desc;
536         ObjectClass *an_oc;
537 } AttributeName;
538
539 #define slap_ad_is_lang(ad)                     ( (ad)->ad_lang.bv_len != 0 )
540 #define slap_ad_is_binary(ad)           \
541         ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
542 #define slap_ad_is_lang_range(ad)       \
543         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
544
545 /*
546  * pointers to schema elements used internally
547  */
548 struct slap_internal_schema {
549         /* objectClass */
550         ObjectClass *si_oc_top;
551         ObjectClass *si_oc_extensibleObject;
552         ObjectClass *si_oc_alias;
553         ObjectClass *si_oc_referral;
554         ObjectClass *si_oc_rootdse;
555         ObjectClass *si_oc_subentry;
556         ObjectClass *si_oc_subschema;
557         ObjectClass *si_oc_monitor;
558         ObjectClass *si_oc_collectiveAttributeSubentry;
559         ObjectClass *si_oc_dynamicObject;
560
561         /* objectClass attribute descriptions */
562         AttributeDescription *si_ad_objectClass;
563
564         /* operational attribute descriptions */
565         AttributeDescription *si_ad_structuralObjectClass;
566         AttributeDescription *si_ad_creatorsName;
567         AttributeDescription *si_ad_createTimestamp;
568         AttributeDescription *si_ad_modifiersName;
569         AttributeDescription *si_ad_modifyTimestamp;
570         AttributeDescription *si_ad_hasSubordinates;
571         AttributeDescription *si_ad_subschemaSubentry;
572         AttributeDescription *si_ad_collectiveSubentries;
573         AttributeDescription *si_ad_collectiveExclusions;
574         AttributeDescription *si_ad_entryUUID;
575         AttributeDescription *si_ad_entryCSN;
576
577         /* root DSE attribute descriptions */
578         AttributeDescription *si_ad_altServer;
579         AttributeDescription *si_ad_namingContexts;
580         AttributeDescription *si_ad_supportedControl;
581         AttributeDescription *si_ad_supportedExtension;
582         AttributeDescription *si_ad_supportedLDAPVersion;
583         AttributeDescription *si_ad_supportedSASLMechanisms;
584         AttributeDescription *si_ad_supportedFeatures;
585         AttributeDescription *si_ad_vendorName;
586         AttributeDescription *si_ad_vendorVersion;
587
588         /* subentry attribute descriptions */
589         AttributeDescription *si_ad_administrativeRole;
590         AttributeDescription *si_ad_subtreeSpecification;
591
592         /* subschema subentry attribute descriptions */
593         AttributeDescription *si_ad_ditStructureRules;
594         AttributeDescription *si_ad_ditContentRules;
595         AttributeDescription *si_ad_nameForms;
596         AttributeDescription *si_ad_objectClasses;
597         AttributeDescription *si_ad_attributeTypes;
598         AttributeDescription *si_ad_ldapSyntaxes;
599         AttributeDescription *si_ad_matchingRules;
600         AttributeDescription *si_ad_matchingRuleUse;
601
602         /* Aliases & Referrals */
603         AttributeDescription *si_ad_aliasedObjectName;
604         AttributeDescription *si_ad_ref;
605
606         /* Access Control Internals */
607         AttributeDescription *si_ad_entry;
608         AttributeDescription *si_ad_children;
609 #ifdef SLAPD_ACI_ENABLED
610         AttributeDescription *si_ad_aci;
611 #endif
612
613         /* dynamic entries */
614         AttributeDescription *si_ad_entryTtl;
615         AttributeDescription *si_ad_dynamicSubtrees;
616
617         /* Other attributes descriptions */
618         AttributeDescription *si_ad_distinguishedName;
619         AttributeDescription *si_ad_name;
620         AttributeDescription *si_ad_cn;
621         AttributeDescription *si_ad_userPassword;
622 #ifdef SLAPD_AUTHPASSWD
623         AttributeDescription *si_ad_authPassword;
624 #endif
625 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
626         AttributeDescription *si_ad_krbName;
627 #endif
628
629         /* Undefined Attribute Type */
630         AttributeType   *si_at_undefined;
631
632         /* Matching Rules */
633         MatchingRule    *si_mr_distinguishedNameMatch;
634         MatchingRule    *si_mr_integerMatch;
635
636         /* Syntaxes */
637         Syntax          *si_syn_distinguishedName;
638         Syntax          *si_syn_integer;
639 };
640
641 typedef struct slap_attr_assertion {
642         AttributeDescription    *aa_desc;
643         struct berval aa_value;
644 } AttributeAssertion;
645
646 typedef struct slap_ss_assertion {
647         AttributeDescription    *sa_desc;
648         struct berval           sa_initial;
649         struct berval           *sa_any;
650         struct berval           sa_final;
651 } SubstringsAssertion;
652
653 typedef struct slap_mr_assertion {
654         MatchingRule            *ma_rule;       /* optional */
655         struct berval           ma_rule_text;  /* optional */
656         AttributeDescription    *ma_desc;       /* optional */
657         int                                             ma_dnattrs; /* boolean */
658         struct berval           ma_value;       /* required */
659 } MatchingRuleAssertion;
660
661 /*
662  * represents a search filter
663  */
664 typedef struct slap_filter {
665         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
666 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
667 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
668 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
669
670         union f_un_u {
671                 /* precomputed result */
672                 ber_int_t f_un_result;
673
674                 /* DN */
675                 struct berval *f_un_dn;
676
677                 /* present */
678                 AttributeDescription *f_un_desc;
679
680                 /* simple value assertion */
681                 AttributeAssertion *f_un_ava;
682
683                 /* substring assertion */
684                 SubstringsAssertion *f_un_ssa;
685
686                 /* matching rule assertion */
687                 MatchingRuleAssertion *f_un_mra;
688
689 #define f_dn                    f_un.f_un_dn
690 #define f_desc                  f_un.f_un_desc
691 #define f_ava                   f_un.f_un_ava
692 #define f_av_desc               f_un.f_un_ava->aa_desc
693 #define f_av_value              f_un.f_un_ava->aa_value
694 #define f_sub                   f_un.f_un_ssa
695 #define f_sub_desc              f_un.f_un_ssa->sa_desc
696 #define f_sub_initial   f_un.f_un_ssa->sa_initial
697 #define f_sub_any               f_un.f_un_ssa->sa_any
698 #define f_sub_final             f_un.f_un_ssa->sa_final
699 #define f_mra                   f_un.f_un_mra
700 #define f_mr_rule               f_un.f_un_mra->ma_rule
701 #define f_mr_rule_text          f_un.f_un_mra->ma_rule_text
702 #define f_mr_desc               f_un.f_un_mra->ma_desc
703 #define f_mr_value              f_un.f_un_mra->ma_value
704 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
705
706                 /* and, or, not */
707                 struct slap_filter *f_un_complex;
708         } f_un;
709
710 #define f_result        f_un.f_un_result
711 #define f_and           f_un.f_un_complex
712 #define f_or            f_un.f_un_complex
713 #define f_not           f_un.f_un_complex
714 #define f_list          f_un.f_un_complex
715
716         struct slap_filter      *f_next;
717 } Filter;
718
719 /* compare routines can return undefined */
720 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
721
722 /*
723  * represents an attribute (description + values)
724  */
725 typedef struct slap_attr {
726         AttributeDescription *a_desc;
727         BerVarray       a_vals;
728         struct slap_attr        *a_next;
729         unsigned a_flags;
730 #define SLAP_ATTR_IXADD         0x1U
731 #define SLAP_ATTR_IXDEL         0x2U
732 } Attribute;
733
734
735 /*
736  * the id used in the indexes to refer to an entry
737  */
738 typedef unsigned long   ID;
739 #define NOID    ((ID)~0)
740
741 /*
742  * represents an entry in core
743  */
744 typedef struct slap_entry {
745         /*
746          * The ID field should only be changed before entry is
747          * inserted into a cache.  The ID value is backend
748          * specific.
749          */
750         ID              e_id;
751
752         struct berval e_name;   /* name (DN) of this entry */
753         struct berval e_nname;  /* normalized name (DN) of this entry */
754
755         /* for migration purposes */
756 #define e_dn e_name.bv_val
757 #define e_ndn e_nname.bv_val
758
759         Attribute       *e_attrs;       /* list of attributes + values */
760
761         slap_mask_t     e_ocflags;
762
763         struct berval   e_bv;           /* For entry_encode/entry_decode */
764
765         /* for use by the backend for any purpose */
766         void*   e_private;
767 } Entry;
768
769 /*
770  * A list of LDAPMods
771  */
772 typedef struct slap_mod {
773         int sm_op;
774         AttributeDescription *sm_desc;
775         struct berval sm_type;
776         BerVarray sm_bvalues;
777 } Modification;
778
779 typedef struct slap_mod_list {
780         Modification sml_mod;
781 #define sml_op          sml_mod.sm_op
782 #define sml_desc        sml_mod.sm_desc
783 #define sml_type        sml_mod.sm_type
784 #define sml_bvalues     sml_mod.sm_bvalues
785         struct slap_mod_list *sml_next;
786 } Modifications;
787
788 typedef struct slap_ldap_modlist {
789         LDAPMod ml_mod;
790         struct slap_ldap_modlist *ml_next;
791 #define ml_op           ml_mod.mod_op
792 #define ml_type         ml_mod.mod_type
793 #define ml_values       ml_mod.mod_values
794 #define ml_bvalues      ml_mod.mod_bvalues
795 } LDAPModList;
796
797 /*
798  * represents an access control list
799  */
800 typedef enum slap_access_e {
801         ACL_INVALID_ACCESS = -1,
802         ACL_NONE = 0,
803         ACL_AUTH,
804         ACL_COMPARE,
805         ACL_SEARCH,
806         ACL_READ,
807         ACL_WRITE
808 } slap_access_t;
809
810 typedef enum slap_control_e {
811         ACL_INVALID_CONTROL     = 0,
812         ACL_STOP,
813         ACL_CONTINUE,
814         ACL_BREAK
815 } slap_control_t;
816
817 typedef enum slap_style_e {
818         ACL_STYLE_REGEX = 0,
819         ACL_STYLE_BASE,
820         ACL_STYLE_ONE,
821         ACL_STYLE_SUBTREE,
822         ACL_STYLE_CHILDREN,
823         ACL_STYLE_ATTROF,
824
825         /* alternate names */
826         ACL_STYLE_EXACT = ACL_STYLE_BASE
827 } slap_style_t;
828
829 typedef struct slap_authz_info {
830         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
831         struct berval   sai_mech;               /* SASL Mechanism */
832         struct berval   sai_dn;                 /* DN for reporting purposes */
833         struct berval   sai_ndn;                /* Normalized DN */
834
835         /* Security Strength Factors */
836         slap_ssf_t      sai_ssf;                        /* Overall SSF */
837         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
838         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
839         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
840 } AuthorizationInformation;
841
842 /* the "by" part */
843 typedef struct slap_access {
844         slap_control_t a_type;
845
846 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
847
848 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
849 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
850 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
851 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
852 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
853 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
854
855 #define ACL_PRIV_MASK                   0x00ffUL
856
857 /* priv flags */
858 #define ACL_PRIV_LEVEL                  0x1000UL
859 #define ACL_PRIV_ADDITIVE               0x2000UL
860 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
861
862 /* invalid privs */
863 #define ACL_PRIV_INVALID                0x0UL
864
865 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
866 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
867 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
868 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
869
870 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
871 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
872
873 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
874
875 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
876
877 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
878 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
879 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
880
881 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
882 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
883 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
884 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
885 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
886 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
887
888 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
889 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
890 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
891 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
892 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
893 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
894 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
895
896 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
897 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
898 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
899 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
900 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
901 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
902
903         slap_mask_t     a_access_mask;
904
905         AuthorizationInformation        a_authz;
906 #define a_dn_pat        a_authz.sai_dn
907
908         slap_style_t a_dn_style;
909         AttributeDescription    *a_dn_at;
910         int                     a_dn_self;
911
912         slap_style_t a_peername_style;
913         struct berval   a_peername_pat;
914         slap_style_t a_sockname_style;
915         struct berval   a_sockname_pat;
916
917         slap_style_t a_domain_style;
918         struct berval   a_domain_pat;
919         slap_style_t a_sockurl_style;
920         struct berval   a_sockurl_pat;
921         slap_style_t a_set_style;
922         struct berval   a_set_pat;
923
924 #ifdef SLAPD_ACI_ENABLED
925         AttributeDescription    *a_aci_at;
926 #endif
927
928         /* ACL Groups */
929         slap_style_t a_group_style;
930         struct berval   a_group_pat;
931         ObjectClass                             *a_group_oc;
932         AttributeDescription    *a_group_at;
933
934         struct slap_access      *a_next;
935 } Access;
936
937 /* the "to" part */
938 typedef struct slap_acl {
939         /* "to" part: the entries this acl applies to */
940         Filter          *acl_filter;
941         slap_style_t acl_dn_style;
942         regex_t         acl_dn_re;
943         struct berval   acl_dn_pat;
944         AttributeName   *acl_attrs;
945
946         /* "by" part: list of who has what access to the entries */
947         Access  *acl_access;
948
949         struct slap_acl *acl_next;
950 } AccessControl;
951
952 /*
953  * replog moddn param structure
954  */
955 struct slap_replog_moddn {
956         struct berval *newrdn;
957         int     deloldrdn;
958         struct berval *newsup;
959 };
960
961 /*
962  * Backend-info
963  * represents a backend 
964  */
965
966 typedef struct slap_backend_info BackendInfo;   /* per backend type */
967 typedef struct slap_backend_db BackendDB;               /* per backend database */
968
969 LDAP_SLAPD_V (int) nBackendInfo;
970 LDAP_SLAPD_V (int) nBackendDB;
971 LDAP_SLAPD_V (BackendInfo *) backendInfo;
972 LDAP_SLAPD_V (BackendDB *) backendDB;
973
974 LDAP_SLAPD_V (int) slapMode;    
975 #define SLAP_UNDEFINED_MODE     0x0000
976 #define SLAP_SERVER_MODE        0x0001
977 #define SLAP_TOOL_MODE          0x0002
978 #define SLAP_MODE                       0x0003
979
980 #define SLAP_TRUNCATE_MODE      0x0100
981
982 struct slap_replica_info {
983         char *ri_host;                          /* supersedes be_replica */
984         struct berval **ri_nsuffix;     /* array of suffixes this replica accepts */
985 };
986
987 struct slap_limits_set {
988         /* time limits */
989         int     lms_t_soft;
990         int     lms_t_hard;
991
992         /* size limits */
993         int     lms_s_soft;
994         int     lms_s_hard;
995         int     lms_s_unchecked;
996 };
997
998 struct slap_limits {
999         int     lm_type;        /* type of pattern */
1000 #define SLAP_LIMITS_UNDEFINED   0x0000
1001 #define SLAP_LIMITS_EXACT       0x0001
1002 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1003 #define SLAP_LIMITS_ONE         0x0002
1004 #define SLAP_LIMITS_SUBTREE     0x0003
1005 #define SLAP_LIMITS_CHILDREN    0x0004
1006 #define SLAP_LIMITS_REGEX       0x0005
1007 #define SLAP_LIMITS_ANONYMOUS   0x0006
1008 #define SLAP_LIMITS_USERS       0x0007
1009         regex_t lm_dn_regex;            /* regex data for REGEX */
1010
1011         /*
1012          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1013          * pattern for REGEX; NULL for ANONYMOUS, USERS
1014          */
1015         struct berval lm_dn_pat;
1016
1017         struct slap_limits_set  lm_limits;
1018 };
1019
1020 /* temporary aliases */
1021 typedef BackendDB Backend;
1022 #define nbackends nBackendDB
1023 #define backends backendDB
1024
1025 struct slap_backend_db {
1026         BackendInfo     *bd_info;       /* pointer to shared backend info */
1027
1028         /* BackendInfo accessors */
1029 #define         be_config       bd_info->bi_db_config
1030 #define         be_type         bd_info->bi_type
1031
1032 #define         be_bind         bd_info->bi_op_bind
1033 #define         be_unbind       bd_info->bi_op_unbind
1034 #define         be_add          bd_info->bi_op_add
1035 #define         be_compare      bd_info->bi_op_compare
1036 #define         be_delete       bd_info->bi_op_delete
1037 #define         be_modify       bd_info->bi_op_modify
1038 #define         be_modrdn       bd_info->bi_op_modrdn
1039 #define         be_search       bd_info->bi_op_search
1040
1041 #define         be_extended     bd_info->bi_extended
1042
1043 #define         be_release      bd_info->bi_entry_release_rw
1044 #define         be_chk_referrals        bd_info->bi_chk_referrals
1045 #define         be_group        bd_info->bi_acl_group
1046 #define         be_attribute    bd_info->bi_acl_attribute
1047 #define         be_operational  bd_info->bi_operational
1048
1049 #define         be_controls     bd_info->bi_controls
1050
1051 #define         be_connection_init      bd_info->bi_connection_init
1052 #define         be_connection_destroy   bd_info->bi_connection_destroy
1053
1054 #ifdef SLAPD_TOOLS
1055 #define         be_entry_open bd_info->bi_tool_entry_open
1056 #define         be_entry_close bd_info->bi_tool_entry_close
1057 #define         be_entry_first bd_info->bi_tool_entry_first
1058 #define         be_entry_next bd_info->bi_tool_entry_next
1059 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1060 #define         be_entry_get bd_info->bi_tool_entry_get
1061 #define         be_entry_put bd_info->bi_tool_entry_put
1062 #define         be_sync bd_info->bi_tool_sync
1063 #endif
1064
1065 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1066 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1067 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1068 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1069 #define SLAP_BFLAG_ALIASES              0x0100U
1070 #define SLAP_BFLAG_REFERRALS    0x0200U
1071 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1072 #define SLAP_BFLAG_MONITOR              0x1000U
1073 #define SLAP_BFLAG_DYNAMIC              0x2000U
1074         slap_mask_t     be_flags;
1075 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1076 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1077 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1078 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1079 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1080 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1081
1082         slap_mask_t     be_restrictops;         /* restriction operations */
1083 #define SLAP_RESTRICT_OP_ADD            0x0001U
1084 #define SLAP_RESTRICT_OP_BIND           0x0002U
1085 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1086 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1087 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1088 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1089 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1090 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1091
1092 #define SLAP_RESTRICT_OP_READS  \
1093         ( SLAP_RESTRICT_OP_COMPARE    \
1094         | SLAP_RESTRICT_OP_SEARCH )
1095 #define SLAP_RESTRICT_OP_WRITES \
1096         ( SLAP_RESTRICT_OP_ADD    \
1097         | SLAP_RESTRICT_OP_DELETE \
1098         | SLAP_RESTRICT_OP_MODIFY \
1099         | SLAP_RESTRICT_OP_RENAME )
1100
1101 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1102 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1103 #define SLAP_ALLOW_BIND_ANON_DN         0x0003U /* dn should be empty */
1104
1105 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1106 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1107 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1108
1109 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1110 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1111
1112         slap_mask_t     be_requires;    /* pre-operation requirements */
1113 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1114 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1115 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1116 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1117 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1118
1119         /* Required Security Strength Factor */
1120         slap_ssf_set_t be_ssf_set;
1121
1122         /* these should be renamed from be_ to bd_ */
1123         struct berval **be_suffix;      /* the DN suffixes of data in this backend */
1124         struct berval **be_nsuffix;     /* the normalized DN suffixes in this backend */
1125         struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1126         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1127         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1128         struct berval be_rootpw;        /* the magic "root" password for this db        */
1129         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
1130 #define be_sizelimit    be_def_limit.lms_s_soft
1131 #define be_timelimit    be_def_limit.lms_t_soft
1132         struct slap_limits_set be_def_limit; /* default limits */
1133         struct slap_limits **be_limits; /* regex-based size and time limits */
1134         AccessControl *be_acl;  /* access control list for this backend    */
1135         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1136         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1137         char    *be_replogfile; /* replication log file (in master)        */
1138         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1139         BerVarray       be_update_refs; /* where to refer modifying clients to */
1140         char    *be_realm;
1141
1142         void    *be_private;    /* anything the backend database needs     */
1143 };
1144
1145 struct slap_conn;
1146 struct slap_op;
1147
1148 /* Backend function typedefs */
1149 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1150 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1151         const char *fname, int lineno,
1152         int argc, char **argv));
1153 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1154 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1155 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1156
1157 typedef int (BI_db_init) LDAP_P((Backend *bd));
1158 typedef int (BI_db_config) LDAP_P((Backend *bd,
1159         const char *fname, int lineno,
1160         int argc, char **argv));
1161 typedef int (BI_db_open) LDAP_P((Backend *bd));
1162 typedef int (BI_db_close) LDAP_P((Backend *bd));
1163 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1164
1165 typedef int (BI_op_bind)  LDAP_P(( BackendDB *bd,
1166                 struct slap_conn *c, struct slap_op *o,
1167                 struct berval *dn, struct berval *ndn, int method,
1168                 struct berval *cred, struct berval *edn ));
1169 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1170                 struct slap_conn *c, struct slap_op *o ));
1171 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1172                 struct slap_conn *c, struct slap_op *o,
1173                 struct berval *base, struct berval *nbase,
1174                 int scope, int deref,
1175                 int slimit, int tlimit,
1176                 Filter *f, struct berval *filterstr,
1177                 AttributeName *attrs, int attrsonly));
1178 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1179                 struct slap_conn *c, struct slap_op *o,
1180                 struct berval *dn, struct berval *ndn,
1181                 AttributeAssertion *ava));
1182 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1183                 struct slap_conn *c, struct slap_op *o,
1184                 struct berval *dn, struct berval *ndn,
1185                 Modifications *m));
1186 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1187                 struct slap_conn *c, struct slap_op *o,
1188                 struct berval *dn, struct berval *ndn,
1189                 struct berval *newrdn, struct berval *nnewrdn,
1190                 int deleteoldrdn,
1191                 struct berval *newSup, struct berval *nnewSup ));
1192 typedef int (BI_op_add)    LDAP_P((BackendDB *bd,
1193                 struct slap_conn *c, struct slap_op *o,
1194                 Entry *e));
1195 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1196                 struct slap_conn *c, struct slap_op *o,
1197                 struct berval *dn, struct berval *ndn));
1198 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1199                 struct slap_conn *c, struct slap_op *o,
1200                 ber_int_t msgid));
1201
1202 typedef int (BI_op_extended) LDAP_P((
1203     BackendDB           *be,
1204     struct slap_conn    *conn,
1205     struct slap_op              *op,
1206         const char              *reqoid,
1207     struct berval * reqdata,
1208         char            **rspoid,
1209     struct berval ** rspdata,
1210         LDAPControl *** rspctrls,
1211         const char **   text,
1212         BerVarray *refs ));
1213
1214 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1215                 struct slap_conn *c, struct slap_op *o,
1216                 Entry *e, int rw));
1217
1218 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1219                 struct slap_conn *c, struct slap_op *o,
1220                 struct berval *dn, struct berval *ndn,
1221                 const char **text ));
1222
1223 typedef int (BI_acl_group)  LDAP_P((Backend *bd,
1224                 struct slap_conn *c, struct slap_op *o,
1225                 Entry *e,
1226                 struct berval *bdn,
1227                 struct berval *edn,
1228                 ObjectClass *group_oc,
1229                 AttributeDescription *group_at ));
1230
1231 typedef int (BI_acl_attribute)  LDAP_P((Backend *bd,
1232                 struct slap_conn *c, struct slap_op *o,
1233                 Entry *e, struct berval *edn,
1234                 AttributeDescription *entry_at,
1235                 BerVarray *vals ));
1236
1237 typedef int (BI_operational)  LDAP_P((Backend *bd,
1238                 struct slap_conn *c, struct slap_op *o,
1239                 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1240
1241 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1242                 struct slap_conn *c));
1243 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1244                 struct slap_conn *c));
1245
1246 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1247 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1248 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1249 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1250 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1251 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e, 
1252                         struct berval *text ));
1253 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1254 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1255
1256 struct slap_backend_info {
1257         char    *bi_type; /* type of backend */
1258
1259         /*
1260          * per backend type routines:
1261          * bi_init: called to allocate a backend_info structure,
1262          *              called once BEFORE configuration file is read.
1263          *              bi_init() initializes this structure hence is
1264          *              called directly from be_initialize()
1265          * bi_config: called per 'backend' specific option
1266          *              all such options must before any 'database' options
1267          *              bi_config() is called only from read_config()
1268          * bi_open: called to open each database, called
1269          *              once AFTER configuration file is read but
1270          *              BEFORE any bi_db_open() calls.
1271          *              bi_open() is called from backend_startup()
1272          * bi_close: called to close each database, called
1273          *              once during shutdown after all bi_db_close calls.
1274          *              bi_close() is called from backend_shutdown()
1275          * bi_destroy: called to destroy each database, called
1276          *              once during shutdown after all bi_db_destroy calls.
1277          *              bi_destory() is called from backend_destroy()
1278          */
1279         BI_init *bi_init;
1280         BI_config       *bi_config;
1281         BI_open *bi_open;
1282         BI_close        *bi_close;
1283         BI_destroy      *bi_destroy;
1284
1285         /*
1286          * per database routines:
1287          * bi_db_init: called to initialize each database,
1288          *      called upon reading 'database <type>' 
1289          *      called only from backend_db_init()
1290          * bi_db_config: called to configure each database,
1291          *  called per database to handle per database options
1292          *      called only from read_config()
1293          * bi_db_open: called to open each database
1294          *      called once per database immediately AFTER bi_open()
1295          *      calls but before daemon startup.
1296          *  called only by backend_startup()
1297          * bi_db_close: called to close each database
1298          *      called once per database during shutdown but BEFORE
1299          *  any bi_close call.
1300          *  called only by backend_shutdown()
1301          * bi_db_destroy: called to destroy each database
1302          *  called once per database during shutdown AFTER all
1303          *  bi_close calls but before bi_destory calls.
1304          *  called only by backend_destory()
1305          */
1306         BI_db_init      *bi_db_init;
1307         BI_db_config    *bi_db_config;
1308         BI_db_open      *bi_db_open;
1309         BI_db_close     *bi_db_close;
1310         BI_db_destroy   *bi_db_destroy;
1311
1312         /* LDAP Operations Handling Routines */
1313         BI_op_bind      *bi_op_bind;
1314         BI_op_unbind    *bi_op_unbind;
1315         BI_op_search    *bi_op_search;
1316         BI_op_compare   *bi_op_compare;
1317         BI_op_modify    *bi_op_modify;
1318         BI_op_modrdn    *bi_op_modrdn;
1319         BI_op_add       *bi_op_add;
1320         BI_op_delete    *bi_op_delete;
1321         BI_op_abandon   *bi_op_abandon;
1322
1323         /* Extended Operations Helper */
1324         BI_op_extended  *bi_extended;
1325
1326         /* Auxilary Functions */
1327         BI_entry_release_rw     *bi_entry_release_rw;
1328         BI_chk_referrals        *bi_chk_referrals;
1329
1330         BI_acl_group    *bi_acl_group;
1331         BI_acl_attribute        *bi_acl_attribute;
1332
1333         BI_operational  *bi_operational;
1334
1335         BI_connection_init      *bi_connection_init;
1336         BI_connection_destroy   *bi_connection_destroy;
1337
1338         /* hooks for slap tools */
1339         BI_tool_entry_open      *bi_tool_entry_open;
1340         BI_tool_entry_close     *bi_tool_entry_close;
1341         BI_tool_entry_first     *bi_tool_entry_first;
1342         BI_tool_entry_next      *bi_tool_entry_next;
1343         BI_tool_entry_get       *bi_tool_entry_get;
1344         BI_tool_entry_put       *bi_tool_entry_put;
1345         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1346         BI_tool_sync            *bi_tool_sync;
1347
1348 #define SLAP_INDEX_ADD_OP               0x0001
1349 #define SLAP_INDEX_DELETE_OP    0x0002
1350
1351         char **bi_controls;             /* supported controls */
1352
1353         unsigned int bi_nDB;    /* number of databases of this type */
1354         void    *bi_private;    /* anything the backend type needs */
1355 };
1356
1357 #define c_authtype      c_authz.sai_method
1358 #define c_authmech      c_authz.sai_mech
1359 #define c_dn            c_authz.sai_dn
1360 #define c_ndn           c_authz.sai_ndn
1361 #define c_ssf                   c_authz.sai_ssf
1362 #define c_transport_ssf c_authz.sai_transport_ssf
1363 #define c_tls_ssf               c_authz.sai_tls_ssf
1364 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1365
1366 #define o_authtype      o_authz.sai_method
1367 #define o_authmech      o_authz.sai_mech
1368 #define o_dn            o_authz.sai_dn
1369 #define o_ndn           o_authz.sai_ndn
1370 #define o_ssf                   o_authz.sai_ssf
1371 #define o_transport_ssf o_authz.sai_transport_ssf
1372 #define o_tls_ssf               o_authz.sai_tls_ssf
1373 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1374
1375 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1376         ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1377         BerVarray, const char *, struct berval *,
1378         struct berval *, LDAPControl ** );
1379
1380 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1381         ber_int_t, const char *, const char *, BerVarray,
1382         LDAPControl **, int nentries);
1383
1384 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1385         struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1386
1387 typedef struct slap_callback {
1388         slap_response *sc_response;
1389         slap_sresult *sc_sresult;
1390         slap_sendentry *sc_sendentry;
1391         void *sc_private;
1392 } slap_callback;
1393
1394 /*
1395  * represents an operation pending from an ldap client
1396  */
1397 typedef struct slap_op {
1398         ber_int_t       o_opid;         /* id of this operation           */
1399         ber_int_t       o_msgid;        /* msgid of the request           */
1400         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1401         ber_tag_t       o_tag;          /* tag of the request             */
1402         time_t          o_time;         /* time op was initiated          */
1403         unsigned long   o_connid; /* id of conn initiating this op  */
1404         ldap_pvt_thread_t       o_tid;  /* thread handling this op        */
1405
1406 #define SLAP_NO_CONTROL 0
1407 #define SLAP_NONCRITICAL_CONTROL 1
1408 #define SLAP_CRITICAL_CONTROL 2
1409         char o_managedsait;
1410         char o_subentries;
1411         char o_subentries_visibility;
1412         char o_noop;
1413
1414         int             o_abandon;      /* abandon flag */
1415         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
1416
1417 #ifdef LDAP_CONNECTIONLESS
1418         Sockaddr        o_peeraddr;     /* UDP peer address               */
1419 #endif
1420         AuthorizationInformation o_authz;
1421
1422         BerElement      *o_ber;         /* ber of the request             */
1423         slap_callback   *o_callback;    /* callback pointers */
1424         LDAPControl     **o_ctrls;       /* controls */
1425
1426         void    *o_private;     /* anything the backend needs */
1427
1428         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1429 } Operation;
1430
1431 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1432 #define get_subentries(op)                              ((int)(op)->o_subentries)
1433 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1434
1435 /*
1436  * Caches the result of a backend_group check for ACL evaluation
1437  */
1438 typedef struct slap_gacl {
1439         struct slap_gacl *next;
1440         Backend *be;
1441         ObjectClass *oc;
1442         AttributeDescription *at;
1443         int res;
1444         ber_len_t len;
1445         char ndn[1];
1446 } GroupAssertion;
1447
1448 /*
1449  * represents a connection from an ldap client
1450  */
1451 typedef struct slap_conn {
1452         int                     c_struct_state; /* structure management state */
1453         int                     c_conn_state;   /* connection state */
1454
1455         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1456         Sockbuf         *c_sb;                  /* ber connection stuff           */
1457
1458         /* only can be changed by connect_init */
1459         time_t          c_starttime;    /* when the connection was opened */
1460         time_t          c_activitytime; /* when the connection was last used */
1461         unsigned long           c_connid;       /* id of this connection for stats*/
1462
1463         struct berval   c_listener_url; /* listener URL */
1464         struct berval   c_peer_domain;  /* DNS name of client */
1465         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
1466         struct berval   c_sock_name;    /* sock name (trans=addr:port) */
1467
1468         /* only can be changed by binding thread */
1469         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1470         struct berval   c_sasl_bind_mech;                       /* mech in progress */
1471         struct berval   c_cdn;
1472
1473         /* authentication backend */
1474         Backend *c_authc_backend;
1475
1476         /* authorization backend - normally same as c_authc_backend */
1477         Backend *c_authz_backend;
1478
1479         AuthorizationInformation c_authz;
1480         GroupAssertion *c_groups;
1481
1482         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1483
1484         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
1485         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
1486
1487         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1488         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1489
1490         BerElement      *c_currentber;  /* ber we're attempting to read */
1491         int             c_writewaiter;  /* true if writer is waiting */
1492
1493 #ifdef LDAP_CONNECTIONLESS
1494         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
1495 #endif
1496 #ifdef HAVE_TLS
1497         int     c_is_tls;               /* true if this LDAP over raw TLS */
1498         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1499 #endif
1500         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1501         void    *c_sasl_context;        /* SASL session context */
1502         void    *c_sasl_extra;          /* SASL session extra stuff */
1503
1504         long    c_n_ops_received;               /* num of ops received (next op_id) */
1505         long    c_n_ops_executing;      /* num of ops currently executing */
1506         long    c_n_ops_pending;                /* num of ops pending execution */
1507         long    c_n_ops_completed;      /* num of ops completed */
1508
1509         long    c_n_get;                /* num of get calls */
1510         long    c_n_read;               /* num of read calls */
1511         long    c_n_write;              /* num of write calls */
1512 } Connection;
1513
1514 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1515 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1516         do { \
1517                 if ( ldap_debug & (level) ) \
1518                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1519                 if ( ldap_syslog & (level) ) \
1520                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1521                                 (arg2), (arg3) ); \
1522         } while (0)
1523 #else
1524 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1525 #endif
1526
1527
1528 #define SASLREGEX_REPLACE 10
1529 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1530 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1531
1532 typedef struct sasl_regexp {
1533   char *match;                            /* regexp match pattern */
1534   char *replace;                          /* regexp replace pattern */
1535   regex_t workspace;                      /* workspace for regexp engine */
1536   regmatch_t strings[SASLREGEX_REPLACE];  /* strings matching $1,$2 ... */
1537   int offset[SASLREGEX_REPLACE+2];        /* offsets of $1,$2... in *replace */
1538 } SaslRegexp_t;
1539
1540 /*
1541  * listener; need to access it from monitor backend
1542  */
1543 typedef struct slap_listener {
1544         char* sl_url;
1545         char* sl_name;
1546 #ifdef HAVE_TLS
1547         int             sl_is_tls;
1548 #endif
1549 #ifdef LDAP_CONNECTIONLESS
1550         int     sl_is_udp;              /* UDP listener is also data port */
1551 #endif
1552         ber_socket_t sl_sd;
1553         Sockaddr sl_sa;
1554 #define sl_addr sl_sa.sa_in_addr
1555 } Listener;
1556
1557 LDAP_END_DECL
1558
1559 #include "proto-slap.h"
1560
1561 #endif /* _SLAP_H_ */