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: `libgnutls-config --libs` `perl ../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 class issl_session : public classbase
39 gnutls_session_t sess;
47 class ModuleSSLGnuTLS : public Module
56 std::vector<int> listenports;
59 issl_session sessions[MAX_DESCRIPTORS];
61 gnutls_certificate_credentials x509_cred;
62 gnutls_dh_params dh_params;
72 ModuleSSLGnuTLS(InspIRCd* Me)
77 culllist = new CullList(ServerInstance);
79 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
80 inbufsize = ServerInstance->Config->NetBufferSize;
82 gnutls_global_init(); // This must be called once in the program
84 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
85 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
87 // Guessing return meaning
88 if(gnutls_dh_params_init(&dh_params) < 0)
89 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
91 // Needs the flag as it ignores a plain /rehash
94 // Void return, guess we assume success
95 gnutls_certificate_set_dh_params(x509_cred, dh_params);
98 virtual void OnRehash(const std::string ¶m)
103 Conf = new ConfigReader(ServerInstance);
105 for(unsigned int i = 0; i < listenports.size(); i++)
107 ServerInstance->Config->DelIOHook(listenports[i]);
112 for(int i = 0; i < Conf->Enumerate("bind"); i++)
114 // For each <bind> tag
115 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
117 // Get the port we're meant to be listening on with SSL
118 unsigned int port = Conf->ReadInteger("bind", "port", i, true);
119 if (ServerInstance->Config->AddIOHook(port, this))
121 // We keep a record of which ports we're listening on with SSL
122 listenports.push_back(port);
124 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", port);
128 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", port);
133 std::string confdir(CONFIG_FILE);
134 // +1 so we the path ends with a /
135 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
137 cafile = Conf->ReadValue("gnutls", "cafile", 0);
138 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
139 certfile = Conf->ReadValue("gnutls", "certfile", 0);
140 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
141 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
143 // Set all the default values needed.
151 certfile = "cert.pem";
156 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
159 // Prepend relative paths with the path to the config directory.
161 cafile = confdir + cafile;
163 if(crlfile[0] != '/')
164 crlfile = confdir + crlfile;
166 if(certfile[0] != '/')
167 certfile = confdir + certfile;
169 if(keyfile[0] != '/')
170 keyfile = confdir + keyfile;
172 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
173 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
175 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
176 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
178 // Guessing on the return value of this, manual doesn't say :|
179 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
180 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());
182 // This may be on a large (once a day or week) timer eventually.
188 void GenerateDHParams()
190 // Generate Diffie Hellman parameters - for use with DHE
191 // kx algorithms. These should be discarded and regenerated
192 // once a day, once a week or once a month. Depending on the
193 // security requirements.
195 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
196 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
199 virtual ~ModuleSSLGnuTLS()
201 gnutls_dh_params_deinit(dh_params);
202 gnutls_certificate_free_credentials(x509_cred);
203 gnutls_global_deinit();
207 virtual void OnCleanup(int target_type, void* item)
209 if(target_type == TYPE_USER)
211 userrec* user = (userrec*)item;
213 if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
215 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
216 // Potentially there could be multiple SSL modules loaded at once on different ports.
217 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Adding user %s to cull list", user->nick);
218 culllist->AddItem(user, "SSL module unloading");
220 if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
223 user->GetExt("ssl_cert", tofree);
225 user->Shrink("ssl_cert");
230 virtual void OnUnloadModule(Module* mod, const std::string &name)
234 // We're being unloaded, kill all the users added to the cull list in OnCleanup
235 int numusers = culllist->Apply();
236 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Killed %d users for unload of GnuTLS SSL module", numusers);
238 for(unsigned int i = 0; i < listenports.size(); i++)
239 ServerInstance->Config->DelIOHook(listenports[i]);
243 virtual Version GetVersion()
245 return Version(1, 0, 0, 0, VF_VENDOR);
248 void Implements(char* List)
250 List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
251 List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
254 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
256 issl_session* session = &sessions[fd];
259 session->inbuf = new char[inbufsize];
260 session->inbufoffset = 0;
262 gnutls_init(&session->sess, GNUTLS_SERVER);
264 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
265 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
266 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
267 gnutls_dh_set_prime_bits(session->sess, dh_bits);
269 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
270 * This needs testing, but it's easy enough to rollback if need be
271 * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
272 * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
274 * With testing this seems to...not work :/
277 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
282 virtual void OnRawSocketClose(int fd)
284 ServerInstance->Log(DEBUG, "OnRawSocketClose: %d", fd);
285 CloseSession(&sessions[fd]);
287 EventHandler* user = ServerInstance->SE->GetRef(fd);
289 if ((user) && (user->GetExt("ssl_cert", dummy)))
292 user->GetExt("ssl_cert", tofree);
294 user->Shrink("ssl_cert");
298 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
300 issl_session* session = &sessions[fd];
304 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
306 CloseSession(session);
310 if (session->status == ISSL_HANDSHAKING_READ)
312 // The handshake isn't finished, try to finish it.
314 if(Handshake(session))
316 // Handshake successfully resumed.
317 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
321 // Couldn't resume handshake.
322 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
326 else if (session->status == ISSL_HANDSHAKING_WRITE)
328 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
332 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
334 if (session->status == ISSL_HANDSHAKEN)
336 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
337 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
338 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
340 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
344 // Client closed connection.
345 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
347 CloseSession(session);
352 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
354 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
359 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
361 CloseSession(session);
366 // Read successfully 'ret' bytes into inbuf + inbufoffset
367 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
368 // 'buffer' is 'count' long
370 unsigned int length = ret + session->inbufoffset;
374 memcpy(buffer, session->inbuf, count);
375 // Move the stuff left in inbuf to the beginning of it
376 memcpy(session->inbuf, session->inbuf + count, (length - count));
377 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
378 session->inbufoffset = length - count;
379 // Insp uses readresult as the count of how much data there is in buffer, so:
384 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
385 memcpy(buffer, session->inbuf, length);
386 // Zero the offset, as there's nothing there..
387 session->inbufoffset = 0;
393 else if(session->status == ISSL_CLOSING)
395 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
402 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
404 issl_session* session = &sessions[fd];
405 const char* sendbuffer = buffer;
409 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
410 CloseSession(session);
414 if(session->status == ISSL_HANDSHAKING_WRITE)
416 // The handshake isn't finished, try to finish it.
418 if(Handshake(session))
420 // Handshake successfully resumed.
421 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
425 // Couldn't resume handshake.
426 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
429 else if(session->status == ISSL_HANDSHAKING_READ)
431 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
434 session->outbuf.append(sendbuffer, count);
435 sendbuffer = session->outbuf.c_str();
436 count = session->outbuf.size();
438 if(session->status == ISSL_HANDSHAKEN)
440 int ret = gnutls_record_send(session->sess, sendbuffer, count);
444 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
445 CloseSession(session);
449 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
451 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
455 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
456 CloseSession(session);
461 session->outbuf = session->outbuf.substr(ret);
464 else if(session->status == ISSL_CLOSING)
466 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
472 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
473 virtual void OnWhois(userrec* source, userrec* dest)
475 // Bugfix, only send this numeric for *our* SSL users
476 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) && isin(dest->GetPort(), listenports)))
478 source->WriteServ("320 %s %s :is using a secure connection", source->nick, dest->nick);
482 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
484 // check if the linking module wants to know about OUR metadata
487 // check if this user has an swhois field to send
488 if(user->GetExt(extname, dummy))
490 // call this function in the linking module, let it format the data how it
491 // sees fit, and send it on its way. We dont need or want to know how.
492 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
497 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
499 // check if its our metadata key, and its associated with a user
500 if ((target_type == TYPE_USER) && (extname == "ssl"))
502 userrec* dest = (userrec*)target;
503 // if they dont already have an ssl flag, accept the remote server's
504 if (!dest->GetExt(extname, dummy))
506 dest->Extend(extname, "ON");
511 bool Handshake(issl_session* session)
513 int ret = gnutls_handshake(session->sess);
517 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
519 // Handshake needs resuming later, read() or write() would have blocked.
521 if(gnutls_record_get_direction(session->sess) == 0)
523 // gnutls_handshake() wants to read() again.
524 session->status = ISSL_HANDSHAKING_READ;
525 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
529 // gnutls_handshake() wants to write() again.
530 session->status = ISSL_HANDSHAKING_WRITE;
531 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
532 MakePollWrite(session);
538 CloseSession(session);
539 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
540 session->status = ISSL_CLOSING;
547 // Handshake complete.
548 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
550 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
551 userrec* extendme = ServerInstance->FindDescriptor(session->fd);
554 if (!extendme->GetExt("ssl", dummy))
555 extendme->Extend("ssl", "ON");
558 // Change the seesion state
559 session->status = ISSL_HANDSHAKEN;
561 // Finish writing, if any left
562 MakePollWrite(session);
568 virtual void OnPostConnect(userrec* user)
570 // This occurs AFTER OnUserConnect so we can be sure the
571 // protocol module has propogated the NICK message.
572 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
574 // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
575 std::deque<std::string>* metadata = new std::deque<std::string>;
576 metadata->push_back(user->nick);
577 metadata->push_back("ssl"); // The metadata id
578 metadata->push_back("ON"); // The value to send
579 Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
580 event->Send(ServerInstance); // Trigger the event. We don't care what module picks it up.
584 VerifyCertificate(&sessions[user->GetFd()],user);
588 void MakePollWrite(issl_session* session)
590 OnRawSocketWrite(session->fd, NULL, 0);
593 void CloseSession(issl_session* session)
597 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
598 gnutls_deinit(session->sess);
603 delete[] session->inbuf;
606 session->outbuf.clear();
607 session->inbuf = NULL;
608 session->sess = NULL;
609 session->status = ISSL_NONE;
612 void VerifyCertificate(issl_session* session, userrec* user)
615 const gnutls_datum_t* cert_list;
617 unsigned int cert_list_size, name_size;
618 gnutls_x509_crt_t cert;
620 unsigned char digest[MAXBUF];
621 size_t digest_size = sizeof(digest);
622 ssl_cert* certinfo = new ssl_cert;
624 user->Extend("ssl_cert",certinfo);
626 /* This verification function uses the trusted CAs in the credentials
627 * structure. So you must have installed one or more CA certificates.
629 ret = gnutls_certificate_verify_peers2(session->sess, &status);
633 certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
637 if (status & GNUTLS_CERT_INVALID)
639 certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
643 certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
645 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
647 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
651 certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
653 if (status & GNUTLS_CERT_REVOKED)
655 certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
659 certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
661 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
663 certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
667 certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
670 /* Up to here the process is the same for X.509 certificates and
671 * OpenPGP keys. From now on X.509 certificates are assumed. This can
672 * be easily extended to work with openpgp keys as well.
674 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
676 certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
680 ret = gnutls_x509_crt_init(&cert);
683 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
688 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
689 if (cert_list == NULL)
691 certinfo->data.insert(std::make_pair("error","No certificate was found"));
695 /* This is not a real world example, since we only check the first
696 * certificate in the given chain.
699 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
702 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
706 name_size = sizeof(name);
707 gnutls_x509_crt_get_dn(cert, name, &name_size);
709 certinfo->data.insert(std::make_pair("dn",name));
711 name_size = sizeof(name);
712 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
714 certinfo->data.insert(std::make_pair("issuer",name));
716 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
718 certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
722 certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
725 /* Beware here we do not check for errors.
727 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
729 certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
732 gnutls_x509_crt_deinit(cert);
739 class ModuleSSLGnuTLSFactory : public ModuleFactory
742 ModuleSSLGnuTLSFactory()
746 ~ModuleSSLGnuTLSFactory()
750 virtual Module * CreateModule(InspIRCd* Me)
752 return new ModuleSSLGnuTLS(Me);
757 extern "C" void * init_module( void )
759 return new ModuleSSLGnuTLSFactory;