1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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>
20 #include <openssl/applink.c>
23 #include "configreader.h"
31 #include "transport.h"
34 #pragma comment(lib, "libeay32MTd")
35 #pragma comment(lib, "ssleay32MTd")
36 #undef MAX_DESCRIPTORS
37 #define MAX_DESCRIPTORS 10000
40 /* $ModDesc: Provides SSL support for clients */
41 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
42 /* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
43 /* $ModDep: transport.h */
45 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
46 enum issl_io_status { ISSL_WRITE, ISSL_READ };
48 static bool SelfSigned = false;
50 bool isin(int port, const std::vector<int> &portlist)
52 for(unsigned int i = 0; i < portlist.size(); i++)
53 if(portlist[i] == port)
61 return ERR_error_string(ERR_get_error(), NULL);
64 static int error_callback(const char *str, size_t len, void *u);
66 /** Represents an SSL user's extra data
68 class issl_session : public classbase
76 unsigned int inbufoffset;
77 char* inbuf; // Buffer OpenSSL reads into.
78 std::string outbuf; // Buffer for outgoing data that OpenSSL will not take.
90 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
92 /* XXX: This will allow self signed certificates.
93 * In the future if we want an option to not allow this,
94 * we can just return preverify_ok here, and openssl
95 * will boot off self-signed and invalid peer certs.
97 int ve = X509_STORE_CTX_get_error(ctx);
99 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
104 class ModuleSSLOpenSSL : public Module
106 std::vector<int> listenports;
109 issl_session sessions[MAX_DESCRIPTORS];
118 std::string certfile;
120 // std::string crlfile;
122 std::string sslports;
128 InspIRCd* PublicInstance;
130 ModuleSSLOpenSSL(InspIRCd* Me)
131 : Module(Me), PublicInstance(Me)
133 ServerInstance->Modules->PublishInterface("InspSocketHook", this);
135 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
136 inbufsize = ServerInstance->Config->NetBufferSize;
138 /* Global SSL library initialization*/
140 SSL_load_error_strings();
142 /* Build our SSL contexts:
143 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
145 ctx = SSL_CTX_new( SSLv23_server_method() );
146 clictx = SSL_CTX_new( SSLv23_client_method() );
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 OnRehash(NULL,"ssl");
155 virtual void OnRehash(userrec* user, const std::string ¶m)
160 ConfigReader Conf(ServerInstance);
162 for (unsigned int i = 0; i < listenports.size(); i++)
164 ServerInstance->Config->DelIOHook(listenports[i]);
171 for (int i = 0; i < Conf.Enumerate("bind"); i++)
173 // For each <bind> tag
174 std::string x = Conf.ReadValue("bind", "type", i);
175 if (((x.empty()) || (x == "clients")) && (Conf.ReadValue("bind", "ssl", i) == "openssl"))
177 // Get the port we're meant to be listening on with SSL
178 std::string port = Conf.ReadValue("bind", "port", i);
179 irc::portparser portrange(port, false);
181 while ((portno = portrange.GetToken()))
186 if (ServerInstance->Config->AddIOHook(portno, this))
188 listenports.push_back(portno);
189 for (size_t i = 0; i < ServerInstance->Config->ports.size(); i++)
190 if (ServerInstance->Config->ports[i]->GetPort() == portno)
191 ServerInstance->Config->ports[i]->SetDescription("ssl");
192 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %d", portno);
193 sslports.append("*:").append(ConvToStr(portno)).append(";");
197 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
200 catch (ModuleException &e)
202 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d: %s. Maybe it's already hooked by the same port on a different IP, or you have another SSL or similar module loaded?", portno, e.GetReason());
208 if (!sslports.empty())
209 sslports.erase(sslports.end() - 1);
211 std::string confdir(ServerInstance->ConfigFileName);
212 // +1 so we the path ends with a /
213 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
215 cafile = Conf.ReadValue("openssl", "cafile", 0);
216 certfile = Conf.ReadValue("openssl", "certfile", 0);
217 keyfile = Conf.ReadValue("openssl", "keyfile", 0);
218 dhfile = Conf.ReadValue("openssl", "dhfile", 0);
220 // Set all the default values needed.
224 if (certfile.empty())
225 certfile = "cert.pem";
231 dhfile = "dhparams.pem";
233 // Prepend relative paths with the path to the config directory.
234 if (cafile[0] != '/')
235 cafile = confdir + cafile;
237 if (certfile[0] != '/')
238 certfile = confdir + certfile;
240 if (keyfile[0] != '/')
241 keyfile = confdir + keyfile;
243 if (dhfile[0] != '/')
244 dhfile = confdir + dhfile;
246 /* Load our keys and certificates
247 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
249 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
251 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
252 ERR_print_errors_cb(error_callback, this);
255 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)))
257 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
258 ERR_print_errors_cb(error_callback, this);
261 /* Load the CAs we trust*/
262 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
264 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
265 ERR_print_errors_cb(error_callback, this);
268 FILE* dhpfile = fopen(dhfile.c_str(), "r");
273 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
274 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
278 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
279 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
281 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
282 ERR_print_errors_cb(error_callback, this);
289 virtual void On005Numeric(std::string &output)
291 output.append(" SSL=" + sslports);
294 virtual ~ModuleSSLOpenSSL()
297 SSL_CTX_free(clictx);
300 virtual void OnCleanup(int target_type, void* item)
302 if (target_type == TYPE_USER)
304 userrec* user = (userrec*)item;
306 if (user->GetExt("ssl", dummy) && IS_LOCAL(user) && isin(user->GetPort(), listenports))
308 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
309 // Potentially there could be multiple SSL modules loaded at once on different ports.
310 userrec::QuitUser(ServerInstance, user, "SSL module unloading");
312 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
315 user->GetExt("ssl_cert", tofree);
317 user->Shrink("ssl_cert");
322 virtual void OnUnloadModule(Module* mod, const std::string &name)
326 for(unsigned int i = 0; i < listenports.size(); i++)
328 ServerInstance->Config->DelIOHook(listenports[i]);
329 for (size_t j = 0; j < ServerInstance->Config->ports.size(); j++)
330 if (ServerInstance->Config->ports[j]->GetPort() == listenports[i])
331 ServerInstance->Config->ports[j]->SetDescription("plaintext");
336 virtual Version GetVersion()
338 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
341 void Implements(char* List)
343 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = List[I_On005Numeric] = 1;
344 List[I_OnBufferFlushed] = List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
347 virtual char* OnRequest(Request* request)
349 ISHRequest* ISR = (ISHRequest*)request;
350 if (strcmp("IS_NAME", request->GetId()) == 0)
354 else if (strcmp("IS_HOOK", request->GetId()) == 0)
359 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
361 catch (ModuleException &e)
368 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
370 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
372 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
374 if (ISR->Sock->GetFd() < 0)
377 issl_session* session = &sessions[ISR->Sock->GetFd()];
378 return (session->status == ISSL_HANDSHAKING) ? NULL : (char*)"OK";
380 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
382 issl_session* session = &sessions[ISR->Sock->GetFd()];
385 VerifyCertificate(session, (InspSocket*)ISR->Sock);
393 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
395 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
396 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
399 issl_session* session = &sessions[fd];
402 session->inbuf = new char[inbufsize];
403 session->inbufoffset = 0;
404 session->sess = SSL_new(ctx);
405 session->status = ISSL_NONE;
406 session->outbound = false;
408 if (session->sess == NULL)
411 if (SSL_set_fd(session->sess, fd) == 0)
413 ServerInstance->Log(DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
420 virtual void OnRawSocketConnect(int fd)
422 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
423 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
426 issl_session* session = &sessions[fd];
429 session->inbuf = new char[inbufsize];
430 session->inbufoffset = 0;
431 session->sess = SSL_new(clictx);
432 session->status = ISSL_NONE;
433 session->outbound = true;
435 if (session->sess == NULL)
438 if (SSL_set_fd(session->sess, fd) == 0)
440 ServerInstance->Log(DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
447 virtual void OnRawSocketClose(int fd)
449 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
450 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
453 CloseSession(&sessions[fd]);
455 EventHandler* user = ServerInstance->SE->GetRef(fd);
457 if ((user) && (user->GetExt("ssl_cert", dummy)))
460 user->GetExt("ssl_cert", tofree);
462 user->Shrink("ssl_cert");
466 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
468 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
469 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
472 issl_session* session = &sessions[fd];
477 CloseSession(session);
481 if (session->status == ISSL_HANDSHAKING)
483 if (session->rstat == ISSL_READ || session->wstat == ISSL_READ)
485 // The handshake isn't finished and it wants to read, try to finish it.
486 if (!Handshake(session))
488 // Couldn't resume handshake.
499 // If we resumed the handshake then session->status will be ISSL_OPEN
501 if (session->status == ISSL_OPEN)
503 if (session->wstat == ISSL_READ)
505 if(DoWrite(session) == 0)
509 if (session->rstat == ISSL_READ)
511 int ret = DoRead(session);
513 ServerInstance->Log(DEBUG, "<***> DoRead count: " + ConvToStr(count));
514 ServerInstance->Log(DEBUG, "<***> DoRead ret: " + ConvToStr(ret));
515 ServerInstance->Log(DEBUG, "<***> DoRead session->inbufoffset: " + ConvToStr(session->inbufoffset));
519 if (count <= session->inbufoffset)
521 memcpy(buffer, session->inbuf, count);
522 // Move the stuff left in inbuf to the beginning of it
523 memcpy(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
524 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
525 session->inbufoffset -= count;
526 // Insp uses readresult as the count of how much data there is in buffer, so:
531 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
532 memcpy(buffer, session->inbuf, session->inbufoffset);
534 readresult = session->inbufoffset;
535 // Zero the offset, as there's nothing there..
536 session->inbufoffset = 0;
551 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
553 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
554 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
557 issl_session* session = &sessions[fd];
561 CloseSession(session);
565 session->outbuf.append(buffer, count);
566 MakePollWrite(session);
568 if (session->status == ISSL_HANDSHAKING)
570 // The handshake isn't finished, try to finish it.
571 if (session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
577 if (session->status == ISSL_OPEN)
579 if (session->rstat == ISSL_WRITE)
584 if (session->wstat == ISSL_WRITE)
586 return DoWrite(session);
593 int DoWrite(issl_session* session)
595 if (!session->outbuf.size())
598 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
602 CloseSession(session);
607 int err = SSL_get_error(session->sess, ret);
609 if (err == SSL_ERROR_WANT_WRITE)
611 session->wstat = ISSL_WRITE;
614 else if (err == SSL_ERROR_WANT_READ)
616 session->wstat = ISSL_READ;
621 CloseSession(session);
627 session->outbuf = session->outbuf.substr(ret);
632 int DoRead(issl_session* session)
634 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
635 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
637 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
641 // Client closed connection.
642 CloseSession(session);
647 int err = SSL_get_error(session->sess, ret);
649 if (err == SSL_ERROR_WANT_READ)
651 session->rstat = ISSL_READ;
654 else if (err == SSL_ERROR_WANT_WRITE)
656 session->rstat = ISSL_WRITE;
657 MakePollWrite(session);
662 CloseSession(session);
668 // Read successfully 'ret' bytes into inbuf + inbufoffset
669 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
670 // 'buffer' is 'count' long
672 session->inbufoffset += ret;
678 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
679 virtual void OnWhois(userrec* source, userrec* dest)
684 // Bugfix, only send this numeric for *our* SSL users
685 if (dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
687 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
691 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
693 // check if the linking module wants to know about OUR metadata
694 if (extname == "ssl")
696 // check if this user has an swhois field to send
697 if(user->GetExt(extname, dummy))
699 // call this function in the linking module, let it format the data how it
700 // sees fit, and send it on its way. We dont need or want to know how.
701 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, displayable ? "Enabled" : "ON");
706 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
708 // check if its our metadata key, and its associated with a user
709 if ((target_type == TYPE_USER) && (extname == "ssl"))
711 userrec* dest = (userrec*)target;
712 // if they dont already have an ssl flag, accept the remote server's
713 if (!dest->GetExt(extname, dummy))
715 dest->Extend(extname, "ON");
720 bool Handshake(issl_session* session)
724 if (session->outbound)
726 ret = SSL_connect(session->sess);
729 ret = SSL_accept(session->sess);
733 int err = SSL_get_error(session->sess, ret);
735 if (err == SSL_ERROR_WANT_READ)
737 session->rstat = ISSL_READ;
738 session->status = ISSL_HANDSHAKING;
741 else if (err == SSL_ERROR_WANT_WRITE)
743 session->wstat = ISSL_WRITE;
744 session->status = ISSL_HANDSHAKING;
745 MakePollWrite(session);
750 CloseSession(session);
757 // Handshake complete.
758 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
759 userrec* u = ServerInstance->FindDescriptor(session->fd);
762 if (!u->GetExt("ssl", dummy))
763 u->Extend("ssl", "ON");
766 session->status = ISSL_OPEN;
768 MakePollWrite(session);
774 int ssl_err = SSL_get_error(session->sess, ret);
776 ERR_print_errors_fp(stderr);
777 ServerInstance->Log(DEBUG,"Handshake fail 2: %d: %s", ssl_err, ERR_error_string(ssl_err,buf));
778 CloseSession(session);
785 virtual void OnPostConnect(userrec* user)
787 // This occurs AFTER OnUserConnect so we can be sure the
788 // protocol module has propagated the NICK message.
789 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
791 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
792 std::deque<std::string>* metadata = new std::deque<std::string>;
793 metadata->push_back(user->nick);
794 metadata->push_back("ssl"); // The metadata id
795 metadata->push_back("ON"); // The value to send
796 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
797 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
801 VerifyCertificate(&sessions[user->GetFd()], user);
802 if (sessions[user->GetFd()].sess)
803 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick, SSL_get_cipher(sessions[user->GetFd()].sess));
807 void MakePollWrite(issl_session* session)
809 //OnRawSocketWrite(session->fd, NULL, 0);
810 EventHandler* eh = ServerInstance->FindDescriptor(session->fd);
812 ServerInstance->SE->WantWrite(eh);
815 virtual void OnBufferFlushed(userrec* user)
817 if (user->GetExt("ssl"))
819 issl_session* session = &sessions[user->GetFd()];
820 if (session && session->outbuf.size())
821 OnRawSocketWrite(user->GetFd(), NULL, 0);
825 void CloseSession(issl_session* session)
829 SSL_shutdown(session->sess);
830 SSL_free(session->sess);
835 delete[] session->inbuf;
838 session->outbuf.clear();
839 session->inbuf = NULL;
840 session->sess = NULL;
841 session->status = ISSL_NONE;
844 void VerifyCertificate(issl_session* session, Extensible* user)
846 if (!session->sess || !user)
850 ssl_cert* certinfo = new ssl_cert;
852 unsigned char md[EVP_MAX_MD_SIZE];
853 const EVP_MD *digest = EVP_md5();
855 user->Extend("ssl_cert",certinfo);
857 cert = SSL_get_peer_certificate((SSL*)session->sess);
861 certinfo->data.insert(std::make_pair("error","Could not get peer certificate: "+std::string(get_error())));
865 certinfo->data.insert(std::make_pair("invalid", SSL_get_verify_result(session->sess) != X509_V_OK ? ConvToStr(1) : ConvToStr(0)));
869 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
870 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
874 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
875 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
878 certinfo->data.insert(std::make_pair("dn",std::string(X509_NAME_oneline(X509_get_subject_name(cert),0,0))));
879 certinfo->data.insert(std::make_pair("issuer",std::string(X509_NAME_oneline(X509_get_issuer_name(cert),0,0))));
881 if (!X509_digest(cert, digest, md, &n))
883 certinfo->data.insert(std::make_pair("error","Out of memory generating fingerprint"));
887 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(md, n)));
890 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))
892 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
899 static int error_callback(const char *str, size_t len, void *u)
901 ModuleSSLOpenSSL* mssl = (ModuleSSLOpenSSL*)u;
902 mssl->PublicInstance->Log(DEFAULT, "SSL error: " + std::string(str, len - 1));
906 MODULE_INIT(ModuleSSLOpenSSL);