/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * InspIRCd: (C) 2002-2010 InspIRCd Development Team * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ #include "inspircd.h" #include #include #include #include "ssl.h" #include "m_cap.h" #ifdef WINDOWS #pragma comment(lib, "libgnutls-13.lib") #endif /* $ModDesc: Provides SSL support for clients */ /* $CompileFlags: pkgconfincludes("gnutls","/gnutls/gnutls.h","") */ /* $LinkerFlags: rpath("pkg-config --libs gnutls") pkgconflibs("gnutls","/libgnutls.so","-lgnutls") -lgcrypt */ enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED }; static gnutls_digest_algorithm_t hash; static int dh_bits; static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs, const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st); struct x509_cred : public refcountbase { std::vector certs; gnutls_x509_privkey_t key; gnutls_certificate_credentials cred; x509_cred(ConfigTag* tag, const std::string& ca_string, const std::string& crl_string, gnutls_dh_params dh_params) { FileReader reader; reader.LoadFile(tag->getString("certfile", "conf/cert.pem")); std::string cert_string = reader.Contents(); reader.LoadFile(tag->getString("keyfile", "conf/key.pem")); std::string key_string = reader.Contents(); int ret; gnutls_datum_t cert_datum = { (unsigned char*)cert_string.data(), cert_string.length() }; gnutls_datum_t key_datum = { (unsigned char*)key_string.data(), key_string.length() }; gnutls_datum_t ca_datum = { (unsigned char*)ca_string.data(), ca_string.length() }; gnutls_datum_t crl_datum = { (unsigned char*)crl_string.data(), crl_string.length() }; unsigned int certcount = tag->getInt("certcount", 3); certs.resize(certcount); ret = gnutls_x509_crt_list_import(&certs[0], &certcount, &cert_datum, GNUTLS_X509_FMT_PEM, GNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED); if (ret < 0) throw ModuleException("Unable to load GnuTLS server certificates: " + std::string(gnutls_strerror(ret))); certs.resize(certcount); ret = gnutls_x509_privkey_init(&key); if (ret < 0) throw ModuleException("GnuTLS memory allocation error " + std::string(gnutls_strerror(ret))); ret = gnutls_x509_privkey_import(key, &key_datum, GNUTLS_X509_FMT_PEM); if (ret < 0) throw ModuleException("Unable to load GnuTLS server private key: " + std::string(gnutls_strerror(ret))); ret = gnutls_certificate_allocate_credentials(&cred); if (ret < 0) throw ModuleException("GnuTLS memory allocation error " + std::string(gnutls_strerror(ret))); if (!ca_string.empty()) { ret = gnutls_certificate_set_x509_trust_mem(cred, &ca_datum, GNUTLS_X509_FMT_PEM); if (ret < 0) ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Could not set X.509 trust file: %s", gnutls_strerror(ret)); } if (!crl_string.empty()) { ret = gnutls_certificate_set_x509_crl_mem(cred, &crl_datum, GNUTLS_X509_FMT_PEM); if (ret < 0) ServerInstance->Logs->Log("m_ssl_gnutls",DEBUG, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", gnutls_strerror(ret)); } ret = gnutls_certificate_set_x509_key(cred, &certs[0], certcount, key); if (ret < 0) throw ModuleException("Unable to set GnuTLS cert/key pair: " + std::string(gnutls_strerror(ret))); gnutls_certificate_set_dh_params(cred, dh_params); gnutls_certificate_client_set_retrieve_function (cred, cert_callback); } ~x509_cred() { gnutls_certificate_free_credentials(cred); for(unsigned int i=0; i < certs.size(); i++) gnutls_x509_crt_deinit(certs[i]); gnutls_x509_privkey_deinit(key); } }; static ssize_t gnutls_pull_wrapper(gnutls_transport_ptr_t user_wrap, void* buffer, size_t size) { StreamSocket* user = reinterpret_cast(user_wrap); if (user->GetEventMask() & FD_READ_WILL_BLOCK) { errno = EAGAIN; return -1; } int rv = recv(user->GetFd(), buffer, size, 0); if (rv < (int)size) ServerInstance->SE->ChangeEventMask(user, FD_READ_WILL_BLOCK); return rv; } static ssize_t gnutls_push_wrapper(gnutls_transport_ptr_t user_wrap, const void* buffer, size_t size) { StreamSocket* user = reinterpret_cast(user_wrap); if (user->GetEventMask() & FD_WRITE_WILL_BLOCK) { errno = EAGAIN; return -1; } int rv = send(user->GetFd(), buffer, size, 0); if (rv < (int)size) ServerInstance->SE->ChangeEventMask(user, FD_WRITE_WILL_BLOCK); return rv; } class RandGen : public HandlerBase2 { public: RandGen() {} void Call(char* buffer, size_t len) { gcry_randomize(buffer, len, GCRY_STRONG_RANDOM); } }; class GnuTLSHook : public IOHook { public: gnutls_session_t sess; issl_status status; reference cert; reference creds; GnuTLSHook(Module* Creator, bool client, StreamSocket* user, x509_cred* mycert) : IOHook(Creator), sess(NULL), status(ISSL_HANDSHAKING), creds(mycert) { int rv; rv = gnutls_init(&sess, client ? GNUTLS_CLIENT : GNUTLS_SERVER); if (rv < 0) throw ModuleException("Cannot init"); rv = gnutls_set_default_priority(sess); if (rv < 0) throw ModuleException("Cannot set priority"); rv = gnutls_credentials_set(sess, GNUTLS_CRD_CERTIFICATE, creds->cred); if (rv < 0) throw ModuleException("Cannot set credentials"); gnutls_dh_set_prime_bits(sess, dh_bits); gnutls_transport_set_ptr(sess, reinterpret_cast(user)); gnutls_transport_set_push_function(sess, gnutls_push_wrapper); gnutls_transport_set_pull_function(sess, gnutls_pull_wrapper); if (!client) gnutls_certificate_server_set_request(sess, GNUTLS_CERT_REQUEST); // Request client certificate if any. user->SetIOHook(this); } ~GnuTLSHook() { OnClose(NULL); } void OnClose(StreamSocket* user) { if (sess) { gnutls_bye(sess, GNUTLS_SHUT_WR); gnutls_deinit(sess); } sess = NULL; cert = NULL; status = ISSL_NONE; } void VerifyCertificate(StreamSocket* user) { unsigned int result; const gnutls_datum_t* cert_list; int ret; unsigned int cert_list_size; gnutls_x509_crt_t raw_cert; char name[MAXBUF]; unsigned char digest[MAXBUF]; size_t digest_size = sizeof(digest); size_t name_size = sizeof(name); ssl_cert* certinfo = new ssl_cert; cert = certinfo; /* This verification function uses the trusted CAs in the credentials * structure. So you must have installed one or more CA certificates. */ ret = gnutls_certificate_verify_peers2(sess, &result); if (ret < 0) { certinfo->error = std::string(gnutls_strerror(ret)); return; } certinfo->invalid = (result & GNUTLS_CERT_INVALID); certinfo->unknownsigner = (result & GNUTLS_CERT_SIGNER_NOT_FOUND); certinfo->revoked = (result & GNUTLS_CERT_REVOKED); certinfo->trusted = !(result & GNUTLS_CERT_SIGNER_NOT_CA); /* Up to here the process is the same for X.509 certificates and * OpenPGP keys. From now on X.509 certificates are assumed. This can * be easily extended to work with openpgp keys as well. */ if (gnutls_certificate_type_get(sess) != GNUTLS_CRT_X509) { certinfo->error = "No X509 keys sent"; return; } ret = gnutls_x509_crt_init(&raw_cert); if (ret < 0) { certinfo->error = gnutls_strerror(ret); return; } cert_list_size = 0; cert_list = gnutls_certificate_get_peers(sess, &cert_list_size); if (cert_list == NULL) { certinfo->error = "No certificate was found"; goto info_done_dealloc; } /* This is not a real world example, since we only check the first * certificate in the given chain. */ ret = gnutls_x509_crt_import(raw_cert, &cert_list[0], GNUTLS_X509_FMT_DER); if (ret < 0) { certinfo->error = gnutls_strerror(ret); goto info_done_dealloc; } gnutls_x509_crt_get_dn(raw_cert, name, &name_size); certinfo->dn = name; gnutls_x509_crt_get_issuer_dn(raw_cert, name, &name_size); certinfo->issuer = name; if ((ret = gnutls_x509_crt_get_fingerprint(raw_cert, hash, digest, &digest_size)) < 0) { certinfo->error = gnutls_strerror(ret); } else { certinfo->fingerprint = irc::hex(digest, digest_size); } /* Beware here we do not check for errors. */ if ((gnutls_x509_crt_get_expiration_time(raw_cert) < ServerInstance->Time()) || (gnutls_x509_crt_get_activation_time(raw_cert) > ServerInstance->Time())) { certinfo->error = "Not activated, or expired certificate"; } info_done_dealloc: gnutls_x509_crt_deinit(raw_cert); } int OnRead(StreamSocket* user, std::string& recvq) { if (!sess) { user->SetError("No SSL session"); return -1; } if (status == ISSL_HANDSHAKING) { // The handshake isn't finished, try to finish it. if(!Handshake(user)) { if (status != ISSL_CLOSING) return 0; return -1; } } // If we resumed the handshake then status will be ISSL_HANDSHAKEN. if (status == ISSL_HANDSHAKEN) { char* buffer = ServerInstance->GetReadBuffer(); size_t bufsiz = ServerInstance->Config->NetBufferSize; int ret = gnutls_record_recv(sess, buffer, bufsiz); if (ret > 0) { recvq.append(buffer, ret); return 1; } else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED) { return 0; } else if (ret == 0) { user->SetError("SSL Connection closed"); OnClose(user); return -1; } else { user->SetError(gnutls_strerror(ret)); OnClose(user); return -1; } } else if (status == ISSL_CLOSING) return -1; return 0; } int OnWrite(StreamSocket* user, std::string& sendq) { if (!sess) { user->SetError("No SSL session"); return -1; } if (status == ISSL_HANDSHAKING) { // The handshake isn't finished, try to finish it. Handshake(user); if (status != ISSL_CLOSING) return 0; return -1; } int ret = 0; if (status == ISSL_HANDSHAKEN) { ret = gnutls_record_send(sess, sendq.data(), sendq.length()); if (ret == (int)sendq.length()) { ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_WRITE); return 1; } else if (ret > 0) { sendq = sendq.substr(ret); ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE); return 0; } else if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED) { ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE); return 0; } else if (ret == 0) { user->SetError("SSL Connection closed"); OnClose(user); return -1; } else // (ret < 0) { user->SetError(gnutls_strerror(ret)); OnClose(user); return -1; } } return 0; } bool Handshake(StreamSocket* user) { int ret = gnutls_handshake(sess); if (ret < 0) { if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED) { // Handshake needs resuming later, read() or write() would have blocked. if(gnutls_record_get_direction(sess) == 0) { // gnutls_handshake() wants to read() again. ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE); } else { // gnutls_handshake() wants to write() again. ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE); } } else { user->SetError(std::string("Handshake Failed - ") + gnutls_strerror(ret)); status = ISSL_CLOSING; OnClose(user); } return false; } else { // Change the seesion state status = ISSL_HANDSHAKEN; VerifyCertificate(user); // Finish writing, if any left ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE); return true; } } }; class GnuTLSProvider : public IOHookProvider { public: reference def_creds; std::map > creds; GnuTLSProvider(Module* Creator) : IOHookProvider(Creator, "ssl/gnutls") {} void OnClientConnection(StreamSocket* user, ConfigTag* tag) { std::string cred = tag->getString("ssl_cert"); std::map >::iterator i = creds.find(cred); new GnuTLSHook(creator, true, user, i == creds.end() ? def_creds : i->second); } void OnServerConnection(StreamSocket* user, ListenSocket* from) { std::string cred = from ? from->bind_tag->getString("ssl_cert") : "starttls"; std::map >::iterator i = creds.find(cred); new GnuTLSHook(creator, false, user, i == creds.end() ? def_creds : i->second); } }; /** Client cert getter */ static int cert_callback (gnutls_session_t session, const gnutls_datum_t * req_ca_rdn, int nreqs, const gnutls_pk_algorithm_t * sign_algos, int sign_algos_length, gnutls_retr_st * st) { StreamSocket* socket = reinterpret_cast(gnutls_transport_get_ptr(session)); GnuTLSHook* hook = static_cast(socket->GetIOHook()); st->type = GNUTLS_CRT_X509; st->cert.x509 = &hook->creds->certs[0]; st->key.x509 = hook->creds->key; st->ncerts = hook->creds->certs.size(); st->deinit_all = 0; return 0; } class CommandStartTLS : public SplitCommand { public: bool enabled; GnuTLSProvider& prov; CommandStartTLS (Module* mod, GnuTLSProvider& Prov) : SplitCommand(mod, "STARTTLS"), prov(Prov) { enabled = true; works_before_reg = true; } CmdResult HandleLocal(const std::vector ¶meters, LocalUser *user) { if (!enabled) { user->WriteNumeric(691, "%s :STARTTLS is not enabled", user->nick.c_str()); return CMD_FAILURE; } if (user->registered == REG_ALL) { user->WriteNumeric(691, "%s :STARTTLS is not permitted after client registration is complete", user->nick.c_str()); } else { if (!user->eh.GetIOHook()) { user->WriteNumeric(670, "%s :STARTTLS successful, go ahead with TLS handshake", user->nick.c_str()); /* We need to flush the write buffer prior to adding the IOHook, * otherwise we'll be sending this line inside the SSL session - which * won't start its handshake until the client gets this line. Currently, * we assume the write will not block here; this is usually safe, as * STARTTLS is sent very early on in the registration phase, where the * user hasn't built up much sendq. Handling a blocked write here would * be very annoying. */ user->eh.DoWrite(); prov.OnServerConnection(&user->eh, NULL); } else user->WriteNumeric(691, "%s :STARTTLS failure", user->nick.c_str()); } return CMD_FAILURE; } }; class ModuleSSLGnuTLS : public Module { gnutls_dh_params dh_params; RandGen randhandler; GenericCap capHandler; GnuTLSProvider iohook; CommandStartTLS starttls; int once_in_a_while; std::string sslports; public: ModuleSSLGnuTLS() : capHandler(this, "tls"), iohook(this), starttls(this, iohook), once_in_a_while(0) { gnutls_global_init(); // This must be called once in the program int ret = gnutls_dh_params_init(&dh_params); if (ret < 0) ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters: %s", gnutls_strerror(ret)); } void init() { OnModuleRehash(NULL,"ssl"); OnGarbageCollect(); ServerInstance->GenRandom = &randhandler; // Void return, guess we assume success Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnUserConnect, I_OnEvent, I_OnGarbageCollect }; ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation)); ServerInstance->Modules->AddService(iohook); ServerInstance->AddCommand(&starttls); } void OnRehash(User* user) { sslports.clear(); ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls"); starttls.enabled = Conf->getBool("starttls", true); if (Conf->getBool("showports", true)) { for (size_t i = 0; i < ServerInstance->ports.size(); i++) { ListenSocket* port = ServerInstance->ports[i]; if (port->bind_tag->getString("ssl") != "gnutls") continue; const std::string& portid = port->bind_desc; ServerInstance->Logs->Log("m_ssl_gnutls", DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %s", portid.c_str()); if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1") sslports.append(portid).append(";"); } if (!sslports.empty()) sslports.erase(sslports.end() - 1); } } void OnModuleRehash(User* user, const std::string ¶m) { if(param != "ssl") return; OnRehash(user); ConfigTag* Conf = ServerInstance->Config->ConfValue("gnutls"); dh_bits = Conf->getInt("dhbits"); std::string hashname = Conf->getString("hash", "md5"); if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096)) dh_bits = 1024; if (hashname == "md5") hash = GNUTLS_DIG_MD5; else if (hashname == "sha1") hash = GNUTLS_DIG_SHA1; else throw ModuleException("Unknown hash type " + hashname); FileReader reader; reader.LoadFile(Conf->getString("cafile", "conf/ca.pem")); std::string ca_string = reader.Contents(); reader.LoadFile(Conf->getString("crlfile", "conf/crl.pem")); std::string crl_string = reader.Contents(); iohook.def_creds = new x509_cred(Conf, ca_string, crl_string, dh_params); iohook.creds.clear(); ConfigTagList tags = ServerInstance->Config->ConfTags("ssl_cert"); while (tags.first != tags.second) { ConfigTag* tag = tags.first->second; std::string name = tag->getString("name"); if (name.empty()) throw ModuleException("Invalid without name at " + tag->getTagLocation()); iohook.creds[name] = new x509_cred(tag, ca_string, crl_string, dh_params); tags.first++; } } void OnGarbageCollect() { // Generate Diffie Hellman parameters - for use with DHE // kx algorithms. These should be discarded and regenerated // once a day, once a week or once a month. Depending on the // security requirements. if (once_in_a_while++ & 0xFF) return; int ret = gnutls_dh_params_generate2(dh_params, dh_bits); if(ret < 0) ServerInstance->Logs->Log("m_ssl_gnutls",DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits): %s", dh_bits, gnutls_strerror(ret)); } ~ModuleSSLGnuTLS() { iohook.creds.clear(); iohook.def_creds = NULL; gnutls_dh_params_deinit(dh_params); gnutls_global_deinit(); ServerInstance->GenRandom = &ServerInstance->HandleGenRandom; } void OnCleanup(int target_type, void* item) { if(target_type == TYPE_USER) { LocalUser* user = IS_LOCAL(static_cast(item)); if (user && user->eh.GetIOHook() && user->eh.GetIOHook()->creator == this) { // User is using SSL, they're a local user, and they're using one of *our* SSL ports. // Potentially there could be multiple SSL modules loaded at once on different ports. ServerInstance->Users->QuitUser(user, "SSL module unloading"); } } } Version GetVersion() { return Version("Provides SSL support for clients", VF_VENDOR); } void On005Numeric(std::string &output) { if (!sslports.empty()) output.append(" SSL=" + sslports); if (starttls.enabled) output.append(" STARTTLS"); } void OnRequest(Request& request) { if (strcmp("GET_SSL_CERT", request.id) == 0) { SocketCertificateRequest& req = static_cast(request); GnuTLSHook* hook = static_cast(req.sock->GetIOHook()); req.cert = hook->cert; } } void OnUserConnect(LocalUser* user) { GnuTLSHook* hook = static_cast(user->eh.GetIOHook()); if (hook && hook->creator == this) { ssl_cert* cert = hook->cert; std::string cipher = gnutls_kx_get_name(gnutls_kx_get(hook->sess)); cipher.append("-").append(gnutls_cipher_get_name(gnutls_cipher_get(hook->sess))).append("-"); cipher.append(gnutls_mac_get_name(gnutls_mac_get(hook->sess))); if (cert->fingerprint.empty()) user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), cipher.c_str()); else user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"" " and your SSL fingerprint is %s", user->nick.c_str(), cipher.c_str(), cert->fingerprint.c_str()); } } void OnEvent(Event& ev) { if (starttls.enabled) capHandler.HandleEvent(ev); } }; MODULE_INIT(ModuleSSLGnuTLS)