2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 John Brooks <john.brooks@dereferenced.net>
6 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "modules/ssl.h"
28 // Fix warnings about the use of commas at end of enumerator lists on C++03.
30 # pragma clang diagnostic ignored "-Wc++11-extensions"
31 #elif defined __GNUC__
32 # pragma GCC diagnostic ignored "-pedantic"
35 #include <gnutls/gnutls.h>
36 #include <gnutls/x509.h>
38 #ifndef GNUTLS_VERSION_NUMBER
39 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
42 // Check if the GnuTLS library is at least version major.minor.patch
43 #define INSPIRCD_GNUTLS_HAS_VERSION(major, minor, patch) (GNUTLS_VERSION_NUMBER >= ((major << 16) | (minor << 8) | patch))
45 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 9, 8)
46 #define GNUTLS_HAS_MAC_GET_ID
47 #include <gnutls/crypto.h>
50 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
51 # define GNUTLS_HAS_RND
57 # pragma comment(lib, "libgnutls-28.lib")
60 /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") eval("print `libgcrypt-config --cflags | tr -d \r` if `pkg-config --modversion gnutls 2>/dev/null | tr -d \r` lt '2.12'") */
61 /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") eval("print `libgcrypt-config --libs | tr -d \r` if `pkg-config --modversion gnutls 2>/dev/null | tr -d \r` lt '2.12'") */
63 // These don't exist in older GnuTLS versions
64 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 1, 7)
65 #define GNUTLS_NEW_PRIO_API
68 #if (!INSPIRCD_GNUTLS_HAS_VERSION(2, 0, 0))
69 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
70 typedef gnutls_dh_params_t gnutls_dh_params;
73 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN };
75 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 12, 0)
76 #define GNUTLS_NEW_CERT_CALLBACK_API
77 typedef gnutls_retr2_st cert_cb_last_param_type;
79 typedef gnutls_retr_st cert_cb_last_param_type;
82 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
83 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
86 class RandGen : public HandlerBase2<void, char*, size_t>
89 void Call(char* buffer, size_t len)
92 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
94 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
104 Init() { gnutls_global_init(); }
105 ~Init() { gnutls_global_deinit(); }
108 class Exception : public ModuleException
111 Exception(const std::string& reason)
112 : ModuleException(reason) { }
115 void ThrowOnError(int errcode, const char* msg)
119 std::string reason = msg;
120 reason.append(" :").append(gnutls_strerror(errcode));
121 throw Exception(reason);
125 /** Used to create a gnutls_datum_t* from a std::string
129 gnutls_datum_t datum;
132 Datum(const std::string& dat)
134 datum.data = (unsigned char*)dat.data();
135 datum.size = static_cast<unsigned int>(dat.length());
138 const gnutls_datum_t* get() const { return &datum; }
143 gnutls_digest_algorithm_t hash;
146 // Nothing to deallocate, constructor may throw freely
147 Hash(const std::string& hashname)
149 // As older versions of gnutls can't do this, let's disable it where needed.
150 #ifdef GNUTLS_HAS_MAC_GET_ID
151 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
152 // There is no gnutls_dig_get_id() at the moment, but it may come later
153 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
154 if (hash == GNUTLS_DIG_UNKNOWN)
155 throw Exception("Unknown hash type " + hashname);
157 // Check if the user is giving us something that is a valid MAC but not digest
158 gnutls_hash_hd_t is_digest;
159 if (gnutls_hash_init(&is_digest, hash) < 0)
160 throw Exception("Unknown hash type " + hashname);
161 gnutls_hash_deinit(is_digest, NULL);
163 if (hashname == "md5")
164 hash = GNUTLS_DIG_MD5;
165 else if (hashname == "sha1")
166 hash = GNUTLS_DIG_SHA1;
167 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
168 else if (hashname == "sha256")
169 hash = GNUTLS_DIG_SHA256;
172 throw Exception("Unknown hash type " + hashname);
176 gnutls_digest_algorithm_t get() const { return hash; }
181 gnutls_dh_params_t dh_params;
185 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
190 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
192 std::auto_ptr<DHParams> dh(new DHParams);
193 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
194 ThrowOnError(ret, "Unable to import DH params");
199 static std::auto_ptr<DHParams> Generate(unsigned int bits)
201 std::auto_ptr<DHParams> dh(new DHParams);
202 ThrowOnError(gnutls_dh_params_generate2(dh->dh_params, bits), "Unable to generate DH params");
208 gnutls_dh_params_deinit(dh_params);
211 const gnutls_dh_params_t& get() const { return dh_params; }
216 /** Ensure that the key is deinited in case the constructor of X509Key throws
221 gnutls_x509_privkey_t key;
225 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
230 gnutls_x509_privkey_deinit(key);
236 X509Key(const std::string& keystr)
238 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
239 ThrowOnError(ret, "Unable to import private key");
242 gnutls_x509_privkey_t& get() { return key.key; }
247 std::vector<gnutls_x509_crt_t> certs;
251 X509CertList(const std::string& certstr)
253 unsigned int certcount = 3;
254 certs.resize(certcount);
255 Datum datum(certstr);
257 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
258 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
260 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
261 // try again with a bigger buffer
262 certs.resize(certcount);
263 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
266 ThrowOnError(ret, "Unable to load certificates");
268 // Resize the vector to the actual number of certs because we rely on its size being correct
269 // when deallocating the certs
270 certs.resize(certcount);
275 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
276 gnutls_x509_crt_deinit(*i);
279 gnutls_x509_crt_t* raw() { return &certs[0]; }
280 unsigned int size() const { return certs.size(); }
283 class X509CRL : public refcountbase
288 gnutls_x509_crl_t crl;
292 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
297 gnutls_x509_crl_deinit(crl);
303 X509CRL(const std::string& crlstr)
305 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
306 ThrowOnError(ret, "Unable to load certificate revocation list");
309 gnutls_x509_crl_t& get() { return crl.crl; }
312 #ifdef GNUTLS_NEW_PRIO_API
315 gnutls_priority_t priority;
318 Priority(const std::string& priorities)
320 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
321 // If the user did not supply anything then the string is already set to "NORMAL"
322 const char* priocstr = priorities.c_str();
323 const char* prioerror;
325 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
328 // gnutls did not understand the user supplied string
329 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
335 gnutls_priority_deinit(priority);
338 void SetupSession(gnutls_session_t sess)
340 gnutls_priority_set(sess, priority);
344 /** Dummy class, used when gnutls_priority_set() is not available
349 Priority(const std::string& priorities)
351 if (priorities != "NORMAL")
352 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
355 static void SetupSession(gnutls_session_t sess)
357 // Always set the default priorities
358 gnutls_set_default_priority(sess);
363 class CertCredentials
365 /** DH parameters associated with these credentials
367 std::auto_ptr<DHParams> dh;
370 gnutls_certificate_credentials_t cred;
375 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
380 gnutls_certificate_free_credentials(cred);
383 /** Associates these credentials with the session
385 void SetupSession(gnutls_session_t sess)
387 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
390 /** Set the given DH parameters to be used with these credentials
392 void SetDH(std::auto_ptr<DHParams>& DH)
395 gnutls_certificate_set_dh_params(cred, dh->get());
399 class X509Credentials : public CertCredentials
405 /** Certificate list, presented to the peer
409 /** Trusted CA, may be NULL
411 std::auto_ptr<X509CertList> trustedca;
413 /** Certificate revocation list, may be NULL
415 std::auto_ptr<X509CRL> crl;
417 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);
420 X509Credentials(const std::string& certstr, const std::string& keystr)
424 // Throwing is ok here, the destructor of Credentials is called in that case
425 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
426 ThrowOnError(ret, "Unable to set cert/key pair");
428 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
429 gnutls_certificate_set_retrieve_function(cred, cert_callback);
431 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
435 /** Sets the trusted CA and the certificate revocation list
436 * to use when verifying certificates
438 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
440 // Do nothing if certlist is NULL
443 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
444 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
448 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
449 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
452 trustedca = certlist;
461 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
462 gnutls_packet_t packet;
465 DataReader(gnutls_session_t sess)
467 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
468 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
469 // to the recvq directly from there in appendto().
470 retval = gnutls_record_recv_packet(sess, &packet);
473 void appendto(std::string& recvq)
475 // Copy data from GnuTLS buffers to recvq
476 gnutls_datum_t datum;
477 gnutls_packet_get(packet, &datum, NULL);
478 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
480 gnutls_packet_deinit(packet);
486 DataReader(gnutls_session_t sess)
487 : buffer(ServerInstance->GetReadBuffer())
489 // Read data from GnuTLS buffers into ReadBuffer
490 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
493 void appendto(std::string& recvq)
495 // Copy data from ReadBuffer to recvq
496 recvq.append(buffer, retval);
500 int ret() const { return retval; }
503 class Profile : public refcountbase
505 /** Name of this profile
507 const std::string name;
509 /** X509 certificate(s) and key
511 X509Credentials x509cred;
513 /** The minimum length in bits for the DH prime to be accepted as a client
515 unsigned int min_dh_bits;
517 /** Hashing algorithm to use when generating certificate fingerprints
521 /** Priorities for ciphers, compression methods, etc.
525 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
526 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
527 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL)
529 , x509cred(certstr, keystr)
535 x509cred.SetCA(CA, CRL);
538 static std::string ReadFile(const std::string& filename)
540 FileReader reader(filename);
541 std::string ret = reader.GetString();
543 throw Exception("Cannot read file " + filename);
548 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
550 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
551 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
553 std::auto_ptr<DHParams> dh;
554 int gendh = tag->getInt("gendh");
557 gendh = (gendh < 1024 ? 1024 : gendh);
558 dh = DHParams::Generate(gendh);
561 dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
563 // Use default priority string if this tag does not specify one
564 std::string priostr = tag->getString("priority", "NORMAL");
565 unsigned int mindh = tag->getInt("mindhbits", 1024);
566 std::string hashstr = tag->getString("hash", "md5");
568 // Load trusted CA and revocation list, if set
569 std::auto_ptr<X509CertList> ca;
570 std::auto_ptr<X509CRL> crl;
571 std::string filename = tag->getString("cafile");
572 if (!filename.empty())
574 ca.reset(new X509CertList(ReadFile(filename)));
576 filename = tag->getString("crlfile");
577 if (!filename.empty())
578 crl.reset(new X509CRL(ReadFile(filename)));
581 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl);
584 /** Set up the given session with the settings in this profile
586 void SetupSession(gnutls_session_t sess)
588 priority.SetupSession(sess);
589 x509cred.SetupSession(sess);
590 gnutls_dh_set_prime_bits(sess, min_dh_bits);
593 const std::string& GetName() const { return name; }
594 X509Credentials& GetX509Credentials() { return x509cred; }
595 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
599 class GnuTLSIOHook : public SSLIOHook
602 gnutls_session_t sess;
604 reference<GnuTLS::Profile> profile;
606 void InitSession(StreamSocket* user, bool me_server)
608 gnutls_init(&sess, me_server ? GNUTLS_SERVER : GNUTLS_CLIENT);
610 profile->SetupSession(sess);
611 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
612 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
613 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
616 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
623 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
624 gnutls_deinit(this->sess);
631 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
632 int Handshake(StreamSocket* user)
634 int ret = gnutls_handshake(this->sess);
638 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
640 // Handshake needs resuming later, read() or write() would have blocked.
641 this->status = ISSL_HANDSHAKING;
643 if (gnutls_record_get_direction(this->sess) == 0)
645 // gnutls_handshake() wants to read() again.
646 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
650 // gnutls_handshake() wants to write() again.
651 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
658 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
665 // Change the seesion state
666 this->status = ISSL_HANDSHAKEN;
670 // Finish writing, if any left
671 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
677 void VerifyCertificate()
679 unsigned int certstatus;
680 const gnutls_datum_t* cert_list;
682 unsigned int cert_list_size;
683 gnutls_x509_crt_t cert;
685 unsigned char digest[512];
686 size_t digest_size = sizeof(digest);
687 size_t name_size = sizeof(str);
688 ssl_cert* certinfo = new ssl_cert;
689 this->certificate = certinfo;
691 /* This verification function uses the trusted CAs in the credentials
692 * structure. So you must have installed one or more CA certificates.
694 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
698 certinfo->error = std::string(gnutls_strerror(ret));
702 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
703 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
704 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
705 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
707 /* Up to here the process is the same for X.509 certificates and
708 * OpenPGP keys. From now on X.509 certificates are assumed. This can
709 * be easily extended to work with openpgp keys as well.
711 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
713 certinfo->error = "No X509 keys sent";
717 ret = gnutls_x509_crt_init(&cert);
720 certinfo->error = gnutls_strerror(ret);
725 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
726 if (cert_list == NULL)
728 certinfo->error = "No certificate was found";
729 goto info_done_dealloc;
732 /* This is not a real world example, since we only check the first
733 * certificate in the given chain.
736 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
739 certinfo->error = gnutls_strerror(ret);
740 goto info_done_dealloc;
743 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
745 std::string& dn = certinfo->dn;
747 // Make sure there are no chars in the string that we consider invalid
748 if (dn.find_first_of("\r\n") != std::string::npos)
752 name_size = sizeof(str);
753 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
755 std::string& issuer = certinfo->issuer;
757 if (issuer.find_first_of("\r\n") != std::string::npos)
761 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
763 certinfo->error = gnutls_strerror(ret);
767 certinfo->fingerprint = BinToHex(digest, digest_size);
770 /* Beware here we do not check for errors.
772 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
774 certinfo->error = "Not activated, or expired certificate";
778 gnutls_x509_crt_deinit(cert);
781 static const char* UnknownIfNULL(const char* str)
783 return str ? str : "UNKNOWN";
786 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
788 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
790 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
793 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
796 gnutls_transport_set_errno(session->sess, EAGAIN);
803 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
808 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
809 * and then set errno appropriately.
810 * The gnutls library may also have a different errno variable than us, see
811 * gnutls_transport_set_errno(3).
813 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
818 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
822 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
824 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
826 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
829 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
832 gnutls_transport_set_errno(session->sess, EAGAIN);
839 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
844 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
845 * and then set errno appropriately.
846 * The gnutls library may also have a different errno variable than us, see
847 * gnutls_transport_set_errno(3).
849 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
854 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
859 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool outbound, const reference<GnuTLS::Profile>& sslprofile)
860 : SSLIOHook(hookprov)
863 , profile(sslprofile)
865 InitSession(sock, outbound);
866 sock->AddIOHook(this);
870 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
875 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
880 user->SetError("No SSL session");
884 if (this->status == ISSL_HANDSHAKING)
886 // The handshake isn't finished, try to finish it.
887 int ret = Handshake(user);
892 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
894 GnuTLS::DataReader reader(sess);
895 int ret = reader.ret();
898 reader.appendto(recvq);
901 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
907 user->SetError("Connection closed");
913 user->SetError(gnutls_strerror(ret));
920 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq) CXX11_OVERRIDE
925 user->SetError("No SSL session");
929 if (this->status == ISSL_HANDSHAKING)
931 // The handshake isn't finished, try to finish it.
932 int ret = Handshake(user);
937 // Session is ready for transferring application data
941 ret = gnutls_record_send(this->sess, sendq.data(), sendq.length());
943 if (ret == (int)sendq.length())
945 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
951 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
954 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
956 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
961 user->SetError(gnutls_strerror(ret));
968 void TellCiphersAndFingerprint(LocalUser* user)
972 std::string text = "*** You are connected using SSL cipher '";
973 GetCiphersuite(text);
975 if (!certificate->fingerprint.empty())
976 text += " and your SSL certificate fingerprint is " + certificate->fingerprint;
978 user->WriteNotice(text);
982 void GetCiphersuite(std::string& out) const
984 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
985 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
986 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
987 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
990 GnuTLS::Profile* GetProfile() { return profile; }
993 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)
995 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
996 st->type = GNUTLS_CRT_X509;
998 st->cert_type = GNUTLS_CRT_X509;
999 st->key_type = GNUTLS_PRIVKEY_X509;
1001 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1002 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetIOHook())->GetProfile()->GetX509Credentials();
1004 st->ncerts = cred.certs.size();
1005 st->cert.x509 = cred.certs.raw();
1006 st->key.x509 = cred.key.get();
1012 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1014 reference<GnuTLS::Profile> profile;
1017 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1018 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1021 ServerInstance->Modules->AddService(*this);
1024 ~GnuTLSIOHookProvider()
1026 ServerInstance->Modules->DelService(*this);
1029 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1031 new GnuTLSIOHook(this, sock, true, profile);
1034 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1036 new GnuTLSIOHook(this, sock, false, profile);
1040 class ModuleSSLGnuTLS : public Module
1042 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1044 // First member of the class, gets constructed first and destructed last
1045 GnuTLS::Init libinit;
1046 RandGen randhandler;
1047 ProfileList profiles;
1051 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1052 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1053 // avoiding unpleasant situations where no new SSL connections are possible.
1054 ProfileList newprofiles;
1056 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1057 if (tags.first == tags.second)
1059 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1060 const std::string defname = "gnutls";
1061 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1062 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1066 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1067 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1069 catch (CoreException& ex)
1071 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1075 for (ConfigIter i = tags.first; i != tags.second; ++i)
1077 ConfigTag* tag = i->second;
1078 if (tag->getString("provider") != "gnutls")
1081 std::string name = tag->getString("name");
1084 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1088 reference<GnuTLS::Profile> profile;
1091 profile = GnuTLS::Profile::Create(name, tag);
1093 catch (CoreException& ex)
1095 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1098 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1101 // New profiles are ok, begin using them
1102 // Old profiles are deleted when their refcount drops to zero
1103 profiles.swap(newprofiles);
1109 #ifndef GNUTLS_HAS_RND
1110 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1114 void init() CXX11_OVERRIDE
1117 ServerInstance->GenRandom = &randhandler;
1120 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1129 catch (ModuleException& ex)
1131 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1137 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1140 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1142 if(target_type == TYPE_USER)
1144 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1146 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
1148 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1149 // Potentially there could be multiple SSL modules loaded at once on different ports.
1150 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1155 Version GetVersion() CXX11_OVERRIDE
1157 return Version("Provides SSL support for clients", VF_VENDOR);
1160 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
1162 IOHook* hook = user->eh.GetIOHook();
1163 if (hook && hook->prov->creator == this)
1164 static_cast<GnuTLSIOHook*>(hook)->TellCiphersAndFingerprint(user);
1168 MODULE_INIT(ModuleSSLGnuTLS)