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
 246         unsigned                mt_flags;
 247 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
 248 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
 249
 250 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 251 #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 )
 252
 253 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 254 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 255 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 256 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 257
 258         int                     mt_version;
 259         time_t                  mt_network_timeout;
 260         struct timeval          mt_bind_timeout;
 261 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
 262         time_t                  mt_timeout[ LDAP_BACK_OP_LAST ];
 263 } metatarget_t;
 264
 265 typedef struct metadncache_t {
 266         ldap_pvt_thread_mutex_t mutex;
 267         Avlnode                 *tree;
 268
 269 #define META_DNCACHE_DISABLED   (0)
 270 #define META_DNCACHE_FOREVER    ((time_t)(-1))
 271         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
 272 } metadncache_t;
 273
 274 typedef struct metacandidates_t {
 275         int                     mc_ntargets;
 276         SlapReply               *mc_candidates;
 277 } metacandidates_t;
 278
 279 /*
 280  * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
 281  */
 282 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
 283
 284 typedef struct metainfo_t {
 285         int                     mi_ntargets;
 286         int                     mi_defaulttarget;
 287 #define META_DEFAULT_TARGET_NONE        (-1)
 288         int                     mi_nretries;
 289
 290         metatarget_t            **mi_targets;
 291         metacandidates_t        *mi_candidates;
 292
 293         LDAP_REBIND_PROC        *mi_rebind_f;
 294         LDAP_URLLIST_PROC       *mi_urllist_f;
 295
 296         metadncache_t           mi_cache;
 297
 298         ldap_avl_info_t         mi_conninfo;
 299
 300         /* NOTE: quarantine uses the connection mutex */
 301         slap_retry_info_t       mi_quarantine;
 302
 303 #define META_BACK_QUARANTINE(mi)        ( (mi)->mi_quarantine.ri_num != NULL )
 304         meta_back_quarantine_f  mi_quarantine_f;
 305         void                    *mi_quarantine_p;
 306
 307         unsigned                mi_flags;
 308 #define li_flags                mi_flags
 309 /* uses flags as defined in <back-ldap/back-ldap.h> */
 310 #define META_BACK_F_ONERR_STOP          (0x00010000U)
 311 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x00020000U)
 312
 313 #define META_BACK_ONERR_STOP(mi)        ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
 314 #define META_BACK_ONERR_CONTINUE(mi)    ( !META_BACK_ONERR_CONTINUE( (mi) ) )
 315
 316 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
 317
 318         int                     mi_version;
 319         time_t                  mi_network_timeout;
 320         time_t                  mi_conn_ttl;
 321         time_t                  mi_idle_timeout;
 322         struct timeval          mi_bind_timeout;
 323         time_t                  mi_timeout[ LDAP_BACK_OP_LAST ];
 324 } metainfo_t;
 325
 326 typedef enum meta_op_type {
 327         META_OP_ALLOW_MULTIPLE = 0,
 328         META_OP_REQUIRE_SINGLE,
 329         META_OP_REQUIRE_ALL
 330 } meta_op_type;
 331
 332 SlapReply *
 333 meta_back_candidates_get( Operation *op );
 334
 335 extern metaconn_t *
 336 meta_back_getconn(
 337         Operation               *op,
 338         SlapReply               *rs,
 339         int                     *candidate,
 340         ldap_back_send_t        sendok );
 341
 342 extern void
 343 meta_back_release_conn_lock(
 344         Operation               *op,
 345         metaconn_t              *mc,
 346         int                     dolock );
 347 #define meta_back_release_conn(op, mc)  meta_back_release_conn_lock( (op), (mc), 1 )
 348
 349 extern int
 350 meta_back_retry(
 351         Operation               *op,
 352         SlapReply               *rs,
 353         metaconn_t              **mcp,
 354         int                     candidate,
 355         ldap_back_send_t        sendok );
 356
 357 extern void
 358 meta_back_conn_free(
 359         void                    *v_mc );
 360
 361 extern int
 362 meta_back_init_one_conn(
 363         Operation               *op,
 364         SlapReply               *rs,
 365         metaconn_t              *mc,
 366         int                     candidate,
 367         int                     ispriv,
 368         ldap_back_send_t        sendok );
 369
 370 extern void
 371 meta_back_quarantine(
 372         Operation               *op,
 373         SlapReply               *rs,
 374         int                     candidate,
 375         int                     dolock );
 376
 377 extern int
 378 meta_back_single_bind(
 379         Operation               *op,
 380         SlapReply               *rs,
 381         metaconn_t              *mc,
 382         int                     candidate,
 383         int                     massage );
 384
 385 extern int
 386 meta_back_dobind(
 387         Operation               *op,
 388         SlapReply               *rs,
 389         metaconn_t              *mc,
 390         ldap_back_send_t        sendok );
 391
 392 extern int
 393 meta_back_single_dobind(
 394         Operation               *op,
 395         SlapReply               *rs,
 396         metaconn_t              **mcp,
 397         int                     candidate,
 398         ldap_back_send_t        sendok,
 399         int                     retries,
 400         int                     dolock );
 401
 402 extern int
 403 meta_back_cancel(
 404         metaconn_t              *mc,
 405         Operation               *op,
 406         SlapReply               *rs,
 407         ber_int_t               msgid,
 408         int                     candidate,
 409         ldap_back_send_t        sendok );
 410
 411 extern int
 412 meta_back_op_result(
 413         metaconn_t              *mc,
 414         Operation               *op,
 415         SlapReply               *rs,
 416         int                     candidate );
 417
 418 extern int
 419 back_meta_LTX_init_module(
 420         int                     argc,
 421         char                    *argv[] );
 422
 423 extern int
 424 meta_back_conn_cmp(
 425         const void              *c1,
 426         const void              *c2 );
 427
 428 extern int
 429 meta_back_conndn_cmp(
 430         const void              *c1,
 431         const void              *c2 );
 432
 433 extern int
 434 meta_back_conndn_dup(
 435         void                    *c1,
 436         void                    *c2 );
 437
 438 /*
 439  * Candidate stuff
 440  */
 441 extern int
 442 meta_back_is_candidate(
 443         metatarget_t            *mt,
 444         struct berval           *ndn,
 445         int                     scope );
 446
 447 extern int
 448 meta_back_select_unique_candidate(
 449         metainfo_t              *mi,
 450         struct berval           *ndn );
 451
 452 extern int
 453 meta_clear_unused_candidates(
 454         Operation               *op,
 455         int                     candidate );
 456
 457 extern int
 458 meta_clear_one_candidate(
 459         metasingleconn_t        *mc );
 460
 461 extern int
 462 meta_clear_candidates(
 463         Operation               *op,
 464         metaconn_t              *mc );
 465
 466 /*
 467  * Dn cache stuff (experimental)
 468  */
 469 extern int
 470 meta_dncache_cmp(
 471         const void              *c1,
 472         const void              *c2 );
 473
 474 extern int
 475 meta_dncache_dup(
 476         void                    *c1,
 477         void                    *c2 );
 478
 479 #define META_TARGET_NONE        (-1)
 480 #define META_TARGET_MULTIPLE    (-2)
 481 extern int
 482 meta_dncache_get_target(
 483         metadncache_t           *cache,
 484         struct berval           *ndn );
 485
 486 extern int
 487 meta_dncache_update_entry(
 488         metadncache_t           *cache,
 489         struct berval           *ndn,
 490         int                     target );
 491
 492 extern int
 493 meta_dncache_delete_entry(
 494         metadncache_t           *cache,
 495         struct berval           *ndn );
 496
 497 extern void
 498 meta_dncache_free( void *entry );
 499
 500 extern LDAP_REBIND_PROC         meta_back_default_rebind;
 501 extern LDAP_URLLIST_PROC        meta_back_default_urllist;
 502
 503 LDAP_END_DECL
 504
 505 #endif /* SLAPD_META_H */
 506