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") */
27 /* $CopyInstall: conf/key.pem $(CONPATH) -m 0400 -o $(INSTUID) */
28 /* $CopyInstall: conf/cert.pem $(CONPATH) -m 0444 */
30 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
32 static gnutls_x509_crt_t x509_cert;
33 static gnutls_x509_privkey_t x509_key;
34 static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs,
35 const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) {
37 st->type = GNUTLS_CRT_X509;
39 st->cert.x509 = &x509_cert;
40 st->key.x509 = x509_key;
46 static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t user_wrap, void* buffer, size_t size)
48 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
49 if (user->GetEventMask() & FD_READ_WILL_BLOCK)
54 int rv = recv(user->GetFd(), buffer, size, 0);
56 ServerInstance->SE->ChangeEventMask(user, FD_READ_WILL_BLOCK);
60 static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t user_wrap, const void* buffer, size_t size)
62 StreamSocket* user = reinterpret_cast<StreamSocket*>(user_wrap);
63 if (user->GetEventMask() & FD_WRITE_WILL_BLOCK)
68 int rv = send(user->GetFd(), buffer, size, 0);
70 ServerInstance->SE->ChangeEventMask(user, FD_WRITE_WILL_BLOCK);
74 /** Represents an SSL user's extra data
79 gnutls_session_t sess;
81 reference<ssl_cert> cert;
82 issl_session() : sess(NULL) {}
85 class CommandStartTLS : public SplitCommand
88 CommandStartTLS (Module* mod) : SplitCommand(mod, "STARTTLS")
90 works_before_reg = true;
93 CmdResult HandleLocal(const std::vector<std::string> ¶meters, LocalUser *user)
95 /* changed from == REG_ALL to catch clients sending STARTTLS
96 * after NICK and USER but before OnUserConnect completes and
97 * give a proper error message (see bug #645) - dz
99 if (user->registered != REG_NONE)
101 user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration has started", user->nick.c_str());
105 if (!user->eh.GetIOHook())
107 user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str());
108 user->eh.AddIOHook(creator);
109 creator->OnStreamSocketAccept(&user->eh, NULL, NULL);
112 user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str());
119 class ModuleSSLGnuTLS : public Module
121 issl_session* sessions;
123 gnutls_certificate_credentials x509_cred;
124 gnutls_dh_params dh_params;
125 gnutls_digest_algorithm_t hash;
127 std::string sslports;
132 CommandStartTLS starttls;
134 GenericCap capHandler;
135 ServiceProvider iohook;
139 : starttls(this), capHandler(this, "tls"), iohook(this, "ssl/gnutls", SERVICE_IOHOOK)
141 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
143 gnutls_global_init(); // This must be called once in the program
144 gnutls_x509_crt_init(&x509_cert);
145 gnutls_x509_privkey_init(&x509_key);
152 // Needs the flag as it ignores a plain /rehash
153 OnModuleRehash(NULL,"ssl");
155 // Void return, guess we assume success
156 gnutls_certificate_set_dh_params(x509_cred, dh_params);
157 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnUserConnect,
158 I_OnEvent, I_OnHookIO };
159 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
161 ServerInstance->Modules->AddService(iohook);
162 ServerInstance->AddCommand(&starttls);
165 void OnRehash(User* user)
169 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
171 ListenSocket* port = ServerInstance->ports[i];
172 if (port->bind_tag->getString("ssl") != "gnutls")
175 const std::string& portid = port->bind_desc;
176 ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str());
178 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
179 sslports.append(portid).append(";");
182 if (!sslports.empty())
183 sslports.erase(sslports.end() - 1);
186 void OnModuleRehash(User* user, const std::string ¶m)
192 std::string certfile;
197 ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls");
199 cafile = Conf->getString("cafile", "conf/ca.pem");
200 crlfile = Conf->getString("crlfile", "conf/crl.pem");
201 certfile = Conf->getString("certfile", "conf/cert.pem");
202 keyfile = Conf->getString("keyfile", "conf/key.pem");
203 dh_bits = Conf->getInt("dhbits");
204 std::string hashname = Conf->getString("hash", "md5");
206 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
209 if (hashname == "md5")
210 hash = GNUTLS_DIG_MD5;
211 else if (hashname == "sha1")
212 hash = GNUTLS_DIG_SHA1;
214 throw ModuleException("Unknown hash type " + hashname);
221 // Deallocate the old credentials
222 gnutls_dh_params_deinit(dh_params);
223 gnutls_certificate_free_credentials(x509_cred);
228 if((ret = gnutls_certificate_allocate_credentials(&x509_cred)) < 0)
229 ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to allocate certificate credentials: %s", gnutls_strerror(ret));
231 if((ret =gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
232 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));
234 if((ret = gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM)) < 0)
235 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));
239 reader.LoadFile(certfile);
240 std::string cert_string = reader.Contents();
241 gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() };
243 reader.LoadFile(keyfile);
244 std::string key_string = reader.Contents();
245 gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() };
247 // If this fails, no SSL port will work. At all. So, do the smart thing - throw a ModuleException
248 if((ret = gnutls_x509_crt_import(x509_cert, &cert_datum, GNUTLS_X509_FMT_PEM)) < 0)
249 throw ModuleException("Unable to load GnuTLS server certificate (" + certfile + "): " + std::string(gnutls_strerror(ret)));
251 if((ret = gnutls_x509_privkey_import(x509_key, &key_datum, GNUTLS_X509_FMT_PEM)) < 0)
252 throw ModuleException("Unable to load GnuTLS server private key (" + keyfile + "): " + std::string(gnutls_strerror(ret)));
254 if((ret = gnutls_certificate_set_x509_key(x509_cred, &x509_cert, 1, x509_key)) < 0)
255 throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret)));
257 gnutls_certificate_client_set_retrieve_function (x509_cred, cert_callback);
259 if((ret = gnutls_dh_params_init(&dh_params)) < 0)
260 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret));
262 // This may be on a large (once a day or week) timer eventually.
266 void GenerateDHParams()
268 // Generate Diffie Hellman parameters - for use with DHE
269 // kx algorithms. These should be discarded and regenerated
270 // once a day, once a week or once a month. Depending on the
271 // security requirements.
275 if((ret = gnutls_dh_params_generate2(dh_params, dh_bits)) < 0)
276 ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret));
281 gnutls_x509_crt_deinit(x509_cert);
282 gnutls_x509_privkey_deinit(x509_key);
285 gnutls_dh_params_deinit(dh_params);
286 gnutls_certificate_free_credentials(x509_cred);
288 gnutls_global_deinit();
292 void OnCleanup(int target_type, void* item)
294 if(target_type == TYPE_USER)
296 LocalUser* user = IS_LOCAL(static_cast<User*>(item));
298 if (user && user->eh.GetIOHook() == this)
300 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
301 // Potentially there could be multiple SSL modules loaded at once on different ports.
302 ServerInstance->Users->QuitUser(user, "SSL module unloading");
309 return Version("Provides SSL support for clients", VF_VENDOR);
313 void On005Numeric(std::string &output)
315 if (!sslports.empty())
316 output.append(" SSL=" + sslports);
317 output.append(" STARTTLS");
320 void OnHookIO(StreamSocket* user, ListenSocket* lsb)
322 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "gnutls")
324 /* Hook the user with our module */
325 user->AddIOHook(this);
329 void OnRequest(Request& request)
331 if (strcmp("GET_SSL_CERT", request.id) == 0)
333 SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
334 int fd = req.sock->GetFd();
335 issl_session* session = &sessions[fd];
337 req.cert = session->cert;
341 void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
343 int fd = user->GetFd();
344 issl_session* session = &sessions[fd];
346 /* For STARTTLS: Don't try and init a session on a socket that already has a session */
350 gnutls_init(&session->sess, GNUTLS_SERVER);
352 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
353 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
354 gnutls_dh_set_prime_bits(session->sess, dh_bits);
356 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
357 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
358 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
360 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
362 Handshake(session, user);
365 void OnStreamSocketConnect(StreamSocket* user)
367 issl_session* session = &sessions[user->GetFd()];
369 gnutls_init(&session->sess, GNUTLS_CLIENT);
371 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
372 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
373 gnutls_dh_set_prime_bits(session->sess, dh_bits);
374 gnutls_transport_set_ptr(session->sess, reinterpret_cast<gnutls_transport_ptr_t>(user));
375 gnutls_transport_set_push_function(session->sess, gnutls_push_wrapper);
376 gnutls_transport_set_pull_function(session->sess, gnutls_pull_wrapper);
378 Handshake(session, user);
381 void OnStreamSocketClose(StreamSocket* user)
383 CloseSession(&sessions[user->GetFd()]);
386 int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
388 issl_session* session = &sessions[user->GetFd()];
392 CloseSession(session);
393 user->SetError("No SSL session");
397 if (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE)
399 // The handshake isn't finished, try to finish it.
401 if(!Handshake(session, user))
403 if (session->status != ISSL_CLOSING)
409 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
411 if (session->status == ISSL_HANDSHAKEN)
413 char* buffer = ServerInstance->GetReadBuffer();
414 size_t bufsiz = ServerInstance->Config->NetBufferSize;
415 int ret = gnutls_record_recv(session->sess, buffer, bufsiz);
418 recvq.append(buffer, ret);
421 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
427 user->SetError("SSL Connection closed");
428 CloseSession(session);
433 user->SetError(gnutls_strerror(ret));
434 CloseSession(session);
438 else if (session->status == ISSL_CLOSING)
444 int OnStreamSocketWrite(StreamSocket* user, std::string& sendq)
446 issl_session* session = &sessions[user->GetFd()];
450 CloseSession(session);
451 user->SetError("No SSL session");
455 if (session->status == ISSL_HANDSHAKING_WRITE || session->status == ISSL_HANDSHAKING_READ)
457 // The handshake isn't finished, try to finish it.
458 Handshake(session, user);
459 if (session->status != ISSL_CLOSING)
466 if (session->status == ISSL_HANDSHAKEN)
468 ret = gnutls_record_send(session->sess, sendq.data(), sendq.length());
470 if (ret == (int)sendq.length())
472 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE);
477 sendq = sendq.substr(ret);
478 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
481 else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
483 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
488 CloseSession(session);
489 user->SetError("SSL Connection closed");
494 user->SetError(gnutls_strerror(ret));
495 CloseSession(session);
503 bool Handshake(issl_session* session, StreamSocket* user)
505 int ret = gnutls_handshake(session->sess);
509 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
511 // Handshake needs resuming later, read() or write() would have blocked.
513 if(gnutls_record_get_direction(session->sess) == 0)
515 // gnutls_handshake() wants to read() again.
516 session->status = ISSL_HANDSHAKING_READ;
517 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
521 // gnutls_handshake() wants to write() again.
522 session->status = ISSL_HANDSHAKING_WRITE;
523 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
528 user->SetError(std::string("Handshake Failed - ") + gnutls_strerror(ret));
529 CloseSession(session);
530 session->status = ISSL_CLOSING;
537 // Change the seesion state
538 session->status = ISSL_HANDSHAKEN;
540 VerifyCertificate(session,user);
542 // Finish writing, if any left
543 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
549 void OnUserConnect(LocalUser* user)
551 if (user->eh.GetIOHook() == this)
553 if (sessions[user->GetFd()].sess)
555 ssl_cert* cert = sessions[user->GetFd()].cert;
556 SSLCertSubmission(user, this, ServerInstance->Modules->Find("m_sslinfo.so"), cert);
557 std::string cipher = gnutls_kx_get_name(gnutls_kx_get(sessions[user->GetFd()].sess));
558 cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(sessions[user->GetFd()].sess))).append("-");
559 cipher.append(gnutls_mac_get_name(gnutls_mac_get(sessions[user->GetFd()].sess)));
560 if (cert->fingerprint.empty())
561 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str());
563 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
564 " and your SSL fingerprint is %s", user->nick.c_str(), cipher.c_str(), cert->fingerprint.c_str());
569 void CloseSession(issl_session* session)
573 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
574 gnutls_deinit(session->sess);
576 session->sess = NULL;
577 session->cert = NULL;
578 session->status = ISSL_NONE;
581 void VerifyCertificate(issl_session* session, StreamSocket* user)
583 if (!session->sess || !user || session->cert)
587 const gnutls_datum_t* cert_list;
589 unsigned int cert_list_size;
590 gnutls_x509_crt_t cert;
592 unsigned char digest[MAXBUF];
593 size_t digest_size = sizeof(digest);
594 size_t name_size = sizeof(name);
595 ssl_cert* certinfo = new ssl_cert;
596 session->cert = certinfo;
598 /* This verification function uses the trusted CAs in the credentials
599 * structure. So you must have installed one or more CA certificates.
601 ret = gnutls_certificate_verify_peers2(session->sess, &status);
605 certinfo->error = std::string(gnutls_strerror(ret));
609 certinfo->invalid = (status & GNUTLS_CERT_INVALID);
610 certinfo->unknownsigner = (status & GNUTLS_CERT_SIGNER_NOT_FOUND);
611 certinfo->revoked = (status & GNUTLS_CERT_REVOKED);
612 certinfo->trusted = !(status & GNUTLS_CERT_SIGNER_NOT_CA);
614 /* Up to here the process is the same for X.509 certificates and
615 * OpenPGP keys. From now on X.509 certificates are assumed. This can
616 * be easily extended to work with openpgp keys as well.
618 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
620 certinfo->error = "No X509 keys sent";
624 ret = gnutls_x509_crt_init(&cert);
627 certinfo->error = gnutls_strerror(ret);
632 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
633 if (cert_list == NULL)
635 certinfo->error = "No certificate was found";
636 goto info_done_dealloc;
639 /* This is not a real world example, since we only check the first
640 * certificate in the given chain.
643 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
646 certinfo->error = gnutls_strerror(ret);
647 goto info_done_dealloc;
650 gnutls_x509_crt_get_dn(cert, name, &name_size);
653 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
654 certinfo->issuer = name;
656 if ((ret = gnutls_x509_crt_get_fingerprint(cert, hash, digest, &digest_size)) < 0)
658 certinfo->error = gnutls_strerror(ret);
662 certinfo->fingerprint = irc::hex(digest, digest_size);
665 /* Beware here we do not check for errors.
667 if ((gnutls_x509_crt_get_expiration_time(cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(cert) > ServerInstance->Time()))
669 certinfo->error = "Not activated, or expired certificate";
673 gnutls_x509_crt_deinit(cert);
676 void OnEvent(Event& ev)
678 capHandler.HandleEvent(ev);
682 MODULE_INIT(ModuleSSLGnuTLS)