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 ldaprwmap *rwmap;
  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 int ldap_back_freeconn( Operation *op, struct ldapconn *lc );
  86 struct ldapconn *ldap_back_getconn(struct slap_op *op, struct slap_rep *rs);
  87 int ldap_back_dobind(struct ldapconn *lc, Operation *op, SlapReply *rs);
  88 int ldap_back_retry(struct ldapconn *lc, Operation *op, SlapReply *rs);
  89 int ldap_back_map_result(SlapReply *rs);
  90 int ldap_back_op_result(struct ldapconn *lc, Operation *op, SlapReply *rs,
  91         ber_int_t msgid, int sendok);
  92 int     back_ldap_LTX_init_module(int argc, char *argv[]);
  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 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 107         int remap );
 108 #define BACKLDAP_MAP    0
 109 #define BACKLDAP_REMAP  1
 110 char *
 111 ldap_back_map_filter(
 112                 struct ldapmap *at_map,
 113                 struct ldapmap *oc_map,
 114                 struct berval *f,
 115                 int remap
 116 );
 117
 118 int
 119 ldap_back_map_attrs(
 120                 struct ldapmap *at_map,
 121                 AttributeName *a,
 122                 int remap,
 123                 char ***mapped_attrs
 124 );
 125
 126 extern int ldap_back_map_config(
 127                 struct ldapmap  *oc_map,
 128                 struct ldapmap  *at_map,
 129                 const char      *fname,
 130                 int             lineno,
 131                 int             argc,
 132                 char            **argv );
 133
 134 extern int
 135 ldap_back_filter_map_rewrite(
 136                 dncookie                *dc,
 137                 Filter                  *f,
 138                 struct berval           *fstr,
 139                 int                     remap );
 140
 141 /* suffix massaging by means of librewrite */
 142 #ifdef ENABLE_REWRITE
 143 extern int suffix_massage_config( struct rewrite_info *info,
 144                 struct berval *pvnc, struct berval *nvnc,
 145                 struct berval *prnc, struct berval *nrnc);
 146 #endif /* ENABLE_REWRITE */
 147 extern int ldap_back_referral_result_rewrite( dncookie *dc, BerVarray a_vals );
 148 extern int ldap_dnattr_rewrite( dncookie *dc, BerVarray a_vals );
 149 extern int ldap_dnattr_result_rewrite( dncookie *dc, BerVarray a_vals );
 150
 151 /* (end of) from back-ldap.h before rwm removal */
 152
 153 struct metasingleconn {
 154         int                     msc_candidate;
 155 #define META_NOT_CANDIDATE      0
 156 #define META_CANDIDATE          1
 157 #define META_LAST_CONN          -1
 158
 159         LDAP                    *msc_ld;
 160         struct berval           msc_bound_ndn;
 161         struct berval           msc_cred;
 162         int                     msc_bound;
 163 #define META_UNBOUND            0
 164 #define META_BOUND              1
 165 #define META_ANONYMOUS          2
 166 };
 167
 168 #define META_LAST(lsc)          ((lsc)->msc_candidate == META_LAST_CONN)
 169
 170 struct metaconn {
 171         struct slap_conn        *mc_conn;
 172         struct rewrite_info     *mc_rwinfo;
 173
 174         /*
 175          * means that the connection is bound;
 176          * of course only one target actually is ...
 177          */
 178         int                     mc_bound_target;
 179 #define META_BOUND_NONE         -1
 180 #define META_BOUND_ALL          -2
 181         /* supersedes the connection stuff */
 182         struct metasingleconn   *mc_conns;
 183 };
 184
 185 struct metatarget {
 186         char                    *mt_uri;
 187         struct berval           mt_psuffix;             /* pretty suffix */
 188         struct berval           mt_nsuffix;             /* normalized suffix */
 189         struct berval           mt_binddn;
 190         struct berval           mt_bindpw;
 191
 192         struct berval           mt_pseudorootdn;
 193         struct berval           mt_pseudorootpw;
 194
 195         struct ldaprwmap        mt_rwmap;
 196 };
 197
 198 struct metadncache {
 199         ldap_pvt_thread_mutex_t mutex;
 200         Avlnode                 *tree;
 201
 202 #define META_DNCACHE_DISABLED   0
 203 #define META_DNCACHE_FOREVER    -1
 204         long int                ttl;  /* seconds; 0: no cache, -1: no expiry */
 205 };
 206
 207 struct metainfo {
 208         int                     ntargets;
 209         int                     defaulttarget;
 210         int                     network_timeout;
 211 #define META_DEFAULT_TARGET_NONE        -1
 212         struct metatarget       **targets;
 213
 214         struct rewrite_info     *rwinfo;
 215         Backend                 *glue_be;
 216
 217         struct metadncache      cache;
 218
 219         ldap_pvt_thread_mutex_t conn_mutex;
 220         Avlnode                 *conntree;
 221
 222         int                     savecred;
 223 };
 224
 225 #define META_OP_ALLOW_MULTIPLE          0x00
 226 #define META_OP_REQUIRE_SINGLE          0x01
 227 #define META_OP_REQUIRE_ALL             0x02
 228 extern struct metaconn *
 229 meta_back_getconn(
 230                 Operation               *op,
 231                 SlapReply               *rs,
 232                 int                     op_type,
 233                 struct berval           *dn,
 234                 int                     *candidate
 235 );
 236
 237 extern int
 238 meta_back_dobind(
 239                 struct metaconn         *lc,
 240                 Operation               *op
 241 );
 242
 243 extern int
 244 meta_back_is_valid(
 245                 struct metaconn         *lc,
 246                 int                     candidate
 247 );
 248
 249 extern int
 250 meta_back_op_result(
 251                 struct metaconn         *lc,
 252                 Operation               *op,
 253                 SlapReply               *rs
 254 );
 255
 256 extern int
 257 back_meta_LTX_init_module(
 258                 int                     argc,
 259                 char                    *argv[]
 260 );
 261
 262 extern int
 263 meta_back_conn_cmp(
 264                 const void              *c1,
 265                 const void              *c2
 266 );
 267
 268 extern int
 269 meta_back_conn_dup(
 270                 void                    *c1,
 271                 void                    *c2
 272 );
 273
 274 /*
 275  * Candidate stuff
 276  */
 277 extern int
 278 meta_back_is_candidate(
 279                 struct berval           *nsuffix,
 280                 struct berval           *ndn
 281 );
 282
 283 extern int
 284 meta_back_count_candidates(
 285                 struct metainfo         *li,
 286                 struct berval           *ndn
 287 );
 288
 289 extern int
 290 meta_back_is_candidate_unique(
 291                 struct metainfo         *li,
 292                 struct berval           *ndn
 293 );
 294
 295 extern int
 296 meta_back_select_unique_candidate(
 297                 struct metainfo         *li,
 298                 struct berval           *ndn
 299 );
 300
 301 extern int
 302 meta_clear_unused_candidates(
 303                 struct metainfo         *li,
 304                 struct metaconn         *lc,
 305                 int                     candidate,
 306                 int                     reallyclean
 307 );
 308
 309 extern int
 310 meta_clear_one_candidate(
 311                 struct metasingleconn   *lc,
 312                 int                     reallyclean
 313 );
 314
 315 /*
 316  * Dn cache stuff (experimental)
 317  */
 318 extern int
 319 meta_dncache_cmp(
 320                 const void              *c1,
 321                 const void              *c2
 322 );
 323
 324 extern int
 325 meta_dncache_dup(
 326                 void                    *c1,
 327                 void                    *c2
 328 );
 329
 330 #define META_TARGET_NONE        (-1)
 331 extern int
 332 meta_dncache_get_target(
 333                 struct metadncache      *cache,
 334                 struct berval           *ndn
 335 );
 336
 337 extern int
 338 meta_dncache_update_entry(
 339                 struct metadncache      *cache,
 340                 struct berval           *ndn,
 341                 int                     target
 342 );
 343
 344 extern int
 345 meta_dncache_delete_entry(
 346                 struct metadncache      *cache,
 347                 struct berval           *ndn
 348 );
 349
 350 extern void
 351 meta_dncache_free(
 352                 void *entry
 353 );
 354
 355 LDAP_END_DECL
 356
 357 #endif /* SLAPD_META_H */
 358