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("arch") gnutls pkgconf
30 /// $PackageInfo: require_system("centos") gnutls-devel pkgconfig
31 /// $PackageInfo: require_system("darwin") gnutls pkg-config
32 /// $PackageInfo: require_system("debian") gnutls-bin libgnutls28-dev pkg-config
33 /// $PackageInfo: require_system("ubuntu") gnutls-bin libgnutls-dev pkg-config
36 #include "modules/ssl.h"
40 # pragma GCC diagnostic push
43 // Fix warnings about the use of commas at end of enumerator lists on C++03.
45 # pragma clang diagnostic ignored "-Wc++11-extensions"
46 #elif defined __GNUC__
47 # if (__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8))
48 # pragma GCC diagnostic ignored "-Wpedantic"
50 # pragma GCC diagnostic ignored "-pedantic"
54 #include <gnutls/gnutls.h>
55 #include <gnutls/x509.h>
58 # pragma GCC diagnostic pop
61 // Fix warnings about using std::auto_ptr on C++11 or newer.
62 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
64 #ifndef GNUTLS_VERSION_NUMBER
65 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
66 #define GNUTLS_VERSION LIBGNUTLS_VERSION
69 // Check if the GnuTLS library is at least version major.minor.patch
70 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
72 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
73 #define GNUTLS_HAS_MAC_GET_ID
74 #include <gnutls/crypto.h>
77 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
78 # define GNUTLS_HAS_RND
84 # pragma comment(lib, "libgnutls-30.lib")
87 // These don't exist in older GnuTLS versions
88 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
89 #define GNUTLS_NEW_PRIO_API
92 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
94 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
95 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
96 #define GNUTLS_NEW_CERT_CALLBACK_API
97 typedef gnutls_retr2_st cert_cb_last_param_type;
99 typedef gnutls_retr_st cert_cb_last_param_type;
102 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
103 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
106 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
107 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
108 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
109 typedef unsigned int inspircd_gnutls_session_init_flags_t;
111 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
114 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
115 #define INSPIRCD_GNUTLS_HAS_CORK
118 static Module* thismod;
123 static void Call(char* buffer, size_t len)
125 #ifdef GNUTLS_HAS_RND
126 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
128 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
138 Init() { gnutls_global_init(); }
139 ~Init() { gnutls_global_deinit(); }
142 class Exception : public ModuleException
145 Exception(const std::string& reason)
146 : ModuleException(reason) { }
149 void ThrowOnError(int errcode, const char* msg)
153 std::string reason = msg;
154 reason.append(" :").append(gnutls_strerror(errcode));
155 throw Exception(reason);
159 /** Used to create a gnutls_datum_t* from a std::string
163 gnutls_datum_t datum;
166 Datum(const std::string& dat)
168 datum.data = (unsigned char*)dat.data();
169 datum.size = static_cast<unsigned int>(dat.length());
172 const gnutls_datum_t* get() const { return &datum; }
177 gnutls_digest_algorithm_t hash;
180 // Nothing to deallocate, constructor may throw freely
181 Hash(const std::string& hashname)
183 // As older versions of gnutls can't do this, let's disable it where needed.
184 #ifdef GNUTLS_HAS_MAC_GET_ID
185 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
186 // There is no gnutls_dig_get_id() at the moment, but it may come later
187 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
188 if (hash == GNUTLS_DIG_UNKNOWN)
189 throw Exception("Unknown hash type " + hashname);
191 // Check if the user is giving us something that is a valid MAC but not digest
192 gnutls_hash_hd_t is_digest;
193 if (gnutls_hash_init(&is_digest, hash) < 0)
194 throw Exception("Unknown hash type " + hashname);
195 gnutls_hash_deinit(is_digest, NULL);
197 if (stdalgo::string::equalsci(hashname, "md5"))
198 hash = GNUTLS_DIG_MD5;
199 else if (stdalgo::string::equalsci(hashname, "sha1"))
200 hash = GNUTLS_DIG_SHA1;
201 else if (stdalgo::string::equalsci(hashname, "sha256"))
202 hash = GNUTLS_DIG_SHA256;
204 throw Exception("Unknown hash type " + hashname);
208 gnutls_digest_algorithm_t get() const { return hash; }
213 gnutls_dh_params_t dh_params;
217 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
222 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
224 std::auto_ptr<DHParams> dh(new DHParams);
225 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
226 ThrowOnError(ret, "Unable to import DH params");
232 gnutls_dh_params_deinit(dh_params);
235 const gnutls_dh_params_t& get() const { return dh_params; }
240 /** Ensure that the key is deinited in case the constructor of X509Key throws
245 gnutls_x509_privkey_t key;
249 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
254 gnutls_x509_privkey_deinit(key);
260 X509Key(const std::string& keystr)
262 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
263 ThrowOnError(ret, "Unable to import private key");
266 gnutls_x509_privkey_t& get() { return key.key; }
271 std::vector<gnutls_x509_crt_t> certs;
275 X509CertList(const std::string& certstr)
277 unsigned int certcount = 3;
278 certs.resize(certcount);
279 Datum datum(certstr);
281 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
282 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
284 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
285 // try again with a bigger buffer
286 certs.resize(certcount);
287 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
290 ThrowOnError(ret, "Unable to load certificates");
292 // Resize the vector to the actual number of certs because we rely on its size being correct
293 // when deallocating the certs
294 certs.resize(certcount);
299 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
300 gnutls_x509_crt_deinit(*i);
303 gnutls_x509_crt_t* raw() { return &certs[0]; }
304 unsigned int size() const { return certs.size(); }
307 class X509CRL : public refcountbase
312 gnutls_x509_crl_t crl;
316 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
321 gnutls_x509_crl_deinit(crl);
327 X509CRL(const std::string& crlstr)
329 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
330 ThrowOnError(ret, "Unable to load certificate revocation list");
333 gnutls_x509_crl_t& get() { return crl.crl; }
336 #ifdef GNUTLS_NEW_PRIO_API
339 gnutls_priority_t priority;
342 Priority(const std::string& priorities)
344 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
345 // If the user did not supply anything then the string is already set to "NORMAL"
346 const char* priocstr = priorities.c_str();
347 const char* prioerror;
349 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
352 // gnutls did not understand the user supplied string
353 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
359 gnutls_priority_deinit(priority);
362 void SetupSession(gnutls_session_t sess)
364 gnutls_priority_set(sess, priority);
367 static const char* GetDefault()
369 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
372 static std::string RemoveUnknownTokens(const std::string& prio)
375 irc::sepstream ss(prio, ':');
376 for (std::string token; ss.GetToken(token); )
378 // Save current position so we can revert later if needed
379 const std::string::size_type prevpos = ret.length();
385 gnutls_priority_t test;
386 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
388 // The new token broke the priority string, revert to the previously working one
389 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
395 gnutls_priority_deinit(test);
402 /** Dummy class, used when gnutls_priority_set() is not available
407 Priority(const std::string& priorities)
409 if (priorities != GetDefault())
410 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
413 static void SetupSession(gnutls_session_t sess)
415 // Always set the default priorities
416 gnutls_set_default_priority(sess);
419 static const char* GetDefault()
424 static std::string RemoveUnknownTokens(const std::string& prio)
426 // We don't do anything here because only NORMAL is accepted
432 class CertCredentials
434 /** DH parameters associated with these credentials
436 std::auto_ptr<DHParams> dh;
439 gnutls_certificate_credentials_t cred;
444 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
449 gnutls_certificate_free_credentials(cred);
452 /** Associates these credentials with the session
454 void SetupSession(gnutls_session_t sess)
456 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
459 /** Set the given DH parameters to be used with these credentials
461 void SetDH(std::auto_ptr<DHParams>& DH)
464 gnutls_certificate_set_dh_params(cred, dh->get());
468 class X509Credentials : public CertCredentials
474 /** Certificate list, presented to the peer
478 /** Trusted CA, may be NULL
480 std::auto_ptr<X509CertList> trustedca;
482 /** Certificate revocation list, may be NULL
484 std::auto_ptr<X509CRL> crl;
486 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);
489 X509Credentials(const std::string& certstr, const std::string& keystr)
493 // Throwing is ok here, the destructor of Credentials is called in that case
494 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
495 ThrowOnError(ret, "Unable to set cert/key pair");
497 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
498 gnutls_certificate_set_retrieve_function(cred, cert_callback);
500 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
504 /** Sets the trusted CA and the certificate revocation list
505 * to use when verifying certificates
507 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
509 // Do nothing if certlist is NULL
512 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
513 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
517 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
518 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
521 trustedca = certlist;
530 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
531 gnutls_packet_t packet;
534 DataReader(gnutls_session_t sess)
536 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
537 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
538 // to the recvq directly from there in appendto().
539 retval = gnutls_record_recv_packet(sess, &packet);
542 void appendto(std::string& recvq)
544 // Copy data from GnuTLS buffers to recvq
545 gnutls_datum_t datum;
546 gnutls_packet_get(packet, &datum, NULL);
547 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
549 gnutls_packet_deinit(packet);
555 DataReader(gnutls_session_t sess)
556 : buffer(ServerInstance->GetReadBuffer())
558 // Read data from GnuTLS buffers into ReadBuffer
559 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
562 void appendto(std::string& recvq)
564 // Copy data from ReadBuffer to recvq
565 recvq.append(buffer, retval);
569 int ret() const { return retval; }
574 /** Name of this profile
576 const std::string name;
578 /** X509 certificate(s) and key
580 X509Credentials x509cred;
582 /** The minimum length in bits for the DH prime to be accepted as a client
584 unsigned int min_dh_bits;
586 /** Hashing algorithm to use when generating certificate fingerprints
590 /** Priorities for ciphers, compression methods, etc.
594 /** Rough max size of records to send
596 const unsigned int outrecsize;
598 /** True to request a client certificate as a server
600 const bool requestclientcert;
602 static std::string ReadFile(const std::string& filename)
604 FileReader reader(filename);
605 std::string ret = reader.GetString();
607 throw Exception("Cannot read file " + filename);
611 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
613 // Use default priority string if this tag does not specify one
614 std::string priostr = GnuTLS::Priority::GetDefault();
615 bool found = tag->readString("priority", priostr);
616 // 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
617 if (!tag->getBool("strictpriority", found))
619 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
620 if (stripped.empty())
622 // Stripping failed, act as if a prio string wasn't set
623 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
624 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());
626 else if ((found) && (stripped != priostr))
628 // Prio string was set in the config and we ended up with something that works but different
629 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
631 priostr.swap(stripped);
641 std::auto_ptr<X509CertList> ca;
642 std::auto_ptr<X509CRL> crl;
646 std::auto_ptr<DHParams> dh;
652 unsigned int outrecsize;
653 bool requestclientcert;
655 Config(const std::string& profilename, ConfigTag* tag)
657 , certstr(ReadFile(tag->getString("certfile", "cert.pem")))
658 , keystr(ReadFile(tag->getString("keyfile", "key.pem")))
659 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem"))))
660 , priostr(GetPrioStr(profilename, tag))
661 , mindh(tag->getUInt("mindhbits", 1024))
662 , hashstr(tag->getString("hash", "md5"))
663 , requestclientcert(tag->getBool("requestclientcert", true))
665 // Load trusted CA and revocation list, if set
666 std::string filename = tag->getString("cafile");
667 if (!filename.empty())
669 ca.reset(new X509CertList(ReadFile(filename)));
671 filename = tag->getString("crlfile");
672 if (!filename.empty())
673 crl.reset(new X509CRL(ReadFile(filename)));
676 #ifdef INSPIRCD_GNUTLS_HAS_CORK
677 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
678 outrecsize = tag->getUInt("outrecsize", 2048, 512);
680 outrecsize = tag->getUInt("outrecsize", 2048, 512, 16384);
685 Profile(Config& config)
687 , x509cred(config.certstr, config.keystr)
688 , min_dh_bits(config.mindh)
689 , hash(config.hashstr)
690 , priority(config.priostr)
691 , outrecsize(config.outrecsize)
692 , requestclientcert(config.requestclientcert)
694 x509cred.SetDH(config.dh);
695 x509cred.SetCA(config.ca, config.crl);
697 /** Set up the given session with the settings in this profile
699 void SetupSession(gnutls_session_t sess)
701 priority.SetupSession(sess);
702 x509cred.SetupSession(sess);
703 gnutls_dh_set_prime_bits(sess, min_dh_bits);
705 // Request client certificate if enabled and we are a server, no-op if we're a client
706 if (requestclientcert)
707 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
710 const std::string& GetName() const { return name; }
711 X509Credentials& GetX509Credentials() { return x509cred; }
712 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
713 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
717 class GnuTLSIOHook : public SSLIOHook
720 gnutls_session_t sess;
722 #ifdef INSPIRCD_GNUTLS_HAS_CORK
730 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
731 gnutls_deinit(this->sess);
738 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
739 int Handshake(StreamSocket* user)
741 int ret = gnutls_handshake(this->sess);
745 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
747 // Handshake needs resuming later, read() or write() would have blocked.
748 this->status = ISSL_HANDSHAKING;
750 if (gnutls_record_get_direction(this->sess) == 0)
752 // gnutls_handshake() wants to read() again.
753 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
757 // gnutls_handshake() wants to write() again.
758 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
765 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
772 // Change the seesion state
773 this->status = ISSL_HANDSHAKEN;
777 // Finish writing, if any left
778 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
784 void VerifyCertificate()
786 unsigned int certstatus;
787 const gnutls_datum_t* cert_list;
789 unsigned int cert_list_size;
790 gnutls_x509_crt_t cert;
792 unsigned char digest[512];
793 size_t digest_size = sizeof(digest);
794 size_t name_size = sizeof(str);
795 ssl_cert* certinfo = new ssl_cert;
796 this->certificate = certinfo;
798 /* This verification function uses the trusted CAs in the credentials
799 * structure. So you must have installed one or more CA certificates.
801 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
805 certinfo->error = std::string(gnutls_strerror(ret));
809 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
810 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
811 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
812 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
814 /* Up to here the process is the same for X.509 certificates and
815 * OpenPGP keys. From now on X.509 certificates are assumed. This can
816 * be easily extended to work with openpgp keys as well.
818 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
820 certinfo->error = "No X509 keys sent";
824 ret = gnutls_x509_crt_init(&cert);
827 certinfo->error = gnutls_strerror(ret);
832 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
833 if (cert_list == NULL)
835 certinfo->error = "No certificate was found";
836 goto info_done_dealloc;
839 /* This is not a real world example, since we only check the first
840 * certificate in the given chain.
843 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
846 certinfo->error = gnutls_strerror(ret);
847 goto info_done_dealloc;
850 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
852 std::string& dn = certinfo->dn;
854 // Make sure there are no chars in the string that we consider invalid
855 if (dn.find_first_of("\r\n") != std::string::npos)
859 name_size = sizeof(str);
860 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
862 std::string& issuer = certinfo->issuer;
864 if (issuer.find_first_of("\r\n") != std::string::npos)
868 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
870 certinfo->error = gnutls_strerror(ret);
874 certinfo->fingerprint = BinToHex(digest, digest_size);
877 /* Beware here we do not check for errors.
879 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
881 certinfo->error = "Not activated, or expired certificate";
885 gnutls_x509_crt_deinit(cert);
888 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
889 int PrepareIO(StreamSocket* sock)
891 if (status == ISSL_HANDSHAKEN)
893 else if (status == ISSL_HANDSHAKING)
895 // The handshake isn't finished, try to finish it
896 return Handshake(sock);
900 sock->SetError("No SSL session");
904 #ifdef INSPIRCD_GNUTLS_HAS_CORK
905 int FlushBuffer(StreamSocket* sock)
907 // If GnuTLS has some data buffered, write it
909 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
914 int HandleWriteRet(StreamSocket* sock, int ret)
918 #ifdef INSPIRCD_GNUTLS_HAS_CORK
922 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
928 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
930 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
935 sock->SetError(gnutls_strerror(ret));
941 static const char* UnknownIfNULL(const char* str)
943 return str ? str : "UNKNOWN";
946 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
948 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
950 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
953 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
956 gnutls_transport_set_errno(session->sess, EAGAIN);
963 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
968 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
969 * and then set errno appropriately.
970 * The gnutls library may also have a different errno variable than us, see
971 * gnutls_transport_set_errno(3).
973 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
978 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
982 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
983 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
985 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
987 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
990 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
993 gnutls_transport_set_errno(session->sess, EAGAIN);
1000 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
1001 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
1003 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
1005 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1009 for (int i = 0; i < iovcnt; i++)
1010 size += iov[i].iov_len;
1013 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1017 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1018 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1020 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1022 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1025 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1028 gnutls_transport_set_errno(session->sess, EAGAIN);
1035 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1040 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1041 * and then set errno appropriately.
1042 * The gnutls library may also have a different errno variable than us, see
1043 * gnutls_transport_set_errno(3).
1045 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1050 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1053 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1056 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1057 : SSLIOHook(hookprov)
1060 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1064 gnutls_init(&sess, flags);
1065 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1066 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1067 gnutls_transport_set_vec_push_function(sess, VectorPush);
1069 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1071 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1072 GetProfile().SetupSession(sess);
1074 sock->AddIOHook(this);
1078 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1083 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1085 // Finish handshake if needed
1086 int prepret = PrepareIO(user);
1090 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1092 GnuTLS::DataReader reader(sess);
1093 int ret = reader.ret();
1096 reader.appendto(recvq);
1097 // Schedule a read if there is still data in the GnuTLS buffer
1098 if (gnutls_record_check_pending(sess) > 0)
1099 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1102 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1108 user->SetError("Connection closed");
1114 user->SetError(gnutls_strerror(ret));
1121 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1123 // Finish handshake if needed
1124 int prepret = PrepareIO(user);
1128 // Session is ready for transferring application data
1130 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1133 // If there is something in the GnuTLS buffer try to send() it
1134 int ret = FlushBuffer(user);
1136 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1138 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1142 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1143 gnutls_record_cork(this->sess);
1144 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1146 const StreamSocket::SendQueue::Element& elem = sendq.front();
1147 gbuffersize += elem.length();
1148 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1160 while (!sendq.empty())
1162 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1163 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1164 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1168 else if (ret < (int)buffer.length())
1170 sendq.erase_front(ret);
1171 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1175 // Wrote entire record, continue sending
1180 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1184 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1186 if (!IsHandshakeDone())
1188 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1189 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1190 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1191 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1194 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1196 std::vector<char> nameBuffer;
1197 size_t nameLength = 0;
1198 unsigned int nameType = GNUTLS_NAME_DNS;
1200 // First, determine the size of the hostname.
1201 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1204 // Then retrieve the hostname.
1205 nameBuffer.resize(nameLength);
1206 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1209 out.append(&nameBuffer[0]);
1213 GnuTLS::Profile& GetProfile();
1214 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1217 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)
1219 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1220 st->type = GNUTLS_CRT_X509;
1222 st->cert_type = GNUTLS_CRT_X509;
1223 st->key_type = GNUTLS_PRIVKEY_X509;
1225 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1226 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1228 st->ncerts = cred.certs.size();
1229 st->cert.x509 = cred.certs.raw();
1230 st->key.x509 = cred.key.get();
1236 class GnuTLSIOHookProvider : public IOHookProvider
1238 GnuTLS::Profile profile;
1241 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1242 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1245 ServerInstance->Modules->AddService(*this);
1248 ~GnuTLSIOHookProvider()
1250 ServerInstance->Modules->DelService(*this);
1253 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1255 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1258 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1260 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1263 GnuTLS::Profile& GetProfile() { return profile; }
1266 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1268 IOHookProvider* hookprov = prov;
1269 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1272 class ModuleSSLGnuTLS : public Module
1274 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1276 // First member of the class, gets constructed first and destructed last
1277 GnuTLS::Init libinit;
1278 ProfileList profiles;
1282 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1283 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1284 // avoiding unpleasant situations where no new SSL connections are possible.
1285 ProfileList newprofiles;
1287 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1288 if (tags.first == tags.second)
1290 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1291 const std::string defname = "gnutls";
1292 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1293 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1297 GnuTLS::Profile::Config profileconfig(defname, tag);
1298 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1300 catch (CoreException& ex)
1302 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1306 for (ConfigIter i = tags.first; i != tags.second; ++i)
1308 ConfigTag* tag = i->second;
1309 if (!stdalgo::string::equalsci(tag->getString("provider"), "gnutls"))
1312 std::string name = tag->getString("name");
1315 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1319 reference<GnuTLSIOHookProvider> prov;
1322 GnuTLS::Profile::Config profileconfig(name, tag);
1323 prov = new GnuTLSIOHookProvider(this, profileconfig);
1325 catch (CoreException& ex)
1327 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1330 newprofiles.push_back(prov);
1333 // New profiles are ok, begin using them
1334 // Old profiles are deleted when their refcount drops to zero
1335 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1337 GnuTLSIOHookProvider& prov = **i;
1338 ServerInstance->Modules.DelService(prov);
1341 profiles.swap(newprofiles);
1347 #ifndef GNUTLS_HAS_RND
1348 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1353 void init() CXX11_OVERRIDE
1355 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1357 ServerInstance->GenRandom = RandGen::Call;
1360 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1362 if (!irc::equals(param, "ssl"))
1368 ServerInstance->SNO->WriteToSnoMask('a', "SSL module %s rehashed.", MODNAME);
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)