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/>.
26 #include <openssl/ssl.h>
27 #include <openssl/err.h>
31 # pragma comment(lib, "libcrypto.lib")
32 # pragma comment(lib, "libssl.lib")
33 # pragma comment(lib, "user32.lib")
34 # pragma comment(lib, "advapi32.lib")
35 # pragma comment(lib, "libgcc.lib")
36 # pragma comment(lib, "libmingwex.lib")
37 # pragma comment(lib, "gdi32.lib")
38 # undef MAX_DESCRIPTORS
39 # define MAX_DESCRIPTORS 10000
42 /* $ModDesc: Provides SSL support for clients */
44 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
45 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
46 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
51 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
53 static bool SelfSigned = false;
57 return ERR_error_string(ERR_get_error(), NULL);
60 static int error_callback(const char *str, size_t len, void *u);
62 /** Represents an SSL user's extra data
69 reference<ssl_cert> cert;
77 data_to_write = false;
81 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
83 /* XXX: This will allow self signed certificates.
84 * In the future if we want an option to not allow this,
85 * we can just return preverify_ok here, and openssl
86 * will boot off self-signed and invalid peer certs.
88 int ve = X509_STORE_CTX_get_error(ctx);
90 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
95 class ModuleSSLOpenSSL : public Module
97 issl_session* sessions;
102 std::string sslports;
105 ServiceProvider iohook;
108 ModuleSSLOpenSSL() : iohook(this, "ssl/openssl", SERVICE_IOHOOK)
110 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
112 /* Global SSL library initialization*/
114 SSL_load_error_strings();
116 /* Build our SSL contexts:
117 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
119 ctx = SSL_CTX_new( SSLv23_server_method() );
120 clictx = SSL_CTX_new( SSLv23_client_method() );
122 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
123 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
125 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
126 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
131 // Needs the flag as it ignores a plain /rehash
132 OnModuleRehash(NULL,"ssl");
133 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
134 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
135 ServerInstance->Modules->AddService(iohook);
138 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
140 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
142 /* Hook the user with our module */
143 user->AddIOHook(this);
147 void OnRehash(User* user)
151 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
153 if (Conf->getBool("showports", true))
155 sslports = Conf->getString("advertisedports");
156 if (!sslports.empty())
159 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
161 ListenSocket* port = ServerInstance->ports[i];
162 if (port->bind_tag->getString("ssl") != "openssl")
165 const std::string& portid = port->bind_desc;
166 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
168 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
171 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
172 * the IP:port in ISUPPORT.
174 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
175 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
176 * To solve this by default we now only display the first IP:port found and let the user
177 * configure the exact value for the 005 token, if necessary.
186 void OnModuleRehash(User* user, const std::string ¶m)
192 std::string certfile;
197 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
199 cafile = conf->getString("cafile", CONFIG_PATH "/ca.pem");
200 certfile = conf->getString("certfile", CONFIG_PATH "/cert.pem");
201 keyfile = conf->getString("keyfile", CONFIG_PATH "/key.pem");
202 dhfile = conf->getString("dhfile", CONFIG_PATH "/dhparams.pem");
203 std::string hash = conf->getString("hash", "md5");
204 if (hash != "sha1" && hash != "md5")
205 throw ModuleException("Unknown hash type " + hash);
206 use_sha = (hash == "sha1");
208 std::string ciphers = conf->getString("ciphers", "");
210 if (!ciphers.empty())
212 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
214 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
215 ERR_print_errors_cb(error_callback, this);
219 /* Load our keys and certificates
220 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
222 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
224 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
225 ERR_print_errors_cb(error_callback, this);
228 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)))
230 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
231 ERR_print_errors_cb(error_callback, this);
234 /* Load the CAs we trust*/
235 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
237 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
238 ERR_print_errors_cb(error_callback, this);
241 FILE* dhpfile = fopen(dhfile.c_str(), "r");
246 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
247 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
251 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
252 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
254 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
255 ERR_print_errors_cb(error_callback, this);
262 void On005Numeric(std::string &output)
264 if (!sslports.empty())
265 output.append(" SSL=" + sslports);
271 SSL_CTX_free(clictx);
275 void OnUserConnect(LocalUser* user)
277 if (user->eh.GetIOHook() == this)
279 if (sessions[user->eh.GetFd()].sess)
281 if (!sessions[user->eh.GetFd()].cert->fingerprint.empty())
282 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
283 " 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());
285 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess));
290 void OnCleanup(int target_type, void* item)
292 if (target_type == TYPE_USER)
294 LocalUser* user = IS_LOCAL((User*)item);
296 if (user && user->eh.GetIOHook() == this)
298 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
299 // Potentially there could be multiple SSL modules loaded at once on different ports.
300 ServerInstance->Users->QuitUser(user, "SSL module unloading");
307 return Version("Provides SSL support for clients", VF_VENDOR);
310 void OnRequest(Request& request)
312 if (strcmp("GET_SSL_CERT", request.id) == 0)
314 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
315 int fd = req.sock->GetFd();
316 issl_session* session = &sessions[fd];
318 req.cert = session->cert;
322 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
324 int fd = user->GetFd();
326 issl_session* session = &sessions[fd];
328 session->sess = SSL_new(ctx);
329 session->status = ISSL_NONE;
330 session->outbound = false;
331 session->cert = NULL;
333 if (session->sess == NULL)
336 if (SSL_set_fd(session->sess, fd) == 0)
338 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
342 Handshake(user, session);
345 void OnStreamSocketConnect(StreamSocket* user)
347 int fd = user->GetFd();
348 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
349 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
352 issl_session* session = &sessions[fd];
354 session->sess = SSL_new(clictx);
355 session->status = ISSL_NONE;
356 session->outbound = true;
358 if (session->sess == NULL)
361 if (SSL_set_fd(session->sess, fd) == 0)
363 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
367 Handshake(user, session);
370 void OnStreamSocketClose(StreamSocket* user)
372 int fd = user->GetFd();
373 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
374 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
377 CloseSession(&sessions[fd]);
380 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
382 int fd = user->GetFd();
383 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
384 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
387 issl_session* session = &sessions[fd];
391 CloseSession(session);
395 if (session->status == ISSL_HANDSHAKING)
397 // The handshake isn't finished and it wants to read, try to finish it.
398 if (!Handshake(user, session))
400 // Couldn't resume handshake.
401 if (session->status == ISSL_NONE)
407 // If we resumed the handshake then session->status will be ISSL_OPEN
409 if (session->status == ISSL_OPEN)
411 char* buffer = ServerInstance->GetReadBuffer();
412 size_t bufsiz = ServerInstance->Config->NetBufferSize;
413 int ret = SSL_read(session->sess, buffer, bufsiz);
417 recvq.append(buffer, ret);
418 if (session->data_to_write)
419 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
424 // Client closed connection.
425 CloseSession(session);
426 user->SetError("Connection closed");
431 int err = SSL_get_error(session->sess, ret);
433 if (err == SSL_ERROR_WANT_READ)
435 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
438 else if (err == SSL_ERROR_WANT_WRITE)
440 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
445 CloseSession(session);
454 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer)
456 int fd = user->GetFd();
458 issl_session* session = &sessions[fd];
462 CloseSession(session);
466 session->data_to_write = true;
468 if (session->status == ISSL_HANDSHAKING)
470 if (!Handshake(user, session))
472 // Couldn't resume handshake.
473 if (session->status == ISSL_NONE)
479 if (session->status == ISSL_OPEN)
481 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
482 if (ret == (int)buffer.length())
484 session->data_to_write = false;
485 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
490 buffer = buffer.substr(ret);
491 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
496 CloseSession(session);
501 int err = SSL_get_error(session->sess, ret);
503 if (err == SSL_ERROR_WANT_WRITE)
505 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
508 else if (err == SSL_ERROR_WANT_READ)
510 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
515 CloseSession(session);
523 bool Handshake(StreamSocket* user, issl_session* session)
527 if (session->outbound)
528 ret = SSL_connect(session->sess);
530 ret = SSL_accept(session->sess);
534 int err = SSL_get_error(session->sess, ret);
536 if (err == SSL_ERROR_WANT_READ)
538 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
539 session->status = ISSL_HANDSHAKING;
542 else if (err == SSL_ERROR_WANT_WRITE)
544 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
545 session->status = ISSL_HANDSHAKING;
550 CloseSession(session);
557 // Handshake complete.
558 VerifyCertificate(session, user);
560 session->status = ISSL_OPEN;
562 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
568 CloseSession(session);
575 void CloseSession(issl_session* session)
579 SSL_shutdown(session->sess);
580 SSL_free(session->sess);
583 session->sess = NULL;
584 session->status = ISSL_NONE;
588 void VerifyCertificate(issl_session* session, StreamSocket* user)
590 if (!session->sess || !user)
594 ssl_cert* certinfo = new ssl_cert;
595 session->cert = certinfo;
597 unsigned char md[EVP_MAX_MD_SIZE];
598 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
600 cert = SSL_get_peer_certificate((SSL*)session->sess);
604 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
608 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
612 certinfo->unknownsigner = false;
613 certinfo->trusted = true;
617 certinfo->unknownsigner = true;
618 certinfo->trusted = false;
621 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
622 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
624 if (!X509_digest(cert, digest, md, &n))
626 certinfo->error = "Out of memory generating fingerprint";
630 certinfo->fingerprint = irc::hex(md, n);
633 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))
635 certinfo->error = "Not activated, or expired certificate";
642 static int error_callback(const char *str, size_t len, void *u)
644 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
647 // XXX: Remove this line, it causes valgrind warnings...
649 // MD_update(&m, buf, j);
652 // ... ONLY JOKING! :-)
658 MODULE_INIT(ModuleSSLOpenSSL)