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 #if (!INSPIRCD_GNUTLS_HAS_VERSION(2, 0, 0))
83 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
84 typedef gnutls_dh_params_t gnutls_dh_params;
87 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
89 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
90 #define INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
91 #define GNUTLS_NEW_CERT_CALLBACK_API
92 typedef gnutls_retr2_st cert_cb_last_param_type;
94 typedef gnutls_retr_st cert_cb_last_param_type;
97 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
98 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
101 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
102 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
103 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
104 typedef unsigned int inspircd_gnutls_session_init_flags_t;
106 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
109 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
110 #define INSPIRCD_GNUTLS_HAS_CORK
113 static Module* thismod;
115 class RandGen : public HandlerBase2<void, char*, size_t>
118 void Call(char* buffer, size_t len)
120 #ifdef GNUTLS_HAS_RND
121 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
123 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
133 Init() { gnutls_global_init(); }
134 ~Init() { gnutls_global_deinit(); }
137 class Exception : public ModuleException
140 Exception(const std::string& reason)
141 : ModuleException(reason) { }
144 void ThrowOnError(int errcode, const char* msg)
148 std::string reason = msg;
149 reason.append(" :").append(gnutls_strerror(errcode));
150 throw Exception(reason);
154 /** Used to create a gnutls_datum_t* from a std::string
158 gnutls_datum_t datum;
161 Datum(const std::string& dat)
163 datum.data = (unsigned char*)dat.data();
164 datum.size = static_cast<unsigned int>(dat.length());
167 const gnutls_datum_t* get() const { return &datum; }
172 gnutls_digest_algorithm_t hash;
175 // Nothing to deallocate, constructor may throw freely
176 Hash(const std::string& hashname)
178 // As older versions of gnutls can't do this, let's disable it where needed.
179 #ifdef GNUTLS_HAS_MAC_GET_ID
180 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
181 // There is no gnutls_dig_get_id() at the moment, but it may come later
182 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
183 if (hash == GNUTLS_DIG_UNKNOWN)
184 throw Exception("Unknown hash type " + hashname);
186 // Check if the user is giving us something that is a valid MAC but not digest
187 gnutls_hash_hd_t is_digest;
188 if (gnutls_hash_init(&is_digest, hash) < 0)
189 throw Exception("Unknown hash type " + hashname);
190 gnutls_hash_deinit(is_digest, NULL);
192 if (hashname == "md5")
193 hash = GNUTLS_DIG_MD5;
194 else if (hashname == "sha1")
195 hash = GNUTLS_DIG_SHA1;
196 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
197 else if (hashname == "sha256")
198 hash = GNUTLS_DIG_SHA256;
201 throw Exception("Unknown hash type " + hashname);
205 gnutls_digest_algorithm_t get() const { return hash; }
210 gnutls_dh_params_t dh_params;
214 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
219 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
221 std::auto_ptr<DHParams> dh(new DHParams);
222 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
223 ThrowOnError(ret, "Unable to import DH params");
229 gnutls_dh_params_deinit(dh_params);
232 const gnutls_dh_params_t& get() const { return dh_params; }
237 /** Ensure that the key is deinited in case the constructor of X509Key throws
242 gnutls_x509_privkey_t key;
246 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
251 gnutls_x509_privkey_deinit(key);
257 X509Key(const std::string& keystr)
259 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
260 ThrowOnError(ret, "Unable to import private key");
263 gnutls_x509_privkey_t& get() { return key.key; }
268 std::vector<gnutls_x509_crt_t> certs;
272 X509CertList(const std::string& certstr)
274 unsigned int certcount = 3;
275 certs.resize(certcount);
276 Datum datum(certstr);
278 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
279 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
281 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
282 // try again with a bigger buffer
283 certs.resize(certcount);
284 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
287 ThrowOnError(ret, "Unable to load certificates");
289 // Resize the vector to the actual number of certs because we rely on its size being correct
290 // when deallocating the certs
291 certs.resize(certcount);
296 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
297 gnutls_x509_crt_deinit(*i);
300 gnutls_x509_crt_t* raw() { return &certs[0]; }
301 unsigned int size() const { return certs.size(); }
304 class X509CRL : public refcountbase
309 gnutls_x509_crl_t crl;
313 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
318 gnutls_x509_crl_deinit(crl);
324 X509CRL(const std::string& crlstr)
326 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
327 ThrowOnError(ret, "Unable to load certificate revocation list");
330 gnutls_x509_crl_t& get() { return crl.crl; }
333 #ifdef GNUTLS_NEW_PRIO_API
336 gnutls_priority_t priority;
339 Priority(const std::string& priorities)
341 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
342 // If the user did not supply anything then the string is already set to "NORMAL"
343 const char* priocstr = priorities.c_str();
344 const char* prioerror;
346 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
349 // gnutls did not understand the user supplied string
350 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
356 gnutls_priority_deinit(priority);
359 void SetupSession(gnutls_session_t sess)
361 gnutls_priority_set(sess, priority);
364 static const char* GetDefault()
366 return "NORMAL:%SERVER_PRECEDENCE:-VERS-SSL3.0";
369 static std::string RemoveUnknownTokens(const std::string& prio)
372 irc::sepstream ss(prio, ':');
373 for (std::string token; ss.GetToken(token); )
375 // Save current position so we can revert later if needed
376 const std::string::size_type prevpos = ret.length();
382 gnutls_priority_t test;
383 if (gnutls_priority_init(&test, ret.c_str(), NULL) < 0)
385 // The new token broke the priority string, revert to the previously working one
386 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Priority string token not recognized: \"%s\"", token.c_str());
392 gnutls_priority_deinit(test);
399 /** Dummy class, used when gnutls_priority_set() is not available
404 Priority(const std::string& priorities)
406 if (priorities != GetDefault())
407 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
410 static void SetupSession(gnutls_session_t sess)
412 // Always set the default priorities
413 gnutls_set_default_priority(sess);
416 static const char* GetDefault()
421 static std::string RemoveUnknownTokens(const std::string& prio)
423 // We don't do anything here because only NORMAL is accepted
429 class CertCredentials
431 /** DH parameters associated with these credentials
433 std::auto_ptr<DHParams> dh;
436 gnutls_certificate_credentials_t cred;
441 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
446 gnutls_certificate_free_credentials(cred);
449 /** Associates these credentials with the session
451 void SetupSession(gnutls_session_t sess)
453 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
456 /** Set the given DH parameters to be used with these credentials
458 void SetDH(std::auto_ptr<DHParams>& DH)
461 gnutls_certificate_set_dh_params(cred, dh->get());
465 class X509Credentials : public CertCredentials
471 /** Certificate list, presented to the peer
475 /** Trusted CA, may be NULL
477 std::auto_ptr<X509CertList> trustedca;
479 /** Certificate revocation list, may be NULL
481 std::auto_ptr<X509CRL> crl;
483 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);
486 X509Credentials(const std::string& certstr, const std::string& keystr)
490 // Throwing is ok here, the destructor of Credentials is called in that case
491 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
492 ThrowOnError(ret, "Unable to set cert/key pair");
494 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
495 gnutls_certificate_set_retrieve_function(cred, cert_callback);
497 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
501 /** Sets the trusted CA and the certificate revocation list
502 * to use when verifying certificates
504 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
506 // Do nothing if certlist is NULL
509 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
510 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
514 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
515 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
518 trustedca = certlist;
527 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
528 gnutls_packet_t packet;
531 DataReader(gnutls_session_t sess)
533 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
534 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
535 // to the recvq directly from there in appendto().
536 retval = gnutls_record_recv_packet(sess, &packet);
539 void appendto(std::string& recvq)
541 // Copy data from GnuTLS buffers to recvq
542 gnutls_datum_t datum;
543 gnutls_packet_get(packet, &datum, NULL);
544 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
546 gnutls_packet_deinit(packet);
552 DataReader(gnutls_session_t sess)
553 : buffer(ServerInstance->GetReadBuffer())
555 // Read data from GnuTLS buffers into ReadBuffer
556 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
559 void appendto(std::string& recvq)
561 // Copy data from ReadBuffer to recvq
562 recvq.append(buffer, retval);
566 int ret() const { return retval; }
571 /** Name of this profile
573 const std::string name;
575 /** X509 certificate(s) and key
577 X509Credentials x509cred;
579 /** The minimum length in bits for the DH prime to be accepted as a client
581 unsigned int min_dh_bits;
583 /** Hashing algorithm to use when generating certificate fingerprints
587 /** Priorities for ciphers, compression methods, etc.
591 /** Rough max size of records to send
593 const unsigned int outrecsize;
595 /** True to request a client certificate as a server
597 const bool requestclientcert;
599 static std::string ReadFile(const std::string& filename)
601 FileReader reader(filename);
602 std::string ret = reader.GetString();
604 throw Exception("Cannot read file " + filename);
608 static std::string GetPrioStr(const std::string& profilename, ConfigTag* tag)
610 // Use default priority string if this tag does not specify one
611 std::string priostr = GnuTLS::Priority::GetDefault();
612 bool found = tag->readString("priority", priostr);
613 // If the prio string isn't set in the config don't be strict about the default one because it doesn't work on all versions of GnuTLS
614 if (!tag->getBool("strictpriority", found))
616 std::string stripped = GnuTLS::Priority::RemoveUnknownTokens(priostr);
617 if (stripped.empty())
619 // Stripping failed, act as if a prio string wasn't set
620 stripped = GnuTLS::Priority::RemoveUnknownTokens(GnuTLS::Priority::GetDefault());
621 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens and stripping it didn't yield a working one either, falling back to \"%s\"", profilename.c_str(), stripped.c_str());
623 else if ((found) && (stripped != priostr))
625 // Prio string was set in the config and we ended up with something that works but different
626 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Priority string for profile \"%s\" contains unknown tokens, stripped to \"%s\"", profilename.c_str(), stripped.c_str());
628 priostr.swap(stripped);
638 std::auto_ptr<X509CertList> ca;
639 std::auto_ptr<X509CRL> crl;
643 std::auto_ptr<DHParams> dh;
649 unsigned int outrecsize;
650 bool requestclientcert;
652 Config(const std::string& profilename, ConfigTag* tag)
654 , certstr(ReadFile(tag->getString("certfile", "cert.pem")))
655 , keystr(ReadFile(tag->getString("keyfile", "key.pem")))
656 , dh(DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem"))))
657 , priostr(GetPrioStr(profilename, tag))
658 , mindh(tag->getInt("mindhbits", 1024))
659 , hashstr(tag->getString("hash", "md5"))
660 , requestclientcert(tag->getBool("requestclientcert", true))
662 // Load trusted CA and revocation list, if set
663 std::string filename = tag->getString("cafile");
664 if (!filename.empty())
666 ca.reset(new X509CertList(ReadFile(filename)));
668 filename = tag->getString("crlfile");
669 if (!filename.empty())
670 crl.reset(new X509CRL(ReadFile(filename)));
673 #ifdef INSPIRCD_GNUTLS_HAS_CORK
674 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
675 outrecsize = tag->getInt("outrecsize", 2048, 512);
677 outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
682 Profile(Config& config)
684 , x509cred(config.certstr, config.keystr)
685 , min_dh_bits(config.mindh)
686 , hash(config.hashstr)
687 , priority(config.priostr)
688 , outrecsize(config.outrecsize)
689 , requestclientcert(config.requestclientcert)
691 x509cred.SetDH(config.dh);
692 x509cred.SetCA(config.ca, config.crl);
694 /** Set up the given session with the settings in this profile
696 void SetupSession(gnutls_session_t sess)
698 priority.SetupSession(sess);
699 x509cred.SetupSession(sess);
700 gnutls_dh_set_prime_bits(sess, min_dh_bits);
702 // Request client certificate if enabled and we are a server, no-op if we're a client
703 if (requestclientcert)
704 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
707 const std::string& GetName() const { return name; }
708 X509Credentials& GetX509Credentials() { return x509cred; }
709 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
710 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
714 class GnuTLSIOHook : public SSLIOHook
717 gnutls_session_t sess;
719 #ifdef INSPIRCD_GNUTLS_HAS_CORK
727 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
728 gnutls_deinit(this->sess);
735 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
736 int Handshake(StreamSocket* user)
738 int ret = gnutls_handshake(this->sess);
742 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
744 // Handshake needs resuming later, read() or write() would have blocked.
745 this->status = ISSL_HANDSHAKING;
747 if (gnutls_record_get_direction(this->sess) == 0)
749 // gnutls_handshake() wants to read() again.
750 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
754 // gnutls_handshake() wants to write() again.
755 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
762 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
769 // Change the seesion state
770 this->status = ISSL_HANDSHAKEN;
774 // Finish writing, if any left
775 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
781 void VerifyCertificate()
783 unsigned int certstatus;
784 const gnutls_datum_t* cert_list;
786 unsigned int cert_list_size;
787 gnutls_x509_crt_t cert;
789 unsigned char digest[512];
790 size_t digest_size = sizeof(digest);
791 size_t name_size = sizeof(str);
792 ssl_cert* certinfo = new ssl_cert;
793 this->certificate = certinfo;
795 /* This verification function uses the trusted CAs in the credentials
796 * structure. So you must have installed one or more CA certificates.
798 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
802 certinfo->error = std::string(gnutls_strerror(ret));
806 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
807 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
808 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
809 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
811 /* Up to here the process is the same for X.509 certificates and
812 * OpenPGP keys. From now on X.509 certificates are assumed. This can
813 * be easily extended to work with openpgp keys as well.
815 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
817 certinfo->error = "No X509 keys sent";
821 ret = gnutls_x509_crt_init(&cert);
824 certinfo->error = gnutls_strerror(ret);
829 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
830 if (cert_list == NULL)
832 certinfo->error = "No certificate was found";
833 goto info_done_dealloc;
836 /* This is not a real world example, since we only check the first
837 * certificate in the given chain.
840 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
843 certinfo->error = gnutls_strerror(ret);
844 goto info_done_dealloc;
847 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
849 std::string& dn = certinfo->dn;
851 // Make sure there are no chars in the string that we consider invalid
852 if (dn.find_first_of("\r\n") != std::string::npos)
856 name_size = sizeof(str);
857 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
859 std::string& issuer = certinfo->issuer;
861 if (issuer.find_first_of("\r\n") != std::string::npos)
865 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GetProfile().GetHash(), digest, &digest_size)) < 0)
867 certinfo->error = gnutls_strerror(ret);
871 certinfo->fingerprint = BinToHex(digest, digest_size);
874 /* Beware here we do not check for errors.
876 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
878 certinfo->error = "Not activated, or expired certificate";
882 gnutls_x509_crt_deinit(cert);
885 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
886 int PrepareIO(StreamSocket* sock)
888 if (status == ISSL_HANDSHAKEN)
890 else if (status == ISSL_HANDSHAKING)
892 // The handshake isn't finished, try to finish it
893 return Handshake(sock);
897 sock->SetError("No SSL session");
901 #ifdef INSPIRCD_GNUTLS_HAS_CORK
902 int FlushBuffer(StreamSocket* sock)
904 // If GnuTLS has some data buffered, write it
906 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
911 int HandleWriteRet(StreamSocket* sock, int ret)
915 #ifdef INSPIRCD_GNUTLS_HAS_CORK
919 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
925 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
927 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
932 sock->SetError(gnutls_strerror(ret));
938 static const char* UnknownIfNULL(const char* str)
940 return str ? str : "UNKNOWN";
943 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
945 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
947 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
950 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
953 gnutls_transport_set_errno(session->sess, EAGAIN);
960 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
965 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
966 * and then set errno appropriately.
967 * The gnutls library may also have a different errno variable than us, see
968 * gnutls_transport_set_errno(3).
970 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
975 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
979 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
980 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
982 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
984 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
987 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
990 gnutls_transport_set_errno(session->sess, EAGAIN);
997 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
998 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
1000 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
1002 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1006 for (int i = 0; i < iovcnt; i++)
1007 size += iov[i].iov_len;
1010 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1014 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1015 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
1017 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
1019 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod));
1022 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
1025 gnutls_transport_set_errno(session->sess, EAGAIN);
1032 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
1037 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
1038 * and then set errno appropriately.
1039 * The gnutls library may also have a different errno variable than us, see
1040 * gnutls_transport_set_errno(3).
1042 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
1047 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
1050 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1053 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags)
1054 : SSLIOHook(hookprov)
1057 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1061 gnutls_init(&sess, flags);
1062 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
1063 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
1064 gnutls_transport_set_vec_push_function(sess, VectorPush);
1066 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
1068 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
1069 GetProfile().SetupSession(sess);
1071 sock->AddIOHook(this);
1075 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
1080 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
1082 // Finish handshake if needed
1083 int prepret = PrepareIO(user);
1087 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1089 GnuTLS::DataReader reader(sess);
1090 int ret = reader.ret();
1093 reader.appendto(recvq);
1094 // Schedule a read if there is still data in the GnuTLS buffer
1095 if (gnutls_record_check_pending(sess) > 0)
1096 SocketEngine::ChangeEventMask(user, FD_ADD_TRIAL_READ);
1099 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1105 user->SetError("Connection closed");
1111 user->SetError(gnutls_strerror(ret));
1118 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
1120 // Finish handshake if needed
1121 int prepret = PrepareIO(user);
1125 // Session is ready for transferring application data
1127 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1130 // If there is something in the GnuTLS buffer try to send() it
1131 int ret = FlushBuffer(user);
1133 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1135 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1139 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1140 gnutls_record_cork(this->sess);
1141 while ((!sendq.empty()) && (gbuffersize < GetProfile().GetOutgoingRecordSize()))
1143 const StreamSocket::SendQueue::Element& elem = sendq.front();
1144 gbuffersize += elem.length();
1145 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1157 while (!sendq.empty())
1159 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
1160 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1161 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1165 else if (ret < (int)buffer.length())
1167 sendq.erase_front(ret);
1168 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1172 // Wrote entire record, continue sending
1177 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1181 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
1183 if (!IsHandshakeDone())
1185 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1186 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1187 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1188 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1191 bool GetServerName(std::string& out) const CXX11_OVERRIDE
1193 std::vector<char> nameBuffer;
1194 size_t nameLength = 0;
1195 unsigned int nameType = GNUTLS_NAME_DNS;
1197 // First, determine the size of the hostname.
1198 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SHORT_MEMORY_BUFFER)
1201 // Then retrieve the hostname.
1202 nameBuffer.resize(nameLength);
1203 if (gnutls_server_name_get(sess, &nameBuffer[0], &nameLength, &nameType, 0) != GNUTLS_E_SUCCESS)
1206 out.append(&nameBuffer[0]);
1210 GnuTLS::Profile& GetProfile();
1211 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1214 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)
1216 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1217 st->type = GNUTLS_CRT_X509;
1219 st->cert_type = GNUTLS_CRT_X509;
1220 st->key_type = GNUTLS_PRIVKEY_X509;
1222 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1223 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetModHook(thismod))->GetProfile().GetX509Credentials();
1225 st->ncerts = cred.certs.size();
1226 st->cert.x509 = cred.certs.raw();
1227 st->key.x509 = cred.key.get();
1233 class GnuTLSIOHookProvider : public IOHookProvider
1235 GnuTLS::Profile profile;
1238 GnuTLSIOHookProvider(Module* mod, GnuTLS::Profile::Config& config)
1239 : IOHookProvider(mod, "ssl/" + config.name, IOHookProvider::IOH_SSL)
1242 ServerInstance->Modules->AddService(*this);
1245 ~GnuTLSIOHookProvider()
1247 ServerInstance->Modules->DelService(*this);
1250 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1252 new GnuTLSIOHook(this, sock, GNUTLS_SERVER);
1255 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1257 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT);
1260 GnuTLS::Profile& GetProfile() { return profile; }
1263 GnuTLS::Profile& GnuTLSIOHook::GetProfile()
1265 IOHookProvider* hookprov = prov;
1266 return static_cast<GnuTLSIOHookProvider*>(hookprov)->GetProfile();
1269 class ModuleSSLGnuTLS : public Module
1271 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1273 // First member of the class, gets constructed first and destructed last
1274 GnuTLS::Init libinit;
1275 RandGen randhandler;
1276 ProfileList profiles;
1280 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1281 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1282 // avoiding unpleasant situations where no new SSL connections are possible.
1283 ProfileList newprofiles;
1285 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1286 if (tags.first == tags.second)
1288 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1289 const std::string defname = "gnutls";
1290 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1291 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1295 GnuTLS::Profile::Config profileconfig(defname, tag);
1296 newprofiles.push_back(new GnuTLSIOHookProvider(this, profileconfig));
1298 catch (CoreException& ex)
1300 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1304 for (ConfigIter i = tags.first; i != tags.second; ++i)
1306 ConfigTag* tag = i->second;
1307 if (tag->getString("provider") != "gnutls")
1310 std::string name = tag->getString("name");
1313 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1317 reference<GnuTLSIOHookProvider> prov;
1320 GnuTLS::Profile::Config profileconfig(name, tag);
1321 prov = new GnuTLSIOHookProvider(this, profileconfig);
1323 catch (CoreException& ex)
1325 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1328 newprofiles.push_back(prov);
1331 // New profiles are ok, begin using them
1332 // Old profiles are deleted when their refcount drops to zero
1333 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1335 GnuTLSIOHookProvider& prov = **i;
1336 ServerInstance->Modules.DelService(prov);
1339 profiles.swap(newprofiles);
1345 #ifndef GNUTLS_HAS_RND
1346 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1351 void init() CXX11_OVERRIDE
1353 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "GnuTLS lib version %s module was compiled for " GNUTLS_VERSION, gnutls_check_version(NULL));
1355 ServerInstance->GenRandom = &randhandler;
1358 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1367 catch (ModuleException& ex)
1369 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1375 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1378 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1380 if (type == ExtensionItem::EXT_USER)
1382 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1384 if ((user) && (user->eh.GetModHook(this)))
1386 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1387 // Potentially there could be multiple SSL modules loaded at once on different ports.
1388 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1393 Version GetVersion() CXX11_OVERRIDE
1395 return Version("Provides SSL support for clients", VF_VENDOR);
1398 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1400 const GnuTLSIOHook* const iohook = static_cast<GnuTLSIOHook*>(user->eh.GetModHook(this));
1401 if ((iohook) && (!iohook->IsHandshakeDone()))
1402 return MOD_RES_DENY;
1403 return MOD_RES_PASSTHRU;
1407 MODULE_INIT(ModuleSSLGnuTLS)