4 #include <gnutls/gnutls.h>
5 #include <gnutls/x509.h>
7 #include "inspircd_config.h"
8 #include "configreader.h"
19 /* $ModDesc: Provides SSL support for clients */
20 /* $CompileFlags: `libgnutls-config --cflags` */
21 /* $LinkerFlags: `perl extra/gnutls_rpath.pl` */
25 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
27 bool isin(int port, const std::vector<int> &portlist)
29 for(unsigned int i = 0; i < portlist.size(); i++)
30 if(portlist[i] == port)
36 /** Represents an SSL user's extra data
38 class issl_session : public classbase
41 gnutls_session_t sess;
49 class ModuleSSLGnuTLS : public Module
58 std::vector<int> listenports;
61 issl_session sessions[MAX_DESCRIPTORS];
63 gnutls_certificate_credentials x509_cred;
64 gnutls_dh_params dh_params;
74 ModuleSSLGnuTLS(InspIRCd* Me)
79 culllist = new CullList(ServerInstance);
81 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
82 inbufsize = ServerInstance->Config->NetBufferSize;
84 gnutls_global_init(); // This must be called once in the program
86 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
87 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
89 // Guessing return meaning
90 if(gnutls_dh_params_init(&dh_params) < 0)
91 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
93 // Needs the flag as it ignores a plain /rehash
96 // Void return, guess we assume success
97 gnutls_certificate_set_dh_params(x509_cred, dh_params);
100 virtual void OnRehash(const std::string ¶m)
105 Conf = new ConfigReader(ServerInstance);
107 for(unsigned int i = 0; i < listenports.size(); i++)
109 ServerInstance->Config->DelIOHook(listenports[i]);
114 for(int i = 0; i < Conf->Enumerate("bind"); i++)
116 // For each <bind> tag
117 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
119 // Get the port we're meant to be listening on with SSL
120 std::string port = Conf->ReadValue("bind", "port", i);
121 irc::portparser portrange(port, false);
123 while ((portno = portrange.GetToken()))
125 if (ServerInstance->Config->AddIOHook(portno, this))
127 listenports.push_back(portno);
128 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
132 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
138 std::string confdir(CONFIG_FILE);
139 // +1 so we the path ends with a /
140 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
142 cafile = Conf->ReadValue("gnutls", "cafile", 0);
143 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
144 certfile = Conf->ReadValue("gnutls", "certfile", 0);
145 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
146 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
148 // Set all the default values needed.
156 certfile = "cert.pem";
161 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
164 // Prepend relative paths with the path to the config directory.
166 cafile = confdir + cafile;
168 if(crlfile[0] != '/')
169 crlfile = confdir + crlfile;
171 if(certfile[0] != '/')
172 certfile = confdir + certfile;
174 if(keyfile[0] != '/')
175 keyfile = confdir + keyfile;
177 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
178 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
180 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
181 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
183 // Guessing on the return value of this, manual doesn't say :|
184 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
185 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());
187 // This may be on a large (once a day or week) timer eventually.
193 void GenerateDHParams()
195 // Generate Diffie Hellman parameters - for use with DHE
196 // kx algorithms. These should be discarded and regenerated
197 // once a day, once a week or once a month. Depending on the
198 // security requirements.
200 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
201 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
204 virtual ~ModuleSSLGnuTLS()
206 gnutls_dh_params_deinit(dh_params);
207 gnutls_certificate_free_credentials(x509_cred);
208 gnutls_global_deinit();
212 virtual void OnCleanup(int target_type, void* item)
214 if(target_type == TYPE_USER)
216 userrec* user = (userrec*)item;
218 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
220 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
221 // Potentially there could be multiple SSL modules loaded at once on different ports.
222 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Adding user %s to cull list", user->nick);
223 culllist->AddItem(user, "SSL module unloading");
225 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
228 user->GetExt("ssl_cert", tofree);
230 user->Shrink("ssl_cert");
235 virtual void OnUnloadModule(Module* mod, const std::string &name)
239 // We're being unloaded, kill all the users added to the cull list in OnCleanup
240 int numusers = culllist->Apply();
241 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Killed %d users for unload of GnuTLS SSL module", numusers);
243 for(unsigned int i = 0; i < listenports.size(); i++)
244 ServerInstance->Config->DelIOHook(listenports[i]);
248 virtual Version GetVersion()
250 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
253 void Implements(char* List)
255 List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
256 List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
259 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
261 issl_session* session = &sessions[fd];
264 session->inbuf = new char[inbufsize];
265 session->inbufoffset = 0;
267 gnutls_init(&session->sess, GNUTLS_SERVER);
269 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
270 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
271 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
272 gnutls_dh_set_prime_bits(session->sess, dh_bits);
274 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
275 * This needs testing, but it's easy enough to rollback if need be
276 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
277 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
279 * With testing this seems to...not work :/
282 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
287 virtual void OnRawSocketClose(int fd)
289 ServerInstance->Log(DEBUG, "OnRawSocketClose: %d", fd);
290 CloseSession(&sessions[fd]);
292 EventHandler* user = ServerInstance->SE->GetRef(fd);
294 if ((user) && (user->GetExt("ssl_cert", dummy)))
297 user->GetExt("ssl_cert", tofree);
299 user->Shrink("ssl_cert");
303 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
305 issl_session* session = &sessions[fd];
309 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
311 CloseSession(session);
315 if (session->status == ISSL_HANDSHAKING_READ)
317 // The handshake isn't finished, try to finish it.
319 if(Handshake(session))
321 // Handshake successfully resumed.
322 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
326 // Couldn't resume handshake.
327 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
331 else if (session->status == ISSL_HANDSHAKING_WRITE)
333 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
337 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
339 if (session->status == ISSL_HANDSHAKEN)
341 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
342 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
343 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
345 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
349 // Client closed connection.
350 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
352 CloseSession(session);
357 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
359 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
364 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
366 CloseSession(session);
371 // Read successfully 'ret' bytes into inbuf + inbufoffset
372 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
373 // 'buffer' is 'count' long
375 unsigned int length = ret + session->inbufoffset;
379 memcpy(buffer, session->inbuf, count);
380 // Move the stuff left in inbuf to the beginning of it
381 memcpy(session->inbuf, session->inbuf + count, (length - count));
382 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
383 session->inbufoffset = length - count;
384 // Insp uses readresult as the count of how much data there is in buffer, so:
389 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
390 memcpy(buffer, session->inbuf, length);
391 // Zero the offset, as there's nothing there..
392 session->inbufoffset = 0;
398 else if(session->status == ISSL_CLOSING)
400 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
407 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
409 issl_session* session = &sessions[fd];
410 const char* sendbuffer = buffer;
414 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
415 CloseSession(session);
419 if(session->status == ISSL_HANDSHAKING_WRITE)
421 // The handshake isn't finished, try to finish it.
423 if(Handshake(session))
425 // Handshake successfully resumed.
426 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
430 // Couldn't resume handshake.
431 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
434 else if(session->status == ISSL_HANDSHAKING_READ)
436 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
439 session->outbuf.append(sendbuffer, count);
440 sendbuffer = session->outbuf.c_str();
441 count = session->outbuf.size();
443 if(session->status == ISSL_HANDSHAKEN)
445 int ret = gnutls_record_send(session->sess, sendbuffer, count);
449 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
450 CloseSession(session);
454 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
456 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
460 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
461 CloseSession(session);
466 session->outbuf = session->outbuf.substr(ret);
469 else if(session->status == ISSL_CLOSING)
471 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
477 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
478 virtual void OnWhois(userrec* source, userrec* dest)
480 // Bugfix, only send this numeric for *our* SSL users
481 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
483 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
487 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
489 // check if the linking module wants to know about OUR metadata
492 // check if this user has an swhois field to send
493 if(user->GetExt(extname, dummy))
495 // call this function in the linking module, let it format the data how it
496 // sees fit, and send it on its way. We dont need or want to know how.
497 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
502 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
504 // check if its our metadata key, and its associated with a user
505 if ((target_type == TYPE_USER) && (extname == "ssl"))
507 userrec* dest = (userrec*)target;
508 // if they dont already have an ssl flag, accept the remote server's
509 if (!dest->GetExt(extname, dummy))
511 dest->Extend(extname, "ON");
516 bool Handshake(issl_session* session)
518 int ret = gnutls_handshake(session->sess);
522 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
524 // Handshake needs resuming later, read() or write() would have blocked.
526 if(gnutls_record_get_direction(session->sess) == 0)
528 // gnutls_handshake() wants to read() again.
529 session->status = ISSL_HANDSHAKING_READ;
530 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
534 // gnutls_handshake() wants to write() again.
535 session->status = ISSL_HANDSHAKING_WRITE;
536 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
537 MakePollWrite(session);
543 CloseSession(session);
544 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
545 session->status = ISSL_CLOSING;
552 // Handshake complete.
553 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
555 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
556 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
559 if (!extendme->GetExt("ssl", dummy))
560 extendme->Extend("ssl", "ON");
563 // Change the seesion state
564 session->status = ISSL_HANDSHAKEN;
566 // Finish writing, if any left
567 MakePollWrite(session);
573 virtual void OnPostConnect(userrec* user)
575 // This occurs AFTER OnUserConnect so we can be sure the
576 // protocol module has propogated the NICK message.
577 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
579 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
580 std::deque<std::string>* metadata = new std::deque<std::string>;
581 metadata->push_back(user->nick);
582 metadata->push_back("ssl"); // The metadata id
583 metadata->push_back("ON"); // The value to send
584 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
585 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
589 VerifyCertificate(&sessions[user->GetFd()],user);
593 void MakePollWrite(issl_session* session)
595 OnRawSocketWrite(session->fd, NULL, 0);
598 void CloseSession(issl_session* session)
602 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
603 gnutls_deinit(session->sess);
608 delete[] session->inbuf;
611 session->outbuf.clear();
612 session->inbuf = NULL;
613 session->sess = NULL;
614 session->status = ISSL_NONE;
617 void VerifyCertificate(issl_session* session, userrec* user)
620 const gnutls_datum_t* cert_list;
622 unsigned int cert_list_size;
623 gnutls_x509_crt_t cert;
625 unsigned char digest[MAXBUF];
626 size_t digest_size = sizeof(digest);
627 size_t name_size = sizeof(name);
628 ssl_cert* certinfo = new ssl_cert;
630 user->Extend("ssl_cert",certinfo);
632 /* This verification function uses the trusted CAs in the credentials
633 * structure. So you must have installed one or more CA certificates.
635 ret = gnutls_certificate_verify_peers2(session->sess, &status);
639 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
643 if (status & GNUTLS_CERT_INVALID)
645 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
649 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
651 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
653 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
657 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
659 if (status & GNUTLS_CERT_REVOKED)
661 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
665 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
667 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
669 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
673 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
676 /* Up to here the process is the same for X.509 certificates and
677 * OpenPGP keys. From now on X.509 certificates are assumed. This can
678 * be easily extended to work with openpgp keys as well.
680 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
682 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
686 ret = gnutls_x509_crt_init(&cert);
689 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
694 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
695 if (cert_list == NULL)
697 certinfo->data.insert(std::make_pair("error","No certificate was found"));
701 /* This is not a real world example, since we only check the first
702 * certificate in the given chain.
705 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
708 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
712 gnutls_x509_crt_get_dn(cert, name, &name_size);
714 certinfo->data.insert(std::make_pair("dn",name));
716 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
718 certinfo->data.insert(std::make_pair("issuer",name));
720 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
722 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
726 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
727 user->WriteServ("NOTICE %s :*** Your SSL Certificate fingerprint is: %s", user->nick, irc::hex(digest, digest_size).c_str());
730 /* Beware here we do not check for errors.
732 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
734 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
737 gnutls_x509_crt_deinit(cert);
744 class ModuleSSLGnuTLSFactory : public ModuleFactory
747 ModuleSSLGnuTLSFactory()
751 ~ModuleSSLGnuTLSFactory()
755 virtual Module * CreateModule(InspIRCd* Me)
757 return new ModuleSSLGnuTLS(Me);
762 extern "C" void * init_module( void )
764 return new ModuleSSLGnuTLSFactory;