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