1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 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>
22 #pragma comment(lib, "libgnutls-13.lib")
25 /* $ModDesc: Provides SSL support for clients */
26 /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") */
27 /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") */
29 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
31 static std::vector<gnutls_x509_crt_t> x509_certs;
32 static gnutls_x509_privkey_t x509_key;
33 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
34 const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) {
36 st->type = GNUTLS_CRT_X509;
37 st->ncerts = x509_certs.size();
38 st->cert.x509 = &x509_certs[0];
39 st->key.x509 = x509_key;
45 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t user_wrap, void* buffer, size_t size)
47 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
48 if (user->GetEventMask() & FD_READ_WILL_BLOCK)
53 int rv = recv(user->GetFd(), buffer, size, 0);
55 ServerInstance->SE->ChangeEventMask(user, FD_READ_WILL_BLOCK);
59 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t user_wrap, const void* buffer, size_t size)
61 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
62 if (user->GetEventMask() & FD_WRITE_WILL_BLOCK)
67 int rv = send(user->GetFd(), buffer, size, 0);
69 ServerInstance->SE->ChangeEventMask(user, FD_WRITE_WILL_BLOCK);
73 class RandGen : public HandlerBase2<void, char*, size_t>
77 void Call(char* buffer, size_t len)
79 gcry_randomize(buffer, len, GCRY_STRONG_RANDOM);
83 /** Represents an SSL user's extra data
88 gnutls_session_t sess;
90 reference<ssl_cert> cert;
91 issl_session() : sess(NULL) {}
94 class CommandStartTLS : public SplitCommand
98 CommandStartTLS (Module* mod) : SplitCommand(mod, "STARTTLS")
101 works_before_reg = true;
104 CmdResult HandleLocal(const std::vector<std::string> ¶meters, LocalUser *user)
108 user->WriteNumeric(691, "%s :STARTTLS is not enabled", user->nick.c_str());
112 if (user->registered == REG_ALL)
114 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration is complete", user->nick.c_str());
118 if (!user->eh.GetIOHook())
120 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
121 /* We need to flush the write buffer prior to adding the IOHook,
122 * otherwise we'll be sending this line inside the SSL session - which
123 * won't start its handshake until the client gets this line. Currently,
124 * we assume the write will not block here; this is usually safe, as
125 * STARTTLS is sent very early on in the registration phase, where the
126 * user hasn't built up much sendq. Handling a blocked write here would
130 user->eh.AddIOHook(creator);
131 creator->OnStreamSocketAccept(&user->eh, NULL, NULL);
134 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
141 class ModuleSSLGnuTLS : public Module
143 issl_session* sessions;
145 gnutls_certificate_credentials x509_cred;
146 gnutls_dh_params dh_params;
147 gnutls_digest_algorithm_t hash;
149 std::string sslports;
155 CommandStartTLS starttls;
157 GenericCap capHandler;
158 ServiceProvider iohook;
162 : starttls(this), capHandler(this, "tls"), iohook(this, "ssl/gnutls", SERVICE_IOHOOK)
164 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
166 gnutls_global_init(); // This must be called once in the program
167 gnutls_x509_privkey_init(&x509_key);
174 // Needs the flag as it ignores a plain /rehash
175 OnModuleRehash(NULL,"ssl");
177 ServerInstance->GenRandom = &randhandler;
179 // Void return, guess we assume success
180 gnutls_certificate_set_dh_params(x509_cred, dh_params);
181 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnUserConnect,
182 I_OnEvent, I_OnHookIO };
183 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
185 ServerInstance->Modules->AddService(iohook);
186 ServerInstance->AddCommand(&starttls);
189 void OnRehash(User* user)
193 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
194 starttls.enabled = Conf->getBool("starttls", true);
196 if (Conf->getBool("showports", true))
198 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
200 ListenSocket* port = ServerInstance->ports[i];
201 if (port->bind_tag->getString("ssl") != "gnutls")
204 const std::string& portid = port->bind_desc;
205 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
207 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
208 sslports.append(portid).append(";");
211 if (!sslports.empty())
212 sslports.erase(sslports.end() - 1);
216 void OnModuleRehash(User* user, const std::string ¶m)
222 std::string certfile;
227 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
229 cafile = Conf->getString("cafile", "conf/ca.pem");
230 crlfile = Conf->getString("crlfile", "conf/crl.pem");
231 certfile = Conf->getString("certfile", "conf/cert.pem");
232 keyfile = Conf->getString("keyfile", "conf/key.pem");
233 dh_bits = Conf->getInt("dhbits");
234 std::string hashname = Conf->getString("hash", "md5");
236 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
239 if (hashname == "md5")
240 hash = GNUTLS_DIG_MD5;
241 else if (hashname == "sha1")
242 hash = GNUTLS_DIG_SHA1;
244 throw ModuleException("Unknown hash type " + hashname);
251 // Deallocate the old credentials
252 gnutls_dh_params_deinit(dh_params);
253 gnutls_certificate_free_credentials(x509_cred);
255 for(unsigned int i=0; i < x509_certs.size(); i++)
256 gnutls_x509_crt_deinit(x509_certs[i]);
262 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
263 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
265 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
266 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));
268 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
269 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));
273 reader.LoadFile(certfile);
274 std::string cert_string = reader.Contents();
275 gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() };
277 reader.LoadFile(keyfile);
278 std::string key_string = reader.Contents();
279 gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() };
281 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
282 unsigned int certcount = Conf->getInt("certcount", 3);
283 x509_certs.resize(certcount);
284 ret = gnutls_x509_crt_list_import(&x509_certs[0], &certcount, &cert_datum, GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED);
286 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + std::string(gnutls_strerror(ret)));
287 x509_certs.resize(certcount);
289 if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
290 throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
292 if((ret = gnutls_certificate_set_x509_key(x509_cred, &x509_certs[0], certcount, x509_key)) < 0)
293 throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
295 gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
297 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
298 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
300 // This may be on a large (once a day or week) timer eventually.
304 void GenerateDHParams()
306 // Generate Diffie Hellman parameters - for use with DHE
307 // kx algorithms. These should be discarded and regenerated
308 // once a day, once a week or once a month. Depending on the
309 // security requirements.
313 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
314 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
319 for(unsigned int i=0; i < x509_certs.size(); i++)
320 gnutls_x509_crt_deinit(x509_certs[i]);
322 gnutls_x509_privkey_deinit(x509_key);
325 gnutls_dh_params_deinit(dh_params);
326 gnutls_certificate_free_credentials(x509_cred);
328 gnutls_global_deinit();
330 ServerInstance->GenRandom = &ServerInstance->HandleGenRandom;
333 void OnCleanup(int target_type, void* item)
335 if(target_type == TYPE_USER)
337 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
339 if (user && user->eh.GetIOHook() == this)
341 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
342 // Potentially there could be multiple SSL modules loaded at once on different ports.
343 ServerInstance->Users->QuitUser(user, "SSL module unloading");
350 return Version("Provides SSL support for clients", VF_VENDOR);
354 void On005Numeric(std::string &output)
356 if (!sslports.empty())
357 output.append(" SSL=" + sslports);
358 if (starttls.enabled)
359 output.append(" STARTTLS");
362 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
364 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "gnutls")
366 /* Hook the user with our module */
367 user->AddIOHook(this);
371 void OnRequest(Request& request)
373 if (strcmp("GET_SSL_CERT", request.id) == 0)
375 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
376 int fd = req.sock->GetFd();
377 issl_session* session = &sessions[fd];
379 req.cert = session->cert;
383 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
385 int fd = user->GetFd();
386 issl_session* session = &sessions[fd];
388 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
392 gnutls_init(&session->sess, GNUTLS_SERVER);
394 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
395 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
396 gnutls_dh_set_prime_bits(session->sess, dh_bits);
398 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
399 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
400 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
402 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
404 Handshake(session, user);
407 void OnStreamSocketConnect(StreamSocket* user)
409 issl_session* session = &sessions[user->GetFd()];
411 gnutls_init(&session->sess, GNUTLS_CLIENT);
413 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
414 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
415 gnutls_dh_set_prime_bits(session->sess, dh_bits);
416 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
417 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
418 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
420 Handshake(session, user);
423 void OnStreamSocketClose(StreamSocket* user)
425 CloseSession(&sessions[user->GetFd()]);
428 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
430 issl_session* session = &sessions[user->GetFd()];
434 CloseSession(session);
435 user->SetError("No SSL session");
439 if (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE)
441 // The handshake isn't finished, try to finish it.
443 if(!Handshake(session, user))
445 if (session->status != ISSL_CLOSING)
451 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
453 if (session->status == ISSL_HANDSHAKEN)
455 char* buffer = ServerInstance->GetReadBuffer();
456 size_t bufsiz = ServerInstance->Config->NetBufferSize;
457 int ret = gnutls_record_recv(session->sess, buffer, bufsiz);
460 recvq.append(buffer, ret);
463 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
469 user->SetError("SSL Connection closed");
470 CloseSession(session);
475 user->SetError(gnutls_strerror(ret));
476 CloseSession(session);
480 else if (session->status == ISSL_CLOSING)
486 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq)
488 issl_session* session = &sessions[user->GetFd()];
492 CloseSession(session);
493 user->SetError("No SSL session");
497 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
499 // The handshake isn't finished, try to finish it.
500 Handshake(session, user);
501 if (session->status != ISSL_CLOSING)
508 if (session->status == ISSL_HANDSHAKEN)
510 ret = gnutls_record_send(session->sess, sendq.data(), sendq.length());
512 if (ret == (int)sendq.length())
514 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE);
519 sendq = sendq.substr(ret);
520 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
523 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
525 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
530 CloseSession(session);
531 user->SetError("SSL Connection closed");
536 user->SetError(gnutls_strerror(ret));
537 CloseSession(session);
545 bool Handshake(issl_session* session, StreamSocket* user)
547 int ret = gnutls_handshake(session->sess);
551 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
553 // Handshake needs resuming later, read() or write() would have blocked.
555 if(gnutls_record_get_direction(session->sess) == 0)
557 // gnutls_handshake() wants to read() again.
558 session->status = ISSL_HANDSHAKING_READ;
559 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
563 // gnutls_handshake() wants to write() again.
564 session->status = ISSL_HANDSHAKING_WRITE;
565 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
570 user->SetError(std::string("Handshake Failed - ") + gnutls_strerror(ret));
571 CloseSession(session);
572 session->status = ISSL_CLOSING;
579 // Change the seesion state
580 session->status = ISSL_HANDSHAKEN;
582 VerifyCertificate(session,user);
584 // Finish writing, if any left
585 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
591 void OnUserConnect(LocalUser* user)
593 if (user->eh.GetIOHook() == this)
595 if (sessions[user->eh.GetFd()].sess)
597 ssl_cert* cert = sessions[user->eh.GetFd()].cert;
598 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->eh.GetFd()].sess));
599 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->eh.GetFd()].sess))).append("-");
600 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->eh.GetFd()].sess)));
601 if (cert->fingerprint.empty())
602 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
604 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
605 " and your SSL fingerprint is %s", user->nick.c_str(), cipher.c_str(), cert->fingerprint.c_str());
610 void CloseSession(issl_session* session)
614 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
615 gnutls_deinit(session->sess);
617 session->sess = NULL;
618 session->cert = NULL;
619 session->status = ISSL_NONE;
622 void VerifyCertificate(issl_session* session, StreamSocket* user)
624 if (!session->sess || !user || session->cert)
628 const gnutls_datum_t* cert_list;
630 unsigned int cert_list_size;
631 gnutls_x509_crt_t cert;
633 unsigned char digest[MAXBUF];
634 size_t digest_size = sizeof(digest);
635 size_t name_size = sizeof(name);
636 ssl_cert* certinfo = new ssl_cert;
637 session->cert = certinfo;
639 /* This verification function uses the trusted CAs in the credentials
640 * structure. So you must have installed one or more CA certificates.
642 ret = gnutls_certificate_verify_peers2(session->sess, &status);
646 certinfo->error = std::string(gnutls_strerror(ret));
650 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
651 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
652 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
653 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
655 /* Up to here the process is the same for X.509 certificates and
656 * OpenPGP keys. From now on X.509 certificates are assumed. This can
657 * be easily extended to work with openpgp keys as well.
659 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
661 certinfo->error = "No X509 keys sent";
665 ret = gnutls_x509_crt_init(&cert);
668 certinfo->error = gnutls_strerror(ret);
673 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
674 if (cert_list == NULL)
676 certinfo->error = "No certificate was found";
677 goto info_done_dealloc;
680 /* This is not a real world example, since we only check the first
681 * certificate in the given chain.
684 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
687 certinfo->error = gnutls_strerror(ret);
688 goto info_done_dealloc;
691 gnutls_x509_crt_get_dn(cert, name, &name_size);
694 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
695 certinfo->issuer = name;
697 if ((ret = gnutls_x509_crt_get_fingerprint(cert, hash, digest, &digest_size)) < 0)
699 certinfo->error = gnutls_strerror(ret);
703 certinfo->fingerprint = irc::hex(digest, digest_size);
706 /* Beware here we do not check for errors.
708 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
710 certinfo->error = "Not activated, or expired certificate";
714 gnutls_x509_crt_deinit(cert);
717 void OnEvent(Event& ev)
719 if (starttls.enabled)
720 capHandler.HandleEvent(ev);
724 MODULE_INIT(ModuleSSLGnuTLS)