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