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 char* hostname, UINT16 port,
117 const char* common_name,
char** alt_names,
118 size_t alt_names_count);
120static void tls_print_new_certificate_warn(rdpCertificateStore* store,
const char* hostname,
121 UINT16 port,
const char* type,
const char* fingerprint);
123static void tls_print_certificate_error(rdpCertificateStore* store, rdpCertificateData* stored_data,
124 const char* hostname, UINT16 port,
const char* fingerprint);
126static void free_tls_public_key(rdpTls* tls)
129 free(tls->PublicKey);
130 tls->PublicKey =
nullptr;
131 tls->PublicKeyLength = 0;
139 free(bindings->Bindings);
143#ifdef WITH_TLS_DATA_LIMIT
149static void bio_rdp_tls_account(BIO_RDP_TLS* tls, BOOL read,
int count)
151 UINT64* counter = read ? &tls->rxBytes : &tls->txBytes;
153 if (!tls->rekeyAvailable || tls->cutPending)
156 *counter += (UINT64)count;
157 if (*counter < TLS_DATA_LIMIT_BYTES)
160 if (SSL_version(tls->ssl) != TLS1_3_VERSION)
162 WLog_DBG(TAG,
"TLS data limit reached but connection is not TLS 1.3; "
163 "rekey unavailable, keeping connection");
164 tls->rekeyAvailable = FALSE;
168 if (SSL_key_update(tls->ssl, SSL_KEY_UPDATE_REQUESTED) != 1)
170 WLog_ERR(TAG,
"SSL_key_update failed at TLS data limit; cutting connection");
171 tls->cutPending = TRUE;
175 WLog_INFO(TAG,
"TLS 1.3 key update requested at data limit (%" PRIu64
" bytes %s)", *counter,
176 read ?
"read" :
"written");
180static void bio_rdp_tls_read_account(BIO_RDP_TLS* tls,
int count)
182 bio_rdp_tls_account(tls, TRUE, count);
185static void bio_rdp_tls_write_account(BIO_RDP_TLS* tls,
int count)
187 bio_rdp_tls_account(tls, FALSE, count);
192static int bio_rdp_tls_write(BIO* bio,
const char* buf,
int size)
196 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
201#ifdef WITH_TLS_DATA_LIMIT
204 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
209 BIO_clear_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_READ | BIO_FLAGS_IO_SPECIAL);
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 EnterCriticalSection(&tls->lock);
280 status = SSL_read(tls->ssl, buf, size);
281 error = SSL_get_error(tls->ssl, status);
282#ifdef WITH_TLS_DATA_LIMIT
284 bio_rdp_tls_read_account(tls, status);
286 LeaveCriticalSection(&tls->lock);
294 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
297 case SSL_ERROR_WANT_READ:
298 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
301 case SSL_ERROR_WANT_WRITE:
302 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
305 case SSL_ERROR_WANT_X509_LOOKUP:
306 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
307 BIO_set_retry_reason(bio, BIO_RR_SSL_X509_LOOKUP);
310 case SSL_ERROR_WANT_ACCEPT:
311 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
312 BIO_set_retry_reason(bio, BIO_RR_ACCEPT);
315 case SSL_ERROR_WANT_CONNECT:
316 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
317 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
321 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
324 case SSL_ERROR_ZERO_RETURN:
325 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
328 case SSL_ERROR_SYSCALL:
329 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
336#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
340 VALGRIND_MAKE_MEM_DEFINED(buf, status);
348static int bio_rdp_tls_puts(BIO* bio,
const char* str)
353 const size_t max = (INT_MAX > SIZE_MAX) ? SIZE_MAX : INT_MAX;
354 const size_t size = strnlen(str, max);
358 return BIO_write(bio, str, (
int)size);
362static int bio_rdp_tls_gets(WINPR_ATTR_UNUSED BIO* bio, WINPR_ATTR_UNUSED
char* str,
363 WINPR_ATTR_UNUSED
int size)
369static long bio_rdp_tls_ctrl(BIO* bio,
int cmd,
long num,
void* ptr)
371 BIO* ssl_rbio =
nullptr;
372 BIO* ssl_wbio =
nullptr;
373 BIO* next_bio =
nullptr;
375 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
380 if (!tls->ssl && (cmd != BIO_C_SET_SSL))
383 next_bio = BIO_next(bio);
384 ssl_rbio = tls->ssl ? SSL_get_rbio(tls->ssl) : nullptr;
385 ssl_wbio = tls->ssl ? SSL_get_wbio(tls->ssl) : nullptr;
390 SSL_shutdown(tls->ssl);
392 if (SSL_in_connect_init(tls->ssl))
393 SSL_set_connect_state(tls->ssl);
394 else if (SSL_in_accept_init(tls->ssl))
395 SSL_set_accept_state(tls->ssl);
400 status = BIO_ctrl(next_bio, cmd, num, ptr);
402 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
409 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
416 case BIO_CTRL_SET_CALLBACK:
420 case BIO_CTRL_GET_CALLBACK:
427 void* vptr = WINPR_FUNC_PTR_CAST(SSL_get_info_callback(tls->ssl),
void*);
428 *((
void**)ptr) = vptr;
435 SSL_set_connect_state(tls->ssl);
437 SSL_set_accept_state(tls->ssl);
442 case BIO_CTRL_GET_CLOSE:
443 status = BIO_get_shutdown(bio);
446 case BIO_CTRL_SET_CLOSE:
447 BIO_set_shutdown(bio, (
int)num);
451 case BIO_CTRL_WPENDING:
452 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
455 case BIO_CTRL_PENDING:
456 status = SSL_pending(tls->ssl);
459 status = BIO_pending(ssl_rbio);
464 BIO_clear_retry_flags(bio);
465 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
467 WLog_DBG(TAG,
"BIO_ctrl returned %ld", status);
468 BIO_copy_next_retry(bio);
473 if (next_bio && (next_bio != ssl_rbio))
475#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
476 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
477 SSL_set_bio(tls->ssl, next_bio, next_bio);
478 CRYPTO_add(&(bio->next_bio->references), 1, CRYPTO_LOCK_BIO);
484 BIO_up_ref(next_bio);
485 SSL_set_bio(tls->ssl, next_bio, next_bio);
497 if (ssl_rbio != ssl_wbio)
498 BIO_free_all(ssl_wbio);
500#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
501 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
504 CRYPTO_add(&(bio->next_bio->references), -1, CRYPTO_LOCK_BIO);
506 tls->ssl->wbio = tls->ssl->rbio =
nullptr;
509 SSL_set_bio(tls->ssl,
nullptr,
nullptr);
519 *((SSL**)ptr) = tls->ssl;
526 BIO_set_shutdown(bio, (
int)num);
530 tls->ssl = (SSL*)ptr;
531 ssl_rbio = SSL_get_rbio(tls->ssl);
537 BIO_push(ssl_rbio, next_bio);
539 BIO_set_next(bio, ssl_rbio);
540#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
541 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
542 CRYPTO_add(&(ssl_rbio->references), 1, CRYPTO_LOCK_BIO);
544 BIO_up_ref(ssl_rbio);
548 BIO_set_init(bio, 1);
552 case BIO_C_DO_STATE_MACHINE:
553 BIO_clear_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL);
554 BIO_set_retry_reason(bio, 0);
555 status = SSL_do_handshake(tls->ssl);
559 const int err = (status < INT32_MIN) ? INT32_MIN : (int)status;
560 switch (SSL_get_error(tls->ssl, err))
562 case SSL_ERROR_WANT_READ:
563 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
566 case SSL_ERROR_WANT_WRITE:
567 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
570 case SSL_ERROR_WANT_CONNECT:
571 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL | BIO_FLAGS_SHOULD_RETRY);
572 BIO_set_retry_reason(bio, BIO_get_retry_reason(next_bio));
576 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
584 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
592static int bio_rdp_tls_new(BIO* bio)
594 BIO_RDP_TLS* tls =
nullptr;
595 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
597 if (!(tls = calloc(1,
sizeof(BIO_RDP_TLS))))
600 if (!InitializeCriticalSectionAndSpinCount(&tls->lock, 4000))
606#ifdef WITH_TLS_DATA_LIMIT
609 tls->rekeyAvailable = TRUE;
612 BIO_set_data(bio, (
void*)tls);
617static int bio_rdp_tls_free(BIO* bio)
619 BIO_RDP_TLS* tls =
nullptr;
624 tls = (BIO_RDP_TLS*)BIO_get_data(bio);
629 BIO_set_data(bio,
nullptr);
630 if (BIO_get_shutdown(bio))
632 if (BIO_get_init(bio) && tls->ssl)
634 SSL_shutdown(tls->ssl);
638 BIO_set_init(bio, 0);
639 BIO_set_flags(bio, 0);
642 DeleteCriticalSection(&tls->lock);
649static long bio_rdp_tls_callback_ctrl(BIO* bio,
int cmd, bio_info_cb* fp)
656 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
663 case BIO_CTRL_SET_CALLBACK:
665 typedef void (*fkt_t)(
const SSL*, int, int);
671 fkt_t fkt = WINPR_FUNC_PTR_CAST(fp, fkt_t);
672 SSL_set_info_callback(tls->ssl, fkt);
678 status = BIO_callback_ctrl(SSL_get_rbio(tls->ssl), cmd, fp);
685#define BIO_TYPE_RDP_TLS 68
688static BOOL CALLBACK bio_rdp_tls_init_once(WINPR_ATTR_UNUSED
PINIT_ONCE once,
689 WINPR_ATTR_UNUSED PVOID param,
690 WINPR_ATTR_UNUSED PVOID* context)
692 g_BioMethods = BIO_meth_new(BIO_TYPE_RDP_TLS,
"RdpTls");
696 if (BIO_meth_set_write(g_BioMethods, bio_rdp_tls_write) != 1)
698 if (BIO_meth_set_read(g_BioMethods, bio_rdp_tls_read) != 1)
700 if (BIO_meth_set_puts(g_BioMethods, bio_rdp_tls_puts) != 1)
702 if (BIO_meth_set_gets(g_BioMethods, bio_rdp_tls_gets) != 1)
704 if (BIO_meth_set_ctrl(g_BioMethods, bio_rdp_tls_ctrl) != 1)
706 if (BIO_meth_set_create(g_BioMethods, bio_rdp_tls_new) != 1)
708 if (BIO_meth_set_destroy(g_BioMethods, bio_rdp_tls_free) != 1)
710 if (BIO_meth_set_callback_ctrl(g_BioMethods, bio_rdp_tls_callback_ctrl) != 1)
717static BIO_METHOD* BIO_s_rdp_tls(
void)
719 if (!InitOnceExecuteOnce(&g_BioMethodsOnce, bio_rdp_tls_init_once,
nullptr,
nullptr))
724WINPR_ATTR_MALLOC(BIO_free, 1)
725static BIO* BIO_new_rdp_tls(SSL_CTX* ctx,
int client)
727 BIO* bio = BIO_new(BIO_s_rdp_tls());
732 SSL* ssl = SSL_new(ctx);
741 SSL_set_connect_state(ssl);
743 SSL_set_accept_state(ssl);
745 BIO_set_ssl(bio, ssl, BIO_CLOSE);
749WINPR_ATTR_MALLOC(freerdp_certificate_free, 1)
750static rdpCertificate* tls_get_certificate(rdpTls* tls, BOOL peer)
752 X509* remote_cert =
nullptr;
755 remote_cert = SSL_get_peer_certificate(tls->ssl);
757 remote_cert = X509_dup(SSL_get_certificate(tls->ssl));
761 WLog_ERR(TAG,
"failed to get the server TLS certificate");
766 STACK_OF(X509)* chain = SSL_get_peer_cert_chain(tls->ssl);
767 rdpCertificate* cert = freerdp_certificate_new_from_x509(remote_cert, chain);
768 X509_free(remote_cert);
774static const char* tls_get_server_name(rdpTls* tls)
776 return tls->serverName ? tls->serverName : tls->hostname;
779#define TLS_SERVER_END_POINT "tls-server-end-point:"
781WINPR_ATTR_MALLOC(free_tls_bindings, 1)
784 size_t CertificateHashLength = 0;
785 BYTE* ChannelBindingToken =
nullptr;
787 const size_t PrefixLength = strnlen(TLS_SERVER_END_POINT, ARRAYSIZE(TLS_SERVER_END_POINT));
792 WINPR_MD_TYPE alg = freerdp_certificate_get_signature_alg(cert);
793 const char* hash =
nullptr;
799 hash = winpr_md_type_to_string(WINPR_MD_SHA256);
802 hash = winpr_md_type_to_string(alg);
808 char* CertificateHash = freerdp_certificate_get_hash(cert, hash, &CertificateHashLength);
809 if (!CertificateHash)
812 const size_t ChannelBindingTokenLength = PrefixLength + CertificateHashLength;
815 if (!ContextBindings)
820 if (slen > UINT32_MAX)
823 ContextBindings->BindingsLength = (UINT32)slen;
827 if (!ChannelBindings)
830 ContextBindings->Bindings = ChannelBindings;
831 ChannelBindings->cbApplicationDataLength = (UINT32)ChannelBindingTokenLength;
833 ChannelBindingToken = &((BYTE*)ChannelBindings)[ChannelBindings->dwApplicationDataOffset];
834 memcpy(ChannelBindingToken, TLS_SERVER_END_POINT, PrefixLength);
835 memcpy(ChannelBindingToken + PrefixLength, CertificateHash, CertificateHashLength);
836 free(CertificateHash);
837 return ContextBindings;
839 free(CertificateHash);
840 free(ContextBindings);
845static BOOL CALLBACK secrets_file_init_cb(WINPR_ATTR_UNUSED
PINIT_ONCE once,
846 WINPR_ATTR_UNUSED PVOID param,
847 WINPR_ATTR_UNUSED PVOID* context)
849 secrets_file_idx = SSL_get_ex_new_index(0,
nullptr,
nullptr,
nullptr,
nullptr);
851 return (secrets_file_idx != -1);
854static void SSLCTX_keylog_cb(
const SSL* ssl,
const char* line)
856 char* dfile =
nullptr;
858 if (secrets_file_idx == -1)
861 dfile = SSL_get_ex_data(ssl, secrets_file_idx);
864 FILE* f = winpr_fopen(dfile,
"a+");
867 (void)fwrite(line, strlen(line), 1, f);
868 (void)fwrite(
"\n", 1, 1, f);
874static void tls_reset(rdpTls* tls)
880 SSL_CTX_free(tls->ctx);
887 BIO_free_all(tls->bio);
888 else if (tls->underlying)
889 BIO_free_all(tls->underlying);
891 tls->underlying =
nullptr;
893 free_tls_public_key(tls);
894 free_tls_bindings(tls->Bindings);
895 tls->Bindings =
nullptr;
898#if OPENSSL_VERSION_NUMBER >= 0x010000000L
900static BOOL tls_prepare(rdpTls* tls, BIO* underlying,
const SSL_METHOD* method,
int options,
904static BOOL tls_prepare(rdpTls* tls, BIO* underlying, SSL_METHOD* method,
int options,
910 rdpSettings* settings = tls->context->settings;
911 WINPR_ASSERT(settings);
914 tls->ctx = SSL_CTX_new(method);
916 tls->underlying = underlying;
920 WLog_ERR(TAG,
"SSL_CTX_new failed");
924 SSL_CTX_set_mode(tls->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_ENABLE_PARTIAL_WRITE);
925 SSL_CTX_set_options(tls->ctx, WINPR_ASSERTING_INT_CAST(uint64_t, options));
926 SSL_CTX_set_read_ahead(tls->ctx, 1);
927#if OPENSSL_VERSION_NUMBER >= 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
929 if (!SSL_CTX_set_min_proto_version(tls->ctx, version))
931 WLog_ERR(TAG,
"SSL_CTX_set_min_proto_version %" PRIu16
" failed", version);
935 if (!SSL_CTX_set_max_proto_version(tls->ctx, version))
937 WLog_ERR(TAG,
"SSL_CTX_set_max_proto_version %" PRIu16
" failed", version);
941#if OPENSSL_VERSION_NUMBER >= 0x10100000L && !defined(LIBRESSL_VERSION_NUMBER)
942 SSL_CTX_set_security_level(tls->ctx, WINPR_ASSERTING_INT_CAST(
int, settings->TlsSecLevel));
945 if (settings->AllowedTlsCiphers)
947 if (!SSL_CTX_set_cipher_list(tls->ctx, settings->AllowedTlsCiphers))
949 WLog_ERR(TAG,
"SSL_CTX_set_cipher_list %s failed", settings->AllowedTlsCiphers);
954 tls->bio = BIO_new_rdp_tls(tls->ctx, clientMode);
958 WLog_ERR(TAG,
"unable to create TLS BIO");
962 if (BIO_get_ssl(tls->bio, &tls->ssl) < 0 || !tls->ssl)
964 WLog_ERR(TAG,
"unable to retrieve the SSL of the connection");
968 if (settings->TlsSecretsFile)
970#if OPENSSL_VERSION_NUMBER >= 0x10101000L
971 if (!InitOnceExecuteOnce(&secrets_file_idx_once, secrets_file_init_cb,
nullptr,
nullptr))
974 if (secrets_file_idx != -1)
976 SSL_set_ex_data(tls->ssl, secrets_file_idx, settings->TlsSecretsFile);
977 SSL_CTX_set_keylog_callback(tls->ctx, SSLCTX_keylog_cb);
980 WLog_WARN(TAG,
"Key-Logging not available - requires OpenSSL 1.1.1 or higher");
984 BIO_push(tls->bio, underlying);
989adjustSslOptions(WINPR_ATTR_UNUSED
int* options)
991 WINPR_ASSERT(options);
992#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
993 *options |= SSL_OP_NO_SSLv2;
994 *options |= SSL_OP_NO_SSLv3;
998const SSL_METHOD* freerdp_tls_get_ssl_method(BOOL isDtls, BOOL isClient)
1003 return DTLS_client_method();
1004#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1005 return SSLv23_client_method();
1007 return TLS_client_method();
1012 return DTLS_server_method();
1014#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1015 return SSLv23_server_method();
1017 return TLS_server_method();
1021TlsHandshakeResult freerdp_tls_connect_ex(rdpTls* tls, BIO* underlying,
const SSL_METHOD* methods)
1035#ifdef SSL_OP_NO_COMPRESSION
1036 options |= SSL_OP_NO_COMPRESSION;
1044 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1051 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1053 tls->isClientMode = TRUE;
1054 adjustSslOptions(&options);
1056 if (!tls_prepare(tls, underlying, methods, options, TRUE))
1057 return TLS_HANDSHAKE_ERROR;
1059#if !defined(OPENSSL_NO_TLSEXT)
1060 const char* str = tls_get_server_name(tls);
1061 void* ptr = WINPR_CAST_CONST_PTR_AWAY(str,
void*);
1062 SSL_set_tlsext_host_name(tls->ssl, ptr);
1065 return freerdp_tls_handshake(tls);
1068static int bio_err_print(
const char* str,
size_t len,
void* u)
1071 WLog_Print(log, WLOG_ERROR,
"[BIO_do_handshake] %s [%" PRIuz
"]", str, len);
1075TlsHandshakeResult freerdp_tls_handshake(rdpTls* tls)
1077 TlsHandshakeResult ret = TLS_HANDSHAKE_ERROR;
1080 const long status = BIO_do_handshake(tls->bio);
1083 if (!BIO_should_retry(tls->bio))
1085 wLog* log = WLog_Get(TAG);
1086 WLog_Print(log, WLOG_ERROR,
"BIO_do_handshake failed");
1087 ERR_print_errors_cb(bio_err_print, log);
1088 return TLS_HANDSHAKE_ERROR;
1091 return TLS_HANDSHAKE_CONTINUE;
1094 int verify_status = 0;
1095 rdpCertificate* cert = tls_get_certificate(tls, tls->isClientMode);
1099 WLog_ERR(TAG,
"tls_get_certificate failed to return the server certificate.");
1100 return TLS_HANDSHAKE_ERROR;
1105 free_tls_bindings(tls->Bindings);
1106 tls->Bindings = tls_get_channel_bindings(cert);
1109 WLog_ERR(TAG,
"unable to retrieve bindings");
1113 free_tls_public_key(tls);
1114 if (!freerdp_certificate_get_public_key(cert, &tls->PublicKey, &tls->PublicKeyLength))
1117 "freerdp_certificate_get_public_key failed to return the server public key.");
1122 ret = TLS_HANDSHAKE_SUCCESS;
1124 if (tls->isClientMode)
1126 WINPR_ASSERT(tls->port <= UINT16_MAX);
1128 tls_verify_certificate(tls, cert, tls_get_server_name(tls), (UINT16)tls->port);
1130 if (verify_status < 1)
1132 WLog_ERR(TAG,
"certificate not trusted, aborting.");
1133 freerdp_tls_send_alert(tls);
1134 ret = TLS_HANDSHAKE_VERIFY_ERROR;
1139 freerdp_certificate_free(cert);
1143static int pollAndHandshake(rdpTls* tls)
1149 HANDLE events[] = { freerdp_abort_event(tls->context),
nullptr };
1151 if (BIO_get_event(tls->bio, &events[1]) < 0)
1153 WLog_ERR(TAG,
"unable to retrieve BIO associated event");
1159 WLog_ERR(TAG,
"unable to retrieve BIO event");
1163 status = WaitForMultipleObjectsEx(ARRAYSIZE(events), events, FALSE, INFINITE, TRUE);
1166 case WAIT_OBJECT_0 + 1:
1169 WLog_DBG(TAG,
"Abort event set, cancel connect");
1172 case WAIT_IO_COMPLETION:
1175 WLog_ERR(TAG,
"error during WaitForSingleObject(): 0x%08" PRIX32
"", status);
1179 TlsHandshakeResult result = freerdp_tls_handshake(tls);
1182 case TLS_HANDSHAKE_CONTINUE:
1184 case TLS_HANDSHAKE_SUCCESS:
1186 case TLS_HANDSHAKE_ERROR:
1187 case TLS_HANDSHAKE_VERIFY_ERROR:
1194int freerdp_tls_connect(rdpTls* tls, BIO* underlying)
1196 const SSL_METHOD* method = freerdp_tls_get_ssl_method(FALSE, TRUE);
1199 TlsHandshakeResult result = freerdp_tls_connect_ex(tls, underlying, method);
1202 case TLS_HANDSHAKE_SUCCESS:
1204 case TLS_HANDSHAKE_CONTINUE:
1206 case TLS_HANDSHAKE_ERROR:
1207 case TLS_HANDSHAKE_VERIFY_ERROR:
1213 return pollAndHandshake(tls);
1216#if defined(MICROSOFT_IOS_SNI_BUG) && !defined(OPENSSL_NO_TLSEXT) && \
1217 !defined(LIBRESSL_VERSION_NUMBER)
1218static void tls_openssl_tlsext_debug_callback(SSL* s,
int client_server,
int type,
1219 unsigned char* data,
int len,
void* arg)
1221 if (type == TLSEXT_TYPE_server_name)
1223 WLog_DBG(TAG,
"Client uses SNI (extension disabled)");
1224 s->servername_done = 2;
1229BOOL freerdp_tls_accept(rdpTls* tls, BIO* underlying, rdpSettings* settings)
1232 TlsHandshakeResult res =
1233 freerdp_tls_accept_ex(tls, underlying, settings, freerdp_tls_get_ssl_method(FALSE, FALSE));
1236 case TLS_HANDSHAKE_SUCCESS:
1238 case TLS_HANDSHAKE_CONTINUE:
1240 case TLS_HANDSHAKE_ERROR:
1241 case TLS_HANDSHAKE_VERIFY_ERROR:
1246 return pollAndHandshake(tls) > 0;
1249TlsHandshakeResult freerdp_tls_accept_ex(rdpTls* tls, BIO* underlying, rdpSettings* settings,
1250 const SSL_METHOD* methods)
1263 options |= SSL_OP_NO_SSLv2;
1273#ifdef SSL_OP_NO_COMPRESSION
1274 options |= SSL_OP_NO_COMPRESSION;
1282 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1289 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1297#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && (OPENSSL_VERSION_NUMBER < 0x30000000L) && \
1298 !defined(LIBRESSL_VERSION_NUMBER)
1299 options |= SSL_OP_NO_RENEGOTIATION;
1302 if (!tls_prepare(tls, underlying, methods, options, FALSE))
1303 return TLS_HANDSHAKE_ERROR;
1308 WLog_ERR(TAG,
"invalid private key");
1309 return TLS_HANDSHAKE_ERROR;
1312 EVP_PKEY* privkey = freerdp_key_get_evp_pkey(key);
1315 WLog_ERR(TAG,
"invalid private key");
1316 return TLS_HANDSHAKE_ERROR;
1319 status = SSL_use_PrivateKey(tls->ssl, privkey);
1324 EVP_PKEY_free(privkey);
1328 WLog_ERR(TAG,
"SSL_CTX_use_PrivateKey_file failed");
1329 return TLS_HANDSHAKE_ERROR;
1332 rdpCertificate* cert =
1336 WLog_ERR(TAG,
"invalid certificate");
1337 return TLS_HANDSHAKE_ERROR;
1340 status = SSL_use_certificate(tls->ssl, freerdp_certificate_get_x509(cert));
1344 WLog_ERR(TAG,
"SSL_use_certificate_file failed");
1345 return TLS_HANDSHAKE_ERROR;
1348 const size_t cnt = freerdp_certificate_get_chain_len(cert);
1349 for (
size_t x = 0; x < cnt; x++)
1351 X509* xcert = freerdp_certificate_get_chain_at(cert, x);
1352 WINPR_ASSERT(xcert);
1353 const long rc = SSL_add1_chain_cert(tls->ssl, xcert);
1356 WLog_ERR(TAG,
"SSL_add1_chain_cert failed");
1357 return TLS_HANDSHAKE_ERROR;
1361#if defined(MICROSOFT_IOS_SNI_BUG) && !defined(OPENSSL_NO_TLSEXT) && \
1362 !defined(LIBRESSL_VERSION_NUMBER)
1363 SSL_set_tlsext_debug_callback(tls->ssl, tls_openssl_tlsext_debug_callback);
1366 return freerdp_tls_handshake(tls);
1369BOOL freerdp_tls_send_alert(rdpTls* tls)
1383#if (!defined(LIBRESSL_VERSION_NUMBER) && (OPENSSL_VERSION_NUMBER < 0x10100000L)) || \
1384 (defined(LIBRESSL_VERSION_NUMBER) && (LIBRESSL_VERSION_NUMBER <= 0x2080300fL))
1386 if (tls->alertDescription != TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY)
1397 SSL_SESSION* ssl_session = SSL_get_session(tls->ssl);
1398 SSL_CTX* ssl_ctx = SSL_get_SSL_CTX(tls->ssl);
1399 SSL_set_quiet_shutdown(tls->ssl, 1);
1401 if ((tls->alertLevel == TLS_ALERT_LEVEL_FATAL) && (ssl_session))
1402 SSL_CTX_remove_session(ssl_ctx, ssl_session);
1404 tls->ssl->s3->alert_dispatch = 1;
1405 tls->ssl->s3->send_alert[0] = tls->alertLevel;
1406 tls->ssl->s3->send_alert[1] = tls->alertDescription;
1408 if (tls->ssl->s3->wbuf.left == 0)
1409 tls->ssl->method->ssl_dispatch_alert(tls->ssl);
1416int freerdp_tls_write_all(rdpTls* tls,
const BYTE* data,
size_t length)
1420 BIO* bio = tls->bio;
1422 if (length > INT32_MAX)
1425 while (offset < length)
1428 const int status = BIO_write(bio, &data[offset], (
int)(length - offset));
1431 offset += (size_t)status;
1434 if (!BIO_should_retry(bio))
1437 if (BIO_write_blocked(bio))
1439 const long rc = BIO_wait_write(bio, 100);
1443 else if (BIO_read_blocked(bio))
1453int freerdp_tls_set_alert_code(rdpTls* tls,
int level,
int description)
1456 tls->alertLevel = level;
1457 tls->alertDescription = description;
1462static BOOL tls_match_hostname(
const char* pattern,
const size_t pattern_length,
1463 const char* hostname)
1465 WINPR_ASSERT(hostname);
1466 WINPR_ASSERT(pattern || (pattern_length == 0));
1468 const size_t hlen = strlen(hostname);
1469 if (hlen == pattern_length)
1471 if (_strnicmp(hostname, pattern, pattern_length) == 0)
1475 if ((pattern_length > 2) && (pattern[0] ==
'*') && (pattern[1] ==
'.') &&
1476 (hlen >= pattern_length))
1479 const size_t prefixlen = hlen - pattern_length;
1480 for (
size_t x = 0; x < prefixlen; x++)
1482 char cur = hostname[x];
1488 const char* check_hostname = &hostname[prefixlen + 1];
1489 return _strnicmp(check_hostname, &pattern[1], pattern_length - 1) == 0;
1496static BOOL is_redirected(rdpTls* tls)
1498 rdpSettings* settings = tls->context->settings;
1500 if (settings->GatewayArmTransport)
1503 if (LB_NOREDIRECT & settings->RedirectionFlags)
1506 return settings->RedirectionFlags != 0;
1510static BOOL is_accepted(rdpTls* tls,
const rdpCertificate* cert)
1513 WINPR_ASSERT(tls->context);
1515 rdpSettings* settings = tls->context->settings;
1516 WINPR_ASSERT(settings);
1518 FreeRDP_Settings_Keys_String keyAccepted = FreeRDP_AcceptedCert;
1519 FreeRDP_Settings_Keys_UInt32 keyLength = FreeRDP_AcceptedCertLength;
1521 if (tls->isGatewayTransport)
1523 keyAccepted = FreeRDP_GatewayAcceptedCert;
1524 keyLength = FreeRDP_GatewayAcceptedCertLength;
1526 else if (is_redirected(tls))
1528 keyAccepted = FreeRDP_RedirectionAcceptedCert;
1529 keyLength = FreeRDP_RedirectionAcceptedCertLength;
1535 if ((AcceptedKeyLength > 0) && AcceptedKey)
1537 BOOL accepted = FALSE;
1538 size_t pemLength = 0;
1539 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1540 if (pem && (AcceptedKeyLength == pemLength))
1542 if (memcmp(AcceptedKey, pem, AcceptedKeyLength) == 0)
1551 WLog_WARN(TAG,
"freerdp_settings_set_string(settings, keyAccepted=%d, nullptr) failed",
1554 WLog_WARN(TAG,
"freerdp_settings_set_uint32(settings, keyLength=%d, 0) failed", keyLength);
1560static BOOL compare_fingerprint(
const char* fp,
const char* hash,
const rdpCertificate* cert,
1564 char* strhash =
nullptr;
1570 strhash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, hash, separator);
1574 equal = (_stricmp(strhash, fp) == 0);
1580static BOOL compare_fingerprint_all(
const char* fp,
const char* hash,
const rdpCertificate* cert)
1585 if (compare_fingerprint(fp, hash, cert, FALSE))
1587 if (compare_fingerprint(fp, hash, cert, TRUE))
1593static BOOL is_accepted_fingerprint(
const rdpCertificate* cert,
1594 const char* CertificateAcceptedFingerprints)
1599 if (CertificateAcceptedFingerprints)
1601 char* context =
nullptr;
1602 char* copy = _strdup(CertificateAcceptedFingerprints);
1603 char* cur = strtok_s(copy,
",", &context);
1606 char* subcontext =
nullptr;
1607 const char* h = strtok_s(cur,
":", &subcontext);
1613 const char* fp = h + strlen(h) + 1;
1614 if (compare_fingerprint_all(fp, h, cert))
1621 cur = strtok_s(
nullptr,
",", &context);
1630static BOOL accept_cert(rdpTls* tls,
const rdpCertificate* cert)
1633 WINPR_ASSERT(tls->context);
1636 FreeRDP_Settings_Keys_String
id = FreeRDP_AcceptedCert;
1637 FreeRDP_Settings_Keys_UInt32 lid = FreeRDP_AcceptedCertLength;
1639 rdpSettings* settings = tls->context->settings;
1640 WINPR_ASSERT(settings);
1642 if (tls->isGatewayTransport)
1644 id = FreeRDP_GatewayAcceptedCert;
1645 lid = FreeRDP_GatewayAcceptedCertLength;
1647 else if (is_redirected(tls))
1649 id = FreeRDP_RedirectionAcceptedCert;
1650 lid = FreeRDP_RedirectionAcceptedCertLength;
1653 size_t pemLength = 0;
1654 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1656 if (pemLength <= UINT32_MAX)
1666static BOOL tls_extract_full_pem(
const rdpCertificate* cert, BYTE** PublicKey,
1667 size_t* PublicKeyLength)
1669 if (!cert || !PublicKey)
1671 *PublicKey = (BYTE*)freerdp_certificate_get_pem(cert, PublicKeyLength);
1672 return *PublicKey !=
nullptr;
1676static int tls_config_parse_bool(WINPR_JSON* json,
const char* opt)
1688static int tls_config_check_allowed_hashed(
const char* configfile,
const rdpCertificate* cert,
1691 WINPR_ASSERT(configfile);
1705 "[%s] invalid certificate-db entry at position %" PRIuz
": not a JSON object",
1714 "[%s] invalid certificate-db entry at position %" PRIuz
1715 ": invalid 'type' element, expected type string",
1723 "[%s] invalid certificate-db entry at position %" PRIuz
1724 ": invalid 'hash' element, expected type string",
1732 char* hash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, skey, FALSE);
1736 "[%s] invalid certificate-db entry at position %" PRIuz
1737 ": hash type '%s' not supported by certificate",
1738 configfile, x, skey);
1742 const int cmp = _stricmp(hash, sval);
1753static int tls_config_check_certificate(
const rdpCertificate* cert, BOOL* pAllowUserconfig)
1756 WINPR_ASSERT(pAllowUserconfig);
1759 const char configfile[] =
"certificates.json";
1760 WINPR_JSON* json = freerdp_GetJSONConfigFile(TRUE, configfile);
1764 WLog_DBG(TAG,
"No or no valid configuration file for certificate handling, asking user");
1768 if (tls_config_parse_bool(json,
"deny") > 0)
1770 WLog_WARN(TAG,
"[%s] certificate denied by configuration", configfile);
1775 if (tls_config_parse_bool(json,
"ignore") > 0)
1777 WLog_WARN(TAG,
"[%s] certificate ignored by configuration", configfile);
1782 if (tls_config_check_allowed_hashed(configfile, cert, json) > 0)
1784 WLog_WARN(TAG,
"[%s] certificate manually accepted by configuration", configfile);
1789 if (tls_config_parse_bool(json,
"deny-userconfig") > 0)
1791 WLog_WARN(TAG,
"[%s] configuration denies user to accept certificates", configfile);
1798 *pAllowUserconfig = (rc == 0);
1803int tls_verify_certificate(rdpTls* tls,
const rdpCertificate* cert,
const char* hostname,
1808 BOOL certificate_status = 0;
1809 char* common_name =
nullptr;
1810 size_t common_name_length = 0;
1811 char** dns_names =
nullptr;
1812 size_t dns_names_count = 0;
1813 size_t* dns_names_lengths =
nullptr;
1814 char** ip_names =
nullptr;
1815 size_t ip_names_count = 0;
1816 size_t* ip_names_lengths =
nullptr;
1817 int verification_status = -1;
1818 BOOL hostname_match = FALSE;
1819 rdpCertificateData* certificate_data =
nullptr;
1820 BYTE* pemCert =
nullptr;
1821 DWORD flags = VERIFY_CERT_FLAG_NONE;
1825 rdpContext* context = tls->context;
1826 WINPR_ASSERT(context);
1828 freerdp* instance = context->instance;
1829 WINPR_ASSERT(instance);
1831 const rdpSettings* settings = context->settings;
1832 WINPR_ASSERT(settings);
1834 if (freerdp_shall_disconnect_context(context))
1837 if (!tls_extract_full_pem(cert, &pemCert, &length))
1841 if (is_accepted(tls, cert))
1843 verification_status = 1;
1847 if (is_accepted_fingerprint(cert, settings->CertificateAcceptedFingerprints))
1849 verification_status = 1;
1853 if (tls->isGatewayTransport || is_redirected(tls))
1854 flags |= VERIFY_CERT_FLAG_LEGACY;
1856 if (tls->isGatewayTransport)
1857 flags |= VERIFY_CERT_FLAG_GATEWAY;
1859 if (is_redirected(tls))
1860 flags |= VERIFY_CERT_FLAG_REDIRECT;
1863 if (settings->ExternalCertificateManagement)
1865 if (instance->VerifyX509Certificate)
1866 verification_status =
1867 instance->VerifyX509Certificate(instance, pemCert, length, hostname, port, flags);
1869 WLog_ERR(TAG,
"No VerifyX509Certificate callback registered!");
1871 if (verification_status > 0)
1873 if (!accept_cert(tls, cert))
1876 else if (verification_status < 0)
1878 WLog_ERR(TAG,
"VerifyX509Certificate failed: (length = %" PRIuz
") status: [%d] %s",
1879 length, verification_status, pemCert);
1886 WLog_WARN(TAG,
"[DANGER] Certificate not checked, /cert:ignore in use.");
1887 WLog_WARN(TAG,
"[DANGER] This prevents MITM attacks from being detected!");
1889 "[DANGER] Avoid using this unless in a secure LAN (=no internet) environment");
1890 verification_status = 1;
1892 else if (!tls->isGatewayTransport && (settings->AuthenticationLevel == 0))
1893 verification_status = 1;
1897 if (!tls->isGatewayTransport && settings->CertificateName)
1898 hostname = settings->CertificateName;
1901 certificate_status = freerdp_certificate_verify(
1902 cert, freerdp_certificate_store_get_certs_path(tls->certificate_store));
1904 certificate_data = freerdp_certificate_data_new(hostname, port, cert);
1905 if (!certificate_data)
1908 common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
1909 dns_names = freerdp_certificate_get_dns_names(cert, &dns_names_count, &dns_names_lengths);
1910 ip_names = freerdp_certificate_get_ip_names(cert, &ip_names_count, &ip_names_lengths);
1912 if (utils_is_valid_ip(hostname))
1914 const size_t hostlen = strlen(hostname);
1915 if ((hostlen != 0) && ip_names && (ip_names_count > 0))
1918 for (
size_t index = 0; index < ip_names_count; index++)
1920 if (utils_compare_ip_strings(ip_names[index], ip_names_lengths[index], hostname,
1923 hostname_match = TRUE;
1932 for (
size_t index = 0; index < dns_names_count; index++)
1934 if (tls_match_hostname(dns_names[index], dns_names_lengths[index], hostname))
1936 hostname_match = TRUE;
1942 else if (common_name)
1944 if (tls_match_hostname(common_name, common_name_length, hostname))
1945 hostname_match = TRUE;
1950 if (certificate_status && hostname_match)
1951 verification_status = 1;
1953 if (!hostname_match)
1954 flags |= VERIFY_CERT_FLAG_MISMATCH;
1956 BOOL allowUserconfig = TRUE;
1957 if (!certificate_status || !hostname_match)
1958 verification_status = tls_config_check_certificate(cert, &allowUserconfig);
1962 if (allowUserconfig && (!certificate_status || !hostname_match))
1964 DWORD accept_certificate = 0;
1965 size_t pem_length = 0;
1966 char* issuer = freerdp_certificate_get_issuer(cert);
1967 char* subject = freerdp_certificate_get_subject(cert);
1968 char* pem = freerdp_certificate_get_pem(cert, &pem_length);
1975 freerdp_certificate_store_contains_data(tls->certificate_store, certificate_data);
1981 if (!hostname_match)
1982 tls_print_certificate_name_mismatch_error(hostname, port, common_name,
1983 dns_names, dns_names_count);
1986 const char* type =
"";
1988 type =
"tofo (auto-accept)";
1991 type =
"strict (auto-deny)";
1994 type =
"ignore (no check)";
1996 char* efp = freerdp_certificate_get_fingerprint(cert);
1997 tls_print_new_certificate_warn(tls->certificate_store, hostname, port, type,
2002#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2003 WINPR_PRAGMA_DIAG_PUSH
2004 WINPR_PRAGMA_DIAG_IGNORED_DEPRECATED_DECL
2008 if (settings->AutoAcceptCertificate)
2010 WLog_INFO(TAG,
"No certificate stored, automatically accepting.");
2011 accept_certificate = 1;
2013 else if (settings->AutoDenyCertificate)
2015 WLog_INFO(TAG,
"No certificate stored, automatically denying.");
2016 accept_certificate = 0;
2018 else if (instance->VerifyX509Certificate)
2020 int rc = instance->VerifyX509Certificate(instance, pemCert, pem_length,
2021 hostname, port, flags);
2024 accept_certificate = 1;
2026 accept_certificate = 2;
2028 accept_certificate = 0;
2030 else if (instance->VerifyCertificateEx)
2032 const BOOL use_pem =
2035 DWORD cflags = flags;
2038 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
2042 fp = freerdp_certificate_get_fingerprint(cert);
2043 accept_certificate = instance->VerifyCertificateEx(
2044 instance, hostname, port, common_name, subject, issuer, fp, cflags);
2048#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2049 else if (instance->VerifyCertificate)
2051 char* fp = freerdp_certificate_get_fingerprint(cert);
2053 WLog_WARN(TAG,
"The VerifyCertificate callback is deprecated, migrate your "
2054 "application to VerifyCertificateEx");
2055 accept_certificate = instance->VerifyCertificate(instance, common_name, subject,
2056 issuer, fp, !hostname_match);
2061 else if (match == -1)
2063 rdpCertificateData* stored_data =
2064 freerdp_certificate_store_load_data(tls->certificate_store, hostname, port);
2068 char* efp = freerdp_certificate_get_fingerprint(cert);
2069 tls_print_certificate_error(tls->certificate_store, stored_data, hostname, port,
2075 WLog_WARN(TAG,
"Failed to get certificate entry for %s:%" PRIu16
"", hostname,
2078 if (settings->AutoDenyCertificate)
2080 WLog_INFO(TAG,
"No certificate stored, automatically denying.");
2081 accept_certificate = 0;
2083 else if (instance->VerifyX509Certificate)
2086 instance->VerifyX509Certificate(instance, pemCert, pem_length, hostname,
2087 port, flags | VERIFY_CERT_FLAG_CHANGED);
2090 accept_certificate = 1;
2092 accept_certificate = 2;
2094 accept_certificate = 0;
2096 else if (instance->VerifyChangedCertificateEx)
2098 DWORD cflags = flags | VERIFY_CERT_FLAG_CHANGED;
2099 const char* old_subject = freerdp_certificate_data_get_subject(stored_data);
2100 const char* old_issuer = freerdp_certificate_data_get_issuer(stored_data);
2101 const char* old_fp = freerdp_certificate_data_get_fingerprint(stored_data);
2102 const char* old_pem = freerdp_certificate_data_get_pem(stored_data);
2103 const BOOL fpIsAllocated =
2109 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
2115 fp = freerdp_certificate_get_fingerprint(cert);
2117 accept_certificate = instance->VerifyChangedCertificateEx(
2118 instance, hostname, port, common_name, subject, issuer, fp, old_subject,
2119 old_issuer, old_fp, cflags);
2123#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2124 else if (instance->VerifyChangedCertificate)
2126 char* fp = freerdp_certificate_get_fingerprint(cert);
2127 const char* old_subject = freerdp_certificate_data_get_subject(stored_data);
2128 const char* old_issuer = freerdp_certificate_data_get_issuer(stored_data);
2129 const char* old_fingerprint =
2130 freerdp_certificate_data_get_fingerprint(stored_data);
2132 WLog_WARN(TAG,
"The VerifyChangedCertificate callback is deprecated, migrate "
2133 "your application to VerifyChangedCertificateEx");
2134 accept_certificate = instance->VerifyChangedCertificate(
2135 instance, common_name, subject, issuer, fp, old_subject, old_issuer,
2141 freerdp_certificate_data_free(stored_data);
2143 else if (match == 0)
2144 accept_certificate = 2;
2146#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2147 WINPR_PRAGMA_DIAG_POP
2151 switch (accept_certificate)
2156 verification_status = freerdp_certificate_store_save_data(
2157 tls->certificate_store, certificate_data)
2164 verification_status = 1;
2169 verification_status = -1;
2178 if (verification_status > 0)
2180 if (!accept_cert(tls, cert))
2186 freerdp_certificate_data_free(certificate_data);
2188 freerdp_certificate_free_ip_names(ip_names_count, ip_names_lengths, ip_names);
2189 freerdp_certificate_free_dns_names(dns_names_count, dns_names_lengths, dns_names);
2191 return verification_status;
2194void tls_print_new_certificate_warn(rdpCertificateStore* store,
const char* hostname, UINT16 port,
2195 const char* type,
const char* fingerprint)
2197 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2199 WLog_ERR(TAG,
"The host key for %s:%" PRIu16
" has changed", hostname, port);
2200 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2201 WLog_ERR(TAG,
"@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @");
2202 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2203 WLog_ERR(TAG,
"IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!");
2204 WLog_ERR(TAG,
"Someone could be eavesdropping on you right now (man-in-the-middle attack)!");
2205 WLog_ERR(TAG,
"It is also possible that a host key has just been changed.");
2206 WLog_ERR(TAG,
"The fingerprint for the host key sent by the remote host is %s", fingerprint);
2207 WLog_ERR(TAG,
"Please contact your system administrator.");
2208 WLog_ERR(TAG,
"Add correct host key in %s to get rid of this message.", path);
2209 WLog_ERR(TAG,
"Host key for %s has changed and you have requested %s checking.", hostname,
2211 WLog_ERR(TAG,
"Host key verification failed.");
2216void tls_print_certificate_error(rdpCertificateStore* store,
2217 WINPR_ATTR_UNUSED rdpCertificateData* stored_data,
2218 const char* hostname, UINT16 port,
const char* fingerprint)
2220 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2222 WLog_ERR(TAG,
"New host key for %s:%" PRIu16, hostname, port);
2223 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2224 WLog_ERR(TAG,
"@ WARNING: NEW HOST IDENTIFICATION! @");
2225 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2227 WLog_ERR(TAG,
"The fingerprint for the host key sent by the remote host is %s", fingerprint);
2228 WLog_ERR(TAG,
"Please contact your system administrator.");
2229 WLog_ERR(TAG,
"Add correct host key in %s to get rid of this message.", path);
2234void tls_print_certificate_name_mismatch_error(
const char* hostname, UINT16 port,
2235 const char* common_name,
char** alt_names,
2236 size_t alt_names_count)
2238 WINPR_ASSERT(
nullptr != hostname);
2239 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2240 WLog_ERR(TAG,
"@ WARNING: CERTIFICATE NAME MISMATCH! @");
2241 WLog_ERR(TAG,
"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2242 WLog_ERR(TAG,
"The hostname used for this connection (%s:%" PRIu16
") ", hostname, port);
2243 WLog_ERR(TAG,
"does not match %s given in the certificate:",
2244 alt_names_count < 1 ?
"the name" :
"any of the names");
2245 WLog_ERR(TAG,
"Common Name (CN):");
2246 WLog_ERR(TAG,
"\t%s", common_name ? common_name :
"no CN found in certificate");
2248 if (alt_names_count > 0)
2250 WINPR_ASSERT(
nullptr != alt_names);
2251 WLog_ERR(TAG,
"Alternative names:");
2253 for (
size_t index = 0; index < alt_names_count; index++)
2255 WINPR_ASSERT(alt_names[index]);
2256 WLog_ERR(TAG,
"\t %s", alt_names[index]);
2260 WLog_ERR(TAG,
"A valid certificate for the wrong name should NOT be trusted!");
2263rdpTls* freerdp_tls_new(rdpContext* context)
2265 rdpTls* tls =
nullptr;
2266 tls = (rdpTls*)calloc(1,
sizeof(rdpTls));
2271 tls->context = context;
2275 tls->certificate_store = freerdp_certificate_store_new(tls->context->settings);
2277 if (!tls->certificate_store)
2281 tls->alertLevel = TLS_ALERT_LEVEL_WARNING;
2282 tls->alertDescription = TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY;
2289void freerdp_tls_free(rdpTls* tls)
2296 if (tls->certificate_store)
2298 freerdp_certificate_store_free(tls->certificate_store);
2299 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.