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: `pkg-config --cflags openssl` */
21 /* $LinkerFlags: `pkg-config --libs openssl` */
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 /** Represents an SSL user's extra data
46 class issl_session : public classbase
54 unsigned int inbufoffset;
55 char* inbuf; // Buffer OpenSSL reads into.
56 std::string outbuf; // Buffer for outgoing data that OpenSSL will not take.
66 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
68 /* XXX: This will allow self signed certificates.
69 * In the future if we want an option to not allow this,
70 * we can just return preverify_ok here, and openssl
71 * will boot off self-signed and invalid peer certs.
73 int ve = X509_STORE_CTX_get_error(ctx);
75 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
80 class ModuleSSLOpenSSL : public Module
87 std::vector<int> listenports;
90 issl_session sessions[MAX_DESCRIPTORS];
99 // std::string crlfile;
104 ModuleSSLOpenSSL(InspIRCd* Me)
107 culllist = new CullList(ServerInstance);
109 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
110 inbufsize = ServerInstance->Config->NetBufferSize;
112 /* Global SSL library initialization*/
114 SSL_load_error_strings();
116 /* Build our SSL context*/
117 ctx = SSL_CTX_new( SSLv23_server_method() );
119 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
121 // Needs the flag as it ignores a plain /rehash
125 virtual void OnRehash(const std::string ¶m)
130 Conf = new ConfigReader(ServerInstance);
132 for(unsigned int i = 0; i < listenports.size(); i++)
134 ServerInstance->Config->DelIOHook(listenports[i]);
139 for(int i = 0; i < Conf->Enumerate("bind"); i++)
141 // For each <bind> tag
142 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "openssl"))
144 // Get the port we're meant to be listening on with SSL
145 std::string port = Conf->ReadValue("bind", "port", i);
146 irc::portparser portrange(port, false);
148 while ((portno = portrange.GetToken()))
150 if (ServerInstance->Config->AddIOHook(portno, this))
152 listenports.push_back(portno);
153 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %d", portno);
157 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
163 std::string confdir(CONFIG_FILE);
164 // +1 so we the path ends with a /
165 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
167 cafile = Conf->ReadValue("openssl", "cafile", 0);
168 // crlfile = Conf->ReadValue("openssl", "crlfile", 0);
169 certfile = Conf->ReadValue("openssl", "certfile", 0);
170 keyfile = Conf->ReadValue("openssl", "keyfile", 0);
171 dhfile = Conf->ReadValue("openssl", "dhfile", 0);
173 // Set all the default values needed.
178 // crlfile = "crl.pem";
181 certfile = "cert.pem";
187 dhfile = "dhparams.pem";
189 // Prepend relative paths with the path to the config directory.
191 cafile = confdir + cafile;
193 //if(crlfile[0] != '/')
194 // crlfile = confdir + crlfile;
196 if(certfile[0] != '/')
197 certfile = confdir + certfile;
199 if(keyfile[0] != '/')
200 keyfile = confdir + keyfile;
203 dhfile = confdir + dhfile;
205 /* Load our keys and certificates*/
206 if(!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str()))
208 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s", certfile.c_str());
211 if(!SSL_CTX_use_PrivateKey_file(ctx, keyfile.c_str(), SSL_FILETYPE_PEM))
213 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read key file %s", keyfile.c_str());
216 /* Load the CAs we trust*/
217 if(!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))
219 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read CA list from ", cafile.c_str());
222 FILE* dhpfile = fopen(dhfile.c_str(), "r");
227 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
228 throw ModuleException();
232 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
234 if(SSL_CTX_set_tmp_dh(ctx, ret) < 0)
236 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters");
245 virtual ~ModuleSSLOpenSSL()
251 virtual void OnCleanup(int target_type, void* item)
253 if(target_type == TYPE_USER)
255 userrec* user = (userrec*)item;
257 if(user->GetExt("ssl", dummy) && IS_LOCAL(user) && isin(user->GetPort(), listenports))
259 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
260 // Potentially there could be multiple SSL modules loaded at once on different ports.
261 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Adding user %s to cull list", user->nick);
262 culllist->AddItem(user, "SSL module unloading");
264 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
267 user->GetExt("ssl_cert", tofree);
269 user->Shrink("ssl_cert");
274 virtual void OnUnloadModule(Module* mod, const std::string &name)
278 // We're being unloaded, kill all the users added to the cull list in OnCleanup
279 int numusers = culllist->Apply();
280 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Killed %d users for unload of OpenSSL SSL module", numusers);
282 for(unsigned int i = 0; i < listenports.size(); i++)
283 ServerInstance->Config->DelIOHook(listenports[i]);
287 virtual Version GetVersion()
289 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
292 void Implements(char* List)
294 List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
295 List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
298 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
300 issl_session* session = &sessions[fd];
303 session->inbuf = new char[inbufsize];
304 session->inbufoffset = 0;
305 session->sess = SSL_new(ctx);
306 session->status = ISSL_NONE;
308 if(session->sess == NULL)
310 ServerInstance->Log(DEBUG, "m_ssl.so: Couldn't create SSL object: %s", get_error());
314 if(SSL_set_fd(session->sess, fd) == 0)
316 ServerInstance->Log(DEBUG, "m_ssl.so: Couldn't set fd for SSL object: %s", get_error());
323 virtual void OnRawSocketClose(int fd)
325 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketClose: %d", fd);
326 CloseSession(&sessions[fd]);
328 EventHandler* user = ServerInstance->SE->GetRef(fd);
330 if ((user) && (user->GetExt("ssl_cert", dummy)))
333 user->GetExt("ssl_cert", tofree);
335 user->Shrink("ssl_cert");
339 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
341 issl_session* session = &sessions[fd];
345 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: No session to read from");
347 CloseSession(session);
351 if(session->status == ISSL_HANDSHAKING)
353 if(session->rstat == ISSL_READ || session->wstat == ISSL_READ)
355 // The handshake isn't finished and it wants to read, try to finish it.
356 if(Handshake(session))
358 // Handshake successfully resumed.
359 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: successfully resumed handshake");
363 // Couldn't resume handshake.
364 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: failed to resume handshake");
370 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
375 // If we resumed the handshake then session->status will be ISSL_OPEN
377 if(session->status == ISSL_OPEN)
379 if(session->wstat == ISSL_READ)
381 if(DoWrite(session) == 0)
385 if(session->rstat == ISSL_READ)
387 int ret = DoRead(session);
391 if(count <= session->inbufoffset)
393 memcpy(buffer, session->inbuf, count);
394 // Move the stuff left in inbuf to the beginning of it
395 memcpy(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
396 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
397 session->inbufoffset -= count;
398 // Insp uses readresult as the count of how much data there is in buffer, so:
403 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
404 memcpy(buffer, session->inbuf, session->inbufoffset);
406 readresult = session->inbufoffset;
407 // Zero the offset, as there's nothing there..
408 session->inbufoffset = 0;
423 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
425 issl_session* session = &sessions[fd];
429 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: No session to write to");
430 CloseSession(session);
434 session->outbuf.append(buffer, count);
436 if(session->status == ISSL_HANDSHAKING)
438 // The handshake isn't finished, try to finish it.
439 if(session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
441 if(Handshake(session))
443 // Handshake successfully resumed.
444 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: successfully resumed handshake");
448 // Couldn't resume handshake.
449 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: failed to resume handshake");
454 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
458 if(session->status == ISSL_OPEN)
460 if(session->rstat == ISSL_WRITE)
465 if(session->wstat == ISSL_WRITE)
467 return DoWrite(session);
474 int DoWrite(issl_session* session)
476 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
480 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Client closed the connection");
481 CloseSession(session);
486 int err = SSL_get_error(session->sess, ret);
488 if(err == SSL_ERROR_WANT_WRITE)
490 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Not all SSL data written, need to retry: %s", get_error());
491 session->wstat = ISSL_WRITE;
494 else if(err == SSL_ERROR_WANT_READ)
496 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Not all SSL data written but the damn thing wants to read instead: %s", get_error());
497 session->wstat = ISSL_READ;
502 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoWrite: Error writing SSL data: %s", get_error());
503 CloseSession(session);
509 session->outbuf = session->outbuf.substr(ret);
514 int DoRead(issl_session* session)
516 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
517 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
519 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
523 // Client closed connection.
524 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Client closed the connection");
525 CloseSession(session);
530 int err = SSL_get_error(session->sess, ret);
532 if(err == SSL_ERROR_WANT_READ)
534 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Not all SSL data read, need to retry: %s", get_error());
535 session->rstat = ISSL_READ;
538 else if(err == SSL_ERROR_WANT_WRITE)
540 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Not all SSL data read but the damn thing wants to write instead: %s", get_error());
541 session->rstat = ISSL_WRITE;
546 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: DoRead: Error reading SSL data: %s", get_error());
547 CloseSession(session);
553 // Read successfully 'ret' bytes into inbuf + inbufoffset
554 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
555 // 'buffer' is 'count' long
557 session->inbufoffset += ret;
563 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
564 virtual void OnWhois(userrec* source, userrec* dest)
566 // Bugfix, only send this numeric for *our* SSL users
567 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
569 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
573 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
575 // check if the linking module wants to know about OUR metadata
578 // check if this user has an swhois field to send
579 if(user->GetExt(extname, dummy))
581 // call this function in the linking module, let it format the data how it
582 // sees fit, and send it on its way. We dont need or want to know how.
583 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
588 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
590 // check if its our metadata key, and its associated with a user
591 if ((target_type == TYPE_USER) && (extname == "ssl"))
593 userrec* dest = (userrec*)target;
594 // if they dont already have an ssl flag, accept the remote server's
595 if (!dest->GetExt(extname, dummy))
597 dest->Extend(extname, "ON");
602 bool Handshake(issl_session* session)
604 int ret = SSL_accept(session->sess);
608 int err = SSL_get_error(session->sess, ret);
610 if(err == SSL_ERROR_WANT_READ)
612 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake: Not completed, need to read again: %s", get_error());
613 session->rstat = ISSL_READ;
614 session->status = ISSL_HANDSHAKING;
616 else if(err == SSL_ERROR_WANT_WRITE)
618 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake: Not completed, need to write more data: %s", get_error());
619 session->wstat = ISSL_WRITE;
620 session->status = ISSL_HANDSHAKING;
621 MakePollWrite(session);
625 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake: Failed, bailing: %s", get_error());
626 CloseSession(session);
633 // Handshake complete.
634 ServerInstance->Log(DEBUG, "m_ssl_openssl.so: Handshake completed");
636 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
637 userrec* u = ServerInstance->FindDescriptor(session->fd);
640 if (!u->GetExt("ssl", dummy))
641 u->Extend("ssl", "ON");
644 session->status = ISSL_OPEN;
646 MakePollWrite(session);
652 virtual void OnPostConnect(userrec* user)
654 // This occurs AFTER OnUserConnect so we can be sure the
655 // protocol module has propogated the NICK message.
656 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
658 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
659 std::deque<std::string>* metadata = new std::deque<std::string>;
660 metadata->push_back(user->nick);
661 metadata->push_back("ssl"); // The metadata id
662 metadata->push_back("ON"); // The value to send
663 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
664 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
668 VerifyCertificate(&sessions[user->GetFd()], user);
672 void MakePollWrite(issl_session* session)
674 OnRawSocketWrite(session->fd, NULL, 0);
677 void CloseSession(issl_session* session)
681 SSL_shutdown(session->sess);
682 SSL_free(session->sess);
687 delete[] session->inbuf;
690 session->outbuf.clear();
691 session->inbuf = NULL;
692 session->sess = NULL;
693 session->status = ISSL_NONE;
696 void VerifyCertificate(issl_session* session, userrec* user)
699 ssl_cert* certinfo = new ssl_cert;
701 unsigned char md[EVP_MAX_MD_SIZE];
702 const EVP_MD *digest = EVP_md5();
704 user->Extend("ssl_cert",certinfo);
706 cert = SSL_get_peer_certificate((SSL*)session->sess);
710 certinfo->data.insert(std::make_pair("error","Could not get peer certificate: "+std::string(get_error())));
714 certinfo->data.insert(std::make_pair("invalid", SSL_get_verify_result(session->sess) != X509_V_OK ? ConvToStr(1) : ConvToStr(0)));
718 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
719 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
723 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
724 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
727 certinfo->data.insert(std::make_pair("dn",std::string(X509_NAME_oneline(X509_get_subject_name(cert),0,0))));
728 certinfo->data.insert(std::make_pair("issuer",std::string(X509_NAME_oneline(X509_get_issuer_name(cert),0,0))));
730 if (!X509_digest(cert, digest, md, &n))
732 certinfo->data.insert(std::make_pair("error","Out of memory generating fingerprint"));
736 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(md, n)));
739 user->WriteServ("NOTICE %s :*** Your SSL Certificate fingerprint is: %s", user->nick, irc::hex(md, n).c_str());
741 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))
743 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
750 class ModuleSSLOpenSSLFactory : public ModuleFactory
753 ModuleSSLOpenSSLFactory()
757 ~ModuleSSLOpenSSLFactory()
761 virtual Module * CreateModule(InspIRCd* Me)
763 return new ModuleSSLOpenSSL(Me);
768 extern "C" void * init_module( void )
770 return new ModuleSSLOpenSSLFactory;