2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 John Brooks <john.brooks@dereferenced.net>
6 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /// $CompilerFlags: find_compiler_flags("gnutls")
24 /// $CompilerFlags: require_version("gnutls" "1.0" "2.12") execute("libgcrypt-config --cflags" "LIBGCRYPT_CXXFLAGS")
26 /// $LinkerFlags: find_linker_flags("gnutls" "-lgnutls")
27 /// $LinkerFlags: require_version("gnutls" "1.0" "2.12") execute("libgcrypt-config --libs" "LIBGCRYPT_LDFLAGS")
29 /// $PackageInfo: require_system("centos") gnutls-devel pkgconfig
30 /// $PackageInfo: require_system("darwin") gnutls pkg-config
31 /// $PackageInfo: require_system("debian" "1.0" "7.99") libgcrypt11-dev
32 /// $PackageInfo: require_system("debian") gnutls-bin libgnutls28-dev pkg-config
33 /// $PackageInfo: require_system("ubuntu" "1.0" "13.10") libgcrypt11-dev
34 /// $PackageInfo: require_system("ubuntu") gnutls-bin libgnutls-dev pkg-config
37 #include "modules/ssl.h"
40 // Fix warnings about the use of commas at end of enumerator lists on C++03.
42 # pragma clang diagnostic ignored "-Wc++11-extensions"
43 #elif defined __GNUC__
45 # pragma GCC diagnostic ignored "-pedantic"
47 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
51 #include <gnutls/gnutls.h>
52 #include <gnutls/x509.h>
54 #ifndef GNUTLS_VERSION_NUMBER
55 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
56 #define GNUTLS_VERSION LIBGNUTLS_VERSION
59 // Check if the GnuTLS library is at least version major.minor.patch
60 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
62 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
63 #define GNUTLS_HAS_MAC_GET_ID
64 #include <gnutls/crypto.h>
67 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
68 # define GNUTLS_HAS_RND
74 # pragma comment(lib, "libgnutls-30.lib")
77 // These don't exist in older GnuTLS versions
78 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
79 #define GNUTLS_NEW_PRIO_API
82 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
84 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
85 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
86 #define GNUTLS_NEW_CERT_CALLBACK_API
87 typedef gnutls_retr2_st cert_cb_last_param_type;
89 typedef gnutls_retr_st cert_cb_last_param_type;
92 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
93 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
96 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
97 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
98 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
99 typedef unsigned int inspircd_gnutls_session_init_flags_t;
101 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
104 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
105 #define INSPIRCD_GNUTLS_HAS_CORK
108 static Module* thismod;
113 static void Call(char* buffer, size_t len)
115 #ifdef GNUTLS_HAS_RND
116 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
118 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
128 Init() { gnutls_global_init(); }
129 ~Init() { gnutls_global_deinit(); }
132 class Exception : public ModuleException
135 Exception(const std::string& reason)
136 : ModuleException(reason) { }
139 void ThrowOnError(int errcode, const char* msg)
143 std::string reason = msg;
144 reason.append(" :").append(gnutls_strerror(errcode));
145 throw Exception(reason);
149 /** Used to create a gnutls_datum_t* from a std::string
153 gnutls_datum_t datum;
156 Datum(const std::string& dat)
158 datum.data = (unsigned char*)dat.data();
159 datum.size = static_cast<unsigned int>(dat.length());
162 const gnutls_datum_t* get() const { return &datum; }
167 gnutls_digest_algorithm_t hash;
170 // Nothing to deallocate, constructor may throw freely
171 Hash(const std::string& hashname)
173 // As older versions of gnutls can't do this, let's disable it where needed.
174 #ifdef GNUTLS_HAS_MAC_GET_ID
175 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
176 // There is no gnutls_dig_get_id() at the moment, but it may come later
177 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
178 if (hash == GNUTLS_DIG_UNKNOWN)
179 throw Exception("Unknown hash type " + hashname);
181 // Check if the user is giving us something that is a valid MAC but not digest
182 gnutls_hash_hd_t is_digest;
183 if (gnutls_hash_init(&is_digest, hash) < 0)
184 throw Exception("Unknown hash type " + hashname);
185 gnutls_hash_deinit(is_digest, NULL);
187 if (hashname == "md5")
188 hash = GNUTLS_DIG_MD5;
189 else if (hashname == "sha1")
190 hash = GNUTLS_DIG_SHA1;
191 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
192 else if (hashname == "sha256")
193 hash = GNUTLS_DIG_SHA256;
196 throw Exception("Unknown hash type " + hashname);
200 gnutls_digest_algorithm_t get() const { return hash; }
205 gnutls_dh_params_t dh_params;
209 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
214 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
216 std::auto_ptr<DHParams> dh(new DHParams);
217 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
218 ThrowOnError(ret, "Unable to import DH params");
224 gnutls_dh_params_deinit(dh_params);
227 const gnutls_dh_params_t& get() const { return dh_params; }
232 /** Ensure that the key is deinited in case the constructor of X509Key throws
237 gnutls_x509_privkey_t key;
241 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
246 gnutls_x509_privkey_deinit(key);
252 X509Key(const std::string& keystr)
254 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
255 ThrowOnError(ret, "Unable to import private key");
258 gnutls_x509_privkey_t& get() { return key.key; }
263 std::vector<gnutls_x509_crt_t> certs;
267 X509CertList(const std::string& certstr)
269 unsigned int certcount = 3;
270 certs.resize(certcount);
271 Datum datum(certstr);
273 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
274 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
276 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
277 // try again with a bigger buffer
278 certs.resize(certcount);
279 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
282 ThrowOnError(ret, "Unable to load certificates");
284 // Resize the vector to the actual number of certs because we rely on its size being correct
285 // when deallocating the certs
286 certs.resize(certcount);
291 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
292 gnutls_x509_crt_deinit(*i);
295 gnutls_x509_crt_t* raw() { return &certs[0]; }
296 unsigned int size() const { return certs.size(); }
299 class X509CRL : public refcountbase
304 gnutls_x509_crl_t crl;
308 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
313 gnutls_x509_crl_deinit(crl);
319 X509CRL(const std::string& crlstr)
321 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
322 ThrowOnError(ret, "Unable to load certificate revocation list");
325 gnutls_x509_crl_t& get() { return crl.crl; }
328 #ifdef GNUTLS_NEW_PRIO_API
331 gnutls_priority_t priority;
334 Priority(const std::string& priorities)
336 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
337 // If the user did not supply anything then the string is already set to "NORMAL"
338 const char* priocstr = priorities.c_str();
339 const char* prioerror;
341 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
344 // gnutls did not understand the user supplied string
345 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
351 gnutls_priority_deinit(priority);
354 void SetupSession(gnutls_session_t sess)
356 gnutls_priority_set(sess, priority);
359 static const char* GetDefault()
361 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
364 static std::string RemoveUnknownTokens(const std::string& prio)
367 irc::sepstream ss(prio, ':');
368 for (std::string token; ss.GetToken(token); )
370 // Save current position so we can revert later if needed
371 const std::string::size_type prevpos = ret.length();
377 gnutls_priority_t test;
378 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
380 // The new token broke the priority string, revert to the previously working one
381 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
387 gnutls_priority_deinit(test);
394 /** Dummy class, used when gnutls_priority_set() is not available
399 Priority(const std::string& priorities)
401 if (priorities != GetDefault())
402 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
405 static void SetupSession(gnutls_session_t sess)
407 // Always set the default priorities
408 gnutls_set_default_priority(sess);
411 static const char* GetDefault()
416 static std::string RemoveUnknownTokens(const std::string& prio)
418 // We don't do anything here because only NORMAL is accepted
424 class CertCredentials
426 /** DH parameters associated with these credentials
428 std::auto_ptr<DHParams> dh;
431 gnutls_certificate_credentials_t cred;
436 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
441 gnutls_certificate_free_credentials(cred);
444 /** Associates these credentials with the session
446 void SetupSession(gnutls_session_t sess)
448 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
451 /** Set the given DH parameters to be used with these credentials
453 void SetDH(std::auto_ptr<DHParams>& DH)
456 gnutls_certificate_set_dh_params(cred, dh->get());
460 class X509Credentials : public CertCredentials
466 /** Certificate list, presented to the peer
470 /** Trusted CA, may be NULL
472 std::auto_ptr<X509CertList> trustedca;
474 /** Certificate revocation list, may be NULL
476 std::auto_ptr<X509CRL> crl;
478 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);
481 X509Credentials(const std::string& certstr, const std::string& keystr)
485 // Throwing is ok here, the destructor of Credentials is called in that case
486 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
487 ThrowOnError(ret, "Unable to set cert/key pair");
489 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
490 gnutls_certificate_set_retrieve_function(cred, cert_callback);
492 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
496 /** Sets the trusted CA and the certificate revocation list
497 * to use when verifying certificates
499 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
501 // Do nothing if certlist is NULL
504 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
505 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
509 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
510 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
513 trustedca = certlist;
522 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
523 gnutls_packet_t packet;
526 DataReader(gnutls_session_t sess)
528 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
529 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
530 // to the recvq directly from there in appendto().
531 retval = gnutls_record_recv_packet(sess, &packet);
534 void appendto(std::string& recvq)
536 // Copy data from GnuTLS buffers to recvq
537 gnutls_datum_t datum;
538 gnutls_packet_get(packet, &datum, NULL);
539 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
541 gnutls_packet_deinit(packet);
547 DataReader(gnutls_session_t sess)
548 : buffer(ServerInstance->GetReadBuffer())
550 // Read data from GnuTLS buffers into ReadBuffer
551 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
554 void appendto(std::string& recvq)
556 // Copy data from ReadBuffer to recvq
557 recvq.append(buffer, retval);
561 int ret() const { return retval; }
566 /** Name of this profile
568 const std::string name;
570 /** X509 certificate(s) and key
572 X509Credentials x509cred;
574 /** The minimum length in bits for the DH prime to be accepted as a client
576 unsigned int min_dh_bits;
578 /** Hashing algorithm to use when generating certificate fingerprints
582 /** Priorities for ciphers, compression methods, etc.
586 /** Rough max size of records to send
588 const unsigned int outrecsize;
590 /** True to request a client certificate as a server
592 const bool requestclientcert;
594 static std::string ReadFile(const std::string& filename)
596 FileReader reader(filename);
597 std::string ret = reader.GetString();
599 throw Exception("Cannot read file " + filename);
603 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
605 // Use default priority string if this tag does not specify one
606 std::string priostr = GnuTLS::Priority::GetDefault();
607 bool found = tag->readString("priority", priostr);
608 // 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
609 if (!tag->getBool("strictpriority", found))
611 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
612 if (stripped.empty())
614 // Stripping failed, act as if a prio string wasn't set
615 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
616 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());
618 else if ((found) && (stripped != priostr))
620 // Prio string was set in the config and we ended up with something that works but different
621 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
623 priostr.swap(stripped);
633 std::auto_ptr<X509CertList> ca;
634 std::auto_ptr<X509CRL> crl;
638 std::auto_ptr<DHParams> dh;
644 unsigned int outrecsize;
645 bool requestclientcert;
647 Config(const std::string& profilename, ConfigTag* tag)
649 , certstr(ReadFile(tag->getString("certfile", "cert.pem")))
650 , keystr(ReadFile(tag->getString("keyfile", "key.pem")))
651 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem"))))
652 , priostr(GetPrioStr(profilename, tag))
653 , mindh(tag->getInt("mindhbits", 1024))
654 , hashstr(tag->getString("hash", "md5"))
655 , requestclientcert(tag->getBool("requestclientcert", true))
657 // Load trusted CA and revocation list, if set
658 std::string filename = tag->getString("cafile");
659 if (!filename.empty())
661 ca.reset(new X509CertList(ReadFile(filename)));
663 filename = tag->getString("crlfile");
664 if (!filename.empty())
665 crl.reset(new X509CRL(ReadFile(filename)));
668 #ifdef INSPIRCD_GNUTLS_HAS_CORK
669 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
670 outrecsize = tag->getInt("outrecsize", 2048, 512);
672 outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
677 Profile(Config& config)
679 , x509cred(config.certstr, config.keystr)
680 , min_dh_bits(config.mindh)
681 , hash(config.hashstr)
682 , priority(config.priostr)
683 , outrecsize(config.outrecsize)
684 , requestclientcert(config.requestclientcert)
686 x509cred.SetDH(config.dh);
687 x509cred.SetCA(config.ca, config.crl);
689 /** Set up the given session with the settings in this profile
691 void SetupSession(gnutls_session_t sess)
693 priority.SetupSession(sess);
694 x509cred.SetupSession(sess);
695 gnutls_dh_set_prime_bits(sess, min_dh_bits);
697 // Request client certificate if enabled and we are a server, no-op if we're a client
698 if (requestclientcert)
699 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
702 const std::string& GetName() const { return name; }
703 X509Credentials& GetX509Credentials() { return x509cred; }
704 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
705 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
709 class GnuTLSIOHook : public SSLIOHook
712 gnutls_session_t sess;
714 #ifdef INSPIRCD_GNUTLS_HAS_CORK
722 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
723 gnutls_deinit(this->sess);
730 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
731 int Handshake(StreamSocket* user)
733 int ret = gnutls_handshake(this->sess);
737 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
739 // Handshake needs resuming later, read() or write() would have blocked.
740 this->status = ISSL_HANDSHAKING;
742 if (gnutls_record_get_direction(this->sess) == 0)
744 // gnutls_handshake() wants to read() again.
745 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
749 // gnutls_handshake() wants to write() again.
750 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
757 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
764 // Change the seesion state
765 this->status = ISSL_HANDSHAKEN;
769 // Finish writing, if any left
770 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
776 void VerifyCertificate()
778 unsigned int certstatus;
779 const gnutls_datum_t* cert_list;
781 unsigned int cert_list_size;
782 gnutls_x509_crt_t cert;
784 unsigned char digest[512];
785 size_t digest_size = sizeof(digest);
786 size_t name_size = sizeof(str);
787 ssl_cert* certinfo = new ssl_cert;
788 this->certificate = certinfo;
790 /* This verification function uses the trusted CAs in the credentials
791 * structure. So you must have installed one or more CA certificates.
793 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
797 certinfo->error = std::string(gnutls_strerror(ret));
801 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
802 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
803 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
804 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
806 /* Up to here the process is the same for X.509 certificates and
807 * OpenPGP keys. From now on X.509 certificates are assumed. This can
808 * be easily extended to work with openpgp keys as well.
810 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
812 certinfo->error = "No X509 keys sent";
816 ret = gnutls_x509_crt_init(&cert);
819 certinfo->error = gnutls_strerror(ret);
824 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
825 if (cert_list == NULL)
827 certinfo->error = "No certificate was found";
828 goto info_done_dealloc;
831 /* This is not a real world example, since we only check the first
832 * certificate in the given chain.
835 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
838 certinfo->error = gnutls_strerror(ret);
839 goto info_done_dealloc;
842 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
844 std::string& dn = certinfo->dn;
846 // Make sure there are no chars in the string that we consider invalid
847 if (dn.find_first_of("\r\n") != std::string::npos)
851 name_size = sizeof(str);
852 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
854 std::string& issuer = certinfo->issuer;
856 if (issuer.find_first_of("\r\n") != std::string::npos)
860 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
862 certinfo->error = gnutls_strerror(ret);
866 certinfo->fingerprint = BinToHex(digest, digest_size);
869 /* Beware here we do not check for errors.
871 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
873 certinfo->error = "Not activated, or expired certificate";
877 gnutls_x509_crt_deinit(cert);
880 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
881 int PrepareIO(StreamSocket* sock)
883 if (status == ISSL_HANDSHAKEN)
885 else if (status == ISSL_HANDSHAKING)
887 // The handshake isn't finished, try to finish it
888 return Handshake(sock);
892 sock->SetError("No SSL session");
896 #ifdef INSPIRCD_GNUTLS_HAS_CORK
897 int FlushBuffer(StreamSocket* sock)
899 // If GnuTLS has some data buffered, write it
901 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
906 int HandleWriteRet(StreamSocket* sock, int ret)
910 #ifdef INSPIRCD_GNUTLS_HAS_CORK
914 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
920 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
922 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
927 sock->SetError(gnutls_strerror(ret));
933 static const char* UnknownIfNULL(const char* str)
935 return str ? str : "UNKNOWN";
938 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
940 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
942 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
945 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
948 gnutls_transport_set_errno(session->sess, EAGAIN);
955 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
960 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
961 * and then set errno appropriately.
962 * The gnutls library may also have a different errno variable than us, see
963 * gnutls_transport_set_errno(3).
965 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
970 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
974 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
975 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
977 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
979 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
982 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
985 gnutls_transport_set_errno(session->sess, EAGAIN);
992 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
993 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
995 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
997 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1001 for (int i = 0; i < iovcnt; i++)
1002 size += iov[i].iov_len;
1005 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1009 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1010 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1012 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1014 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1017 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1020 gnutls_transport_set_errno(session->sess, EAGAIN);
1027 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1032 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1033 * and then set errno appropriately.
1034 * The gnutls library may also have a different errno variable than us, see
1035 * gnutls_transport_set_errno(3).
1037 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1042 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1045 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1048 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1049 : SSLIOHook(hookprov)
1052 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1056 gnutls_init(&sess, flags);
1057 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1058 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1059 gnutls_transport_set_vec_push_function(sess, VectorPush);
1061 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1063 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1064 GetProfile().SetupSession(sess);
1066 sock->AddIOHook(this);
1070 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1075 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1077 // Finish handshake if needed
1078 int prepret = PrepareIO(user);
1082 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1084 GnuTLS::DataReader reader(sess);
1085 int ret = reader.ret();
1088 reader.appendto(recvq);
1089 // Schedule a read if there is still data in the GnuTLS buffer
1090 if (gnutls_record_check_pending(sess) > 0)
1091 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1094 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1100 user->SetError("Connection closed");
1106 user->SetError(gnutls_strerror(ret));
1113 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1115 // Finish handshake if needed
1116 int prepret = PrepareIO(user);
1120 // Session is ready for transferring application data
1122 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1125 // If there is something in the GnuTLS buffer try to send() it
1126 int ret = FlushBuffer(user);
1128 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1130 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1134 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1135 gnutls_record_cork(this->sess);
1136 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1138 const StreamSocket::SendQueue::Element& elem = sendq.front();
1139 gbuffersize += elem.length();
1140 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1152 while (!sendq.empty())
1154 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1155 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1156 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1160 else if (ret < (int)buffer.length())
1162 sendq.erase_front(ret);
1163 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1167 // Wrote entire record, continue sending
1172 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1176 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1178 if (!IsHandshakeDone())
1180 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1181 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1182 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1183 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1186 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1188 std::vector<char> nameBuffer;
1189 size_t nameLength = 0;
1190 unsigned int nameType = GNUTLS_NAME_DNS;
1192 // First, determine the size of the hostname.
1193 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1196 // Then retrieve the hostname.
1197 nameBuffer.resize(nameLength);
1198 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1201 out.append(&nameBuffer[0]);
1205 GnuTLS::Profile& GetProfile();
1206 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1209 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)
1211 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1212 st->type = GNUTLS_CRT_X509;
1214 st->cert_type = GNUTLS_CRT_X509;
1215 st->key_type = GNUTLS_PRIVKEY_X509;
1217 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1218 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1220 st->ncerts = cred.certs.size();
1221 st->cert.x509 = cred.certs.raw();
1222 st->key.x509 = cred.key.get();
1228 class GnuTLSIOHookProvider : public IOHookProvider
1230 GnuTLS::Profile profile;
1233 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1234 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1237 ServerInstance->Modules->AddService(*this);
1240 ~GnuTLSIOHookProvider()
1242 ServerInstance->Modules->DelService(*this);
1245 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1247 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1250 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1252 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1255 GnuTLS::Profile& GetProfile() { return profile; }
1258 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1260 IOHookProvider* hookprov = prov;
1261 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1264 class ModuleSSLGnuTLS : public Module
1266 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1268 // First member of the class, gets constructed first and destructed last
1269 GnuTLS::Init libinit;
1270 ProfileList profiles;
1274 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1275 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1276 // avoiding unpleasant situations where no new SSL connections are possible.
1277 ProfileList newprofiles;
1279 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1280 if (tags.first == tags.second)
1282 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1283 const std::string defname = "gnutls";
1284 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1285 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1289 GnuTLS::Profile::Config profileconfig(defname, tag);
1290 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1292 catch (CoreException& ex)
1294 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1298 for (ConfigIter i = tags.first; i != tags.second; ++i)
1300 ConfigTag* tag = i->second;
1301 if (tag->getString("provider") != "gnutls")
1304 std::string name = tag->getString("name");
1307 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1311 reference<GnuTLSIOHookProvider> prov;
1314 GnuTLS::Profile::Config profileconfig(name, tag);
1315 prov = new GnuTLSIOHookProvider(this, profileconfig);
1317 catch (CoreException& ex)
1319 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1322 newprofiles.push_back(prov);
1325 // New profiles are ok, begin using them
1326 // Old profiles are deleted when their refcount drops to zero
1327 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1329 GnuTLSIOHookProvider& prov = **i;
1330 ServerInstance->Modules.DelService(prov);
1333 profiles.swap(newprofiles);
1339 #ifndef GNUTLS_HAS_RND
1340 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1345 void init() CXX11_OVERRIDE
1347 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1349 ServerInstance->GenRandom = RandGen::Call;
1352 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1361 catch (ModuleException& ex)
1363 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1369 ServerInstance->GenRandom = &InspIRCd::DefaultGenRandom;
1372 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1374 if (type == ExtensionItem::EXT_USER)
1376 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1378 if ((user) && (user->eh.GetModHook(this)))
1380 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1381 // Potentially there could be multiple SSL modules loaded at once on different ports.
1382 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1387 Version GetVersion() CXX11_OVERRIDE
1389 return Version("Provides SSL support for clients", VF_VENDOR);
1392 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1394 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1395 if ((iohook) && (!iohook->IsHandshakeDone()))
1396 return MOD_RES_DENY;
1397 return MOD_RES_PASSTHRU;
1401 MODULE_INIT(ModuleSSLGnuTLS)