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>
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 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t user_wrap, void* buffer, size_t size)
49 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
50 if (user->GetEventMask() & FD_READ_WILL_BLOCK)
55 int rv = recv(user->GetFd(), buffer, size, 0);
57 ServerInstance->SE->ChangeEventMask(user, FD_READ_WILL_BLOCK);
61 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t user_wrap, const void* buffer, size_t size)
63 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
64 if (user->GetEventMask() & FD_WRITE_WILL_BLOCK)
69 int rv = send(user->GetFd(), buffer, size, 0);
71 ServerInstance->SE->ChangeEventMask(user, FD_WRITE_WILL_BLOCK);
75 /** Represents an SSL user's extra data
77 class issl_session : public classbase
85 gnutls_session_t sess;
89 class CommandStartTLS : public Command
92 CommandStartTLS (Module* mod) : Command(mod, "STARTTLS")
94 works_before_reg = true;
97 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
99 /* changed from == REG_ALL to catch clients sending STARTTLS
100 * after NICK and USER but before OnUserConnect completes and
101 * give a proper error message (see bug #645) - dz
103 if (user->registered != REG_NONE)
105 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration has started", user->nick.c_str());
109 if (!user->GetIOHook())
111 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
112 user->AddIOHook(creator);
113 creator->OnStreamSocketAccept(user, NULL, NULL);
116 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
123 class ModuleSSLGnuTLS : public Module
125 std::set<ListenSocketBase*> listenports;
127 issl_session* sessions;
129 gnutls_certificate_credentials x509_cred;
130 gnutls_dh_params dh_params;
133 std::string certfile;
136 std::string sslports;
141 CommandStartTLS starttls;
143 GenericCap capHandler;
147 : starttls(this), capHandler(this, "tls")
149 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
151 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
153 gnutls_global_init(); // This must be called once in the program
154 gnutls_x509_crt_init(&x509_cert);
155 gnutls_x509_privkey_init(&x509_key);
158 // Needs the flag as it ignores a plain /rehash
159 OnModuleRehash(NULL,"ssl");
161 // Void return, guess we assume success
162 gnutls_certificate_set_dh_params(x509_cred, dh_params);
163 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnPostConnect,
164 I_OnEvent, I_OnHookIO };
165 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
167 ServerInstance->AddCommand(&starttls);
170 void OnRehash(User* user)
177 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
179 ListenSocketBase* port = ServerInstance->ports[i];
180 std::string desc = port->GetDescription();
181 if (desc != "gnutls")
184 listenports.insert(port);
185 std::string portid = port->GetBindDesc();
187 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
188 if (port->GetIP() != "127.0.0.1")
189 sslports.append(portid).append(";");
192 if (!sslports.empty())
193 sslports.erase(sslports.end() - 1);
196 void OnModuleRehash(User* user, const std::string ¶m)
205 std::string confdir(ServerInstance->ConfigFileName);
206 // +1 so we the path ends with a /
207 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
209 cafile = Conf.ReadValue("gnutls", "cafile", 0);
210 crlfile = Conf.ReadValue("gnutls", "crlfile", 0);
211 certfile = Conf.ReadValue("gnutls", "certfile", 0);
212 keyfile = Conf.ReadValue("gnutls", "keyfile", 0);
213 dh_bits = Conf.ReadInteger("gnutls", "dhbits", 0, false);
215 // Set all the default values needed.
222 if (certfile.empty())
223 certfile = "cert.pem";
228 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
231 // Prepend relative paths with the path to the config directory.
232 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
233 cafile = confdir + cafile;
235 if ((crlfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(crlfile)))
236 crlfile = confdir + crlfile;
238 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
239 certfile = confdir + certfile;
241 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
242 keyfile = confdir + keyfile;
248 // Deallocate the old credentials
249 gnutls_dh_params_deinit(dh_params);
250 gnutls_certificate_free_credentials(x509_cred);
255 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
256 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
258 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
259 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));
261 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
262 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));
266 reader.LoadFile(certfile);
267 std::string cert_string = reader.Contents();
268 gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() };
270 reader.LoadFile(keyfile);
271 std::string key_string = reader.Contents();
272 gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() };
274 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
275 if((ret = gnutls_x509_crt_import(x509_cert, &cert_datum, GNUTLS_X509_FMT_PEM)) < 0)
276 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + std::string(gnutls_strerror(ret)));
278 if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
279 throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
281 if((ret = gnutls_certificate_set_x509_key(x509_cred, &x509_cert, 1, x509_key)) < 0)
282 throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
284 gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
286 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
287 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
289 // This may be on a large (once a day or week) timer eventually.
293 void GenerateDHParams()
295 // Generate Diffie Hellman parameters - for use with DHE
296 // kx algorithms. These should be discarded and regenerated
297 // once a day, once a week or once a month. Depending on the
298 // security requirements.
302 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
303 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
308 gnutls_x509_crt_deinit(x509_cert);
309 gnutls_x509_privkey_deinit(x509_key);
310 gnutls_dh_params_deinit(dh_params);
311 gnutls_certificate_free_credentials(x509_cred);
312 gnutls_global_deinit();
313 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
317 void OnCleanup(int target_type, void* item)
319 if(target_type == TYPE_USER)
321 User* user = static_cast<User*>(item);
323 if (user->GetIOHook() == this)
325 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
326 // Potentially there could be multiple SSL modules loaded at once on different ports.
327 ServerInstance->Users->QuitUser(user, "SSL module unloading");
335 return Version("Provides SSL support for clients", VF_VENDOR, API_VERSION);
339 void On005Numeric(std::string &output)
341 if (!sslports.empty())
342 output.append(" SSL=" + sslports);
343 output.append(" STARTTLS");
346 void OnHookIO(StreamSocket* user, ListenSocketBase* lsb)
348 if (!user->GetIOHook() && listenports.find(lsb) != listenports.end())
350 /* Hook the user with our module */
351 user->AddIOHook(this);
355 void OnRequest(Request& request)
357 Module* sslinfo = ServerInstance->Modules->Find("m_sslinfo.so");
359 sslinfo->OnRequest(request);
363 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
365 int fd = user->GetFd();
366 issl_session* session = &sessions[fd];
368 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
372 gnutls_init(&session->sess, GNUTLS_SERVER);
374 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
375 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
376 gnutls_dh_set_prime_bits(session->sess, dh_bits);
378 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
379 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
380 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
382 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
384 Handshake(session, user);
387 void OnStreamSocketConnect(StreamSocket* user)
389 issl_session* session = &sessions[user->GetFd()];
391 gnutls_init(&session->sess, GNUTLS_CLIENT);
393 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
394 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
395 gnutls_dh_set_prime_bits(session->sess, dh_bits);
396 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
397 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
398 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
400 Handshake(session, user);
403 void OnStreamSocketClose(StreamSocket* user)
405 CloseSession(&sessions[user->GetFd()]);
408 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
410 issl_session* session = &sessions[user->GetFd()];
414 CloseSession(session);
415 user->SetError("No SSL session");
419 if (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE)
421 // The handshake isn't finished, try to finish it.
423 if(!Handshake(session, user))
425 if (session->status != ISSL_CLOSING)
427 user->SetError("Handshake Failed");
432 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
434 if (session->status == ISSL_HANDSHAKEN)
436 char* buffer = ServerInstance->GetReadBuffer();
437 size_t bufsiz = ServerInstance->Config->NetBufferSize;
438 int ret = gnutls_record_recv(session->sess, buffer, bufsiz);
441 recvq.append(buffer, ret);
444 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
450 user->SetError("SSL Connection closed");
451 CloseSession(session);
456 user->SetError(gnutls_strerror(ret));
457 CloseSession(session);
461 else if (session->status == ISSL_CLOSING)
467 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq)
469 issl_session* session = &sessions[user->GetFd()];
473 CloseSession(session);
474 user->SetError("No SSL session");
478 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
480 // The handshake isn't finished, try to finish it.
481 Handshake(session, user);
482 if (session->status != ISSL_CLOSING)
484 user->SetError("Handshake Failed");
490 if (session->status == ISSL_HANDSHAKEN)
492 ret = gnutls_record_send(session->sess, sendq.data(), sendq.length());
494 if (ret == (int)sendq.length())
496 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE);
501 sendq = sendq.substr(ret);
502 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
505 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
507 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
512 CloseSession(session);
513 user->SetError("SSL Connection closed");
518 user->SetError(gnutls_strerror(ret));
519 CloseSession(session);
527 bool Handshake(issl_session* session, StreamSocket* user)
529 int ret = gnutls_handshake(session->sess);
533 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
535 // Handshake needs resuming later, read() or write() would have blocked.
537 if(gnutls_record_get_direction(session->sess) == 0)
539 // gnutls_handshake() wants to read() again.
540 session->status = ISSL_HANDSHAKING_READ;
541 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
545 // gnutls_handshake() wants to write() again.
546 session->status = ISSL_HANDSHAKING_WRITE;
547 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
552 CloseSession(session);
553 session->status = ISSL_CLOSING;
560 // Change the seesion state
561 session->status = ISSL_HANDSHAKEN;
563 VerifyCertificate(session,user);
565 // Finish writing, if any left
566 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
572 void OnPostConnect(User* user)
574 // This occurs AFTER OnUserConnect so we can be sure the
575 // protocol module has propagated the NICK message.
576 if (user->GetIOHook() == this && (IS_LOCAL(user)))
578 if (sessions[user->GetFd()].sess)
580 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
581 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
582 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
583 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
588 void CloseSession(issl_session* session)
592 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
593 gnutls_deinit(session->sess);
596 session->sess = NULL;
597 session->status = ISSL_NONE;
600 void VerifyCertificate(issl_session* session, Extensible* user)
602 if (!session->sess || !user)
605 Module* sslinfo = ServerInstance->Modules->Find("m_sslinfo.so");
610 const gnutls_datum_t* cert_list;
612 unsigned int cert_list_size;
613 gnutls_x509_crt_t cert;
615 unsigned char digest[MAXBUF];
616 size_t digest_size = sizeof(digest);
617 size_t name_size = sizeof(name);
618 ssl_cert* certinfo = new ssl_cert;
620 /* This verification function uses the trusted CAs in the credentials
621 * structure. So you must have installed one or more CA certificates.
623 ret = gnutls_certificate_verify_peers2(session->sess, &status);
627 certinfo->error = std::string(gnutls_strerror(ret));
631 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
632 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
633 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
634 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
636 /* Up to here the process is the same for X.509 certificates and
637 * OpenPGP keys. From now on X.509 certificates are assumed. This can
638 * be easily extended to work with openpgp keys as well.
640 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
642 certinfo->error = "No X509 keys sent";
646 ret = gnutls_x509_crt_init(&cert);
649 certinfo->error = gnutls_strerror(ret);
654 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
655 if (cert_list == NULL)
657 certinfo->error = "No certificate was found";
658 goto info_done_dealloc;
661 /* This is not a real world example, since we only check the first
662 * certificate in the given chain.
665 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
668 certinfo->error = gnutls_strerror(ret);
669 goto info_done_dealloc;
672 gnutls_x509_crt_get_dn(cert, name, &name_size);
675 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
676 certinfo->issuer = name;
678 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
680 certinfo->error = gnutls_strerror(ret);
684 certinfo->fingerprint = irc::hex(digest, digest_size);
687 /* Beware here we do not check for errors.
689 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
691 certinfo->error = "Not activated, or expired certificate";
695 gnutls_x509_crt_deinit(cert);
697 SSLCertSubmission(user, this, sslinfo, certinfo);
700 void OnEvent(Event& ev)
702 capHandler.HandleEvent(ev);
706 MODULE_INIT(ModuleSSLGnuTLS)