]> git.sur5r.net Git - openldap/blob - servers/slapd/back-meta/back-meta.h
Sync with HEAD for OL 2.4.5
[openldap] / servers / slapd / back-meta / back-meta.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 1999-2007 The OpenLDAP Foundation.
5  * Portions Copyright 2001-2003 Pierangelo Masarati.
6  * Portions Copyright 1999-2003 Howard Chu.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted only as authorized by the OpenLDAP
11  * Public License.
12  *
13  * A copy of this license is available in the file LICENSE in the
14  * top-level directory of the distribution or, alternatively, at
15  * <http://www.OpenLDAP.org/license.html>.
16  */
17 /* ACKNOWLEDGEMENTS:
18  * This work was initially developed by the Howard Chu for inclusion
19  * in OpenLDAP Software and subsequently enhanced by Pierangelo
20  * Masarati.
21  */
22
23 #ifndef SLAPD_LDAP_H
24 #error "include servers/slapd/back-ldap/back-ldap.h before this file!"
25 #endif /* SLAPD_LDAP_H */
26
27 #ifndef SLAPD_META_H
28 #define SLAPD_META_H
29
30 #include "proto-meta.h"
31
32 /* String rewrite library */
33 #include "rewrite.h"
34
35 LDAP_BEGIN_DECL
36
37 /*
38  * Set META_BACK_PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
39  */
40 #ifndef META_BACK_PRINT_CONNTREE
41 #define META_BACK_PRINT_CONNTREE 0
42 #endif /* !META_BACK_PRINT_CONNTREE */
43
44 /* from back-ldap.h before rwm removal */
45 struct ldapmap {
46         int drop_missing;
47
48         Avlnode *map;
49         Avlnode *remap;
50 };
51
52 struct ldapmapping {
53         struct berval src;
54         struct berval dst;
55 };
56
57 struct ldaprwmap {
58         /*
59          * DN rewriting
60          */
61 #ifdef ENABLE_REWRITE
62         struct rewrite_info *rwm_rw;
63 #else /* !ENABLE_REWRITE */
64         /* some time the suffix massaging without librewrite
65          * will be disabled */
66         BerVarray rwm_suffix_massage;
67 #endif /* !ENABLE_REWRITE */
68
69         /*
70          * Attribute/objectClass mapping
71          */
72         struct ldapmap rwm_oc;
73         struct ldapmap rwm_at;
74 };
75
76 /* Whatever context ldap_back_dn_massage needs... */
77 typedef struct dncookie {
78         struct metatarget_t     *target;
79
80 #ifdef ENABLE_REWRITE
81         Connection              *conn;
82         char                    *ctx;
83         SlapReply               *rs;
84 #else
85         int                     normalized;
86         int                     tofrom;
87 #endif
88 } dncookie;
89
90 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
91         struct berval *res);
92
93 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
94 extern int ldap_back_conn_dup( void *c1, void *c2 );
95 extern void ldap_back_conn_free( void *c );
96
97 /* attributeType/objectClass mapping */
98 int mapping_cmp (const void *, const void *);
99 int mapping_dup (void *, void *);
100
101 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
102 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
103         struct ldapmapping **m, int remap );
104 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
105         int remap );
106 #define BACKLDAP_MAP    0
107 #define BACKLDAP_REMAP  1
108 char *
109 ldap_back_map_filter(
110         struct ldapmap *at_map,
111         struct ldapmap *oc_map,
112         struct berval *f,
113         int remap );
114
115 int
116 ldap_back_map_attrs(
117         struct ldapmap *at_map,
118         AttributeName *a,
119         int remap,
120         char ***mapped_attrs );
121
122 extern int ldap_back_map_config(
123         struct ldapmap  *oc_map,
124         struct ldapmap  *at_map,
125         const char      *fname,
126         int             lineno,
127         int             argc,
128         char            **argv );
129
130 extern int
131 ldap_back_filter_map_rewrite(
132         dncookie        *dc,
133         Filter          *f,
134         struct berval   *fstr,
135         int             remap );
136
137 /* suffix massaging by means of librewrite */
138 #ifdef ENABLE_REWRITE
139 extern int
140 suffix_massage_config( struct rewrite_info *info,
141         struct berval *pvnc,
142         struct berval *nvnc,
143         struct berval *prnc,
144         struct berval *nrnc );
145 #endif /* ENABLE_REWRITE */
146 extern int
147 ldap_back_referral_result_rewrite(
148         dncookie        *dc,
149         BerVarray       a_vals );
150 extern int
151 ldap_dnattr_rewrite(
152         dncookie        *dc,
153         BerVarray       a_vals );
154 extern int
155 ldap_dnattr_result_rewrite(
156         dncookie        *dc,
157         BerVarray       a_vals );
158
159 /* (end of) from back-ldap.h before rwm removal */
160
161 /*
162  * A metasingleconn_t can be in the following, mutually exclusive states:
163  *
164  *      - none                  (0x0U)
165  *      - creating              META_BACK_FCONN_CREATING
166  *      - initialized           META_BACK_FCONN_INITED
167  *      - binding               LDAP_BACK_FCONN_BINDING
168  *      - bound/anonymous       LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON
169  *
170  * possible modifiers are:
171  *
172  *      - privileged            LDAP_BACK_FCONN_ISPRIV
173  *      - privileged, TLS       LDAP_BACK_FCONN_ISTLS
174  *      - subjected to idassert LDAP_BACK_FCONN_ISIDASR
175  *      - tainted               LDAP_BACK_FCONN_TAINTED
176  */
177
178 #define META_BACK_FCONN_INITED          (0x00100000U)
179 #define META_BACK_FCONN_CREATING        (0x00200000U)
180
181 #define META_BACK_CONN_INITED(lc)               LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED)
182 #define META_BACK_CONN_INITED_SET(lc)           LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED)
183 #define META_BACK_CONN_INITED_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED)
184 #define META_BACK_CONN_INITED_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc))
185 #define META_BACK_CONN_CREATING(lc)             LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING)
186 #define META_BACK_CONN_CREATING_SET(lc)         LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING)
187 #define META_BACK_CONN_CREATING_CLEAR(lc)       LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING)
188 #define META_BACK_CONN_CREATING_CPY(lc, mlc)    LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc))
189
190 struct metainfo_t;
191
192 #define META_NOT_CANDIDATE              ((ber_tag_t)0x0)
193 #define META_CANDIDATE                  ((ber_tag_t)0x1)
194 #define META_BINDING                    ((ber_tag_t)0x2)
195 #define META_RETRYING                   ((ber_tag_t)0x4)
196
197 typedef struct metasingleconn_t {
198 #define META_CND_ISSET(rs,f)            ( ( (rs)->sr_tag & (f) ) == (f) )
199 #define META_CND_SET(rs,f)              ( (rs)->sr_tag |= (f) )
200 #define META_CND_CLEAR(rs,f)            ( (rs)->sr_tag &= ~(f) )
201
202 #define META_CANDIDATE_RESET(rs)        ( (rs)->sr_tag = 0 )
203 #define META_IS_CANDIDATE(rs)           META_CND_ISSET( (rs), META_CANDIDATE )
204 #define META_CANDIDATE_SET(rs)          META_CND_SET( (rs), META_CANDIDATE )
205 #define META_CANDIDATE_CLEAR(rs)        META_CND_CLEAR( (rs), META_CANDIDATE )
206 #define META_IS_BINDING(rs)             META_CND_ISSET( (rs), META_BINDING )
207 #define META_BINDING_SET(rs)            META_CND_SET( (rs), META_BINDING )
208 #define META_BINDING_CLEAR(rs)          META_CND_CLEAR( (rs), META_BINDING )
209 #define META_IS_RETRYING(rs)            META_CND_ISSET( (rs), META_RETRYING )
210 #define META_RETRYING_SET(rs)           META_CND_SET( (rs), META_RETRYING )
211 #define META_RETRYING_CLEAR(rs)         META_CND_CLEAR( (rs), META_RETRYING )
212         
213         LDAP                    *msc_ld;
214         time_t                  msc_time;
215         struct berval           msc_bound_ndn;
216         struct berval           msc_cred;
217         unsigned                msc_mscflags;
218         /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
219          * defined for back-ldap */
220 #define lc_lcflags              msc_mscflags
221 } metasingleconn_t;
222
223 typedef struct metaconn_t {
224         Connection              *mc_conn;
225 #define lc_conn                 mc_conn
226         unsigned                mc_refcnt;
227
228         time_t                  mc_create_time;
229         time_t                  mc_time;
230         
231         struct berval           mc_local_ndn;
232         /* NOTE: msc_mscflags is used to recycle the #define
233          * in metasingleconn_t */
234         unsigned                msc_mscflags;
235
236         /*
237          * means that the connection is bound; 
238          * of course only one target actually is ...
239          */
240         int                     mc_authz_target;
241 #define META_BOUND_NONE         (-1)
242 #define META_BOUND_ALL          (-2)
243
244         struct metainfo_t       *mc_info;
245
246         LDAP_TAILQ_ENTRY(metaconn_t)    mc_q;
247
248         /* supersedes the connection stuff */
249         metasingleconn_t        mc_conns[ 1 ];
250         /* NOTE: mc_conns must be last, because
251          * the required number of conns is malloc'ed
252          * in one block with the metaconn_t structure */
253 } metaconn_t;
254
255 typedef struct metatarget_t {
256         char                    *mt_uri;
257         ldap_pvt_thread_mutex_t mt_uri_mutex;
258
259         /* TODO: we might want to enable different strategies
260          * for different targets */
261         LDAP_REBIND_PROC        *mt_rebind_f;
262         LDAP_URLLIST_PROC       *mt_urllist_f;
263         void                    *mt_urllist_p;
264
265         BerVarray               mt_subtree_exclude;
266         int                     mt_scope;
267
268         struct berval           mt_psuffix;             /* pretty suffix */
269         struct berval           mt_nsuffix;             /* normalized suffix */
270
271         struct berval           mt_binddn;
272         struct berval           mt_bindpw;
273
274         slap_idassert_t         mt_idassert;
275 #define mt_idassert_mode        mt_idassert.si_mode
276 #define mt_idassert_authcID     mt_idassert.si_bc.sb_authcId
277 #define mt_idassert_authcDN     mt_idassert.si_bc.sb_binddn
278 #define mt_idassert_passwd      mt_idassert.si_bc.sb_cred
279 #define mt_idassert_authzID     mt_idassert.si_bc.sb_authzId
280 #define mt_idassert_authmethod  mt_idassert.si_bc.sb_method
281 #define mt_idassert_sasl_mech   mt_idassert.si_bc.sb_saslmech
282 #define mt_idassert_sasl_realm  mt_idassert.si_bc.sb_realm
283 #define mt_idassert_secprops    mt_idassert.si_bc.sb_secprops
284 #define mt_idassert_tls         mt_idassert.si_bc.sb_tls
285 #define mt_idassert_flags       mt_idassert.si_flags
286 #define mt_idassert_authz       mt_idassert.si_authz
287
288         int                     mt_nretries;
289 #define META_RETRY_UNDEFINED    (-2)
290 #define META_RETRY_FOREVER      (-1)
291 #define META_RETRY_NEVER        (0)
292 #define META_RETRY_DEFAULT      (10)
293
294         struct ldaprwmap        mt_rwmap;
295
296         sig_atomic_t            mt_isquarantined;
297         slap_retry_info_t       mt_quarantine;
298         ldap_pvt_thread_mutex_t mt_quarantine_mutex;
299
300         unsigned                mt_flags;
301 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
302 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
303
304 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
305 #define META_BACK_TGT_T_F_DISCOVER(mt)          META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
306
307 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
308 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
309 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
310 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
311 #define META_BACK_TGT_QUARANTINE(mt)            META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_QUARANTINE )
312
313 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
314 #define META_BACK_TGT_ST_REQUEST(mt)            META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_REQUEST )
315 #define META_BACK_TGT_ST_RESPONSE(mt)           META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_RESPONSE )
316 #endif /* SLAP_CONTROL_X_SESSION_TRACKING */
317
318         int                     mt_version;
319         time_t                  mt_network_timeout;
320         struct timeval          mt_bind_timeout;
321 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
322         time_t                  mt_timeout[ SLAP_OP_LAST ];
323 } metatarget_t;
324
325 typedef struct metadncache_t {
326         ldap_pvt_thread_mutex_t mutex;
327         Avlnode                 *tree;
328
329 #define META_DNCACHE_DISABLED   (0)
330 #define META_DNCACHE_FOREVER    ((time_t)(-1))
331         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
332 } metadncache_t;
333
334 typedef struct metacandidates_t {
335         int                     mc_ntargets;
336         SlapReply               *mc_candidates;
337 } metacandidates_t;
338
339 /*
340  * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
341  */
342 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
343
344 typedef struct metainfo_t {
345         int                     mi_ntargets;
346         int                     mi_defaulttarget;
347 #define META_DEFAULT_TARGET_NONE        (-1)
348         int                     mi_nretries;
349
350         metatarget_t            **mi_targets;
351         metacandidates_t        *mi_candidates;
352
353         LDAP_REBIND_PROC        *mi_rebind_f;
354         LDAP_URLLIST_PROC       *mi_urllist_f;
355
356         metadncache_t           mi_cache;
357         
358         /* cached connections; 
359          * special conns are in tailq rather than in tree */
360         ldap_avl_info_t         mi_conninfo;
361         struct {
362                 int                                             mic_num;
363                 LDAP_TAILQ_HEAD(mc_conn_priv_q, metaconn_t)     mic_priv;
364         }                       mi_conn_priv[ LDAP_BACK_PCONN_LAST ];
365         int                     mi_conn_priv_max;
366
367         /* NOTE: quarantine uses the connection mutex */
368         slap_retry_info_t       mi_quarantine;
369         meta_back_quarantine_f  mi_quarantine_f;
370         void                    *mi_quarantine_p;
371
372         unsigned                mi_flags;
373 #define li_flags                mi_flags
374 /* uses flags as defined in <back-ldap/back-ldap.h> */
375 #define META_BACK_F_ONERR_STOP          (0x00100000U)
376 #define META_BACK_F_ONERR_REPORT        (0x00200000U)
377 #define META_BACK_F_ONERR_MASK          (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT)
378 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x00400000U)
379 #define META_BACK_F_PROXYAUTHZ_ALWAYS   (0x00800000U)   /* users always proxyauthz */
380 #define META_BACK_F_PROXYAUTHZ_ANON     (0x01000000U)   /* anonymous always proxyauthz */
381 #define META_BACK_F_PROXYAUTHZ_NOANON   (0x02000000U)   /* anonymous remains anonymous */
382
383 #define META_BACK_ONERR_STOP(mi)        LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_STOP )
384 #define META_BACK_ONERR_REPORT(mi)      LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_REPORT )
385 #define META_BACK_ONERR_CONTINUE(mi)    ( !LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_MASK ) )
386
387 #define META_BACK_DEFER_ROOTDN_BIND(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_DEFER_ROOTDN_BIND )
388 #define META_BACK_PROXYAUTHZ_ALWAYS(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ALWAYS )
389 #define META_BACK_PROXYAUTHZ_ANON(mi)   LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ANON )
390 #define META_BACK_PROXYAUTHZ_NOANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_NOANON )
391
392 #define META_BACK_QUARANTINE(mi)        LDAP_BACK_ISSET( (mi), LDAP_BACK_F_QUARANTINE )
393
394         int                     mi_version;
395         time_t                  mi_network_timeout;
396         time_t                  mi_conn_ttl;
397         time_t                  mi_idle_timeout;
398         struct timeval          mi_bind_timeout;
399         time_t                  mi_timeout[ SLAP_OP_LAST ];
400 } metainfo_t;
401
402 typedef enum meta_op_type {
403         META_OP_ALLOW_MULTIPLE = 0,
404         META_OP_REQUIRE_SINGLE,
405         META_OP_REQUIRE_ALL
406 } meta_op_type;
407
408 SlapReply *
409 meta_back_candidates_get( Operation *op );
410
411 extern metaconn_t *
412 meta_back_getconn(
413         Operation               *op,
414         SlapReply               *rs,
415         int                     *candidate,
416         ldap_back_send_t        sendok );
417
418 extern void
419 meta_back_release_conn_lock(
420         metainfo_t              *mi,
421         metaconn_t              *mc,
422         int                     dolock );
423 #define meta_back_release_conn(mi, mc)  meta_back_release_conn_lock( (mi), (mc), 1 )
424
425 extern int
426 meta_back_retry(
427         Operation               *op,
428         SlapReply               *rs,
429         metaconn_t              **mcp,
430         int                     candidate,
431         ldap_back_send_t        sendok );
432
433 extern void
434 meta_back_conn_free(
435         void                    *v_mc );
436
437 #if META_BACK_PRINT_CONNTREE > 0
438 extern void
439 meta_back_print_conntree(
440         metainfo_t              *mi,
441         char                    *msg );
442 #endif
443
444 extern int
445 meta_back_init_one_conn(
446         Operation               *op,
447         SlapReply               *rs,
448         metaconn_t              *mc,
449         int                     candidate,
450         int                     ispriv,
451         ldap_back_send_t        sendok,
452         int                     dolock );
453
454 extern void
455 meta_back_quarantine(
456         Operation               *op,
457         SlapReply               *rs,
458         int                     candidate );
459
460 extern int
461 meta_back_dobind(
462         Operation               *op,
463         SlapReply               *rs,
464         metaconn_t              *mc,
465         ldap_back_send_t        sendok );
466
467 extern int
468 meta_back_single_dobind(
469         Operation               *op,
470         SlapReply               *rs,
471         metaconn_t              **mcp,
472         int                     candidate,
473         ldap_back_send_t        sendok,
474         int                     retries,
475         int                     dolock );
476
477 extern int
478 meta_back_proxy_authz_cred(
479         metaconn_t              *mc,
480         int                     candidate,
481         Operation               *op,
482         SlapReply               *rs,
483         ldap_back_send_t        sendok,
484         struct berval           *binddn,
485         struct berval           *bindcred,
486         int                     *method );
487
488 extern int
489 meta_back_cancel(
490         metaconn_t              *mc,
491         Operation               *op,
492         SlapReply               *rs,
493         ber_int_t               msgid,
494         int                     candidate,
495         ldap_back_send_t        sendok );
496
497 extern int
498 meta_back_op_result(
499         metaconn_t              *mc,
500         Operation               *op,
501         SlapReply               *rs,
502         int                     candidate,
503         ber_int_t               msgid,
504         time_t                  timeout,
505         ldap_back_send_t        sendok );
506
507 extern int
508 back_meta_LTX_init_module(
509         int                     argc,
510         char                    *argv[] );
511
512 extern int
513 meta_back_conn_cmp(
514         const void              *c1,
515         const void              *c2 );
516
517 extern int
518 meta_back_conndn_cmp(
519         const void              *c1,
520         const void              *c2 );
521
522 extern int
523 meta_back_conndn_dup(
524         void                    *c1,
525         void                    *c2 );
526
527 /*
528  * Candidate stuff
529  */
530 extern int
531 meta_back_is_candidate(
532         metatarget_t            *mt,
533         struct berval           *ndn,
534         int                     scope );
535
536 extern int
537 meta_back_select_unique_candidate(
538         metainfo_t              *mi,
539         struct berval           *ndn );
540
541 extern int
542 meta_clear_unused_candidates(
543         Operation               *op,
544         int                     candidate );
545
546 extern int
547 meta_clear_one_candidate(
548         Operation               *op,
549         metaconn_t              *mc,
550         int                     candidate );
551
552 /*
553  * Dn cache stuff (experimental)
554  */
555 extern int
556 meta_dncache_cmp(
557         const void              *c1,
558         const void              *c2 );
559
560 extern int
561 meta_dncache_dup(
562         void                    *c1,
563         void                    *c2 );
564
565 #define META_TARGET_NONE        (-1)
566 #define META_TARGET_MULTIPLE    (-2)
567 extern int
568 meta_dncache_get_target(
569         metadncache_t           *cache,
570         struct berval           *ndn );
571
572 extern int
573 meta_dncache_update_entry(
574         metadncache_t           *cache,
575         struct berval           *ndn,
576         int                     target );
577
578 extern int
579 meta_dncache_delete_entry(
580         metadncache_t           *cache,
581         struct berval           *ndn );
582
583 extern void
584 meta_dncache_free( void *entry );
585
586 extern LDAP_REBIND_PROC         meta_back_default_rebind;
587 extern LDAP_URLLIST_PROC        meta_back_default_urllist;
588
589 LDAP_END_DECL
590
591 #endif /* SLAPD_META_H */
592