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