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;
101 GenericCap capHandler;
104 ModuleSSLGnuTLS(InspIRCd* Me)
105 : Module(Me), starttls(Me, this), capHandler(this, "tls")
107 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
109 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
111 gnutls_global_init(); // This must be called once in the program
114 // Needs the flag as it ignores a plain /rehash
115 OnModuleRehash(NULL,"ssl");
117 // Void return, guess we assume success
118 gnutls_certificate_set_dh_params(x509_cred, dh_params);
119 Implementation eventlist[] = { I_On005Numeric, I_OnRawSocketConnect, I_OnRawSocketAccept,
120 I_OnRawSocketClose, I_OnRawSocketRead, I_OnRawSocketWrite, I_OnCleanup,
121 I_OnBufferFlushed, I_OnRequest, I_OnRehash, I_OnModuleRehash, I_OnPostConnect,
122 I_OnEvent, I_OnHookIO };
123 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
125 ServerInstance->AddCommand(&starttls);
128 virtual void OnRehash(User* user)
130 ConfigReader Conf(ServerInstance);
135 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
137 ListenSocketBase* port = ServerInstance->ports[i];
138 std::string desc = port->GetDescription();
139 if (desc != "gnutls")
142 listenports.insert(port);
143 std::string portid = port->GetBindDesc();
145 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
146 if (port->GetIP() != "127.0.0.1")
147 sslports.append(portid).append(";");
150 if (!sslports.empty())
151 sslports.erase(sslports.end() - 1);
154 virtual void OnModuleRehash(User* user, const std::string ¶m)
161 ConfigReader Conf(ServerInstance);
163 std::string confdir(ServerInstance->ConfigFileName);
164 // +1 so we the path ends with a /
165 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
167 cafile = Conf.ReadValue("gnutls", "cafile", 0);
168 crlfile = Conf.ReadValue("gnutls", "crlfile", 0);
169 certfile = Conf.ReadValue("gnutls", "certfile", 0);
170 keyfile = Conf.ReadValue("gnutls", "keyfile", 0);
171 dh_bits = Conf.ReadInteger("gnutls", "dhbits", 0, false);
173 // Set all the default values needed.
180 if (certfile.empty())
181 certfile = "cert.pem";
186 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
189 // Prepend relative paths with the path to the config directory.
190 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
191 cafile = confdir + cafile;
193 if ((crlfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(crlfile)))
194 crlfile = confdir + crlfile;
196 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
197 certfile = confdir + certfile;
199 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
200 keyfile = confdir + keyfile;
206 // Deallocate the old credentials
207 gnutls_dh_params_deinit(dh_params);
208 gnutls_certificate_free_credentials(x509_cred);
213 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
214 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
216 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
217 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
219 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
220 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));
222 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
223 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));
225 if((ret = gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
227 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
228 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + ", key: " + keyfile + "): " + std::string(gnutls_strerror(ret)));
231 // This may be on a large (once a day or week) timer eventually.
235 void GenerateDHParams()
237 // Generate Diffie Hellman parameters - for use with DHE
238 // kx algorithms. These should be discarded and regenerated
239 // once a day, once a week or once a month. Depending on the
240 // security requirements.
244 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
245 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
248 virtual ~ModuleSSLGnuTLS()
250 gnutls_dh_params_deinit(dh_params);
251 gnutls_certificate_free_credentials(x509_cred);
252 gnutls_global_deinit();
253 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
257 virtual void OnCleanup(int target_type, void* item)
259 if(target_type == TYPE_USER)
261 User* user = static_cast<User*>(item);
263 if (user->GetIOHook() == this)
265 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
266 // Potentially there could be multiple SSL modules loaded at once on different ports.
267 ServerInstance->Users->QuitUser(user, "SSL module unloading");
273 virtual Version GetVersion()
275 return Version("$Id$", VF_VENDOR, API_VERSION);
279 virtual void On005Numeric(std::string &output)
281 if (!sslports.empty())
282 output.append(" SSL=" + sslports);
283 output.append(" STARTTLS");
286 virtual void OnHookIO(EventHandler* user, ListenSocketBase* lsb)
288 if (!user->GetIOHook() && listenports.find(lsb) != listenports.end())
290 /* Hook the user with our module */
291 user->AddIOHook(this);
295 virtual const char* OnRequest(Request* request)
297 ISHRequest* ISR = static_cast<ISHRequest*>(request);
298 if (strcmp("IS_NAME", request->GetId()) == 0)
302 else if (strcmp("IS_HOOK", request->GetId()) == 0)
304 const char* ret = "OK";
307 ret = ISR->Sock->AddIOHook(this) ? "OK" : NULL;
309 catch (ModuleException &e)
315 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
317 return ISR->Sock->DelIOHook() ? "OK" : NULL;
319 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
321 if (ISR->Sock->GetFd() < 0)
324 issl_session* session = &sessions[ISR->Sock->GetFd()];
325 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : "OK";
327 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
329 if (ISR->Sock->GetFd() > -1)
331 issl_session* session = &sessions[ISR->Sock->GetFd()];
334 if (static_cast<Extensible*>(ServerInstance->SE->GetRef(ISR->Sock->GetFd())) == static_cast<Extensible*>(ISR->Sock))
341 else if (strcmp("GET_CERT", request->GetId()) == 0)
343 Module* sslinfo = ServerInstance->Modules->Find("m_sslinfo.so");
345 return sslinfo->OnRequest(request);
351 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
353 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
354 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
357 issl_session* session = &sessions[fd];
359 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
363 gnutls_init(&session->sess, GNUTLS_SERVER);
365 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
366 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
367 gnutls_dh_set_prime_bits(session->sess, dh_bits);
369 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
371 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
373 Handshake(session, fd);
376 virtual void OnRawSocketConnect(int fd)
378 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
379 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
382 issl_session* session = &sessions[fd];
384 gnutls_init(&session->sess, GNUTLS_CLIENT);
386 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
387 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
388 gnutls_dh_set_prime_bits(session->sess, dh_bits);
389 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
391 Handshake(session, fd);
394 virtual void OnRawSocketClose(int fd)
396 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
397 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds()))
400 CloseSession(&sessions[fd]);
403 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
405 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
406 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
409 issl_session* session = &sessions[fd];
414 CloseSession(session);
418 if (session->status == ISSL_HANDSHAKING_READ)
420 // The handshake isn't finished, try to finish it.
422 if(!Handshake(session, fd))
424 errno = session->status == ISSL_CLOSING ? EIO : EAGAIN;
425 // Couldn't resume handshake.
429 else if (session->status == ISSL_HANDSHAKING_WRITE)
436 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
438 if (session->status == ISSL_HANDSHAKEN)
440 unsigned int len = 0;
443 int ret = gnutls_record_recv(session->sess, buffer + len, count - len);
448 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
455 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
456 "m_ssl_gnutls.so: Error while reading on fd %d: %s",
457 fd, gnutls_strerror(ret));
459 // if ret == 0, client closed connection.
461 CloseSession(session);
476 else if (session->status == ISSL_CLOSING)
482 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
484 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
485 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
488 issl_session* session = &sessions[fd];
489 const char* sendbuffer = buffer;
493 CloseSession(session);
497 session->outbuf.append(sendbuffer, count);
498 sendbuffer = session->outbuf.c_str();
499 count = session->outbuf.size();
501 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
503 // The handshake isn't finished, try to finish it.
504 Handshake(session, fd);
505 errno = session->status == ISSL_CLOSING ? EIO : EAGAIN;
511 if (session->status == ISSL_HANDSHAKEN)
513 ret = gnutls_record_send(session->sess, sendbuffer, count);
517 CloseSession(session);
521 if(ret != GNUTLS_E_AGAIN && ret != GNUTLS_E_INTERRUPTED)
523 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
524 "m_ssl_gnutls.so: Error while writing to fd %d: %s",
525 fd, gnutls_strerror(ret));
526 CloseSession(session);
535 session->outbuf = session->outbuf.substr(ret);
539 if (!session->outbuf.empty())
542 /* Who's smart idea was it to return 1 when we havent written anything?
543 * This fucks the buffer up in BufferedSocket :p
545 return ret < 1 ? 0 : ret;
548 bool Handshake(issl_session* session, int fd)
550 int ret = gnutls_handshake(session->sess);
554 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
556 // Handshake needs resuming later, read() or write() would have blocked.
558 if(gnutls_record_get_direction(session->sess) == 0)
560 // gnutls_handshake() wants to read() again.
561 session->status = ISSL_HANDSHAKING_READ;
565 // gnutls_handshake() wants to write() again.
566 session->status = ISSL_HANDSHAKING_WRITE;
573 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT,
574 "m_ssl_gnutls.so: Handshake failed on fd %d: %s",
575 fd, gnutls_strerror(ret));
576 CloseSession(session);
577 session->status = ISSL_CLOSING;
584 // Change the seesion state
585 session->status = ISSL_HANDSHAKEN;
587 EventHandler* user = ServerInstance->SE->GetRef(fd);
589 VerifyCertificate(session,user);
591 // Finish writing, if any left
598 virtual void OnPostConnect(User* user)
600 // This occurs AFTER OnUserConnect so we can be sure the
601 // protocol module has propagated the NICK message.
602 if (user->GetIOHook() == this && (IS_LOCAL(user)))
604 if (sessions[user->GetFd()].sess)
606 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
607 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
608 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
609 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
614 void MakePollWrite(int fd)
616 //OnRawSocketWrite(fd, NULL, 0);
617 EventHandler* eh = ServerInstance->SE->GetRef(fd);
619 ServerInstance->SE->WantWrite(eh);
622 virtual void OnBufferFlushed(User* user)
624 if (user->GetIOHook() == this)
626 issl_session* session = &sessions[user->GetFd()];
627 if (session && session->outbuf.size())
628 OnRawSocketWrite(user->GetFd(), NULL, 0);
632 void CloseSession(issl_session* session)
636 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
637 gnutls_deinit(session->sess);
640 session->outbuf.clear();
641 session->sess = NULL;
642 session->status = ISSL_NONE;
645 void VerifyCertificate(issl_session* session, Extensible* user)
647 if (!session->sess || !user)
650 Module* sslinfo = ServerInstance->Modules->Find("m_sslinfo.so");
655 const gnutls_datum_t* cert_list;
657 unsigned int cert_list_size;
658 gnutls_x509_crt_t cert;
660 unsigned char digest[MAXBUF];
661 size_t digest_size = sizeof(digest);
662 size_t name_size = sizeof(name);
663 ssl_cert* certinfo = new ssl_cert;
665 /* This verification function uses the trusted CAs in the credentials
666 * structure. So you must have installed one or more CA certificates.
668 ret = gnutls_certificate_verify_peers2(session->sess, &status);
672 certinfo->error = std::string(gnutls_strerror(ret));
676 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
677 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
678 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
679 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
681 /* Up to here the process is the same for X.509 certificates and
682 * OpenPGP keys. From now on X.509 certificates are assumed. This can
683 * be easily extended to work with openpgp keys as well.
685 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
687 certinfo->error = "No X509 keys sent";
691 ret = gnutls_x509_crt_init(&cert);
694 certinfo->error = gnutls_strerror(ret);
699 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
700 if (cert_list == NULL)
702 certinfo->error = "No certificate was found";
703 goto info_done_dealloc;
706 /* This is not a real world example, since we only check the first
707 * certificate in the given chain.
710 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
713 certinfo->error = gnutls_strerror(ret);
714 goto info_done_dealloc;
717 gnutls_x509_crt_get_dn(cert, name, &name_size);
720 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
721 certinfo->issuer = name;
723 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
725 certinfo->error = gnutls_strerror(ret);
729 certinfo->fingerprint = irc::hex(digest, digest_size);
732 /* Beware here we do not check for errors.
734 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
736 certinfo->error = "Not activated, or expired certificate";
740 gnutls_x509_crt_deinit(cert);
742 BufferedSocketFingerprintSubmission(user, this, sslinfo, certinfo).Send();
745 void OnEvent(Event* ev)
747 capHandler.HandleEvent(ev);
751 MODULE_INIT(ModuleSSLGnuTLS)