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
34 #include <openssl/ssl.h>
35 #include <openssl/err.h>
39 # pragma comment(lib, "ssleay32.lib")
40 # pragma comment(lib, "libeay32.lib")
41 # undef MAX_DESCRIPTORS
42 # define MAX_DESCRIPTORS 10000
45 /* $ModDesc: Provides SSL support for clients */
47 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
48 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
49 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
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 ModuleSSLOpenSSL : public Module
100 issl_session* sessions;
105 std::string sslports;
108 ServiceProvider iohook;
111 ModuleSSLOpenSSL() : iohook(this, "ssl/openssl", SERVICE_IOHOOK)
113 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
115 /* Global SSL library initialization*/
117 SSL_load_error_strings();
119 /* Build our SSL contexts:
120 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
122 ctx = SSL_CTX_new( SSLv23_server_method() );
123 clictx = SSL_CTX_new( SSLv23_client_method() );
125 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
126 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
128 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
129 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
131 const unsigned char session_id[] = "inspircd";
132 SSL_CTX_set_session_id_context(ctx, session_id, sizeof(session_id) - 1);
137 // Needs the flag as it ignores a plain /rehash
138 OnModuleRehash(NULL,"ssl");
139 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
140 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
141 ServerInstance->Modules->AddService(iohook);
144 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
146 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
148 /* Hook the user with our module */
149 user->AddIOHook(this);
153 void OnRehash(User* user)
157 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
159 if (Conf->getBool("showports", true))
161 sslports = Conf->getString("advertisedports");
162 if (!sslports.empty())
165 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
167 ListenSocket* port = ServerInstance->ports[i];
168 if (port->bind_tag->getString("ssl") != "openssl")
171 const std::string& portid = port->bind_desc;
172 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
174 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
177 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
178 * the IP:port in ISUPPORT.
180 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
181 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
182 * To solve this by default we now only display the first IP:port found and let the user
183 * configure the exact value for the 005 token, if necessary.
192 void OnModuleRehash(User* user, const std::string ¶m)
198 std::string certfile;
203 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
205 cafile = conf->getString("cafile", CONFIG_PATH "/ca.pem");
206 certfile = conf->getString("certfile", CONFIG_PATH "/cert.pem");
207 keyfile = conf->getString("keyfile", CONFIG_PATH "/key.pem");
208 dhfile = conf->getString("dhfile", CONFIG_PATH "/dhparams.pem");
209 std::string hash = conf->getString("hash", "md5");
210 if (hash != "sha1" && hash != "md5")
211 throw ModuleException("Unknown hash type " + hash);
212 use_sha = (hash == "sha1");
214 std::string ciphers = conf->getString("ciphers", "");
216 if (!ciphers.empty())
218 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
220 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
221 ERR_print_errors_cb(error_callback, this);
225 /* Load our keys and certificates
226 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
228 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
230 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
231 ERR_print_errors_cb(error_callback, this);
234 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)))
236 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
237 ERR_print_errors_cb(error_callback, this);
240 /* Load the CAs we trust*/
241 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
243 ServerInstance->Logs->Log("m_ssl_openssl",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));
244 ERR_print_errors_cb(error_callback, this);
248 BIO* dhpfile = BIO_new_file(dhfile.c_str(), "r");
250 FILE* dhpfile = fopen(dhfile.c_str(), "r");
256 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
257 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
262 ret = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
265 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
267 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
269 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
270 ERR_print_errors_cb(error_callback, this);
280 void On005Numeric(std::string &output)
282 if (!sslports.empty())
283 output.append(" SSL=" + sslports);
289 SSL_CTX_free(clictx);
293 void OnUserConnect(LocalUser* user)
295 if (user->eh.GetIOHook() == this)
297 if (sessions[user->eh.GetFd()].sess)
299 if (!sessions[user->eh.GetFd()].cert->fingerprint.empty())
300 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
301 " and your SSL fingerprint is %s", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess), sessions[user->eh.GetFd()].cert->fingerprint.c_str());
303 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess));
308 void OnCleanup(int target_type, void* item)
310 if (target_type == TYPE_USER)
312 LocalUser* user = IS_LOCAL((User*)item);
314 if (user && user->eh.GetIOHook() == this)
316 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
317 // Potentially there could be multiple SSL modules loaded at once on different ports.
318 ServerInstance->Users->QuitUser(user, "SSL module unloading");
325 return Version("Provides SSL support for clients", VF_VENDOR);
328 void OnRequest(Request& request)
330 if (strcmp("GET_SSL_CERT", request.id) == 0)
332 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
333 int fd = req.sock->GetFd();
334 issl_session* session = &sessions[fd];
336 req.cert = session->cert;
340 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
342 int fd = user->GetFd();
344 issl_session* session = &sessions[fd];
346 session->sess = SSL_new(ctx);
347 session->status = ISSL_NONE;
348 session->outbound = false;
349 session->cert = NULL;
351 if (session->sess == NULL)
354 if (SSL_set_fd(session->sess, fd) == 0)
356 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
360 Handshake(user, session);
363 void OnStreamSocketConnect(StreamSocket* user)
365 int fd = user->GetFd();
366 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
367 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
370 issl_session* session = &sessions[fd];
372 session->sess = SSL_new(clictx);
373 session->status = ISSL_NONE;
374 session->outbound = true;
376 if (session->sess == NULL)
379 if (SSL_set_fd(session->sess, fd) == 0)
381 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
385 Handshake(user, session);
388 void OnStreamSocketClose(StreamSocket* user)
390 int fd = user->GetFd();
391 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
392 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
395 CloseSession(&sessions[fd]);
398 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
400 int fd = user->GetFd();
401 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
402 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
405 issl_session* session = &sessions[fd];
409 CloseSession(session);
413 if (session->status == ISSL_HANDSHAKING)
415 // The handshake isn't finished and it wants to read, try to finish it.
416 if (!Handshake(user, session))
418 // Couldn't resume handshake.
419 if (session->status == ISSL_NONE)
425 // If we resumed the handshake then session->status will be ISSL_OPEN
427 if (session->status == ISSL_OPEN)
429 char* buffer = ServerInstance->GetReadBuffer();
430 size_t bufsiz = ServerInstance->Config->NetBufferSize;
431 int ret = SSL_read(session->sess, buffer, bufsiz);
435 recvq.append(buffer, ret);
436 if (session->data_to_write)
437 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
442 // Client closed connection.
443 CloseSession(session);
444 user->SetError("Connection closed");
449 int err = SSL_get_error(session->sess, ret);
451 if (err == SSL_ERROR_WANT_READ)
453 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
456 else if (err == SSL_ERROR_WANT_WRITE)
458 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
463 CloseSession(session);
472 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer)
474 int fd = user->GetFd();
476 issl_session* session = &sessions[fd];
480 CloseSession(session);
484 session->data_to_write = true;
486 if (session->status == ISSL_HANDSHAKING)
488 if (!Handshake(user, session))
490 // Couldn't resume handshake.
491 if (session->status == ISSL_NONE)
497 if (session->status == ISSL_OPEN)
499 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
500 if (ret == (int)buffer.length())
502 session->data_to_write = false;
503 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
508 buffer = buffer.substr(ret);
509 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
514 CloseSession(session);
519 int err = SSL_get_error(session->sess, ret);
521 if (err == SSL_ERROR_WANT_WRITE)
523 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
526 else if (err == SSL_ERROR_WANT_READ)
528 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
533 CloseSession(session);
541 bool Handshake(StreamSocket* user, issl_session* session)
545 if (session->outbound)
546 ret = SSL_connect(session->sess);
548 ret = SSL_accept(session->sess);
552 int err = SSL_get_error(session->sess, ret);
554 if (err == SSL_ERROR_WANT_READ)
556 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
557 session->status = ISSL_HANDSHAKING;
560 else if (err == SSL_ERROR_WANT_WRITE)
562 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
563 session->status = ISSL_HANDSHAKING;
568 CloseSession(session);
575 // Handshake complete.
576 VerifyCertificate(session, user);
578 session->status = ISSL_OPEN;
580 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
586 CloseSession(session);
593 void CloseSession(issl_session* session)
597 SSL_shutdown(session->sess);
598 SSL_free(session->sess);
601 session->sess = NULL;
602 session->status = ISSL_NONE;
606 void VerifyCertificate(issl_session* session, StreamSocket* user)
608 if (!session->sess || !user)
612 ssl_cert* certinfo = new ssl_cert;
613 session->cert = certinfo;
615 unsigned char md[EVP_MAX_MD_SIZE];
616 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
618 cert = SSL_get_peer_certificate((SSL*)session->sess);
622 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
626 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
630 certinfo->unknownsigner = false;
631 certinfo->trusted = true;
635 certinfo->unknownsigner = true;
636 certinfo->trusted = false;
640 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
642 // Make sure there are no chars in the string that we consider invalid
643 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
644 certinfo->dn.clear();
646 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
647 certinfo->issuer = buf;
648 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
649 certinfo->issuer.clear();
651 if (!X509_digest(cert, digest, md, &n))
653 certinfo->error = "Out of memory generating fingerprint";
657 certinfo->fingerprint = irc::hex(md, n);
660 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))
662 certinfo->error = "Not activated, or expired certificate";
669 static int error_callback(const char *str, size_t len, void *u)
671 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
674 // XXX: Remove this line, it causes valgrind warnings...
676 // MD_update(&m, buf, j);
679 // ... ONLY JOKING! :-)
685 MODULE_INIT(ModuleSSLOpenSSL)