2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 John Brooks <john.brooks@dereferenced.net>
6 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "modules/ssl.h"
28 // Fix warnings about the use of commas at end of enumerator lists on C++03.
30 # pragma clang diagnostic ignored "-Wc++11-extensions"
31 #elif defined __GNUC__
32 # pragma GCC diagnostic ignored "-pedantic"
35 #include <gnutls/gnutls.h>
36 #include <gnutls/x509.h>
38 #ifndef GNUTLS_VERSION_NUMBER
39 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
40 #define GNUTLS_VERSION LIBGNUTLS_VERSION
43 // Check if the GnuTLS library is at least version major.minor.patch
44 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
46 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
47 #define GNUTLS_HAS_MAC_GET_ID
48 #include <gnutls/crypto.h>
51 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
52 # define GNUTLS_HAS_RND
58 # pragma comment(lib, "libgnutls-28.lib")
61 /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") eval("print `libgcrypt-config --cflags | tr -d \r` if `pkg-config --modversion gnutls 2>/dev/null | tr -d \r` lt '2.12'") */
62 /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") eval("print `libgcrypt-config --libs | tr -d \r` if `pkg-config --modversion gnutls 2>/dev/null | tr -d \r` lt '2.12'") */
64 // These don't exist in older GnuTLS versions
65 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
66 #define GNUTLS_NEW_PRIO_API
69 #if (!INSPIRCD_GNUTLS_HAS_VERSION(2, 0, 0))
70 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
71 typedef gnutls_dh_params_t gnutls_dh_params;
74 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
76 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
77 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
78 #define GNUTLS_NEW_CERT_CALLBACK_API
79 typedef gnutls_retr2_st cert_cb_last_param_type;
81 typedef gnutls_retr_st cert_cb_last_param_type;
84 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
85 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
88 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
89 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
90 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
91 typedef unsigned int inspircd_gnutls_session_init_flags_t;
93 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
96 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
97 #define INSPIRCD_GNUTLS_HAS_CORK
100 class RandGen : public HandlerBase2<void, char*, size_t>
103 void Call(char* buffer, size_t len)
105 #ifdef GNUTLS_HAS_RND
106 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
108 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
118 Init() { gnutls_global_init(); }
119 ~Init() { gnutls_global_deinit(); }
122 class Exception : public ModuleException
125 Exception(const std::string& reason)
126 : ModuleException(reason) { }
129 void ThrowOnError(int errcode, const char* msg)
133 std::string reason = msg;
134 reason.append(" :").append(gnutls_strerror(errcode));
135 throw Exception(reason);
139 /** Used to create a gnutls_datum_t* from a std::string
143 gnutls_datum_t datum;
146 Datum(const std::string& dat)
148 datum.data = (unsigned char*)dat.data();
149 datum.size = static_cast<unsigned int>(dat.length());
152 const gnutls_datum_t* get() const { return &datum; }
157 gnutls_digest_algorithm_t hash;
160 // Nothing to deallocate, constructor may throw freely
161 Hash(const std::string& hashname)
163 // As older versions of gnutls can't do this, let's disable it where needed.
164 #ifdef GNUTLS_HAS_MAC_GET_ID
165 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
166 // There is no gnutls_dig_get_id() at the moment, but it may come later
167 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
168 if (hash == GNUTLS_DIG_UNKNOWN)
169 throw Exception("Unknown hash type " + hashname);
171 // Check if the user is giving us something that is a valid MAC but not digest
172 gnutls_hash_hd_t is_digest;
173 if (gnutls_hash_init(&is_digest, hash) < 0)
174 throw Exception("Unknown hash type " + hashname);
175 gnutls_hash_deinit(is_digest, NULL);
177 if (hashname == "md5")
178 hash = GNUTLS_DIG_MD5;
179 else if (hashname == "sha1")
180 hash = GNUTLS_DIG_SHA1;
181 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
182 else if (hashname == "sha256")
183 hash = GNUTLS_DIG_SHA256;
186 throw Exception("Unknown hash type " + hashname);
190 gnutls_digest_algorithm_t get() const { return hash; }
195 gnutls_dh_params_t dh_params;
199 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
204 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
206 std::auto_ptr<DHParams> dh(new DHParams);
207 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
208 ThrowOnError(ret, "Unable to import DH params");
214 gnutls_dh_params_deinit(dh_params);
217 const gnutls_dh_params_t& get() const { return dh_params; }
222 /** Ensure that the key is deinited in case the constructor of X509Key throws
227 gnutls_x509_privkey_t key;
231 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
236 gnutls_x509_privkey_deinit(key);
242 X509Key(const std::string& keystr)
244 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
245 ThrowOnError(ret, "Unable to import private key");
248 gnutls_x509_privkey_t& get() { return key.key; }
253 std::vector<gnutls_x509_crt_t> certs;
257 X509CertList(const std::string& certstr)
259 unsigned int certcount = 3;
260 certs.resize(certcount);
261 Datum datum(certstr);
263 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
264 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
266 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
267 // try again with a bigger buffer
268 certs.resize(certcount);
269 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
272 ThrowOnError(ret, "Unable to load certificates");
274 // Resize the vector to the actual number of certs because we rely on its size being correct
275 // when deallocating the certs
276 certs.resize(certcount);
281 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
282 gnutls_x509_crt_deinit(*i);
285 gnutls_x509_crt_t* raw() { return &certs[0]; }
286 unsigned int size() const { return certs.size(); }
289 class X509CRL : public refcountbase
294 gnutls_x509_crl_t crl;
298 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
303 gnutls_x509_crl_deinit(crl);
309 X509CRL(const std::string& crlstr)
311 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
312 ThrowOnError(ret, "Unable to load certificate revocation list");
315 gnutls_x509_crl_t& get() { return crl.crl; }
318 #ifdef GNUTLS_NEW_PRIO_API
321 gnutls_priority_t priority;
324 Priority(const std::string& priorities)
326 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
327 // If the user did not supply anything then the string is already set to "NORMAL"
328 const char* priocstr = priorities.c_str();
329 const char* prioerror;
331 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
334 // gnutls did not understand the user supplied string
335 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
341 gnutls_priority_deinit(priority);
344 void SetupSession(gnutls_session_t sess)
346 gnutls_priority_set(sess, priority);
349 static const char* GetDefault()
351 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
354 static std::string RemoveUnknownTokens(const std::string& prio)
357 irc::sepstream ss(prio, ':');
358 for (std::string token; ss.GetToken(token); )
360 // Save current position so we can revert later if needed
361 const std::string::size_type prevpos = ret.length();
367 gnutls_priority_t test;
368 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
370 // The new token broke the priority string, revert to the previously working one
371 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
377 gnutls_priority_deinit(test);
384 /** Dummy class, used when gnutls_priority_set() is not available
389 Priority(const std::string& priorities)
391 if (priorities != GetDefault())
392 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
395 static void SetupSession(gnutls_session_t sess)
397 // Always set the default priorities
398 gnutls_set_default_priority(sess);
401 static const char* GetDefault()
406 static std::string RemoveUnknownTokens(const std::string& prio)
408 // We don't do anything here because only NORMAL is accepted
414 class CertCredentials
416 /** DH parameters associated with these credentials
418 std::auto_ptr<DHParams> dh;
421 gnutls_certificate_credentials_t cred;
426 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
431 gnutls_certificate_free_credentials(cred);
434 /** Associates these credentials with the session
436 void SetupSession(gnutls_session_t sess)
438 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
441 /** Set the given DH parameters to be used with these credentials
443 void SetDH(std::auto_ptr<DHParams>& DH)
446 gnutls_certificate_set_dh_params(cred, dh->get());
450 class X509Credentials : public CertCredentials
456 /** Certificate list, presented to the peer
460 /** Trusted CA, may be NULL
462 std::auto_ptr<X509CertList> trustedca;
464 /** Certificate revocation list, may be NULL
466 std::auto_ptr<X509CRL> crl;
468 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);
471 X509Credentials(const std::string& certstr, const std::string& keystr)
475 // Throwing is ok here, the destructor of Credentials is called in that case
476 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
477 ThrowOnError(ret, "Unable to set cert/key pair");
479 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
480 gnutls_certificate_set_retrieve_function(cred, cert_callback);
482 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
486 /** Sets the trusted CA and the certificate revocation list
487 * to use when verifying certificates
489 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
491 // Do nothing if certlist is NULL
494 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
495 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
499 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
500 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
503 trustedca = certlist;
512 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
513 gnutls_packet_t packet;
516 DataReader(gnutls_session_t sess)
518 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
519 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
520 // to the recvq directly from there in appendto().
521 retval = gnutls_record_recv_packet(sess, &packet);
524 void appendto(std::string& recvq)
526 // Copy data from GnuTLS buffers to recvq
527 gnutls_datum_t datum;
528 gnutls_packet_get(packet, &datum, NULL);
529 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
531 gnutls_packet_deinit(packet);
537 DataReader(gnutls_session_t sess)
538 : buffer(ServerInstance->GetReadBuffer())
540 // Read data from GnuTLS buffers into ReadBuffer
541 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
544 void appendto(std::string& recvq)
546 // Copy data from ReadBuffer to recvq
547 recvq.append(buffer, retval);
551 int ret() const { return retval; }
554 class Profile : public refcountbase
556 /** Name of this profile
558 const std::string name;
560 /** X509 certificate(s) and key
562 X509Credentials x509cred;
564 /** The minimum length in bits for the DH prime to be accepted as a client
566 unsigned int min_dh_bits;
568 /** Hashing algorithm to use when generating certificate fingerprints
572 /** Priorities for ciphers, compression methods, etc.
576 /** Rough max size of records to send
578 const unsigned int outrecsize;
580 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
581 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
582 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL,
583 unsigned int recsize)
585 , x509cred(certstr, keystr)
589 , outrecsize(recsize)
592 x509cred.SetCA(CA, CRL);
595 static std::string ReadFile(const std::string& filename)
597 FileReader reader(filename);
598 std::string ret = reader.GetString();
600 throw Exception("Cannot read file " + filename);
604 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
606 // Use default priority string if this tag does not specify one
607 std::string priostr = GnuTLS::Priority::GetDefault();
608 bool found = tag->readString("priority", priostr);
609 // If the prio string isn't set in the config don't be strict about the default one because it doesn't work on all versions of GnuTLS
610 if (!tag->getBool("strictpriority", found))
612 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
613 if (stripped.empty())
615 // Stripping failed, act as if a prio string wasn't set
616 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
617 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens and stripping it didn't yield a working one either, falling back to \"%s\"", profilename.c_str(), stripped.c_str());
619 else if ((found) && (stripped != priostr))
621 // Prio string was set in the config and we ended up with something that works but different
622 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
624 priostr.swap(stripped);
630 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
632 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
633 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
635 std::auto_ptr<DHParams> dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
637 std::string priostr = GetPrioStr(profilename, tag);
638 unsigned int mindh = tag->getInt("mindhbits", 1024);
639 std::string hashstr = tag->getString("hash", "md5");
641 // Load trusted CA and revocation list, if set
642 std::auto_ptr<X509CertList> ca;
643 std::auto_ptr<X509CRL> crl;
644 std::string filename = tag->getString("cafile");
645 if (!filename.empty())
647 ca.reset(new X509CertList(ReadFile(filename)));
649 filename = tag->getString("crlfile");
650 if (!filename.empty())
651 crl.reset(new X509CRL(ReadFile(filename)));
654 #ifdef INSPIRCD_GNUTLS_HAS_CORK
655 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
656 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512);
658 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
660 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl, outrecsize);
663 /** Set up the given session with the settings in this profile
665 void SetupSession(gnutls_session_t sess)
667 priority.SetupSession(sess);
668 x509cred.SetupSession(sess);
669 gnutls_dh_set_prime_bits(sess, min_dh_bits);
671 // Request client certificate if we are a server, no-op if we're a client
672 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
675 const std::string& GetName() const { return name; }
676 X509Credentials& GetX509Credentials() { return x509cred; }
677 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
678 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
682 class GnuTLSIOHook : public SSLIOHook
685 gnutls_session_t sess;
687 reference<GnuTLS::Profile> profile;
688 #ifdef INSPIRCD_GNUTLS_HAS_CORK
696 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
697 gnutls_deinit(this->sess);
704 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
705 int Handshake(StreamSocket* user)
707 int ret = gnutls_handshake(this->sess);
711 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
713 // Handshake needs resuming later, read() or write() would have blocked.
714 this->status = ISSL_HANDSHAKING;
716 if (gnutls_record_get_direction(this->sess) == 0)
718 // gnutls_handshake() wants to read() again.
719 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
723 // gnutls_handshake() wants to write() again.
724 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
731 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
738 // Change the seesion state
739 this->status = ISSL_HANDSHAKEN;
743 // Finish writing, if any left
744 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
750 void VerifyCertificate()
752 unsigned int certstatus;
753 const gnutls_datum_t* cert_list;
755 unsigned int cert_list_size;
756 gnutls_x509_crt_t cert;
758 unsigned char digest[512];
759 size_t digest_size = sizeof(digest);
760 size_t name_size = sizeof(str);
761 ssl_cert* certinfo = new ssl_cert;
762 this->certificate = certinfo;
764 /* This verification function uses the trusted CAs in the credentials
765 * structure. So you must have installed one or more CA certificates.
767 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
771 certinfo->error = std::string(gnutls_strerror(ret));
775 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
776 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
777 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
778 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
780 /* Up to here the process is the same for X.509 certificates and
781 * OpenPGP keys. From now on X.509 certificates are assumed. This can
782 * be easily extended to work with openpgp keys as well.
784 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
786 certinfo->error = "No X509 keys sent";
790 ret = gnutls_x509_crt_init(&cert);
793 certinfo->error = gnutls_strerror(ret);
798 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
799 if (cert_list == NULL)
801 certinfo->error = "No certificate was found";
802 goto info_done_dealloc;
805 /* This is not a real world example, since we only check the first
806 * certificate in the given chain.
809 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
812 certinfo->error = gnutls_strerror(ret);
813 goto info_done_dealloc;
816 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
818 std::string& dn = certinfo->dn;
820 // Make sure there are no chars in the string that we consider invalid
821 if (dn.find_first_of("\r\n") != std::string::npos)
825 name_size = sizeof(str);
826 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
828 std::string& issuer = certinfo->issuer;
830 if (issuer.find_first_of("\r\n") != std::string::npos)
834 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
836 certinfo->error = gnutls_strerror(ret);
840 certinfo->fingerprint = BinToHex(digest, digest_size);
843 /* Beware here we do not check for errors.
845 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
847 certinfo->error = "Not activated, or expired certificate";
851 gnutls_x509_crt_deinit(cert);
854 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
855 int PrepareIO(StreamSocket* sock)
857 if (status == ISSL_HANDSHAKEN)
859 else if (status == ISSL_HANDSHAKING)
861 // The handshake isn't finished, try to finish it
862 return Handshake(sock);
866 sock->SetError("No SSL session");
870 #ifdef INSPIRCD_GNUTLS_HAS_CORK
871 int FlushBuffer(StreamSocket* sock)
873 // If GnuTLS has some data buffered, write it
875 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
880 int HandleWriteRet(StreamSocket* sock, int ret)
884 #ifdef INSPIRCD_GNUTLS_HAS_CORK
888 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
894 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
896 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
901 sock->SetError(gnutls_strerror(ret));
907 static const char* UnknownIfNULL(const char* str)
909 return str ? str : "UNKNOWN";
912 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
914 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
916 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
919 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
922 gnutls_transport_set_errno(session->sess, EAGAIN);
929 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
934 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
935 * and then set errno appropriately.
936 * The gnutls library may also have a different errno variable than us, see
937 * gnutls_transport_set_errno(3).
939 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
944 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
948 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
949 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
951 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
953 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
956 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
959 gnutls_transport_set_errno(session->sess, EAGAIN);
966 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
967 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
969 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
971 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
975 for (int i = 0; i < iovcnt; i++)
976 size += iov[i].iov_len;
979 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
983 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
984 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
986 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
988 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
991 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
994 gnutls_transport_set_errno(session->sess, EAGAIN);
1001 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1006 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1007 * and then set errno appropriately.
1008 * The gnutls library may also have a different errno variable than us, see
1009 * gnutls_transport_set_errno(3).
1011 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1016 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1019 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1022 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags, const reference<GnuTLS::Profile>& sslprofile)
1023 : SSLIOHook(hookprov)
1026 , profile(sslprofile)
1027 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1031 gnutls_init(&sess, flags);
1032 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1033 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1034 gnutls_transport_set_vec_push_function(sess, VectorPush);
1036 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1038 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1039 profile->SetupSession(sess);
1041 sock->AddIOHook(this);
1045 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1050 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1052 // Finish handshake if needed
1053 int prepret = PrepareIO(user);
1057 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1059 GnuTLS::DataReader reader(sess);
1060 int ret = reader.ret();
1063 reader.appendto(recvq);
1066 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1072 user->SetError("Connection closed");
1078 user->SetError(gnutls_strerror(ret));
1085 int OnStreamSocketWrite(StreamSocket* user) CXX11_OVERRIDE
1087 // Finish handshake if needed
1088 int prepret = PrepareIO(user);
1092 // Session is ready for transferring application data
1093 StreamSocket::SendQueue& sendq = user->GetSendQ();
1095 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1098 // If there is something in the GnuTLS buffer try to send() it
1099 int ret = FlushBuffer(user);
1101 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1103 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1107 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1108 gnutls_record_cork(this->sess);
1109 while ((!sendq.empty()) && (gbuffersize < profile->GetOutgoingRecordSize()))
1111 const StreamSocket::SendQueue::Element& elem = sendq.front();
1112 gbuffersize += elem.length();
1113 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1125 while (!sendq.empty())
1127 FlattenSendQueue(sendq, profile->GetOutgoingRecordSize());
1128 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1129 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1133 else if (ret < (int)buffer.length())
1135 sendq.erase_front(ret);
1136 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1140 // Wrote entire record, continue sending
1145 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1149 void TellCiphersAndFingerprint(LocalUser* user)
1153 std::string text = "*** You are connected using SSL cipher '";
1154 GetCiphersuite(text);
1156 if (!certificate->fingerprint.empty())
1157 text += " and your SSL certificate fingerprint is " + certificate->fingerprint;
1159 user->WriteNotice(text);
1163 void GetCiphersuite(std::string& out) const
1165 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1166 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1167 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1168 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1171 GnuTLS::Profile* GetProfile() { return profile; }
1172 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1175 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)
1177 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1178 st->type = GNUTLS_CRT_X509;
1180 st->cert_type = GNUTLS_CRT_X509;
1181 st->key_type = GNUTLS_PRIVKEY_X509;
1183 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1184 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetIOHook())->GetProfile()->GetX509Credentials();
1186 st->ncerts = cred.certs.size();
1187 st->cert.x509 = cred.certs.raw();
1188 st->key.x509 = cred.key.get();
1194 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1196 reference<GnuTLS::Profile> profile;
1199 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1200 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1203 ServerInstance->Modules->AddService(*this);
1206 ~GnuTLSIOHookProvider()
1208 ServerInstance->Modules->DelService(*this);
1211 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1213 new GnuTLSIOHook(this, sock, GNUTLS_SERVER, profile);
1216 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1218 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT, profile);
1222 class ModuleSSLGnuTLS : public Module
1224 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1226 // First member of the class, gets constructed first and destructed last
1227 GnuTLS::Init libinit;
1228 RandGen randhandler;
1229 ProfileList profiles;
1233 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1234 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1235 // avoiding unpleasant situations where no new SSL connections are possible.
1236 ProfileList newprofiles;
1238 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1239 if (tags.first == tags.second)
1241 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1242 const std::string defname = "gnutls";
1243 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1244 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1248 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1249 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1251 catch (CoreException& ex)
1253 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1257 for (ConfigIter i = tags.first; i != tags.second; ++i)
1259 ConfigTag* tag = i->second;
1260 if (tag->getString("provider") != "gnutls")
1263 std::string name = tag->getString("name");
1266 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1270 reference<GnuTLS::Profile> profile;
1273 profile = GnuTLS::Profile::Create(name, tag);
1275 catch (CoreException& ex)
1277 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1280 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1283 // New profiles are ok, begin using them
1284 // Old profiles are deleted when their refcount drops to zero
1285 profiles.swap(newprofiles);
1291 #ifndef GNUTLS_HAS_RND
1292 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1296 void init() CXX11_OVERRIDE
1298 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1300 ServerInstance->GenRandom = &randhandler;
1303 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1312 catch (ModuleException& ex)
1314 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1320 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1323 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1325 if(target_type == TYPE_USER)
1327 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1329 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
1331 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1332 // Potentially there could be multiple SSL modules loaded at once on different ports.
1333 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1338 Version GetVersion() CXX11_OVERRIDE
1340 return Version("Provides SSL support for clients", VF_VENDOR);
1343 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
1345 IOHook* hook = user->eh.GetIOHook();
1346 if (hook && hook->prov->creator == this)
1347 static_cast<GnuTLSIOHook*>(hook)->TellCiphersAndFingerprint(user);
1350 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1352 if ((user->eh.GetIOHook()) && (user->eh.GetIOHook()->prov->creator == this))
1354 GnuTLSIOHook* iohook = static_cast<GnuTLSIOHook*>(user->eh.GetIOHook());
1355 if (!iohook->IsHandshakeDone())
1356 return MOD_RES_DENY;
1359 return MOD_RES_PASSTHRU;
1363 MODULE_INIT(ModuleSSLGnuTLS)