]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_ssl_gnutls.cpp
Add LOG_ prefix to the log level enum values.
[user/henk/code/inspircd.git] / src / modules / extra / m_ssl_gnutls.cpp
index bba2b620b0c51fbc88a78c8f949404b43cac0d1b..31beb258f6b8f0c1d260fa055fcebf4a5795d4fe 100644 (file)
 
 
 #include "inspircd.h"
+#include <gcrypt.h>
 #include <gnutls/gnutls.h>
 #include <gnutls/x509.h>
-#include <gcrypt.h>
 #include "ssl.h"
 #include "m_cap.h"
 
-#ifdef WINDOWS
+#ifdef _WIN32
 # pragma comment(lib, "libgnutls.lib")
 # pragma comment(lib, "libgcrypt.lib")
 # pragma comment(lib, "libgpg-error.lib")
 #endif
 
 /* $ModDesc: Provides SSL support for clients */
-/* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") -Wno-deprecated-declarations */
-/* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") -lgcrypt */
+/* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") exec("libgcrypt-config --cflags") */
+/* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") exec("libgcrypt-config --libs") */
+/* $NoPedantic */
+
+// These don't exist in older GnuTLS versions
+#if ((GNUTLS_VERSION_MAJOR > 2) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR > 1) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR == 1 && GNUTLS_VERSION_MICRO >= 7))
+#define GNUTLS_NEW_PRIO_API
+#endif
+
+#if(GNUTLS_VERSION_MAJOR < 2)
+typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
+typedef gnutls_dh_params_t gnutls_dh_params;
+#endif
 
 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
 
 static std::vector<gnutls_x509_crt_t> x509_certs;
 static gnutls_x509_privkey_t x509_key;
+#if(GNUTLS_VERSION_MAJOR < 2 || ( GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR < 12 ) )
 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
        const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) {
 
        st->type = GNUTLS_CRT_X509;
+#else
+static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
+       const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr2_st * st) {
+       st->cert_type = GNUTLS_CRT_X509;
+       st->key_type = GNUTLS_PRIVKEY_X509;
+#endif
        st->ncerts = x509_certs.size();
        st->cert.x509 = &x509_certs[0];
        st->key.x509 = x509_key;
@@ -159,9 +177,12 @@ class ModuleSSLGnuTLS : public Module
 {
        issl_session* sessions;
 
-       gnutls_certificate_credentials x509_cred;
-       gnutls_dh_params dh_params;
+       gnutls_certificate_credentials_t x509_cred;
+       gnutls_dh_params_t dh_params;
        gnutls_digest_algorithm_t hash;
+       #ifdef GNUTLS_NEW_PRIO_API
+       gnutls_priority_t priority;
+       #endif
 
        std::string sslports;
        int dh_bits;
@@ -174,16 +195,28 @@ class ModuleSSLGnuTLS : public Module
 
        GenericCap capHandler;
        ServiceProvider iohook;
- public:
 
+       inline static const char* UnknownIfNULL(const char* str)
+       {
+               return str ? str : "UNKNOWN";
+       }
+
+ public:
        ModuleSSLGnuTLS()
                : starttls(this), capHandler(this, "tls"), iohook(this, "ssl/gnutls", SERVICE_IOHOOK)
        {
+               gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
+
                sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
 
                gnutls_global_init(); // This must be called once in the program
                gnutls_x509_privkey_init(&x509_key);
 
+               #ifdef GNUTLS_NEW_PRIO_API
+               // Init this here so it's always initialized, avoids an extra boolean
+               gnutls_priority_init(&priority, "NORMAL", NULL);
+               #endif
+
                cred_alloc = false;
                dh_alloc = false;
        }
@@ -202,7 +235,7 @@ class ModuleSSLGnuTLS : public Module
                ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 
                ServerInstance->Modules->AddService(iohook);
-               ServerInstance->AddCommand(&starttls);
+               ServerInstance->Modules->AddService(starttls);
        }
 
        void OnRehash(User* user)
@@ -225,7 +258,7 @@ class ModuleSSLGnuTLS : public Module
                                        continue;
 
                                const std::string& portid = port->bind_desc;
-                               ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
+                               ServerInstance->Logs->Log("m_ssl_gnutls", LOG_DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
 
                                if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
                                {
@@ -258,13 +291,20 @@ class ModuleSSLGnuTLS : public Module
 
                ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
 
-               cafile = Conf->getString("cafile", "conf/ca.pem");
-               crlfile = Conf->getString("crlfile", "conf/crl.pem");
-               certfile = Conf->getString("certfile", "conf/cert.pem");
-               keyfile = Conf->getString("keyfile", "conf/key.pem");
+               cafile = Conf->getString("cafile", CONFIG_PATH "/ca.pem");
+               crlfile = Conf->getString("crlfile", CONFIG_PATH "/crl.pem");
+               certfile = Conf->getString("certfile", CONFIG_PATH "/cert.pem");
+               keyfile = Conf->getString("keyfile", CONFIG_PATH "/key.pem");
                dh_bits = Conf->getInt("dhbits");
                std::string hashname = Conf->getString("hash", "md5");
 
+               // The GnuTLS manual states that the gnutls_set_default_priority()
+               // call we used previously when initializing the session is the same
+               // as setting the "NORMAL" priority string.
+               // Thus if the setting below is not in the config we will behave exactly
+               // the same as before, when the priority setting wasn't available.
+               std::string priorities = Conf->getString("priority", "NORMAL");
+
                if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
                        dh_bits = 1024;
 
@@ -297,31 +337,42 @@ class ModuleSSLGnuTLS : public Module
                ret = gnutls_certificate_allocate_credentials(&x509_cred);
                cred_alloc = (ret >= 0);
                if (!cred_alloc)
-                       ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
 
                if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
-                       ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEBUG, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
 
                if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
-                       ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEBUG, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
 
                FileReader reader;
 
                reader.LoadFile(certfile);
                std::string cert_string = reader.Contents();
-               gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() };
+               gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), static_cast<unsigned int>(cert_string.length()) };
 
                reader.LoadFile(keyfile);
                std::string key_string = reader.Contents();
