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
71 std::vector<int> listenports;
74 issl_session sessions[MAX_DESCRIPTORS];
76 gnutls_certificate_credentials x509_cred;
77 gnutls_dh_params dh_params;
87 ModuleSSLGnuTLS(InspIRCd* Me)
92 culllist = new CullList(ServerInstance);
94 ServerInstance->PublishInterface("InspSocketHook", this);
96 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
97 inbufsize = ServerInstance->Config->NetBufferSize;
99 gnutls_global_init(); // This must be called once in the program
101 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
102 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
104 // Guessing return meaning
105 if(gnutls_dh_params_init(&dh_params) < 0)
106 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
108 // Needs the flag as it ignores a plain /rehash
109 OnRehash(NULL,"ssl");
111 // Void return, guess we assume success
112 gnutls_certificate_set_dh_params(x509_cred, dh_params);
115 virtual void OnRehash(userrec* user, const std::string ¶m)
120 Conf = new ConfigReader(ServerInstance);
122 for(unsigned int i = 0; i < listenports.size(); i++)
124 ServerInstance->Config->DelIOHook(listenports[i]);
129 for(int i = 0; i < Conf->Enumerate("bind"); i++)
131 // For each <bind> tag
132 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
134 // Get the port we're meant to be listening on with SSL
135 std::string port = Conf->ReadValue("bind", "port", i);
136 irc::portparser portrange(port, false);
138 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);
156 std::string confdir(CONFIG_FILE);
157 // +1 so we the path ends with a /
158 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
160 cafile = Conf->ReadValue("gnutls", "cafile", 0);
161 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
162 certfile = Conf->ReadValue("gnutls", "certfile", 0);
163 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
164 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
166 // Set all the default values needed.
174 certfile = "cert.pem";
179 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
182 // Prepend relative paths with the path to the config directory.
184 cafile = confdir + cafile;
186 if(crlfile[0] != '/')
187 crlfile = confdir + crlfile;
189 if(certfile[0] != '/')
190 certfile = confdir + certfile;
192 if(keyfile[0] != '/')
193 keyfile = confdir + keyfile;
195 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
196 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
198 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
199 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
201 // Guessing on the return value of this, manual doesn't say :|
202 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
203 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());
205 // This may be on a large (once a day or week) timer eventually.
211 void GenerateDHParams()
213 // Generate Diffie Hellman parameters - for use with DHE
214 // kx algorithms. These should be discarded and regenerated
215 // once a day, once a week or once a month. Depending on the
216 // security requirements.
218 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
219 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
222 virtual ~ModuleSSLGnuTLS()
224 gnutls_dh_params_deinit(dh_params);
225 gnutls_certificate_free_credentials(x509_cred);
226 gnutls_global_deinit();
230 virtual void OnCleanup(int target_type, void* item)
232 if(target_type == TYPE_USER)
234 userrec* user = (userrec*)item;
236 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
238 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
239 // Potentially there could be multiple SSL modules loaded at once on different ports.
240 culllist->AddItem(user, "SSL module unloading");
242 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
245 user->GetExt("ssl_cert", tofree);
247 user->Shrink("ssl_cert");
252 virtual void OnUnloadModule(Module* mod, const std::string &name)
256 // We're being unloaded, kill all the users added to the cull list in OnCleanup
259 for(unsigned int i = 0; i < listenports.size(); i++)
261 ServerInstance->Config->DelIOHook(listenports[i]);
262 for (unsigned int j = 0; j < ServerInstance->stats->BoundPortCount; j++)
263 if (ServerInstance->Config->ports[j] == listenports[i])
264 if (ServerInstance->Config->openSockfd[j])
265 ServerInstance->Config->openSockfd[j]->SetDescription("plaintext");
270 virtual Version GetVersion()
272 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
275 void Implements(char* List)
277 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
278 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
281 virtual char* OnRequest(Request* request)
283 ISHRequest* ISR = (ISHRequest*)request;
284 if (strcmp("IS_NAME", request->GetId()) == 0)
288 else if (strcmp("IS_HOOK", request->GetId()) == 0)
293 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
295 catch (ModuleException &e)
301 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
303 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
305 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
307 issl_session* session = &sessions[ISR->Sock->GetFd()];
308 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
310 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
312 issl_session* session = &sessions[ISR->Sock->GetFd()];
315 VerifyCertificate(session, (InspSocket*)ISR->Sock);
323 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
325 issl_session* session = &sessions[fd];
328 session->inbuf = new char[inbufsize];
329 session->inbufoffset = 0;
331 gnutls_init(&session->sess, GNUTLS_SERVER);
333 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
334 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
335 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
336 gnutls_dh_set_prime_bits(session->sess, dh_bits);
338 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
339 * This needs testing, but it's easy enough to rollback if need be
340 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
341 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
343 * With testing this seems to...not work :/
346 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
351 virtual void OnRawSocketConnect(int fd)
353 issl_session* session = &sessions[fd];
356 session->inbuf = new char[inbufsize];
357 session->inbufoffset = 0;
359 gnutls_init(&session->sess, GNUTLS_CLIENT);
361 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
362 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
363 //TODO: Request server cert here.
364 //gnutls_certificate_request(session->sess, GNUTLS_CERT_REQUEST); // Request server certificate if any.
365 gnutls_dh_set_prime_bits(session->sess, dh_bits);
367 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
372 virtual void OnRawSocketClose(int fd)
374 CloseSession(&sessions[fd]);
376 EventHandler* user = ServerInstance->SE->GetRef(fd);
378 if ((user) && (user->GetExt("ssl_cert", dummy)))
381 user->GetExt("ssl_cert", tofree);
383 user->Shrink("ssl_cert");
387 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
389 issl_session* session = &sessions[fd];
394 CloseSession(session);
398 if (session->status == ISSL_HANDSHAKING_READ)
400 // The handshake isn't finished, try to finish it.
402 if(!Handshake(session))
404 // Couldn't resume handshake.
408 else if (session->status == ISSL_HANDSHAKING_WRITE)
413 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
415 if (session->status == ISSL_HANDSHAKEN)
417 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
418 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
419 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
423 // Client closed connection.
425 CloseSession(session);
430 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
435 CloseSession(session);
440 // Read successfully 'ret' bytes into inbuf + inbufoffset
441 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
442 // 'buffer' is 'count' long
444 unsigned int length = ret + session->inbufoffset;
448 memcpy(buffer, session->inbuf, count);
449 // Move the stuff left in inbuf to the beginning of it
450 memcpy(session->inbuf, session->inbuf + count, (length - count));
451 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
452 session->inbufoffset = length - count;
453 // Insp uses readresult as the count of how much data there is in buffer, so:
458 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
459 memcpy(buffer, session->inbuf, length);
460 // Zero the offset, as there's nothing there..
461 session->inbufoffset = 0;
467 else if(session->status == ISSL_CLOSING)
473 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
478 issl_session* session = &sessions[fd];
479 const char* sendbuffer = buffer;
483 CloseSession(session);
487 session->outbuf.append(sendbuffer, count);
488 sendbuffer = session->outbuf.c_str();
489 count = session->outbuf.size();
491 if(session->status == ISSL_HANDSHAKING_WRITE)
493 // The handshake isn't finished, try to finish it.
501 if(session->status == ISSL_HANDSHAKEN)
503 ret = gnutls_record_send(session->sess, sendbuffer, count);
506 CloseSession(session);
509 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
510 CloseSession(session);
514 session->outbuf = session->outbuf.substr(ret);
518 /* Who's smart idea was it to return 1 when we havent written anything?
519 * This fucks the buffer up in InspSocket :p
521 return ret < 1 ? 0 : ret;
524 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
525 virtual void OnWhois(userrec* source, userrec* dest)
527 // Bugfix, only send this numeric for *our* SSL users
528 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
530 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
534 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
536 // check if the linking module wants to know about OUR metadata
539 // check if this user has an swhois field to send
540 if(user->GetExt(extname, dummy))
542 // call this function in the linking module, let it format the data how it
543 // sees fit, and send it on its way. We dont need or want to know how.
544 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
549 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
551 // check if its our metadata key, and its associated with a user
552 if ((target_type == TYPE_USER) && (extname == "ssl"))
554 userrec* dest = (userrec*)target;
555 // if they dont already have an ssl flag, accept the remote server's
556 if (!dest->GetExt(extname, dummy))
558 dest->Extend(extname, "ON");
563 bool Handshake(issl_session* session)
565 int ret = gnutls_handshake(session->sess);
569 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
571 // Handshake needs resuming later, read() or write() would have blocked.
573 if(gnutls_record_get_direction(session->sess) == 0)
575 // gnutls_handshake() wants to read() again.
576 session->status = ISSL_HANDSHAKING_READ;
580 // gnutls_handshake() wants to write() again.
581 session->status = ISSL_HANDSHAKING_WRITE;
582 MakePollWrite(session);
588 CloseSession(session);
589 session->status = ISSL_CLOSING;
596 // Handshake complete.
597 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
598 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
601 if (!extendme->GetExt("ssl", dummy))
602 extendme->Extend("ssl", "ON");
605 // Change the seesion state
606 session->status = ISSL_HANDSHAKEN;
608 // Finish writing, if any left
609 MakePollWrite(session);
615 virtual void OnPostConnect(userrec* user)
617 // This occurs AFTER OnUserConnect so we can be sure the
618 // protocol module has propogated the NICK message.
619 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
621 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
622 std::deque<std::string>* metadata = new std::deque<std::string>;
623 metadata->push_back(user->nick);
624 metadata->push_back("ssl"); // The metadata id
625 metadata->push_back("ON"); // The value to send
626 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
627 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
631 VerifyCertificate(&sessions[user->GetFd()],user);
635 void MakePollWrite(issl_session* session)
637 OnRawSocketWrite(session->fd, NULL, 0);
640 void CloseSession(issl_session* session)
644 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
645 gnutls_deinit(session->sess);
650 delete[] session->inbuf;
653 session->outbuf.clear();
654 session->inbuf = NULL;
655 session->sess = NULL;
656 session->status = ISSL_NONE;
659 void VerifyCertificate(issl_session* session, Extensible* user)
662 const gnutls_datum_t* cert_list;
664 unsigned int cert_list_size;
665 gnutls_x509_crt_t cert;
667 unsigned char digest[MAXBUF];
668 size_t digest_size = sizeof(digest);
669 size_t name_size = sizeof(name);
670 ssl_cert* certinfo = new ssl_cert;
672 user->Extend("ssl_cert",certinfo);
674 /* This verification function uses the trusted CAs in the credentials
675 * structure. So you must have installed one or more CA certificates.
677 ret = gnutls_certificate_verify_peers2(session->sess, &status);
681 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
685 if (status & GNUTLS_CERT_INVALID)
687 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
691 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
693 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
695 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
699 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
701 if (status & GNUTLS_CERT_REVOKED)
703 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
707 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
709 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
711 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
715 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
718 /* Up to here the process is the same for X.509 certificates and
719 * OpenPGP keys. From now on X.509 certificates are assumed. This can
720 * be easily extended to work with openpgp keys as well.
722 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
724 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
728 ret = gnutls_x509_crt_init(&cert);
731 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
736 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
737 if (cert_list == NULL)
739 certinfo->data.insert(std::make_pair("error","No certificate was found"));
743 /* This is not a real world example, since we only check the first
744 * certificate in the given chain.
747 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
750 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
754 gnutls_x509_crt_get_dn(cert, name, &name_size);
756 certinfo->data.insert(std::make_pair("dn",name));
758 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
760 certinfo->data.insert(std::make_pair("issuer",name));
762 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
764 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
768 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
771 /* Beware here we do not check for errors.
773 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
775 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
778 gnutls_x509_crt_deinit(cert);
785 class ModuleSSLGnuTLSFactory : public ModuleFactory
788 ModuleSSLGnuTLSFactory()
792 ~ModuleSSLGnuTLSFactory()
796 virtual Module * CreateModule(InspIRCd* Me)
798 return new ModuleSSLGnuTLS(Me);
803 extern "C" void * init_module( void )
805 return new ModuleSSLGnuTLSFactory;