2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
6 * Copyright (C) 2013-2014, 2016-2020 Sadie Powell <sadie@witchery.services>
7 * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
8 * Copyright (C) 2012-2017 Attila Molnar <attilamolnar@hush.com>
9 * Copyright (C) 2012-2013, 2016 Adam <Adam@anope.org>
10 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
11 * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
12 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
13 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
14 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
15 * Copyright (C) 2008 John Brooks <special@inspircd.org>
16 * Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
17 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
18 * Copyright (C) 2006 Oliver Lupton <om@inspircd.org>
20 * This file is part of InspIRCd. InspIRCd is free software: you can
21 * redistribute it and/or modify it under the terms of the GNU General Public
22 * License as published by the Free Software Foundation, version 2.
24 * This program is distributed in the hope that it will be useful, but WITHOUT
25 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
26 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 /// $CompilerFlags: find_compiler_flags("gnutls")
34 /// $CompilerFlags: require_version("gnutls" "1.0" "2.12") execute("libgcrypt-config --cflags" "LIBGCRYPT_CXXFLAGS")
36 /// $LinkerFlags: find_linker_flags("gnutls" "-lgnutls")
37 /// $LinkerFlags: require_version("gnutls" "1.0" "2.12") execute("libgcrypt-config --libs" "LIBGCRYPT_LDFLAGS")
39 /// $PackageInfo: require_system("arch") gnutls pkgconf
40 /// $PackageInfo: require_system("centos") gnutls-devel pkgconfig
41 /// $PackageInfo: require_system("darwin") gnutls pkg-config
42 /// $PackageInfo: require_system("debian") gnutls-bin libgnutls28-dev pkg-config
43 /// $PackageInfo: require_system("ubuntu") gnutls-bin libgnutls-dev pkg-config
46 #include "modules/ssl.h"
50 # pragma GCC diagnostic push
53 // Fix warnings about the use of commas at end of enumerator lists on C++03.
55 # pragma clang diagnostic ignored "-Wc++11-extensions"
56 #elif defined __GNUC__
57 # if (__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8))
58 # pragma GCC diagnostic ignored "-Wpedantic"
60 # pragma GCC diagnostic ignored "-pedantic"
64 #include <gnutls/gnutls.h>
65 #include <gnutls/x509.h>
68 # pragma GCC diagnostic pop
71 // Fix warnings about using std::auto_ptr on C++11 or newer.
72 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
74 #ifndef GNUTLS_VERSION_NUMBER
75 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
76 #define GNUTLS_VERSION LIBGNUTLS_VERSION
79 // Check if the GnuTLS library is at least version major.minor.patch
80 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
82 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
83 #define GNUTLS_HAS_MAC_GET_ID
84 #include <gnutls/crypto.h>
87 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
88 # define GNUTLS_HAS_RND
94 # pragma comment(lib, "libgnutls-30.lib")
97 // These don't exist in older GnuTLS versions
98 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
99 #define GNUTLS_NEW_PRIO_API
102 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
104 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
105 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
106 #define GNUTLS_NEW_CERT_CALLBACK_API
107 typedef gnutls_retr2_st cert_cb_last_param_type;
109 typedef gnutls_retr_st cert_cb_last_param_type;
112 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
113 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
116 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
117 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
118 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
119 typedef unsigned int inspircd_gnutls_session_init_flags_t;
121 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
124 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
125 #define INSPIRCD_GNUTLS_HAS_CORK
128 static Module* thismod;
133 static void Call(char* buffer, size_t len)
135 #ifdef GNUTLS_HAS_RND
136 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
138 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
148 Init() { gnutls_global_init(); }
149 ~Init() { gnutls_global_deinit(); }
152 class Exception : public ModuleException
155 Exception(const std::string& reason)
156 : ModuleException(reason) { }
159 void ThrowOnError(int errcode, const char* msg)
163 std::string reason = msg;
164 reason.append(" :").append(gnutls_strerror(errcode));
165 throw Exception(reason);
169 /** Used to create a gnutls_datum_t* from a std::string
173 gnutls_datum_t datum;
176 Datum(const std::string& dat)
178 datum.data = (unsigned char*)dat.data();
179 datum.size = static_cast<unsigned int>(dat.length());
182 const gnutls_datum_t* get() const { return &datum; }
187 gnutls_digest_algorithm_t hash;
190 // Nothing to deallocate, constructor may throw freely
191 Hash(const std::string& hashname)
193 // As older versions of gnutls can't do this, let's disable it where needed.
194 #ifdef GNUTLS_HAS_MAC_GET_ID
195 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
196 // There is no gnutls_dig_get_id() at the moment, but it may come later
197 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
198 if (hash == GNUTLS_DIG_UNKNOWN)
199 throw Exception("Unknown hash type " + hashname);
201 // Check if the user is giving us something that is a valid MAC but not digest
202 gnutls_hash_hd_t is_digest;
203 if (gnutls_hash_init(&is_digest, hash) < 0)
204 throw Exception("Unknown hash type " + hashname);
205 gnutls_hash_deinit(is_digest, NULL);
207 if (stdalgo::string::equalsci(hashname, "md5"))
208 hash = GNUTLS_DIG_MD5;
209 else if (stdalgo::string::equalsci(hashname, "sha1"))
210 hash = GNUTLS_DIG_SHA1;
211 else if (stdalgo::string::equalsci(hashname, "sha256"))
212 hash = GNUTLS_DIG_SHA256;
214 throw Exception("Unknown hash type " + hashname);
218 gnutls_digest_algorithm_t get() const { return hash; }
223 gnutls_dh_params_t dh_params;
227 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
232 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
234 std::auto_ptr<DHParams> dh(new DHParams);
235 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
236 ThrowOnError(ret, "Unable to import DH params");
242 gnutls_dh_params_deinit(dh_params);
245 const gnutls_dh_params_t& get() const { return dh_params; }
250 /** Ensure that the key is deinited in case the constructor of X509Key throws
255 gnutls_x509_privkey_t key;
259 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
264 gnutls_x509_privkey_deinit(key);
270 X509Key(const std::string& keystr)
272 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
273 ThrowOnError(ret, "Unable to import private key");
276 gnutls_x509_privkey_t& get() { return key.key; }
281 std::vector<gnutls_x509_crt_t> certs;
285 X509CertList(const std::string& certstr)
287 unsigned int certcount = 3;
288 certs.resize(certcount);
289 Datum datum(certstr);
291 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
292 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
294 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
295 // try again with a bigger buffer
296 certs.resize(certcount);
297 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
300 ThrowOnError(ret, "Unable to load certificates");
302 // Resize the vector to the actual number of certs because we rely on its size being correct
303 // when deallocating the certs
304 certs.resize(certcount);
309 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
310 gnutls_x509_crt_deinit(*i);
313 gnutls_x509_crt_t* raw() { return &certs[0]; }
314 unsigned int size() const { return certs.size(); }
317 class X509CRL : public refcountbase
322 gnutls_x509_crl_t crl;
326 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
331 gnutls_x509_crl_deinit(crl);
337 X509CRL(const std::string& crlstr)
339 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
340 ThrowOnError(ret, "Unable to load certificate revocation list");
343 gnutls_x509_crl_t& get() { return crl.crl; }
346 #ifdef GNUTLS_NEW_PRIO_API
349 gnutls_priority_t priority;
352 Priority(const std::string& priorities)
354 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
355 // If the user did not supply anything then the string is already set to "NORMAL"
356 const char* priocstr = priorities.c_str();
357 const char* prioerror;
359 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
362 // gnutls did not understand the user supplied string
363 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
369 gnutls_priority_deinit(priority);
372 void SetupSession(gnutls_session_t sess)
374 gnutls_priority_set(sess, priority);
377 static const char* GetDefault()
379 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
382 static std::string RemoveUnknownTokens(const std::string& prio)
385 irc::sepstream ss(prio, ':');
386 for (std::string token; ss.GetToken(token); )
388 // Save current position so we can revert later if needed
389 const std::string::size_type prevpos = ret.length();
395 gnutls_priority_t test;
396 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
398 // The new token broke the priority string, revert to the previously working one
399 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
405 gnutls_priority_deinit(test);
412 /** Dummy class, used when gnutls_priority_set() is not available
417 Priority(const std::string& priorities)
419 if (priorities != GetDefault())
420 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
423 static void SetupSession(gnutls_session_t sess)
425 // Always set the default priorities
426 gnutls_set_default_priority(sess);
429 static const char* GetDefault()
434 static std::string RemoveUnknownTokens(const std::string& prio)
436 // We don't do anything here because only NORMAL is accepted
442 class CertCredentials
444 /** DH parameters associated with these credentials
446 std::auto_ptr<DHParams> dh;
449 gnutls_certificate_credentials_t cred;
454 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
459 gnutls_certificate_free_credentials(cred);
462 /** Associates these credentials with the session
464 void SetupSession(gnutls_session_t sess)
466 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
469 /** Set the given DH parameters to be used with these credentials
471 void SetDH(std::auto_ptr<DHParams>& DH)
474 gnutls_certificate_set_dh_params(cred, dh->get());
478 class X509Credentials : public CertCredentials
484 /** Certificate list, presented to the peer
488 /** Trusted CA, may be NULL
490 std::auto_ptr<X509CertList> trustedca;
492 /** Certificate revocation list, may be NULL
494 std::auto_ptr<X509CRL> crl;
496 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);
499 X509Credentials(const std::string& certstr, const std::string& keystr)
503 // Throwing is ok here, the destructor of Credentials is called in that case
504 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
505 ThrowOnError(ret, "Unable to set cert/key pair");
507 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
508 gnutls_certificate_set_retrieve_function(cred, cert_callback);
510 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
514 /** Sets the trusted CA and the certificate revocation list
515 * to use when verifying certificates
517 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
519 // Do nothing if certlist is NULL
522 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
523 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
527 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
528 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
531 trustedca = certlist;
540 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
541 gnutls_packet_t packet;
544 DataReader(gnutls_session_t sess)
546 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
547 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
548 // to the recvq directly from there in appendto().
549 retval = gnutls_record_recv_packet(sess, &packet);
552 void appendto(std::string& recvq)
554 // Copy data from GnuTLS buffers to recvq
555 gnutls_datum_t datum;
556 gnutls_packet_get(packet, &datum, NULL);
557 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
559 gnutls_packet_deinit(packet);
565 DataReader(gnutls_session_t sess)
566 : buffer(ServerInstance->GetReadBuffer())
568 // Read data from GnuTLS buffers into ReadBuffer
569 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
572 void appendto(std::string& recvq)
574 // Copy data from ReadBuffer to recvq
575 recvq.append(buffer, retval);
579 int ret() const { return retval; }
584 /** Name of this profile
586 const std::string name;
588 /** X509 certificate(s) and key
590 X509Credentials x509cred;
592 /** The minimum length in bits for the DH prime to be accepted as a client
594 unsigned int min_dh_bits;
596 /** Hashing algorithm to use when generating certificate fingerprints
600 /** Priorities for ciphers, compression methods, etc.
604 /** Rough max size of records to send
606 const unsigned int outrecsize;
608 /** True to request a client certificate as a server
610 const bool requestclientcert;
612 static std::string ReadFile(const std::string& filename)
614 FileReader reader(filename);
615 std::string ret = reader.GetString();
617 throw Exception("Cannot read file " + filename);
621 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
623 // Use default priority string if this tag does not specify one
624 std::string priostr = GnuTLS::Priority::GetDefault();
625 bool found = tag->readString("priority", priostr);
626 // 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
627 if (!tag->getBool("strictpriority", found))
629 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
630 if (stripped.empty())
632 // Stripping failed, act as if a prio string wasn't set
633 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
634 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());
636 else if ((found) && (stripped != priostr))
638 // Prio string was set in the config and we ended up with something that works but different
639 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
641 priostr.swap(stripped);
651 std::auto_ptr<X509CertList> ca;
652 std::auto_ptr<X509CRL> crl;
656 std::auto_ptr<DHParams> dh;
662 unsigned int outrecsize;
663 bool requestclientcert;
665 Config(const std::string& profilename, ConfigTag* tag)
667 , certstr(ReadFile(tag->getString("certfile", "cert.pem", 1)))
668 , keystr(ReadFile(tag->getString("keyfile", "key.pem", 1)))
669 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem", 1))))
670 , priostr(GetPrioStr(profilename, tag))
671 , mindh(tag->getUInt("mindhbits", 1024))
672 , hashstr(tag->getString("hash", "md5", 1))
673 , requestclientcert(tag->getBool("requestclientcert", true))
675 // Load trusted CA and revocation list, if set
676 std::string filename = tag->getString("cafile");
677 if (!filename.empty())
679 ca.reset(new X509CertList(ReadFile(filename)));
681 filename = tag->getString("crlfile");
682 if (!filename.empty())
683 crl.reset(new X509CRL(ReadFile(filename)));
686 #ifdef INSPIRCD_GNUTLS_HAS_CORK
687 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
688 outrecsize = tag->getUInt("outrecsize", 2048, 512);
690 outrecsize = tag->getUInt("outrecsize", 2048, 512, 16384);
695 Profile(Config& config)
697 , x509cred(config.certstr, config.keystr)
698 , min_dh_bits(config.mindh)
699 , hash(config.hashstr)
700 , priority(config.priostr)
701 , outrecsize(config.outrecsize)
702 , requestclientcert(config.requestclientcert)
704 x509cred.SetDH(config.dh);
705 x509cred.SetCA(config.ca, config.crl);
707 /** Set up the given session with the settings in this profile
709 void SetupSession(gnutls_session_t sess)
711 priority.SetupSession(sess);
712 x509cred.SetupSession(sess);
713 gnutls_dh_set_prime_bits(sess, min_dh_bits);
715 // Request client certificate if enabled and we are a server, no-op if we're a client
716 if (requestclientcert)
717 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
720 const std::string& GetName() const { return name; }
721 X509Credentials& GetX509Credentials() { return x509cred; }
722 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
723 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
727 class GnuTLSIOHook : public SSLIOHook
730 gnutls_session_t sess;
732 #ifdef INSPIRCD_GNUTLS_HAS_CORK
740 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
741 gnutls_deinit(this->sess);
748 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
749 int Handshake(StreamSocket* user)
751 int ret = gnutls_handshake(this->sess);
755 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
757 // Handshake needs resuming later, read() or write() would have blocked.
758 this->status = ISSL_HANDSHAKING;
760 if (gnutls_record_get_direction(this->sess) == 0)
762 // gnutls_handshake() wants to read() again.
763 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
767 // gnutls_handshake() wants to write() again.
768 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
775 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
782 // Change the seesion state
783 this->status = ISSL_HANDSHAKEN;
787 // Finish writing, if any left
788 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
794 void VerifyCertificate()
796 unsigned int certstatus;
797 const gnutls_datum_t* cert_list;
799 unsigned int cert_list_size;
800 gnutls_x509_crt_t cert;
802 unsigned char digest[512];
803 size_t digest_size = sizeof(digest);
804 size_t name_size = sizeof(str);
805 ssl_cert* certinfo = new ssl_cert;
806 this->certificate = certinfo;
808 /* This verification function uses the trusted CAs in the credentials
809 * structure. So you must have installed one or more CA certificates.
811 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
815 certinfo->error = std::string(gnutls_strerror(ret));
819 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
820 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
821 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
822 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
824 /* Up to here the process is the same for X.509 certificates and
825 * OpenPGP keys. From now on X.509 certificates are assumed. This can
826 * be easily extended to work with openpgp keys as well.
828 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
830 certinfo->error = "No X509 keys sent";
834 ret = gnutls_x509_crt_init(&cert);
837 certinfo->error = gnutls_strerror(ret);
842 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
843 if (cert_list == NULL)
845 certinfo->error = "No certificate was found";
846 goto info_done_dealloc;
849 /* This is not a real world example, since we only check the first
850 * certificate in the given chain.
853 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
856 certinfo->error = gnutls_strerror(ret);
857 goto info_done_dealloc;
860 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
862 std::string& dn = certinfo->dn;
864 // Make sure there are no chars in the string that we consider invalid
865 if (dn.find_first_of("\r\n") != std::string::npos)
869 name_size = sizeof(str);
870 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
872 std::string& issuer = certinfo->issuer;
874 if (issuer.find_first_of("\r\n") != std::string::npos)
878 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
880 certinfo->error = gnutls_strerror(ret);
884 certinfo->fingerprint = BinToHex(digest, digest_size);
887 /* Beware here we do not check for errors.
889 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
891 certinfo->error = "Not activated, or expired certificate";
895 gnutls_x509_crt_deinit(cert);
898 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
899 int PrepareIO(StreamSocket* sock)
901 if (status == ISSL_HANDSHAKEN)
903 else if (status == ISSL_HANDSHAKING)
905 // The handshake isn't finished, try to finish it
906 return Handshake(sock);
910 sock->SetError("No TLS (SSL) session");
914 #ifdef INSPIRCD_GNUTLS_HAS_CORK
915 int FlushBuffer(StreamSocket* sock)
917 // If GnuTLS has some data buffered, write it
919 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
924 int HandleWriteRet(StreamSocket* sock, int ret)
928 #ifdef INSPIRCD_GNUTLS_HAS_CORK
932 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
938 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
940 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
945 sock->SetError(gnutls_strerror(ret));
951 static const char* UnknownIfNULL(const char* str)
953 return str ? str : "UNKNOWN";
956 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
958 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
960 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
963 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
966 gnutls_transport_set_errno(session->sess, EAGAIN);
973 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
978 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
979 * and then set errno appropriately.
980 * The gnutls library may also have a different errno variable than us, see
981 * gnutls_transport_set_errno(3).
983 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
988 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
992 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
993 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
995 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
997 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1000 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1003 gnutls_transport_set_errno(session->sess, EAGAIN);
1010 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
1011 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
1013 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
1015 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1019 for (int i = 0; i < iovcnt; i++)
1020 size += iov[i].iov_len;
1023 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1027 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1028 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1030 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1032 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1035 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1038 gnutls_transport_set_errno(session->sess, EAGAIN);
1045 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1050 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1051 * and then set errno appropriately.
1052 * The gnutls library may also have a different errno variable than us, see
1053 * gnutls_transport_set_errno(3).
1055 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1060 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1063 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1066 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1067 : SSLIOHook(hookprov)
1070 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1074 gnutls_init(&sess, flags);
1075 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1076 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1077 gnutls_transport_set_vec_push_function(sess, VectorPush);
1079 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1081 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1082 GetProfile().SetupSession(sess);
1084 sock->AddIOHook(this);
1088 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1093 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1095 // Finish handshake if needed
1096 int prepret = PrepareIO(user);
1100 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1102 GnuTLS::DataReader reader(sess);
1103 int ret = reader.ret();
1106 reader.appendto(recvq);
1107 // Schedule a read if there is still data in the GnuTLS buffer
1108 if (gnutls_record_check_pending(sess) > 0)
1109 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1112 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1118 user->SetError("Connection closed");
1124 user->SetError(gnutls_strerror(ret));
1131 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1133 // Finish handshake if needed
1134 int prepret = PrepareIO(user);
1138 // Session is ready for transferring application data
1140 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1143 // If there is something in the GnuTLS buffer try to send() it
1144 int ret = FlushBuffer(user);
1146 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1148 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1152 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1153 gnutls_record_cork(this->sess);
1154 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1156 const StreamSocket::SendQueue::Element& elem = sendq.front();
1157 gbuffersize += elem.length();
1158 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1170 while (!sendq.empty())
1172 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1173 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1174 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1178 else if (ret < (int)buffer.length())
1180 sendq.erase_front(ret);
1181 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1185 // Wrote entire record, continue sending
1190 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1194 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1196 if (!IsHandshakeDone())
1198 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1199 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1200 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1201 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1204 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1206 std::vector<char> nameBuffer;
1207 size_t nameLength = 0;
1208 unsigned int nameType = GNUTLS_NAME_DNS;
1210 // First, determine the size of the hostname.
1211 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1214 // Then retrieve the hostname.
1215 nameBuffer.resize(nameLength);
1216 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1219 out.append(&nameBuffer[0]);
1223 GnuTLS::Profile& GetProfile();
1224 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1227 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)
1229 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1230 st->type = GNUTLS_CRT_X509;
1232 st->cert_type = GNUTLS_CRT_X509;
1233 st->key_type = GNUTLS_PRIVKEY_X509;
1235 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1236 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1238 st->ncerts = cred.certs.size();
1239 st->cert.x509 = cred.certs.raw();
1240 st->key.x509 = cred.key.get();
1246 class GnuTLSIOHookProvider : public IOHookProvider
1248 GnuTLS::Profile profile;
1251 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1252 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1255 ServerInstance->Modules->AddService(*this);
1258 ~GnuTLSIOHookProvider()
1260 ServerInstance->Modules->DelService(*this);
1263 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1265 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1268 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1270 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1273 GnuTLS::Profile& GetProfile() { return profile; }
1276 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1278 IOHookProvider* hookprov = prov;
1279 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1282 class ModuleSSLGnuTLS : public Module
1284 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1286 // First member of the class, gets constructed first and destructed last
1287 GnuTLS::Init libinit;
1288 ProfileList profiles;
1292 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1293 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1294 // avoiding unpleasant situations where no new TLS (SSL) connections are possible.
1295 ProfileList newprofiles;
1297 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1298 if (tags.first == tags.second)
1300 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1301 const std::string defname = "gnutls";
1302 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1303 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the deprecated <gnutls> tag");
1307 GnuTLS::Profile::Config profileconfig(defname, tag);
1308 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1310 catch (CoreException& ex)
1312 throw ModuleException("Error while initializing the default TLS (SSL) profile - " + ex.GetReason());
1317 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "You have defined an <sslprofile> tag; you should use this in place of \"gnutls\" when configuring TLS (SSL) connections in <bind:ssl> or <link:ssl>");
1318 for (ConfigIter i = tags.first; i != tags.second; ++i)
1320 ConfigTag* tag = i->second;
1321 if (!stdalgo::string::equalsci(tag->getString("provider"), "gnutls"))
1323 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring non-GnuTLS <sslprofile> tag at " + tag->getTagLocation());
1327 std::string name = tag->getString("name");
1330 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1334 reference<GnuTLSIOHookProvider> prov;
1337 GnuTLS::Profile::Config profileconfig(name, tag);
1338 prov = new GnuTLSIOHookProvider(this, profileconfig);
1340 catch (CoreException& ex)
1342 throw ModuleException("Error while initializing TLS (SSL) profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1345 newprofiles.push_back(prov);
1349 // New profiles are ok, begin using them
1350 // Old profiles are deleted when their refcount drops to zero
1351 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1353 GnuTLSIOHookProvider& prov = **i;
1354 ServerInstance->Modules.DelService(prov);
1357 profiles.swap(newprofiles);
1363 #ifndef GNUTLS_HAS_RND
1364 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1369 void init() CXX11_OVERRIDE
1371 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1373 ServerInstance->GenRandom = RandGen::Call;
1376 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1378 if (!irc::equals(param, "tls") && !irc::equals(param, "ssl"))
1384 ServerInstance->SNO->WriteToSnoMask('a', "TLS (SSL) module GnuTLS rehashed.");
1386 catch (ModuleException& ex)
1388 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1394 ServerInstance->GenRandom = &InspIRCd::DefaultGenRandom;
1397 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1399 if (type == ExtensionItem::EXT_USER)
1401 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1403 if ((user) && (user->eh.GetModHook(this)))
1405 // User is using TLS (SSL), they're a local user, and they're using one of *our* TLS (SSL) ports.
1406 // Potentially there could be multiple TLS (SSL) modules loaded at once on different ports.
1407 ServerInstance->Users->QuitUser(user, "GnuTLS module unloading");
1412 Version GetVersion() CXX11_OVERRIDE
1414 return Version("Allows TLS (SSL) encrypted connections using the GnuTLS library.", VF_VENDOR);
1417 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1419 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1420 if ((iohook) && (!iohook->IsHandshakeDone()))
1421 return MOD_RES_DENY;
1422 return MOD_RES_PASSTHRU;
1426 MODULE_INIT(ModuleSSLGnuTLS)