]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/back-meta/back-meta.h
Preliminary ldapAdd support
[openldap] / servers / slapd / back-meta / back-meta.h
index dcbe64632c22399b0244e0d125c6f0df0d079251..6df5a58e5c7149be6def00eac32c788fd781a0cd 100644 (file)
@@ -1,70 +1,24 @@
-/*
- * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
- * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
- *
- * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
- *
- * Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
- *
- * This work has been developed to fulfill the requirements
- * of SysNet s.n.c. <http:www.sys-net.it> and it has been donated
- * to the OpenLDAP Foundation in the hope that it may be useful
- * to the Open Source community, but WITHOUT ANY WARRANTY.
- *
- * Permission is granted to anyone to use this software for any purpose
- * on any computer system, and to alter it and redistribute it, subject
- * to the following restrictions:
- *
- * 1. The author and SysNet s.n.c. are not responsible for the consequences
- *    of use of this software, no matter how awful, even if they arise from 
- *    flaws in it.
- *
- * 2. The origin of this software must not be misrepresented, either by
- *    explicit claim or by omission.  Since few users ever read sources,
- *    credits should appear in the documentation.
- *
- * 3. Altered versions must be plainly marked as such, and must not be
- *    misrepresented as being the original software.  Since few users
- *    ever read sources, credits should appear in the documentation.
- *    SysNet s.n.c. cannot be responsible for the consequences of the
- *    alterations.
- *                         
- * 4. This notice may not be removed or altered.
- *
- *
- * This software is based on the backend back-ldap, implemented
- * by Howard Chu <hyc@highlandsun.com>, and modified by Mark Valence
- * <kurash@sassafras.com>, Pierangelo Masarati <ando@sys-net.it> and other
- * contributors. The contribution of the original software to the present
- * implementation is acknowledged in this copyright statement.
- *
- * A special acknowledgement goes to Howard for the overall architecture
- * (and for borrowing large pieces of code), and to Mark, who implemented
- * from scratch the attribute/objectclass mapping.
- *
- * The original copyright statement follows.
- *
- * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
+/* $OpenLDAP$ */
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Permission is granted to anyone to use this software for any purpose
- * on any computer system, and to alter it and redistribute it, subject
- * to the following restrictions:
+ * Copyright 1999-2005 The OpenLDAP Foundation.
+ * Portions Copyright 2001-2003 Pierangelo Masarati.
+ * Portions Copyright 1999-2003 Howard Chu.
+ * All rights reserved.
  *
- * 1. The author is not responsible for the consequences of use of this
- *    software, no matter how awful, even if they arise from flaws in it.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted only as authorized by the OpenLDAP
+ * Public License.
  *
- * 2. The origin of this software must not be misrepresented, either by
- *    explicit claim or by omission.  Since few users ever read sources,
- *    credits should appear in the documentation.
- *
- * 3. Altered versions must be plainly marked as such, and must not be
- *    misrepresented as being the original software.  Since few users
- *    ever read sources, credits should appear in the
- *    documentation.
- *
- * 4. This notice may not be removed or altered.
- *                
- */ 
+ * A copy of this license is available in the file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
+ */
+/* ACKNOWLEDGEMENTS:
+ * This work was initially developed by the Howard Chu for inclusion
+ * in OpenLDAP Software and subsequently enhanced by Pierangelo
+ * Masarati.
+ */
 
 #ifndef SLAPD_LDAP_H
 #error "include servers/slapd/back-ldap/back-ldap.h before this file!"
 #ifndef SLAPD_META_H
 #define SLAPD_META_H
 
-#include "external.h"
+#include "proto-meta.h"
 
 /* String rewrite library */
 #include "rewrite.h"
-
 LDAP_BEGIN_DECL
 
 struct slap_conn;
 struct slap_op;
 
