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 INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
77 #define GNUTLS_NEW_CERT_CALLBACK_API
78 typedef gnutls_retr2_st cert_cb_last_param_type;
80 typedef gnutls_retr_st cert_cb_last_param_type;
83 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 3, 5)
84 #define INSPIRCD_GNUTLS_HAS_RECV_PACKET
87 #if INSPIRCD_GNUTLS_HAS_VERSION(2, 99, 0)
88 // The second parameter of gnutls_init() has changed in 2.99.0 from gnutls_connection_end_t to unsigned int
89 // (it became a general flags parameter) and the enum has been deprecated and generates a warning on use.
90 typedef unsigned int inspircd_gnutls_session_init_flags_t;
92 typedef gnutls_connection_end_t inspircd_gnutls_session_init_flags_t;
95 #if INSPIRCD_GNUTLS_HAS_VERSION(3, 1, 9)
96 #define INSPIRCD_GNUTLS_HAS_CORK
99 class RandGen : public HandlerBase2<void, char*, size_t>
102 void Call(char* buffer, size_t len)
104 #ifdef GNUTLS_HAS_RND
105 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
107 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
117 Init() { gnutls_global_init(); }
118 ~Init() { gnutls_global_deinit(); }
121 class Exception : public ModuleException
124 Exception(const std::string& reason)
125 : ModuleException(reason) { }
128 void ThrowOnError(int errcode, const char* msg)
132 std::string reason = msg;
133 reason.append(" :").append(gnutls_strerror(errcode));
134 throw Exception(reason);
138 /** Used to create a gnutls_datum_t* from a std::string
142 gnutls_datum_t datum;
145 Datum(const std::string& dat)
147 datum.data = (unsigned char*)dat.data();
148 datum.size = static_cast<unsigned int>(dat.length());
151 const gnutls_datum_t* get() const { return &datum; }
156 gnutls_digest_algorithm_t hash;
159 // Nothing to deallocate, constructor may throw freely
160 Hash(const std::string& hashname)
162 // As older versions of gnutls can't do this, let's disable it where needed.
163 #ifdef GNUTLS_HAS_MAC_GET_ID
164 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
165 // There is no gnutls_dig_get_id() at the moment, but it may come later
166 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
167 if (hash == GNUTLS_DIG_UNKNOWN)
168 throw Exception("Unknown hash type " + hashname);
170 // Check if the user is giving us something that is a valid MAC but not digest
171 gnutls_hash_hd_t is_digest;
172 if (gnutls_hash_init(&is_digest, hash) < 0)
173 throw Exception("Unknown hash type " + hashname);
174 gnutls_hash_deinit(is_digest, NULL);
176 if (hashname == "md5")
177 hash = GNUTLS_DIG_MD5;
178 else if (hashname == "sha1")
179 hash = GNUTLS_DIG_SHA1;
180 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
181 else if (hashname == "sha256")
182 hash = GNUTLS_DIG_SHA256;
185 throw Exception("Unknown hash type " + hashname);
189 gnutls_digest_algorithm_t get() const { return hash; }
194 gnutls_dh_params_t dh_params;
198 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
203 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
205 std::auto_ptr<DHParams> dh(new DHParams);
206 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
207 ThrowOnError(ret, "Unable to import DH params");
212 static std::auto_ptr<DHParams> Generate(unsigned int bits)
214 std::auto_ptr<DHParams> dh(new DHParams);
215 ThrowOnError(gnutls_dh_params_generate2(dh->dh_params, bits), "Unable to generate DH params");
221 gnutls_dh_params_deinit(dh_params);
224 const gnutls_dh_params_t& get() const { return dh_params; }
229 /** Ensure that the key is deinited in case the constructor of X509Key throws
234 gnutls_x509_privkey_t key;
238 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
243 gnutls_x509_privkey_deinit(key);
249 X509Key(const std::string& keystr)
251 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
252 ThrowOnError(ret, "Unable to import private key");
255 gnutls_x509_privkey_t& get() { return key.key; }
260 std::vector<gnutls_x509_crt_t> certs;
264 X509CertList(const std::string& certstr)
266 unsigned int certcount = 3;
267 certs.resize(certcount);
268 Datum datum(certstr);
270 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
271 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
273 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
274 // try again with a bigger buffer
275 certs.resize(certcount);
276 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
279 ThrowOnError(ret, "Unable to load certificates");
281 // Resize the vector to the actual number of certs because we rely on its size being correct
282 // when deallocating the certs
283 certs.resize(certcount);
288 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
289 gnutls_x509_crt_deinit(*i);
292 gnutls_x509_crt_t* raw() { return &certs[0]; }
293 unsigned int size() const { return certs.size(); }
296 class X509CRL : public refcountbase
301 gnutls_x509_crl_t crl;
305 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
310 gnutls_x509_crl_deinit(crl);
316 X509CRL(const std::string& crlstr)
318 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
319 ThrowOnError(ret, "Unable to load certificate revocation list");
322 gnutls_x509_crl_t& get() { return crl.crl; }
325 #ifdef GNUTLS_NEW_PRIO_API
328 gnutls_priority_t priority;
331 Priority(const std::string& priorities)
333 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
334 // If the user did not supply anything then the string is already set to "NORMAL"
335 const char* priocstr = priorities.c_str();
336 const char* prioerror;
338 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
341 // gnutls did not understand the user supplied string
342 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
348 gnutls_priority_deinit(priority);
351 void SetupSession(gnutls_session_t sess)
353 gnutls_priority_set(sess, priority);
357 /** Dummy class, used when gnutls_priority_set() is not available
362 Priority(const std::string& priorities)
364 if (priorities != "NORMAL")
365 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
368 static void SetupSession(gnutls_session_t sess)
370 // Always set the default priorities
371 gnutls_set_default_priority(sess);
376 class CertCredentials
378 /** DH parameters associated with these credentials
380 std::auto_ptr<DHParams> dh;
383 gnutls_certificate_credentials_t cred;
388 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
393 gnutls_certificate_free_credentials(cred);
396 /** Associates these credentials with the session
398 void SetupSession(gnutls_session_t sess)
400 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
403 /** Set the given DH parameters to be used with these credentials
405 void SetDH(std::auto_ptr<DHParams>& DH)
408 gnutls_certificate_set_dh_params(cred, dh->get());
412 class X509Credentials : public CertCredentials
418 /** Certificate list, presented to the peer
422 /** Trusted CA, may be NULL
424 std::auto_ptr<X509CertList> trustedca;
426 /** Certificate revocation list, may be NULL
428 std::auto_ptr<X509CRL> crl;
430 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);
433 X509Credentials(const std::string& certstr, const std::string& keystr)
437 // Throwing is ok here, the destructor of Credentials is called in that case
438 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
439 ThrowOnError(ret, "Unable to set cert/key pair");
441 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
442 gnutls_certificate_set_retrieve_function(cred, cert_callback);
444 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
448 /** Sets the trusted CA and the certificate revocation list
449 * to use when verifying certificates
451 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
453 // Do nothing if certlist is NULL
456 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
457 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
461 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
462 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
465 trustedca = certlist;
474 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
475 gnutls_packet_t packet;
478 DataReader(gnutls_session_t sess)
480 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
481 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
482 // to the recvq directly from there in appendto().
483 retval = gnutls_record_recv_packet(sess, &packet);
486 void appendto(std::string& recvq)
488 // Copy data from GnuTLS buffers to recvq
489 gnutls_datum_t datum;
490 gnutls_packet_get(packet, &datum, NULL);
491 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
493 gnutls_packet_deinit(packet);
499 DataReader(gnutls_session_t sess)
500 : buffer(ServerInstance->GetReadBuffer())
502 // Read data from GnuTLS buffers into ReadBuffer
503 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
506 void appendto(std::string& recvq)
508 // Copy data from ReadBuffer to recvq
509 recvq.append(buffer, retval);
513 int ret() const { return retval; }
516 class Profile : public refcountbase
518 /** Name of this profile
520 const std::string name;
522 /** X509 certificate(s) and key
524 X509Credentials x509cred;
526 /** The minimum length in bits for the DH prime to be accepted as a client
528 unsigned int min_dh_bits;
530 /** Hashing algorithm to use when generating certificate fingerprints
534 /** Priorities for ciphers, compression methods, etc.
538 /** Rough max size of records to send
540 const unsigned int outrecsize;
542 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
543 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
544 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL,
545 unsigned int recsize)
547 , x509cred(certstr, keystr)
551 , outrecsize(recsize)
554 x509cred.SetCA(CA, CRL);
557 static std::string ReadFile(const std::string& filename)
559 FileReader reader(filename);
560 std::string ret = reader.GetString();
562 throw Exception("Cannot read file " + filename);
567 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
569 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
570 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
572 std::auto_ptr<DHParams> dh;
573 int gendh = tag->getInt("gendh");
576 gendh = (gendh < 1024 ? 1024 : gendh);
577 dh = DHParams::Generate(gendh);
580 dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
582 // Use default priority string if this tag does not specify one
583 std::string priostr = tag->getString("priority", "NORMAL");
584 unsigned int mindh = tag->getInt("mindhbits", 1024);
585 std::string hashstr = tag->getString("hash", "md5");
587 // Load trusted CA and revocation list, if set
588 std::auto_ptr<X509CertList> ca;
589 std::auto_ptr<X509CRL> crl;
590 std::string filename = tag->getString("cafile");
591 if (!filename.empty())
593 ca.reset(new X509CertList(ReadFile(filename)));
595 filename = tag->getString("crlfile");
596 if (!filename.empty())
597 crl.reset(new X509CRL(ReadFile(filename)));
600 #ifdef INSPIRCD_GNUTLS_HAS_CORK
601 // If cork support is available outrecsize represents the (rough) max amount of data we give GnuTLS while corked
602 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512);
604 unsigned int outrecsize = tag->getInt("outrecsize", 2048, 512, 16384);
606 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl, outrecsize);
609 /** Set up the given session with the settings in this profile
611 void SetupSession(gnutls_session_t sess)
613 priority.SetupSession(sess);
614 x509cred.SetupSession(sess);
615 gnutls_dh_set_prime_bits(sess, min_dh_bits);
617 // Request client certificate if we are a server, no-op if we're a client
618 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
621 const std::string& GetName() const { return name; }
622 X509Credentials& GetX509Credentials() { return x509cred; }
623 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
624 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
628 class GnuTLSIOHook : public SSLIOHook
631 gnutls_session_t sess;
633 reference<GnuTLS::Profile> profile;
634 #ifdef INSPIRCD_GNUTLS_HAS_CORK
642 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
643 gnutls_deinit(this->sess);
650 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
651 int Handshake(StreamSocket* user)
653 int ret = gnutls_handshake(this->sess);
657 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
659 // Handshake needs resuming later, read() or write() would have blocked.
660 this->status = ISSL_HANDSHAKING;
662 if (gnutls_record_get_direction(this->sess) == 0)
664 // gnutls_handshake() wants to read() again.
665 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
669 // gnutls_handshake() wants to write() again.
670 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
677 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
684 // Change the seesion state
685 this->status = ISSL_HANDSHAKEN;
689 // Finish writing, if any left
690 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
696 void VerifyCertificate()
698 unsigned int certstatus;
699 const gnutls_datum_t* cert_list;
701 unsigned int cert_list_size;
702 gnutls_x509_crt_t cert;
704 unsigned char digest[512];
705 size_t digest_size = sizeof(digest);
706 size_t name_size = sizeof(str);
707 ssl_cert* certinfo = new ssl_cert;
708 this->certificate = certinfo;
710 /* This verification function uses the trusted CAs in the credentials
711 * structure. So you must have installed one or more CA certificates.
713 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
717 certinfo->error = std::string(gnutls_strerror(ret));
721 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
722 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
723 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
724 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
726 /* Up to here the process is the same for X.509 certificates and
727 * OpenPGP keys. From now on X.509 certificates are assumed. This can
728 * be easily extended to work with openpgp keys as well.
730 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
732 certinfo->error = "No X509 keys sent";
736 ret = gnutls_x509_crt_init(&cert);
739 certinfo->error = gnutls_strerror(ret);
744 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
745 if (cert_list == NULL)
747 certinfo->error = "No certificate was found";
748 goto info_done_dealloc;
751 /* This is not a real world example, since we only check the first
752 * certificate in the given chain.
755 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
758 certinfo->error = gnutls_strerror(ret);
759 goto info_done_dealloc;
762 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
764 std::string& dn = certinfo->dn;
766 // Make sure there are no chars in the string that we consider invalid
767 if (dn.find_first_of("\r\n") != std::string::npos)
771 name_size = sizeof(str);
772 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
774 std::string& issuer = certinfo->issuer;
776 if (issuer.find_first_of("\r\n") != std::string::npos)
780 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
782 certinfo->error = gnutls_strerror(ret);
786 certinfo->fingerprint = BinToHex(digest, digest_size);
789 /* Beware here we do not check for errors.
791 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
793 certinfo->error = "Not activated, or expired certificate";
797 gnutls_x509_crt_deinit(cert);
800 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
801 int PrepareIO(StreamSocket* sock)
803 if (status == ISSL_HANDSHAKEN)
805 else if (status == ISSL_HANDSHAKING)
807 // The handshake isn't finished, try to finish it
808 return Handshake(sock);
812 sock->SetError("No SSL session");
816 #ifdef INSPIRCD_GNUTLS_HAS_CORK
817 int FlushBuffer(StreamSocket* sock)
819 // If GnuTLS has some data buffered, write it
821 return HandleWriteRet(sock, gnutls_record_uncork(this->sess, 0));
826 int HandleWriteRet(StreamSocket* sock, int ret)
830 #ifdef INSPIRCD_GNUTLS_HAS_CORK
834 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
840 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
842 SocketEngine::ChangeEventMask(sock, FD_WANT_SINGLE_WRITE);
847 sock->SetError(gnutls_strerror(ret));
853 static const char* UnknownIfNULL(const char* str)
855 return str ? str : "UNKNOWN";
858 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
860 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
862 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
865 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
868 gnutls_transport_set_errno(session->sess, EAGAIN);
875 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
880 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
881 * and then set errno appropriately.
882 * The gnutls library may also have a different errno variable than us, see
883 * gnutls_transport_set_errno(3).
885 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
890 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
894 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
895 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
897 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
899 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
902 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
905 gnutls_transport_set_errno(session->sess, EAGAIN);
912 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
913 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
915 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
917 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
921 for (int i = 0; i < iovcnt; i++)
922 size += iov[i].iov_len;
925 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
929 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
930 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
932 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
934 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
937 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
940 gnutls_transport_set_errno(session->sess, EAGAIN);
947 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
952 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
953 * and then set errno appropriately.
954 * The gnutls library may also have a different errno variable than us, see
955 * gnutls_transport_set_errno(3).
957 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
962 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
965 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
968 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags, const reference<GnuTLS::Profile>& sslprofile)
969 : SSLIOHook(hookprov)
972 , profile(sslprofile)
973 #ifdef INSPIRCD_GNUTLS_HAS_CORK
977 gnutls_init(&sess, flags);
978 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
979 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
980 gnutls_transport_set_vec_push_function(sess, VectorPush);
982 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
984 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
985 profile->SetupSession(sess);
987 sock->AddIOHook(this);
991 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
996 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
998 // Finish handshake if needed
999 int prepret = PrepareIO(user);
1003 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
1005 GnuTLS::DataReader reader(sess);
1006 int ret = reader.ret();
1009 reader.appendto(recvq);
1012 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
1018 user->SetError("Connection closed");
1024 user->SetError(gnutls_strerror(ret));
1031 int OnStreamSocketWrite(StreamSocket* user) CXX11_OVERRIDE
1033 // Finish handshake if needed
1034 int prepret = PrepareIO(user);
1038 // Session is ready for transferring application data
1039 StreamSocket::SendQueue& sendq = user->GetSendQ();
1041 #ifdef INSPIRCD_GNUTLS_HAS_CORK
1044 // If there is something in the GnuTLS buffer try to send() it
1045 int ret = FlushBuffer(user);
1047 return ret; // Couldn't flush entire buffer, retry later (or close on error)
1049 // GnuTLS buffer is empty, if the sendq is empty as well then break to set FD_WANT_NO_WRITE
1053 // GnuTLS buffer is empty but sendq is not, begin sending data from the sendq
1054 gnutls_record_cork(this->sess);
1055 while ((!sendq.empty()) && (gbuffersize < profile->GetOutgoingRecordSize()))
1057 const StreamSocket::SendQueue::Element& elem = sendq.front();
1058 gbuffersize += elem.length();
1059 ret = gnutls_record_send(this->sess, elem.data(), elem.length());
1071 while (!sendq.empty())
1073 FlattenSendQueue(sendq, profile->GetOutgoingRecordSize());
1074 const StreamSocket::SendQueue::Element& buffer = sendq.front();
1075 ret = HandleWriteRet(user, gnutls_record_send(this->sess, buffer.data(), buffer.length()));
1079 else if (ret < (int)buffer.length())
1081 sendq.erase_front(ret);
1082 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1086 // Wrote entire record, continue sending
1091 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
1095 void TellCiphersAndFingerprint(LocalUser* user)
1099 std::string text = "*** You are connected using SSL cipher '";
1100 GetCiphersuite(text);
1102 if (!certificate->fingerprint.empty())
1103 text += " and your SSL certificate fingerprint is " + certificate->fingerprint;
1105 user->WriteNotice(text);
1109 void GetCiphersuite(std::string& out) const
1111 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1112 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1113 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1114 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1117 GnuTLS::Profile* GetProfile() { return profile; }
1118 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1121 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)
1123 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1124 st->type = GNUTLS_CRT_X509;
1126 st->cert_type = GNUTLS_CRT_X509;
1127 st->key_type = GNUTLS_PRIVKEY_X509;
1129 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1130 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetIOHook())->GetProfile()->GetX509Credentials();
1132 st->ncerts = cred.certs.size();
1133 st->cert.x509 = cred.certs.raw();
1134 st->key.x509 = cred.key.get();
1140 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1142 reference<GnuTLS::Profile> profile;
1145 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1146 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1149 ServerInstance->Modules->AddService(*this);
1152 ~GnuTLSIOHookProvider()
1154 ServerInstance->Modules->DelService(*this);
1157 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1159 new GnuTLSIOHook(this, sock, GNUTLS_SERVER, profile);
1162 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1164 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT, profile);
1168 class ModuleSSLGnuTLS : public Module
1170 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1172 // First member of the class, gets constructed first and destructed last
1173 GnuTLS::Init libinit;
1174 RandGen randhandler;
1175 ProfileList profiles;
1179 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1180 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1181 // avoiding unpleasant situations where no new SSL connections are possible.
1182 ProfileList newprofiles;
1184 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1185 if (tags.first == tags.second)
1187 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1188 const std::string defname = "gnutls";
1189 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1190 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1194 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1195 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1197 catch (CoreException& ex)
1199 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1203 for (ConfigIter i = tags.first; i != tags.second; ++i)
1205 ConfigTag* tag = i->second;
1206 if (tag->getString("provider") != "gnutls")
1209 std::string name = tag->getString("name");
1212 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1216 reference<GnuTLS::Profile> profile;
1219 profile = GnuTLS::Profile::Create(name, tag);
1221 catch (CoreException& ex)
1223 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1226 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1229 // New profiles are ok, begin using them
1230 // Old profiles are deleted when their refcount drops to zero
1231 profiles.swap(newprofiles);
1237 #ifndef GNUTLS_HAS_RND
1238 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1242 void init() CXX11_OVERRIDE
1245 ServerInstance->GenRandom = &randhandler;
1248 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1257 catch (ModuleException& ex)
1259 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1265 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1268 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1270 if(target_type == TYPE_USER)
1272 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1274 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
1276 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1277 // Potentially there could be multiple SSL modules loaded at once on different ports.
1278 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1283 Version GetVersion() CXX11_OVERRIDE
1285 return Version("Provides SSL support for clients", VF_VENDOR);
1288 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
1290 IOHook* hook = user->eh.GetIOHook();
1291 if (hook && hook->prov->creator == this)
1292 static_cast<GnuTLSIOHook*>(hook)->TellCiphersAndFingerprint(user);
1295 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1297 if ((user->eh.GetIOHook()) && (user->eh.GetIOHook()->prov->creator == this))
1299 GnuTLSIOHook* iohook = static_cast<GnuTLSIOHook*>(user->eh.GetIOHook());
1300 if (!iohook->IsHandshakeDone())
1301 return MOD_RES_DENY;
1304 return MOD_RES_PASSTHRU;
1308 MODULE_INIT(ModuleSSLGnuTLS)