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