git.sur5r.net Git - openldap/blob - servers/slapd/back-meta/back-meta.h

   1 /*
   2  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   4  *
   5  * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
   6  *
   7  * Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
   8  *
   9  * This work has been developed to fulfill the requirements
  10  * of SysNet s.n.c. <http:www.sys-net.it> and it has been donated
  11  * to the OpenLDAP Foundation in the hope that it may be useful
  12  * to the Open Source community, but WITHOUT ANY WARRANTY.
  13  *
  14  * Permission is granted to anyone to use this software for any purpose
  15  * on any computer system, and to alter it and redistribute it, subject
  16  * to the following restrictions:
  17  *
  18  * 1. The author and SysNet s.n.c. are not responsible for the consequences
  19  *    of use of this software, no matter how awful, even if they arise from
  20  *    flaws in it.
  21  *
  22  * 2. The origin of this software must not be misrepresented, either by
  23  *    explicit claim or by omission.  Since few users ever read sources,
  24  *    credits should appear in the documentation.
  25  *
  26  * 3. Altered versions must be plainly marked as such, and must not be
  27  *    misrepresented as being the original software.  Since few users
  28  *    ever read sources, credits should appear in the documentation.
  29  *    SysNet s.n.c. cannot be responsible for the consequences of the
  30  *    alterations.
  31  *
  32  * 4. This notice may not be removed or altered.
  33  *
  34  *
  35  * This software is based on the backend back-ldap, implemented
  36  * by Howard Chu <hyc@highlandsun.com>, and modified by Mark Valence
  37  * <kurash@sassafras.com>, Pierangelo Masarati <ando@sys-net.it> and other
  38  * contributors. The contribution of the original software to the present
  39  * implementation is acknowledged in this copyright statement.
  40  *
  41  * A special acknowledgement goes to Howard for the overall architecture
  42  * (and for borrowing large pieces of code), and to Mark, who implemented
  43  * from scratch the attribute/objectclass mapping.
  44  *
  45  * The original copyright statement follows.
  46  *
  47  * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
  48  *
  49  * Permission is granted to anyone to use this software for any purpose
  50  * on any computer system, and to alter it and redistribute it, subject
  51  * to the following restrictions:
  52  *
  53  * 1. The author is not responsible for the consequences of use of this
  54  *    software, no matter how awful, even if they arise from flaws in it.
  55  *
  56  * 2. The origin of this software must not be misrepresented, either by
  57  *    explicit claim or by omission.  Since few users ever read sources,
  58  *    credits should appear in the documentation.
  59  *
  60  * 3. Altered versions must be plainly marked as such, and must not be
  61  *    misrepresented as being the original software.  Since few users
  62  *    ever read sources, credits should appear in the
  63  *    documentation.
  64  *
  65  * 4. This notice may not be removed or altered.
  66  *
  67  */
  68
  69 #ifndef SLAPD_LDAP_H
  70 #error "include servers/slapd/back-ldap/back-ldap.h before this file!"
  71 #endif /* SLAPD_LDAP_H */
  72
  73 #ifndef SLAPD_META_H
  74 #define SLAPD_META_H
  75
  76 #include "external.h"
  77
  78 /* String rewrite library */
  79 #include "rewrite.h"
  80 #include "cache.h"
  81 LDAP_BEGIN_DECL
  82
  83 struct slap_conn;
  84 struct slap_op;
  85
  86 struct metasingleconn {
  87         int                     candidate;
  88 #define META_NOT_CANDIDATE      0
  89 #define META_CANDIDATE          1
  90 #define META_LAST_CONN          -1
  91
  92         LDAP                    *ld;
  93         struct berval           bound_dn;
  94         struct berval           cred;
  95         int                     bound;
  96 #define META_UNBOUND            0
  97 #define META_BOUND              1
  98 #define META_ANONYMOUS          2
  99 };
 100
 101 #define META_LAST(lsc)          ((lsc)->candidate == META_LAST_CONN)
 102
 103 struct metaconn {
 104         struct slap_conn        *conn;
 105         struct rewrite_info     *rwinfo;
 106
 107         /*
 108          * means that the connection is bound;
 109          * of course only one target actually is ...
 110          */
 111         int             bound_target;
 112 #define META_BOUND_NONE         -1
 113 #define META_BOUND_ALL          -2
 114         /* supersedes the connection stuff */
 115         struct metasingleconn *conns;
 116 };
 117
 118 struct metatarget {
 119         char                    *uri;
 120         struct berval           psuffix;        /* pretty suffix */
 121         struct berval           suffix;         /* normalized suffix */
 122         struct berval           binddn;
 123         struct berval           bindpw;
 124
 125         struct berval           pseudorootdn;
 126         struct berval           pseudorootpw;
 127
 128         struct rewrite_info     *rwinfo;
 129
 130         struct ldapmap          oc_map;
 131         struct ldapmap          at_map;
 132 };
 133
 134 struct metadncache {
 135         ldap_pvt_thread_mutex_t mutex;
 136         Avlnode                 *tree;
 137
 138 #define META_DNCACHE_DISABLED   0
 139 #define META_DNCACHE_FOREVER    -1
 140         long int                ttl;  /* seconds; 0: no cache, -1: no expiry */
 141 };
 142
 143 struct metainfo {
 144         int                     ntargets;
 145         int                     defaulttarget;
 146 #define META_DEFAULT_TARGET_NONE        -1
 147         struct metatarget       **targets;
 148
 149 #ifdef LDAP_CACHING
 150         struct rewrite_info     *rwinfo;
 151         cache_manager           *cm;
 152         Backend                 *glue_be;
 153 #endif /* LDAP_CACHING */
 154
 155         struct metadncache      cache;
 156
 157         ldap_pvt_thread_mutex_t conn_mutex;
 158         Avlnode                 *conntree;
 159
 160         int                     savecred;
 161 };
 162
 163 #define META_OP_ALLOW_MULTIPLE          0x00
 164 #define META_OP_REQUIRE_SINGLE          0x01
 165 #define META_OP_REQUIRE_ALL             0x02
 166 extern struct metaconn *
 167 meta_back_getconn(
 168                 Operation               *op,
 169                 SlapReply               *rs,
 170                 int                     op_type,
 171                 struct berval           *dn,
 172                 int                     *candidate
 173 );
 174
 175 extern int
 176 meta_back_dobind(
 177                 struct metaconn         *lc,
 178                 Operation               *op
 179 );
 180
 181 extern int
 182 meta_back_is_valid(
 183                 struct metaconn         *lc,
 184                 int                     candidate
 185 );
 186
 187 extern int
 188 meta_back_op_result(
 189                 struct metaconn         *lc,
 190                 Operation               *op,
 191                 SlapReply               *rs
 192 );
 193
 194 extern int
 195 back_meta_LTX_init_module(
 196                 int                     argc,
 197                 char                    *argv[]
 198 );
 199
 200 extern int
 201 meta_back_conn_cmp(
 202                 const void              *c1,
 203                 const void              *c2
 204 );
 205
 206 extern int
 207 meta_back_conn_dup(
 208                 void                    *c1,
 209                 void                    *c2
 210 );
 211
 212 /*
 213  * Candidate stuff
 214  */
 215 extern int
 216 meta_back_is_candidate(
 217                 struct berval           *nsuffix,
 218                 struct berval           *ndn
 219 );
 220
 221 extern int
 222 meta_back_count_candidates(
 223                 struct metainfo         *li,
 224                 struct berval           *ndn
 225 );
 226
 227 extern int
 228 meta_back_is_candidate_unique(
 229                 struct metainfo         *li,
 230                 struct berval           *ndn
 231 );
 232
 233 extern int
 234 meta_back_select_unique_candidate(
 235                 struct metainfo         *li,
 236                 struct berval           *ndn
 237 );
 238
 239 extern int
 240 meta_clear_unused_candidates(
 241                 struct metainfo         *li,
 242                 struct metaconn         *lc,
 243                 int                     candidate,
 244                 int                     reallyclean
 245 );
 246
 247 extern int
 248 meta_clear_one_candidate(
 249                 struct metasingleconn   *lc,
 250                 int                     reallyclean
 251 );
 252
 253 /*
 254  * Dn cache stuff (experimental)
 255  */
 256 extern int
 257 meta_dncache_cmp(
 258                 const void              *c1,
 259                 const void              *c2
 260 );
 261
 262 extern int
 263 meta_dncache_dup(
 264                 void                    *c1,
 265                 void                    *c2
 266 );
 267
 268 extern int
 269 meta_dncache_get_target(
 270                 struct metadncache      *cache,
 271                 struct berval           *ndn
 272 );
 273
 274 extern int
 275 meta_dncache_update_entry(
 276                 struct metadncache      *cache,
 277                 struct berval           *ndn,
 278                 int                     target
 279 );
 280
 281 extern int
 282 meta_dncache_delete_entry(
 283                 struct metadncache      *cache,
 284                 struct berval           *ndn
 285 );
 286
 287 extern void
 288 meta_dncache_free(
 289                 void *entry
 290 );
 291
 292 LDAP_END_DECL
 293
 294 #endif /* SLAPD_META_H */
 295