]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_ssl_gnutls.cpp
Attach to events and register services in init()
[user/henk/code/inspircd.git] / src / modules / extra / m_ssl_gnutls.cpp
index cc934ff77288fe76b6b1d739bf36630bec82e61d..a8a35fa78ee45bdcd4fd0abd9b608fb630cb62c7 100644 (file)
 #include "ssl.h"
 #include "m_cap.h"
 
+#ifdef _WIN32
+# pragma comment(lib, "libgnutls.lib")
+# pragma comment(lib, "libgcrypt.lib")
+# pragma comment(lib, "libgpg-error.lib")
+# pragma comment(lib, "user32.lib")
+# pragma comment(lib, "advapi32.lib")
+# pragma comment(lib, "libgcc.lib")
+# pragma comment(lib, "libmingwex.lib")
+# pragma comment(lib, "gdi32.lib")
+#endif
+
 /* $ModDesc: Provides SSL support for clients */
-/* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") */
-/* $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)
+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;
@@ -56,7 +81,7 @@ static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t user_wrap, void* buffe
                errno = EAGAIN;
                return -1;
        }
-       int rv = recv(user->GetFd(), reinterpret_cast<char *>(buffer), size, 0);
+       int rv = ServerInstance->SE->Recv(user, reinterpret_cast<char *>(buffer), size, 0);
        if (rv < (int)size)
                ServerInstance->SE->ChangeEventMask(user, FD_READ_WILL_BLOCK);
        return rv;
@@ -70,7 +95,7 @@ static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t user_wrap, const void*
                errno = EAGAIN;
                return -1;
        }
-       int rv = send(user->GetFd(), reinterpret_cast<const char *>(buffer), size, 0);
+       int rv = ServerInstance->SE->Send(user, reinterpret_cast<const char *>(buffer), size, 0);
        if (rv < (int)size)
                ServerInstance->SE->ChangeEventMask(user, FD_WRITE_WILL_BLOCK);
        return rv;
@@ -148,14 +173,16 @@ 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;
+       gnutls_priority_t priority;
 
        std::string sslports;
        int dh_bits;
 
        bool cred_alloc;
+       bool dh_alloc;
 
        RandGen randhandler;
        CommandStartTLS starttls;
@@ -167,12 +194,17 @@ class ModuleSSLGnuTLS : public Module
        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);
+               // Init this here so it's always initialized, avoids an extra boolean
+               gnutls_priority_init(&priority, "NORMAL", NULL);
 
                cred_alloc = false;
+               dh_alloc = false;
        }
 
        void init()
@@ -201,6 +233,10 @@ class ModuleSSLGnuTLS : public Module
 
                if (Conf->getBool("showports", true))
                {
+                       sslports = Conf->getString("advertisedports");
+                       if (!sslports.empty())
+                               return;
+
                        for (size_t i = 0; i < ServerInstance->ports.size(); i++)
                        {
                                ListenSocket* port = ServerInstance->ports[i];
@@ -211,11 +247,20 @@ class ModuleSSLGnuTLS : public Module
                                ServerInstance->Logs->Log("m_ssl_gnutls", 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")
-                                       sslports.append(portid).append(";");
+                               {
+                                       /*
+                                        * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
+                                        * the IP:port in ISUPPORT.
+                                        *
+                                        * We used to advertise all ports seperated by a ';' char that matched the above criteria,
+                                        * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
+                                        * To solve this by default we now only display the first IP:port found and let the user
+                                        * configure the exact value for the 005 token, if necessary.
+                                        */
+                                       sslports = portid;
+                                       break;
+                               }
                        }
-
-                       if (!sslports.empty())
-                               sslports.erase(sslports.end() - 1);
                }
        }
 
@@ -232,13 +277,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;
 
@@ -252,20 +304,25 @@ class ModuleSSLGnuTLS : public Module
 
                int ret;
 
+               if (dh_alloc)
+               {
+                       gnutls_dh_params_deinit(dh_params);
+                       dh_alloc = false;
+               }
+
                if (cred_alloc)
                {
                        // Deallocate the old credentials
-                       gnutls_dh_params_deinit(dh_params);
                        gnutls_certificate_free_credentials(x509_cred);
 
                        for(unsigned int i=0; i < x509_certs.size(); i++)
                                gnutls_x509_crt_deinit(x509_certs[i]);
                        x509_certs.clear();
                }
-               else
-                       cred_alloc = true;
 
-               if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
+               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));
 
                if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
@@ -278,19 +335,30 @@ class ModuleSSLGnuTLS : public Module
 
                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)));
@@ -298,9 +366,29 @@ 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);
+               // It's safe to call this every time as we cannot have this uninitialized, see constructor and below.
+               gnutls_priority_deinit(priority);
 
-               if((ret = gnutls_dh_params_init(&dh_params)) < 0)
+               // 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",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);
+               }
+
+               #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));
 
                // This may be on a large (once a day or week) timer eventually.
@@ -314,6 +402,9 @@ class ModuleSSLGnuTLS : public Module
                // once a day, once a week or once a month. Depending on the
                // security requirements.
 
+               if (!dh_alloc)
+                       return;
+
                int ret;
 
                if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
@@ -324,13 +415,15 @@ class ModuleSSLGnuTLS : public Module
        {
                for(unsigned int i=0; i < x509_certs.size(); i++)
                        gnutls_x509_crt_deinit(x509_certs[i]);
-               x509_certs.clear();
+
                gnutls_x509_privkey_deinit(x509_key);
-               if (cred_alloc)
-               {
+               gnutls_priority_deinit(priority);
+
+               if (dh_alloc)
                        gnutls_dh_params_deinit(dh_params);
+               if (cred_alloc)
                        gnutls_certificate_free_credentials(x509_cred);
-               }
+
                gnutls_global_deinit();
                delete[] sessions;
                ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
@@ -386,44 +479,39 @@ class ModuleSSLGnuTLS : public Module
                }
        }
 
-       void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
+       void InitSession(StreamSocket* user, bool me_server)
        {
-               int fd = user->GetFd();
-               issl_session* session = &sessions[fd];
-
-               /* For STARTTLS: Don't try and init a session on a socket that already has a session */
-               if (session->sess)
-                       return;
+               issl_session* session = &sessions[user->GetFd()];
 
-               gnutls_init(&session->sess, GNUTLS_SERVER);
+               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.
+               gnutls_priority_set(session->sess, priority);
                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));
                gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
                gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
 
-               gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
+               if (me_server)
+                       gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
 
                Handshake(session, user);
        }
 
-       void OnStreamSocketConnect(StreamSocket* user)
+       void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
        {
                issl_session* session = &sessions[user->GetFd()];
 
-               gnutls_init(&session->sess, GNUTLS_CLIENT);
+               /* For STARTTLS: Don't try and init a session on a socket that already has a session */
+               if (session->sess)
+                       return;
 
-               gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
-               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));
-               gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
-               gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
+               InitSession(user, true);
+       }
 
-               Handshake(session, user);
+       void OnStreamSocketConnect(StreamSocket* user)
+       {
+               InitSession(user, false);
        }
 
        void OnStreamSocketClose(StreamSocket* user)
@@ -472,7 +560,7 @@ class ModuleSSLGnuTLS : public Module
                        }
                        else if (ret == 0)
                        {
-                               user->SetError("SSL Connection closed");
+                               user->SetError("Connection closed");
                                CloseSession(session);
                                return -1;
                        }
@@ -567,7 +655,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;
                        }