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/>.
23 /// $CompilerFlags: find_compiler_flags("gnutls")
24 /// $CompilerFlags: require_version("gnutls" "1.0" "2.12") execute("libgcrypt-config --cflags" "LIBGCRYPT_CXXFLAGS")
26 /// $LinkerFlags: find_linker_flags("gnutls" "-lgnutls")
27 /// $LinkerFlags: require_version("gnutls" "1.0" "2.12") execute("libgcrypt-config --libs" "LIBGCRYPT_LDFLAGS")
29 /// $PackageInfo: require_system("centos") gnutls-devel pkgconfig
30 /// $PackageInfo: require_system("darwin") gnutls pkg-config
31 /// $PackageInfo: require_system("debian" "1.0" "7.99") libgcrypt11-dev
32 /// $PackageInfo: require_system("debian") gnutls-bin libgnutls28-dev pkg-config
33 /// $PackageInfo: require_system("ubuntu" "1.0" "13.10") libgcrypt11-dev
34 /// $PackageInfo: require_system("ubuntu") gnutls-bin libgnutls-dev pkg-config
37 #include "modules/ssl.h"
40 // Fix warnings about the use of commas at end of enumerator lists on C++03.
42 # pragma clang diagnostic ignored "-Wc++11-extensions"
43 #elif defined __GNUC__
44 # if (__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8))
45 # pragma GCC diagnostic ignored "-Wpedantic"
47 # pragma GCC diagnostic ignored "-pedantic"
51 // Fix warnings about using std::auto_ptr on C++11 or newer.
52 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
54 #include <gnutls/gnutls.h>
55 #include <gnutls/x509.h>
57 #ifndef GNUTLS_VERSION_NUMBER
58 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
59 #define GNUTLS_VERSION LIBGNUTLS_VERSION
62 // Check if the GnuTLS library is at least version major.minor.patch
63 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
65 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
66 #define GNUTLS_HAS_MAC_GET_ID
67 #include <gnutls/crypto.h>
70 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
71 # define GNUTLS_HAS_RND
77 # pragma comment(lib, "libgnutls-30.lib")
80 // These don't exist in older GnuTLS versions
81 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
82 #define GNUTLS_NEW_PRIO_API
85 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
87 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
88 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
89 #define GNUTLS_NEW_CERT_CALLBACK_API
90 typedef gnutls_retr2_st cert_cb_last_param_type;
92 typedef gnutls_retr_st cert_cb_last_param_type;
95 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
96 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
99 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
100 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
101 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
102 typedef unsigned int inspircd_gnutls_session_init_flags_t;
104 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
107 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
108 #define INSPIRCD_GNUTLS_HAS_CORK
111 static Module* thismod;
116 static void Call(char* buffer, size_t len)
118 #ifdef GNUTLS_HAS_RND
119 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
121 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
131 Init() { gnutls_global_init(); }
132 ~Init() { gnutls_global_deinit(); }
135 class Exception : public ModuleException
138 Exception(const std::string& reason)
139 : ModuleException(reason) { }
142 void ThrowOnError(int errcode, const char* msg)
146 std::string reason = msg;
147 reason.append(" :").append(gnutls_strerror(errcode));
148 throw Exception(reason);
152 /** Used to create a gnutls_datum_t* from a std::string
156 gnutls_datum_t datum;
159 Datum(const std::string& dat)
161 datum.data = (unsigned char*)dat.data();
162 datum.size = static_cast<unsigned int>(dat.length());
165 const gnutls_datum_t* get() const { return &datum; }
170 gnutls_digest_algorithm_t hash;
173 // Nothing to deallocate, constructor may throw freely
174 Hash(const std::string& hashname)
176 // As older versions of gnutls can't do this, let's disable it where needed.
177 #ifdef GNUTLS_HAS_MAC_GET_ID
178 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
179 // There is no gnutls_dig_get_id() at the moment, but it may come later
180 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
181 if (hash == GNUTLS_DIG_UNKNOWN)
182 throw Exception("Unknown hash type " + hashname);
184 // Check if the user is giving us something that is a valid MAC but not digest
185 gnutls_hash_hd_t is_digest;
186 if (gnutls_hash_init(&is_digest, hash) < 0)
187 throw Exception("Unknown hash type " + hashname);
188 gnutls_hash_deinit(is_digest, NULL);
190 if (stdalgo::string::equalsci(hashname, "md5"))
191 hash = GNUTLS_DIG_MD5;
192 else if (stdalgo::string::equalsci(hashname, "sha1"))
193 hash = GNUTLS_DIG_SHA1;
194 else if (stdalgo::string::equalsci(hashname, "sha256"))
195 hash = GNUTLS_DIG_SHA256;
197 throw Exception("Unknown hash type " + hashname);
201 gnutls_digest_algorithm_t get() const { return hash; }
206 gnutls_dh_params_t dh_params;
210 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
215 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
217 std::auto_ptr<DHParams> dh(new DHParams);
218 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
219 ThrowOnError(ret, "Unable to import DH params");
225 gnutls_dh_params_deinit(dh_params);
228 const gnutls_dh_params_t& get() const { return dh_params; }
233 /** Ensure that the key is deinited in case the constructor of X509Key throws
238 gnutls_x509_privkey_t key;
242 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
247 gnutls_x509_privkey_deinit(key);
253 X509Key(const std::string& keystr)
255 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
256 ThrowOnError(ret, "Unable to import private key");
259 gnutls_x509_privkey_t& get() { return key.key; }
264 std::vector<gnutls_x509_crt_t> certs;
268 X509CertList(const std::string& certstr)
270 unsigned int certcount = 3;
271 certs.resize(certcount);
272 Datum datum(certstr);
274 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
275 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
277 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
278 // try again with a bigger buffer
279 certs.resize(certcount);
280 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
283 ThrowOnError(ret, "Unable to load certificates");
285 // Resize the vector to the actual number of certs because we rely on its size being correct
286 // when deallocating the certs
287 certs.resize(certcount);
292 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
293 gnutls_x509_crt_deinit(*i);
296 gnutls_x509_crt_t* raw() { return &certs[0]; }
297 unsigned int size() const { return certs.size(); }
300 class X509CRL : public refcountbase
305 gnutls_x509_crl_t crl;
309 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
314 gnutls_x509_crl_deinit(crl);
320 X509CRL(const std::string& crlstr)
322 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
323 ThrowOnError(ret, "Unable to load certificate revocation list");
326 gnutls_x509_crl_t& get() { return crl.crl; }
329 #ifdef GNUTLS_NEW_PRIO_API
332 gnutls_priority_t priority;
335 Priority(const std::string& priorities)
337 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
338 // If the user did not supply anything then the string is already set to "NORMAL"
339 const char* priocstr = priorities.c_str();
340 const char* prioerror;
342 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
345 // gnutls did not understand the user supplied string
346 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
352 gnutls_priority_deinit(priority);
355 void SetupSession(gnutls_session_t sess)
357 gnutls_priority_set(sess, priority);
360 static const char* GetDefault()
362 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
365 static std::string RemoveUnknownTokens(const std::string& prio)
368 irc::sepstream ss(prio, ':');
369 for (std::string token; ss.GetToken(token); )
371 // Save current position so we can revert later if needed
372 const std::string::size_type prevpos = ret.length();
378 gnutls_priority_t test;
379 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
381 // The new token broke the priority string, revert to the previously working one
382 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
388 gnutls_priority_deinit(test);
395 /** Dummy class, used when gnutls_priority_set() is not available
400 Priority(const std::string& priorities)
402 if (priorities != GetDefault())
403 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
406 static void SetupSession(gnutls_session_t sess)
408 // Always set the default priorities
409 gnutls_set_default_priority(sess);
412 static const char* GetDefault()
417 static std::string RemoveUnknownTokens(const std::string& prio)
419 // We don't do anything here because only NORMAL is accepted
425 class CertCredentials
427 /** DH parameters associated with these credentials
429 std::auto_ptr<DHParams> dh;
432 gnutls_certificate_credentials_t cred;
437 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
442 gnutls_certificate_free_credentials(cred);
445 /** Associates these credentials with the session
447 void SetupSession(gnutls_session_t sess)
449 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
452 /** Set the given DH parameters to be used with these credentials
454 void SetDH(std::auto_ptr<DHParams>& DH)
457 gnutls_certificate_set_dh_params(cred, dh->get());
461 class X509Credentials : public CertCredentials
467 /** Certificate list, presented to the peer
471 /** Trusted CA, may be NULL
473 std::auto_ptr<X509CertList> trustedca;
475 /** Certificate revocation list, may be NULL
477 std::auto_ptr<X509CRL> crl;
479 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);
482 X509Credentials(const std::string& certstr, const std::string& keystr)
486 // Throwing is ok here, the destructor of Credentials is called in that case
487 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
488 ThrowOnError(ret, "Unable to set cert/key pair");
490 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
491 gnutls_certificate_set_retrieve_function(cred, cert_callback);
493 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
497 /** Sets the trusted CA and the certificate revocation list
498 * to use when verifying certificates
500 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
502 // Do nothing if certlist is NULL
505 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
506 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
510 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
511 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
514 trustedca = certlist;
523 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
524 gnutls_packet_t packet;
527 DataReader(gnutls_session_t sess)
529 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
530 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
531 // to the recvq directly from there in appendto().
532 retval = gnutls_record_recv_packet(sess, &packet);
535 void appendto(std::string& recvq)
537 // Copy data from GnuTLS buffers to recvq
538 gnutls_datum_t datum;
539 gnutls_packet_get(packet, &datum, NULL);
540 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
542 gnutls_packet_deinit(packet);
548 DataReader(gnutls_session_t sess)
549 : buffer(ServerInstance->GetReadBuffer())
551 // Read data from GnuTLS buffers into ReadBuffer
552 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
555 void appendto(std::string& recvq)
557 // Copy data from ReadBuffer to recvq
558 recvq.append(buffer, retval);
562 int ret() const { return retval; }
567 /** Name of this profile
569 const std::string name;
571 /** X509 certificate(s) and key
573 X509Credentials x509cred;
575 /** The minimum length in bits for the DH prime to be accepted as a client
577 unsigned int min_dh_bits;
579 /** Hashing algorithm to use when generating certificate fingerprints
583 /** Priorities for ciphers, compression methods, etc.
587 /** Rough max size of records to send
589 const unsigned int outrecsize;
591 /** True to request a client certificate as a server
593 const bool requestclientcert;
595 static std::string ReadFile(const std::string& filename)
597 FileReader reader(filename);
598 std::string ret = reader.GetString();
600 throw Exception("Cannot read file " + filename);
604 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
606 // Use default priority string if this tag does not specify one
607 std::string priostr = GnuTLS::Priority::GetDefault();
608 bool found = tag->readString("priority", priostr);
609 // 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
610 if (!tag->getBool("strictpriority", found))
612 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
613 if (stripped.empty())
615 // Stripping failed, act as if a prio string wasn't set
616 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
617 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());
619 else if ((found) && (stripped != priostr))
621 // Prio string was set in the config and we ended up with something that works but different
622 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
624 priostr.swap(stripped);
634 std::auto_ptr<X509CertList> ca;
635 std::auto_ptr<X509CRL> crl;
639 std::auto_ptr<DHParams> dh;
645 unsigned int outrecsize;
646 bool requestclientcert;
648 Config(const std::string& profilename, ConfigTag* tag)
650 , certstr(ReadFile(tag->getString("certfile", "cert.pem")))
651 , keystr(ReadFile(tag->getString("keyfile", "key.pem")))
652 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem"))))
653 , priostr(GetPrioStr(profilename, tag))
654 , mindh(tag->getUInt("mindhbits", 1024))
655 , hashstr(tag->getString("hash", "md5"))
656 , requestclientcert(tag->getBool("requestclientcert", true))
658 // Load trusted CA and revocation list, if set
659 std::string filename = tag->getString("cafile");
660 if (!filename.empty())
662 ca.reset(new X509CertList(ReadFile(filename)));
664 filename = tag->getString("crlfile");
665 if (!filename.empty())
666 crl.reset(new X509CRL(ReadFile(filename)));
669 #ifdef INSPIRCD_GNUTLS_HAS_CORK
670 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
671 outrecsize = tag->getUInt("outrecsize", 2048, 512);
673 outrecsize = tag->getUInt("outrecsize", 2048, 512, 16384);
678 Profile(Config& config)
680 , x509cred(config.certstr, config.keystr)
681 , min_dh_bits(config.mindh)
682 , hash(config.hashstr)
683 , priority(config.priostr)
684 , outrecsize(config.outrecsize)
685 , requestclientcert(config.requestclientcert)
687 x509cred.SetDH(config.dh);
688 x509cred.SetCA(config.ca, config.crl);
690 /** Set up the given session with the settings in this profile
692 void SetupSession(gnutls_session_t sess)
694 priority.SetupSession(sess);
695 x509cred.SetupSession(sess);
696 gnutls_dh_set_prime_bits(sess, min_dh_bits);
698 // Request client certificate if enabled and we are a server, no-op if we're a client
699 if (requestclientcert)
700 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
703 const std::string& GetName() const { return name; }
704 X509Credentials& GetX509Credentials() { return x509cred; }
705 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
706 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
710 class GnuTLSIOHook : public SSLIOHook
713 gnutls_session_t sess;
715 #ifdef INSPIRCD_GNUTLS_HAS_CORK
723 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
724 gnutls_deinit(this->sess);
731 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
732 int Handshake(StreamSocket* user)
734 int ret = gnutls_handshake(this->sess);
738 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
740 // Handshake needs resuming later, read() or write() would have blocked.
741 this->status = ISSL_HANDSHAKING;
743 if (gnutls_record_get_direction(this->sess) == 0)
745 // gnutls_handshake() wants to read() again.
746 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
750 // gnutls_handshake() wants to write() again.
751 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
758 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
765 // Change the seesion state
766 this->status = ISSL_HANDSHAKEN;
770 // Finish writing, if any left
771 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
777 void VerifyCertificate()
779 unsigned int certstatus;
780 const gnutls_datum_t* cert_list;
782 unsigned int cert_list_size;
783 gnutls_x509_crt_t cert;
785 unsigned char digest[512];
786 size_t digest_size = sizeof(digest);
787 size_t name_size = sizeof(str);
788 ssl_cert* certinfo = new ssl_cert;
789 this->certificate = certinfo;
791 /* This verification function uses the trusted CAs in the credentials
792 * structure. So you must have installed one or more CA certificates.
794 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
798 certinfo->error = std::string(gnutls_strerror(ret));
802 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
803 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
804 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
805 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
807 /* Up to here the process is the same for X.509 certificates and
808 * OpenPGP keys. From now on X.509 certificates are assumed. This can
809 * be easily extended to work with openpgp keys as well.
811 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
813 certinfo->error = "No X509 keys sent";
817 ret = gnutls_x509_crt_init(&cert);
820 certinfo->error = gnutls_strerror(ret);
825 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
826 if (cert_list == NULL)
828 certinfo->error = "No certificate was found";
829 goto info_done_dealloc;
832 /* This is not a real world example, since we only check the first
833 * certificate in the given chain.
836 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
839 certinfo->error = gnutls_strerror(ret);
840 goto info_done_dealloc;
843 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
845 std::string& dn = certinfo->dn;
847 // Make sure there are no chars in the string that we consider invalid
848 if (dn.find_first_of("\r\n") != std::string::npos)
852 name_size = sizeof(str);
853 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
855 std::string& issuer = certinfo->issuer;
857 if (issuer.find_first_of("\r\n") != std::string::npos)
861 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
863 certinfo->error = gnutls_strerror(ret);
867 certinfo->fingerprint = BinToHex(digest, digest_size);
870 /* Beware here we do not check for errors.
872 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
874 certinfo->error = "Not activated, or expired certificate";
878 gnutls_x509_crt_deinit(cert);
881 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
882 int PrepareIO(StreamSocket* sock)
884 if (status == ISSL_HANDSHAKEN)
886 else if (status == ISSL_HANDSHAKING)
888 // The handshake isn't finished, try to finish it
889 return Handshake(sock);
893 sock->SetError("No SSL session");
897 #ifdef INSPIRCD_GNUTLS_HAS_CORK
898 int FlushBuffer(StreamSocket* sock)
900 // If GnuTLS has some data buffered, write it
902 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
907 int HandleWriteRet(StreamSocket* sock, int ret)
911 #ifdef INSPIRCD_GNUTLS_HAS_CORK
915 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
921 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
923 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
928 sock->SetError(gnutls_strerror(ret));
934 static const char* UnknownIfNULL(const char* str)
936 return str ? str : "UNKNOWN";
939 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
941 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
943 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
946 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
949 gnutls_transport_set_errno(session->sess, EAGAIN);
956 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
961 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
962 * and then set errno appropriately.
963 * The gnutls library may also have a different errno variable than us, see
964 * gnutls_transport_set_errno(3).
966 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
971 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
975 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
976 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
978 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
980 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
983 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
986 gnutls_transport_set_errno(session->sess, EAGAIN);
993 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
994 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
996 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
998 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1002 for (int i = 0; i < iovcnt; i++)
1003 size += iov[i].iov_len;
1006 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1010 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1011 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1013 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1015 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1018 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1021 gnutls_transport_set_errno(session->sess, EAGAIN);
1028 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1033 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1034 * and then set errno appropriately.
1035 * The gnutls library may also have a different errno variable than us, see
1036 * gnutls_transport_set_errno(3).
1038 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1043 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1046 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1049 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1050 : SSLIOHook(hookprov)
1053 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1057 gnutls_init(&sess, flags);
1058 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1059 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1060 gnutls_transport_set_vec_push_function(sess, VectorPush);
1062 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1064 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1065 GetProfile().SetupSession(sess);
1067 sock->AddIOHook(this);
1071 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1076 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1078 // Finish handshake if needed
1079 int prepret = PrepareIO(user);
1083 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1085 GnuTLS::DataReader reader(sess);
1086 int ret = reader.ret();
1089 reader.appendto(recvq);
1090 // Schedule a read if there is still data in the GnuTLS buffer
1091 if (gnutls_record_check_pending(sess) > 0)
1092 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1095 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1101 user->SetError("Connection closed");
1107 user->SetError(gnutls_strerror(ret));
1114 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1116 // Finish handshake if needed
1117 int prepret = PrepareIO(user);
1121 // Session is ready for transferring application data
1123 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1126 // If there is something in the GnuTLS buffer try to send() it
1127 int ret = FlushBuffer(user);
1129 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1131 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1135 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1136 gnutls_record_cork(this->sess);
1137 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1139 const StreamSocket::SendQueue::Element& elem = sendq.front();
1140 gbuffersize += elem.length();
1141 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1153 while (!sendq.empty())
1155 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1156 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1157 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1161 else if (ret < (int)buffer.length())
1163 sendq.erase_front(ret);
1164 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1168 // Wrote entire record, continue sending
1173 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1177 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1179 if (!IsHandshakeDone())
1181 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1182 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1183 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1184 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1187 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1189 std::vector<char> nameBuffer;
1190 size_t nameLength = 0;
1191 unsigned int nameType = GNUTLS_NAME_DNS;
1193 // First, determine the size of the hostname.
1194 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1197 // Then retrieve the hostname.
1198 nameBuffer.resize(nameLength);
1199 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1202 out.append(&nameBuffer[0]);
1206 GnuTLS::Profile& GetProfile();
1207 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1210 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)
1212 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1213 st->type = GNUTLS_CRT_X509;
1215 st->cert_type = GNUTLS_CRT_X509;
1216 st->key_type = GNUTLS_PRIVKEY_X509;
1218 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1219 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1221 st->ncerts = cred.certs.size();
1222 st->cert.x509 = cred.certs.raw();
1223 st->key.x509 = cred.key.get();
1229 class GnuTLSIOHookProvider : public IOHookProvider
1231 GnuTLS::Profile profile;
1234 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1235 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1238 ServerInstance->Modules->AddService(*this);
1241 ~GnuTLSIOHookProvider()
1243 ServerInstance->Modules->DelService(*this);
1246 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1248 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1251 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1253 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1256 GnuTLS::Profile& GetProfile() { return profile; }
1259 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1261 IOHookProvider* hookprov = prov;
1262 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1265 class ModuleSSLGnuTLS : public Module
1267 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1269 // First member of the class, gets constructed first and destructed last
1270 GnuTLS::Init libinit;
1271 ProfileList profiles;
1275 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1276 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1277 // avoiding unpleasant situations where no new SSL connections are possible.
1278 ProfileList newprofiles;
1280 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1281 if (tags.first == tags.second)
1283 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1284 const std::string defname = "gnutls";
1285 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1286 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1290 GnuTLS::Profile::Config profileconfig(defname, tag);
1291 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1293 catch (CoreException& ex)
1295 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1299 for (ConfigIter i = tags.first; i != tags.second; ++i)
1301 ConfigTag* tag = i->second;
1302 if (!stdalgo::string::equalsci(tag->getString("provider"), "gnutls"))
1305 std::string name = tag->getString("name");
1308 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1312 reference<GnuTLSIOHookProvider> prov;
1315 GnuTLS::Profile::Config profileconfig(name, tag);
1316 prov = new GnuTLSIOHookProvider(this, profileconfig);
1318 catch (CoreException& ex)
1320 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1323 newprofiles.push_back(prov);
1326 // New profiles are ok, begin using them
1327 // Old profiles are deleted when their refcount drops to zero
1328 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1330 GnuTLSIOHookProvider& prov = **i;
1331 ServerInstance->Modules.DelService(prov);
1334 profiles.swap(newprofiles);
1340 #ifndef GNUTLS_HAS_RND
1341 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1346 void init() CXX11_OVERRIDE
1348 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1350 ServerInstance->GenRandom = RandGen::Call;
1353 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1362 catch (ModuleException& ex)
1364 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1370 ServerInstance->GenRandom = &InspIRCd::DefaultGenRandom;
1373 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1375 if (type == ExtensionItem::EXT_USER)
1377 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1379 if ((user) && (user->eh.GetModHook(this)))
1381 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1382 // Potentially there could be multiple SSL modules loaded at once on different ports.
1383 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1388 Version GetVersion() CXX11_OVERRIDE
1390 return Version("Provides SSL support for clients", VF_VENDOR);
1393 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1395 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1396 if ((iohook) && (!iohook->IsHandshakeDone()))
1397 return MOD_RES_DENY;
1398 return MOD_RES_PASSTHRU;
1402 MODULE_INIT(ModuleSSLGnuTLS)