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__
33 # pragma GCC diagnostic ignored "-pedantic"
35 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
39 #include <gnutls/gnutls.h>
40 #include <gnutls/x509.h>
42 #ifndef GNUTLS_VERSION_NUMBER
43 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
44 #define GNUTLS_VERSION LIBGNUTLS_VERSION
47 // Check if the GnuTLS library is at least version major.minor.patch
48 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
50 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
51 #define GNUTLS_HAS_MAC_GET_ID
52 #include <gnutls/crypto.h>
55 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
56 # define GNUTLS_HAS_RND
62 # pragma comment(lib, "libgnutls-30.lib")
65 /* $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'") */
66 /* $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'") */
68 // These don't exist in older GnuTLS versions
69 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
70 #define GNUTLS_NEW_PRIO_API
73 #if (!INSPIRCD_GNUTLS_HAS_VERSION(2, 0, 0))
74 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
75 typedef gnutls_dh_params_t gnutls_dh_params;
78 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
80 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
81 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
82 #define GNUTLS_NEW_CERT_CALLBACK_API
83 typedef gnutls_retr2_st cert_cb_last_param_type;
85 typedef gnutls_retr_st cert_cb_last_param_type;
88 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
89 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
92 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
93 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
94 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
95 typedef unsigned int inspircd_gnutls_session_init_flags_t;
97 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
100 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
101 #define INSPIRCD_GNUTLS_HAS_CORK
104 class RandGen : public HandlerBase2<void, char*, size_t>
107 void Call(char* buffer, size_t len)
109 #ifdef GNUTLS_HAS_RND
110 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
112 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
122 Init() { gnutls_global_init(); }
123 ~Init() { gnutls_global_deinit(); }
126 class Exception : public ModuleException
129 Exception(const std::string& reason)
130 : ModuleException(reason) { }
133 void ThrowOnError(int errcode, const char* msg)
137 std::string reason = msg;
138 reason.append(" :").append(gnutls_strerror(errcode));
139 throw Exception(reason);
143 /** Used to create a gnutls_datum_t* from a std::string
147 gnutls_datum_t datum;
150 Datum(const std::string& dat)
152 datum.data = (unsigned char*)dat.data();
153 datum.size = static_cast<unsigned int>(dat.length());
156 const gnutls_datum_t* get() const { return &datum; }
161 gnutls_digest_algorithm_t hash;
164 // Nothing to deallocate, constructor may throw freely
165 Hash(const std::string& hashname)
167 // As older versions of gnutls can't do this, let's disable it where needed.
168 #ifdef GNUTLS_HAS_MAC_GET_ID
169 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
170 // There is no gnutls_dig_get_id() at the moment, but it may come later
171 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
172 if (hash == GNUTLS_DIG_UNKNOWN)
173 throw Exception("Unknown hash type " + hashname);
175 // Check if the user is giving us something that is a valid MAC but not digest
176 gnutls_hash_hd_t is_digest;
177 if (gnutls_hash_init(&is_digest, hash) < 0)
178 throw Exception("Unknown hash type " + hashname);
179 gnutls_hash_deinit(is_digest, NULL);
181 if (hashname == "md5")
182 hash = GNUTLS_DIG_MD5;
183 else if (hashname == "sha1")
184 hash = GNUTLS_DIG_SHA1;
185 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
186 else if (hashname == "sha256")
187 hash = GNUTLS_DIG_SHA256;
190 throw Exception("Unknown hash type " + hashname);
194 gnutls_digest_algorithm_t get() const { return hash; }
199 gnutls_dh_params_t dh_params;
203 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
208 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
210 std::auto_ptr<DHParams> dh(new DHParams);
211 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
212 ThrowOnError(ret, "Unable to import DH params");
218 gnutls_dh_params_deinit(dh_params);
221 const gnutls_dh_params_t& get() const { return dh_params; }
226 /** Ensure that the key is deinited in case the constructor of X509Key throws
231 gnutls_x509_privkey_t key;
235 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
240 gnutls_x509_privkey_deinit(key);
246 X509Key(const std::string& keystr)
248 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
249 ThrowOnError(ret, "Unable to import private key");
252 gnutls_x509_privkey_t& get() { return key.key; }
257 std::vector<gnutls_x509_crt_t> certs;
261 X509CertList(const std::string& certstr)
263 unsigned int certcount = 3;
264 certs.resize(certcount);
265 Datum datum(certstr);
267 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
268 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
270 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
271 // try again with a bigger buffer
272 certs.resize(certcount);
273 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
276 ThrowOnError(ret, "Unable to load certificates");
278 // Resize the vector to the actual number of certs because we rely on its size being correct
279 // when deallocating the certs
280 certs.resize(certcount);
285 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
286 gnutls_x509_crt_deinit(*i);
289 gnutls_x509_crt_t* raw() { return &certs[0]; }
290 unsigned int size() const { return certs.size(); }
293 class X509CRL : public refcountbase
298 gnutls_x509_crl_t crl;
302 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
307 gnutls_x509_crl_deinit(crl);
313 X509CRL(const std::string& crlstr)
315 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
316 ThrowOnError(ret, "Unable to load certificate revocation list");
319 gnutls_x509_crl_t& get() { return crl.crl; }
322 #ifdef GNUTLS_NEW_PRIO_API
325 gnutls_priority_t priority;
328 Priority(const std::string& priorities)
330 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
331 // If the user did not supply anything then the string is already set to "NORMAL"
332 const char* priocstr = priorities.c_str();
333 const char* prioerror;
335 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
338 // gnutls did not understand the user supplied string
339 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
345 gnutls_priority_deinit(priority);
348 void SetupSession(gnutls_session_t sess)
350 gnutls_priority_set(sess, priority);
353 static const char* GetDefault()
355 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
358 static std::string RemoveUnknownTokens(const std::string& prio)
361 irc::sepstream ss(prio, ':');
362 for (std::string token; ss.GetToken(token); )
364 // Save current position so we can revert later if needed
365 const std::string::size_type prevpos = ret.length();
371 gnutls_priority_t test;
372 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
374 // The new token broke the priority string, revert to the previously working one
375 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
381 gnutls_priority_deinit(test);
388 /** Dummy class, used when gnutls_priority_set() is not available
393 Priority(const std::string& priorities)
395 if (priorities != GetDefault())
396 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
399 static void SetupSession(gnutls_session_t sess)
401 // Always set the default priorities
402 gnutls_set_default_priority(sess);
405 static const char* GetDefault()
410 static std::string RemoveUnknownTokens(const std::string& prio)
412 // We don't do anything here because only NORMAL is accepted
418 class CertCredentials
420 /** DH parameters associated with these credentials
422 std::auto_ptr<DHParams> dh;
425 gnutls_certificate_credentials_t cred;
430 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
435 gnutls_certificate_free_credentials(cred);
438 /** Associates these credentials with the session
440 void SetupSession(gnutls_session_t sess)
442 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
445 /** Set the given DH parameters to be used with these credentials
447 void SetDH(std::auto_ptr<DHParams>& DH)
450 gnutls_certificate_set_dh_params(cred, dh->get());
454 class X509Credentials : public CertCredentials
460 /** Certificate list, presented to the peer
464 /** Trusted CA, may be NULL
466 std::auto_ptr<X509CertList> trustedca;
468 /** Certificate revocation list, may be NULL
470 std::auto_ptr<X509CRL> crl;
472 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);
475 X509Credentials(const std::string& certstr, const std::string& keystr)
479 // Throwing is ok here, the destructor of Credentials is called in that case
480 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
481 ThrowOnError(ret, "Unable to set cert/key pair");
483 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
484 gnutls_certificate_set_retrieve_function(cred, cert_callback);
486 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
490 /** Sets the trusted CA and the certificate revocation list
491 * to use when verifying certificates
493 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
495 // Do nothing if certlist is NULL
498 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
499 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
503 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
504 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
507 trustedca = certlist;
516 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
517 gnutls_packet_t packet;
520 DataReader(gnutls_session_t sess)
522 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
523 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
524 // to the recvq directly from there in appendto().
525 retval = gnutls_record_recv_packet(sess, &packet);
528 void appendto(std::string& recvq)
530 // Copy data from GnuTLS buffers to recvq
531 gnutls_datum_t datum;
532 gnutls_packet_get(packet, &datum, NULL);
533 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
535 gnutls_packet_deinit(packet);
541 DataReader(gnutls_session_t sess)
542 : buffer(ServerInstance->GetReadBuffer())
544 // Read data from GnuTLS buffers into ReadBuffer
545 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
548 void appendto(std::string& recvq)
550 // Copy data from ReadBuffer to recvq
551 recvq.append(buffer, retval);
555 int ret() const { return retval; }
558 class Profile : public refcountbase
560 /** Name of this profile
562 const std::string name;
564 /** X509 certificate(s) and key
566 X509Credentials x509cred;
568 /** The minimum length in bits for the DH prime to be accepted as a client
570 unsigned int min_dh_bits;
572 /** Hashing algorithm to use when generating certificate fingerprints
576 /** Priorities for ciphers, compression methods, etc.
580 /** Rough max size of records to send
582 const unsigned int outrecsize;
584 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
585 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
586 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL,
587 unsigned int recsize)
589 , x509cred(certstr, keystr)
593 , outrecsize(recsize)
596 x509cred.SetCA(CA, CRL);
599 static std::string ReadFile(const std::string& filename)
601 FileReader reader(filename);
602 std::string ret = reader.GetString();
604 throw Exception("Cannot read file " + filename);
608 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
610 // Use default priority string if this tag does not specify one
611 std::string priostr = GnuTLS::Priority::GetDefault();
612 bool found = tag->readString("priority", priostr);
613 // 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
614 if (!tag->getBool("strictpriority", found))
616 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
617 if (stripped.empty())
619 // Stripping failed, act as if a prio string wasn't set
620 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
621 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());
623 else if ((found) && (stripped != priostr))
625 // Prio string was set in the config and we ended up with something that works but different
626 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
628 priostr.swap(stripped);
634 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
636 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
637 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
639 std::auto_ptr<DHParams> dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
641 std::string priostr = GetPrioStr(profilename, tag);
642 unsigned int mindh = tag->getInt("mindhbits", 1024);
643 std::string hashstr = tag->getString("hash", "md5");
645 // Load trusted CA and revocation list, if set
646 std::auto_ptr<X509CertList> ca;
647 std::auto_ptr<X509CRL> crl;
648 std::string filename = tag->getString("cafile");
649 if (!filename.empty())
651 ca.reset(new X509CertList(ReadFile(filename)));
653 filename = tag->getString("crlfile");
654 if (!filename.empty())
655 crl.reset(new X509CRL(ReadFile(filename)));
658 #ifdef INSPIRCD_GNUTLS_HAS_CORK
659 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
660 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512);
662 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
664 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl, outrecsize);
667 /** Set up the given session with the settings in this profile
669 void SetupSession(gnutls_session_t sess)
671 priority.SetupSession(sess);
672 x509cred.SetupSession(sess);
673 gnutls_dh_set_prime_bits(sess, min_dh_bits);
675 // Request client certificate if we are a server, no-op if we're a client
676 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
679 const std::string& GetName() const { return name; }
680 X509Credentials& GetX509Credentials() { return x509cred; }
681 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
682 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
686 class GnuTLSIOHook : public SSLIOHook
689 gnutls_session_t sess;
691 reference<GnuTLS::Profile> profile;
692 #ifdef INSPIRCD_GNUTLS_HAS_CORK
700 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
701 gnutls_deinit(this->sess);
708 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
709 int Handshake(StreamSocket* user)
711 int ret = gnutls_handshake(this->sess);
715 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
717 // Handshake needs resuming later, read() or write() would have blocked.
718 this->status = ISSL_HANDSHAKING;
720 if (gnutls_record_get_direction(this->sess) == 0)
722 // gnutls_handshake() wants to read() again.
723 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
727 // gnutls_handshake() wants to write() again.
728 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
735 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
742 // Change the seesion state
743 this->status = ISSL_HANDSHAKEN;
747 // Finish writing, if any left
748 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
754 void VerifyCertificate()
756 unsigned int certstatus;
757 const gnutls_datum_t* cert_list;
759 unsigned int cert_list_size;
760 gnutls_x509_crt_t cert;
762 unsigned char digest[512];
763 size_t digest_size = sizeof(digest);
764 size_t name_size = sizeof(str);
765 ssl_cert* certinfo = new ssl_cert;
766 this->certificate = certinfo;
768 /* This verification function uses the trusted CAs in the credentials
769 * structure. So you must have installed one or more CA certificates.
771 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
775 certinfo->error = std::string(gnutls_strerror(ret));
779 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
780 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
781 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
782 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
784 /* Up to here the process is the same for X.509 certificates and
785 * OpenPGP keys. From now on X.509 certificates are assumed. This can
786 * be easily extended to work with openpgp keys as well.
788 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
790 certinfo->error = "No X509 keys sent";
794 ret = gnutls_x509_crt_init(&cert);
797 certinfo->error = gnutls_strerror(ret);
802 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
803 if (cert_list == NULL)
805 certinfo->error = "No certificate was found";
806 goto info_done_dealloc;
809 /* This is not a real world example, since we only check the first
810 * certificate in the given chain.
813 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
816 certinfo->error = gnutls_strerror(ret);
817 goto info_done_dealloc;
820 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
822 std::string& dn = certinfo->dn;
824 // Make sure there are no chars in the string that we consider invalid
825 if (dn.find_first_of("\r\n") != std::string::npos)
829 name_size = sizeof(str);
830 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
832 std::string& issuer = certinfo->issuer;
834 if (issuer.find_first_of("\r\n") != std::string::npos)
838 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
840 certinfo->error = gnutls_strerror(ret);
844 certinfo->fingerprint = BinToHex(digest, digest_size);
847 /* Beware here we do not check for errors.
849 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
851 certinfo->error = "Not activated, or expired certificate";
855 gnutls_x509_crt_deinit(cert);
858 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
859 int PrepareIO(StreamSocket* sock)
861 if (status == ISSL_HANDSHAKEN)
863 else if (status == ISSL_HANDSHAKING)
865 // The handshake isn't finished, try to finish it
866 return Handshake(sock);
870 sock->SetError("No SSL session");
874 #ifdef INSPIRCD_GNUTLS_HAS_CORK
875 int FlushBuffer(StreamSocket* sock)
877 // If GnuTLS has some data buffered, write it
879 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
884 int HandleWriteRet(StreamSocket* sock, int ret)
888 #ifdef INSPIRCD_GNUTLS_HAS_CORK
892 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
898 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
900 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
905 sock->SetError(gnutls_strerror(ret));
911 static const char* UnknownIfNULL(const char* str)
913 return str ? str : "UNKNOWN";
916 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
918 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
920 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
923 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
926 gnutls_transport_set_errno(session->sess, EAGAIN);
933 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
938 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
939 * and then set errno appropriately.
940 * The gnutls library may also have a different errno variable than us, see
941 * gnutls_transport_set_errno(3).
943 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
948 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
952 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
953 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
955 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
957 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
960 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
963 gnutls_transport_set_errno(session->sess, EAGAIN);
970 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
971 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
973 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
975 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
979 for (int i = 0; i < iovcnt; i++)
980 size += iov[i].iov_len;
983 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
987 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
988 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
990 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
992 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
995 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
998 gnutls_transport_set_errno(session->sess, EAGAIN);
1005 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1010 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1011 * and then set errno appropriately.
1012 * The gnutls library may also have a different errno variable than us, see
1013 * gnutls_transport_set_errno(3).
1015 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1020 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1023 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1026 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags, const reference<GnuTLS::Profile>& sslprofile)
1027 : SSLIOHook(hookprov)
1030 , profile(sslprofile)
1031 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1035 gnutls_init(&sess, flags);
1036 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1037 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1038 gnutls_transport_set_vec_push_function(sess, VectorPush);
1040 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1042 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1043 profile->SetupSession(sess);
1045 sock->AddIOHook(this);
1049 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1054 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1056 // Finish handshake if needed
1057 int prepret = PrepareIO(user);
1061 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1063 GnuTLS::DataReader reader(sess);
1064 int ret = reader.ret();
1067 reader.appendto(recvq);
1070 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1076 user->SetError("Connection closed");
1082 user->SetError(gnutls_strerror(ret));
1089 int OnStreamSocketWrite(StreamSocket* user) CXX11_OVERRIDE
1091 // Finish handshake if needed
1092 int prepret = PrepareIO(user);
1096 // Session is ready for transferring application data
1097 StreamSocket::SendQueue& sendq = user->GetSendQ();
1099 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1102 // If there is something in the GnuTLS buffer try to send() it
1103 int ret = FlushBuffer(user);
1105 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1107 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1111 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1112 gnutls_record_cork(this->sess);
1113 while ((!sendq.empty()) && (gbuffersize < profile->GetOutgoingRecordSize()))
1115 const StreamSocket::SendQueue::Element& elem = sendq.front();
1116 gbuffersize += elem.length();
1117 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1129 while (!sendq.empty())
1131 FlattenSendQueue(sendq, profile->GetOutgoingRecordSize());
1132 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1133 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1137 else if (ret < (int)buffer.length())
1139 sendq.erase_front(ret);
1140 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1144 // Wrote entire record, continue sending
1149 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1153 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1155 if (!IsHandshakeDone())
1157 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1158 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1159 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1160 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1163 GnuTLS::Profile* GetProfile() { return profile; }
1164 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1167 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)
1169 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1170 st->type = GNUTLS_CRT_X509;
1172 st->cert_type = GNUTLS_CRT_X509;
1173 st->key_type = GNUTLS_PRIVKEY_X509;
1175 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1176 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetIOHook())->GetProfile()->GetX509Credentials();
1178 st->ncerts = cred.certs.size();
1179 st->cert.x509 = cred.certs.raw();
1180 st->key.x509 = cred.key.get();
1186 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1188 reference<GnuTLS::Profile> profile;
1191 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1192 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1195 ServerInstance->Modules->AddService(*this);
1198 ~GnuTLSIOHookProvider()
1200 ServerInstance->Modules->DelService(*this);
1203 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1205 new GnuTLSIOHook(this, sock, GNUTLS_SERVER, profile);
1208 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1210 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT, profile);
1214 class ModuleSSLGnuTLS : public Module
1216 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1218 // First member of the class, gets constructed first and destructed last
1219 GnuTLS::Init libinit;
1220 RandGen randhandler;
1221 ProfileList profiles;
1225 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1226 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1227 // avoiding unpleasant situations where no new SSL connections are possible.
1228 ProfileList newprofiles;
1230 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1231 if (tags.first == tags.second)
1233 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1234 const std::string defname = "gnutls";
1235 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1236 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1240 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1241 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1243 catch (CoreException& ex)
1245 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1249 for (ConfigIter i = tags.first; i != tags.second; ++i)
1251 ConfigTag* tag = i->second;
1252 if (tag->getString("provider") != "gnutls")
1255 std::string name = tag->getString("name");
1258 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1262 reference<GnuTLS::Profile> profile;
1265 profile = GnuTLS::Profile::Create(name, tag);
1267 catch (CoreException& ex)
1269 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1272 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1275 // New profiles are ok, begin using them
1276 // Old profiles are deleted when their refcount drops to zero
1277 profiles.swap(newprofiles);
1283 #ifndef GNUTLS_HAS_RND
1284 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1288 void init() CXX11_OVERRIDE
1290 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1292 ServerInstance->GenRandom = &randhandler;
1295 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1304 catch (ModuleException& ex)
1306 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1312 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1315 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1317 if(target_type == TYPE_USER)
1319 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1321 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
1323 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1324 // Potentially there could be multiple SSL modules loaded at once on different ports.
1325 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1330 Version GetVersion() CXX11_OVERRIDE
1332 return Version("Provides SSL support for clients", VF_VENDOR);
1335 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1337 if ((user->eh.GetIOHook()) && (user->eh.GetIOHook()->prov->creator == this))
1339 GnuTLSIOHook* iohook = static_cast<GnuTLSIOHook*>(user->eh.GetIOHook());
1340 if (!iohook->IsHandshakeDone())
1341 return MOD_RES_DENY;
1344 return MOD_RES_PASSTHRU;
1348 MODULE_INIT(ModuleSSLGnuTLS)