2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 John Brooks <john.brooks@dereferenced.net>
6 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include <gnutls/gnutls.h>
27 #include <gnutls/x509.h>
28 #include "modules/ssl.h"
29 #include "modules/cap.h"
31 #if ((GNUTLS_VERSION_MAJOR > 2) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR > 9) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR == 9 && GNUTLS_VERSION_PATCH >= 8))
32 #define GNUTLS_HAS_MAC_GET_ID
33 #include <gnutls/crypto.h>
37 # pragma comment(lib, "libgnutls.lib")
38 # pragma comment(lib, "libgcrypt.lib")
39 # pragma comment(lib, "libgpg-error.lib")
40 # pragma comment(lib, "user32.lib")
41 # pragma comment(lib, "advapi32.lib")
42 # pragma comment(lib, "libgcc.lib")
43 # pragma comment(lib, "libmingwex.lib")
44 # pragma comment(lib, "gdi32.lib")
47 /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") exec("libgcrypt-config --cflags") -Wno-pedantic */
48 /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") exec("libgcrypt-config --libs") */
50 #ifndef GNUTLS_VERSION_MAJOR
51 #define GNUTLS_VERSION_MAJOR LIBGNUTLS_VERSION_MAJOR
52 #define GNUTLS_VERSION_MINOR LIBGNUTLS_VERSION_MINOR
53 #define GNUTLS_VERSION_PATCH LIBGNUTLS_VERSION_PATCH
56 // These don't exist in older GnuTLS versions
57 #if ((GNUTLS_VERSION_MAJOR > 2) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR > 1) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR == 1 && GNUTLS_VERSION_PATCH >= 7))
58 #define GNUTLS_NEW_PRIO_API
61 #if(GNUTLS_VERSION_MAJOR < 2)
62 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
63 typedef gnutls_dh_params_t gnutls_dh_params;
66 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
68 static std::vector<gnutls_x509_crt_t> x509_certs;
69 static gnutls_x509_privkey_t x509_key;
70 #if(GNUTLS_VERSION_MAJOR < 2 || ( GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR < 12 ) )
71 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
72 const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) {
74 st->type = GNUTLS_CRT_X509;
76 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
77 const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr2_st * st) {
78 st->cert_type = GNUTLS_CRT_X509;
79 st->key_type = GNUTLS_PRIVKEY_X509;
81 st->ncerts = x509_certs.size();
82 st->cert.x509 = &x509_certs[0];
83 st->key.x509 = x509_key;
89 class RandGen : public HandlerBase2<void, char*, size_t>
93 void Call(char* buffer, size_t len)
95 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
99 /** Represents an SSL user's extra data
104 StreamSocket* socket;
105 gnutls_session_t sess;
107 reference<ssl_cert> cert;
109 issl_session() : socket(NULL), sess(NULL) {}
112 class GnuTLSIOHook : public SSLIOHook
115 void InitSession(StreamSocket* user, bool me_server)
117 issl_session* session = &sessions[user->GetFd()];
119 gnutls_init(&session->sess, me_server ? GNUTLS_SERVER : GNUTLS_CLIENT);
120 session->socket = user;
122 #ifdef GNUTLS_NEW_PRIO_API
123 gnutls_priority_set(session->sess, priority);
125 gnutls_set_default_priority(session->sess);
127 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
128 gnutls_dh_set_prime_bits(session->sess, dh_bits);
129 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(session));
130 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
131 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
134 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
136 Handshake(session, user);
139 void CloseSession(issl_session* session)
143 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
144 gnutls_deinit(session->sess);
146 session->socket = NULL;
147 session->sess = NULL;
148 session->cert = NULL;
149 session->status = ISSL_NONE;
152 bool Handshake(issl_session* session, StreamSocket* user)
154 int ret = gnutls_handshake(session->sess);
158 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
160 // Handshake needs resuming later, read() or write() would have blocked.
162 if(gnutls_record_get_direction(session->sess) == 0)
164 // gnutls_handshake() wants to read() again.
165 session->status = ISSL_HANDSHAKING_READ;
166 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
170 // gnutls_handshake() wants to write() again.
171 session->status = ISSL_HANDSHAKING_WRITE;
172 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
177 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
178 CloseSession(session);
179 session->status = ISSL_CLOSING;
186 // Change the seesion state
187 session->status = ISSL_HANDSHAKEN;
189 VerifyCertificate(session,user);
191 // Finish writing, if any left
192 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
198 void VerifyCertificate(issl_session* session, StreamSocket* user)
200 if (!session->sess || !user)
204 const gnutls_datum_t* cert_list;
206 unsigned int cert_list_size;
207 gnutls_x509_crt_t cert;
209 unsigned char digest[512];
210 size_t digest_size = sizeof(digest);
211 size_t name_size = sizeof(str);
212 ssl_cert* certinfo = new ssl_cert;
213 session->cert = certinfo;
215 /* This verification function uses the trusted CAs in the credentials
216 * structure. So you must have installed one or more CA certificates.
218 ret = gnutls_certificate_verify_peers2(session->sess, &status);
222 certinfo->error = std::string(gnutls_strerror(ret));
226 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
227 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
228 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
229 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
231 /* Up to here the process is the same for X.509 certificates and
232 * OpenPGP keys. From now on X.509 certificates are assumed. This can
233 * be easily extended to work with openpgp keys as well.
235 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
237 certinfo->error = "No X509 keys sent";
241 ret = gnutls_x509_crt_init(&cert);
244 certinfo->error = gnutls_strerror(ret);
249 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
250 if (cert_list == NULL)
252 certinfo->error = "No certificate was found";
253 goto info_done_dealloc;
256 /* This is not a real world example, since we only check the first
257 * certificate in the given chain.
260 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
263 certinfo->error = gnutls_strerror(ret);
264 goto info_done_dealloc;
267 gnutls_x509_crt_get_dn(cert, str, &name_size);
270 gnutls_x509_crt_get_issuer_dn(cert, str, &name_size);
271 certinfo->issuer = str;
273 if ((ret = gnutls_x509_crt_get_fingerprint(cert, hash, digest, &digest_size)) < 0)
275 certinfo->error = gnutls_strerror(ret);
279 certinfo->fingerprint = BinToHex(digest, digest_size);
282 /* Beware here we do not check for errors.
284 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
286 certinfo->error = "Not activated, or expired certificate";
290 gnutls_x509_crt_deinit(cert);
293 static const char* UnknownIfNULL(const char* str)
295 return str ? str : "UNKNOWN";
298 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
300 issl_session* session = reinterpret_cast<issl_session*>(session_wrap);
301 if (session->socket->GetEventMask() & FD_READ_WILL_BLOCK)
304 gnutls_transport_set_errno(session->sess, EAGAIN);
311 int rv = ServerInstance->SE->Recv(session->socket, reinterpret_cast<char *>(buffer), size, 0);
316 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
317 * and then set errno appropriately.
318 * The gnutls library may also have a different errno variable than us, see
319 * gnutls_transport_set_errno(3).
321 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
326 ServerInstance->SE->ChangeEventMask(session->socket, FD_READ_WILL_BLOCK);
330 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
332 issl_session* session = reinterpret_cast<issl_session*>(session_wrap);
333 if (session->socket->GetEventMask() & FD_WRITE_WILL_BLOCK)
336 gnutls_transport_set_errno(session->sess, EAGAIN);
343 int rv = ServerInstance->SE->Send(session->socket, reinterpret_cast<const char *>(buffer), size, 0);
348 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
349 * and then set errno appropriately.
350 * The gnutls library may also have a different errno variable than us, see
351 * gnutls_transport_set_errno(3).
353 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
358 ServerInstance->SE->ChangeEventMask(session->socket, FD_WRITE_WILL_BLOCK);
363 issl_session* sessions;
364 gnutls_certificate_credentials_t x509_cred;
366 gnutls_digest_algorithm_t hash;
367 #ifdef GNUTLS_NEW_PRIO_API
368 gnutls_priority_t priority;
372 GnuTLSIOHook(Module* parent)
373 : SSLIOHook(parent, "ssl/gnutls")
375 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
383 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
385 issl_session* session = &sessions[user->GetFd()];
387 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
391 InitSession(user, true);
394 void OnStreamSocketConnect(StreamSocket* user) CXX11_OVERRIDE
396 InitSession(user, false);
399 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
401 CloseSession(&sessions[user->GetFd()]);
404 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
406 issl_session* session = &sessions[user->GetFd()];
410 CloseSession(session);
411 user->SetError("No SSL session");
415 if (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE)
417 // The handshake isn't finished, try to finish it.
419 if(!Handshake(session, user))
421 if (session->status != ISSL_CLOSING)
427 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
429 if (session->status == ISSL_HANDSHAKEN)
431 char* buffer = ServerInstance->GetReadBuffer();
432 size_t bufsiz = ServerInstance->Config->NetBufferSize;
433 int ret = gnutls_record_recv(session->sess, buffer, bufsiz);
436 recvq.append(buffer, ret);
439 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
445 user->SetError("Connection closed");
446 CloseSession(session);
451 user->SetError(gnutls_strerror(ret));
452 CloseSession(session);
456 else if (session->status == ISSL_CLOSING)
462 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq) CXX11_OVERRIDE
464 issl_session* session = &sessions[user->GetFd()];
468 CloseSession(session);
469 user->SetError("No SSL session");
473 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
475 // The handshake isn't finished, try to finish it.
476 Handshake(session, user);
477 if (session->status != ISSL_CLOSING)
484 if (session->status == ISSL_HANDSHAKEN)
486 ret = gnutls_record_send(session->sess, sendq.data(), sendq.length());
488 if (ret == (int)sendq.length())
490 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE);
495 sendq = sendq.substr(ret);
496 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
499 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
501 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
506 user->SetError(gnutls_strerror(ret));
507 CloseSession(session);
515 ssl_cert* GetCertificate(StreamSocket* sock) CXX11_OVERRIDE
517 int fd = sock->GetFd();
518 issl_session* session = &sessions[fd];
519 return session->cert;
522 void TellCiphersAndFingerprint(LocalUser* user)
524 const gnutls_session_t& sess = sessions[user->eh.GetFd()].sess;
527 std::string text = "*** You are connected using SSL cipher '";
529 text += UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)));
530 text.append("-").append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).append("-");
531 text.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess)))).append("'");
533 ssl_cert* cert = sessions[user->eh.GetFd()].cert;
534 if (!cert->fingerprint.empty())
535 text += " and your SSL fingerprint is " + cert->fingerprint;
537 user->WriteNotice(text);
542 class CommandStartTLS : public SplitCommand
548 CommandStartTLS(Module* mod, IOHook& Hook)
549 : SplitCommand(mod, "STARTTLS")
553 works_before_reg = true;
556 CmdResult HandleLocal(const std::vector<std::string> ¶meters, LocalUser *user)
560 user->WriteNumeric(691, "%s :STARTTLS is not enabled", user->nick.c_str());
564 if (user->registered == REG_ALL)
566 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration is complete", user->nick.c_str());
570 if (!user->eh.GetIOHook())
572 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
573 /* We need to flush the write buffer prior to adding the IOHook,
574 * otherwise we'll be sending this line inside the SSL session - which
575 * won't start its handshake until the client gets this line. Currently,
576 * we assume the write will not block here; this is usually safe, as
577 * STARTTLS is sent very early on in the registration phase, where the
578 * user hasn't built up much sendq. Handling a blocked write here would
582 user->eh.AddIOHook(&hook);
583 hook.OnStreamSocketAccept(&user->eh, NULL, NULL);
586 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
593 class ModuleSSLGnuTLS : public Module
597 gnutls_dh_params_t dh_params;
599 std::string sslports;
605 CommandStartTLS starttls;
607 GenericCap capHandler;
611 : iohook(this), starttls(this, iohook), capHandler(this, "tls")
613 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
615 gnutls_global_init(); // This must be called once in the program
616 gnutls_x509_privkey_init(&x509_key);
618 #ifdef GNUTLS_NEW_PRIO_API
619 // Init this here so it's always initialized, avoids an extra boolean
620 gnutls_priority_init(&iohook.priority, "NORMAL", NULL);
627 void init() CXX11_OVERRIDE
629 // Needs the flag as it ignores a plain /rehash
630 OnModuleRehash(NULL,"ssl");
632 ServerInstance->GenRandom = &randhandler;
634 // Void return, guess we assume success
635 gnutls_certificate_set_dh_params(iohook.x509_cred, dh_params);
637 ServerInstance->Modules->AddService(iohook);
638 ServerInstance->Modules->AddService(starttls);
641 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
645 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
646 starttls.enabled = Conf->getBool("starttls", true);
648 if (Conf->getBool("showports", true))
650 sslports = Conf->getString("advertisedports");
651 if (!sslports.empty())
654 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
656 ListenSocket* port = ServerInstance->ports[i];
657 if (port->bind_tag->getString("ssl") != "gnutls")
660 const std::string& portid = port->bind_desc;
661 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Enabling SSL for port %s", portid.c_str());
663 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
666 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
667 * the IP:port in ISUPPORT.
669 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
670 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
671 * To solve this by default we now only display the first IP:port found and let the user
672 * configure the exact value for the 005 token, if necessary.
681 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
687 std::string certfile;
691 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
693 cafile = ServerInstance->Config->Paths.PrependConfig(Conf->getString("cafile", "ca.pem"));
694 crlfile = ServerInstance->Config->Paths.PrependConfig(Conf->getString("crlfile", "crl.pem"));
695 certfile = ServerInstance->Config->Paths.PrependConfig(Conf->getString("certfile", "cert.pem"));
696 keyfile = ServerInstance->Config->Paths.PrependConfig(Conf->getString("keyfile", "key.pem"));
697 int dh_bits = Conf->getInt("dhbits");
698 std::string hashname = Conf->getString("hash", "md5");
700 // The GnuTLS manual states that the gnutls_set_default_priority()
701 // call we used previously when initializing the session is the same
702 // as setting the "NORMAL" priority string.
703 // Thus if the setting below is not in the config we will behave exactly
704 // the same as before, when the priority setting wasn't available.
705 std::string priorities = Conf->getString("priority", "NORMAL");
707 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
710 iohook.dh_bits = dh_bits;
712 // As older versions of gnutls can't do this, let's disable it where needed.
713 #ifdef GNUTLS_HAS_MAC_GET_ID
714 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
715 // There is no gnutls_dig_get_id() at the moment, but it may come later
716 iohook.hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
717 if (iohook.hash == GNUTLS_DIG_UNKNOWN)
718 throw ModuleException("Unknown hash type " + hashname);
720 // Check if the user is walking around with their head in the ass,
721 // giving us something that is a valid MAC but not digest
722 gnutls_hash_hd_t is_digest;
723 if (gnutls_hash_init(&is_digest, iohook.hash) < 0)
724 throw ModuleException("Unknown hash type " + hashname);
725 gnutls_hash_deinit(is_digest, NULL);
727 if (hashname == "md5")
728 iohook.hash = GNUTLS_DIG_MD5;
729 else if (hashname == "sha1")
730 iohook.hash = GNUTLS_DIG_SHA1;
732 throw ModuleException("Unknown hash type " + hashname);
739 gnutls_dh_params_deinit(dh_params);
746 // Deallocate the old credentials
747 gnutls_certificate_free_credentials(iohook.x509_cred);
749 for(unsigned int i=0; i < x509_certs.size(); i++)
750 gnutls_x509_crt_deinit(x509_certs[i]);
754 ret = gnutls_certificate_allocate_credentials(&iohook.x509_cred);
755 cred_alloc = (ret >= 0);
757 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
759 if((ret =gnutls_certificate_set_x509_trust_file(iohook.x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
760 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
762 if((ret = gnutls_certificate_set_x509_crl_file (iohook.x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
763 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
767 reader.Load(certfile);
768 std::string cert_string = reader.GetString();
769 gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), static_cast<unsigned int>(cert_string.length()) };
771 reader.Load(keyfile);
772 std::string key_string = reader.GetString();
773 gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), static_cast<unsigned int>(key_string.length()) };
775 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
776 unsigned int certcount = 3;
777 x509_certs.resize(certcount);
778 ret = gnutls_x509_crt_list_import(&x509_certs[0], &certcount, &cert_datum, GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
779 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
781 // 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
782 x509_certs.resize(certcount);
783 ret = gnutls_x509_crt_list_import(&x509_certs[0], &certcount, &cert_datum, GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
788 // clear the vector so we won't call gnutls_x509_crt_deinit() on the (uninited) certs later
790 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + ((ret < 0) ? (std::string(gnutls_strerror(ret))) : "No certs could be read"));
792 x509_certs.resize(ret);
794 if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
795 throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
797 if((ret = gnutls_certificate_set_x509_key(iohook.x509_cred, &x509_certs[0], certcount, x509_key)) < 0)
798 throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
800 #ifdef GNUTLS_NEW_PRIO_API
801 // It's safe to call this every time as we cannot have this uninitialized, see constructor and below.
802 gnutls_priority_deinit(iohook.priority);
804 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
805 // If the user did not supply anything then the string is already set to "NORMAL"
806 const char* priocstr = priorities.c_str();
807 const char* prioerror;
809 if ((ret = gnutls_priority_init(&iohook.priority, priocstr, &prioerror)) < 0)
811 // gnutls did not understand the user supplied string, log and fall back to the default priorities
812 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "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));
813 gnutls_priority_init(&iohook.priority, "NORMAL", NULL);
817 if (priorities != "NORMAL")
818 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "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.");
821 #if(GNUTLS_VERSION_MAJOR < 2 || ( GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR < 12 ) )
822 gnutls_certificate_client_set_retrieve_function (iohook.x509_cred, cert_callback);
824 gnutls_certificate_set_retrieve_function (iohook.x509_cred, cert_callback);
826 ret = gnutls_dh_params_init(&dh_params);
827 dh_alloc = (ret >= 0);
830 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Failed to initialise DH parameters: %s", gnutls_strerror(ret));
834 std::string dhfile = Conf->getString("dhfile");
837 // Try to load DH params from file
839 std::string dhstring = reader.GetString();
840 gnutls_datum_t dh_datum = { (unsigned char*)dhstring.data(), static_cast<unsigned int>(dhstring.length()) };
842 if ((ret = gnutls_dh_params_import_pkcs3(dh_params, &dh_datum, GNUTLS_X509_FMT_PEM)) < 0)
844 // File unreadable or GnuTLS was unhappy with the contents, generate the DH primes now
845 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Generating DH parameters because I failed to load them from file '%s': %s", dhfile.c_str(), gnutls_strerror(ret));
855 void GenerateDHParams()
857 // Generate Diffie Hellman parameters - for use with DHE
858 // kx algorithms. These should be discarded and regenerated
859 // once a day, once a week or once a month. Depending on the
860 // security requirements.
867 if((ret = gnutls_dh_params_generate2(dh_params, iohook.dh_bits)) < 0)
868 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Failed to generate DH parameters (%d bits): %s", iohook.dh_bits, gnutls_strerror(ret));
873 for(unsigned int i=0; i < x509_certs.size(); i++)
874 gnutls_x509_crt_deinit(x509_certs[i]);
876 gnutls_x509_privkey_deinit(x509_key);
877 #ifdef GNUTLS_NEW_PRIO_API
878 gnutls_priority_deinit(iohook.priority);
882 gnutls_dh_params_deinit(dh_params);
884 gnutls_certificate_free_credentials(iohook.x509_cred);
886 gnutls_global_deinit();
887 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
890 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
892 if(target_type == TYPE_USER)
894 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
896 if (user && user->eh.GetIOHook() == &iohook)
898 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
899 // Potentially there could be multiple SSL modules loaded at once on different ports.
900 ServerInstance->Users->QuitUser(user, "SSL module unloading");
905 Version GetVersion() CXX11_OVERRIDE
907 return Version("Provides SSL support for clients", VF_VENDOR);
910 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
912 if (!sslports.empty())
913 tokens["SSL"] = sslports;
914 if (starttls.enabled)
918 void OnHookIO(StreamSocket* user, ListenSocket* lsb) CXX11_OVERRIDE
920 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "gnutls")
922 /* Hook the user with our module */
923 user->AddIOHook(&iohook);
927 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
929 if (user->eh.GetIOHook() == &iohook)
930 iohook.TellCiphersAndFingerprint(user);
933 void OnEvent(Event& ev) CXX11_OVERRIDE
935 if (starttls.enabled)
936 capHandler.HandleEvent(ev);
940 MODULE_INIT(ModuleSSLGnuTLS)