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)0)
 161 #define META_CANDIDATE          ((ber_tag_t)1)
 162
 163         LDAP                    *msc_ld;
 164         struct berval           msc_bound_ndn;
 165         struct berval           msc_cred;
 166         unsigned                msc_mscflags;
 167         /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
 168          * defined for back-ldap */
 169 #define lc_lcflags              msc_mscflags
 170
 171         struct metainfo_t       *msc_info;
 172 } metasingleconn_t;
 173
 174 typedef struct metaconn_t {
 175         struct slap_conn        *mc_conn;
 176         unsigned                mc_refcnt;
 177
 178         time_t                  mc_create_time;
 179         time_t                  mc_time;
 180
 181         struct berval           mc_local_ndn;
 182         /* NOTE: msc_mscflags is used to recycle the #define
 183          * in metasingleconn_t */
 184         unsigned                msc_mscflags;
 185
 186         /*
 187          * means that the connection is bound;
 188          * of course only one target actually is ...
 189          */
 190         int                     mc_authz_target;
 191 #define META_BOUND_NONE         (-1)
 192 #define META_BOUND_ALL          (-2)
 193         /* supersedes the connection stuff */
 194         metasingleconn_t        mc_conns[ 1 ];
 195         /* NOTE: mc_conns must be last, because
 196          * the required number of conns is malloc'ed
 197          * in one block with the metaconn_t structure */
 198 } metaconn_t;
 199
 200 typedef struct metatarget_t {
 201         char                    *mt_uri;
 202         ldap_pvt_thread_mutex_t mt_uri_mutex;
 203
 204         /* TODO: we might want to enable different strategies
 205          * for different targets */
 206         LDAP_REBIND_PROC        *mt_rebind_f;
 207         LDAP_URLLIST_PROC       *mt_urllist_f;
 208         void                    *mt_urllist_p;
 209
 210         BerVarray               mt_subtree_exclude;
 211         int                     mt_scope;
 212
 213         struct berval           mt_psuffix;             /* pretty suffix */
 214         struct berval           mt_nsuffix;             /* normalized suffix */
 215
 216         struct berval           mt_binddn;
 217         struct berval           mt_bindpw;
 218
 219         struct berval           mt_pseudorootdn;
 220         struct berval           mt_pseudorootpw;
 221
 222         int                     mt_nretries;
 223 #define META_RETRY_UNDEFINED    (-2)
 224 #define META_RETRY_FOREVER      (-1)
 225 #define META_RETRY_NEVER        (0)
 226 #define META_RETRY_DEFAULT      (3)
 227
 228         struct ldaprwmap        mt_rwmap;
 229
 230         sig_atomic_t            mt_isquarantined;
 231         slap_retry_info_t       mt_quarantine;
 232
 233         unsigned                mt_flags;
 234 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
 235 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
 236
 237 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 238 #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 )
 239
 240 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 241 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 242 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 243 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 244
 245         int                     mt_version;
 246         time_t                  mt_network_timeout;
 247         struct timeval          mt_bind_timeout;
 248 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
 249         time_t                  mt_timeout[ LDAP_BACK_OP_LAST ];
 250 } metatarget_t;
 251
 252 typedef struct metadncache_t {
 253         ldap_pvt_thread_mutex_t mutex;
 254         Avlnode                 *tree;
 255
 256 #define META_DNCACHE_DISABLED   (0)
 257 #define META_DNCACHE_FOREVER    ((time_t)(-1))
 258         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
 259 } metadncache_t;
 260
 261 typedef struct metacandidates_t {
 262         int                     mc_ntargets;
 263         SlapReply               *mc_candidates;
 264 } metacandidates_t;
 265
 266 typedef struct metainfo_t {
 267         int                     mi_ntargets;
 268         int                     mi_defaulttarget;
 269 #define META_DEFAULT_TARGET_NONE        (-1)
 270         int                     mi_nretries;
 271
 272         metatarget_t            **mi_targets;
 273         metacandidates_t        *mi_candidates;
 274
 275         LDAP_REBIND_PROC        *mi_rebind_f;
 276         LDAP_URLLIST_PROC       *mi_urllist_f;
 277
 278         metadncache_t           mi_cache;
 279
 280         ldap_avl_info_t         mi_conninfo;
 281
 282         /* NOTE: quarantine uses the connection mutex */
 283         slap_retry_info_t       mi_quarantine;
 284
 285 #define META_BACK_QUARANTINE(mi)        ( (mi)->mi_quarantine.ri_num != NULL )
 286
 287         unsigned                mi_flags;
 288 #define li_flags                mi_flags
 289 /* uses flags as defined in <back-ldap/back-ldap.h> */
 290 #define META_BACK_F_ONERR_STOP          (0x00010000U)
 291 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x00020000U)
 292
 293 #define META_BACK_ONERR_STOP(mi)        ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
 294 #define META_BACK_ONERR_CONTINUE(mi)    ( !META_BACK_ONERR_CONTINUE( (mi) ) )
 295
 296 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
 297
 298         int                     mi_version;
 299         time_t                  mi_network_timeout;
 300         time_t                  mi_conn_ttl;
 301         time_t                  mi_idle_timeout;
 302         struct timeval          mi_bind_timeout;
 303         time_t                  mi_timeout[ LDAP_BACK_OP_LAST ];
 304 } metainfo_t;
 305
 306 typedef enum meta_op_type {
 307         META_OP_ALLOW_MULTIPLE = 0,
 308         META_OP_REQUIRE_SINGLE,
 309         META_OP_REQUIRE_ALL
 310 } meta_op_type;
 311
 312 SlapReply *
 313 meta_back_candidates_get( Operation *op );
 314
 315 extern metaconn_t *
 316 meta_back_getconn(
 317         Operation               *op,
 318         SlapReply               *rs,
 319         int                     *candidate,
 320         ldap_back_send_t        sendok );
 321
 322 extern void
 323 meta_back_release_conn_lock(
 324         Operation               *op,
 325         metaconn_t              *mc,
 326         int                     dolock );
 327 #define meta_back_release_conn(op, mc)  meta_back_release_conn_lock( (op), (mc), 1 )
 328
 329 extern int
 330 meta_back_retry(
 331         Operation               *op,
 332         SlapReply               *rs,
 333         metaconn_t              **mcp,
 334         int                     candidate,
 335         ldap_back_send_t        sendok );
 336
 337 extern void
 338 meta_back_conn_free(
 339         void                    *v_mc );
 340
 341 extern int
 342 meta_back_init_one_conn(
 343         Operation               *op,
 344         SlapReply               *rs,
 345         metaconn_t              *mc,
 346         int                     candidate,
 347         int                     ispriv,
 348         ldap_back_send_t        sendok );
 349
 350 extern void
 351 meta_back_quarantine(
 352         Operation               *op,
 353         SlapReply               *rs,
 354         int                     candidate,
 355         int                     dolock );
 356
 357 extern int
 358 meta_back_single_bind(
 359         Operation               *op,
 360         SlapReply               *rs,
 361         metaconn_t              *mc,
 362         int                     candidate,
 363         int                     massage );
 364
 365 extern int
 366 meta_back_dobind(
 367         Operation               *op,
 368         SlapReply               *rs,
 369         metaconn_t              *mc,
 370         ldap_back_send_t        sendok );
 371
 372 extern int
 373 meta_back_single_dobind(
 374         Operation               *op,
 375         SlapReply               *rs,
 376         metaconn_t              **mcp,
 377         int                     candidate,
 378         ldap_back_send_t        sendok,
 379         int                     retries,
 380         int                     dolock );
 381
 382 extern int
 383 meta_back_cancel(
 384         metaconn_t              *mc,
 385         Operation               *op,
 386         SlapReply               *rs,
 387         ber_int_t               msgid,
 388         int                     candidate,
 389         ldap_back_send_t        sendok );
 390
 391 extern int
 392 meta_back_op_result(
 393         metaconn_t              *mc,
 394         Operation               *op,
 395         SlapReply               *rs,
 396         int                     candidate );
 397
 398 extern int
 399 back_meta_LTX_init_module(
 400         int                     argc,
 401         char                    *argv[] );
 402
 403 extern int
 404 meta_back_conn_cmp(
 405         const void              *c1,
 406         const void              *c2 );
 407
 408 extern int
 409 meta_back_conndn_cmp(
 410         const void              *c1,
 411         const void              *c2 );
 412
 413 extern int
 414 meta_back_conndn_dup(
 415         void                    *c1,
 416         void                    *c2 );
 417
 418 /*
 419  * Candidate stuff
 420  */
 421 extern int
 422 meta_back_is_candidate(
 423         struct berval           *nsuffix,
 424         int                     suffixscope,
 425         BerVarray               subtree_exclude,
 426         struct berval           *ndn,
 427         int                     scope );
 428
 429 extern int
 430 meta_back_select_unique_candidate(
 431         metainfo_t              *mi,
 432         struct berval           *ndn );
 433
 434 extern int
 435 meta_clear_unused_candidates(
 436         Operation               *op,
 437         int                     candidate );
 438
 439 extern int
 440 meta_clear_one_candidate(
 441         metasingleconn_t        *mc );
 442
 443 extern int
 444 meta_clear_candidates(
 445         Operation               *op,
 446         metaconn_t              *mc );
 447
 448 /*
 449  * Dn cache stuff (experimental)
 450  */
 451 extern int
 452 meta_dncache_cmp(
 453         const void              *c1,
 454         const void              *c2 );
 455
 456 extern int
 457 meta_dncache_dup(
 458         void                    *c1,
 459         void                    *c2 );
 460
 461 #define META_TARGET_NONE        (-1)
 462 #define META_TARGET_MULTIPLE    (-2)
 463 extern int
 464 meta_dncache_get_target(
 465         metadncache_t           *cache,
 466         struct berval           *ndn );
 467
 468 extern int
 469 meta_dncache_update_entry(
 470         metadncache_t           *cache,
 471         struct berval           *ndn,
 472         int                     target );
 473
 474 extern int
 475 meta_dncache_delete_entry(
 476         metadncache_t           *cache,
 477         struct berval           *ndn );
 478
 479 extern void
 480 meta_dncache_free( void *entry );
 481
 482 extern LDAP_REBIND_PROC         meta_back_default_rebind;
 483 extern LDAP_URLLIST_PROC        meta_back_default_urllist;
 484
 485 LDAP_END_DECL
 486
 487 #endif /* SLAPD_META_H */
 488