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-2012 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 #ifdef LDAP_DEVEL
  31 #define SLAPD_META_CLIENT_PR 1
  32 #endif /* LDAP_DEVEL */
  33
  34 #include "proto-meta.h"
  35
  36 /* String rewrite library */
  37 #include "rewrite.h"
  38
  39 LDAP_BEGIN_DECL
  40
  41 /*
  42  * Set META_BACK_PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
  43  */
  44 #ifndef META_BACK_PRINT_CONNTREE
  45 #define META_BACK_PRINT_CONNTREE 0
  46 #endif /* !META_BACK_PRINT_CONNTREE */
  47
  48 /* from back-ldap.h before rwm removal */
  49 struct ldapmap {
  50         int drop_missing;
  51
  52         Avlnode *map;
  53         Avlnode *remap;
  54 };
  55
  56 struct ldapmapping {
  57         struct berval src;
  58         struct berval dst;
  59 };
  60
  61 struct ldaprwmap {
  62         /*
  63          * DN rewriting
  64          */
  65 #ifdef ENABLE_REWRITE
  66         struct rewrite_info *rwm_rw;
  67 #else /* !ENABLE_REWRITE */
  68         /* some time the suffix massaging without librewrite
  69          * will be disabled */
  70         BerVarray rwm_suffix_massage;
  71 #endif /* !ENABLE_REWRITE */
  72
  73         /*
  74          * Attribute/objectClass mapping
  75          */
  76         struct ldapmap rwm_oc;
  77         struct ldapmap rwm_at;
  78 };
  79
  80 /* Whatever context ldap_back_dn_massage needs... */
  81 typedef struct dncookie {
  82         struct metatarget_t     *target;
  83
  84 #ifdef ENABLE_REWRITE
  85         Connection              *conn;
  86         char                    *ctx;
  87         SlapReply               *rs;
  88 #else
  89         int                     normalized;
  90         int                     tofrom;
  91 #endif
  92 } dncookie;
  93
  94 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
  95         struct berval *res);
  96
  97 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
  98 extern int ldap_back_conn_dup( void *c1, void *c2 );
  99 extern void ldap_back_conn_free( void *c );
 100
 101 /* attributeType/objectClass mapping */
 102 int mapping_cmp (const void *, const void *);
 103 int mapping_dup (void *, void *);
 104
 105 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
 106 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
 107         struct ldapmapping **m, int remap );
 108 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 109         int remap );
 110 #define BACKLDAP_MAP    0
 111 #define BACKLDAP_REMAP  1
 112 char *
 113 ldap_back_map_filter(
 114         struct ldapmap *at_map,
 115         struct ldapmap *oc_map,
 116         struct berval *f,
 117         int remap );
 118
 119 int
 120 ldap_back_map_attrs(
 121         Operation *op,
 122         struct ldapmap *at_map,
 123         AttributeName *a,
 124         int remap,
 125         char ***mapped_attrs );
 126
 127 extern int
 128 ldap_back_filter_map_rewrite(
 129         dncookie        *dc,
 130         Filter          *f,
 131         struct berval   *fstr,
 132         int             remap,
 133         void            *memctx );
 134
 135 /* suffix massaging by means of librewrite */
 136 #ifdef ENABLE_REWRITE
 137 extern int
 138 suffix_massage_config( struct rewrite_info *info,
 139         struct berval *pvnc,
 140         struct berval *nvnc,
 141         struct berval *prnc,
 142         struct berval *nrnc );
 143 #endif /* ENABLE_REWRITE */
 144 extern int
 145 ldap_back_referral_result_rewrite(
 146         dncookie        *dc,
 147         BerVarray       a_vals,
 148         void            *memctx );
 149 extern int
 150 ldap_dnattr_rewrite(
 151         dncookie        *dc,
 152         BerVarray       a_vals );
 153 extern int
 154 ldap_dnattr_result_rewrite(
 155         dncookie        *dc,
 156         BerVarray       a_vals );
 157
 158 /* (end of) from back-ldap.h before rwm removal */
 159
 160 /*
 161  * A metasingleconn_t can be in the following, mutually exclusive states:
 162  *
 163  *      - none                  (0x0U)
 164  *      - creating              META_BACK_FCONN_CREATING
 165  *      - initialized           META_BACK_FCONN_INITED
 166  *      - binding               LDAP_BACK_FCONN_BINDING
 167  *      - bound/anonymous       LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON
 168  *
 169  * possible modifiers are:
 170  *
 171  *      - privileged            LDAP_BACK_FCONN_ISPRIV
 172  *      - privileged, TLS       LDAP_BACK_FCONN_ISTLS
 173  *      - subjected to idassert LDAP_BACK_FCONN_ISIDASR
 174  *      - tainted               LDAP_BACK_FCONN_TAINTED
 175  */
 176
 177 #define META_BACK_FCONN_INITED          (0x00100000U)
 178 #define META_BACK_FCONN_CREATING        (0x00200000U)
 179
 180 #define META_BACK_CONN_INITED(lc)               LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED)
 181 #define META_BACK_CONN_INITED_SET(lc)           LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED)
 182 #define META_BACK_CONN_INITED_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED)
 183 #define META_BACK_CONN_INITED_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc))
 184 #define META_BACK_CONN_CREATING(lc)             LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING)
 185 #define META_BACK_CONN_CREATING_SET(lc)         LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING)
 186 #define META_BACK_CONN_CREATING_CLEAR(lc)       LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING)
 187 #define META_BACK_CONN_CREATING_CPY(lc, mlc)    LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc))
 188
 189 struct metainfo_t;
 190
 191 #define META_NOT_CANDIDATE              ((ber_tag_t)0x0)
 192 #define META_CANDIDATE                  ((ber_tag_t)0x1)
 193 #define META_BINDING                    ((ber_tag_t)0x2)
 194 #define META_RETRYING                   ((ber_tag_t)0x4)
 195
 196 typedef struct metasingleconn_t {
 197 #define META_CND_ISSET(rs,f)            ( ( (rs)->sr_tag & (f) ) == (f) )
 198 #define META_CND_SET(rs,f)              ( (rs)->sr_tag |= (f) )
 199 #define META_CND_CLEAR(rs,f)            ( (rs)->sr_tag &= ~(f) )
 200
 201 #define META_CANDIDATE_RESET(rs)        ( (rs)->sr_tag = 0 )
 202 #define META_IS_CANDIDATE(rs)           META_CND_ISSET( (rs), META_CANDIDATE )
 203 #define META_CANDIDATE_SET(rs)          META_CND_SET( (rs), META_CANDIDATE )
 204 #define META_CANDIDATE_CLEAR(rs)        META_CND_CLEAR( (rs), META_CANDIDATE )
 205 #define META_IS_BINDING(rs)             META_CND_ISSET( (rs), META_BINDING )
 206 #define META_BINDING_SET(rs)            META_CND_SET( (rs), META_BINDING )
 207 #define META_BINDING_CLEAR(rs)          META_CND_CLEAR( (rs), META_BINDING )
 208 #define META_IS_RETRYING(rs)            META_CND_ISSET( (rs), META_RETRYING )
 209 #define META_RETRYING_SET(rs)           META_CND_SET( (rs), META_RETRYING )
 210 #define META_RETRYING_CLEAR(rs)         META_CND_CLEAR( (rs), META_RETRYING )
 211
 212         LDAP                    *msc_ld;
 213         time_t                  msc_time;
 214         struct berval           msc_bound_ndn;
 215         struct berval           msc_cred;
 216         unsigned                msc_mscflags;
 217         /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
 218          * defined for back-ldap */
 219 #define lc_lcflags              msc_mscflags
 220 } metasingleconn_t;
 221
 222 typedef struct metaconn_t {
 223         ldapconn_base_t         lc_base;
 224 #define mc_base                 lc_base
 225 #define mc_conn                 mc_base.lcb_conn
 226 #define mc_local_ndn            mc_base.lcb_local_ndn
 227 #define mc_refcnt               mc_base.lcb_refcnt
 228 #define mc_create_time          mc_base.lcb_create_time
 229 #define mc_time                 mc_base.lcb_time
 230
 231         LDAP_TAILQ_ENTRY(metaconn_t)    mc_q;
 232
 233         /* NOTE: msc_mscflags is used to recycle the #define
 234          * in metasingleconn_t */
 235         unsigned                msc_mscflags;
 236
 237         /*
 238          * means that the connection is bound;
 239          * of course only one target actually is ...
 240          */
 241         int                     mc_authz_target;
 242 #define META_BOUND_NONE         (-1)
 243 #define META_BOUND_ALL          (-2)
 244
 245         struct metainfo_t       *mc_info;
 246
 247         /* supersedes the connection stuff */
 248         metasingleconn_t        mc_conns[ 1 ];
 249         /* NOTE: mc_conns must be last, because
 250          * the required number of conns is malloc'ed
 251          * in one block with the metaconn_t structure */
 252 } metaconn_t;
 253
 254 typedef enum meta_st_t {
 255 #if 0 /* todo */
 256         META_ST_EXACT = LDAP_SCOPE_BASE,
 257 #endif
 258         META_ST_SUBTREE = LDAP_SCOPE_SUBTREE,
 259         META_ST_SUBORDINATE = LDAP_SCOPE_SUBORDINATE,
 260         META_ST_REGEX /* last + 1 */
 261 } meta_st_t;
 262
 263 typedef struct metasubtree_t {
 264         meta_st_t ms_type;
 265         union {
 266                 struct berval msu_dn;
 267                 struct {
 268                         regex_t msr_regex;
 269                         char *msr_regex_pattern;
 270                 } msu_regex;
 271         } ms_un;
 272 #define ms_dn ms_un.msu_dn
 273 #define ms_regex ms_un.msu_regex.msr_regex
 274 #define ms_regex_pattern ms_un.msu_regex.msr_regex_pattern
 275
 276         struct metasubtree_t *ms_next;
 277 } metasubtree_t;
 278
 279 typedef struct metacommon_t {
 280         int                             mc_version;
 281         int                             mc_nretries;
 282 #define META_RETRY_UNDEFINED    (-2)
 283 #define META_RETRY_FOREVER      (-1)
 284 #define META_RETRY_NEVER        (0)
 285 #define META_RETRY_DEFAULT      (10)
 286
 287         unsigned                mc_flags;
 288 #define META_BACK_CMN_ISSET(mc,f)               ( ( (mc)->mc_flags & (f) ) == (f) )
 289 #define META_BACK_CMN_QUARANTINE(mc)            META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_QUARANTINE )
 290
 291 #ifdef SLAPD_META_CLIENT_PR
 292         /*
 293          * client-side paged results:
 294          * -1: accept unsolicited paged results responses
 295          *  0: off
 296          * >0: always request paged results with size == mt_ps
 297          */
 298 #define META_CLIENT_PR_DISABLE                  (0)
 299 #define META_CLIENT_PR_ACCEPT_UNSOLICITED       (-1)
 300         ber_int_t               mc_ps;
 301 #endif /* SLAPD_META_CLIENT_PR */
 302
 303         slap_retry_info_t       mc_quarantine;
 304         time_t                  mc_network_timeout;
 305         struct timeval  mc_bind_timeout;
 306 #define META_BIND_TIMEOUT       LDAP_BACK_RESULT_UTIMEOUT
 307         time_t                  mc_timeout[ SLAP_OP_LAST ];
 308 } metacommon_t;
 309
 310 typedef struct metatarget_t {
 311         char                    *mt_uri;
 312         ldap_pvt_thread_mutex_t mt_uri_mutex;
 313
 314         /* TODO: we might want to enable different strategies
 315          * for different targets */
 316         LDAP_REBIND_PROC        *mt_rebind_f;
 317         LDAP_URLLIST_PROC       *mt_urllist_f;
 318         void                    *mt_urllist_p;
 319
 320         metasubtree_t           *mt_subtree;
 321         /* F: subtree-include; T: subtree-exclude */
 322         int                     mt_subtree_exclude;
 323
 324         int                     mt_scope;
 325
 326         struct berval           mt_psuffix;             /* pretty suffix */
 327         struct berval           mt_nsuffix;             /* normalized suffix */
 328
 329         struct berval           mt_binddn;
 330         struct berval           mt_bindpw;
 331
 332         /* we only care about the TLS options here */
 333         slap_bindconf           mt_tls;
 334
 335         slap_idassert_t         mt_idassert;
 336 #define mt_idassert_mode        mt_idassert.si_mode
 337 #define mt_idassert_authcID     mt_idassert.si_bc.sb_authcId
 338 #define mt_idassert_authcDN     mt_idassert.si_bc.sb_binddn
 339 #define mt_idassert_passwd      mt_idassert.si_bc.sb_cred
 340 #define mt_idassert_authzID     mt_idassert.si_bc.sb_authzId
 341 #define mt_idassert_authmethod  mt_idassert.si_bc.sb_method
 342 #define mt_idassert_sasl_mech   mt_idassert.si_bc.sb_saslmech
 343 #define mt_idassert_sasl_realm  mt_idassert.si_bc.sb_realm
 344 #define mt_idassert_secprops    mt_idassert.si_bc.sb_secprops
 345 #define mt_idassert_tls         mt_idassert.si_bc.sb_tls
 346 #define mt_idassert_flags       mt_idassert.si_flags
 347 #define mt_idassert_authz       mt_idassert.si_authz
 348
 349         struct ldaprwmap        mt_rwmap;
 350
 351         sig_atomic_t            mt_isquarantined;
 352         ldap_pvt_thread_mutex_t mt_quarantine_mutex;
 353
 354         metacommon_t    mt_mc;
 355 #define mt_nretries     mt_mc.mc_nretries
 356 #define mt_flags        mt_mc.mc_flags
 357 #define mt_version      mt_mc.mc_version
 358 #define mt_ps           mt_mc.mc_ps
 359 #define mt_network_timeout      mt_mc.mc_network_timeout
 360 #define mt_bind_timeout mt_mc.mc_bind_timeout
 361 #define mt_timeout      mt_mc.mc_timeout
 362 #define mt_quarantine   mt_mc.mc_quarantine
 363
 364 #define META_BACK_TGT_ISSET(mt,f)               ( ( (mt)->mt_flags & (f) ) == (f) )
 365 #define META_BACK_TGT_ISMASK(mt,m,f)            ( ( (mt)->mt_flags & (m) ) == (f) )
 366
 367 #define META_BACK_TGT_SAVECRED(mt)              META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_SAVECRED )
 368
 369 #define META_BACK_TGT_USE_TLS(mt)               META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_USE_TLS )
 370 #define META_BACK_TGT_PROPAGATE_TLS(mt)         META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_PROPAGATE_TLS )
 371 #define META_BACK_TGT_TLS_CRITICAL(mt)          META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_TLS_CRITICAL )
 372
 373 #define META_BACK_TGT_CHASE_REFERRALS(mt)       META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_CHASE_REFERRALS )
 374
 375 #define META_BACK_TGT_T_F(mt)                   META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 376 #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 )
 377
 378 #define META_BACK_TGT_ABANDON(mt)               META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 379 #define META_BACK_TGT_IGNORE(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 380 #define META_BACK_TGT_CANCEL(mt)                META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 381 #define META_BACK_TGT_CANCEL_DISCOVER(mt)       META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 382 #define META_BACK_TGT_QUARANTINE(mt)            META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_QUARANTINE )
 383
 384 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
 385 #define META_BACK_TGT_ST_REQUEST(mt)            META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_REQUEST )
 386 #define META_BACK_TGT_ST_RESPONSE(mt)           META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_RESPONSE )
 387 #endif /* SLAP_CONTROL_X_SESSION_TRACKING */
 388
 389 #define META_BACK_TGT_NOREFS(mt)                META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOREFS )
 390 #define META_BACK_TGT_NOUNDEFFILTER(mt)         META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOUNDEFFILTER )
 391
 392         slap_mask_t             mt_rep_flags;
 393
 394 } metatarget_t;
 395
 396 typedef struct metadncache_t {
 397         ldap_pvt_thread_mutex_t mutex;
 398         Avlnode                 *tree;
 399
 400 #define META_DNCACHE_DISABLED   (0)
 401 #define META_DNCACHE_FOREVER    ((time_t)(-1))
 402         time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
 403 } metadncache_t;
 404
 405 typedef struct metacandidates_t {
 406         int                     mc_ntargets;
 407         SlapReply               *mc_candidates;
 408 } metacandidates_t;
 409
 410 /*
 411  * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
 412  */
 413 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
 414
 415 typedef struct metainfo_t {
 416         int                     mi_ntargets;
 417         int                     mi_defaulttarget;
 418 #define META_DEFAULT_TARGET_NONE        (-1)
 419
 420 #define mi_nretries     mi_mc.mc_nretries
 421 #define mi_flags        mi_mc.mc_flags
 422 #define mi_version      mi_mc.mc_version
 423 #define mi_ps           mi_mc.mc_ps
 424 #define mi_network_timeout      mi_mc.mc_network_timeout
 425 #define mi_bind_timeout mi_mc.mc_bind_timeout
 426 #define mi_timeout      mi_mc.mc_timeout
 427 #define mi_quarantine   mi_mc.mc_quarantine
 428
 429         metatarget_t            **mi_targets;
 430         metacandidates_t        *mi_candidates;
 431
 432         LDAP_REBIND_PROC        *mi_rebind_f;
 433         LDAP_URLLIST_PROC       *mi_urllist_f;
 434
 435         metadncache_t           mi_cache;
 436
 437         /* cached connections;
 438          * special conns are in tailq rather than in tree */
 439         ldap_avl_info_t         mi_conninfo;
 440         struct {
 441                 int                                             mic_num;
 442                 LDAP_TAILQ_HEAD(mc_conn_priv_q, metaconn_t)     mic_priv;
 443         }                       mi_conn_priv[ LDAP_BACK_PCONN_LAST ];
 444         int                     mi_conn_priv_max;
 445
 446         /* NOTE: quarantine uses the connection mutex */
 447         meta_back_quarantine_f  mi_quarantine_f;
 448         void                    *mi_quarantine_p;
 449
 450 #define li_flags                mi_flags
 451 /* uses flags as defined in <back-ldap/back-ldap.h> */
 452 #define META_BACK_F_ONERR_STOP          (0x01000000U)
 453 #define META_BACK_F_ONERR_REPORT        (0x02000000U)
 454 #define META_BACK_F_ONERR_MASK          (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT)
 455 #define META_BACK_F_DEFER_ROOTDN_BIND   (0x04000000U)
 456 #define META_BACK_F_PROXYAUTHZ_ALWAYS   (0x08000000U)   /* users always proxyauthz */
 457 #define META_BACK_F_PROXYAUTHZ_ANON     (0x10000000U)   /* anonymous always proxyauthz */
 458 #define META_BACK_F_PROXYAUTHZ_NOANON   (0x20000000U)   /* anonymous remains anonymous */
 459
 460 #define META_BACK_ONERR_STOP(mi)        LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_STOP )
 461 #define META_BACK_ONERR_REPORT(mi)      LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_REPORT )
 462 #define META_BACK_ONERR_CONTINUE(mi)    ( !LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_MASK ) )
 463
 464 #define META_BACK_DEFER_ROOTDN_BIND(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_DEFER_ROOTDN_BIND )
 465 #define META_BACK_PROXYAUTHZ_ALWAYS(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ALWAYS )
 466 #define META_BACK_PROXYAUTHZ_ANON(mi)   LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ANON )
 467 #define META_BACK_PROXYAUTHZ_NOANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_NOANON )
 468
 469 #define META_BACK_QUARANTINE(mi)        LDAP_BACK_ISSET( (mi), LDAP_BACK_F_QUARANTINE )
 470
 471         time_t                  mi_conn_ttl;
 472         time_t                  mi_idle_timeout;
 473
 474         metacommon_t    mi_mc;
 475         ldap_extra_t    *mi_ldap_extra;
 476
 477 } metainfo_t;
 478
 479 typedef enum meta_op_type {
 480         META_OP_ALLOW_MULTIPLE = 0,
 481         META_OP_REQUIRE_SINGLE,
 482         META_OP_REQUIRE_ALL
 483 } meta_op_type;
 484
 485 SlapReply *
 486 meta_back_candidates_get( Operation *op );
 487
 488 extern metaconn_t *
 489 meta_back_getconn(
 490         Operation               *op,
 491         SlapReply               *rs,
 492         int                     *candidate,
 493         ldap_back_send_t        sendok );
 494
 495 extern void
 496 meta_back_release_conn_lock(
 497         metainfo_t              *mi,
 498         metaconn_t              *mc,
 499         int                     dolock );
 500 #define meta_back_release_conn(mi, mc)  meta_back_release_conn_lock( (mi), (mc), 1 )
 501
 502 extern int
 503 meta_back_retry(
 504         Operation               *op,
 505         SlapReply               *rs,
 506         metaconn_t              **mcp,
 507         int                     candidate,
 508         ldap_back_send_t        sendok );
 509
 510 extern void
 511 meta_back_conn_free(
 512         void                    *v_mc );
 513
 514 #if META_BACK_PRINT_CONNTREE > 0
 515 extern void
 516 meta_back_print_conntree(
 517         metainfo_t              *mi,
 518         char                    *msg );
 519 #endif
 520
 521 extern int
 522 meta_back_init_one_conn(
 523         Operation               *op,
 524         SlapReply               *rs,
 525         metaconn_t              *mc,
 526         int                     candidate,
 527         int                     ispriv,
 528         ldap_back_send_t        sendok,
 529         int                     dolock );
 530
 531 extern void
 532 meta_back_quarantine(
 533         Operation               *op,
 534         SlapReply               *rs,
 535         int                     candidate );
 536
 537 extern int
 538 meta_back_dobind(
 539         Operation               *op,
 540         SlapReply               *rs,
 541         metaconn_t              *mc,
 542         ldap_back_send_t        sendok );
 543
 544 extern int
 545 meta_back_single_dobind(
 546         Operation               *op,
 547         SlapReply               *rs,
 548         metaconn_t              **mcp,
 549         int                     candidate,
 550         ldap_back_send_t        sendok,
 551         int                     retries,
 552         int                     dolock );
 553
 554 extern int
 555 meta_back_proxy_authz_cred(
 556         metaconn_t              *mc,
 557         int                     candidate,
 558         Operation               *op,
 559         SlapReply               *rs,
 560         ldap_back_send_t        sendok,
 561         struct berval           *binddn,
 562         struct berval           *bindcred,
 563         int                     *method );
 564
 565 extern int
 566 meta_back_cancel(
 567         metaconn_t              *mc,
 568         Operation               *op,
 569         SlapReply               *rs,
 570         ber_int_t               msgid,
 571         int                     candidate,
 572         ldap_back_send_t        sendok );
 573
 574 extern int
 575 meta_back_op_result(
 576         metaconn_t              *mc,
 577         Operation               *op,
 578         SlapReply               *rs,
 579         int                     candidate,
 580         ber_int_t               msgid,
 581         time_t                  timeout,
 582         ldap_back_send_t        sendok );
 583
 584 extern int
 585 meta_back_controls_add(
 586         Operation       *op,
 587         SlapReply       *rs,
 588         metaconn_t      *mc,
 589         int             candidate,
 590         LDAPControl     ***pctrls );
 591
 592 extern int
 593 back_meta_LTX_init_module(
 594         int                     argc,
 595         char                    *argv[] );
 596
 597 extern int
 598 meta_back_conn_cmp(
 599         const void              *c1,
 600         const void              *c2 );
 601
 602 extern int
 603 meta_back_conndn_cmp(
 604         const void              *c1,
 605         const void              *c2 );
 606
 607 extern int
 608 meta_back_conndn_dup(
 609         void                    *c1,
 610         void                    *c2 );
 611
 612 /*
 613  * Candidate stuff
 614  */
 615 extern int
 616 meta_back_is_candidate(
 617         metatarget_t            *mt,
 618         struct berval           *ndn,
 619         int                     scope );
 620
 621 extern int
 622 meta_back_select_unique_candidate(
 623         metainfo_t              *mi,
 624         struct berval           *ndn );
 625
 626 extern int
 627 meta_clear_unused_candidates(
 628         Operation               *op,
 629         int                     candidate );
 630
 631 extern int
 632 meta_clear_one_candidate(
 633         Operation               *op,
 634         metaconn_t              *mc,
 635         int                     candidate );
 636
 637 /*
 638  * Dn cache stuff (experimental)
 639  */
 640 extern int
 641 meta_dncache_cmp(
 642         const void              *c1,
 643         const void              *c2 );
 644
 645 extern int
 646 meta_dncache_dup(
 647         void                    *c1,
 648         void                    *c2 );
 649
 650 #define META_TARGET_NONE        (-1)
 651 #define META_TARGET_MULTIPLE    (-2)
 652 extern int
 653 meta_dncache_get_target(
 654         metadncache_t           *cache,
 655         struct berval           *ndn );
 656
 657 extern int
 658 meta_dncache_update_entry(
 659         metadncache_t           *cache,
 660         struct berval           *ndn,
 661         int                     target );
 662
 663 extern int
 664 meta_dncache_delete_entry(
 665         metadncache_t           *cache,
 666         struct berval           *ndn );
 667
 668 extern void
 669 meta_dncache_free( void *entry );
 670
 671 extern int
 672 meta_subtree_destroy( metasubtree_t *ms );
 673
 674 extern LDAP_REBIND_PROC         meta_back_default_rebind;
 675 extern LDAP_URLLIST_PROC        meta_back_default_urllist;
 676
 677 LDAP_END_DECL
 678
 679 #endif /* SLAPD_META_H */
 680