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;
51 return ERR_error_string(ERR_get_error(), NULL);
54 static int OnVerify(int preverify_ok, X509_STORE_CTX* ctx);
58 class Exception : public ModuleException
61 Exception(const std::string& reason)
62 : ModuleException(reason) { }
70 DHParams(const std::string& filename)
72 BIO* dhpfile = BIO_new_file(filename.c_str(), "r");
74 throw Exception("Couldn't open DH file " + filename);
76 dh = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
80 throw Exception("Couldn't read DH params from file " + filename);
99 Context(SSL_CTX* context)
102 // Sane default options for OpenSSL see https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html
103 // and when choosing a cipher, use the server's preferences instead of the client preferences.
104 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_CIPHER_SERVER_PREFERENCE);
105 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
106 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
108 const unsigned char session_id[] = "inspircd";
109 SSL_CTX_set_session_id_context(ctx, session_id, sizeof(session_id) - 1);
117 bool SetDH(DHParams& dh)
119 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
122 bool SetCiphers(const std::string& ciphers)
124 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
127 bool SetCerts(const std::string& filename)
129 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
132 bool SetPrivateKey(const std::string& filename)
134 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
137 bool SetCA(const std::string& filename)
139 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
148 class Profile : public refcountbase
150 /** Name of this profile
152 const std::string name;
154 /** DH parameters in use
158 /** OpenSSL makes us have two contexts, one for servers and one for clients
163 /** Digest to use when generating fingerprints
165 const EVP_MD* digest;
167 /** Last error, set by error_callback()
171 static int error_callback(const char* str, size_t len, void* u)
173 Profile* profile = reinterpret_cast<Profile*>(u);
174 profile->lasterr = std::string(str, len - 1);
179 Profile(const std::string& profilename, ConfigTag* tag)
181 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dh.pem")))
182 , ctx(SSL_CTX_new(SSLv23_server_method()))
183 , clictx(SSL_CTX_new(SSLv23_client_method()))
185 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
186 throw Exception("Couldn't set DH parameters");
188 std::string hash = tag->getString("hash", "md5");
189 digest = EVP_get_digestbyname(hash.c_str());
191 throw Exception("Unknown hash type " + hash);
193 std::string ciphers = tag->getString("ciphers");
194 if (!ciphers.empty())
196 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
198 ERR_print_errors_cb(error_callback, this);
199 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
203 /* Load our keys and certificates
204 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
206 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
207 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
209 ERR_print_errors_cb(error_callback, this);
210 throw Exception("Can't read certificate file: " + lasterr);
213 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
214 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
216 ERR_print_errors_cb(error_callback, this);
217 throw Exception("Can't read key file: " + lasterr);
220 // Load the CAs we trust
221 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
222 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
224 ERR_print_errors_cb(error_callback, this);
225 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());
229 const std::string& GetName() const { return name; }
230 SSL* CreateServerSession() { return ctx.CreateSession(); }
231 SSL* CreateClientSession() { return clictx.CreateSession(); }
232 const EVP_MD* GetDigest() { return digest; }
236 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
238 /* XXX: This will allow self signed certificates.
239 * In the future if we want an option to not allow this,
240 * we can just return preverify_ok here, and openssl
241 * will boot off self-signed and invalid peer certs.
243 int ve = X509_STORE_CTX_get_error(ctx);
245 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
250 class OpenSSLIOHook : public SSLIOHook
257 reference<OpenSSL::Profile> profile;
259 bool Handshake(StreamSocket* user)
264 ret = SSL_connect(sess);
266 ret = SSL_accept(sess);
270 int err = SSL_get_error(sess, ret);
272 if (err == SSL_ERROR_WANT_READ)
274 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
275 this->status = ISSL_HANDSHAKING;
278 else if (err == SSL_ERROR_WANT_WRITE)
280 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
281 this->status = ISSL_HANDSHAKING;
293 // Handshake complete.
298 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
324 void VerifyCertificate()
327 ssl_cert* certinfo = new ssl_cert;
328 this->certificate = certinfo;
330 unsigned char md[EVP_MAX_MD_SIZE];
332 cert = SSL_get_peer_certificate(sess);
336 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
340 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
344 certinfo->unknownsigner = false;
345 certinfo->trusted = true;
349 certinfo->unknownsigner = true;
350 certinfo->trusted = false;
354 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
356 // Make sure there are no chars in the string that we consider invalid
357 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
358 certinfo->dn.clear();
360 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
361 certinfo->issuer = buf;
362 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
363 certinfo->issuer.clear();
365 if (!X509_digest(cert, profile->GetDigest(), md, &n))
367 certinfo->error = "Out of memory generating fingerprint";
371 certinfo->fingerprint = BinToHex(md, n);
374 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))
376 certinfo->error = "Not activated, or expired certificate";
383 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool is_outbound, SSL* session, const reference<OpenSSL::Profile>& sslprofile)
384 : SSLIOHook(hookprov)
387 , outbound(is_outbound)
388 , data_to_write(false)
389 , profile(sslprofile)
393 if (SSL_set_fd(sess, sock->GetFd()) == 0)
394 throw ModuleException("Can't set fd with SSL_set_fd: " + ConvToStr(sock->GetFd()));
396 sock->AddIOHook(this);
400 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
405 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
413 if (status == ISSL_HANDSHAKING)
415 // The handshake isn't finished and it wants to read, try to finish it.
416 if (!Handshake(user))
418 // Couldn't resume handshake.
419 if (status == ISSL_NONE)
425 // If we resumed the handshake then this->status will be ISSL_OPEN
427 if (status == ISSL_OPEN)
429 char* buffer = ServerInstance->GetReadBuffer();
430 size_t bufsiz = ServerInstance->Config->NetBufferSize;
431 int ret = SSL_read(sess, buffer, bufsiz);
435 recvq.append(buffer, ret);
437 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
442 // Client closed connection.
444 user->SetError("Connection closed");
449 int err = SSL_get_error(sess, ret);
451 if (err == SSL_ERROR_WANT_READ)
453 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
456 else if (err == SSL_ERROR_WANT_WRITE)
458 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
472 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
480 data_to_write = true;
482 if (status == ISSL_HANDSHAKING)
484 if (!Handshake(user))
486 // Couldn't resume handshake.
487 if (status == ISSL_NONE)
493 if (status == ISSL_OPEN)
495 int ret = SSL_write(sess, buffer.data(), buffer.size());
496 if (ret == (int)buffer.length())
498 data_to_write = false;
499 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
504 buffer = buffer.substr(ret);
505 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
515 int err = SSL_get_error(sess, ret);
517 if (err == SSL_ERROR_WANT_WRITE)
519 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
522 else if (err == SSL_ERROR_WANT_READ)
524 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
537 void TellCiphersAndFingerprint(LocalUser* user)
541 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(sess)) + "'";
542 const std::string& fingerprint = certificate->fingerprint;
543 if (!fingerprint.empty())
544 text += " and your SSL certificate fingerprint is " + fingerprint;
546 user->WriteNotice(text);
551 class OpenSSLIOHookProvider : public refcountbase, public IOHookProvider
553 reference<OpenSSL::Profile> profile;
556 OpenSSLIOHookProvider(Module* mod, reference<OpenSSL::Profile>& prof)
557 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
560 ServerInstance->Modules->AddService(*this);
563 ~OpenSSLIOHookProvider()
565 ServerInstance->Modules->DelService(*this);
568 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
570 new OpenSSLIOHook(this, sock, false, profile->CreateServerSession(), profile);
573 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
575 new OpenSSLIOHook(this, sock, true, profile->CreateClientSession(), profile);
579 class ModuleSSLOpenSSL : public Module
581 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
583 ProfileList profiles;
587 ProfileList newprofiles;
588 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
589 if (tags.first == tags.second)
591 // Create a default profile named "openssl"
592 const std::string defname = "openssl";
593 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
594 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
598 reference<OpenSSL::Profile> profile(new OpenSSL::Profile(defname, tag));
599 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
601 catch (OpenSSL::Exception& ex)
603 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
607 for (ConfigIter i = tags.first; i != tags.second; ++i)
609 ConfigTag* tag = i->second;
610 if (tag->getString("provider") != "openssl")
613 std::string name = tag->getString("name");
616 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
620 reference<OpenSSL::Profile> profile;
623 profile = new OpenSSL::Profile(name, tag);
625 catch (CoreException& ex)
627 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
630 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
633 profiles.swap(newprofiles);
639 // Initialize OpenSSL
641 SSL_load_error_strings();
644 void init() CXX11_OVERRIDE
649 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
658 catch (ModuleException& ex)
660 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
664 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
666 IOHook* hook = user->eh.GetIOHook();
667 if (hook && hook->prov->creator == this)
668 static_cast<OpenSSLIOHook*>(hook)->TellCiphersAndFingerprint(user);
671 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
673 if (target_type == TYPE_USER)
675 LocalUser* user = IS_LOCAL((User*)item);
677 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
679 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
680 // Potentially there could be multiple SSL modules loaded at once on different ports.
681 ServerInstance->Users->QuitUser(user, "SSL module unloading");
686 Version GetVersion() CXX11_OVERRIDE
688 return Version("Provides SSL support for clients", VF_VENDOR);
692 MODULE_INIT(ModuleSSLOpenSSL)