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 <gnutls/gnutls.h>
26 #include <gnutls/x509.h>
27 #include "modules/ssl.h"
28 #include "modules/cap.h"
31 #if ((GNUTLS_VERSION_MAJOR > 2) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR > 9) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR == 9 && GNUTLS_VERSION_PATCH >= 8))
32 #define GNUTLS_HAS_MAC_GET_ID
33 #include <gnutls/crypto.h>
36 #if (GNUTLS_VERSION_MAJOR > 2 || GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR > 12)
37 # define GNUTLS_HAS_RND
43 # pragma comment(lib, "libgnutls.lib")
44 # pragma comment(lib, "libgcrypt.lib")
45 # pragma comment(lib, "libgpg-error.lib")
46 # pragma comment(lib, "user32.lib")
47 # pragma comment(lib, "advapi32.lib")
48 # pragma comment(lib, "libgcc.lib")
49 # pragma comment(lib, "libmingwex.lib")
50 # pragma comment(lib, "gdi32.lib")
53 /* $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'") -Wno-pedantic */
54 /* $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'") */
56 #ifndef GNUTLS_VERSION_MAJOR
57 #define GNUTLS_VERSION_MAJOR LIBGNUTLS_VERSION_MAJOR
58 #define GNUTLS_VERSION_MINOR LIBGNUTLS_VERSION_MINOR
59 #define GNUTLS_VERSION_PATCH LIBGNUTLS_VERSION_PATCH
62 // These don't exist in older GnuTLS versions
63 #if ((GNUTLS_VERSION_MAJOR > 2) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR > 1) || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR == 1 && GNUTLS_VERSION_PATCH >= 7))
64 #define GNUTLS_NEW_PRIO_API
67 #if(GNUTLS_VERSION_MAJOR < 2)
68 typedef gnutls_certificate_credentials_t gnutls_certificate_credentials;
69 typedef gnutls_dh_params_t gnutls_dh_params;
72 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
74 #if (GNUTLS_VERSION_MAJOR > 2 || (GNUTLS_VERSION_MAJOR == 2 && GNUTLS_VERSION_MINOR >= 12))
75 #define GNUTLS_NEW_CERT_CALLBACK_API
76 typedef gnutls_retr2_st cert_cb_last_param_type;
78 typedef gnutls_retr_st cert_cb_last_param_type;
81 class RandGen : public HandlerBase2<void, char*, size_t>
84 void Call(char* buffer, size_t len)
87 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
89 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
99 Init() { gnutls_global_init(); }
100 ~Init() { gnutls_global_deinit(); }
103 class Exception : public ModuleException
106 Exception(const std::string& reason)
107 : ModuleException(reason) { }
110 void ThrowOnError(int errcode, const char* msg)
114 std::string reason = msg;
115 reason.append(" :").append(gnutls_strerror(errcode));
116 throw Exception(reason);
120 /** Used to create a gnutls_datum_t* from a std::string
124 gnutls_datum_t datum;
127 Datum(const std::string& dat)
129 datum.data = (unsigned char*)dat.data();
130 datum.size = static_cast<unsigned int>(dat.length());
133 const gnutls_datum_t* get() const { return &datum; }
138 gnutls_digest_algorithm_t hash;
141 // Nothing to deallocate, constructor may throw freely
142 Hash(const std::string& hashname)
144 // As older versions of gnutls can't do this, let's disable it where needed.
145 #ifdef GNUTLS_HAS_MAC_GET_ID
146 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
147 // There is no gnutls_dig_get_id() at the moment, but it may come later
148 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
149 if (hash == GNUTLS_DIG_UNKNOWN)
150 throw Exception("Unknown hash type " + hashname);
152 // Check if the user is giving us something that is a valid MAC but not digest
153 gnutls_hash_hd_t is_digest;
154 if (gnutls_hash_init(&is_digest, hash) < 0)
155 throw Exception("Unknown hash type " + hashname);
156 gnutls_hash_deinit(is_digest, NULL);
158 if (hashname == "md5")
159 hash = GNUTLS_DIG_MD5;
160 else if (hashname == "sha1")
161 hash = GNUTLS_DIG_SHA1;
163 throw Exception("Unknown hash type " + hashname);
167 gnutls_digest_algorithm_t get() const { return hash; }
172 gnutls_dh_params_t dh_params;
176 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
181 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
183 std::auto_ptr<DHParams> dh(new DHParams);
184 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
185 ThrowOnError(ret, "Unable to import DH params");
190 static std::auto_ptr<DHParams> Generate(unsigned int bits)
192 std::auto_ptr<DHParams> dh(new DHParams);
193 ThrowOnError(gnutls_dh_params_generate2(dh->dh_params, bits), "Unable to generate DH params");
199 gnutls_dh_params_deinit(dh_params);
202 const gnutls_dh_params_t& get() const { return dh_params; }
207 /** Ensure that the key is deinited in case the constructor of X509Key throws
212 gnutls_x509_privkey_t key;
216 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
221 gnutls_x509_privkey_deinit(key);
227 X509Key(const std::string& keystr)
229 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
230 ThrowOnError(ret, "Unable to import private key");
233 gnutls_x509_privkey_t& get() { return key.key; }
238 std::vector<gnutls_x509_crt_t> certs;
242 X509CertList(const std::string& certstr)
244 unsigned int certcount = 3;
245 certs.resize(certcount);
246 Datum datum(certstr);
248 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
249 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
251 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
252 // try again with a bigger buffer
253 certs.resize(certcount);
254 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
257 ThrowOnError(ret, "Unable to load certificates");
259 // Resize the vector to the actual number of certs because we rely on its size being correct
260 // when deallocating the certs
261 certs.resize(certcount);
266 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
267 gnutls_x509_crt_deinit(*i);
270 gnutls_x509_crt_t* raw() { return &certs[0]; }
271 unsigned int size() const { return certs.size(); }
274 class X509CRL : public refcountbase
279 gnutls_x509_crl_t crl;
283 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
288 gnutls_x509_crl_deinit(crl);
294 X509CRL(const std::string& crlstr)
296 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
297 ThrowOnError(ret, "Unable to load certificate revocation list");
300 gnutls_x509_crl_t& get() { return crl.crl; }
303 #ifdef GNUTLS_NEW_PRIO_API
306 gnutls_priority_t priority;
309 Priority(const std::string& priorities)
311 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
312 // If the user did not supply anything then the string is already set to "NORMAL"
313 const char* priocstr = priorities.c_str();
314 const char* prioerror;
316 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
319 // gnutls did not understand the user supplied string
320 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
326 gnutls_priority_deinit(priority);
329 void SetupSession(gnutls_session_t sess)
331 gnutls_priority_set(sess, priority);
335 /** Dummy class, used when gnutls_priority_set() is not available
340 Priority(const std::string& priorities)
342 if (priorities != "NORMAL")
343 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
346 static void SetupSession(gnutls_session_t sess)
348 // Always set the default priorities
349 gnutls_set_default_priority(sess);
354 class CertCredentials
356 /** DH parameters associated with these credentials
358 std::auto_ptr<DHParams> dh;
361 gnutls_certificate_credentials_t cred;
366 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
371 gnutls_certificate_free_credentials(cred);
374 /** Associates these credentials with the session
376 void SetupSession(gnutls_session_t sess)
378 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
381 /** Set the given DH parameters to be used with these credentials
383 void SetDH(std::auto_ptr<DHParams>& DH)
386 gnutls_certificate_set_dh_params(cred, dh->get());
390 class X509Credentials : public CertCredentials
396 /** Certificate list, presented to the peer
400 /** Trusted CA, may be NULL
402 std::auto_ptr<X509CertList> trustedca;
404 /** Certificate revocation list, may be NULL
406 std::auto_ptr<X509CRL> crl;
408 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);
411 X509Credentials(const std::string& certstr, const std::string& keystr)
415 // Throwing is ok here, the destructor of Credentials is called in that case
416 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
417 ThrowOnError(ret, "Unable to set cert/key pair");
419 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
420 gnutls_certificate_set_retrieve_function(cred, cert_callback);
422 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
426 /** Sets the trusted CA and the certificate revocation list
427 * to use when verifying certificates
429 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
431 // Do nothing if certlist is NULL
434 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
435 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
439 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
440 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
443 trustedca = certlist;
449 class Profile : public refcountbase
451 /** Name of this profile
453 const std::string name;
455 /** X509 certificate(s) and key
457 X509Credentials x509cred;
459 /** The minimum length in bits for the DH prime to be accepted as a client
461 unsigned int min_dh_bits;
463 /** Hashing algorithm to use when generating certificate fingerprints
467 /** Priorities for ciphers, compression methods, etc.
471 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
472 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
473 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL)
475 , x509cred(certstr, keystr)
481 x509cred.SetCA(CA, CRL);
484 static std::string ReadFile(const std::string& filename)
486 FileReader reader(filename);
487 std::string ret = reader.GetString();
489 throw Exception("Cannot read file " + filename);
494 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
496 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
497 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
499 std::auto_ptr<DHParams> dh;
500 int gendh = tag->getInt("gendh");
503 gendh = (gendh < 1024 ? 1024 : gendh);
504 dh = DHParams::Generate(gendh);
507 dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
509 // Use default priority string if this tag does not specify one
510 std::string priostr = tag->getString("priority", "NORMAL");
511 unsigned int mindh = tag->getInt("mindhbits", 1024);
512 std::string hashstr = tag->getString("hash", "md5");
514 // Load trusted CA and revocation list, if set
515 std::auto_ptr<X509CertList> ca;
516 std::auto_ptr<X509CRL> crl;
517 std::string filename = tag->getString("cafile");
518 if (!filename.empty())
520 ca.reset(new X509CertList(ReadFile(filename)));
522 filename = tag->getString("crlfile");
523 if (!filename.empty())
524 crl.reset(new X509CRL(ReadFile(filename)));
527 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl);
530 /** Set up the given session with the settings in this profile
532 void SetupSession(gnutls_session_t sess)
534 priority.SetupSession(sess);
535 x509cred.SetupSession(sess);
536 gnutls_dh_set_prime_bits(sess, min_dh_bits);
539 const std::string& GetName() const { return name; }
540 X509Credentials& GetX509Credentials() { return x509cred; }
541 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
545 class GnuTLSIOHook : public SSLIOHook
548 gnutls_session_t sess;
550 reference<GnuTLS::Profile> profile;
552 void InitSession(StreamSocket* user, bool me_server)
554 gnutls_init(&sess, me_server ? GNUTLS_SERVER : GNUTLS_CLIENT);
556 profile->SetupSession(sess);
557 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
558 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
559 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
562 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
569 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
570 gnutls_deinit(this->sess);
577 bool Handshake(StreamSocket* user)
579 int ret = gnutls_handshake(this->sess);
583 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
585 // Handshake needs resuming later, read() or write() would have blocked.
587 if (gnutls_record_get_direction(this->sess) == 0)
589 // gnutls_handshake() wants to read() again.
590 this->status = ISSL_HANDSHAKING_READ;
591 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
595 // gnutls_handshake() wants to write() again.
596 this->status = ISSL_HANDSHAKING_WRITE;
597 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
602 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
604 this->status = ISSL_CLOSING;
611 // Change the seesion state
612 this->status = ISSL_HANDSHAKEN;
616 // Finish writing, if any left
617 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
623 void VerifyCertificate()
625 unsigned int certstatus;
626 const gnutls_datum_t* cert_list;
628 unsigned int cert_list_size;
629 gnutls_x509_crt_t cert;
631 unsigned char digest[512];
632 size_t digest_size = sizeof(digest);
633 size_t name_size = sizeof(str);
634 ssl_cert* certinfo = new ssl_cert;
635 this->certificate = certinfo;
637 /* This verification function uses the trusted CAs in the credentials
638 * structure. So you must have installed one or more CA certificates.
640 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
644 certinfo->error = std::string(gnutls_strerror(ret));
648 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
649 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
650 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
651 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
653 /* Up to here the process is the same for X.509 certificates and
654 * OpenPGP keys. From now on X.509 certificates are assumed. This can
655 * be easily extended to work with openpgp keys as well.
657 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
659 certinfo->error = "No X509 keys sent";
663 ret = gnutls_x509_crt_init(&cert);
666 certinfo->error = gnutls_strerror(ret);
671 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
672 if (cert_list == NULL)
674 certinfo->error = "No certificate was found";
675 goto info_done_dealloc;
678 /* This is not a real world example, since we only check the first
679 * certificate in the given chain.
682 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
685 certinfo->error = gnutls_strerror(ret);
686 goto info_done_dealloc;
689 gnutls_x509_crt_get_dn(cert, str, &name_size);
692 gnutls_x509_crt_get_issuer_dn(cert, str, &name_size);
693 certinfo->issuer = str;
695 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
697 certinfo->error = gnutls_strerror(ret);
701 certinfo->fingerprint = BinToHex(digest, digest_size);
704 /* Beware here we do not check for errors.
706 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
708 certinfo->error = "Not activated, or expired certificate";
712 gnutls_x509_crt_deinit(cert);
715 static const char* UnknownIfNULL(const char* str)
717 return str ? str : "UNKNOWN";
720 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
722 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
724 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
727 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
730 gnutls_transport_set_errno(session->sess, EAGAIN);
737 int rv = ServerInstance->SE->Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
742 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
743 * and then set errno appropriately.
744 * The gnutls library may also have a different errno variable than us, see
745 * gnutls_transport_set_errno(3).
747 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
752 ServerInstance->SE->ChangeEventMask(sock, FD_READ_WILL_BLOCK);
756 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
758 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
760 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
763 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
766 gnutls_transport_set_errno(session->sess, EAGAIN);
773 int rv = ServerInstance->SE->Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
778 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
779 * and then set errno appropriately.
780 * The gnutls library may also have a different errno variable than us, see
781 * gnutls_transport_set_errno(3).
783 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
788 ServerInstance->SE->ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
793 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool outbound, const reference<GnuTLS::Profile>& sslprofile)
794 : SSLIOHook(hookprov)
797 , profile(sslprofile)
799 InitSession(sock, outbound);
800 sock->AddIOHook(this);
804 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
809 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
814 user->SetError("No SSL session");
818 if (this->status == ISSL_HANDSHAKING_READ || this->status == ISSL_HANDSHAKING_WRITE)
820 // The handshake isn't finished, try to finish it.
822 if (!Handshake(user))
824 if (this->status != ISSL_CLOSING)
830 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
832 if (this->status == ISSL_HANDSHAKEN)
834 char* buffer = ServerInstance->GetReadBuffer();
835 size_t bufsiz = ServerInstance->Config->NetBufferSize;
836 int ret = gnutls_record_recv(this->sess, buffer, bufsiz);
839 recvq.append(buffer, ret);
842 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
848 user->SetError("Connection closed");
854 user->SetError(gnutls_strerror(ret));
859 else if (this->status == ISSL_CLOSING)
865 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq) CXX11_OVERRIDE
870 user->SetError("No SSL session");
874 if (this->status == ISSL_HANDSHAKING_WRITE || this->status == ISSL_HANDSHAKING_READ)
876 // The handshake isn't finished, try to finish it.
878 if (this->status != ISSL_CLOSING)
885 if (this->status == ISSL_HANDSHAKEN)
887 ret = gnutls_record_send(this->sess, sendq.data(), sendq.length());
889 if (ret == (int)sendq.length())
891 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE);
896 sendq = sendq.substr(ret);
897 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
900 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
902 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
907 user->SetError(gnutls_strerror(ret));
916 void TellCiphersAndFingerprint(LocalUser* user)
920 std::string text = "*** You are connected using SSL cipher '";
922 text += UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)));
923 text.append("-").append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).append("-");
924 text.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess)))).append("'");
926 if (!certificate->fingerprint.empty())
927 text += " and your SSL fingerprint is " + certificate->fingerprint;
929 user->WriteNotice(text);
933 GnuTLS::Profile* GetProfile() { return profile; }
936 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)
938 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
939 st->type = GNUTLS_CRT_X509;
941 st->cert_type = GNUTLS_CRT_X509;
942 st->key_type = GNUTLS_PRIVKEY_X509;
944 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
945 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetIOHook())->GetProfile()->GetX509Credentials();
947 st->ncerts = cred.certs.size();
948 st->cert.x509 = cred.certs.raw();
949 st->key.x509 = cred.key.get();
955 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
957 reference<GnuTLS::Profile> profile;
960 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
961 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
964 ServerInstance->Modules->AddService(*this);
967 ~GnuTLSIOHookProvider()
969 ServerInstance->Modules->DelService(*this);
972 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
974 new GnuTLSIOHook(this, sock, true, profile);
977 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
979 new GnuTLSIOHook(this, sock, false, profile);
983 class ModuleSSLGnuTLS : public Module
985 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
987 // First member of the class, gets constructed first and destructed last
988 GnuTLS::Init libinit;
990 std::string sslports;
993 ProfileList profiles;
997 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
998 // containers; this way if something goes wrong we can go back and continue using the current profiles,
999 // avoiding unpleasant situations where no new SSL connections are possible.
1000 ProfileList newprofiles;
1002 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1003 if (tags.first == tags.second)
1005 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1006 const std::string defname = "gnutls";
1007 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1008 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1012 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1013 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1015 catch (CoreException& ex)
1017 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1021 for (ConfigIter i = tags.first; i != tags.second; ++i)
1023 ConfigTag* tag = i->second;
1024 if (tag->getString("provider") != "gnutls")
1027 std::string name = tag->getString("name");
1030 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1034 reference<GnuTLS::Profile> profile;
1037 profile = GnuTLS::Profile::Create(name, tag);
1039 catch (CoreException& ex)
1041 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1044 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1047 // New profiles are ok, begin using them
1048 // Old profiles are deleted when their refcount drops to zero
1049 profiles.swap(newprofiles);
1055 #ifndef GNUTLS_HAS_RND
1056 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1060 void init() CXX11_OVERRIDE
1063 ServerInstance->GenRandom = &randhandler;
1066 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
1070 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
1072 if (Conf->getBool("showports", true))
1074 sslports = Conf->getString("advertisedports");
1075 if (!sslports.empty())
1078 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
1080 ListenSocket* port = ServerInstance->ports[i];
1081 if (port->bind_tag->getString("ssl") != "gnutls")
1084 const std::string& portid = port->bind_desc;
1085 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Enabling SSL for port %s", portid.c_str());
1087 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
1090 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
1091 * the IP:port in ISUPPORT.
1093 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
1094 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
1095 * To solve this by default we now only display the first IP:port found and let the user
1096 * configure the exact value for the 005 token, if necessary.
1105 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1114 catch (ModuleException& ex)
1116 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1122 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1125 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1127 if(target_type == TYPE_USER)
1129 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1131 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
1133 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1134 // Potentially there could be multiple SSL modules loaded at once on different ports.
1135 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1140 Version GetVersion() CXX11_OVERRIDE
1142 return Version("Provides SSL support for clients", VF_VENDOR);
1145 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
1147 if (!sslports.empty())
1148 tokens["SSL"] = sslports;
1151 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
1153 IOHook* hook = user->eh.GetIOHook();
1154 if (hook && hook->prov->creator == this)
1155 static_cast<GnuTLSIOHook*>(hook)->TellCiphersAndFingerprint(user);
1159 MODULE_INIT(ModuleSSLGnuTLS)