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_OnRawSocketConnect] = 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 OnRawSocketConnect(int fd)
289 issl_session* session = &sessions[fd];
292 session->inbuf = new char[inbufsize];
293 session->inbufoffset = 0;
295 gnutls_init(&session->sess, GNUTLS_SERVER);
297 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
298 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
299 gnutls_dh_set_prime_bits(session->sess, dh_bits);
301 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
306 virtual void OnRawSocketClose(int fd)
308 ServerInstance->Log(DEBUG, "OnRawSocketClose: %d", fd);
309 CloseSession(&sessions[fd]);
311 EventHandler* user = ServerInstance->SE->GetRef(fd);
313 if ((user) && (user->GetExt("ssl_cert", dummy)))
316 user->GetExt("ssl_cert", tofree);
318 user->Shrink("ssl_cert");
322 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
324 issl_session* session = &sessions[fd];
328 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
330 CloseSession(session);
334 if (session->status == ISSL_HANDSHAKING_READ)
336 // The handshake isn't finished, try to finish it.
338 if(Handshake(session))
340 // Handshake successfully resumed.
341 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
345 // Couldn't resume handshake.
346 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
350 else if (session->status == ISSL_HANDSHAKING_WRITE)
352 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
356 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
358 if (session->status == ISSL_HANDSHAKEN)
360 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
361 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
362 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
364 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
368 // Client closed connection.
369 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
371 CloseSession(session);
376 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
378 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
383 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
385 CloseSession(session);
390 // Read successfully 'ret' bytes into inbuf + inbufoffset
391 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
392 // 'buffer' is 'count' long
394 unsigned int length = ret + session->inbufoffset;
398 memcpy(buffer, session->inbuf, count);
399 // Move the stuff left in inbuf to the beginning of it
400 memcpy(session->inbuf, session->inbuf + count, (length - count));
401 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
402 session->inbufoffset = length - count;
403 // Insp uses readresult as the count of how much data there is in buffer, so:
408 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
409 memcpy(buffer, session->inbuf, length);
410 // Zero the offset, as there's nothing there..
411 session->inbufoffset = 0;
417 else if(session->status == ISSL_CLOSING)
419 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
426 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
428 issl_session* session = &sessions[fd];
429 const char* sendbuffer = buffer;
433 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
434 CloseSession(session);
438 if(session->status == ISSL_HANDSHAKING_WRITE)
440 // The handshake isn't finished, try to finish it.
442 if(Handshake(session))
444 // Handshake successfully resumed.
445 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
449 // Couldn't resume handshake.
450 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
453 else if(session->status == ISSL_HANDSHAKING_READ)
455 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
458 session->outbuf.append(sendbuffer, count);
459 sendbuffer = session->outbuf.c_str();
460 count = session->outbuf.size();
462 if(session->status == ISSL_HANDSHAKEN)
464 int ret = gnutls_record_send(session->sess, sendbuffer, count);
468 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
469 CloseSession(session);
473 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
475 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
479 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
480 CloseSession(session);
485 session->outbuf = session->outbuf.substr(ret);
488 else if(session->status == ISSL_CLOSING)
490 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
496 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
497 virtual void OnWhois(userrec* source, userrec* dest)
499 // Bugfix, only send this numeric for *our* SSL users
500 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
502 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
506 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
508 // check if the linking module wants to know about OUR metadata
511 // check if this user has an swhois field to send
512 if(user->GetExt(extname, dummy))
514 // call this function in the linking module, let it format the data how it
515 // sees fit, and send it on its way. We dont need or want to know how.
516 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
521 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
523 // check if its our metadata key, and its associated with a user
524 if ((target_type == TYPE_USER) && (extname == "ssl"))
526 userrec* dest = (userrec*)target;
527 // if they dont already have an ssl flag, accept the remote server's
528 if (!dest->GetExt(extname, dummy))
530 dest->Extend(extname, "ON");
535 bool Handshake(issl_session* session)
537 int ret = gnutls_handshake(session->sess);
541 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
543 // Handshake needs resuming later, read() or write() would have blocked.
545 if(gnutls_record_get_direction(session->sess) == 0)
547 // gnutls_handshake() wants to read() again.
548 session->status = ISSL_HANDSHAKING_READ;
549 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
553 // gnutls_handshake() wants to write() again.
554 session->status = ISSL_HANDSHAKING_WRITE;
555 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
556 MakePollWrite(session);
562 CloseSession(session);
563 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
564 session->status = ISSL_CLOSING;
571 // Handshake complete.
572 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
574 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
575 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
578 if (!extendme->GetExt("ssl", dummy))
579 extendme->Extend("ssl", "ON");
582 // Change the seesion state
583 session->status = ISSL_HANDSHAKEN;
585 // Finish writing, if any left
586 MakePollWrite(session);
592 virtual void OnPostConnect(userrec* user)
594 // This occurs AFTER OnUserConnect so we can be sure the
595 // protocol module has propogated the NICK message.
596 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
598 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
599 std::deque<std::string>* metadata = new std::deque<std::string>;
600 metadata->push_back(user->nick);
601 metadata->push_back("ssl"); // The metadata id
602 metadata->push_back("ON"); // The value to send
603 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
604 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
608 VerifyCertificate(&sessions[user->GetFd()],user);
612 void MakePollWrite(issl_session* session)
614 OnRawSocketWrite(session->fd, NULL, 0);
617 void CloseSession(issl_session* session)
621 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
622 gnutls_deinit(session->sess);
627 delete[] session->inbuf;
630 session->outbuf.clear();
631 session->inbuf = NULL;
632 session->sess = NULL;
633 session->status = ISSL_NONE;
636 void VerifyCertificate(issl_session* session, userrec* user)
639 const gnutls_datum_t* cert_list;
641 unsigned int cert_list_size;
642 gnutls_x509_crt_t cert;
644 unsigned char digest[MAXBUF];
645 size_t digest_size = sizeof(digest);
646 size_t name_size = sizeof(name);
647 ssl_cert* certinfo = new ssl_cert;
649 user->Extend("ssl_cert",certinfo);
651 /* This verification function uses the trusted CAs in the credentials
652 * structure. So you must have installed one or more CA certificates.
654 ret = gnutls_certificate_verify_peers2(session->sess, &status);
658 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
662 if (status & GNUTLS_CERT_INVALID)
664 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
668 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
670 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
672 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
676 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
678 if (status & GNUTLS_CERT_REVOKED)
680 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
684 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
686 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
688 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
692 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
695 /* Up to here the process is the same for X.509 certificates and
696 * OpenPGP keys. From now on X.509 certificates are assumed. This can
697 * be easily extended to work with openpgp keys as well.
699 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
701 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
705 ret = gnutls_x509_crt_init(&cert);
708 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
713 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
714 if (cert_list == NULL)
716 certinfo->data.insert(std::make_pair("error","No certificate was found"));
720 /* This is not a real world example, since we only check the first
721 * certificate in the given chain.
724 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
727 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
731 gnutls_x509_crt_get_dn(cert, name, &name_size);
733 certinfo->data.insert(std::make_pair("dn",name));
735 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
737 certinfo->data.insert(std::make_pair("issuer",name));
739 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
741 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
745 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
746 user->WriteServ("NOTICE %s :*** Your SSL Certificate fingerprint is: %s", user->nick, irc::hex(digest, digest_size).c_str());
749 /* Beware here we do not check for errors.
751 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
753 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
756 gnutls_x509_crt_deinit(cert);
763 class ModuleSSLGnuTLSFactory : public ModuleFactory
766 ModuleSSLGnuTLSFactory()
770 ~ModuleSSLGnuTLSFactory()
774 virtual Module * CreateModule(InspIRCd* Me)
776 return new ModuleSSLGnuTLS(Me);
781 extern "C" void * init_module( void )
783 return new ModuleSSLGnuTLSFactory;