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