+/* from back-ldap.h before rwm removal */
+struct ldapmap {
+       int drop_missing;
+
+       Avlnode *map;
+       Avlnode *remap;
+};
+
+struct ldapmapping {
+       struct berval src;
+       struct berval dst;
+};
+
+struct ldaprwmap {
+       /*
+        * DN rewriting
+        */
+#ifdef ENABLE_REWRITE
+       struct rewrite_info *rwm_rw;
+#else /* !ENABLE_REWRITE */
+       /* some time the suffix massaging without librewrite
+        * will be disabled */
+       BerVarray rwm_suffix_massage;
+#endif /* !ENABLE_REWRITE */
+
+       /*
+        * Attribute/objectClass mapping
+        */
+       struct ldapmap rwm_oc;
+       struct ldapmap rwm_at;
+};
+
+/* Whatever context ldap_back_dn_massage needs... */
+typedef struct dncookie {
+       struct ldaprwmap *rwmap;
+
+#ifdef ENABLE_REWRITE
+       Connection *conn;
+       char *ctx;
+       SlapReply *rs;
+#else
+       int normalized;
+       int tofrom;
+#endif
+} dncookie;
+
+#define META_BIND_NRETRIES     3
+#define META_BIND_TIMEOUT      1000
+
+int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
+       struct berval *res);
+
+extern int ldap_back_conn_cmp( const void *c1, const void *c2);
+extern int ldap_back_conn_dup( void *c1, void *c2 );
+extern void ldap_back_conn_free( void *c );
+
+/* attributeType/objectClass mapping */
+int mapping_cmp (const void *, const void *);
+int mapping_dup (void *, void *);
+
+void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
+int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
+       struct ldapmapping **m, int remap );
+void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
+       int remap );
+#define BACKLDAP_MAP   0
+#define BACKLDAP_REMAP 1
+char *
+ldap_back_map_filter(
+               struct ldapmap *at_map,
+               struct ldapmap *oc_map,
+               struct berval *f,
+               int remap
+);
+
+int
+ldap_back_map_attrs(
+               struct ldapmap *at_map,
+               AttributeName *a,
+               int remap,
+               char ***mapped_attrs
+);
+
+extern int ldap_back_map_config(
+               struct ldapmap  *oc_map,
+               struct ldapmap  *at_map,
+               const char      *fname,
+               int             lineno,
+               int             argc,
+               char            **argv );
+
+extern int
+ldap_back_filter_map_rewrite(
+               dncookie                *dc,
+               Filter                  *f,
+               struct berval           *fstr,
+               int                     remap );
+
+/* suffix massaging by means of librewrite */
+#ifdef ENABLE_REWRITE
+extern int suffix_massage_config( struct rewrite_info *info,
+               struct berval *pvnc, struct berval *nvnc,
+               struct berval *prnc, struct berval *nrnc);
+#endif /* ENABLE_REWRITE */
+extern int ldap_back_referral_result_rewrite( dncookie *dc, BerVarray a_vals );
+extern int ldap_dnattr_rewrite( dncookie *dc, BerVarray a_vals );
+extern int ldap_dnattr_result_rewrite( dncookie *dc, BerVarray a_vals );
+
+/* (end of) from back-ldap.h before rwm removal */
+
 struct metasingleconn {
-       int                     candidate;
+       int                     msc_candidate;
 #define        META_NOT_CANDIDATE      0
 #define        META_CANDIDATE          1
+#define        META_LAST_CONN          -1
        
-       LDAP                    *ld;
-       struct berval           *bound_dn;
-       int                     bound;
+       LDAP                    *msc_ld;
+       struct berval           msc_bound_ndn;
+       struct berval           msc_cred;
+       int                     msc_bound;
 #define META_UNBOUND           0
 #define META_BOUND             1
 #define META_ANONYMOUS         2
 };
 
