]> git.sur5r.net Git - openldap/blob - servers/slapd/slap.h
Add referral generator
[openldap] / servers / slapd / slap.h
1 /* slap.h - stand alone ldap server include file */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2000 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 <ac/stdlib.h>
14
15 #include <sys/types.h>
16 #include <ac/syslog.h>
17 #include <ac/regex.h>
18 #include <ac/socket.h>
19 #include <ac/time.h>
20 #include <ac/param.h>
21
22 #ifdef HAVE_CYRUS_SASL
23 #include <sasl.h>
24 #endif
25
26 #include "avl.h"
27
28 #ifndef ldap_debug
29 #define ldap_debug slap_debug
30 #endif
31
32
33 #include "ldap_log.h"
34
35 #include <ldap.h>
36 #include <ldap_schema.h>
37
38 #include "ldap_pvt_thread.h"
39 #include "ldif.h"
40
41 LDAP_BEGIN_DECL
42
43 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
44 #define SLAPD_ANONYMOUS "<anonymous>"
45
46 #ifdef f_next
47 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
48 #endif
49
50 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
51  *
52  * This is a value used internally by the backends. It is needed to allow
53  * adding values that already exist without getting an error as required by
54  * modrdn when the new rdn was already an attribute value itself.
55  * JCG 05/1999 (gomez@engr.sgi.com)
56  */
57 #define SLAP_MOD_SOFTADD        0x1000
58
59 #define ON      1
60 #define OFF     (-1)
61 #define UNDEFINED 0
62
63 #define MAXREMATCHES 10
64
65
66 /* psuedo error code indicating abandoned operation */
67 #define SLAPD_ABANDON (-1)
68
69 /* psuedo error code indicating disconnect */
70 #define SLAPD_DISCONNECT (-2)
71
72
73 /* We assume "C" locale, that is US-ASCII */
74 #define ASCII_SPACE(c)  ( (c) == ' ' )
75 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
76 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
77 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
78 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
79 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
80
81 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
82 #define RDN_SEPARATOR(c)        ((c) == ',' || (c) == ';' || (c) == '+')
83 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
84
85 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
86 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
87 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
88 #define OID_CHAR(c)     ( ASCII_DIGIT(c) || (c) == '.' )
89
90 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
91 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
92
93 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
94 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
95
96 /* must match in schema_init.c */
97 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
98 #define SLAPD_GROUP_ATTR                "member"
99 #define SLAPD_GROUP_CLASS               "groupOfNames"
100 #define SLAPD_ROLE_ATTR                 "roleOccupant"
101 #define SLAPD_ROLE_CLASS                "organizationalRole"
102
103 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
104 #define SLAPD_ACI_ATTR                  "OpenLDAPaci"
105
106 LIBSLAPD_F (int) slap_debug;
107
108 /*
109  * Index types
110  */
111 #define SLAP_INDEX_TYPE           0x00FFUL
112 #define SLAP_INDEX_UNDEFINED      0x0001UL
113 #define SLAP_INDEX_PRESENT        0x0002UL
114 #define SLAP_INDEX_EQUALITY       0x0004UL
115 #define SLAP_INDEX_APPROX         0x0008UL
116 #define SLAP_INDEX_SUBSTR         0x0010UL
117 #define SLAP_INDEX_EXTENDED               0x0020UL
118
119 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
120
121 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type) )
122
123 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
124
125 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL ) 
126 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
127 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
128 #define SLAP_INDEX_SUBSTR_DEFAULT ( SLAP_INDEX_SUBSTR \
129         | SLAP_INDEX_SUBSTR_INITIAL | SLAP_INDEX_SUBSTR_FINAL )
130
131 #define SLAP_INDEX_FLAGS          0xF000UL
132 #define SLAP_INDEX_SUBTYPES       0x1000UL /* use index with subtypes */
133 #define SLAP_INDEX_AUTO_SUBTYPES  0x2000UL /* use mask with subtypes */
134 #define SLAP_INDEX_LANG           0x4000UL /* use index with lang subtypes */
135 #define SLAP_INDEX_AUTO_LANG      0x8000UL /* use mask with lang subtypes */
136
137 typedef long slap_index;
138
139 /*
140  * there is a single index for each attribute.  these prefixes ensure
141  * that there is no collision among keys.
142  */
143 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
144 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
145 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
146 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
147 #define SLAP_INDEX_UNKNOWN_PREFIX       '?'             /* prefix for unknown keys */
148
149 /*
150  * represents schema information for a database
151  */
152 #define SLAP_SCHERR_OUTOFMEM            1
153 #define SLAP_SCHERR_CLASS_NOT_FOUND     2
154 #define SLAP_SCHERR_ATTR_NOT_FOUND      3
155 #define SLAP_SCHERR_DUP_CLASS           4
156 #define SLAP_SCHERR_DUP_ATTR            5
157 #define SLAP_SCHERR_DUP_SYNTAX          6
158 #define SLAP_SCHERR_DUP_RULE            7
159 #define SLAP_SCHERR_NO_NAME             8
160 #define SLAP_SCHERR_ATTR_INCOMPLETE     9
161 #define SLAP_SCHERR_MR_NOT_FOUND        10
162 #define SLAP_SCHERR_SYN_NOT_FOUND       11
163 #define SLAP_SCHERR_MR_INCOMPLETE       12
164
165 typedef struct slap_oid_macro {
166         struct berval som_oid;
167         char **som_names;
168         struct slap_oid_macro *som_next;
169 } OidMacro;
170
171 /* forward declarations */
172 struct slap_syntax;
173 struct slap_matching_rule;
174
175 typedef int slap_syntax_validate_func LDAP_P((
176         struct slap_syntax *syntax,
177         struct berval * in));
178
179 typedef int slap_syntax_transform_func LDAP_P((
180         struct slap_syntax *syntax,
181         struct berval * in,
182         struct berval ** out));
183
184 typedef struct slap_syntax {
185         LDAP_SYNTAX                     ssyn_syn;
186 #define ssyn_oid                ssyn_syn.syn_oid
187 #define ssyn_desc               ssyn_syn.syn_desc
188 #define ssyn_extensions         ssyn_syn.syn_extensions
189
190         unsigned        ssyn_flags;
191
192 #define SLAP_SYNTAX_NONE        0x00U
193 #define SLAP_SYNTAX_BLOB        0x01U /* syntax treated as blob (audio) */
194 #define SLAP_SYNTAX_BINARY      0x02U /* binary transfer required (certificate) */
195 #define SLAP_SYNTAX_BER         0x04U /* stored using BER encoding (binary,certificate) */
196 #define SLAP_SYNTAX_HIDE        0x80U /* hide (do not publish) */
197
198         slap_syntax_validate_func       *ssyn_validate;
199         slap_syntax_transform_func      *ssyn_normalize;
200         slap_syntax_transform_func      *ssyn_pretty;
201
202 #ifdef SLAPD_BINARY_CONVERSION
203         /* convert to and from binary */
204         slap_syntax_transform_func      *ssyn_ber2str;
205         slap_syntax_transform_func      *ssyn_str2ber;
206 #endif
207
208         struct slap_syntax              *ssyn_next;
209 } Syntax;
210
211 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
212 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
213 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
214 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
215 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
216
217 /* XXX -> UCS-2 Converter */
218 typedef int slap_mr_convert_func LDAP_P((
219         struct berval * in,
220         struct berval ** out ));
221
222 /* Normalizer */
223 typedef int slap_mr_normalize_func LDAP_P((
224         unsigned use,
225         struct slap_syntax *syntax, /* NULL if in is asserted value */
226         struct slap_matching_rule *mr,
227         struct berval * in,
228         struct berval ** out ));
229
230 /* Match (compare) function */
231 typedef int slap_mr_match_func LDAP_P((
232         int *match,
233         unsigned use,
234         struct slap_syntax *syntax,     /* syntax of stored value */
235         struct slap_matching_rule *mr,
236         struct berval * value,
237         void * assertValue ));
238
239 /* Index generation function */
240 typedef int slap_mr_indexer_func LDAP_P((
241         unsigned use,
242         struct slap_syntax *syntax,     /* syntax of stored value */
243         struct slap_matching_rule *mr,
244         struct berval *prefix,
245         struct berval **values,
246         struct berval ***keys ));
247
248 /* Filter index function */
249 typedef int slap_mr_filter_func LDAP_P((
250         unsigned use,
251         struct slap_syntax *syntax,     /* syntax of stored value */
252         struct slap_matching_rule *mr,
253         struct berval *prefix,
254         void * assertValue,
255         struct berval ***keys ));
256
257 typedef struct slap_matching_rule {
258         LDAP_MATCHING_RULE              smr_mrule;
259         unsigned                                smr_usage;
260
261 #define SLAP_MR_TYPE_MASK               0xFF00U
262 #define SLAP_MR_SUBTYPE_MASK    0x00FFU
263
264 #define SLAP_MR_NONE                    0x0000U
265 #define SLAP_MR_EQUALITY                0x0100U
266 #define SLAP_MR_ORDERING                0x0200U
267 #define SLAP_MR_SUBSTR                  0x0400U
268 #define SLAP_MR_EXT                             0x0800U
269
270 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0001U )
271
272 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0001U )
273 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0002U )
274 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0004U )
275
276         Syntax                                  *smr_syntax;
277         slap_mr_convert_func    *smr_convert;
278         slap_mr_normalize_func  *smr_normalize;
279         slap_mr_match_func              *smr_match;
280         slap_mr_indexer_func    *smr_indexer;
281         slap_mr_filter_func             *smr_filter;
282         struct slap_matching_rule       *smr_next;
283 #define smr_oid                         smr_mrule.mr_oid
284 #define smr_names                       smr_mrule.mr_names
285 #define smr_desc                        smr_mrule.mr_desc
286 #define smr_obsolete            smr_mrule.mr_obsolete
287 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
288 #define smr_extensions          smr_mrule.mr_extensions
289 } MatchingRule;
290
291 typedef struct slap_attribute_type {
292         char                                    *sat_cname;
293         LDAP_ATTRIBUTE_TYPE             sat_atype;
294         struct slap_attribute_type      *sat_sup;
295         struct slap_attribute_type      **sat_subtypes;
296         MatchingRule                    *sat_equality;
297         MatchingRule                    *sat_approx;
298         MatchingRule                    *sat_ordering;
299         MatchingRule                    *sat_substr;
300         Syntax                          *sat_syntax;
301         struct slap_attribute_type      *sat_next;
302 #define sat_oid                 sat_atype.at_oid
303 #define sat_names               sat_atype.at_names
304 #define sat_desc                sat_atype.at_desc
305 #define sat_obsolete            sat_atype.at_obsolete
306 #define sat_sup_oid             sat_atype.at_sup_oid
307 #define sat_equality_oid        sat_atype.at_equality_oid
308 #define sat_ordering_oid        sat_atype.at_ordering_oid
309 #define sat_substr_oid          sat_atype.at_substr_oid
310 #define sat_syntax_oid          sat_atype.at_syntax_oid
311 #define sat_single_value        sat_atype.at_single_value
312 #define sat_collective          sat_atype.at_collective
313 #define sat_no_user_mod         sat_atype.at_no_user_mod
314 #define sat_usage               sat_atype.at_usage
315 #define sat_extensions          sat_atype.at_extensions
316 } AttributeType;
317
318 #define is_at_operational(at)   ((at)->sat_usage)
319 #define is_at_single_value(at)  ((at)->sat_single_value)
320 #define is_at_collective(at)    ((at)->sat_collective)
321 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
322
323 typedef struct slap_object_class {
324         LDAP_OBJECT_CLASS               soc_oclass;
325         struct slap_object_class        **soc_sups;
326         AttributeType                   **soc_required;
327         AttributeType                   **soc_allowed;
328         struct slap_object_class        *soc_next;
329 #define soc_oid                 soc_oclass.oc_oid
330 #define soc_names               soc_oclass.oc_names
331 #define soc_desc                soc_oclass.oc_desc
332 #define soc_obsolete            soc_oclass.oc_obsolete
333 #define soc_sup_oids            soc_oclass.oc_sup_oids
334 #define soc_kind                soc_oclass.oc_kind
335 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
336 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
337 #define soc_extensions          soc_oclass.oc_extensions
338 } ObjectClass;
339
340
341 /*
342  * represents a recognized attribute description ( type + options )
343  */
344 typedef struct slap_attr_desc {
345         struct berval *ad_cname;        /* canonical name */
346         AttributeType *ad_type;         /* NULL if unknown */
347         char *ad_lang;                          /* NULL if no language tags */
348         unsigned ad_flags;
349 #define SLAP_DESC_NONE          0x0U
350 #define SLAP_DESC_BINARY        0x1U
351 } AttributeDescription;
352
353 #define slap_ad_is_lang(ad)             ( (ad)->ad_lang != NULL )
354 #define slap_ad_is_binary(ad)   ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
355
356 /*
357  * pointers to schema elements used internally
358  */
359 struct slap_internal_schema {
360         /* objectClass */
361         ObjectClass *si_oc_top;
362         ObjectClass *si_oc_extensibleObject;
363         ObjectClass *si_oc_alias;
364         ObjectClass *si_oc_referral;
365         ObjectClass *si_oc_subentry;
366         ObjectClass *si_oc_subschema;
367         ObjectClass *si_oc_rootdse;
368
369         /* objectClass attribute */
370         AttributeDescription *si_ad_objectClass;
371
372         /* operational attributes */
373         AttributeDescription *si_ad_creatorsName;
374         AttributeDescription *si_ad_createTimestamp;
375         AttributeDescription *si_ad_modifiersName;
376         AttributeDescription *si_ad_modifyTimestamp;
377         AttributeDescription *si_ad_subschemaSubentry;
378
379         /* root DSE attributes */
380         AttributeDescription *si_ad_namingContexts;
381         AttributeDescription *si_ad_supportedControl;
382         AttributeDescription *si_ad_supportedExtension;
383         AttributeDescription *si_ad_supportedLDAPVersion;
384         AttributeDescription *si_ad_supportedSASLMechanisms;
385
386         /* subschema subentry attributes */
387         AttributeDescription *si_ad_objectClasses;
388         AttributeDescription *si_ad_attributeTypes;
389         AttributeDescription *si_ad_ldapSyntaxes;
390         AttributeDescription *si_ad_matchingRules;
391         AttributeDescription *si_ad_matchingRulesUse;
392
393         /* Aliases & Referrals */
394         AttributeDescription *si_ad_aliasedObjectName;
395         AttributeDescription *si_ad_ref;
396
397         /* Access Control Internals */
398         AttributeDescription *si_ad_entry;
399         AttributeDescription *si_ad_children;
400 #ifdef SLAPD_ACI_ENABLED
401         AttributeDescription *si_ad_aci;
402 #endif
403
404         /* Other */
405         AttributeDescription *si_ad_userPassword;
406         AttributeDescription *si_ad_authPassword;
407 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
408         AttributeDescription *si_ad_krbName;
409 #endif
410 };
411
412 typedef struct slap_attr_assertion {
413         AttributeDescription    *aa_desc;
414         struct berval *aa_value;
415 } AttributeAssertion;
416
417 typedef struct slap_ss_assertion {
418         AttributeDescription    *sa_desc;
419         struct berval                   *sa_initial;
420         struct berval                   **sa_any;
421         struct berval                   *sa_final;
422 } SubstringsAssertion;
423
424 typedef struct slap_mr_assertion {
425         char                                    *ma_rule;       /* optional */
426         AttributeDescription    *ma_desc;       /* optional */
427         int                                             ma_dnattrs; /* boolean */
428         struct berval                   *ma_value;      /* required */
429 } MatchingRuleAssertion;
430
431
432 /*
433  * represents a search filter
434  */
435
436 typedef struct slap_filter {
437         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
438 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
439 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
440 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
441
442
443         union f_un_u {
444                 /* precomputed result */
445                 ber_int_t f_un_result;
446
447                 /* DN */
448                 char *f_un_dn;
449
450                 /* present */
451                 AttributeDescription *f_un_desc;
452
453                 /* simple value assertion */
454                 AttributeAssertion *f_un_ava;
455
456                 /* substring assertion */
457                 SubstringsAssertion *f_un_ssa;
458
459                 /* matching rule assertion */
460                 MatchingRuleAssertion *f_un_mra;
461
462 #define f_dn                    f_un.f_un_dn
463 #define f_desc                  f_un.f_un_desc
464 #define f_ava                   f_un.f_un_ava
465 #define f_av_desc               f_un.f_un_ava->aa_desc
466 #define f_av_value              f_un.f_un_ava->aa_value
467 #define f_sub                   f_un.f_un_ssa
468 #define f_sub_desc              f_un.f_un_ssa->sa_desc
469 #define f_sub_initial   f_un.f_un_ssa->sa_initial
470 #define f_sub_any               f_un.f_un_ssa->sa_any
471 #define f_sub_final             f_un.f_un_ssa->sa_final
472 #define f_mra                   f_un.f_un_mra
473 #define f_mr_rule               f_un.f_un_mra->ma_rule
474 #define f_mr_desc               f_un.f_un_mra->ma_desc
475 #define f_mr_value              f_un.f_un_mra->ma_value
476 #define f_mr_dnaddrs    f_un.f_un_mra->ma_dnattrs
477
478                 /* and, or, not */
479                 struct slap_filter *f_un_complex;
480         } f_un;
481
482 #define f_result        f_un.f_un_result
483 #define f_and           f_un.f_un_complex
484 #define f_or            f_un.f_un_complex
485 #define f_not           f_un.f_un_complex
486 #define f_list          f_un.f_un_complex
487
488         struct slap_filter      *f_next;
489 } Filter;
490
491 /* compare routines can return undefined */
492 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
493
494 /*
495  * represents an attribute (description + values)
496  */
497 typedef struct slap_attr {
498         AttributeDescription *a_desc;
499         struct berval   **a_vals;
500         struct slap_attr        *a_next;
501 } Attribute;
502
503
504 /*
505  * the id used in the indexes to refer to an entry
506  */
507 typedef unsigned long   ID;
508 #define NOID    ((ID)~0)
509
510 /*
511  * represents an entry in core
512  */
513 typedef struct slap_entry {
514         /*
515          * The ID field should only be changed before entry is
516          * inserted into a cache.  The ID value is backend
517          * specific.
518          */
519         ID              e_id;
520
521         char            *e_dn;          /* DN of this entry */
522         char            *e_ndn;         /* normalized DN of this entry */
523         Attribute       *e_attrs;       /* list of attributes + values */
524
525         /* for use by the backend for any purpose */
526         void*   e_private;
527 } Entry;
528
529 /*
530  * A list of LDAPMods
531  */
532 typedef struct slap_mod {
533         int sm_op;
534         AttributeDescription *sm_desc;
535         struct berval **sm_bvalues;
536 } Modification;
537
538 typedef struct slap_mod_list {
539         Modification sml_mod;
540 #define sml_op          sml_mod.sm_op
541 #define sml_desc        sml_mod.sm_desc
542 #define sml_bvalues     sml_mod.sm_bvalues
543         struct slap_mod_list *sml_next;
544 } Modifications;
545
546 typedef struct slap_ldap_modlist {
547         LDAPMod ml_mod;
548         struct slap_ldap_modlist *ml_next;
549 #define ml_op           ml_mod.mod_op
550 #define ml_type         ml_mod.mod_type
551 #define ml_values       ml_mod.mod_values
552 #define ml_bvalues      ml_mod.mod_bvalues
553 } LDAPModList;
554
555 /*
556  * represents an access control list
557  */
558
559 typedef enum slap_access_e {
560         ACL_INVALID_ACCESS = -1,
561         ACL_NONE = 0,
562         ACL_AUTH,
563         ACL_COMPARE,
564         ACL_SEARCH,
565         ACL_READ,
566         ACL_WRITE
567 } slap_access_t;
568
569 typedef enum slap_control_e {
570         ACL_INVALID_CONTROL     = 0,
571         ACL_STOP,
572         ACL_CONTINUE,
573         ACL_BREAK
574 } slap_control_t;
575
576 typedef enum slap_style_e {
577         ACL_STYLE_REGEX,
578         ACL_STYLE_BASE,
579         ACL_STYLE_ONE,
580         ACL_STYLE_SUBTREE,
581         ACL_STYLE_CHILDREN
582 } slap_style_t;
583
584 typedef unsigned long slap_access_mask_t;
585
586 /* the "by" part */
587 typedef struct slap_access {
588         slap_control_t a_type;
589
590 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
591
592 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
593 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
594 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
595 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
596 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
597 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
598
599 #define ACL_PRIV_MASK                   0x00ffUL
600
601 /* priv flags */
602 #define ACL_PRIV_LEVEL                  0x1000UL
603 #define ACL_PRIV_ADDITIVE               0x2000UL
604 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
605
606 /* invalid privs */
607 #define ACL_PRIV_INVALID                0x0UL
608
609 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
610 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
611 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
612 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
613
614 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
615 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
616
617 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
618
619 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
620
621 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
622 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
623 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
624
625 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
626 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
627 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
628 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
629 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
630 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
631
632 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
633 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
634 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
635 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
636 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
637 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
638 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
639
640 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
641 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
642 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
643 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
644 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
645 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
646
647         slap_access_mask_t      a_mask;
648
649         slap_style_t a_dn_style;
650         char            *a_dn_pat;
651         AttributeDescription    *a_dn_at;
652         int                     a_dn_self;
653
654         slap_style_t a_peername_style;
655         char            *a_peername_pat;
656         slap_style_t a_sockname_style;
657         char            *a_sockname_pat;
658
659         slap_style_t a_domain_style;
660         char            *a_domain_pat;
661         slap_style_t a_sockurl_style;
662         char            *a_sockurl_pat;
663
664 #ifdef SLAPD_ACI_ENABLED
665         AttributeDescription    *a_aci_at;
666 #endif
667
668         /* ACL Groups */
669         slap_style_t a_group_style;
670         char            *a_group_pat;
671         ObjectClass                             *a_group_oc;
672         AttributeDescription    *a_group_at;
673
674         struct slap_access      *a_next;
675 } Access;
676
677 /* the "to" part */
678 typedef struct slap_acl {
679         /* "to" part: the entries this acl applies to */
680         Filter          *acl_filter;
681         slap_style_t acl_dn_style;
682         regex_t         acl_dn_re;
683         char            *acl_dn_pat;
684         char            **acl_attrs;
685
686         /* "by" part: list of who has what access to the entries */
687         Access  *acl_access;
688
689         struct slap_acl *acl_next;
690 } AccessControl;
691
692 /*
693  * replog moddn param structure
694  */
695 struct replog_moddn {
696         char *newrdn;
697         int     deloldrdn;
698         char *newsup;
699 };
700
701 /*
702  * Backend-info
703  * represents a backend 
704  */
705
706 typedef struct slap_backend_info BackendInfo;   /* per backend type */
707 typedef struct slap_backend_db BackendDB;               /* per backend database */
708
709 LIBSLAPD_F (int) nBackendInfo;
710 LIBSLAPD_F (int) nBackendDB;
711 LIBSLAPD_F (BackendInfo *) backendInfo;
712 LIBSLAPD_F (BackendDB *) backendDB;
713
714 LIBSLAPD_F (int) slapMode;      
715 #define SLAP_UNDEFINED_MODE     0x0000
716 #define SLAP_SERVER_MODE        0x0001
717 #define SLAP_TOOL_MODE          0x0002
718 #define SLAP_MODE                       0x0003
719
720 #define SLAP_TRUNCATE_MODE      0x0100
721
722 /* temporary aliases */
723 typedef BackendDB Backend;
724 #define nbackends nBackendDB
725 #define backends backendDB
726
727 struct slap_backend_db {
728         BackendInfo     *bd_info;       /* pointer to shared backend info */
729
730         /* BackendInfo accessors */
731 #define         be_config       bd_info->bi_db_config
732 #define         be_type         bd_info->bi_type
733
734 #define         be_bind         bd_info->bi_op_bind
735 #define         be_unbind       bd_info->bi_op_unbind
736 #define         be_add          bd_info->bi_op_add
737 #define         be_compare      bd_info->bi_op_compare
738 #define         be_delete       bd_info->bi_op_delete
739 #define         be_modify       bd_info->bi_op_modify
740 #define         be_modrdn       bd_info->bi_op_modrdn
741 #define         be_search       bd_info->bi_op_search
742
743 #define         be_extended     bd_info->bi_extended
744
745 #define         be_release      bd_info->bi_entry_release_rw
746 #define         be_chk_referrals        bd_info->bi_chk_referrals
747 #define         be_group        bd_info->bi_acl_group
748
749 #define         be_controls     bd_info->bi_controls
750
751 #define         be_connection_init      bd_info->bi_connection_init
752 #define         be_connection_destroy   bd_info->bi_connection_destroy
753
754 #ifdef SLAPD_TOOLS
755 #define         be_entry_open bd_info->bi_tool_entry_open
756 #define         be_entry_close bd_info->bi_tool_entry_close
757 #define         be_entry_first bd_info->bi_tool_entry_first
758 #define         be_entry_next bd_info->bi_tool_entry_next
759 #define         be_entry_get bd_info->bi_tool_entry_get
760 #define         be_entry_put bd_info->bi_tool_entry_put
761 #define         be_index_attr bd_info->bi_tool_index_attr
762 #define         be_index_change bd_info->bi_tool_index_change
763 #define         be_sync bd_info->bi_tool_sync
764 #endif
765
766 #ifdef HAVE_CYRUS_SASL
767 #define         be_sasl_authorize bd_info->bi_sasl_authorize
768 #define         be_sasl_getsecret bd_info->bi_sasl_getsecret
769 #define         be_sasl_putsecret bd_info->bi_sasl_putsecret
770 #endif
771
772         /* these should be renamed from be_ to bd_ */
773         char    **be_suffix;    /* the DN suffixes of data in this backend */
774         char    **be_nsuffix;   /* the normalized DN suffixes in this backend */
775         char    **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
776         char    *be_root_dn;    /* the magic "root" dn for this db      */
777         char    *be_root_ndn;   /* the magic "root" normalized dn for this db   */
778         struct berval be_root_pw;       /* the magic "root" password for this db        */
779         int     be_readonly;    /* 1 => db is in "read only" mode          */
780         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
781         int     be_sizelimit;   /* size limit for this backend             */
782         int     be_timelimit;   /* time limit for this backend             */
783         AccessControl *be_acl;  /* access control list for this backend    */
784         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
785         char    **be_replica;   /* replicas of this backend (in master)    */
786         char    *be_replogfile; /* replication log file (in master)        */
787         char    *be_update_ndn; /* allowed to make changes (in replicas) */
788         struct berval **be_update_refs; /* where to refer modifying clients to */
789         int     be_lastmod;     /* keep track of lastmodified{by,time}     */
790
791         char    *be_realm;
792
793         void    *be_private;    /* anything the backend database needs     */
794 };
795
796 struct slap_conn;
797 struct slap_op;
798
799 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
800     Backend             *be,
801     struct slap_conn            *conn,
802     struct slap_op              *op,
803         const char              *reqoid,
804     struct berval * reqdata,
805         char            **rspoid,
806     struct berval ** rspdata,
807         LDAPControl *** rspctrls,
808         const char **   text,
809         struct berval *** refs ));
810
811 struct slap_backend_info {
812         char    *bi_type;       /* type of backend */
813
814         /*
815          * per backend type routines:
816          * bi_init: called to allocate a backend_info structure,
817          *              called once BEFORE configuration file is read.
818          *              bi_init() initializes this structure hence is
819          *              called directly from be_initialize()
820          * bi_config: called per 'backend' specific option
821          *              all such options must before any 'database' options
822          *              bi_config() is called only from read_config()
823          * bi_open: called to open each database, called
824          *              once AFTER configuration file is read but
825          *              BEFORE any bi_db_open() calls.
826          *              bi_open() is called from backend_startup()
827          * bi_close: called to close each database, called
828          *              once during shutdown after all bi_db_close calls.
829          *              bi_close() is called from backend_shutdown()
830          * bi_destroy: called to destroy each database, called
831          *              once during shutdown after all bi_db_destroy calls.
832          *              bi_destory() is called from backend_destroy()
833          */
834         int (*bi_init)  LDAP_P((BackendInfo *bi));
835         int     (*bi_config) LDAP_P((BackendInfo *bi,
836                 const char *fname, int lineno, int argc, char **argv ));
837         int (*bi_open) LDAP_P((BackendInfo *bi));
838         int (*bi_close) LDAP_P((BackendInfo *bi));
839         int (*bi_destroy) LDAP_P((BackendInfo *bi));
840
841         /*
842          * per database routines:
843          * bi_db_init: called to initialize each database,
844          *      called upon reading 'database <type>' 
845          *      called only from backend_db_init()
846          * bi_db_config: called to configure each database,
847          *  called per database to handle per database options
848          *      called only from read_config()
849          * bi_db_open: called to open each database
850          *      called once per database immediately AFTER bi_open()
851          *      calls but before daemon startup.
852          *  called only by backend_startup()
853          * bi_db_close: called to close each database
854          *      called once per database during shutdown but BEFORE
855          *  any bi_close call.
856          *  called only by backend_shutdown()
857          * bi_db_destroy: called to destroy each database
858          *  called once per database during shutdown AFTER all
859          *  bi_close calls but before bi_destory calls.
860          *  called only by backend_destory()
861          */
862         int (*bi_db_init) LDAP_P((Backend *bd));
863         int     (*bi_db_config) LDAP_P((Backend *bd,
864                 const char *fname, int lineno, int argc, char **argv ));
865         int (*bi_db_open) LDAP_P((Backend *bd));
866         int (*bi_db_close) LDAP_P((Backend *bd));
867         int (*bi_db_destroy) LDAP_P((Backend *db));
868
869         /* LDAP Operations Handling Routines */
870         int     (*bi_op_bind)  LDAP_P(( BackendDB *bd,
871                 struct slap_conn *c, struct slap_op *o,
872                 const char *dn, const char *ndn, int method,
873                 struct berval *cred, char** edn ));
874         int (*bi_op_unbind) LDAP_P((BackendDB *bd,
875                 struct slap_conn *c, struct slap_op *o ));
876         int     (*bi_op_search) LDAP_P((BackendDB *bd,
877                 struct slap_conn *c, struct slap_op *o,
878                 const char *base, const char *nbase,
879                 int scope, int deref,
880                 int slimit, int tlimit,
881                 Filter *f, const char *filterstr,
882                 char **attrs, int attrsonly));
883         int     (*bi_op_compare)LDAP_P((BackendDB *bd,
884                 struct slap_conn *c, struct slap_op *o,
885                 const char *dn, const char *ndn,
886                 AttributeAssertion *ava));
887         int     (*bi_op_modify) LDAP_P((BackendDB *bd,
888                 struct slap_conn *c, struct slap_op *o,
889                 const char *dn, const char *ndn, Modifications *m));
890         int     (*bi_op_modrdn) LDAP_P((BackendDB *bd,
891                 struct slap_conn *c, struct slap_op *o,
892                 const char *dn, const char *ndn,
893                 const char *newrdn, int deleteoldrdn,
894                 const char *newSuperior));
895         int     (*bi_op_add)    LDAP_P((BackendDB *bd,
896                 struct slap_conn *c, struct slap_op *o,
897                 Entry *e));
898         int     (*bi_op_delete) LDAP_P((BackendDB *bd,
899                 struct slap_conn *c, struct slap_op *o,
900                 const char *dn, const char *ndn));
901         int     (*bi_op_abandon) LDAP_P((BackendDB *bd,
902                 struct slap_conn *c, struct slap_op *o,
903                 ber_int_t msgid));
904
905         /* Extended Operations Helper */
906         SLAP_EXTENDED_FN bi_extended;
907
908         /* Auxilary Functions */
909         int     (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
910
911         int     (*bi_chk_referrals) LDAP_P((BackendDB *bd,
912                 struct slap_conn *c, struct slap_op *o,
913                 const char *dn, const char *ndn,
914                 const char **text ));
915
916         int     (*bi_acl_group)  LDAP_P((Backend *bd,
917                 Entry *e, const char *bdn, const char *edn,
918                 ObjectClass *group_oc,
919                 AttributeDescription *group_at ));
920
921         int     (*bi_connection_init) LDAP_P((BackendDB *bd,
922                 struct slap_conn *c));
923         int     (*bi_connection_destroy) LDAP_P((BackendDB *bd,
924                 struct slap_conn *c));
925
926         /* hooks for slap tools */
927         int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
928         int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
929         ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
930         ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
931         Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
932         ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
933         int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
934                 AttributeDescription *desc ));
935         int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
936                 AttributeDescription *desc,
937                 struct berval **bv, ID id, int op ));
938         int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
939
940 #ifdef HAVE_CYRUS_SASL
941         int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
942                 const char *authnid, const char *authzid,
943                 const char **canon_authzid, const char **errstr ));
944         int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
945                 const char *mechanism, const char *authzid,
946                 const char *realm, sasl_secret_t **secret ));
947         int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
948                 const char *mechanism, const char *auth_identity,
949                 const char *realm, const sasl_secret_t *secret ));
950 #endif /* HAVE_CYRUS_SASL */
951
952 #define SLAP_INDEX_ADD_OP               0x0001
953 #define SLAP_INDEX_DELETE_OP    0x0002
954
955         char **bi_controls;             /* supported controls */
956
957         unsigned int bi_nDB;    /* number of databases of this type */
958         void    *bi_private;    /* anything the backend type needs */
959 };
960
961 /*
962  * represents an operation pending from an ldap client
963  */
964
965 typedef struct slap_op {
966         ber_int_t       o_opid;         /* id of this operation           */
967         ber_int_t       o_msgid;        /* msgid of the request           */
968
969         ldap_pvt_thread_t       o_tid;          /* thread handling this op        */
970
971         BerElement      *o_ber;         /* ber of the request             */
972
973         ber_tag_t       o_tag;          /* tag of the request             */
974         time_t          o_time;         /* time op was initiated          */
975
976 #ifdef SLAP_AUTHZID
977         /* should only be used for reporting purposes */
978         char    *o_authc_dn;    /* authentication DN */
979
980         /* should be used as the DN of the User */
981         char    *o_authz_dn;    /* authorization DN */
982         char    *o_authz_ndn;   /* authorizaiton NDN */
983
984 #else
985         char            *o_dn;          /* dn bound when op was initiated */
986         char            *o_ndn;         /* normalized dn bound when op was initiated */
987 #endif
988
989         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
990         ber_tag_t       o_authtype;     /* auth method used to bind dn    */
991                                         /* values taken from ldap.h       */
992                                         /* LDAP_AUTH_*                    */
993         char            *o_authmech; /* SASL mechanism used to bind dn */
994
995         LDAPControl     **o_ctrls;       /* controls */
996
997         unsigned long   o_connid; /* id of conn initiating this op  */
998
999 #ifdef LDAP_CONNECTIONLESS
1000         int             o_cldap;        /* != 0 if this came in via CLDAP */
1001         struct sockaddr o_clientaddr;   /* client address if via CLDAP    */
1002         char            o_searchbase;   /* search base if via CLDAP       */
1003 #endif
1004
1005         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
1006         int             o_abandon;      /* abandon flag */
1007
1008         struct slap_op  *o_next;        /* next operation in list         */
1009         void    *o_private;     /* anything the backend needs     */
1010 } Operation;
1011
1012 /*
1013  * represents a connection from an ldap client
1014  */
1015
1016 typedef struct slap_conn {
1017         int                     c_struct_state; /* structure management state */
1018         int                     c_conn_state;   /* connection state */
1019
1020         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1021         Sockbuf         *c_sb;                  /* ber connection stuff           */
1022
1023         /* only can be changed by connect_init */
1024         time_t          c_starttime;    /* when the connection was opened */
1025         time_t          c_activitytime; /* when the connection was last used */
1026         unsigned long           c_connid;       /* id of this connection for stats*/
1027
1028         char            *c_listener_url;        /* listener URL */
1029         char            *c_peer_domain; /* DNS name of client */
1030         char            *c_peer_name;   /* peer name (trans=addr:port) */
1031         char            *c_sock_name;   /* sock name (trans=addr:port) */
1032
1033         /* only can be changed by binding thread */
1034         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1035         char    *c_sasl_bind_mech;                      /* mech in progress */
1036 #ifdef HAVE_CYRUS_SASL
1037         sasl_conn_t     *c_sasl_bind_context;   /* Cyrus SASL state data */
1038 #endif
1039
1040         /* authentication backend */
1041         Backend *c_authc_backend;
1042
1043         /* authorization backend - normally same as c_authc_backend */
1044         Backend *c_authz_backend;
1045
1046 #ifdef SLAP_AUTHZID
1047         /* authentication backend */
1048         /* should only be used for reporting purposes */
1049         char    *c_authc_dn;    /* authentication DN */
1050
1051         /* should be used as the DN of the User */
1052         char    *c_authz_dn;    /* authorization DN */
1053         char    *c_authz_ndn;   /* authorization NDN */
1054
1055 #else
1056         char    *c_cdn;         /* DN provided by the client */
1057         char    *c_dn;          /* DN bound to this conn  */
1058 #endif
1059
1060         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1061         ber_tag_t       c_authtype;/* auth method used to bind c_dn  */
1062         char    *c_authmech;    /* SASL mechanism used to bind c_dn */
1063
1064         Operation       *c_ops;                 /* list of operations being processed */
1065         Operation       *c_pending_ops; /* list of pending operations */
1066
1067         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1068         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1069
1070         BerElement      *c_currentber;  /* ber we're attempting to read */
1071         int             c_writewaiter;  /* true if writer is waiting */
1072
1073 #ifdef HAVE_TLS
1074         int     c_is_tls;               /* true if this LDAP over raw TLS */
1075         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1076 #endif
1077
1078         long    c_n_ops_received;               /* num of ops received (next op_id) */
1079         long    c_n_ops_executing;      /* num of ops currently executing */
1080         long    c_n_ops_pending;                /* num of ops pending execution */
1081         long    c_n_ops_completed;      /* num of ops completed */
1082
1083         long    c_n_get;                /* num of get calls */
1084         long    c_n_read;               /* num of read calls */
1085         long    c_n_write;              /* num of write calls */
1086 } Connection;
1087
1088 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1089 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1090         do { \
1091                 if ( ldap_debug & (level) ) \
1092                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1093                 if ( ldap_syslog & (level) ) \
1094                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1095                                 (arg2), (arg3) ); \
1096         } while (0)
1097 #else
1098 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1099 #endif
1100
1101 LDAP_END_DECL
1102
1103 #include "proto-slap.h"
1104
1105 #endif /* _SLAP_H_ */