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"
41 # pragma GCC diagnostic push
44 // Fix warnings about the use of commas at end of enumerator lists on C++03.
46 # pragma clang diagnostic ignored "-Wc++11-extensions"
47 #elif defined __GNUC__
48 # if (__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8))
49 # pragma GCC diagnostic ignored "-Wpedantic"
51 # pragma GCC diagnostic ignored "-pedantic"
55 // Fix warnings about using std::auto_ptr on C++11 or newer.
56 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
58 #include <gnutls/gnutls.h>
59 #include <gnutls/x509.h>
62 # pragma GCC diagnostic pop
65 #ifndef GNUTLS_VERSION_NUMBER
66 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
67 #define GNUTLS_VERSION LIBGNUTLS_VERSION
70 // Check if the GnuTLS library is at least version major.minor.patch
71 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
73 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
74 #define GNUTLS_HAS_MAC_GET_ID
75 #include <gnutls/crypto.h>
78 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
79 # define GNUTLS_HAS_RND
85 # pragma comment(lib, "libgnutls-30.lib")
88 // These don't exist in older GnuTLS versions
89 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
90 #define GNUTLS_NEW_PRIO_API
93 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
95 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
96 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
97 #define GNUTLS_NEW_CERT_CALLBACK_API
98 typedef gnutls_retr2_st cert_cb_last_param_type;
100 typedef gnutls_retr_st cert_cb_last_param_type;
103 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
104 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
107 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
108 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
109 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
110 typedef unsigned int inspircd_gnutls_session_init_flags_t;
112 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
115 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
116 #define INSPIRCD_GNUTLS_HAS_CORK
119 static Module* thismod;
124 static void Call(char* buffer, size_t len)
126 #ifdef GNUTLS_HAS_RND
127 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
129 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
139 Init() { gnutls_global_init(); }
140 ~Init() { gnutls_global_deinit(); }
143 class Exception : public ModuleException
146 Exception(const std::string& reason)
147 : ModuleException(reason) { }
150 void ThrowOnError(int errcode, const char* msg)
154 std::string reason = msg;
155 reason.append(" :").append(gnutls_strerror(errcode));
156 throw Exception(reason);
160 /** Used to create a gnutls_datum_t* from a std::string
164 gnutls_datum_t datum;
167 Datum(const std::string& dat)
169 datum.data = (unsigned char*)dat.data();
170 datum.size = static_cast<unsigned int>(dat.length());
173 const gnutls_datum_t* get() const { return &datum; }
178 gnutls_digest_algorithm_t hash;
181 // Nothing to deallocate, constructor may throw freely
182 Hash(const std::string& hashname)
184 // As older versions of gnutls can't do this, let's disable it where needed.
185 #ifdef GNUTLS_HAS_MAC_GET_ID
186 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
187 // There is no gnutls_dig_get_id() at the moment, but it may come later
188 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
189 if (hash == GNUTLS_DIG_UNKNOWN)
190 throw Exception("Unknown hash type " + hashname);
192 // Check if the user is giving us something that is a valid MAC but not digest
193 gnutls_hash_hd_t is_digest;
194 if (gnutls_hash_init(&is_digest, hash) < 0)
195 throw Exception("Unknown hash type " + hashname);
196 gnutls_hash_deinit(is_digest, NULL);
198 if (stdalgo::string::equalsci(hashname, "md5"))
199 hash = GNUTLS_DIG_MD5;
200 else if (stdalgo::string::equalsci(hashname, "sha1"))
201 hash = GNUTLS_DIG_SHA1;
202 else if (stdalgo::string::equalsci(hashname, "sha256"))
203 hash = GNUTLS_DIG_SHA256;
205 throw Exception("Unknown hash type " + hashname);
209 gnutls_digest_algorithm_t get() const { return hash; }
214 gnutls_dh_params_t dh_params;
218 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
223 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
225 std::auto_ptr<DHParams> dh(new DHParams);
226 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
227 ThrowOnError(ret, "Unable to import DH params");
233 gnutls_dh_params_deinit(dh_params);
236 const gnutls_dh_params_t& get() const { return dh_params; }
241 /** Ensure that the key is deinited in case the constructor of X509Key throws
246 gnutls_x509_privkey_t key;
250 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
255 gnutls_x509_privkey_deinit(key);
261 X509Key(const std::string& keystr)
263 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
264 ThrowOnError(ret, "Unable to import private key");
267 gnutls_x509_privkey_t& get() { return key.key; }
272 std::vector<gnutls_x509_crt_t> certs;
276 X509CertList(const std::string& certstr)
278 unsigned int certcount = 3;
279 certs.resize(certcount);
280 Datum datum(certstr);
282 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
283 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
285 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
286 // try again with a bigger buffer
287 certs.resize(certcount);
288 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
291 ThrowOnError(ret, "Unable to load certificates");
293 // Resize the vector to the actual number of certs because we rely on its size being correct
294 // when deallocating the certs
295 certs.resize(certcount);
300 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
301 gnutls_x509_crt_deinit(*i);
304 gnutls_x509_crt_t* raw() { return &certs[0]; }
305 unsigned int size() const { return certs.size(); }
308 class X509CRL : public refcountbase
313 gnutls_x509_crl_t crl;
317 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
322 gnutls_x509_crl_deinit(crl);
328 X509CRL(const std::string& crlstr)
330 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
331 ThrowOnError(ret, "Unable to load certificate revocation list");
334 gnutls_x509_crl_t& get() { return crl.crl; }
337 #ifdef GNUTLS_NEW_PRIO_API
340 gnutls_priority_t priority;
343 Priority(const std::string& priorities)
345 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
346 // If the user did not supply anything then the string is already set to "NORMAL"
347 const char* priocstr = priorities.c_str();
348 const char* prioerror;
350 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
353 // gnutls did not understand the user supplied string
354 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
360 gnutls_priority_deinit(priority);
363 void SetupSession(gnutls_session_t sess)
365 gnutls_priority_set(sess, priority);
368 static const char* GetDefault()
370 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
373 static std::string RemoveUnknownTokens(const std::string& prio)
376 irc::sepstream ss(prio, ':');
377 for (std::string token; ss.GetToken(token); )
379 // Save current position so we can revert later if needed
380 const std::string::size_type prevpos = ret.length();
386 gnutls_priority_t test;
387 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
389 // The new token broke the priority string, revert to the previously working one
390 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
396 gnutls_priority_deinit(test);
403 /** Dummy class, used when gnutls_priority_set() is not available
408 Priority(const std::string& priorities)
410 if (priorities != GetDefault())
411 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
414 static void SetupSession(gnutls_session_t sess)
416 // Always set the default priorities
417 gnutls_set_default_priority(sess);
420 static const char* GetDefault()
425 static std::string RemoveUnknownTokens(const std::string& prio)
427 // We don't do anything here because only NORMAL is accepted
433 class CertCredentials
435 /** DH parameters associated with these credentials
437 std::auto_ptr<DHParams> dh;
440 gnutls_certificate_credentials_t cred;
445 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
450 gnutls_certificate_free_credentials(cred);
453 /** Associates these credentials with the session
455 void SetupSession(gnutls_session_t sess)
457 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
460 /** Set the given DH parameters to be used with these credentials
462 void SetDH(std::auto_ptr<DHParams>& DH)
465 gnutls_certificate_set_dh_params(cred, dh->get());
469 class X509Credentials : public CertCredentials
475 /** Certificate list, presented to the peer
479 /** Trusted CA, may be NULL
481 std::auto_ptr<X509CertList> trustedca;
483 /** Certificate revocation list, may be NULL
485 std::auto_ptr<X509CRL> crl;
487 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);
490 X509Credentials(const std::string& certstr, const std::string& keystr)
494 // Throwing is ok here, the destructor of Credentials is called in that case
495 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
496 ThrowOnError(ret, "Unable to set cert/key pair");
498 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
499 gnutls_certificate_set_retrieve_function(cred, cert_callback);
501 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
505 /** Sets the trusted CA and the certificate revocation list
506 * to use when verifying certificates
508 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
510 // Do nothing if certlist is NULL
513 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
514 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
518 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
519 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
522 trustedca = certlist;
531 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
532 gnutls_packet_t packet;
535 DataReader(gnutls_session_t sess)
537 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
538 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
539 // to the recvq directly from there in appendto().
540 retval = gnutls_record_recv_packet(sess, &packet);
543 void appendto(std::string& recvq)
545 // Copy data from GnuTLS buffers to recvq
546 gnutls_datum_t datum;
547 gnutls_packet_get(packet, &datum, NULL);
548 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
550 gnutls_packet_deinit(packet);
556 DataReader(gnutls_session_t sess)
557 : buffer(ServerInstance->GetReadBuffer())
559 // Read data from GnuTLS buffers into ReadBuffer
560 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
563 void appendto(std::string& recvq)
565 // Copy data from ReadBuffer to recvq
566 recvq.append(buffer, retval);
570 int ret() const { return retval; }
575 /** Name of this profile
577 const std::string name;
579 /** X509 certificate(s) and key
581 X509Credentials x509cred;
583 /** The minimum length in bits for the DH prime to be accepted as a client
585 unsigned int min_dh_bits;
587 /** Hashing algorithm to use when generating certificate fingerprints
591 /** Priorities for ciphers, compression methods, etc.
595 /** Rough max size of records to send
597 const unsigned int outrecsize;
599 /** True to request a client certificate as a server
601 const bool requestclientcert;
603 static std::string ReadFile(const std::string& filename)
605 FileReader reader(filename);
606 std::string ret = reader.GetString();
608 throw Exception("Cannot read file " + filename);
612 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
614 // Use default priority string if this tag does not specify one
615 std::string priostr = GnuTLS::Priority::GetDefault();
616 bool found = tag->readString("priority", priostr);
617 // 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
618 if (!tag->getBool("strictpriority", found))
620 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
621 if (stripped.empty())
623 // Stripping failed, act as if a prio string wasn't set
624 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
625 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());
627 else if ((found) && (stripped != priostr))
629 // Prio string was set in the config and we ended up with something that works but different
630 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
632 priostr.swap(stripped);
642 std::auto_ptr<X509CertList> ca;
643 std::auto_ptr<X509CRL> crl;
647 std::auto_ptr<DHParams> dh;
653 unsigned int outrecsize;
654 bool requestclientcert;
656 Config(const std::string& profilename, ConfigTag* tag)
658 , certstr(ReadFile(tag->getString("certfile", "cert.pem")))
659 , keystr(ReadFile(tag->getString("keyfile", "key.pem")))
660 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem"))))
661 , priostr(GetPrioStr(profilename, tag))
662 , mindh(tag->getUInt("mindhbits", 1024))
663 , hashstr(tag->getString("hash", "md5"))
664 , requestclientcert(tag->getBool("requestclientcert", true))
666 // Load trusted CA and revocation list, if set
667 std::string filename = tag->getString("cafile");
668 if (!filename.empty())
670 ca.reset(new X509CertList(ReadFile(filename)));
672 filename = tag->getString("crlfile");
673 if (!filename.empty())
674 crl.reset(new X509CRL(ReadFile(filename)));
677 #ifdef INSPIRCD_GNUTLS_HAS_CORK
678 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
679 outrecsize = tag->getUInt("outrecsize", 2048, 512);
681 outrecsize = tag->getUInt("outrecsize", 2048, 512, 16384);
686 Profile(Config& config)
688 , x509cred(config.certstr, config.keystr)
689 , min_dh_bits(config.mindh)
690 , hash(config.hashstr)
691 , priority(config.priostr)
692 , outrecsize(config.outrecsize)
693 , requestclientcert(config.requestclientcert)
695 x509cred.SetDH(config.dh);
696 x509cred.SetCA(config.ca, config.crl);
698 /** Set up the given session with the settings in this profile
700 void SetupSession(gnutls_session_t sess)
702 priority.SetupSession(sess);
703 x509cred.SetupSession(sess);
704 gnutls_dh_set_prime_bits(sess, min_dh_bits);
706 // Request client certificate if enabled and we are a server, no-op if we're a client
707 if (requestclientcert)
708 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
711 const std::string& GetName() const { return name; }
712 X509Credentials& GetX509Credentials() { return x509cred; }
713 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
714 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
718 class GnuTLSIOHook : public SSLIOHook
721 gnutls_session_t sess;
723 #ifdef INSPIRCD_GNUTLS_HAS_CORK
731 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
732 gnutls_deinit(this->sess);
739 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
740 int Handshake(StreamSocket* user)
742 int ret = gnutls_handshake(this->sess);
746 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
748 // Handshake needs resuming later, read() or write() would have blocked.
749 this->status = ISSL_HANDSHAKING;
751 if (gnutls_record_get_direction(this->sess) == 0)
753 // gnutls_handshake() wants to read() again.
754 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
758 // gnutls_handshake() wants to write() again.
759 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
766 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
773 // Change the seesion state
774 this->status = ISSL_HANDSHAKEN;
778 // Finish writing, if any left
779 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
785 void VerifyCertificate()
787 unsigned int certstatus;
788 const gnutls_datum_t* cert_list;
790 unsigned int cert_list_size;
791 gnutls_x509_crt_t cert;
793 unsigned char digest[512];
794 size_t digest_size = sizeof(digest);
795 size_t name_size = sizeof(str);
796 ssl_cert* certinfo = new ssl_cert;
797 this->certificate = certinfo;
799 /* This verification function uses the trusted CAs in the credentials
800 * structure. So you must have installed one or more CA certificates.
802 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
806 certinfo->error = std::string(gnutls_strerror(ret));
810 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
811 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
812 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
813 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
815 /* Up to here the process is the same for X.509 certificates and
816 * OpenPGP keys. From now on X.509 certificates are assumed. This can
817 * be easily extended to work with openpgp keys as well.
819 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
821 certinfo->error = "No X509 keys sent";
825 ret = gnutls_x509_crt_init(&cert);
828 certinfo->error = gnutls_strerror(ret);
833 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
834 if (cert_list == NULL)
836 certinfo->error = "No certificate was found";
837 goto info_done_dealloc;
840 /* This is not a real world example, since we only check the first
841 * certificate in the given chain.
844 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
847 certinfo->error = gnutls_strerror(ret);
848 goto info_done_dealloc;
851 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
853 std::string& dn = certinfo->dn;
855 // Make sure there are no chars in the string that we consider invalid
856 if (dn.find_first_of("\r\n") != std::string::npos)
860 name_size = sizeof(str);
861 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
863 std::string& issuer = certinfo->issuer;
865 if (issuer.find_first_of("\r\n") != std::string::npos)
869 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
871 certinfo->error = gnutls_strerror(ret);
875 certinfo->fingerprint = BinToHex(digest, digest_size);
878 /* Beware here we do not check for errors.
880 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
882 certinfo->error = "Not activated, or expired certificate";
886 gnutls_x509_crt_deinit(cert);
889 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
890 int PrepareIO(StreamSocket* sock)
892 if (status == ISSL_HANDSHAKEN)
894 else if (status == ISSL_HANDSHAKING)
896 // The handshake isn't finished, try to finish it
897 return Handshake(sock);
901 sock->SetError("No SSL session");
905 #ifdef INSPIRCD_GNUTLS_HAS_CORK
906 int FlushBuffer(StreamSocket* sock)
908 // If GnuTLS has some data buffered, write it
910 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
915 int HandleWriteRet(StreamSocket* sock, int ret)
919 #ifdef INSPIRCD_GNUTLS_HAS_CORK
923 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
929 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
931 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
936 sock->SetError(gnutls_strerror(ret));
942 static const char* UnknownIfNULL(const char* str)
944 return str ? str : "UNKNOWN";
947 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
949 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
951 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
954 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
957 gnutls_transport_set_errno(session->sess, EAGAIN);
964 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
969 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
970 * and then set errno appropriately.
971 * The gnutls library may also have a different errno variable than us, see
972 * gnutls_transport_set_errno(3).
974 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
979 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
983 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
984 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
986 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
988 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
991 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
994 gnutls_transport_set_errno(session->sess, EAGAIN);
1001 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
1002 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
1004 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
1006 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1010 for (int i = 0; i < iovcnt; i++)
1011 size += iov[i].iov_len;
1014 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1018 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1019 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1021 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1023 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1026 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1029 gnutls_transport_set_errno(session->sess, EAGAIN);
1036 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1041 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1042 * and then set errno appropriately.
1043 * The gnutls library may also have a different errno variable than us, see
1044 * gnutls_transport_set_errno(3).
1046 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1051 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1054 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1057 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1058 : SSLIOHook(hookprov)
1061 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1065 gnutls_init(&sess, flags);
1066 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1067 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1068 gnutls_transport_set_vec_push_function(sess, VectorPush);
1070 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1072 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1073 GetProfile().SetupSession(sess);
1075 sock->AddIOHook(this);
1079 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1084 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1086 // Finish handshake if needed
1087 int prepret = PrepareIO(user);
1091 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1093 GnuTLS::DataReader reader(sess);
1094 int ret = reader.ret();
1097 reader.appendto(recvq);
1098 // Schedule a read if there is still data in the GnuTLS buffer
1099 if (gnutls_record_check_pending(sess) > 0)
1100 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1103 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1109 user->SetError("Connection closed");
1115 user->SetError(gnutls_strerror(ret));
1122 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1124 // Finish handshake if needed
1125 int prepret = PrepareIO(user);
1129 // Session is ready for transferring application data
1131 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1134 // If there is something in the GnuTLS buffer try to send() it
1135 int ret = FlushBuffer(user);
1137 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1139 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1143 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1144 gnutls_record_cork(this->sess);
1145 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1147 const StreamSocket::SendQueue::Element& elem = sendq.front();
1148 gbuffersize += elem.length();
1149 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1161 while (!sendq.empty())
1163 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1164 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1165 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1169 else if (ret < (int)buffer.length())
1171 sendq.erase_front(ret);
1172 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1176 // Wrote entire record, continue sending
1181 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1185 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1187 if (!IsHandshakeDone())
1189 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1190 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1191 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1192 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1195 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1197 std::vector<char> nameBuffer;
1198 size_t nameLength = 0;
1199 unsigned int nameType = GNUTLS_NAME_DNS;
1201 // First, determine the size of the hostname.
1202 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1205 // Then retrieve the hostname.
1206 nameBuffer.resize(nameLength);
1207 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1210 out.append(&nameBuffer[0]);
1214 GnuTLS::Profile& GetProfile();
1215 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1218 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)
1220 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1221 st->type = GNUTLS_CRT_X509;
1223 st->cert_type = GNUTLS_CRT_X509;
1224 st->key_type = GNUTLS_PRIVKEY_X509;
1226 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1227 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1229 st->ncerts = cred.certs.size();
1230 st->cert.x509 = cred.certs.raw();
1231 st->key.x509 = cred.key.get();
1237 class GnuTLSIOHookProvider : public IOHookProvider
1239 GnuTLS::Profile profile;
1242 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1243 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1246 ServerInstance->Modules->AddService(*this);
1249 ~GnuTLSIOHookProvider()
1251 ServerInstance->Modules->DelService(*this);
1254 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1256 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1259 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1261 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1264 GnuTLS::Profile& GetProfile() { return profile; }
1267 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1269 IOHookProvider* hookprov = prov;
1270 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1273 class ModuleSSLGnuTLS : public Module
1275 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1277 // First member of the class, gets constructed first and destructed last
1278 GnuTLS::Init libinit;
1279 ProfileList profiles;
1283 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1284 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1285 // avoiding unpleasant situations where no new SSL connections are possible.
1286 ProfileList newprofiles;
1288 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1289 if (tags.first == tags.second)
1291 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1292 const std::string defname = "gnutls";
1293 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1294 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1298 GnuTLS::Profile::Config profileconfig(defname, tag);
1299 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1301 catch (CoreException& ex)
1303 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1307 for (ConfigIter i = tags.first; i != tags.second; ++i)
1309 ConfigTag* tag = i->second;
1310 if (!stdalgo::string::equalsci(tag->getString("provider"), "gnutls"))
1313 std::string name = tag->getString("name");
1316 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1320 reference<GnuTLSIOHookProvider> prov;
1323 GnuTLS::Profile::Config profileconfig(name, tag);
1324 prov = new GnuTLSIOHookProvider(this, profileconfig);
1326 catch (CoreException& ex)
1328 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1331 newprofiles.push_back(prov);
1334 // New profiles are ok, begin using them
1335 // Old profiles are deleted when their refcount drops to zero
1336 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1338 GnuTLSIOHookProvider& prov = **i;
1339 ServerInstance->Modules.DelService(prov);
1342 profiles.swap(newprofiles);
1348 #ifndef GNUTLS_HAS_RND
1349 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1354 void init() CXX11_OVERRIDE
1356 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1358 ServerInstance->GenRandom = RandGen::Call;
1361 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1370 catch (ModuleException& ex)
1372 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1378 ServerInstance->GenRandom = &InspIRCd::DefaultGenRandom;
1381 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1383 if (type == ExtensionItem::EXT_USER)
1385 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1387 if ((user) && (user->eh.GetModHook(this)))
1389 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1390 // Potentially there could be multiple SSL modules loaded at once on different ports.
1391 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1396 Version GetVersion() CXX11_OVERRIDE
1398 return Version("Provides SSL support via GnuTLS", VF_VENDOR);
1401 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1403 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1404 if ((iohook) && (!iohook->IsHandshakeDone()))
1405 return MOD_RES_DENY;
1406 return MOD_RES_PASSTHRU;
1410 MODULE_INIT(ModuleSSLGnuTLS)