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/>.
27 #include "modules/ssl.h"
29 // Ignore OpenSSL deprecation warnings on OS X Lion and newer.
31 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
34 #include <openssl/ssl.h>
35 #include <openssl/err.h>
38 # pragma comment(lib, "ssleay32.lib")
39 # pragma comment(lib, "libeay32.lib")
42 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
43 /* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto") */
45 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
47 static bool SelfSigned = false;
48 static int exdataindex;
52 return ERR_error_string(ERR_get_error(), NULL);
55 static int OnVerify(int preverify_ok, X509_STORE_CTX* ctx);
56 static void StaticSSLInfoCallback(const SSL* ssl, int where, int rc);
60 class Exception : public ModuleException
63 Exception(const std::string& reason)
64 : ModuleException(reason) { }
72 DHParams(const std::string& filename)
74 BIO* dhpfile = BIO_new_file(filename.c_str(), "r");
76 throw Exception("Couldn't open DH file " + filename);
78 dh = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
82 throw Exception("Couldn't read DH params from file " + filename);
102 Context(SSL_CTX* context)
105 // Sane default options for OpenSSL see https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html
106 // and when choosing a cipher, use the server's preferences instead of the client preferences.
107 long opts = SSL_OP_NO_SSLv2 | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_SINGLE_DH_USE;
108 // Only turn options on if they exist
109 #ifdef SSL_OP_SINGLE_ECDH_USE
110 opts |= SSL_OP_SINGLE_ECDH_USE;
112 #ifdef SSL_OP_NO_TICKET
113 opts |= SSL_OP_NO_TICKET;
116 ctx_options = SSL_CTX_set_options(ctx, opts);
117 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
118 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
119 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
120 SSL_CTX_set_info_callback(ctx, StaticSSLInfoCallback);
128 bool SetDH(DHParams& dh)
131 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
134 #ifdef INSPIRCD_OPENSSL_ENABLE_ECDH
135 void SetECDH(const std::string& curvename)
137 int nid = OBJ_sn2nid(curvename.c_str());
139 throw Exception("Unknown curve: " + curvename);
141 EC_KEY* eckey = EC_KEY_new_by_curve_name(nid);
143 throw Exception("Unable to create EC key object");
146 bool ret = (SSL_CTX_set_tmp_ecdh(ctx, eckey) >= 0);
149 throw Exception("Couldn't set ECDH parameters");
153 bool SetCiphers(const std::string& ciphers)
156 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
159 bool SetCerts(const std::string& filename)
162 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
165 bool SetPrivateKey(const std::string& filename)
168 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
171 bool SetCA(const std::string& filename)
174 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
177 long GetDefaultContextOptions() const
182 long SetRawContextOptions(long setoptions, long clearoptions)
185 SSL_CTX_clear_options(ctx, SSL_CTX_get_options(ctx));
187 // Set the default options and what is in the conf
188 SSL_CTX_set_options(ctx, ctx_options | setoptions);
189 return SSL_CTX_clear_options(ctx, clearoptions);
198 class Profile : public refcountbase
200 /** Name of this profile
202 const std::string name;
204 /** DH parameters in use
208 /** OpenSSL makes us have two contexts, one for servers and one for clients
213 /** Digest to use when generating fingerprints
215 const EVP_MD* digest;
217 /** Last error, set by error_callback()
221 /** True if renegotiations are allowed, false if not
223 const bool allowrenego;
225 static int error_callback(const char* str, size_t len, void* u)
227 Profile* profile = reinterpret_cast<Profile*>(u);
228 profile->lasterr = std::string(str, len - 1);
232 /** Set raw OpenSSL context (SSL_CTX) options from a config tag
233 * @param ctxname Name of the context, client or server
234 * @param tag Config tag defining this profile
235 * @param context Context object to manipulate
237 void SetContextOptions(const std::string& ctxname, ConfigTag* tag, Context& context)
239 long setoptions = tag->getInt(ctxname + "setoptions");
240 long clearoptions = tag->getInt(ctxname + "clearoptions");
241 #ifdef SSL_OP_NO_COMPRESSION
242 if (!tag->getBool("compression", true))
243 setoptions |= SSL_OP_NO_COMPRESSION;
245 if (!tag->getBool("sslv3", true))
246 setoptions |= SSL_OP_NO_SSLv3;
247 if (!tag->getBool("tlsv1", true))
248 setoptions |= SSL_OP_NO_TLSv1;
250 if (!setoptions && !clearoptions)
251 return; // Nothing to do
253 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);
254 long final = context.SetRawContextOptions(setoptions, clearoptions);
255 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "%s %s context options: %ld", name.c_str(), ctxname.c_str(), final);
259 Profile(const std::string& profilename, ConfigTag* tag)
261 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dh.pem")))
262 , ctx(SSL_CTX_new(SSLv23_server_method()))
263 , clictx(SSL_CTX_new(SSLv23_client_method()))
264 , allowrenego(tag->getBool("renegotiation", true))
266 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
267 throw Exception("Couldn't set DH parameters");
269 std::string hash = tag->getString("hash", "md5");
270 digest = EVP_get_digestbyname(hash.c_str());
272 throw Exception("Unknown hash type " + hash);
274 std::string ciphers = tag->getString("ciphers");
275 if (!ciphers.empty())
277 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
279 ERR_print_errors_cb(error_callback, this);
280 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
284 #ifdef INSPIRCD_OPENSSL_ENABLE_ECDH
285 std::string curvename = tag->getString("ecdhcurve", "prime256v1");
286 if (!curvename.empty())
287 ctx.SetECDH(curvename);
290 SetContextOptions("server", tag, ctx);
291 SetContextOptions("client", tag, clictx);
293 /* Load our keys and certificates
294 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
296 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
297 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
299 ERR_print_errors_cb(error_callback, this);
300 throw Exception("Can't read certificate file: " + lasterr);
303 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
304 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
306 ERR_print_errors_cb(error_callback, this);
307 throw Exception("Can't read key file: " + lasterr);
310 // Load the CAs we trust
311 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
312 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
314 ERR_print_errors_cb(error_callback, this);
315 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());
319 const std::string& GetName() const { return name; }
320 SSL* CreateServerSession() { return ctx.CreateSession(); }
321 SSL* CreateClientSession() { return clictx.CreateSession(); }
322 const EVP_MD* GetDigest() { return digest; }
323 bool AllowRenegotiation() const { return allowrenego; }
327 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
329 /* XXX: This will allow self signed certificates.
330 * In the future if we want an option to not allow this,
331 * we can just return preverify_ok here, and openssl
332 * will boot off self-signed and invalid peer certs.
334 int ve = X509_STORE_CTX_get_error(ctx);
336 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
341 class OpenSSLIOHook : public SSLIOHook
348 reference<OpenSSL::Profile> profile;
350 bool Handshake(StreamSocket* user)
356 ret = SSL_connect(sess);
358 ret = SSL_accept(sess);
362 int err = SSL_get_error(sess, ret);
364 if (err == SSL_ERROR_WANT_READ)
366 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
367 this->status = ISSL_HANDSHAKING;
370 else if (err == SSL_ERROR_WANT_WRITE)
372 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
373 this->status = ISSL_HANDSHAKING;
385 // Handshake complete.
390 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
413 void VerifyCertificate()
416 ssl_cert* certinfo = new ssl_cert;
417 this->certificate = certinfo;
419 unsigned char md[EVP_MAX_MD_SIZE];
421 cert = SSL_get_peer_certificate(sess);
425 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
429 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
433 certinfo->unknownsigner = false;
434 certinfo->trusted = true;
438 certinfo->unknownsigner = true;
439 certinfo->trusted = false;
443 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
445 // Make sure there are no chars in the string that we consider invalid
446 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
447 certinfo->dn.clear();
449 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
450 certinfo->issuer = buf;
451 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
452 certinfo->issuer.clear();
454 if (!X509_digest(cert, profile->GetDigest(), md, &n))
456 certinfo->error = "Out of memory generating fingerprint";
460 certinfo->fingerprint = BinToHex(md, n);
463 if ((ASN1_UTCTIME_cmp_time_t(X509_get_notAfter(cert), ServerInstance->Time()) == -1) || (ASN1_UTCTIME_cmp_time_t(X509_get_notBefore(cert), ServerInstance->Time()) == 0))
465 certinfo->error = "Not activated, or expired certificate";
471 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
472 void SSLInfoCallback(int where, int rc)
474 if ((where & SSL_CB_HANDSHAKE_START) && (status == ISSL_OPEN))
476 if (profile->AllowRenegotiation())
479 // The other side is trying to renegotiate, kill the connection and change status
480 // to ISSL_NONE so CheckRenego() closes the session
482 SocketEngine::Shutdown(SSL_get_fd(sess), 2);
486 bool CheckRenego(StreamSocket* sock)
488 if (status != ISSL_NONE)
491 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Session %p killed, attempted to renegotiate", (void*)sess);
493 sock->SetError("Renegotiation is not allowed");
498 // Calls our private SSLInfoCallback()
499 friend void StaticSSLInfoCallback(const SSL* ssl, int where, int rc);
502 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool is_outbound, SSL* session, const reference<OpenSSL::Profile>& sslprofile)
503 : SSLIOHook(hookprov)
506 , outbound(is_outbound)
507 , data_to_write(false)
508 , profile(sslprofile)
512 if (SSL_set_fd(sess, sock->GetFd()) == 0)
513 throw ModuleException("Can't set fd with SSL_set_fd: " + ConvToStr(sock->GetFd()));
515 SSL_set_ex_data(sess, exdataindex, this);
516 sock->AddIOHook(this);
520 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
525 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
533 if (status == ISSL_HANDSHAKING)
535 // The handshake isn't finished and it wants to read, try to finish it.
536 if (!Handshake(user))
538 // Couldn't resume handshake.
539 if (status == ISSL_NONE)
545 // If we resumed the handshake then this->status will be ISSL_OPEN
547 if (status == ISSL_OPEN)
550 char* buffer = ServerInstance->GetReadBuffer();
551 size_t bufsiz = ServerInstance->Config->NetBufferSize;
552 int ret = SSL_read(sess, buffer, bufsiz);
554 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
555 if (!CheckRenego(user))
561 recvq.append(buffer, ret);
563 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
568 // Client closed connection.
570 user->SetError("Connection closed");
575 int err = SSL_get_error(sess, ret);
577 if (err == SSL_ERROR_WANT_READ)
579 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
582 else if (err == SSL_ERROR_WANT_WRITE)
584 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
598 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
606 data_to_write = true;
608 if (status == ISSL_HANDSHAKING)
610 if (!Handshake(user))
612 // Couldn't resume handshake.
613 if (status == ISSL_NONE)
619 if (status == ISSL_OPEN)
622 int ret = SSL_write(sess, buffer.data(), buffer.size());
624 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
625 if (!CheckRenego(user))
629 if (ret == (int)buffer.length())
631 data_to_write = false;
632 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
637 buffer = buffer.substr(ret);
638 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
648 int err = SSL_get_error(sess, ret);
650 if (err == SSL_ERROR_WANT_WRITE)
652 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
655 else if (err == SSL_ERROR_WANT_READ)
657 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
670 void TellCiphersAndFingerprint(LocalUser* user)
674 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(sess)) + "'";
675 const std::string& fingerprint = certificate->fingerprint;
676 if (!fingerprint.empty())
677 text += " and your SSL certificate fingerprint is " + fingerprint;
679 user->WriteNotice(text);
684 static void StaticSSLInfoCallback(const SSL* ssl, int where, int rc)
686 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
687 OpenSSLIOHook* hook = static_cast<OpenSSLIOHook*>(SSL_get_ex_data(ssl, exdataindex));
688 hook->SSLInfoCallback(where, rc);
692 class OpenSSLIOHookProvider : public refcountbase, public IOHookProvider
694 reference<OpenSSL::Profile> profile;
697 OpenSSLIOHookProvider(Module* mod, reference<OpenSSL::Profile>& prof)
698 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
701 ServerInstance->Modules->AddService(*this);
704 ~OpenSSLIOHookProvider()
706 ServerInstance->Modules->DelService(*this);
709 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
711 new OpenSSLIOHook(this, sock, false, profile->CreateServerSession(), profile);
714 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
716 new OpenSSLIOHook(this, sock, true, profile->CreateClientSession(), profile);
720 class ModuleSSLOpenSSL : public Module
722 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
724 ProfileList profiles;
728 ProfileList newprofiles;
729 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
730 if (tags.first == tags.second)
732 // Create a default profile named "openssl"
733 const std::string defname = "openssl";
734 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
735 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
739 reference<OpenSSL::Profile> profile(new OpenSSL::Profile(defname, tag));
740 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
742 catch (OpenSSL::Exception& ex)
744 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
748 for (ConfigIter i = tags.first; i != tags.second; ++i)
750 ConfigTag* tag = i->second;
751 if (tag->getString("provider") != "openssl")
754 std::string name = tag->getString("name");
757 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
761 reference<OpenSSL::Profile> profile;
764 profile = new OpenSSL::Profile(name, tag);
766 catch (CoreException& ex)
768 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
771 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
774 profiles.swap(newprofiles);
780 // Initialize OpenSSL
782 SSL_load_error_strings();
785 void init() CXX11_OVERRIDE
787 // Register application specific data
788 char exdatastr[] = "inspircd";
789 exdataindex = SSL_get_ex_new_index(0, exdatastr, NULL, NULL, NULL);
791 throw ModuleException("Failed to register application specific data");
796 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
805 catch (ModuleException& ex)
807 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
811 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
813 IOHook* hook = user->eh.GetIOHook();
814 if (hook && hook->prov->creator == this)
815 static_cast<OpenSSLIOHook*>(hook)->TellCiphersAndFingerprint(user);
818 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
820 if (target_type == TYPE_USER)
822 LocalUser* user = IS_LOCAL((User*)item);
824 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
826 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
827 // Potentially there could be multiple SSL modules loaded at once on different ports.
828 ServerInstance->Users->QuitUser(user, "SSL module unloading");
833 Version GetVersion() CXX11_OVERRIDE
835 return Version("Provides SSL support for clients", VF_VENDOR);
839 MODULE_INIT(ModuleSSLOpenSSL)