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
51 CommandStartTLS (InspIRCd* Instance, Module* mod) : Command(Instance, mod, "STARTTLS", 0, 0, true)
55 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
57 /* changed from == REG_ALL to catch clients sending STARTTLS
58 * after NICK and USER but before OnUserConnect completes and
59 * give a proper error message (see bug #645) - dz
61 if (user->registered != REG_NONE)
63 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration has started", user->nick.c_str());
67 if (!user->GetIOHook())
69 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
70 user->AddIOHook(creator);
71 creator->OnRawSocketAccept(user->GetFd(), NULL, NULL);
74 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
81 class ModuleSSLGnuTLS : public Module
83 std::set<ListenSocketBase*> listenports;
85 issl_session* sessions;
87 gnutls_certificate_credentials x509_cred;
88 gnutls_dh_params dh_params;
99 CommandStartTLS starttls;
103 ModuleSSLGnuTLS(InspIRCd* Me)
104 : Module(Me), starttls(Me, this)
106 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
108 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
110 gnutls_global_init(); // This must be called once in the program
113 // Needs the flag as it ignores a plain /rehash
114 OnModuleRehash(NULL,"ssl");
116 // Void return, guess we assume success
117 gnutls_certificate_set_dh_params(x509_cred, dh_params);
118 Implementation eventlist[] = { I_On005Numeric, I_OnRawSocketConnect, I_OnRawSocketAccept,
119 I_OnRawSocketClose, I_OnRawSocketRead, I_OnRawSocketWrite, I_OnCleanup,
120 I_OnBufferFlushed, I_OnRequest, I_OnRehash, I_OnModuleRehash, I_OnPostConnect,
121 I_OnEvent, I_OnHookIO };
122 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
124 ServerInstance->AddCommand(&starttls);
127 virtual void OnRehash(User* user)
129 ConfigReader Conf(ServerInstance);
134 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
136 ListenSocketBase* port = ServerInstance->ports[i];
137 std::string desc = port->GetDescription();
138 if (desc != "gnutls")
141 listenports.insert(port);
142 std::string portid = port->GetBindDesc();
144 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
145 if (port->GetIP() != "127.0.0.1")
146 sslports.append(portid).append(";");
149 if (!sslports.empty())
150 sslports.erase(sslports.end() - 1);
153 virtual void OnModuleRehash(User* user, const std::string ¶m)
160 ConfigReader Conf(ServerInstance);
162 std::string confdir(ServerInstance->ConfigFileName);
163 // +1 so we the path ends with a /
164 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
166 cafile = Conf.ReadValue("gnutls", "cafile", 0);
167 crlfile = Conf.ReadValue("gnutls", "crlfile", 0);
168 certfile = Conf.ReadValue("gnutls", "certfile", 0);
169 keyfile = Conf.ReadValue("gnutls", "keyfile", 0);
170 dh_bits = Conf.ReadInteger("gnutls", "dhbits", 0, false);
172 // Set all the default values needed.
179 if (certfile.empty())
180 certfile = "cert.pem";
185 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
188 // Prepend relative paths with the path to the config directory.
189 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
190 cafile = confdir + cafile;
192 if ((crlfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(crlfile)))
193 crlfile = confdir + crlfile;
195 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
196 certfile = confdir + certfile;
198 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
199 keyfile = confdir + keyfile;
205 // Deallocate the old credentials
206 gnutls_dh_params_deinit(dh_params);
207 gnutls_certificate_free_credentials(x509_cred);
212 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
213 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
215 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
216 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
218 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
219 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));
221 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
222 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));
224 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
226 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
227 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + ", key: " + keyfile + "): " + std::string(gnutls_strerror(ret)));
230 // This may be on a large (once a day or week) timer eventually.
234 void GenerateDHParams()
236 // Generate Diffie Hellman parameters - for use with DHE
237 // kx algorithms. These should be discarded and regenerated
238 // once a day, once a week or once a month. Depending on the
239 // security requirements.
243 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
244 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
247 virtual ~ModuleSSLGnuTLS()
249 gnutls_dh_params_deinit(dh_params);
250 gnutls_certificate_free_credentials(x509_cred);
251 gnutls_global_deinit();
252 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
256 virtual void OnCleanup(int target_type, void* item)
258 if(target_type == TYPE_USER)
260 User* user = static_cast<User*>(item);
262 if (user->GetIOHook() == this)
264 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
265 // Potentially there could be multiple SSL modules loaded at once on different ports.
266 ServerInstance->Users->QuitUser(user, "SSL module unloading");
269 if (user->GetExt("ssl_cert"))
272 user->GetExt("ssl_cert", tofree);
274 user->Shrink("ssl_cert");
279 virtual Version GetVersion()
281 return Version("$Id$", VF_VENDOR, API_VERSION);
285 virtual void On005Numeric(std::string &output)
287 if (!sslports.empty())
288 output.append(" SSL=" + sslports);
289 output.append(" STARTTLS");
292 virtual void OnHookIO(EventHandler* user, ListenSocketBase* lsb)
294 if (!user->GetIOHook() && listenports.find(lsb) != listenports.end())
296 /* Hook the user with our module */
297 user->AddIOHook(this);
301 virtual const char* OnRequest(Request* request)
303 ISHRequest* ISR = static_cast<ISHRequest*>(request);
304 if (strcmp("IS_NAME", request->GetId()) == 0)
308 else if (strcmp("IS_HOOK", request->GetId()) == 0)
310 const char* ret = "OK";
313 ret = ISR->Sock->AddIOHook(this) ? "OK" : NULL;
315 catch (ModuleException &e)
321 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
323 return ISR->Sock->DelIOHook() ? "OK" : NULL;
325 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
327 if (ISR->Sock->GetFd() < 0)
330 issl_session* session = &sessions[ISR->Sock->GetFd()];
331 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : "OK";
333 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
335 if (ISR->Sock->GetFd() > -1)
337 issl_session* session = &sessions[ISR->Sock->GetFd()];
340 if (static_cast<Extensible*>(ServerInstance->SE->GetRef(ISR->Sock->GetFd())) == static_cast<Extensible*>(ISR->Sock))
342 VerifyCertificate(session, ISR->Sock);
348 else if (strcmp("GET_FP", request->GetId()) == 0)
350 if (ISR->Sock->GetFd() > -1)
352 issl_session* session = &sessions[ISR->Sock->GetFd()];
355 Extensible* ext = ISR->Sock;
357 if (ext->GetExt("ssl_cert",certinfo))
358 return certinfo->GetFingerprint().c_str();
366 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
368 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
369 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
372 issl_session* session = &sessions[fd];
374 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
378 gnutls_init(&session->sess, GNUTLS_SERVER);
380 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
381 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
382 gnutls_dh_set_prime_bits(session->sess, dh_bits);
384 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
386 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
388 Handshake(session, fd);
391 virtual void OnRawSocketConnect(int fd)
393 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
394 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
397 issl_session* session = &sessions[fd];
399 gnutls_init(&session->sess, GNUTLS_CLIENT);
401 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
402 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
403 gnutls_dh_set_prime_bits(session->sess, dh_bits);
404 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
406 Handshake(session, fd);
409 virtual void OnRawSocketClose(int fd)
411 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
412 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds()))
415 CloseSession(&sessions[fd]);
417 EventHandler* user = ServerInstance->SE->GetRef(fd);
419 if ((user) && (user->GetExt("ssl_cert")))
422 user->GetExt("ssl_cert", tofree);
424 user->Shrink("ssl_cert");
428 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
430 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
431 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
434 issl_session* session = &sessions[fd];
439 CloseSession(session);
443 if (session->status == ISSL_HANDSHAKING_READ)
445 // The handshake isn't finished, try to finish it.
447 if(!Handshake(session, fd))
449 errno = session->status == ISSL_CLOSING ? EIO : EAGAIN;
450 // Couldn't resume handshake.
454 else if (session->status == ISSL_HANDSHAKING_WRITE)
461 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
463 if (session->status == ISSL_HANDSHAKEN)
465 unsigned int len = 0;
468 int ret = gnutls_record_recv(session->sess, buffer + len, count - len);
473 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
480 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
481 "m_ssl_gnutls.so: Error while reading on fd %d: %s",
482 fd, gnutls_strerror(ret));
484 // if ret == 0, client closed connection.
486 CloseSession(session);
501 else if (session->status == ISSL_CLOSING)
507 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
509 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
510 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
513 issl_session* session = &sessions[fd];
514 const char* sendbuffer = buffer;
518 CloseSession(session);
522 session->outbuf.append(sendbuffer, count);
523 sendbuffer = session->outbuf.c_str();
524 count = session->outbuf.size();
526 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
528 // The handshake isn't finished, try to finish it.
529 Handshake(session, fd);
530 errno = session->status == ISSL_CLOSING ? EIO : EAGAIN;
536 if (session->status == ISSL_HANDSHAKEN)
538 ret = gnutls_record_send(session->sess, sendbuffer, count);
542 CloseSession(session);
546 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
548 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
549 "m_ssl_gnutls.so: Error while writing to fd %d: %s",
550 fd, gnutls_strerror(ret));
551 CloseSession(session);
560 session->outbuf = session->outbuf.substr(ret);
564 if (!session->outbuf.empty())
567 /* Who's smart idea was it to return 1 when we havent written anything?
568 * This fucks the buffer up in BufferedSocket :p
570 return ret < 1 ? 0 : ret;
573 bool Handshake(issl_session* session, int fd)
575 int ret = gnutls_handshake(session->sess);
579 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
581 // Handshake needs resuming later, read() or write() would have blocked.
583 if(gnutls_record_get_direction(session->sess) == 0)
585 // gnutls_handshake() wants to read() again.
586 session->status = ISSL_HANDSHAKING_READ;
590 // gnutls_handshake() wants to write() again.
591 session->status = ISSL_HANDSHAKING_WRITE;
598 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
599 "m_ssl_gnutls.so: Handshake failed on fd %d: %s",
600 fd, gnutls_strerror(ret));
601 CloseSession(session);
602 session->status = ISSL_CLOSING;
609 // Handshake complete.
610 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
611 EventHandler *extendme = ServerInstance->SE->GetRef(fd);
614 extendme->Extend("ssl");
617 // Change the seesion state
618 session->status = ISSL_HANDSHAKEN;
620 // Finish writing, if any left
627 virtual void OnPostConnect(User* user)
629 // This occurs AFTER OnUserConnect so we can be sure the
630 // protocol module has propagated the NICK message.
631 if (user->GetIOHook() == this && (IS_LOCAL(user)))
633 ssl_cert* certdata = VerifyCertificate(&sessions[user->GetFd()],user);
634 if (sessions[user->GetFd()].sess)
636 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
637 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
638 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
639 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
642 ServerInstance->PI->SendMetaData(user, "ssl", "ON");
644 ServerInstance->PI->SendMetaData(user, "ssl_cert", certdata->GetMetaLine().c_str());
648 void MakePollWrite(int fd)
650 //OnRawSocketWrite(fd, NULL, 0);
651 EventHandler* eh = ServerInstance->SE->GetRef(fd);
653 ServerInstance->SE->WantWrite(eh);
656 virtual void OnBufferFlushed(User* user)
658 if (user->GetIOHook() == this)
660 issl_session* session = &sessions[user->GetFd()];
661 if (session && session->outbuf.size())
662 OnRawSocketWrite(user->GetFd(), NULL, 0);
666 void CloseSession(issl_session* session)
670 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
671 gnutls_deinit(session->sess);
674 session->outbuf.clear();
675 session->sess = NULL;
676 session->status = ISSL_NONE;
679 ssl_cert* VerifyCertificate(issl_session* session, Extensible* user)
681 if (!session->sess || !user)
685 const gnutls_datum_t* cert_list;
687 unsigned int cert_list_size;
688 gnutls_x509_crt_t cert;
690 unsigned char digest[MAXBUF];
691 size_t digest_size = sizeof(digest);
692 size_t name_size = sizeof(name);
693 ssl_cert* certinfo = new ssl_cert;
695 user->Extend("ssl_cert",certinfo);
697 /* This verification function uses the trusted CAs in the credentials
698 * structure. So you must have installed one or more CA certificates.
700 ret = gnutls_certificate_verify_peers2(session->sess, &status);
704 certinfo->error = std::string(gnutls_strerror(ret));
708 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
709 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
710 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
711 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
713 /* Up to here the process is the same for X.509 certificates and
714 * OpenPGP keys. From now on X.509 certificates are assumed. This can
715 * be easily extended to work with openpgp keys as well.
717 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
719 certinfo->error = "No X509 keys sent";
723 ret = gnutls_x509_crt_init(&cert);
726 certinfo->error = gnutls_strerror(ret);
731 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
732 if (cert_list == NULL)
734 certinfo->error = "No certificate was found";
738 /* This is not a real world example, since we only check the first
739 * certificate in the given chain.
742 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
745 certinfo->error = gnutls_strerror(ret);
749 gnutls_x509_crt_get_dn(cert, name, &name_size);
752 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
753 certinfo->issuer = name;
755 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
757 certinfo->error = gnutls_strerror(ret);
761 certinfo->fingerprint = irc::hex(digest, digest_size);
764 /* Beware here we do not check for errors.
766 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
768 certinfo->error = "Not activated, or expired certificate";
771 gnutls_x509_crt_deinit(cert);
776 void OnEvent(Event* ev)
778 GenericCapHandler(ev, "tls", "tls");
783 Module* server = ServerInstance->Modules->Find("m_spanningtree.so");
784 ServerInstance->Modules->SetPriority(this, I_OnPostConnect, PRIORITY_AFTER, &server);
788 MODULE_INIT(ModuleSSLGnuTLS)