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;
108 std::string sslports;
111 ServiceProvider iohook;
113 static void SetContextOptions(SSL_CTX* ctx, long defoptions, const std::string& ctxname, ConfigTag* tag)
115 long setoptions = tag->getInt(ctxname + "setoptions");
116 // User-friendly config options for setting context options
117 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
118 if (tag->getBool("cipherserverpref"))
119 setoptions |= SSL_OP_CIPHER_SERVER_PREFERENCE;
121 #ifdef SSL_OP_NO_COMPRESSION
122 if (!tag->getBool("compression", true))
123 setoptions |= SSL_OP_NO_COMPRESSION;
125 if (!tag->getBool("sslv3", true))
126 setoptions |= SSL_OP_NO_SSLv3;
127 if (!tag->getBool("tlsv1", true))
128 setoptions |= SSL_OP_NO_TLSv1;
130 long clearoptions = tag->getInt(ctxname + "clearoptions");
131 ServerInstance->Logs->Log("m_ssl_openssl", DEBUG, "Setting OpenSSL %s context options, default: %ld set: %ld clear: %ld", ctxname.c_str(), defoptions, clearoptions, setoptions);
134 SSL_CTX_clear_options(ctx, SSL_CTX_get_options(ctx));
136 // Set the default options and what is in the conf
137 SSL_CTX_set_options(ctx, defoptions | setoptions);
138 long final = SSL_CTX_clear_options(ctx, clearoptions);
139 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "OpenSSL %s context options: %ld", ctxname.c_str(), final);
144 ModuleSSLOpenSSL() : iohook(this, "ssl/openssl", SERVICE_IOHOOK)
146 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
148 /* Global SSL library initialization*/
150 SSL_load_error_strings();
152 /* Build our SSL contexts:
153 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
155 ctx = SSL_CTX_new( SSLv23_server_method() );
156 clictx = SSL_CTX_new( SSLv23_client_method() );
158 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
159 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
161 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
162 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
164 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
165 SSL_CTX_set_session_cache_mode(clictx, SSL_SESS_CACHE_OFF);
167 long opts = SSL_OP_NO_SSLv2 | SSL_OP_SINGLE_DH_USE;
168 // Only turn options on if they exist
169 #ifdef SSL_OP_SINGLE_ECDH_USE
170 opts |= SSL_OP_SINGLE_ECDH_USE;
172 #ifdef SSL_OP_NO_TICKET
173 opts |= SSL_OP_NO_TICKET;
176 ctx_options = SSL_CTX_set_options(ctx, opts);
177 clictx_options = SSL_CTX_set_options(clictx, opts);
182 // Needs the flag as it ignores a plain /rehash
183 OnModuleRehash(NULL,"ssl");
184 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
185 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
186 ServerInstance->Modules->AddService(iohook);
189 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
191 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
193 /* Hook the user with our module */
194 user->AddIOHook(this);
198 void OnRehash(User* user)
202 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
204 if (Conf->getBool("showports", true))
206 sslports = Conf->getString("advertisedports");
207 if (!sslports.empty())
210 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
212 ListenSocket* port = ServerInstance->ports[i];
213 if (port->bind_tag->getString("ssl") != "openssl")
216 const std::string& portid = port->bind_desc;
217 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
219 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
222 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
223 * the IP:port in ISUPPORT.
225 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
226 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
227 * To solve this by default we now only display the first IP:port found and let the user
228 * configure the exact value for the 005 token, if necessary.
237 void OnModuleRehash(User* user, const std::string ¶m)
243 std::string certfile;
248 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
250 cafile = conf->getString("cafile", CONFIG_PATH "/ca.pem");
251 certfile = conf->getString("certfile", CONFIG_PATH "/cert.pem");
252 keyfile = conf->getString("keyfile", CONFIG_PATH "/key.pem");
253 dhfile = conf->getString("dhfile", CONFIG_PATH "/dhparams.pem");
254 std::string hash = conf->getString("hash", "md5");
255 if (hash != "sha1" && hash != "md5")
256 throw ModuleException("Unknown hash type " + hash);
257 use_sha = (hash == "sha1");
259 if (conf->getBool("customcontextoptions"))
261 SetContextOptions(ctx, ctx_options, "server", conf);
262 SetContextOptions(clictx, clictx_options, "client", conf);
265 std::string ciphers = conf->getString("ciphers", "");
267 if (!ciphers.empty())
270 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
272 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
273 ERR_print_errors_cb(error_callback, this);
277 /* Load our keys and certificates
278 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
281 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
283 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
284 ERR_print_errors_cb(error_callback, this);
288 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)))
290 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
291 ERR_print_errors_cb(error_callback, this);
294 /* Load the CAs we trust*/
296 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
298 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));
299 ERR_print_errors_cb(error_callback, this);
303 BIO* dhpfile = BIO_new_file(dhfile.c_str(), "r");
305 FILE* dhpfile = fopen(dhfile.c_str(), "r");
311 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
312 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
317 ret = PEM_read_bio_DHparams(dhpfile, NULL, NULL, NULL);
320 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
324 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
326 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
327 ERR_print_errors_cb(error_callback, this);
337 void On005Numeric(std::string &output)
339 if (!sslports.empty())
340 output.append(" SSL=" + sslports);
346 SSL_CTX_free(clictx);
350 void OnUserConnect(LocalUser* user)
352 if (user->eh.GetIOHook() == this)
354 if (sessions[user->eh.GetFd()].sess)
356 if (!sessions[user->eh.GetFd()].cert->fingerprint.empty())
357 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
358 " 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());
360 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess));
365 void OnCleanup(int target_type, void* item)
367 if (target_type == TYPE_USER)
369 LocalUser* user = IS_LOCAL((User*)item);
371 if (user && user->eh.GetIOHook() == this)
373 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
374 // Potentially there could be multiple SSL modules loaded at once on different ports.
375 ServerInstance->Users->QuitUser(user, "SSL module unloading");
382 return Version("Provides SSL support for clients", VF_VENDOR);
385 void OnRequest(Request& request)
387 if (strcmp("GET_SSL_CERT", request.id) == 0)
389 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
390 int fd = req.sock->GetFd();
391 issl_session* session = &sessions[fd];
393 req.cert = session->cert;
397 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
399 int fd = user->GetFd();
401 issl_session* session = &sessions[fd];
403 session->sess = SSL_new(ctx);
404 session->status = ISSL_NONE;
405 session->outbound = false;
406 session->data_to_write = false;
408 if (session->sess == NULL)
411 if (SSL_set_fd(session->sess, fd) == 0)
413 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
417 Handshake(user, session);
420 void OnStreamSocketConnect(StreamSocket* user)
422 int fd = user->GetFd();
423 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
424 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
427 issl_session* session = &sessions[fd];
429 session->sess = SSL_new(clictx);
430 session->status = ISSL_NONE;
431 session->outbound = true;
432 session->data_to_write = false;
434 if (session->sess == NULL)
437 if (SSL_set_fd(session->sess, fd) == 0)
439 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
443 Handshake(user, session);
446 void OnStreamSocketClose(StreamSocket* user)
448 int fd = user->GetFd();
449 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
450 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
453 CloseSession(&sessions[fd]);
456 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
458 int fd = user->GetFd();
459 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
460 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
463 issl_session* session = &sessions[fd];
467 CloseSession(session);
471 if (session->status == ISSL_HANDSHAKING)
473 // The handshake isn't finished and it wants to read, try to finish it.
474 if (!Handshake(user, session))
476 // Couldn't resume handshake.
477 if (session->status == ISSL_NONE)
483 // If we resumed the handshake then session->status will be ISSL_OPEN
485 if (session->status == ISSL_OPEN)
488 char* buffer = ServerInstance->GetReadBuffer();
489 size_t bufsiz = ServerInstance->Config->NetBufferSize;
490 int ret = SSL_read(session->sess, buffer, bufsiz);
494 recvq.append(buffer, ret);
495 if (session->data_to_write)
496 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
501 // Client closed connection.
502 CloseSession(session);
503 user->SetError("Connection closed");
508 int err = SSL_get_error(session->sess, ret);
510 if (err == SSL_ERROR_WANT_READ)
512 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
515 else if (err == SSL_ERROR_WANT_WRITE)
517 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
522 CloseSession(session);
531 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer)
533 int fd = user->GetFd();
535 issl_session* session = &sessions[fd];
539 CloseSession(session);
543 session->data_to_write = true;
545 if (session->status == ISSL_HANDSHAKING)
547 if (!Handshake(user, session))
549 // Couldn't resume handshake.
550 if (session->status == ISSL_NONE)
556 if (session->status == ISSL_OPEN)
559 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
560 if (ret == (int)buffer.length())
562 session->data_to_write = false;
563 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
568 buffer = buffer.substr(ret);
569 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
574 CloseSession(session);
579 int err = SSL_get_error(session->sess, ret);
581 if (err == SSL_ERROR_WANT_WRITE)
583 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
586 else if (err == SSL_ERROR_WANT_READ)
588 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
593 CloseSession(session);
601 bool Handshake(StreamSocket* user, issl_session* session)
606 if (session->outbound)
607 ret = SSL_connect(session->sess);
609 ret = SSL_accept(session->sess);
613 int err = SSL_get_error(session->sess, ret);
615 if (err == SSL_ERROR_WANT_READ)
617 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
618 session->status = ISSL_HANDSHAKING;
621 else if (err == SSL_ERROR_WANT_WRITE)
623 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
624 session->status = ISSL_HANDSHAKING;
629 CloseSession(session);
636 // Handshake complete.
637 VerifyCertificate(session, user);
639 session->status = ISSL_OPEN;
641 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
647 CloseSession(session);
654 void CloseSession(issl_session* session)
658 SSL_shutdown(session->sess);
659 SSL_free(session->sess);
662 session->sess = NULL;
663 session->status = ISSL_NONE;
664 session->cert = NULL;
667 void VerifyCertificate(issl_session* session, StreamSocket* user)
669 if (!session->sess || !user)
673 ssl_cert* certinfo = new ssl_cert;
674 session->cert = certinfo;
676 unsigned char md[EVP_MAX_MD_SIZE];
677 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
679 cert = SSL_get_peer_certificate((SSL*)session->sess);
683 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
687 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
691 certinfo->unknownsigner = false;
692 certinfo->trusted = true;
696 certinfo->unknownsigner = true;
697 certinfo->trusted = false;
701 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
703 // Make sure there are no chars in the string that we consider invalid
704 if (certinfo->dn.find_first_of("\r\n") != std::string::npos)
705 certinfo->dn.clear();
707 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
708 certinfo->issuer = buf;
709 if (certinfo->issuer.find_first_of("\r\n") != std::string::npos)
710 certinfo->issuer.clear();
712 if (!X509_digest(cert, digest, md, &n))
714 certinfo->error = "Out of memory generating fingerprint";
718 certinfo->fingerprint = irc::hex(md, n);
721 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))
723 certinfo->error = "Not activated, or expired certificate";
730 static int error_callback(const char *str, size_t len, void *u)
732 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
735 // XXX: Remove this line, it causes valgrind warnings...
737 // MD_update(&m, buf, j);
740 // ... ONLY JOKING! :-)
746 MODULE_INIT(ModuleSSLOpenSSL)