-               gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() };
+               gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), static_cast<unsigned int>(key_string.length()) };
 
                // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
-               unsigned int certcount = Conf->getInt("certcount", 3);
+               unsigned int certcount = 3;
                x509_certs.resize(certcount);
                ret = gnutls_x509_crt_list_import(&x509_certs[0], &certcount, &cert_datum, GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
-               if (ret < 0)
-                       throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + std::string(gnutls_strerror(ret)));
-               x509_certs.resize(certcount);
+               if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
+               {
+                       // the buffer wasn't big enough to hold all certs but gnutls updated certcount to the number of available certs, try again with a bigger buffer
+                       x509_certs.resize(certcount);
+                       ret = gnutls_x509_crt_list_import(&x509_certs[0], &certcount, &cert_datum, GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
+               }
+
+               if (ret <= 0)
+               {
+                       // clear the vector so we won't call gnutls_x509_crt_deinit() on the (uninited) certs later
+                       x509_certs.clear();
+                       throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + ((ret < 0) ? (std::string(gnutls_strerror(ret))) : "No certs could be read"));
+               }
+               x509_certs.resize(ret);
 
                if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
                        throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
@@ -329,12 +380,36 @@ class ModuleSSLGnuTLS : public Module
                if((ret = gnutls_certificate_set_x509_key(x509_cred, &x509_certs[0], certcount, x509_key)) < 0)
                        throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
 
-               gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
+               #ifdef GNUTLS_NEW_PRIO_API
+               // It's safe to call this every time as we cannot have this uninitialized, see constructor and below.
+               gnutls_priority_deinit(priority);
 
