4 #include <gnutls/gnutls.h>
5 #include <gnutls/x509.h>
7 #include "inspircd_config.h"
8 #include "configreader.h"
17 #include "transport.h"
19 /* $ModDesc: Provides SSL support for clients */
20 /* $CompileFlags: `libgnutls-config --cflags` */
21 /* $LinkerFlags: `perl extra/gnutls_rpath.pl` */
22 /* $ModDep: transport.h */
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 ServerInstance->PublishInterface("InspSocketHook", this);
83 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
84 inbufsize = ServerInstance->Config->NetBufferSize;
86 gnutls_global_init(); // This must be called once in the program
88 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
89 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
91 // Guessing return meaning
92 if(gnutls_dh_params_init(&dh_params) < 0)
93 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
95 // Needs the flag as it ignores a plain /rehash
98 // Void return, guess we assume success
99 gnutls_certificate_set_dh_params(x509_cred, dh_params);
102 virtual void OnRehash(const std::string ¶m)
107 Conf = new ConfigReader(ServerInstance);
109 for(unsigned int i = 0; i < listenports.size(); i++)
111 ServerInstance->Config->DelIOHook(listenports[i]);
116 for(int i = 0; i < Conf->Enumerate("bind"); i++)
118 // For each <bind> tag
119 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
121 // Get the port we're meant to be listening on with SSL
122 std::string port = Conf->ReadValue("bind", "port", i);
123 irc::portparser portrange(port, false);
125 while ((portno = portrange.GetToken()))
127 if (ServerInstance->Config->AddIOHook(portno, this))
129 listenports.push_back(portno);
130 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
134 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
140 std::string confdir(CONFIG_FILE);
141 // +1 so we the path ends with a /
142 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
144 cafile = Conf->ReadValue("gnutls", "cafile", 0);
145 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
146 certfile = Conf->ReadValue("gnutls", "certfile", 0);
147 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
148 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
150 // Set all the default values needed.
158 certfile = "cert.pem";
163 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
166 // Prepend relative paths with the path to the config directory.
168 cafile = confdir + cafile;
170 if(crlfile[0] != '/')
171 crlfile = confdir + crlfile;
173 if(certfile[0] != '/')
174 certfile = confdir + certfile;
176 if(keyfile[0] != '/')
177 keyfile = confdir + keyfile;
179 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
180 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
182 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
183 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
185 // Guessing on the return value of this, manual doesn't say :|
186 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
187 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());
189 // This may be on a large (once a day or week) timer eventually.
195 void GenerateDHParams()
197 // Generate Diffie Hellman parameters - for use with DHE
198 // kx algorithms. These should be discarded and regenerated
199 // once a day, once a week or once a month. Depending on the
200 // security requirements.
202 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
203 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
206 virtual ~ModuleSSLGnuTLS()
208 gnutls_dh_params_deinit(dh_params);
209 gnutls_certificate_free_credentials(x509_cred);
210 gnutls_global_deinit();
214 virtual void OnCleanup(int target_type, void* item)
216 if(target_type == TYPE_USER)
218 userrec* user = (userrec*)item;
220 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
222 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
223 // Potentially there could be multiple SSL modules loaded at once on different ports.
224 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Adding user %s to cull list", user->nick);
225 culllist->AddItem(user, "SSL module unloading");
227 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
230 user->GetExt("ssl_cert", tofree);
232 user->Shrink("ssl_cert");
237 virtual void OnUnloadModule(Module* mod, const std::string &name)
241 // We're being unloaded, kill all the users added to the cull list in OnCleanup
242 int numusers = culllist->Apply();
243 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Killed %d users for unload of GnuTLS SSL module", numusers);
245 for(unsigned int i = 0; i < listenports.size(); i++)
246 ServerInstance->Config->DelIOHook(listenports[i]);
250 virtual Version GetVersion()
252 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
255 void Implements(char* List)
257 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
258 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
261 virtual char* OnRequest(Request* request)
263 ISHRequest* ISR = (ISHRequest*)request;
264 if (strcmp("IS_NAME", request->GetId()) == 0)
268 else if (strcmp("IS_HOOK", request->GetId()) == 0)
273 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
275 catch (ModuleException &e)
281 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
283 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
285 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
287 issl_session* session = &sessions[ISR->Sock->GetFd()];
288 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
290 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
292 issl_session* session = &sessions[ISR->Sock->GetFd()];
295 VerifyCertificate(session, (InspSocket*)ISR->Sock);
303 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
305 issl_session* session = &sessions[fd];
308 session->inbuf = new char[inbufsize];
309 session->inbufoffset = 0;
311 gnutls_init(&session->sess, GNUTLS_SERVER);
313 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
314 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
315 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
316 gnutls_dh_set_prime_bits(session->sess, dh_bits);
318 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
319 * This needs testing, but it's easy enough to rollback if need be
320 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
321 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
323 * With testing this seems to...not work :/
326 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
331 virtual void OnRawSocketConnect(int fd)
333 issl_session* session = &sessions[fd];
336 session->inbuf = new char[inbufsize];
337 session->inbufoffset = 0;
339 gnutls_init(&session->sess, GNUTLS_SERVER);
341 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
342 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
343 gnutls_dh_set_prime_bits(session->sess, dh_bits);
345 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
350 virtual void OnRawSocketClose(int fd)
352 ServerInstance->Log(DEBUG, "OnRawSocketClose: %d", fd);
353 CloseSession(&sessions[fd]);
355 EventHandler* user = ServerInstance->SE->GetRef(fd);
357 if ((user) && (user->GetExt("ssl_cert", dummy)))
360 user->GetExt("ssl_cert", tofree);
362 user->Shrink("ssl_cert");
366 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
368 issl_session* session = &sessions[fd];
372 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
374 CloseSession(session);
378 if (session->status == ISSL_HANDSHAKING_READ)
380 // The handshake isn't finished, try to finish it.
382 if(Handshake(session))
384 // Handshake successfully resumed.
385 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
389 // Couldn't resume handshake.
390 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
394 else if (session->status == ISSL_HANDSHAKING_WRITE)
396 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
400 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
402 if (session->status == ISSL_HANDSHAKEN)
404 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
405 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
406 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
408 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
412 // Client closed connection.
413 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
415 CloseSession(session);
420 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
422 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
427 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
429 CloseSession(session);
434 // Read successfully 'ret' bytes into inbuf + inbufoffset
435 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
436 // 'buffer' is 'count' long
438 unsigned int length = ret + session->inbufoffset;
442 memcpy(buffer, session->inbuf, count);
443 // Move the stuff left in inbuf to the beginning of it
444 memcpy(session->inbuf, session->inbuf + count, (length - count));
445 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
446 session->inbufoffset = length - count;
447 // Insp uses readresult as the count of how much data there is in buffer, so:
452 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
453 memcpy(buffer, session->inbuf, length);
454 // Zero the offset, as there's nothing there..
455 session->inbufoffset = 0;
461 else if(session->status == ISSL_CLOSING)
463 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
470 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
475 issl_session* session = &sessions[fd];
476 const char* sendbuffer = buffer;
480 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
481 CloseSession(session);
485 if(session->status == ISSL_HANDSHAKING_WRITE)
487 // The handshake isn't finished, try to finish it.
489 if(Handshake(session))
491 // Handshake successfully resumed.
492 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
496 // Couldn't resume handshake.
497 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
500 else if(session->status == ISSL_HANDSHAKING_READ)
502 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
505 session->outbuf.append(sendbuffer, count);
506 sendbuffer = session->outbuf.c_str();
507 count = session->outbuf.size();
509 if(session->status == ISSL_HANDSHAKEN)
511 int ret = gnutls_record_send(session->sess, sendbuffer, count);
515 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
516 CloseSession(session);
520 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
522 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
526 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
527 CloseSession(session);
532 session->outbuf = session->outbuf.substr(ret);
535 else if(session->status == ISSL_CLOSING)
537 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
543 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
544 virtual void OnWhois(userrec* source, userrec* dest)
546 // Bugfix, only send this numeric for *our* SSL users
547 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
549 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
553 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
555 // check if the linking module wants to know about OUR metadata
558 // check if this user has an swhois field to send
559 if(user->GetExt(extname, dummy))
561 // call this function in the linking module, let it format the data how it
562 // sees fit, and send it on its way. We dont need or want to know how.
563 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
568 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
570 // check if its our metadata key, and its associated with a user
571 if ((target_type == TYPE_USER) && (extname == "ssl"))
573 userrec* dest = (userrec*)target;
574 // if they dont already have an ssl flag, accept the remote server's
575 if (!dest->GetExt(extname, dummy))
577 dest->Extend(extname, "ON");
582 bool Handshake(issl_session* session)
584 int ret = gnutls_handshake(session->sess);
588 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
590 // Handshake needs resuming later, read() or write() would have blocked.
592 if(gnutls_record_get_direction(session->sess) == 0)
594 // gnutls_handshake() wants to read() again.
595 session->status = ISSL_HANDSHAKING_READ;
596 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
600 // gnutls_handshake() wants to write() again.
601 session->status = ISSL_HANDSHAKING_WRITE;
602 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
603 MakePollWrite(session);
609 CloseSession(session);
610 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
611 session->status = ISSL_CLOSING;
618 // Handshake complete.
619 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
621 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
622 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
625 if (!extendme->GetExt("ssl", dummy))
626 extendme->Extend("ssl", "ON");
629 // Change the seesion state
630 session->status = ISSL_HANDSHAKEN;
632 // Finish writing, if any left
633 MakePollWrite(session);
639 virtual void OnPostConnect(userrec* user)
641 // This occurs AFTER OnUserConnect so we can be sure the
642 // protocol module has propogated the NICK message.
643 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
645 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
646 std::deque<std::string>* metadata = new std::deque<std::string>;
647 metadata->push_back(user->nick);
648 metadata->push_back("ssl"); // The metadata id
649 metadata->push_back("ON"); // The value to send
650 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
651 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
655 VerifyCertificate(&sessions[user->GetFd()],user);
659 void MakePollWrite(issl_session* session)
661 OnRawSocketWrite(session->fd, NULL, 0);
664 void CloseSession(issl_session* session)
668 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
669 gnutls_deinit(session->sess);
674 delete[] session->inbuf;
677 session->outbuf.clear();
678 session->inbuf = NULL;
679 session->sess = NULL;
680 session->status = ISSL_NONE;
683 void VerifyCertificate(issl_session* session, Extensible* user)
686 const gnutls_datum_t* cert_list;
688 unsigned int cert_list_size;
689 gnutls_x509_crt_t cert;
691 unsigned char digest[MAXBUF];
692 size_t digest_size = sizeof(digest);
693 size_t name_size = sizeof(name);
694 ssl_cert* certinfo = new ssl_cert;
696 user->Extend("ssl_cert",certinfo);
698 /* This verification function uses the trusted CAs in the credentials
699 * structure. So you must have installed one or more CA certificates.
701 ret = gnutls_certificate_verify_peers2(session->sess, &status);
705 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
709 if (status & GNUTLS_CERT_INVALID)
711 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
715 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
717 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
719 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
723 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
725 if (status & GNUTLS_CERT_REVOKED)
727 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
731 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
733 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
735 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
739 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
742 /* Up to here the process is the same for X.509 certificates and
743 * OpenPGP keys. From now on X.509 certificates are assumed. This can
744 * be easily extended to work with openpgp keys as well.
746 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
748 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
752 ret = gnutls_x509_crt_init(&cert);
755 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
760 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
761 if (cert_list == NULL)
763 certinfo->data.insert(std::make_pair("error","No certificate was found"));
767 /* This is not a real world example, since we only check the first
768 * certificate in the given chain.
771 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
774 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
778 gnutls_x509_crt_get_dn(cert, name, &name_size);
780 certinfo->data.insert(std::make_pair("dn",name));
782 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
784 certinfo->data.insert(std::make_pair("issuer",name));
786 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
788 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
792 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
795 /* Beware here we do not check for errors.
797 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
799 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
802 gnutls_x509_crt_deinit(cert);
809 class ModuleSSLGnuTLSFactory : public ModuleFactory
812 ModuleSSLGnuTLSFactory()
816 ~ModuleSSLGnuTLSFactory()
820 virtual Module * CreateModule(InspIRCd* Me)
822 return new ModuleSSLGnuTLS(Me);
827 extern "C" void * init_module( void )
829 return new ModuleSSLGnuTLSFactory;