4 #include <gnutls/gnutls.h>
5 #include <gnutls/x509.h>
7 #include "inspircd_config.h"
8 #include "configreader.h"
19 /* $ModDesc: Provides SSL support for clients */
20 /* $CompileFlags: `libgnutls-config --cflags` */
21 /* $LinkerFlags: `libgnutls-config --libs` `perl ../gnutls_rpath.pl` */
25 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
27 bool isin(int port, const std::vector<int> &portlist)
29 for(unsigned int i = 0; i < portlist.size(); i++)
30 if(portlist[i] == port)
36 /** Represents an SSL user's extra data
38 class issl_session : public classbase
41 gnutls_session_t sess;
49 class ModuleSSLGnuTLS : public Module
58 std::vector<int> listenports;
61 issl_session sessions[MAX_DESCRIPTORS];
63 gnutls_certificate_credentials x509_cred;
64 gnutls_dh_params dh_params;
74 ModuleSSLGnuTLS(InspIRCd* Me)
79 culllist = new CullList(ServerInstance);
81 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
82 inbufsize = ServerInstance->Config->NetBufferSize;
84 gnutls_global_init(); // This must be called once in the program
86 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
87 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
89 // Guessing return meaning
90 if(gnutls_dh_params_init(&dh_params) < 0)
91 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
93 // Needs the flag as it ignores a plain /rehash
96 // Void return, guess we assume success
97 gnutls_certificate_set_dh_params(x509_cred, dh_params);
100 virtual void OnRehash(const std::string ¶m)
105 Conf = new ConfigReader(ServerInstance);
107 for(unsigned int i = 0; i < listenports.size(); i++)
109 ServerInstance->Config->DelIOHook(listenports[i]);
114 for(int i = 0; i < Conf->Enumerate("bind"); i++)
116 // For each <bind> tag
117 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
119 // Get the port we're meant to be listening on with SSL
120 std::string port = Conf->ReadValue("bind", "port", i);
121 irc::commasepstream portrange(port);
122 std::string portno = "*";
123 while ((portno = portrange.GetToken()) != "")
125 std::string::size_type dash = portno.rfind('-');
126 if (dash != std::string::npos)
128 std::string sbegin = portno.substr(0, dash);
129 std::string send = portno.substr(dash+1, portno.length());
130 long begin = atoi(sbegin.c_str());
131 long end = atoi(send.c_str());
132 if ((begin < 0) || (end < 0) || (begin > 65535) || (end > 65535) || (begin >= end))
134 ServerInstance->Log(DEFAULT,"WARNING: Port range \"%d-%d\" discarded. begin >= end, or begin/end out of range.", begin, end);
138 for (int portval = begin; portval <= end; ++portval)
140 if (ServerInstance->Config->AddIOHook(portval, this))
142 listenports.push_back(portval);
143 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portval);
147 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?",
155 if (ServerInstance->Config->AddIOHook(atoi(portno.c_str()), this))
157 // We keep a record of which ports we're listening on with SSL
158 listenports.push_back(atoi(portno.c_str()));
160 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portno.c_str());
164 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %s, maybe you have another ssl or similar module loaded?", portno.c_str());
171 std::string confdir(CONFIG_FILE);
172 // +1 so we the path ends with a /
173 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
175 cafile = Conf->ReadValue("gnutls", "cafile", 0);
176 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
177 certfile = Conf->ReadValue("gnutls", "certfile", 0);
178 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
179 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
181 // Set all the default values needed.
189 certfile = "cert.pem";
194 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
197 // Prepend relative paths with the path to the config directory.
199 cafile = confdir + cafile;
201 if(crlfile[0] != '/')
202 crlfile = confdir + crlfile;
204 if(certfile[0] != '/')
205 certfile = confdir + certfile;
207 if(keyfile[0] != '/')
208 keyfile = confdir + keyfile;
210 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
211 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
213 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
214 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
216 // Guessing on the return value of this, manual doesn't say :|
217 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
218 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 certificate and key files: %s and %s", certfile.c_str(), keyfile.c_str());
220 // This may be on a large (once a day or week) timer eventually.
226 void GenerateDHParams()
228 // Generate Diffie Hellman parameters - for use with DHE
229 // kx algorithms. These should be discarded and regenerated
230 // once a day, once a week or once a month. Depending on the
231 // security requirements.
233 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
234 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
237 virtual ~ModuleSSLGnuTLS()
239 gnutls_dh_params_deinit(dh_params);
240 gnutls_certificate_free_credentials(x509_cred);
241 gnutls_global_deinit();
245 virtual void OnCleanup(int target_type, void* item)
247 if(target_type == TYPE_USER)
249 userrec* user = (userrec*)item;
251 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
253 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
254 // Potentially there could be multiple SSL modules loaded at once on different ports.
255 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Adding user %s to cull list", user->nick);
256 culllist->AddItem(user, "SSL module unloading");
258 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
261 user->GetExt("ssl_cert", tofree);
263 user->Shrink("ssl_cert");
268 virtual void OnUnloadModule(Module* mod, const std::string &name)
272 // We're being unloaded, kill all the users added to the cull list in OnCleanup
273 int numusers = culllist->Apply();
274 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Killed %d users for unload of GnuTLS SSL module", numusers);
276 for(unsigned int i = 0; i < listenports.size(); i++)
277 ServerInstance->Config->DelIOHook(listenports[i]);
281 virtual Version GetVersion()
283 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
286 void Implements(char* List)
288 List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
289 List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
292 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
294 issl_session* session = &sessions[fd];
297 session->inbuf = new char[inbufsize];
298 session->inbufoffset = 0;
300 gnutls_init(&session->sess, GNUTLS_SERVER);
302 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
303 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
304 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
305 gnutls_dh_set_prime_bits(session->sess, dh_bits);
307 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
308 * This needs testing, but it's easy enough to rollback if need be
309 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
310 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
312 * With testing this seems to...not work :/
315 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
320 virtual void OnRawSocketClose(int fd)
322 ServerInstance->Log(DEBUG, "OnRawSocketClose: %d", fd);
323 CloseSession(&sessions[fd]);
325 EventHandler* user = ServerInstance->SE->GetRef(fd);
327 if ((user) && (user->GetExt("ssl_cert", dummy)))
330 user->GetExt("ssl_cert", tofree);
332 user->Shrink("ssl_cert");
336 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
338 issl_session* session = &sessions[fd];
342 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
344 CloseSession(session);
348 if (session->status == ISSL_HANDSHAKING_READ)
350 // The handshake isn't finished, try to finish it.
352 if(Handshake(session))
354 // Handshake successfully resumed.
355 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
359 // Couldn't resume handshake.
360 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
364 else if (session->status == ISSL_HANDSHAKING_WRITE)
366 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
370 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
372 if (session->status == ISSL_HANDSHAKEN)
374 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
375 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
376 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
378 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
382 // Client closed connection.
383 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
385 CloseSession(session);
390 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
392 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
397 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
399 CloseSession(session);
404 // Read successfully 'ret' bytes into inbuf + inbufoffset
405 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
406 // 'buffer' is 'count' long
408 unsigned int length = ret + session->inbufoffset;
412 memcpy(buffer, session->inbuf, count);
413 // Move the stuff left in inbuf to the beginning of it
414 memcpy(session->inbuf, session->inbuf + count, (length - count));
415 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
416 session->inbufoffset = length - count;
417 // Insp uses readresult as the count of how much data there is in buffer, so:
422 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
423 memcpy(buffer, session->inbuf, length);
424 // Zero the offset, as there's nothing there..
425 session->inbufoffset = 0;
431 else if(session->status == ISSL_CLOSING)
433 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
440 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
442 issl_session* session = &sessions[fd];
443 const char* sendbuffer = buffer;
447 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
448 CloseSession(session);
452 if(session->status == ISSL_HANDSHAKING_WRITE)
454 // The handshake isn't finished, try to finish it.
456 if(Handshake(session))
458 // Handshake successfully resumed.
459 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
463 // Couldn't resume handshake.
464 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
467 else if(session->status == ISSL_HANDSHAKING_READ)
469 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
472 session->outbuf.append(sendbuffer, count);
473 sendbuffer = session->outbuf.c_str();
474 count = session->outbuf.size();
476 if(session->status == ISSL_HANDSHAKEN)
478 int ret = gnutls_record_send(session->sess, sendbuffer, count);
482 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
483 CloseSession(session);
487 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
489 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
493 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
494 CloseSession(session);
499 session->outbuf = session->outbuf.substr(ret);
502 else if(session->status == ISSL_CLOSING)
504 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
510 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
511 virtual void OnWhois(userrec* source, userrec* dest)
513 // Bugfix, only send this numeric for *our* SSL users
514 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
516 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
520 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
522 // check if the linking module wants to know about OUR metadata
525 // check if this user has an swhois field to send
526 if(user->GetExt(extname, dummy))
528 // call this function in the linking module, let it format the data how it
529 // sees fit, and send it on its way. We dont need or want to know how.
530 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
535 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
537 // check if its our metadata key, and its associated with a user
538 if ((target_type == TYPE_USER) && (extname == "ssl"))
540 userrec* dest = (userrec*)target;
541 // if they dont already have an ssl flag, accept the remote server's
542 if (!dest->GetExt(extname, dummy))
544 dest->Extend(extname, "ON");
549 bool Handshake(issl_session* session)
551 int ret = gnutls_handshake(session->sess);
555 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
557 // Handshake needs resuming later, read() or write() would have blocked.
559 if(gnutls_record_get_direction(session->sess) == 0)
561 // gnutls_handshake() wants to read() again.
562 session->status = ISSL_HANDSHAKING_READ;
563 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
567 // gnutls_handshake() wants to write() again.
568 session->status = ISSL_HANDSHAKING_WRITE;
569 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
570 MakePollWrite(session);
576 CloseSession(session);
577 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
578 session->status = ISSL_CLOSING;
585 // Handshake complete.
586 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
588 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
589 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
592 if (!extendme->GetExt("ssl", dummy))
593 extendme->Extend("ssl", "ON");
596 // Change the seesion state
597 session->status = ISSL_HANDSHAKEN;
599 // Finish writing, if any left
600 MakePollWrite(session);
606 virtual void OnPostConnect(userrec* user)
608 // This occurs AFTER OnUserConnect so we can be sure the
609 // protocol module has propogated the NICK message.
610 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
612 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
613 std::deque<std::string>* metadata = new std::deque<std::string>;
614 metadata->push_back(user->nick);
615 metadata->push_back("ssl"); // The metadata id
616 metadata->push_back("ON"); // The value to send
617 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
618 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
622 VerifyCertificate(&sessions[user->GetFd()],user);
626 void MakePollWrite(issl_session* session)
628 OnRawSocketWrite(session->fd, NULL, 0);
631 void CloseSession(issl_session* session)
635 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
636 gnutls_deinit(session->sess);
641 delete[] session->inbuf;
644 session->outbuf.clear();
645 session->inbuf = NULL;
646 session->sess = NULL;
647 session->status = ISSL_NONE;
650 void VerifyCertificate(issl_session* session, userrec* user)
653 const gnutls_datum_t* cert_list;
655 unsigned int cert_list_size;
656 gnutls_x509_crt_t cert;
658 unsigned char digest[MAXBUF];
659 size_t digest_size = sizeof(digest);
660 size_t name_size = sizeof(name);
661 ssl_cert* certinfo = new ssl_cert;
663 user->Extend("ssl_cert",certinfo);
665 /* This verification function uses the trusted CAs in the credentials
666 * structure. So you must have installed one or more CA certificates.
668 ret = gnutls_certificate_verify_peers2(session->sess, &status);
672 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
676 if (status & GNUTLS_CERT_INVALID)
678 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
682 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
684 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
686 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
690 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
692 if (status & GNUTLS_CERT_REVOKED)
694 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
698 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
700 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
702 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
706 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
709 /* Up to here the process is the same for X.509 certificates and
710 * OpenPGP keys. From now on X.509 certificates are assumed. This can
711 * be easily extended to work with openpgp keys as well.
713 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
715 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
719 ret = gnutls_x509_crt_init(&cert);
722 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
727 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
728 if (cert_list == NULL)
730 certinfo->data.insert(std::make_pair("error","No certificate was found"));
734 /* This is not a real world example, since we only check the first
735 * certificate in the given chain.
738 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
741 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
745 gnutls_x509_crt_get_dn(cert, name, &name_size);
747 certinfo->data.insert(std::make_pair("dn",name));
749 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
751 certinfo->data.insert(std::make_pair("issuer",name));
753 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
755 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
759 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
760 user->WriteServ("NOTICE %s :*** Your SSL Certificate fingerprint is: %s", user->nick, irc::hex(digest, digest_size).c_str());
763 /* Beware here we do not check for errors.
765 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
767 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
770 gnutls_x509_crt_deinit(cert);
777 class ModuleSSLGnuTLSFactory : public ModuleFactory
780 ModuleSSLGnuTLSFactory()
784 ~ModuleSSLGnuTLSFactory()
788 virtual Module * CreateModule(InspIRCd* Me)
790 return new ModuleSSLGnuTLS(Me);
795 extern "C" void * init_module( void )
797 return new ModuleSSLGnuTLSFactory;