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