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 * ---------------------------------------------------
17 #include <gnutls/gnutls.h>
18 #include <gnutls/x509.h>
20 #include "inspircd_config.h"
21 #include "configreader.h"
30 #include "transport.h"
33 #pragma comment(lib, "libgnutls-13.lib")
34 #undef MAX_DESCRIPTORS
35 #define MAX_DESCRIPTORS 10000
38 /* $ModDesc: Provides SSL support for clients */
39 /* $CompileFlags: exec("libgnutls-config --cflags") */
40 /* $LinkerFlags: rpath("libgnutls-config --libs") exec("libgnutls-config --libs") */
41 /* $ModDep: transport.h */
44 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
46 bool isin(int port, const std::vector<int> &portlist)
48 for(unsigned int i = 0; i < portlist.size(); i++)
49 if(portlist[i] == port)
55 /** Represents an SSL user's extra data
57 class issl_session : public classbase
60 gnutls_session_t sess;
68 class ModuleSSLGnuTLS : public Module
75 std::vector<int> listenports;
78 issl_session sessions[MAX_DESCRIPTORS];
80 gnutls_certificate_credentials x509_cred;
81 gnutls_dh_params dh_params;
93 ModuleSSLGnuTLS(InspIRCd* Me)
96 ServerInstance->PublishInterface("InspSocketHook", this);
98 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
99 inbufsize = ServerInstance->Config->NetBufferSize;
101 gnutls_global_init(); // This must be called once in the program
103 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
104 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
106 // Guessing return meaning
107 if(gnutls_dh_params_init(&dh_params) < 0)
108 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
110 // Needs the flag as it ignores a plain /rehash
111 OnRehash(NULL,"ssl");
113 // Void return, guess we assume success
114 gnutls_certificate_set_dh_params(x509_cred, dh_params);
117 virtual void OnRehash(userrec* user, const std::string ¶m)
122 Conf = new ConfigReader(ServerInstance);
124 for(unsigned int i = 0; i < listenports.size(); i++)
126 ServerInstance->Config->DelIOHook(listenports[i]);
132 for(int i = 0; i < Conf->Enumerate("bind"); i++)
134 // For each <bind> tag
135 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
137 // Get the port we're meant to be listening on with SSL
138 std::string port = Conf->ReadValue("bind", "port", i);
139 irc::portparser portrange(port, false);
141 while ((portno = portrange.GetToken()))
146 if (ServerInstance->Config->AddIOHook(portno, this))
148 listenports.push_back(portno);
149 for (size_t i = 0; i < ServerInstance->Config->ports.size(); i++)
150 if (ServerInstance->Config->ports[i]->GetPort() == portno)
151 ServerInstance->Config->ports[i]->SetDescription("ssl");
152 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
156 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
159 catch (ModuleException &e)
161 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());
167 std::string confdir(ServerInstance->ConfigFileName);
168 // +1 so we the path ends with a /
169 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
171 cafile = Conf->ReadValue("gnutls", "cafile", 0);
172 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
173 certfile = Conf->ReadValue("gnutls", "certfile", 0);
174 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
175 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
177 // Set all the default values needed.
185 certfile = "cert.pem";
190 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
193 // Prepend relative paths with the path to the config directory.
195 cafile = confdir + cafile;
197 if(crlfile[0] != '/')
198 crlfile = confdir + crlfile;
200 if(certfile[0] != '/')
201 certfile = confdir + certfile;
203 if(keyfile[0] != '/')
204 keyfile = confdir + keyfile;
208 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
209 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
211 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
212 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
214 // Guessing on the return value of this, manual doesn't say :|
215 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
216 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));
218 // This may be on a large (once a day or week) timer eventually.
224 void GenerateDHParams()
226 // Generate Diffie Hellman parameters - for use with DHE
227 // kx algorithms. These should be discarded and regenerated
228 // once a day, once a week or once a month. Depending on the
229 // security requirements.
233 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
234 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
237 virtual ~ModuleSSLGnuTLS()
239 gnutls_dh_params_deinit(dh_params);
240 gnutls_certificate_free_credentials(x509_cred);
241 gnutls_global_deinit();
244 virtual void OnCleanup(int target_type, void* item)
246 if(target_type == TYPE_USER)
248 userrec* user = (userrec*)item;
250 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
252 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
253 // Potentially there could be multiple SSL modules loaded at once on different ports.
254 ServerInstance->GlobalCulls.AddItem(user, "SSL module unloading");
256 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
259 user->GetExt("ssl_cert", tofree);
261 user->Shrink("ssl_cert");
266 virtual void OnUnloadModule(Module* mod, const std::string &name)
270 for(unsigned int i = 0; i < listenports.size(); i++)
272 ServerInstance->Config->DelIOHook(listenports[i]);
273 for (size_t j = 0; j < ServerInstance->Config->ports.size(); j++)
274 if (ServerInstance->Config->ports[j]->GetPort() == listenports[i])
275 ServerInstance->Config->ports[j]->SetDescription("plaintext");
280 virtual Version GetVersion()
282 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
285 void Implements(char* List)
287 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
288 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
291 virtual char* OnRequest(Request* request)
293 ISHRequest* ISR = (ISHRequest*)request;
294 if (strcmp("IS_NAME", request->GetId()) == 0)
298 else if (strcmp("IS_HOOK", request->GetId()) == 0)
303 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
305 catch (ModuleException &e)
311 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
313 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
315 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
317 if (ISR->Sock->GetFd() < 0)
320 issl_session* session = &sessions[ISR->Sock->GetFd()];
321 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
323 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
325 if (ISR->Sock->GetFd() > -1)
327 issl_session* session = &sessions[ISR->Sock->GetFd()];
330 if ((Extensible*)ServerInstance->FindDescriptor(ISR->Sock->GetFd()) == (Extensible*)(ISR->Sock))
332 VerifyCertificate(session, (InspSocket*)ISR->Sock);
342 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
344 issl_session* session = &sessions[fd];
347 session->inbuf = new char[inbufsize];
348 session->inbufoffset = 0;
350 gnutls_init(&session->sess, GNUTLS_SERVER);
352 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
353 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
354 gnutls_dh_set_prime_bits(session->sess, dh_bits);
356 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
357 * This needs testing, but it's easy enough to rollback if need be
358 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
359 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
361 * With testing this seems to...not work :/
364 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
366 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
371 virtual void OnRawSocketConnect(int fd)
373 issl_session* session = &sessions[fd];
376 session->inbuf = new char[inbufsize];
377 session->inbufoffset = 0;
379 gnutls_init(&session->sess, GNUTLS_CLIENT);
381 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
382 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
383 gnutls_dh_set_prime_bits(session->sess, dh_bits);
384 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
389 virtual void OnRawSocketClose(int fd)
391 CloseSession(&sessions[fd]);
393 EventHandler* user = ServerInstance->SE->GetRef(fd);
395 if ((user) && (user->GetExt("ssl_cert", dummy)))
398 user->GetExt("ssl_cert", tofree);
400 user->Shrink("ssl_cert");
404 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
406 issl_session* session = &sessions[fd];
411 CloseSession(session);
415 if (session->status == ISSL_HANDSHAKING_READ)
417 // The handshake isn't finished, try to finish it.
419 if(!Handshake(session))
421 // Couldn't resume handshake.
425 else if (session->status == ISSL_HANDSHAKING_WRITE)
431 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
433 if (session->status == ISSL_HANDSHAKEN)
435 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
436 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
437 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
441 // Client closed connection.
443 CloseSession(session);
448 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
456 CloseSession(session);
461 // Read successfully 'ret' bytes into inbuf + inbufoffset
462 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
463 // 'buffer' is 'count' long
465 unsigned int length = ret + session->inbufoffset;
469 memcpy(buffer, session->inbuf, count);
470 // Move the stuff left in inbuf to the beginning of it
471 memcpy(session->inbuf, session->inbuf + count, (length - count));
472 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
473 session->inbufoffset = length - count;
474 // Insp uses readresult as the count of how much data there is in buffer, so:
479 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
480 memcpy(buffer, session->inbuf, length);
481 // Zero the offset, as there's nothing there..
482 session->inbufoffset = 0;
488 else if(session->status == ISSL_CLOSING)
494 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
499 issl_session* session = &sessions[fd];
500 const char* sendbuffer = buffer;
504 CloseSession(session);
508 session->outbuf.append(sendbuffer, count);
509 sendbuffer = session->outbuf.c_str();
510 count = session->outbuf.size();
512 if(session->status == ISSL_HANDSHAKING_WRITE)
514 // The handshake isn't finished, try to finish it.
522 if(session->status == ISSL_HANDSHAKEN)
524 ret = gnutls_record_send(session->sess, sendbuffer, count);
528 CloseSession(session);
532 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
534 CloseSession(session);
544 session->outbuf = session->outbuf.substr(ret);
548 /* Who's smart idea was it to return 1 when we havent written anything?
549 * This fucks the buffer up in InspSocket :p
551 return ret < 1 ? 0 : ret;
554 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
555 virtual void OnWhois(userrec* source, userrec* dest)
560 // Bugfix, only send this numeric for *our* SSL users
561 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
563 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
567 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
569 // check if the linking module wants to know about OUR metadata
572 // check if this user has an swhois field to send
573 if(user->GetExt(extname, dummy))
575 // call this function in the linking module, let it format the data how it
576 // sees fit, and send it on its way. We dont need or want to know how.
577 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, displayable ? "Enabled" : "ON");
582 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
584 // check if its our metadata key, and its associated with a user
585 if ((target_type == TYPE_USER) && (extname == "ssl"))
587 userrec* dest = (userrec*)target;
588 // if they dont already have an ssl flag, accept the remote server's
589 if (!dest->GetExt(extname, dummy))
591 dest->Extend(extname, "ON");
596 bool Handshake(issl_session* session)
598 int ret = gnutls_handshake(session->sess);
602 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
604 // Handshake needs resuming later, read() or write() would have blocked.
606 if(gnutls_record_get_direction(session->sess) == 0)
608 // gnutls_handshake() wants to read() again.
609 session->status = ISSL_HANDSHAKING_READ;
613 // gnutls_handshake() wants to write() again.
614 session->status = ISSL_HANDSHAKING_WRITE;
615 MakePollWrite(session);
621 CloseSession(session);
622 session->status = ISSL_CLOSING;
629 // Handshake complete.
630 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
631 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
634 if (!extendme->GetExt("ssl", dummy))
635 extendme->Extend("ssl", "ON");
638 // Change the seesion state
639 session->status = ISSL_HANDSHAKEN;
641 // Finish writing, if any left
642 MakePollWrite(session);
648 virtual void OnPostConnect(userrec* user)
650 // This occurs AFTER OnUserConnect so we can be sure the
651 // protocol module has propogated the NICK message.
652 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
654 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
655 std::deque<std::string>* metadata = new std::deque<std::string>;
656 metadata->push_back(user->nick);
657 metadata->push_back("ssl"); // The metadata id
658 metadata->push_back("ON"); // The value to send
659 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
660 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
664 VerifyCertificate(&sessions[user->GetFd()],user);
665 if (sessions[user->GetFd()].sess)
667 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
668 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
669 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
670 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick, cipher.c_str());
675 void MakePollWrite(issl_session* session)
677 OnRawSocketWrite(session->fd, NULL, 0);
680 void CloseSession(issl_session* session)
684 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
685 gnutls_deinit(session->sess);
690 delete[] session->inbuf;
693 session->outbuf.clear();
694 session->inbuf = NULL;
695 session->sess = NULL;
696 session->status = ISSL_NONE;
699 void VerifyCertificate(issl_session* session, Extensible* user)
701 if (!session->sess || !user)
705 const gnutls_datum_t* cert_list;
707 unsigned int cert_list_size;
708 gnutls_x509_crt_t cert;
710 unsigned char digest[MAXBUF];
711 size_t digest_size = sizeof(digest);
712 size_t name_size = sizeof(name);
713 ssl_cert* certinfo = new ssl_cert;
715 user->Extend("ssl_cert",certinfo);
717 /* This verification function uses the trusted CAs in the credentials
718 * structure. So you must have installed one or more CA certificates.
720 ret = gnutls_certificate_verify_peers2(session->sess, &status);
724 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
728 if (status & GNUTLS_CERT_INVALID)
730 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
734 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
736 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
738 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
742 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
744 if (status & GNUTLS_CERT_REVOKED)
746 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
750 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
752 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
754 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
758 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
761 /* Up to here the process is the same for X.509 certificates and
762 * OpenPGP keys. From now on X.509 certificates are assumed. This can
763 * be easily extended to work with openpgp keys as well.
765 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
767 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
771 ret = gnutls_x509_crt_init(&cert);
774 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
779 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
780 if (cert_list == NULL)
782 certinfo->data.insert(std::make_pair("error","No certificate was found"));
786 /* This is not a real world example, since we only check the first
787 * certificate in the given chain.
790 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
793 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
797 gnutls_x509_crt_get_dn(cert, name, &name_size);
799 certinfo->data.insert(std::make_pair("dn",name));
801 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
803 certinfo->data.insert(std::make_pair("issuer",name));
805 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
807 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
811 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
814 /* Beware here we do not check for errors.
816 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
818 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
821 gnutls_x509_crt_deinit(cert);
828 class ModuleSSLGnuTLSFactory : public ModuleFactory
831 ModuleSSLGnuTLSFactory()
835 ~ModuleSSLGnuTLSFactory()
839 virtual Module * CreateModule(InspIRCd* Me)
841 return new ModuleSSLGnuTLS(Me);
846 extern "C" DllExport void * init_module( void )
848 return new ModuleSSLGnuTLSFactory;