+               // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
+               // If the user did not supply anything then the string is already set to "NORMAL"
+               const char* priocstr = priorities.c_str();
+               const char* prioerror;
+
+               if ((ret = gnutls_priority_init(&priority, priocstr, &prioerror)) < 0)
+               {
+                       // gnutls did not understand the user supplied string, log and fall back to the default priorities
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEFAULT, "m_ssl_gnutls.so: Failed to set priorities to \"%s\": %s Syntax error at position %u, falling back to default (NORMAL)", priorities.c_str(), gnutls_strerror(ret), (unsigned int) (prioerror - priocstr));
+                       gnutls_priority_init(&priority, "NORMAL", NULL);
+               }
+
+               #else
+               if (priorities != "NORMAL")
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEFAULT, "m_ssl_gnutls.so: You've set <gnutls:priority> to a value other than the default, but this is only supported with GnuTLS v2.1.7 or newer. Your GnuTLS version is older than that so the option will have no effect.");
+               #endif
+
+               #if(GNUTLS_VERSION_MAJOR < 2 || ( GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR < 12 ) )
+               gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
+               #else
+               gnutls_certificate_set_retrieve_function (x509_cred, cert_callback);
+               #endif
                ret = gnutls_dh_params_init(&dh_params);
                dh_alloc = (ret >= 0);
                if (!dh_alloc)
-                       ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
 
                // This may be on a large (once a day or week) timer eventually.
                GenerateDHParams();
@@ -353,7 +428,7 @@ class ModuleSSLGnuTLS : public Module
                int ret;
 
                if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
-                       ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
+                       ServerInstance->Logs->Log("m_ssl_gnutls",LOG_DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
        }
 
        ~ModuleSSLGnuTLS()
@@ -362,6 +437,9 @@ class ModuleSSLGnuTLS : public Module
                        gnutls_x509_crt_deinit(x509_certs[i]);
 
                gnutls_x509_privkey_deinit(x509_key);
+               #ifdef GNUTLS_NEW_PRIO_API
+               gnutls_priority_deinit(priority);
+               #endif
 
                if (dh_alloc)
                        gnutls_dh_params_deinit(dh_params);
@@ -393,13 +471,12 @@ class ModuleSSLGnuTLS : public Module
                return Version("Provides SSL support for clients", VF_VENDOR);
        }
 
-
-       void On005Numeric(std::string &output)
+       void On005Numeric(std::map<std::string, std::string>& tokens)
        {
                if (!sslports.empty())
-                       output.append(" SSL=" + sslports);
+                       tokens["SSL"] = sslports;
                if (starttls.enabled)
-                       output.append(" STARTTLS");
+                       tokens["STARTTLS"];
        }
 
        void OnHookIO(StreamSocket* user, ListenSocket* lsb)
@@ -429,7 +506,9 @@ class ModuleSSLGnuTLS : public Module
 
                gnutls_init(&session->sess, me_server ? GNUTLS_SERVER : GNUTLS_CLIENT);
 
-               gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
+               #ifdef GNUTLS_NEW_PRIO_API
+               gnutls_priority_set(session->sess, priority);
+               #endif
                gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
                gnutls_dh_set_prime_bits(session->sess, dh_bits);
                gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
@@ -504,7 +583,7 @@ class ModuleSSLGnuTLS : public Module
                        }
                        else if (ret == 0)
                        {
-                               user->SetError("SSL Connection closed");
+                               user->SetError("Connection closed");
                                CloseSession(session);
                                return -1;
                        }
@@ -599,7 +678,7 @@ class ModuleSSLGnuTLS : public Module
                        }
                        else
                        {
-                               user->SetError(std::string("Handshake Failed - ") + gnutls_strerror(ret));
+                               user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
                                CloseSession(session);
                                session->status = ISSL_CLOSING;
                        }
@@ -626,10 +705,12 @@ class ModuleSSLGnuTLS : public Module
                {
                        if (sessions[user->eh.GetFd()].sess)
                        {
+                               const gnutls_session_t& sess = sessions[user->eh.GetFd()].sess;
+                               std::string cipher = UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)));
+                               cipher.append("-").append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).append("-");
+                               cipher.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
+
                                ssl_cert* cert = sessions[user->eh.GetFd()].cert;
-                               std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->eh.GetFd()].sess));
-                               cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->eh.GetFd()].sess))).append("-");
-                               cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->eh.GetFd()].sess)));
                                if (cert->fingerprint.empty())
                                        user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
                                else