2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
6 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /// $CompilerFlags: find_compiler_flags("openssl")
25 /// $LinkerFlags: find_linker_flags("openssl" "-lssl -lcrypto")
27 /// $PackageInfo: require_system("centos") openssl-devel pkgconfig
28 /// $PackageInfo: require_system("darwin") openssl pkg-config
29 /// $PackageInfo: require_system("debian") libssl-dev openssl pkg-config
30 /// $PackageInfo: require_system("ubuntu") libssl-dev openssl pkg-config
35 #include "modules/ssl.h"
37 // Ignore OpenSSL deprecation warnings on OS X Lion and newer.
39 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
42 // Fix warnings about the use of `long long` on C++03.
44 # pragma clang diagnostic ignored "-Wc++11-long-long"
45 #elif defined __GNUC__
46 # pragma GCC diagnostic ignored "-Wlong-long"
49 #include <openssl/ssl.h>
50 #include <openssl/err.h>
51 #include <openssl/dh.h>
54 # pragma comment(lib, "ssleay32.lib")
55 # pragma comment(lib, "libeay32.lib")
58 // Compatibility layer to allow OpenSSL 1.0 to use the 1.1 API.
59 #if ((defined LIBRESSL_VERSION_NUMBER) || (OPENSSL_VERSION_NUMBER < 0x10100000L))
61 // BIO is opaque in OpenSSL 1.1 but the access API does not exist in 1.0.
62 # define BIO_get_data(BIO) BIO->ptr
63 # define BIO_set_data(BIO, VALUE) BIO->ptr = VALUE;
64 # define BIO_set_init(BIO, VALUE) BIO->init = VALUE;
66 // These functions have been renamed in OpenSSL 1.1.
67 # define OpenSSL_version SSLeay_version
68 # define X509_getm_notAfter X509_get_notAfter
69 # define X509_getm_notBefore X509_get_notBefore
70 # define OPENSSL_init_ssl(OPTIONS, SETTINGS) \
72 SSL_load_error_strings();
74 // These macros have been renamed in OpenSSL 1.1.
75 # define OPENSSL_VERSION SSLEAY_VERSION
78 # define INSPIRCD_OPENSSL_OPAQUE_BIO
81 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
83 static bool SelfSigned = false;
84 static int exdataindex;
88 return ERR_error_string(ERR_get_error(), NULL);
91 static int OnVerify(int preverify_ok, X509_STORE_CTX* ctx);
92 static void StaticSSLInfoCallback(const SSL* ssl, int where, int rc);
96 class Exception : public ModuleException
99 Exception(const std::string& reason)
100 : ModuleException(reason) { }
108 DHParams(const std::string& filename)
110 BIO* dhpfile = BIO_new_file(filename.c_str(), "r");
112 throw Exception("Couldn't open DH file " + filename);
114 dh = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
118 throw Exception("Couldn't read DH params from file " + filename);
138 Context(SSL_CTX* context)
141 // Sane default options for OpenSSL see https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html
142 // and when choosing a cipher, use the server's preferences instead of the client preferences.
143 long opts = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_SINGLE_DH_USE;
144 // Only turn options on if they exist
145 #ifdef SSL_OP_SINGLE_ECDH_USE
146 opts |= SSL_OP_SINGLE_ECDH_USE;
148 #ifdef SSL_OP_NO_TICKET
149 opts |= SSL_OP_NO_TICKET;
152 ctx_options = SSL_CTX_set_options(ctx, opts);
154 long mode = SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER;
155 #ifdef SSL_MODE_RELEASE_BUFFERS
156 mode |= SSL_MODE_RELEASE_BUFFERS;
158 SSL_CTX_set_mode(ctx, mode);
159 SSL_CTX_set_verify(ctx, SSL_VERIFY_NONE, NULL);
160 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
161 SSL_CTX_set_info_callback(ctx, StaticSSLInfoCallback);
169 bool SetDH(DHParams& dh)
172 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
175 #ifndef OPENSSL_NO_ECDH
176 void SetECDH(const std::string& curvename)
178 int nid = OBJ_sn2nid(curvename.c_str());
180 throw Exception("Unknown curve: " + curvename);
182 EC_KEY* eckey = EC_KEY_new_by_curve_name(nid);
184 throw Exception("Unable to create EC key object");
187 bool ret = (SSL_CTX_set_tmp_ecdh(ctx, eckey) >= 0);
190 throw Exception("Couldn't set ECDH parameters");
194 bool SetCiphers(const std::string& ciphers)
197 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
200 bool SetCerts(const std::string& filename)
203 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
206 bool SetPrivateKey(const std::string& filename)
209 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
212 bool SetCA(const std::string& filename)
215 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
218 void SetCRL(const std::string& crlfile, const std::string& crlpath, const std::string& crlmode)
220 if (crlfile.empty() && crlpath.empty())
224 unsigned long crlflags = X509_V_FLAG_CRL_CHECK;
225 if (stdalgo::string::equalsci(crlmode, "chain"))
227 crlflags |= X509_V_FLAG_CRL_CHECK_ALL;
229 else if (!stdalgo::string::equalsci(crlmode, "leaf"))
231 throw ModuleException("Unknown mode '" + crlmode + "'; expected either 'chain' (default) or 'leaf'");
235 X509_STORE* store = SSL_CTX_get_cert_store(ctx);
238 throw ModuleException("Unable to get X509_STORE from SSL context; this should never happen");
241 if (!X509_STORE_load_locations(store,
242 crlfile.empty() ? NULL : crlfile.c_str(),
243 crlpath.empty() ? NULL : crlpath.c_str()))
245 int err = ERR_get_error();
246 throw ModuleException("Unable to load CRL file '" + crlfile + "' or CRL path '" + crlpath + "': '" + (err ? ERR_error_string(err, NULL) : "unknown") + "'");
250 if (X509_STORE_set_flags(store, crlflags) != 1)
252 throw ModuleException("Unable to set X509 CRL flags");
257 long GetDefaultContextOptions() const
262 long SetRawContextOptions(long setoptions, long clearoptions)
265 SSL_CTX_clear_options(ctx, SSL_CTX_get_options(ctx));
267 // Set the default options and what is in the conf
268 SSL_CTX_set_options(ctx, ctx_options | setoptions);
269 return SSL_CTX_clear_options(ctx, clearoptions);
274 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
277 SSL* CreateServerSession()
279 SSL* sess = SSL_new(ctx);
280 SSL_set_accept_state(sess); // Act as server
284 SSL* CreateClientSession()
286 SSL* sess = SSL_new(ctx);
287 SSL_set_connect_state(sess); // Act as client
294 /** Name of this profile
296 const std::string name;
298 /** DH parameters in use
302 /** OpenSSL makes us have two contexts, one for servers and one for clients
307 /** Digest to use when generating fingerprints
309 const EVP_MD* digest;
311 /** Last error, set by error_callback()
315 /** True if renegotiations are allowed, false if not
317 const bool allowrenego;
319 /** Rough max size of records to send
321 const unsigned int outrecsize;
323 static int error_callback(const char* str, size_t len, void* u)
325 Profile* profile = reinterpret_cast<Profile*>(u);
326 profile->lasterr = std::string(str, len - 1);
330 /** Set raw OpenSSL context (SSL_CTX) options from a config tag
331 * @param ctxname Name of the context, client or server
332 * @param tag Config tag defining this profile
333 * @param context Context object to manipulate
335 void SetContextOptions(const std::string& ctxname, ConfigTag* tag, Context& context)
337 long setoptions = tag->getInt(ctxname + "setoptions", 0);
338 long clearoptions = tag->getInt(ctxname + "clearoptions", 0);
340 #ifdef SSL_OP_NO_COMPRESSION
341 // Disable compression by default
342 if (!tag->getBool("compression", false))
343 setoptions |= SSL_OP_NO_COMPRESSION;
346 // Disable TLSv1.0 by default.
347 if (!tag->getBool("tlsv1", false))
348 setoptions |= SSL_OP_NO_TLSv1;
350 #ifdef SSL_OP_NO_TLSv1_1
351 // Enable TLSv1.1 by default.
352 if (!tag->getBool("tlsv11", true))
353 setoptions |= SSL_OP_NO_TLSv1_1;
356 #ifdef SSL_OP_NO_TLSv1_2
357 // Enable TLSv1.2 by default.
358 if (!tag->getBool("tlsv12", true))
359 setoptions |= SSL_OP_NO_TLSv1_2;
362 if (!setoptions && !clearoptions)
363 return; // Nothing to do
365 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Setting %s %s context options, default: %ld set: %ld clear: %ld", name.c_str(), ctxname.c_str(), ctx.GetDefaultContextOptions(), setoptions, clearoptions);
366 long final = context.SetRawContextOptions(setoptions, clearoptions);
367 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "%s %s context options: %ld", name.c_str(), ctxname.c_str(), final);
371 Profile(const std::string& profilename, ConfigTag* tag)
373 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dhparams.pem")))
374 , ctx(SSL_CTX_new(SSLv23_server_method()))
375 , clictx(SSL_CTX_new(SSLv23_client_method()))
376 , allowrenego(tag->getBool("renegotiation")) // Disallow by default
377 , outrecsize(tag->getUInt("outrecsize", 2048, 512, 16384))
379 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
380 throw Exception("Couldn't set DH parameters");
382 std::string hash = tag->getString("hash", "md5");
383 digest = EVP_get_digestbyname(hash.c_str());
385 throw Exception("Unknown hash type " + hash);
387 std::string ciphers = tag->getString("ciphers");
388 if (!ciphers.empty())
390 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
392 ERR_print_errors_cb(error_callback, this);
393 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
397 #ifndef OPENSSL_NO_ECDH
398 std::string curvename = tag->getString("ecdhcurve", "prime256v1");
399 if (!curvename.empty())
400 ctx.SetECDH(curvename);
403 SetContextOptions("server", tag, ctx);
404 SetContextOptions("client", tag, clictx);
406 /* Load our keys and certificates
407 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
409 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
410 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
412 ERR_print_errors_cb(error_callback, this);
413 throw Exception("Can't read certificate file: " + lasterr);
416 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
417 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
419 ERR_print_errors_cb(error_callback, this);
420 throw Exception("Can't read key file: " + lasterr);
423 // Load the CAs we trust
424 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
425 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
427 ERR_print_errors_cb(error_callback, this);
428 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't read CA list from %s. This is only a problem if you want to verify client certificates, otherwise it's safe to ignore this message. Error: %s", filename.c_str(), lasterr.c_str());
432 std::string crlfile = tag->getString("crlfile");
433 std::string crlpath = tag->getString("crlpath");
434 std::string crlmode = tag->getString("crlmode", "chain");
435 ctx.SetCRL(crlfile, crlpath, crlmode);
437 clictx.SetVerifyCert();
438 if (tag->getBool("requestclientcert", true))
442 const std::string& GetName() const { return name; }
443 SSL* CreateServerSession() { return ctx.CreateServerSession(); }
444 SSL* CreateClientSession() { return clictx.CreateClientSession(); }
445 const EVP_MD* GetDigest() { return digest; }
446 bool AllowRenegotiation() const { return allowrenego; }
447 unsigned int GetOutgoingRecordSize() const { return outrecsize; }
452 static int create(BIO* bio)
454 BIO_set_init(bio, 1);
458 static int destroy(BIO* bio)
460 // XXX: Dummy function to avoid a memory leak in OpenSSL.
461 // The memory leak happens in BIO_free() (bio_lib.c) when the destroy func of the BIO is NULL.
462 // This is fixed in OpenSSL but some distros still ship the unpatched version hence we provide this workaround.
466 static long ctrl(BIO* bio, int cmd, long num, void* ptr)
468 if (cmd == BIO_CTRL_FLUSH)
473 static int read(BIO* bio, char* buf, int len);
474 static int write(BIO* bio, const char* buf, int len);
476 #ifdef INSPIRCD_OPENSSL_OPAQUE_BIO
477 static BIO_METHOD* alloc()
479 BIO_METHOD* meth = BIO_meth_new(100 | BIO_TYPE_SOURCE_SINK, "inspircd");
480 BIO_meth_set_write(meth, OpenSSL::BIOMethod::write);
481 BIO_meth_set_read(meth, OpenSSL::BIOMethod::read);
482 BIO_meth_set_ctrl(meth, OpenSSL::BIOMethod::ctrl);
483 BIO_meth_set_create(meth, OpenSSL::BIOMethod::create);
484 BIO_meth_set_destroy(meth, OpenSSL::BIOMethod::destroy);
491 // BIO_METHOD is opaque in OpenSSL 1.1 so we can't do this.
492 // See OpenSSL::BIOMethod::alloc for the new method.
493 #ifndef INSPIRCD_OPENSSL_OPAQUE_BIO
494 static BIO_METHOD biomethods =
496 (100 | BIO_TYPE_SOURCE_SINK),
498 OpenSSL::BIOMethod::write,
499 OpenSSL::BIOMethod::read,
502 OpenSSL::BIOMethod::ctrl,
503 OpenSSL::BIOMethod::create,
504 OpenSSL::BIOMethod::destroy, // destroy, does nothing, see function body for more info
505 NULL // callback_ctrl
508 static BIO_METHOD* biomethods;
511 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
513 /* XXX: This will allow self signed certificates.
514 * In the future if we want an option to not allow this,
515 * we can just return preverify_ok here, and openssl
516 * will boot off self-signed and invalid peer certs.
518 int ve = X509_STORE_CTX_get_error(ctx);
520 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
525 class OpenSSLIOHook : public SSLIOHook
532 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
533 int Handshake(StreamSocket* user)
536 int ret = SSL_do_handshake(sess);
539 int err = SSL_get_error(sess, ret);
541 if (err == SSL_ERROR_WANT_READ)
543 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
544 this->status = ISSL_HANDSHAKING;
547 else if (err == SSL_ERROR_WANT_WRITE)
549 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
550 this->status = ISSL_HANDSHAKING;
561 // Handshake complete.
566 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
589 void VerifyCertificate()
592 ssl_cert* certinfo = new ssl_cert;
593 this->certificate = certinfo;
595 unsigned char md[EVP_MAX_MD_SIZE];
597 cert = SSL_get_peer_certificate(sess);
601 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
605 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
609 certinfo->unknownsigner = false;
610 certinfo->trusted = true;
614 certinfo->unknownsigner = true;
615 certinfo->trusted = false;
619 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
621 // Make sure there are no chars in the string that we consider invalid
622 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
623 certinfo->dn.clear();
625 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
626 certinfo->issuer = buf;
627 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
628 certinfo->issuer.clear();
630 if (!X509_digest(cert, GetProfile().GetDigest(), md, &n))
632 certinfo->error = "Out of memory generating fingerprint";
636 certinfo->fingerprint = BinToHex(md, n);
639 if ((ASN1_UTCTIME_cmp_time_t(X509_getm_notAfter(cert), ServerInstance->Time()) == -1) || (ASN1_UTCTIME_cmp_time_t(X509_getm_notBefore(cert), ServerInstance->Time()) == 0))
641 certinfo->error = "Not activated, or expired certificate";
647 void SSLInfoCallback(int where, int rc)
649 if ((where & SSL_CB_HANDSHAKE_START) && (status == ISSL_OPEN))
651 if (GetProfile().AllowRenegotiation())
654 // The other side is trying to renegotiate, kill the connection and change status
655 // to ISSL_NONE so CheckRenego() closes the session
657 BIO* bio = SSL_get_rbio(sess);
658 EventHandler* eh = static_cast<StreamSocket*>(BIO_get_data(bio));
659 SocketEngine::Shutdown(eh, 2);
663 bool CheckRenego(StreamSocket* sock)
665 if (status != ISSL_NONE)
668 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Session %p killed, attempted to renegotiate", (void*)sess);
670 sock->SetError("Renegotiation is not allowed");
674 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
675 int PrepareIO(StreamSocket* sock)
677 if (status == ISSL_OPEN)
679 else if (status == ISSL_HANDSHAKING)
681 // The handshake isn't finished, try to finish it
682 return Handshake(sock);
689 // Calls our private SSLInfoCallback()
690 friend void StaticSSLInfoCallback(const SSL* ssl, int where, int rc);
693 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, SSL* session)
694 : SSLIOHook(hookprov)
697 , data_to_write(false)
699 // Create BIO instance and store a pointer to the socket in it which will be used by the read and write functions
700 #ifdef INSPIRCD_OPENSSL_OPAQUE_BIO
701 BIO* bio = BIO_new(biomethods);
703 BIO* bio = BIO_new(&biomethods);
705 BIO_set_data(bio, sock);
706 SSL_set_bio(sess, bio, bio);
708 SSL_set_ex_data(sess, exdataindex, this);
709 sock->AddIOHook(this);
713 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
718 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
720 // Finish handshake if needed
721 int prepret = PrepareIO(user);
725 // If we resumed the handshake then this->status will be ISSL_OPEN
728 char* buffer = ServerInstance->GetReadBuffer();
729 size_t bufsiz = ServerInstance->Config->NetBufferSize;
730 int ret = SSL_read(sess, buffer, bufsiz);
732 if (!CheckRenego(user))
737 recvq.append(buffer, ret);
739 // Schedule a read if there is still data in the OpenSSL buffer
740 if (SSL_pending(sess) > 0)
741 mask |= FD_ADD_TRIAL_READ;
743 mask |= FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE;
745 SocketEngine::ChangeEventMask(user, mask);
750 // Client closed connection.
752 user->SetError("Connection closed");
757 int err = SSL_get_error(sess, ret);
759 if (err == SSL_ERROR_WANT_READ)
761 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
764 else if (err == SSL_ERROR_WANT_WRITE)
766 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
778 int OnStreamSocketWrite(StreamSocket* user, StreamSocket::SendQueue& sendq) CXX11_OVERRIDE
780 // Finish handshake if needed
781 int prepret = PrepareIO(user);
785 data_to_write = true;
787 // Session is ready for transferring application data
788 while (!sendq.empty())
791 FlattenSendQueue(sendq, GetProfile().GetOutgoingRecordSize());
792 const StreamSocket::SendQueue::Element& buffer = sendq.front();
793 int ret = SSL_write(sess, buffer.data(), buffer.size());
795 if (!CheckRenego(user))
798 if (ret == (int)buffer.length())
800 // Wrote entire record, continue sending
805 sendq.erase_front(ret);
806 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
816 int err = SSL_get_error(sess, ret);
818 if (err == SSL_ERROR_WANT_WRITE)
820 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
823 else if (err == SSL_ERROR_WANT_READ)
825 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
836 data_to_write = false;
837 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
841 void GetCiphersuite(std::string& out) const CXX11_OVERRIDE
843 if (!IsHandshakeDone())
845 out.append(SSL_get_version(sess)).push_back('-');
846 out.append(SSL_get_cipher(sess));
849 bool GetServerName(std::string& out) const CXX11_OVERRIDE
851 const char* name = SSL_get_servername(sess, TLSEXT_NAMETYPE_host_name);
859 bool IsHandshakeDone() const { return (status == ISSL_OPEN); }
860 OpenSSL::Profile& GetProfile();
863 static void StaticSSLInfoCallback(const SSL* ssl, int where, int rc)
865 OpenSSLIOHook* hook = static_cast<OpenSSLIOHook*>(SSL_get_ex_data(ssl, exdataindex));
866 hook->SSLInfoCallback(where, rc);
869 static int OpenSSL::BIOMethod::write(BIO* bio, const char* buffer, int size)
871 BIO_clear_retry_flags(bio);
873 StreamSocket* sock = static_cast<StreamSocket*>(BIO_get_data(bio));
874 if (sock->GetEventMask() & FD_WRITE_WILL_BLOCK)
876 // Writes blocked earlier, don't retry syscall
877 BIO_set_retry_write(bio);
881 int ret = SocketEngine::Send(sock, buffer, size, 0);
882 if ((ret < size) && ((ret > 0) || (SocketEngine::IgnoreError())))
884 // Blocked, set retry flag for OpenSSL
885 SocketEngine::ChangeEventMask(sock, FD_WRITE_WILL_BLOCK);
886 BIO_set_retry_write(bio);
892 static int OpenSSL::BIOMethod::read(BIO* bio, char* buffer, int size)
894 BIO_clear_retry_flags(bio);
896 StreamSocket* sock = static_cast<StreamSocket*>(BIO_get_data(bio));
897 if (sock->GetEventMask() & FD_READ_WILL_BLOCK)
899 // Reads blocked earlier, don't retry syscall
900 BIO_set_retry_read(bio);
904 int ret = SocketEngine::Recv(sock, buffer, size, 0);
905 if ((ret < size) && ((ret > 0) || (SocketEngine::IgnoreError())))
907 // Blocked, set retry flag for OpenSSL
908 SocketEngine::ChangeEventMask(sock, FD_READ_WILL_BLOCK);
909 BIO_set_retry_read(bio);
915 class OpenSSLIOHookProvider : public IOHookProvider
917 OpenSSL::Profile profile;
920 OpenSSLIOHookProvider(Module* mod, const std::string& profilename, ConfigTag* tag)
921 : IOHookProvider(mod, "ssl/" + profilename, IOHookProvider::IOH_SSL)
922 , profile(profilename, tag)
924 ServerInstance->Modules->AddService(*this);
927 ~OpenSSLIOHookProvider()
929 ServerInstance->Modules->DelService(*this);
932 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
934 new OpenSSLIOHook(this, sock, profile.CreateServerSession());
937 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
939 new OpenSSLIOHook(this, sock, profile.CreateClientSession());
942 OpenSSL::Profile& GetProfile() { return profile; }
945 OpenSSL::Profile& OpenSSLIOHook::GetProfile()
947 IOHookProvider* hookprov = prov;
948 return static_cast<OpenSSLIOHookProvider*>(hookprov)->GetProfile();
951 class ModuleSSLOpenSSL : public Module
953 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
955 ProfileList profiles;
959 ProfileList newprofiles;
960 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
961 if (tags.first == tags.second)
963 // Create a default profile named "openssl"
964 const std::string defname = "openssl";
965 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
966 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
970 newprofiles.push_back(new OpenSSLIOHookProvider(this, defname, tag));
972 catch (OpenSSL::Exception& ex)
974 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
978 for (ConfigIter i = tags.first; i != tags.second; ++i)
980 ConfigTag* tag = i->second;
981 if (!stdalgo::string::equalsci(tag->getString("provider"), "openssl"))
984 std::string name = tag->getString("name");
987 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
991 reference<OpenSSLIOHookProvider> prov;
994 prov = new OpenSSLIOHookProvider(this, name, tag);
996 catch (CoreException& ex)
998 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
1001 newprofiles.push_back(prov);
1004 for (ProfileList::iterator i = profiles.begin(); i != profiles.end(); ++i)
1006 OpenSSLIOHookProvider& prov = **i;
1007 ServerInstance->Modules.DelService(prov);
1010 profiles.swap(newprofiles);
1016 // Initialize OpenSSL
1017 OPENSSL_init_ssl(0, NULL);
1018 #ifdef INSPIRCD_OPENSSL_OPAQUE_BIO
1019 biomethods = OpenSSL::BIOMethod::alloc();
1024 BIO_meth_free(biomethods);
1028 void init() CXX11_OVERRIDE
1030 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "OpenSSL lib version \"%s\" module was compiled for \"" OPENSSL_VERSION_TEXT "\"", OpenSSL_version(OPENSSL_VERSION));
1032 // Register application specific data
1033 char exdatastr[] = "inspircd";
1034 exdataindex = SSL_get_ex_new_index(0, exdatastr, NULL, NULL, NULL);
1035 if (exdataindex < 0)
1036 throw ModuleException("Failed to register application specific data");
1041 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
1050 catch (ModuleException& ex)
1052 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
1056 void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item) CXX11_OVERRIDE
1058 if (type == ExtensionItem::EXT_USER)
1060 LocalUser* user = IS_LOCAL((User*)item);
1062 if ((user) && (user->eh.GetModHook(this)))
1064 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
1065 // Potentially there could be multiple SSL modules loaded at once on different ports.
1066 ServerInstance->Users->QuitUser(user, "SSL module unloading");
1071 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
1073 const OpenSSLIOHook* const iohook = static_cast<OpenSSLIOHook*>(user->eh.GetModHook(this));
1074 if ((iohook) && (!iohook->IsHandshakeDone()))
1075 return MOD_RES_DENY;
1076 return MOD_RES_PASSTHRU;
1079 Version GetVersion() CXX11_OVERRIDE
1081 return Version("Provides SSL support via OpenSSL", VF_VENDOR);
1085 MODULE_INIT(ModuleSSLOpenSSL)