FreeRDP
Loading...
Searching...
No Matches
libfreerdp/crypto/tls.c
1
22#include <freerdp/config.h>
23
24#include "../core/settings.h"
25
26#include <winpr/assert.h>
27#include <string.h>
28#include <errno.h>
29
30#include <winpr/crt.h>
31#include <winpr/winpr.h>
32#include <winpr/string.h>
33#include <winpr/sspi.h>
34#include <winpr/ssl.h>
35#include <winpr/json.h>
36
37#include <winpr/stream.h>
38#include <freerdp/utils/ringbuffer.h>
39
40#include <freerdp/crypto/certificate.h>
41#include <freerdp/crypto/certificate_data.h>
42#include <freerdp/utils/helpers.h>
43
44#include <freerdp/log.h>
45#include "../crypto/tls.h"
46#include "../core/tcp.h"
47
48#include "opensslcompat.h"
49#include "certificate.h"
50#include "privatekey.h"
51#include "../core/utils.h"
52
53#ifdef WINPR_HAVE_POLL_H
54#include <poll.h>
55#endif
56
57#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
58#include <valgrind/memcheck.h>
59#endif
60
61#define TAG FREERDP_TAG("crypto")
62
85typedef struct
86{
87 SSL* ssl;
89#ifdef WITH_TLS_DATA_LIMIT
90 UINT64 rxBytes; /* plaintext bytes read since the last rekey */
91 UINT64 txBytes; /* plaintext bytes written since the last rekey */
92 BOOL rekeyAvailable; /* FALSE once we learn the connection is not TLS 1.3 */
93 BOOL cutPending; /* TRUE once a TLS 1.3 rekey failed; tear the connection down */
94#endif
95} BIO_RDP_TLS;
96
97#ifdef WITH_TLS_DATA_LIMIT
98/* Per-direction plaintext byte threshold before refreshing the TLS traffic keys,
99 * to stay within AEAD cryptographic limits. RFC 8446 (TLS 1.3) ยง5.5 bounds
100 * AES-GCM at 2^24.5 records (2^14 B) (~362 GiB). OpenSSL does not enforce this itself
101 * (https://github.com/openssl/openssl/issues/23566). On TLS 1.3 the keys are
102 * rekeyed in place (SSL_key_update); on other protocols a rekey is not possible. */
103static const UINT64 TLS_DATA_LIMIT_BYTES = 388736063996ULL;
104#endif
105
106static INIT_ONCE g_BioMethodsOnce = INIT_ONCE_STATIC_INIT;
107static BIO_METHOD* g_BioMethods = nullptr;
108
109static INIT_ONCE secrets_file_idx_once = INIT_ONCE_STATIC_INIT;
110static int secrets_file_idx = -1;
111
112WINPR_ATTR_NODISCARD
113static int tls_verify_certificate(rdpTls* tls, const rdpCertificate* cert, const char* hostname,
114 UINT16 port);
115
116static void tls_print_certificate_name_mismatch_error(const rdpCertificate* cert,
117 const char* hostname, UINT16 port);
118
119static void tls_print_new_certificate_warn(rdpCertificateStore* store, const char* hostname,
120 UINT16 port, const char* type, const char* fingerprint);
121
122static void tls_print_certificate_error(rdpCertificateStore* store, rdpCertificateData* stored_data,
123 const char* hostname, UINT16 port, const char* fingerprint);
124
125static void free_tls_public_key(rdpTls* tls)
126{
127 WINPR_ASSERT(tls);
128 free(tls->PublicKey);
129 tls->PublicKey = nullptr;
130 tls->PublicKeyLength = 0;
131}
132
133static void free_tls_bindings(SecPkgContext_Bindings* bindings)
134{
135 if (!bindings)
136 return;
137
138 free(bindings->Bindings);
139 free(bindings);
140}
141
142#ifdef WITH_TLS_DATA_LIMIT
143/* Must be called with tls->lock held, after a successful SSL_read/SSL_write of
144 * `count` bytes in the given direction. Once a per-direction byte threshold is
145 * crossed, refreshes the TLS 1.3 traffic keys in place; on a non-TLS-1.3
146 * connection a rekey is not possible so it is disabled (the connection is kept).
147 * If a TLS 1.3 rekey fails, flags the connection to be cut. */
148static void bio_rdp_tls_account(BIO_RDP_TLS* tls, BOOL read, int count)
149{
150 UINT64* counter = read ? &tls->rxBytes : &tls->txBytes;
151
152 if (!tls->rekeyAvailable || tls->cutPending)
153 return;
154
155 *counter += (UINT64)count;
156 if (*counter < TLS_DATA_LIMIT_BYTES)
157 return;
158
159 if (SSL_version(tls->ssl) != TLS1_3_VERSION)
160 {
161 WLog_DBG(TAG, "TLS data limit reached but connection is not TLS 1.3; "
162 "rekey unavailable, keeping connection");
163 tls->rekeyAvailable = FALSE;
164 return;
165 }
166
167 if (SSL_key_update(tls->ssl, SSL_KEY_UPDATE_REQUESTED) != 1)
168 {
169 WLog_ERR(TAG, "SSL_key_update failed at TLS data limit; cutting connection");
170 tls->cutPending = TRUE;
171 return;
172 }
173
174 WLog_INFO(TAG, "TLS 1.3 key update requested at data limit (%" PRIu64 " bytes %s)", *counter,
175 read ? "read" : "written");
176 *counter = 0;
177}
178
179static void bio_rdp_tls_read_account(BIO_RDP_TLS* tls, int count)
180{
181 bio_rdp_tls_account(tls, TRUE, count);
182}
183
184static void bio_rdp_tls_write_account(BIO_RDP_TLS* tls, int count)
185{
186 bio_rdp_tls_account(tls, FALSE, count);
187}
188#endif
189
190WINPR_ATTR_NODISCARD
191static int bio_rdp_tls_write(BIO* bio, const char* buf, int size)
192{
193 int error = 0;
194 int status = 0;
195 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
196
197 if (!buf || !tls)
198 return 0;
199
200#ifdef WITH_TLS_DATA_LIMIT
201 if (tls->cutPending)
202 {
203 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
204 return -1;
205 }
206#endif
207
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
213 if (status > 0)
214 bio_rdp_tls_write_account(tls, status);
215#endif
216 LeaveCriticalSection(&tls->lock);
217
218 if (status <= 0)
219 {
220 switch (error)
221 {
222 case SSL_ERROR_NONE:
223 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
224 break;
225
226 case SSL_ERROR_WANT_WRITE:
227 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
228 break;
229
230 case SSL_ERROR_WANT_READ:
231 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
232 break;
233
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);
237 break;
238
239 case SSL_ERROR_WANT_CONNECT:
240 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
241 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
242 break;
243
244 case SSL_ERROR_SYSCALL:
245 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
246 break;
247
248 case SSL_ERROR_SSL:
249 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
250 break;
251 default:
252 break;
253 }
254 }
255
256 return status;
257}
258
259WINPR_ATTR_NODISCARD
260static int bio_rdp_tls_read(BIO* bio, char* buf, int size)
261{
262 int error = 0;
263 int status = 0;
264 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
265
266 if (!buf || !tls)
267 return 0;
268
269#ifdef WITH_TLS_DATA_LIMIT
270 if (tls->cutPending)
271 {
272 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
273 return -1;
274 }
275#endif
276
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
282 if (status > 0)
283 bio_rdp_tls_read_account(tls, status);
284#endif
285 LeaveCriticalSection(&tls->lock);
286
287 if (status <= 0)
288 {
289
290 switch (error)
291 {
292 case SSL_ERROR_NONE:
293 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
294 break;
295
296 case SSL_ERROR_WANT_READ:
297 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
298 break;
299
300 case SSL_ERROR_WANT_WRITE:
301 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
302 break;
303
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);
307 break;
308
309 case SSL_ERROR_WANT_ACCEPT:
310 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
311 BIO_set_retry_reason(bio, BIO_RR_ACCEPT);
312 break;
313
314 case SSL_ERROR_WANT_CONNECT:
315 BIO_set_flags(bio, BIO_FLAGS_IO_SPECIAL);
316 BIO_set_retry_reason(bio, BIO_RR_CONNECT);
317 break;
318
319 case SSL_ERROR_SSL:
320 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
321 break;
322
323 case SSL_ERROR_ZERO_RETURN:
324 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
325 break;
326
327 case SSL_ERROR_SYSCALL:
328 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
329 break;
330 default:
331 break;
332 }
333 }
334
335#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
336
337 if (status > 0)
338 {
339 VALGRIND_MAKE_MEM_DEFINED(buf, status);
340 }
341
342#endif
343 return status;
344}
345
346WINPR_ATTR_NODISCARD
347static int bio_rdp_tls_puts(BIO* bio, const char* str)
348{
349 if (!str)
350 return 0;
351
352 const size_t max = (INT_MAX > SIZE_MAX) ? SIZE_MAX : INT_MAX;
353 const size_t size = strnlen(str, max);
354 if (size >= max)
355 return -1;
356 ERR_clear_error();
357 return BIO_write(bio, str, (int)size);
358}
359
360WINPR_ATTR_NODISCARD
361static int bio_rdp_tls_gets(WINPR_ATTR_UNUSED BIO* bio, WINPR_ATTR_UNUSED char* str,
362 WINPR_ATTR_UNUSED int size)
363{
364 return 1;
365}
366
367WINPR_ATTR_NODISCARD
368static long bio_rdp_tls_ctrl(BIO* bio, int cmd, long num, void* ptr)
369{
370 BIO* ssl_rbio = nullptr;
371 BIO* ssl_wbio = nullptr;
372 BIO* next_bio = nullptr;
373 long status = -1;
374 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
375
376 if (!tls)
377 return 0;
378
379 if (!tls->ssl && (cmd != BIO_C_SET_SSL))
380 return 0;
381
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;
385
386 switch (cmd)
387 {
388 case BIO_CTRL_RESET:
389 SSL_shutdown(tls->ssl);
390
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);
395
396 SSL_clear(tls->ssl);
397
398 if (next_bio)
399 status = BIO_ctrl(next_bio, cmd, num, ptr);
400 else if (ssl_rbio)
401 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
402 else
403 status = 1;
404
405 break;
406
407 case BIO_C_GET_FD:
408 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
409 break;
410
411 case BIO_CTRL_INFO:
412 status = 0;
413 break;
414
415 case BIO_CTRL_SET_CALLBACK:
416 status = 0;
417 break;
418
419 case BIO_CTRL_GET_CALLBACK:
420 /* The OpenSSL API is horrible here:
421 * we get a function pointer returned and have to cast it to ULONG_PTR
422 * to return the value to the caller.
423 *
424 * This, of course, is something compilers warn about. So silence it by casting */
425 {
426 void* vptr = WINPR_FUNC_PTR_CAST(SSL_get_info_callback(tls->ssl), void*);
427 *((void**)ptr) = vptr;
428 status = 1;
429 }
430 break;
431
432 case BIO_C_SSL_MODE:
433 if (num)
434 SSL_set_connect_state(tls->ssl);
435 else
436 SSL_set_accept_state(tls->ssl);
437
438 status = 1;
439 break;
440
441 case BIO_CTRL_GET_CLOSE:
442 status = BIO_get_shutdown(bio);
443 break;
444
445 case BIO_CTRL_SET_CLOSE:
446 BIO_set_shutdown(bio, (int)num);
447 status = 1;
448 break;
449
450 case BIO_CTRL_WPENDING:
451 EnterCriticalSection(&tls->lock);
452 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
453 LeaveCriticalSection(&tls->lock);
454 break;
455
456 case BIO_CTRL_PENDING:
457 status = SSL_pending(tls->ssl);
458
459 if (status == 0)
460 status = BIO_pending(ssl_rbio);
461
462 break;
463
464 case BIO_CTRL_FLUSH:
465 BIO_clear_retry_flags(bio);
466 /* A flush writes out the BIO below, just like SSL_write and SSL_read do,
467 * so it must be serialized with them by the same lock. */
468 EnterCriticalSection(&tls->lock);
469 status = BIO_ctrl(ssl_wbio, cmd, num, ptr);
470 LeaveCriticalSection(&tls->lock);
471 if (status != 1)
472 WLog_DBG(TAG, "BIO_ctrl returned %ld", status);
473 BIO_copy_next_retry(bio);
474 status = 1;
475 break;
476
477 case BIO_CTRL_PUSH:
478 if (next_bio && (next_bio != ssl_rbio))
479 {
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);
484#else
485 /*
486 * We are going to pass ownership of next to the SSL object...but
487 * we don't own a reference to pass yet - so up ref
488 */
489 BIO_up_ref(next_bio);
490 SSL_set_bio(tls->ssl, next_bio, next_bio);
491#endif
492 }
493
494 status = 1;
495 break;
496
497 case BIO_CTRL_POP:
498
499 /* Only detach if we are the BIO explicitly being popped */
500 if (bio == ptr)
501 {
502 if (ssl_rbio != ssl_wbio)
503 BIO_free_all(ssl_wbio);
504
505#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
506 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
507
508 if (next_bio)
509 CRYPTO_add(&(bio->next_bio->references), -1, CRYPTO_LOCK_BIO);
510
511 tls->ssl->wbio = tls->ssl->rbio = nullptr;
512#else
513 /* OpenSSL 1.1: This will also clear the reference we obtained during push */
514 SSL_set_bio(tls->ssl, nullptr, nullptr);
515#endif
516 }
517
518 status = 1;
519 break;
520
521 case BIO_C_GET_SSL:
522 if (ptr)
523 {
524 *((SSL**)ptr) = tls->ssl;
525 status = 1;
526 }
527
528 break;
529
530 case BIO_C_SET_SSL:
531 BIO_set_shutdown(bio, (int)num);
532
533 if (ptr)
534 {
535 tls->ssl = (SSL*)ptr;
536 ssl_rbio = SSL_get_rbio(tls->ssl);
537 }
538
539 if (ssl_rbio)
540 {
541 if (next_bio)
542 BIO_push(ssl_rbio, next_bio);
543
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);
548#else
549 BIO_up_ref(ssl_rbio);
550#endif
551 }
552
553 BIO_set_init(bio, 1);
554 status = 1;
555 break;
556
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);
561
562 if (status <= 0)
563 {
564 const int err = (status < INT32_MIN) ? INT32_MIN : (int)status;
565 switch (SSL_get_error(tls->ssl, err))
566 {
567 case SSL_ERROR_WANT_READ:
568 BIO_set_flags(bio, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
569 break;
570
571 case SSL_ERROR_WANT_WRITE:
572 BIO_set_flags(bio, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
573 break;
574
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));
578 break;
579
580 default:
581 BIO_clear_flags(bio, BIO_FLAGS_SHOULD_RETRY);
582 break;
583 }
584 }
585
586 break;
587
588 default:
589 status = BIO_ctrl(ssl_rbio, cmd, num, ptr);
590 break;
591 }
592
593 return status;
594}
595
596WINPR_ATTR_NODISCARD
597static int bio_rdp_tls_new(BIO* bio)
598{
599 BIO_RDP_TLS* tls = nullptr;
600 BIO_set_flags(bio, BIO_FLAGS_SHOULD_RETRY);
601
602 if (!(tls = calloc(1, sizeof(BIO_RDP_TLS))))
603 return 0;
604
605 if (!InitializeCriticalSectionAndSpinCount(&tls->lock, 4000))
606 {
607 free(tls);
608 return -1;
609 }
610
611#ifdef WITH_TLS_DATA_LIMIT
612 /* counters/cutPending zeroed by calloc; rekey is assumed possible until we
613 * observe a non-TLS-1.3 connection at the data limit. */
614 tls->rekeyAvailable = TRUE;
615#endif
616
617 BIO_set_data(bio, (void*)tls);
618 return 1;
619}
620
621WINPR_ATTR_NODISCARD
622static int bio_rdp_tls_free(BIO* bio)
623{
624 BIO_RDP_TLS* tls = nullptr;
625
626 if (!bio)
627 return 0;
628
629 tls = (BIO_RDP_TLS*)BIO_get_data(bio);
630
631 if (!tls)
632 return 0;
633
634 BIO_set_data(bio, nullptr);
635 if (BIO_get_shutdown(bio))
636 {
637 if (BIO_get_init(bio) && tls->ssl)
638 {
639 SSL_shutdown(tls->ssl);
640 SSL_free(tls->ssl);
641 }
642
643 BIO_set_init(bio, 0);
644 BIO_set_flags(bio, 0);
645 }
646
647 DeleteCriticalSection(&tls->lock);
648 free(tls);
649
650 return 1;
651}
652
653WINPR_ATTR_NODISCARD
654static long bio_rdp_tls_callback_ctrl(BIO* bio, int cmd, bio_info_cb* fp)
655{
656 long status = 0;
657
658 if (!bio)
659 return 0;
660
661 BIO_RDP_TLS* tls = (BIO_RDP_TLS*)BIO_get_data(bio);
662
663 if (!tls)
664 return 0;
665
666 switch (cmd)
667 {
668 case BIO_CTRL_SET_CALLBACK:
669 {
670 typedef void (*fkt_t)(const SSL*, int, int);
671
672 /* Documented since https://www.openssl.org/docs/man1.1.1/man3/BIO_set_callback.html
673 * the argument is not really of type bio_info_cb* and must be cast
674 * to the required type */
675
676 fkt_t fkt = WINPR_FUNC_PTR_CAST(fp, fkt_t);
677 SSL_set_info_callback(tls->ssl, fkt);
678 status = 1;
679 }
680 break;
681
682 default:
683 status = BIO_callback_ctrl(SSL_get_rbio(tls->ssl), cmd, fp);
684 break;
685 }
686
687 return status;
688}
689
690#define BIO_TYPE_RDP_TLS 68
691
692WINPR_ATTR_NODISCARD
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)
696{
697 g_BioMethods = BIO_meth_new(BIO_TYPE_RDP_TLS, "RdpTls");
698 if (!g_BioMethods)
699 return FALSE;
700
701 if (BIO_meth_set_write(g_BioMethods, bio_rdp_tls_write) != 1)
702 return FALSE;
703 if (BIO_meth_set_read(g_BioMethods, bio_rdp_tls_read) != 1)
704 return FALSE;
705 if (BIO_meth_set_puts(g_BioMethods, bio_rdp_tls_puts) != 1)
706 return FALSE;
707 if (BIO_meth_set_gets(g_BioMethods, bio_rdp_tls_gets) != 1)
708 return FALSE;
709 if (BIO_meth_set_ctrl(g_BioMethods, bio_rdp_tls_ctrl) != 1)
710 return FALSE;
711 if (BIO_meth_set_create(g_BioMethods, bio_rdp_tls_new) != 1)
712 return FALSE;
713 if (BIO_meth_set_destroy(g_BioMethods, bio_rdp_tls_free) != 1)
714 return FALSE;
715 if (BIO_meth_set_callback_ctrl(g_BioMethods, bio_rdp_tls_callback_ctrl) != 1)
716 return FALSE;
717
718 return TRUE;
719}
720
721WINPR_ATTR_NODISCARD
722static BIO_METHOD* BIO_s_rdp_tls(void)
723{
724 if (!InitOnceExecuteOnce(&g_BioMethodsOnce, bio_rdp_tls_init_once, nullptr, nullptr))
725 return nullptr;
726 return g_BioMethods;
727}
728
729WINPR_ATTR_MALLOC(BIO_free, 1)
730static BIO* BIO_new_rdp_tls(SSL_CTX* ctx, int client)
731{
732 BIO* bio = BIO_new(BIO_s_rdp_tls());
733
734 if (!bio)
735 return nullptr;
736
737 SSL* ssl = SSL_new(ctx);
738
739 if (!ssl)
740 {
741 BIO_free_all(bio);
742 return nullptr;
743 }
744
745 if (client)
746 SSL_set_connect_state(ssl);
747 else
748 SSL_set_accept_state(ssl);
749
750 BIO_set_ssl(bio, ssl, BIO_CLOSE);
751 return bio;
752}
753
754WINPR_ATTR_MALLOC(freerdp_certificate_free, 1)
755static rdpCertificate* tls_get_certificate(rdpTls* tls, BOOL peer)
756{
757 X509* remote_cert = nullptr;
758
759 if (peer)
760 remote_cert = SSL_get_peer_certificate(tls->ssl);
761 else
762 remote_cert = X509_dup(SSL_get_certificate(tls->ssl));
763
764 if (!remote_cert)
765 {
766 WLog_ERR(TAG, "failed to get the server TLS certificate");
767 return nullptr;
768 }
769
770 /* Get the peer's chain. If it does not exist, we're setting nullptr (clean data either way) */
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);
774
775 return cert;
776}
777
778WINPR_ATTR_NODISCARD
779static const char* tls_get_server_name(rdpTls* tls)
780{
781 return tls->serverName ? tls->serverName : tls->hostname;
782}
783
784#define TLS_SERVER_END_POINT "tls-server-end-point:"
785
786WINPR_ATTR_MALLOC(free_tls_bindings, 1)
787static SecPkgContext_Bindings* tls_get_channel_bindings(const rdpCertificate* cert)
788{
789 size_t CertificateHashLength = 0;
790 BYTE* ChannelBindingToken = nullptr;
791 SEC_CHANNEL_BINDINGS* ChannelBindings = nullptr;
792 const size_t PrefixLength = strnlen(TLS_SERVER_END_POINT, ARRAYSIZE(TLS_SERVER_END_POINT));
793
794 WINPR_ASSERT(cert);
795
796 /* See https://www.rfc-editor.org/rfc/rfc5929 for details about hashes */
797 WINPR_MD_TYPE alg = freerdp_certificate_get_signature_alg(cert);
798 const char* hash = nullptr;
799 switch (alg)
800 {
801
802 case WINPR_MD_MD5:
803 case WINPR_MD_SHA1:
804 hash = winpr_md_type_to_string(WINPR_MD_SHA256);
805 break;
806 default:
807 hash = winpr_md_type_to_string(alg);
808 break;
809 }
810 if (!hash)
811 return nullptr;
812
813 char* CertificateHash = freerdp_certificate_get_hash(cert, hash, &CertificateHashLength);
814 if (!CertificateHash)
815 return nullptr;
816
817 const size_t ChannelBindingTokenLength = PrefixLength + CertificateHashLength;
818 SecPkgContext_Bindings* ContextBindings = calloc(1, sizeof(SecPkgContext_Bindings));
819
820 if (!ContextBindings)
821 goto out_free;
822
823 {
824 const size_t slen = sizeof(SEC_CHANNEL_BINDINGS) + ChannelBindingTokenLength;
825 if (slen > UINT32_MAX)
826 goto out_free;
827
828 ContextBindings->BindingsLength = (UINT32)slen;
829 }
830 ChannelBindings = (SEC_CHANNEL_BINDINGS*)calloc(1, ContextBindings->BindingsLength);
831
832 if (!ChannelBindings)
833 goto out_free;
834
835 ContextBindings->Bindings = ChannelBindings;
836 ChannelBindings->cbApplicationDataLength = (UINT32)ChannelBindingTokenLength;
837 ChannelBindings->dwApplicationDataOffset = sizeof(SEC_CHANNEL_BINDINGS);
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;
843out_free:
844 free(CertificateHash);
845 free(ContextBindings);
846 return nullptr;
847}
848
849WINPR_ATTR_NODISCARD
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)
853{
854 secrets_file_idx = SSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
855
856 return (secrets_file_idx != -1);
857}
858
859static void SSLCTX_keylog_cb(const SSL* ssl, const char* line)
860{
861 char* dfile = nullptr;
862
863 if (secrets_file_idx == -1)
864 return;
865
866 dfile = SSL_get_ex_data(ssl, secrets_file_idx);
867 if (dfile)
868 {
869 FILE* f = winpr_fopen(dfile, "a+");
870 if (f)
871 {
872 (void)fwrite(line, strlen(line), 1, f);
873 (void)fwrite("\n", 1, 1, f);
874 (void)fclose(f);
875 }
876 }
877}
878
879static void tls_reset(rdpTls* tls)
880{
881 WINPR_ASSERT(tls);
882
883 if (tls->ctx)
884 {
885 SSL_CTX_free(tls->ctx);
886 tls->ctx = nullptr;
887 }
888
889 /* tls->underlying is a stacked BIO under tls->bio.
890 * BIO_free_all will free recursively. */
891 if (tls->bio)
892 BIO_free_all(tls->bio);
893 else if (tls->underlying)
894 BIO_free_all(tls->underlying);
895 tls->bio = nullptr;
896 tls->underlying = nullptr;
897
898 free_tls_public_key(tls);
899 free_tls_bindings(tls->Bindings);
900 tls->Bindings = nullptr;
901}
902
903#if OPENSSL_VERSION_NUMBER >= 0x010000000L
904WINPR_ATTR_NODISCARD
905static BOOL tls_prepare(rdpTls* tls, BIO* underlying, const SSL_METHOD* method, int options,
906 BOOL clientMode)
907#else
908WINPR_ATTR_NODISCARD
909static BOOL tls_prepare(rdpTls* tls, BIO* underlying, SSL_METHOD* method, int options,
910 BOOL clientMode)
911#endif
912{
913 WINPR_ASSERT(tls);
914
915 rdpSettings* settings = tls->context->settings;
916 WINPR_ASSERT(settings);
917
918 tls_reset(tls);
919 tls->ctx = SSL_CTX_new(method);
920
921 tls->underlying = underlying;
922
923 if (!tls->ctx)
924 {
925 WLog_ERR(TAG, "SSL_CTX_new failed");
926 return FALSE;
927 }
928
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)
933 UINT16 version = freerdp_settings_get_uint16(settings, FreeRDP_TLSMinVersion);
934 if (!SSL_CTX_set_min_proto_version(tls->ctx, version))
935 {
936 WLog_ERR(TAG, "SSL_CTX_set_min_proto_version %" PRIu16 " failed", version);
937 return FALSE;
938 }
939 version = freerdp_settings_get_uint16(settings, FreeRDP_TLSMaxVersion);
940 if (!SSL_CTX_set_max_proto_version(tls->ctx, version))
941 {
942 WLog_ERR(TAG, "SSL_CTX_set_max_proto_version %" PRIu16 " failed", version);
943 return FALSE;
944 }
945#endif
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));
948#endif
949
950 if (settings->AllowedTlsCiphers)
951 {
952 if (!SSL_CTX_set_cipher_list(tls->ctx, settings->AllowedTlsCiphers))
953 {
954 WLog_ERR(TAG, "SSL_CTX_set_cipher_list %s failed", settings->AllowedTlsCiphers);
955 return FALSE;
956 }
957 }
958
959 tls->bio = BIO_new_rdp_tls(tls->ctx, clientMode);
960
961 if (!tls->bio)
962 {
963 WLog_ERR(TAG, "unable to create TLS BIO");
964 return FALSE;
965 }
966
967 if (BIO_get_ssl(tls->bio, &tls->ssl) < 0 || !tls->ssl)
968 {
969 WLog_ERR(TAG, "unable to retrieve the SSL of the connection");
970 return FALSE;
971 }
972
973 if (settings->TlsSecretsFile)
974 {
975#if OPENSSL_VERSION_NUMBER >= 0x10101000L
976 if (!InitOnceExecuteOnce(&secrets_file_idx_once, secrets_file_init_cb, nullptr, nullptr))
977 return FALSE;
978
979 if (secrets_file_idx != -1)
980 {
981 SSL_set_ex_data(tls->ssl, secrets_file_idx, settings->TlsSecretsFile);
982 SSL_CTX_set_keylog_callback(tls->ctx, SSLCTX_keylog_cb);
983 }
984#else
985 WLog_WARN(TAG, "Key-Logging not available - requires OpenSSL 1.1.1 or higher");
986#endif
987 }
988
989 BIO_push(tls->bio, underlying);
990 return TRUE;
991}
992
993static void
994adjustSslOptions(WINPR_ATTR_UNUSED int* options) // NOLINT(readability-non-const-parameter)
995{
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;
1000#endif
1001}
1002
1003const SSL_METHOD* freerdp_tls_get_ssl_method(BOOL isDtls, BOOL isClient)
1004{
1005 if (isClient)
1006 {
1007 if (isDtls)
1008 return DTLS_client_method();
1009#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1010 return SSLv23_client_method();
1011#else
1012 return TLS_client_method();
1013#endif
1014 }
1015
1016 if (isDtls)
1017 return DTLS_server_method();
1018
1019#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1020 return SSLv23_server_method();
1021#else
1022 return TLS_server_method();
1023#endif
1024}
1025
1026TlsHandshakeResult freerdp_tls_connect_ex(rdpTls* tls, BIO* underlying, const SSL_METHOD* methods)
1027{
1028 WINPR_ASSERT(tls);
1029
1030 int options = 0;
1040#ifdef SSL_OP_NO_COMPRESSION
1041 options |= SSL_OP_NO_COMPRESSION;
1042#endif
1049 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1056 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1057
1058 tls->isClientMode = TRUE;
1059 adjustSslOptions(&options);
1060
1061 if (!tls_prepare(tls, underlying, methods, options, TRUE))
1062 return TLS_HANDSHAKE_ERROR;
1063
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);
1068#endif
1069
1070 return freerdp_tls_handshake(tls);
1071}
1072
1073static int bio_err_print(const char* str, size_t len, void* u)
1074{
1075 wLog* log = u;
1076 WLog_Print(log, WLOG_ERROR, "[BIO_do_handshake] %s [%" PRIuz "]", str, len);
1077 return 0;
1078}
1079
1080TlsHandshakeResult freerdp_tls_handshake(rdpTls* tls)
1081{
1082 TlsHandshakeResult ret = TLS_HANDSHAKE_ERROR;
1083
1084 WINPR_ASSERT(tls);
1085 const long status = BIO_do_handshake(tls->bio);
1086 if (status != 1)
1087 {
1088 if (!BIO_should_retry(tls->bio))
1089 {
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;
1094 }
1095
1096 return TLS_HANDSHAKE_CONTINUE;
1097 }
1098
1099 int verify_status = 0;
1100 rdpCertificate* cert = tls_get_certificate(tls, tls->isClientMode);
1101
1102 if (!cert)
1103 {
1104 WLog_ERR(TAG, "tls_get_certificate failed to return the server certificate.");
1105 return TLS_HANDSHAKE_ERROR;
1106 }
1107
1108 do
1109 {
1110 free_tls_bindings(tls->Bindings);
1111 tls->Bindings = tls_get_channel_bindings(cert);
1112 if (!tls->Bindings)
1113 {
1114 WLog_ERR(TAG, "unable to retrieve bindings");
1115 break;
1116 }
1117
1118 free_tls_public_key(tls);
1119 if (!freerdp_certificate_get_public_key(cert, &tls->PublicKey, &tls->PublicKeyLength))
1120 {
1121 WLog_ERR(TAG,
1122 "freerdp_certificate_get_public_key failed to return the server public key.");
1123 break;
1124 }
1125
1126 /* server-side NLA needs public keys (keys from us, the server) but no certificate verify */
1127 ret = TLS_HANDSHAKE_SUCCESS;
1128
1129 if (tls->isClientMode)
1130 {
1131 WINPR_ASSERT(tls->port <= UINT16_MAX);
1132 verify_status =
1133 tls_verify_certificate(tls, cert, tls_get_server_name(tls), (UINT16)tls->port);
1134
1135 if (verify_status < 1)
1136 {
1137 WLog_ERR(TAG, "certificate not trusted, aborting.");
1138 freerdp_tls_send_alert(tls);
1139 ret = TLS_HANDSHAKE_VERIFY_ERROR;
1140 }
1141 }
1142 } while (0);
1143
1144 freerdp_certificate_free(cert);
1145 return ret;
1146}
1147
1148static int pollAndHandshake(rdpTls* tls)
1149{
1150 WINPR_ASSERT(tls);
1151
1152 do
1153 {
1154 HANDLE events[] = { freerdp_abort_event(tls->context), nullptr };
1155 DWORD status = 0;
1156 if (BIO_get_event(tls->bio, &events[1]) < 0)
1157 {
1158 WLog_ERR(TAG, "unable to retrieve BIO associated event");
1159 return -1;
1160 }
1161
1162 if (!events[1])
1163 {
1164 WLog_ERR(TAG, "unable to retrieve BIO event");
1165 return -1;
1166 }
1167
1168 status = WaitForMultipleObjectsEx(ARRAYSIZE(events), events, FALSE, INFINITE, TRUE);
1169 switch (status)
1170 {
1171 case WAIT_OBJECT_0 + 1:
1172 break;
1173 case WAIT_OBJECT_0:
1174 WLog_DBG(TAG, "Abort event set, cancel connect");
1175 return -1;
1176 case WAIT_TIMEOUT:
1177 case WAIT_IO_COMPLETION:
1178 continue;
1179 default:
1180 WLog_ERR(TAG, "error during WaitForSingleObject(): 0x%08" PRIX32 "", status);
1181 return -1;
1182 }
1183
1184 TlsHandshakeResult result = freerdp_tls_handshake(tls);
1185 switch (result)
1186 {
1187 case TLS_HANDSHAKE_CONTINUE:
1188 break;
1189 case TLS_HANDSHAKE_SUCCESS:
1190 return 1;
1191 case TLS_HANDSHAKE_ERROR:
1192 case TLS_HANDSHAKE_VERIFY_ERROR:
1193 default:
1194 return -1;
1195 }
1196 } while (TRUE);
1197}
1198
1199int freerdp_tls_connect(rdpTls* tls, BIO* underlying)
1200{
1201 const SSL_METHOD* method = freerdp_tls_get_ssl_method(FALSE, TRUE);
1202
1203 WINPR_ASSERT(tls);
1204 TlsHandshakeResult result = freerdp_tls_connect_ex(tls, underlying, method);
1205 switch (result)
1206 {
1207 case TLS_HANDSHAKE_SUCCESS:
1208 return 1;
1209 case TLS_HANDSHAKE_CONTINUE:
1210 break;
1211 case TLS_HANDSHAKE_ERROR:
1212 case TLS_HANDSHAKE_VERIFY_ERROR:
1213 return -1;
1214 default:
1215 return -1;
1216 }
1217
1218 return pollAndHandshake(tls);
1219}
1220
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)
1225{
1226 if (type == TLSEXT_TYPE_server_name)
1227 {
1228 WLog_DBG(TAG, "Client uses SNI (extension disabled)");
1229 s->servername_done = 2;
1230 }
1231}
1232#endif
1233
1234BOOL freerdp_tls_accept(rdpTls* tls, BIO* underlying, rdpSettings* settings)
1235{
1236 WINPR_ASSERT(tls);
1237 TlsHandshakeResult res =
1238 freerdp_tls_accept_ex(tls, underlying, settings, freerdp_tls_get_ssl_method(FALSE, FALSE));
1239 switch (res)
1240 {
1241 case TLS_HANDSHAKE_SUCCESS:
1242 return TRUE;
1243 case TLS_HANDSHAKE_CONTINUE:
1244 break;
1245 case TLS_HANDSHAKE_ERROR:
1246 case TLS_HANDSHAKE_VERIFY_ERROR:
1247 default:
1248 return FALSE;
1249 }
1250
1251 return pollAndHandshake(tls) > 0;
1252}
1253
1254TlsHandshakeResult freerdp_tls_accept_ex(rdpTls* tls, BIO* underlying, rdpSettings* settings,
1255 const SSL_METHOD* methods)
1256{
1257 WINPR_ASSERT(tls);
1258
1259 int options = 0;
1260 int status = 0;
1261
1268 options |= SSL_OP_NO_SSLv2;
1278#ifdef SSL_OP_NO_COMPRESSION
1279 options |= SSL_OP_NO_COMPRESSION;
1280#endif
1287 options |= SSL_OP_TLS_BLOCK_PADDING_BUG;
1294 options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1295
1302#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && (OPENSSL_VERSION_NUMBER < 0x30000000L) && \
1303 !defined(LIBRESSL_VERSION_NUMBER)
1304 options |= SSL_OP_NO_RENEGOTIATION;
1305#endif
1306
1307 if (!tls_prepare(tls, underlying, methods, options, FALSE))
1308 return TLS_HANDSHAKE_ERROR;
1309
1310 const rdpPrivateKey* key = freerdp_settings_get_pointer(settings, FreeRDP_RdpServerRsaKey);
1311 if (!key)
1312 {
1313 WLog_ERR(TAG, "invalid private key");
1314 return TLS_HANDSHAKE_ERROR;
1315 }
1316
1317 EVP_PKEY* privkey = freerdp_key_get_evp_pkey(key);
1318 if (!privkey)
1319 {
1320 WLog_ERR(TAG, "invalid private key");
1321 return TLS_HANDSHAKE_ERROR;
1322 }
1323
1324 status = SSL_use_PrivateKey(tls->ssl, privkey);
1325 /* The local reference to the private key will anyway go out of
1326 * scope; so the reference count should be decremented whether
1327 * SSL_use_PrivateKey succeeds or fails.
1328 */
1329 EVP_PKEY_free(privkey);
1330
1331 if (status <= 0)
1332 {
1333 WLog_ERR(TAG, "SSL_CTX_use_PrivateKey_file failed");
1334 return TLS_HANDSHAKE_ERROR;
1335 }
1336
1337 rdpCertificate* cert =
1338 freerdp_settings_get_pointer_writable(settings, FreeRDP_RdpServerCertificate);
1339 if (!cert)
1340 {
1341 WLog_ERR(TAG, "invalid certificate");
1342 return TLS_HANDSHAKE_ERROR;
1343 }
1344
1345 status = SSL_use_certificate(tls->ssl, freerdp_certificate_get_x509(cert));
1346
1347 if (status <= 0)
1348 {
1349 WLog_ERR(TAG, "SSL_use_certificate_file failed");
1350 return TLS_HANDSHAKE_ERROR;
1351 }
1352
1353 const size_t cnt = freerdp_certificate_get_chain_len(cert);
1354 for (size_t x = 0; x < cnt; x++)
1355 {
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);
1359 if (rc != 1)
1360 {
1361 WLog_ERR(TAG, "SSL_add1_chain_cert failed");
1362 return TLS_HANDSHAKE_ERROR;
1363 }
1364 }
1365
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);
1369#endif
1370
1371 return freerdp_tls_handshake(tls);
1372}
1373
1374BOOL freerdp_tls_send_alert(rdpTls* tls)
1375{
1376 WINPR_ASSERT(tls);
1377
1378 if (!tls)
1379 return FALSE;
1380
1381 if (!tls->ssl)
1382 return TRUE;
1383
1388#if (!defined(LIBRESSL_VERSION_NUMBER) && (OPENSSL_VERSION_NUMBER < 0x10100000L)) || \
1389 (defined(LIBRESSL_VERSION_NUMBER) && (LIBRESSL_VERSION_NUMBER <= 0x2080300fL))
1390
1391 if (tls->alertDescription != TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY)
1392 {
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);
1405
1406 if ((tls->alertLevel == TLS_ALERT_LEVEL_FATAL) && (ssl_session))
1407 SSL_CTX_remove_session(ssl_ctx, ssl_session);
1408
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;
1412
1413 if (tls->ssl->s3->wbuf.left == 0)
1414 tls->ssl->method->ssl_dispatch_alert(tls->ssl);
1415 }
1416
1417#endif
1418 return TRUE;
1419}
1420
1421int freerdp_tls_write_all(rdpTls* tls, const BYTE* data, size_t length)
1422{
1423 WINPR_ASSERT(tls);
1424 size_t offset = 0;
1425 BIO* bio = tls->bio;
1426
1427 if (length > INT32_MAX)
1428 return -1;
1429
1430 while (offset < length)
1431 {
1432 ERR_clear_error();
1433 const int status = BIO_write(bio, &data[offset], (int)(length - offset));
1434
1435 if (status > 0)
1436 offset += (size_t)status;
1437 else
1438 {
1439 if (!BIO_should_retry(bio))
1440 return -1;
1441
1442 if (BIO_write_blocked(bio))
1443 {
1444 const long rc = BIO_wait_write(bio, 100);
1445 if (rc < 0)
1446 return -1;
1447 }
1448 else if (BIO_read_blocked(bio))
1449 return -2; /* Abort write, there is data that must be read */
1450 else
1451 USleep(100);
1452 }
1453 }
1454
1455 return (int)length;
1456}
1457
1458int freerdp_tls_set_alert_code(rdpTls* tls, int level, int description)
1459{
1460 WINPR_ASSERT(tls);
1461 tls->alertLevel = level;
1462 tls->alertDescription = description;
1463 return 0;
1464}
1465
1466WINPR_ATTR_NODISCARD
1467static BOOL is_redirected(rdpTls* tls)
1468{
1469 rdpSettings* settings = tls->context->settings;
1470
1471 if (settings->GatewayArmTransport)
1472 return TRUE;
1473
1474 if (LB_NOREDIRECT & settings->RedirectionFlags)
1475 return FALSE;
1476
1477 return settings->RedirectionFlags != 0;
1478}
1479
1480WINPR_ATTR_NODISCARD
1481static BOOL is_accepted(rdpTls* tls, const rdpCertificate* cert)
1482{
1483 WINPR_ASSERT(tls);
1484 WINPR_ASSERT(tls->context);
1485 WINPR_ASSERT(cert);
1486 rdpSettings* settings = tls->context->settings;
1487 WINPR_ASSERT(settings);
1488
1489 FreeRDP_Settings_Keys_String keyAccepted = FreeRDP_AcceptedCert;
1490 FreeRDP_Settings_Keys_UInt32 keyLength = FreeRDP_AcceptedCertLength;
1491
1492 if (tls->isGatewayTransport)
1493 {
1494 keyAccepted = FreeRDP_GatewayAcceptedCert;
1495 keyLength = FreeRDP_GatewayAcceptedCertLength;
1496 }
1497 else if (is_redirected(tls))
1498 {
1499 keyAccepted = FreeRDP_RedirectionAcceptedCert;
1500 keyLength = FreeRDP_RedirectionAcceptedCertLength;
1501 }
1502
1503 const char* AcceptedKey = freerdp_settings_get_string(settings, keyAccepted);
1504 const UINT32 AcceptedKeyLength = freerdp_settings_get_uint32(settings, keyLength);
1505
1506 if ((AcceptedKeyLength > 0) && AcceptedKey)
1507 {
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))
1512 {
1513 if (memcmp(AcceptedKey, pem, AcceptedKeyLength) == 0)
1514 accepted = TRUE;
1515 }
1516 free(pem);
1517 if (accepted)
1518 return TRUE;
1519 }
1520
1521 if (!freerdp_settings_set_string(settings, keyAccepted, nullptr))
1522 WLog_WARN(TAG, "freerdp_settings_set_string(settings, keyAccepted=%d, nullptr) failed",
1523 keyAccepted);
1524 if (!freerdp_settings_set_uint32(settings, keyLength, 0))
1525 WLog_WARN(TAG, "freerdp_settings_set_uint32(settings, keyLength=%d, 0) failed", keyLength);
1526
1527 return FALSE;
1528}
1529
1530WINPR_ATTR_NODISCARD
1531static BOOL compare_fingerprint(const char* fp, const char* hash, const rdpCertificate* cert,
1532 BOOL separator)
1533{
1534 BOOL equal = 0;
1535 char* strhash = nullptr;
1536
1537 WINPR_ASSERT(fp);
1538 WINPR_ASSERT(hash);
1539 WINPR_ASSERT(cert);
1540
1541 strhash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, hash, separator);
1542 if (!strhash)
1543 return FALSE;
1544
1545 equal = (_stricmp(strhash, fp) == 0);
1546 free(strhash);
1547 return equal;
1548}
1549
1550WINPR_ATTR_NODISCARD
1551static BOOL compare_fingerprint_all(const char* fp, const char* hash, const rdpCertificate* cert)
1552{
1553 WINPR_ASSERT(fp);
1554 WINPR_ASSERT(hash);
1555 WINPR_ASSERT(cert);
1556 if (compare_fingerprint(fp, hash, cert, FALSE))
1557 return TRUE;
1558 if (compare_fingerprint(fp, hash, cert, TRUE))
1559 return TRUE;
1560 return FALSE;
1561}
1562
1563WINPR_ATTR_NODISCARD
1564static BOOL is_accepted_fingerprint(const rdpCertificate* cert,
1565 const char* CertificateAcceptedFingerprints)
1566{
1567 WINPR_ASSERT(cert);
1568
1569 BOOL rc = FALSE;
1570 if (CertificateAcceptedFingerprints)
1571 {
1572 char* context = nullptr;
1573 char* copy = _strdup(CertificateAcceptedFingerprints);
1574 char* cur = strtok_s(copy, ",", &context);
1575 while (cur)
1576 {
1577 char* subcontext = nullptr;
1578 const char* h = strtok_s(cur, ":", &subcontext);
1579
1580 if (!h)
1581 goto next;
1582
1583 {
1584 const char* fp = h + strlen(h) + 1;
1585 if (compare_fingerprint_all(fp, h, cert))
1586 {
1587 rc = TRUE;
1588 break;
1589 }
1590 }
1591 next:
1592 cur = strtok_s(nullptr, ",", &context);
1593 }
1594 free(copy);
1595 }
1596
1597 return rc;
1598}
1599
1600WINPR_ATTR_NODISCARD
1601static BOOL accept_cert(rdpTls* tls, const rdpCertificate* cert)
1602{
1603 WINPR_ASSERT(tls);
1604 WINPR_ASSERT(tls->context);
1605 WINPR_ASSERT(cert);
1606
1607 FreeRDP_Settings_Keys_String id = FreeRDP_AcceptedCert;
1608 FreeRDP_Settings_Keys_UInt32 lid = FreeRDP_AcceptedCertLength;
1609
1610 rdpSettings* settings = tls->context->settings;
1611 WINPR_ASSERT(settings);
1612
1613 if (tls->isGatewayTransport)
1614 {
1615 id = FreeRDP_GatewayAcceptedCert;
1616 lid = FreeRDP_GatewayAcceptedCertLength;
1617 }
1618 else if (is_redirected(tls))
1619 {
1620 id = FreeRDP_RedirectionAcceptedCert;
1621 lid = FreeRDP_RedirectionAcceptedCertLength;
1622 }
1623
1624 size_t pemLength = 0;
1625 char* pem = freerdp_certificate_get_pem_ex(cert, &pemLength, FALSE);
1626 BOOL rc = FALSE;
1627 if (pemLength <= UINT32_MAX)
1628 {
1629 if (freerdp_settings_set_string_len(settings, id, pem, pemLength))
1630 rc = freerdp_settings_set_uint32(settings, lid, (UINT32)pemLength);
1631 }
1632 free(pem);
1633 return rc;
1634}
1635
1636WINPR_ATTR_NODISCARD
1637static BOOL tls_extract_full_pem(const rdpCertificate* cert, BYTE** PublicKey,
1638 size_t* PublicKeyLength)
1639{
1640 if (!cert || !PublicKey)
1641 return FALSE;
1642 *PublicKey = (BYTE*)freerdp_certificate_get_pem(cert, PublicKeyLength);
1643 return *PublicKey != nullptr;
1644}
1645
1646WINPR_ATTR_NODISCARD
1647static int tls_config_parse_bool(WINPR_JSON* json, const char* opt)
1648{
1649 WINPR_JSON* val = WINPR_JSON_GetObjectItemCaseSensitive(json, opt);
1650 if (!val || !WINPR_JSON_IsBool(val))
1651 return -1;
1652
1653 if (WINPR_JSON_IsTrue(val))
1654 return 1;
1655 return 0;
1656}
1657
1658WINPR_ATTR_NODISCARD
1659static int tls_config_check_allowed_hashed(const char* configfile, const rdpCertificate* cert,
1660 WINPR_JSON* json)
1661{
1662 WINPR_ASSERT(configfile);
1663 WINPR_ASSERT(cert);
1664 WINPR_ASSERT(json);
1665
1666 WINPR_JSON* db = WINPR_JSON_GetObjectItemCaseSensitive(json, "certificate-db");
1667 if (!db || !WINPR_JSON_IsArray(db))
1668 return 0;
1669
1670 for (size_t x = 0; x < WINPR_JSON_GetArraySize(db); x++)
1671 {
1672 WINPR_JSON* cur = WINPR_JSON_GetArrayItem(db, x);
1673 if (!cur || !WINPR_JSON_IsObject(cur))
1674 {
1675 WLog_WARN(TAG,
1676 "[%s] invalid certificate-db entry at position %" PRIuz ": not a JSON object",
1677 configfile, x);
1678 continue;
1679 }
1680
1681 WINPR_JSON* key = WINPR_JSON_GetObjectItemCaseSensitive(cur, "type");
1682 if (!key || !WINPR_JSON_IsString(key))
1683 {
1684 WLog_WARN(TAG,
1685 "[%s] invalid certificate-db entry at position %" PRIuz
1686 ": invalid 'type' element, expected type string",
1687 configfile, x);
1688 continue;
1689 }
1690 WINPR_JSON* val = WINPR_JSON_GetObjectItemCaseSensitive(cur, "hash");
1691 if (!val || !WINPR_JSON_IsString(val))
1692 {
1693 WLog_WARN(TAG,
1694 "[%s] invalid certificate-db entry at position %" PRIuz
1695 ": invalid 'hash' element, expected type string",
1696 configfile, x);
1697 continue;
1698 }
1699
1700 const char* skey = WINPR_JSON_GetStringValue(key);
1701 const char* sval = WINPR_JSON_GetStringValue(val);
1702
1703 char* hash = freerdp_certificate_get_fingerprint_by_hash_ex(cert, skey, FALSE);
1704 if (!hash)
1705 {
1706 WLog_WARN(TAG,
1707 "[%s] invalid certificate-db entry at position %" PRIuz
1708 ": hash type '%s' not supported by certificate",
1709 configfile, x, skey);
1710 continue;
1711 }
1712
1713 const int cmp = _stricmp(hash, sval);
1714 free(hash);
1715
1716 if (cmp == 0)
1717 return 1;
1718 }
1719
1720 return 0;
1721}
1722
1723WINPR_ATTR_NODISCARD
1724static int tls_config_check_certificate(const rdpCertificate* cert, BOOL* pAllowUserconfig)
1725{
1726 WINPR_ASSERT(cert);
1727 WINPR_ASSERT(pAllowUserconfig);
1728
1729 int rc = 0;
1730 const char configfile[] = "certificates.json";
1731 WINPR_JSON* json = freerdp_GetJSONConfigFile(TRUE, configfile);
1732
1733 if (!json)
1734 {
1735 WLog_DBG(TAG, "No or no valid configuration file for certificate handling, asking user");
1736 goto fail;
1737 }
1738
1739 if (tls_config_parse_bool(json, "deny") > 0)
1740 {
1741 WLog_WARN(TAG, "[%s] certificate denied by configuration", configfile);
1742 rc = -1;
1743 goto fail;
1744 }
1745
1746 if (tls_config_parse_bool(json, "ignore") > 0)
1747 {
1748 WLog_WARN(TAG, "[%s] certificate ignored by configuration", configfile);
1749 rc = 1;
1750 goto fail;
1751 }
1752
1753 if (tls_config_check_allowed_hashed(configfile, cert, json) > 0)
1754 {
1755 WLog_WARN(TAG, "[%s] certificate manually accepted by configuration", configfile);
1756 rc = 1;
1757 goto fail;
1758 }
1759
1760 if (tls_config_parse_bool(json, "deny-userconfig") > 0)
1761 {
1762 WLog_WARN(TAG, "[%s] configuration denies user to accept certificates", configfile);
1763 rc = -1;
1764 goto fail;
1765 }
1766
1767fail:
1768
1769 *pAllowUserconfig = (rc == 0);
1770 WINPR_JSON_Delete(json);
1771 return rc;
1772}
1773
1774int tls_verify_certificate(rdpTls* tls, const rdpCertificate* cert, const char* hostname,
1775 UINT16 port)
1776{
1777 int match = 0;
1778 size_t length = 0;
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;
1787
1788 WINPR_ASSERT(tls);
1789
1790 rdpContext* context = tls->context;
1791 WINPR_ASSERT(context);
1792
1793 freerdp* instance = context->instance;
1794 WINPR_ASSERT(instance);
1795
1796 const rdpSettings* settings = context->settings;
1797 WINPR_ASSERT(settings);
1798
1799 if (freerdp_shall_disconnect_context(context))
1800 return -1;
1801
1802 if (!tls_extract_full_pem(cert, &pemCert, &length))
1803 goto end;
1804
1805 /* Check, if we already accepted this key. */
1806 if (is_accepted(tls, cert))
1807 {
1808 verification_status = 1;
1809 goto end;
1810 }
1811
1812 if (is_accepted_fingerprint(cert, settings->CertificateAcceptedFingerprints))
1813 {
1814 verification_status = 1;
1815 goto end;
1816 }
1817
1818 if (tls->isGatewayTransport || is_redirected(tls))
1819 flags |= VERIFY_CERT_FLAG_LEGACY;
1820
1821 if (tls->isGatewayTransport)
1822 flags |= VERIFY_CERT_FLAG_GATEWAY;
1823
1824 if (is_redirected(tls))
1825 flags |= VERIFY_CERT_FLAG_REDIRECT;
1826
1827 /* Certificate management is done by the application */
1828 if (settings->ExternalCertificateManagement)
1829 {
1830 if (instance->VerifyX509Certificate)
1831 verification_status =
1832 instance->VerifyX509Certificate(instance, pemCert, length, hostname, port, flags);
1833 else
1834 WLog_ERR(TAG, "No VerifyX509Certificate callback registered!");
1835
1836 if (verification_status > 0)
1837 {
1838 if (!accept_cert(tls, cert))
1839 goto end;
1840 }
1841 else if (verification_status < 0)
1842 {
1843 WLog_ERR(TAG, "VerifyX509Certificate failed: (length = %" PRIuz ") status: [%d] %s",
1844 length, verification_status, pemCert);
1845 goto end;
1846 }
1847 }
1848 /* ignore certificate verification if user explicitly required it (discouraged) */
1849 else if (freerdp_settings_get_bool(settings, FreeRDP_IgnoreCertificate))
1850 {
1851 WLog_WARN(TAG, "[DANGER] Certificate not checked, /cert:ignore in use.");
1852 WLog_WARN(TAG, "[DANGER] This prevents MITM attacks from being detected!");
1853 WLog_WARN(TAG,
1854 "[DANGER] Avoid using this unless in a secure LAN (=no internet) environment");
1855 verification_status = 1; /* success! */
1856 }
1857 else if (!tls->isGatewayTransport && (settings->AuthenticationLevel == 0))
1858 verification_status = 1; /* success! */
1859 else
1860 {
1861 /* if user explicitly specified a certificate name, use it instead of the hostname */
1862 if (!tls->isGatewayTransport && settings->CertificateName)
1863 hostname = settings->CertificateName;
1864
1865 /* attempt verification using OpenSSL and the ~/.freerdp/certs certificate store */
1866 certificate_status = freerdp_certificate_verify(
1867 cert, freerdp_certificate_store_get_certs_path(tls->certificate_store));
1868 /* verify certificate name match */
1869 certificate_data = freerdp_certificate_data_new(hostname, port, cert);
1870 if (!certificate_data)
1871 goto end;
1872 /* extra common name and alternative names */
1873 common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
1874
1875 const size_t hostlen = strlen(hostname);
1876 if (freerdp_certificate_matches_hostname(cert, hostname, hostlen))
1877 hostname_match = TRUE;
1878
1879 /* if the certificate is valid and the certificate name matches, verification succeeds
1880 */
1881 if (certificate_status && hostname_match)
1882 verification_status = 1; /* success! */
1883
1884 if (!hostname_match)
1885 flags |= VERIFY_CERT_FLAG_MISMATCH;
1886
1887 BOOL allowUserconfig = TRUE;
1888 if (!certificate_status || !hostname_match)
1889 verification_status = tls_config_check_certificate(cert, &allowUserconfig);
1890
1891 /* verification could not succeed with OpenSSL, use known_hosts file and prompt user for
1892 * manual verification */
1893 if (allowUserconfig && (!certificate_status || !hostname_match))
1894 {
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);
1900
1901 if (!pem)
1902 goto end;
1903
1904 /* search for matching entry in known_hosts file */
1905 match =
1906 freerdp_certificate_store_contains_data(tls->certificate_store, certificate_data);
1907
1908 if (match == 1)
1909 {
1910 /* no entry was found in known_hosts file, prompt user for manual verification
1911 */
1912 if (!hostname_match)
1913 tls_print_certificate_name_mismatch_error(cert, hostname, port);
1914
1915 {
1916 const char* type = "";
1917 if (freerdp_settings_get_bool(settings, FreeRDP_AutoAcceptCertificate))
1918 type = "tofo (auto-accept)";
1919
1920 if (freerdp_settings_get_bool(settings, FreeRDP_AutoDenyCertificate))
1921 type = "strict (auto-deny)";
1922
1923 if (freerdp_settings_get_bool(settings, FreeRDP_IgnoreCertificate))
1924 type = "ignore (no check)";
1925
1926 char* efp = freerdp_certificate_get_fingerprint(cert);
1927 tls_print_new_certificate_warn(tls->certificate_store, hostname, port, type,
1928 efp);
1929 free(efp);
1930 }
1931
1932#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
1933 WINPR_PRAGMA_DIAG_PUSH
1934 WINPR_PRAGMA_DIAG_IGNORED_DEPRECATED_DECL
1935#endif
1936
1937 /* Automatically accept certificate on first use */
1938 if (settings->AutoAcceptCertificate)
1939 {
1940 WLog_INFO(TAG, "No certificate stored, automatically accepting.");
1941 accept_certificate = 1;
1942 }
1943 else if (settings->AutoDenyCertificate)
1944 {
1945 WLog_INFO(TAG, "No certificate stored, automatically denying.");
1946 accept_certificate = 0;
1947 }
1948 else if (instance->VerifyX509Certificate)
1949 {
1950 int rc = instance->VerifyX509Certificate(instance, pemCert, pem_length,
1951 hostname, port, flags);
1952
1953 if (rc == 1)
1954 accept_certificate = 1;
1955 else if (rc > 1)
1956 accept_certificate = 2;
1957 else
1958 accept_certificate = 0;
1959 }
1960 else if (instance->VerifyCertificateEx)
1961 {
1962 const BOOL use_pem =
1963 freerdp_settings_get_bool(settings, FreeRDP_CertificateCallbackPreferPEM);
1964 char* fp = nullptr;
1965 DWORD cflags = flags;
1966 if (use_pem)
1967 {
1968 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
1969 fp = pem;
1970 }
1971 else
1972 fp = freerdp_certificate_get_fingerprint(cert);
1973 accept_certificate = instance->VerifyCertificateEx(
1974 instance, hostname, port, common_name, subject, issuer, fp, cflags);
1975 if (!use_pem)
1976 free(fp);
1977 }
1978#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
1979 else if (instance->VerifyCertificate)
1980 {
1981 char* fp = freerdp_certificate_get_fingerprint(cert);
1982
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);
1987 free(fp);
1988 }
1989#endif
1990 }
1991 else if (match == -1)
1992 {
1993 rdpCertificateData* stored_data =
1994 freerdp_certificate_store_load_data(tls->certificate_store, hostname, port);
1995 /* entry was found in known_hosts file, but fingerprint does not match. ask user
1996 * to use it */
1997 {
1998 char* efp = freerdp_certificate_get_fingerprint(cert);
1999 tls_print_certificate_error(tls->certificate_store, stored_data, hostname, port,
2000 efp);
2001 free(efp);
2002 }
2003
2004 if (!stored_data)
2005 WLog_WARN(TAG, "Failed to get certificate entry for %s:%" PRIu16 "", hostname,
2006 port);
2007
2008 if (settings->AutoDenyCertificate)
2009 {
2010 WLog_INFO(TAG, "No certificate stored, automatically denying.");
2011 accept_certificate = 0;
2012 }
2013 else if (instance->VerifyX509Certificate)
2014 {
2015 const int rc =
2016 instance->VerifyX509Certificate(instance, pemCert, pem_length, hostname,
2017 port, flags | VERIFY_CERT_FLAG_CHANGED);
2018
2019 if (rc == 1)
2020 accept_certificate = 1;
2021 else if (rc > 1)
2022 accept_certificate = 2;
2023 else
2024 accept_certificate = 0;
2025 }
2026 else if (instance->VerifyChangedCertificateEx)
2027 {
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 =
2034 !old_pem ||
2035 !freerdp_settings_get_bool(settings, FreeRDP_CertificateCallbackPreferPEM);
2036 char* fp = nullptr;
2037 if (!fpIsAllocated)
2038 {
2039 cflags |= VERIFY_CERT_FLAG_FP_IS_PEM;
2040 fp = pem;
2041 old_fp = old_pem;
2042 }
2043 else
2044 {
2045 fp = freerdp_certificate_get_fingerprint(cert);
2046 }
2047 accept_certificate = instance->VerifyChangedCertificateEx(
2048 instance, hostname, port, common_name, subject, issuer, fp, old_subject,
2049 old_issuer, old_fp, cflags);
2050 if (fpIsAllocated)
2051 free(fp);
2052 }
2053#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2054 else if (instance->VerifyChangedCertificate)
2055 {
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);
2061
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,
2066 old_fingerprint);
2067 free(fp);
2068 }
2069#endif
2070
2071 freerdp_certificate_data_free(stored_data);
2072 }
2073 else if (match == 0)
2074 accept_certificate = 2; /* success! */
2075
2076#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
2077 WINPR_PRAGMA_DIAG_POP
2078#endif
2079
2080 /* Save certificate or do a simple accept / reject */
2081 switch (accept_certificate)
2082 {
2083 case 1:
2084
2085 /* user accepted certificate, add entry in known_hosts file */
2086 verification_status = freerdp_certificate_store_save_data(
2087 tls->certificate_store, certificate_data)
2088 ? 1
2089 : -1;
2090 break;
2091
2092 case 2:
2093 /* user did accept temporary, do not add to known hosts file */
2094 verification_status = 1;
2095 break;
2096
2097 default:
2098 /* user did not accept, abort and do not add entry in known_hosts file */
2099 verification_status = -1; /* failure! */
2100 break;
2101 }
2102
2103 free(issuer);
2104 free(subject);
2105 free(pem);
2106 }
2107
2108 if (verification_status > 0)
2109 {
2110 if (!accept_cert(tls, cert))
2111 goto end;
2112 }
2113 }
2114
2115end:
2116 freerdp_certificate_data_free(certificate_data);
2117 free(common_name);
2118 free(pemCert);
2119 return verification_status;
2120}
2121
2122void tls_print_new_certificate_warn(rdpCertificateStore* store, const char* hostname, UINT16 port,
2123 const char* type, const char* fingerprint)
2124{
2125 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2126
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,
2138 type);
2139 WLog_ERR(TAG, "Host key verification failed.");
2140
2141 free(path);
2142}
2143
2144void tls_print_certificate_error(rdpCertificateStore* store,
2145 WINPR_ATTR_UNUSED rdpCertificateData* stored_data,
2146 const char* hostname, UINT16 port, const char* fingerprint)
2147{
2148 char* path = freerdp_certificate_store_get_cert_path(store, hostname, port);
2149
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, "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
2154
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);
2158
2159 free(path);
2160}
2161
2162void tls_print_certificate_name_mismatch_error(const rdpCertificate* cert, const char* hostname,
2163 UINT16 port)
2164{
2165 WINPR_ASSERT(nullptr != hostname);
2166 WINPR_ASSERT(cert);
2167
2168 size_t common_name_length = 0;
2169 char* common_name = freerdp_certificate_get_common_name(cert, &common_name_length);
2170
2171 size_t dnscount = 0;
2172 size_t* dnslengths = nullptr;
2173 char** dnsnames = freerdp_certificate_get_dns_names(cert, &dnscount, &dnslengths);
2174
2175 size_t ipcount = 0;
2176 size_t* iplengths = nullptr;
2177 char** ipnames = freerdp_certificate_get_ip_names(cert, &ipcount, &iplengths);
2178
2179 size_t count = dnscount;
2180 char** names = dnsnames;
2181 const BOOL isIP = utils_is_valid_ip(hostname);
2182 if (isIP)
2183 {
2184 count = ipcount;
2185 names = ipnames;
2186 }
2187
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");
2196
2197 if (count > 0)
2198 {
2199 WINPR_ASSERT(nullptr != names);
2200 WLog_ERR(TAG, "Alternative names:");
2201
2202 for (size_t index = 0; index < count; index++)
2203 {
2204 WINPR_ASSERT(names[index]);
2205 WLog_ERR(TAG, "\t %s", names[index]);
2206 }
2207 }
2208
2209 WLog_ERR(TAG, "A valid certificate for the wrong name should NOT be trusted!");
2210
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);
2214}
2215
2216rdpTls* freerdp_tls_new(rdpContext* context)
2217{
2218 rdpTls* tls = nullptr;
2219 tls = (rdpTls*)calloc(1, sizeof(rdpTls));
2220
2221 if (!tls)
2222 return nullptr;
2223
2224 tls->context = context;
2225
2226 if (!freerdp_settings_get_bool(tls->context->settings, FreeRDP_ServerMode))
2227 {
2228 tls->certificate_store = freerdp_certificate_store_new(tls->context->settings);
2229
2230 if (!tls->certificate_store)
2231 goto out_free;
2232 }
2233
2234 tls->alertLevel = TLS_ALERT_LEVEL_WARNING;
2235 tls->alertDescription = TLS_ALERT_DESCRIPTION_CLOSE_NOTIFY;
2236 return tls;
2237out_free:
2238 free(tls);
2239 return nullptr;
2240}
2241
2242void freerdp_tls_free(rdpTls* tls)
2243{
2244 if (!tls)
2245 return;
2246
2247 tls_reset(tls);
2248
2249 if (tls->certificate_store)
2250 {
2251 freerdp_certificate_store_free(tls->certificate_store);
2252 tls->certificate_store = nullptr;
2253 }
2254
2255 free(tls);
2256}
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsBool(const WINPR_JSON *item)
Check if JSON item is of type BOOL.
Definition c-json.c:167
WINPR_ATTR_NODISCARD WINPR_API size_t WINPR_JSON_GetArraySize(const WINPR_JSON *array)
Get the number of arrayitems from an array.
Definition c-json.c:114
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsTrue(const WINPR_JSON *item)
Check if JSON item is BOOL value True.
Definition c-json.c:162
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.
Definition c-json.c:127
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsString(const WINPR_JSON *item)
Check if JSON item is of type String.
Definition c-json.c:182
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.
Definition c-json.c:108
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsArray(const WINPR_JSON *item)
Check if JSON item is of type Array.
Definition c-json.c:187
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsObject(const WINPR_JSON *item)
Check if JSON item is of type Object.
Definition c-json.c:192
WINPR_API void WINPR_JSON_Delete(WINPR_JSON *item)
Delete a WinPR JSON wrapper object.
Definition c-json.c:103
WINPR_ATTR_NODISCARD WINPR_API const char * WINPR_JSON_GetStringValue(WINPR_JSON *item)
Return the String value of a JSON item.
Definition c-json.c:142
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.