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