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