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 // Fix warnings about the use of `long long` on C++03.
36 # pragma clang diagnostic ignored "-Wc++11-long-long"
37 #elif defined __GNUC__
38 # pragma GCC diagnostic ignored "-Wlong-long"
41 #include <openssl/ssl.h>
42 #include <openssl/err.h>
45 # pragma comment(lib, "ssleay32.lib")
46 # pragma comment(lib, "libeay32.lib")
49 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
50 /* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto") */
52 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
54 static bool SelfSigned = false;
55 static int exdataindex;
59 return ERR_error_string(ERR_get_error(), NULL);
62 static int OnVerify(int preverify_ok, X509_STORE_CTX* ctx);
63 static void StaticSSLInfoCallback(const SSL* ssl, int where, int rc);
67 class Exception : public ModuleException
70 Exception(const std::string& reason)
71 : ModuleException(reason) { }
79 DHParams(const std::string& filename)
81 BIO* dhpfile = BIO_new_file(filename.c_str(), "r");
83 throw Exception("Couldn't open DH file " + filename);
85 dh = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
89 throw Exception("Couldn't read DH params from file " + filename);
109 Context(SSL_CTX* context)
112 // Sane default options for OpenSSL see https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html
113 // and when choosing a cipher, use the server's preferences instead of the client preferences.
114 long opts = SSL_OP_NO_SSLv2 | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_SINGLE_DH_USE;
115 // Only turn options on if they exist
116 #ifdef SSL_OP_SINGLE_ECDH_USE
117 opts |= SSL_OP_SINGLE_ECDH_USE;
119 #ifdef SSL_OP_NO_TICKET
120 opts |= SSL_OP_NO_TICKET;
123 ctx_options = SSL_CTX_set_options(ctx, opts);
124 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
125 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
126 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
127 SSL_CTX_set_info_callback(ctx, StaticSSLInfoCallback);
135 bool SetDH(DHParams& dh)
138 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
141 #ifdef INSPIRCD_OPENSSL_ENABLE_ECDH
142 void SetECDH(const std::string& curvename)
144 int nid = OBJ_sn2nid(curvename.c_str());
146 throw Exception("Unknown curve: " + curvename);
148 EC_KEY* eckey = EC_KEY_new_by_curve_name(nid);
150 throw Exception("Unable to create EC key object");
153 bool ret = (SSL_CTX_set_tmp_ecdh(ctx, eckey) >= 0);
156 throw Exception("Couldn't set ECDH parameters");
160 bool SetCiphers(const std::string& ciphers)
163 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
166 bool SetCerts(const std::string& filename)
169 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
172 bool SetPrivateKey(const std::string& filename)
175 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
178 bool SetCA(const std::string& filename)
181 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
184 long GetDefaultContextOptions() const
189 long SetRawContextOptions(long setoptions, long clearoptions)
192 SSL_CTX_clear_options(ctx, SSL_CTX_get_options(ctx));
194 // Set the default options and what is in the conf
195 SSL_CTX_set_options(ctx, ctx_options | setoptions);
196 return SSL_CTX_clear_options(ctx, clearoptions);
199 SSL* CreateServerSession()
201 SSL* sess = SSL_new(ctx);
202 SSL_set_accept_state(sess); // Act as server
206 SSL* CreateClientSession()
208 SSL* sess = SSL_new(ctx);
209 SSL_set_connect_state(sess); // Act as client
214 class Profile : public refcountbase
216 /** Name of this profile
218 const std::string name;
220 /** DH parameters in use
224 /** OpenSSL makes us have two contexts, one for servers and one for clients
229 /** Digest to use when generating fingerprints
231 const EVP_MD* digest;
233 /** Last error, set by error_callback()
237 /** True if renegotiations are allowed, false if not
239 const bool allowrenego;
241 static int error_callback(const char* str, size_t len, void* u)
243 Profile* profile = reinterpret_cast<Profile*>(u);
244 profile->lasterr = std::string(str, len - 1);
248 /** Set raw OpenSSL context (SSL_CTX) options from a config tag
249 * @param ctxname Name of the context, client or server
250 * @param tag Config tag defining this profile
251 * @param context Context object to manipulate
253 void SetContextOptions(const std::string& ctxname, ConfigTag* tag, Context& context)
255 long setoptions = tag->getInt(ctxname + "setoptions");
256 long clearoptions = tag->getInt(ctxname + "clearoptions");
257 #ifdef SSL_OP_NO_COMPRESSION
258 if (!tag->getBool("compression", true))
259 setoptions |= SSL_OP_NO_COMPRESSION;
261 if (!tag->getBool("sslv3", true))
262 setoptions |= SSL_OP_NO_SSLv3;
263 if (!tag->getBool("tlsv1", true))
264 setoptions |= SSL_OP_NO_TLSv1;
266 if (!setoptions && !clearoptions)
267 return; // Nothing to do
269 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);
270 long final = context.SetRawContextOptions(setoptions, clearoptions);
271 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "%s %s context options: %ld", name.c_str(), ctxname.c_str(), final);
275 Profile(const std::string& profilename, ConfigTag* tag)
277 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dh.pem")))
278 , ctx(SSL_CTX_new(SSLv23_server_method()))
279 , clictx(SSL_CTX_new(SSLv23_client_method()))
280 , allowrenego(tag->getBool("renegotiation", true))
282 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
283 throw Exception("Couldn't set DH parameters");
285 std::string hash = tag->getString("hash", "md5");
286 digest = EVP_get_digestbyname(hash.c_str());
288 throw Exception("Unknown hash type " + hash);
290 std::string ciphers = tag->getString("ciphers");
291 if (!ciphers.empty())
293 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
295 ERR_print_errors_cb(error_callback, this);
296 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
300 #ifdef INSPIRCD_OPENSSL_ENABLE_ECDH
301 std::string curvename = tag->getString("ecdhcurve", "prime256v1");
302 if (!curvename.empty())
303 ctx.SetECDH(curvename);
306 SetContextOptions("server", tag, ctx);
307 SetContextOptions("client", tag, clictx);
309 /* Load our keys and certificates
310 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
312 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
313 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
315 ERR_print_errors_cb(error_callback, this);
316 throw Exception("Can't read certificate file: " + lasterr);
319 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
320 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
322 ERR_print_errors_cb(error_callback, this);
323 throw Exception("Can't read key file: " + lasterr);
326 // Load the CAs we trust
327 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
328 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
330 ERR_print_errors_cb(error_callback, this);
331 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());
335 const std::string& GetName() const { return name; }
336 SSL* CreateServerSession() { return ctx.CreateServerSession(); }
337 SSL* CreateClientSession() { return clictx.CreateClientSession(); }
338 const EVP_MD* GetDigest() { return digest; }
339 bool AllowRenegotiation() const { return allowrenego; }
343 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
345 /* XXX: This will allow self signed certificates.
346 * In the future if we want an option to not allow this,
347 * we can just return preverify_ok here, and openssl
348 * will boot off self-signed and invalid peer certs.
350 int ve = X509_STORE_CTX_get_error(ctx);
352 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
357 class OpenSSLIOHook : public SSLIOHook
364 reference<OpenSSL::Profile> profile;
366 // Returns 1 if handshake succeeded, 0 if it is still in progress, -1 if it failed
367 int Handshake(StreamSocket* user)
370 int ret = SSL_do_handshake(sess);
373 int err = SSL_get_error(sess, ret);
375 if (err == SSL_ERROR_WANT_READ)
377 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
378 this->status = ISSL_HANDSHAKING;
381 else if (err == SSL_ERROR_WANT_WRITE)
383 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
384 this->status = ISSL_HANDSHAKING;
395 // Handshake complete.
400 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
423 void VerifyCertificate()
426 ssl_cert* certinfo = new ssl_cert;
427 this->certificate = certinfo;
429 unsigned char md[EVP_MAX_MD_SIZE];
431 cert = SSL_get_peer_certificate(sess);
435 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
439 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
443 certinfo->unknownsigner = false;
444 certinfo->trusted = true;
448 certinfo->unknownsigner = true;
449 certinfo->trusted = false;
453 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
455 // Make sure there are no chars in the string that we consider invalid
456 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
457 certinfo->dn.clear();
459 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
460 certinfo->issuer = buf;
461 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
462 certinfo->issuer.clear();
464 if (!X509_digest(cert, profile->GetDigest(), md, &n))
466 certinfo->error = "Out of memory generating fingerprint";
470 certinfo->fingerprint = BinToHex(md, n);
473 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))
475 certinfo->error = "Not activated, or expired certificate";
481 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
482 void SSLInfoCallback(int where, int rc)
484 if ((where & SSL_CB_HANDSHAKE_START) && (status == ISSL_OPEN))
486 if (profile->AllowRenegotiation())
489 // The other side is trying to renegotiate, kill the connection and change status
490 // to ISSL_NONE so CheckRenego() closes the session
492 SocketEngine::Shutdown(SSL_get_fd(sess), 2);
496 bool CheckRenego(StreamSocket* sock)
498 if (status != ISSL_NONE)
501 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Session %p killed, attempted to renegotiate", (void*)sess);
503 sock->SetError("Renegotiation is not allowed");
508 // Returns 1 if application I/O should proceed, 0 if it must wait for the underlying protocol to progress, -1 on fatal error
509 int PrepareIO(StreamSocket* sock)
511 if (status == ISSL_OPEN)
513 else if (status == ISSL_HANDSHAKING)
515 // The handshake isn't finished, try to finish it
516 return Handshake(sock);
523 // Calls our private SSLInfoCallback()
524 friend void StaticSSLInfoCallback(const SSL* ssl, int where, int rc);
527 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool is_outbound, SSL* session, const reference<OpenSSL::Profile>& sslprofile)
528 : SSLIOHook(hookprov)
531 , outbound(is_outbound)
532 , data_to_write(false)
533 , profile(sslprofile)
537 if (SSL_set_fd(sess, sock->GetFd()) == 0)
538 throw ModuleException("Can't set fd with SSL_set_fd: " + ConvToStr(sock->GetFd()));
540 SSL_set_ex_data(sess, exdataindex, this);
541 sock->AddIOHook(this);
545 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
550 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
552 // Finish handshake if needed
553 int prepret = PrepareIO(user);
557 // If we resumed the handshake then this->status will be ISSL_OPEN
560 char* buffer = ServerInstance->GetReadBuffer();
561 size_t bufsiz = ServerInstance->Config->NetBufferSize;
562 int ret = SSL_read(sess, buffer, bufsiz);
564 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
565 if (!CheckRenego(user))
571 recvq.append(buffer, ret);
573 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
578 // Client closed connection.
580 user->SetError("Connection closed");
585 int err = SSL_get_error(sess, ret);
587 if (err == SSL_ERROR_WANT_READ)
589 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
592 else if (err == SSL_ERROR_WANT_WRITE)
594 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
606 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
608 // Finish handshake if needed
609 int prepret = PrepareIO(user);
613 data_to_write = true;
615 // Session is ready for transferring application data
618 int ret = SSL_write(sess, buffer.data(), buffer.size());
620 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
621 if (!CheckRenego(user))
625 if (ret == (int)buffer.length())
627 data_to_write = false;
628 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
633 buffer.erase(0, ret);
634 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
644 int err = SSL_get_error(sess, ret);
646 if (err == SSL_ERROR_WANT_WRITE)
648 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
651 else if (err == SSL_ERROR_WANT_READ)
653 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
665 void TellCiphersAndFingerprint(LocalUser* user)
669 std::string text = "*** You are connected using SSL cipher '";
670 GetCiphersuite(text);
672 const std::string& fingerprint = certificate->fingerprint;
673 if (!fingerprint.empty())
674 text += " and your SSL certificate fingerprint is " + fingerprint;
676 user->WriteNotice(text);
680 void GetCiphersuite(std::string& out) const
682 out.append(SSL_get_version(sess)).push_back('-');
683 out.append(SSL_get_cipher(sess));
687 static void StaticSSLInfoCallback(const SSL* ssl, int where, int rc)
689 #ifdef INSPIRCD_OPENSSL_ENABLE_RENEGO_DETECTION
690 OpenSSLIOHook* hook = static_cast<OpenSSLIOHook*>(SSL_get_ex_data(ssl, exdataindex));
691 hook->SSLInfoCallback(where, rc);
695 class OpenSSLIOHookProvider : public refcountbase, public IOHookProvider
697 reference<OpenSSL::Profile> profile;
700 OpenSSLIOHookProvider(Module* mod, reference<OpenSSL::Profile>& prof)
701 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
704 ServerInstance->Modules->AddService(*this);
707 ~OpenSSLIOHookProvider()
709 ServerInstance->Modules->DelService(*this);
712 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
714 new OpenSSLIOHook(this, sock, false, profile->CreateServerSession(), profile);
717 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
719 new OpenSSLIOHook(this, sock, true, profile->CreateClientSession(), profile);
723 class ModuleSSLOpenSSL : public Module
725 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
727 ProfileList profiles;
731 ProfileList newprofiles;
732 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
733 if (tags.first == tags.second)
735 // Create a default profile named "openssl"
736 const std::string defname = "openssl";
737 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
738 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
742 reference<OpenSSL::Profile> profile(new OpenSSL::Profile(defname, tag));
743 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
745 catch (OpenSSL::Exception& ex)
747 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
751 for (ConfigIter i = tags.first; i != tags.second; ++i)
753 ConfigTag* tag = i->second;
754 if (tag->getString("provider") != "openssl")
757 std::string name = tag->getString("name");
760 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
764 reference<OpenSSL::Profile> profile;
767 profile = new OpenSSL::Profile(name, tag);
769 catch (CoreException& ex)
771 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
774 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
777 profiles.swap(newprofiles);
783 // Initialize OpenSSL
785 SSL_load_error_strings();
788 void init() CXX11_OVERRIDE
790 // Register application specific data
791 char exdatastr[] = "inspircd";
792 exdataindex = SSL_get_ex_new_index(0, exdatastr, NULL, NULL, NULL);
794 throw ModuleException("Failed to register application specific data");
799 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
808 catch (ModuleException& ex)
810 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
814 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
816 IOHook* hook = user->eh.GetIOHook();
817 if (hook && hook->prov->creator == this)
818 static_cast<OpenSSLIOHook*>(hook)->TellCiphersAndFingerprint(user);
821 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
823 if (target_type == TYPE_USER)
825 LocalUser* user = IS_LOCAL((User*)item);
827 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
829 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
830 // Potentially there could be multiple SSL modules loaded at once on different ports.
831 ServerInstance->Users->QuitUser(user, "SSL module unloading");
836 Version GetVersion() CXX11_OVERRIDE
838 return Version("Provides SSL support for clients", VF_VENDOR);
842 MODULE_INIT(ModuleSSLOpenSSL)