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/>.
25 #include "modules/ssl.h"
28 // Fix warnings about the use of commas at end of enumerator lists on C++03.
30 # pragma clang diagnostic ignored "-Wc++11-extensions"
31 #elif defined __GNUC__
33 # pragma GCC diagnostic ignored "-pedantic"
35 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
39 #include <gnutls/gnutls.h>
40 #include <gnutls/x509.h>
42 #ifndef GNUTLS_VERSION_NUMBER
43 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
44 #define GNUTLS_VERSION LIBGNUTLS_VERSION
47 // Check if the GnuTLS library is at least version major.minor.patch
48 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
50 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
51 #define GNUTLS_HAS_MAC_GET_ID
52 #include <gnutls/crypto.h>
55 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
56 # define GNUTLS_HAS_RND
62 # pragma comment(lib, "libgnutls-30.lib")
65 /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") eval("print `libgcrypt-config --cflags | tr -d \r` if `pkg-config --modversion gnutls 2>/dev/null | tr -d \r` lt '2.12'") */
66 /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") eval("print `libgcrypt-config --libs | tr -d \r` if `pkg-config --modversion gnutls 2>/dev/null | tr -d \r` lt '2.12'") */
68 // These don't exist in older GnuTLS versions
69 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
70 #define GNUTLS_NEW_PRIO_API
73 #if (!INSPIRCD_GNUTLS_HAS_VERSION(2, 0, 0))
74 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
75 typedef gnutls_dh_params_t gnutls_dh_params;
78 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
80 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
81 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
82 #define GNUTLS_NEW_CERT_CALLBACK_API
83 typedef gnutls_retr2_st cert_cb_last_param_type;
85 typedef gnutls_retr_st cert_cb_last_param_type;
88 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
89 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
92 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
93 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
94 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
95 typedef unsigned int inspircd_gnutls_session_init_flags_t;
97 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
100 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
101 #define INSPIRCD_GNUTLS_HAS_CORK
104 static Module* thismod;
106 class RandGen : public HandlerBase2<void, char*, size_t>
109 void Call(char* buffer, size_t len)
111 #ifdef GNUTLS_HAS_RND
112 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
114 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
124 Init() { gnutls_global_init(); }
125 ~Init() { gnutls_global_deinit(); }
128 class Exception : public ModuleException
131 Exception(const std::string& reason)
132 : ModuleException(reason) { }
135 void ThrowOnError(int errcode, const char* msg)
139 std::string reason = msg;
140 reason.append(" :").append(gnutls_strerror(errcode));
141 throw Exception(reason);
145 /** Used to create a gnutls_datum_t* from a std::string
149 gnutls_datum_t datum;
152 Datum(const std::string& dat)
154 datum.data = (unsigned char*)dat.data();
155 datum.size = static_cast<unsigned int>(dat.length());
158 const gnutls_datum_t* get() const { return &datum; }
163 gnutls_digest_algorithm_t hash;
166 // Nothing to deallocate, constructor may throw freely
167 Hash(const std::string& hashname)
169 // As older versions of gnutls can't do this, let's disable it where needed.
170 #ifdef GNUTLS_HAS_MAC_GET_ID
171 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
172 // There is no gnutls_dig_get_id() at the moment, but it may come later
173 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
174 if (hash == GNUTLS_DIG_UNKNOWN)
175 throw Exception("Unknown hash type " + hashname);
177 // Check if the user is giving us something that is a valid MAC but not digest
178 gnutls_hash_hd_t is_digest;
179 if (gnutls_hash_init(&is_digest, hash) < 0)
180 throw Exception("Unknown hash type " + hashname);
181 gnutls_hash_deinit(is_digest, NULL);
183 if (hashname == "md5")
184 hash = GNUTLS_DIG_MD5;
185 else if (hashname == "sha1")
186 hash = GNUTLS_DIG_SHA1;
187 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
188 else if (hashname == "sha256")
189 hash = GNUTLS_DIG_SHA256;
192 throw Exception("Unknown hash type " + hashname);
196 gnutls_digest_algorithm_t get() const { return hash; }
201 gnutls_dh_params_t dh_params;
205 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
210 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
212 std::auto_ptr<DHParams> dh(new DHParams);
213 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
214 ThrowOnError(ret, "Unable to import DH params");
220 gnutls_dh_params_deinit(dh_params);
223 const gnutls_dh_params_t& get() const { return dh_params; }
228 /** Ensure that the key is deinited in case the constructor of X509Key throws
233 gnutls_x509_privkey_t key;
237 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
242 gnutls_x509_privkey_deinit(key);
248 X509Key(const std::string& keystr)
250 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
251 ThrowOnError(ret, "Unable to import private key");
254 gnutls_x509_privkey_t& get() { return key.key; }
259 std::vector<gnutls_x509_crt_t> certs;
263 X509CertList(const std::string& certstr)
265 unsigned int certcount = 3;
266 certs.resize(certcount);
267 Datum datum(certstr);
269 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
270 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
272 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
273 // try again with a bigger buffer
274 certs.resize(certcount);
275 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
278 ThrowOnError(ret, "Unable to load certificates");
280 // Resize the vector to the actual number of certs because we rely on its size being correct
281 // when deallocating the certs
282 certs.resize(certcount);
287 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
288 gnutls_x509_crt_deinit(*i);
291 gnutls_x509_crt_t* raw() { return &certs[0]; }
292 unsigned int size() const { return certs.size(); }
295 class X509CRL : public refcountbase
300 gnutls_x509_crl_t crl;
304 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
309 gnutls_x509_crl_deinit(crl);
315 X509CRL(const std::string& crlstr)
317 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
318 ThrowOnError(ret, "Unable to load certificate revocation list");
321 gnutls_x509_crl_t& get() { return crl.crl; }
324 #ifdef GNUTLS_NEW_PRIO_API
327 gnutls_priority_t priority;
330 Priority(const std::string& priorities)
332 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
333 // If the user did not supply anything then the string is already set to "NORMAL"
334 const char* priocstr = priorities.c_str();
335 const char* prioerror;
337 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
340 // gnutls did not understand the user supplied string
341 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
347 gnutls_priority_deinit(priority);
350 void SetupSession(gnutls_session_t sess)
352 gnutls_priority_set(sess, priority);
355 static const char* GetDefault()
357 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
360 static std::string RemoveUnknownTokens(const std::string& prio)
363 irc::sepstream ss(prio, ':');
364 for (std::string token; ss.GetToken(token); )
366 // Save current position so we can revert later if needed
367 const std::string::size_type prevpos = ret.length();
373 gnutls_priority_t test;
374 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
376 // The new token broke the priority string, revert to the previously working one
377 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
383 gnutls_priority_deinit(test);
390 /** Dummy class, used when gnutls_priority_set() is not available
395 Priority(const std::string& priorities)
397 if (priorities != GetDefault())
398 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
401 static void SetupSession(gnutls_session_t sess)
403 // Always set the default priorities
404 gnutls_set_default_priority(sess);
407 static const char* GetDefault()
412 static std::string RemoveUnknownTokens(const std::string& prio)
414 // We don't do anything here because only NORMAL is accepted
420 class CertCredentials
422 /** DH parameters associated with these credentials
424 std::auto_ptr<DHParams> dh;
427 gnutls_certificate_credentials_t cred;
432 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
437 gnutls_certificate_free_credentials(cred);
440 /** Associates these credentials with the session
442 void SetupSession(gnutls_session_t sess)
444 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
447 /** Set the given DH parameters to be used with these credentials
449 void SetDH(std::auto_ptr<DHParams>& DH)
452 gnutls_certificate_set_dh_params(cred, dh->get());
456 class X509Credentials : public CertCredentials
462 /** Certificate list, presented to the peer
466 /** Trusted CA, may be NULL
468 std::auto_ptr<X509CertList> trustedca;
470 /** Certificate revocation list, may be NULL
472 std::auto_ptr<X509CRL> crl;
474 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, cert_cb_last_param_type* st);
477 X509Credentials(const std::string& certstr, const std::string& keystr)
481 // Throwing is ok here, the destructor of Credentials is called in that case
482 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
483 ThrowOnError(ret, "Unable to set cert/key pair");
485 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
486 gnutls_certificate_set_retrieve_function(cred, cert_callback);
488 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
492 /** Sets the trusted CA and the certificate revocation list
493 * to use when verifying certificates
495 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
497 // Do nothing if certlist is NULL
500 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
501 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
505 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
506 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
509 trustedca = certlist;
518 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
519 gnutls_packet_t packet;
522 DataReader(gnutls_session_t sess)
524 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
525 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
526 // to the recvq directly from there in appendto().
527 retval = gnutls_record_recv_packet(sess, &packet);
530 void appendto(std::string& recvq)
532 // Copy data from GnuTLS buffers to recvq
533 gnutls_datum_t datum;
534 gnutls_packet_get(packet, &datum, NULL);
535 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
537 gnutls_packet_deinit(packet);
543 DataReader(gnutls_session_t sess)
544 : buffer(ServerInstance->GetReadBuffer())
546 // Read data from GnuTLS buffers into ReadBuffer
547 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
550 void appendto(std::string& recvq)
552 // Copy data from ReadBuffer to recvq
553 recvq.append(buffer, retval);
557 int ret() const { return retval; }
560 class Profile : public refcountbase
562 /** Name of this profile
564 const std::string name;
566 /** X509 certificate(s) and key
568 X509Credentials x509cred;
570 /** The minimum length in bits for the DH prime to be accepted as a client
572 unsigned int min_dh_bits;
574 /** Hashing algorithm to use when generating certificate fingerprints
578 /** Priorities for ciphers, compression methods, etc.
582 /** Rough max size of records to send
584 const unsigned int outrecsize;
586 /** True to request a client certificate as a server
588 const bool requestclientcert;
590 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
591 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
592 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL,
593 unsigned int recsize, bool Requestclientcert)
595 , x509cred(certstr, keystr)
599 , outrecsize(recsize)
600 , requestclientcert(Requestclientcert)
603 x509cred.SetCA(CA, CRL);
606 static std::string ReadFile(const std::string& filename)
608 FileReader reader(filename);
609 std::string ret = reader.GetString();
611 throw Exception("Cannot read file " + filename);
615 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
617 // Use default priority string if this tag does not specify one
618 std::string priostr = GnuTLS::Priority::GetDefault();
619 bool found = tag->readString("priority", priostr);
620 // If the prio string isn't set in the config don't be strict about the default one because it doesn't work on all versions of GnuTLS
621 if (!tag->getBool("strictpriority", found))
623 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
624 if (stripped.empty())
626 // Stripping failed, act as if a prio string wasn't set
627 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
628 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens and stripping it didn't yield a working one either, falling back to \"%s\"", profilename.c_str(), stripped.c_str());
630 else if ((found) && (stripped != priostr))
632 // Prio string was set in the config and we ended up with something that works but different
633 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
635 priostr.swap(stripped);
641 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
643 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
644 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
646 std::auto_ptr<DHParams> dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
648 std::string priostr = GetPrioStr(profilename, tag);
649 unsigned int mindh = tag->getInt("mindhbits", 1024);
650 std::string hashstr = tag->getString("hash", "md5");
652 // Load trusted CA and revocation list, if set
653 std::auto_ptr<X509CertList> ca;
654 std::auto_ptr<X509CRL> crl;
655 std::string filename = tag->getString("cafile");
656 if (!filename.empty())
658 ca.reset(new X509CertList(ReadFile(filename)));
660 filename = tag->getString("crlfile");
661 if (!filename.empty())
662 crl.reset(new X509CRL(ReadFile(filename)));
665 #ifdef INSPIRCD_GNUTLS_HAS_CORK
666 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
667 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512);
669 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
672 const bool requestclientcert = tag->getBool("requestclientcert", true);
674 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl, outrecsize, requestclientcert);
677 /** Set up the given session with the settings in this profile
679 void SetupSession(gnutls_session_t sess)
681 priority.SetupSession(sess);
682 x509cred.SetupSession(sess);
683 gnutls_dh_set_prime_bits(sess, min_dh_bits);
685 // Request client certificate if enabled and we are a server, no-op if we're a client
686 if (requestclientcert)
687 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
690 const std::string& GetName() const { return name; }
691 X509Credentials& GetX509Credentials() { return x509cred; }
692 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
693 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
697 class GnuTLSIOHook : public SSLIOHook
700 gnutls_session_t sess;
702 reference<GnuTLS::Profile> profile;
703 #ifdef INSPIRCD_GNUTLS_HAS_CORK
711 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
712 gnutls_deinit(this->sess);
719 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
720 int Handshake(StreamSocket* user)
722 int ret = gnutls_handshake(this->sess);
726 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
728 // Handshake needs resuming later, read() or write() would have blocked.
729 this->status = ISSL_HANDSHAKING;
731 if (gnutls_record_get_direction(this->sess) == 0)
733 // gnutls_handshake() wants to read() again.
734 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
738 // gnutls_handshake() wants to write() again.
739 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
746 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
753 // Change the seesion state
754 this->status = ISSL_HANDSHAKEN;
758 // Finish writing, if any left
759 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
765 void VerifyCertificate()
767 unsigned int certstatus;
768 const gnutls_datum_t* cert_list;
770 unsigned int cert_list_size;
771 gnutls_x509_crt_t cert;
773 unsigned char digest[512];
774 size_t digest_size = sizeof(digest);
775 size_t name_size = sizeof(str);
776 ssl_cert* certinfo = new ssl_cert;
777 this->certificate = certinfo;
779 /* This verification function uses the trusted CAs in the credentials
780 * structure. So you must have installed one or more CA certificates.
782 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
786 certinfo->error = std::string(gnutls_strerror(ret));
790 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
791 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
792 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
793 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
795 /* Up to here the process is the same for X.509 certificates and
796 * OpenPGP keys. From now on X.509 certificates are assumed. This can
797 * be easily extended to work with openpgp keys as well.
799 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
801 certinfo->error = "No X509 keys sent";
805 ret = gnutls_x509_crt_init(&cert);
808 certinfo->error = gnutls_strerror(ret);
813 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
814 if (cert_list == NULL)
816 certinfo->error = "No certificate was found";
817 goto info_done_dealloc;
820 /* This is not a real world example, since we only check the first
821 * certificate in the given chain.
824 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
827 certinfo->error = gnutls_strerror(ret);
828 goto info_done_dealloc;
831 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
833 std::string& dn = certinfo->dn;
835 // Make sure there are no chars in the string that we consider invalid
836 if (dn.find_first_of("\r\n") != std::string::npos)
840 name_size = sizeof(str);
841 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
843 std::string& issuer = certinfo->issuer;
845 if (issuer.find_first_of("\r\n") != std::string::npos)
849 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
851 certinfo->error = gnutls_strerror(ret);
855 certinfo->fingerprint = BinToHex(digest, digest_size);
858 /* Beware here we do not check for errors.
860 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
862 certinfo->error = "Not activated, or expired certificate";
866 gnutls_x509_crt_deinit(cert);
869 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
870 int PrepareIO(StreamSocket* sock)
872 if (status == ISSL_HANDSHAKEN)
874 else if (status == ISSL_HANDSHAKING)
876 // The handshake isn't finished, try to finish it
877 return Handshake(sock);
881 sock->SetError("No SSL session");
885 #ifdef INSPIRCD_GNUTLS_HAS_CORK
886 int FlushBuffer(StreamSocket* sock)
888 // If GnuTLS has some data buffered, write it
890 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
895 int HandleWriteRet(StreamSocket* sock, int ret)
899 #ifdef INSPIRCD_GNUTLS_HAS_CORK
903 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
909 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
911 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
916 sock->SetError(gnutls_strerror(ret));
922 static const char* UnknownIfNULL(const char* str)
924 return str ? str : "UNKNOWN";
927 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
929 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
931 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
934 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
937 gnutls_transport_set_errno(session->sess, EAGAIN);
944 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
949 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
950 * and then set errno appropriately.
951 * The gnutls library may also have a different errno variable than us, see
952 * gnutls_transport_set_errno(3).
954 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
959 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
963 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
964 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
966 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
968 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
971 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
974 gnutls_transport_set_errno(session->sess, EAGAIN);
981 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
982 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
984 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
986 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
990 for (int i = 0; i < iovcnt; i++)
991 size += iov[i].iov_len;
994 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
998 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
999 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1001 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1003 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1006 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1009 gnutls_transport_set_errno(session->sess, EAGAIN);
1016 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1021 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1022 * and then set errno appropriately.
1023 * The gnutls library may also have a different errno variable than us, see
1024 * gnutls_transport_set_errno(3).
1026 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1031 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1034 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1037 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags, const reference<GnuTLS::Profile>& sslprofile)
1038 : SSLIOHook(hookprov)
1041 , profile(sslprofile)
1042 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1046 gnutls_init(&sess, flags);
1047 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1048 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1049 gnutls_transport_set_vec_push_function(sess, VectorPush);
1051 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1053 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1054 profile->SetupSession(sess);
1056 sock->AddIOHook(this);
1060 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1065 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1067 // Finish handshake if needed
1068 int prepret = PrepareIO(user);
1072 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1074 GnuTLS::DataReader reader(sess);
1075 int ret = reader.ret();
1078 reader.appendto(recvq);
1079 // Schedule a read if there is still data in the GnuTLS buffer
1080 if (gnutls_record_check_pending(sess) > 0)
1081 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1084 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1090 user->SetError("Connection closed");
1096 user->SetError(gnutls_strerror(ret));
1103 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1105 // Finish handshake if needed
1106 int prepret = PrepareIO(user);
1110 // Session is ready for transferring application data
1112 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1115 // If there is something in the GnuTLS buffer try to send() it
1116 int ret = FlushBuffer(user);
1118 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1120 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1124 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1125 gnutls_record_cork(this->sess);
1126 while ((!sendq.empty()) && (gbuffersize < profile->GetOutgoingRecordSize()))
1128 const StreamSocket::SendQueue::Element& elem = sendq.front();
1129 gbuffersize += elem.length();
1130 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1142 while (!sendq.empty())
1144 FlattenSendQueue(sendq, profile->GetOutgoingRecordSize());
1145 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1146 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1150 else if (ret < (int)buffer.length())
1152 sendq.erase_front(ret);
1153 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1157 // Wrote entire record, continue sending
1162 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1166 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1168 if (!IsHandshakeDone())
1170 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1171 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1172 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1173 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1176 GnuTLS::Profile* GetProfile() { return profile; }
1177 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1180 int GnuTLS::X509Credentials::cert_callback(gnutls_session_t sess, const gnutls_datum_t* req_ca_rdn, int nreqs, const gnutls_pk_algorithm_t* sign_algos, int sign_algos_length, cert_cb_last_param_type* st)
1182 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1183 st->type = GNUTLS_CRT_X509;
1185 st->cert_type = GNUTLS_CRT_X509;
1186 st->key_type = GNUTLS_PRIVKEY_X509;
1188 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1189 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile()->GetX509Credentials();
1191 st->ncerts = cred.certs.size();
1192 st->cert.x509 = cred.certs.raw();
1193 st->key.x509 = cred.key.get();
1199 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1201 reference<GnuTLS::Profile> profile;
1204 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1205 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1208 ServerInstance->Modules->AddService(*this);
1211 ~GnuTLSIOHookProvider()
1213 ServerInstance->Modules->DelService(*this);
1216 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1218 new GnuTLSIOHook(this, sock, GNUTLS_SERVER, profile);
1221 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1223 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT, profile);
1227 class ModuleSSLGnuTLS : public Module
1229 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1231 // First member of the class, gets constructed first and destructed last
1232 GnuTLS::Init libinit;
1233 RandGen randhandler;
1234 ProfileList profiles;
1238 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1239 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1240 // avoiding unpleasant situations where no new SSL connections are possible.
1241 ProfileList newprofiles;
1243 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1244 if (tags.first == tags.second)
1246 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1247 const std::string defname = "gnutls";
1248 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1249 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1253 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1254 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1256 catch (CoreException& ex)
1258 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1262 for (ConfigIter i = tags.first; i != tags.second; ++i)
1264 ConfigTag* tag = i->second;
1265 if (tag->getString("provider") != "gnutls")
1268 std::string name = tag->getString("name");
1271 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1275 reference<GnuTLS::Profile> profile;
1278 profile = GnuTLS::Profile::Create(name, tag);
1280 catch (CoreException& ex)
1282 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1285 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1288 // New profiles are ok, begin using them
1289 // Old profiles are deleted when their refcount drops to zero
1290 profiles.swap(newprofiles);
1296 #ifndef GNUTLS_HAS_RND
1297 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1302 void init() CXX11_OVERRIDE
1304 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1306 ServerInstance->GenRandom = &randhandler;
1309 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1318 catch (ModuleException& ex)
1320 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1326 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1329 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1331 if(target_type == TYPE_USER)
1333 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1335 if ((user) && (user->eh.GetModHook(this)))
1337 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1338 // Potentially there could be multiple SSL modules loaded at once on different ports.
1339 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1344 Version GetVersion() CXX11_OVERRIDE
1346 return Version("Provides SSL support for clients", VF_VENDOR);
1349 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1351 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1352 if ((iohook) && (!iohook->IsHandshakeDone()))
1353 return MOD_RES_DENY;
1354 return MOD_RES_PASSTHRU;
1358 MODULE_INIT(ModuleSSLGnuTLS)