+#define META_LAST(lsc)         ((lsc)->msc_candidate == META_LAST_CONN)
+
 struct metaconn {
-       struct slap_conn        *conn;
-       struct rewrite_info     *rwinfo;
+       struct slap_conn        *mc_conn;
+       struct rewrite_info     *mc_rwinfo;
        
        /*
         * means that the connection is bound; 
         * of course only one target actually is ...
         */
-       int             bound_target;
+       int                     mc_bound_target;
 #define META_BOUND_NONE                -1
 #define META_BOUND_ALL         -2
        /* supersedes the connection stuff */
-       struct metasingleconn **conns;
+       struct metasingleconn   *mc_conns;
 };
 
 struct metatarget {
-       char                    *uri;
-       struct berval           psuffix;        /* pretty suffix */
-       struct berval           suffix;         /* normalized suffix */
-       struct berval           binddn;
-       struct berval           bindpw;
-
-       struct berval           pseudorootdn;
-       struct berval           pseudorootpw;
+       char                    *mt_uri;
+       struct berval           mt_psuffix;             /* pretty suffix */
+       struct berval           mt_nsuffix;             /* normalized suffix */
+       struct berval           mt_binddn;
+       struct berval           mt_bindpw;
 
-       struct rewrite_info     *rwinfo;
+       struct berval           mt_pseudorootdn;
+       struct berval           mt_pseudorootpw;
 
-       struct ldapmap          oc_map;
-       struct ldapmap          at_map;
+       struct ldaprwmap        mt_rwmap;
 };
 
 struct metadncache {
@@ -139,44 +203,46 @@ struct metadncache {
 struct metainfo {
        int                     ntargets;
        int                     defaulttarget;
+       int                     network_timeout;
 #define META_DEFAULT_TARGET_NONE       -1
        struct metatarget       **targets;
 
+       struct rewrite_info     *rwinfo;
+       Backend                 *glue_be; 
+
        struct metadncache      cache;
        
        ldap_pvt_thread_mutex_t conn_mutex;
        Avlnode                 *conntree;
-};
-
-extern int
-meta_back_do_single_bind(
-               struct metainfo         *li,
-               struct metaconn         *lc,
-               struct berval           *dn,
-               struct berval           *ndn,
-               struct berval           *cred,
-               int                     method,
-               int                     candidate
-);
 
+       unsigned                flags;
+/* defined in <back-ldap/back-ldap.h>
+#define LDAP_BACK_F_NONE               0x00U
+#define LDAP_BACK_F_SAVECRED           0x01U
+#define LDAP_BACK_F_USE_TLS            0x02U
+#define LDAP_BACK_F_TLS_CRITICAL       ( 0x04U | LDAP_BACK_F_USE_TLS )
+#define LDAP_BACK_F_CHASE_REFERRALS    0x8U
+*/
+};
 
 #define META_OP_ALLOW_MULTIPLE         0x00
 #define META_OP_REQUIRE_SINGLE         0x01
 #define META_OP_REQUIRE_ALL            0x02
 extern struct metaconn *
 meta_back_getconn(
-               struct                  metainfo *li,
-               struct                  slap_conn *conn,
-               struct                  slap_op *op,
+               Operation               *op,
+               SlapReply               *rs,
                int                     op_type,
                struct berval           *dn,
-               int                     *candidate
+               int                     *candidate,
+               ldap_back_send_t        sendok
 );
 
 extern int
 meta_back_dobind(
                struct metaconn         *lc,
-               Operation               *op
+               Operation               *op,
+               ldap_back_send_t        sendok
 );
 
 extern int
@@ -188,7 +254,8 @@ meta_back_is_valid(
 extern int
 meta_back_op_result(
                struct metaconn         *lc,
-               Operation               *op
+               Operation               *op,
+               SlapReply               *rs
 );
 
 extern int
@@ -265,6 +332,7 @@ meta_dncache_dup(
                void                    *c2
 );
 
+#define META_TARGET_NONE       (-1)
 extern int
 meta_dncache_get_target(
                struct metadncache      *cache,