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 #define META_LAST_CONN          ((ber_tag_t)(-1))
 166
 167         LDAP                    *msc_ld;
 168         struct berval           msc_bound_ndn;
 169         struct berval           msc_cred;
 170         int                     msc_bound;
 171 #define META_UNBOUND            0
 172 #define META_BOUND              1
 173 #define META_ANONYMOUS          2
 174
 175         struct metainfo_t       *msc_info;
 176 } metasingleconn_t;
 177
 178 #define META_LAST(msc)          ((msc)->msc_candidate == META_LAST_CONN)
 179
 180 typedef struct metaconn_t {
 181         struct slap_conn        *mc_conn;
 182         ldap_pvt_thread_mutex_t mc_mutex;
 183
 184         /*
 185          * means that the connection is bound;
 186          * of course only one target actually is ...
 187          */
 188         int                     mc_auth_target;
 189 #define META_BOUND_NONE         (-1)
 190 #define META_BOUND_ALL          (-2)
 191         /* supersedes the connection stuff */
 192         metasingleconn_t        *mc_conns;
 193 } metaconn_t;
 194
 195 typedef struct metatarget_t {
 196         char                    *mt_uri;
 197
 198         struct berval           mt_psuffix;             /* pretty suffix */
 199         struct berval           mt_nsuffix;             /* normalized suffix */
 200
 201         struct berval           mt_binddn;
 202         struct berval           mt_bindpw;
 203
 204         struct berval           mt_pseudorootdn;
 205         struct berval           mt_pseudorootpw;
 206
 207         int                     mt_nretries;
 208 #define META_RETRY_UNDEFINED    (-2)
 209 #define META_RETRY_FOREVER      (-1)
 210 #define META_RETRY_NEVER        (0)
 211 #define META_RETRY_DEFAULT      (3)
 212
 213         struct ldaprwmap        mt_rwmap;
 214
 215         unsigned                mt_flags;
 216         int                     mt_version;
 217 } metatarget_t;
 218
 219 typedef struct metadncache_t {
 220         ldap_pvt_thread_mutex_t mutex;
 221         Avlnode                 *tree;
 222
 223 #define META_DNCACHE_DISABLED   (0)
 224 #define META_DNCACHE_FOREVER    (-1)
 225         long int                ttl;  /* seconds; 0: no cache, -1: no expiry */
 226 } metadncache_t;
 227
 228 typedef struct metainfo_t {
 229         int                     mi_ntargets;
 230         int                     mi_defaulttarget;
 231         int                     mi_network_timeout;
 232 #define META_DEFAULT_TARGET_NONE        (-1)
 233         int                     mi_nretries;
 234
 235         metatarget_t            *mi_targets;
 236         SlapReply               *mi_candidates;
 237
 238         metadncache_t           mi_cache;
 239
 240         ldap_pvt_thread_mutex_t mi_conn_mutex;
 241         Avlnode                 *mi_conntree;
 242
 243         unsigned                flags;
 244 #if 0
 245 /* defined in <back-ldap/back-ldap.h> */
 246 #define LDAP_BACK_F_NONE                0x00U
 247 #define LDAP_BACK_F_SAVECRED            0x01U
 248 #define LDAP_BACK_F_USE_TLS             0x02U
 249 #define LDAP_BACK_F_PROPAGATE_TLS       0x04U
 250 #define LDAP_BACK_F_TLS_CRITICAL        0x08U
 251 #define LDAP_BACK_F_TLS_MASK            (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 252 #define LDAP_BACK_F_CHASE_REFERRALS     0x10U
 253 #endif
 254
 255         int                     mi_version;
 256 } metainfo_t;
 257
 258 typedef enum meta_op_type {
 259         META_OP_ALLOW_MULTIPLE = 0,
 260         META_OP_REQUIRE_SINGLE,
 261         META_OP_REQUIRE_ALL
 262 } meta_op_type;
 263
 264 SlapReply *
 265 meta_back_candidates_get( Operation *op );
 266
 267 extern metaconn_t *
 268 meta_back_getconn(
 269         Operation               *op,
 270         SlapReply               *rs,
 271         int                     *candidate,
 272         ldap_back_send_t        sendok );
 273
 274 extern int
 275 meta_back_retry(
 276         Operation               *op,
 277         SlapReply               *rs,
 278         metaconn_t              *mc,
 279         int                     candidate,
 280         ldap_back_send_t        sendok );
 281
 282 extern void
 283 meta_back_conn_free( metaconn_t *mc );
 284
 285 extern int
 286 meta_back_init_one_conn(
 287         Operation               *op,
 288         SlapReply               *rs,
 289         metatarget_t            *mt,
 290         metasingleconn_t        *msc,
 291         ldap_back_send_t        sendok );
 292
 293 extern int
 294 meta_back_dobind(
 295         Operation               *op,
 296         SlapReply               *rs,
 297         metaconn_t              *mc,
 298         ldap_back_send_t        sendok );
 299
 300 int
 301 meta_back_single_dobind(
 302         Operation               *op,
 303         SlapReply               *rs,
 304         metaconn_t              *msc,
 305         int                     candidate,
 306         ldap_back_send_t        sendok,
 307         int                     retries );
 308
 309 extern int
 310 meta_back_op_result(
 311         metaconn_t              *mc,
 312         Operation               *op,
 313         SlapReply               *rs,
 314         int                     candidate );
 315
 316 extern int
 317 back_meta_LTX_init_module(
 318         int                     argc,
 319         char                    *argv[] );
 320
 321 extern int
 322 meta_back_conn_cmp(
 323         const void              *c1,
 324         const void              *c2 );
 325
 326 extern int
 327 meta_back_conn_dup(
 328         void                    *c1,
 329         void                    *c2 );
 330
 331 /*
 332  * Candidate stuff
 333  */
 334 extern int
 335 meta_back_is_candidate(
 336         struct berval           *nsuffix,
 337         struct berval           *ndn,
 338         int                     scope );
 339
 340 extern int
 341 meta_back_select_unique_candidate(
 342         metainfo_t              *mi,
 343         struct berval           *ndn );
 344
 345 extern int
 346 meta_clear_unused_candidates(
 347         Operation               *op,
 348         int                     candidate );
 349
 350 extern int
 351 meta_clear_one_candidate(
 352         metasingleconn_t        *mc );
 353
 354 /*
 355  * Dn cache stuff (experimental)
 356  */
 357 extern int
 358 meta_dncache_cmp(
 359         const void              *c1,
 360         const void              *c2 );
 361
 362 extern int
 363 meta_dncache_dup(
 364         void                    *c1,
 365         void                    *c2 );
 366
 367 #define META_TARGET_NONE        (-1)
 368 #define META_TARGET_MULTIPLE    (-2)
 369 extern int
 370 meta_dncache_get_target(
 371         metadncache_t           *cache,
 372         struct berval           *ndn );
 373
 374 extern int
 375 meta_dncache_update_entry(
 376         metadncache_t           *cache,
 377         struct berval           *ndn,
 378         int                     target );
 379
 380 extern int
 381 meta_dncache_delete_entry(
 382         metadncache_t           *cache,
 383         struct berval           *ndn );
 384
 385 extern void
 386 meta_dncache_free( void *entry );
 387
 388 LDAP_END_DECL
 389
 390 #endif /* SLAPD_META_H */
 391