Use network log for LDAP operations output
[claws.git] / src / ldaputil.c
index 27ec13904f8060704022d3a1232ea87edb04ee10..1be1854245fa436e5a154c28e96567a96cf697f5 100644 (file)
@@ -1,10 +1,10 @@
 /*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 2003-2007 Match Grun and the Claws Mail team
+ * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 2003-2018 Match Grun and the Claws Mail team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
@@ -13,8 +13,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
+#include "claws-features.h"
 #endif
 
 #ifdef USE_LDAP
 
 #include <glib.h>
+#include <glib/gi18n.h>
 #include <string.h>
 #include <sys/time.h>
-#include <ldap.h>
-#include <lber.h>
 #include <errno.h>
+#include "common/utils.h"
+#include "ldaputil.h"
+#include "ldapserver.h"
+#include "ldapctrl.h"
+#include "log.h"
 
 #define SYLDAP_TEST_FILTER   "(objectclass=*)"
 #define SYLDAP_SEARCHBASE_V2 "cn=config"
@@ -74,6 +78,7 @@ static GList *ldaputil_test_v3( LDAP *ld, gint tov, gint *errcode ) {
                attribs, 0, NULL, NULL, &timeout, 0, &result );
 
        if( rc == LDAP_SUCCESS ) {
+               log_message(LOG_PROTOCOL, _("LDAP (search): succesful\n"));
                /* Process entries */
                for( e = ldap_first_entry( ld, result );
                     e != NULL;
@@ -103,7 +108,12 @@ static GList *ldaputil_test_v3( LDAP *ld, gint tov, gint *errcode ) {
                        }
                        ber = NULL;
                }
-       } 
+       } else {
+               log_error(LOG_PROTOCOL, _("LDAP error (search): %d (%s)\n"),
+                               rc, ldaputil_get_error(ld));
+               debug_print("LDAP: Error %d (%s)\n", rc, ldaputil_get_error(ld));
+       }
+       
        if (errcode)
                *errcode = rc;
        if (result)
