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;
78 data_to_write = false;
82 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
84 /* XXX: This will allow self signed certificates.
85 * In the future if we want an option to not allow this,
86 * we can just return preverify_ok here, and openssl
87 * will boot off self-signed and invalid peer certs.
89 int ve = X509_STORE_CTX_get_error(ctx);
91 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
96 class ModuleSSLOpenSSL : public Module
99 issl_session* sessions;
106 std::string sslports;
109 ServiceProvider iohook;
112 ModuleSSLOpenSSL() : iohook(this, "ssl/openssl", SERVICE_IOHOOK)
114 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
116 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
117 inbufsize = ServerInstance->Config->NetBufferSize;
119 /* Global SSL library initialization*/
121 SSL_load_error_strings();
123 /* Build our SSL contexts:
124 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
126 ctx = SSL_CTX_new( SSLv23_server_method() );
127 clictx = SSL_CTX_new( SSLv23_client_method() );
129 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
130 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
132 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
133 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
138 // Needs the flag as it ignores a plain /rehash
139 OnModuleRehash(NULL,"ssl");
140 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
141 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
142 ServerInstance->Modules->AddService(iohook);
145 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
147 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
149 /* Hook the user with our module */
150 user->AddIOHook(this);
154 void OnRehash(User* user)
158 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
160 if (Conf->getBool("showports", true))
162 sslports = Conf->getString("advertisedports");
163 if (!sslports.empty())
166 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
168 ListenSocket* port = ServerInstance->ports[i];
169 if (port->bind_tag->getString("ssl") != "openssl")
172 const std::string& portid = port->bind_desc;
173 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
175 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
178 * Found an SSL port for clients that is not bound to 127.0.0.1 and handled by us, display
179 * the IP:port in ISUPPORT.
181 * We used to advertise all ports seperated by a ';' char that matched the above criteria,
182 * but this resulted in too long ISUPPORT lines if there were lots of ports to be displayed.
183 * To solve this by default we now only display the first IP:port found and let the user
184 * configure the exact value for the 005 token, if necessary.
193 void OnModuleRehash(User* user, const std::string ¶m)
199 std::string certfile;
204 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
206 cafile = conf->getString("cafile", "conf/ca.pem");
207 certfile = conf->getString("certfile", "conf/cert.pem");
208 keyfile = conf->getString("keyfile", "conf/key.pem");
209 dhfile = conf->getString("dhfile", "conf/dhparams.pem");
210 std::string hash = conf->getString("hash", "md5");
211 if (hash != "sha1" && hash != "md5")
212 throw ModuleException("Unknown hash type " + hash);
213 use_sha = (hash == "sha1");
215 std::string ciphers = conf->getString("ciphers", "");
217 if (!ciphers.empty())
219 if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
221 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
222 ERR_print_errors_cb(error_callback, this);
226 /* Load our keys and certificates
227 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
229 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
231 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
232 ERR_print_errors_cb(error_callback, this);
235 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)))
237 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
238 ERR_print_errors_cb(error_callback, this);
241 /* Load the CAs we trust*/
242 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
244 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
245 ERR_print_errors_cb(error_callback, this);
248 FILE* dhpfile = fopen(dhfile.c_str(), "r");
253 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
254 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
258 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
259 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
261 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
262 ERR_print_errors_cb(error_callback, this);
269 void On005Numeric(std::string &output)
271 if (!sslports.empty())
272 output.append(" SSL=" + sslports);
278 SSL_CTX_free(clictx);
282 void OnUserConnect(LocalUser* user)
284 if (user->eh.GetIOHook() == this)
286 if (sessions[user->eh.GetFd()].sess)
288 if (!sessions[user->eh.GetFd()].cert->fingerprint.empty())
289 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
290 " 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());
292 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess));
297 void OnCleanup(int target_type, void* item)
299 if (target_type == TYPE_USER)
301 LocalUser* user = IS_LOCAL((User*)item);
303 if (user && user->eh.GetIOHook() == this)
305 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
306 // Potentially there could be multiple SSL modules loaded at once on different ports.
307 ServerInstance->Users->QuitUser(user, "SSL module unloading");
314 return Version("Provides SSL support for clients", VF_VENDOR);
317 void OnRequest(Request& request)
319 if (strcmp("GET_SSL_CERT", request.id) == 0)
321 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
322 int fd = req.sock->GetFd();
323 issl_session* session = &sessions[fd];
325 req.cert = session->cert;
329 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
331 int fd = user->GetFd();
333 issl_session* session = &sessions[fd];
336 session->sess = SSL_new(ctx);
337 session->status = ISSL_NONE;
338 session->outbound = false;
339 session->cert = NULL;
341 if (session->sess == NULL)
344 if (SSL_set_fd(session->sess, fd) == 0)
346 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
350 Handshake(user, session);
353 void OnStreamSocketConnect(StreamSocket* user)
355 int fd = user->GetFd();
356 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
357 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
360 issl_session* session = &sessions[fd];
363 session->sess = SSL_new(clictx);
364 session->status = ISSL_NONE;
365 session->outbound = true;
367 if (session->sess == NULL)
370 if (SSL_set_fd(session->sess, fd) == 0)
372 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
376 Handshake(user, session);
379 void OnStreamSocketClose(StreamSocket* user)
381 int fd = user->GetFd();
382 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
383 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
386 CloseSession(&sessions[fd]);
389 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
391 int fd = user->GetFd();
392 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
393 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
396 issl_session* session = &sessions[fd];
400 CloseSession(session);
404 if (session->status == ISSL_HANDSHAKING)
406 // The handshake isn't finished and it wants to read, try to finish it.
407 if (!Handshake(user, session))
409 // Couldn't resume handshake.
410 if (session->status == ISSL_NONE)
416 // If we resumed the handshake then session->status will be ISSL_OPEN
418 if (session->status == ISSL_OPEN)
420 char* buffer = ServerInstance->GetReadBuffer();
421 size_t bufsiz = ServerInstance->Config->NetBufferSize;
422 int ret = SSL_read(session->sess, buffer, bufsiz);
426 recvq.append(buffer, ret);
427 if (session->data_to_write)
428 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
433 // Client closed connection.
434 CloseSession(session);
439 int err = SSL_get_error(session->sess, ret);
441 if (err == SSL_ERROR_WANT_READ)
443 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
446 else if (err == SSL_ERROR_WANT_WRITE)
448 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
453 CloseSession(session);
462 int OnStreamSocketWrite(StreamSocket* user, std::string& buffer)
464 int fd = user->GetFd();
466 issl_session* session = &sessions[fd];
470 CloseSession(session);
474 session->data_to_write = true;
476 if (session->status == ISSL_HANDSHAKING)
478 if (!Handshake(user, session))
480 // Couldn't resume handshake.
481 if (session->status == ISSL_NONE)
487 if (session->status == ISSL_OPEN)
489 int ret = SSL_write(session->sess, buffer.data(), buffer.size());
490 if (ret == (int)buffer.length())
492 session->data_to_write = false;
493 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
498 buffer = buffer.substr(ret);
499 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
504 CloseSession(session);
509 int err = SSL_get_error(session->sess, ret);
511 if (err == SSL_ERROR_WANT_WRITE)
513 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
516 else if (err == SSL_ERROR_WANT_READ)
518 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
523 CloseSession(session);
531 bool Handshake(StreamSocket* user, issl_session* session)
535 if (session->outbound)
536 ret = SSL_connect(session->sess);
538 ret = SSL_accept(session->sess);
542 int err = SSL_get_error(session->sess, ret);
544 if (err == SSL_ERROR_WANT_READ)
546 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
547 session->status = ISSL_HANDSHAKING;
550 else if (err == SSL_ERROR_WANT_WRITE)
552 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
553 session->status = ISSL_HANDSHAKING;
558 CloseSession(session);
565 // Handshake complete.
566 VerifyCertificate(session, user);
568 session->status = ISSL_OPEN;
570 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
576 CloseSession(session);
583 void CloseSession(issl_session* session)
587 SSL_shutdown(session->sess);
588 SSL_free(session->sess);
591 session->sess = NULL;
592 session->status = ISSL_NONE;
596 void VerifyCertificate(issl_session* session, StreamSocket* user)
598 if (!session->sess || !user)
602 ssl_cert* certinfo = new ssl_cert;
603 session->cert = certinfo;
605 unsigned char md[EVP_MAX_MD_SIZE];
606 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
608 cert = SSL_get_peer_certificate((SSL*)session->sess);
612 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
616 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
620 certinfo->unknownsigner = false;
621 certinfo->trusted = true;
625 certinfo->unknownsigner = true;
626 certinfo->trusted = false;
629 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
630 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
632 if (!X509_digest(cert, digest, md, &n))
634 certinfo->error = "Out of memory generating fingerprint";
638 certinfo->fingerprint = irc::hex(md, n);
641 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))
643 certinfo->error = "Not activated, or expired certificate";
650 static int error_callback(const char *str, size_t len, void *u)
652 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
655 // XXX: Remove this line, it causes valgrind warnings...
657 // MD_update(&m, buf, j);
660 // ... ONLY JOKING! :-)
666 MODULE_INIT(ModuleSSLOpenSSL)