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      ((char)0)
 152 #define META_CANDIDATE          ((char)1)
 153 #define META_LAST_CONN          ((char)(-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
 169         /*
 170          * means that the connection is bound;
 171          * of course only one target actually is ...
 172          */
 173         int                     mc_bound_target;
 174 #define META_BOUND_NONE         (-1)
 175 #define META_BOUND_ALL          (-2)
 176         /* supersedes the connection stuff */
 177         struct metasingleconn   *mc_conns;
 178 };
 179
 180 struct metatarget {
 181         char                    *mt_uri;
 182         struct berval           mt_psuffix;             /* pretty suffix */
 183         struct berval           mt_nsuffix;             /* normalized suffix */
 184         struct berval           mt_binddn;
 185         struct berval           mt_bindpw;
 186
 187         struct berval           mt_pseudorootdn;
 188         struct berval           mt_pseudorootpw;
 189
 190         struct ldaprwmap        mt_rwmap;
 191 };
 192
 193 struct metadncache {
 194         ldap_pvt_thread_mutex_t mutex;
 195         Avlnode                 *tree;
 196
 197 #define META_DNCACHE_DISABLED   (0)
 198 #define META_DNCACHE_FOREVER    (-1)
 199         long int                ttl;  /* seconds; 0: no cache, -1: no expiry */
 200 };
 201
 202 struct metainfo {
 203         int                     mi_ntargets;
 204         int                     mi_defaulttarget;
 205         int                     mi_network_timeout;
 206 #define META_DEFAULT_TARGET_NONE        (-1)
 207         struct metatarget       **mi_targets;
 208         char                    *mi_candidates;
 209
 210         struct metadncache      mi_cache;
 211
 212         ldap_pvt_thread_mutex_t mi_conn_mutex;
 213         Avlnode                 *mi_conntree;
 214
 215         unsigned                flags;
 216 #if 0
 217 /* defined in <back-ldap/back-ldap.h> */
 218 #define LDAP_BACK_F_NONE                0x00U
 219 #define LDAP_BACK_F_SAVECRED            0x01U
 220 #define LDAP_BACK_F_USE_TLS             0x02U
 221 #define LDAP_BACK_F_TLS_CRITICAL        ( 0x04U | LDAP_BACK_F_USE_TLS )
 222 #define LDAP_BACK_F_CHASE_REFERRALS     0x8U
 223 #endif
 224 };
 225
 226 typedef enum meta_op_type {
 227         META_OP_ALLOW_MULTIPLE = 0,
 228         META_OP_REQUIRE_SINGLE,
 229         META_OP_REQUIRE_ALL
 230 } meta_op_type;
 231
 232 char *
 233 meta_back_candidates_get( Operation *op );
 234
 235 extern struct metaconn *
 236 meta_back_getconn(
 237                 Operation               *op,
 238                 SlapReply               *rs,
 239                 int                     *candidate,
 240                 ldap_back_send_t        sendok
 241 );
 242
 243 extern int
 244 meta_back_dobind(
 245                 struct metaconn         *lc,
 246                 Operation               *op,
 247                 ldap_back_send_t        sendok
 248 );
 249
 250 extern int
 251 meta_back_is_valid(
 252                 struct metaconn         *lc,
 253                 int                     candidate
 254 );
 255
 256 extern int
 257 meta_back_op_result(
 258                 struct metaconn         *lc,
 259                 Operation               *op,
 260                 SlapReply               *rs,
 261                 int                     candidate
 262 );
 263
 264 extern int
 265 back_meta_LTX_init_module(
 266                 int                     argc,
 267                 char                    *argv[]
 268 );
 269
 270 extern int
 271 meta_back_conn_cmp(
 272                 const void              *c1,
 273                 const void              *c2
 274 );
 275
 276 extern int
 277 meta_back_conn_dup(
 278                 void                    *c1,
 279                 void                    *c2
 280 );
 281
 282 /*
 283  * Candidate stuff
 284  */
 285 extern int
 286 meta_back_is_candidate(
 287                 struct berval           *nsuffix,
 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                 Operation               *op,
 300                 struct metaconn         *lc,
 301                 int                     candidate
 302 );
 303
 304 extern int
 305 meta_clear_one_candidate(
 306                 struct metasingleconn   *lc
 307 );
 308
 309 /*
 310  * Dn cache stuff (experimental)
 311  */
 312 extern int
 313 meta_dncache_cmp(
 314                 const void              *c1,
 315                 const void              *c2
 316 );
 317
 318 extern int
 319 meta_dncache_dup(
 320                 void                    *c1,
 321                 void                    *c2
 322 );
 323
 324 #define META_TARGET_NONE        (-1)
 325 #define META_TARGET_MULTIPLE    (-2)
 326 extern int
 327 meta_dncache_get_target(
 328                 struct metadncache      *cache,
 329                 struct berval           *ndn
 330 );
 331
 332 extern int
 333 meta_dncache_update_entry(
 334                 struct metadncache      *cache,
 335                 struct berval           *ndn,
 336                 int                     target
 337 );
 338
 339 extern int
 340 meta_dncache_delete_entry(
 341                 struct metadncache      *cache,
 342                 struct berval           *ndn
 343 );
 344
 345 extern void
 346 meta_dncache_free(
 347                 void *entry
 348 );
 349
 350 LDAP_END_DECL
 351
 352 #endif /* SLAPD_META_H */
 353