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 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
195 else if (stdalgo::string::equalsci(hashname, "sha256"))
196 hash = GNUTLS_DIG_SHA256;
199 throw Exception("Unknown hash type " + hashname);
203 gnutls_digest_algorithm_t get() const { return hash; }
208 gnutls_dh_params_t dh_params;
212 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
217 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
219 std::auto_ptr<DHParams> dh(new DHParams);
220 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
221 ThrowOnError(ret, "Unable to import DH params");
227 gnutls_dh_params_deinit(dh_params);
230 const gnutls_dh_params_t& get() const { return dh_params; }
235 /** Ensure that the key is deinited in case the constructor of X509Key throws
240 gnutls_x509_privkey_t key;
244 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
249 gnutls_x509_privkey_deinit(key);
255 X509Key(const std::string& keystr)
257 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
258 ThrowOnError(ret, "Unable to import private key");
261 gnutls_x509_privkey_t& get() { return key.key; }
266 std::vector<gnutls_x509_crt_t> certs;
270 X509CertList(const std::string& certstr)
272 unsigned int certcount = 3;
273 certs.resize(certcount);
274 Datum datum(certstr);
276 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
277 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
279 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
280 // try again with a bigger buffer
281 certs.resize(certcount);
282 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
285 ThrowOnError(ret, "Unable to load certificates");
287 // Resize the vector to the actual number of certs because we rely on its size being correct
288 // when deallocating the certs
289 certs.resize(certcount);
294 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
295 gnutls_x509_crt_deinit(*i);
298 gnutls_x509_crt_t* raw() { return &certs[0]; }
299 unsigned int size() const { return certs.size(); }
302 class X509CRL : public refcountbase
307 gnutls_x509_crl_t crl;
311 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
316 gnutls_x509_crl_deinit(crl);
322 X509CRL(const std::string& crlstr)
324 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
325 ThrowOnError(ret, "Unable to load certificate revocation list");
328 gnutls_x509_crl_t& get() { return crl.crl; }
331 #ifdef GNUTLS_NEW_PRIO_API
334 gnutls_priority_t priority;
337 Priority(const std::string& priorities)
339 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
340 // If the user did not supply anything then the string is already set to "NORMAL"
341 const char* priocstr = priorities.c_str();
342 const char* prioerror;
344 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
347 // gnutls did not understand the user supplied string
348 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
354 gnutls_priority_deinit(priority);
357 void SetupSession(gnutls_session_t sess)
359 gnutls_priority_set(sess, priority);
362 static const char* GetDefault()
364 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
367 static std::string RemoveUnknownTokens(const std::string& prio)
370 irc::sepstream ss(prio, ':');
371 for (std::string token; ss.GetToken(token); )
373 // Save current position so we can revert later if needed
374 const std::string::size_type prevpos = ret.length();
380 gnutls_priority_t test;
381 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
383 // The new token broke the priority string, revert to the previously working one
384 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
390 gnutls_priority_deinit(test);
397 /** Dummy class, used when gnutls_priority_set() is not available
402 Priority(const std::string& priorities)
404 if (priorities != GetDefault())
405 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
408 static void SetupSession(gnutls_session_t sess)
410 // Always set the default priorities
411 gnutls_set_default_priority(sess);
414 static const char* GetDefault()
419 static std::string RemoveUnknownTokens(const std::string& prio)
421 // We don't do anything here because only NORMAL is accepted
427 class CertCredentials
429 /** DH parameters associated with these credentials
431 std::auto_ptr<DHParams> dh;
434 gnutls_certificate_credentials_t cred;
439 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
444 gnutls_certificate_free_credentials(cred);
447 /** Associates these credentials with the session
449 void SetupSession(gnutls_session_t sess)
451 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
454 /** Set the given DH parameters to be used with these credentials
456 void SetDH(std::auto_ptr<DHParams>& DH)
459 gnutls_certificate_set_dh_params(cred, dh->get());
463 class X509Credentials : public CertCredentials
469 /** Certificate list, presented to the peer
473 /** Trusted CA, may be NULL
475 std::auto_ptr<X509CertList> trustedca;
477 /** Certificate revocation list, may be NULL
479 std::auto_ptr<X509CRL> crl;
481 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);
484 X509Credentials(const std::string& certstr, const std::string& keystr)
488 // Throwing is ok here, the destructor of Credentials is called in that case
489 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
490 ThrowOnError(ret, "Unable to set cert/key pair");
492 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
493 gnutls_certificate_set_retrieve_function(cred, cert_callback);
495 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
499 /** Sets the trusted CA and the certificate revocation list
500 * to use when verifying certificates
502 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
504 // Do nothing if certlist is NULL
507 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
508 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
512 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
513 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
516 trustedca = certlist;
525 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
526 gnutls_packet_t packet;
529 DataReader(gnutls_session_t sess)
531 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
532 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
533 // to the recvq directly from there in appendto().
534 retval = gnutls_record_recv_packet(sess, &packet);
537 void appendto(std::string& recvq)
539 // Copy data from GnuTLS buffers to recvq
540 gnutls_datum_t datum;
541 gnutls_packet_get(packet, &datum, NULL);
542 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
544 gnutls_packet_deinit(packet);
550 DataReader(gnutls_session_t sess)
551 : buffer(ServerInstance->GetReadBuffer())
553 // Read data from GnuTLS buffers into ReadBuffer
554 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
557 void appendto(std::string& recvq)
559 // Copy data from ReadBuffer to recvq
560 recvq.append(buffer, retval);
564 int ret() const { return retval; }
569 /** Name of this profile
571 const std::string name;
573 /** X509 certificate(s) and key
575 X509Credentials x509cred;
577 /** The minimum length in bits for the DH prime to be accepted as a client
579 unsigned int min_dh_bits;
581 /** Hashing algorithm to use when generating certificate fingerprints
585 /** Priorities for ciphers, compression methods, etc.
589 /** Rough max size of records to send
591 const unsigned int outrecsize;
593 /** True to request a client certificate as a server
595 const bool requestclientcert;
597 static std::string ReadFile(const std::string& filename)
599 FileReader reader(filename);
600 std::string ret = reader.GetString();
602 throw Exception("Cannot read file " + filename);
606 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
608 // Use default priority string if this tag does not specify one
609 std::string priostr = GnuTLS::Priority::GetDefault();
610 bool found = tag->readString("priority", priostr);
611 // 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
612 if (!tag->getBool("strictpriority", found))
614 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
615 if (stripped.empty())
617 // Stripping failed, act as if a prio string wasn't set
618 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
619 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());
621 else if ((found) && (stripped != priostr))
623 // Prio string was set in the config and we ended up with something that works but different
624 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
626 priostr.swap(stripped);
636 std::auto_ptr<X509CertList> ca;
637 std::auto_ptr<X509CRL> crl;
641 std::auto_ptr<DHParams> dh;
647 unsigned int outrecsize;
648 bool requestclientcert;
650 Config(const std::string& profilename, ConfigTag* tag)
652 , certstr(ReadFile(tag->getString("certfile", "cert.pem")))
653 , keystr(ReadFile(tag->getString("keyfile", "key.pem")))
654 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem"))))
655 , priostr(GetPrioStr(profilename, tag))
656 , mindh(tag->getUInt("mindhbits", 1024))
657 , hashstr(tag->getString("hash", "md5"))
658 , requestclientcert(tag->getBool("requestclientcert", true))
660 // Load trusted CA and revocation list, if set
661 std::string filename = tag->getString("cafile");
662 if (!filename.empty())
664 ca.reset(new X509CertList(ReadFile(filename)));
666 filename = tag->getString("crlfile");
667 if (!filename.empty())
668 crl.reset(new X509CRL(ReadFile(filename)));
671 #ifdef INSPIRCD_GNUTLS_HAS_CORK
672 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
673 outrecsize = tag->getUInt("outrecsize", 2048, 512);
675 outrecsize = tag->getUInt("outrecsize", 2048, 512, 16384);
680 Profile(Config& config)
682 , x509cred(config.certstr, config.keystr)
683 , min_dh_bits(config.mindh)
684 , hash(config.hashstr)
685 , priority(config.priostr)
686 , outrecsize(config.outrecsize)
687 , requestclientcert(config.requestclientcert)
689 x509cred.SetDH(config.dh);
690 x509cred.SetCA(config.ca, config.crl);
692 /** Set up the given session with the settings in this profile
694 void SetupSession(gnutls_session_t sess)
696 priority.SetupSession(sess);
697 x509cred.SetupSession(sess);
698 gnutls_dh_set_prime_bits(sess, min_dh_bits);
700 // Request client certificate if enabled and we are a server, no-op if we're a client
701 if (requestclientcert)
702 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
705 const std::string& GetName() const { return name; }
706 X509Credentials& GetX509Credentials() { return x509cred; }
707 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
708 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
712 class GnuTLSIOHook : public SSLIOHook
715 gnutls_session_t sess;
717 #ifdef INSPIRCD_GNUTLS_HAS_CORK
725 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
726 gnutls_deinit(this->sess);
733 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
734 int Handshake(StreamSocket* user)
736 int ret = gnutls_handshake(this->sess);
740 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
742 // Handshake needs resuming later, read() or write() would have blocked.
743 this->status = ISSL_HANDSHAKING;
745 if (gnutls_record_get_direction(this->sess) == 0)
747 // gnutls_handshake() wants to read() again.
748 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
752 // gnutls_handshake() wants to write() again.
753 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
760 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
767 // Change the seesion state
768 this->status = ISSL_HANDSHAKEN;
772 // Finish writing, if any left
773 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
779 void VerifyCertificate()
781 unsigned int certstatus;
782 const gnutls_datum_t* cert_list;
784 unsigned int cert_list_size;
785 gnutls_x509_crt_t cert;
787 unsigned char digest[512];
788 size_t digest_size = sizeof(digest);
789 size_t name_size = sizeof(str);
790 ssl_cert* certinfo = new ssl_cert;
791 this->certificate = certinfo;
793 /* This verification function uses the trusted CAs in the credentials
794 * structure. So you must have installed one or more CA certificates.
796 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
800 certinfo->error = std::string(gnutls_strerror(ret));
804 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
805 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
806 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
807 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
809 /* Up to here the process is the same for X.509 certificates and
810 * OpenPGP keys. From now on X.509 certificates are assumed. This can
811 * be easily extended to work with openpgp keys as well.
813 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
815 certinfo->error = "No X509 keys sent";
819 ret = gnutls_x509_crt_init(&cert);
822 certinfo->error = gnutls_strerror(ret);
827 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
828 if (cert_list == NULL)
830 certinfo->error = "No certificate was found";
831 goto info_done_dealloc;
834 /* This is not a real world example, since we only check the first
835 * certificate in the given chain.
838 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
841 certinfo->error = gnutls_strerror(ret);
842 goto info_done_dealloc;
845 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
847 std::string& dn = certinfo->dn;
849 // Make sure there are no chars in the string that we consider invalid
850 if (dn.find_first_of("\r\n") != std::string::npos)
854 name_size = sizeof(str);
855 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
857 std::string& issuer = certinfo->issuer;
859 if (issuer.find_first_of("\r\n") != std::string::npos)
863 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
865 certinfo->error = gnutls_strerror(ret);
869 certinfo->fingerprint = BinToHex(digest, digest_size);
872 /* Beware here we do not check for errors.
874 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
876 certinfo->error = "Not activated, or expired certificate";
880 gnutls_x509_crt_deinit(cert);
883 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
884 int PrepareIO(StreamSocket* sock)
886 if (status == ISSL_HANDSHAKEN)
888 else if (status == ISSL_HANDSHAKING)
890 // The handshake isn't finished, try to finish it
891 return Handshake(sock);
895 sock->SetError("No SSL session");
899 #ifdef INSPIRCD_GNUTLS_HAS_CORK
900 int FlushBuffer(StreamSocket* sock)
902 // If GnuTLS has some data buffered, write it
904 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
909 int HandleWriteRet(StreamSocket* sock, int ret)
913 #ifdef INSPIRCD_GNUTLS_HAS_CORK
917 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
923 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
925 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
930 sock->SetError(gnutls_strerror(ret));
936 static const char* UnknownIfNULL(const char* str)
938 return str ? str : "UNKNOWN";
941 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
943 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
945 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
948 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
951 gnutls_transport_set_errno(session->sess, EAGAIN);
958 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
963 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
964 * and then set errno appropriately.
965 * The gnutls library may also have a different errno variable than us, see
966 * gnutls_transport_set_errno(3).
968 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
973 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
977 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
978 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
980 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
982 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
985 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
988 gnutls_transport_set_errno(session->sess, EAGAIN);
995 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
996 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
998 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
1000 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1004 for (int i = 0; i < iovcnt; i++)
1005 size += iov[i].iov_len;
1008 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1012 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1013 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1015 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1017 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1020 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1023 gnutls_transport_set_errno(session->sess, EAGAIN);
1030 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1035 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1036 * and then set errno appropriately.
1037 * The gnutls library may also have a different errno variable than us, see
1038 * gnutls_transport_set_errno(3).
1040 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1045 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1048 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1051 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1052 : SSLIOHook(hookprov)
1055 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1059 gnutls_init(&sess, flags);
1060 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1061 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1062 gnutls_transport_set_vec_push_function(sess, VectorPush);
1064 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1066 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1067 GetProfile().SetupSession(sess);
1069 sock->AddIOHook(this);
1073 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1078 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1080 // Finish handshake if needed
1081 int prepret = PrepareIO(user);
1085 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1087 GnuTLS::DataReader reader(sess);
1088 int ret = reader.ret();
1091 reader.appendto(recvq);
1092 // Schedule a read if there is still data in the GnuTLS buffer
1093 if (gnutls_record_check_pending(sess) > 0)
1094 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1097 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1103 user->SetError("Connection closed");
1109 user->SetError(gnutls_strerror(ret));
1116 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1118 // Finish handshake if needed
1119 int prepret = PrepareIO(user);
1123 // Session is ready for transferring application data
1125 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1128 // If there is something in the GnuTLS buffer try to send() it
1129 int ret = FlushBuffer(user);
1131 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1133 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1137 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1138 gnutls_record_cork(this->sess);
1139 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1141 const StreamSocket::SendQueue::Element& elem = sendq.front();
1142 gbuffersize += elem.length();
1143 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1155 while (!sendq.empty())
1157 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1158 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1159 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1163 else if (ret < (int)buffer.length())
1165 sendq.erase_front(ret);
1166 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1170 // Wrote entire record, continue sending
1175 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1179 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1181 if (!IsHandshakeDone())
1183 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1184 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1185 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1186 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1189 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1191 std::vector<char> nameBuffer;
1192 size_t nameLength = 0;
1193 unsigned int nameType = GNUTLS_NAME_DNS;
1195 // First, determine the size of the hostname.
1196 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1199 // Then retrieve the hostname.
1200 nameBuffer.resize(nameLength);
1201 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1204 out.append(&nameBuffer[0]);
1208 GnuTLS::Profile& GetProfile();
1209 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1212 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)
1214 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1215 st->type = GNUTLS_CRT_X509;
1217 st->cert_type = GNUTLS_CRT_X509;
1218 st->key_type = GNUTLS_PRIVKEY_X509;
1220 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1221 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1223 st->ncerts = cred.certs.size();
1224 st->cert.x509 = cred.certs.raw();
1225 st->key.x509 = cred.key.get();
1231 class GnuTLSIOHookProvider : public IOHookProvider
1233 GnuTLS::Profile profile;
1236 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1237 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1240 ServerInstance->Modules->AddService(*this);
1243 ~GnuTLSIOHookProvider()
1245 ServerInstance->Modules->DelService(*this);
1248 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1250 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1253 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1255 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1258 GnuTLS::Profile& GetProfile() { return profile; }
1261 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1263 IOHookProvider* hookprov = prov;
1264 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1267 class ModuleSSLGnuTLS : public Module
1269 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1271 // First member of the class, gets constructed first and destructed last
1272 GnuTLS::Init libinit;
1273 ProfileList profiles;
1277 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1278 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1279 // avoiding unpleasant situations where no new SSL connections are possible.
1280 ProfileList newprofiles;
1282 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1283 if (tags.first == tags.second)
1285 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1286 const std::string defname = "gnutls";
1287 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1288 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1292 GnuTLS::Profile::Config profileconfig(defname, tag);
1293 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1295 catch (CoreException& ex)
1297 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1301 for (ConfigIter i = tags.first; i != tags.second; ++i)
1303 ConfigTag* tag = i->second;
1304 if (!stdalgo::string::equalsci(tag->getString("provider"), "gnutls"))
1307 std::string name = tag->getString("name");
1310 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1314 reference<GnuTLSIOHookProvider> prov;
1317 GnuTLS::Profile::Config profileconfig(name, tag);
1318 prov = new GnuTLSIOHookProvider(this, profileconfig);
1320 catch (CoreException& ex)
1322 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1325 newprofiles.push_back(prov);
1328 // New profiles are ok, begin using them
1329 // Old profiles are deleted when their refcount drops to zero
1330 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1332 GnuTLSIOHookProvider& prov = **i;
1333 ServerInstance->Modules.DelService(prov);
1336 profiles.swap(newprofiles);
1342 #ifndef GNUTLS_HAS_RND
1343 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1348 void init() CXX11_OVERRIDE
1350 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1352 ServerInstance->GenRandom = RandGen::Call;
1355 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1364 catch (ModuleException& ex)
1366 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1372 ServerInstance->GenRandom = &InspIRCd::DefaultGenRandom;
1375 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1377 if (type == ExtensionItem::EXT_USER)
1379 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1381 if ((user) && (user->eh.GetModHook(this)))
1383 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1384 // Potentially there could be multiple SSL modules loaded at once on different ports.
1385 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1390 Version GetVersion() CXX11_OVERRIDE
1392 return Version("Provides SSL support for clients", VF_VENDOR);
1395 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1397 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1398 if ((iohook) && (!iohook->IsHandshakeDone()))
1399 return MOD_RES_DENY;
1400 return MOD_RES_PASSTHRU;
1404 MODULE_INIT(ModuleSSLGnuTLS)