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 static gnutls_x509_crt_t x509_cert;
34 static gnutls_x509_privkey_t x509_key;
35 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
36 const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) {
38 st->type = GNUTLS_CRT_X509;
40 st->cert.x509 = &x509_cert;
41 st->key.x509 = x509_key;
47 /** Represents an SSL user's extra data
49 class issl_session : public classbase
57 gnutls_session_t sess;
61 class CommandStartTLS : public Command
64 CommandStartTLS (Module* mod) : Command(mod, "STARTTLS")
66 works_before_reg = true;
69 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
71 /* changed from == REG_ALL to catch clients sending STARTTLS
72 * after NICK and USER but before OnUserConnect completes and
73 * give a proper error message (see bug #645) - dz
75 if (user->registered != REG_NONE)
77 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration has started", user->nick.c_str());
81 if (!user->GetIOHook())
83 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
84 user->AddIOHook(creator);
85 creator->OnStreamSocketAccept(user, NULL, NULL);
88 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
95 class ModuleSSLGnuTLS : public Module
97 std::set<ListenSocketBase*> listenports;
99 issl_session* sessions;
101 gnutls_certificate_credentials x509_cred;
102 gnutls_dh_params dh_params;
105 std::string certfile;
108 std::string sslports;
113 CommandStartTLS starttls;
115 GenericCap capHandler;
118 ModuleSSLGnuTLS(InspIRCd* Me)
119 : Module(Me), starttls(this), capHandler(this, "tls")
121 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
123 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
125 gnutls_global_init(); // This must be called once in the program
126 gnutls_x509_crt_init(&x509_cert);
127 gnutls_x509_privkey_init(&x509_key);
130 // Needs the flag as it ignores a plain /rehash
131 OnModuleRehash(NULL,"ssl");
133 // Void return, guess we assume success
134 gnutls_certificate_set_dh_params(x509_cred, dh_params);
135 Implementation eventlist[] = { I_On005Numeric, I_OnRequest, I_OnRehash, I_OnModuleRehash, I_OnPostConnect,
136 I_OnEvent, I_OnHookIO };
137 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
139 ServerInstance->AddCommand(&starttls);
142 void OnRehash(User* user)
144 ConfigReader Conf(ServerInstance);
149 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
151 ListenSocketBase* port = ServerInstance->ports[i];
152 std::string desc = port->GetDescription();
153 if (desc != "gnutls")
156 listenports.insert(port);
157 std::string portid = port->GetBindDesc();
159 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
160 if (port->GetIP() != "127.0.0.1")
161 sslports.append(portid).append(";");
164 if (!sslports.empty())
165 sslports.erase(sslports.end() - 1);
168 void OnModuleRehash(User* user, const std::string ¶m)
175 ConfigReader Conf(ServerInstance);
177 std::string confdir(ServerInstance->ConfigFileName);
178 // +1 so we the path ends with a /
179 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
181 cafile = Conf.ReadValue("gnutls", "cafile", 0);
182 crlfile = Conf.ReadValue("gnutls", "crlfile", 0);
183 certfile = Conf.ReadValue("gnutls", "certfile", 0);
184 keyfile = Conf.ReadValue("gnutls", "keyfile", 0);
185 dh_bits = Conf.ReadInteger("gnutls", "dhbits", 0, false);
187 // Set all the default values needed.
194 if (certfile.empty())
195 certfile = "cert.pem";
200 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
203 // Prepend relative paths with the path to the config directory.
204 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
205 cafile = confdir + cafile;
207 if ((crlfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(crlfile)))
208 crlfile = confdir + crlfile;
210 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
211 certfile = confdir + certfile;
213 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
214 keyfile = confdir + keyfile;
220 // Deallocate the old credentials
221 gnutls_dh_params_deinit(dh_params);
222 gnutls_certificate_free_credentials(x509_cred);
227 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
228 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
230 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
231 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));
233 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
234 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));
236 FileReader reader(ServerInstance);
238 reader.LoadFile(certfile);
239 std::string cert_string = reader.Contents();
240 gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() };
242 reader.LoadFile(keyfile);
243 std::string key_string = reader.Contents();
244 gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() };
246 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
247 if((ret = gnutls_x509_crt_import(x509_cert, &cert_datum, GNUTLS_X509_FMT_PEM)) < 0)
248 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + std::string(gnutls_strerror(ret)));
250 if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
251 throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
253 if((ret = gnutls_certificate_set_x509_key(x509_cred, &x509_cert, 1, x509_key)) < 0)
254 throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
256 gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
258 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
259 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
261 // This may be on a large (once a day or week) timer eventually.
265 void GenerateDHParams()
267 // Generate Diffie Hellman parameters - for use with DHE
268 // kx algorithms. These should be discarded and regenerated
269 // once a day, once a week or once a month. Depending on the
270 // security requirements.
274 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
275 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
280 gnutls_x509_crt_deinit(x509_cert);
281 gnutls_x509_privkey_deinit(x509_key);
282 gnutls_dh_params_deinit(dh_params);
283 gnutls_certificate_free_credentials(x509_cred);
284 gnutls_global_deinit();
285 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
289 void OnCleanup(int target_type, void* item)
291 if(target_type == TYPE_USER)
293 User* user = static_cast<User*>(item);
295 if (user->GetIOHook() == this)
297 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
298 // Potentially there could be multiple SSL modules loaded at once on different ports.
299 ServerInstance->Users->QuitUser(user, "SSL module unloading");
307 return Version("$Id$", VF_VENDOR, API_VERSION);
311 void On005Numeric(std::string &output)
313 if (!sslports.empty())
314 output.append(" SSL=" + sslports);
315 output.append(" STARTTLS");
318 void OnHookIO(StreamSocket* user, ListenSocketBase* lsb)
320 if (!user->GetIOHook() && listenports.find(lsb) != listenports.end())
322 /* Hook the user with our module */
323 user->AddIOHook(this);
327 const char* OnRequest(Request* request)
329 ISHRequest* ISR = static_cast<ISHRequest*>(request);
330 if (strcmp("IS_NAME", request->GetId()) == 0)
334 else if (strcmp("IS_HOOK", request->GetId()) == 0)
336 ISR->Sock->AddIOHook(this);
339 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
341 ISR->Sock->DelIOHook();
344 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
346 if (ISR->Sock->GetFd() < 0)
349 issl_session* session = &sessions[ISR->Sock->GetFd()];
350 return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : "OK";
352 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
354 if (ISR->Sock->GetFd() > -1)
356 issl_session* session = &sessions[ISR->Sock->GetFd()];
359 if (static_cast<Extensible*>(ServerInstance->SE->GetRef(ISR->Sock->GetFd())) == static_cast<Extensible*>(ISR->Sock))
366 else if (strcmp("GET_CERT", request->GetId()) == 0)
368 Module* sslinfo = ServerInstance->Modules->Find("m_sslinfo.so");
370 return sslinfo->OnRequest(request);
376 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
378 int fd = user->GetFd();
379 issl_session* session = &sessions[fd];
381 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
385 gnutls_init(&session->sess, GNUTLS_SERVER);
387 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
388 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
389 gnutls_dh_set_prime_bits(session->sess, dh_bits);
391 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(fd)); // Give gnutls the fd for the socket.
393 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
395 Handshake(session, user);
398 void OnStreamSocketConnect(StreamSocket* user)
400 issl_session* session = &sessions[user->GetFd()];
402 gnutls_init(&session->sess, GNUTLS_CLIENT);
404 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
405 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
406 gnutls_dh_set_prime_bits(session->sess, dh_bits);
407 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user->GetFd()));
409 Handshake(session, user);
412 void OnStreamSocketClose(StreamSocket* user)
414 CloseSession(&sessions[user->GetFd()]);
417 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
419 issl_session* session = &sessions[user->GetFd()];
423 CloseSession(session);
424 user->SetError("No SSL session");
428 if (session->status == ISSL_HANDSHAKING_READ)
430 // The handshake isn't finished, try to finish it.
432 if(!Handshake(session, user))
434 if (session->status != ISSL_CLOSING)
436 user->SetError("Handshake Failed");
440 else if (session->status == ISSL_HANDSHAKING_WRITE)
446 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
448 if (session->status == ISSL_HANDSHAKEN)
450 char* buffer = ServerInstance->GetReadBuffer();
451 size_t bufsiz = ServerInstance->Config->NetBufferSize;
455 int ret = gnutls_record_recv(session->sess, buffer + len, bufsiz - len);
460 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
466 user->SetError("SSL Connection closed");
467 CloseSession(session);
472 user->SetError(gnutls_strerror(ret));
473 CloseSession(session);
479 recvq.append(buffer, len);
483 else if (session->status == ISSL_CLOSING)
489 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq)
491 issl_session* session = &sessions[user->GetFd()];
495 CloseSession(session);
496 user->SetError("No SSL session");
500 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
502 // The handshake isn't finished, try to finish it.
503 Handshake(session, user);
504 if (session->status != ISSL_CLOSING)
506 user->SetError("Handshake Failed");
512 if (session->status == ISSL_HANDSHAKEN)
514 ret = gnutls_record_send(session->sess, sendq.data(), sendq.length());
516 if (ret == (int)sendq.length())
522 sendq = sendq.substr(ret);
526 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
533 CloseSession(session);
534 user->SetError("SSL Connection closed");
539 user->SetError(gnutls_strerror(ret));
540 CloseSession(session);
548 bool Handshake(issl_session* session, EventHandler* user)
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;
572 CloseSession(session);
573 session->status = ISSL_CLOSING;
580 // Change the seesion state
581 session->status = ISSL_HANDSHAKEN;
583 VerifyCertificate(session,user);
585 // Finish writing, if any left
592 void OnPostConnect(User* user)
594 // This occurs AFTER OnUserConnect so we can be sure the
595 // protocol module has propagated the NICK message.
596 if (user->GetIOHook() == this && (IS_LOCAL(user)))
598 if (sessions[user->GetFd()].sess)
600 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
601 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
602 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
603 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
608 void MakePollWrite(EventHandler* eh)
610 ServerInstance->SE->WantWrite(eh);
613 void CloseSession(issl_session* session)
617 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
618 gnutls_deinit(session->sess);
621 session->sess = NULL;
622 session->status = ISSL_NONE;
625 void VerifyCertificate(issl_session* session, Extensible* user)
627 if (!session->sess || !user)
630 Module* sslinfo = ServerInstance->Modules->Find("m_sslinfo.so");
635 const gnutls_datum_t* cert_list;
637 unsigned int cert_list_size;
638 gnutls_x509_crt_t cert;
640 unsigned char digest[MAXBUF];
641 size_t digest_size = sizeof(digest);
642 size_t name_size = sizeof(name);
643 ssl_cert* certinfo = new ssl_cert;
645 /* This verification function uses the trusted CAs in the credentials
646 * structure. So you must have installed one or more CA certificates.
648 ret = gnutls_certificate_verify_peers2(session->sess, &status);
652 certinfo->error = std::string(gnutls_strerror(ret));
656 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
657 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
658 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
659 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
661 /* Up to here the process is the same for X.509 certificates and
662 * OpenPGP keys. From now on X.509 certificates are assumed. This can
663 * be easily extended to work with openpgp keys as well.
665 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
667 certinfo->error = "No X509 keys sent";
671 ret = gnutls_x509_crt_init(&cert);
674 certinfo->error = gnutls_strerror(ret);
679 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
680 if (cert_list == NULL)
682 certinfo->error = "No certificate was found";
683 goto info_done_dealloc;
686 /* This is not a real world example, since we only check the first
687 * certificate in the given chain.
690 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
693 certinfo->error = gnutls_strerror(ret);
694 goto info_done_dealloc;
697 gnutls_x509_crt_get_dn(cert, name, &name_size);
700 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
701 certinfo->issuer = name;
703 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
705 certinfo->error = gnutls_strerror(ret);
709 certinfo->fingerprint = irc::hex(digest, digest_size);
712 /* Beware here we do not check for errors.
714 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
716 certinfo->error = "Not activated, or expired certificate";
720 gnutls_x509_crt_deinit(cert);
722 BufferedSocketFingerprintSubmission(user, this, sslinfo, certinfo).Send();
725 void OnEvent(Event* ev)
727 capHandler.HandleEvent(ev);
731 MODULE_INIT(ModuleSSLGnuTLS)