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 EnterCriticalSection(&tls->lock);
210 status = SSL_write(tls->ssl, buf, size);
211 error = SSL_get_error(tls->ssl, status);
212#ifdef WITH_TLS_DATA_LIMIT
214 bio_rdp_tls_write_account(tls, status);
216 LeaveCriticalSection(&tls->lock);
223 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
226 case SSL_ERROR_WANT_WRITE:
227 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
230 case SSL_ERROR_WANT_READ:
231 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
234 case SSL_ERROR_WANT_X509_LOOKUP:
235 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
236 BIO_set_retry_reason(bio, BIO_RR_SSL_X509_LOOKUP);
239 case SSL_ERROR_WANT_CONNECT:
240 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
241 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
244 case SSL_ERROR_SYSCALL:
245 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
249 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
260static int bio_rdp_tls_read(BIO* bio,
char* buf,
int size)
264 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
269#ifdef WITH_TLS_DATA_LIMIT
272 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
277 BIO_clear_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_READ | BIO_FLAGS_IO_SPECIAL);
278 EnterCriticalSection(&tls->lock);
279 status = SSL_read(tls->ssl, buf, size);
280 error = SSL_get_error(tls->ssl, status);
281#ifdef WITH_TLS_DATA_LIMIT
283 bio_rdp_tls_read_account(tls, status);
285 LeaveCriticalSection(&tls->lock);
293 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
296 case SSL_ERROR_WANT_READ:
297 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
300 case SSL_ERROR_WANT_WRITE:
301 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
304 case SSL_ERROR_WANT_X509_LOOKUP:
305 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
306 BIO_set_retry_reason(bio, BIO_RR_SSL_X509_LOOKUP);
309 case SSL_ERROR_WANT_ACCEPT:
310 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
311 BIO_set_retry_reason(bio, BIO_RR_ACCEPT);
314 case SSL_ERROR_WANT_CONNECT:
315 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
316 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
320 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
323 case SSL_ERROR_ZERO_RETURN:
324 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
327 case SSL_ERROR_SYSCALL:
328 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
335#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
339 VALGRIND_MAKE_MEM_DEFINED(buf, status);
347static int bio_rdp_tls_puts(BIO* bio,
const char* str)
352 const size_t max = (INT_MAX > SIZE_MAX) ? SIZE_MAX : INT_MAX;
353 const size_t size = strnlen(str, max);
357 return BIO_write(bio, str, (
int)size);
361static int bio_rdp_tls_gets(WINPR_ATTR_UNUSED BIO* bio, WINPR_ATTR_UNUSED
char* str,
362 WINPR_ATTR_UNUSED
int size)
368static long bio_rdp_tls_ctrl(BIO* bio,
int cmd,
long num,
void* ptr)
370 BIO* ssl_rbio =
nullptr;
371 BIO* ssl_wbio =
nullptr;
372 BIO* next_bio =
nullptr;
374 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
379 if (!tls->ssl && (cmd != BIO_C_SET_SSL))
382 next_bio = BIO_next(bio);
383 ssl_rbio = tls->ssl ? SSL_get_rbio(tls->ssl) : nullptr;
384 ssl_wbio = tls->ssl ? SSL_get_wbio(tls->ssl) : nullptr;
389 SSL_shutdown(tls->ssl);
391 if (SSL_in_connect_init(tls->ssl))
392 SSL_set_connect_state(tls->ssl);
393 else if (SSL_in_accept_init(tls->ssl))
394 SSL_set_accept_state(tls->ssl);
399 status = BIO_ctrl(next_bio, cmd, num, ptr);
401 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
408 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
415 case BIO_CTRL_SET_CALLBACK:
419 case BIO_CTRL_GET_CALLBACK:
426 void* vptr = WINPR_FUNC_PTR_CAST(SSL_get_info_callback(tls->ssl),
void*);
427 *((
void**)ptr) = vptr;
434 SSL_set_connect_state(tls->ssl);
436 SSL_set_accept_state(tls->ssl);
441 case BIO_CTRL_GET_CLOSE:
442 status = BIO_get_shutdown(bio);
445 case BIO_CTRL_SET_CLOSE:
446 BIO_set_shutdown(bio, (
int)num);
450 case BIO_CTRL_WPENDING:
451 EnterCriticalSection(&tls->lock);
452 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
453 LeaveCriticalSection(&tls->lock);
456 case BIO_CTRL_PENDING:
457 status = SSL_pending(tls->ssl);
460 status = BIO_pending(ssl_rbio);
465 BIO_clear_retry_flags(bio);
468 EnterCriticalSection(&tls->lock);
469 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
470 LeaveCriticalSection(&tls->lock);
472 WLog_DBG(TAG,
"BIO_ctrl returned %ld", status);
473 BIO_copy_next_retry(bio);
478 if (next_bio && (next_bio != ssl_rbio))
480#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
481 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
482 SSL_set_bio(tls->ssl, next_bio, next_bio);
483 CRYPTO_add(&(bio->next_bio->references), 1, CRYPTO_LOCK_BIO);
489 BIO_up_ref(next_bio);
490 SSL_set_bio(tls->ssl, next_bio, next_bio);
502 if (ssl_rbio != ssl_wbio)
503 BIO_free_all(ssl_wbio);
505#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
506 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
509 CRYPTO_add(&(bio->next_bio->references), -1, CRYPTO_LOCK_BIO);
511 tls->ssl->wbio = tls->ssl->rbio =
nullptr;
514 SSL_set_bio(tls->ssl,
nullptr,
nullptr);
524 *((SSL**)ptr) = tls->ssl;
531 BIO_set_shutdown(bio, (
int)num);
535 tls->ssl = (SSL*)ptr;
536 ssl_rbio = SSL_get_rbio(tls->ssl);
542 BIO_push(ssl_rbio, next_bio);
544 BIO_set_next(bio, ssl_rbio);
545#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
546 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
547 CRYPTO_add(&(ssl_rbio->references), 1, CRYPTO_LOCK_BIO);
549 BIO_up_ref(ssl_rbio);
553 BIO_set_init(bio, 1);
557 case BIO_C_DO_STATE_MACHINE:
558 BIO_clear_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL);
559 BIO_set_retry_reason(bio, 0);
560 status = SSL_do_handshake(tls->ssl);
564 const int err = (status < INT32_MIN) ? INT32_MIN : (int)status;
565 switch (SSL_get_error(tls->ssl, err))
567 case SSL_ERROR_WANT_READ:
568 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
571 case SSL_ERROR_WANT_WRITE:
572 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
575 case SSL_ERROR_WANT_CONNECT:
576 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL | BIO_FLAGS_SHOULD_RETRY);
577 BIO_set_retry_reason(bio, BIO_get_retry_reason(next_bio));
581 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
589 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
597static int bio_rdp_tls_new(BIO* bio)
599 BIO_RDP_TLS* tls =
nullptr;
600 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
602 if (!(tls = calloc(1,
sizeof(BIO_RDP_TLS))))
605 if (!InitializeCriticalSectionAndSpinCount(&tls->lock, 4000))
611#ifdef WITH_TLS_DATA_LIMIT
614 tls->rekeyAvailable = TRUE;
617 BIO_set_data(bio, (
void*)tls);
622static int bio_rdp_tls_free(BIO* bio)
624 BIO_RDP_TLS* tls =
nullptr;
629 tls = (BIO_RDP_TLS*)BIO_get_data(bio);
634 BIO_set_data(bio,
nullptr);
635 if (BIO_get_shutdown(bio))
637 if (BIO_get_init(bio) && tls->ssl)
639 SSL_shutdown(tls->ssl);
643 BIO_set_init(bio, 0);
644 BIO_set_flags(bio, 0);
647 DeleteCriticalSection(&tls->lock);
654static long bio_rdp_tls_callback_ctrl(BIO* bio,
int cmd, bio_info_cb* fp)
661 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
668 case BIO_CTRL_SET_CALLBACK:
670 typedef void (*fkt_t)(
const SSL*, int, int);
676 fkt_t fkt = WINPR_FUNC_PTR_CAST(fp, fkt_t);
677 SSL_set_info_callback(tls->ssl, fkt);
683 status = BIO_callback_ctrl(SSL_get_rbio(tls->ssl), cmd, fp);
690#define BIO_TYPE_RDP_TLS 68
693static BOOL CALLBACK bio_rdp_tls_init_once(WINPR_ATTR_UNUSED
PINIT_ONCE once,
694 WINPR_ATTR_UNUSED PVOID param,
695 WINPR_ATTR_UNUSED PVOID* context)
697 g_BioMethods = BIO_meth_new(BIO_TYPE_RDP_TLS,
"RdpTls");
701 if (BIO_meth_set_write(g_BioMethods, bio_rdp_tls_write) != 1)
703 if (BIO_meth_set_read(g_BioMethods, bio_rdp_tls_read) != 1)
705 if (BIO_meth_set_puts(g_BioMethods, bio_rdp_tls_puts) != 1)
707 if (BIO_meth_set_gets(g_BioMethods, bio_rdp_tls_gets) != 1)
709 if (BIO_meth_set_ctrl(g_BioMethods, bio_rdp_tls_ctrl) != 1)
711 if (BIO_meth_set_create(g_BioMethods, bio_rdp_tls_new) != 1)
713 if (BIO_meth_set_destroy(g_BioMethods, bio_rdp_tls_free) != 1)
715 if (BIO_meth_set_callback_ctrl(g_BioMethods, bio_rdp_tls_callback_ctrl) != 1)
722static BIO_METHOD* BIO_s_rdp_tls(
void)
724 if (!InitOnceExecuteOnce(&g_BioMethodsOnce, bio_rdp_tls_init_once,
nullptr,
nullptr))
729WINPR_ATTR_MALLOC(BIO_free, 1)
730static BIO* BIO_new_rdp_tls(SSL_CTX* ctx,
int client)
732 BIO* bio = BIO_new(BIO_s_rdp_tls());
737 SSL* ssl = SSL_new(ctx);
746 SSL_set_connect_state(ssl);
748 SSL_set_accept_state(ssl);
750 BIO_set_ssl(bio, ssl, BIO_CLOSE);
754WINPR_ATTR_MALLOC(freerdp_certificate_free, 1)
755static rdpCertificate* tls_get_certificate(rdpTls* tls, BOOL peer)
757 X509* remote_cert =
nullptr;
760 remote_cert = SSL_get_peer_certificate(tls->ssl);
762 remote_cert = X509_dup(SSL_get_certificate(tls->ssl));
766 WLog_ERR(TAG,
"failed to get the server TLS certificate");
771 STACK_OF(X509)* chain = SSL_get_peer_cert_chain(tls->ssl);
772 rdpCertificate* cert = freerdp_certificate_new_from_x509(remote_cert, chain);
773 X509_free(remote_cert);
779static const char* tls_get_server_name(rdpTls* tls)
781 return tls->serverName ? tls->serverName : tls->hostname;
784#define TLS_SERVER_END_POINT "tls-server-end-point:"
786WINPR_ATTR_MALLOC(free_tls_bindings, 1)
789 size_t CertificateHashLength = 0;
790 BYTE* ChannelBindingToken =
nullptr;
792 const size_t PrefixLength = strnlen(TLS_SERVER_END_POINT, ARRAYSIZE(TLS_SERVER_END_POINT));
797 WINPR_MD_TYPE alg = freerdp_certificate_get_signature_alg(cert);
798 const char* hash =
nullptr;
804 hash = winpr_md_type_to_string(WINPR_MD_SHA256);
807 hash = winpr_md_type_to_string(alg);
813 char* CertificateHash = freerdp_certificate_get_hash(cert, hash, &CertificateHashLength);
814 if (!CertificateHash)
817 const size_t ChannelBindingTokenLength = PrefixLength + CertificateHashLength;
820 if (!ContextBindings)
825 if (slen > UINT32_MAX)
828 ContextBindings->BindingsLength = (UINT32)slen;
832 if (!ChannelBindings)
835 ContextBindings->Bindings = ChannelBindings;
836 ChannelBindings->cbApplicationDataLength = (UINT32)ChannelBindingTokenLength;
838 ChannelBindingToken = &((BYTE*)ChannelBindings)[ChannelBindings->dwApplicationDataOffset];
839 memcpy(ChannelBindingToken, TLS_SERVER_END_POINT, PrefixLength);
840 memcpy(ChannelBindingToken + PrefixLength, CertificateHash, CertificateHashLength);
841 free(CertificateHash);
842 return ContextBindings;
844 free(CertificateHash);
845 free(ContextBindings);
850static BOOL CALLBACK secrets_file_init_cb(WINPR_ATTR_UNUSED
PINIT_ONCE once,
851 WINPR_ATTR_UNUSED PVOID param,
852 WINPR_ATTR_UNUSED PVOID* context)
854 secrets_file_idx = SSL_get_ex_new_index(0,
nullptr,
nullptr,
nullptr,
nullptr);
856 return (secrets_file_idx != -1);
859static void SSLCTX_keylog_cb(
const SSL* ssl,
const char* line)
861 char* dfile =
nullptr;
863 if (secrets_file_idx == -1)
866 dfile = SSL_get_ex_data(ssl, secrets_file_idx);
869 FILE* f = winpr_fopen(dfile,
"a+");
872 (void)fwrite(line, strlen(line), 1, f);
873 (void)fwrite(
"\n", 1, 1, f);
879static void tls_reset(rdpTls* tls)
885 SSL_CTX_free(tls->ctx);
892 BIO_free_all(tls->bio);
893 else if (tls->underlying)
894 BIO_free_all(tls->underlying);
896 tls->underlying =
nullptr;
898 free_tls_public_key(tls);
899 free_tls_bindings(tls->Bindings);
900 tls->Bindings =
nullptr;
903#if OPENSSL_VERSION_NUMBER >= 0x010000000L
905static BOOL tls_prepare(rdpTls* tls, BIO* underlying,
const SSL_METHOD* method,
int options,
909static BOOL tls_prepare(rdpTls* tls, BIO* underlying, SSL_METHOD* method,
int options,
915 rdpSettings* settings = tls->context->settings;
916 WINPR_ASSERT(settings);
919 tls->ctx = SSL_CTX_new(method);
921 tls->underlying = underlying;
925 WLog_ERR(TAG,
"SSL_CTX_new failed");
929 SSL_CTX_set_mode(tls->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_ENABLE_PARTIAL_WRITE);
930 SSL_CTX_set_options(tls->ctx, WINPR_ASSERTING_INT_CAST(uint64_t, options));
931 SSL_CTX_set_read_ahead(tls->ctx, 1);
932#if OPENSSL_VERSION_NUMBER >= 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
934 if (!SSL_CTX_set_min_proto_version(tls->ctx, version))
936 WLog_ERR(TAG,
"SSL_CTX_set_min_proto_version %" PRIu16
" failed", version);
940 if (!SSL_CTX_set_max_proto_version(tls->ctx, version))
942 WLog_ERR(TAG,
"SSL_CTX_set_max_proto_version %" PRIu16
" failed", version);
946#if OPENSSL_VERSION_NUMBER >= 0x10100000L && !defined(LIBRESSL_VERSION_NUMBER)
947 SSL_CTX_set_security_level(tls->ctx, WINPR_ASSERTING_INT_CAST(
int, settings->TlsSecLevel));
950 if (settings->AllowedTlsCiphers)
952 if (!SSL_CTX_set_cipher_list(tls->ctx, settings->AllowedTlsCiphers))
954 WLog_ERR(TAG,
"SSL_CTX_set_cipher_list %s failed", settings->AllowedTlsCiphers);
959 tls->bio = BIO_new_rdp_tls(tls->ctx, clientMode);
963 WLog_ERR(TAG,
"unable to create TLS BIO");
967 if (BIO_get_ssl(tls->bio, &tls->ssl) < 0 || !tls->ssl)
969 WLog_ERR(TAG,
"unable to retrieve the SSL of the connection");
973 if (settings->TlsSecretsFile)
975#if OPENSSL_VERSION_NUMBER >= 0x10101000L
976 if (!InitOnceExecuteOnce(&secrets_file_idx_once, secrets_file_init_cb,
nullptr,
nullptr))
979 if (secrets_file_idx != -1)
981 SSL_set_ex_data(tls->ssl, secrets_file_idx, settings->TlsSecretsFile);
982 SSL_CTX_set_keylog_callback(tls->ctx, SSLCTX_keylog_cb);
985 WLog_WARN(TAG,
"Key-Logging not available - requires OpenSSL 1.1.1 or higher");
989 BIO_push(tls->bio, underlying);
994adjustSslOptions(WINPR_ATTR_UNUSED
int* options)
996 WINPR_ASSERT(options);
997#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
998 *options |= SSL_OP_NO_SSLv2;
999 *options |= SSL_OP_NO_SSLv3;
1003const SSL_METHOD* freerdp_tls_get_ssl_method(BOOL isDtls, BOOL isClient)
1008 return DTLS_client_method();
1009#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1010 return SSLv23_client_method();
1012 return TLS_client_method();
1017 return DTLS_server_method();
1019#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1020 return SSLv23_server_method();
1022 return TLS_server_method();
1026TlsHandshakeResult freerdp_tls_connect_ex(rdpTls* tls, BIO* underlying,
const SSL_METHOD* methods)
1040#ifdef SSL_OP_NO_COMPRESSION
1041 options |= SSL_OP_NO_COMPRESSION;
1049 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1056 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1058 tls->isClientMode = TRUE;
1059 adjustSslOptions(&options);
1061 if (!tls_prepare(tls, underlying, methods, options, TRUE))
1062 return TLS_HANDSHAKE_ERROR;
1064#if !defined(OPENSSL_NO_TLSEXT)
1065 const char* str = tls_get_server_name(tls);
1066 void* ptr = WINPR_CAST_CONST_PTR_AWAY(str,
void*);
1067 SSL_set_tlsext_host_name(tls->ssl, ptr);
1070 return freerdp_tls_handshake(tls);
1073static int bio_err_print(
const char* str,
size_t len,
void* u)
1076 WLog_Print(log, WLOG_ERROR,
"[BIO_do_handshake] %s [%" PRIuz
"]", str, len);
1080TlsHandshakeResult freerdp_tls_handshake(rdpTls* tls)
1082 TlsHandshakeResult ret = TLS_HANDSHAKE_ERROR;
1085 const long status = BIO_do_handshake(tls->bio);
1088 if (!BIO_should_retry(tls->bio))
1090 wLog* log = WLog_Get(TAG);
1091 WLog_Print(log, WLOG_ERROR,
"BIO_do_handshake failed");
1092 ERR_print_errors_cb(bio_err_print, log);
1093 return TLS_HANDSHAKE_ERROR;
1096 return TLS_HANDSHAKE_CONTINUE;
1099 int verify_status = 0;
1100 rdpCertificate* cert = tls_get_certificate(tls, tls->isClientMode);
1104 WLog_ERR(TAG,
"tls_get_certificate failed to return the server certificate.");
1105 return TLS_HANDSHAKE_ERROR;
1110 free_tls_bindings(tls->Bindings);
1111 tls->Bindings = tls_get_channel_bindings(cert);
1114 WLog_ERR(TAG,
"unable to retrieve bindings");
1118 free_tls_public_key(tls);
1119 if (!freerdp_certificate_get_public_key(cert, &tls->PublicKey, &tls->PublicKeyLength))
1122 "freerdp_certificate_get_public_key failed to return the server public key.");
1127 ret = TLS_HANDSHAKE_SUCCESS;
1129 if (tls->isClientMode)
1131 WINPR_ASSERT(tls->port <= UINT16_MAX);
1133 tls_verify_certificate(tls, cert, tls_get_server_name(tls), (UINT16)tls->port);
1135 if (verify_status < 1)
1137 WLog_ERR(TAG,
"certificate not trusted, aborting.");
1138 freerdp_tls_send_alert(tls);
1139 ret = TLS_HANDSHAKE_VERIFY_ERROR;
1144 freerdp_certificate_free(cert);
1148static int pollAndHandshake(rdpTls* tls)
1154 HANDLE events[] = { freerdp_abort_event(tls->context),
nullptr };
1156 if (BIO_get_event(tls->bio, &events[1]) < 0)
1158 WLog_ERR(TAG,
"unable to retrieve BIO associated event");
1164 WLog_ERR(TAG,
"unable to retrieve BIO event");
1168 status = WaitForMultipleObjectsEx(ARRAYSIZE(events), events, FALSE, INFINITE, TRUE);
1171 case WAIT_OBJECT_0 + 1:
1174 WLog_DBG(TAG,
"Abort event set, cancel connect");
1177 case WAIT_IO_COMPLETION:
1180 WLog_ERR(TAG,
"error during WaitForSingleObject(): 0x%08" PRIX32
"", status);
1184 TlsHandshakeResult result = freerdp_tls_handshake(tls);
1187 case TLS_HANDSHAKE_CONTINUE:
1189 case TLS_HANDSHAKE_SUCCESS:
1191 case TLS_HANDSHAKE_ERROR:
1192 case TLS_HANDSHAKE_VERIFY_ERROR:
1199int freerdp_tls_connect(rdpTls* tls, BIO* underlying)
1201 const SSL_METHOD* method = freerdp_tls_get_ssl_method(FALSE, TRUE);
1204 TlsHandshakeResult result = freerdp_tls_connect_ex(tls, underlying, method);
1207 case TLS_HANDSHAKE_SUCCESS:
1209 case TLS_HANDSHAKE_CONTINUE:
1211 case TLS_HANDSHAKE_ERROR:
1212 case TLS_HANDSHAKE_VERIFY_ERROR:
1218 return pollAndHandshake(tls);
1221#if defined(MICROSOFT_IOS_SNI_BUG) && !defined(OPENSSL_NO_TLSEXT) && \
1222 !defined(LIBRESSL_VERSION_NUMBER)
1223static void tls_openssl_tlsext_debug_callback(SSL* s,
int client_server,
int type,
1224 unsigned char* data,
int len,
void* arg)
1226 if (type == TLSEXT_TYPE_server_name)
1228 WLog_DBG(TAG,
"Client uses SNI (extension disabled)");
1229 s->servername_done = 2;
1234BOOL freerdp_tls_accept(rdpTls* tls, BIO* underlying, rdpSettings* settings)
1237 TlsHandshakeResult res =
1238 freerdp_tls_accept_ex(tls, underlying, settings, freerdp_tls_get_ssl_method(FALSE, FALSE));
1241 case TLS_HANDSHAKE_SUCCESS:
1243 case TLS_HANDSHAKE_CONTINUE:
1245 case TLS_HANDSHAKE_ERROR:
1246 case TLS_HANDSHAKE_VERIFY_ERROR:
1251 return pollAndHandshake(tls) > 0;
1254TlsHandshakeResult freerdp_tls_accept_ex(rdpTls* tls, BIO* underlying, rdpSettings* settings,
1255 const SSL_METHOD* methods)
1268 options |= SSL_OP_NO_SSLv2;
1278#ifdef SSL_OP_NO_COMPRESSION
1279 options |= SSL_OP_NO_COMPRESSION;
1287 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1294 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1302#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && (OPENSSL_VERSION_NUMBER < 0x30000000L) && \
1303 !defined(LIBRESSL_VERSION_NUMBER)
1304 options |= SSL_OP_NO_RENEGOTIATION;
1307 if (!tls_prepare(tls, underlying, methods, options, FALSE))
1308 return TLS_HANDSHAKE_ERROR;
1313 WLog_ERR(TAG,
"invalid private key");
1314 return TLS_HANDSHAKE_ERROR;
1317 EVP_PKEY* privkey = freerdp_key_get_evp_pkey(key);
1320 WLog_ERR(TAG,
"invalid private key");
1321 return TLS_HANDSHAKE_ERROR;
1324 status = SSL_use_PrivateKey(tls->ssl, privkey);
1329 EVP_PKEY_free(privkey);
1333 WLog_ERR(TAG,
"SSL_CTX_use_PrivateKey_file failed");
1334 return TLS_HANDSHAKE_ERROR;
1337 rdpCertificate* cert =
1341 WLog_ERR(TAG,
"invalid certificate");
1342 return TLS_HANDSHAKE_ERROR;
1345 status = SSL_use_certificate(tls->ssl, freerdp_certificate_get_x509(cert));
1349 WLog_ERR(TAG,
"SSL_use_certificate_file failed");
1350 return TLS_HANDSHAKE_ERROR;
1353 const size_t cnt = freerdp_certificate_get_chain_len(cert);
1354 for (
size_t x = 0; x < cnt; x++)
1356 X509* xcert = freerdp_certificate_get_chain_at(cert, x);
1357 WINPR_ASSERT(xcert);
1358 const long rc = SSL_add1_chain_cert(tls->ssl, xcert);
1361 WLog_ERR(TAG,
"SSL_add1_chain_cert failed");
1362 return TLS_HANDSHAKE_ERROR;
1366#if defined(MICROSOFT_IOS_SNI_BUG) && !defined(OPENSSL_NO_TLSEXT) && \
1367 !defined(LIBRESSL_VERSION_NUMBER)
1368 SSL_set_tlsext_debug_callback(tls->ssl, tls_openssl_tlsext_debug_callback);
1371 return freerdp_tls_handshake(tls);
1374BOOL freerdp_tls_send_alert(rdpTls* tls)
1388#if (!defined(LIBRESSL_VERSION_NUMBER) && (OPENSSL_VERSION_NUMBER < 0x10100000L)) || \
1389 (defined(LIBRESSL_VERSION_NUMBER) && (LIBRESSL_VERSION_NUMBER <= 0x2080300fL))
1391 if (tls->alertDescription != TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY)
1402 SSL_SESSION* ssl_session = SSL_get_session(tls->ssl);
1403 SSL_CTX* ssl_ctx = SSL_get_SSL_CTX(tls->ssl);
1404 SSL_set_quiet_shutdown(tls->ssl, 1);
1406 if ((tls->alertLevel == TLS_ALERT_LEVEL_FATAL) && (ssl_session))
1407 SSL_CTX_remove_session(ssl_ctx, ssl_session);
1409 tls->ssl->s3->alert_dispatch = 1;
1410 tls->ssl->s3->send_alert[0] = tls->alertLevel;
1411 tls->ssl->s3->send_alert[1] = tls->alertDescription;
1413 if (tls->ssl->s3->wbuf.left == 0)
1414 tls->ssl->method->ssl_dispatch_alert(tls->ssl);
1421int freerdp_tls_write_all(rdpTls* tls,
const BYTE* data,
size_t length)
1425 BIO* bio = tls->bio;
1427 if (length > INT32_MAX)
1430 while (offset < length)
1433 const int status = BIO_write(bio, &data[offset], (
int)(length - offset));
1436 offset += (size_t)status;
1439 if (!BIO_should_retry(bio))
1442 if (BIO_write_blocked(bio))
1444 const long rc = BIO_wait_write(bio, 100);
1448 else if (BIO_read_blocked(bio))
1458int freerdp_tls_set_alert_code(rdpTls* tls,
int level,
int description)
1461 tls->alertLevel = level;
1462 tls->alertDescription = description;
1467static BOOL is_redirected(rdpTls* tls)
1469 rdpSettings* settings = tls->context->settings;
1471 if (settings->GatewayArmTransport)
1474 if (LB_NOREDIRECT & settings->RedirectionFlags)
1477 return settings->RedirectionFlags != 0;
1481static BOOL is_accepted(rdpTls* tls,
const rdpCertificate* cert)
1484 WINPR_ASSERT(tls->context);
1486 rdpSettings* settings = tls->context->settings;
1487 WINPR_ASSERT(settings);
1489 FreeRDP_Settings_Keys_String keyAccepted = FreeRDP_AcceptedCert;
1490 FreeRDP_Settings_Keys_UInt32 keyLength = FreeRDP_AcceptedCertLength;
1492 if (tls->isGatewayTransport)
1494 keyAccepted = FreeRDP_GatewayAcceptedCert;
1495 keyLength = FreeRDP_GatewayAcceptedCertLength;
1497 else if (is_redirected(tls))
1499 keyAccepted = FreeRDP_RedirectionAcceptedCert;
1500 keyLength = FreeRDP_RedirectionAcceptedCertLength;
1506 if ((AcceptedKeyLength > 0) && AcceptedKey)
1508 BOOL accepted = FALSE;
1509 size_t pemLength = 0;
1510 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1511 if (pem && (AcceptedKeyLength == pemLength))
1513 if (memcmp(AcceptedKey, pem, AcceptedKeyLength) == 0)
1522 WLog_WARN(TAG,
"freerdp_settings_set_string(settings, keyAccepted=%d, nullptr) failed",
1525 WLog_WARN(TAG,
"freerdp_settings_set_uint32(settings, keyLength=%d, 0) failed", keyLength);
1531static BOOL compare_fingerprint(
const char* fp,
const char* hash,
const rdpCertificate* cert,
1535 char* strhash =
nullptr;
1541 strhash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, hash, separator);
1545 equal = (_stricmp(strhash, fp) == 0);
1551static BOOL compare_fingerprint_all(
const char* fp,
const char* hash,
const rdpCertificate* cert)
1556 if (compare_fingerprint(fp, hash, cert, FALSE))
1558 if (compare_fingerprint(fp, hash, cert, TRUE))
1564static BOOL is_accepted_fingerprint(
const rdpCertificate* cert,
1565 const char* CertificateAcceptedFingerprints)
1570 if (CertificateAcceptedFingerprints)
1572 char* context =
nullptr;
1573 char* copy = _strdup(CertificateAcceptedFingerprints);
1574 char* cur = strtok_s(copy,
",", &context);
1577 char* subcontext =
nullptr;
1578 const char* h = strtok_s(cur,
":", &subcontext);
1584 const char* fp = h + strlen(h) + 1;
1585 if (compare_fingerprint_all(fp, h, cert))
1592 cur = strtok_s(
nullptr,
",", &context);
1601static BOOL accept_cert(rdpTls* tls,
const rdpCertificate* cert)
1604 WINPR_ASSERT(tls->context);
1607 FreeRDP_Settings_Keys_String
id = FreeRDP_AcceptedCert;
1608 FreeRDP_Settings_Keys_UInt32 lid = FreeRDP_AcceptedCertLength;
1610 rdpSettings* settings = tls->context->settings;
1611 WINPR_ASSERT(settings);
1613 if (tls->isGatewayTransport)
1615 id = FreeRDP_GatewayAcceptedCert;
1616 lid = FreeRDP_GatewayAcceptedCertLength;
1618 else if (is_redirected(tls))
1620 id = FreeRDP_RedirectionAcceptedCert;
1621 lid = FreeRDP_RedirectionAcceptedCertLength;
1624 size_t pemLength = 0;
1625 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1627 if (pemLength <= UINT32_MAX)
1637static BOOL tls_extract_full_pem(
const rdpCertificate* cert, BYTE** PublicKey,
1638 size_t* PublicKeyLength)
1640 if (!cert || !PublicKey)
1642 *PublicKey = (BYTE*)freerdp_certificate_get_pem(cert, PublicKeyLength);
1643 return *PublicKey !=
nullptr;
1647static int tls_config_parse_bool(WINPR_JSON* json,
const char* opt)
1659static int tls_config_check_allowed_hashed(
const char* configfile,
const rdpCertificate* cert,
1662 WINPR_ASSERT(configfile);
1676 "[%s] invalid certificate-db entry at position %" PRIuz
": not a JSON object",
1685 "[%s] invalid certificate-db entry at position %" PRIuz
1686 ": invalid 'type' element, expected type string",
1694 "[%s] invalid certificate-db entry at position %" PRIuz
1695 ": invalid 'hash' element, expected type string",
1703 char* hash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, skey, FALSE);
1707 "[%s] invalid certificate-db entry at position %" PRIuz
1708 ": hash type '%s' not supported by certificate",
1709 configfile, x, skey);
1713 const int cmp = _stricmp(hash, sval);
1724static int tls_config_check_certificate(
const rdpCertificate* cert, BOOL* pAllowUserconfig)
1727 WINPR_ASSERT(pAllowUserconfig);
1730 const char configfile[] =
"certificates.json";
1731 WINPR_JSON* json = freerdp_GetJSONConfigFile(TRUE, configfile);
1735 WLog_DBG(TAG,
"No or no valid configuration file for certificate handling, asking user");
1739 if (tls_config_parse_bool(json,
"deny") > 0)
1741 WLog_WARN(TAG,
"[%s] certificate denied by configuration", configfile);
1746 if (tls_config_parse_bool(json,
"ignore") > 0)
1748 WLog_WARN(TAG,
"[%s] certificate ignored by configuration", configfile);
1753 if (tls_config_check_allowed_hashed(configfile, cert, json) > 0)
1755 WLog_WARN(TAG,
"[%s] certificate manually accepted by configuration", configfile);
1760 if (tls_config_parse_bool(json,
"deny-userconfig") > 0)
1762 WLog_WARN(TAG,
"[%s] configuration denies user to accept certificates", configfile);
1769 *pAllowUserconfig = (rc == 0);
1774int tls_verify_certificate(rdpTls* tls,
const rdpCertificate* cert,
const char* hostname,
1779 BOOL certificate_status = 0;
1780 char* common_name =
nullptr;
1781 size_t common_name_length = 0;
1782 int verification_status = -1;
1783 BOOL hostname_match = FALSE;
1784 rdpCertificateData* certificate_data =
nullptr;
1785 BYTE* pemCert =
nullptr;
1786 DWORD flags = VERIFY_CERT_FLAG_NONE;
1790 rdpContext* context = tls->context;
1791 WINPR_ASSERT(context);
1793 freerdp* instance = context->instance;
1794 WINPR_ASSERT(instance);
1796 const rdpSettings* settings = context->settings;
1797 WINPR_ASSERT(settings);
1799 if (freerdp_shall_disconnect_context(context))
1802 if (!tls_extract_full_pem(cert, &pemCert, &length))
1806 if (is_accepted(tls, cert))
1808 verification_status = 1;
1812 if (is_accepted_fingerprint(cert, settings->CertificateAcceptedFingerprints))
1814 verification_status = 1;
1818 if (tls->isGatewayTransport || is_redirected(tls))
1819 flags |= VERIFY_CERT_FLAG_LEGACY;
1821 if (tls->isGatewayTransport)
1822 flags |= VERIFY_CERT_FLAG_GATEWAY;
1824 if (is_redirected(tls))
1825 flags |= VERIFY_CERT_FLAG_REDIRECT;
1828 if (settings->ExternalCertificateManagement)
1830 if (instance->VerifyX509Certificate)
1831 verification_status =
1832 instance->VerifyX509Certificate(instance, pemCert, length, hostname, port, flags);
1834 WLog_ERR(TAG,
"No VerifyX509Certificate callback registered!");
1836 if (verification_status > 0)
1838 if (!accept_cert(tls, cert))
1841 else if (verification_status < 0)
1843 WLog_ERR(TAG,
"VerifyX509Certificate failed: (length = %" PRIuz
") status: [%d] %s",
1844 length, verification_status, pemCert);
1851 WLog_WARN(TAG,
"[DANGER] Certificate not checked, /cert:ignore in use.");
1852 WLog_WARN(TAG,
"[DANGER] This prevents MITM attacks from being detected!");
1854 "[DANGER] Avoid using this unless in a secure LAN (=no internet) environment");
1855 verification_status = 1;
1857 else if (!tls->isGatewayTransport && (settings->AuthenticationLevel == 0))
1858 verification_status = 1;
1862 if (!tls->isGatewayTransport && settings->CertificateName)
1863 hostname = settings->CertificateName;
1866 certificate_status = freerdp_certificate_verify(
1867 cert, freerdp_certificate_store_get_certs_path(tls->certificate_store));
1869 certificate_data = freerdp_certificate_data_new(hostname, port, cert);
1870 if (!certificate_data)
1873 common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
1875 const size_t hostlen = strlen(hostname);
1876 if (freerdp_certificate_matches_hostname(cert, hostname, hostlen))
1877 hostname_match = TRUE;
1881 if (certificate_status && hostname_match)
1882 verification_status = 1;
1884 if (!hostname_match)
1885 flags |= VERIFY_CERT_FLAG_MISMATCH;
1887 BOOL allowUserconfig = TRUE;
1888 if (!certificate_status || !hostname_match)
1889 verification_status = tls_config_check_certificate(cert, &allowUserconfig);
1893 if (allowUserconfig && (!certificate_status || !hostname_match))
1895 DWORD accept_certificate = 0;
1896 size_t pem_length = 0;
1897 char* issuer = freerdp_certificate_get_issuer(cert);
1898 char* subject = freerdp_certificate_get_subject(cert);
1899 char* pem = freerdp_certificate_get_pem(cert, &pem_length);
1906 freerdp_certificate_store_contains_data(tls->certificate_store, certificate_data);
1912 if (!hostname_match)
1913 tls_print_certificate_name_mismatch_error(cert, hostname, port);
1916 const char* type =
"";
1918 type =
"tofo (auto-accept)";
1921 type =
"strict (auto-deny)";
1924 type =
"ignore (no check)";
1926 char* efp = freerdp_certificate_get_fingerprint(cert);
1927 tls_print_new_certificate_warn(tls->certificate_store, hostname, port, type,
1932#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
1933 WINPR_PRAGMA_DIAG_PUSH
1934 WINPR_PRAGMA_DIAG_IGNORED_DEPRECATED_DECL
1938 if (settings->AutoAcceptCertificate)
1940 WLog_INFO(TAG,
"No certificate stored, automatically accepting.");
1941 accept_certificate = 1;
1943 else if (settings->AutoDenyCertificate)
1945 WLog_INFO(TAG,
"No certificate stored, automatically denying.");
1946 accept_certificate = 0;
1948 else if (instance->VerifyX509Certificate)
1950 int rc = instance->VerifyX509Certificate(instance, pemCert, pem_length,
1951 hostname, port, flags);
1954 accept_certificate = 1;
1956 accept_certificate = 2;
1958 accept_certificate = 0;
1960 else if (instance->VerifyCertificateEx)
1962 const BOOL use_pem =
1965 DWORD cflags = flags;
1968 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
1972 fp = freerdp_certificate_get_fingerprint(cert);
1973 accept_certificate = instance->VerifyCertificateEx(
1974 instance, hostname, port, common_name, subject, issuer, fp, cflags);
1978#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
1979 else if (instance->VerifyCertificate)
1981 char* fp = freerdp_certificate_get_fingerprint(cert);
1983 WLog_WARN(TAG,
"The VerifyCertificate callback is deprecated, migrate your "
1984 "application to VerifyCertificateEx");
1985 accept_certificate = instance->VerifyCertificate(instance, common_name, subject,
1986 issuer, fp, !hostname_match);
1991 else if (match == -1)
1993 rdpCertificateData* stored_data =
1994 freerdp_certificate_store_load_data(tls->certificate_store, hostname, port);
1998 char* efp = freerdp_certificate_get_fingerprint(cert);
1999 tls_print_certificate_error(tls->certificate_store, stored_data, hostname, port,
2005 WLog_WARN(TAG,
"Failed to get certificate entry for %s:%" PRIu16
"", hostname,
2008 if (settings->AutoDenyCertificate)
2010 WLog_INFO(TAG,
"No certificate stored, automatically denying.");
2011 accept_certificate = 0;
2013 else if (instance->VerifyX509Certificate)
2016 instance->VerifyX509Certificate(instance, pemCert, pem_length, hostname,
2017 port, flags | VERIFY_CERT_FLAG_CHANGED);
2020 accept_certificate = 1;
2022 accept_certificate = 2;
2024 accept_certificate = 0;
2026 else if (instance->VerifyChangedCertificateEx)
2028 DWORD cflags = flags | VERIFY_CERT_FLAG_CHANGED;
2029 const char* old_subject = freerdp_certificate_data_get_subject(stored_data);
2030 const char* old_issuer = freerdp_certificate_data_get_issuer(stored_data);
2031 const char* old_fp = freerdp_certificate_data_get_fingerprint(stored_data);
2032 const char* old_pem = freerdp_certificate_data_get_pem(stored_data);
2033 const BOOL fpIsAllocated =
2039 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
2045 fp = freerdp_certificate_get_fingerprint(cert);
2047 accept_certificate = instance->VerifyChangedCertificateEx(
2048 instance, hostname, port, common_name, subject, issuer, fp, old_subject,
2049 old_issuer, old_fp, cflags);
2053#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2054 else if (instance->VerifyChangedCertificate)
2056 char* fp = freerdp_certificate_get_fingerprint(cert);
2057 const char* old_subject = freerdp_certificate_data_get_subject(stored_data);
2058 const char* old_issuer = freerdp_certificate_data_get_issuer(stored_data);
2059 const char* old_fingerprint =
2060 freerdp_certificate_data_get_fingerprint(stored_data);
2062 WLog_WARN(TAG,
"The VerifyChangedCertificate callback is deprecated, migrate "
2063 "your application to VerifyChangedCertificateEx");
2064 accept_certificate = instance->VerifyChangedCertificate(
2065 instance, common_name, subject, issuer, fp, old_subject, old_issuer,
2071 freerdp_certificate_data_free(stored_data);
2073 else if (match == 0)
2074 accept_certificate = 2;
2076#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2077 WINPR_PRAGMA_DIAG_POP
2081 switch (accept_certificate)
2086 verification_status = freerdp_certificate_store_save_data(
2087 tls->certificate_store, certificate_data)
2094 verification_status = 1;
2099 verification_status = -1;
2108 if (verification_status > 0)
2110 if (!accept_cert(tls, cert))
2116 freerdp_certificate_data_free(certificate_data);
2119 return verification_status;
2122void tls_print_new_certificate_warn(rdpCertificateStore* store,
const char* hostname, UINT16 port,
2123 const char* type,
const char* fingerprint)
2125 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2127 WLog_ERR(TAG,
"The host key for %s:%" PRIu16
" has changed", hostname, port);
2128 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2129 WLog_ERR(TAG,
"@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @");
2130 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2131 WLog_ERR(TAG,
"IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!");
2132 WLog_ERR(TAG,
"Someone could be eavesdropping on you right now (man-in-the-middle attack)!");
2133 WLog_ERR(TAG,
"It is also possible that a host key has just been changed.");
2134 WLog_ERR(TAG,
"The fingerprint for the host key sent by the remote host is %s", fingerprint);
2135 WLog_ERR(TAG,
"Please contact your system administrator.");
2136 WLog_ERR(TAG,
"Add correct host key in %s to get rid of this message.", path);
2137 WLog_ERR(TAG,
"Host key for %s has changed and you have requested %s checking.", hostname,
2139 WLog_ERR(TAG,
"Host key verification failed.");
2144void tls_print_certificate_error(rdpCertificateStore* store,
2145 WINPR_ATTR_UNUSED rdpCertificateData* stored_data,
2146 const char* hostname, UINT16 port,
const char* fingerprint)
2148 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2150 WLog_ERR(TAG,
"New host key for %s:%" PRIu16, hostname, port);
2151 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2152 WLog_ERR(TAG,
"@ WARNING: NEW HOST IDENTIFICATION! @");
2153 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2155 WLog_ERR(TAG,
"The fingerprint for the host key sent by the remote host is %s", fingerprint);
2156 WLog_ERR(TAG,
"Please contact your system administrator.");
2157 WLog_ERR(TAG,
"Add correct host key in %s to get rid of this message.", path);
2162void tls_print_certificate_name_mismatch_error(
const rdpCertificate* cert,
const char* hostname,
2165 WINPR_ASSERT(
nullptr != hostname);
2168 size_t common_name_length = 0;
2169 char* common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
2171 size_t dnscount = 0;
2172 size_t* dnslengths =
nullptr;
2173 char** dnsnames = freerdp_certificate_get_dns_names(cert, &dnscount, &dnslengths);
2176 size_t* iplengths =
nullptr;
2177 char** ipnames = freerdp_certificate_get_ip_names(cert, &ipcount, &iplengths);
2179 size_t count = dnscount;
2180 char** names = dnsnames;
2181 const BOOL isIP = utils_is_valid_ip(hostname);
2188 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2189 WLog_ERR(TAG,
"@ WARNING: CERTIFICATE NAME MISMATCH! @");
2190 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2191 WLog_ERR(TAG,
"The hostname used for this connection (%s:%" PRIu16
") ", hostname, port);
2192 WLog_ERR(TAG,
"does not match %s given in the certificate:",
2193 count < 1 ?
"the name" :
"any of the names");
2194 WLog_ERR(TAG,
"Common Name (CN):");
2195 WLog_ERR(TAG,
"\t%s", common_name ? common_name :
"no CN found in certificate");
2199 WINPR_ASSERT(
nullptr != names);
2200 WLog_ERR(TAG,
"Alternative names:");
2202 for (
size_t index = 0; index < count; index++)
2204 WINPR_ASSERT(names[index]);
2205 WLog_ERR(TAG,
"\t %s", names[index]);
2209 WLog_ERR(TAG,
"A valid certificate for the wrong name should NOT be trusted!");
2211 freerdp_certificate_free_dns_names(dnscount, dnslengths, dnsnames);
2212 freerdp_certificate_free_ip_names(ipcount, iplengths, ipnames);
2213 winpr_znfree(common_name, common_name_length);
2216rdpTls* freerdp_tls_new(rdpContext* context)
2218 rdpTls* tls =
nullptr;
2219 tls = (rdpTls*)calloc(1,
sizeof(rdpTls));
2224 tls->context = context;
2228 tls->certificate_store = freerdp_certificate_store_new(tls->context->settings);
2230 if (!tls->certificate_store)
2234 tls->alertLevel = TLS_ALERT_LEVEL_WARNING;
2235 tls->alertDescription = TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY;
2242void freerdp_tls_free(rdpTls* tls)
2249 if (tls->certificate_store)
2251 freerdp_certificate_store_free(tls->certificate_store);
2252 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.