4 #include <openssl/ssl.h>
5 #include <openssl/err.h>
7 #include "inspircd_config.h"
8 #include "configreader.h"
19 /* $ModDesc: Provides SSL support for clients */
20 /* $CompileFlags: -I/usr/include -I/usr/local/include */
21 /* $LinkerFlags: -L/usr/local/lib -Wl,--rpath -Wl,/usr/local/lib -L/usr/lib -Wl,--rpath -Wl,/usr/lib -lssl */
25 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
26 enum issl_io_status { ISSL_WRITE, ISSL_READ };
28 static bool SelfSigned = false;
30 bool isin(int port, const std::vector<int> &portlist)
32 for(unsigned int i = 0; i < portlist.size(); i++)
33 if(portlist[i] == port)
41 return ERR_error_string(ERR_get_error(), NULL);
44 class issl_session : public classbase
52 unsigned int inbufoffset;
53 char* inbuf; // Buffer OpenSSL reads into.
54 std::string outbuf; // Buffer for outgoing data that OpenSSL will not take.
64 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
66 /* XXX: This will allow self signed certificates.
67 * In the future if we want an option to not allow this,
68 * we can just return preverify_ok here, and openssl
69 * will boot off self-signed and invalid peer certs.
71 int ve = X509_STORE_CTX_get_error(ctx);
73 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
78 class ModuleSSLOpenSSL : public Module
85 std::vector<int> listenports;
88 issl_session sessions[MAX_DESCRIPTORS];
97 // std::string crlfile;
102 ModuleSSLOpenSSL(InspIRCd* Me)
105 culllist = new CullList(ServerInstance);
107 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
108 inbufsize = ServerInstance->Config->NetBufferSize;
110 /* Global SSL library initialization*/
112 SSL_load_error_strings();
114 /* Build our SSL context*/
115 ctx = SSL_CTX_new( SSLv23_server_method() );
117 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
119 // Needs the flag as it ignores a plain /rehash
123 virtual void OnRehash(const std::string ¶m)
128 Conf = new ConfigReader(ServerInstance);
130 for(unsigned int i = 0; i < listenports.size(); i++)
132 ServerInstance->Config->DelIOHook(listenports[i]);
137 for(int i = 0; i < Conf->Enumerate("bind"); i++)
139 // For each <bind> tag
140 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "openssl"))
142 // Get the port we're meant to be listening on with SSL
143 unsigned int port = Conf->ReadInteger("bind", "port", i, true);
144 if (ServerInstance->Config->AddIOHook(port, this))
146 // We keep a record of which ports we're listening on with SSL
147 listenports.push_back(port);
149 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %d", port);
153 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", port);
158 std::string confdir(CONFIG_FILE);
159 // +1 so we the path ends with a /
160 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
162 cafile = Conf->ReadValue("openssl", "cafile", 0);
163 // crlfile = Conf->ReadValue("openssl", "crlfile", 0);
164 certfile = Conf->ReadValue("openssl", "certfile", 0);
165 keyfile = Conf->ReadValue("openssl", "keyfile", 0);
166 dhfile = Conf->ReadValue("openssl", "dhfile", 0);
168 // Set all the default values needed.
173 // crlfile = "crl.pem";
176 certfile = "cert.pem";
182 dhfile = "dhparams.pem";
184 // Prepend relative paths with the path to the config directory.
186 cafile = confdir + cafile;
188 //if(crlfile[0] != '/')
189 // crlfile = confdir + crlfile;
191 if(certfile[0] != '/')
192 certfile = confdir + certfile;
194 if(keyfile[0] != '/')
195 keyfile = confdir + keyfile;
198 dhfile = confdir + dhfile;
200 /* Load our keys and certificates*/
201 if(!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str()))
203 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s", certfile.c_str());
206 if(!SSL_CTX_use_PrivateKey_file(ctx, keyfile.c_str(), SSL_FILETYPE_PEM))
208 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read key file %s", keyfile.c_str());
211 /* Load the CAs we trust*/
212 if(!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))
214 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read CA list from ", cafile.c_str());
217 FILE* dhpfile = fopen(dhfile.c_str(), "r");
222 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
223 throw ModuleException();
227 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
229 if(SSL_CTX_set_tmp_dh(ctx, ret) < 0)
231 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters");
240 virtual ~ModuleSSLOpenSSL()
246 virtual void OnCleanup(int target_type, void* item)
248 if(target_type == TYPE_USER)
250 userrec* user = (userrec*)item;
252 if(user->GetExt("ssl", dummy) && IS_LOCAL(user) && isin(user->GetPort(), listenports))
254 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
255 // Potentially there could be multiple SSL modules loaded at once on different ports.
256 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Adding user %s to cull list", user->nick);
257 culllist->AddItem(user, "SSL module unloading");
259 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
262 user->GetExt("ssl_cert", tofree);
264 user->Shrink("ssl_cert");
269 virtual void OnUnloadModule(Module* mod, const std::string &name)
273 // We're being unloaded, kill all the users added to the cull list in OnCleanup
274 int numusers = culllist->Apply();
275 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Killed %d users for unload of OpenSSL SSL module", numusers);
277 for(unsigned int i = 0; i < listenports.size(); i++)
278 ServerInstance->Config->DelIOHook(listenports[i]);
282 virtual Version GetVersion()
284 return Version(1, 0, 0, 0, VF_VENDOR);
287 void Implements(char* List)
289 List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
290 List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
293 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
295 issl_session* session = &sessions[fd];
298 session->inbuf = new char[inbufsize];
299 session->inbufoffset = 0;
300 session->sess = SSL_new(ctx);
301 session->status = ISSL_NONE;
303 if(session->sess == NULL)
305 ServerInstance->Log(DEBUG, "m_ssl.so: Couldn't create SSL object: %s", get_error());
309 if(SSL_set_fd(session->sess, fd) == 0)
311 ServerInstance->Log(DEBUG, "m_ssl.so: Couldn't set fd for SSL object: %s", get_error());
318 virtual void OnRawSocketClose(int fd)
320 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketClose: %d", fd);
321 CloseSession(&sessions[fd]);
323 EventHandler* user = ServerInstance->SE->GetRef(fd);
325 if ((user) && (user->GetExt("ssl_cert", dummy)))
328 user->GetExt("ssl_cert", tofree);
330 user->Shrink("ssl_cert");
334 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
336 issl_session* session = &sessions[fd];
340 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: No session to read from");
342 CloseSession(session);
346 if(session->status == ISSL_HANDSHAKING)
348 if(session->rstat == ISSL_READ || session->wstat == ISSL_READ)
350 // The handshake isn't finished and it wants to read, try to finish it.
351 if(Handshake(session))
353 // Handshake successfully resumed.
354 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: successfully resumed handshake");
358 // Couldn't resume handshake.
359 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: failed to resume handshake");
365 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
370 // If we resumed the handshake then session->status will be ISSL_OPEN
372 if(session->status == ISSL_OPEN)
374 if(session->wstat == ISSL_READ)
376 if(DoWrite(session) == 0)
380 if(session->rstat == ISSL_READ)
382 int ret = DoRead(session);
386 if(count <= session->inbufoffset)
388 memcpy(buffer, session->inbuf, count);
389 // Move the stuff left in inbuf to the beginning of it
390 memcpy(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
391 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
392 session->inbufoffset -= count;
393 // Insp uses readresult as the count of how much data there is in buffer, so:
398 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
399 memcpy(buffer, session->inbuf, session->inbufoffset);
401 readresult = session->inbufoffset;
402 // Zero the offset, as there's nothing there..
403 session->inbufoffset = 0;
418 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
420 issl_session* session = &sessions[fd];
424 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: No session to write to");
425 CloseSession(session);
429 session->outbuf.append(buffer, count);
431 if(session->status == ISSL_HANDSHAKING)
433 // The handshake isn't finished, try to finish it.
434 if(session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
436 if(Handshake(session))
438 // Handshake successfully resumed.
439 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: successfully resumed handshake");
443 // Couldn't resume handshake.
444 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: failed to resume handshake");
449 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
453 if(session->status == ISSL_OPEN)
455 if(session->rstat == ISSL_WRITE)
460 if(session->wstat == ISSL_WRITE)
462 return DoWrite(session);
469 int DoWrite(issl_session* session)
471 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
475 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Client closed the connection");
476 CloseSession(session);
481 int err = SSL_get_error(session->sess, ret);
483 if(err == SSL_ERROR_WANT_WRITE)
485 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Not all SSL data written, need to retry: %s", get_error());
486 session->wstat = ISSL_WRITE;
489 else if(err == SSL_ERROR_WANT_READ)
491 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Not all SSL data written but the damn thing wants to read instead: %s", get_error());
492 session->wstat = ISSL_READ;
497 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Error writing SSL data: %s", get_error());
498 CloseSession(session);
504 session->outbuf = session->outbuf.substr(ret);
509 int DoRead(issl_session* session)
511 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
512 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
514 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
518 // Client closed connection.
519 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Client closed the connection");
520 CloseSession(session);
525 int err = SSL_get_error(session->sess, ret);
527 if(err == SSL_ERROR_WANT_READ)
529 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Not all SSL data read, need to retry: %s", get_error());
530 session->rstat = ISSL_READ;
533 else if(err == SSL_ERROR_WANT_WRITE)
535 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Not all SSL data read but the damn thing wants to write instead: %s", get_error());
536 session->rstat = ISSL_WRITE;
541 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Error reading SSL data: %s", get_error());
542 CloseSession(session);
548 // Read successfully 'ret' bytes into inbuf + inbufoffset
549 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
550 // 'buffer' is 'count' long
552 session->inbufoffset += ret;
558 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
559 virtual void OnWhois(userrec* source, userrec* dest)
561 // Bugfix, only send this numeric for *our* SSL users
562 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
564 source->WriteServ("320 %s %s :is using a secure connection", source->nick, dest->nick);
568 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
570 // check if the linking module wants to know about OUR metadata
573 // check if this user has an swhois field to send
574 if(user->GetExt(extname, dummy))
576 // call this function in the linking module, let it format the data how it
577 // sees fit, and send it on its way. We dont need or want to know how.
578 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
583 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
585 // check if its our metadata key, and its associated with a user
586 if ((target_type == TYPE_USER) && (extname == "ssl"))
588 userrec* dest = (userrec*)target;
589 // if they dont already have an ssl flag, accept the remote server's
590 if (!dest->GetExt(extname, dummy))
592 dest->Extend(extname, "ON");
597 bool Handshake(issl_session* session)
599 int ret = SSL_accept(session->sess);
603 int err = SSL_get_error(session->sess, ret);
605 if(err == SSL_ERROR_WANT_READ)
607 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake: Not completed, need to read again: %s", get_error());
608 session->rstat = ISSL_READ;
609 session->status = ISSL_HANDSHAKING;
611 else if(err == SSL_ERROR_WANT_WRITE)
613 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake: Not completed, need to write more data: %s", get_error());
614 session->wstat = ISSL_WRITE;
615 session->status = ISSL_HANDSHAKING;
616 MakePollWrite(session);
620 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake: Failed, bailing: %s", get_error());
621 CloseSession(session);
628 // Handshake complete.
629 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake completed");
631 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
632 userrec* u = ServerInstance->FindDescriptor(session->fd);
635 if (!u->GetExt("ssl", dummy))
636 u->Extend("ssl", "ON");
639 session->status = ISSL_OPEN;
641 MakePollWrite(session);
647 virtual void OnPostConnect(userrec* user)
649 // This occurs AFTER OnUserConnect so we can be sure the
650 // protocol module has propogated the NICK message.
651 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
653 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
654 std::deque<std::string>* metadata = new std::deque<std::string>;
655 metadata->push_back(user->nick);
656 metadata->push_back("ssl"); // The metadata id
657 metadata->push_back("ON"); // The value to send
658 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
659 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
663 VerifyCertificate(&sessions[user->GetFd()], user);
667 void MakePollWrite(issl_session* session)
669 OnRawSocketWrite(session->fd, NULL, 0);
672 void CloseSession(issl_session* session)
676 SSL_shutdown(session->sess);
677 SSL_free(session->sess);
682 delete[] session->inbuf;
685 session->outbuf.clear();
686 session->inbuf = NULL;
687 session->sess = NULL;
688 session->status = ISSL_NONE;
691 void VerifyCertificate(issl_session* session, userrec* user)
694 ssl_cert* certinfo = new ssl_cert;
696 unsigned char md[EVP_MAX_MD_SIZE];
697 const EVP_MD *digest = EVP_md5();
699 user->Extend("ssl_cert",certinfo);
701 cert = SSL_get_peer_certificate((SSL*)session->sess);
705 certinfo->data.insert(std::make_pair("error","Could not get peer certificate: "+std::string(get_error())));
709 certinfo->data.insert(std::make_pair("invalid", SSL_get_verify_result(session->sess) != X509_V_OK ? ConvToStr(1) : ConvToStr(0)));
713 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
714 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
718 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
719 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
722 certinfo->data.insert(std::make_pair("dn",std::string(X509_NAME_oneline(X509_get_subject_name(cert),0,0))));
723 certinfo->data.insert(std::make_pair("issuer",std::string(X509_NAME_oneline(X509_get_issuer_name(cert),0,0))));
725 if (!X509_digest(cert, digest, md, &n))
727 certinfo->data.insert(std::make_pair("error","Out of memory generating fingerprint"));
731 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(md, n)));
734 user->WriteServ("NOTICE %s :*** Your SSL Certificate fingerprint is: %s", user->nick, irc::hex(md, n).c_str());
736 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))
738 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
743 class ModuleSSLOpenSSLFactory : public ModuleFactory
746 ModuleSSLOpenSSLFactory()
750 ~ModuleSSLOpenSSLFactory()
754 virtual Module * CreateModule(InspIRCd* Me)
756 return new ModuleSSLOpenSSL(Me);
761 extern "C" void * init_module( void )
763 return new ModuleSSLOpenSSLFactory;