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);
59 class Exception : public ModuleException
62 Exception(const std::string& reason)
63 : ModuleException(reason) { }
71 DHParams(const std::string& filename)
73 BIO* dhpfile = BIO_new_file(filename.c_str(), "r");
75 throw Exception("Couldn't open DH file " + filename);
77 dh = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
81 throw Exception("Couldn't read DH params from file " + filename);
100 Context(SSL_CTX* context)
103 // Sane default options for OpenSSL see https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html
104 // and when choosing a cipher, use the server's preferences instead of the client preferences.
105 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_CIPHER_SERVER_PREFERENCE);
106 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
107 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
109 const unsigned char session_id[] = "inspircd";
110 SSL_CTX_set_session_id_context(ctx, session_id, sizeof(session_id) - 1);
118 bool SetDH(DHParams& dh)
120 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
123 bool SetCiphers(const std::string& ciphers)
125 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
128 bool SetCerts(const std::string& filename)
130 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
133 bool SetPrivateKey(const std::string& filename)
135 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
138 bool SetCA(const std::string& filename)
140 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
149 class Profile : public refcountbase
151 /** Name of this profile
153 const std::string name;
155 /** DH parameters in use
159 /** OpenSSL makes us have two contexts, one for servers and one for clients
164 /** Digest to use when generating fingerprints
166 const EVP_MD* digest;
168 /** Last error, set by error_callback()
172 static int error_callback(const char* str, size_t len, void* u)
174 Profile* profile = reinterpret_cast<Profile*>(u);
175 profile->lasterr = std::string(str, len - 1);
180 Profile(const std::string& profilename, ConfigTag* tag)
182 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dh.pem")))
183 , ctx(SSL_CTX_new(SSLv23_server_method()))
184 , clictx(SSL_CTX_new(SSLv23_client_method()))
186 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
187 throw Exception("Couldn't set DH parameters");
189 std::string hash = tag->getString("hash", "md5");
190 digest = EVP_get_digestbyname(hash.c_str());
192 throw Exception("Unknown hash type " + hash);
194 std::string ciphers = tag->getString("ciphers");
195 if (!ciphers.empty())
197 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
199 ERR_print_errors_cb(error_callback, this);
200 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
204 /* Load our keys and certificates
205 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
207 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
208 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
210 ERR_print_errors_cb(error_callback, this);
211 throw Exception("Can't read certificate file: " + lasterr);
214 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
215 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
217 ERR_print_errors_cb(error_callback, this);
218 throw Exception("Can't read key file: " + lasterr);
221 // Load the CAs we trust
222 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
223 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
225 ERR_print_errors_cb(error_callback, this);
226 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());
230 const std::string& GetName() const { return name; }
231 SSL* CreateServerSession() { return ctx.CreateSession(); }
232 SSL* CreateClientSession() { return clictx.CreateSession(); }
233 const EVP_MD* GetDigest() { return digest; }
237 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
239 /* XXX: This will allow self signed certificates.
240 * In the future if we want an option to not allow this,
241 * we can just return preverify_ok here, and openssl
242 * will boot off self-signed and invalid peer certs.
244 int ve = X509_STORE_CTX_get_error(ctx);
246 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
251 class OpenSSLIOHook : public SSLIOHook
258 reference<OpenSSL::Profile> profile;
260 bool Handshake(StreamSocket* user)
265 ret = SSL_connect(sess);
267 ret = SSL_accept(sess);
271 int err = SSL_get_error(sess, ret);
273 if (err == SSL_ERROR_WANT_READ)
275 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
276 this->status = ISSL_HANDSHAKING;
279 else if (err == SSL_ERROR_WANT_WRITE)
281 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
282 this->status = ISSL_HANDSHAKING;
294 // Handshake complete.
299 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
325 void VerifyCertificate()
328 ssl_cert* certinfo = new ssl_cert;
329 this->certificate = certinfo;
331 unsigned char md[EVP_MAX_MD_SIZE];
333 cert = SSL_get_peer_certificate(sess);
337 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
341 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
345 certinfo->unknownsigner = false;
346 certinfo->trusted = true;
350 certinfo->unknownsigner = true;
351 certinfo->trusted = false;
355 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
357 // Make sure there are no chars in the string that we consider invalid
358 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
359 certinfo->dn.clear();
361 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
362 certinfo->issuer = buf;
363 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
364 certinfo->issuer.clear();
366 if (!X509_digest(cert, profile->GetDigest(), md, &n))
368 certinfo->error = "Out of memory generating fingerprint";
372 certinfo->fingerprint = BinToHex(md, n);
375 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))
377 certinfo->error = "Not activated, or expired certificate";
384 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool is_outbound, SSL* session, const reference<OpenSSL::Profile>& sslprofile)
385 : SSLIOHook(hookprov)
388 , outbound(is_outbound)
389 , data_to_write(false)
390 , profile(sslprofile)
394 if (SSL_set_fd(sess, sock->GetFd()) == 0)
395 throw ModuleException("Can't set fd with SSL_set_fd: " + ConvToStr(sock->GetFd()));
397 SSL_set_ex_data(sess, exdataindex, this);
398 sock->AddIOHook(this);
402 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
407 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
415 if (status == ISSL_HANDSHAKING)
417 // The handshake isn't finished and it wants to read, try to finish it.
418 if (!Handshake(user))
420 // Couldn't resume handshake.
421 if (status == ISSL_NONE)
427 // If we resumed the handshake then this->status will be ISSL_OPEN
429 if (status == ISSL_OPEN)
431 char* buffer = ServerInstance->GetReadBuffer();
432 size_t bufsiz = ServerInstance->Config->NetBufferSize;
433 int ret = SSL_read(sess, buffer, bufsiz);
437 recvq.append(buffer, ret);
439 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
444 // Client closed connection.
446 user->SetError("Connection closed");
451 int err = SSL_get_error(sess, ret);
453 if (err == SSL_ERROR_WANT_READ)
455 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
458 else if (err == SSL_ERROR_WANT_WRITE)
460 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
474 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
482 data_to_write = true;
484 if (status == ISSL_HANDSHAKING)
486 if (!Handshake(user))
488 // Couldn't resume handshake.
489 if (status == ISSL_NONE)
495 if (status == ISSL_OPEN)
497 int ret = SSL_write(sess, buffer.data(), buffer.size());
498 if (ret == (int)buffer.length())
500 data_to_write = false;
501 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
506 buffer = buffer.substr(ret);
507 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
517 int err = SSL_get_error(sess, ret);
519 if (err == SSL_ERROR_WANT_WRITE)
521 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
524 else if (err == SSL_ERROR_WANT_READ)
526 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
539 void TellCiphersAndFingerprint(LocalUser* user)
543 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(sess)) + "'";
544 const std::string& fingerprint = certificate->fingerprint;
545 if (!fingerprint.empty())
546 text += " and your SSL certificate fingerprint is " + fingerprint;
548 user->WriteNotice(text);
553 class OpenSSLIOHookProvider : public refcountbase, public IOHookProvider
555 reference<OpenSSL::Profile> profile;
558 OpenSSLIOHookProvider(Module* mod, reference<OpenSSL::Profile>& prof)
559 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
562 ServerInstance->Modules->AddService(*this);
565 ~OpenSSLIOHookProvider()
567 ServerInstance->Modules->DelService(*this);
570 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
572 new OpenSSLIOHook(this, sock, false, profile->CreateServerSession(), profile);
575 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
577 new OpenSSLIOHook(this, sock, true, profile->CreateClientSession(), profile);
581 class ModuleSSLOpenSSL : public Module
583 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
585 ProfileList profiles;
589 ProfileList newprofiles;
590 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
591 if (tags.first == tags.second)
593 // Create a default profile named "openssl"
594 const std::string defname = "openssl";
595 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
596 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
600 reference<OpenSSL::Profile> profile(new OpenSSL::Profile(defname, tag));
601 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
603 catch (OpenSSL::Exception& ex)
605 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
609 for (ConfigIter i = tags.first; i != tags.second; ++i)
611 ConfigTag* tag = i->second;
612 if (tag->getString("provider") != "openssl")
615 std::string name = tag->getString("name");
618 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
622 reference<OpenSSL::Profile> profile;
625 profile = new OpenSSL::Profile(name, tag);
627 catch (CoreException& ex)
629 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
632 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
635 profiles.swap(newprofiles);
641 // Initialize OpenSSL
643 SSL_load_error_strings();
646 void init() CXX11_OVERRIDE
648 // Register application specific data
649 char exdatastr[] = "inspircd";
650 exdataindex = SSL_get_ex_new_index(0, exdatastr, NULL, NULL, NULL);
652 throw ModuleException("Failed to register application specific data");
657 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
666 catch (ModuleException& ex)
668 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
672 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
674 IOHook* hook = user->eh.GetIOHook();
675 if (hook && hook->prov->creator == this)
676 static_cast<OpenSSLIOHook*>(hook)->TellCiphersAndFingerprint(user);
679 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
681 if (target_type == TYPE_USER)
683 LocalUser* user = IS_LOCAL((User*)item);
685 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
687 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
688 // Potentially there could be multiple SSL modules loaded at once on different ports.
689 ServerInstance->Users->QuitUser(user, "SSL module unloading");
694 Version GetVersion() CXX11_OVERRIDE
696 return Version("Provides SSL support for clients", VF_VENDOR);
700 MODULE_INIT(ModuleSSLOpenSSL)