1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 #include <openssl/ssl.h>
17 #include <openssl/err.h>
19 #include "configreader.h"
27 #include "transport.h"
30 #pragma comment(lib, "libeay32MTd")
31 #pragma comment(lib, "ssleay32MTd")
32 #undef MAX_DESCRIPTORS
33 #define MAX_DESCRIPTORS 10000
36 /* $ModDesc: Provides SSL support for clients */
38 /* $LinkerFlags: ifuname("freebsd") -lssl -lcrypto */
39 /* $CompileFlags: ifuname(!"freebsd") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
40 /* $LinkerFlags: ifuname(!"freebsd") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
42 /* $ModDep: transport.h */
44 /* $CopyInstall: conf/key.pem $(CONPATH) */
45 /* $CopyInstall: conf/cert.pem $(CONPATH) */
48 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
49 enum issl_io_status { ISSL_WRITE, ISSL_READ };
51 static bool SelfSigned = false;
53 bool isin(const std::string &host, int port, const std::vector<std::string> &portlist)
55 if (std::find(portlist.begin(), portlist.end(), "*:" + ConvToStr(port)) != portlist.end())
58 if (std::find(portlist.begin(), portlist.end(), ":" + ConvToStr(port)) != portlist.end())
61 return std::find(portlist.begin(), portlist.end(), host + ":" + ConvToStr(port)) != portlist.end();
66 return ERR_error_string(ERR_get_error(), NULL);
69 static int error_callback(const char *str, size_t len, void *u);
71 /** Represents an SSL user's extra data
73 class issl_session : public classbase
81 unsigned int inbufoffset;
82 char* inbuf; // Buffer OpenSSL reads into.
83 std::string outbuf; // Buffer for outgoing data that OpenSSL will not take.
95 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
97 /* XXX: This will allow self signed certificates.
98 * In the future if we want an option to not allow this,
99 * we can just return preverify_ok here, and openssl
100 * will boot off self-signed and invalid peer certs.
102 int ve = X509_STORE_CTX_get_error(ctx);
104 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
109 class ModuleSSLOpenSSL : public Module
111 std::vector<std::string> listenports;
114 issl_session* sessions;
123 std::string certfile;
125 // std::string crlfile;
127 std::string sslports;
133 InspIRCd* PublicInstance;
135 ModuleSSLOpenSSL(InspIRCd* Me)
136 : Module(Me), PublicInstance(Me)
138 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
140 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
142 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
143 inbufsize = ServerInstance->Config->NetBufferSize;
145 /* Global SSL library initialization*/
147 SSL_load_error_strings();
149 /* Build our SSL contexts:
150 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
152 ctx = SSL_CTX_new( SSLv23_server_method() );
153 clictx = SSL_CTX_new( SSLv23_client_method() );
155 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
156 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
158 // Needs the flag as it ignores a plain /rehash
159 OnRehash(NULL,"ssl");
160 Implementation eventlist[] = { I_OnRawSocketConnect, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketRead, I_OnRawSocketWrite, I_OnCleanup, I_On005Numeric,
161 I_OnBufferFlushed, I_OnRequest, I_OnSyncUserMetaData, I_OnDecodeMetaData, I_OnUnloadModule, I_OnRehash, I_OnWhois, I_OnPostConnect, I_OnHookUserIO };
162 ServerInstance->Modules->Attach(eventlist, this, 16);
165 virtual void OnHookUserIO(User* user, const std::string &targetip)
167 if (!user->io && isin(targetip,user->GetPort(), listenports))
169 /* Hook the user with our module */
174 virtual void OnRehash(User* user, const std::string ¶m)
176 ConfigReader Conf(ServerInstance);
182 for(int index = 0; index < Conf.Enumerate("bind"); index++)
184 // For each <bind> tag
185 std::string x = Conf.ReadValue("bind", "type", index);
186 if(((x.empty()) || (x == "clients")) && (Conf.ReadValue("bind", "ssl", index) == "openssl"))
188 // Get the port we're meant to be listening on with SSL
189 std::string port = Conf.ReadValue("bind", "port", index);
190 std::string addr = Conf.ReadValue("bind", "address", index);
192 irc::portparser portrange(port, false);
194 while ((portno = portrange.GetToken()))
199 listenports.push_back(addr + ":" + ConvToStr(portno));
201 for (size_t i = 0; i < ServerInstance->Config->ports.size(); i++)
202 if ((ServerInstance->Config->ports[i]->GetPort() == portno) && (ServerInstance->Config->ports[i]->GetIP() == addr))
203 ServerInstance->Config->ports[i]->SetDescription("ssl");
204 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %ld", portno);
206 sslports.append((addr.empty() ? "*" : addr)).append(":").append(ConvToStr(portno)).append(";");
208 catch (ModuleException &e)
210 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_gnutls.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());
216 if (!sslports.empty())
217 sslports.erase(sslports.end() - 1);
224 std::string confdir(ServerInstance->ConfigFileName);
225 // +1 so we the path ends with a /
226 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
228 cafile = Conf.ReadValue("openssl", "cafile", 0);
229 certfile = Conf.ReadValue("openssl", "certfile", 0);
230 keyfile = Conf.ReadValue("openssl", "keyfile", 0);
231 dhfile = Conf.ReadValue("openssl", "dhfile", 0);
233 // Set all the default values needed.
237 if (certfile.empty())
238 certfile = "cert.pem";
244 dhfile = "dhparams.pem";
246 // Prepend relative paths with the path to the config directory.
247 if (cafile[0] != '/')
248 cafile = confdir + cafile;
250 if (certfile[0] != '/')
251 certfile = confdir + certfile;
253 if (keyfile[0] != '/')
254 keyfile = confdir + keyfile;
256 if (dhfile[0] != '/')
257 dhfile = confdir + dhfile;
259 /* Load our keys and certificates
260 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
262 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
264 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
265 ERR_print_errors_cb(error_callback, this);
268 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)))
270 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
271 ERR_print_errors_cb(error_callback, this);
274 /* Load the CAs we trust*/
275 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
277 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
278 ERR_print_errors_cb(error_callback, this);
281 FILE* dhpfile = fopen(dhfile.c_str(), "r");
286 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
287 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
291 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
292 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
294 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
295 ERR_print_errors_cb(error_callback, this);
302 virtual void On005Numeric(std::string &output)
304 output.append(" SSL=" + sslports);
307 virtual ~ModuleSSLOpenSSL()
310 SSL_CTX_free(clictx);
311 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
315 virtual void OnCleanup(int target_type, void* item)
317 if (target_type == TYPE_USER)
319 User* user = (User*)item;
321 if (user->GetExt("ssl", dummy) && IS_LOCAL(user) && user->io == this)
323 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
324 // Potentially there could be multiple SSL modules loaded at once on different ports.
325 ServerInstance->Users->QuitUser(user, "SSL module unloading");
327 if (user->GetExt("ssl_cert", dummy))
330 user->GetExt("ssl_cert", tofree);
332 user->Shrink("ssl_cert");
339 virtual void OnUnloadModule(Module* mod, const std::string &name)
343 for(unsigned int i = 0; i < listenports.size(); i++)
345 for (size_t j = 0; j < ServerInstance->Config->ports.size(); j++)
346 if (listenports[i] == (ServerInstance->Config->ports[j]->GetIP()+":"+ConvToStr(ServerInstance->Config->ports[j]->GetPort())))
347 ServerInstance->Config->ports[j]->SetDescription("plaintext");
352 virtual Version GetVersion()
354 return Version(1, 2, 0, 0, VF_VENDOR, API_VERSION);
358 virtual const char* OnRequest(Request* request)
360 ISHRequest* ISR = (ISHRequest*)request;
361 if (strcmp("IS_NAME", request->GetId()) == 0)
365 else if (strcmp("IS_HOOK", request->GetId()) == 0)
367 const char* ret = "OK";
370 ret = ServerInstance->Config->AddIOHook((Module*)this, (BufferedSocket*)ISR->Sock) ? "OK" : NULL;
372 catch (ModuleException &e)
379 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
381 return ServerInstance->Config->DelIOHook((BufferedSocket*)ISR->Sock) ? "OK" : NULL;
383 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
385 if (ISR->Sock->GetFd() < 0)
388 issl_session* session = &sessions[ISR->Sock->GetFd()];
389 return (session->status == ISSL_HANDSHAKING) ? NULL : "OK";
391 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
393 issl_session* session = &sessions[ISR->Sock->GetFd()];
396 VerifyCertificate(session, (BufferedSocket*)ISR->Sock);
404 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
406 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
407 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
410 issl_session* session = &sessions[fd];
413 session->inbuf = new char[inbufsize];
414 session->inbufoffset = 0;
415 session->sess = SSL_new(ctx);
416 session->status = ISSL_NONE;
417 session->outbound = false;
419 if (session->sess == NULL)
422 if (SSL_set_fd(session->sess, fd) == 0)
424 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
431 virtual void OnRawSocketConnect(int fd)
433 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
434 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
437 issl_session* session = &sessions[fd];
440 session->inbuf = new char[inbufsize];
441 session->inbufoffset = 0;
442 session->sess = SSL_new(clictx);
443 session->status = ISSL_NONE;
444 session->outbound = true;
446 if (session->sess == NULL)
449 if (SSL_set_fd(session->sess, fd) == 0)
451 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
458 virtual void OnRawSocketClose(int fd)
460 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
461 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
464 CloseSession(&sessions[fd]);
466 EventHandler* user = ServerInstance->SE->GetRef(fd);
468 if ((user) && (user->GetExt("ssl_cert", dummy)))
471 user->GetExt("ssl_cert", tofree);
473 user->Shrink("ssl_cert");
477 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
479 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
480 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
483 issl_session* session = &sessions[fd];
488 CloseSession(session);
492 if (session->status == ISSL_HANDSHAKING)
494 if (session->rstat == ISSL_READ || session->wstat == ISSL_READ)
496 // The handshake isn't finished and it wants to read, try to finish it.
497 if (!Handshake(session))
499 // Couldn't resume handshake.
510 // If we resumed the handshake then session->status will be ISSL_OPEN
512 if (session->status == ISSL_OPEN)
514 if (session->wstat == ISSL_READ)
516 if(DoWrite(session) == 0)
520 if (session->rstat == ISSL_READ)
522 int ret = DoRead(session);
526 if (count <= session->inbufoffset)
528 memcpy(buffer, session->inbuf, count);
529 // Move the stuff left in inbuf to the beginning of it
530 memcpy(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
531 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
532 session->inbufoffset -= count;
533 // Insp uses readresult as the count of how much data there is in buffer, so:
538 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
539 memcpy(buffer, session->inbuf, session->inbufoffset);
541 readresult = session->inbufoffset;
542 // Zero the offset, as there's nothing there..
543 session->inbufoffset = 0;
554 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
556 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
557 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
560 issl_session* session = &sessions[fd];
564 CloseSession(session);
568 session->outbuf.append(buffer, count);
569 MakePollWrite(session);
571 if (session->status == ISSL_HANDSHAKING)
573 // The handshake isn't finished, try to finish it.
574 if (session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
580 if (session->status == ISSL_OPEN)
582 if (session->rstat == ISSL_WRITE)
587 if (session->wstat == ISSL_WRITE)
589 return DoWrite(session);
596 int DoWrite(issl_session* session)
598 if (!session->outbuf.size())
601 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
605 CloseSession(session);
610 int err = SSL_get_error(session->sess, ret);
612 if (err == SSL_ERROR_WANT_WRITE)
614 session->wstat = ISSL_WRITE;
617 else if (err == SSL_ERROR_WANT_READ)
619 session->wstat = ISSL_READ;
624 CloseSession(session);
630 session->outbuf = session->outbuf.substr(ret);
635 int DoRead(issl_session* session)
637 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
638 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
640 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
644 // Client closed connection.
645 CloseSession(session);
650 int err = SSL_get_error(session->sess, ret);
652 if (err == SSL_ERROR_WANT_READ)
654 session->rstat = ISSL_READ;
657 else if (err == SSL_ERROR_WANT_WRITE)
659 session->rstat = ISSL_WRITE;
660 MakePollWrite(session);
665 CloseSession(session);
671 // Read successfully 'ret' bytes into inbuf + inbufoffset
672 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
673 // 'buffer' is 'count' long
675 session->inbufoffset += ret;
681 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
682 virtual void OnWhois(User* source, User* dest)
687 // Bugfix, only send this numeric for *our* SSL users
688 if (dest->GetExt("ssl", dummy) || ((IS_LOCAL(dest) && dest->io == this)))
690 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
694 virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
696 // check if the linking module wants to know about OUR metadata
697 if (extname == "ssl")
699 // check if this user has an swhois field to send
700 if(user->GetExt(extname, dummy))
702 // call this function in the linking module, let it format the data how it
703 // sees fit, and send it on its way. We dont need or want to know how.
704 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, displayable ? "Enabled" : "ON");
709 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
711 // check if its our metadata key, and its associated with a user
712 if ((target_type == TYPE_USER) && (extname == "ssl"))
714 User* dest = (User*)target;
715 // if they dont already have an ssl flag, accept the remote server's
716 if (!dest->GetExt(extname, dummy))
718 dest->Extend(extname, "ON");
723 bool Handshake(issl_session* session)
727 if (session->outbound)
728 ret = SSL_connect(session->sess);
730 ret = SSL_accept(session->sess);
734 int err = SSL_get_error(session->sess, ret);
736 if (err == SSL_ERROR_WANT_READ)
738 session->rstat = ISSL_READ;
739 session->status = ISSL_HANDSHAKING;
742 else if (err == SSL_ERROR_WANT_WRITE)
744 session->wstat = ISSL_WRITE;
745 session->status = ISSL_HANDSHAKING;
746 MakePollWrite(session);
751 CloseSession(session);
758 // Handshake complete.
759 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
760 User* u = ServerInstance->FindDescriptor(session->fd);
763 if (!u->GetExt("ssl", dummy))
764 u->Extend("ssl", "ON");
767 session->status = ISSL_OPEN;
769 MakePollWrite(session);
775 CloseSession(session);
782 virtual void OnPostConnect(User* user)
784 // This occurs AFTER OnUserConnect so we can be sure the
785 // protocol module has propagated the NICK message.
786 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
788 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
789 ServerInstance->PI->SendMetaData(user, TYPE_USER, "SSL", "on");
791 VerifyCertificate(&sessions[user->GetFd()], user);
792 if (sessions[user->GetFd()].sess)
793 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick, SSL_get_cipher(sessions[user->GetFd()].sess));
797 void MakePollWrite(issl_session* session)
799 //OnRawSocketWrite(session->fd, NULL, 0);
800 EventHandler* eh = ServerInstance->FindDescriptor(session->fd);
803 ServerInstance->SE->WantWrite(eh);
807 virtual void OnBufferFlushed(User* user)
809 if (user->GetExt("ssl"))
811 issl_session* session = &sessions[user->GetFd()];
812 if (session && session->outbuf.size())
813 OnRawSocketWrite(user->GetFd(), NULL, 0);
817 void CloseSession(issl_session* session)
821 SSL_shutdown(session->sess);
822 SSL_free(session->sess);
827 delete[] session->inbuf;
830 session->outbuf.clear();
831 session->inbuf = NULL;
832 session->sess = NULL;
833 session->status = ISSL_NONE;
836 void VerifyCertificate(issl_session* session, Extensible* user)
838 if (!session->sess || !user)
842 ssl_cert* certinfo = new ssl_cert;
844 unsigned char md[EVP_MAX_MD_SIZE];
845 const EVP_MD *digest = EVP_md5();
847 user->Extend("ssl_cert",certinfo);
849 cert = SSL_get_peer_certificate((SSL*)session->sess);
853 certinfo->data.insert(std::make_pair("error","Could not get peer certificate: "+std::string(get_error())));
857 certinfo->data.insert(std::make_pair("invalid", SSL_get_verify_result(session->sess) != X509_V_OK ? ConvToStr(1) : ConvToStr(0)));
861 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
862 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
866 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
867 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
870 certinfo->data.insert(std::make_pair("dn",std::string(X509_NAME_oneline(X509_get_subject_name(cert),0,0))));
871 certinfo->data.insert(std::make_pair("issuer",std::string(X509_NAME_oneline(X509_get_issuer_name(cert),0,0))));
873 if (!X509_digest(cert, digest, md, &n))
875 certinfo->data.insert(std::make_pair("error","Out of memory generating fingerprint"));
879 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(md, n)));
882 if ((ASN1_UTCTIME_cmp_time_t(X509_get_notAfter(cert), time(NULL)) == -1) || (ASN1_UTCTIME_cmp_time_t(X509_get_notBefore(cert), time(NULL)) == 0))
884 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
892 Module* server = ServerInstance->Modules->Find("m_spanningtree.so");
893 ServerInstance->Modules->SetPriority(this, I_OnPostConnect, PRIO_AFTER, &server);
898 static int error_callback(const char *str, size_t len, void *u)
900 ModuleSSLOpenSSL* mssl = (ModuleSSLOpenSSL*)u;
901 mssl->PublicInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
905 MODULE_INIT(ModuleSSLOpenSSL)