22#include <freerdp/config.h>
24#include "../core/settings.h"
26#include <winpr/assert.h>
31#include <winpr/winpr.h>
32#include <winpr/string.h>
33#include <winpr/sspi.h>
35#include <winpr/json.h>
37#include <winpr/stream.h>
38#include <freerdp/utils/ringbuffer.h>
40#include <freerdp/crypto/certificate.h>
41#include <freerdp/crypto/certificate_data.h>
42#include <freerdp/utils/helpers.h>
44#include <freerdp/log.h>
45#include "../crypto/tls.h"
46#include "../core/tcp.h"
48#include "opensslcompat.h"
49#include "certificate.h"
50#include "privatekey.h"
51#include "../core/utils.h"
53#ifdef WINPR_HAVE_POLL_H
57#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
58#include <valgrind/memcheck.h>
61#define TAG FREERDP_TAG("crypto")
89#ifdef WITH_TLS_DATA_LIMIT
97#ifdef WITH_TLS_DATA_LIMIT
103static const UINT64 TLS_DATA_LIMIT_BYTES = 388736063996ULL;
106static INIT_ONCE g_BioMethodsOnce = INIT_ONCE_STATIC_INIT;
107static BIO_METHOD* g_BioMethods =
nullptr;
109static INIT_ONCE secrets_file_idx_once = INIT_ONCE_STATIC_INIT;
110static int secrets_file_idx = -1;
113static int tls_verify_certificate(rdpTls* tls,
const rdpCertificate* cert,
const char* hostname,
116static void tls_print_certificate_name_mismatch_error(
const rdpCertificate* cert,
117 const char* hostname, UINT16 port);
119static void tls_print_new_certificate_warn(rdpCertificateStore* store,
const char* hostname,
120 UINT16 port,
const char* type,
const char* fingerprint);
122static void tls_print_certificate_error(rdpCertificateStore* store, rdpCertificateData* stored_data,
123 const char* hostname, UINT16 port,
const char* fingerprint);
125static void free_tls_public_key(rdpTls* tls)
128 free(tls->PublicKey);
129 tls->PublicKey =
nullptr;
130 tls->PublicKeyLength = 0;
138 free(bindings->Bindings);
142#ifdef WITH_TLS_DATA_LIMIT
148static void bio_rdp_tls_account(BIO_RDP_TLS* tls, BOOL read,
int count)
150 UINT64* counter = read ? &tls->rxBytes : &tls->txBytes;
152 if (!tls->rekeyAvailable || tls->cutPending)
155 *counter += (UINT64)count;
156 if (*counter < TLS_DATA_LIMIT_BYTES)
159 if (SSL_version(tls->ssl) != TLS1_3_VERSION)
161 WLog_DBG(TAG,
"TLS data limit reached but connection is not TLS 1.3; "
162 "rekey unavailable, keeping connection");
163 tls->rekeyAvailable = FALSE;
167 if (SSL_key_update(tls->ssl, SSL_KEY_UPDATE_REQUESTED) != 1)
169 WLog_ERR(TAG,
"SSL_key_update failed at TLS data limit; cutting connection");
170 tls->cutPending = TRUE;
174 WLog_INFO(TAG,
"TLS 1.3 key update requested at data limit (%" PRIu64
" bytes %s)", *counter,
175 read ?
"read" :
"written");
179static void bio_rdp_tls_read_account(BIO_RDP_TLS* tls,
int count)
181 bio_rdp_tls_account(tls, TRUE, count);
184static void bio_rdp_tls_write_account(BIO_RDP_TLS* tls,
int count)
186 bio_rdp_tls_account(tls, FALSE, count);
191static int bio_rdp_tls_write(BIO* bio,
const char* buf,
int size)
195 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
200#ifdef WITH_TLS_DATA_LIMIT
203 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
208 BIO_clear_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_READ | BIO_FLAGS_IO_SPECIAL);
209 BIO_clear_retry_flags(bio);
210 EnterCriticalSection(&tls->lock);
211 status = SSL_write(tls->ssl, buf, size);
212 error = SSL_get_error(tls->ssl, status);
213#ifdef WITH_TLS_DATA_LIMIT
215 bio_rdp_tls_write_account(tls, status);
217 LeaveCriticalSection(&tls->lock);
224 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
227 case SSL_ERROR_WANT_WRITE:
228 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
231 case SSL_ERROR_WANT_READ:
232 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
235 case SSL_ERROR_WANT_X509_LOOKUP:
236 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
237 BIO_set_retry_reason(bio, BIO_RR_SSL_X509_LOOKUP);
240 case SSL_ERROR_WANT_CONNECT:
241 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
242 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
245 case SSL_ERROR_SYSCALL:
246 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
250 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
261static int bio_rdp_tls_read(BIO* bio,
char* buf,
int size)
265 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
270#ifdef WITH_TLS_DATA_LIMIT
273 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
278 BIO_clear_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_READ | BIO_FLAGS_IO_SPECIAL);
279 BIO_clear_retry_flags(bio);
280 EnterCriticalSection(&tls->lock);
281 status = SSL_read(tls->ssl, buf, size);
282 error = SSL_get_error(tls->ssl, status);
283#ifdef WITH_TLS_DATA_LIMIT
285 bio_rdp_tls_read_account(tls, status);
287 LeaveCriticalSection(&tls->lock);
295 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
298 case SSL_ERROR_WANT_READ:
299 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
302 case SSL_ERROR_WANT_WRITE:
303 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
306 case SSL_ERROR_WANT_X509_LOOKUP:
307 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
308 BIO_set_retry_reason(bio, BIO_RR_SSL_X509_LOOKUP);
311 case SSL_ERROR_WANT_ACCEPT:
312 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
313 BIO_set_retry_reason(bio, BIO_RR_ACCEPT);
316 case SSL_ERROR_WANT_CONNECT:
317 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
318 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
322 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
325 case SSL_ERROR_ZERO_RETURN:
326 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
329 case SSL_ERROR_SYSCALL:
330 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
337#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
341 VALGRIND_MAKE_MEM_DEFINED(buf, status);
349static int bio_rdp_tls_puts(BIO* bio,
const char* str)
354 const size_t max = (INT_MAX > SIZE_MAX) ? SIZE_MAX : INT_MAX;
355 const size_t size = strnlen(str, max);
359 return BIO_write(bio, str, (
int)size);
363static int bio_rdp_tls_gets(WINPR_ATTR_UNUSED BIO* bio, WINPR_ATTR_UNUSED
char* str,
364 WINPR_ATTR_UNUSED
int size)
370static long bio_rdp_tls_ctrl(BIO* bio,
int cmd,
long num,
void* ptr)
372 BIO* ssl_rbio =
nullptr;
373 BIO* ssl_wbio =
nullptr;
374 BIO* next_bio =
nullptr;
376 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
381 if (!tls->ssl && (cmd != BIO_C_SET_SSL))
384 next_bio = BIO_next(bio);
385 ssl_rbio = tls->ssl ? SSL_get_rbio(tls->ssl) : nullptr;
386 ssl_wbio = tls->ssl ? SSL_get_wbio(tls->ssl) : nullptr;
391 SSL_shutdown(tls->ssl);
393 if (SSL_in_connect_init(tls->ssl))
394 SSL_set_connect_state(tls->ssl);
395 else if (SSL_in_accept_init(tls->ssl))
396 SSL_set_accept_state(tls->ssl);
401 status = BIO_ctrl(next_bio, cmd, num, ptr);
403 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
410 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
417 case BIO_CTRL_SET_CALLBACK:
421 case BIO_CTRL_GET_CALLBACK:
428 void* vptr = WINPR_FUNC_PTR_CAST(SSL_get_info_callback(tls->ssl),
void*);
429 *((
void**)ptr) = vptr;
436 SSL_set_connect_state(tls->ssl);
438 SSL_set_accept_state(tls->ssl);
443 case BIO_CTRL_GET_CLOSE:
444 status = BIO_get_shutdown(bio);
447 case BIO_CTRL_SET_CLOSE:
448 BIO_set_shutdown(bio, (
int)num);
452 case BIO_CTRL_WPENDING:
453 EnterCriticalSection(&tls->lock);
454 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
455 LeaveCriticalSection(&tls->lock);
458 case BIO_CTRL_PENDING:
459 status = SSL_pending(tls->ssl);
462 status = BIO_pending(ssl_rbio);
467 BIO_clear_retry_flags(bio);
470 EnterCriticalSection(&tls->lock);
471 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
472 LeaveCriticalSection(&tls->lock);
474 WLog_DBG(TAG,
"BIO_ctrl returned %ld", status);
475 BIO_copy_next_retry(bio);
480 if (next_bio && (next_bio != ssl_rbio))
482#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
483 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
484 SSL_set_bio(tls->ssl, next_bio, next_bio);
485 CRYPTO_add(&(bio->next_bio->references), 1, CRYPTO_LOCK_BIO);
491 BIO_up_ref(next_bio);
492 SSL_set_bio(tls->ssl, next_bio, next_bio);
504 if (ssl_rbio != ssl_wbio)
505 BIO_free_all(ssl_wbio);
507#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
508 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
511 CRYPTO_add(&(bio->next_bio->references), -1, CRYPTO_LOCK_BIO);
513 tls->ssl->wbio = tls->ssl->rbio =
nullptr;
516 SSL_set_bio(tls->ssl,
nullptr,
nullptr);
526 *((SSL**)ptr) = tls->ssl;
533 BIO_set_shutdown(bio, (
int)num);
537 tls->ssl = (SSL*)ptr;
538 ssl_rbio = SSL_get_rbio(tls->ssl);
544 BIO_push(ssl_rbio, next_bio);
546 BIO_set_next(bio, ssl_rbio);
547#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
548 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
549 CRYPTO_add(&(ssl_rbio->references), 1, CRYPTO_LOCK_BIO);
551 BIO_up_ref(ssl_rbio);
555 BIO_set_init(bio, 1);
559 case BIO_C_DO_STATE_MACHINE:
560 BIO_clear_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL);
561 BIO_set_retry_reason(bio, 0);
562 status = SSL_do_handshake(tls->ssl);
566 const int err = (status < INT32_MIN) ? INT32_MIN : (int)status;
567 switch (SSL_get_error(tls->ssl, err))
569 case SSL_ERROR_WANT_READ:
570 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
573 case SSL_ERROR_WANT_WRITE:
574 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
577 case SSL_ERROR_WANT_CONNECT:
578 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL | BIO_FLAGS_SHOULD_RETRY);
579 BIO_set_retry_reason(bio, BIO_get_retry_reason(next_bio));
583 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
591 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
599static int bio_rdp_tls_new(BIO* bio)
601 BIO_RDP_TLS* tls =
nullptr;
602 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
604 if (!(tls = calloc(1,
sizeof(BIO_RDP_TLS))))
607 if (!InitializeCriticalSectionAndSpinCount(&tls->lock, 4000))
613#ifdef WITH_TLS_DATA_LIMIT
616 tls->rekeyAvailable = TRUE;
619 BIO_set_data(bio, (
void*)tls);
624static int bio_rdp_tls_free(BIO* bio)
626 BIO_RDP_TLS* tls =
nullptr;
631 tls = (BIO_RDP_TLS*)BIO_get_data(bio);
636 BIO_set_data(bio,
nullptr);
637 if (BIO_get_shutdown(bio))
639 if (BIO_get_init(bio) && tls->ssl)
641 SSL_shutdown(tls->ssl);
645 BIO_set_init(bio, 0);
646 BIO_set_flags(bio, 0);
649 DeleteCriticalSection(&tls->lock);
656static long bio_rdp_tls_callback_ctrl(BIO* bio,
int cmd, bio_info_cb* fp)
663 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
670 case BIO_CTRL_SET_CALLBACK:
672 typedef void (*fkt_t)(
const SSL*, int, int);
678 fkt_t fkt = WINPR_FUNC_PTR_CAST(fp, fkt_t);
679 SSL_set_info_callback(tls->ssl, fkt);
685 status = BIO_callback_ctrl(SSL_get_rbio(tls->ssl), cmd, fp);
692#define BIO_TYPE_RDP_TLS 68
695static BOOL CALLBACK bio_rdp_tls_init_once(WINPR_ATTR_UNUSED
PINIT_ONCE once,
696 WINPR_ATTR_UNUSED PVOID param,
697 WINPR_ATTR_UNUSED PVOID* context)
699 g_BioMethods = BIO_meth_new(BIO_TYPE_RDP_TLS,
"RdpTls");
703 if (BIO_meth_set_write(g_BioMethods, bio_rdp_tls_write) != 1)
705 if (BIO_meth_set_read(g_BioMethods, bio_rdp_tls_read) != 1)
707 if (BIO_meth_set_puts(g_BioMethods, bio_rdp_tls_puts) != 1)
709 if (BIO_meth_set_gets(g_BioMethods, bio_rdp_tls_gets) != 1)
711 if (BIO_meth_set_ctrl(g_BioMethods, bio_rdp_tls_ctrl) != 1)
713 if (BIO_meth_set_create(g_BioMethods, bio_rdp_tls_new) != 1)
715 if (BIO_meth_set_destroy(g_BioMethods, bio_rdp_tls_free) != 1)
717 if (BIO_meth_set_callback_ctrl(g_BioMethods, bio_rdp_tls_callback_ctrl) != 1)
724static BIO_METHOD* BIO_s_rdp_tls(
void)
726 if (!InitOnceExecuteOnce(&g_BioMethodsOnce, bio_rdp_tls_init_once,
nullptr,
nullptr))
731WINPR_ATTR_MALLOC(BIO_free, 1)
732static BIO* BIO_new_rdp_tls(SSL_CTX* ctx,
int client)
734 BIO* bio = BIO_new(BIO_s_rdp_tls());
739 SSL* ssl = SSL_new(ctx);
748 SSL_set_connect_state(ssl);
750 SSL_set_accept_state(ssl);
752 BIO_set_ssl(bio, ssl, BIO_CLOSE);
756WINPR_ATTR_MALLOC(freerdp_certificate_free, 1)
757static rdpCertificate* tls_get_certificate(rdpTls* tls, BOOL peer)
759 X509* remote_cert =
nullptr;
762 remote_cert = SSL_get_peer_certificate(tls->ssl);
764 remote_cert = X509_dup(SSL_get_certificate(tls->ssl));
768 WLog_ERR(TAG,
"failed to get the server TLS certificate");
773 STACK_OF(X509)* chain = SSL_get_peer_cert_chain(tls->ssl);
774 rdpCertificate* cert = freerdp_certificate_new_from_x509(remote_cert, chain);
775 X509_free(remote_cert);
781static const char* tls_get_server_name(rdpTls* tls)
783 return tls->serverName ? tls->serverName : tls->hostname;
786#define TLS_SERVER_END_POINT "tls-server-end-point:"
788WINPR_ATTR_MALLOC(free_tls_bindings, 1)
791 size_t CertificateHashLength = 0;
792 BYTE* ChannelBindingToken =
nullptr;
794 const size_t PrefixLength = strnlen(TLS_SERVER_END_POINT, ARRAYSIZE(TLS_SERVER_END_POINT));
799 WINPR_MD_TYPE alg = freerdp_certificate_get_signature_alg(cert);
800 const char* hash =
nullptr;
806 hash = winpr_md_type_to_string(WINPR_MD_SHA256);
809 hash = winpr_md_type_to_string(alg);
815 char* CertificateHash = freerdp_certificate_get_hash(cert, hash, &CertificateHashLength);
816 if (!CertificateHash)
819 const size_t ChannelBindingTokenLength = PrefixLength + CertificateHashLength;
822 if (!ContextBindings)
827 if (slen > UINT32_MAX)
830 ContextBindings->BindingsLength = (UINT32)slen;
834 if (!ChannelBindings)
837 ContextBindings->Bindings = ChannelBindings;
838 ChannelBindings->cbApplicationDataLength = (UINT32)ChannelBindingTokenLength;
840 ChannelBindingToken = &((BYTE*)ChannelBindings)[ChannelBindings->dwApplicationDataOffset];
841 memcpy(ChannelBindingToken, TLS_SERVER_END_POINT, PrefixLength);
842 memcpy(ChannelBindingToken + PrefixLength, CertificateHash, CertificateHashLength);
843 free(CertificateHash);
844 return ContextBindings;
846 free(CertificateHash);
847 free(ContextBindings);
852static BOOL CALLBACK secrets_file_init_cb(WINPR_ATTR_UNUSED
PINIT_ONCE once,
853 WINPR_ATTR_UNUSED PVOID param,
854 WINPR_ATTR_UNUSED PVOID* context)
856 secrets_file_idx = SSL_get_ex_new_index(0,
nullptr,
nullptr,
nullptr,
nullptr);
858 return (secrets_file_idx != -1);
861static void SSLCTX_keylog_cb(
const SSL* ssl,
const char* line)
863 char* dfile =
nullptr;
865 if (secrets_file_idx == -1)
868 dfile = SSL_get_ex_data(ssl, secrets_file_idx);
871 FILE* f = winpr_fopen(dfile,
"a+");
874 (void)fwrite(line, strlen(line), 1, f);
875 (void)fwrite(
"\n", 1, 1, f);
881static void tls_reset(rdpTls* tls)
887 SSL_CTX_free(tls->ctx);
894 BIO_free_all(tls->bio);
895 else if (tls->underlying)
896 BIO_free_all(tls->underlying);
898 tls->underlying =
nullptr;
900 free_tls_public_key(tls);
901 free_tls_bindings(tls->Bindings);
902 tls->Bindings =
nullptr;
905#if OPENSSL_VERSION_NUMBER >= 0x010000000L
907static BOOL tls_prepare(rdpTls* tls, BIO* underlying,
const SSL_METHOD* method,
int options,
911static BOOL tls_prepare(rdpTls* tls, BIO* underlying, SSL_METHOD* method,
int options,
917 rdpSettings* settings = tls->context->settings;
918 WINPR_ASSERT(settings);
921 tls->ctx = SSL_CTX_new(method);
923 tls->underlying = underlying;
927 WLog_ERR(TAG,
"SSL_CTX_new failed");
931 SSL_CTX_set_mode(tls->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_ENABLE_PARTIAL_WRITE);
932 SSL_CTX_set_options(tls->ctx, WINPR_ASSERTING_INT_CAST(uint64_t, options));
933 SSL_CTX_set_read_ahead(tls->ctx, 1);
934#if OPENSSL_VERSION_NUMBER >= 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
936 if (!SSL_CTX_set_min_proto_version(tls->ctx, version))
938 WLog_ERR(TAG,
"SSL_CTX_set_min_proto_version %" PRIu16
" failed", version);
942 if (!SSL_CTX_set_max_proto_version(tls->ctx, version))
944 WLog_ERR(TAG,
"SSL_CTX_set_max_proto_version %" PRIu16
" failed", version);
948#if OPENSSL_VERSION_NUMBER >= 0x10100000L && !defined(LIBRESSL_VERSION_NUMBER)
949 SSL_CTX_set_security_level(tls->ctx, WINPR_ASSERTING_INT_CAST(
int, settings->TlsSecLevel));
952 if (settings->AllowedTlsCiphers)
954 if (!SSL_CTX_set_cipher_list(tls->ctx, settings->AllowedTlsCiphers))
956 WLog_ERR(TAG,
"SSL_CTX_set_cipher_list %s failed", settings->AllowedTlsCiphers);
961 tls->bio = BIO_new_rdp_tls(tls->ctx, clientMode);
965 WLog_ERR(TAG,
"unable to create TLS BIO");
969 if (BIO_get_ssl(tls->bio, &tls->ssl) < 0 || !tls->ssl)
971 WLog_ERR(TAG,
"unable to retrieve the SSL of the connection");
975 if (settings->TlsSecretsFile)
977#if OPENSSL_VERSION_NUMBER >= 0x10101000L
978 if (!InitOnceExecuteOnce(&secrets_file_idx_once, secrets_file_init_cb,
nullptr,
nullptr))
981 if (secrets_file_idx != -1)
983 SSL_set_ex_data(tls->ssl, secrets_file_idx, settings->TlsSecretsFile);
984 SSL_CTX_set_keylog_callback(tls->ctx, SSLCTX_keylog_cb);
987 WLog_WARN(TAG,
"Key-Logging not available - requires OpenSSL 1.1.1 or higher");
991 BIO_push(tls->bio, underlying);
996adjustSslOptions(WINPR_ATTR_UNUSED
int* options)
998 WINPR_ASSERT(options);
999#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1000 *options |= SSL_OP_NO_SSLv2;
1001 *options |= SSL_OP_NO_SSLv3;
1005const SSL_METHOD* freerdp_tls_get_ssl_method(BOOL isDtls, BOOL isClient)
1010 return DTLS_client_method();
1011#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1012 return SSLv23_client_method();
1014 return TLS_client_method();
1019 return DTLS_server_method();
1021#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1022 return SSLv23_server_method();
1024 return TLS_server_method();
1028TlsHandshakeResult freerdp_tls_connect_ex(rdpTls* tls, BIO* underlying,
const SSL_METHOD* methods)
1042#ifdef SSL_OP_NO_COMPRESSION
1043 options |= SSL_OP_NO_COMPRESSION;
1051 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1058 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1060 tls->isClientMode = TRUE;
1061 adjustSslOptions(&options);
1063 if (!tls_prepare(tls, underlying, methods, options, TRUE))
1064 return TLS_HANDSHAKE_ERROR;
1066#if !defined(OPENSSL_NO_TLSEXT)
1067 const char* str = tls_get_server_name(tls);
1068 void* ptr = WINPR_CAST_CONST_PTR_AWAY(str,
void*);
1069 SSL_set_tlsext_host_name(tls->ssl, ptr);
1072 return freerdp_tls_handshake(tls);
1075static int bio_err_print(
const char* str,
size_t len,
void* u)
1078 WLog_Print(log, WLOG_ERROR,
"[BIO_do_handshake] %s [%" PRIuz
"]", str, len);
1082TlsHandshakeResult freerdp_tls_handshake(rdpTls* tls)
1084 TlsHandshakeResult ret = TLS_HANDSHAKE_ERROR;
1087 const long status = BIO_do_handshake(tls->bio);
1090 if (!BIO_should_retry(tls->bio))
1092 wLog* log = WLog_Get(TAG);
1093 WLog_Print(log, WLOG_ERROR,
"BIO_do_handshake failed");
1094 ERR_print_errors_cb(bio_err_print, log);
1095 return TLS_HANDSHAKE_ERROR;
1098 return TLS_HANDSHAKE_CONTINUE;
1101 int verify_status = 0;
1102 rdpCertificate* cert = tls_get_certificate(tls, tls->isClientMode);
1106 WLog_ERR(TAG,
"tls_get_certificate failed to return the server certificate.");
1107 return TLS_HANDSHAKE_ERROR;
1112 free_tls_bindings(tls->Bindings);
1113 tls->Bindings = tls_get_channel_bindings(cert);
1116 WLog_ERR(TAG,
"unable to retrieve bindings");
1120 free_tls_public_key(tls);
1121 if (!freerdp_certificate_get_public_key(cert, &tls->PublicKey, &tls->PublicKeyLength))
1124 "freerdp_certificate_get_public_key failed to return the server public key.");
1129 ret = TLS_HANDSHAKE_SUCCESS;
1131 if (tls->isClientMode)
1133 WINPR_ASSERT(tls->port <= UINT16_MAX);
1135 tls_verify_certificate(tls, cert, tls_get_server_name(tls), (UINT16)tls->port);
1137 if (verify_status < 1)
1139 WLog_ERR(TAG,
"certificate not trusted, aborting.");
1140 freerdp_tls_send_alert(tls);
1141 ret = TLS_HANDSHAKE_VERIFY_ERROR;
1146 freerdp_certificate_free(cert);
1150static int pollAndHandshake(rdpTls* tls)
1156 HANDLE events[] = { freerdp_abort_event(tls->context),
nullptr };
1158 if (BIO_get_event(tls->bio, &events[1]) < 0)
1160 WLog_ERR(TAG,
"unable to retrieve BIO associated event");
1166 WLog_ERR(TAG,
"unable to retrieve BIO event");
1170 status = WaitForMultipleObjectsEx(ARRAYSIZE(events), events, FALSE, INFINITE, TRUE);
1173 case WAIT_OBJECT_0 + 1:
1176 WLog_DBG(TAG,
"Abort event set, cancel connect");
1179 case WAIT_IO_COMPLETION:
1182 WLog_ERR(TAG,
"error during WaitForSingleObject(): 0x%08" PRIX32
"", status);
1186 TlsHandshakeResult result = freerdp_tls_handshake(tls);
1189 case TLS_HANDSHAKE_CONTINUE:
1191 case TLS_HANDSHAKE_SUCCESS:
1193 case TLS_HANDSHAKE_ERROR:
1194 case TLS_HANDSHAKE_VERIFY_ERROR:
1201int freerdp_tls_connect(rdpTls* tls, BIO* underlying)
1203 const SSL_METHOD* method = freerdp_tls_get_ssl_method(FALSE, TRUE);
1206 TlsHandshakeResult result = freerdp_tls_connect_ex(tls, underlying, method);
1209 case TLS_HANDSHAKE_SUCCESS:
1211 case TLS_HANDSHAKE_CONTINUE:
1213 case TLS_HANDSHAKE_ERROR:
1214 case TLS_HANDSHAKE_VERIFY_ERROR:
1220 return pollAndHandshake(tls);
1223#if defined(MICROSOFT_IOS_SNI_BUG) && !defined(OPENSSL_NO_TLSEXT) && \
1224 !defined(LIBRESSL_VERSION_NUMBER)
1225static void tls_openssl_tlsext_debug_callback(SSL* s,
int client_server,
int type,
1226 unsigned char* data,
int len,
void* arg)
1228 if (type == TLSEXT_TYPE_server_name)
1230 WLog_DBG(TAG,
"Client uses SNI (extension disabled)");
1231 s->servername_done = 2;
1236BOOL freerdp_tls_accept(rdpTls* tls, BIO* underlying, rdpSettings* settings)
1239 TlsHandshakeResult res =
1240 freerdp_tls_accept_ex(tls, underlying, settings, freerdp_tls_get_ssl_method(FALSE, FALSE));
1243 case TLS_HANDSHAKE_SUCCESS:
1245 case TLS_HANDSHAKE_CONTINUE:
1247 case TLS_HANDSHAKE_ERROR:
1248 case TLS_HANDSHAKE_VERIFY_ERROR:
1253 return pollAndHandshake(tls) > 0;
1256TlsHandshakeResult freerdp_tls_accept_ex(rdpTls* tls, BIO* underlying, rdpSettings* settings,
1257 const SSL_METHOD* methods)
1270 options |= SSL_OP_NO_SSLv2;
1280#ifdef SSL_OP_NO_COMPRESSION
1281 options |= SSL_OP_NO_COMPRESSION;
1289 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1296 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1304#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && (OPENSSL_VERSION_NUMBER < 0x30000000L) && \
1305 !defined(LIBRESSL_VERSION_NUMBER)
1306 options |= SSL_OP_NO_RENEGOTIATION;
1309 if (!tls_prepare(tls, underlying, methods, options, FALSE))
1310 return TLS_HANDSHAKE_ERROR;
1315 WLog_ERR(TAG,
"invalid private key");
1316 return TLS_HANDSHAKE_ERROR;
1319 EVP_PKEY* privkey = freerdp_key_get_evp_pkey(key);
1322 WLog_ERR(TAG,
"invalid private key");
1323 return TLS_HANDSHAKE_ERROR;
1326 status = SSL_use_PrivateKey(tls->ssl, privkey);
1331 EVP_PKEY_free(privkey);
1335 WLog_ERR(TAG,
"SSL_CTX_use_PrivateKey_file failed");
1336 return TLS_HANDSHAKE_ERROR;
1339 rdpCertificate* cert =
1343 WLog_ERR(TAG,
"invalid certificate");
1344 return TLS_HANDSHAKE_ERROR;
1347 status = SSL_use_certificate(tls->ssl, freerdp_certificate_get_x509(cert));
1351 WLog_ERR(TAG,
"SSL_use_certificate_file failed");
1352 return TLS_HANDSHAKE_ERROR;
1355 const size_t cnt = freerdp_certificate_get_chain_len(cert);
1356 for (
size_t x = 0; x < cnt; x++)
1358 X509* xcert = freerdp_certificate_get_chain_at(cert, x);
1359 WINPR_ASSERT(xcert);
1360 const long rc = SSL_add1_chain_cert(tls->ssl, xcert);
1363 WLog_ERR(TAG,
"SSL_add1_chain_cert failed");
1364 return TLS_HANDSHAKE_ERROR;
1368#if defined(MICROSOFT_IOS_SNI_BUG) && !defined(OPENSSL_NO_TLSEXT) && \
1369 !defined(LIBRESSL_VERSION_NUMBER)
1370 SSL_set_tlsext_debug_callback(tls->ssl, tls_openssl_tlsext_debug_callback);
1373 return freerdp_tls_handshake(tls);
1376BOOL freerdp_tls_send_alert(rdpTls* tls)
1390#if (!defined(LIBRESSL_VERSION_NUMBER) && (OPENSSL_VERSION_NUMBER < 0x10100000L)) || \
1391 (defined(LIBRESSL_VERSION_NUMBER) && (LIBRESSL_VERSION_NUMBER <= 0x2080300fL))
1393 if (tls->alertDescription != TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY)
1404 SSL_SESSION* ssl_session = SSL_get_session(tls->ssl);
1405 SSL_CTX* ssl_ctx = SSL_get_SSL_CTX(tls->ssl);
1406 SSL_set_quiet_shutdown(tls->ssl, 1);
1408 if ((tls->alertLevel == TLS_ALERT_LEVEL_FATAL) && (ssl_session))
1409 SSL_CTX_remove_session(ssl_ctx, ssl_session);
1411 tls->ssl->s3->alert_dispatch = 1;
1412 tls->ssl->s3->send_alert[0] = tls->alertLevel;
1413 tls->ssl->s3->send_alert[1] = tls->alertDescription;
1415 if (tls->ssl->s3->wbuf.left == 0)
1416 tls->ssl->method->ssl_dispatch_alert(tls->ssl);
1423int freerdp_tls_write_all(rdpTls* tls,
const BYTE* data,
size_t length)
1427 BIO* bio = tls->bio;
1429 if (length > INT32_MAX)
1432 while (offset < length)
1435 const int status = BIO_write(bio, &data[offset], (
int)(length - offset));
1438 offset += (size_t)status;
1441 if (!BIO_should_retry(bio))
1444 if (BIO_write_blocked(bio))
1446 const long rc = BIO_wait_write(bio, 100);
1450 else if (BIO_read_blocked(bio))
1460int freerdp_tls_set_alert_code(rdpTls* tls,
int level,
int description)
1463 tls->alertLevel = level;
1464 tls->alertDescription = description;
1469static BOOL is_redirected(rdpTls* tls)
1471 rdpSettings* settings = tls->context->settings;
1473 if (settings->GatewayArmTransport)
1476 if (LB_NOREDIRECT & settings->RedirectionFlags)
1479 return settings->RedirectionFlags != 0;
1483static BOOL is_accepted(rdpTls* tls,
const rdpCertificate* cert)
1486 WINPR_ASSERT(tls->context);
1488 rdpSettings* settings = tls->context->settings;
1489 WINPR_ASSERT(settings);
1491 FreeRDP_Settings_Keys_String keyAccepted = FreeRDP_AcceptedCert;
1492 FreeRDP_Settings_Keys_UInt32 keyLength = FreeRDP_AcceptedCertLength;
1494 if (tls->isGatewayTransport)
1496 keyAccepted = FreeRDP_GatewayAcceptedCert;
1497 keyLength = FreeRDP_GatewayAcceptedCertLength;
1499 else if (is_redirected(tls))
1501 keyAccepted = FreeRDP_RedirectionAcceptedCert;
1502 keyLength = FreeRDP_RedirectionAcceptedCertLength;
1508 if ((AcceptedKeyLength > 0) && AcceptedKey)
1510 BOOL accepted = FALSE;
1511 size_t pemLength = 0;
1512 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1513 if (pem && (AcceptedKeyLength == pemLength))
1515 if (memcmp(AcceptedKey, pem, AcceptedKeyLength) == 0)
1524 WLog_WARN(TAG,
"freerdp_settings_set_string(settings, keyAccepted=%d, nullptr) failed",
1527 WLog_WARN(TAG,
"freerdp_settings_set_uint32(settings, keyLength=%d, 0) failed", keyLength);
1533static BOOL compare_fingerprint(
const char* fp,
const char* hash,
const rdpCertificate* cert,
1537 char* strhash =
nullptr;
1543 strhash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, hash, separator);
1547 equal = (_stricmp(strhash, fp) == 0);
1553static BOOL compare_fingerprint_all(
const char* fp,
const char* hash,
const rdpCertificate* cert)
1558 if (compare_fingerprint(fp, hash, cert, FALSE))
1560 if (compare_fingerprint(fp, hash, cert, TRUE))
1566static BOOL is_accepted_fingerprint(
const rdpCertificate* cert,
1567 const char* CertificateAcceptedFingerprints)
1572 if (CertificateAcceptedFingerprints)
1574 char* context =
nullptr;
1575 char* copy = _strdup(CertificateAcceptedFingerprints);
1576 char* cur = strtok_s(copy,
",", &context);
1579 char* subcontext =
nullptr;
1580 const char* h = strtok_s(cur,
":", &subcontext);
1586 const char* fp = h + strlen(h) + 1;
1587 if (compare_fingerprint_all(fp, h, cert))
1594 cur = strtok_s(
nullptr,
",", &context);
1603static BOOL accept_cert(rdpTls* tls,
const rdpCertificate* cert)
1606 WINPR_ASSERT(tls->context);
1609 FreeRDP_Settings_Keys_String
id = FreeRDP_AcceptedCert;
1610 FreeRDP_Settings_Keys_UInt32 lid = FreeRDP_AcceptedCertLength;
1612 rdpSettings* settings = tls->context->settings;
1613 WINPR_ASSERT(settings);
1615 if (tls->isGatewayTransport)
1617 id = FreeRDP_GatewayAcceptedCert;
1618 lid = FreeRDP_GatewayAcceptedCertLength;
1620 else if (is_redirected(tls))
1622 id = FreeRDP_RedirectionAcceptedCert;
1623 lid = FreeRDP_RedirectionAcceptedCertLength;
1626 size_t pemLength = 0;
1627 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1629 if (pemLength <= UINT32_MAX)
1639static BOOL tls_extract_full_pem(
const rdpCertificate* cert, BYTE** PublicKey,
1640 size_t* PublicKeyLength)
1642 if (!cert || !PublicKey)
1644 *PublicKey = (BYTE*)freerdp_certificate_get_pem(cert, PublicKeyLength);
1645 return *PublicKey !=
nullptr;
1649static int tls_config_parse_bool(WINPR_JSON* json,
const char* opt)
1661static int tls_config_check_allowed_hashed(
const char* configfile,
const rdpCertificate* cert,
1664 WINPR_ASSERT(configfile);
1678 "[%s] invalid certificate-db entry at position %" PRIuz
": not a JSON object",
1687 "[%s] invalid certificate-db entry at position %" PRIuz
1688 ": invalid 'type' element, expected type string",
1696 "[%s] invalid certificate-db entry at position %" PRIuz
1697 ": invalid 'hash' element, expected type string",
1705 char* hash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, skey, FALSE);
1709 "[%s] invalid certificate-db entry at position %" PRIuz
1710 ": hash type '%s' not supported by certificate",
1711 configfile, x, skey);
1715 const int cmp = _stricmp(hash, sval);
1726static int tls_config_check_certificate(
const rdpCertificate* cert, BOOL* pAllowUserconfig)
1729 WINPR_ASSERT(pAllowUserconfig);
1732 const char configfile[] =
"certificates.json";
1733 WINPR_JSON* json = freerdp_GetJSONConfigFile(TRUE, configfile);
1737 WLog_DBG(TAG,
"No or no valid configuration file for certificate handling, asking user");
1741 if (tls_config_parse_bool(json,
"deny") > 0)
1743 WLog_WARN(TAG,
"[%s] certificate denied by configuration", configfile);
1748 if (tls_config_parse_bool(json,
"ignore") > 0)
1750 WLog_WARN(TAG,
"[%s] certificate ignored by configuration", configfile);
1755 if (tls_config_check_allowed_hashed(configfile, cert, json) > 0)
1757 WLog_WARN(TAG,
"[%s] certificate manually accepted by configuration", configfile);
1762 if (tls_config_parse_bool(json,
"deny-userconfig") > 0)
1764 WLog_WARN(TAG,
"[%s] configuration denies user to accept certificates", configfile);
1771 *pAllowUserconfig = (rc == 0);
1776int tls_verify_certificate(rdpTls* tls,
const rdpCertificate* cert,
const char* hostname,
1781 BOOL certificate_status = 0;
1782 char* common_name =
nullptr;
1783 size_t common_name_length = 0;
1784 int verification_status = -1;
1785 BOOL hostname_match = FALSE;
1786 rdpCertificateData* certificate_data =
nullptr;
1787 BYTE* pemCert =
nullptr;
1788 DWORD flags = VERIFY_CERT_FLAG_NONE;
1792 rdpContext* context = tls->context;
1793 WINPR_ASSERT(context);
1795 freerdp* instance = context->instance;
1796 WINPR_ASSERT(instance);
1798 const rdpSettings* settings = context->settings;
1799 WINPR_ASSERT(settings);
1801 if (freerdp_shall_disconnect_context(context))
1804 if (!tls_extract_full_pem(cert, &pemCert, &length))
1808 if (is_accepted(tls, cert))
1810 verification_status = 1;
1814 if (is_accepted_fingerprint(cert, settings->CertificateAcceptedFingerprints))
1816 verification_status = 1;
1820 if (tls->isGatewayTransport || is_redirected(tls))
1821 flags |= VERIFY_CERT_FLAG_LEGACY;
1823 if (tls->isGatewayTransport)
1824 flags |= VERIFY_CERT_FLAG_GATEWAY;
1826 if (is_redirected(tls))
1827 flags |= VERIFY_CERT_FLAG_REDIRECT;
1830 if (settings->ExternalCertificateManagement)
1832 if (instance->VerifyX509Certificate)
1833 verification_status =
1834 instance->VerifyX509Certificate(instance, pemCert, length, hostname, port, flags);
1836 WLog_ERR(TAG,
"No VerifyX509Certificate callback registered!");
1838 if (verification_status > 0)
1840 if (!accept_cert(tls, cert))
1843 else if (verification_status < 0)
1845 WLog_ERR(TAG,
"VerifyX509Certificate failed: (length = %" PRIuz
") status: [%d] %s",
1846 length, verification_status, pemCert);
1853 WLog_WARN(TAG,
"[DANGER] Certificate not checked, /cert:ignore in use.");
1854 WLog_WARN(TAG,
"[DANGER] This prevents MITM attacks from being detected!");
1856 "[DANGER] Avoid using this unless in a secure LAN (=no internet) environment");
1857 verification_status = 1;
1859 else if (!tls->isGatewayTransport && (settings->AuthenticationLevel == 0))
1860 verification_status = 1;
1864 if (!tls->isGatewayTransport && settings->CertificateName)
1865 hostname = settings->CertificateName;
1868 certificate_status = freerdp_certificate_verify(
1869 cert, freerdp_certificate_store_get_certs_path(tls->certificate_store));
1871 certificate_data = freerdp_certificate_data_new(hostname, port, cert);
1872 if (!certificate_data)
1875 common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
1877 const size_t hostlen = strlen(hostname);
1878 if (freerdp_certificate_matches_hostname(cert, hostname, hostlen))
1879 hostname_match = TRUE;
1883 if (certificate_status && hostname_match)
1884 verification_status = 1;
1886 if (!hostname_match)
1887 flags |= VERIFY_CERT_FLAG_MISMATCH;
1889 BOOL allowUserconfig = TRUE;
1890 if (!certificate_status || !hostname_match)
1891 verification_status = tls_config_check_certificate(cert, &allowUserconfig);
1895 if (allowUserconfig && (!certificate_status || !hostname_match))
1897 DWORD accept_certificate = 0;
1898 size_t pem_length = 0;
1899 char* issuer = freerdp_certificate_get_issuer(cert);
1900 char* subject = freerdp_certificate_get_subject(cert);
1901 char* pem = freerdp_certificate_get_pem(cert, &pem_length);
1908 freerdp_certificate_store_contains_data(tls->certificate_store, certificate_data);
1914 if (!hostname_match)
1915 tls_print_certificate_name_mismatch_error(cert, hostname, port);
1918 const char* type =
"";
1920 type =
"tofo (auto-accept)";
1923 type =
"strict (auto-deny)";
1926 type =
"ignore (no check)";
1928 char* efp = freerdp_certificate_get_fingerprint(cert);
1929 tls_print_new_certificate_warn(tls->certificate_store, hostname, port, type,
1934#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
1935 WINPR_PRAGMA_DIAG_PUSH
1936 WINPR_PRAGMA_DIAG_IGNORED_DEPRECATED_DECL
1940 if (settings->AutoAcceptCertificate)
1942 WLog_INFO(TAG,
"No certificate stored, automatically accepting.");
1943 accept_certificate = 1;
1945 else if (settings->AutoDenyCertificate)
1947 WLog_INFO(TAG,
"No certificate stored, automatically denying.");
1948 accept_certificate = 0;
1950 else if (instance->VerifyX509Certificate)
1952 int rc = instance->VerifyX509Certificate(instance, pemCert, pem_length,
1953 hostname, port, flags);
1956 accept_certificate = 1;
1958 accept_certificate = 2;
1960 accept_certificate = 0;
1962 else if (instance->VerifyCertificateEx)
1964 const BOOL use_pem =
1967 DWORD cflags = flags;
1970 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
1974 fp = freerdp_certificate_get_fingerprint(cert);
1975 accept_certificate = instance->VerifyCertificateEx(
1976 instance, hostname, port, common_name, subject, issuer, fp, cflags);
1980#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
1981 else if (instance->VerifyCertificate)
1983 char* fp = freerdp_certificate_get_fingerprint(cert);
1985 WLog_WARN(TAG,
"The VerifyCertificate callback is deprecated, migrate your "
1986 "application to VerifyCertificateEx");
1987 accept_certificate = instance->VerifyCertificate(instance, common_name, subject,
1988 issuer, fp, !hostname_match);
1993 else if (match == -1)
1995 rdpCertificateData* stored_data =
1996 freerdp_certificate_store_load_data(tls->certificate_store, hostname, port);
2000 char* efp = freerdp_certificate_get_fingerprint(cert);
2001 tls_print_certificate_error(tls->certificate_store, stored_data, hostname, port,
2007 WLog_WARN(TAG,
"Failed to get certificate entry for %s:%" PRIu16
"", hostname,
2010 if (settings->AutoDenyCertificate)
2012 WLog_INFO(TAG,
"No certificate stored, automatically denying.");
2013 accept_certificate = 0;
2015 else if (instance->VerifyX509Certificate)
2018 instance->VerifyX509Certificate(instance, pemCert, pem_length, hostname,
2019 port, flags | VERIFY_CERT_FLAG_CHANGED);
2022 accept_certificate = 1;
2024 accept_certificate = 2;
2026 accept_certificate = 0;
2028 else if (instance->VerifyChangedCertificateEx)
2030 DWORD cflags = flags | VERIFY_CERT_FLAG_CHANGED;
2031 const char* old_subject = freerdp_certificate_data_get_subject(stored_data);
2032 const char* old_issuer = freerdp_certificate_data_get_issuer(stored_data);
2033 const char* old_fp = freerdp_certificate_data_get_fingerprint(stored_data);
2034 const char* old_pem = freerdp_certificate_data_get_pem(stored_data);
2035 const BOOL fpIsAllocated =
2041 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
2047 fp = freerdp_certificate_get_fingerprint(cert);
2049 accept_certificate = instance->VerifyChangedCertificateEx(
2050 instance, hostname, port, common_name, subject, issuer, fp, old_subject,
2051 old_issuer, old_fp, cflags);
2055#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2056 else if (instance->VerifyChangedCertificate)
2058 char* fp = freerdp_certificate_get_fingerprint(cert);
2059 const char* old_subject = freerdp_certificate_data_get_subject(stored_data);
2060 const char* old_issuer = freerdp_certificate_data_get_issuer(stored_data);
2061 const char* old_fingerprint =
2062 freerdp_certificate_data_get_fingerprint(stored_data);
2064 WLog_WARN(TAG,
"The VerifyChangedCertificate callback is deprecated, migrate "
2065 "your application to VerifyChangedCertificateEx");
2066 accept_certificate = instance->VerifyChangedCertificate(
2067 instance, common_name, subject, issuer, fp, old_subject, old_issuer,
2073 freerdp_certificate_data_free(stored_data);
2075 else if (match == 0)
2076 accept_certificate = 2;
2078#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2079 WINPR_PRAGMA_DIAG_POP
2083 switch (accept_certificate)
2088 verification_status = freerdp_certificate_store_save_data(
2089 tls->certificate_store, certificate_data)
2096 verification_status = 1;
2101 verification_status = -1;
2110 if (verification_status > 0)
2112 if (!accept_cert(tls, cert))
2118 freerdp_certificate_data_free(certificate_data);
2121 return verification_status;
2124void tls_print_new_certificate_warn(rdpCertificateStore* store,
const char* hostname, UINT16 port,
2125 const char* type,
const char* fingerprint)
2127 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2129 WLog_ERR(TAG,
"The host key for %s:%" PRIu16
" has changed", hostname, port);
2130 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2131 WLog_ERR(TAG,
"@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @");
2132 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2133 WLog_ERR(TAG,
"IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!");
2134 WLog_ERR(TAG,
"Someone could be eavesdropping on you right now (man-in-the-middle attack)!");
2135 WLog_ERR(TAG,
"It is also possible that a host key has just been changed.");
2136 WLog_ERR(TAG,
"The fingerprint for the host key sent by the remote host is %s", fingerprint);
2137 WLog_ERR(TAG,
"Please contact your system administrator.");
2138 WLog_ERR(TAG,
"Add correct host key in %s to get rid of this message.", path);
2139 WLog_ERR(TAG,
"Host key for %s has changed and you have requested %s checking.", hostname,
2141 WLog_ERR(TAG,
"Host key verification failed.");
2146void tls_print_certificate_error(rdpCertificateStore* store,
2147 WINPR_ATTR_UNUSED rdpCertificateData* stored_data,
2148 const char* hostname, UINT16 port,
const char* fingerprint)
2150 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2152 WLog_ERR(TAG,
"New host key for %s:%" PRIu16, hostname, port);
2153 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2154 WLog_ERR(TAG,
"@ WARNING: NEW HOST IDENTIFICATION! @");
2155 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2157 WLog_ERR(TAG,
"The fingerprint for the host key sent by the remote host is %s", fingerprint);
2158 WLog_ERR(TAG,
"Please contact your system administrator.");
2159 WLog_ERR(TAG,
"Add correct host key in %s to get rid of this message.", path);
2164void tls_print_certificate_name_mismatch_error(
const rdpCertificate* cert,
const char* hostname,
2167 WINPR_ASSERT(
nullptr != hostname);
2170 size_t common_name_length = 0;
2171 char* common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
2173 size_t dnscount = 0;
2174 size_t* dnslengths =
nullptr;
2175 char** dnsnames = freerdp_certificate_get_dns_names(cert, &dnscount, &dnslengths);
2178 size_t* iplengths =
nullptr;
2179 char** ipnames = freerdp_certificate_get_ip_names(cert, &ipcount, &iplengths);
2181 size_t count = dnscount;
2182 char** names = dnsnames;
2183 const BOOL isIP = utils_is_valid_ip(hostname);
2190 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2191 WLog_ERR(TAG,
"@ WARNING: CERTIFICATE NAME MISMATCH! @");
2192 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2193 WLog_ERR(TAG,
"The hostname used for this connection (%s:%" PRIu16
") ", hostname, port);
2194 WLog_ERR(TAG,
"does not match %s given in the certificate:",
2195 count < 1 ?
"the name" :
"any of the names");
2196 WLog_ERR(TAG,
"Common Name (CN):");
2197 WLog_ERR(TAG,
"\t%s", common_name ? common_name :
"no CN found in certificate");
2201 WINPR_ASSERT(
nullptr != names);
2202 WLog_ERR(TAG,
"Alternative names:");
2204 for (
size_t index = 0; index < count; index++)
2206 WINPR_ASSERT(names[index]);
2207 WLog_ERR(TAG,
"\t %s", names[index]);
2211 WLog_ERR(TAG,
"A valid certificate for the wrong name should NOT be trusted!");
2213 freerdp_certificate_free_dns_names(dnscount, dnslengths, dnsnames);
2214 freerdp_certificate_free_ip_names(ipcount, iplengths, ipnames);
2215 winpr_znfree(common_name, common_name_length);
2218rdpTls* freerdp_tls_new(rdpContext* context)
2220 rdpTls* tls =
nullptr;
2221 tls = (rdpTls*)calloc(1,
sizeof(rdpTls));
2226 tls->context = context;
2230 tls->certificate_store = freerdp_certificate_store_new(tls->context->settings);
2232 if (!tls->certificate_store)
2236 tls->alertLevel = TLS_ALERT_LEVEL_WARNING;
2237 tls->alertDescription = TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY;
2244void freerdp_tls_free(rdpTls* tls)
2251 if (tls->certificate_store)
2253 freerdp_certificate_store_free(tls->certificate_store);
2254 tls->certificate_store =
nullptr;
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsBool(const WINPR_JSON *item)
Check if JSON item is of type BOOL.
WINPR_ATTR_NODISCARD WINPR_API size_t WINPR_JSON_GetArraySize(const WINPR_JSON *array)
Get the number of arrayitems from an array.
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsTrue(const WINPR_JSON *item)
Check if JSON item is BOOL value True.
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_GetObjectItemCaseSensitive(const WINPR_JSON *object, const char *string)
Same as WINPR_JSON_GetObjectItem but with case sensitive matching.
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsString(const WINPR_JSON *item)
Check if JSON item is of type String.
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_GetArrayItem(const WINPR_JSON *array, size_t index)
Return a pointer to an item in the array.
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsArray(const WINPR_JSON *item)
Check if JSON item is of type Array.
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsObject(const WINPR_JSON *item)
Check if JSON item is of type Object.
WINPR_API void WINPR_JSON_Delete(WINPR_JSON *item)
Delete a WinPR JSON wrapper object.
WINPR_ATTR_NODISCARD WINPR_API const char * WINPR_JSON_GetStringValue(WINPR_JSON *item)
Return the String value of a JSON item.
WINPR_ATTR_NODISCARD FREERDP_API const void * freerdp_settings_get_pointer(const rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a immutable pointer settings value.
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val, size_t len)
Sets a string settings value. The val is copied.
WINPR_ATTR_NODISCARD FREERDP_API void * freerdp_settings_get_pointer_writable(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
Returns a mutable pointer settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT16 freerdp_settings_get_uint16(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id)
Returns a UINT16 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.