git.sur5r.net Git - openldap/blob - servers/slapd/back-asyncmeta/back-asyncmeta.h

   1 /* back-asyncmeta.h - main header file for back-asyncmeta module */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2016-2018 The OpenLDAP Foundation.
   6  * Portions Copyright 2016 Symas Corporation.
   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
  18 /* ACKNOWLEDGEMENTS:
  19  * This work was developed by Symas Corporation
  20  * based on back-meta module for inclusion in OpenLDAP Software.
  21  * This work was sponsored by Ericsson. */
  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_ASYNCMETA_H
  28 #define SLAPD_ASYNCMETA_H
  29
  30 #ifndef ENABLE_REWRITE
  31 #error "--enable-rewrite is required!"
  32 #endif
  33
  34 #ifdef LDAP_DEVEL
  35 #define SLAPD_META_CLIENT_PR 1
  36 #endif /* LDAP_DEVEL */
  37
  38 #include "proto-asyncmeta.h"
  39
  40 /* String rewrite library */
  41 #include "rewrite.h"
  42 #include "ldap_rq.h"
  43
  44 LDAP_BEGIN_DECL
  45
  46 /*
  47  * Set META_BACK_PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
  48  */
  49 #ifndef META_BACK_PRINT_CONNTREE
  50 #define META_BACK_PRINT_CONNTREE 0
  51 #endif /* !META_BACK_PRINT_CONNTREE */
  52
  53 /* from back-ldap.h before rwm removal */
  54 struct ldapmap {
  55         int drop_missing;
  56
  57         Avlnode *map;
  58         Avlnode *remap;
  59 };
  60
  61 struct ldapmapping {
  62         struct berval src;
  63         struct berval dst;
  64 };
  65
  66 struct ldaprwmap {
  67         /*
  68          * DN rewriting
  69          */
  70         struct rewrite_info *rwm_rw;
  71         BerVarray rwm_bva_rewrite;
  72
  73         /*
  74          * Attribute/objectClass mapping
  75          */
  76         struct ldapmap rwm_oc;
  77         struct ldapmap rwm_at;
  78         BerVarray rwm_bva_map;
  79 };
  80
  81 /* Whatever context asyncmeta_dn_massage needs... */
  82 typedef struct a_dncookie {
  83         struct a_metatarget_t   *target;
  84
  85         Connection              *conn;
  86         char                    *ctx;
  87         SlapReply               *rs;
  88 } a_dncookie;
  89
  90 int asyncmeta_dn_massage(a_dncookie *dc, struct berval *dn,
  91         struct berval *res);
  92
  93 extern int asyncmeta_conn_dup( void *c1, void *c2 );
  94 extern void asyncmeta_conn_free( void *c );
  95
  96 /* attributeType/objectClass mapping */
  97 int asyncmeta_mapping_cmp (const void *, const void *);
  98 int asyncmeta_mapping_dup (void *, void *);
  99
 100 void asyncmeta_map_init ( struct ldapmap *lm, struct ldapmapping ** );
 101 int asyncmeta_mapping ( struct ldapmap *map, struct berval *s,
 102         struct ldapmapping **m, int remap );
 103 void asyncmeta_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 104         int remap );
 105 #define BACKLDAP_MAP    0
 106 #define BACKLDAP_REMAP  1
 107 char *
 108 asyncmeta_map_filter(
 109         struct ldapmap *at_map,
 110         struct ldapmap *oc_map,
 111         struct berval *f,
 112         int remap );
 113
 114 int
 115 asyncmeta_map_attrs(
 116         Operation *op,
 117         struct ldapmap *at_map,
 118         AttributeName *a,
 119         int remap,
 120         char ***mapped_attrs );
 121
 122 extern int
 123 asyncmeta_filter_map_rewrite(
 124         a_dncookie      *dc,
 125         Filter          *f,
 126         struct berval   *fstr,
 127         int             remap,
 128         void            *memctx );
 129
 130 /* suffix massaging by means of librewrite */
 131 extern int
 132 asyncmeta_suffix_massage_config( struct rewrite_info *info,
 133         struct berval *pvnc,
 134         struct berval *nvnc,
 135         struct berval *prnc,
 136         struct berval *nrnc );
 137
 138 extern int
 139 asyncmeta_back_referral_result_rewrite(
 140         a_dncookie      *dc,
 141         BerVarray       a_vals,
 142         void            *memctx );
 143 extern int
 144 asyncmeta_dnattr_rewrite(
 145         a_dncookie      *dc,
 146         BerVarray       a_vals );
 147 extern int
 148 asyncmeta_dnattr_result_rewrite(
 149         a_dncookie      *dc,
 150         BerVarray       a_vals );
 151
 152
 153 /* (end of) from back-ldap.h before rwm removal */
 154
 155 /*
 156  * A a_metasingleconn_t can be in the following, mutually exclusive states:
 157  *
 158  *      - none                  (0x0U)
 159  *      - creating              META_BACK_FCONN_CREATING
 160  *      - initialized           META_BACK_FCONN_INITED
 161  *      - binding               LDAP_BACK_FCONN_BINDING
 162  *      - bound/anonymous       LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON
 163  *
 164  * possible modifiers are:
 165  *
 166  *      - privileged            LDAP_BACK_FCONN_ISPRIV
 167  *      - privileged, TLS       LDAP_BACK_FCONN_ISTLS
 168  *      - subjected to idassert LDAP_BACK_FCONN_ISIDASR
 169  *      - tainted               LDAP_BACK_FCONN_TAINTED
 170  */
 171
 172 #define META_BACK_FCONN_INITED          (0x00100000U)
 173 #define META_BACK_FCONN_CREATING        (0x00200000U)
 174
 175 #define META_BACK_CONN_INITED(lc)               LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED)
 176 #define META_BACK_CONN_INITED_SET(lc)           LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED)
 177 #define META_BACK_CONN_INITED_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED)
 178 #define META_BACK_CONN_INITED_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc))
 179 #define META_BACK_CONN_CREATING(lc)             LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING)
 180 #define META_BACK_CONN_CREATING_SET(lc)         LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING)
 181 #define META_BACK_CONN_CREATING_CLEAR(lc)       LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING)
 182 #define META_BACK_CONN_CREATING_CPY(lc, mlc)    LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc))
 183
 184 struct a_metainfo_t;
 185 struct a_metaconn_t;
 186 struct a_metatarget_t;
 187 #define META_NOT_CANDIDATE              ((ber_tag_t)0x0)
 188 #define META_CANDIDATE                  ((ber_tag_t)0x1)
 189 #define META_BINDING                    ((ber_tag_t)0x2)
 190 #define META_RETRYING                   ((ber_tag_t)0x4)
 191
 192 typedef struct bm_context_t {
 193         LDAP_SLIST_ENTRY(bm_context_t) bc_next;
 194         time_t                  timeout;
 195         time_t                  stoptime;
 196         ldap_back_send_t        sendok;
 197         ldap_back_send_t        retrying;
 198         int candidate_match;
 199         int sent;
 200         int bc_active;
 201         int searchtime; /* stoptime is a search timelimit */
 202         int is_ok;
 203         SlapReply               rs;
 204         Operation               *op;
 205         LDAPControl             **ctrls;
 206         int                     *msgids;
 207         SlapReply               *candidates;
 208 } bm_context_t;
 209
 210 typedef struct a_metasingleconn_t {
 211 #define META_CND_ISSET(rs,f)            ( ( (rs)->sr_tag & (f) ) == (f) )
 212 #define META_CND_SET(rs,f)              ( (rs)->sr_tag |= (f) )
 213 #define META_CND_CLEAR(rs,f)            ( (rs)->sr_tag &= ~(f) )
 214
 215 #define META_CANDIDATE_RESET(rs)        ( (rs)->sr_tag = 0 )
 216 #define META_IS_CANDIDATE(rs)           META_CND_ISSET( (rs), META_CANDIDATE )
 217 #define META_CANDIDATE_SET(rs)          META_CND_SET( (rs), META_CANDIDATE )
 218 #define META_CANDIDATE_CLEAR(rs)        META_CND_CLEAR( (rs), META_CANDIDATE )
 219 #define META_IS_BINDING(rs)             META_CND_ISSET( (rs), META_BINDING )
 220 #define META_BINDING_SET(rs)            META_CND_SET( (rs), META_BINDING )
 221 #define META_BINDING_CLEAR(rs)          META_CND_CLEAR( (rs), META_BINDING )
 222 #define META_IS_RETRYING(rs)            META_CND_ISSET( (rs), META_RETRYING )
 223 #define META_RETRYING_SET(rs)           META_CND_SET( (rs), META_RETRYING )
 224 #define META_RETRYING_CLEAR(rs)         META_CND_CLEAR( (rs), META_RETRYING )
 225
 226         LDAP                    *msc_ld;
 227         LDAP                    *msc_ldr;
 228         time_t                  msc_time;
 229         struct berval           msc_bound_ndn;
 230         struct berval           msc_cred;
 231         unsigned                msc_mscflags;
 232         /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
 233          * defined for back-ldap */
 234 #define lc_lcflags              msc_mscflags
 235         int msc_pending_ops;
 236         int msc_timeout_ops;
 237                 /* Connection for the select */
 238         Connection *conn;
 239 } a_metasingleconn_t;
 240
 241 typedef struct a_metaconn_t {
 242         ldapconn_base_t         lc_base;
 243 #define mc_base                 lc_base
 244 //#define       mc_conn                 mc_base.lcb_conn
 245 //#define       mc_local_ndn            mc_base.lcb_local_ndn
 246 //#define       mc_refcnt               mc_base.lcb_refcnt
 247 //#define       mc_create_time          mc_base.lcb_create_time
 248 //#define       mc_time                 mc_base.lcb_time
 249
 250         LDAP_TAILQ_ENTRY(a_metaconn_t)  mc_q;
 251
 252         /* NOTE: msc_mscflags is used to recycle the #define
 253          * in metasingleconn_t */
 254         unsigned                msc_mscflags;
 255         int     mc_active;
 256
 257         /*
 258          * means that the connection is bound;
 259          * of course only one target actually is ...
 260          */
 261         int                     mc_authz_target;
 262 #define META_BOUND_NONE         (-1)
 263 #define META_BOUND_ALL          (-2)
 264
 265         struct a_metainfo_t     *mc_info;
 266
 267         int pending_ops;
 268         ldap_pvt_thread_mutex_t mc_om_mutex;
 269         /* queue for pending operations */
 270         LDAP_SLIST_HEAD(BCList, bm_context_t) mc_om_list;
 271         /* supersedes the connection stuff */
 272         a_metasingleconn_t      *mc_conns;
 273 } a_metaconn_t;
 274
 275 typedef enum meta_st_t {
 276 #if 0 /* todo */
 277         META_ST_EXACT = LDAP_SCOPE_BASE,
 278 #endif
 279         META_ST_SUBTREE = LDAP_SCOPE_SUBTREE,
 280         META_ST_SUBORDINATE = LDAP_SCOPE_SUBORDINATE,
 281         META_ST_REGEX /* last + 1 */
 282 } meta_st_t;
 283
 284 typedef struct a_metasubtree_t {
 285         meta_st_t ms_type;
 286         union {
 287                 struct berval msu_dn;
 288                 struct {
 289                         struct berval msr_regex_pattern;
 290                         regex_t msr_regex;
 291                 } msu_regex;
 292         } ms_un;
 293 #define ms_dn ms_un.msu_dn
 294 #define ms_regex ms_un.msu_regex.msr_regex
 295 #define ms_regex_pattern ms_un.msu_regex.msr_regex_pattern
 296
 297         struct a_metasubtree_t *ms_next;
 298 } a_metasubtree_t;
 299
 300 typedef struct metafilter_t {
 301         struct metafilter_t *mf_next;
 302         struct berval mf_regex_pattern;
 303         regex_t mf_regex;
 304 } metafilter_t;
 305
 306 typedef struct a_metacommon_t {
 307         int                             mc_version;
 308         int                             mc_nretries;
 309 #define META_RETRY_UNDEFINED    (-2)
 310 #define META_RETRY_FOREVER      (-1)
 311 #define META_RETRY_NEVER        (0)
 312 #define META_RETRY_DEFAULT      (10)
 313
 314         unsigned                mc_flags;
 315 #define META_BACK_CMN_ISSET(mc,f)               ( ( (mc)->mc_flags & (f) ) == (f) )
 316 #define META_BACK_CMN_QUARANTINE(mc)            META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_QUARANTINE )
 317 #define META_BACK_CMN_CHASE_REFERRALS(mc)       META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_CHASE_REFERRALS )
 318 #define META_BACK_CMN_NOREFS(mc)                META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_NOREFS )
 319 #define META_BACK_CMN_NOUNDEFFILTER(mc)         META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_NOUNDEFFILTER )
 320 #define META_BACK_CMN_SAVECRED(mc)              META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_SAVECRED )
 321 #define META_BACK_CMN_ST_REQUEST(mc)            META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_ST_REQUEST )
 322
 323 #ifdef SLAPD_META_CLIENT_PR
 324         /*
 325          * client-side paged results:
 326          * -1: accept unsolicited paged results responses
 327          *  0: off
 328          * >0: always request paged results with size == mt_ps
 329          */
 330 #define META_CLIENT_PR_DISABLE                  (0)
 331 #define META_CLIENT_PR_ACCEPT_UNSOLICITED       (-1)
 332         ber_int_t               mc_ps;
 333 #endif /* SLAPD_META_CLIENT_PR */
 334
 335         slap_retry_info_t       mc_quarantine;
 336         time_t                  mc_network_timeout;
 337         struct timeval  mc_bind_timeout;
 338 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
 339         time_t                  mc_timeout[ SLAP_OP_LAST ];
 340 } a_metacommon_t;
 341
 342 typedef struct a_metatarget_t {
 343         char                    *mt_uri;
 344         ldap_pvt_thread_mutex_t mt_uri_mutex;
 345
 346         /* TODO: we might want to enable different strategies
 347          * for different targets */
 348         LDAP_REBIND_PROC        *mt_rebind_f;
 349         LDAP_URLLIST_PROC       *mt_urllist_f;
 350         void                    *mt_urllist_p;
 351
 352         metafilter_t    *mt_filter;
 353         a_metasubtree_t         *mt_subtree;
 354         /* F: subtree-include; T: subtree-exclude */
 355         int                     mt_subtree_exclude;
 356
 357         int                     mt_scope;
 358
 359         struct berval           mt_psuffix;             /* pretty suffix */
 360         struct berval           mt_nsuffix;             /* normalized suffix */
 361
 362         struct berval           mt_binddn;
 363         struct berval           mt_bindpw;
 364
 365         /* we only care about the TLS options here */
 366         slap_bindconf           mt_tls;
 367
 368         slap_idassert_t         mt_idassert;
 369 #define mt_idassert_mode        mt_idassert.si_mode
 370 #define mt_idassert_authcID     mt_idassert.si_bc.sb_authcId
 371 #define mt_idassert_authcDN     mt_idassert.si_bc.sb_binddn
 372 #define mt_idassert_passwd      mt_idassert.si_bc.sb_cred
 373 #define mt_idassert_authzID     mt_idassert.si_bc.sb_authzId
 374 #define mt_idassert_authmethod  mt_idassert.si_bc.sb_method
 375 #define mt_idassert_sasl_mech   mt_idassert.si_bc.sb_saslmech
 376 #define mt_idassert_sasl_realm  mt_idassert.si_bc.sb_realm
 377 #define mt_idassert_secprops    mt_idassert.si_bc.sb_secprops
 378 #define mt_idassert_tls         mt_idassert.si_bc.sb_tls
 379 #define mt_idassert_flags       mt_idassert.si_flags
 380 #define mt_idassert_authz       mt_idassert.si_authz
 381
 382         struct ldaprwmap        mt_rwmap;
 383
 384         sig_atomic_t            mt_isquarantined;
 385         ldap_pvt_thread_mutex_t mt_quarantine_mutex;
 386
 387         a_metacommon_t  mt_mc;
 388 #define mt_nretries     mt_mc.mc_nretries
 389 #define mt_flags        mt_mc.mc_flags
 390 #define mt_version      mt_mc.mc_version
 391 #define mt_ps           mt_mc.mc_ps
 392 #define mt_network_timeout      mt_mc.mc_network_timeout
 393 #define mt_bind_timeout mt_mc.mc_bind_timeout
 394 #define mt_timeout      mt_mc.mc_timeout
 395 #define mt_quarantine   mt_mc.mc_quarantine
 396
 397 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
 398 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
 399
 400 #define META_BACK_TGT_SAVECRED(mt)              META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_SAVECRED )
 401
 402 #define META_BACK_TGT_USE_TLS(mt)               META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_USE_TLS )
 403 #define META_BACK_TGT_PROPAGATE_TLS(mt)         META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_PROPAGATE_TLS )
 404 #define META_BACK_TGT_TLS_CRITICAL(mt)          META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_TLS_CRITICAL )
 405
 406 #define META_BACK_TGT_CHASE_REFERRALS(mt)       META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_CHASE_REFERRALS )
 407
 408 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 409 #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 )
 410
 411 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 412 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 413 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 414 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 415 #define META_BACK_TGT_QUARANTINE(mt)            META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_QUARANTINE )
 416
 417 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
 418 #define META_BACK_TGT_ST_REQUEST(mt)            META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_REQUEST )
 419 #define META_BACK_TGT_ST_RESPONSE(mt)           META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_RESPONSE )
 420 #endif /* SLAP_CONTROL_X_SESSION_TRACKING */
 421
 422 #define META_BACK_TGT_NOREFS(mt)                META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOREFS )
 423 #define META_BACK_TGT_NOUNDEFFILTER(mt)         META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOUNDEFFILTER )
 424
 425 #define META_BACK_CFG_MAX_PENDING_OPS          0x80
 426 #define META_BACK_CFG_MAX_TARGET_CONNS          0xFF
 427 /* the interval of the timeout checking loop in microseconds
 428  * possibly make this configurable? */
 429 #define META_BACK_CFG_MAX_TIMEOUT_LOOP          0x70000
 430         slap_mask_t             mt_rep_flags;
 431         int                     mt_timeout_ops;
 432 } a_metatarget_t;
 433
 434 typedef struct a_metadncache_t {
 435         ldap_pvt_thread_mutex_t mutex;
 436         Avlnode                 *tree;
 437
 438 #define META_DNCACHE_DISABLED   (0)
 439 #define META_DNCACHE_FOREVER    ((time_t)(-1))
 440         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
 441 } a_metadncache_t;
 442
 443 typedef struct a_metacandidates_t {
 444         int                     mc_ntargets;
 445         SlapReply               *mc_candidates;
 446 } a_metacandidates_t;
 447
 448 /*
 449  * Hook to allow mucking with a_metainfo_t/a_metatarget_t when quarantine is over
 450  */
 451 typedef int (*asyncmeta_quarantine_f)( struct a_metainfo_t *, int target, void * );
 452
 453 struct meta_out_message_t;
 454
 455 typedef struct a_metainfo_t {
 456         int                     mi_ntargets;
 457         int                     mi_defaulttarget;
 458 #define META_DEFAULT_TARGET_NONE        (-1)
 459
 460 #define mi_nretries     mi_mc.mc_nretries
 461 #define mi_flags        mi_mc.mc_flags
 462 #define mi_version      mi_mc.mc_version
 463 #define mi_ps           mi_mc.mc_ps
 464 #define mi_network_timeout      mi_mc.mc_network_timeout
 465 #define mi_bind_timeout mi_mc.mc_bind_timeout
 466 #define mi_timeout      mi_mc.mc_timeout
 467 #define mi_quarantine   mi_mc.mc_quarantine
 468
 469         a_metatarget_t          **mi_targets;
 470         a_metacandidates_t      *mi_candidates;
 471
 472         LDAP_REBIND_PROC        *mi_rebind_f;
 473         LDAP_URLLIST_PROC       *mi_urllist_f;
 474
 475         a_metadncache_t         mi_cache;
 476
 477         struct {
 478                 int                                             mic_num;
 479                 LDAP_TAILQ_HEAD(mc_conn_priv_q, a_metaconn_t)   mic_priv;
 480         }                       mi_conn_priv[ LDAP_BACK_PCONN_LAST ];
 481         int                     mi_conn_priv_max;
 482
 483         /* NOTE: quarantine uses the connection mutex */
 484         asyncmeta_quarantine_f  mi_quarantine_f;
 485         void                    *mi_quarantine_p;
 486
 487 #define li_flags                mi_flags
 488 /* uses flags as defined in <back-ldap/back-ldap.h> */
 489 #define META_BACK_F_ONERR_STOP          LDAP_BACK_F_ONERR_STOP
 490 #define META_BACK_F_ONERR_REPORT        (0x02000000U)
 491 #define META_BACK_F_ONERR_MASK          (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT)
 492 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x04000000U)
 493 #define META_BACK_F_PROXYAUTHZ_ALWAYS   (0x08000000U)   /* users always proxyauthz */
 494 #define META_BACK_F_PROXYAUTHZ_ANON     (0x10000000U)   /* anonymous always proxyauthz */
 495 #define META_BACK_F_PROXYAUTHZ_NOANON   (0x20000000U)   /* anonymous remains anonymous */
 496
 497 #define META_BACK_ONERR_STOP(mi)        LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_STOP )
 498 #define META_BACK_ONERR_REPORT(mi)      LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_REPORT )
 499 #define META_BACK_ONERR_CONTINUE(mi)    ( !LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_MASK ) )
 500
 501 #define META_BACK_DEFER_ROOTDN_BIND(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_DEFER_ROOTDN_BIND )
 502 #define META_BACK_PROXYAUTHZ_ALWAYS(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ALWAYS )
 503 #define META_BACK_PROXYAUTHZ_ANON(mi)   LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ANON )
 504 #define META_BACK_PROXYAUTHZ_NOANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_NOANON )
 505
 506 #define META_BACK_QUARANTINE(mi)        LDAP_BACK_ISSET( (mi), LDAP_BACK_F_QUARANTINE )
 507
 508         time_t                  mi_idle_timeout;
 509         struct re_s *mi_task;
 510
 511         a_metacommon_t  mi_mc;
 512         ldap_extra_t    *mi_ldap_extra;
 513
 514         int                    mi_max_timeout_ops;
 515         int                    mi_max_pending_ops;
 516         int                    mi_max_target_conns;
 517         /* mutex for access to the connection structures */
 518         ldap_pvt_thread_mutex_t mi_mc_mutex;
 519         int                    mi_num_conns;
 520         int                    mi_next_conn;
 521         a_metaconn_t          *mi_conns;
 522
 523 } a_metainfo_t;
 524
 525 typedef enum meta_op_type {
 526         META_OP_ALLOW_MULTIPLE = 0,
 527         META_OP_REQUIRE_SINGLE,
 528         META_OP_REQUIRE_ALL
 529 } meta_op_type;
 530
 531 extern a_metaconn_t *
 532 asyncmeta_getconn(
 533         Operation               *op,
 534         SlapReply               *rs,
 535         SlapReply               *candidates,
 536         int                     *candidate,
 537         ldap_back_send_t        sendok,
 538         int                     alloc_new);
 539
 540 extern int
 541 asyncmeta_retry(
 542         Operation               *op,
 543         SlapReply               *rs,
 544         a_metaconn_t            **mcp,
 545         int                     candidate,
 546         ldap_back_send_t        sendok );
 547
 548 extern void
 549 asyncmeta_conn_free(
 550         void                    *v_mc );
 551
 552 extern int
 553 asyncmeta_init_one_conn(
 554         Operation               *op,
 555         SlapReply               *rs,
 556         a_metaconn_t            *mc,
 557         int                     candidate,
 558         int                     ispriv,
 559         ldap_back_send_t        sendok,
 560         int                     dolock );
 561
 562 extern void
 563 asyncmeta_quarantine(
 564         Operation               *op,
 565         a_metainfo_t            *mi,
 566         SlapReply               *rs,
 567         int                     candidate );
 568
 569 extern int
 570 asyncmeta_dobind(
 571         Operation               *op,
 572         SlapReply               *rs,
 573         a_metaconn_t            *mc,
 574         ldap_back_send_t        sendok,
 575         SlapReply               *candidates);
 576
 577 extern int
 578 asyncmeta_single_dobind(
 579         Operation               *op,
 580         SlapReply               *rs,
 581         a_metaconn_t            **mcp,
 582         int                     candidate,
 583         ldap_back_send_t        sendok,
 584         int                     retries,
 585         int                     dolock );
 586
 587 extern int
 588 asyncmeta_proxy_authz_cred(
 589         a_metaconn_t            *mc,
 590         int                     candidate,
 591         Operation               *op,
 592         SlapReply               *rs,
 593         ldap_back_send_t        sendok,
 594         struct berval           *binddn,
 595         struct berval           *bindcred,
 596         int                     *method );
 597
 598 extern int
 599 asyncmeta_cancel(
 600         a_metaconn_t            *mc,
 601         Operation               *op,
 602         SlapReply               *rs,
 603         ber_int_t               msgid,
 604         int                     candidate,
 605         ldap_back_send_t        sendok );
 606
 607 extern int
 608 asyncmeta_op_result(
 609         a_metaconn_t            *mc,
 610         Operation               *op,
 611         SlapReply               *rs,
 612         int                     candidate,
 613         ber_int_t               msgid,
 614         time_t                  timeout,
 615         ldap_back_send_t        sendok );
 616
 617 extern int
 618 asyncmeta_controls_add(
 619         Operation       *op,
 620         SlapReply       *rs,
 621         a_metaconn_t    *mc,
 622         int             candidate,
 623         LDAPControl     ***pctrls );
 624
 625 extern int
 626 asyncmeta_LTX_init_module(
 627         int                     argc,
 628         char                    *argv[] );
 629
 630 /*
 631  * Candidate stuff
 632  */
 633 extern int
 634 asyncmeta_is_candidate(
 635         a_metatarget_t          *mt,
 636         struct berval           *ndn,
 637         int                     scope );
 638
 639 extern int
 640 asyncmeta_select_unique_candidate(
 641         a_metainfo_t            *mi,
 642         struct berval           *ndn );
 643
 644 extern int
 645 asyncmeta_clear_unused_candidates(
 646         Operation               *op,
 647         int                     candidate,
 648         a_metaconn_t            *mc,
 649         SlapReply       *candidates);
 650
 651 /*
 652  * Dn cache stuff (experimental)
 653  */
 654 extern int
 655 asyncmeta_dncache_cmp(
 656         const void              *c1,
 657         const void              *c2 );
 658
 659 extern int
 660 asyncmeta_dncache_dup(
 661         void                    *c1,
 662         void                    *c2 );
 663
 664 #define META_TARGET_NONE        (-1)
 665 #define META_TARGET_MULTIPLE    (-2)
 666 extern int
 667 asyncmeta_dncache_get_target(
 668         a_metadncache_t         *cache,
 669         struct berval           *ndn );
 670
 671 extern int
 672 meta_dncache_update_entry(
 673         a_metadncache_t         *cache,
 674         struct berval           *ndn,
 675         int                     target );
 676
 677 extern int
 678 asyncmeta_dncache_delete_entry(
 679         a_metadncache_t         *cache,
 680         struct berval           *ndn );
 681
 682 extern void
 683 asyncmeta_dncache_free( void *entry );
 684
 685 extern void
 686 asyncmeta_back_map_free( struct ldapmap *lm );
 687
 688 extern int
 689 asyncmeta_subtree_destroy( a_metasubtree_t *ms );
 690
 691 extern void
 692 asyncmeta_filter_destroy( metafilter_t *mf );
 693
 694 extern int
 695 asyncmeta_target_finish( a_metainfo_t *mi, a_metatarget_t *mt,
 696         const char *log, char *msg, size_t msize
 697 );
 698
 699
 700 extern LDAP_REBIND_PROC         asyncmeta_back_default_rebind;
 701 extern LDAP_URLLIST_PROC        asyncmeta_back_default_urllist;
 702
 703 /* IGNORE means that target does not (no longer) participate
 704  * in the search;
 705  * NOTREADY means the search on that target has not been initialized yet
 706  */
 707 #define META_MSGID_IGNORE       (-1)
 708 #define META_MSGID_NEED_BIND    (-2)
 709 #define META_MSGID_CONNECTING   (-3)
 710 #define META_MSGID_UNDEFINED    (-4)
 711
 712 typedef enum meta_search_candidate_t {
 713         META_SEARCH_UNDEFINED = -2,
 714         META_SEARCH_ERR = -1,
 715         META_SEARCH_NOT_CANDIDATE,
 716         META_SEARCH_CANDIDATE,
 717         META_SEARCH_BINDING,
 718         META_SEARCH_NEED_BIND,
 719         META_SEARCH_CONNECTING
 720 } meta_search_candidate_t;
 721
 722 Operation* asyncmeta_copy_op(Operation *op);
 723 void asyncmeta_clear_bm_context(bm_context_t *bc);
 724
 725 int asyncmeta_add_message_queue(a_metaconn_t *mc, bm_context_t *bc);
 726 void asyncmeta_drop_bc(a_metaconn_t *mc, bm_context_t *bc);
 727
 728 bm_context_t *
 729 asyncmeta_find_message(ber_int_t msgid, a_metaconn_t *mc, int candidate);
 730
 731 bm_context_t *
 732 asyncmeta_find_message_by_opmsguid(ber_int_t msgid, a_metaconn_t *mc, int remove);
 733
 734 void* asyncmeta_op_handle_result(void *ctx, void *arg);
 735 int asyncmeta_back_cleanup( Operation *op, SlapReply *rs, bm_context_t *bm );
 736
 737 int
 738 asyncmeta_clear_one_msc(
 739         Operation       *op,
 740         a_metaconn_t    *msc,
 741         int             candidate );
 742
 743 a_metaconn_t *
 744 asyncmeta_get_next_mc( a_metainfo_t *mi );
 745
 746 void* asyncmeta_timeout_loop(void *ctx, void *arg);
 747 int
 748 asyncmeta_start_timeout_loop(a_metatarget_t *mt, a_metainfo_t *mi);
 749 void asyncmeta_set_msc_time(a_metasingleconn_t *msc);
 750 void asyncmeta_clear_message_queue(a_metasingleconn_t *msc);
 751
 752 int asyncmeta_back_cancel(
 753         a_metaconn_t    *mc,
 754         Operation               *op,
 755         ber_int_t               msgid,
 756         int                             candidate );
 757
 758 int
 759 asyncmeta_back_cancel_msc(
 760         Operation               *op,
 761         SlapReply               *rs,
 762         ber_int_t               msgid,
 763         a_metasingleconn_t      *msc,
 764         int                     candidate,
 765         ldap_back_send_t        sendok );
 766
 767 int
 768 asyncmeta_back_abandon_candidate(
 769         a_metaconn_t            *mc,
 770         Operation               *op,
 771         ber_int_t               msgid,
 772         int                     candidate );
 773 void
 774 asyncmeta_send_result(bm_context_t* bc, int error, char *text);
 775
 776 int asyncmeta_new_bm_context(Operation *op, SlapReply *rs, bm_context_t **new_bc, int ntargets);
 777 int asyncmeta_start_listeners(a_metaconn_t *mc, SlapReply *candidates,  bm_context_t *bc);
 778 int asyncmeta_start_one_listener(a_metaconn_t *mc, SlapReply *candidates,  bm_context_t *bc, int candidate);
 779
 780 meta_search_candidate_t
 781 asyncmeta_back_search_start(
 782         Operation             *op,
 783         SlapReply             *rs,
 784         a_metaconn_t          *mc,
 785         bm_context_t          *bc,
 786         int                   candidate,
 787         struct berval         *prcookie,
 788         ber_int_t             prsize );
 789
 790 meta_search_candidate_t
 791 asyncmeta_dobind_init(
 792         Operation            *op,
 793         SlapReply            *rs,
 794         bm_context_t         *bc,
 795         a_metaconn_t         *mc,
 796         int                  candidate);
 797
 798 meta_search_candidate_t
 799 asyncmeta_dobind_init_with_retry(
 800         Operation            *op,
 801         SlapReply            *rs,
 802         bm_context_t         *bc,
 803         a_metaconn_t         *mc,
 804         int                  candidate);
 805
 806 meta_search_candidate_t
 807 asyncmeta_back_add_start(Operation *op,
 808                          SlapReply *rs,
 809                          a_metaconn_t *mc,
 810                          bm_context_t *bc,
 811                          int candidate);
 812 meta_search_candidate_t
 813 asyncmeta_back_modify_start(Operation *op,
 814                          SlapReply *rs,
 815                          a_metaconn_t *mc,
 816                          bm_context_t *bc,
 817                          int candidate);
 818
 819 meta_search_candidate_t
 820 asyncmeta_back_modrdn_start(Operation *op,
 821                          SlapReply *rs,
 822                          a_metaconn_t *mc,
 823                          bm_context_t *bc,
 824                          int candidate);
 825 meta_search_candidate_t
 826 asyncmeta_back_delete_start(Operation *op,
 827                          SlapReply *rs,
 828                          a_metaconn_t *mc,
 829                          bm_context_t *bc,
 830                          int candidate);
 831
 832 meta_search_candidate_t
 833 asyncmeta_back_compare_start(Operation *op,
 834                          SlapReply *rs,
 835                          a_metaconn_t *mc,
 836                          bm_context_t *bc,
 837                          int candidate);
 838
 839
 840 void
 841 asyncmeta_sender_error(Operation *op,
 842                        SlapReply *rs,
 843                        slap_callback *cb);
 844
 845
 846 LDAP_END_DECL
 847
 848 #endif /* SLAPD_ASYNCMETA_H */