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;
87 ModuleSSLGnuTLS(InspIRCd* Me)
90 ServerInstance->PublishInterface("InspSocketHook", this);
92 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
93 inbufsize = ServerInstance->Config->NetBufferSize;
95 gnutls_global_init(); // This must be called once in the program
97 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
98 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
100 // Guessing return meaning
101 if(gnutls_dh_params_init(&dh_params) < 0)
102 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
104 // Needs the flag as it ignores a plain /rehash
105 OnRehash(NULL,"ssl");
107 // Void return, guess we assume success
108 gnutls_certificate_set_dh_params(x509_cred, dh_params);
111 virtual void OnRehash(userrec* user, const std::string ¶m)
116 Conf = new ConfigReader(ServerInstance);
118 for(unsigned int i = 0; i < listenports.size(); i++)
120 ServerInstance->Config->DelIOHook(listenports[i]);
126 for(int i = 0; i < Conf->Enumerate("bind"); i++)
128 // For each <bind> tag
129 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
131 // Get the port we're meant to be listening on with SSL
132 std::string port = Conf->ReadValue("bind", "port", i);
133 irc::portparser portrange(port, false);
135 while ((portno = portrange.GetToken()))
140 if (ServerInstance->Config->AddIOHook(portno, this))
142 listenports.push_back(portno);
143 for (unsigned int i = 0; i < ServerInstance->stats->BoundPortCount; i++)
144 if (ServerInstance->Config->ports[i] == portno)
145 ServerInstance->Config->openSockfd[i]->SetDescription("ssl");
146 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
150 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
153 catch (ModuleException &e)
155 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());
161 std::string confdir(CONFIG_FILE);
162 // +1 so we the path ends with a /
163 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
165 cafile = Conf->ReadValue("gnutls", "cafile", 0);
166 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
167 certfile = Conf->ReadValue("gnutls", "certfile", 0);
168 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
169 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
171 // Set all the default values needed.
179 certfile = "cert.pem";
184 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
187 // Prepend relative paths with the path to the config directory.
189 cafile = confdir + cafile;
191 if(crlfile[0] != '/')
192 crlfile = confdir + crlfile;
194 if(certfile[0] != '/')
195 certfile = confdir + certfile;
197 if(keyfile[0] != '/')
198 keyfile = confdir + keyfile;
202 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
203 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
205 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
206 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
208 // Guessing on the return value of this, manual doesn't say :|
209 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
210 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));
212 // This may be on a large (once a day or week) timer eventually.
218 void GenerateDHParams()
220 // Generate Diffie Hellman parameters - for use with DHE
221 // kx algorithms. These should be discarded and regenerated
222 // once a day, once a week or once a month. Depending on the
223 // security requirements.
227 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
228 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
231 virtual ~ModuleSSLGnuTLS()
233 gnutls_dh_params_deinit(dh_params);
234 gnutls_certificate_free_credentials(x509_cred);
235 gnutls_global_deinit();
238 virtual void OnCleanup(int target_type, void* item)
240 if(target_type == TYPE_USER)
242 userrec* user = (userrec*)item;
244 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
246 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
247 // Potentially there could be multiple SSL modules loaded at once on different ports.
248 ServerInstance->GlobalCulls.AddItem(user, "SSL module unloading");
250 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
253 user->GetExt("ssl_cert", tofree);
255 user->Shrink("ssl_cert");
260 virtual void OnUnloadModule(Module* mod, const std::string &name)
264 for(unsigned int i = 0; i < listenports.size(); i++)
266 ServerInstance->Config->DelIOHook(listenports[i]);
267 for (unsigned int j = 0; j < ServerInstance->stats->BoundPortCount; j++)
268 if (ServerInstance->Config->ports[j] == listenports[i])
269 if (ServerInstance->Config->openSockfd[j])
270 ServerInstance->Config->openSockfd[j]->SetDescription("plaintext");
275 virtual Version GetVersion()
277 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
280 void Implements(char* List)
282 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
283 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
286 virtual char* OnRequest(Request* request)
288 ISHRequest* ISR = (ISHRequest*)request;
289 if (strcmp("IS_NAME", request->GetId()) == 0)
293 else if (strcmp("IS_HOOK", request->GetId()) == 0)
298 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
300 catch (ModuleException &e)
306 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
308 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
310 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
312 if (ISR->Sock->GetFd() < 0)
315 issl_session* session = &sessions[ISR->Sock->GetFd()];
316 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
318 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
320 if (ISR->Sock->GetFd() > -1)
322 issl_session* session = &sessions[ISR->Sock->GetFd()];
325 if ((Extensible*)ServerInstance->FindDescriptor(ISR->Sock->GetFd()) == (Extensible*)(ISR->Sock))
327 VerifyCertificate(session, (InspSocket*)ISR->Sock);
337 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
339 issl_session* session = &sessions[fd];
342 session->inbuf = new char[inbufsize];
343 session->inbufoffset = 0;
345 gnutls_init(&session->sess, GNUTLS_SERVER);
347 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
348 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
349 gnutls_dh_set_prime_bits(session->sess, dh_bits);
351 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
352 * This needs testing, but it's easy enough to rollback if need be
353 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
354 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
356 * With testing this seems to...not work :/
359 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
361 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
366 virtual void OnRawSocketConnect(int fd)
368 issl_session* session = &sessions[fd];
371 session->inbuf = new char[inbufsize];
372 session->inbufoffset = 0;
374 gnutls_init(&session->sess, GNUTLS_CLIENT);
376 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
377 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
378 gnutls_dh_set_prime_bits(session->sess, dh_bits);
379 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
384 virtual void OnRawSocketClose(int fd)
386 ServerInstance->Log(DEBUG,"Close 3");
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 ServerInstance->Log(DEBUG,"Close 4");
408 CloseSession(session);
412 if (session->status == ISSL_HANDSHAKING_READ)
414 // The handshake isn't finished, try to finish it.
416 if(!Handshake(session))
418 // Couldn't resume handshake.
422 else if (session->status == ISSL_HANDSHAKING_WRITE)
428 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
430 if (session->status == ISSL_HANDSHAKEN)
432 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
433 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
434 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
438 // Client closed connection.
440 ServerInstance->Log(DEBUG,"Close 5");
441 CloseSession(session);
446 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
454 ServerInstance->Log(DEBUG,"Close 6");
455 CloseSession(session);
460 // Read successfully 'ret' bytes into inbuf + inbufoffset
461 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
462 // 'buffer' is 'count' long
464 unsigned int length = ret + session->inbufoffset;
468 memcpy(buffer, session->inbuf, count);
469 // Move the stuff left in inbuf to the beginning of it
470 memcpy(session->inbuf, session->inbuf + count, (length - count));
471 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
472 session->inbufoffset = length - count;
473 // Insp uses readresult as the count of how much data there is in buffer, so:
478 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
479 memcpy(buffer, session->inbuf, length);
480 // Zero the offset, as there's nothing there..
481 session->inbufoffset = 0;
487 else if(session->status == ISSL_CLOSING)
493 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
498 issl_session* session = &sessions[fd];
499 const char* sendbuffer = buffer;
503 ServerInstance->Log(DEBUG,"Close 7");
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 ServerInstance->Log(DEBUG,"Close 1");
529 CloseSession(session);
533 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
535 ServerInstance->Log(DEBUG,"Close 7");
536 CloseSession(session);
546 session->outbuf = session->outbuf.substr(ret);
550 /* Who's smart idea was it to return 1 when we havent written anything?
551 * This fucks the buffer up in InspSocket :p
553 return ret < 1 ? 0 : ret;
556 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
557 virtual void OnWhois(userrec* source, userrec* dest)
562 // Bugfix, only send this numeric for *our* SSL users
563 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
565 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
569 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
571 // check if the linking module wants to know about OUR metadata
574 // check if this user has an swhois field to send
575 if(user->GetExt(extname, dummy))
577 // call this function in the linking module, let it format the data how it
578 // sees fit, and send it on its way. We dont need or want to know how.
579 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
584 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
586 // check if its our metadata key, and its associated with a user
587 if ((target_type == TYPE_USER) && (extname == "ssl"))
589 userrec* dest = (userrec*)target;
590 // if they dont already have an ssl flag, accept the remote server's
591 if (!dest->GetExt(extname, dummy))
593 dest->Extend(extname, "ON");
598 bool Handshake(issl_session* session)
600 int ret = gnutls_handshake(session->sess);
604 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
606 // Handshake needs resuming later, read() or write() would have blocked.
608 if(gnutls_record_get_direction(session->sess) == 0)
610 // gnutls_handshake() wants to read() again.
611 session->status = ISSL_HANDSHAKING_READ;
615 // gnutls_handshake() wants to write() again.
616 session->status = ISSL_HANDSHAKING_WRITE;
617 MakePollWrite(session);
623 ServerInstance->Log(DEBUG,"Close 2");
624 CloseSession(session);
625 session->status = ISSL_CLOSING;
632 // Handshake complete.
633 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
634 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
637 if (!extendme->GetExt("ssl", dummy))
638 extendme->Extend("ssl", "ON");
641 // Change the seesion state
642 session->status = ISSL_HANDSHAKEN;
644 // Finish writing, if any left
645 MakePollWrite(session);
651 virtual void OnPostConnect(userrec* user)
653 // This occurs AFTER OnUserConnect so we can be sure the
654 // protocol module has propogated the NICK message.
655 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
657 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
658 std::deque<std::string>* metadata = new std::deque<std::string>;
659 metadata->push_back(user->nick);
660 metadata->push_back("ssl"); // The metadata id
661 metadata->push_back("ON"); // The value to send
662 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
663 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
667 VerifyCertificate(&sessions[user->GetFd()],user);
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" void * init_module( void )
844 return new ModuleSSLGnuTLSFactory;