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 <gnutls/gnutls.h>
17 #include <gnutls/x509.h>
19 #include "inspircd_config.h"
20 #include "configreader.h"
26 #include "transport.h"
29 #pragma comment(lib, "libgnutls-13.lib")
30 #undef MAX_DESCRIPTORS
31 #define MAX_DESCRIPTORS 10000
34 /* $ModDesc: Provides SSL support for clients */
35 /* $CompileFlags: exec("libgnutls-config --cflags") */
36 /* $LinkerFlags: rpath("libgnutls-config --libs") exec("libgnutls-config --libs") */
37 /* $ModDep: transport.h */
40 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
42 bool isin(int port, const std::vector<int> &portlist)
44 for(unsigned int i = 0; i < portlist.size(); i++)
45 if(portlist[i] == port)
51 /** Represents an SSL user's extra data
53 class issl_session : public classbase
56 gnutls_session_t sess;
64 class ModuleSSLGnuTLS : public Module
71 std::vector<int> listenports;
74 issl_session sessions[MAX_DESCRIPTORS];
76 gnutls_certificate_credentials x509_cred;
77 gnutls_dh_params dh_params;
89 ModuleSSLGnuTLS(InspIRCd* Me)
92 ServerInstance->PublishInterface("InspSocketHook", this);
94 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
95 inbufsize = ServerInstance->Config->NetBufferSize;
97 gnutls_global_init(); // This must be called once in the program
99 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
100 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
102 // Guessing return meaning
103 if(gnutls_dh_params_init(&dh_params) < 0)
104 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
106 // Needs the flag as it ignores a plain /rehash
107 OnRehash(NULL,"ssl");
109 // Void return, guess we assume success
110 gnutls_certificate_set_dh_params(x509_cred, dh_params);
113 virtual void OnRehash(userrec* user, const std::string ¶m)
118 Conf = new ConfigReader(ServerInstance);
120 for(unsigned int i = 0; i < listenports.size(); i++)
122 ServerInstance->Config->DelIOHook(listenports[i]);
128 for(int i = 0; i < Conf->Enumerate("bind"); i++)
130 // For each <bind> tag
131 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
133 // Get the port we're meant to be listening on with SSL
134 std::string port = Conf->ReadValue("bind", "port", i);
135 irc::portparser portrange(port, false);
137 while ((portno = portrange.GetToken()))
142 if (ServerInstance->Config->AddIOHook(portno, this))
144 listenports.push_back(portno);
145 for (size_t i = 0; i < ServerInstance->Config->ports.size(); i++)
146 if (ServerInstance->Config->ports[i]->GetPort() == portno)
147 ServerInstance->Config->ports[i]->SetDescription("ssl");
148 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
152 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
155 catch (ModuleException &e)
157 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.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 an other SSL or similar module loaded?", portno, e.GetReason());
163 std::string confdir(ServerInstance->ConfigFileName);
164 // +1 so we the path ends with a /
165 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
167 cafile = Conf->ReadValue("gnutls", "cafile", 0);
168 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
169 certfile = Conf->ReadValue("gnutls", "certfile", 0);
170 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
171 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
173 // Set all the default values needed.
181 certfile = "cert.pem";
186 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
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;
204 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
205 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
207 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
208 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
210 // Guessing on the return value of this, manual doesn't say :|
211 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
212 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 certificate and key files '%s' and '%s': %s", certfile.c_str(), keyfile.c_str(), gnutls_strerror(ret));
214 // This may be on a large (once a day or week) timer eventually.
220 void GenerateDHParams()
222 // Generate Diffie Hellman parameters - for use with DHE
223 // kx algorithms. These should be discarded and regenerated
224 // once a day, once a week or once a month. Depending on the
225 // security requirements.
229 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
230 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
233 virtual ~ModuleSSLGnuTLS()
235 gnutls_dh_params_deinit(dh_params);
236 gnutls_certificate_free_credentials(x509_cred);
237 gnutls_global_deinit();
240 virtual void OnCleanup(int target_type, void* item)
242 if(target_type == TYPE_USER)
244 userrec* user = (userrec*)item;
246 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
248 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
249 // Potentially there could be multiple SSL modules loaded at once on different ports.
250 ServerInstance->GlobalCulls.AddItem(user, "SSL module unloading");
252 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
255 user->GetExt("ssl_cert", tofree);
257 user->Shrink("ssl_cert");
262 virtual void OnUnloadModule(Module* mod, const std::string &name)
266 for(unsigned int i = 0; i < listenports.size(); i++)
268 ServerInstance->Config->DelIOHook(listenports[i]);
269 for (size_t j = 0; j < ServerInstance->Config->ports.size(); j++)
270 if (ServerInstance->Config->ports[j]->GetPort() == listenports[i])
271 ServerInstance->Config->ports[j]->SetDescription("plaintext");
276 virtual Version GetVersion()
278 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
281 void Implements(char* List)
283 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
284 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
287 virtual char* OnRequest(Request* request)
289 ISHRequest* ISR = (ISHRequest*)request;
290 if (strcmp("IS_NAME", request->GetId()) == 0)
294 else if (strcmp("IS_HOOK", request->GetId()) == 0)
299 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
301 catch (ModuleException &e)
307 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
309 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
311 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
313 if (ISR->Sock->GetFd() < 0)
316 issl_session* session = &sessions[ISR->Sock->GetFd()];
317 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
319 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
321 if (ISR->Sock->GetFd() > -1)
323 issl_session* session = &sessions[ISR->Sock->GetFd()];
326 if ((Extensible*)ServerInstance->FindDescriptor(ISR->Sock->GetFd()) == (Extensible*)(ISR->Sock))
328 VerifyCertificate(session, (InspSocket*)ISR->Sock);
338 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
340 issl_session* session = &sessions[fd];
343 session->inbuf = new char[inbufsize];
344 session->inbufoffset = 0;
346 gnutls_init(&session->sess, GNUTLS_SERVER);
348 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
349 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
350 gnutls_dh_set_prime_bits(session->sess, dh_bits);
352 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
353 * This needs testing, but it's easy enough to rollback if need be
354 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
355 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
357 * With testing this seems to...not work :/
360 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
362 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
367 virtual void OnRawSocketConnect(int fd)
369 issl_session* session = &sessions[fd];
372 session->inbuf = new char[inbufsize];
373 session->inbufoffset = 0;
375 gnutls_init(&session->sess, GNUTLS_CLIENT);
377 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
378 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
379 gnutls_dh_set_prime_bits(session->sess, dh_bits);
380 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
385 virtual void OnRawSocketClose(int fd)
387 CloseSession(&sessions[fd]);
389 EventHandler* user = ServerInstance->SE->GetRef(fd);
391 if ((user) && (user->GetExt("ssl_cert", dummy)))
394 user->GetExt("ssl_cert", tofree);
396 user->Shrink("ssl_cert");
400 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
402 issl_session* session = &sessions[fd];
407 CloseSession(session);
411 if (session->status == ISSL_HANDSHAKING_READ)
413 // The handshake isn't finished, try to finish it.
415 if(!Handshake(session))
417 // Couldn't resume handshake.
421 else if (session->status == ISSL_HANDSHAKING_WRITE)
427 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
429 if (session->status == ISSL_HANDSHAKEN)
431 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
432 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
433 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
437 // Client closed connection.
439 CloseSession(session);
444 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
452 CloseSession(session);
457 // Read successfully 'ret' bytes into inbuf + inbufoffset
458 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
459 // 'buffer' is 'count' long
461 unsigned int length = ret + session->inbufoffset;
465 memcpy(buffer, session->inbuf, count);
466 // Move the stuff left in inbuf to the beginning of it
467 memcpy(session->inbuf, session->inbuf + count, (length - count));
468 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
469 session->inbufoffset = length - count;
470 // Insp uses readresult as the count of how much data there is in buffer, so:
475 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
476 memcpy(buffer, session->inbuf, length);
477 // Zero the offset, as there's nothing there..
478 session->inbufoffset = 0;
484 else if(session->status == ISSL_CLOSING)
490 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
495 issl_session* session = &sessions[fd];
496 const char* sendbuffer = buffer;
500 CloseSession(session);
504 session->outbuf.append(sendbuffer, count);
505 sendbuffer = session->outbuf.c_str();
506 count = session->outbuf.size();
508 if(session->status == ISSL_HANDSHAKING_WRITE)
510 // The handshake isn't finished, try to finish it.
518 if(session->status == ISSL_HANDSHAKEN)
520 ret = gnutls_record_send(session->sess, sendbuffer, count);
524 CloseSession(session);
528 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
530 CloseSession(session);
540 session->outbuf = session->outbuf.substr(ret);
544 /* Who's smart idea was it to return 1 when we havent written anything?
545 * This fucks the buffer up in InspSocket :p
547 return ret < 1 ? 0 : ret;
550 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
551 virtual void OnWhois(userrec* source, userrec* dest)
556 // Bugfix, only send this numeric for *our* SSL users
557 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
559 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
563 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
565 // check if the linking module wants to know about OUR metadata
568 // check if this user has an swhois field to send
569 if(user->GetExt(extname, dummy))
571 // call this function in the linking module, let it format the data how it
572 // sees fit, and send it on its way. We dont need or want to know how.
573 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, displayable ? "Enabled" : "ON");
578 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
580 // check if its our metadata key, and its associated with a user
581 if ((target_type == TYPE_USER) && (extname == "ssl"))
583 userrec* dest = (userrec*)target;
584 // if they dont already have an ssl flag, accept the remote server's
585 if (!dest->GetExt(extname, dummy))
587 dest->Extend(extname, "ON");
592 bool Handshake(issl_session* session)
594 int ret = gnutls_handshake(session->sess);
598 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
600 // Handshake needs resuming later, read() or write() would have blocked.
602 if(gnutls_record_get_direction(session->sess) == 0)
604 // gnutls_handshake() wants to read() again.
605 session->status = ISSL_HANDSHAKING_READ;
609 // gnutls_handshake() wants to write() again.
610 session->status = ISSL_HANDSHAKING_WRITE;
611 MakePollWrite(session);
617 CloseSession(session);
618 session->status = ISSL_CLOSING;
625 // Handshake complete.
626 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
627 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
630 if (!extendme->GetExt("ssl", dummy))
631 extendme->Extend("ssl", "ON");
634 // Change the seesion state
635 session->status = ISSL_HANDSHAKEN;
637 // Finish writing, if any left
638 MakePollWrite(session);
644 virtual void OnPostConnect(userrec* user)
646 // This occurs AFTER OnUserConnect so we can be sure the
647 // protocol module has propogated the NICK message.
648 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
650 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
651 std::deque<std::string>* metadata = new std::deque<std::string>;
652 metadata->push_back(user->nick);
653 metadata->push_back("ssl"); // The metadata id
654 metadata->push_back("ON"); // The value to send
655 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
656 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
660 VerifyCertificate(&sessions[user->GetFd()],user);
661 if (sessions[user->GetFd()].sess)
663 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
664 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
665 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
666 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick, cipher.c_str());
671 void MakePollWrite(issl_session* session)
673 OnRawSocketWrite(session->fd, NULL, 0);
676 void CloseSession(issl_session* session)
680 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
681 gnutls_deinit(session->sess);
686 delete[] session->inbuf;
689 session->outbuf.clear();
690 session->inbuf = NULL;
691 session->sess = NULL;
692 session->status = ISSL_NONE;
695 void VerifyCertificate(issl_session* session, Extensible* user)
697 if (!session->sess || !user)
701 const gnutls_datum_t* cert_list;
703 unsigned int cert_list_size;
704 gnutls_x509_crt_t cert;
706 unsigned char digest[MAXBUF];
707 size_t digest_size = sizeof(digest);
708 size_t name_size = sizeof(name);
709 ssl_cert* certinfo = new ssl_cert;
711 user->Extend("ssl_cert",certinfo);
713 /* This verification function uses the trusted CAs in the credentials
714 * structure. So you must have installed one or more CA certificates.
716 ret = gnutls_certificate_verify_peers2(session->sess, &status);
720 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
724 if (status & GNUTLS_CERT_INVALID)
726 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
730 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
732 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
734 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
738 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
740 if (status & GNUTLS_CERT_REVOKED)
742 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
746 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
748 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
750 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
754 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
757 /* Up to here the process is the same for X.509 certificates and
758 * OpenPGP keys. From now on X.509 certificates are assumed. This can
759 * be easily extended to work with openpgp keys as well.
761 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
763 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
767 ret = gnutls_x509_crt_init(&cert);
770 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
775 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
776 if (cert_list == NULL)
778 certinfo->data.insert(std::make_pair("error","No certificate was found"));
782 /* This is not a real world example, since we only check the first
783 * certificate in the given chain.
786 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
789 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
793 gnutls_x509_crt_get_dn(cert, name, &name_size);
795 certinfo->data.insert(std::make_pair("dn",name));
797 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
799 certinfo->data.insert(std::make_pair("issuer",name));
801 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
803 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
807 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
810 /* Beware here we do not check for errors.
812 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
814 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
817 gnutls_x509_crt_deinit(cert);
824 class ModuleSSLGnuTLSFactory : public ModuleFactory
827 ModuleSSLGnuTLSFactory()
831 ~ModuleSSLGnuTLSFactory()
835 virtual Module * CreateModule(InspIRCd* Me)
837 return new ModuleSSLGnuTLS(Me);
842 extern "C" DllExport void * init_module( void )
844 return new ModuleSSLGnuTLSFactory;