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 class RandGen : public HandlerBase2<void, char*, size_t>
98 void Call(char* buffer, size_t len)
100 #ifdef GNUTLS_HAS_RND
101 gnutls_rnd(GNUTLS_RND_RANDOM, buffer, len);
103 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
113 Init() { gnutls_global_init(); }
114 ~Init() { gnutls_global_deinit(); }
117 class Exception : public ModuleException
120 Exception(const std::string& reason)
121 : ModuleException(reason) { }
124 void ThrowOnError(int errcode, const char* msg)
128 std::string reason = msg;
129 reason.append(" :").append(gnutls_strerror(errcode));
130 throw Exception(reason);
134 /** Used to create a gnutls_datum_t* from a std::string
138 gnutls_datum_t datum;
141 Datum(const std::string& dat)
143 datum.data = (unsigned char*)dat.data();
144 datum.size = static_cast<unsigned int>(dat.length());
147 const gnutls_datum_t* get() const { return &datum; }
152 gnutls_digest_algorithm_t hash;
155 // Nothing to deallocate, constructor may throw freely
156 Hash(const std::string& hashname)
158 // As older versions of gnutls can't do this, let's disable it where needed.
159 #ifdef GNUTLS_HAS_MAC_GET_ID
160 // As gnutls_digest_algorithm_t and gnutls_mac_algorithm_t are mapped 1:1, we can do this
161 // There is no gnutls_dig_get_id() at the moment, but it may come later
162 hash = (gnutls_digest_algorithm_t)gnutls_mac_get_id(hashname.c_str());
163 if (hash == GNUTLS_DIG_UNKNOWN)
164 throw Exception("Unknown hash type " + hashname);
166 // Check if the user is giving us something that is a valid MAC but not digest
167 gnutls_hash_hd_t is_digest;
168 if (gnutls_hash_init(&is_digest, hash) < 0)
169 throw Exception("Unknown hash type " + hashname);
170 gnutls_hash_deinit(is_digest, NULL);
172 if (hashname == "md5")
173 hash = GNUTLS_DIG_MD5;
174 else if (hashname == "sha1")
175 hash = GNUTLS_DIG_SHA1;
176 #ifdef INSPIRCD_GNUTLS_ENABLE_SHA256_FINGERPRINT
177 else if (hashname == "sha256")
178 hash = GNUTLS_DIG_SHA256;
181 throw Exception("Unknown hash type " + hashname);
185 gnutls_digest_algorithm_t get() const { return hash; }
190 gnutls_dh_params_t dh_params;
194 ThrowOnError(gnutls_dh_params_init(&dh_params), "gnutls_dh_params_init() failed");
199 static std::auto_ptr<DHParams> Import(const std::string& dhstr)
201 std::auto_ptr<DHParams> dh(new DHParams);
202 int ret = gnutls_dh_params_import_pkcs3(dh->dh_params, Datum(dhstr).get(), GNUTLS_X509_FMT_PEM);
203 ThrowOnError(ret, "Unable to import DH params");
208 static std::auto_ptr<DHParams> Generate(unsigned int bits)
210 std::auto_ptr<DHParams> dh(new DHParams);
211 ThrowOnError(gnutls_dh_params_generate2(dh->dh_params, bits), "Unable to generate DH params");
217 gnutls_dh_params_deinit(dh_params);
220 const gnutls_dh_params_t& get() const { return dh_params; }
225 /** Ensure that the key is deinited in case the constructor of X509Key throws
230 gnutls_x509_privkey_t key;
234 ThrowOnError(gnutls_x509_privkey_init(&key), "gnutls_x509_privkey_init() failed");
239 gnutls_x509_privkey_deinit(key);
245 X509Key(const std::string& keystr)
247 int ret = gnutls_x509_privkey_import(key.key, Datum(keystr).get(), GNUTLS_X509_FMT_PEM);
248 ThrowOnError(ret, "Unable to import private key");
251 gnutls_x509_privkey_t& get() { return key.key; }
256 std::vector<gnutls_x509_crt_t> certs;
260 X509CertList(const std::string& certstr)
262 unsigned int certcount = 3;
263 certs.resize(certcount);
264 Datum datum(certstr);
266 int ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
267 if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER)
269 // the buffer wasn't big enough to hold all certs but gnutls changed certcount to the number of available certs,
270 // try again with a bigger buffer
271 certs.resize(certcount);
272 ret = gnutls_x509_crt_list_import(raw(), &certcount, datum.get(), GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
275 ThrowOnError(ret, "Unable to load certificates");
277 // Resize the vector to the actual number of certs because we rely on its size being correct
278 // when deallocating the certs
279 certs.resize(certcount);
284 for (std::vector<gnutls_x509_crt_t>::iterator i = certs.begin(); i != certs.end(); ++i)
285 gnutls_x509_crt_deinit(*i);
288 gnutls_x509_crt_t* raw() { return &certs[0]; }
289 unsigned int size() const { return certs.size(); }
292 class X509CRL : public refcountbase
297 gnutls_x509_crl_t crl;
301 ThrowOnError(gnutls_x509_crl_init(&crl), "gnutls_x509_crl_init() failed");
306 gnutls_x509_crl_deinit(crl);
312 X509CRL(const std::string& crlstr)
314 int ret = gnutls_x509_crl_import(get(), Datum(crlstr).get(), GNUTLS_X509_FMT_PEM);
315 ThrowOnError(ret, "Unable to load certificate revocation list");
318 gnutls_x509_crl_t& get() { return crl.crl; }
321 #ifdef GNUTLS_NEW_PRIO_API
324 gnutls_priority_t priority;
327 Priority(const std::string& priorities)
329 // Try to set the priorities for ciphers, kex methods etc. to the user supplied string
330 // If the user did not supply anything then the string is already set to "NORMAL"
331 const char* priocstr = priorities.c_str();
332 const char* prioerror;
334 int ret = gnutls_priority_init(&priority, priocstr, &prioerror);
337 // gnutls did not understand the user supplied string
338 throw Exception("Unable to initialize priorities to \"" + priorities + "\": " + gnutls_strerror(ret) + " Syntax error at position " + ConvToStr((unsigned int) (prioerror - priocstr)));
344 gnutls_priority_deinit(priority);
347 void SetupSession(gnutls_session_t sess)
349 gnutls_priority_set(sess, priority);
353 /** Dummy class, used when gnutls_priority_set() is not available
358 Priority(const std::string& priorities)
360 if (priorities != "NORMAL")
361 throw Exception("You've set a non-default priority string, but GnuTLS lacks support for it");
364 static void SetupSession(gnutls_session_t sess)
366 // Always set the default priorities
367 gnutls_set_default_priority(sess);
372 class CertCredentials
374 /** DH parameters associated with these credentials
376 std::auto_ptr<DHParams> dh;
379 gnutls_certificate_credentials_t cred;
384 ThrowOnError(gnutls_certificate_allocate_credentials(&cred), "Cannot allocate certificate credentials");
389 gnutls_certificate_free_credentials(cred);
392 /** Associates these credentials with the session
394 void SetupSession(gnutls_session_t sess)
396 gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, cred);
399 /** Set the given DH parameters to be used with these credentials
401 void SetDH(std::auto_ptr<DHParams>& DH)
404 gnutls_certificate_set_dh_params(cred, dh->get());
408 class X509Credentials : public CertCredentials
414 /** Certificate list, presented to the peer
418 /** Trusted CA, may be NULL
420 std::auto_ptr<X509CertList> trustedca;
422 /** Certificate revocation list, may be NULL
424 std::auto_ptr<X509CRL> crl;
426 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);
429 X509Credentials(const std::string& certstr, const std::string& keystr)
433 // Throwing is ok here, the destructor of Credentials is called in that case
434 int ret = gnutls_certificate_set_x509_key(cred, certs.raw(), certs.size(), key.get());
435 ThrowOnError(ret, "Unable to set cert/key pair");
437 #ifdef GNUTLS_NEW_CERT_CALLBACK_API
438 gnutls_certificate_set_retrieve_function(cred, cert_callback);
440 gnutls_certificate_client_set_retrieve_function(cred, cert_callback);
444 /** Sets the trusted CA and the certificate revocation list
445 * to use when verifying certificates
447 void SetCA(std::auto_ptr<X509CertList>& certlist, std::auto_ptr<X509CRL>& CRL)
449 // Do nothing if certlist is NULL
452 int ret = gnutls_certificate_set_x509_trust(cred, certlist->raw(), certlist->size());
453 ThrowOnError(ret, "gnutls_certificate_set_x509_trust() failed");
457 ret = gnutls_certificate_set_x509_crl(cred, &CRL->get(), 1);
458 ThrowOnError(ret, "gnutls_certificate_set_x509_crl() failed");
461 trustedca = certlist;
470 #ifdef INSPIRCD_GNUTLS_HAS_RECV_PACKET
471 gnutls_packet_t packet;
474 DataReader(gnutls_session_t sess)
476 // Using the packet API avoids the final copy of the data which GnuTLS does if we supply
477 // our own buffer. Instead, we get the buffer containing the data from GnuTLS and copy it
478 // to the recvq directly from there in appendto().
479 retval = gnutls_record_recv_packet(sess, &packet);
482 void appendto(std::string& recvq)
484 // Copy data from GnuTLS buffers to recvq
485 gnutls_datum_t datum;
486 gnutls_packet_get(packet, &datum, NULL);
487 recvq.append(reinterpret_cast<const char*>(datum.data), datum.size);
489 gnutls_packet_deinit(packet);
495 DataReader(gnutls_session_t sess)
496 : buffer(ServerInstance->GetReadBuffer())
498 // Read data from GnuTLS buffers into ReadBuffer
499 retval = gnutls_record_recv(sess, buffer, ServerInstance->Config->NetBufferSize);
502 void appendto(std::string& recvq)
504 // Copy data from ReadBuffer to recvq
505 recvq.append(buffer, retval);
509 int ret() const { return retval; }
512 class Profile : public refcountbase
514 /** Name of this profile
516 const std::string name;
518 /** X509 certificate(s) and key
520 X509Credentials x509cred;
522 /** The minimum length in bits for the DH prime to be accepted as a client
524 unsigned int min_dh_bits;
526 /** Hashing algorithm to use when generating certificate fingerprints
530 /** Priorities for ciphers, compression methods, etc.
534 Profile(const std::string& profilename, const std::string& certstr, const std::string& keystr,
535 std::auto_ptr<DHParams>& DH, unsigned int mindh, const std::string& hashstr,
536 const std::string& priostr, std::auto_ptr<X509CertList>& CA, std::auto_ptr<X509CRL>& CRL)
538 , x509cred(certstr, keystr)
544 x509cred.SetCA(CA, CRL);
547 static std::string ReadFile(const std::string& filename)
549 FileReader reader(filename);
550 std::string ret = reader.GetString();
552 throw Exception("Cannot read file " + filename);
557 static reference<Profile> Create(const std::string& profilename, ConfigTag* tag)
559 std::string certstr = ReadFile(tag->getString("certfile", "cert.pem"));
560 std::string keystr = ReadFile(tag->getString("keyfile", "key.pem"));
562 std::auto_ptr<DHParams> dh;
563 int gendh = tag->getInt("gendh");
566 gendh = (gendh < 1024 ? 1024 : gendh);
567 dh = DHParams::Generate(gendh);
570 dh = DHParams::Import(ReadFile(tag->getString("dhfile", "dhparams.pem")));
572 // Use default priority string if this tag does not specify one
573 std::string priostr = tag->getString("priority", "NORMAL");
574 unsigned int mindh = tag->getInt("mindhbits", 1024);
575 std::string hashstr = tag->getString("hash", "md5");
577 // Load trusted CA and revocation list, if set
578 std::auto_ptr<X509CertList> ca;
579 std::auto_ptr<X509CRL> crl;
580 std::string filename = tag->getString("cafile");
581 if (!filename.empty())
583 ca.reset(new X509CertList(ReadFile(filename)));
585 filename = tag->getString("crlfile");
586 if (!filename.empty())
587 crl.reset(new X509CRL(ReadFile(filename)));
590 return new Profile(profilename, certstr, keystr, dh, mindh, hashstr, priostr, ca, crl);
593 /** Set up the given session with the settings in this profile
595 void SetupSession(gnutls_session_t sess)
597 priority.SetupSession(sess);
598 x509cred.SetupSession(sess);
599 gnutls_dh_set_prime_bits(sess, min_dh_bits);
601 // Request client certificate if we are a server, no-op if we're a client
602 gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST);
605 const std::string& GetName() const { return name; }
606 X509Credentials& GetX509Credentials() { return x509cred; }
607 gnutls_digest_algorithm_t GetHash() const { return hash.get(); }
611 class GnuTLSIOHook : public SSLIOHook
614 gnutls_session_t sess;
616 reference<GnuTLS::Profile> profile;
622 gnutls_bye(this->sess, GNUTLS_SHUT_WR);
623 gnutls_deinit(this->sess);
630 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
631 int Handshake(StreamSocket* user)
633 int ret = gnutls_handshake(this->sess);
637 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
639 // Handshake needs resuming later, read() or write() would have blocked.
640 this->status = ISSL_HANDSHAKING;
642 if (gnutls_record_get_direction(this->sess) == 0)
644 // gnutls_handshake() wants to read() again.
645 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
649 // gnutls_handshake() wants to write() again.
650 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
657 user->SetError("Handshake Failed - " + std::string(gnutls_strerror(ret)));
664 // Change the seesion state
665 this->status = ISSL_HANDSHAKEN;
669 // Finish writing, if any left
670 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
676 void VerifyCertificate()
678 unsigned int certstatus;
679 const gnutls_datum_t* cert_list;
681 unsigned int cert_list_size;
682 gnutls_x509_crt_t cert;
684 unsigned char digest[512];
685 size_t digest_size = sizeof(digest);
686 size_t name_size = sizeof(str);
687 ssl_cert* certinfo = new ssl_cert;
688 this->certificate = certinfo;
690 /* This verification function uses the trusted CAs in the credentials
691 * structure. So you must have installed one or more CA certificates.
693 ret = gnutls_certificate_verify_peers2(this->sess, &certstatus);
697 certinfo->error = std::string(gnutls_strerror(ret));
701 certinfo->invalid = (certstatus & GNUTLS_CERT_INVALID);
702 certinfo->unknownsigner = (certstatus & GNUTLS_CERT_SIGNER_NOT_FOUND);
703 certinfo->revoked = (certstatus & GNUTLS_CERT_REVOKED);
704 certinfo->trusted = !(certstatus & GNUTLS_CERT_SIGNER_NOT_CA);
706 /* Up to here the process is the same for X.509 certificates and
707 * OpenPGP keys. From now on X.509 certificates are assumed. This can
708 * be easily extended to work with openpgp keys as well.
710 if (gnutls_certificate_type_get(this->sess) != GNUTLS_CRT_X509)
712 certinfo->error = "No X509 keys sent";
716 ret = gnutls_x509_crt_init(&cert);
719 certinfo->error = gnutls_strerror(ret);
724 cert_list = gnutls_certificate_get_peers(this->sess, &cert_list_size);
725 if (cert_list == NULL)
727 certinfo->error = "No certificate was found";
728 goto info_done_dealloc;
731 /* This is not a real world example, since we only check the first
732 * certificate in the given chain.
735 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
738 certinfo->error = gnutls_strerror(ret);
739 goto info_done_dealloc;
742 if (gnutls_x509_crt_get_dn(cert, str, &name_size) == 0)
744 std::string& dn = certinfo->dn;
746 // Make sure there are no chars in the string that we consider invalid
747 if (dn.find_first_of("\r\n") != std::string::npos)
751 name_size = sizeof(str);
752 if (gnutls_x509_crt_get_issuer_dn(cert, str, &name_size) == 0)
754 std::string& issuer = certinfo->issuer;
756 if (issuer.find_first_of("\r\n") != std::string::npos)
760 if ((ret = gnutls_x509_crt_get_fingerprint(cert, profile->GetHash(), digest, &digest_size)) < 0)
762 certinfo->error = gnutls_strerror(ret);
766 certinfo->fingerprint = BinToHex(digest, digest_size);
769 /* Beware here we do not check for errors.
771 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
773 certinfo->error = "Not activated, or expired certificate";
777 gnutls_x509_crt_deinit(cert);
780 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
781 int PrepareIO(StreamSocket* sock)
783 if (status == ISSL_HANDSHAKEN)
785 else if (status == ISSL_HANDSHAKING)
787 // The handshake isn't finished, try to finish it
788 return Handshake(sock);
792 sock->SetError("No SSL session");
796 static const char* UnknownIfNULL(const char* str)
798 return str ? str : "UNKNOWN";
801 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t session_wrap, void* buffer, size_t size)
803 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
805 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
808 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
811 gnutls_transport_set_errno(session->sess, EAGAIN);
818 int rv = SocketEngine::Recv(sock, reinterpret_cast<char *>(buffer), size, 0);
823 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
824 * and then set errno appropriately.
825 * The gnutls library may also have a different errno variable than us, see
826 * gnutls_transport_set_errno(3).
828 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
833 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
837 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
838 static ssize_t VectorPush(gnutls_transport_ptr_t transportptr, const giovec_t* iov, int iovcnt)
840 StreamSocket* sock = reinterpret_cast<StreamSocket*>(transportptr);
842 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
845 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
848 gnutls_transport_set_errno(session->sess, EAGAIN);
855 // Cast the giovec_t to iovec not to IOVector so the correct function is called on Windows
856 int ret = SocketEngine::WriteV(sock, reinterpret_cast<const iovec*>(iov), iovcnt);
858 // See the function above for more info about the usage of gnutls_transport_set_errno() on Windows
860 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
864 for (int i = 0; i < iovcnt; i++)
865 size += iov[i].iov_len;
868 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
872 #else // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
873 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t session_wrap, const void* buffer, size_t size)
875 StreamSocket* sock = reinterpret_cast<StreamSocket*>(session_wrap);
877 GnuTLSIOHook* session = static_cast<GnuTLSIOHook*>(sock->GetIOHook());
880 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
883 gnutls_transport_set_errno(session->sess, EAGAIN);
890 int rv = SocketEngine::Send(sock, reinterpret_cast<const char *>(buffer), size, 0);
895 /* Windows doesn't use errno, but gnutls does, so check SocketEngine::IgnoreError()
896 * and then set errno appropriately.
897 * The gnutls library may also have a different errno variable than us, see
898 * gnutls_transport_set_errno(3).
900 gnutls_transport_set_errno(session->sess, SocketEngine::IgnoreError() ? EAGAIN : errno);
905 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
908 #endif // INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
911 GnuTLSIOHook(IOHookProvider* hookprov, StreamSocket* sock, inspircd_gnutls_session_init_flags_t flags, const reference<GnuTLS::Profile>& sslprofile)
912 : SSLIOHook(hookprov)
915 , profile(sslprofile)
917 gnutls_init(&sess, flags);
918 gnutls_transport_set_ptr(sess, reinterpret_cast<gnutls_transport_ptr_t>(sock));
919 #ifdef INSPIRCD_GNUTLS_HAS_VECTOR_PUSH
920 gnutls_transport_set_vec_push_function(sess, VectorPush);
922 gnutls_transport_set_push_function(sess, gnutls_push_wrapper);
924 gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper);
925 profile->SetupSession(sess);
927 sock->AddIOHook(this);
931 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
936 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
938 // Finish handshake if needed
939 int prepret = PrepareIO(user);
943 // If we resumed the handshake then this->status will be ISSL_HANDSHAKEN.
945 GnuTLS::DataReader reader(sess);
946 int ret = reader.ret();
949 reader.appendto(recvq);
952 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
958 user->SetError("Connection closed");
964 user->SetError(gnutls_strerror(ret));
971 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq) CXX11_OVERRIDE
973 // Finish handshake if needed
974 int prepret = PrepareIO(user);
978 // Session is ready for transferring application data
982 ret = gnutls_record_send(this->sess, sendq.data(), sendq.length());
984 if (ret == (int)sendq.length())
986 SocketEngine::ChangeEventMask(user, FD_WANT_NO_WRITE);
992 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
995 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED || ret == 0)
997 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
1002 user->SetError(gnutls_strerror(ret));
1009 void TellCiphersAndFingerprint(LocalUser* user)
1013 std::string text = "*** You are connected using SSL cipher '";
1014 GetCiphersuite(text);
1016 if (!certificate->fingerprint.empty())
1017 text += " and your SSL certificate fingerprint is " + certificate->fingerprint;
1019 user->WriteNotice(text);
1023 void GetCiphersuite(std::string& out) const
1025 out.append(UnknownIfNULL(gnutls_protocol_get_name(gnutls_protocol_get_version(sess)))).push_back('-');
1026 out.append(UnknownIfNULL(gnutls_kx_get_name(gnutls_kx_get(sess)))).push_back('-');
1027 out.append(UnknownIfNULL(gnutls_cipher_get_name(gnutls_cipher_get(sess)))).push_back('-');
1028 out.append(UnknownIfNULL(gnutls_mac_get_name(gnutls_mac_get(sess))));
1031 GnuTLS::Profile* GetProfile() { return profile; }
1032 bool IsHandshakeDone() const { return (status == ISSL_HANDSHAKEN); }
1035 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)
1037 #ifndef GNUTLS_NEW_CERT_CALLBACK_API
1038 st->type = GNUTLS_CRT_X509;
1040 st->cert_type = GNUTLS_CRT_X509;
1041 st->key_type = GNUTLS_PRIVKEY_X509;
1043 StreamSocket* sock = reinterpret_cast<StreamSocket*>(gnutls_transport_get_ptr(sess));
1044 GnuTLS::X509Credentials& cred = static_cast<GnuTLSIOHook*>(sock->GetIOHook())->GetProfile()->GetX509Credentials();
1046 st->ncerts = cred.certs.size();
1047 st->cert.x509 = cred.certs.raw();
1048 st->key.x509 = cred.key.get();
1054 class GnuTLSIOHookProvider : public refcountbase, public IOHookProvider
1056 reference<GnuTLS::Profile> profile;
1059 GnuTLSIOHookProvider(Module* mod, reference<GnuTLS::Profile>& prof)
1060 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
1063 ServerInstance->Modules->AddService(*this);
1066 ~GnuTLSIOHookProvider()
1068 ServerInstance->Modules->DelService(*this);
1071 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
1073 new GnuTLSIOHook(this, sock, GNUTLS_SERVER, profile);
1076 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
1078 new GnuTLSIOHook(this, sock, GNUTLS_CLIENT, profile);
1082 class ModuleSSLGnuTLS : public Module
1084 typedef std::vector<reference<GnuTLSIOHookProvider> > ProfileList;
1086 // First member of the class, gets constructed first and destructed last
1087 GnuTLS::Init libinit;
1088 RandGen randhandler;
1089 ProfileList profiles;
1093 // First, store all profiles in a new, temporary container. If no problems occur, swap the two
1094 // containers; this way if something goes wrong we can go back and continue using the current profiles,
1095 // avoiding unpleasant situations where no new SSL connections are possible.
1096 ProfileList newprofiles;
1098 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
1099 if (tags.first == tags.second)
1101 // No <sslprofile> tags found, create a profile named "gnutls" from settings in the <gnutls> block
1102 const std::string defname = "gnutls";
1103 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
1104 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found; using settings from the <gnutls> tag");
1108 reference<GnuTLS::Profile> profile(GnuTLS::Profile::Create(defname, tag));
1109 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1111 catch (CoreException& ex)
1113 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
1117 for (ConfigIter i = tags.first; i != tags.second; ++i)
1119 ConfigTag* tag = i->second;
1120 if (tag->getString("provider") != "gnutls")
1123 std::string name = tag->getString("name");
1126 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
1130 reference<GnuTLS::Profile> profile;
1133 profile = GnuTLS::Profile::Create(name, tag);
1135 catch (CoreException& ex)
1137 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1140 newprofiles.push_back(new GnuTLSIOHookProvider(this, profile));
1143 // New profiles are ok, begin using them
1144 // Old profiles are deleted when their refcount drops to zero
1145 profiles.swap(newprofiles);
1151 #ifndef GNUTLS_HAS_RND
1152 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
1156 void init() CXX11_OVERRIDE
1159 ServerInstance->GenRandom = &randhandler;
1162 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1171 catch (ModuleException& ex)
1173 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1179 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
1182 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
1184 if(target_type == TYPE_USER)
1186 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
1188 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
1190 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1191 // Potentially there could be multiple SSL modules loaded at once on different ports.
1192 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1197 Version GetVersion() CXX11_OVERRIDE
1199 return Version("Provides SSL support for clients", VF_VENDOR);
1202 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
1204 IOHook* hook = user->eh.GetIOHook();
1205 if (hook && hook->prov->creator == this)
1206 static_cast<GnuTLSIOHook*>(hook)->TellCiphersAndFingerprint(user);
1209 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1211 if ((user->eh.GetIOHook()) && (user->eh.GetIOHook()->prov->creator == this))
1213 GnuTLSIOHook* iohook = static_cast<GnuTLSIOHook*>(user->eh.GetIOHook());
1214 if (!iohook->IsHandshakeDone())
1215 return MOD_RES_DENY;
1218 return MOD_RES_PASSTHRU;
1222 MODULE_INIT(ModuleSSLGnuTLS)