1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
15 #include <gnutls/gnutls.h>
16 #include <gnutls/x509.h>
17 #include "transport.h"
21 #pragma comment(lib, "libgnutls-13.lib")
24 /* $ModDesc: Provides SSL support for clients */
25 /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") */
26 /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") */
27 /* $ModDep: transport.h */
28 /* $CopyInstall: conf/key.pem $(CONPATH) */
29 /* $CopyInstall: conf/cert.pem $(CONPATH) */
31 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
33 /** Represents an SSL user's extra data
35 class issl_session : public classbase
43 gnutls_session_t sess;
48 class CommandStartTLS : public Command
52 CommandStartTLS (InspIRCd* Instance, Module* mod) : Command(Instance,"STARTTLS", 0, 0, true), Caller(mod)
54 this->source = "m_ssl_gnutls.so";
57 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
59 /* changed from == REG_ALL to catch clients sending STARTTLS
60 * after NICK and USER but before OnUserConnect completes and
61 * give a proper error message (see bug #645) - dz
63 if (user->registered != REG_NONE)
65 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration has started", user->nick.c_str());
69 if (!user->GetIOHook())
71 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
72 user->AddIOHook(Caller);
73 Caller->OnRawSocketAccept(user->GetFd(), NULL, NULL);
76 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
83 class ModuleSSLGnuTLS : public Module
85 std::set<ListenSocketBase*> listenports;
87 issl_session* sessions;
89 gnutls_certificate_credentials x509_cred;
90 gnutls_dh_params dh_params;
101 CommandStartTLS starttls;
105 ModuleSSLGnuTLS(InspIRCd* Me)
106 : Module(Me), starttls(Me, this)
108 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
110 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
112 gnutls_global_init(); // This must be called once in the program
115 // Needs the flag as it ignores a plain /rehash
116 OnModuleRehash(NULL,"ssl");
118 // Void return, guess we assume success
119 gnutls_certificate_set_dh_params(x509_cred, dh_params);
120 Implementation eventlist[] = { I_On005Numeric, I_OnRawSocketConnect, I_OnRawSocketAccept,
121 I_OnRawSocketClose, I_OnRawSocketRead, I_OnRawSocketWrite, I_OnCleanup,
122 I_OnBufferFlushed, I_OnRequest, I_OnRehash, I_OnModuleRehash, I_OnPostConnect,
123 I_OnEvent, I_OnHookIO };
124 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
126 ServerInstance->AddCommand(&starttls);
129 virtual void OnRehash(User* user)
131 ConfigReader Conf(ServerInstance);
136 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
138 ListenSocketBase* port = ServerInstance->ports[i];
139 std::string desc = port->GetDescription();
140 if (desc != "gnutls")
143 listenports.insert(port);
144 std::string portid = port->GetBindDesc();
146 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
147 if (port->GetIP() != "127.0.0.1")
148 sslports.append(portid).append(";");
151 if (!sslports.empty())
152 sslports.erase(sslports.end() - 1);
155 virtual void OnModuleRehash(User* user, const std::string ¶m)
162 ConfigReader Conf(ServerInstance);
164 std::string confdir(ServerInstance->ConfigFileName);
165 // +1 so we the path ends with a /
166 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
168 cafile = Conf.ReadValue("gnutls", "cafile", 0);
169 crlfile = Conf.ReadValue("gnutls", "crlfile", 0);
170 certfile = Conf.ReadValue("gnutls", "certfile", 0);
171 keyfile = Conf.ReadValue("gnutls", "keyfile", 0);
172 dh_bits = Conf.ReadInteger("gnutls", "dhbits", 0, false);
174 // Set all the default values needed.
181 if (certfile.empty())
182 certfile = "cert.pem";
187 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
190 // Prepend relative paths with the path to the config directory.
191 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
192 cafile = confdir + cafile;
194 if ((crlfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(crlfile)))
195 crlfile = confdir + crlfile;
197 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
198 certfile = confdir + certfile;
200 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
201 keyfile = confdir + keyfile;
207 // Deallocate the old credentials
208 gnutls_dh_params_deinit(dh_params);
209 gnutls_certificate_free_credentials(x509_cred);
214 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
215 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
217 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
218 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
220 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
221 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to set X.509 trust file '%s': %s", cafile.c_str(), gnutls_strerror(ret));
223 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
224 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to set X.509 CRL file '%s': %s", crlfile.c_str(), gnutls_strerror(ret));
226 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
228 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
229 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + ", key: " + keyfile + "): " + std::string(gnutls_strerror(ret)));
232 // This may be on a large (once a day or week) timer eventually.
236 void GenerateDHParams()
238 // Generate Diffie Hellman parameters - for use with DHE
239 // kx algorithms. These should be discarded and regenerated
240 // once a day, once a week or once a month. Depending on the
241 // security requirements.
245 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
246 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
249 virtual ~ModuleSSLGnuTLS()
251 gnutls_dh_params_deinit(dh_params);
252 gnutls_certificate_free_credentials(x509_cred);
253 gnutls_global_deinit();
254 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
258 virtual void OnCleanup(int target_type, void* item)
260 if(target_type == TYPE_USER)
262 User* user = static_cast<User*>(item);
264 if (user->GetIOHook() == this)
266 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
267 // Potentially there could be multiple SSL modules loaded at once on different ports.
268 ServerInstance->Users->QuitUser(user, "SSL module unloading");
271 if (user->GetExt("ssl_cert"))
274 user->GetExt("ssl_cert", tofree);
276 user->Shrink("ssl_cert");
281 virtual Version GetVersion()
283 return Version("$Id$", VF_VENDOR, API_VERSION);
287 virtual void On005Numeric(std::string &output)
289 if (!sslports.empty())
290 output.append(" SSL=" + sslports);
291 output.append(" STARTTLS");
294 virtual void OnHookIO(EventHandler* user, ListenSocketBase* lsb)
296 if (!user->GetIOHook() && listenports.find(lsb) != listenports.end())
298 /* Hook the user with our module */
299 user->AddIOHook(this);
303 virtual const char* OnRequest(Request* request)
305 ISHRequest* ISR = static_cast<ISHRequest*>(request);
306 if (strcmp("IS_NAME", request->GetId()) == 0)
310 else if (strcmp("IS_HOOK", request->GetId()) == 0)
312 const char* ret = "OK";
315 ret = ISR->Sock->AddIOHook(this) ? "OK" : NULL;
317 catch (ModuleException &e)
323 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
325 return ISR->Sock->DelIOHook() ? "OK" : NULL;
327 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
329 if (ISR->Sock->GetFd() < 0)
332 issl_session* session = &sessions[ISR->Sock->GetFd()];
333 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : "OK";
335 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
337 if (ISR->Sock->GetFd() > -1)
339 issl_session* session = &sessions[ISR->Sock->GetFd()];
342 if (static_cast<Extensible*>(ServerInstance->SE->GetRef(ISR->Sock->GetFd())) == static_cast<Extensible*>(ISR->Sock))
344 VerifyCertificate(session, ISR->Sock);
350 else if (strcmp("GET_FP", request->GetId()) == 0)
352 if (ISR->Sock->GetFd() > -1)
354 issl_session* session = &sessions[ISR->Sock->GetFd()];
357 Extensible* ext = ISR->Sock;
359 if (ext->GetExt("ssl_cert",certinfo))
360 return certinfo->GetFingerprint().c_str();
368 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
370 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
371 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
374 issl_session* session = &sessions[fd];
376 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
380 gnutls_init(&session->sess, GNUTLS_SERVER);
382 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
383 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
384 gnutls_dh_set_prime_bits(session->sess, dh_bits);
386 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
388 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
390 Handshake(session, fd);
393 virtual void OnRawSocketConnect(int fd)
395 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
396 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
399 issl_session* session = &sessions[fd];
401 gnutls_init(&session->sess, GNUTLS_CLIENT);
403 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
404 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
405 gnutls_dh_set_prime_bits(session->sess, dh_bits);
406 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
408 Handshake(session, fd);
411 virtual void OnRawSocketClose(int fd)
413 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
414 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds()))
417 CloseSession(&sessions[fd]);
419 EventHandler* user = ServerInstance->SE->GetRef(fd);
421 if ((user) && (user->GetExt("ssl_cert")))
424 user->GetExt("ssl_cert", tofree);
426 user->Shrink("ssl_cert");
430 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
432 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
433 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
436 issl_session* session = &sessions[fd];
441 CloseSession(session);
445 if (session->status == ISSL_HANDSHAKING_READ)
447 // The handshake isn't finished, try to finish it.
449 if(!Handshake(session, fd))
451 errno = session->status == ISSL_CLOSING ? EIO : EAGAIN;
452 // Couldn't resume handshake.
456 else if (session->status == ISSL_HANDSHAKING_WRITE)
463 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
465 if (session->status == ISSL_HANDSHAKEN)
467 unsigned int len = 0;
470 int ret = gnutls_record_recv(session->sess, buffer + len, count - len);
475 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
482 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
483 "m_ssl_gnutls.so: Error while reading on fd %d: %s",
484 fd, gnutls_strerror(ret));
486 // if ret == 0, client closed connection.
488 CloseSession(session);
503 else if (session->status == ISSL_CLOSING)
509 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
511 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
512 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
515 issl_session* session = &sessions[fd];
516 const char* sendbuffer = buffer;
520 CloseSession(session);
524 session->outbuf.append(sendbuffer, count);
525 sendbuffer = session->outbuf.c_str();
526 count = session->outbuf.size();
528 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
530 // The handshake isn't finished, try to finish it.
531 Handshake(session, fd);
532 errno = session->status == ISSL_CLOSING ? EIO : EAGAIN;
538 if (session->status == ISSL_HANDSHAKEN)
540 ret = gnutls_record_send(session->sess, sendbuffer, count);
544 CloseSession(session);
548 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
550 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
551 "m_ssl_gnutls.so: Error while writing to fd %d: %s",
552 fd, gnutls_strerror(ret));
553 CloseSession(session);
562 session->outbuf = session->outbuf.substr(ret);
566 if (!session->outbuf.empty())
569 /* Who's smart idea was it to return 1 when we havent written anything?
570 * This fucks the buffer up in BufferedSocket :p
572 return ret < 1 ? 0 : ret;
575 bool Handshake(issl_session* session, int fd)
577 int ret = gnutls_handshake(session->sess);
581 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
583 // Handshake needs resuming later, read() or write() would have blocked.
585 if(gnutls_record_get_direction(session->sess) == 0)
587 // gnutls_handshake() wants to read() again.
588 session->status = ISSL_HANDSHAKING_READ;
592 // gnutls_handshake() wants to write() again.
593 session->status = ISSL_HANDSHAKING_WRITE;
600 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
601 "m_ssl_gnutls.so: Handshake failed on fd %d: %s",
602 fd, gnutls_strerror(ret));
603 CloseSession(session);
604 session->status = ISSL_CLOSING;
611 // Handshake complete.
612 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
613 EventHandler *extendme = ServerInstance->SE->GetRef(fd);
616 extendme->Extend("ssl");
619 // Change the seesion state
620 session->status = ISSL_HANDSHAKEN;
622 // Finish writing, if any left
629 virtual void OnPostConnect(User* user)
631 // This occurs AFTER OnUserConnect so we can be sure the
632 // protocol module has propagated the NICK message.
633 if (user->GetIOHook() == this && (IS_LOCAL(user)))
635 ssl_cert* certdata = VerifyCertificate(&sessions[user->GetFd()],user);
636 if (sessions[user->GetFd()].sess)
638 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
639 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
640 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
641 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
644 ServerInstance->PI->SendMetaData(user, "ssl", "ON");
646 ServerInstance->PI->SendMetaData(user, "ssl_cert", certdata->GetMetaLine().c_str());
650 void MakePollWrite(int fd)
652 //OnRawSocketWrite(fd, NULL, 0);
653 EventHandler* eh = ServerInstance->SE->GetRef(fd);
655 ServerInstance->SE->WantWrite(eh);
658 virtual void OnBufferFlushed(User* user)
660 if (user->GetIOHook() == this)
662 issl_session* session = &sessions[user->GetFd()];
663 if (session && session->outbuf.size())
664 OnRawSocketWrite(user->GetFd(), NULL, 0);
668 void CloseSession(issl_session* session)
672 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
673 gnutls_deinit(session->sess);
676 session->outbuf.clear();
677 session->sess = NULL;
678 session->status = ISSL_NONE;
681 ssl_cert* VerifyCertificate(issl_session* session, Extensible* user)
683 if (!session->sess || !user)
687 const gnutls_datum_t* cert_list;
689 unsigned int cert_list_size;
690 gnutls_x509_crt_t cert;
692 unsigned char digest[MAXBUF];
693 size_t digest_size = sizeof(digest);
694 size_t name_size = sizeof(name);
695 ssl_cert* certinfo = new ssl_cert;
697 user->Extend("ssl_cert",certinfo);
699 /* This verification function uses the trusted CAs in the credentials
700 * structure. So you must have installed one or more CA certificates.
702 ret = gnutls_certificate_verify_peers2(session->sess, &status);
706 certinfo->error = std::string(gnutls_strerror(ret));
710 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
711 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
712 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
713 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
715 /* Up to here the process is the same for X.509 certificates and
716 * OpenPGP keys. From now on X.509 certificates are assumed. This can
717 * be easily extended to work with openpgp keys as well.
719 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
721 certinfo->error = "No X509 keys sent";
725 ret = gnutls_x509_crt_init(&cert);
728 certinfo->error = gnutls_strerror(ret);
733 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
734 if (cert_list == NULL)
736 certinfo->error = "No certificate was found";
740 /* This is not a real world example, since we only check the first
741 * certificate in the given chain.
744 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
747 certinfo->error = gnutls_strerror(ret);
751 gnutls_x509_crt_get_dn(cert, name, &name_size);
754 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
755 certinfo->issuer = name;
757 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
759 certinfo->error = gnutls_strerror(ret);
763 certinfo->fingerprint = irc::hex(digest, digest_size);
766 /* Beware here we do not check for errors.
768 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
770 certinfo->error = "Not activated, or expired certificate";
773 gnutls_x509_crt_deinit(cert);
778 void OnEvent(Event* ev)
780 GenericCapHandler(ev, "tls", "tls");
785 Module* server = ServerInstance->Modules->Find("m_spanningtree.so");
786 ServerInstance->Modules->SetPriority(this, I_OnPostConnect, PRIORITY_AFTER, &server);
790 MODULE_INIT(ModuleSSLGnuTLS)