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 /*
 164  * A metasingleconn_t can be in the following, mutually exclusive states:
 165  *
 166  *      - none                  (0x0U)
 167  *      - creating              META_BACK_FCONN_CREATING
 168  *      - initialized           META_BACK_FCONN_INITED
 169  *      - binding               LDAP_BACK_FCONN_BINDING
 170  *      - bound/anonymous       LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON
 171  *
 172  * possible modifiers are:
 173  *
 174  *      - privileged            LDAP_BACK_FCONN_ISPRIV
 175  *      - privileged, TLS       LDAP_BACK_FCONN_ISTLS
 176  *      - subjected to idassert LDAP_BACK_FCONN_ISIDASR
 177  *      - tainted               LDAP_BACK_FCONN_TAINTED
 178  */
 179
 180 #define META_BACK_FCONN_INITED          (0x00100000U)
 181 #define META_BACK_FCONN_CREATING        (0x00200000U)
 182
 183 #define META_BACK_CONN_INITED(lc)               LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED)
 184 #define META_BACK_CONN_INITED_SET(lc)           LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED)
 185 #define META_BACK_CONN_INITED_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED)
 186 #define META_BACK_CONN_INITED_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc))
 187 #define META_BACK_CONN_CREATING(lc)             LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING)
 188 #define META_BACK_CONN_CREATING_SET(lc)         LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING)
 189 #define META_BACK_CONN_CREATING_CLEAR(lc)       LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING)
 190 #define META_BACK_CONN_CREATING_CPY(lc, mlc)    LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc))
 191
 192 struct metainfo_t;
 193
 194 #define META_NOT_CANDIDATE              ((ber_tag_t)0x0)
 195 #define META_CANDIDATE                  ((ber_tag_t)0x1)
 196 #define META_BINDING                    ((ber_tag_t)0x2)
 197
 198 typedef struct metasingleconn_t {
 199 #define META_CND_ISSET(rs,f)            ( ( (rs)->sr_tag & (f) ) == (f) )
 200 #define META_CND_SET(rs,f)              ( (rs)->sr_tag |= (f) )
 201 #define META_CND_CLEAR(rs,f)            ( (rs)->sr_tag &= ~(f) )
 202
 203 #define META_CANDIDATE_RESET(rs)        ( (rs)->sr_tag = 0 )
 204 #define META_IS_CANDIDATE(rs)           META_CND_ISSET( (rs), META_CANDIDATE )
 205 #define META_CANDIDATE_SET(rs)          META_CND_SET( (rs), META_CANDIDATE )
 206 #define META_CANDIDATE_CLEAR(rs)        META_CND_CLEAR( (rs), META_CANDIDATE )
 207 #define META_IS_BINDING(rs)             META_CND_ISSET( (rs), META_BINDING )
 208 #define META_BINDING_SET(rs)            META_CND_SET( (rs), META_BINDING )
 209 #define META_BINDING_CLEAR(rs)          META_CND_CLEAR( (rs), META_BINDING )
 210
 211         LDAP                    *msc_ld;
 212         time_t                  msc_time;
 213         struct berval           msc_bound_ndn;
 214         struct berval           msc_cred;
 215         unsigned                msc_mscflags;
 216         /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
 217          * defined for back-ldap */
 218 #define lc_lcflags              msc_mscflags
 219 } metasingleconn_t;
 220
 221 typedef struct metaconn_t {
 222         struct slap_conn        *mc_conn;
 223 #define lc_conn                 mc_conn
 224         unsigned                mc_refcnt;
 225
 226         time_t                  mc_create_time;
 227         time_t                  mc_time;
 228
 229         struct berval           mc_local_ndn;
 230         /* NOTE: msc_mscflags is used to recycle the #define
 231          * in metasingleconn_t */
 232         unsigned                msc_mscflags;
 233
 234         /*
 235          * means that the connection is bound;
 236          * of course only one target actually is ...
 237          */
 238         int                     mc_authz_target;
 239 #define META_BOUND_NONE         (-1)
 240 #define META_BOUND_ALL          (-2)
 241
 242         struct metainfo_t       *mc_info;
 243
 244         LDAP_TAILQ_ENTRY(metaconn_t)    mc_q;
 245
 246         /* supersedes the connection stuff */
 247         metasingleconn_t        mc_conns[ 1 ];
 248         /* NOTE: mc_conns must be last, because
 249          * the required number of conns is malloc'ed
 250          * in one block with the metaconn_t structure */
 251 } metaconn_t;
 252
 253 typedef struct metatarget_t {
 254         char                    *mt_uri;
 255         ldap_pvt_thread_mutex_t mt_uri_mutex;
 256
 257         /* TODO: we might want to enable different strategies
 258          * for different targets */
 259         LDAP_REBIND_PROC        *mt_rebind_f;
 260         LDAP_URLLIST_PROC       *mt_urllist_f;
 261         void                    *mt_urllist_p;
 262
 263         BerVarray               mt_subtree_exclude;
 264         int                     mt_scope;
 265
 266         struct berval           mt_psuffix;             /* pretty suffix */
 267         struct berval           mt_nsuffix;             /* normalized suffix */
 268
 269         struct berval           mt_binddn;
 270         struct berval           mt_bindpw;
 271
 272         slap_idassert_t         mt_idassert;
 273 #define mt_idassert_mode        mt_idassert.si_mode
 274 #define mt_idassert_authcID     mt_idassert.si_bc.sb_authcId
 275 #define mt_idassert_authcDN     mt_idassert.si_bc.sb_binddn
 276 #define mt_idassert_passwd      mt_idassert.si_bc.sb_cred
 277 #define mt_idassert_authzID     mt_idassert.si_bc.sb_authzId
 278 #define mt_idassert_authmethod  mt_idassert.si_bc.sb_method
 279 #define mt_idassert_sasl_mech   mt_idassert.si_bc.sb_saslmech
 280 #define mt_idassert_sasl_realm  mt_idassert.si_bc.sb_realm
 281 #define mt_idassert_secprops    mt_idassert.si_bc.sb_secprops
 282 #define mt_idassert_tls         mt_idassert.si_bc.sb_tls
 283 #define mt_idassert_flags       mt_idassert.si_flags
 284 #define mt_idassert_authz       mt_idassert.si_authz
 285
 286         int                     mt_nretries;
 287 #define META_RETRY_UNDEFINED    (-2)
 288 #define META_RETRY_FOREVER      (-1)
 289 #define META_RETRY_NEVER        (0)
 290 #define META_RETRY_DEFAULT      (10)
 291
 292         struct ldaprwmap        mt_rwmap;
 293
 294         sig_atomic_t            mt_isquarantined;
 295         slap_retry_info_t       mt_quarantine;
 296         ldap_pvt_thread_mutex_t mt_quarantine_mutex;
 297 #define META_BACK_TGT_QUARANTINE(mt)    ( (mt)->mt_quarantine.ri_num != NULL )
 298
 299         unsigned                mt_flags;
 300 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
 301 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
 302
 303 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 304 #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 )
 305
 306 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 307 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 308 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 309 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 310
 311         int                     mt_version;
 312         time_t                  mt_network_timeout;
 313         struct timeval          mt_bind_timeout;
 314 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
 315         time_t                  mt_timeout[ SLAP_OP_LAST ];
 316 } metatarget_t;
 317
 318 typedef struct metadncache_t {
 319         ldap_pvt_thread_mutex_t mutex;
 320         Avlnode                 *tree;
 321
 322 #define META_DNCACHE_DISABLED   (0)
 323 #define META_DNCACHE_FOREVER    ((time_t)(-1))
 324         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
 325 } metadncache_t;
 326
 327 typedef struct metacandidates_t {
 328         int                     mc_ntargets;
 329         SlapReply               *mc_candidates;
 330 } metacandidates_t;
 331
 332 /*
 333  * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
 334  */
 335 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
 336
 337 typedef struct metainfo_t {
 338         int                     mi_ntargets;
 339         int                     mi_defaulttarget;
 340 #define META_DEFAULT_TARGET_NONE        (-1)
 341         int                     mi_nretries;
 342
 343         metatarget_t            **mi_targets;
 344         metacandidates_t        *mi_candidates;
 345
 346         LDAP_REBIND_PROC        *mi_rebind_f;
 347         LDAP_URLLIST_PROC       *mi_urllist_f;
 348
 349         metadncache_t           mi_cache;
 350
 351         /* cached connections;
 352          * special conns are in tailq rather than in tree */
 353         ldap_avl_info_t         mi_conninfo;
 354         struct {
 355                 int                                             mic_num;
 356                 LDAP_TAILQ_HEAD(mc_conn_priv_q, metaconn_t)     mic_priv;
 357         }                       mi_conn_priv[ LDAP_BACK_PCONN_LAST ];
 358         int                     mi_conn_priv_max;
 359
 360         /* NOTE: quarantine uses the connection mutex */
 361         slap_retry_info_t       mi_quarantine;
 362
 363 #define META_BACK_QUARANTINE(mi)        ( (mi)->mi_quarantine.ri_num != NULL )
 364         meta_back_quarantine_f  mi_quarantine_f;
 365         void                    *mi_quarantine_p;
 366
 367         unsigned                mi_flags;
 368 #define li_flags                mi_flags
 369 /* uses flags as defined in <back-ldap/back-ldap.h> */
 370 #define META_BACK_F_ONERR_STOP          (0x00100000U)
 371 #define META_BACK_F_ONERR_REPORT        (0x00200000U)
 372 #define META_BACK_F_ONERR_MASK          (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT)
 373 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x00400000U)
 374 #define META_BACK_F_PROXYAUTHZ_ALWAYS   (0x00800000U)
 375
 376 #define META_BACK_ONERR_STOP(mi)        ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
 377 #define META_BACK_ONERR_REPORT(mi)      ( (mi)->mi_flags & META_BACK_F_ONERR_REPORT )
 378 #define META_BACK_ONERR_CONTINUE(mi)    ( !( (mi)->mi_flags & META_BACK_F_ONERR_MASK ) )
 379
 380 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
 381 #define META_BACK_PROXYAUTHZ_ALWAYS(mi) ( (mi)->mi_flags & META_BACK_F_PROXYAUTHZ_ALWAYS )
 382
 383         int                     mi_version;
 384         time_t                  mi_network_timeout;
 385         time_t                  mi_conn_ttl;
 386         time_t                  mi_idle_timeout;
 387         struct timeval          mi_bind_timeout;
 388         time_t                  mi_timeout[ SLAP_OP_LAST ];
 389 } metainfo_t;
 390
 391 typedef enum meta_op_type {
 392         META_OP_ALLOW_MULTIPLE = 0,
 393         META_OP_REQUIRE_SINGLE,
 394         META_OP_REQUIRE_ALL
 395 } meta_op_type;
 396
 397 SlapReply *
 398 meta_back_candidates_get( Operation *op );
 399
 400 extern metaconn_t *
 401 meta_back_getconn(
 402         Operation               *op,
 403         SlapReply               *rs,
 404         int                     *candidate,
 405         ldap_back_send_t        sendok );
 406
 407 extern void
 408 meta_back_release_conn_lock(
 409         Operation               *op,
 410         metaconn_t              *mc,
 411         int                     dolock );
 412 #define meta_back_release_conn(op, mc)  meta_back_release_conn_lock( (op), (mc), 1 )
 413
 414 extern int
 415 meta_back_retry(
 416         Operation               *op,
 417         SlapReply               *rs,
 418         metaconn_t              **mcp,
 419         int                     candidate,
 420         ldap_back_send_t        sendok );
 421
 422 extern void
 423 meta_back_conn_free(
 424         void                    *v_mc );
 425
 426 #if META_BACK_PRINT_CONNTREE > 0
 427 extern void
 428 meta_back_print_conntree(
 429         metainfo_t              *mi,
 430         char                    *msg );
 431 #endif
 432
 433 extern int
 434 meta_back_init_one_conn(
 435         Operation               *op,
 436         SlapReply               *rs,
 437         metaconn_t              *mc,
 438         int                     candidate,
 439         int                     ispriv,
 440         ldap_back_send_t        sendok,
 441         int                     dolock );
 442
 443 extern void
 444 meta_back_quarantine(
 445         Operation               *op,
 446         SlapReply               *rs,
 447         int                     candidate );
 448
 449 extern int
 450 meta_back_dobind(
 451         Operation               *op,
 452         SlapReply               *rs,
 453         metaconn_t              *mc,
 454         ldap_back_send_t        sendok );
 455
 456 extern int
 457 meta_back_single_dobind(
 458         Operation               *op,
 459         SlapReply               *rs,
 460         metaconn_t              **mcp,
 461         int                     candidate,
 462         ldap_back_send_t        sendok,
 463         int                     retries,
 464         int                     dolock );
 465
 466 extern int
 467 meta_back_proxy_authz_cred(
 468         metaconn_t              *mc,
 469         int                     candidate,
 470         Operation               *op,
 471         SlapReply               *rs,
 472         ldap_back_send_t        sendok,
 473         struct berval           *binddn,
 474         struct berval           *bindcred,
 475         int                     *method );
 476
 477 extern int
 478 meta_back_cancel(
 479         metaconn_t              *mc,
 480         Operation               *op,
 481         SlapReply               *rs,
 482         ber_int_t               msgid,
 483         int                     candidate,
 484         ldap_back_send_t        sendok );
 485
 486 extern int
 487 meta_back_op_result(
 488         metaconn_t              *mc,
 489         Operation               *op,
 490         SlapReply               *rs,
 491         int                     candidate,
 492         ber_int_t               msgid,
 493         time_t                  timeout,
 494         ldap_back_send_t        sendok );
 495
 496 extern int
 497 back_meta_LTX_init_module(
 498         int                     argc,
 499         char                    *argv[] );
 500
 501 extern int
 502 meta_back_conn_cmp(
 503         const void              *c1,
 504         const void              *c2 );
 505
 506 extern int
 507 meta_back_conndn_cmp(
 508         const void              *c1,
 509         const void              *c2 );
 510
 511 extern int
 512 meta_back_conndn_dup(
 513         void                    *c1,
 514         void                    *c2 );
 515
 516 /*
 517  * Candidate stuff
 518  */
 519 extern int
 520 meta_back_is_candidate(
 521         metatarget_t            *mt,
 522         struct berval           *ndn,
 523         int                     scope );
 524
 525 extern int
 526 meta_back_select_unique_candidate(
 527         metainfo_t              *mi,
 528         struct berval           *ndn );
 529
 530 extern int
 531 meta_clear_unused_candidates(
 532         Operation               *op,
 533         int                     candidate );
 534
 535 extern int
 536 meta_clear_one_candidate(
 537         Operation               *op,
 538         metaconn_t              *mc,
 539         int                     candidate );
 540
 541 /*
 542  * Dn cache stuff (experimental)
 543  */
 544 extern int
 545 meta_dncache_cmp(
 546         const void              *c1,
 547         const void              *c2 );
 548
 549 extern int
 550 meta_dncache_dup(
 551         void                    *c1,
 552         void                    *c2 );
 553
 554 #define META_TARGET_NONE        (-1)
 555 #define META_TARGET_MULTIPLE    (-2)
 556 extern int
 557 meta_dncache_get_target(
 558         metadncache_t           *cache,
 559         struct berval           *ndn );
 560
 561 extern int
 562 meta_dncache_update_entry(
 563         metadncache_t           *cache,
 564         struct berval           *ndn,
 565         int                     target );
 566
 567 extern int
 568 meta_dncache_delete_entry(
 569         metadncache_t           *cache,
 570         struct berval           *ndn );
 571
 572 extern void
 573 meta_dncache_free( void *entry );
 574
 575 extern LDAP_REBIND_PROC         meta_back_default_rebind;
 576 extern LDAP_URLLIST_PROC        meta_back_default_urllist;
 577
 578 LDAP_END_DECL
 579
 580 #endif /* SLAPD_META_H */
 581