FreeRDP
Loading...
Searching...
No Matches
connection.c
1/*
2 * FreeRDP: A Remote Desktop Protocol Implementation
3 * Connection Sequence
4 *
5 * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
6 * Copyright 2015 Thincast Technologies GmbH
7 * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
8 * Copyright 2023 Armin Novak <anovak@thincast.com>
9 * Copyright 2023 Thincast Technologies GmbH
10 *
11 * Licensed under the Apache License, Version 2.0 (the "License");
12 * you may not use this file except in compliance with the License.
13 * You may obtain a copy of the License at
14 *
15 * http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
22 */
23
24#include <freerdp/config.h>
25
26#include "settings.h"
27
28#include "info.h"
29#include "input.h"
30#include "rdp.h"
31#include "peer.h"
32
33#include "connection.h"
34#include "transport.h"
35
36#include <winpr/crt.h>
37#include <winpr/crypto.h>
38#include <winpr/ssl.h>
39
40#include <freerdp/log.h>
41#include <freerdp/error.h>
42#include <freerdp/listener.h>
43
44#include "../cache/cache.h"
45#include "../cache/pointer.h"
46#include "../crypto/crypto.h"
47#include "../crypto/privatekey.h"
48#include "../crypto/certificate.h"
49#include "gateway/arm.h"
50
51#include "utils.h"
52
53#define TAG FREERDP_TAG("core.connection")
54
198static BOOL rdp_set_state(rdpRdp* rdp, CONNECTION_STATE state);
199
200static BOOL rdp_client_reset_codecs(rdpContext* context)
201{
202 rdpSettings* settings = nullptr;
203
204 if (!context || !context->settings)
205 return FALSE;
206
207 settings = context->settings;
208
209 if (!freerdp_settings_get_bool(settings, FreeRDP_DeactivateClientDecoding))
210 {
211 const UINT32 flags = freerdp_settings_get_uint32(settings, FreeRDP_ThreadingFlags);
212 freerdp_client_codecs_free(context->codecs);
213 context->codecs = freerdp_client_codecs_new(flags);
214
215 if (!context->codecs)
216 return FALSE;
217
218 if (!freerdp_client_codecs_prepare(context->codecs,
220 settings->DesktopWidth, settings->DesktopHeight))
221 return FALSE;
222
223/* Runtime H264 detection. (only available if dynamic backend loading is defined)
224 * If no backend is available disable it before the channel is loaded.
225 */
226#if defined(WITH_GFX_H264) && defined(WITH_OPENH264_LOADING)
227 if (!context->codecs->h264)
228 {
229 settings->GfxH264 = FALSE;
230 settings->GfxAVC444 = FALSE;
231 settings->GfxAVC444v2 = FALSE;
232 }
233#endif
234 }
235
236 return TRUE;
237}
238
239static BOOL rdp_client_wait_for_activation(rdpRdp* rdp)
240{
241 BOOL timedout = FALSE;
242 WINPR_ASSERT(rdp);
243
244 const rdpSettings* settings = rdp->settings;
245 WINPR_ASSERT(settings);
246
247 UINT64 now = GetTickCount64();
248 UINT64 dueDate = now + freerdp_settings_get_uint32(settings, FreeRDP_TcpAckTimeout);
249
250 for (; (now < dueDate) && !timedout; now = GetTickCount64())
251 {
252 HANDLE events[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
253 DWORD wstatus = 0;
254 DWORD nevents = freerdp_get_event_handles(rdp->context, events, ARRAYSIZE(events));
255 if (!nevents)
256 {
257 WLog_ERR(TAG, "error retrieving connection events");
258 return FALSE;
259 }
260
261 const UINT64 timeout = (dueDate - now);
262 WINPR_ASSERT(timeout <= UINT32_MAX);
263 wstatus = WaitForMultipleObjectsEx(nevents, events, FALSE, (UINT32)timeout, TRUE);
264 switch (wstatus)
265 {
266 case WAIT_TIMEOUT:
267 /* will make us quit with a timeout */
268 timedout = TRUE;
269 break;
270 case WAIT_ABANDONED:
271 case WAIT_FAILED:
272 return FALSE;
273 case WAIT_IO_COMPLETION:
274 break;
275 case WAIT_OBJECT_0:
276 default:
277 /* handles all WAIT_OBJECT_0 + [0 .. MAXIMUM_WAIT_OBJECTS-1] cases */
278 if (rdp_check_fds(rdp) < 0)
279 {
280 freerdp_set_last_error_if_not(rdp->context,
281 FREERDP_ERROR_CONNECT_TRANSPORT_FAILED);
282 return FALSE;
283 }
284 break;
285 }
286
287 if (rdp_is_active_state(rdp))
288 return TRUE;
289 }
290
291 WLog_ERR(TAG, "Timeout waiting for activation");
292 freerdp_set_last_error_if_not(rdp->context, FREERDP_ERROR_CONNECT_ACTIVATION_TIMEOUT);
293 return FALSE;
294}
302BOOL rdp_client_connect(rdpRdp* rdp)
303{
304 UINT32 SelectedProtocol = 0;
305 BOOL status = 0;
306 /* make sure SSL is initialize for earlier enough for crypto, by taking advantage of winpr SSL
307 * FIPS flag for openssl initialization */
308 DWORD flags = WINPR_SSL_INIT_DEFAULT;
309
310 WINPR_ASSERT(rdp);
311
312 rdpSettings* settings = rdp->settings;
313 WINPR_ASSERT(settings);
314
315 if (!rdp_client_reset_codecs(rdp->context))
316 return FALSE;
317
318 if (settings->FIPSMode)
319 flags |= WINPR_SSL_INIT_ENABLE_FIPS;
320
321 if (!winpr_InitializeSSL(flags))
322 return FALSE;
323
324 rdp_log_build_warnings(rdp);
325
326 /* FIPS Mode forces the following and overrides the following(by happening later
327 * in the command line processing):
328 * 1. Forces the only supported RDP encryption method to be FIPS.
329 * 2. Disables NTLM authentication (not FIPS compliant due to MD4/RC4).
330 * 3. Disables RDP Security if 3DES is not available in the crypto provider. */
331 if (settings->FIPSMode || winpr_FIPSMode())
332 {
333
334 settings->EncryptionMethods = ENCRYPTION_METHOD_FIPS;
335
336 if (!settings->AuthenticationPackageList)
337 {
338 if (!freerdp_settings_set_string(settings, FreeRDP_AuthenticationPackageList, "!ntlm"))
339 return FALSE;
340 }
341
342 const BYTE key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
343 const BYTE iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;
344 WINPR_CIPHER_CTX* ctx = winpr_Cipher_NewEx(WINPR_CIPHER_DES_EDE3_CBC, WINPR_ENCRYPT, key,
345 sizeof(key), iv, sizeof(iv));
346 if (ctx)
347 {
348 winpr_Cipher_Free(ctx);
349 }
350 else
351 {
352 settings->RdpSecurity = FALSE;
353 }
354 }
355
356 UINT32 TcpConnectTimeout = freerdp_settings_get_uint32(settings, FreeRDP_TcpConnectTimeout);
357 if (settings->GatewayArmTransport)
358 {
359 if (!arm_resolve_endpoint(rdp->log, rdp->context, TcpConnectTimeout))
360 {
361 WLog_ERR(TAG, "error retrieving ARM configuration");
362 return FALSE;
363 }
364 }
365
366 const char* hostname = settings->ServerHostname;
367 if (!hostname)
368 {
369 WLog_ERR(TAG, "Missing hostname, can not connect to nullptr target");
370 return FALSE;
371 }
372
373 const UINT32 port = settings->ServerPort;
374 WINPR_ASSERT(port <= UINT32_MAX);
375
376 if (!rdp->nego)
377 return FALSE;
378
379 nego_init(rdp->nego);
380 nego_set_target(rdp->nego, hostname, (UINT16)port);
381
382 if (settings->GatewayEnabled)
383 {
384 char* user = nullptr;
385 char* domain = nullptr;
386 size_t user_length = 0;
387
388 if (settings->Username)
389 {
390 user = settings->Username;
391 user_length = strlen(settings->Username);
392 }
393
394 if (settings->Domain)
395 domain = settings->Domain;
396 else
397 domain = settings->ComputerName;
398
399 const size_t domain_length = strlen(domain);
400 const size_t cookie_length = domain_length + 1 + user_length;
401 char* cookie = malloc(cookie_length + 1);
402
403 if (!cookie)
404 return FALSE;
405
406 CopyMemory(cookie, domain, domain_length);
407 WINPR_ASSERT(domain_length <= UINT32_MAX);
408 CharUpperBuffA(cookie, (UINT32)domain_length);
409 cookie[domain_length] = '\\';
410
411 if (settings->Username)
412 CopyMemory(&cookie[domain_length + 1], user, user_length);
413
414 cookie[cookie_length] = '\0';
415 status = nego_set_cookie(rdp->nego, cookie);
416 free(cookie);
417 }
418 else
419 {
420 status = nego_set_cookie(rdp->nego, settings->Username);
421 }
422
423 if (!status)
424 return FALSE;
425
426 nego_set_childsession_enabled(rdp->nego, settings->ConnectChildSession);
427 nego_set_send_preconnection_pdu(rdp->nego, settings->SendPreconnectionPdu);
428 nego_set_preconnection_id(rdp->nego, settings->PreconnectionId);
429 nego_set_preconnection_blob(rdp->nego, settings->PreconnectionBlob);
430 nego_set_negotiation_enabled(rdp->nego, settings->NegotiateSecurityLayer);
431 nego_set_restricted_admin_mode_required(rdp->nego, settings->RestrictedAdminModeRequired);
432 nego_set_RCG_required(rdp->nego, settings->RemoteCredentialGuard);
433 nego_set_gateway_enabled(rdp->nego, settings->GatewayEnabled);
434 nego_set_gateway_bypass_local(rdp->nego, settings->GatewayBypassLocal);
435 nego_enable_rdp(rdp->nego, settings->RdpSecurity);
436 nego_enable_tls(rdp->nego, settings->TlsSecurity);
437 nego_enable_nla(rdp->nego, settings->NlaSecurity);
438 nego_enable_ext(rdp->nego, settings->ExtSecurity);
439 nego_enable_rdstls(rdp->nego, settings->RdstlsSecurity);
440 nego_enable_aad(rdp->nego, settings->AadSecurity);
441
442 if (settings->MstscCookieMode)
443 settings->CookieMaxLength = MSTSC_COOKIE_MAX_LENGTH;
444
445 nego_set_cookie_max_length(rdp->nego, settings->CookieMaxLength);
446
447 if (settings->LoadBalanceInfo && (settings->LoadBalanceInfoLength > 0))
448 {
449 if (!nego_set_routing_token(rdp->nego, settings->LoadBalanceInfo,
450 settings->LoadBalanceInfoLength))
451 return FALSE;
452 }
453
454 if (!freerdp_settings_get_bool(settings, FreeRDP_TransportDumpReplay))
455 {
456 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_NEGO))
457 return FALSE;
458
459 if (!nego_connect(rdp->nego))
460 {
461 if (!freerdp_get_last_error(rdp->context))
462 {
463 freerdp_set_last_error_log(rdp->context,
464 FREERDP_ERROR_SECURITY_NEGO_CONNECT_FAILED);
465 WLog_ERR(TAG, "Error: protocol security negotiation or connection failure");
466 }
467
468 return FALSE;
469 }
470
471 SelectedProtocol = nego_get_selected_protocol(rdp->nego);
472
473 if ((SelectedProtocol & PROTOCOL_SSL) || (SelectedProtocol == PROTOCOL_RDP) ||
474 (SelectedProtocol == PROTOCOL_RDSTLS))
475 {
476 wStream s = WINPR_C_ARRAY_INIT;
477
478 if ((settings->Username != nullptr) &&
479 ((freerdp_settings_get_string(settings, FreeRDP_Password) != nullptr) ||
480 (settings->RedirectionPassword != nullptr &&
481 settings->RedirectionPasswordLength > 0)))
482 settings->AutoLogonEnabled = TRUE;
483
484 if (rdp_recv_callback(rdp->transport, &s, rdp) < 0)
485 return FALSE;
486 }
487
488 if (!transport_set_blocking_mode(rdp->transport, FALSE))
489 return FALSE;
490 }
491 else
492 {
493 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
494 return FALSE;
495 }
496
497 /* everything beyond this point is event-driven and non blocking */
498 if (!transport_set_recv_callbacks(rdp->transport, rdp_recv_callback, rdp))
499 return FALSE;
500
501 /* A tunnel the server asked for during the connection sequence is of no use when the
502 * sequence fails. It is stopped now: the next disconnect, which would stop it too, can be a
503 * long way off, an auto-reconnect waits between attempts. */
504 const BOOL activated = rdp_client_wait_for_activation(rdp);
505 if (!activated)
506 multitransport_reset(rdp->multitransport);
507 return activated;
508}
509
510BOOL rdp_client_disconnect(rdpRdp* rdp)
511{
512 rdpContext* context = nullptr;
513
514 if (!rdp || !rdp->settings || !rdp->context)
515 return FALSE;
516
517 context = rdp->context;
518
519 if (rdp->nego)
520 {
521 if (!nego_disconnect(rdp->nego))
522 return FALSE;
523 }
524
525 if (!transport_disconnect(rdp->transport))
526 return FALSE;
527
528 if (!rdp_reset(rdp))
529 return FALSE;
530
531 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_INITIAL))
532 return FALSE;
533
534 if (context->channels)
535 {
536 if (freerdp_channels_disconnect(context->channels, context->instance) != CHANNEL_RC_OK)
537 return FALSE;
538 }
539
540 freerdp_client_codecs_free(context->codecs);
541 context->codecs = nullptr;
542 return TRUE;
543}
544
545BOOL rdp_client_disconnect_and_clear(rdpRdp* rdp)
546{
547 rdpContext* context = nullptr;
548
549 if (!rdp_client_disconnect(rdp))
550 return FALSE;
551
552 WINPR_ASSERT(rdp);
553
554 context = rdp->context;
555 WINPR_ASSERT(context);
556
557 if (freerdp_get_last_error(context) == FREERDP_ERROR_CONNECT_CANCELLED)
558 return FALSE;
559
560 context->LastError = FREERDP_ERROR_SUCCESS;
561 clearChannelError(context);
562 return utils_reset_abort(rdp);
563}
564
565static BOOL rdp_client_reconnect_channels(rdpRdp* rdp, BOOL redirect)
566{
567 BOOL status = FALSE;
568 rdpContext* context = nullptr;
569
570 if (!rdp || !rdp->context || !rdp->context->channels)
571 return FALSE;
572
573 context = rdp->context;
574
575 if (context->instance->ConnectionCallbackState == CLIENT_STATE_INITIAL)
576 return FALSE;
577
578 if (context->instance->ConnectionCallbackState == CLIENT_STATE_PRECONNECT_PASSED)
579 {
580 if (redirect)
581 return TRUE;
582
583 pointer_cache_register_callbacks(context->update);
584
585 if (!cache_resize(context))
586 return FALSE;
587
588 if (!IFCALLRESULT(FALSE, context->instance->PostConnect, context->instance))
589 return FALSE;
590
591 context->instance->ConnectionCallbackState = CLIENT_STATE_POSTCONNECT_PASSED;
592 }
593
594 if (context->instance->ConnectionCallbackState == CLIENT_STATE_POSTCONNECT_PASSED)
595 status =
596 (freerdp_channels_post_connect(context->channels, context->instance) == CHANNEL_RC_OK);
597
598 return status;
599}
600
601static BOOL rdp_client_redirect_resolvable(const char* host)
602{
603 struct addrinfo* result = freerdp_tcp_resolve_host(host, -1, 0);
604
605 if (!result)
606 return FALSE;
607
608 freeaddrinfo(result);
609 return TRUE;
610}
611
612static BOOL rdp_client_redirect_try_fqdn(rdpSettings* settings)
613{
614 if (settings->RedirectionFlags & LB_TARGET_FQDN)
615 {
616 if (settings->GatewayEnabled ||
617 rdp_client_redirect_resolvable(settings->RedirectionTargetFQDN))
618 {
619 return (freerdp_settings_set_string(settings, FreeRDP_ServerHostname,
620 settings->RedirectionTargetFQDN));
621 }
622 }
623
624 return FALSE;
625}
626
627static BOOL rdp_client_redirect_try_ip(rdpSettings* settings)
628{
629 if (settings->RedirectionFlags & LB_TARGET_NET_ADDRESS)
630 {
631 return (freerdp_settings_set_string(settings, FreeRDP_ServerHostname,
632 settings->TargetNetAddress));
633 }
634
635 return FALSE;
636}
637
638static BOOL rdp_client_redirect_try_netbios(rdpSettings* settings)
639{
640 if (settings->RedirectionFlags & LB_TARGET_NETBIOS_NAME)
641 {
642 if (settings->GatewayEnabled ||
643 rdp_client_redirect_resolvable(settings->RedirectionTargetNetBiosName))
644 {
645 return (freerdp_settings_set_string(settings, FreeRDP_ServerHostname,
646 settings->RedirectionTargetNetBiosName));
647 }
648 }
649
650 return FALSE;
651}
652
653BOOL rdp_client_redirect(rdpRdp* rdp)
654{
655 BOOL status = 0;
656 rdpSettings* settings = nullptr;
657
658 if (!rdp_client_disconnect_and_clear(rdp))
659 return FALSE;
660
661 /* Only disconnect & close the channels here.
662 * they will be discarded and recreated after the new settings have been applied. */
663 freerdp_channels_disconnect(rdp->context->channels, rdp->context->instance);
664 freerdp_channels_close(rdp->context->channels, rdp->context->instance);
665
666 if (rdp_redirection_apply_settings(rdp) != 0)
667 return FALSE;
668
669 WINPR_ASSERT(rdp);
670
671 settings = rdp->settings;
672 WINPR_ASSERT(settings);
673
674 if ((settings->RedirectionFlags & LB_LOAD_BALANCE_INFO) == 0)
675 {
676 BOOL haveRedirectAddress = FALSE;
677 UINT32 redirectionMask = settings->RedirectionPreferType;
678
679 do
680 {
681 const BOOL tryFQDN = (redirectionMask & 0x01) == 0;
682 const BOOL tryNetAddress = (redirectionMask & 0x02) == 0;
683 const BOOL tryNetbios = (redirectionMask & 0x04) == 0;
684
685 if (tryFQDN && !haveRedirectAddress)
686 haveRedirectAddress = rdp_client_redirect_try_fqdn(settings);
687
688 if (tryNetAddress && !haveRedirectAddress)
689 haveRedirectAddress = rdp_client_redirect_try_ip(settings);
690
691 if (tryNetbios && !haveRedirectAddress)
692 haveRedirectAddress = rdp_client_redirect_try_netbios(settings);
693
694 redirectionMask >>= 3;
695 } while (!haveRedirectAddress && (redirectionMask != 0));
696 }
697
698 if (settings->RedirectionFlags & LB_USERNAME)
699 {
701 settings, FreeRDP_Username,
702 freerdp_settings_get_string(settings, FreeRDP_RedirectionUsername)))
703 return FALSE;
704 }
705
706 if (settings->RedirectionFlags & LB_DOMAIN)
707 {
709 settings, FreeRDP_Domain,
710 freerdp_settings_get_string(settings, FreeRDP_RedirectionDomain)))
711 return FALSE;
712 }
713
714 settings->RdstlsSecurity = ((settings->RedirectionFlags & LB_PASSWORD_IS_PK_ENCRYPTED) != 0);
715
716 WINPR_ASSERT(rdp->context);
717 WINPR_ASSERT(rdp->context->instance);
718 if (!IFCALLRESULT(TRUE, rdp->context->instance->Redirect, rdp->context->instance))
719 return FALSE;
720
721 BOOL ok = utils_reload_channels(rdp->context);
722 if (!ok)
723 return FALSE;
724
725 status = rdp_client_connect(rdp);
726
727 if (status)
728 status = rdp_client_reconnect_channels(rdp, TRUE);
729
730 return status;
731}
732
733/* A redirection that carried a one-time RDSTLS token (LB_PASSWORD_IS_PK_ENCRYPTED) cannot be
734 * replayed: reconnecting straight to the redirected host is refused with SEC_E_INVALID_TOKEN.
735 * Go back to the server the connection was originally made to (the RD Connection Broker), which
736 * redirects again to the same session with a fresh token. Everything the redirection changed
737 * (host, load balance info, user, redirected session id, auto-reconnect cookie) has to go, so
738 * start again from the settings the connection began with, the way rdp_client_redirect() does:
739 * the channels are closed before the settings they use are freed, and loaded again after. */
740WINPR_ATTR_NODISCARD
741static BOOL rdp_client_reconnect_via_broker(rdpRdp* rdp, BOOL* viaBroker)
742{
743 WINPR_ASSERT(rdp);
744 WINPR_ASSERT(viaBroker);
745 *viaBroker = FALSE;
746 const rdpSettings* settings = rdp->settings;
747 WINPR_ASSERT(settings);
748
749 if (!rdp->originalSettings || !freerdp_settings_get_bool(settings, FreeRDP_RdstlsSecurity))
750 return TRUE;
751 if ((freerdp_settings_get_uint32(settings, FreeRDP_RedirectionFlags) &
752 LB_PASSWORD_IS_PK_ENCRYPTED) == 0)
753 return TRUE;
754
755 WINPR_ASSERT(rdp->context);
756 WINPR_ASSERT(rdp->context->instance);
757 WLog_INFO(TAG, "the redirection used a one-time RDSTLS token, reconnecting through %s",
758 freerdp_settings_get_string(rdp->originalSettings, FreeRDP_ServerHostname));
759
760 freerdp_channels_disconnect(rdp->context->channels, rdp->context->instance);
761 freerdp_channels_close(rdp->context->channels, rdp->context->instance);
762
763 if (!rdp_reset_runtime_settings(rdp))
764 return FALSE;
765 if (!freerdp_settings_set_bool(rdp->settings, FreeRDP_SessionHasBeenReconnected, TRUE))
766 return FALSE;
767 if (!IFCALLRESULT(TRUE, rdp->context->instance->Redirect, rdp->context->instance))
768 return FALSE;
769 if (!utils_reload_channels(rdp->context))
770 return FALSE;
771
772 *viaBroker = TRUE;
773 return TRUE;
774}
775
776/* Pause before reconnecting a connection that its UDP tunnel ended, see rdp_client_reconnect. */
777#define TUNNEL_RECONNECT_PAUSE_MS 2000
778
779BOOL rdp_client_reconnect(rdpRdp* rdp)
780{
781 /* A connection ended by its UDP tunnel closes TCP cleanly, and the server starts tearing
782 * the session down at once. Windows drops a reconnect that arrives during that teardown,
783 * and the auto-reconnect then waits out its whole retry delay. */
784 const BOOL tunnelEnded = multitransport_ended_connection(rdp->multitransport);
785
786 if (!rdp_client_disconnect_and_clear(rdp))
787 return FALSE;
788
789 if (tunnelEnded)
790 {
791 WLog_DBG(TAG, "the UDP tunnel ended the connection, reconnecting in %d ms",
792 TUNNEL_RECONNECT_PAUSE_MS);
793 if (WaitForSingleObject(utils_get_abort_event(rdp), TUNNEL_RECONNECT_PAUSE_MS) ==
794 WAIT_OBJECT_0)
795 return FALSE;
796 }
797
798 if (!freerdp_settings_set_bool(rdp->settings, FreeRDP_SessionHasBeenReconnected, TRUE))
799 return FALSE;
800
801 BOOL viaBroker = FALSE;
802 if (!rdp_client_reconnect_via_broker(rdp, &viaBroker))
803 return FALSE;
804
805 BOOL status = rdp_client_connect(rdp);
806
807 /* When the broker redirected us, rdp_client_redirect() already reloaded and reconnected the
808 * channels (rdp_check_fds() runs it from inside rdp_client_connect()); doing it a second time
809 * fails with CHANNEL_RC_ALREADY_OPEN and makes the whole attempt fail. */
810 const BOOL redirected =
811 viaBroker && (freerdp_settings_get_uint32(rdp->settings, FreeRDP_RedirectionFlags) != 0);
812 if (status && !redirected)
813 status = rdp_client_reconnect_channels(rdp, viaBroker);
814
815 return status;
816}
817
818static const BYTE fips_ivec[8] = { 0x12, 0x34, 0x56, 0x78, 0x90, 0xAB, 0xCD, 0xEF };
819
820static BOOL rdp_client_establish_keys(rdpRdp* rdp)
821{
822 wStream* s = nullptr;
823 BOOL ret = FALSE;
824
825 WINPR_ASSERT(rdp);
826 rdpSettings* settings = rdp->settings;
827 BYTE* crypt_client_random = nullptr;
828
829 WINPR_ASSERT(settings);
830 if (!settings->UseRdpSecurityLayer)
831 {
832 /* no RDP encryption */
833 return TRUE;
834 }
835
836 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_RDP_SECURITY_COMMENCEMENT))
837 return FALSE;
838
839 /* encrypt client random */
840 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ClientRandom, nullptr,
841 CLIENT_RANDOM_LENGTH))
842 return FALSE;
843 if (winpr_RAND(settings->ClientRandom, settings->ClientRandomLength) < 0)
844 return FALSE;
845
846 const rdpCertInfo* info = freerdp_certificate_get_info(settings->RdpServerCertificate);
847 if (!info)
848 {
849 WLog_ERR(TAG, "Failed to get rdpCertInfo from RdpServerCertificate");
850 return FALSE;
851 }
852
853 /*
854 * client random must be (bitlen / 8) + 8 - see [MS-RDPBCGR] 5.3.4.1
855 * for details
856 */
857 crypt_client_random = calloc(info->ModulusLength, 1);
858
859 if (!crypt_client_random)
860 return FALSE;
861
862 if (crypto_rsa_public_encrypt(settings->ClientRandom, settings->ClientRandomLength, info,
863 crypt_client_random, info->ModulusLength) < 0)
864 goto end;
865 /* send crypt client random to server */
866 const size_t length = RDP_PACKET_HEADER_MAX_LENGTH + RDP_SECURITY_HEADER_LENGTH + 4ULL +
867 info->ModulusLength + 8ULL;
868 if (length > UINT16_MAX)
869 goto end;
870
871 s = Stream_New(nullptr, length);
872
873 if (!s)
874 {
875 WLog_ERR(TAG, "Stream_New failed!");
876 goto end;
877 }
878
879 {
880 const UINT16 sec_flags = SEC_EXCHANGE_PKT | SEC_LICENSE_ENCRYPT_SC;
881 if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
882 goto end;
883 if (!rdp_write_security_header(rdp, s, sec_flags))
884 goto end;
885 }
886
887 Stream_Write_UINT32(s, info->ModulusLength + 8);
888 Stream_Write(s, crypt_client_random, info->ModulusLength);
889 Stream_Zero(s, 8);
890 Stream_SealLength(s);
891
892 {
893 rdpTransport* transport = freerdp_get_transport(rdp->context);
894 const int status = transport_write(transport, s);
895
896 if (status < 0)
897 goto end;
898 }
899
900 rdp->do_crypt_license = TRUE;
901
902 /* now calculate encrypt / decrypt and update keys */
903 if (!security_establish_keys(rdp))
904 goto end;
905
906 rdp->do_crypt = TRUE;
907
908 if (settings->SaltedChecksum)
909 rdp->do_secure_checksum = TRUE;
910
911 if (settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
912 {
913 rdp->fips_encrypt =
914 winpr_Cipher_NewEx(WINPR_CIPHER_DES_EDE3_CBC, WINPR_ENCRYPT, rdp->fips_encrypt_key,
915 sizeof(rdp->fips_encrypt_key), fips_ivec, sizeof(fips_ivec));
916
917 if (!rdp->fips_encrypt)
918 {
919 WLog_ERR(TAG, "unable to allocate des3 encrypt key");
920 goto end;
921 }
922
923 rdp->fips_decrypt =
924 winpr_Cipher_NewEx(WINPR_CIPHER_DES_EDE3_CBC, WINPR_DECRYPT, rdp->fips_decrypt_key,
925 sizeof(rdp->fips_decrypt_key), fips_ivec, sizeof(fips_ivec));
926
927 if (!rdp->fips_decrypt)
928 {
929 WLog_ERR(TAG, "unable to allocate des3 decrypt key");
930 goto end;
931 }
932
933 ret = TRUE;
934 goto end;
935 }
936
937 if (!rdp_reset_rc4_encrypt_keys(rdp))
938 goto end;
939 if (!rdp_reset_rc4_decrypt_keys(rdp))
940 goto end;
941
942 ret = TRUE;
943end:
944 Stream_Free(s, TRUE);
945 free(crypt_client_random);
946
947 if (!ret)
948 {
949 winpr_Cipher_Free(rdp->fips_decrypt);
950 winpr_Cipher_Free(rdp->fips_encrypt);
951 rdp->fips_decrypt = nullptr;
952 rdp->fips_encrypt = nullptr;
953
954 rdp_free_rc4_decrypt_keys(rdp);
955 rdp_free_rc4_encrypt_keys(rdp);
956 }
957
958 return ret;
959}
960
961static BOOL rdp_update_client_random(rdpSettings* settings, const BYTE* crypt_random,
962 size_t crypt_random_len)
963{
964 const size_t length = 32;
965 WINPR_ASSERT(settings);
966
967 const rdpPrivateKey* rsa = freerdp_settings_get_pointer(settings, FreeRDP_RdpServerRsaKey);
968 WINPR_ASSERT(rsa);
969
970 const rdpCertInfo* cinfo = freerdp_key_get_info(rsa);
971 WINPR_ASSERT(cinfo);
972
973 if (crypt_random_len != cinfo->ModulusLength + 8)
974 {
975 WLog_ERR(TAG, "invalid encrypted client random length");
976 return FALSE;
977 }
978 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ClientRandom, nullptr, length))
979 return FALSE;
980
981 BYTE* client_random = freerdp_settings_get_pointer_writable(settings, FreeRDP_ClientRandom);
982 WINPR_ASSERT(client_random);
983 return crypto_rsa_private_decrypt(crypt_random, crypt_random_len - 8, rsa, client_random,
984 length) > 0;
985}
986
987BOOL rdp_server_establish_keys(rdpRdp* rdp, wStream* s)
988{
989 UINT32 rand_len = 0;
990 UINT16 channel_id = 0;
991 UINT16 length = 0;
992 UINT16 sec_flags = 0;
993 BOOL ret = FALSE;
994
995 WINPR_ASSERT(rdp);
996
997 if (!rdp->settings->UseRdpSecurityLayer)
998 {
999 /* No RDP Security. */
1000 return TRUE;
1001 }
1002
1003 if (!rdp_read_header(rdp, s, &length, &channel_id))
1004 return FALSE;
1005
1006 if (!rdp_read_security_header(rdp, s, &sec_flags, nullptr))
1007 {
1008 WLog_Print(rdp->log, WLOG_ERROR, "invalid security header");
1009 return FALSE;
1010 }
1011
1012 if ((sec_flags & SEC_EXCHANGE_PKT) == 0)
1013 {
1014 WLog_Print(rdp->log, WLOG_ERROR, "missing SEC_EXCHANGE_PKT in security header");
1015 return FALSE;
1016 }
1017
1018 rdp->do_crypt_license = ((sec_flags & SEC_LICENSE_ENCRYPT_SC) != 0);
1019
1020 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
1021 return FALSE;
1022
1023 Stream_Read_UINT32(s, rand_len);
1024
1025 /* rand_len already includes 8 bytes of padding */
1026 if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, rand_len))
1027 return FALSE;
1028
1029 const BYTE* crypt_random = Stream_ConstPointer(s);
1030 if (!Stream_SafeSeek(s, rand_len))
1031 goto end;
1032 if (!rdp_update_client_random(rdp->settings, crypt_random, rand_len))
1033 goto end;
1034
1035 /* now calculate encrypt / decrypt and update keys */
1036 if (!security_establish_keys(rdp))
1037 goto end;
1038
1039 rdp->do_crypt = TRUE;
1040
1041 if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
1042 {
1043 rdp->fips_encrypt =
1044 winpr_Cipher_NewEx(WINPR_CIPHER_DES_EDE3_CBC, WINPR_ENCRYPT, rdp->fips_encrypt_key,
1045 sizeof(rdp->fips_encrypt_key), fips_ivec, sizeof(fips_ivec));
1046
1047 if (!rdp->fips_encrypt)
1048 {
1049 WLog_Print(rdp->log, WLOG_ERROR, "unable to allocate des3 encrypt key");
1050 goto end;
1051 }
1052
1053 rdp->fips_decrypt =
1054 winpr_Cipher_NewEx(WINPR_CIPHER_DES_EDE3_CBC, WINPR_DECRYPT, rdp->fips_decrypt_key,
1055 sizeof(rdp->fips_decrypt_key), fips_ivec, sizeof(fips_ivec));
1056
1057 if (!rdp->fips_decrypt)
1058 {
1059 WLog_Print(rdp->log, WLOG_ERROR, "unable to allocate des3 decrypt key");
1060 goto end;
1061 }
1062
1063 ret = TRUE;
1064 goto end;
1065 }
1066
1067 if (!rdp_reset_rc4_encrypt_keys(rdp))
1068 goto end;
1069
1070 if (!rdp_reset_rc4_decrypt_keys(rdp))
1071 goto end;
1072
1073 ret = tpkt_ensure_stream_consumed(rdp->log, s, length);
1074end:
1075
1076 if (!ret)
1077 {
1078 winpr_Cipher_Free(rdp->fips_encrypt);
1079 winpr_Cipher_Free(rdp->fips_decrypt);
1080 rdp->fips_encrypt = nullptr;
1081 rdp->fips_decrypt = nullptr;
1082
1083 rdp_free_rc4_encrypt_keys(rdp);
1084 rdp_free_rc4_decrypt_keys(rdp);
1085 }
1086
1087 return ret;
1088}
1089
1090static BOOL rdp_client_send_client_info_and_change_state(rdpRdp* rdp)
1091{
1092 WINPR_ASSERT(rdp);
1093 if (!rdp_client_establish_keys(rdp))
1094 return FALSE;
1095 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_SECURE_SETTINGS_EXCHANGE))
1096 return FALSE;
1097 if (!rdp_send_client_info(rdp))
1098 return FALSE;
1099 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST))
1100 return FALSE;
1101 return TRUE;
1102}
1103
1104BOOL rdp_client_skip_mcs_channel_join(rdpRdp* rdp)
1105{
1106 WINPR_ASSERT(rdp);
1107
1108 rdpMcs* mcs = rdp->mcs;
1109 WINPR_ASSERT(mcs);
1110
1111 mcs->userChannelJoined = TRUE;
1112 mcs->globalChannelJoined = TRUE;
1113 mcs->messageChannelJoined = TRUE;
1114
1115 for (UINT32 i = 0; i < mcs->channelCount; i++)
1116 {
1117 rdpMcsChannel* cur = &mcs->channels[i];
1118 WLog_DBG(TAG, " %s [%" PRIu16 "]", cur->Name, cur->ChannelId);
1119 cur->joined = TRUE;
1120 }
1121
1122 return rdp_client_send_client_info_and_change_state(rdp);
1123}
1124
1125static BOOL rdp_client_join_channel(rdpRdp* rdp, UINT16 ChannelId)
1126{
1127 WINPR_ASSERT(rdp);
1128
1129 rdpMcs* mcs = rdp->mcs;
1130 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
1131 return FALSE;
1132 if (!mcs_send_channel_join_request(mcs, ChannelId))
1133 return FALSE;
1134 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
1135 return FALSE;
1136 return TRUE;
1137}
1138
1139BOOL rdp_client_connect_mcs_channel_join_confirm(rdpRdp* rdp, wStream* s)
1140{
1141 UINT16 channelId = 0;
1142 BOOL allJoined = TRUE;
1143
1144 WINPR_ASSERT(rdp);
1145 rdpMcs* mcs = rdp->mcs;
1146
1147 if (!mcs_recv_channel_join_confirm(mcs, s, &channelId))
1148 return FALSE;
1149
1150 if (!mcs->userChannelJoined)
1151 {
1152 if (channelId != mcs->userId)
1153 {
1154 WLog_ERR(TAG, "expected user channel id %" PRIu16 ", but received %" PRIu16,
1155 mcs->userId, channelId);
1156 return FALSE;
1157 }
1158
1159 mcs->userChannelJoined = TRUE;
1160 if (!rdp_client_join_channel(rdp, MCS_GLOBAL_CHANNEL_ID))
1161 return FALSE;
1162 }
1163 else if (!mcs->globalChannelJoined)
1164 {
1165 if (channelId != MCS_GLOBAL_CHANNEL_ID)
1166 {
1167 WLog_ERR(TAG, "expected uglobalser channel id %d, but received %" PRIu16,
1168 MCS_GLOBAL_CHANNEL_ID, channelId);
1169 return FALSE;
1170 }
1171 mcs->globalChannelJoined = TRUE;
1172
1173 if (mcs->messageChannelId != 0)
1174 {
1175 if (!rdp_client_join_channel(rdp, mcs->messageChannelId))
1176 return FALSE;
1177 allJoined = FALSE;
1178 }
1179 else
1180 {
1181 if (mcs->channelCount > 0)
1182 {
1183 const rdpMcsChannel* cur = &mcs->channels[0];
1184 if (!rdp_client_join_channel(rdp, cur->ChannelId))
1185 return FALSE;
1186 allJoined = FALSE;
1187 }
1188 }
1189 }
1190 else if ((mcs->messageChannelId != 0) && !mcs->messageChannelJoined)
1191 {
1192 if (channelId != mcs->messageChannelId)
1193 {
1194 WLog_ERR(TAG, "expected messageChannelId=%" PRIu16 ", got %" PRIu16,
1195 mcs->messageChannelId, channelId);
1196 return FALSE;
1197 }
1198
1199 mcs->messageChannelJoined = TRUE;
1200
1201 if (mcs->channelCount > 0)
1202 {
1203 const rdpMcsChannel* cur = &mcs->channels[0];
1204 if (!rdp_client_join_channel(rdp, cur->ChannelId))
1205 return FALSE;
1206 allJoined = FALSE;
1207 }
1208 }
1209 else
1210 {
1211 UINT32 i = 0;
1212 for (; i < mcs->channelCount; i++)
1213 {
1214 rdpMcsChannel* cur = &mcs->channels[i];
1215 if (cur->joined)
1216 continue;
1217
1218 if (cur->ChannelId != channelId)
1219 {
1220 WLog_ERR(TAG, "expected channel id %d, but received %" PRIu16,
1221 MCS_GLOBAL_CHANNEL_ID, channelId);
1222 return FALSE;
1223 }
1224 cur->joined = TRUE;
1225 break;
1226 }
1227
1228 if (i + 1 < mcs->channelCount)
1229 {
1230 const rdpMcsChannel* cur = &mcs->channels[i + 1];
1231 if (!rdp_client_join_channel(rdp, cur->ChannelId))
1232 return FALSE;
1233 allJoined = FALSE;
1234 }
1235 }
1236
1237 if (mcs->userChannelJoined && mcs->globalChannelJoined && allJoined)
1238 {
1239 if (!rdp_client_send_client_info_and_change_state(rdp))
1240 return FALSE;
1241 }
1242
1243 return TRUE;
1244}
1245
1246state_run_t rdp_handle_message_channel(rdpRdp* rdp, wStream* s, UINT16 channelId, UINT16 length)
1247{
1248 WINPR_ASSERT(rdp);
1249 WINPR_ASSERT(rdp->mcs);
1250
1251 if (!rdp->mcs->messageChannelJoined)
1252 {
1253 WLog_Print(rdp->log, WLOG_WARN, "MCS message channel not joined!");
1254 return STATE_RUN_FAILED;
1255 }
1256 const UINT16 messageChannelId = rdp->mcs->messageChannelId;
1257 if (messageChannelId == 0)
1258 {
1259 WLog_Print(rdp->log, WLOG_WARN, "MCS message channel id == 0");
1260 return STATE_RUN_FAILED;
1261 }
1262
1263 if ((channelId != messageChannelId) && (channelId != MCS_GLOBAL_CHANNEL_ID))
1264 {
1265 WLog_Print(rdp->log, WLOG_WARN,
1266 "MCS message channel expected id=[%" PRIu16 "|%d], got %" PRIu16,
1267 messageChannelId, MCS_GLOBAL_CHANNEL_ID, channelId);
1268 return STATE_RUN_FAILED;
1269 }
1270
1271 UINT16 securityFlags = 0;
1272 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1273 return STATE_RUN_FAILED;
1274
1275 if (securityFlags & SEC_ENCRYPT)
1276 {
1277 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1278 return STATE_RUN_FAILED;
1279 }
1280
1281 const state_run_t rc = rdp_recv_message_channel_pdu(rdp, s, securityFlags);
1282 if (state_run_success(rc))
1283 {
1284 if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
1285 return STATE_RUN_FAILED;
1286 }
1287 return rc;
1288}
1289
1290BOOL rdp_client_connect_auto_detect(rdpRdp* rdp, wStream* s, DWORD logLevel)
1291{
1292 BOOL res = TRUE;
1293 WINPR_ASSERT(rdp);
1294 WINPR_ASSERT(rdp->mcs);
1295
1296 size_t pos = Stream_GetPosition(s);
1297 UINT16 length = 0;
1298 UINT16 channelId = 0;
1299
1300 if (!rdp_read_header(rdp, s, &length, &channelId))
1301 res = FALSE;
1302 else
1303 {
1304 const UINT16 messageChannelId = rdp->mcs->messageChannelId;
1305 /* If the MCS message channel has been joined... */
1306
1307 /* Process any MCS message channel PDUs. */
1308 if (rdp->mcs->messageChannelJoined && (channelId == messageChannelId))
1309 {
1310 const state_run_t rc = rdp_handle_message_channel(rdp, s, channelId, length);
1311 res = state_run_success(rc);
1312 pos = Stream_GetPosition(s);
1313 }
1314 else
1315 {
1316 wLog* log = WLog_Get(TAG);
1317 WLog_Print(log, logLevel, "expected messageChannelId=%" PRIu16 ", got %" PRIu16,
1318 messageChannelId, channelId);
1319 res = FALSE;
1320 }
1321 }
1322
1323 if (!Stream_SetPosition(s, pos))
1324 res = FALSE;
1325 return res;
1326}
1327
1328state_run_t rdp_client_connect_license(rdpRdp* rdp, wStream* s)
1329{
1330 state_run_t status = STATE_RUN_FAILED;
1331 LICENSE_STATE state = LICENSE_STATE_ABORTED;
1332 UINT16 length = 0;
1333 UINT16 channelId = 0;
1334 UINT16 securityFlags = 0;
1335
1336 WINPR_ASSERT(rdp);
1337 if (!rdp_read_header(rdp, s, &length, &channelId))
1338 return STATE_RUN_FAILED;
1339
1340 /* there might be autodetect messages mixed in between licensing messages.
1341 * that has been observed with 2k12 R2 and 2k19
1342 */
1343 const UINT16 messageChannelId = rdp->mcs->messageChannelId;
1344 if (rdp->mcs->messageChannelJoined && (channelId == messageChannelId))
1345 {
1346 return rdp_handle_message_channel(rdp, s, channelId, length);
1347 }
1348
1349 if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
1350 return STATE_RUN_FAILED;
1351
1352 if (securityFlags & SEC_ENCRYPT)
1353 {
1354 if (!rdp_decrypt(rdp, s, &length, securityFlags))
1355 return STATE_RUN_FAILED;
1356 }
1357
1358 if (channelId != MCS_GLOBAL_CHANNEL_ID)
1359 WLog_WARN(TAG, "unexpected message for channel %u, expected %d", channelId,
1360 MCS_GLOBAL_CHANNEL_ID);
1361
1362 if ((securityFlags & SEC_LICENSE_PKT) == 0)
1363 {
1364 char buffer[512] = WINPR_C_ARRAY_INIT;
1365 char lbuffer[32] = WINPR_C_ARRAY_INIT;
1366 WLog_ERR(TAG, "securityFlags=%s, missing required flag %s",
1367 rdp_security_flag_string(securityFlags, buffer, sizeof(buffer)),
1368 rdp_security_flag_string(SEC_LICENSE_PKT, lbuffer, sizeof(lbuffer)));
1369 return STATE_RUN_FAILED;
1370 }
1371
1372 status = license_recv(rdp->license, s);
1373
1374 if (state_run_failed(status))
1375 return status;
1376
1377 state = license_get_state(rdp->license);
1378 switch (state)
1379 {
1380 case LICENSE_STATE_ABORTED:
1381 WLog_ERR(TAG, "license connection sequence aborted.");
1382 return STATE_RUN_FAILED;
1383 case LICENSE_STATE_COMPLETED:
1384 if (rdp->settings->MultitransportFlags)
1385 {
1386 if (!rdp_client_transition_to_state(
1387 rdp, CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST))
1388 return STATE_RUN_FAILED;
1389 }
1390 else
1391 {
1392 if (!rdp_client_transition_to_state(
1393 rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
1394 return STATE_RUN_FAILED;
1395 }
1396 return STATE_RUN_SUCCESS;
1397 default:
1398 return STATE_RUN_SUCCESS;
1399 }
1400}
1401
1402state_run_t rdp_client_connect_demand_active(rdpRdp* rdp, wStream* s)
1403{
1404 UINT16 length = 0;
1405 UINT16 channelId = 0;
1406 UINT16 pduType = 0;
1407 UINT16 pduSource = 0;
1408
1409 WINPR_ASSERT(rdp);
1410 WINPR_ASSERT(s);
1411 WINPR_ASSERT(rdp->settings);
1412
1413 if (!rdp_recv_get_active_header(rdp, s, &channelId, &length))
1414 return STATE_RUN_FAILED;
1415
1416 if (freerdp_shall_disconnect_context(rdp->context))
1417 return STATE_RUN_QUIT_SESSION;
1418
1419 if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
1420 {
1421 rdp->inPackets++;
1422 return rdp_handle_message_channel(rdp, s, channelId, length);
1423 }
1424
1425 if (!rdp_handle_optional_rdp_decryption(rdp, s, &length, nullptr))
1426 return STATE_RUN_FAILED;
1427
1428 if (!rdp_read_share_control_header(rdp, s, nullptr, nullptr, &pduType, &pduSource))
1429 return STATE_RUN_FAILED;
1430
1431 switch (pduType)
1432 {
1433 case PDU_TYPE_DEMAND_ACTIVE:
1434 if (!rdp_recv_demand_active(rdp, s, pduSource, length))
1435 return STATE_RUN_FAILED;
1436 return STATE_RUN_ACTIVE;
1437 default:
1438 return rdp_recv_out_of_sequence_pdu(rdp, s, pduType, length);
1439 }
1440}
1441
1442WINPR_ATTR_NODISCARD
1443static state_run_t rdp_client_connect_finalize(rdpRdp* rdp)
1444{
1445 WINPR_ASSERT(rdp);
1452 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_SYNC))
1453 return STATE_RUN_FAILED;
1454
1455 if (!rdp_send_client_synchronize_pdu(rdp))
1456 return STATE_RUN_FAILED;
1457
1458 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_COOPERATE))
1459 return STATE_RUN_FAILED;
1460 if (!rdp_send_client_control_pdu(rdp, CTRLACTION_COOPERATE))
1461 return STATE_RUN_FAILED;
1462
1463 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_REQUEST_CONTROL))
1464 return STATE_RUN_FAILED;
1465 if (!rdp_send_client_control_pdu(rdp, CTRLACTION_REQUEST_CONTROL))
1466 return STATE_RUN_FAILED;
1467
1475 if (!rdp_finalize_is_flag_set(rdp, FINALIZE_DEACTIVATE_REACTIVATE) &&
1476 freerdp_settings_get_bool(rdp->settings, FreeRDP_BitmapCachePersistEnabled))
1477 {
1478 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_PERSISTENT_KEY_LIST))
1479 return STATE_RUN_FAILED;
1480 if (!rdp_send_client_persistent_key_list_pdu(rdp))
1481 return STATE_RUN_FAILED;
1482 }
1483
1484 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_FONT_LIST))
1485 return STATE_RUN_FAILED;
1486 if (!rdp_send_client_font_list_pdu(rdp, FONTLIST_FIRST | FONTLIST_LAST))
1487 return STATE_RUN_FAILED;
1488
1489 if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_CLIENT_SYNC))
1490 return STATE_RUN_FAILED;
1491 return STATE_RUN_SUCCESS;
1492}
1493
1494BOOL rdp_client_transition_to_state(rdpRdp* rdp, CONNECTION_STATE state)
1495{
1496 const char* name = rdp_state_string(state);
1497
1498 WINPR_ASSERT(rdp);
1499 WLog_Print(rdp->log, WLOG_DEBUG, "%s --> %s", rdp_get_state_string(rdp), name);
1500
1501 if (!rdp_set_state(rdp, state))
1502 return FALSE;
1503
1504 switch (state)
1505 {
1506 case CONNECTION_STATE_FINALIZATION_SYNC:
1507 case CONNECTION_STATE_FINALIZATION_COOPERATE:
1508 case CONNECTION_STATE_FINALIZATION_REQUEST_CONTROL:
1509 case CONNECTION_STATE_FINALIZATION_PERSISTENT_KEY_LIST:
1510 case CONNECTION_STATE_FINALIZATION_FONT_LIST:
1511 update_reset_state(rdp->update);
1512 break;
1513
1514 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
1515 {
1516 ActivatedEventArgs activatedEvent = WINPR_C_ARRAY_INIT;
1517 rdpContext* context = rdp->context;
1518 EventArgsInit(&activatedEvent, "libfreerdp");
1519 activatedEvent.firstActivation =
1520 !rdp_finalize_is_flag_set(rdp, FINALIZE_DEACTIVATE_REACTIVATE);
1521 if (PubSub_OnActivated(rdp->pubSub, context, &activatedEvent) < 0)
1522 return FALSE;
1523 }
1524
1525 break;
1526
1527 default:
1528 break;
1529 }
1530
1531 {
1532 ConnectionStateChangeEventArgs stateEvent = WINPR_C_ARRAY_INIT;
1533 rdpContext* context = rdp->context;
1534 EventArgsInit(&stateEvent, "libfreerdp");
1535 stateEvent.state = WINPR_ASSERTING_INT_CAST(int32_t, rdp_get_state(rdp));
1536 stateEvent.active = rdp_is_active_state(rdp);
1537 if (PubSub_OnConnectionStateChange(rdp->pubSub, context, &stateEvent) < 0)
1538 return FALSE;
1539 }
1540
1541 return TRUE;
1542}
1543
1544BOOL rdp_server_accept_nego(rdpRdp* rdp, wStream* s)
1545{
1546 UINT32 SelectedProtocol = 0;
1547 UINT32 RequestedProtocols = 0;
1548 BOOL status = 0;
1549 rdpSettings* settings = nullptr;
1550 rdpNego* nego = nullptr;
1551
1552 WINPR_ASSERT(rdp);
1553 WINPR_ASSERT(s);
1554
1555 settings = rdp->settings;
1556 WINPR_ASSERT(settings);
1557
1558 nego = rdp->nego;
1559 WINPR_ASSERT(nego);
1560
1561 if (!transport_set_blocking_mode(rdp->transport, TRUE))
1562 return FALSE;
1563
1564 if (!nego_read_request(nego, s))
1565 return FALSE;
1566
1567 RequestedProtocols = nego_get_requested_protocols(nego);
1568 WLog_DBG(TAG, "Client Security: RDSTLS:%d NLA:%d EXT:%d TLS:%d RDP:%d",
1569 (RequestedProtocols & PROTOCOL_RDSTLS) ? 1 : 0,
1570 (RequestedProtocols & PROTOCOL_HYBRID) ? 1 : 0,
1571 (RequestedProtocols & PROTOCOL_HYBRID_EX) ? 1 : 0,
1572 (RequestedProtocols & PROTOCOL_SSL) ? 1 : 0,
1573 (RequestedProtocols == PROTOCOL_RDP) ? 1 : 0);
1574 WLog_DBG(TAG,
1575 "Server Security: RDSTLS:%" PRId32 " NLA:%" PRId32 " EXT:%" PRId32 " TLS:%" PRId32
1576 " RDP:%" PRId32 "",
1577 settings->RdstlsSecurity, settings->NlaSecurity, settings->ExtSecurity,
1578 settings->TlsSecurity, settings->RdpSecurity);
1579
1580 if ((settings->RdstlsSecurity) && (RequestedProtocols & PROTOCOL_RDSTLS))
1581 {
1582 SelectedProtocol = PROTOCOL_RDSTLS;
1583 }
1584 else if ((settings->ExtSecurity) && (RequestedProtocols & PROTOCOL_HYBRID_EX))
1585 {
1586 SelectedProtocol = PROTOCOL_HYBRID_EX;
1587 }
1588 else if ((settings->NlaSecurity) && (RequestedProtocols & PROTOCOL_HYBRID))
1589 {
1590 SelectedProtocol = PROTOCOL_HYBRID;
1591 }
1592 else if ((settings->TlsSecurity) && (RequestedProtocols & PROTOCOL_SSL))
1593 {
1594 SelectedProtocol = PROTOCOL_SSL;
1595 }
1596 else if ((settings->RdpSecurity) && (RequestedProtocols == PROTOCOL_RDP))
1597 {
1598 SelectedProtocol = PROTOCOL_RDP;
1599 }
1600 else
1601 {
1602 /*
1603 * when here client and server aren't compatible, we select the right
1604 * error message to return to the client in the nego failure packet
1605 */
1606 SelectedProtocol = PROTOCOL_FAILED_NEGO;
1607
1608 if (settings->RdpSecurity)
1609 {
1610 WLog_ERR(TAG, "server supports only Standard RDP Security");
1611 SelectedProtocol |= SSL_NOT_ALLOWED_BY_SERVER;
1612 }
1613 else
1614 {
1615 if ((settings->ExtSecurity || settings->NlaSecurity) && !settings->TlsSecurity)
1616 {
1617 WLog_WARN(TAG, "server supports only NLA Security");
1618 SelectedProtocol |= HYBRID_REQUIRED_BY_SERVER;
1619 }
1620 else
1621 {
1622 WLog_WARN(TAG, "server supports only a SSL based Security (TLS or NLA)");
1623 SelectedProtocol |= SSL_REQUIRED_BY_SERVER;
1624 }
1625 }
1626
1627 WLog_ERR(TAG, "Protocol security negotiation failure");
1628 }
1629
1630 if (!(SelectedProtocol & PROTOCOL_FAILED_NEGO))
1631 {
1632 WLog_DBG(TAG, "Negotiated Security: RDSTLS:%d NLA:%d EXT:%d TLS:%d RDP:%d",
1633 (SelectedProtocol & PROTOCOL_RDSTLS) ? 1 : 0,
1634 (SelectedProtocol & PROTOCOL_HYBRID) ? 1 : 0,
1635 (SelectedProtocol & PROTOCOL_HYBRID_EX) ? 1 : 0,
1636 (SelectedProtocol & PROTOCOL_SSL) ? 1 : 0,
1637 (SelectedProtocol == PROTOCOL_RDP) ? 1 : 0);
1638 }
1639
1640 if (!nego_set_selected_protocol(nego, SelectedProtocol))
1641 return FALSE;
1642
1643 if (!nego_send_negotiation_response(nego))
1644 return FALSE;
1645
1646 if ((SelectedProtocol & PROTOCOL_FAILED_NEGO) != 0)
1647 {
1648 WLog_ERR(TAG, "Protocol security negotiation failed, disconnecting.");
1649 return FALSE;
1650 }
1651
1652 SelectedProtocol = nego_get_selected_protocol(nego);
1653 status = FALSE;
1654
1655 if (freerdp_settings_get_bool(rdp->settings, FreeRDP_VmConnectMode) &&
1656 SelectedProtocol != PROTOCOL_RDP)
1657 /* When behind a Hyper-V proxy, security != RDP is handled by the host. */
1658 status = TRUE;
1659 else if (SelectedProtocol & PROTOCOL_RDSTLS)
1660 status = transport_accept_rdstls(rdp->transport);
1661 else if (SelectedProtocol & PROTOCOL_HYBRID)
1662 status = transport_accept_nla(rdp->transport, FALSE);
1663 else if (SelectedProtocol & PROTOCOL_HYBRID_EX)
1664 status = transport_accept_nla(rdp->transport, TRUE);
1665 else if (SelectedProtocol & PROTOCOL_SSL)
1666 status = transport_accept_tls(rdp->transport);
1667 else if (SelectedProtocol == PROTOCOL_RDP) /* 0 */
1668 status = transport_accept_rdp(rdp->transport);
1669
1670 if (!status)
1671 return FALSE;
1672
1673 return transport_set_blocking_mode(rdp->transport, FALSE);
1674}
1675
1676static BOOL rdp_update_encryption_level(rdpSettings* settings)
1677{
1678 WINPR_ASSERT(settings);
1679
1680 UINT32 EncryptionLevel = freerdp_settings_get_uint32(settings, FreeRDP_EncryptionLevel);
1681 UINT32 EncryptionMethods = freerdp_settings_get_uint32(settings, FreeRDP_EncryptionMethods);
1682
1693 if (!settings->UseRdpSecurityLayer)
1694 {
1695 /* TLS/NLA is used: disable rdp style encryption */
1696 EncryptionLevel = ENCRYPTION_LEVEL_NONE;
1697 }
1698 else
1699 {
1700 /* verify server encryption level value */
1701 switch (EncryptionLevel)
1702 {
1703 case ENCRYPTION_LEVEL_NONE:
1704 WLog_INFO(TAG, "Active rdp encryption level: NONE");
1705 break;
1706
1707 case ENCRYPTION_LEVEL_FIPS:
1708 WLog_INFO(TAG, "Active rdp encryption level: FIPS Compliant");
1709 break;
1710
1711 case ENCRYPTION_LEVEL_HIGH:
1712 WLog_INFO(TAG, "Active rdp encryption level: HIGH");
1713 break;
1714
1715 case ENCRYPTION_LEVEL_LOW:
1716 WLog_INFO(TAG, "Active rdp encryption level: LOW");
1717 break;
1718
1719 case ENCRYPTION_LEVEL_CLIENT_COMPATIBLE:
1720 WLog_INFO(TAG, "Active rdp encryption level: CLIENT-COMPATIBLE");
1721 break;
1722
1723 default:
1724 WLog_ERR(TAG, "Invalid server encryption level 0x%08" PRIX32 "", EncryptionLevel);
1725 WLog_ERR(TAG, "Switching to encryption level CLIENT-COMPATIBLE");
1726 EncryptionLevel = ENCRYPTION_LEVEL_CLIENT_COMPATIBLE;
1727 }
1728 }
1729
1730 /* choose rdp encryption method based on server level and client methods */
1731 switch (EncryptionLevel)
1732 {
1733 case ENCRYPTION_LEVEL_NONE:
1734 /* The only valid method is NONE in this case */
1735 EncryptionMethods = ENCRYPTION_METHOD_NONE;
1736 break;
1737
1738 case ENCRYPTION_LEVEL_FIPS:
1739
1740 /* The only valid method is FIPS in this case */
1741 if (!(EncryptionMethods & ENCRYPTION_METHOD_FIPS))
1742 {
1743 WLog_WARN(TAG, "client does not support FIPS as required by server configuration");
1744 }
1745
1746 EncryptionMethods = ENCRYPTION_METHOD_FIPS;
1747 break;
1748
1749 case ENCRYPTION_LEVEL_HIGH:
1750
1751 /* Maximum key strength supported by the server must be used (128 bit)*/
1752 if (!(EncryptionMethods & ENCRYPTION_METHOD_128BIT))
1753 {
1754 WLog_WARN(TAG, "client does not support 128 bit encryption method as required by "
1755 "server configuration");
1756 }
1757
1758 EncryptionMethods = ENCRYPTION_METHOD_128BIT;
1759 break;
1760
1761 case ENCRYPTION_LEVEL_LOW:
1762 case ENCRYPTION_LEVEL_CLIENT_COMPATIBLE:
1763
1764 /* Maximum key strength supported by the client must be used */
1765 if (EncryptionMethods & ENCRYPTION_METHOD_128BIT)
1766 EncryptionMethods = ENCRYPTION_METHOD_128BIT;
1767 else if (EncryptionMethods & ENCRYPTION_METHOD_56BIT)
1768 EncryptionMethods = ENCRYPTION_METHOD_56BIT;
1769 else if (EncryptionMethods & ENCRYPTION_METHOD_40BIT)
1770 EncryptionMethods = ENCRYPTION_METHOD_40BIT;
1771 else if (EncryptionMethods & ENCRYPTION_METHOD_FIPS)
1772 EncryptionMethods = ENCRYPTION_METHOD_FIPS;
1773 else
1774 {
1775 WLog_WARN(TAG, "client has not announced any supported encryption methods");
1776 EncryptionMethods = ENCRYPTION_METHOD_128BIT;
1777 }
1778
1779 break;
1780
1781 default:
1782 WLog_ERR(TAG, "internal error: unknown encryption level");
1783 return FALSE;
1784 }
1785
1786 /* log selected encryption method */
1787 if (settings->UseRdpSecurityLayer)
1788 {
1789 switch (EncryptionMethods)
1790 {
1791 case ENCRYPTION_METHOD_NONE:
1792 WLog_INFO(TAG, "Selected rdp encryption method: NONE");
1793 break;
1794
1795 case ENCRYPTION_METHOD_40BIT:
1796 WLog_INFO(TAG, "Selected rdp encryption method: 40BIT");
1797 break;
1798
1799 case ENCRYPTION_METHOD_56BIT:
1800 WLog_INFO(TAG, "Selected rdp encryption method: 56BIT");
1801 break;
1802
1803 case ENCRYPTION_METHOD_128BIT:
1804 WLog_INFO(TAG, "Selected rdp encryption method: 128BIT");
1805 break;
1806
1807 case ENCRYPTION_METHOD_FIPS:
1808 WLog_INFO(TAG, "Selected rdp encryption method: FIPS");
1809 break;
1810
1811 default:
1812 WLog_ERR(TAG, "internal error: unknown encryption method");
1813 return FALSE;
1814 }
1815 }
1816
1817 if (!freerdp_settings_set_uint32(settings, FreeRDP_EncryptionLevel, EncryptionLevel))
1818 return FALSE;
1819 if (!freerdp_settings_set_uint32(settings, FreeRDP_EncryptionMethods, EncryptionMethods))
1820 return FALSE;
1821 return TRUE;
1822}
1823
1824BOOL rdp_server_accept_mcs_connect_initial(rdpRdp* rdp, wStream* s)
1825{
1826 WINPR_ASSERT(rdp);
1827 WINPR_ASSERT(s);
1828
1829 rdpMcs* mcs = rdp->mcs;
1830 WINPR_ASSERT(mcs);
1831
1832 WINPR_ASSERT(rdp_is_reached_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST));
1833 if (!mcs_recv_connect_initial(mcs, s))
1834 return FALSE;
1835 WINPR_ASSERT(rdp->settings);
1836
1837 if (!mcs_server_apply_to_settings(mcs, rdp->settings))
1838 return FALSE;
1839
1840 WLog_DBG(TAG, "Accepted client: %s", rdp->settings->ClientHostname);
1841 WLog_DBG(TAG, "Accepted channels:");
1842
1843 WINPR_ASSERT(mcs->channels || (mcs->channelCount == 0));
1844 for (UINT32 i = 0; i < mcs->channelCount; i++)
1845 {
1846 ADDIN_ARGV* arg = nullptr;
1847 rdpMcsChannel* cur = &mcs->channels[i];
1848 const char* params[1] = { cur->Name };
1849 WLog_DBG(TAG, " %s [%" PRIu16 "]", cur->Name, cur->ChannelId);
1850 arg = freerdp_addin_argv_new(ARRAYSIZE(params), params);
1851 if (!arg)
1852 return FALSE;
1853
1854 if (!freerdp_static_channel_collection_add(rdp->settings, arg))
1855 {
1856 freerdp_addin_argv_free(arg);
1857 return FALSE;
1858 }
1859 }
1860
1861 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
1862 return FALSE;
1863 if (!rdp_update_encryption_level(rdp->settings))
1864 return FALSE;
1865 if (!mcs_send_connect_response(mcs))
1866 return FALSE;
1867 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
1868 return FALSE;
1869
1870 return TRUE;
1871}
1872
1873BOOL rdp_server_accept_mcs_erect_domain_request(rdpRdp* rdp, wStream* s)
1874{
1875 WINPR_ASSERT(rdp);
1876 WINPR_ASSERT(s);
1877 WINPR_ASSERT(rdp_is_reached_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN));
1878
1879 if (!mcs_recv_erect_domain_request(rdp->mcs, s))
1880 return FALSE;
1881
1882 return rdp_server_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER);
1883}
1884
1885static BOOL rdp_server_skip_mcs_channel_join(rdpRdp* rdp)
1886{
1887 WINPR_ASSERT(rdp);
1888
1889 rdpMcs* mcs = rdp->mcs;
1890 WINPR_ASSERT(mcs);
1891
1892 mcs->userChannelJoined = TRUE;
1893 mcs->globalChannelJoined = TRUE;
1894 mcs->messageChannelJoined = TRUE;
1895
1896 for (UINT32 i = 0; i < mcs->channelCount; i++)
1897 {
1898 rdpMcsChannel* cur = &mcs->channels[i];
1899 WLog_DBG(TAG, " %s [%" PRIu16 "]", cur->Name, cur->ChannelId);
1900 cur->joined = TRUE;
1901 }
1902 return rdp_server_transition_to_state(rdp, CONNECTION_STATE_RDP_SECURITY_COMMENCEMENT);
1903}
1904
1905BOOL rdp_server_accept_mcs_attach_user_request(rdpRdp* rdp, wStream* s)
1906{
1907 if (!mcs_recv_attach_user_request(rdp->mcs, s))
1908 return FALSE;
1909
1910 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
1911 return FALSE;
1912
1913 if (!mcs_send_attach_user_confirm(rdp->mcs))
1914 return FALSE;
1915
1916 if (freerdp_settings_get_bool(rdp->settings, FreeRDP_SupportSkipChannelJoin))
1917 return rdp_server_skip_mcs_channel_join(rdp);
1918 return rdp_server_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST);
1919}
1920
1921BOOL rdp_server_accept_mcs_channel_join_request(rdpRdp* rdp, wStream* s)
1922{
1923 UINT16 channelId = 0;
1924 BOOL allJoined = TRUE;
1925 rdpMcs* mcs = nullptr;
1926
1927 WINPR_ASSERT(rdp);
1928 WINPR_ASSERT(rdp->context);
1929
1930 mcs = rdp->mcs;
1931 WINPR_ASSERT(mcs);
1932
1933 WINPR_ASSERT(rdp_is_reached_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST));
1934
1935 if (!mcs_recv_channel_join_request(mcs, rdp->settings, s, &channelId))
1936 return FALSE;
1937
1938 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
1939 return FALSE;
1940
1941 if (!mcs_send_channel_join_confirm(mcs, channelId))
1942 return FALSE;
1943
1944 if (channelId == mcs->userId)
1945 mcs->userChannelJoined = TRUE;
1946 if (channelId == MCS_GLOBAL_CHANNEL_ID)
1947 mcs->globalChannelJoined = TRUE;
1948 if (channelId == mcs->messageChannelId)
1949 mcs->messageChannelJoined = TRUE;
1950
1951 for (UINT32 i = 0; i < mcs->channelCount; i++)
1952 {
1953 rdpMcsChannel* cur = &mcs->channels[i];
1954 WLog_DBG(TAG, " %s [%" PRIu16 "]", cur->Name, cur->ChannelId);
1955 if (cur->ChannelId == channelId)
1956 cur->joined = TRUE;
1957
1958 if (!cur->joined)
1959 allJoined = FALSE;
1960 }
1961
1962 CONNECTION_STATE rc = CONNECTION_STATE_INITIAL;
1963 if ((mcs->userChannelJoined) && (mcs->globalChannelJoined) &&
1964 (mcs->messageChannelId == 0 || mcs->messageChannelJoined) && allJoined)
1965 rc = CONNECTION_STATE_RDP_SECURITY_COMMENCEMENT;
1966 else
1967 rc = CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST;
1968
1969 return rdp_server_transition_to_state(rdp, rc);
1970}
1971
1972static BOOL rdp_server_send_sync(rdpRdp* rdp)
1973{
1974 WINPR_ASSERT(rdp);
1975
1976 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_CLIENT_SYNC))
1977 return FALSE;
1978 if (!rdp_send_server_synchronize_pdu(rdp))
1979 return FALSE;
1980 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE))
1981 return FALSE;
1982 if (!rdp_send_server_control_cooperate_pdu(rdp))
1983 return FALSE;
1984 if (!rdp_finalize_reset_flags(rdp, FALSE))
1985 return FALSE;
1986 return rdp_server_transition_to_state(rdp, CONNECTION_STATE_FINALIZATION_SYNC);
1987}
1988
1989BOOL rdp_server_accept_confirm_active(rdpRdp* rdp, wStream* s, UINT16 pduLength)
1990{
1991 WINPR_ASSERT(rdp);
1992 WINPR_ASSERT(rdp->context);
1993 WINPR_ASSERT(rdp->settings);
1994 WINPR_ASSERT(s);
1995
1996 freerdp_peer* peer = rdp->context->peer;
1997 WINPR_ASSERT(peer);
1998
1999 if (rdp_get_state(rdp) != CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE)
2000 {
2001 if (freerdp_settings_get_bool(rdp->settings, FreeRDP_TransportDumpReplay))
2002 rdp_finalize_set_flag(rdp, FINALIZE_DEACTIVATE_REACTIVATE);
2003 else
2004 {
2005 WLog_WARN(TAG, "Invalid state, got %s, expected %s", rdp_get_state_string(rdp),
2006 rdp_state_string(CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE));
2007 return FALSE;
2008 }
2009 }
2010
2011 if (!rdp_recv_confirm_active(rdp, s, pduLength))
2012 return FALSE;
2013
2014 if (peer->ClientCapabilities && !peer->ClientCapabilities(peer))
2015 {
2016 WLog_WARN(TAG, "peer->ClientCapabilities failed");
2017 return FALSE;
2018 }
2019
2020 if (rdp->settings->SaltedChecksum)
2021 rdp->do_secure_checksum = TRUE;
2022
2023 return rdp_server_send_sync(rdp);
2024}
2025
2026BOOL rdp_server_reactivate(rdpRdp* rdp)
2027{
2028 freerdp_peer* client = nullptr;
2029
2030 if (rdp->context && rdp->context->peer)
2031 client = rdp->context->peer;
2032
2033 if (client)
2034 client->activated = FALSE;
2035
2036 if (!rdp_send_deactivate_all(rdp))
2037 return FALSE;
2038
2039 rdp_finalize_set_flag(rdp, FINALIZE_DEACTIVATE_REACTIVATE);
2040 if (!rdp_server_transition_to_state(rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
2041 return FALSE;
2042
2043 state_run_t rc = rdp_peer_handle_state_demand_active(client);
2044 return state_run_success(rc);
2045}
2046
2047static BOOL rdp_is_active_peer_state(CONNECTION_STATE state)
2048{
2049 /* [MS-RDPBCGR] 1.3.1.1 Connection Sequence states:
2050 * 'upon receipt of the Font List PDU the server can start sending graphics
2051 * output to the client'
2052 */
2053 switch (state)
2054 {
2055 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2056 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2057 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2058 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2059 case CONNECTION_STATE_ACTIVE:
2060 return TRUE;
2061 default:
2062 return FALSE;
2063 }
2064}
2065
2066static BOOL rdp_is_active_client_state(CONNECTION_STATE state)
2067{
2068 /* [MS-RDPBCGR] 1.3.1.1 Connection Sequence states:
2069 * 'Once the client has sent the Confirm Active PDU, it can start sending
2070 * mouse and keyboard input to the server'
2071 */
2072 switch (state)
2073 {
2074 case CONNECTION_STATE_FINALIZATION_SYNC:
2075 case CONNECTION_STATE_FINALIZATION_COOPERATE:
2076 case CONNECTION_STATE_FINALIZATION_REQUEST_CONTROL:
2077 case CONNECTION_STATE_FINALIZATION_PERSISTENT_KEY_LIST:
2078 case CONNECTION_STATE_FINALIZATION_FONT_LIST:
2079 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2080 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2081 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2082 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2083 case CONNECTION_STATE_ACTIVE:
2084 return TRUE;
2085 default:
2086 return FALSE;
2087 }
2088}
2089
2090BOOL rdp_has_reached_state_impl(const rdpRdp* rdp, CONNECTION_STATE state, const char* file,
2091 size_t line, const char* fkt)
2092{
2093 WINPR_ASSERT(rdp);
2094 const CONNECTION_STATE cur = rdp_get_state(rdp);
2095 if (cur < state)
2096 {
2097 if (WLog_IsLevelActive(rdp->log, WLOG_WARN))
2098 WLog_PrintTextMessage(rdp->log, WLOG_WARN, line, file, fkt,
2099 "State %s (or higher) requested, but %s found. Aborting.",
2100 rdp_state_string(state), rdp_state_string(cur));
2101 return FALSE;
2102 }
2103 return TRUE;
2104}
2105
2106BOOL rdp_is_reached_state_impl(const rdpRdp* rdp, CONNECTION_STATE state, const char* file,
2107 size_t line, const char* fkt)
2108{
2109 WINPR_ASSERT(rdp);
2110 const CONNECTION_STATE cur = rdp_get_state(rdp);
2111 if (cur != state)
2112 {
2113 if (WLog_IsLevelActive(rdp->log, WLOG_WARN))
2114 WLog_PrintTextMessage(rdp->log, WLOG_WARN, line, file, fkt,
2115 "State %s requested, but %s found. Aborting.",
2116 rdp_state_string(state), rdp_state_string(cur));
2117 return FALSE;
2118 }
2119 return TRUE;
2120}
2121
2122BOOL rdp_is_active_state(const rdpRdp* rdp)
2123{
2124 WINPR_ASSERT(rdp);
2125 WINPR_ASSERT(rdp->context);
2126
2127 const CONNECTION_STATE state = rdp_get_state(rdp);
2128 if (freerdp_settings_get_bool(rdp->context->settings, FreeRDP_ServerMode))
2129 return rdp_is_active_peer_state(state);
2130 else
2131 return rdp_is_active_client_state(state);
2132}
2133
2134BOOL rdp_server_transition_to_state(rdpRdp* rdp, CONNECTION_STATE state)
2135{
2136 BOOL status = FALSE;
2137 freerdp_peer* client = nullptr;
2138 const CONNECTION_STATE cstate = rdp_get_state(rdp);
2139
2140 if (cstate >= CONNECTION_STATE_RDP_SECURITY_COMMENCEMENT)
2141 {
2142 WINPR_ASSERT(rdp->context);
2143 client = rdp->context->peer;
2144 }
2145
2146 if (!rdp_is_active_peer_state(cstate))
2147 {
2148 if (client)
2149 client->activated = FALSE;
2150 }
2151
2152 WLog_Print(rdp->log, WLOG_DEBUG, "%s --> %s", rdp_get_state_string(rdp),
2153 rdp_state_string(state));
2154 if (!rdp_set_state(rdp, state))
2155 goto fail;
2156
2157 status = TRUE;
2158fail:
2159 return status;
2160}
2161
2162const char* rdp_client_connection_state_string(UINT state)
2163{
2164 switch (state)
2165 {
2166 case CLIENT_STATE_INITIAL:
2167 return "CLIENT_STATE_INITIAL";
2168 case CLIENT_STATE_PRECONNECT_PASSED:
2169 return "CLIENT_STATE_PRECONNECT_PASSED";
2170 case CLIENT_STATE_POSTCONNECT_PASSED:
2171 return "CLIENT_STATE_POSTCONNECT_PASSED";
2172 default:
2173 return "UNKNOWN";
2174 }
2175}
2176
2177const char* rdp_state_string(CONNECTION_STATE state)
2178{
2179 switch (state)
2180 {
2181 case CONNECTION_STATE_INITIAL:
2182 return "CONNECTION_STATE_INITIAL";
2183 case CONNECTION_STATE_NEGO:
2184 return "CONNECTION_STATE_NEGO";
2185 case CONNECTION_STATE_NLA:
2186 return "CONNECTION_STATE_NLA";
2187 case CONNECTION_STATE_AAD:
2188 return "CONNECTION_STATE_AAD";
2189 case CONNECTION_STATE_MCS_CREATE_REQUEST:
2190 return "CONNECTION_STATE_MCS_CREATE_REQUEST";
2191 case CONNECTION_STATE_MCS_CREATE_RESPONSE:
2192 return "CONNECTION_STATE_MCS_CREATE_RESPONSE";
2193 case CONNECTION_STATE_MCS_ERECT_DOMAIN:
2194 return "CONNECTION_STATE_MCS_ERECT_DOMAIN";
2195 case CONNECTION_STATE_MCS_ATTACH_USER:
2196 return "CONNECTION_STATE_MCS_ATTACH_USER";
2197 case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
2198 return "CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM";
2199 case CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST:
2200 return "CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST";
2201 case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
2202 return "CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE";
2203 case CONNECTION_STATE_RDP_SECURITY_COMMENCEMENT:
2204 return "CONNECTION_STATE_RDP_SECURITY_COMMENCEMENT";
2205 case CONNECTION_STATE_SECURE_SETTINGS_EXCHANGE:
2206 return "CONNECTION_STATE_SECURE_SETTINGS_EXCHANGE";
2207 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
2208 return "CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST";
2209 case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_RESPONSE:
2210 return "CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_RESPONSE";
2211 case CONNECTION_STATE_LICENSING:
2212 return "CONNECTION_STATE_LICENSING";
2213 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
2214 return "CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST";
2215 case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_RESPONSE:
2216 return "CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_RESPONSE";
2217 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
2218 return "CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE";
2219 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
2220 return "CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT";
2221 case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
2222 return "CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE";
2223 case CONNECTION_STATE_FINALIZATION_SYNC:
2224 return "CONNECTION_STATE_FINALIZATION_SYNC";
2225 case CONNECTION_STATE_FINALIZATION_COOPERATE:
2226 return "CONNECTION_STATE_FINALIZATION_COOPERATE";
2227 case CONNECTION_STATE_FINALIZATION_REQUEST_CONTROL:
2228 return "CONNECTION_STATE_FINALIZATION_REQUEST_CONTROL";
2229 case CONNECTION_STATE_FINALIZATION_PERSISTENT_KEY_LIST:
2230 return "CONNECTION_STATE_FINALIZATION_PERSISTENT_KEY_LIST";
2231 case CONNECTION_STATE_FINALIZATION_FONT_LIST:
2232 return "CONNECTION_STATE_FINALIZATION_FONT_LIST";
2233 case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
2234 return "CONNECTION_STATE_FINALIZATION_CLIENT_SYNC";
2235 case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
2236 return "CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE";
2237 case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
2238 return "CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL";
2239 case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
2240 return "CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP";
2241 case CONNECTION_STATE_ACTIVE:
2242 return "CONNECTION_STATE_ACTIVE";
2243 default:
2244 return "UNKNOWN";
2245 }
2246}
2247
2248CONNECTION_STATE rdp_get_state(const rdpRdp* rdp)
2249{
2250 WINPR_ASSERT(rdp);
2251 return rdp->state;
2252}
2253
2254BOOL rdp_set_state(rdpRdp* rdp, CONNECTION_STATE state)
2255{
2256 WINPR_ASSERT(rdp);
2257
2258 rdpContext* context = rdp->context;
2259 WINPR_ASSERT(context);
2260
2261 if (context->pubSub)
2262 {
2263 StateChangedEventArgs e = WINPR_C_ARRAY_INIT;
2264 EventArgsInit(&e, "freerdp");
2265 e.oldState = rdp->state;
2266 e.newState = state;
2267
2268 const int rc = PubSub_OnStateChanged(context->pubSub, context, &e);
2269 if (rc < 0)
2270 WLog_WARN(TAG, "PubSub_OnStateChanged() failed");
2271 }
2272 rdp->state = state;
2273 return TRUE;
2274}
2275
2276const char* rdp_get_state_string(const rdpRdp* rdp)
2277{
2278 CONNECTION_STATE state = rdp_get_state(rdp);
2279 return rdp_state_string(state);
2280}
2281
2282BOOL rdp_channels_from_mcs(rdpSettings* settings, const rdpRdp* rdp)
2283{
2284 const rdpMcs* mcs = nullptr;
2285
2286 WINPR_ASSERT(rdp);
2287
2288 mcs = rdp->mcs;
2289 WINPR_ASSERT(mcs);
2290
2291 if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ChannelDefArray, nullptr,
2292 CHANNEL_MAX_COUNT))
2293 return FALSE;
2294
2295 for (UINT32 x = 0; x < mcs->channelCount; x++)
2296 {
2297 const rdpMcsChannel* mchannel = &mcs->channels[x];
2298 CHANNEL_DEF cur = WINPR_C_ARRAY_INIT;
2299
2300 memcpy(cur.name, mchannel->Name, sizeof(cur.name));
2301 cur.options = mchannel->options;
2302 if (!freerdp_settings_set_pointer_array(settings, FreeRDP_ChannelDefArray, x, &cur))
2303 return FALSE;
2304 }
2305
2306 return freerdp_settings_set_uint32(settings, FreeRDP_ChannelCount, mcs->channelCount);
2307}
2308
2309/* Here we are in client state CONFIRM_ACTIVE.
2310 *
2311 * This means:
2312 * 1. send the CONFIRM_ACTIVE PDU to the server
2313 * 2. register callbacks, the server can now start sending stuff
2314 */
2315state_run_t rdp_client_connect_confirm_active(rdpRdp* rdp, WINPR_ATTR_UNUSED wStream* s)
2316{
2317 WINPR_ASSERT(rdp);
2318 WINPR_ASSERT(rdp->settings);
2319 WINPR_ASSERT(s);
2320
2321 const UINT32 width = rdp->settings->DesktopWidth;
2322 const UINT32 height = rdp->settings->DesktopHeight;
2323
2324 if (!rdp_send_confirm_active(rdp))
2325 return STATE_RUN_FAILED;
2326
2327 if (!input_register_client_callbacks(rdp->input))
2328 {
2329 WLog_ERR(TAG, "error registering client callbacks");
2330 return STATE_RUN_FAILED;
2331 }
2332
2337 const BOOL deactivate_reactivate =
2338 rdp->was_deactivated && ((rdp->deactivated_width != rdp->settings->DesktopWidth) ||
2339 (rdp->deactivated_height != rdp->settings->DesktopHeight));
2340 const BOOL resolution_change =
2341 ((width != rdp->settings->DesktopWidth) || (height != rdp->settings->DesktopHeight));
2342 if (deactivate_reactivate || resolution_change)
2343 {
2344 BOOL status = TRUE;
2345 WLog_DBG(TAG, "new size %" PRIu32 "x%" PRIu32, rdp->settings->DesktopWidth,
2346 rdp->settings->DesktopHeight);
2347
2348 rdp_update_internal* up = update_cast(rdp->update);
2349 up->stats.base[RDP_STATS_RESIZE]++;
2350 IFCALLRET(rdp->update->DesktopResize, status, rdp->update->context);
2351
2352 if (!status)
2353 {
2354 WLog_ERR(TAG, "client desktop resize callback failed");
2355 return STATE_RUN_FAILED;
2356 }
2357
2358 /* The codecs for bitmap updates and surface bits were sized for the
2359 * old desktop when connecting. The GFX codecs are reset by the GFX
2360 * channel on ResetGraphics instead. */
2361 rdpCodecs* codecs = rdp->context->codecs;
2362 if (codecs)
2363 {
2364 const UINT32 flags = FREERDP_CODEC_INTERLEAVED | FREERDP_CODEC_PLANAR |
2365 FREERDP_CODEC_NSCODEC | FREERDP_CODEC_REMOTEFX;
2366 if (!freerdp_client_codecs_reset(codecs, flags, rdp->settings->DesktopWidth,
2367 rdp->settings->DesktopHeight))
2368 {
2369 WLog_ERR(TAG, "failed to reset codecs to the new desktop size");
2370 return STATE_RUN_FAILED;
2371 }
2372 }
2373 }
2374
2375 WINPR_ASSERT(rdp->context);
2376 if (freerdp_shall_disconnect_context(rdp->context))
2377 return STATE_RUN_SUCCESS;
2378
2379 if (!cache_resize(rdp->context))
2380 return STATE_RUN_FAILED;
2381
2382 state_run_t status = rdp_client_connect_finalize(rdp);
2383 if (state_run_success(status) &&
2384 freerdp_settings_get_bool(rdp->settings, FreeRDP_SupportMonitorLayoutPdu))
2385 {
2386 if (!rdp_client_transition_to_state(rdp,
2387 CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT))
2388 status = STATE_RUN_FAILED;
2389 }
2390 if (!rdp_finalize_reset_flags(rdp, FALSE))
2391 status = STATE_RUN_FAILED;
2392 return status;
2393}
2394
2395BOOL rdp_handle_optional_rdp_decryption(rdpRdp* rdp, wStream* s, UINT16* length,
2396 UINT16* pSecurityFlags)
2397{
2398 BOOL rc = FALSE;
2399 WINPR_ASSERT(rdp);
2400 WINPR_ASSERT(rdp->settings);
2401
2402 UINT16 securityFlags = 0;
2403 if (rdp->settings->UseRdpSecurityLayer)
2404 {
2405 if (!rdp_read_security_header(rdp, s, &securityFlags, length))
2406 goto fail;
2407
2408 if (securityFlags & SEC_ENCRYPT)
2409 {
2410 if (!rdp_decrypt(rdp, s, length, securityFlags))
2411 goto fail;
2412 }
2413 }
2414
2415 rc = TRUE;
2416
2417fail:
2418 if (pSecurityFlags)
2419 *pSecurityFlags = securityFlags;
2420 return rc;
2421}
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_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL val)
Sets a BOOL settings value.
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 UINT32 freerdp_settings_get_codecs_flags(const rdpSettings *settings)
helper function to get a mask of supported codec flags.
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 BOOL freerdp_settings_set_pointer_len(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, const void *data, size_t len)
Set a pointer to value data.
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.