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("darwin") gnutls pkg-config
30 /// $PackageInfo: require_system("ubuntu" "1.0" "13.10") libgcrypt11-dev
31 /// $PackageInfo: require_system("ubuntu" "14.04") gnutls-bin libgnutls-dev pkg-config
34 #include "modules/ssl.h"
37 // Fix warnings about the use of commas at end of enumerator lists on C++03.
39 # pragma clang diagnostic ignored "-Wc++11-extensions"
40 #elif defined __GNUC__
42 # pragma GCC diagnostic ignored "-pedantic"
44 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
48 #include <gnutls/gnutls.h>
49 #include <gnutls/x509.h>
51 #ifndef GNUTLS_VERSION_NUMBER
52 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
53 #define GNUTLS_VERSION LIBGNUTLS_VERSION
56 // Check if the GnuTLS library is at least version major.minor.patch
57 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
59 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
60 #define GNUTLS_HAS_MAC_GET_ID
61 #include <gnutls/crypto.h>
64 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
65 # define GNUTLS_HAS_RND
71 # pragma comment(lib, "libgnutls-30.lib")
74 // These don't exist in older GnuTLS versions
75 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
76 #define GNUTLS_NEW_PRIO_API
79 #if (!INSPIRCD_GNUTLS_HAS_VERSION(2, 0, 0))
80 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
81 typedef gnutls_dh_params_t gnutls_dh_params;
84 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
86 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
87 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
88 #define GNUTLS_NEW_CERT_CALLBACK_API
89 typedef gnutls_retr2_st cert_cb_last_param_type;
91 typedef gnutls_retr_st cert_cb_last_param_type;
94 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
95 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
98 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
99 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
100 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
101 typedef unsigned int inspircd_gnutls_session_init_flags_t;
103 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
106 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
107 #define INSPIRCD_GNUTLS_HAS_CORK
110 static Module* thismod;
112 class RandGen : public HandlerBase2<void, char*, size_t>
115 void Call(char* buffer, size_t len)
117 #ifdef GNUTLS_HAS_RND
118 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
120 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
130 Init() { gnutls_global_init(); }
131 ~Init() { gnutls_global_deinit(); }
134 class Exception : public ModuleException
137 Exception(const std::string& reason)
138 : ModuleException(reason) { }
141 void ThrowOnError(int errcode, const char* msg)
145 std::string reason = msg;
146 reason.append(" :").append(gnutls_strerror(errcode));
147 throw Exception(reason);
151 /** Used to create a gnutls_datum_t* from a std::string
155 gnutls_datum_t datum;
158 Datum(const std::string& dat)
160 datum.data = (unsigned char*)dat.data();
161 datum.size = static_cast<unsigned int>(dat.length());
164 const gnutls_datum_t* get() const { return &datum; }
169 gnutls_digest_algorithm_t hash;
172 // Nothing to deallocate, constructor may throw freely
173 Hash(const std::string& hashname)
175 // As older versions of gnutls can't do this, let's disable it where needed.
176 #ifdef GNUTLS_HAS_MAC_GET_ID
177 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
178 // There is no gnutls_dig_get_id() at the moment, but it may come later
179 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
180 if (hash == GNUTLS_DIG_UNKNOWN)
181 throw Exception("Unknown hash type " + hashname);
183 // Check if the user is giving us something that is a valid MAC but not digest
184 gnutls_hash_hd_t is_digest;
185 if (gnutls_hash_init(&is_digest, hash) < 0)
186 throw Exception("Unknown hash type " + hashname);
187 gnutls_hash_deinit(is_digest, NULL);
189 if (hashname == "md5")
190 hash = GNUTLS_DIG_MD5;
191 else if (hashname == "sha1")
192 hash = GNUTLS_DIG_SHA1;
193 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
194 else if (hashname == "sha256")
195 hash = GNUTLS_DIG_SHA256;
198 throw Exception("Unknown hash type " + hashname);
202 gnutls_digest_algorithm_t get() const { return hash; }
207 gnutls_dh_params_t dh_params;
211 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
216 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
218 std::auto_ptr<DHParams> dh(new DHParams);
219 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
220 ThrowOnError(ret, "Unable to import DH params");
226 gnutls_dh_params_deinit(dh_params);
229 const gnutls_dh_params_t& get() const { return dh_params; }
234 /** Ensure that the key is deinited in case the constructor of X509Key throws
239 gnutls_x509_privkey_t key;
243 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
248 gnutls_x509_privkey_deinit(key);
254 X509Key(const std::string& keystr)
256 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
257 ThrowOnError(ret, "Unable to import private key");
260 gnutls_x509_privkey_t& get() { return key.key; }
265 std::vector<gnutls_x509_crt_t> certs;
269 X509CertList(const std::string& certstr)
271 unsigned int certcount = 3;
272 certs.resize(certcount);
273 Datum datum(certstr);
275 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
276 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
278 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
279 // try again with a bigger buffer
280 certs.resize(certcount);
281 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
284 ThrowOnError(ret, "Unable to load certificates");
286 // Resize the vector to the actual number of certs because we rely on its size being correct
287 // when deallocating the certs
288 certs.resize(certcount);
293 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
294 gnutls_x509_crt_deinit(*i);
297 gnutls_x509_crt_t* raw() { return &certs[0]; }
298 unsigned int size() const { return certs.size(); }
301 class X509CRL : public refcountbase
306 gnutls_x509_crl_t crl;
310 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
315 gnutls_x509_crl_deinit(crl);
321 X509CRL(const std::string& crlstr)
323 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
324 ThrowOnError(ret, "Unable to load certificate revocation list");
327 gnutls_x509_crl_t& get() { return crl.crl; }
330 #ifdef GNUTLS_NEW_PRIO_API
333 gnutls_priority_t priority;
336 Priority(const std::string& priorities)
338 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
339 // If the user did not supply anything then the string is already set to "NORMAL"
340 const char* priocstr = priorities.c_str();
341 const char* prioerror;
343 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
346 // gnutls did not understand the user supplied string
347 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
353 gnutls_priority_deinit(priority);
356 void SetupSession(gnutls_session_t sess)
358 gnutls_priority_set(sess, priority);
361 static const char* GetDefault()
363 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
366 static std::string RemoveUnknownTokens(const std::string& prio)
369 irc::sepstream ss(prio, ':');
370 for (std::string token; ss.GetToken(token); )
372 // Save current position so we can revert later if needed
373 const std::string::size_type prevpos = ret.length();
379 gnutls_priority_t test;
380 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
382 // The new token broke the priority string, revert to the previously working one
383 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
389 gnutls_priority_deinit(test);
396 /** Dummy class, used when gnutls_priority_set() is not available
401 Priority(const std::string& priorities)
403 if (priorities != GetDefault())
404 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
407 static void SetupSession(gnutls_session_t sess)
409 // Always set the default priorities
410 gnutls_set_default_priority(sess);
413 static const char* GetDefault()
418 static std::string RemoveUnknownTokens(const std::string& prio)
420 // We don't do anything here because only NORMAL is accepted
426 class CertCredentials
428 /** DH parameters associated with these credentials
430 std::auto_ptr<DHParams> dh;
433 gnutls_certificate_credentials_t cred;
438 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
443 gnutls_certificate_free_credentials(cred);
446 /** Associates these credentials with the session
448 void SetupSession(gnutls_session_t sess)
450 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
453 /** Set the given DH parameters to be used with these credentials
455 void SetDH(std::auto_ptr<DHParams>& DH)
458 gnutls_certificate_set_dh_params(cred, dh->get());
462 class X509Credentials : public CertCredentials
468 /** Certificate list, presented to the peer
472 /** Trusted CA, may be NULL
474 std::auto_ptr<X509CertList> trustedca;
476 /** Certificate revocation list, may be NULL
478 std::auto_ptr<X509CRL> crl;
480 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);
483 X509Credentials(const std::string& certstr, const std::string& keystr)
487 // Throwing is ok here, the destructor of Credentials is called in that case
488 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
489 ThrowOnError(ret, "Unable to set cert/key pair");
491 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
492 gnutls_certificate_set_retrieve_function(cred, cert_callback);
494 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
498 /** Sets the trusted CA and the certificate revocation list
499 * to use when verifying certificates
501 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
503 // Do nothing if certlist is NULL
506 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
507 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
511 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
512 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
515 trustedca = certlist;
524 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
525 gnutls_packet_t packet;
528 DataReader(gnutls_session_t sess)
530 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
531 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
532 // to the recvq directly from there in appendto().
533 retval = gnutls_record_recv_packet(sess, &packet);
536 void appendto(std::string& recvq)
538 // Copy data from GnuTLS buffers to recvq
539 gnutls_datum_t datum;
540 gnutls_packet_get(packet, &datum, NULL);
541 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
543 gnutls_packet_deinit(packet);
549 DataReader(gnutls_session_t sess)
550 : buffer(ServerInstance->GetReadBuffer())
552 // Read data from GnuTLS buffers into ReadBuffer
553 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
556 void appendto(std::string& recvq)
558 // Copy data from ReadBuffer to recvq
559 recvq.append(buffer, retval);
563 int ret() const { return retval; }
566 class Profile : public refcountbase
568 /** Name of this profile
570 const std::string name;
572 /** X509 certificate(s) and key
574 X509Credentials x509cred;
576 /** The minimum length in bits for the DH prime to be accepted as a client
578 unsigned int min_dh_bits;
580 /** Hashing algorithm to use when generating certificate fingerprints
584 /** Priorities for ciphers, compression methods, etc.
588 /** Rough max size of records to send
590 const unsigned int outrecsize;
592 /** True to request a client certificate as a server
594 const bool requestclientcert;
596 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
597 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
598 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL,
599 unsigned int recsize, bool Requestclientcert)
601 , x509cred(certstr, keystr)
605 , outrecsize(recsize)
606 , requestclientcert(Requestclientcert)
609 x509cred.SetCA(CA, CRL);
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);
647 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
649 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
650 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
652 std::auto_ptr<DHParams> dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
654 std::string priostr = GetPrioStr(profilename, tag);
655 unsigned int mindh = tag->getInt("mindhbits", 1024);
656 std::string hashstr = tag->getString("hash", "md5");
658 // Load trusted CA and revocation list, if set
659 std::auto_ptr<X509CertList> ca;
660 std::auto_ptr<X509CRL> crl;
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 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512);
675 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
678 const bool requestclientcert = tag->getBool("requestclientcert", true);
680 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl, outrecsize, requestclientcert);
683 /** Set up the given session with the settings in this profile
685 void SetupSession(gnutls_session_t sess)
687 priority.SetupSession(sess);
688 x509cred.SetupSession(sess);
689 gnutls_dh_set_prime_bits(sess, min_dh_bits);
691 // Request client certificate if enabled and we are a server, no-op if we're a client
692 if (requestclientcert)
693 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
696 const std::string& GetName() const { return name; }
697 X509Credentials& GetX509Credentials() { return x509cred; }
698 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
699 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
703 class GnuTLSIOHook : public SSLIOHook
706 gnutls_session_t sess;
708 reference<GnuTLS::Profile> profile;
709 #ifdef INSPIRCD_GNUTLS_HAS_CORK
717 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
718 gnutls_deinit(this->sess);
725 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
726 int Handshake(StreamSocket* user)
728 int ret = gnutls_handshake(this->sess);
732 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
734 // Handshake needs resuming later, read() or write() would have blocked.
735 this->status = ISSL_HANDSHAKING;
737 if (gnutls_record_get_direction(this->sess) == 0)
739 // gnutls_handshake() wants to read() again.
740 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
744 // gnutls_handshake() wants to write() again.
745 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
752 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
759 // Change the seesion state
760 this->status = ISSL_HANDSHAKEN;
764 // Finish writing, if any left
765 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
771 void VerifyCertificate()
773 unsigned int certstatus;
774 const gnutls_datum_t* cert_list;
776 unsigned int cert_list_size;
777 gnutls_x509_crt_t cert;
779 unsigned char digest[512];
780 size_t digest_size = sizeof(digest);
781 size_t name_size = sizeof(str);
782 ssl_cert* certinfo = new ssl_cert;
783 this->certificate = certinfo;
785 /* This verification function uses the trusted CAs in the credentials
786 * structure. So you must have installed one or more CA certificates.
788 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
792 certinfo->error = std::string(gnutls_strerror(ret));
796 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
797 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
798 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
799 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
801 /* Up to here the process is the same for X.509 certificates and
802 * OpenPGP keys. From now on X.509 certificates are assumed. This can
803 * be easily extended to work with openpgp keys as well.
805 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
807 certinfo->error = "No X509 keys sent";
811 ret = gnutls_x509_crt_init(&cert);
814 certinfo->error = gnutls_strerror(ret);
819 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
820 if (cert_list == NULL)
822 certinfo->error = "No certificate was found";
823 goto info_done_dealloc;
826 /* This is not a real world example, since we only check the first
827 * certificate in the given chain.
830 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
833 certinfo->error = gnutls_strerror(ret);
834 goto info_done_dealloc;
837 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
839 std::string& dn = certinfo->dn;
841 // Make sure there are no chars in the string that we consider invalid
842 if (dn.find_first_of("\r\n") != std::string::npos)
846 name_size = sizeof(str);
847 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
849 std::string& issuer = certinfo->issuer;
851 if (issuer.find_first_of("\r\n") != std::string::npos)
855 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
857 certinfo->error = gnutls_strerror(ret);
861 certinfo->fingerprint = BinToHex(digest, digest_size);
864 /* Beware here we do not check for errors.
866 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
868 certinfo->error = "Not activated, or expired certificate";
872 gnutls_x509_crt_deinit(cert);
875 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
876 int PrepareIO(StreamSocket* sock)
878 if (status == ISSL_HANDSHAKEN)
880 else if (status == ISSL_HANDSHAKING)
882 // The handshake isn't finished, try to finish it
883 return Handshake(sock);
887 sock->SetError("No SSL session");
891 #ifdef INSPIRCD_GNUTLS_HAS_CORK
892 int FlushBuffer(StreamSocket* sock)
894 // If GnuTLS has some data buffered, write it
896 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
901 int HandleWriteRet(StreamSocket* sock, int ret)
905 #ifdef INSPIRCD_GNUTLS_HAS_CORK
909 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
915 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
917 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
922 sock->SetError(gnutls_strerror(ret));
928 static const char* UnknownIfNULL(const char* str)
930 return str ? str : "UNKNOWN";
933 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
935 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
937 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
940 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
943 gnutls_transport_set_errno(session->sess, EAGAIN);
950 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
955 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
956 * and then set errno appropriately.
957 * The gnutls library may also have a different errno variable than us, see
958 * gnutls_transport_set_errno(3).
960 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
965 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
969 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
970 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
972 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
974 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
977 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
980 gnutls_transport_set_errno(session->sess, EAGAIN);
987 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
988 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
990 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
992 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
996 for (int i = 0; i < iovcnt; i++)
997 size += iov[i].iov_len;
1000 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1004 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1005 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1007 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1009 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1012 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1015 gnutls_transport_set_errno(session->sess, EAGAIN);
1022 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1027 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1028 * and then set errno appropriately.
1029 * The gnutls library may also have a different errno variable than us, see
1030 * gnutls_transport_set_errno(3).
1032 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1037 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1040 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1043 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags, const reference<GnuTLS::Profile>& sslprofile)
1044 : SSLIOHook(hookprov)
1047 , profile(sslprofile)
1048 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1052 gnutls_init(&sess, flags);
1053 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1054 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1055 gnutls_transport_set_vec_push_function(sess, VectorPush);
1057 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1059 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1060 profile->SetupSession(sess);
1062 sock->AddIOHook(this);
1066 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1071 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1073 // Finish handshake if needed
1074 int prepret = PrepareIO(user);
1078 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1080 GnuTLS::DataReader reader(sess);
1081 int ret = reader.ret();
1084 reader.appendto(recvq);
1085 // Schedule a read if there is still data in the GnuTLS buffer
1086 if (gnutls_record_check_pending(sess) > 0)
1087 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1090 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1096 user->SetError("Connection closed");
1102 user->SetError(gnutls_strerror(ret));
1109 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1111 // Finish handshake if needed
1112 int prepret = PrepareIO(user);
1116 // Session is ready for transferring application data
1118 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1121 // If there is something in the GnuTLS buffer try to send() it
1122 int ret = FlushBuffer(user);
1124 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1126 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1130 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1131 gnutls_record_cork(this->sess);
1132 while ((!sendq.empty()) && (gbuffersize < profile->GetOutgoingRecordSize()))
1134 const StreamSocket::SendQueue::Element& elem = sendq.front();
1135 gbuffersize += elem.length();
1136 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1148 while (!sendq.empty())
1150 FlattenSendQueue(sendq, profile->GetOutgoingRecordSize());
1151 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1152 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1156 else if (ret < (int)buffer.length())
1158 sendq.erase_front(ret);
1159 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1163 // Wrote entire record, continue sending
1168 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1172 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1174 if (!IsHandshakeDone())
1176 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1177 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1178 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1179 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1182 GnuTLS::Profile* GetProfile() { return profile; }
1183 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1186 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)
1188 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1189 st->type = GNUTLS_CRT_X509;
1191 st->cert_type = GNUTLS_CRT_X509;
1192 st->key_type = GNUTLS_PRIVKEY_X509;
1194 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1195 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile()->GetX509Credentials();
1197 st->ncerts = cred.certs.size();
1198 st->cert.x509 = cred.certs.raw();
1199 st->key.x509 = cred.key.get();
1205 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1207 reference<GnuTLS::Profile> profile;
1210 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1211 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1214 ServerInstance->Modules->AddService(*this);
1217 ~GnuTLSIOHookProvider()
1219 ServerInstance->Modules->DelService(*this);
1222 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1224 new GnuTLSIOHook(this, sock, GNUTLS_SERVER, profile);
1227 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1229 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT, profile);
1233 class ModuleSSLGnuTLS : public Module
1235 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1237 // First member of the class, gets constructed first and destructed last
1238 GnuTLS::Init libinit;
1239 RandGen randhandler;
1240 ProfileList profiles;
1244 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1245 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1246 // avoiding unpleasant situations where no new SSL connections are possible.
1247 ProfileList newprofiles;
1249 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1250 if (tags.first == tags.second)
1252 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1253 const std::string defname = "gnutls";
1254 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1255 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1259 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1260 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1262 catch (CoreException& ex)
1264 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1268 for (ConfigIter i = tags.first; i != tags.second; ++i)
1270 ConfigTag* tag = i->second;
1271 if (tag->getString("provider") != "gnutls")
1274 std::string name = tag->getString("name");
1277 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1281 reference<GnuTLS::Profile> profile;
1284 profile = GnuTLS::Profile::Create(name, tag);
1286 catch (CoreException& ex)
1288 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1291 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1294 // New profiles are ok, begin using them
1295 // Old profiles are deleted when their refcount drops to zero
1296 profiles.swap(newprofiles);
1302 #ifndef GNUTLS_HAS_RND
1303 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1308 void init() CXX11_OVERRIDE
1310 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1312 ServerInstance->GenRandom = &randhandler;
1315 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1324 catch (ModuleException& ex)
1326 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1332 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1335 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1337 if(target_type == TYPE_USER)
1339 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1341 if ((user) && (user->eh.GetModHook(this)))
1343 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1344 // Potentially there could be multiple SSL modules loaded at once on different ports.
1345 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1350 Version GetVersion() CXX11_OVERRIDE
1352 return Version("Provides SSL support for clients", VF_VENDOR);
1355 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1357 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1358 if ((iohook) && (!iohook->IsHandshakeDone()))
1359 return MOD_RES_DENY;
1360 return MOD_RES_PASSTHRU;
1364 MODULE_INIT(ModuleSSLGnuTLS)