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