Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2004 Red Hat Inc. |
| 3 | * Copyright (C) 2005 Martin Koegler |
| 4 | * Copyright (C) 2010 TigerVNC Team |
| 5 | * |
| 6 | * This is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This software is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this software; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
| 19 | * USA. |
| 20 | */ |
| 21 | |
| 22 | #ifdef HAVE_CONFIG_H |
| 23 | #include <config.h> |
| 24 | #endif |
| 25 | |
Adam Tkac | df79970 | 2010-04-28 15:45:53 +0000 | [diff] [blame] | 26 | #ifndef HAVE_GNUTLS |
| 27 | #error "This source should not be compiled without HAVE_GNUTLS defined" |
| 28 | #endif |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 29 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 30 | #include <rfb/SSecurityTLS.h> |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 31 | #include <rfb/SConnection.h> |
| 32 | #include <rfb/LogWriter.h> |
| 33 | #include <rfb/Exception.h> |
| 34 | #include <rdr/TLSInStream.h> |
| 35 | #include <rdr/TLSOutStream.h> |
| 36 | |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 37 | #define DH_BITS 1024 /* XXX This should be configurable! */ |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 38 | |
| 39 | using namespace rfb; |
| 40 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 41 | StringParameter SSecurityTLS::X509_CertFile |
Pierre Ossman | 3d2a84b | 2014-09-17 16:45:35 +0200 | [diff] [blame^] | 42 | ("X509Cert", "Path to the X509 certificate in PEM format", "", ConfServer); |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 43 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 44 | StringParameter SSecurityTLS::X509_KeyFile |
Pierre Ossman | 3d2a84b | 2014-09-17 16:45:35 +0200 | [diff] [blame^] | 45 | ("X509Key", "Path to the key of the X509 certificate in PEM format", "", ConfServer); |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 46 | |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 47 | static LogWriter vlog("TLS"); |
Adam Tkac | 348269d | 2011-02-18 10:54:11 +0000 | [diff] [blame] | 48 | static LogWriter vlog_raw("RawTLS"); |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 49 | |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 50 | static void debug_log(int level, const char* str) |
| 51 | { |
Pierre Ossman | ad8609a | 2012-04-26 09:04:14 +0000 | [diff] [blame] | 52 | vlog.debug("[%d]: %s", level, str); |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 53 | } |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 54 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 55 | void SSecurityTLS::initGlobal() |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 56 | { |
| 57 | static bool globalInitDone = false; |
| 58 | |
| 59 | if (!globalInitDone) { |
| 60 | if (gnutls_global_init() != GNUTLS_E_SUCCESS) |
| 61 | throw AuthFailureException("gnutls_global_init failed"); |
| 62 | |
Adam Tkac | 348269d | 2011-02-18 10:54:11 +0000 | [diff] [blame] | 63 | /* 100 means debug log */ |
| 64 | if (vlog_raw.getLevel() >= 100) { |
| 65 | gnutls_global_set_log_level(10); |
| 66 | gnutls_global_set_log_function(debug_log); |
| 67 | } |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 68 | |
| 69 | globalInitDone = true; |
| 70 | } |
| 71 | } |
| 72 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 73 | SSecurityTLS::SSecurityTLS(bool _anon) : session(0), dh_params(0), |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 74 | anon_cred(0), cert_cred(0), |
| 75 | anon(_anon), fis(0), fos(0) |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 76 | { |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 77 | certfile = X509_CertFile.getData(); |
| 78 | keyfile = X509_KeyFile.getData(); |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 79 | } |
| 80 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 81 | void SSecurityTLS::shutdown() |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 82 | { |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 83 | if (session) { |
| 84 | if (gnutls_bye(session, GNUTLS_SHUT_RDWR) != GNUTLS_E_SUCCESS) { |
| 85 | /* FIXME: Treat as non-fatal error */ |
| 86 | vlog.error("TLS session wasn't terminated gracefully"); |
| 87 | } |
| 88 | } |
| 89 | |
| 90 | if (dh_params) { |
| 91 | gnutls_dh_params_deinit(dh_params); |
| 92 | dh_params = 0; |
| 93 | } |
| 94 | |
| 95 | if (anon_cred) { |
| 96 | gnutls_anon_free_server_credentials(anon_cred); |
| 97 | anon_cred = 0; |
| 98 | } |
| 99 | |
| 100 | if (cert_cred) { |
| 101 | gnutls_certificate_free_credentials(cert_cred); |
| 102 | cert_cred = 0; |
| 103 | } |
| 104 | |
| 105 | if (session) { |
| 106 | gnutls_deinit(session); |
| 107 | session = 0; |
| 108 | |
| 109 | gnutls_global_deinit(); |
| 110 | } |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 114 | SSecurityTLS::~SSecurityTLS() |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 115 | { |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 116 | shutdown(); |
| 117 | |
| 118 | if (fis) |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 119 | delete fis; |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 120 | if (fos) |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 121 | delete fos; |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 122 | |
| 123 | delete[] keyfile; |
| 124 | delete[] certfile; |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 125 | } |
| 126 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 127 | bool SSecurityTLS::processMsg(SConnection *sc) |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 128 | { |
| 129 | rdr::InStream* is = sc->getInStream(); |
| 130 | rdr::OutStream* os = sc->getOutStream(); |
| 131 | |
| 132 | vlog.debug("Process security message (session %p)", session); |
| 133 | |
| 134 | if (!session) { |
| 135 | initGlobal(); |
| 136 | |
| 137 | if (gnutls_init(&session, GNUTLS_SERVER) != GNUTLS_E_SUCCESS) |
| 138 | throw AuthFailureException("gnutls_init failed"); |
| 139 | |
| 140 | if (gnutls_set_default_priority(session) != GNUTLS_E_SUCCESS) |
| 141 | throw AuthFailureException("gnutls_set_default_priority failed"); |
| 142 | |
| 143 | try { |
| 144 | setParams(session); |
| 145 | } |
| 146 | catch(...) { |
| 147 | os->writeU8(0); |
| 148 | throw; |
| 149 | } |
| 150 | |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 151 | os->writeU8(1); |
| 152 | os->flush(); |
| 153 | } |
| 154 | |
Pierre Ossman | fe48cd4 | 2012-07-03 14:43:38 +0000 | [diff] [blame] | 155 | rdr::TLSInStream *tlsis = new rdr::TLSInStream(is, session); |
| 156 | rdr::TLSOutStream *tlsos = new rdr::TLSOutStream(os, session); |
| 157 | |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 158 | int err; |
Pierre Ossman | fe48cd4 | 2012-07-03 14:43:38 +0000 | [diff] [blame] | 159 | err = gnutls_handshake(session); |
| 160 | if (err != GNUTLS_E_SUCCESS) { |
| 161 | delete tlsis; |
| 162 | delete tlsos; |
| 163 | |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 164 | if (!gnutls_error_is_fatal(err)) { |
| 165 | vlog.debug("Deferring completion of TLS handshake: %s", gnutls_strerror(err)); |
| 166 | return false; |
| 167 | } |
| 168 | vlog.error("TLS Handshake failed: %s", gnutls_strerror (err)); |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 169 | shutdown(); |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 170 | throw AuthFailureException("TLS Handshake failed"); |
| 171 | } |
| 172 | |
| 173 | vlog.debug("Handshake completed"); |
| 174 | |
Pierre Ossman | fe48cd4 | 2012-07-03 14:43:38 +0000 | [diff] [blame] | 175 | sc->setStreams(fis = tlsis, fos = tlsos); |
Adam Tkac | dfe19cf | 2010-04-23 14:14:11 +0000 | [diff] [blame] | 176 | |
| 177 | return true; |
| 178 | } |
| 179 | |
Adam Tkac | 21b61a5 | 2010-07-21 09:19:00 +0000 | [diff] [blame] | 180 | void SSecurityTLS::setParams(gnutls_session session) |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 181 | { |
| 182 | static const int kx_anon_priority[] = { GNUTLS_KX_ANON_DH, 0 }; |
| 183 | static const int kx_priority[] = { GNUTLS_KX_DHE_DSS, GNUTLS_KX_RSA, |
| 184 | GNUTLS_KX_DHE_RSA, GNUTLS_KX_SRP, 0 }; |
| 185 | |
Adam Tkac | 6948ead | 2010-08-11 15:58:59 +0000 | [diff] [blame] | 186 | if (gnutls_kx_set_priority(session, anon ? kx_anon_priority : kx_priority) |
| 187 | != GNUTLS_E_SUCCESS) |
| 188 | throw AuthFailureException("gnutls_kx_set_priority failed"); |
Adam Tkac | f39671d | 2010-07-21 09:10:54 +0000 | [diff] [blame] | 189 | |
| 190 | if (gnutls_dh_params_init(&dh_params) != GNUTLS_E_SUCCESS) |
| 191 | throw AuthFailureException("gnutls_dh_params_init failed"); |
| 192 | |
| 193 | if (gnutls_dh_params_generate2(dh_params, DH_BITS) != GNUTLS_E_SUCCESS) |
| 194 | throw AuthFailureException("gnutls_dh_params_generate2 failed"); |
| 195 | |
| 196 | if (anon) { |
| 197 | if (gnutls_anon_allocate_server_credentials(&anon_cred) != GNUTLS_E_SUCCESS) |
| 198 | throw AuthFailureException("gnutls_anon_allocate_server_credentials failed"); |
| 199 | |
| 200 | gnutls_anon_set_server_dh_params(anon_cred, dh_params); |
| 201 | |
| 202 | if (gnutls_credentials_set(session, GNUTLS_CRD_ANON, anon_cred) |
| 203 | != GNUTLS_E_SUCCESS) |
| 204 | throw AuthFailureException("gnutls_credentials_set failed"); |
| 205 | |
| 206 | vlog.debug("Anonymous session has been set"); |
| 207 | |
| 208 | } else { |
| 209 | if (gnutls_certificate_allocate_credentials(&cert_cred) != GNUTLS_E_SUCCESS) |
| 210 | throw AuthFailureException("gnutls_certificate_allocate_credentials failed"); |
| 211 | |
| 212 | gnutls_certificate_set_dh_params(cert_cred, dh_params); |
| 213 | |
| 214 | if (gnutls_certificate_set_x509_key_file(cert_cred, certfile, keyfile, |
| 215 | GNUTLS_X509_FMT_PEM) != GNUTLS_E_SUCCESS) |
| 216 | throw AuthFailureException("load of key failed"); |
| 217 | |
| 218 | if (gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, cert_cred) |
| 219 | != GNUTLS_E_SUCCESS) |
| 220 | throw AuthFailureException("gnutls_credentials_set failed"); |
| 221 | |
| 222 | vlog.debug("X509 session has been set"); |
| 223 | |
| 224 | } |
| 225 | |
| 226 | } |