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 /* $ModDesc: Provides SSL support for clients */
53 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
54 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
55 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
60 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
62 static bool SelfSigned = false;
66 return ERR_error_string(ERR_get_error(), NULL);
69 static int error_callback(const char *str, size_t len, void *u);
71 /** Represents an SSL user's extra data
78 reference<ssl_cert> cert;
86 data_to_write = false;
90 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
92 /* XXX: This will allow self signed certificates.
93 * In the future if we want an option to not allow this,
94 * we can just return preverify_ok here, and openssl
95 * will boot off self-signed and invalid peer certs.
97 int ve = X509_STORE_CTX_get_error(ctx);
99 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
104 class OpenSSLIOHook : public SSLIOHook
107 bool Handshake(StreamSocket* user, issl_session* session)
111 if (session->outbound)
112 ret = SSL_connect(session->sess);
114 ret = SSL_accept(session->sess);
118 int err = SSL_get_error(session->sess, ret);
120 if (err == SSL_ERROR_WANT_READ)
122 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
123 session->status = ISSL_HANDSHAKING;
126 else if (err == SSL_ERROR_WANT_WRITE)
128 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
129 session->status = ISSL_HANDSHAKING;
134 CloseSession(session);
141 // Handshake complete.
142 VerifyCertificate(session, user);
144 session->status = ISSL_OPEN;
146 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
152 CloseSession(session);
159 void CloseSession(issl_session* session)
163 SSL_shutdown(session->sess);
164 SSL_free(session->sess);
167 session->sess = NULL;
168 session->status = ISSL_NONE;
172 void VerifyCertificate(issl_session* session, StreamSocket* user)
174 if (!session->sess || !user)
178 ssl_cert* certinfo = new ssl_cert;
179 session->cert = certinfo;
181 unsigned char md[EVP_MAX_MD_SIZE];
182 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
184 cert = SSL_get_peer_certificate((SSL*)session->sess);
188 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
192 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
196 certinfo->unknownsigner = false;
197 certinfo->trusted = true;
201 certinfo->unknownsigner = true;
202 certinfo->trusted = false;
205 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
206 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
208 if (!X509_digest(cert, digest, md, &n))
210 certinfo->error = "Out of memory generating fingerprint";
214 certinfo->fingerprint = BinToHex(md, n);
217 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))
219 certinfo->error = "Not activated, or expired certificate";
226 issl_session* sessions;
231 OpenSSLIOHook(Module* mod)
232 : SSLIOHook(mod, "ssl/openssl")
234 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
242 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
244 int fd = user->GetFd();
246 issl_session* session = &sessions[fd];
248 session->sess = SSL_new(ctx);
249 session->status = ISSL_NONE;
250 session->outbound = false;
251 session->cert = NULL;
253 if (session->sess == NULL)
256 if (SSL_set_fd(session->sess, fd) == 0)
258 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEBUG, "BUG: Can't set fd with SSL_set_fd: %d", fd);
262 Handshake(user, session);
265 void OnStreamSocketConnect(StreamSocket* user) CXX11_OVERRIDE
267 int fd = user->GetFd();
268 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
269 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
272 issl_session* session = &sessions[fd];
274 session->sess = SSL_new(clictx);
275 session->status = ISSL_NONE;
276 session->outbound = true;
278 if (session->sess == NULL)
281 if (SSL_set_fd(session->sess, fd) == 0)
283 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEBUG, "BUG: Can't set fd with SSL_set_fd: %d", fd);
287 Handshake(user, session);
290 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
292 int fd = user->GetFd();
293 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
294 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
297 CloseSession(&sessions[fd]);
300 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
302 int fd = user->GetFd();
303 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
304 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
307 issl_session* session = &sessions[fd];
311 CloseSession(session);
315 if (session->status == ISSL_HANDSHAKING)
317 // The handshake isn't finished and it wants to read, try to finish it.
318 if (!Handshake(user, session))
320 // Couldn't resume handshake.
321 if (session->status == ISSL_NONE)
327 // If we resumed the handshake then session->status will be ISSL_OPEN
329 if (session->status == ISSL_OPEN)
331 char* buffer = ServerInstance->GetReadBuffer();
332 size_t bufsiz = ServerInstance->Config->NetBufferSize;
333 int ret = SSL_read(session->sess, buffer, bufsiz);
337 recvq.append(buffer, ret);
338 if (session->data_to_write)
339 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
344 // Client closed connection.
345 CloseSession(session);
346 user->SetError("Connection closed");
351 int err = SSL_get_error(session->sess, ret);
353 if (err == SSL_ERROR_WANT_READ)
355 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
358 else if (err == SSL_ERROR_WANT_WRITE)
360 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
365 CloseSession(session);
374 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
376 int fd = user->GetFd();
378 issl_session* session = &sessions[fd];
382 CloseSession(session);
386 session->data_to_write = true;
388 if (session->status == ISSL_HANDSHAKING)
390 if (!Handshake(user, session))
392 // Couldn't resume handshake.
393 if (session->status == ISSL_NONE)
399 if (session->status == ISSL_OPEN)
401 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
402 if (ret == (int)buffer.length())
404 session->data_to_write = false;
405 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
410 buffer = buffer.substr(ret);
411 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
416 CloseSession(session);
421 int err = SSL_get_error(session->sess, ret);
423 if (err == SSL_ERROR_WANT_WRITE)
425 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
428 else if (err == SSL_ERROR_WANT_READ)
430 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
435 CloseSession(session);
443 ssl_cert* GetCertificate(StreamSocket* sock) CXX11_OVERRIDE
445 int fd = sock->GetFd();
446 issl_session* session = &sessions[fd];
447 return session->cert;
450 void TellCiphersAndFingerprint(LocalUser* user)
452 issl_session& s = sessions[user->eh.GetFd()];
455 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(s.sess)) + "'";
456 const std::string& fingerprint = s.cert->fingerprint;
457 if (!fingerprint.empty())
458 text += " and your SSL fingerprint is " + fingerprint;
460 user->WriteNotice(text);
465 class ModuleSSLOpenSSL : public Module
467 std::string sslports;
468 OpenSSLIOHook iohook;
471 ModuleSSLOpenSSL() : iohook(this)
473 /* Global SSL library initialization*/
475 SSL_load_error_strings();
477 /* Build our SSL contexts:
478 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
480 iohook.ctx = SSL_CTX_new( SSLv23_server_method() );
481 iohook.clictx = SSL_CTX_new( SSLv23_client_method() );
483 SSL_CTX_set_mode(iohook.ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
484 SSL_CTX_set_mode(iohook.clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
486 SSL_CTX_set_verify(iohook.ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
487 SSL_CTX_set_verify(iohook.clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
492 SSL_CTX_free(iohook.ctx);
493 SSL_CTX_free(iohook.clictx);
496 void init() CXX11_OVERRIDE
498 // Needs the flag as it ignores a plain /rehash
499 OnModuleRehash(NULL,"ssl");
500 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
501 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
502 ServerInstance->Modules->AddService(iohook);
505 void OnHookIO(StreamSocket* user, ListenSocket* lsb) CXX11_OVERRIDE
507 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
509 /* Hook the user with our module */
510 user->AddIOHook(&iohook);
514 void OnRehash(User* user) CXX11_OVERRIDE
518 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
520 if (Conf->getBool("showports", true))
522 sslports = Conf->getString("advertisedports");
523 if (!sslports.empty())
526 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
528 ListenSocket* port = ServerInstance->ports[i];
529 if (port->bind_tag->getString("ssl") != "openssl")
532 const std::string& portid = port->bind_desc;
533 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
535 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
538 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
539 * the IP:port in ISUPPORT.
541 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
542 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
543 * To solve this by default we now only display the first IP:port found and let the user
544 * configure the exact value for the 005 token, if necessary.
553 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
559 std::string certfile;
564 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
566 cafile = conf->getString("cafile", CONFIG_PATH "/ca.pem");
567 certfile = conf->getString("certfile", CONFIG_PATH "/cert.pem");
568 keyfile = conf->getString("keyfile", CONFIG_PATH "/key.pem");
569 dhfile = conf->getString("dhfile", CONFIG_PATH "/dhparams.pem");
570 std::string hash = conf->getString("hash", "md5");
571 if (hash != "sha1" && hash != "md5")
572 throw ModuleException("Unknown hash type " + hash);
573 iohook.use_sha = (hash == "sha1");
575 std::string ciphers = conf->getString("ciphers", "");
577 SSL_CTX* ctx = iohook.ctx;
578 SSL_CTX* clictx = iohook.clictx;
580 if (!ciphers.empty())
582 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
584 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
585 ERR_print_errors_cb(error_callback, this);
589 /* Load our keys and certificates
590 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
592 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
594 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
595 ERR_print_errors_cb(error_callback, this);
598 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)))
600 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
601 ERR_print_errors_cb(error_callback, this);
604 /* Load the CAs we trust*/
605 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
607 ServerInstance->Logs->Log("m_ssl_openssl",LOG_DEFAULT, "m_ssl_openssl.so: 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));
608 ERR_print_errors_cb(error_callback, this);
611 FILE* dhpfile = fopen(dhfile.c_str(), "r");
616 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
617 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
621 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
622 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
624 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
625 ERR_print_errors_cb(error_callback, this);
632 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
634 if (!sslports.empty())
635 tokens["SSL"] = sslports;
638 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
640 if (user->eh.GetIOHook() == &iohook)
641 iohook.TellCiphersAndFingerprint(user);
644 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
646 if (target_type == TYPE_USER)
648 LocalUser* user = IS_LOCAL((User*)item);
650 if (user && user->eh.GetIOHook() == &iohook)
652 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
653 // Potentially there could be multiple SSL modules loaded at once on different ports.
654 ServerInstance->Users->QuitUser(user, "SSL module unloading");
659 Version GetVersion() CXX11_OVERRIDE
661 return Version("Provides SSL support for clients", VF_VENDOR);
665 static int error_callback(const char *str, size_t len, void *u)
667 ServerInstance->Logs->Log("m_ssl_openssl", LOG_DEFAULT, "SSL error: " + std::string(str, len - 1));
670 // XXX: Remove this line, it causes valgrind warnings...
672 // MD_update(&m, buf, j);
675 // ... ONLY JOKING! :-)
681 MODULE_INIT(ModuleSSLOpenSSL)