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 error_callback(const char *str, size_t len, void *u);
65 /** Represents an SSL user's extra data
72 reference<ssl_cert> cert;
80 data_to_write = false;
84 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
86 /* XXX: This will allow self signed certificates.
87 * In the future if we want an option to not allow this,
88 * we can just return preverify_ok here, and openssl
89 * will boot off self-signed and invalid peer certs.
91 int ve = X509_STORE_CTX_get_error(ctx);
93 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
98 class OpenSSLIOHook : public SSLIOHook
101 bool Handshake(StreamSocket* user, issl_session* session)
105 if (session->outbound)
106 ret = SSL_connect(session->sess);
108 ret = SSL_accept(session->sess);
112 int err = SSL_get_error(session->sess, ret);
114 if (err == SSL_ERROR_WANT_READ)
116 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
117 session->status = ISSL_HANDSHAKING;
120 else if (err == SSL_ERROR_WANT_WRITE)
122 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
123 session->status = ISSL_HANDSHAKING;
128 CloseSession(session);
135 // Handshake complete.
136 VerifyCertificate(session, user);
138 session->status = ISSL_OPEN;
140 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
146 CloseSession(session);
153 void CloseSession(issl_session* session)
157 SSL_shutdown(session->sess);
158 SSL_free(session->sess);
161 session->sess = NULL;
162 session->status = ISSL_NONE;
166 void VerifyCertificate(issl_session* session, StreamSocket* user)
168 if (!session->sess || !user)
172 ssl_cert* certinfo = new ssl_cert;
173 session->cert = certinfo;
175 unsigned char md[EVP_MAX_MD_SIZE];
177 cert = SSL_get_peer_certificate((SSL*)session->sess);
181 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
185 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
189 certinfo->unknownsigner = false;
190 certinfo->trusted = true;
194 certinfo->unknownsigner = true;
195 certinfo->trusted = false;
198 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
199 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
201 if (!X509_digest(cert, digest, md, &n))
203 certinfo->error = "Out of memory generating fingerprint";
207 certinfo->fingerprint = BinToHex(md, n);
210 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))
212 certinfo->error = "Not activated, or expired certificate";
219 issl_session* sessions;
222 const EVP_MD *digest;
224 OpenSSLIOHook(Module* mod)
225 : SSLIOHook(mod, "ssl/openssl")
227 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
235 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
237 int fd = user->GetFd();
239 issl_session* session = &sessions[fd];
241 session->sess = SSL_new(ctx);
242 session->status = ISSL_NONE;
243 session->outbound = false;
244 session->cert = NULL;
246 if (session->sess == NULL)
249 if (SSL_set_fd(session->sess, fd) == 0)
251 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Can't set fd with SSL_set_fd: %d", fd);
255 Handshake(user, session);
258 void OnStreamSocketConnect(StreamSocket* user) CXX11_OVERRIDE
260 int fd = user->GetFd();
261 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
262 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
265 issl_session* session = &sessions[fd];
267 session->sess = SSL_new(clictx);
268 session->status = ISSL_NONE;
269 session->outbound = true;
271 if (session->sess == NULL)
274 if (SSL_set_fd(session->sess, fd) == 0)
276 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Can't set fd with SSL_set_fd: %d", fd);
280 Handshake(user, session);
283 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
285 int fd = user->GetFd();
286 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
287 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
290 CloseSession(&sessions[fd]);
293 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
295 int fd = user->GetFd();
296 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
297 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
300 issl_session* session = &sessions[fd];
304 CloseSession(session);
308 if (session->status == ISSL_HANDSHAKING)
310 // The handshake isn't finished and it wants to read, try to finish it.
311 if (!Handshake(user, session))
313 // Couldn't resume handshake.
314 if (session->status == ISSL_NONE)
320 // If we resumed the handshake then session->status will be ISSL_OPEN
322 if (session->status == ISSL_OPEN)
324 char* buffer = ServerInstance->GetReadBuffer();
325 size_t bufsiz = ServerInstance->Config->NetBufferSize;
326 int ret = SSL_read(session->sess, buffer, bufsiz);
330 recvq.append(buffer, ret);
331 if (session->data_to_write)
332 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
337 // Client closed connection.
338 CloseSession(session);
339 user->SetError("Connection closed");
344 int err = SSL_get_error(session->sess, ret);
346 if (err == SSL_ERROR_WANT_READ)
348 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
351 else if (err == SSL_ERROR_WANT_WRITE)
353 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
358 CloseSession(session);
367 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
369 int fd = user->GetFd();
371 issl_session* session = &sessions[fd];
375 CloseSession(session);
379 session->data_to_write = true;
381 if (session->status == ISSL_HANDSHAKING)
383 if (!Handshake(user, session))
385 // Couldn't resume handshake.
386 if (session->status == ISSL_NONE)
392 if (session->status == ISSL_OPEN)
394 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
395 if (ret == (int)buffer.length())
397 session->data_to_write = false;
398 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
403 buffer = buffer.substr(ret);
404 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
409 CloseSession(session);
414 int err = SSL_get_error(session->sess, ret);
416 if (err == SSL_ERROR_WANT_WRITE)
418 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
421 else if (err == SSL_ERROR_WANT_READ)
423 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
428 CloseSession(session);
436 ssl_cert* GetCertificate(StreamSocket* sock) CXX11_OVERRIDE
438 int fd = sock->GetFd();
439 issl_session* session = &sessions[fd];
440 return session->cert;
443 void TellCiphersAndFingerprint(LocalUser* user)
445 issl_session& s = sessions[user->eh.GetFd()];
448 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(s.sess)) + "'";
449 const std::string& fingerprint = s.cert->fingerprint;
450 if (!fingerprint.empty())
451 text += " and your SSL fingerprint is " + fingerprint;
453 user->WriteNotice(text);
458 class ModuleSSLOpenSSL : public Module
460 std::string sslports;
461 OpenSSLIOHook iohook;
464 ModuleSSLOpenSSL() : iohook(this)
466 /* Global SSL library initialization*/
468 SSL_load_error_strings();
470 /* Build our SSL contexts:
471 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
473 iohook.ctx = SSL_CTX_new( SSLv23_server_method() );
474 iohook.clictx = SSL_CTX_new( SSLv23_client_method() );
476 SSL_CTX_set_mode(iohook.ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
477 SSL_CTX_set_mode(iohook.clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
479 SSL_CTX_set_verify(iohook.ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
480 SSL_CTX_set_verify(iohook.clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
485 SSL_CTX_free(iohook.ctx);
486 SSL_CTX_free(iohook.clictx);
489 void init() CXX11_OVERRIDE
491 // Needs the flag as it ignores a plain /rehash
492 OnModuleRehash(NULL,"ssl");
495 void OnHookIO(StreamSocket* user, ListenSocket* lsb) CXX11_OVERRIDE
497 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
499 /* Hook the user with our module */
500 user->AddIOHook(&iohook);
504 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
508 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
510 if (Conf->getBool("showports", true))
512 sslports = Conf->getString("advertisedports");
513 if (!sslports.empty())
516 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
518 ListenSocket* port = ServerInstance->ports[i];
519 if (port->bind_tag->getString("ssl") != "openssl")
522 const std::string& portid = port->bind_desc;
523 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Enabling SSL for port %s", portid.c_str());
525 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
528 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
529 * the IP:port in ISUPPORT.
531 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
532 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
533 * To solve this by default we now only display the first IP:port found and let the user
534 * configure the exact value for the 005 token, if necessary.
543 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
549 std::string certfile;
553 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
555 cafile = ServerInstance->Config->Paths.PrependConfig(conf->getString("cafile", "ca.pem"));
556 certfile = ServerInstance->Config->Paths.PrependConfig(conf->getString("certfile", "cert.pem"));
557 keyfile = ServerInstance->Config->Paths.PrependConfig(conf->getString("keyfile", "key.pem"));
558 dhfile = ServerInstance->Config->Paths.PrependConfig(conf->getString("dhfile", "dhparams.pem"));
559 std::string hash = conf->getString("hash", "md5");
561 iohook.digest = EVP_get_digestbyname(hash.c_str());
562 if (iohook.digest == NULL)
563 throw ModuleException("Unknown hash type " + hash);
565 std::string ciphers = conf->getString("ciphers", "");
567 SSL_CTX* ctx = iohook.ctx;
568 SSL_CTX* clictx = iohook.clictx;
570 if (!ciphers.empty())
572 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
574 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't set cipher list to %s.", ciphers.c_str());
575 ERR_print_errors_cb(error_callback, this);
579 /* Load our keys and certificates
580 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
582 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
584 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
585 ERR_print_errors_cb(error_callback, this);
588 if (((!SSL_CTX_use_PrivateKey_file(ctx, keyfile.c_str(), SSL_FILETYPE_PEM))) || (!SSL_CTX_use_PrivateKey_file(clictx, keyfile.c_str(), SSL_FILETYPE_PEM)))
590 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
591 ERR_print_errors_cb(error_callback, this);
594 /* Load the CAs we trust*/
595 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
597 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", cafile.c_str(), strerror(errno));
598 ERR_print_errors_cb(error_callback, this);
601 FILE* dhpfile = fopen(dhfile.c_str(), "r");
606 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
607 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
611 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
612 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
614 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
615 ERR_print_errors_cb(error_callback, this);
622 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
624 if (!sslports.empty())
625 tokens["SSL"] = sslports;
628 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
630 if (user->eh.GetIOHook() == &iohook)
631 iohook.TellCiphersAndFingerprint(user);
634 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
636 if (target_type == TYPE_USER)
638 LocalUser* user = IS_LOCAL((User*)item);
640 if (user && user->eh.GetIOHook() == &iohook)
642 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
643 // Potentially there could be multiple SSL modules loaded at once on different ports.
644 ServerInstance->Users->QuitUser(user, "SSL module unloading");
649 Version GetVersion() CXX11_OVERRIDE
651 return Version("Provides SSL support for clients", VF_VENDOR);
655 static int error_callback(const char *str, size_t len, void *u)
657 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "SSL error: " + std::string(str, len - 1));
660 // XXX: Remove this line, it causes valgrind warnings...
662 // MD_update(&m, buf, j);
665 // ... ONLY JOKING! :-)
671 MODULE_INIT(ModuleSSLOpenSSL)