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, "libcrypto.lib")
40 # pragma comment(lib, "libssl.lib")
41 # pragma comment(lib, "user32.lib")
42 # pragma comment(lib, "advapi32.lib")
43 # pragma comment(lib, "libgcc.lib")
44 # pragma comment(lib, "libmingwex.lib")
45 # pragma comment(lib, "gdi32.lib")
46 # undef MAX_DESCRIPTORS
47 # define MAX_DESCRIPTORS 10000
50 /* $ModDesc: Provides SSL support for clients */
52 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
53 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
54 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
59 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
61 static bool SelfSigned = false;
65 return ERR_error_string(ERR_get_error(), NULL);
68 static int error_callback(const char *str, size_t len, void *u);
70 /** Represents an SSL user's extra data
77 reference<ssl_cert> cert;
85 data_to_write = false;
89 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
91 /* XXX: This will allow self signed certificates.
92 * In the future if we want an option to not allow this,
93 * we can just return preverify_ok here, and openssl
94 * will boot off self-signed and invalid peer certs.
96 int ve = X509_STORE_CTX_get_error(ctx);
98 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
103 class ModuleSSLOpenSSL : public Module
105 issl_session* sessions;
110 std::string sslports;
113 ServiceProvider iohook;
116 ModuleSSLOpenSSL() : iohook(this, "ssl/openssl", SERVICE_IOHOOK)
118 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
120 /* Global SSL library initialization*/
122 SSL_load_error_strings();
124 /* Build our SSL contexts:
125 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
127 ctx = SSL_CTX_new( SSLv23_server_method() );
128 clictx = SSL_CTX_new( SSLv23_client_method() );
130 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
131 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
133 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
134 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
136 const unsigned char session_id[] = "inspircd";
137 SSL_CTX_set_session_id_context(ctx, session_id, sizeof(session_id) - 1);
142 // Needs the flag as it ignores a plain /rehash
143 OnModuleRehash(NULL,"ssl");
144 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
145 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
146 ServerInstance->Modules->AddService(iohook);
149 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
151 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
153 /* Hook the user with our module */
154 user->AddIOHook(this);
158 void OnRehash(User* user)
162 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
164 if (Conf->getBool("showports", true))
166 sslports = Conf->getString("advertisedports");
167 if (!sslports.empty())
170 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
172 ListenSocket* port = ServerInstance->ports[i];
173 if (port->bind_tag->getString("ssl") != "openssl")
176 const std::string& portid = port->bind_desc;
177 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
179 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
182 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
183 * the IP:port in ISUPPORT.
185 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
186 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
187 * To solve this by default we now only display the first IP:port found and let the user
188 * configure the exact value for the 005 token, if necessary.
197 void OnModuleRehash(User* user, const std::string ¶m)
203 std::string certfile;
208 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
210 cafile = conf->getString("cafile", CONFIG_PATH "/ca.pem");
211 certfile = conf->getString("certfile", CONFIG_PATH "/cert.pem");
212 keyfile = conf->getString("keyfile", CONFIG_PATH "/key.pem");
213 dhfile = conf->getString("dhfile", CONFIG_PATH "/dhparams.pem");
214 std::string hash = conf->getString("hash", "md5");
215 if (hash != "sha1" && hash != "md5")
216 throw ModuleException("Unknown hash type " + hash);
217 use_sha = (hash == "sha1");
219 std::string ciphers = conf->getString("ciphers", "");
221 if (!ciphers.empty())
223 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
225 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
226 ERR_print_errors_cb(error_callback, this);
230 /* Load our keys and certificates
231 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
233 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
235 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
236 ERR_print_errors_cb(error_callback, this);
239 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)))
241 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
242 ERR_print_errors_cb(error_callback, this);
245 /* Load the CAs we trust*/
246 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
248 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));
249 ERR_print_errors_cb(error_callback, this);
252 FILE* dhpfile = fopen(dhfile.c_str(), "r");
257 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
258 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
262 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
263 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
265 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
266 ERR_print_errors_cb(error_callback, this);
274 void On005Numeric(std::string &output)
276 if (!sslports.empty())
277 output.append(" SSL=" + sslports);
283 SSL_CTX_free(clictx);
287 void OnUserConnect(LocalUser* user)
289 if (user->eh.GetIOHook() == this)
291 if (sessions[user->eh.GetFd()].sess)
293 if (!sessions[user->eh.GetFd()].cert->fingerprint.empty())
294 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
295 " 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());
297 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess));
302 void OnCleanup(int target_type, void* item)
304 if (target_type == TYPE_USER)
306 LocalUser* user = IS_LOCAL((User*)item);
308 if (user && user->eh.GetIOHook() == this)
310 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
311 // Potentially there could be multiple SSL modules loaded at once on different ports.
312 ServerInstance->Users->QuitUser(user, "SSL module unloading");
319 return Version("Provides SSL support for clients", VF_VENDOR);
322 void OnRequest(Request& request)
324 if (strcmp("GET_SSL_CERT", request.id) == 0)
326 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
327 int fd = req.sock->GetFd();
328 issl_session* session = &sessions[fd];
330 req.cert = session->cert;
334 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
336 int fd = user->GetFd();
338 issl_session* session = &sessions[fd];
340 session->sess = SSL_new(ctx);
341 session->status = ISSL_NONE;
342 session->outbound = false;
343 session->cert = NULL;
345 if (session->sess == NULL)
348 if (SSL_set_fd(session->sess, fd) == 0)
350 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
354 Handshake(user, session);
357 void OnStreamSocketConnect(StreamSocket* user)
359 int fd = user->GetFd();
360 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
361 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
364 issl_session* session = &sessions[fd];
366 session->sess = SSL_new(clictx);
367 session->status = ISSL_NONE;
368 session->outbound = true;
370 if (session->sess == NULL)
373 if (SSL_set_fd(session->sess, fd) == 0)
375 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
379 Handshake(user, session);
382 void OnStreamSocketClose(StreamSocket* user)
384 int fd = user->GetFd();
385 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
386 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
389 CloseSession(&sessions[fd]);
392 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
394 int fd = user->GetFd();
395 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
396 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
399 issl_session* session = &sessions[fd];
403 CloseSession(session);
407 if (session->status == ISSL_HANDSHAKING)
409 // The handshake isn't finished and it wants to read, try to finish it.
410 if (!Handshake(user, session))
412 // Couldn't resume handshake.
413 if (session->status == ISSL_NONE)
419 // If we resumed the handshake then session->status will be ISSL_OPEN
421 if (session->status == ISSL_OPEN)
423 char* buffer = ServerInstance->GetReadBuffer();
424 size_t bufsiz = ServerInstance->Config->NetBufferSize;
425 int ret = SSL_read(session->sess, buffer, bufsiz);
429 recvq.append(buffer, ret);
430 if (session->data_to_write)
431 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
436 // Client closed connection.
437 CloseSession(session);
438 user->SetError("Connection closed");
443 int err = SSL_get_error(session->sess, ret);
445 if (err == SSL_ERROR_WANT_READ)
447 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
450 else if (err == SSL_ERROR_WANT_WRITE)
452 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
457 CloseSession(session);
466 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer)
468 int fd = user->GetFd();
470 issl_session* session = &sessions[fd];
474 CloseSession(session);
478 session->data_to_write = true;
480 if (session->status == ISSL_HANDSHAKING)
482 if (!Handshake(user, session))
484 // Couldn't resume handshake.
485 if (session->status == ISSL_NONE)
491 if (session->status == ISSL_OPEN)
493 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
494 if (ret == (int)buffer.length())
496 session->data_to_write = false;
497 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
502 buffer = buffer.substr(ret);
503 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
508 CloseSession(session);
513 int err = SSL_get_error(session->sess, ret);
515 if (err == SSL_ERROR_WANT_WRITE)
517 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
520 else if (err == SSL_ERROR_WANT_READ)
522 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
527 CloseSession(session);
535 bool Handshake(StreamSocket* user, issl_session* session)
539 if (session->outbound)
540 ret = SSL_connect(session->sess);
542 ret = SSL_accept(session->sess);
546 int err = SSL_get_error(session->sess, ret);
548 if (err == SSL_ERROR_WANT_READ)
550 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
551 session->status = ISSL_HANDSHAKING;
554 else if (err == SSL_ERROR_WANT_WRITE)
556 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
557 session->status = ISSL_HANDSHAKING;
562 CloseSession(session);
569 // Handshake complete.
570 VerifyCertificate(session, user);
572 session->status = ISSL_OPEN;
574 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
580 CloseSession(session);
587 void CloseSession(issl_session* session)
591 SSL_shutdown(session->sess);
592 SSL_free(session->sess);
595 session->sess = NULL;
596 session->status = ISSL_NONE;
600 void VerifyCertificate(issl_session* session, StreamSocket* user)
602 if (!session->sess || !user)
606 ssl_cert* certinfo = new ssl_cert;
607 session->cert = certinfo;
609 unsigned char md[EVP_MAX_MD_SIZE];
610 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
612 cert = SSL_get_peer_certificate((SSL*)session->sess);
616 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
620 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
624 certinfo->unknownsigner = false;
625 certinfo->trusted = true;
629 certinfo->unknownsigner = true;
630 certinfo->trusted = false;
634 X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
636 X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
637 certinfo->issuer = buf;
639 if (!X509_digest(cert, digest, md, &n))
641 certinfo->error = "Out of memory generating fingerprint";
645 certinfo->fingerprint = irc::hex(md, n);
648 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))
650 certinfo->error = "Not activated, or expired certificate";
657 static int error_callback(const char *str, size_t len, void *u)
659 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
662 // XXX: Remove this line, it causes valgrind warnings...
664 // MD_update(&m, buf, j);
667 // ... ONLY JOKING! :-)
673 MODULE_INIT(ModuleSSLOpenSSL)