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>
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") */
28 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
30 static gnutls_x509_crt_t x509_cert;
31 static gnutls_x509_privkey_t x509_key;
32 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
33 const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) {
35 st->type = GNUTLS_CRT_X509;
37 st->cert.x509 = &x509_cert;
38 st->key.x509 = x509_key;
44 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t user_wrap, void* buffer, size_t size)
46 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
47 if (user->GetEventMask() & FD_READ_WILL_BLOCK)
52 int rv = recv(user->GetFd(), buffer, size, 0);
54 ServerInstance->SE->ChangeEventMask(user, FD_READ_WILL_BLOCK);
58 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t user_wrap, const void* buffer, size_t size)
60 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
61 if (user->GetEventMask() & FD_WRITE_WILL_BLOCK)
66 int rv = send(user->GetFd(), buffer, size, 0);
68 ServerInstance->SE->ChangeEventMask(user, FD_WRITE_WILL_BLOCK);
72 /** Represents an SSL user's extra data
77 gnutls_session_t sess;
79 reference<ssl_cert> cert;
80 issl_session() : sess(NULL) {}
83 class CommandStartTLS : public SplitCommand
86 CommandStartTLS (Module* mod) : SplitCommand(mod, "STARTTLS")
88 works_before_reg = true;
91 CmdResult HandleLocal(const std::vector<std::string> ¶meters, LocalUser *user)
93 /* changed from == REG_ALL to catch clients sending STARTTLS
94 * after NICK and USER but before OnUserConnect completes and
95 * give a proper error message (see bug #645) - dz
97 if (user->registered != REG_NONE)
99 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration has started", user->nick.c_str());
103 if (!user->eh.GetIOHook())
105 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
106 /* We need to flush the write buffer prior to adding the IOHook,
107 * otherwise we'll be sending this line inside the SSL session - which
108 * won't start its handshake until the client gets this line. Currently,
109 * we assume the write will not block here; this is usually safe, as
110 * STARTTLS is sent very early on in the registration phase, where the
111 * user hasn't built up much sendq. Handling a blocked write here would
115 user->eh.AddIOHook(creator);
116 creator->OnStreamSocketAccept(&user->eh, NULL, NULL);
119 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
126 class ModuleSSLGnuTLS : public Module
128 issl_session* sessions;
130 gnutls_certificate_credentials x509_cred;
131 gnutls_dh_params dh_params;
132 gnutls_digest_algorithm_t hash;
134 std::string sslports;
139 CommandStartTLS starttls;
141 GenericCap capHandler;
142 ServiceProvider iohook;
146 : starttls(this), capHandler(this, "tls"), iohook(this, "ssl/gnutls", SERVICE_IOHOOK)
148 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
150 gnutls_global_init(); // This must be called once in the program
151 gnutls_x509_crt_init(&x509_cert);
152 gnutls_x509_privkey_init(&x509_key);
159 // Needs the flag as it ignores a plain /rehash
160 OnModuleRehash(NULL,"ssl");
162 // Void return, guess we assume success
163 gnutls_certificate_set_dh_params(x509_cred, dh_params);
164 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnUserConnect,
165 I_OnEvent, I_OnHookIO };
166 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
168 ServerInstance->Modules->AddService(iohook);
169 ServerInstance->AddCommand(&starttls);
172 void OnRehash(User* user)
176 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
178 ListenSocket* port = ServerInstance->ports[i];
179 if (port->bind_tag->getString("ssl") != "gnutls")
182 const std::string& portid = port->bind_desc;
183 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
185 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
186 sslports.append(portid).append(";");
189 if (!sslports.empty())
190 sslports.erase(sslports.end() - 1);
193 void OnModuleRehash(User* user, const std::string ¶m)
199 std::string certfile;
204 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
206 cafile = Conf->getString("cafile", "conf/ca.pem");
207 crlfile = Conf->getString("crlfile", "conf/crl.pem");
208 certfile = Conf->getString("certfile", "conf/cert.pem");
209 keyfile = Conf->getString("keyfile", "conf/key.pem");
210 dh_bits = Conf->getInt("dhbits");
211 std::string hashname = Conf->getString("hash", "md5");
213 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
216 if (hashname == "md5")
217 hash = GNUTLS_DIG_MD5;
218 else if (hashname == "sha1")
219 hash = GNUTLS_DIG_SHA1;
221 throw ModuleException("Unknown hash type " + hashname);
228 // Deallocate the old credentials
229 gnutls_dh_params_deinit(dh_params);
230 gnutls_certificate_free_credentials(x509_cred);
235 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
236 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
238 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
239 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));
241 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
242 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));
246 reader.LoadFile(certfile);
247 std::string cert_string = reader.Contents();
248 gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() };
250 reader.LoadFile(keyfile);
251 std::string key_string = reader.Contents();
252 gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() };
254 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
255 if((ret = gnutls_x509_crt_import(x509_cert, &cert_datum, GNUTLS_X509_FMT_PEM)) < 0)
256 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + std::string(gnutls_strerror(ret)));
258 if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
259 throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
261 if((ret = gnutls_certificate_set_x509_key(x509_cred, &x509_cert, 1, x509_key)) < 0)
262 throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
264 gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
266 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
267 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
269 // This may be on a large (once a day or week) timer eventually.
273 void GenerateDHParams()
275 // Generate Diffie Hellman parameters - for use with DHE
276 // kx algorithms. These should be discarded and regenerated
277 // once a day, once a week or once a month. Depending on the
278 // security requirements.
282 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
283 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
288 gnutls_x509_crt_deinit(x509_cert);
289 gnutls_x509_privkey_deinit(x509_key);
292 gnutls_dh_params_deinit(dh_params);
293 gnutls_certificate_free_credentials(x509_cred);
295 gnutls_global_deinit();
299 void OnCleanup(int target_type, void* item)
301 if(target_type == TYPE_USER)
303 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
305 if (user && user->eh.GetIOHook() == this)
307 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
308 // Potentially there could be multiple SSL modules loaded at once on different ports.
309 ServerInstance->Users->QuitUser(user, "SSL module unloading");
316 return Version("Provides SSL support for clients", VF_VENDOR);
320 void On005Numeric(std::string &output)
322 if (!sslports.empty())
323 output.append(" SSL=" + sslports);
324 output.append(" STARTTLS");
327 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
329 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "gnutls")
331 /* Hook the user with our module */
332 user->AddIOHook(this);
336 void OnRequest(Request& request)
338 if (strcmp("GET_SSL_CERT", request.id) == 0)
340 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
341 int fd = req.sock->GetFd();
342 issl_session* session = &sessions[fd];
344 req.cert = session->cert;
348 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
350 int fd = user->GetFd();
351 issl_session* session = &sessions[fd];
353 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
357 gnutls_init(&session->sess, GNUTLS_SERVER);
359 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
360 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
361 gnutls_dh_set_prime_bits(session->sess, dh_bits);
363 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
364 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
365 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
367 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
369 Handshake(session, user);
372 void OnStreamSocketConnect(StreamSocket* user)
374 issl_session* session = &sessions[user->GetFd()];
376 gnutls_init(&session->sess, GNUTLS_CLIENT);
378 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
379 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
380 gnutls_dh_set_prime_bits(session->sess, dh_bits);
381 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
382 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
383 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
385 Handshake(session, user);
388 void OnStreamSocketClose(StreamSocket* user)
390 CloseSession(&sessions[user->GetFd()]);
393 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
395 issl_session* session = &sessions[user->GetFd()];
399 CloseSession(session);
400 user->SetError("No SSL session");
404 if (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE)
406 // The handshake isn't finished, try to finish it.
408 if(!Handshake(session, user))
410 if (session->status != ISSL_CLOSING)
416 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
418 if (session->status == ISSL_HANDSHAKEN)
420 char* buffer = ServerInstance->GetReadBuffer();
421 size_t bufsiz = ServerInstance->Config->NetBufferSize;
422 int ret = gnutls_record_recv(session->sess, buffer, bufsiz);
425 recvq.append(buffer, ret);
428 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
434 user->SetError("SSL Connection closed");
435 CloseSession(session);
440 user->SetError(gnutls_strerror(ret));
441 CloseSession(session);
445 else if (session->status == ISSL_CLOSING)
451 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq)
453 issl_session* session = &sessions[user->GetFd()];
457 CloseSession(session);
458 user->SetError("No SSL session");
462 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
464 // The handshake isn't finished, try to finish it.
465 Handshake(session, user);
466 if (session->status != ISSL_CLOSING)
473 if (session->status == ISSL_HANDSHAKEN)
475 ret = gnutls_record_send(session->sess, sendq.data(), sendq.length());
477 if (ret == (int)sendq.length())
479 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE);
484 sendq = sendq.substr(ret);
485 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
488 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
490 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
495 CloseSession(session);
496 user->SetError("SSL Connection closed");
501 user->SetError(gnutls_strerror(ret));
502 CloseSession(session);
510 bool Handshake(issl_session* session, StreamSocket* user)
512 int ret = gnutls_handshake(session->sess);
516 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
518 // Handshake needs resuming later, read() or write() would have blocked.
520 if(gnutls_record_get_direction(session->sess) == 0)
522 // gnutls_handshake() wants to read() again.
523 session->status = ISSL_HANDSHAKING_READ;
524 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
528 // gnutls_handshake() wants to write() again.
529 session->status = ISSL_HANDSHAKING_WRITE;
530 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
535 user->SetError(std::string("Handshake Failed - ") + gnutls_strerror(ret));
536 CloseSession(session);
537 session->status = ISSL_CLOSING;
544 // Change the seesion state
545 session->status = ISSL_HANDSHAKEN;
547 VerifyCertificate(session,user);
549 // Finish writing, if any left
550 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
556 void OnUserConnect(LocalUser* user)
558 if (user->eh.GetIOHook() == this)
560 if (sessions[user->GetFd()].sess)
562 ssl_cert* cert = sessions[user->GetFd()].cert;
563 SSLCertSubmission(user, this, ServerInstance->Modules->Find("m_sslinfo.so"), cert);
564 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
565 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
566 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
567 if (cert->fingerprint.empty())
568 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
570 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
571 " and your SSL fingerprint is %s", user->nick.c_str(), cipher.c_str(), cert->fingerprint.c_str());
576 void CloseSession(issl_session* session)
580 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
581 gnutls_deinit(session->sess);
583 session->sess = NULL;
584 session->cert = NULL;
585 session->status = ISSL_NONE;
588 void VerifyCertificate(issl_session* session, StreamSocket* user)
590 if (!session->sess || !user || session->cert)
594 const gnutls_datum_t* cert_list;
596 unsigned int cert_list_size;
597 gnutls_x509_crt_t cert;
599 unsigned char digest[MAXBUF];
600 size_t digest_size = sizeof(digest);
601 size_t name_size = sizeof(name);
602 ssl_cert* certinfo = new ssl_cert;
603 session->cert = certinfo;
605 /* This verification function uses the trusted CAs in the credentials
606 * structure. So you must have installed one or more CA certificates.
608 ret = gnutls_certificate_verify_peers2(session->sess, &status);
612 certinfo->error = std::string(gnutls_strerror(ret));
616 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
617 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
618 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
619 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
621 /* Up to here the process is the same for X.509 certificates and
622 * OpenPGP keys. From now on X.509 certificates are assumed. This can
623 * be easily extended to work with openpgp keys as well.
625 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
627 certinfo->error = "No X509 keys sent";
631 ret = gnutls_x509_crt_init(&cert);
634 certinfo->error = gnutls_strerror(ret);
639 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
640 if (cert_list == NULL)
642 certinfo->error = "No certificate was found";
643 goto info_done_dealloc;
646 /* This is not a real world example, since we only check the first
647 * certificate in the given chain.
650 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
653 certinfo->error = gnutls_strerror(ret);
654 goto info_done_dealloc;
657 gnutls_x509_crt_get_dn(cert, name, &name_size);
660 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
661 certinfo->issuer = name;
663 if ((ret = gnutls_x509_crt_get_fingerprint(cert, hash, digest, &digest_size)) < 0)
665 certinfo->error = gnutls_strerror(ret);
669 certinfo->fingerprint = irc::hex(digest, digest_size);
672 /* Beware here we do not check for errors.
674 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
676 certinfo->error = "Not activated, or expired certificate";
680 gnutls_x509_crt_deinit(cert);
683 void OnEvent(Event& ev)
685 capHandler.HandleEvent(ev);
689 MODULE_INIT(ModuleSSLGnuTLS)