1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
15 #include <openssl/ssl.h>
16 #include <openssl/err.h>
17 #include "transport.h"
20 #pragma comment(lib, "libeay32MTd")
21 #pragma comment(lib, "ssleay32MTd")
22 #undef MAX_DESCRIPTORS
23 #define MAX_DESCRIPTORS 10000
26 /* $ModDesc: Provides SSL support for clients */
28 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
29 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
30 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
32 /* $ModDep: transport.h */
34 /* $CopyInstall: conf/key.pem $(CONPATH) */
35 /* $CopyInstall: conf/cert.pem $(CONPATH) */
38 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
39 enum issl_io_status { ISSL_WRITE, ISSL_READ };
41 static bool SelfSigned = false;
43 bool isin(const std::string &host, int port, const std::vector<std::string> &portlist)
45 if (std::find(portlist.begin(), portlist.end(), "*:" + ConvToStr(port)) != portlist.end())
48 if (std::find(portlist.begin(), portlist.end(), ":" + ConvToStr(port)) != portlist.end())
51 return std::find(portlist.begin(), portlist.end(), host + ":" + ConvToStr(port)) != portlist.end();
56 return ERR_error_string(ERR_get_error(), NULL);
59 static int error_callback(const char *str, size_t len, void *u);
61 /** Represents an SSL user's extra data
63 class issl_session : public classbase
71 unsigned int inbufoffset;
72 char* inbuf; // Buffer OpenSSL reads into.
73 std::string outbuf; // Buffer for outgoing data that OpenSSL will not take.
85 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
87 /* XXX: This will allow self signed certificates.
88 * In the future if we want an option to not allow this,
89 * we can just return preverify_ok here, and openssl
90 * will boot off self-signed and invalid peer certs.
92 int ve = X509_STORE_CTX_get_error(ctx);
94 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
99 class ModuleSSLOpenSSL : public Module
101 std::vector<std::string> listenports;
104 issl_session* sessions;
113 std::string certfile;
115 // std::string crlfile;
117 std::string sslports;
123 InspIRCd* PublicInstance;
125 ModuleSSLOpenSSL(InspIRCd* Me)
126 : Module(Me), PublicInstance(Me)
128 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
130 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
132 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
133 inbufsize = ServerInstance->Config->NetBufferSize;
135 /* Global SSL library initialization*/
137 SSL_load_error_strings();
139 /* Build our SSL contexts:
140 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
142 ctx = SSL_CTX_new( SSLv23_server_method() );
143 clictx = SSL_CTX_new( SSLv23_client_method() );
145 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
146 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
148 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
149 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
151 // Needs the flag as it ignores a plain /rehash
152 OnModuleRehash(NULL,"ssl");
153 Implementation eventlist[] = { I_OnRawSocketConnect, I_OnRawSocketAccept,
154 I_OnRawSocketClose, I_OnRawSocketRead, I_OnRawSocketWrite, I_OnCleanup, I_On005Numeric,
155 I_OnBufferFlushed, I_OnRequest, I_OnUnloadModule, I_OnRehash, I_OnModuleRehash,
156 I_OnPostConnect, I_OnHookUserIO };
157 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
160 virtual void OnHookUserIO(User* user)
162 if (!user->GetIOHook() && isin(user->GetServerIP(),user->GetServerPort(), listenports))
164 /* Hook the user with our module */
165 user->AddIOHook(this);
169 virtual void OnRehash(User* user)
171 ConfigReader Conf(ServerInstance);
177 for(int index = 0; index < Conf.Enumerate("bind"); index++)
179 // For each <bind> tag
180 std::string x = Conf.ReadValue("bind", "type", index);
181 if(((x.empty()) || (x == "clients")) && (Conf.ReadValue("bind", "ssl", index) == "openssl"))
183 // Get the port we're meant to be listening on with SSL
184 std::string port = Conf.ReadValue("bind", "port", index);
185 std::string addr = Conf.ReadValue("bind", "address", index);
189 // normalize address, important for IPv6
191 irc::sockets::sockaddrs bin;
192 if (irc::sockets::aptosa(addr.c_str(), portint, &bin))
193 irc::sockets::satoap(&bin, addr, portint);
196 irc::portparser portrange(port, false);
198 while ((portno = portrange.GetToken()))
203 listenports.push_back(addr + ":" + ConvToStr(portno));
205 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
206 if ((ServerInstance->ports[i]->GetPort() == portno) && (ServerInstance->ports[i]->GetIP() == addr))
207 ServerInstance->ports[i]->SetDescription("ssl");
208 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %ld", portno);
210 if (addr != "127.0.0.1")
211 sslports.append((addr.empty() ? "*" : addr)).append(":").append(ConvToStr(portno)).append(";");
213 catch (ModuleException &e)
215 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %ld: %s. Maybe it's already hooked by the same port on a different IP, or you have an other SSL or similar module loaded?", portno, e.GetReason());
221 if (!sslports.empty())
222 sslports.erase(sslports.end() - 1);
225 virtual void OnModuleRehash(User* user, const std::string ¶m)
232 ConfigReader Conf(ServerInstance);
234 std::string confdir(ServerInstance->ConfigFileName);
235 // +1 so we the path ends with a /
236 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
238 cafile = Conf.ReadValue("openssl", "cafile", 0);
239 certfile = Conf.ReadValue("openssl", "certfile", 0);
240 keyfile = Conf.ReadValue("openssl", "keyfile", 0);
241 dhfile = Conf.ReadValue("openssl", "dhfile", 0);
243 // Set all the default values needed.
247 if (certfile.empty())
248 certfile = "cert.pem";
254 dhfile = "dhparams.pem";
256 // Prepend relative paths with the path to the config directory.
257 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
258 cafile = confdir + cafile;
260 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
261 certfile = confdir + certfile;
263 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
264 keyfile = confdir + keyfile;
266 if ((dhfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(dhfile)))
267 dhfile = confdir + dhfile;
269 /* Load our keys and certificates
270 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
272 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
274 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
275 ERR_print_errors_cb(error_callback, this);
278 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)))
280 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
281 ERR_print_errors_cb(error_callback, this);
284 /* Load the CAs we trust*/
285 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
287 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
288 ERR_print_errors_cb(error_callback, this);
291 FILE* dhpfile = fopen(dhfile.c_str(), "r");
296 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
297 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
301 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
302 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
304 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
305 ERR_print_errors_cb(error_callback, this);
312 virtual void On005Numeric(std::string &output)
314 output.append(" SSL=" + sslports);
317 virtual ~ModuleSSLOpenSSL()
320 SSL_CTX_free(clictx);
321 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
325 virtual void OnCleanup(int target_type, void* item)
327 if (target_type == TYPE_USER)
329 User* user = (User*)item;
331 if (user->GetIOHook() == this)
333 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
334 // Potentially there could be multiple SSL modules loaded at once on different ports.
335 ServerInstance->Users->QuitUser(user, "SSL module unloading");
338 if (user->GetExt("ssl_cert", dummy))
341 user->GetExt("ssl_cert", tofree);
343 user->Shrink("ssl_cert");
348 virtual void OnUnloadModule(Module* mod, const std::string &name)
352 for(unsigned int i = 0; i < listenports.size(); i++)
354 for (size_t j = 0; j < ServerInstance->ports.size(); j++)
355 if (listenports[i] == (ServerInstance->ports[j]->GetIP()+":"+ConvToStr(ServerInstance->ports[j]->GetPort())))
356 ServerInstance->ports[j]->SetDescription("plaintext");
361 virtual Version GetVersion()
363 return Version("$Id$", VF_VENDOR, API_VERSION);
367 virtual const char* OnRequest(Request* request)
369 ISHRequest* ISR = (ISHRequest*)request;
370 if (strcmp("IS_NAME", request->GetId()) == 0)
374 else if (strcmp("IS_HOOK", request->GetId()) == 0)
376 const char* ret = "OK";
379 ret = ISR->Sock->AddIOHook((Module*)this) ? "OK" : NULL;
381 catch (ModuleException &e)
388 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
390 return ISR->Sock->DelIOHook() ? "OK" : NULL;
392 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
394 if (ISR->Sock->GetFd() < 0)
397 issl_session* session = &sessions[ISR->Sock->GetFd()];
398 return (session->status == ISSL_HANDSHAKING) ? NULL : "OK";
400 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
402 issl_session* session = &sessions[ISR->Sock->GetFd()];
405 VerifyCertificate(session, (BufferedSocket*)ISR->Sock);
409 else if (strcmp("GET_FP", request->GetId()) == 0)
411 if (ISR->Sock->GetFd() > -1)
413 issl_session* session = &sessions[ISR->Sock->GetFd()];
416 Extensible* ext = ISR->Sock;
418 if (ext->GetExt("ssl_cert",certinfo))
419 return certinfo->GetFingerprint().c_str();
427 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
429 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
430 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
433 issl_session* session = &sessions[fd];
436 session->inbuf = new char[inbufsize];
437 session->inbufoffset = 0;
438 session->sess = SSL_new(ctx);
439 session->status = ISSL_NONE;
440 session->outbound = false;
442 if (session->sess == NULL)
445 if (SSL_set_fd(session->sess, fd) == 0)
447 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
454 virtual void OnRawSocketConnect(int fd)
456 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
457 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
460 issl_session* session = &sessions[fd];
463 session->inbuf = new char[inbufsize];
464 session->inbufoffset = 0;
465 session->sess = SSL_new(clictx);
466 session->status = ISSL_NONE;
467 session->outbound = true;
469 if (session->sess == NULL)
472 if (SSL_set_fd(session->sess, fd) == 0)
474 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
481 virtual void OnRawSocketClose(int fd)
483 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
484 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
487 CloseSession(&sessions[fd]);
489 EventHandler* user = ServerInstance->SE->GetRef(fd);
491 if ((user) && (user->GetExt("ssl_cert", dummy)))
494 user->GetExt("ssl_cert", tofree);
496 user->Shrink("ssl_cert");
500 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
502 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
503 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
506 issl_session* session = &sessions[fd];
511 CloseSession(session);
515 if (session->status == ISSL_HANDSHAKING)
517 if (session->rstat == ISSL_READ || session->wstat == ISSL_READ)
519 // The handshake isn't finished and it wants to read, try to finish it.
520 if (!Handshake(session))
522 // Couldn't resume handshake.
523 errno = session->status == ISSL_NONE ? EIO : EAGAIN;
534 // If we resumed the handshake then session->status will be ISSL_OPEN
536 if (session->status == ISSL_OPEN)
538 if (session->wstat == ISSL_READ)
540 if(DoWrite(session) == 0)
544 if (session->rstat == ISSL_READ)
546 int ret = DoRead(session);
550 if (count <= session->inbufoffset)
552 memcpy(buffer, session->inbuf, count);
553 // Move the stuff left in inbuf to the beginning of it
554 memmove(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
555 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
556 session->inbufoffset -= count;
557 // Insp uses readresult as the count of how much data there is in buffer, so:
562 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
563 memcpy(buffer, session->inbuf, session->inbufoffset);
565 readresult = session->inbufoffset;
566 // Zero the offset, as there's nothing there..
567 session->inbufoffset = 0;
578 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
580 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
581 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
585 issl_session* session = &sessions[fd];
589 CloseSession(session);
593 session->outbuf.append(buffer, count);
594 MakePollWrite(session);
596 if (session->status == ISSL_HANDSHAKING)
598 // The handshake isn't finished, try to finish it.
599 if (session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
601 if (!Handshake(session))
603 // Couldn't resume handshake.
604 errno = session->status == ISSL_NONE ? EIO : EAGAIN;
610 if (session->status == ISSL_OPEN)
612 if (session->rstat == ISSL_WRITE)
617 if (session->wstat == ISSL_WRITE)
619 return DoWrite(session);
626 int DoWrite(issl_session* session)
628 if (!session->outbuf.size())
631 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
635 CloseSession(session);
640 int err = SSL_get_error(session->sess, ret);
642 if (err == SSL_ERROR_WANT_WRITE)
644 session->wstat = ISSL_WRITE;
647 else if (err == SSL_ERROR_WANT_READ)
649 session->wstat = ISSL_READ;
654 CloseSession(session);
660 session->outbuf = session->outbuf.substr(ret);
665 int DoRead(issl_session* session)
667 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
668 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
670 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
674 // Client closed connection.
675 CloseSession(session);
680 int err = SSL_get_error(session->sess, ret);
682 if (err == SSL_ERROR_WANT_READ)
684 session->rstat = ISSL_READ;
687 else if (err == SSL_ERROR_WANT_WRITE)
689 session->rstat = ISSL_WRITE;
690 MakePollWrite(session);
695 CloseSession(session);
701 // Read successfully 'ret' bytes into inbuf + inbufoffset
702 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
703 // 'buffer' is 'count' long
705 session->inbufoffset += ret;
711 bool Handshake(issl_session* session)
715 if (session->outbound)
716 ret = SSL_connect(session->sess);
718 ret = SSL_accept(session->sess);
722 int err = SSL_get_error(session->sess, ret);
724 if (err == SSL_ERROR_WANT_READ)
726 session->rstat = ISSL_READ;
727 session->status = ISSL_HANDSHAKING;
730 else if (err == SSL_ERROR_WANT_WRITE)
732 session->wstat = ISSL_WRITE;
733 session->status = ISSL_HANDSHAKING;
734 MakePollWrite(session);
739 CloseSession(session);
746 // Handshake complete.
747 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
748 EventHandler *u = ServerInstance->SE->GetRef(session->fd);
751 if (!u->GetExt("ssl", dummy))
752 u->Extend("ssl", "ON");
755 session->status = ISSL_OPEN;
757 MakePollWrite(session);
763 CloseSession(session);
770 virtual void OnPostConnect(User* user)
772 // This occurs AFTER OnUserConnect so we can be sure the
773 // protocol module has propagated the NICK message.
774 if ((user->GetIOHook() == this) && (IS_LOCAL(user)))
776 ssl_cert* certdata = VerifyCertificate(&sessions[user->GetFd()], user);
777 if (sessions[user->GetFd()].sess)
778 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->GetFd()].sess));
780 ServerInstance->PI->SendMetaData(user, TYPE_USER, "ssl", "ON");
782 ServerInstance->PI->SendMetaData(user, TYPE_USER, "ssl_cert", certdata->GetMetaLine().c_str());
786 void MakePollWrite(issl_session* session)
788 //OnRawSocketWrite(session->fd, NULL, 0);
789 EventHandler* eh = ServerInstance->SE->GetRef(session->fd);
792 ServerInstance->SE->WantWrite(eh);
796 virtual void OnBufferFlushed(User* user)
798 if (user->GetIOHook() == this)
800 issl_session* session = &sessions[user->GetFd()];
801 if (session && session->outbuf.size())
802 OnRawSocketWrite(user->GetFd(), NULL, 0);
806 void CloseSession(issl_session* session)
810 SSL_shutdown(session->sess);
811 SSL_free(session->sess);
816 delete[] session->inbuf;
819 session->outbuf.clear();
820 session->inbuf = NULL;
821 session->sess = NULL;
822 session->status = ISSL_NONE;
826 ssl_cert* VerifyCertificate(issl_session* session, Extensible* user)
828 if (!session->sess || !user)
832 ssl_cert* certinfo = new ssl_cert;
834 unsigned char md[EVP_MAX_MD_SIZE];
835 const EVP_MD *digest = EVP_md5();
837 user->Extend("ssl_cert",certinfo);
839 cert = SSL_get_peer_certificate((SSL*)session->sess);
843 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
847 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
851 certinfo->unknownsigner = false;
852 certinfo->trusted = true;
856 certinfo->unknownsigner = true;
857 certinfo->trusted = false;
860 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
861 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
863 if (!X509_digest(cert, digest, md, &n))
865 certinfo->error = "Out of memory generating fingerprint";
869 certinfo->fingerprint = irc::hex(md, n);
872 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))
874 certinfo->error = "Not activated, or expired certificate";
883 Module* server = ServerInstance->Modules->Find("m_spanningtree.so");
884 ServerInstance->Modules->SetPriority(this, I_OnPostConnect, PRIORITY_AFTER, &server);
889 static int error_callback(const char *str, size_t len, void *u)
891 ModuleSSLOpenSSL* mssl = (ModuleSSLOpenSSL*)u;
892 mssl->PublicInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
895 // XXX: Remove this line, it causes valgrind warnings...
897 // MD_update(&m, buf, j);
900 // ... ONLY JOKING! :-)
906 MODULE_INIT(ModuleSSLOpenSSL)