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 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
52 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
53 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
58 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
60 static bool SelfSigned = false;
64 return ERR_error_string(ERR_get_error(), NULL);
67 static int error_callback(const char *str, size_t len, void *u);
69 /** Represents an SSL user's extra data
76 reference<ssl_cert> cert;
84 data_to_write = false;
88 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
90 /* XXX: This will allow self signed certificates.
91 * In the future if we want an option to not allow this,
92 * we can just return preverify_ok here, and openssl
93 * will boot off self-signed and invalid peer certs.
95 int ve = X509_STORE_CTX_get_error(ctx);
97 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
102 class OpenSSLIOHook : public SSLIOHook
105 bool Handshake(StreamSocket* user, issl_session* session)
109 if (session->outbound)
110 ret = SSL_connect(session->sess);
112 ret = SSL_accept(session->sess);
116 int err = SSL_get_error(session->sess, ret);
118 if (err == SSL_ERROR_WANT_READ)
120 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
121 session->status = ISSL_HANDSHAKING;
124 else if (err == SSL_ERROR_WANT_WRITE)
126 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
127 session->status = ISSL_HANDSHAKING;
132 CloseSession(session);
139 // Handshake complete.
140 VerifyCertificate(session, user);
142 session->status = ISSL_OPEN;
144 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
150 CloseSession(session);
157 void CloseSession(issl_session* session)
161 SSL_shutdown(session->sess);
162 SSL_free(session->sess);
165 session->sess = NULL;
166 session->status = ISSL_NONE;
170 void VerifyCertificate(issl_session* session, StreamSocket* user)
172 if (!session->sess || !user)
176 ssl_cert* certinfo = new ssl_cert;
177 session->cert = certinfo;
179 unsigned char md[EVP_MAX_MD_SIZE];
181 cert = SSL_get_peer_certificate((SSL*)session->sess);
185 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
189 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
193 certinfo->unknownsigner = false;
194 certinfo->trusted = true;
198 certinfo->unknownsigner = true;
199 certinfo->trusted = false;
202 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
203 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
205 if (!X509_digest(cert, digest, md, &n))
207 certinfo->error = "Out of memory generating fingerprint";
211 certinfo->fingerprint = BinToHex(md, n);
214 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))
216 certinfo->error = "Not activated, or expired certificate";
223 issl_session* sessions;
226 const EVP_MD *digest;
228 OpenSSLIOHook(Module* mod)
229 : SSLIOHook(mod, "ssl/openssl")
231 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
239 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE
241 int fd = user->GetFd();
243 issl_session* session = &sessions[fd];
245 session->sess = SSL_new(ctx);
246 session->status = ISSL_NONE;
247 session->outbound = false;
248 session->cert = NULL;
250 if (session->sess == NULL)
253 if (SSL_set_fd(session->sess, fd) == 0)
255 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Can't set fd with SSL_set_fd: %d", fd);
259 Handshake(user, session);
262 void OnStreamSocketConnect(StreamSocket* user) CXX11_OVERRIDE
264 int fd = user->GetFd();
265 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
266 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
269 issl_session* session = &sessions[fd];
271 session->sess = SSL_new(clictx);
272 session->status = ISSL_NONE;
273 session->outbound = true;
275 if (session->sess == NULL)
278 if (SSL_set_fd(session->sess, fd) == 0)
280 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Can't set fd with SSL_set_fd: %d", fd);
284 Handshake(user, session);
287 void OnStreamSocketClose(StreamSocket* user) CXX11_OVERRIDE
289 int fd = user->GetFd();
290 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
291 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
294 CloseSession(&sessions[fd]);
297 int OnStreamSocketRead(StreamSocket* user, std::string& recvq) CXX11_OVERRIDE
299 int fd = user->GetFd();
300 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
301 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
304 issl_session* session = &sessions[fd];
308 CloseSession(session);
312 if (session->status == ISSL_HANDSHAKING)
314 // The handshake isn't finished and it wants to read, try to finish it.
315 if (!Handshake(user, session))
317 // Couldn't resume handshake.
318 if (session->status == ISSL_NONE)
324 // If we resumed the handshake then session->status will be ISSL_OPEN
326 if (session->status == ISSL_OPEN)
328 char* buffer = ServerInstance->GetReadBuffer();
329 size_t bufsiz = ServerInstance->Config->NetBufferSize;
330 int ret = SSL_read(session->sess, buffer, bufsiz);
334 recvq.append(buffer, ret);
335 if (session->data_to_write)
336 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
341 // Client closed connection.
342 CloseSession(session);
343 user->SetError("Connection closed");
348 int err = SSL_get_error(session->sess, ret);
350 if (err == SSL_ERROR_WANT_READ)
352 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
355 else if (err == SSL_ERROR_WANT_WRITE)
357 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
362 CloseSession(session);
371 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer) CXX11_OVERRIDE
373 int fd = user->GetFd();
375 issl_session* session = &sessions[fd];
379 CloseSession(session);
383 session->data_to_write = true;
385 if (session->status == ISSL_HANDSHAKING)
387 if (!Handshake(user, session))
389 // Couldn't resume handshake.
390 if (session->status == ISSL_NONE)
396 if (session->status == ISSL_OPEN)
398 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
399 if (ret == (int)buffer.length())
401 session->data_to_write = false;
402 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
407 buffer = buffer.substr(ret);
408 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
413 CloseSession(session);
418 int err = SSL_get_error(session->sess, ret);
420 if (err == SSL_ERROR_WANT_WRITE)
422 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
425 else if (err == SSL_ERROR_WANT_READ)
427 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
432 CloseSession(session);
440 ssl_cert* GetCertificate(StreamSocket* sock) CXX11_OVERRIDE
442 int fd = sock->GetFd();
443 issl_session* session = &sessions[fd];
444 return session->cert;
447 void TellCiphersAndFingerprint(LocalUser* user)
449 issl_session& s = sessions[user->eh.GetFd()];
452 std::string text = "*** You are connected using SSL cipher '" + std::string(SSL_get_cipher(s.sess)) + "'";
453 const std::string& fingerprint = s.cert->fingerprint;
454 if (!fingerprint.empty())
455 text += " and your SSL fingerprint is " + fingerprint;
457 user->WriteNotice(text);
462 class ModuleSSLOpenSSL : public Module
464 std::string sslports;
465 OpenSSLIOHook iohook;
468 ModuleSSLOpenSSL() : iohook(this)
470 /* Global SSL library initialization*/
472 SSL_load_error_strings();
474 /* Build our SSL contexts:
475 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
477 iohook.ctx = SSL_CTX_new( SSLv23_server_method() );
478 iohook.clictx = SSL_CTX_new( SSLv23_client_method() );
480 SSL_CTX_set_mode(iohook.ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
481 SSL_CTX_set_mode(iohook.clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
483 SSL_CTX_set_verify(iohook.ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
484 SSL_CTX_set_verify(iohook.clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
489 SSL_CTX_free(iohook.ctx);
490 SSL_CTX_free(iohook.clictx);
493 void init() CXX11_OVERRIDE
495 // Needs the flag as it ignores a plain /rehash
496 OnModuleRehash(NULL,"ssl");
497 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
498 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
499 ServerInstance->Modules->AddService(iohook);
502 void OnHookIO(StreamSocket* user, ListenSocket* lsb) CXX11_OVERRIDE
504 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
506 /* Hook the user with our module */
507 user->AddIOHook(&iohook);
511 void OnRehash(User* user) CXX11_OVERRIDE
515 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
517 if (Conf->getBool("showports", true))
519 sslports = Conf->getString("advertisedports");
520 if (!sslports.empty())
523 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
525 ListenSocket* port = ServerInstance->ports[i];
526 if (port->bind_tag->getString("ssl") != "openssl")
529 const std::string& portid = port->bind_desc;
530 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Enabling SSL for port %s", portid.c_str());
532 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
535 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
536 * the IP:port in ISUPPORT.
538 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
539 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
540 * To solve this by default we now only display the first IP:port found and let the user
541 * configure the exact value for the 005 token, if necessary.
550 void OnModuleRehash(User* user, const std::string ¶m) CXX11_OVERRIDE
556 std::string certfile;
561 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
563 cafile = conf->getString("cafile", CONFIG_PATH "/ca.pem");
564 certfile = conf->getString("certfile", CONFIG_PATH "/cert.pem");
565 keyfile = conf->getString("keyfile", CONFIG_PATH "/key.pem");
566 dhfile = conf->getString("dhfile", CONFIG_PATH "/dhparams.pem");
567 std::string hash = conf->getString("hash", "md5");
569 iohook.digest = EVP_get_digestbyname(hash.c_str());
570 if (iohook.digest == NULL)
571 throw ModuleException("Unknown hash type " + hash);
573 std::string ciphers = conf->getString("ciphers", "");
575 SSL_CTX* ctx = iohook.ctx;
576 SSL_CTX* clictx = iohook.clictx;
578 if (!ciphers.empty())
580 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
582 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't set cipher list to %s.", ciphers.c_str());
583 ERR_print_errors_cb(error_callback, this);
587 /* Load our keys and certificates
588 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
590 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
592 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
593 ERR_print_errors_cb(error_callback, this);
596 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)))
598 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
599 ERR_print_errors_cb(error_callback, this);
602 /* Load the CAs we trust*/
603 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
605 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));
606 ERR_print_errors_cb(error_callback, this);
609 FILE* dhpfile = fopen(dhfile.c_str(), "r");
614 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
615 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
619 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
620 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
622 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
623 ERR_print_errors_cb(error_callback, this);
630 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
632 if (!sslports.empty())
633 tokens["SSL"] = sslports;
636 void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
638 if (user->eh.GetIOHook() == &iohook)
639 iohook.TellCiphersAndFingerprint(user);
642 void OnCleanup(int target_type, void* item) CXX11_OVERRIDE
644 if (target_type == TYPE_USER)
646 LocalUser* user = IS_LOCAL((User*)item);
648 if (user && user->eh.GetIOHook() == &iohook)
650 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
651 // Potentially there could be multiple SSL modules loaded at once on different ports.
652 ServerInstance->Users->QuitUser(user, "SSL module unloading");
657 Version GetVersion() CXX11_OVERRIDE
659 return Version("Provides SSL support for clients", VF_VENDOR);
663 static int error_callback(const char *str, size_t len, void *u)
665 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "SSL error: " + std::string(str, len - 1));
668 // XXX: Remove this line, it causes valgrind warnings...
670 // MD_update(&m, buf, j);
673 // ... ONLY JOKING! :-)
679 MODULE_INIT(ModuleSSLOpenSSL)