git.sur5r.net Git - openldap/blob - 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-2006 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 LDAP_BEGIN_DECL
  35
  36 struct slap_conn;
  37 struct slap_op;
  38
  39 /* from back-ldap.h before rwm removal */
  40 struct ldapmap {
  41         int drop_missing;
  42
  43         Avlnode *map;
  44         Avlnode *remap;
  45 };
  46
  47 struct ldapmapping {
  48         struct berval src;
  49         struct berval dst;
  50 };
  51
  52 struct ldaprwmap {
  53         /*
  54          * DN rewriting
  55          */
  56 #ifdef ENABLE_REWRITE
  57         struct rewrite_info *rwm_rw;
  58 #else /* !ENABLE_REWRITE */
  59         /* some time the suffix massaging without librewrite
  60          * will be disabled */
  61         BerVarray rwm_suffix_massage;
  62 #endif /* !ENABLE_REWRITE */
  63
  64         /*
  65          * Attribute/objectClass mapping
  66          */
  67         struct ldapmap rwm_oc;
  68         struct ldapmap rwm_at;
  69 };
  70
  71 /* Whatever context ldap_back_dn_massage needs... */
  72 typedef struct dncookie {
  73         struct metatarget_t     *target;
  74
  75 #ifdef ENABLE_REWRITE
  76         Connection              *conn;
  77         char                    *ctx;
  78         SlapReply               *rs;
  79 #else
  80         int                     normalized;
  81         int                     tofrom;
  82 #endif
  83 } dncookie;
  84
  85 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
  86         struct berval *res);
  87
  88 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
  89 extern int ldap_back_conn_dup( void *c1, void *c2 );
  90 extern void ldap_back_conn_free( void *c );
  91
  92 /* attributeType/objectClass mapping */
  93 int mapping_cmp (const void *, const void *);
  94 int mapping_dup (void *, void *);
  95
  96 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
  97 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
  98         struct ldapmapping **m, int remap );
  99 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 100         int remap );
 101 #define BACKLDAP_MAP    0
 102 #define BACKLDAP_REMAP  1
 103 char *
 104 ldap_back_map_filter(
 105         struct ldapmap *at_map,
 106         struct ldapmap *oc_map,
 107         struct berval *f,
 108         int remap );
 109
 110 int
 111 ldap_back_map_attrs(
 112         struct ldapmap *at_map,
 113         AttributeName *a,
 114         int remap,
 115         char ***mapped_attrs );
 116
 117 extern int ldap_back_map_config(
 118         struct ldapmap  *oc_map,
 119         struct ldapmap  *at_map,
 120         const char      *fname,
 121         int             lineno,
 122         int             argc,
 123         char            **argv );
 124
 125 extern int
 126 ldap_back_filter_map_rewrite(
 127         dncookie        *dc,
 128         Filter          *f,
 129         struct berval   *fstr,
 130         int             remap );
 131
 132 /* suffix massaging by means of librewrite */
 133 #ifdef ENABLE_REWRITE
 134 extern int
 135 suffix_massage_config( struct rewrite_info *info,
 136         struct berval *pvnc,
 137         struct berval *nvnc,
 138         struct berval *prnc,
 139         struct berval *nrnc );
 140 #endif /* ENABLE_REWRITE */
 141 extern int
 142 ldap_back_referral_result_rewrite(
 143         dncookie        *dc,
 144         BerVarray       a_vals );
 145 extern int
 146 ldap_dnattr_rewrite(
 147         dncookie        *dc,
 148         BerVarray       a_vals );
 149 extern int
 150 ldap_dnattr_result_rewrite(
 151         dncookie        *dc,
 152         BerVarray       a_vals );
 153
 154 /* (end of) from back-ldap.h before rwm removal */
 155
 156 struct metainfo_t;
 157
 158 typedef struct metasingleconn_t {
 159         int                     msc_candidate;
 160 #define META_NOT_CANDIDATE      ((ber_tag_t)0x0)
 161 #define META_CANDIDATE          ((ber_tag_t)0x1)
 162 #define META_BINDING            ((ber_tag_t)0x2)
 163
 164 #define META_CND_ISSET(rs,f)            ( ( (rs)->sr_tag & (f) ) == (f) )
 165 #define META_CND_SET(rs,f)              ( (rs)->sr_tag |= (f) )
 166 #define META_CND_CLEAR(rs,f)            ( (rs)->sr_tag &= ~(f) )
 167
 168 #define META_CANDIDATE_RESET(rs)        ( (rs)->sr_tag = 0 )
 169 #define META_IS_CANDIDATE(rs)           META_CND_ISSET( (rs), META_CANDIDATE )
 170 #define META_CANDIDATE_SET(rs)          META_CND_SET( (rs), META_CANDIDATE )
 171 #define META_CANDIDATE_CLEAR(rs)        META_CND_CLEAR( (rs), META_CANDIDATE )
 172 #define META_IS_BINDING(rs)             META_CND_ISSET( (rs), META_BINDING )
 173 #define META_BINDING_SET(rs)            META_CND_SET( (rs), META_BINDING )
 174 #define META_BINDING_CLEAR(rs)          META_CND_CLEAR( (rs), META_BINDING )
 175
 176         LDAP                    *msc_ld;
 177         struct berval           msc_bound_ndn;
 178         struct berval           msc_cred;
 179         unsigned                msc_mscflags;
 180         /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
 181          * defined for back-ldap */
 182 #define lc_lcflags              msc_mscflags
 183
 184         struct metainfo_t       *msc_info;
 185 } metasingleconn_t;
 186
 187 typedef struct metaconn_t {
 188         struct slap_conn        *mc_conn;
 189         unsigned                mc_refcnt;
 190
 191         time_t                  mc_create_time;
 192         time_t                  mc_time;
 193
 194         struct berval           mc_local_ndn;
 195         /* NOTE: msc_mscflags is used to recycle the #define
 196          * in metasingleconn_t */
 197         unsigned                msc_mscflags;
 198
 199         /*
 200          * means that the connection is bound;
 201          * of course only one target actually is ...
 202          */
 203         int                     mc_authz_target;
 204 #define META_BOUND_NONE         (-1)
 205 #define META_BOUND_ALL          (-2)
 206         /* supersedes the connection stuff */
 207         metasingleconn_t        mc_conns[ 1 ];
 208         /* NOTE: mc_conns must be last, because
 209          * the required number of conns is malloc'ed
 210          * in one block with the metaconn_t structure */
 211 } metaconn_t;
 212
 213 typedef struct metatarget_t {
 214         char                    *mt_uri;
 215         ldap_pvt_thread_mutex_t mt_uri_mutex;
 216
 217         /* TODO: we might want to enable different strategies
 218          * for different targets */
 219         LDAP_REBIND_PROC        *mt_rebind_f;
 220         LDAP_URLLIST_PROC       *mt_urllist_f;
 221         void                    *mt_urllist_p;
 222
 223         BerVarray               mt_subtree_exclude;
 224         int                     mt_scope;
 225
 226         struct berval           mt_psuffix;             /* pretty suffix */
 227         struct berval           mt_nsuffix;             /* normalized suffix */
 228
 229         struct berval           mt_binddn;
 230         struct berval           mt_bindpw;
 231
 232         struct berval           mt_pseudorootdn;
 233         struct berval           mt_pseudorootpw;
 234
 235         int                     mt_nretries;
 236 #define META_RETRY_UNDEFINED    (-2)
 237 #define META_RETRY_FOREVER      (-1)
 238 #define META_RETRY_NEVER        (0)
 239 #define META_RETRY_DEFAULT      (3)
 240
 241         struct ldaprwmap        mt_rwmap;
 242
 243         sig_atomic_t            mt_isquarantined;
 244         slap_retry_info_t       mt_quarantine;
 245         ldap_pvt_thread_mutex_t mt_quarantine_mutex;
 246 #define META_BACK_TGT_QUARANTINE(mt)    ( (mt)->mt_quarantine.ri_num != NULL )
 247
 248         unsigned                mt_flags;
 249 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
 250 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
 251
 252 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 253 #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 )
 254
 255 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 256 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 257 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 258 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 259
 260         int                     mt_version;
 261         time_t                  mt_network_timeout;
 262         struct timeval          mt_bind_timeout;
 263 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
 264         time_t                  mt_timeout[ LDAP_BACK_OP_LAST ];
 265 } metatarget_t;
 266
 267 typedef struct metadncache_t {
 268         ldap_pvt_thread_mutex_t mutex;
 269         Avlnode                 *tree;
 270
 271 #define META_DNCACHE_DISABLED   (0)
 272 #define META_DNCACHE_FOREVER    ((time_t)(-1))
 273         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
 274 } metadncache_t;
 275
 276 typedef struct metacandidates_t {
 277         int                     mc_ntargets;
 278         SlapReply               *mc_candidates;
 279 } metacandidates_t;
 280
 281 /*
 282  * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
 283  */
 284 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
 285
 286 typedef struct metainfo_t {
 287         int                     mi_ntargets;
 288         int                     mi_defaulttarget;
 289 #define META_DEFAULT_TARGET_NONE        (-1)
 290         int                     mi_nretries;
 291
 292         metatarget_t            **mi_targets;
 293         metacandidates_t        *mi_candidates;
 294
 295         LDAP_REBIND_PROC        *mi_rebind_f;
 296         LDAP_URLLIST_PROC       *mi_urllist_f;
 297
 298         metadncache_t           mi_cache;
 299
 300         ldap_avl_info_t         mi_conninfo;
 301
 302         /* NOTE: quarantine uses the connection mutex */
 303         slap_retry_info_t       mi_quarantine;
 304
 305 #define META_BACK_QUARANTINE(mi)        ( (mi)->mi_quarantine.ri_num != NULL )
 306         meta_back_quarantine_f  mi_quarantine_f;
 307         void                    *mi_quarantine_p;
 308
 309         unsigned                mi_flags;
 310 #define li_flags                mi_flags
 311 /* uses flags as defined in <back-ldap/back-ldap.h> */
 312 #define META_BACK_F_ONERR_STOP          (0x00010000U)
 313 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x00020000U)
 314
 315 #define META_BACK_ONERR_STOP(mi)        ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
 316 #define META_BACK_ONERR_CONTINUE(mi)    ( !META_BACK_ONERR_CONTINUE( (mi) ) )
 317
 318 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
 319
 320         int                     mi_version;
 321         time_t                  mi_network_timeout;
 322         time_t                  mi_conn_ttl;
 323         time_t                  mi_idle_timeout;
 324         struct timeval          mi_bind_timeout;
 325         time_t                  mi_timeout[ LDAP_BACK_OP_LAST ];
 326 } metainfo_t;
 327
 328 typedef enum meta_op_type {
 329         META_OP_ALLOW_MULTIPLE = 0,
 330         META_OP_REQUIRE_SINGLE,
 331         META_OP_REQUIRE_ALL
 332 } meta_op_type;
 333
 334 SlapReply *
 335 meta_back_candidates_get( Operation *op );
 336
 337 extern metaconn_t *
 338 meta_back_getconn(
 339         Operation               *op,
 340         SlapReply               *rs,
 341         int                     *candidate,
 342         ldap_back_send_t        sendok );
 343
 344 extern void
 345 meta_back_release_conn_lock(
 346         Operation               *op,
 347         metaconn_t              *mc,
 348         int                     dolock );
 349 #define meta_back_release_conn(op, mc)  meta_back_release_conn_lock( (op), (mc), 1 )
 350
 351 extern int
 352 meta_back_retry(
 353         Operation               *op,
 354         SlapReply               *rs,
 355         metaconn_t              **mcp,
 356         int                     candidate,
 357         ldap_back_send_t        sendok );
 358
 359 extern void
 360 meta_back_conn_free(
 361         void                    *v_mc );
 362
 363 extern int
 364 meta_back_init_one_conn(
 365         Operation               *op,
 366         SlapReply               *rs,
 367         metaconn_t              *mc,
 368         int                     candidate,
 369         int                     ispriv,
 370         ldap_back_send_t        sendok );
 371
 372 extern void
 373 meta_back_quarantine(
 374         Operation               *op,
 375         SlapReply               *rs,
 376         int                     candidate );
 377
 378 extern int
 379 meta_back_single_bind(
 380         Operation               *op,
 381         SlapReply               *rs,
 382         metaconn_t              *mc,
 383         int                     candidate,
 384         int                     massage );
 385
 386 extern int
 387 meta_back_dobind(
 388         Operation               *op,
 389         SlapReply               *rs,
 390         metaconn_t              *mc,
 391         ldap_back_send_t        sendok );
 392
 393 extern int
 394 meta_back_single_dobind(
 395         Operation               *op,
 396         SlapReply               *rs,
 397         metaconn_t              **mcp,
 398         int                     candidate,
 399         ldap_back_send_t        sendok,
 400         int                     retries,
 401         int                     dolock );
 402
 403 extern int
 404 meta_back_cancel(
 405         metaconn_t              *mc,
 406         Operation               *op,
 407         SlapReply               *rs,
 408         ber_int_t               msgid,
 409         int                     candidate,
 410         ldap_back_send_t        sendok );
 411
 412 extern int
 413 meta_back_op_result(
 414         metaconn_t              *mc,
 415         Operation               *op,
 416         SlapReply               *rs,
 417         int                     candidate );
 418
 419 extern int
 420 back_meta_LTX_init_module(
 421         int                     argc,
 422         char                    *argv[] );
 423
 424 extern int
 425 meta_back_conn_cmp(
 426         const void              *c1,
 427         const void              *c2 );
 428
 429 extern int
 430 meta_back_conndn_cmp(
 431         const void              *c1,
 432         const void              *c2 );
 433
 434 extern int
 435 meta_back_conndn_dup(
 436         void                    *c1,
 437         void                    *c2 );
 438
 439 /*
 440  * Candidate stuff
 441  */
 442 extern int
 443 meta_back_is_candidate(
 444         metatarget_t            *mt,
 445         struct berval           *ndn,
 446         int                     scope );
 447
 448 extern int
 449 meta_back_select_unique_candidate(
 450         metainfo_t              *mi,
 451         struct berval           *ndn );
 452
 453 extern int
 454 meta_clear_unused_candidates(
 455         Operation               *op,
 456         int                     candidate );
 457
 458 extern int
 459 meta_clear_one_candidate(
 460         metasingleconn_t        *mc );
 461
 462 extern int
 463 meta_clear_candidates(
 464         Operation               *op,
 465         metaconn_t              *mc );
 466
 467 /*
 468  * Dn cache stuff (experimental)
 469  */
 470 extern int
 471 meta_dncache_cmp(
 472         const void              *c1,
 473         const void              *c2 );
 474
 475 extern int
 476 meta_dncache_dup(
 477         void                    *c1,
 478         void                    *c2 );
 479
 480 #define META_TARGET_NONE        (-1)
 481 #define META_TARGET_MULTIPLE    (-2)
 482 extern int
 483 meta_dncache_get_target(
 484         metadncache_t           *cache,
 485         struct berval           *ndn );
 486
 487 extern int
 488 meta_dncache_update_entry(
 489         metadncache_t           *cache,
 490         struct berval           *ndn,
 491         int                     target );
 492
 493 extern int
 494 meta_dncache_delete_entry(
 495         metadncache_t           *cache,
 496         struct berval           *ndn );
 497
 498 extern void
 499 meta_dncache_free( void *entry );
 500
 501 extern LDAP_REBIND_PROC         meta_back_default_rebind;
 502 extern LDAP_URLLIST_PROC        meta_back_default_urllist;
 503
 504 LDAP_END_DECL
 505
 506 #endif /* SLAPD_META_H */
 507