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, "libcrypto.lib")
39 # pragma comment(lib, "libssl.lib")
40 # pragma comment(lib, "user32.lib")
41 # pragma comment(lib, "advapi32.lib")
42 # pragma comment(lib, "libgcc.lib")
43 # pragma comment(lib, "libmingwex.lib")
44 # pragma comment(lib, "gdi32.lib")
47 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
48 /* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto") */
50 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
52 static bool SelfSigned = false;
56 return ERR_error_string(ERR_get_error(), NULL);
59 static int OnVerify(int preverify_ok, X509_STORE_CTX* ctx);
63 class Exception : public ModuleException
66 Exception(const std::string& reason)
67 : ModuleException(reason) { }
75 DHParams(const std::string& filename)
77 FILE* dhpfile = fopen(filename.c_str(), "r");
79 throw Exception("Couldn't open DH file " + filename + ": " + strerror(errno));
81 dh = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
84 throw Exception("Couldn't read DH params from file " + filename);
103 Context(SSL_CTX* context)
106 // Sane default options for OpenSSL see https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html
107 // and when choosing a cipher, use the server's preferences instead of the client preferences.
108 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_CIPHER_SERVER_PREFERENCE);
109 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
110 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
112 const unsigned char session_id[] = "inspircd";
113 SSL_CTX_set_session_id_context(ctx, session_id, sizeof(session_id) - 1);
121 bool SetDH(DHParams& dh)
123 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
126 bool SetCiphers(const std::string& ciphers)
128 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
131 bool SetCerts(const std::string& filename)
133 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
136 bool SetPrivateKey(const std::string& filename)
138 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
141 bool SetCA(const std::string& filename)
143 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
152 class Profile : public refcountbase
154 /** Name of this profile
156 const std::string name;
158 /** DH parameters in use
162 /** OpenSSL makes us have two contexts, one for servers and one for clients
167 /** Digest to use when generating fingerprints
169 const EVP_MD* digest;
171 /** Last error, set by error_callback()
175 static int error_callback(const char* str, size_t len, void* u)
177 Profile* profile = reinterpret_cast<Profile*>(u);
178 profile->lasterr = std::string(str, len - 1);
183 Profile(const std::string& profilename, ConfigTag* tag)
185 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dh.pem")))
186 , ctx(SSL_CTX_new(SSLv23_server_method()))
187 , clictx(SSL_CTX_new(SSLv23_client_method()))
189 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
190 throw Exception("Couldn't set DH parameters");
192 std::string hash = tag->getString("hash", "md5");
193 digest = EVP_get_digestbyname(hash.c_str());
195 throw Exception("Unknown hash type " + hash);
197 std::string ciphers = tag->getString("ciphers");
198 if (!ciphers.empty())
200 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
202 ERR_print_errors_cb(error_callback, this);
203 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
207 /* Load our keys and certificates
208 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
210 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
211 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
213 ERR_print_errors_cb(error_callback, this);
214 throw Exception("Can't read certificate file: " + lasterr);
217 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
218 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
220 ERR_print_errors_cb(error_callback, this);
221 throw Exception("Can't read key file: " + lasterr);
224 // Load the CAs we trust
225 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
226 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
228 ERR_print_errors_cb(error_callback, this);
229 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());
233 const std::string& GetName() const { return name; }
234 SSL* CreateServerSession() { return ctx.CreateSession(); }
235 SSL* CreateClientSession() { return clictx.CreateSession(); }
236 const EVP_MD* GetDigest() { return digest; }
240 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
242 /* XXX: This will allow self signed certificates.
243 * In the future if we want an option to not allow this,
244 * we can just return preverify_ok here, and openssl
245 * will boot off self-signed and invalid peer certs.
247 int ve = X509_STORE_CTX_get_error(ctx);
249 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
254 class OpenSSLIOHook : public SSLIOHook
261 reference<OpenSSL::Profile> profile;
263 bool Handshake(StreamSocket* user)
268 ret = SSL_connect(sess);
270 ret = SSL_accept(sess);
274 int err = SSL_get_error(sess, ret);
276 if (err == SSL_ERROR_WANT_READ)
278 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
279 this->status = ISSL_HANDSHAKING;
282 else if (err == SSL_ERROR_WANT_WRITE)
284 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
285 this->status = ISSL_HANDSHAKING;
297 // Handshake complete.
302 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
328 void VerifyCertificate()
331 ssl_cert* certinfo = new ssl_cert;
332 this->certificate = certinfo;
334 unsigned char md[EVP_MAX_MD_SIZE];
336 cert = SSL_get_peer_certificate(sess);
340 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
344 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
348 certinfo->unknownsigner = false;
349 certinfo->trusted = true;
353 certinfo->unknownsigner = true;
354 certinfo->trusted = false;
358 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
360 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
361 certinfo->issuer = buf;
363 if (!X509_digest(cert, profile->GetDigest(), md, &n))
365 certinfo->error = "Out of memory generating fingerprint";
369 certinfo->fingerprint = BinToHex(md, n);
372 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))
374 certinfo->error = "Not activated, or expired certificate";
381 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool is_outbound, SSL* session, const reference<OpenSSL::Profile>& sslprofile)
382 : SSLIOHook(hookprov)
385 , outbound(is_outbound)
386 , data_to_write(false)
387 , profile(sslprofile)
391 if (SSL_set_fd(sess, sock->GetFd()) == 0)
392 throw ModuleException("Can't set fd with SSL_set_fd: " + ConvToStr(sock->GetFd()));
394 sock->AddIOHook(this);
398 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
403 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
411 if (status == ISSL_HANDSHAKING)
413 // The handshake isn't finished and it wants to read, try to finish it.
414 if (!Handshake(user))
416 // Couldn't resume handshake.
417 if (status == ISSL_NONE)
423 // If we resumed the handshake then this->status will be ISSL_OPEN
425 if (status == ISSL_OPEN)
427 char* buffer = ServerInstance->GetReadBuffer();
428 size_t bufsiz = ServerInstance->Config->NetBufferSize;
429 int ret = SSL_read(sess, buffer, bufsiz);
433 recvq.append(buffer, ret);
435 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
440 // Client closed connection.
442 user->SetError("Connection closed");
447 int err = SSL_get_error(sess, ret);
449 if (err == SSL_ERROR_WANT_READ)
451 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
454 else if (err == SSL_ERROR_WANT_WRITE)
456 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
470 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
478 data_to_write = true;
480 if (status == ISSL_HANDSHAKING)
482 if (!Handshake(user))
484 // Couldn't resume handshake.
485 if (status == ISSL_NONE)
491 if (status == ISSL_OPEN)
493 int ret = SSL_write(sess, buffer.data(), buffer.size());
494 if (ret == (int)buffer.length())
496 data_to_write = false;
497 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
502 buffer = buffer.substr(ret);
503 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
513 int err = SSL_get_error(sess, ret);
515 if (err == SSL_ERROR_WANT_WRITE)
517 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
520 else if (err == SSL_ERROR_WANT_READ)
522 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
535 void TellCiphersAndFingerprint(LocalUser* user)
539 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(sess)) + "'";
540 const std::string& fingerprint = certificate->fingerprint;
541 if (!fingerprint.empty())
542 text += " and your SSL fingerprint is " + fingerprint;
544 user->WriteNotice(text);
549 class OpenSSLIOHookProvider : public refcountbase, public IOHookProvider
551 reference<OpenSSL::Profile> profile;
554 OpenSSLIOHookProvider(Module* mod, reference<OpenSSL::Profile>& prof)
555 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
558 ServerInstance->Modules->AddService(*this);
561 ~OpenSSLIOHookProvider()
563 ServerInstance->Modules->DelService(*this);
566 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
568 new OpenSSLIOHook(this, sock, false, profile->CreateServerSession(), profile);
571 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
573 new OpenSSLIOHook(this, sock, true, profile->CreateClientSession(), profile);
577 class ModuleSSLOpenSSL : public Module
579 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
581 ProfileList profiles;
585 ProfileList newprofiles;
586 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
587 if (tags.first == tags.second)
589 // Create a default profile named "openssl"
590 const std::string defname = "openssl";
591 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
592 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
596 reference<OpenSSL::Profile> profile(new OpenSSL::Profile(defname, tag));
597 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
599 catch (OpenSSL::Exception& ex)
601 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
605 for (ConfigIter i = tags.first; i != tags.second; ++i)
607 ConfigTag* tag = i->second;
608 if (tag->getString("provider") != "openssl")
611 std::string name = tag->getString("name");
614 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
618 reference<OpenSSL::Profile> profile;
621 profile = new OpenSSL::Profile(name, tag);
623 catch (CoreException& ex)
625 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
628 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
631 profiles.swap(newprofiles);
637 // Initialize OpenSSL
639 SSL_load_error_strings();
642 void init() CXX11_OVERRIDE
647 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
656 catch (ModuleException& ex)
658 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
662 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
664 IOHook* hook = user->eh.GetIOHook();
665 if (hook && hook->prov->creator == this)
666 static_cast<OpenSSLIOHook*>(hook)->TellCiphersAndFingerprint(user);
669 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
671 if (target_type == TYPE_USER)
673 LocalUser* user = IS_LOCAL((User*)item);
675 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
677 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
678 // Potentially there could be multiple SSL modules loaded at once on different ports.
679 ServerInstance->Users->QuitUser(user, "SSL module unloading");
684 Version GetVersion() CXX11_OVERRIDE
686 return Version("Provides SSL support for clients", VF_VENDOR);
690 MODULE_INIT(ModuleSSLOpenSSL)