@@ -143,6 +153,7 @@ static GList *ldaputil_test_v2( LDAP *ld, gint tov ) {
                attribs, 0, NULL, NULL, &timeout, 0, &result );
 
        if( rc == LDAP_SUCCESS ) {
+               log_message(LOG_PROTOCOL, _("LDAP (search): succesful\n"));
                /* Process entries */
                for( e = ldap_first_entry( ld, result );
                     e != NULL;
@@ -168,8 +179,7 @@ static GList *ldaputil_test_v2( LDAP *ld, gint tov ) {
                                                        ch = ( char * ) strchr( tmp, ':' );
                                                        if( ch ) {
                                                                gchar *bn = g_strdup( ++ch );
-                                                               g_strchomp( bn );
-                                                               g_strchug( bn );
+                                                               g_strstrip( bn );
                                                                baseDN = g_list_append(
                                                                        baseDN, g_strdup( bn ) );
                                                                g_free( bn );
@@ -186,12 +196,37 @@ static GList *ldaputil_test_v2( LDAP *ld, gint tov ) {
                        }
                        ber = NULL;
                }
+       } else {
+               log_error(LOG_PROTOCOL, _("LDAP error (search): %d (%s)\n"),
+                               rc, ldaputil_get_error(ld));
+               debug_print("LDAP: Error %d (%s)\n", rc, ldaputil_get_error(ld));
        }
        if (result)
                ldap_msgfree( result );
        return baseDN;
 }
 
+int claws_ldap_simple_bind_s( LDAP *ld, LDAP_CONST char *dn, LDAP_CONST char *passwd )
+{
+       debug_print("binding: DN->%s\n", dn?dn:"null");
+#ifdef G_OS_UNIX
+       struct berval cred;
+
+       if ( passwd != NULL ) {
+               cred.bv_val = (char *) passwd;
+               cred.bv_len = strlen( passwd );
+       } else {
+               cred.bv_val = "";
+               cred.bv_len = 0;
+       }
+
+       return ldap_sasl_bind_s( ld, dn, LDAP_SASL_SIMPLE, &cred,
+               NULL, NULL, NULL );
+#else
+       return ldap_simple_bind_s(ld, (PCHAR)dn, (PCHAR)passwd);
+#endif
+}
+
 /**
  * Attempt to discover the base DN for the server.
  * \param  host   Host name.
@@ -208,63 +243,43 @@ GList *ldaputil_read_basedn(
 {
        GList *baseDN = NULL;
        LDAP *ld = NULL;
+       LdapControl *ctl = ldapctl_create();
        gint rc;
-#ifdef USE_LDAP_TLS
-       gint version;
-#endif
 
-       if( host == NULL ) return baseDN;
-       if( port < 1 ) return baseDN;
+       if( host == NULL ) 
+               return NULL;
+       if( port < 1 ) 
+               return NULL;
 
-       /* Connect to server. */
+       ldapctl_set_tls(ctl, tls);
+       ldapctl_set_ssl(ctl, ssl);
+       ldapctl_set_port(ctl, port);
+       ldapctl_set_host(ctl, host);
+       ldapctl_set_timeout(ctl, tov);
+       ldapctl_set_bind_dn(ctl, bindDN);
 
-       if (!ssl) {
-               ld = ldap_init( host, port );
-       } else {
-               gchar *uri = g_strdup_printf("ldaps://%s:%d",
-                               host, port);
-               rc = ldap_initialize(&ld, uri);
-               g_free(uri);
+       ld = ldapsvr_connect(ctl);
+       if (ld == NULL) {
+               ldapctl_free(ctl);
+               return NULL;
        }
-       if( ld == NULL ) {
-               return baseDN;
-       }
-#ifdef USE_LDAP_TLS
-       if( tls && !ssl ) {
-               /* Handle TLS */
-               version = LDAP_VERSION3;
-               rc = ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version );
-               if( rc != LDAP_OPT_SUCCESS ) {
-                       ldap_unbind( ld );
-                       return baseDN;
-               }
-               rc = ldap_start_tls_s( ld, NULL, NULL );
-               if (rc != 0) {
-                       ldap_unbind( ld );
-                       return baseDN;
-               }
-       }
-#endif
-
-       /* Bind to the server, if required */
-       if( bindDN ) {
-               if( *bindDN != '\0' ) {
-                       rc = ldap_simple_bind_s( ld, bindDN, bindPW );
-                       if( rc != LDAP_SUCCESS ) {
-                               ldap_unbind( ld );
-                               return baseDN;
-                       }
-               }
-       }
-
-       /* Test for LDAP version 3 */
        baseDN = ldaputil_test_v3( ld, tov, &rc );
+       if (baseDN)
+               debug_print("Using LDAP v3\n");
 
+#ifdef G_OS_UNIX
        if( baseDN == NULL && !LDAP_API_ERROR(rc) ) {
+#else
+       if( baseDN == NULL) {
+#endif
                baseDN = ldaputil_test_v2( ld, tov );
+               if (baseDN)
+                       debug_print("Using LDAP v2\n");
        }
-       if (ld && !LDAP_API_ERROR(rc))
-               ldap_unbind( ld );
+       if (ld)
+               ldapsvr_disconnect(ld);
+
+       ldapctl_free(ctl);
        
        return baseDN;
 }
@@ -276,55 +291,25 @@ GList *ldaputil_read_basedn(
  * \param  port Port number.
  * \return <i>TRUE</i> if connected successfully.
  */
-gboolean ldaputil_test_connect( const gchar *host, const gint port, int ssl, int tls ) {
+gboolean ldaputil_test_connect( const gchar *host, const gint port, int ssl, int tls, int secs ) {
        gboolean retVal = FALSE;
+       LdapControl *ctl = ldapctl_create();
        LDAP *ld;
-#ifdef USE_LDAP_TLS
-       gint rc;
-       gint version;
-#endif
-       if( host == NULL ) return retVal;
-       if( port < 1 ) return retVal;
-       if (!ssl) {
-               ld = ldap_open( host, port );
-       } else {
-               gchar *uri = g_strdup_printf("ldaps://%s:%d",
-                               host, port);
-               ldap_initialize(&ld, uri);
-               g_free(uri);
-       }
-       if (ld == NULL)
-               return FALSE;
 
-#ifdef USE_LDAP_TLS
-       if (ssl) {
-               GList *dummy = ldaputil_test_v3( ld, 10, &rc );
-               if (dummy)
-                       g_list_free(dummy);
-               if (LDAP_API_ERROR(rc))
-                       return FALSE;
-       }
+       ldapctl_set_tls(ctl, tls);
+       ldapctl_set_ssl(ctl, ssl);
+       ldapctl_set_port(ctl, port);
+       ldapctl_set_host(ctl, host);
+       ldapctl_set_timeout(ctl, secs);
 
-       if( tls && !ssl ) {
-               /* Handle TLS */
-               version = LDAP_VERSION3;
-               rc = ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version );
-               if( rc != LDAP_OPT_SUCCESS ) {
-                       ldap_unbind( ld );
-                       return FALSE;
-               }
-
-               rc = ldap_start_tls_s( ld, NULL, NULL );
-               if (rc != 0) {
-                       ldap_unbind( ld );
-                       return FALSE;
-               }
-       }
-#endif
+       ld = ldapsvr_connect(ctl);
        if( ld != NULL ) {
-               ldap_unbind( ld );
+               ldapsvr_disconnect(ld);
+               debug_print("ld != NULL\n");
                retVal = TRUE;
        }
+       ldapctl_free(ctl);
+
        return retVal;
 }
 
@@ -336,6 +321,27 @@ gboolean ldaputil_test_ldap_lib( void ) {
        return TRUE;
 }
 
+const gchar *ldaputil_get_error(LDAP *ld)
+{
+       gchar *ld_error = NULL;
+       static gchar error[512];
+
+       ldap_get_option( ld, LDAP_OPT_ERROR_STRING, &ld_error);
+       if (ld_error != NULL)
+               strncpy2(error, ld_error, sizeof(error));
+       else
+               strncpy2(error, _("Unknown error"), sizeof(error));
+#ifndef G_OS_WIN32
+       /* From https://msdn.microsoft.com/en-us/library/aa366594%28v=vs.85%29.aspx
+        * "LDAP_OPT_ERROR_STRING returns a pointer to an internal static
+        * string table, and ldap_memfree should not be called when using
+        * this session option."
+        */
+       ldap_memfree(ld_error);
+#endif
+
+       return error;
+}
 #endif /* USE_LDAP */
 
 /*