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-2005 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 struct slap_conn;
  37 struct slap_op;
  38
  39 /* from back-ldap.h before rwm removal */
  40 struct ldapmap {
  41         int drop_missing;
  42
  43         Avlnode *map;
  44         Avlnode *remap;
  45 };
  46
  47 struct ldapmapping {
  48         struct berval src;
  49         struct berval dst;
  50 };
  51
  52 struct ldaprwmap {
  53         /*
  54          * DN rewriting
  55          */
  56 #ifdef ENABLE_REWRITE
  57         struct rewrite_info *rwm_rw;
  58 #else /* !ENABLE_REWRITE */
  59         /* some time the suffix massaging without librewrite
  60          * will be disabled */
  61         BerVarray rwm_suffix_massage;
  62 #endif /* !ENABLE_REWRITE */
  63
  64         /*
  65          * Attribute/objectClass mapping
  66          */
  67         struct ldapmap rwm_oc;
  68         struct ldapmap rwm_at;
  69 };
  70
  71 /* Whatever context ldap_back_dn_massage needs... */
  72 typedef struct dncookie {
  73         struct metatarget_t     *target;
  74
  75 #ifdef ENABLE_REWRITE
  76         Connection              *conn;
  77         char                    *ctx;
  78         SlapReply               *rs;
  79 #else
  80         int                     normalized;
  81         int                     tofrom;
  82 #endif
  83 } dncookie;
  84
  85 /* TODO: allow to define it on a per-target basis */
  86 #define META_BIND_TIMEOUT       10000
  87
  88 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
  89         struct berval *res);
  90
  91 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
  92 extern int ldap_back_conn_dup( void *c1, void *c2 );
  93 extern void ldap_back_conn_free( void *c );
  94
  95 /* attributeType/objectClass mapping */
  96 int mapping_cmp (const void *, const void *);
  97 int mapping_dup (void *, void *);
  98
  99 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
 100 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
 101         struct ldapmapping **m, int remap );
 102 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 103         int remap );
 104 #define BACKLDAP_MAP    0
 105 #define BACKLDAP_REMAP  1
 106 char *
 107 ldap_back_map_filter(
 108         struct ldapmap *at_map,
 109         struct ldapmap *oc_map,
 110         struct berval *f,
 111         int remap );
 112
 113 int
 114 ldap_back_map_attrs(
 115         struct ldapmap *at_map,
 116         AttributeName *a,
 117         int remap,
 118         char ***mapped_attrs );
 119
 120 extern int ldap_back_map_config(
 121         struct ldapmap  *oc_map,
 122         struct ldapmap  *at_map,
 123         const char      *fname,
 124         int             lineno,
 125         int             argc,
 126         char            **argv );
 127
 128 extern int
 129 ldap_back_filter_map_rewrite(
 130         dncookie        *dc,
 131         Filter          *f,
 132         struct berval   *fstr,
 133         int             remap );
 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 extern int
 149 ldap_dnattr_rewrite(
 150         dncookie        *dc,
 151         BerVarray       a_vals );
 152 extern int
 153 ldap_dnattr_result_rewrite(
 154         dncookie        *dc,
 155         BerVarray       a_vals );
 156
 157 /* (end of) from back-ldap.h before rwm removal */
 158
 159 struct metainfo_t;
 160
 161 typedef struct metasingleconn_t {
 162         int                     msc_candidate;
 163 #define META_NOT_CANDIDATE      ((ber_tag_t)0)
 164 #define META_CANDIDATE          ((ber_tag_t)1)
 165
 166         LDAP                    *msc_ld;
 167         struct berval           msc_bound_ndn;
 168         struct berval           msc_cred;
 169         int                     msc_bound;
 170 #define META_UNBOUND            0
 171 #define META_BOUND              1
 172 #define META_ANONYMOUS          2
 173
 174         struct metainfo_t       *msc_info;
 175 } metasingleconn_t;
 176
 177 typedef struct metaconn_t {
 178         struct slap_conn        *mc_conn;
 179         ldap_pvt_thread_mutex_t mc_mutex;
 180         unsigned                mc_refcnt;
 181
 182         /*
 183          * means that the connection is bound;
 184          * of course only one target actually is ...
 185          */
 186         int                     mc_auth_target;
 187 #define META_BOUND_NONE         (-1)
 188 #define META_BOUND_ALL          (-2)
 189         /* supersedes the connection stuff */
 190         metasingleconn_t        mc_conns[ 1 ];
 191         /* NOTE: mc_conns must be last, because
 192          * the required number of conns is malloc'ed
 193          * in one block with the metaconn_t structure */
 194 } metaconn_t;
 195
 196 enum {
 197         META_OP_ADD = 0,
 198         META_OP_DELETE,
 199         META_OP_MODIFY,
 200         META_OP_MODRDN,
 201         META_OP_LAST
 202 };
 203
 204 typedef struct metatarget_t {
 205         char                    *mt_uri;
 206         int                     mt_scope;
 207
 208         struct berval           mt_psuffix;             /* pretty suffix */
 209         struct berval           mt_nsuffix;             /* normalized suffix */
 210
 211         struct berval           mt_binddn;
 212         struct berval           mt_bindpw;
 213
 214         struct berval           mt_pseudorootdn;
 215         struct berval           mt_pseudorootpw;
 216
 217         int                     mt_nretries;
 218 #define META_RETRY_UNDEFINED    (-2)
 219 #define META_RETRY_FOREVER      (-1)
 220 #define META_RETRY_NEVER        (0)
 221 #define META_RETRY_DEFAULT      (3)
 222
 223         struct ldaprwmap        mt_rwmap;
 224
 225         unsigned                mt_flags;
 226         int                     mt_version;
 227         time_t                  mt_timeout[ META_OP_LAST ];
 228 } metatarget_t;
 229
 230 typedef struct metadncache_t {
 231         ldap_pvt_thread_mutex_t mutex;
 232         Avlnode                 *tree;
 233
 234 #define META_DNCACHE_DISABLED   (0)
 235 #define META_DNCACHE_FOREVER    (-1)
 236         long int                ttl;  /* seconds; 0: no cache, -1: no expiry */
 237 } metadncache_t;
 238
 239 typedef struct metacandidates_t {
 240         int                     mc_ntargets;
 241         SlapReply               *mc_candidates;
 242 } metacandidates_t;
 243
 244 typedef struct metainfo_t {
 245         int                     mi_ntargets;
 246         int                     mi_defaulttarget;
 247         int                     mi_network_timeout;
 248 #define META_DEFAULT_TARGET_NONE        (-1)
 249         int                     mi_nretries;
 250
 251         metatarget_t            *mi_targets;
 252         metacandidates_t        *mi_candidates;
 253
 254         metadncache_t           mi_cache;
 255
 256         ldap_pvt_thread_mutex_t mi_conn_mutex;
 257         Avlnode                 *mi_conntree;
 258
 259         unsigned                flags;
 260 /* uses flags as defined in <back-ldap/back-ldap.h> */
 261 #define META_BACK_F_ONERR_STOP  0x00010000U
 262 #define META_BACK_ONERR_STOP(mi)        ( (mi)->flags & META_BACK_F_ONERR_STOP )
 263 #define META_BACK_ONERR_CONTINUE(mi)    ( !META_BACK_ONERR_CONTINUE( (mi) ) )
 264
 265         int                     mi_version;
 266         time_t                  mi_timeout[ META_OP_LAST ];
 267 } metainfo_t;
 268
 269 typedef enum meta_op_type {
 270         META_OP_ALLOW_MULTIPLE = 0,
 271         META_OP_REQUIRE_SINGLE,
 272         META_OP_REQUIRE_ALL
 273 } meta_op_type;
 274
 275 SlapReply *
 276 meta_back_candidates_get( Operation *op );
 277
 278 extern metaconn_t *
 279 meta_back_getconn(
 280         Operation               *op,
 281         SlapReply               *rs,
 282         int                     *candidate,
 283         ldap_back_send_t        sendok );
 284
 285 extern void
 286 meta_back_release_conn(
 287         Operation               *op,
 288         metaconn_t              *mc );
 289
 290 extern int
 291 meta_back_retry(
 292         Operation               *op,
 293         SlapReply               *rs,
 294         metaconn_t              *mc,
 295         int                     candidate,
 296         ldap_back_send_t        sendok );
 297
 298 extern void
 299 meta_back_conn_free(
 300         metaconn_t              *mc );
 301
 302 extern int
 303 meta_back_init_one_conn(
 304         Operation               *op,
 305         SlapReply               *rs,
 306         metatarget_t            *mt,
 307         metasingleconn_t        *msc,
 308         ldap_back_send_t        sendok );
 309
 310 extern int
 311 meta_back_dobind(
 312         Operation               *op,
 313         SlapReply               *rs,
 314         metaconn_t              *mc,
 315         ldap_back_send_t        sendok );
 316
 317 int
 318 meta_back_single_dobind(
 319         Operation               *op,
 320         SlapReply               *rs,
 321         metaconn_t              *msc,
 322         int                     candidate,
 323         ldap_back_send_t        sendok,
 324         int                     retries,
 325         int                     dolock );
 326
 327 extern int
 328 meta_back_op_result(
 329         metaconn_t              *mc,
 330         Operation               *op,
 331         SlapReply               *rs,
 332         int                     candidate );
 333
 334 extern int
 335 back_meta_LTX_init_module(
 336         int                     argc,
 337         char                    *argv[] );
 338
 339 extern int
 340 meta_back_conn_cmp(
 341         const void              *c1,
 342         const void              *c2 );
 343
 344 extern int
 345 meta_back_conn_dup(
 346         void                    *c1,
 347         void                    *c2 );
 348
 349 /*
 350  * Candidate stuff
 351  */
 352 extern int
 353 meta_back_is_candidate(
 354         struct berval           *nsuffix,
 355         int                     suffixscope,
 356         struct berval           *ndn,
 357         int                     scope );
 358
 359 extern int
 360 meta_back_select_unique_candidate(
 361         metainfo_t              *mi,
 362         struct berval           *ndn );
 363
 364 extern int
 365 meta_clear_unused_candidates(
 366         Operation               *op,
 367         int                     candidate );
 368
 369 extern int
 370 meta_clear_one_candidate(
 371         metasingleconn_t        *mc );
 372
 373 /*
 374  * Dn cache stuff (experimental)
 375  */
 376 extern int
 377 meta_dncache_cmp(
 378         const void              *c1,
 379         const void              *c2 );
 380
 381 extern int
 382 meta_dncache_dup(
 383         void                    *c1,
 384         void                    *c2 );
 385
 386 #define META_TARGET_NONE        (-1)
 387 #define META_TARGET_MULTIPLE    (-2)
 388 extern int
 389 meta_dncache_get_target(
 390         metadncache_t           *cache,
 391         struct berval           *ndn );
 392
 393 extern int
 394 meta_dncache_update_entry(
 395         metadncache_t           *cache,
 396         struct berval           *ndn,
 397         int                     target );
 398
 399 extern int
 400 meta_dncache_delete_entry(
 401         metadncache_t           *cache,
 402         struct berval           *ndn );
 403
 404 extern void
 405 meta_dncache_free( void *entry );
 406
 407 LDAP_END_DECL
 408
 409 #endif /* SLAPD_META_H */
 410