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/>.
24 /* HACK: This prevents OpenSSL on OS X 10.7 and later from spewing deprecation
25 * warnings for every single function call. As far as I (SaberUK) know, Apple
26 * have no plans to remove OpenSSL so this warning just causes needless spam.
29 # define __AVAILABILITYMACROS__
30 # define DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER
35 #include <openssl/ssl.h>
36 #include <openssl/err.h>
37 #include "modules/ssl.h"
40 # pragma comment(lib, "libcrypto.lib")
41 # pragma comment(lib, "libssl.lib")
42 # pragma comment(lib, "user32.lib")
43 # pragma comment(lib, "advapi32.lib")
44 # pragma comment(lib, "libgcc.lib")
45 # pragma comment(lib, "libmingwex.lib")
46 # pragma comment(lib, "gdi32.lib")
47 # undef MAX_DESCRIPTORS
48 # define MAX_DESCRIPTORS 10000
51 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") -Wno-pedantic */
52 /* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto") */
54 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
56 static bool SelfSigned = false;
60 return ERR_error_string(ERR_get_error(), NULL);
63 static int OnVerify(int preverify_ok, X509_STORE_CTX* ctx);
67 class Exception : public ModuleException
70 Exception(const std::string& reason)
71 : ModuleException(reason) { }
79 DHParams(const std::string& filename)
81 FILE* dhpfile = fopen(filename.c_str(), "r");
83 throw Exception("Couldn't open DH file " + filename + ": " + strerror(errno));
85 dh = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
88 throw Exception("Couldn't read DH params from file " + filename);
107 Context(SSL_CTX* context)
110 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
111 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
113 const unsigned char session_id[] = "inspircd";
114 SSL_CTX_set_session_id_context(ctx, session_id, sizeof(session_id) - 1);
122 bool SetDH(DHParams& dh)
124 return (SSL_CTX_set_tmp_dh(ctx, dh.get()) >= 0);
127 bool SetCiphers(const std::string& ciphers)
129 return SSL_CTX_set_cipher_list(ctx, ciphers.c_str());
132 bool SetCerts(const std::string& filename)
134 return SSL_CTX_use_certificate_chain_file(ctx, filename.c_str());
137 bool SetPrivateKey(const std::string& filename)
139 return SSL_CTX_use_PrivateKey_file(ctx, filename.c_str(), SSL_FILETYPE_PEM);
142 bool SetCA(const std::string& filename)
144 return SSL_CTX_load_verify_locations(ctx, filename.c_str(), 0);
153 class Profile : public refcountbase
155 /** Name of this profile
157 const std::string name;
159 /** DH parameters in use
163 /** OpenSSL makes us have two contexts, one for servers and one for clients
168 /** Digest to use when generating fingerprints
170 const EVP_MD* digest;
172 /** Last error, set by error_callback()
176 static int error_callback(const char* str, size_t len, void* u)
178 Profile* profile = reinterpret_cast<Profile*>(u);
179 profile->lasterr = std::string(str, len - 1);
184 Profile(const std::string& profilename, ConfigTag* tag)
186 , dh(ServerInstance->Config->Paths.PrependConfig(tag->getString("dhfile", "dh.pem")))
187 , ctx(SSL_CTX_new(SSLv23_server_method()))
188 , clictx(SSL_CTX_new(SSLv23_client_method()))
190 if ((!ctx.SetDH(dh)) || (!clictx.SetDH(dh)))
191 throw Exception("Couldn't set DH parameters");
193 std::string hash = tag->getString("hash", "md5");
194 digest = EVP_get_digestbyname(hash.c_str());
196 throw Exception("Unknown hash type " + hash);
198 std::string ciphers = tag->getString("ciphers");
199 if (!ciphers.empty())
201 if ((!ctx.SetCiphers(ciphers)) || (!clictx.SetCiphers(ciphers)))
203 ERR_print_errors_cb(error_callback, this);
204 throw Exception("Can't set cipher list to \"" + ciphers + "\" " + lasterr);
208 /* Load our keys and certificates
209 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
211 std::string filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("certfile", "cert.pem"));
212 if ((!ctx.SetCerts(filename)) || (!clictx.SetCerts(filename)))
214 ERR_print_errors_cb(error_callback, this);
215 throw Exception("Can't read certificate file: " + lasterr);
218 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("keyfile", "key.pem"));
219 if ((!ctx.SetPrivateKey(filename)) || (!clictx.SetPrivateKey(filename)))
221 ERR_print_errors_cb(error_callback, this);
222 throw Exception("Can't read key file: " + lasterr);
225 // Load the CAs we trust
226 filename = ServerInstance->Config->Paths.PrependConfig(tag->getString("cafile", "ca.pem"));
227 if ((!ctx.SetCA(filename)) || (!clictx.SetCA(filename)))
229 ERR_print_errors_cb(error_callback, this);
230 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());
234 const std::string& GetName() const { return name; }
235 SSL* CreateServerSession() { return ctx.CreateSession(); }
236 SSL* CreateClientSession() { return clictx.CreateSession(); }
237 const EVP_MD* GetDigest() { return digest; }
241 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
243 /* XXX: This will allow self signed certificates.
244 * In the future if we want an option to not allow this,
245 * we can just return preverify_ok here, and openssl
246 * will boot off self-signed and invalid peer certs.
248 int ve = X509_STORE_CTX_get_error(ctx);
250 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
255 class OpenSSLIOHook : public SSLIOHook
262 reference<OpenSSL::Profile> profile;
264 bool Handshake(StreamSocket* user)
269 ret = SSL_connect(sess);
271 ret = SSL_accept(sess);
275 int err = SSL_get_error(sess, ret);
277 if (err == SSL_ERROR_WANT_READ)
279 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
280 this->status = ISSL_HANDSHAKING;
283 else if (err == SSL_ERROR_WANT_WRITE)
285 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
286 this->status = ISSL_HANDSHAKING;
298 // Handshake complete.
303 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
329 void VerifyCertificate()
332 ssl_cert* certinfo = new ssl_cert;
333 this->certificate = certinfo;
335 unsigned char md[EVP_MAX_MD_SIZE];
337 cert = SSL_get_peer_certificate(sess);
341 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
345 certinfo->invalid = (SSL_get_verify_result(sess) != X509_V_OK);
349 certinfo->unknownsigner = false;
350 certinfo->trusted = true;
354 certinfo->unknownsigner = true;
355 certinfo->trusted = false;
359 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
361 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
362 certinfo->issuer = buf;
364 if (!X509_digest(cert, profile->GetDigest(), md, &n))
366 certinfo->error = "Out of memory generating fingerprint";
370 certinfo->fingerprint = BinToHex(md, n);
373 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))
375 certinfo->error = "Not activated, or expired certificate";
382 OpenSSLIOHook(IOHookProvider* hookprov, StreamSocket* sock, bool is_outbound, SSL* session, const reference<OpenSSL::Profile>& sslprofile)
383 : SSLIOHook(hookprov)
386 , outbound(is_outbound)
387 , data_to_write(false)
388 , profile(sslprofile)
392 if (SSL_set_fd(sess, sock->GetFd()) == 0)
393 throw ModuleException("Can't set fd with SSL_set_fd: " + ConvToStr(sock->GetFd()));
395 sock->AddIOHook(this);
399 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
404 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
412 if (status == ISSL_HANDSHAKING)
414 // The handshake isn't finished and it wants to read, try to finish it.
415 if (!Handshake(user))
417 // Couldn't resume handshake.
418 if (status == ISSL_NONE)
424 // If we resumed the handshake then this->status will be ISSL_OPEN
426 if (status == ISSL_OPEN)
428 char* buffer = ServerInstance->GetReadBuffer();
429 size_t bufsiz = ServerInstance->Config->NetBufferSize;
430 int ret = SSL_read(sess, buffer, bufsiz);
434 recvq.append(buffer, ret);
436 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
441 // Client closed connection.
443 user->SetError("Connection closed");
448 int err = SSL_get_error(sess, ret);
450 if (err == SSL_ERROR_WANT_READ)
452 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
455 else if (err == SSL_ERROR_WANT_WRITE)
457 SocketEngine::ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
471 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
479 data_to_write = true;
481 if (status == ISSL_HANDSHAKING)
483 if (!Handshake(user))
485 // Couldn't resume handshake.
486 if (status == ISSL_NONE)
492 if (status == ISSL_OPEN)
494 int ret = SSL_write(sess, buffer.data(), buffer.size());
495 if (ret == (int)buffer.length())
497 data_to_write = false;
498 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
503 buffer = buffer.substr(ret);
504 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
514 int err = SSL_get_error(sess, ret);
516 if (err == SSL_ERROR_WANT_WRITE)
518 SocketEngine::ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
521 else if (err == SSL_ERROR_WANT_READ)
523 SocketEngine::ChangeEventMask(user, FD_WANT_POLL_READ);
536 void TellCiphersAndFingerprint(LocalUser* user)
540 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(sess)) + "'";
541 const std::string& fingerprint = certificate->fingerprint;
542 if (!fingerprint.empty())
543 text += " and your SSL fingerprint is " + fingerprint;
545 user->WriteNotice(text);
550 class OpenSSLIOHookProvider : public refcountbase, public IOHookProvider
552 reference<OpenSSL::Profile> profile;
555 OpenSSLIOHookProvider(Module* mod, reference<OpenSSL::Profile>& prof)
556 : IOHookProvider(mod, "ssl/" + prof->GetName(), IOHookProvider::IOH_SSL)
559 ServerInstance->Modules->AddService(*this);
562 ~OpenSSLIOHookProvider()
564 ServerInstance->Modules->DelService(*this);
567 void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
569 new OpenSSLIOHook(this, sock, false, profile->CreateServerSession(), profile);
572 void OnConnect(StreamSocket* sock) CXX11_OVERRIDE
574 new OpenSSLIOHook(this, sock, true, profile->CreateClientSession(), profile);
578 class ModuleSSLOpenSSL : public Module
580 typedef std::vector<reference<OpenSSLIOHookProvider> > ProfileList;
582 ProfileList profiles;
586 ProfileList newprofiles;
587 ConfigTagList tags = ServerInstance->Config->ConfTags("sslprofile");
588 if (tags.first == tags.second)
590 // Create a default profile named "openssl"
591 const std::string defname = "openssl";
592 ConfigTag* tag = ServerInstance->Config->ConfValue(defname);
593 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "No <sslprofile> tags found, using settings from the <openssl> tag");
597 reference<OpenSSL::Profile> profile(new OpenSSL::Profile(defname, tag));
598 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
600 catch (OpenSSL::Exception& ex)
602 throw ModuleException("Error while initializing the default SSL profile - " + ex.GetReason());
606 for (ConfigIter i = tags.first; i != tags.second; ++i)
608 ConfigTag* tag = i->second;
609 if (tag->getString("provider") != "openssl")
612 std::string name = tag->getString("name");
615 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring <sslprofile> tag without name at " + tag->getTagLocation());
619 reference<OpenSSL::Profile> profile;
622 profile = new OpenSSL::Profile(name, tag);
624 catch (CoreException& ex)
626 throw ModuleException("Error while initializing SSL profile \"" + name + "\" at " + tag->getTagLocation() + " - " + ex.GetReason());
629 newprofiles.push_back(new OpenSSLIOHookProvider(this, profile));
632 profiles.swap(newprofiles);
638 // Initialize OpenSSL
640 SSL_load_error_strings();
643 void init() CXX11_OVERRIDE
648 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
657 catch (ModuleException& ex)
659 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, ex.GetReason() + " Not applying settings.");
663 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
665 IOHook* hook = user->eh.GetIOHook();
666 if (hook && hook->prov->creator == this)
667 static_cast<OpenSSLIOHook*>(hook)->TellCiphersAndFingerprint(user);
670 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
672 if (target_type == TYPE_USER)
674 LocalUser* user = IS_LOCAL((User*)item);
676 if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->prov->creator == this)
678 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
679 // Potentially there could be multiple SSL modules loaded at once on different ports.
680 ServerInstance->Users->QuitUser(user, "SSL module unloading");
685 Version GetVersion() CXX11_OVERRIDE
687 return Version("Provides SSL support for clients", VF_VENDOR);
691 MODULE_INIT(ModuleSSLOpenSSL)