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"
32 /* $ModDesc: Provides SSL support for clients */
33 /* $CompileFlags: exec("libgnutls-config --cflags") */
34 /* $LinkerFlags: rpath("libgnutls-config --libs") exec("libgnutls-config --libs") */
35 /* $ModDep: transport.h */
38 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
40 bool isin(int port, const std::vector<int> &portlist)
42 for(unsigned int i = 0; i < portlist.size(); i++)
43 if(portlist[i] == port)
49 /** Represents an SSL user's extra data
51 class issl_session : public classbase
54 gnutls_session_t sess;
62 class ModuleSSLGnuTLS : public Module
69 std::vector<int> listenports;
72 issl_session sessions[MAX_DESCRIPTORS];
74 gnutls_certificate_credentials x509_cred;
75 gnutls_dh_params dh_params;
85 ModuleSSLGnuTLS(InspIRCd* Me)
88 ServerInstance->PublishInterface("InspSocketHook", this);
90 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
91 inbufsize = ServerInstance->Config->NetBufferSize;
93 gnutls_global_init(); // This must be called once in the program
95 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
96 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
98 // Guessing return meaning
99 if(gnutls_dh_params_init(&dh_params) < 0)
100 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
102 // Needs the flag as it ignores a plain /rehash
103 OnRehash(NULL,"ssl");
105 // Void return, guess we assume success
106 gnutls_certificate_set_dh_params(x509_cred, dh_params);
109 virtual void OnRehash(userrec* user, const std::string ¶m)
114 Conf = new ConfigReader(ServerInstance);
116 for(unsigned int i = 0; i < listenports.size(); i++)
118 ServerInstance->Config->DelIOHook(listenports[i]);
123 for(int i = 0; i < Conf->Enumerate("bind"); i++)
125 // For each <bind> tag
126 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
128 // Get the port we're meant to be listening on with SSL
129 std::string port = Conf->ReadValue("bind", "port", i);
130 irc::portparser portrange(port, false);
132 while ((portno = portrange.GetToken()))
136 if (ServerInstance->Config->AddIOHook(portno, this))
138 listenports.push_back(portno);
139 for (unsigned int i = 0; i < ServerInstance->stats->BoundPortCount; i++)
140 if (ServerInstance->Config->ports[i] == portno)
141 ServerInstance->Config->openSockfd[i]->SetDescription("ssl");
142 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
146 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
149 catch (ModuleException &e)
151 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());
157 std::string confdir(CONFIG_FILE);
158 // +1 so we the path ends with a /
159 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
161 cafile = Conf->ReadValue("gnutls", "cafile", 0);
162 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
163 certfile = Conf->ReadValue("gnutls", "certfile", 0);
164 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
165 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
167 // Set all the default values needed.
175 certfile = "cert.pem";
180 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
183 // Prepend relative paths with the path to the config directory.
185 cafile = confdir + cafile;
187 if(crlfile[0] != '/')
188 crlfile = confdir + crlfile;
190 if(certfile[0] != '/')
191 certfile = confdir + certfile;
193 if(keyfile[0] != '/')
194 keyfile = confdir + keyfile;
198 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
199 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
201 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
202 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
204 // Guessing on the return value of this, manual doesn't say :|
205 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
206 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));
208 // This may be on a large (once a day or week) timer eventually.
214 void GenerateDHParams()
216 // Generate Diffie Hellman parameters - for use with DHE
217 // kx algorithms. These should be discarded and regenerated
218 // once a day, once a week or once a month. Depending on the
219 // security requirements.
223 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
224 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
227 virtual ~ModuleSSLGnuTLS()
229 gnutls_dh_params_deinit(dh_params);
230 gnutls_certificate_free_credentials(x509_cred);
231 gnutls_global_deinit();
234 virtual void OnCleanup(int target_type, void* item)
236 if(target_type == TYPE_USER)
238 userrec* user = (userrec*)item;
240 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
242 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
243 // Potentially there could be multiple SSL modules loaded at once on different ports.
244 ServerInstance->GlobalCulls.AddItem(user, "SSL module unloading");
246 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
249 user->GetExt("ssl_cert", tofree);
251 user->Shrink("ssl_cert");
256 virtual void OnUnloadModule(Module* mod, const std::string &name)
260 for(unsigned int i = 0; i < listenports.size(); i++)
262 ServerInstance->Config->DelIOHook(listenports[i]);
263 for (unsigned int j = 0; j < ServerInstance->stats->BoundPortCount; j++)
264 if (ServerInstance->Config->ports[j] == listenports[i])
265 if (ServerInstance->Config->openSockfd[j])
266 ServerInstance->Config->openSockfd[j]->SetDescription("plaintext");
271 virtual Version GetVersion()
273 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
276 void Implements(char* List)
278 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
279 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
282 virtual char* OnRequest(Request* request)
284 ISHRequest* ISR = (ISHRequest*)request;
285 if (strcmp("IS_NAME", request->GetId()) == 0)
289 else if (strcmp("IS_HOOK", request->GetId()) == 0)
294 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
296 catch (ModuleException &e)
302 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
304 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
306 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
308 issl_session* session = &sessions[ISR->Sock->GetFd()];
309 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
311 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
313 if (ISR->Sock->GetFd() > -1)
315 issl_session* session = &sessions[ISR->Sock->GetFd()];
318 if ((Extensible*)ServerInstance->FindDescriptor(ISR->Sock->GetFd()) == (Extensible*)(ISR->Sock))
320 VerifyCertificate(session, (InspSocket*)ISR->Sock);
330 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
332 issl_session* session = &sessions[fd];
335 session->inbuf = new char[inbufsize];
336 session->inbufoffset = 0;
338 gnutls_init(&session->sess, GNUTLS_SERVER);
340 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
341 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
342 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
343 gnutls_dh_set_prime_bits(session->sess, dh_bits);
345 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
346 * This needs testing, but it's easy enough to rollback if need be
347 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
348 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
350 * With testing this seems to...not work :/
353 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
358 virtual void OnRawSocketConnect(int fd)
360 issl_session* session = &sessions[fd];
363 session->inbuf = new char[inbufsize];
364 session->inbufoffset = 0;
366 gnutls_init(&session->sess, GNUTLS_CLIENT);
368 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
369 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
370 //TODO: Request server cert here.
371 //gnutls_certificate_request(session->sess, GNUTLS_CERT_REQUEST); // Request server certificate if any.
372 gnutls_dh_set_prime_bits(session->sess, dh_bits);
374 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
379 virtual void OnRawSocketClose(int fd)
381 CloseSession(&sessions[fd]);
383 EventHandler* user = ServerInstance->SE->GetRef(fd);
385 if ((user) && (user->GetExt("ssl_cert", dummy)))
388 user->GetExt("ssl_cert", tofree);
390 user->Shrink("ssl_cert");
394 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
396 issl_session* session = &sessions[fd];
401 CloseSession(session);
405 if (session->status == ISSL_HANDSHAKING_READ)
407 // The handshake isn't finished, try to finish it.
409 if(!Handshake(session))
411 // Couldn't resume handshake.
415 else if (session->status == ISSL_HANDSHAKING_WRITE)
420 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
422 if (session->status == ISSL_HANDSHAKEN)
424 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
425 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
426 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
430 // Client closed connection.
432 CloseSession(session);
437 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
442 CloseSession(session);
447 // Read successfully 'ret' bytes into inbuf + inbufoffset
448 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
449 // 'buffer' is 'count' long
451 unsigned int length = ret + session->inbufoffset;
455 memcpy(buffer, session->inbuf, count);
456 // Move the stuff left in inbuf to the beginning of it
457 memcpy(session->inbuf, session->inbuf + count, (length - count));
458 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
459 session->inbufoffset = length - count;
460 // Insp uses readresult as the count of how much data there is in buffer, so:
465 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
466 memcpy(buffer, session->inbuf, length);
467 // Zero the offset, as there's nothing there..
468 session->inbufoffset = 0;
474 else if(session->status == ISSL_CLOSING)
480 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
485 issl_session* session = &sessions[fd];
486 const char* sendbuffer = buffer;
490 CloseSession(session);
494 session->outbuf.append(sendbuffer, count);
495 sendbuffer = session->outbuf.c_str();
496 count = session->outbuf.size();
498 if(session->status == ISSL_HANDSHAKING_WRITE)
500 // The handshake isn't finished, try to finish it.
508 if(session->status == ISSL_HANDSHAKEN)
510 ret = gnutls_record_send(session->sess, sendbuffer, count);
513 CloseSession(session);
516 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
517 CloseSession(session);
521 session->outbuf = session->outbuf.substr(ret);
525 /* Who's smart idea was it to return 1 when we havent written anything?
526 * This fucks the buffer up in InspSocket :p
528 return ret < 1 ? 0 : ret;
531 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
532 virtual void OnWhois(userrec* source, userrec* dest)
534 // Bugfix, only send this numeric for *our* SSL users
535 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
537 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
541 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
543 // check if the linking module wants to know about OUR metadata
546 // check if this user has an swhois field to send
547 if(user->GetExt(extname, dummy))
549 // call this function in the linking module, let it format the data how it
550 // sees fit, and send it on its way. We dont need or want to know how.
551 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
556 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
558 // check if its our metadata key, and its associated with a user
559 if ((target_type == TYPE_USER) && (extname == "ssl"))
561 userrec* dest = (userrec*)target;
562 // if they dont already have an ssl flag, accept the remote server's
563 if (!dest->GetExt(extname, dummy))
565 dest->Extend(extname, "ON");
570 bool Handshake(issl_session* session)
572 int ret = gnutls_handshake(session->sess);
576 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
578 // Handshake needs resuming later, read() or write() would have blocked.
580 if(gnutls_record_get_direction(session->sess) == 0)
582 // gnutls_handshake() wants to read() again.
583 session->status = ISSL_HANDSHAKING_READ;
587 // gnutls_handshake() wants to write() again.
588 session->status = ISSL_HANDSHAKING_WRITE;
589 MakePollWrite(session);
595 CloseSession(session);
596 session->status = ISSL_CLOSING;
603 // Handshake complete.
604 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
605 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
608 if (!extendme->GetExt("ssl", dummy))
609 extendme->Extend("ssl", "ON");
612 // Change the seesion state
613 session->status = ISSL_HANDSHAKEN;
615 // Finish writing, if any left
616 MakePollWrite(session);
622 virtual void OnPostConnect(userrec* user)
624 // This occurs AFTER OnUserConnect so we can be sure the
625 // protocol module has propogated the NICK message.
626 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
628 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
629 std::deque<std::string>* metadata = new std::deque<std::string>;
630 metadata->push_back(user->nick);
631 metadata->push_back("ssl"); // The metadata id
632 metadata->push_back("ON"); // The value to send
633 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
634 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
638 VerifyCertificate(&sessions[user->GetFd()],user);
642 void MakePollWrite(issl_session* session)
644 OnRawSocketWrite(session->fd, NULL, 0);
647 void CloseSession(issl_session* session)
651 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
652 gnutls_deinit(session->sess);
657 delete[] session->inbuf;
660 session->outbuf.clear();
661 session->inbuf = NULL;
662 session->sess = NULL;
663 session->status = ISSL_NONE;
666 void VerifyCertificate(issl_session* session, Extensible* user)
669 const gnutls_datum_t* cert_list;
671 unsigned int cert_list_size;
672 gnutls_x509_crt_t cert;
674 unsigned char digest[MAXBUF];
675 size_t digest_size = sizeof(digest);
676 size_t name_size = sizeof(name);
677 ssl_cert* certinfo = new ssl_cert;
679 user->Extend("ssl_cert",certinfo);
681 /* This verification function uses the trusted CAs in the credentials
682 * structure. So you must have installed one or more CA certificates.
684 ret = gnutls_certificate_verify_peers2(session->sess, &status);
688 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
692 if (status & GNUTLS_CERT_INVALID)
694 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
698 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
700 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
702 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
706 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
708 if (status & GNUTLS_CERT_REVOKED)
710 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
714 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
716 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
718 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
722 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
725 /* Up to here the process is the same for X.509 certificates and
726 * OpenPGP keys. From now on X.509 certificates are assumed. This can
727 * be easily extended to work with openpgp keys as well.
729 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
731 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
735 ret = gnutls_x509_crt_init(&cert);
738 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
743 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
744 if (cert_list == NULL)
746 certinfo->data.insert(std::make_pair("error","No certificate was found"));
750 /* This is not a real world example, since we only check the first
751 * certificate in the given chain.
754 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
757 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
761 gnutls_x509_crt_get_dn(cert, name, &name_size);
763 certinfo->data.insert(std::make_pair("dn",name));
765 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
767 certinfo->data.insert(std::make_pair("issuer",name));
769 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
771 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
775 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
778 /* Beware here we do not check for errors.
780 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
782 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
785 gnutls_x509_crt_deinit(cert);
792 class ModuleSSLGnuTLSFactory : public ModuleFactory
795 ModuleSSLGnuTLSFactory()
799 ~ModuleSSLGnuTLSFactory()
803 virtual Module * CreateModule(InspIRCd* Me)
805 return new ModuleSSLGnuTLS(Me);
810 extern "C" void * init_module( void )
812 return new ModuleSSLGnuTLSFactory;