1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "remoting/host/client_session.h"
#include <algorithm>
#include <cstdint>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <variant>
#include <vector>
#include "base/check.h"
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/sequence_checker.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "remoting/base/capabilities.h"
#include "remoting/base/constants.h"
#include "remoting/base/errors.h"
#include "remoting/base/local_session_policies_provider.h"
#include "remoting/base/logging.h"
#include "remoting/base/session_options.h"
#include "remoting/base/session_policies.h"
#include "remoting/host/action_executor.h"
#include "remoting/host/action_message_handler.h"
#include "remoting/host/active_display_monitor.h"
#include "remoting/host/audio_capturer.h"
#include "remoting/host/base/desktop_environment_options.h"
#include "remoting/host/base/screen_controls.h"
#include "remoting/host/base/screen_resolution.h"
#include "remoting/host/desktop_display_info.h"
#include "remoting/host/desktop_display_info_monitor.h"
#include "remoting/host/desktop_environment.h"
#include "remoting/host/file_transfer/file_transfer_message_handler.h"
#include "remoting/host/file_transfer/rtc_log_file_operations.h"
#include "remoting/host/host_extension.h"
#include "remoting/host/host_extension_session.h"
#include "remoting/host/host_extension_session_manager.h"
#include "remoting/host/input_injector.h"
#include "remoting/host/keyboard_layout_monitor.h"
#include "remoting/host/mojom/chromoting_host_services.mojom.h"
#include "remoting/host/mojom/remote_url_opener.mojom.h"
#include "remoting/host/mojom/webauthn_proxy.mojom.h"
#include "remoting/host/mouse_shape_pump.h"
#include "remoting/host/remote_open_url/remote_open_url_constants.h"
#include "remoting/host/remote_open_url/remote_open_url_message_handler.h"
#include "remoting/host/remote_open_url/remote_open_url_util.h"
#include "remoting/host/remote_open_url/url_forwarder_configurator.h"
#include "remoting/host/remote_open_url/url_forwarder_control_message_handler.h"
#include "remoting/host/security_key/security_key_extension.h"
#include "remoting/host/security_key/security_key_extension_session.h"
#include "remoting/host/webauthn/remote_webauthn_constants.h"
#include "remoting/host/webauthn/remote_webauthn_message_handler.h"
#include "remoting/host/webauthn/remote_webauthn_state_change_notifier.h"
#include "remoting/proto/control.pb.h"
#include "remoting/proto/event.pb.h"
#include "remoting/protocol/audio_stream.h"
#include "remoting/protocol/capability_names.h"
#include "remoting/protocol/client_stub.h"
#include "remoting/protocol/clipboard_thread_proxy.h"
#include "remoting/protocol/connection_to_client.h"
#include "remoting/protocol/data_channel_manager.h"
#include "remoting/protocol/display_size.h"
#include "remoting/protocol/errors.h"
#include "remoting/protocol/input_event_timestamps.h"
#include "remoting/protocol/keyboard_layout_stub.h"
#include "remoting/protocol/message_pipe.h"
#include "remoting/protocol/network_settings.h"
#include "remoting/protocol/observing_input_filter.h"
#include "remoting/protocol/pairing_registry.h"
#include "remoting/protocol/peer_connection_controls.h"
#include "remoting/protocol/session.h"
#include "remoting/protocol/session_config.h"
#include "remoting/protocol/transport.h"
#include "remoting/protocol/video_frame_pump.h"
#include "remoting/protocol/webrtc_video_stream.h"
#include "third_party/webrtc/modules/desktop_capture/desktop_capture_types.h"
#include "third_party/webrtc/modules/desktop_capture/desktop_geometry.h"
#include "third_party/webrtc/modules/desktop_capture/mouse_cursor.h"
#include "ui/events/types/event_type.h"
namespace {
constexpr char kRtcLogTransferDataChannelPrefix[] = "rtc-log-transfer-";
constexpr base::TimeDelta kDefaultBoostCaptureInterval = base::Milliseconds(5);
constexpr base::TimeDelta kDefaultBoostDuration = base::Milliseconds(50);
} // namespace
namespace remoting {
using protocol::ActionRequest;
ClientSession::ClientSession(
EventHandler* event_handler,
std::unique_ptr<protocol::ConnectionToClient> connection,
DesktopEnvironmentFactory* desktop_environment_factory,
const DesktopEnvironmentOptions& desktop_environment_options,
scoped_refptr<protocol::PairingRegistry> pairing_registry,
const std::vector<raw_ptr<HostExtension, VectorExperimental>>& extensions,
const LocalSessionPoliciesProvider* local_session_policies_provider)
: event_handler_(event_handler),
desktop_environment_factory_(desktop_environment_factory),
desktop_environment_options_(desktop_environment_options),
remote_input_filter_(&input_tracker_),
fractional_input_filter_(&remote_input_filter_),
mouse_clamping_filter_(&fractional_input_filter_),
observing_input_filter_(&mouse_clamping_filter_),
desktop_and_cursor_composer_notifier_(&observing_input_filter_, this),
disable_input_filter_(&desktop_and_cursor_composer_notifier_),
host_clipboard_filter_(clipboard_echo_filter_.host_filter()),
client_clipboard_filter_(clipboard_echo_filter_.client_filter()),
client_clipboard_factory_(&client_clipboard_filter_),
pairing_registry_(pairing_registry),
connection_(std::move(connection)),
client_jid_(connection_->session()->jid()),
local_session_policies_provider_(local_session_policies_provider) {
connection_->session()->AddPlugin(&host_experiment_session_plugin_);
connection_->SetEventHandler(this);
// Create a manager for the configured extensions, if any.
extension_manager_ =
std::make_unique<HostExtensionSessionManager>(extensions, this);
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_CHROMEOS)
// LocalMouseInputMonitorWin and LocalPointerInputMonitorChromeos filter out
// an echo of the injected input before it reaches |remote_input_filter_|.
remote_input_filter_.SetExpectLocalEcho(false);
#endif // BUILDFLAG(IS_WIN) || BUILDFLAG(IS_CHROMEOS)
}
ClientSession::~ClientSession() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!audio_stream_);
DCHECK(!desktop_environment_);
DCHECK(!input_injector_);
DCHECK(!screen_controls_);
DCHECK(video_streams_.empty());
}
void ClientSession::NotifyClientResolution(
const protocol::ClientResolution& resolution) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(resolution.width_pixels() >= 0 && resolution.height_pixels() >= 0);
VLOG(1) << "Received ClientResolution (width=" << resolution.width_pixels()
<< ", height=" << resolution.height_pixels()
<< ", x_dpi=" << resolution.x_dpi()
<< ", y_dpi=" << resolution.y_dpi() << ")";
if (!screen_controls_) {
return;
}
webrtc::DesktopSize client_size(resolution.width_pixels(),
resolution.height_pixels());
if (connection_->session()->config().protocol() ==
protocol::SessionConfig::Protocol::WEBRTC) {
// When using WebRTC round down the dimensions to multiple of 2. Otherwise
// the dimensions will be rounded on the receiver, which will cause blurring
// due to scaling. The resulting size is still close to the client size and
// will fit on the client's screen without scaling.
// TODO(sergeyu): Make WebRTC handle odd dimensions properly.
// crbug.com/636071
client_size.set(client_size.width() & (~1), client_size.height() & (~1));
}
// TODO(joedow): Determine if other platforms support desktop scaling.
webrtc::DesktopVector dpi_vector{kDefaultDpi, kDefaultDpi};
#if BUILDFLAG(IS_WIN)
// Matching the client DPI is only supported on Windows when curtained.
if (effective_policies_.curtain_required.value_or(false)) {
dpi_vector.set(resolution.x_dpi(), resolution.y_dpi());
}
#elif BUILDFLAG(IS_LINUX)
dpi_vector.set(resolution.x_dpi(), resolution.y_dpi());
#endif
// Try to match the client's resolution.
ScreenResolution screen_resolution(client_size, dpi_vector);
std::optional<webrtc::ScreenId> screen_id;
if (resolution.has_screen_id()) {
screen_id = resolution.screen_id();
}
screen_controls_->SetScreenResolution(screen_resolution, screen_id);
}
void ClientSession::ControlVideo(const protocol::VideoControl& video_control) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Note that |video_stream_| may be null, depending upon whether
// extensions choose to wrap or "steal" the video capturer or encoder.
if (video_control.has_enable()) {
VLOG(1) << "Received VideoControl (enable=" << video_control.enable()
<< ")";
pause_video_ = !video_control.enable();
for (const auto& [_, video_stream] : video_streams_) {
video_stream->Pause(pause_video_);
}
}
if (video_control.has_target_framerate()) {
target_framerate_ = video_control.target_framerate();
LOG(INFO) << "Received target framerate: " << target_framerate_;
for (const auto& [_, video_stream] : video_streams_) {
video_stream->SetTargetFramerate(target_framerate_);
}
if (mouse_shape_pump_) {
mouse_shape_pump_->SetCursorCaptureInterval(
base::Hertz(target_framerate_));
}
}
if (video_control.has_framerate_boost()) {
auto framerate_boost = video_control.framerate_boost();
DCHECK(framerate_boost.has_enabled());
if (!framerate_boost.enabled()) {
LOG(INFO) << "FramerateBoost disabled.";
observing_input_filter_.ClearInputEventCallback();
} else {
base::TimeDelta capture_interval =
framerate_boost.has_capture_interval_ms()
? std::clamp(
base::Milliseconds(framerate_boost.capture_interval_ms()),
base::Milliseconds(1), base::Milliseconds(1000))
: kDefaultBoostCaptureInterval;
base::TimeDelta boost_duration =
framerate_boost.has_boost_duration_ms()
? std::clamp(
base::Milliseconds(framerate_boost.boost_duration_ms()),
base::Milliseconds(1), base::Milliseconds(1000))
: kDefaultBoostDuration;
LOG(INFO) << "FramerateBoost enabled (interval: "
<< capture_interval.InMilliseconds()
<< "ms, duration: " << boost_duration.InMilliseconds() << "ms)";
// Unretained is sound as this instance owns |observing_input_filter_|.
observing_input_filter_.SetInputEventCallback(base::BindRepeating(
&ClientSession::BoostFramerateOnInput, base::Unretained(this),
capture_interval, boost_duration, base::OwnedRef(false)));
}
}
}
void ClientSession::ControlAudio(const protocol::AudioControl& audio_control) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (audio_control.has_enable()) {
VLOG(1) << "Received AudioControl (enable=" << audio_control.enable()
<< ")";
if (audio_stream_) {
audio_stream_->Pause(!audio_control.enable());
}
}
}
void ClientSession::SetCapabilities(
const protocol::Capabilities& capabilities) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(
base::BindOnce(&ClientSession::SetCapabilities,
weak_factory_.GetWeakPtr(), capabilities));
return;
}
// Ignore all the messages but the 1st one.
if (client_capabilities_) {
LOG(WARNING) << "protocol::Capabilities has been received already.";
return;
}
// Compute the set of capabilities supported by both client and host.
client_capabilities_ = std::make_unique<std::string>();
if (capabilities.has_capabilities()) {
*client_capabilities_ = capabilities.capabilities();
}
capabilities_ =
IntersectCapabilities(*client_capabilities_, host_capabilities_);
extension_manager_->OnNegotiatedCapabilities(connection_->client_stub(),
capabilities_);
if (HasCapability(capabilities_, protocol::kFileTransferCapability)) {
data_channel_manager_.RegisterCreateHandlerCallback(
kFileTransferDataChannelPrefix,
base::BindRepeating(&ClientSession::CreateFileTransferMessageHandler,
base::Unretained(this)));
}
if (HasCapability(capabilities_, protocol::kRtcLogTransferCapability)) {
data_channel_manager_.RegisterCreateHandlerCallback(
kRtcLogTransferDataChannelPrefix,
base::BindRepeating(&ClientSession::CreateRtcLogTransferMessageHandler,
base::Unretained(this)));
}
if (HasCapability(capabilities_, protocol::kRemoteOpenUrlCapability)) {
data_channel_manager_.RegisterCreateHandlerCallback(
kRemoteOpenUrlDataChannelName,
base::BindRepeating(&ClientSession::CreateRemoteOpenUrlMessageHandler,
base::Unretained(this)));
data_channel_manager_.RegisterCreateHandlerCallback(
UrlForwarderControlMessageHandler::kDataChannelName,
base::BindRepeating(
&ClientSession::CreateUrlForwarderControlMessageHandler,
base::Unretained(this)));
}
if (HasCapability(capabilities_, protocol::kRemoteWebAuthnCapability)) {
data_channel_manager_.RegisterCreateHandlerCallback(
kRemoteWebAuthnDataChannelName,
base::BindRepeating(&ClientSession::CreateRemoteWebAuthnMessageHandler,
base::Unretained(this)));
}
std::vector<ActionRequest::Action> supported_actions;
if (HasCapability(capabilities_, protocol::kSendAttentionSequenceAction)) {
supported_actions.push_back(ActionRequest::SEND_ATTENTION_SEQUENCE);
}
if (HasCapability(capabilities_, protocol::kLockWorkstationAction)) {
supported_actions.push_back(ActionRequest::LOCK_WORKSTATION);
}
if (supported_actions.size() > 0) {
// Register the action message handler.
data_channel_manager_.RegisterCreateHandlerCallback(
kActionDataChannelPrefix,
base::BindRepeating(&ClientSession::CreateActionMessageHandler,
base::Unretained(this),
std::move(supported_actions)));
}
// TODO(crbug.com/40225767): Remove this code when legacy VideoLayout messages
// are fully deprecated and no longer sent. We already start the monitor in
// OnConnectionChannelsConnected() so we don't need this block if the legacy
// message in multi-stream mode is no longer required.
if (HasCapability(capabilities_, protocol::kMultiStreamCapability)) {
if (desktop_display_info_.NumDisplays() != 0) {
// If display info is already known, create the initial video streams.
// Otherwise they will be created on the next displays-changed message.
CreatePerMonitorVideoStreams();
}
// Query the OS for the display-info on a timer, instead of doing it after
// every captured frame from multiple capturers.
auto* monitor = desktop_environment_->GetDisplayInfoMonitor();
if (monitor) {
// In the multi-process case, |monitor| will be null and this will be
// handled instead by DesktopSessionAgent.
monitor->Start();
}
active_display_monitor_ =
desktop_environment_->CreateActiveDisplayMonitor(base::BindRepeating(
&ClientSession::OnActiveDisplayChanged, base::Unretained(this)));
// Re-send the extended layout information so the client has information
// needed to identify each stream.
if (desktop_display_info_.NumDisplays() != 0) {
OnDesktopDisplayChanged(desktop_display_info_.GetVideoLayoutProto());
}
}
data_channel_manager_.OnRegistrationComplete();
VLOG(1) << "Client capabilities: " << *client_capabilities_;
desktop_environment_->SetCapabilities(capabilities_);
}
void ClientSession::RequestPairing(
const protocol::PairingRequest& pairing_request) {
if (pairing_registry_.get() && pairing_request.has_client_name()) {
protocol::PairingRegistry::Pairing pairing =
pairing_registry_->CreatePairing(pairing_request.client_name());
protocol::PairingResponse pairing_response;
pairing_response.set_client_id(pairing.client_id());
pairing_response.set_shared_secret(pairing.shared_secret());
connection_->client_stub()->SetPairingResponse(pairing_response);
}
}
void ClientSession::DeliverClientMessage(
const protocol::ExtensionMessage& message) {
if (message.has_type()) {
if (extension_manager_->OnExtensionMessage(message)) {
return;
}
DLOG(INFO) << "Unexpected message received: " << message.type() << ": "
<< message.data();
}
}
void ClientSession::SelectDesktopDisplay(
const protocol::SelectDesktopDisplayRequest& select_display) {
LOG(INFO) << "SelectDesktopDisplay "
<< "'" << select_display.id() << "'";
if (HasCapability(capabilities_, protocol::kMultiStreamCapability)) {
// TODO(lambroslambrou): Close the connection with a protocol error,
// once we are sure the client will not send this request after
// multi-stream has been negotiated.
LOG(ERROR) << "SelectDesktopDisplayRequest received after multi-stream is "
"enabled.";
return;
}
// Parse the string with the selected display. Note that this request's |id|
// field is not a monitor ID, but an index into the list of displays (or the
// special string "all"),
int new_index = webrtc::kInvalidScreenId;
if (select_display.id() == "all") {
new_index = webrtc::kFullDesktopScreenId;
} else {
if (!base::StringToInt(select_display.id().c_str(), &new_index)) {
LOG(ERROR) << " Unable to parse display index "
<< "'" << select_display.id() << "'";
new_index = webrtc::kInvalidScreenId;
}
if (!desktop_display_info_.GetDisplayInfo(new_index)) {
LOG(ERROR) << " Invalid display index "
<< "'" << select_display.id() << "'";
new_index = webrtc::kInvalidScreenId;
}
}
// Don't allow requests for fullscreen if not supported by the current
// display configuration.
if (!can_capture_full_desktop_ && new_index == webrtc::kFullDesktopScreenId) {
LOG(ERROR) << " Full desktop not supported";
new_index = webrtc::kInvalidScreenId;
}
// Fall back to default capture config if invalid request.
if (new_index == webrtc::kInvalidScreenId) {
LOG(ERROR) << " Invalid display specification, falling back to default";
new_index = can_capture_full_desktop_ ? webrtc::kFullDesktopScreenId : 0;
}
if (selected_display_index_ == new_index) {
LOG(INFO) << " Display " << new_index << " is already selected. Ignoring";
return;
}
const DisplayGeometry* oldGeo =
desktop_display_info_.GetDisplayInfo(selected_display_index_);
const DisplayGeometry* newGeo =
desktop_display_info_.GetDisplayInfo(new_index);
auto& stream = video_streams_.begin()->second;
if (newGeo) {
stream->SelectSource(newGeo->id);
} else if (new_index == webrtc::kFullDesktopScreenId) {
stream->SelectSource(webrtc::kFullDesktopScreenId);
} else {
// This corner-case might occur if fullscreen capture is not supported, and
// the fallback default of 0 is not a valid index (the list is empty).
LOG(ERROR) << " Display geometry not found for index " << new_index;
return;
}
selected_display_index_ = new_index;
// If the old and new displays are the different sizes, then SelectSource()
// will trigger an OnVideoSizeChanged() message which will update the mouse
// filters.
// However, if the old and new displays are the exact same size, then the
// video size message will not be generated (because the size of the video
// has not changed). But we still need to update the mouse clamping filter
// with the new display origin, so we update that directly.
if (oldGeo != nullptr && newGeo != nullptr) {
if (oldGeo->width == newGeo->width && oldGeo->height == newGeo->height) {
UpdateMouseClampingFilterOffset();
UpdateFractionalFilterFallback();
}
}
}
void ClientSession::ControlPeerConnection(
const protocol::PeerConnectionParameters& parameters) {
if (!connection_->peer_connection_controls()) {
return;
}
std::optional<int> min_bitrate_bps;
std::optional<int> max_bitrate_bps;
bool set_preferred_bitrates = false;
if (parameters.has_preferred_min_bitrate_bps()) {
min_bitrate_bps = parameters.preferred_min_bitrate_bps();
set_preferred_bitrates = true;
}
if (parameters.has_preferred_max_bitrate_bps()) {
max_bitrate_bps = parameters.preferred_max_bitrate_bps();
set_preferred_bitrates = true;
}
if (set_preferred_bitrates) {
connection_->peer_connection_controls()->SetPreferredBitrates(
min_bitrate_bps, max_bitrate_bps);
}
if (parameters.request_ice_restart()) {
connection_->peer_connection_controls()->RequestIceRestart();
}
if (parameters.request_sdp_restart()) {
connection_->peer_connection_controls()->RequestSdpRestart();
}
}
void ClientSession::SetVideoLayout(const protocol::VideoLayout& video_layout) {
screen_controls_->SetVideoLayout(video_layout);
}
void ClientSession::OnConnectionAuthenticating() {
event_handler_->OnSessionAuthenticating(this);
}
void ClientSession::OnConnectionAuthenticated(
const SessionPolicies* session_policies) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!audio_stream_);
DCHECK(!desktop_environment_);
DCHECK(!input_injector_);
DCHECK(!screen_controls_);
DCHECK(video_streams_.empty());
is_authenticated_ = true;
desktop_display_info_.Reset();
if (session_policies) {
effective_policies_ = *session_policies;
HOST_LOG << "Connection authenticated with remote session policies: "
<< effective_policies_;
} else {
effective_policies_ =
local_session_policies_provider_->get_local_policies();
local_session_policy_update_subscription_ =
local_session_policies_provider_->AddLocalPoliciesChangedCallback(
base::BindRepeating(&ClientSession::OnLocalSessionPoliciesChanged,
weak_factory_.GetWeakPtr()));
HOST_LOG << "Connection authenticated with local session policies: "
<< effective_policies_;
}
std::optional<ErrorCode> validation_result =
event_handler_->OnSessionPoliciesReceived(effective_policies_);
if (validation_result.has_value()) {
// TODO: crbug.com/382334458 - Include error details and location in the
// validation result.
std::string error_details = base::StringPrintf(
"Session policies disallowed by validator. Error code: %d",
static_cast<int>(*validation_result));
DisconnectSession(*validation_result, error_details, FROM_HERE);
return;
}
base::TimeDelta max_duration =
effective_policies_.maximum_session_duration.value_or(base::TimeDelta());
if (max_duration.is_positive()) {
max_duration_timer_.Start(
FROM_HERE, max_duration,
base::BindOnce(&ClientSession::DisconnectSession,
base::Unretained(this), ErrorCode::MAX_SESSION_LENGTH,
"Maximum session duration has been reached.",
FROM_HERE));
}
// Notify EventHandler.
event_handler_->OnSessionAuthenticated(this);
const SessionOptions session_options(
host_experiment_session_plugin_.configuration());
connection_->ApplySessionOptions(session_options);
connection_->ApplyNetworkSettings(
protocol::NetworkSettings(effective_policies_));
DesktopEnvironmentOptions options = desktop_environment_options_;
options.ApplySessionOptions(session_options);
if (effective_policies_.curtain_required.has_value()) {
options.set_enable_curtaining(*effective_policies_.curtain_required);
}
// Create the desktop environment.
// Note: The handlers for various other events use the created desktop
// environment. Since those events may occur before the desktop environment
// creation has finished, each such event handler must include a prologue to
// check if the desktop environment has been created, and add itself to a list
// of deferred handlers if not.
// TODO(rkjnsn): During a future refactor, see if this can be improved. E.g.,
// perhaps ensuring at a higher layer that additional events don't occur until
// the ClientSession is ready, or using co_await (once approved in Chromium)
// to wait for the desktop environment more simply and safely when it is used.
desktop_environment_factory_->Create(
weak_factory_.GetWeakPtr(), weak_factory_.GetWeakPtr(), options,
base::BindOnce(&ClientSession::OnDesktopEnvironmentCreated,
weak_factory_.GetWeakPtr()));
}
void ClientSession::CreateMediaStreams() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(base::BindOnce(
&ClientSession::CreateMediaStreams, weak_factory_.GetWeakPtr()));
return;
}
// Create a VideoStream to pump frames from the capturer to the client.
DCHECK(video_streams_.empty());
auto video_stream = connection_->StartVideoStream(
webrtc::kFullDesktopScreenId,
desktop_environment_->CreateVideoCapturer(webrtc::kFullDesktopScreenId));
// Create an AudioStream to pump audio from the capturer to the client.
std::unique_ptr<protocol::AudioSource> audio_capturer =
desktop_environment_->CreateAudioCapturer();
if (audio_capturer) {
audio_stream_ = connection_->StartAudioStream(std::move(audio_capturer));
}
video_stream->SetObserver(this);
// Pause capturing if necessary.
video_stream->Pause(pause_video_);
// Set the current target framerate.
video_stream->SetTargetFramerate(target_framerate_);
if (event_timestamp_source_for_tests_) {
video_stream->SetEventTimestampsSource(event_timestamp_source_for_tests_);
}
// Store the single video-stream using a key that isn't a valid monitor-id.
// If multi-stream is enabled, this entry will get removed when the new
// video-streams are created.
video_streams_[webrtc::kInvalidScreenId] = std::move(video_stream);
}
void ClientSession::CreatePerMonitorVideoStreams() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Undo any previously-set fallback. When there are multiple streams, all
// fractional coordinates must specify a screen_id.
fractional_input_filter_.set_fallback_geometry({});
// Create new streams for any monitors that don't already have streams.
for (int i = 0; i < desktop_display_info_.NumDisplays(); i++) {
auto id = desktop_display_info_.GetDisplayInfo(i)->id;
if (base::Contains(video_streams_, id)) {
HOST_LOG << "Video stream for id " << id << " already exists.";
continue;
}
HOST_LOG << "Creating video stream for id " << id;
auto video_stream = connection_->StartVideoStream(
id, desktop_environment_->CreateVideoCapturer(id));
// SetObserver(this) is not called on the new video-stream, because
// per-monitor resizing should be handled by OnDesktopDisplayChanged()
// rather than OnVideoSizeChanged(). The latter would send out a legacy
// (non-extended) video-layout message, which may confuse the client when
// multi-stream is being used.
// Pause capturing if necessary.
video_stream->Pause(pause_video_);
// Set the current target framerate.
video_stream->SetTargetFramerate(target_framerate_);
if (event_timestamp_source_for_tests_) {
video_stream->SetEventTimestampsSource(event_timestamp_source_for_tests_);
}
video_streams_[id] = std::move(video_stream);
}
// Delete any streams that no longer have monitors in |desktop_display_info_|.
// This will also delete any video-stream for the single-stream case, because
// it is stored with a key chosen to not be a valid monitor ID.
const auto& displays = desktop_display_info_.displays();
std::erase_if(video_streams_, [displays](const auto& id_stream_pair) {
webrtc::ScreenId id = id_stream_pair.first;
bool keep = base::Contains(
displays, id, [](const DisplayGeometry& geo) { return geo.id; });
HOST_LOG << (keep ? "Keeping" : "Removing") << " video stream for id "
<< id;
return !keep;
});
}
void ClientSession::OnConnectionChannelsConnected() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(
base::BindOnce(&ClientSession::OnConnectionChannelsConnected,
weak_factory_.GetWeakPtr()));
return;
}
DCHECK(!channels_connected_);
channels_connected_ = true;
// Negotiate capabilities with the client.
VLOG(1) << "Host capabilities: " << host_capabilities_;
protocol::Capabilities capabilities;
capabilities.set_capabilities(host_capabilities_);
connection_->client_stub()->SetCapabilities(capabilities);
// Start the event executor.
// TODO: crbug.com/406740794 - Decouple clipboard and input controls.
// Clipboard synchronization and remote input are controlled via two separate
// policies. Currently the code has them intertwined together and it is hard
// to disable one without disabling the other. These should be separated.
if (effective_policies_.allow_remote_input.value_or(true)) {
input_injector_->Start(CreateClipboardProxy());
SetDisableInputs(false);
} else {
SetDisableInputs(true);
}
// Create MouseShapePump to send mouse cursor shape.
mouse_shape_pump_ = std::make_unique<MouseShapePump>(
desktop_environment_->CreateMouseCursorMonitor(),
connection_->client_stub());
mouse_shape_pump_->SetMouseCursorMonitorCallback(this);
mouse_shape_pump_->SetCursorCaptureInterval(base::Hertz(target_framerate_));
// Create KeyboardLayoutMonitor to send keyboard layout.
// Unretained is sound because callback will never be called after
// |keyboard_layout_monitor_| has been destroyed, and |connection_| (which
// owns the client stub) is guaranteed to outlive |keyboard_layout_monitor_|.
keyboard_layout_monitor_ = desktop_environment_->CreateKeyboardLayoutMonitor(
base::BindRepeating(&protocol::KeyboardLayoutStub::SetKeyboardLayout,
base::Unretained(connection_->client_stub())));
keyboard_layout_monitor_->Start();
if (pending_video_layout_message_) {
connection_->client_stub()->SetVideoLayout(*pending_video_layout_message_);
pending_video_layout_message_.reset();
}
// Query the OS for the display-info on a timer.
auto* display_info_monitor = desktop_environment_->GetDisplayInfoMonitor();
if (display_info_monitor) {
// In the multi-process case, |display_info_monitor| will be null and this
// will be handled instead by the DesktopSessionAgent.
display_info_monitor->Start();
}
// Notify the event handler that all our channels are now connected.
event_handler_->OnSessionChannelsConnected(this);
}
void ClientSession::OnConnectionClosed(protocol::ErrorCode error) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
HOST_LOG << "Client disconnected: " << client_jid_
<< "; error = " << ErrorCodeToString(error);
// Ignore any further callbacks.
weak_factory_.InvalidateWeakPtrs();
// If the client never authenticated then the session failed.
if (!is_authenticated_) {
event_handler_->OnSessionAuthenticationFailed(this);
}
// ReleaseAll() requires an InputInjector, which might not be present if a
// connection wasn't established.
if (input_injector_) {
// Ensure that any pressed keys or buttons are released.
input_tracker_.ReleaseAll();
// Avoid dangling raw_ptr in `input_tracker_` after deleting
// `input_injector_` below.
input_tracker_.set_input_stub(nullptr);
}
// Stop components access the client, audio or video stubs, which are no
// longer valid once ConnectionToClient calls OnConnectionClosed().
audio_stream_.reset();
mouse_shape_pump_.reset();
video_streams_.clear();
keyboard_layout_monitor_.reset();
client_clipboard_factory_.InvalidateWeakPtrs();
input_injector_.reset();
screen_controls_.reset();
desktop_environment_.reset();
// Notify the ChromotingHost that this client is disconnected.
event_handler_->OnSessionClosed(this);
}
void ClientSession::OnTransportProtocolChange(const std::string& protocol) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
HOST_LOG << "Transport protocol: " << protocol;
protocol::TransportInfo transport_info;
transport_info.set_protocol(protocol);
connection_->client_stub()->SetTransportInfo(transport_info);
}
void ClientSession::OnRouteChange(const std::string& channel_name,
const protocol::TransportRoute& route) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
event_handler_->OnSessionRouteChange(this, channel_name, route);
}
void ClientSession::OnIncomingDataChannel(
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
data_channel_manager_.OnIncomingDataChannel(channel_name, std::move(pipe));
}
const std::string& ClientSession::client_jid() const {
return client_jid_;
}
void ClientSession::DisconnectSession(ErrorCode error,
std::string_view error_details,
const SourceLocation& error_location) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(connection_.get());
max_duration_timer_.Stop();
// This triggers OnConnectionClosed(), and the session may be destroyed
// as the result, so this call must be the last in this method.
connection_->Disconnect(error, error_details, error_location);
}
void ClientSession::OnLocalKeyPressed(std::uint32_t usb_keycode) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
bool is_local = remote_input_filter_.LocalKeyPressed(usb_keycode);
if (is_local && desktop_environment_options_.terminate_upon_input()) {
DisconnectSession(
ErrorCode::OK,
"Disconnecting CRD session because local keyboard input was detected.",
FROM_HERE);
}
}
void ClientSession::OnLocalPointerMoved(const webrtc::DesktopVector& position,
ui::EventType type) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
bool is_local = remote_input_filter_.LocalPointerMoved(position, type);
if (is_local) {
if (desktop_environment_options_.terminate_upon_input()) {
DisconnectSession(
ErrorCode::OK,
"Disconnecting CRD session because local mouse input was detected.",
FROM_HERE);
} else {
desktop_and_cursor_composer_notifier_.OnLocalInput();
}
}
}
void ClientSession::SetDisableInputs(bool disable_inputs) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (disable_inputs) {
input_tracker_.ReleaseAll();
}
disable_input_filter_.set_enabled(!disable_inputs);
host_clipboard_filter_.set_enabled(!disable_inputs);
}
std::uint32_t ClientSession::desktop_session_id() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(desktop_environment_);
return desktop_environment_->GetDesktopSessionId();
}
ClientSessionControl* ClientSession::session_control() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return this;
}
void ClientSession::SetComposeEnabled(bool enabled) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
for (const auto& [_, video_stream] : video_streams_) {
video_stream->SetComposeEnabled(enabled);
}
}
void ClientSession::OnMouseCursor(webrtc::MouseCursor* mouse_cursor) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// This method should take ownership of |mouse_cursor|.
std::unique_ptr<webrtc::MouseCursor> owned_cursor(mouse_cursor);
for (const auto& [_, video_stream] : video_streams_) {
video_stream->SetMouseCursor(
base::WrapUnique(webrtc::MouseCursor::CopyOf(*owned_cursor)));
}
}
void ClientSession::OnMouseCursorPosition(
const webrtc::DesktopVector& position) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
for (const auto& [_, video_stream] : video_streams_) {
video_stream->SetMouseCursorPosition(position);
}
}
void ClientSession::BindReceiver(
mojo::PendingReceiver<mojom::ChromotingSessionServices> receiver) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
session_services_receivers_.Add(this, std::move(receiver));
}
void ClientSession::BindWebAuthnProxy(
mojo::PendingReceiver<mojom::WebAuthnProxy> receiver) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!remote_webauthn_message_handler_) {
LOG(WARNING)
<< "No WebAuthn message handler is found. Binding request rejected.";
return;
}
remote_webauthn_message_handler_->AddReceiver(std::move(receiver));
}
void ClientSession::BindRemoteUrlOpener(
mojo::PendingReceiver<mojom::RemoteUrlOpener> receiver) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!remote_open_url_message_handler_) {
LOG(WARNING) << "No RemoteOpenUrl message handler is found. Binding "
<< "request rejected.";
return;
}
remote_open_url_message_handler_->AddReceiver(std::move(receiver));
}
#if BUILDFLAG(IS_WIN)
void ClientSession::BindSecurityKeyForwarder(
mojo::PendingReceiver<mojom::SecurityKeyForwarder> receiver) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
auto* extension_session = reinterpret_cast<SecurityKeyExtensionSession*>(
extension_manager_->FindExtensionSession(
SecurityKeyExtension::kCapability));
if (!extension_session) {
LOG(WARNING) << "Security key extension not found. "
<< "Binding request rejected.";
return;
}
extension_session->BindSecurityKeyForwarder(std::move(receiver));
}
#endif
void ClientSession::RegisterCreateHandlerCallbackForTesting(
const std::string& prefix,
protocol::DataChannelManager::CreateHandlerCallback constructor) {
data_channel_manager_.RegisterCreateHandlerCallback(prefix,
std::move(constructor));
}
void ClientSession::SetEventTimestampsSourceForTests(
scoped_refptr<protocol::InputEventTimestampsSource>
event_timestamp_source) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
event_timestamp_source_for_tests_ = event_timestamp_source;
for (const auto& [_, video_stream] : video_streams_) {
video_stream->SetEventTimestampsSource(event_timestamp_source_for_tests_);
}
}
std::unique_ptr<protocol::ClipboardStub> ClientSession::CreateClipboardProxy() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return std::make_unique<protocol::ClipboardThreadProxy>(
client_clipboard_factory_.GetWeakPtr(),
base::SingleThreadTaskRunner::GetCurrentDefault());
}
void ClientSession::SetMouseClampingFilter(const DisplaySize& size) {
UpdateMouseClampingFilterOffset();
#if BUILDFLAG(IS_CHROMEOS)
// ChromeOS uses Screen DIP coordinates to uniquely position all displays.
mouse_clamping_filter_.set_output_size(size.WidthAsDips(),
size.HeightAsDips());
#else
mouse_clamping_filter_.set_output_size(size.WidthAsPixels(),
size.HeightAsPixels());
#endif // BUILDFLAG(IS_CHROMEOS)
switch (connection_->session()->config().protocol()) {
case protocol::SessionConfig::Protocol::ICE:
mouse_clamping_filter_.set_input_size(size.WidthAsPixels(),
size.HeightAsPixels());
break;
case protocol::SessionConfig::Protocol::WEBRTC: {
#if BUILDFLAG(IS_APPLE)
mouse_clamping_filter_.set_input_size(size.WidthAsPixels(),
size.HeightAsPixels());
#else
// When using the WebRTC protocol the client sends mouse coordinates in
// DIPs, while InputInjector expects them in physical pixels.
// TODO(sergeyu): Fix InputInjector implementations to use DIPs as well.
mouse_clamping_filter_.set_input_size(size.WidthAsDips(),
size.HeightAsDips());
#endif // BUILDFLAG(IS_APPLE)
}
}
}
void ClientSession::UpdateMouseClampingFilterOffset() {
if (selected_display_index_ == webrtc::kInvalidScreenId) {
return;
}
webrtc::DesktopVector origin;
origin = desktop_display_info_.CalcDisplayOffset(selected_display_index_);
mouse_clamping_filter_.set_output_offset(origin);
}
void ClientSession::OnDesktopEnvironmentCreated(
std::unique_ptr<DesktopEnvironment> desktop_environment) {
// Drop the connection if it could not be created for any reason (for instance
// the curtain could not initialize).
if (!desktop_environment) {
DisconnectSession(ErrorCode::HOST_CONFIGURATION_ERROR,
"Failed to create desktop environment.", FROM_HERE);
return;
}
desktop_environment_ = std::move(desktop_environment);
// Connect host stub.
connection_->set_host_stub(this);
// Collate the set of capabilities to offer the client, if it supports them.
host_capabilities_ = desktop_environment_->GetCapabilities();
if (!host_capabilities_.empty()) {
host_capabilities_.append(" ");
}
host_capabilities_.append(extension_manager_->GetCapabilities());
if (!host_capabilities_.empty()) {
host_capabilities_.append(" ");
}
host_capabilities_.append(protocol::kRtcLogTransferCapability);
host_capabilities_.append(" ");
host_capabilities_.append(protocol::kWebrtcIceSdpRestartAction);
host_capabilities_.append(" ");
host_capabilities_.append(protocol::kFractionalCoordinatesCapability);
if (InputInjector::SupportsTouchEvents()) {
host_capabilities_.append(" ");
host_capabilities_.append(protocol::kTouchEventsCapability);
}
if (effective_policies_.allow_file_transfer.value_or(true)) {
host_capabilities_.append(" ");
host_capabilities_.append(protocol::kFileTransferCapability);
}
if (effective_policies_.allow_uri_forwarding.value_or(true) &&
IsRemoteOpenUrlSupported()) {
host_capabilities_.append(" ");
host_capabilities_.append(protocol::kRemoteOpenUrlCapability);
}
// Create the object that controls the screen resolution.
screen_controls_ = desktop_environment_->CreateScreenControls();
// Create the event executor.
input_injector_ = desktop_environment_->CreateInputInjector();
// Connect the host input stubs.
connection_->set_input_stub(&disable_input_filter_);
input_tracker_.set_input_stub(input_injector_.get());
if (effective_policies_.clipboard_size_bytes.has_value()) {
int max_size = *effective_policies_.clipboard_size_bytes;
client_clipboard_filter_.set_max_size(max_size);
host_clipboard_filter_.set_max_size(max_size);
}
// Connect the clipboard stubs.
connection_->set_clipboard_stub(&host_clipboard_filter_);
clipboard_echo_filter_.set_host_stub(input_injector_.get());
clipboard_echo_filter_.set_client_stub(connection_->client_stub());
// Execute any pending events that require the desktop environment.
for (auto& callback : desktop_environment_ready_callbacks_) {
std::move(callback).Run();
}
desktop_environment_ready_callbacks_.clear();
}
void ClientSession::OnLocalSessionPoliciesChanged(
const SessionPolicies& new_policies) {
DCHECK(local_session_policy_update_subscription_);
DisconnectSession(ErrorCode::SESSION_POLICIES_CHANGED,
"Effective policies have changed. Terminating session.",
FROM_HERE);
}
void ClientSession::OnVideoSizeChanged(protocol::VideoStream* video_stream,
const webrtc::DesktopSize& size_px,
const webrtc::DesktopVector& dpi) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
LOG(INFO) << "ClientSession::OnVideoSizeChanged";
DisplaySize size =
DisplaySize::FromPixels(size_px.width(), size_px.height(), dpi.x());
LOG(INFO) << " DisplaySize: " << size
<< " (size in pixels: " << size_px.width() << "x"
<< size_px.height() << ")";
// The first video size message that we receive from WebRtc is the full
// desktop size (if supported). If full desktop capture is not supported,
// then this will be the size of the default display.
if (default_webrtc_desktop_size_.IsEmpty()) {
default_webrtc_desktop_size_ = size;
LOG(INFO) << " display index " << selected_display_index_;
LOG(INFO) << " Recording default webrtc capture size "
<< default_webrtc_desktop_size_;
}
webrtc_capture_size_ = size;
SetMouseClampingFilter(size);
UpdateFractionalFilterFallback();
// Record default DPI in case a display reports 0 for DPI.
default_x_dpi_ = dpi.x();
default_y_dpi_ = dpi.y();
if (dpi.x() != dpi.y()) {
LOG(WARNING) << "Mismatch x,y dpi. x=" << dpi.x() << " y=" << dpi.y();
}
if (connection_->session()->config().protocol() !=
protocol::SessionConfig::Protocol::WEBRTC) {
return;
}
// Generate and send VideoLayout message.
protocol::VideoLayout layout;
protocol::VideoTrackLayout* video_track = layout.add_video_track();
video_track->set_position_x(0);
video_track->set_position_y(0);
video_track->set_width(size.WidthAsDips());
video_track->set_height(size.HeightAsDips());
video_track->set_x_dpi(dpi.x());
video_track->set_y_dpi(dpi.y());
// VideoLayout can be sent only after the control channel is connected.
// TODO(sergeyu): Change client_stub() implementation to allow queuing
// while connection is being established.
if (channels_connected_) {
connection_->client_stub()->SetVideoLayout(layout);
} else {
pending_video_layout_message_ =
std::make_unique<protocol::VideoLayout>(layout);
}
}
void ClientSession::OnDesktopDisplayChanged(
std::unique_ptr<protocol::VideoLayout> displays) {
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(
base::BindOnce(&ClientSession::OnDesktopDisplayChanged,
weak_factory_.GetWeakPtr(), std::move(displays)));
return;
}
LOG(INFO) << "ClientSession::OnDesktopDisplayChanged";
bool multiStreamEnabled =
HasCapability(capabilities_, protocol::kMultiStreamCapability);
// Scan display list to calculate the full desktop size.
int min_x = 0;
int max_x = 0;
int min_y = 0;
int max_y = 0;
int dpi_x = 0;
int dpi_y = 0;
LOG(INFO) << " Scanning display info... (dips)";
for (int display_id = 0; display_id < displays->video_track_size();
display_id++) {
protocol::VideoTrackLayout track = displays->video_track(display_id);
LOG(INFO) << " #" << display_id << " : " << track.position_x() << ","
<< track.position_y() << " " << track.width() << "x"
<< track.height() << " [" << track.x_dpi() << "," << track.y_dpi()
<< "], screen_id=" << track.screen_id();
if (dpi_x == 0) {
dpi_x = track.x_dpi();
}
if (dpi_y == 0) {
dpi_y = track.y_dpi();
}
int x = track.position_x();
int y = track.position_y();
min_x = std::min(x, min_x);
min_y = std::min(y, min_y);
max_x = std::max(x + track.width(), max_x);
max_y = std::max(y + track.height(), max_y);
}
// TODO(garykac): Investigate why these DPI values are 0 for some users.
if (dpi_x == 0) {
dpi_x = default_x_dpi_;
}
if (dpi_y == 0) {
dpi_y = default_y_dpi_;
}
// Calc desktop scaled geometry (in DIPs)
// See comment in OnVideoSizeChanged() for details.
const webrtc::DesktopSize size(max_x - min_x, max_y - min_y);
// If this is our first message, then we need to determine if the current
// display configuration supports capturing the entire desktop.
LOG(INFO) << " Webrtc desktop size " << default_webrtc_desktop_size_;
if (selected_display_index_ == webrtc::kInvalidScreenId) {
#if BUILDFLAG(IS_APPLE)
// On MacOS, there are situations where webrtc cannot capture the entire
// desktop (e.g, when there are displays with different DPIs). We detect
// this situation by comparing the full desktop size (calculated above
// from the displays) and the size of the initial webrtc capture (which
// defaults to the full desktop if supported).
if (size.width() == default_webrtc_desktop_size_.WidthAsDips() &&
size.height() == default_webrtc_desktop_size_.HeightAsDips()) {
LOG(INFO) << " Full desktop capture supported.";
can_capture_full_desktop_ = true;
} else {
LOG(INFO)
<< " This configuration does not support full desktop capture.";
can_capture_full_desktop_ = false;
}
#elif BUILDFLAG(IS_CHROMEOS)
can_capture_full_desktop_ = false;
#else
// Windows/Linux can capture full desktop if multiple displays.
can_capture_full_desktop_ = true;
#endif // BUILDFLAG(IS_APPLE)
}
// Generate and send VideoLayout message.
protocol::VideoLayout layout;
layout.set_supports_full_desktop_capture(can_capture_full_desktop_);
if (displays->has_primary_screen_id()) {
layout.set_primary_screen_id(displays->primary_screen_id());
}
protocol::VideoTrackLayout* video_track;
// For single-stream clients, the first layout must be the current webrtc
// capture size. This is required because we reuse the same message for both
// VideoSizeChanged (which is used to scale mouse coordinates) and
// DisplayDesktopChanged. Multi-stream clients will ignore the legacy layout
// message, except that the width/height must be non-zero (the first
// display-changed event may occur before |webrtc_capture_size_| becomes
// non-zero).
video_track = layout.add_video_track();
video_track->set_position_x(0);
video_track->set_position_y(0);
video_track->set_width(
multiStreamEnabled ? 1 : webrtc_capture_size_.WidthAsDips());
video_track->set_height(
multiStreamEnabled ? 1 : webrtc_capture_size_.HeightAsDips());
video_track->set_x_dpi(dpi_x);
video_track->set_y_dpi(dpi_y);
LOG(INFO) << " Webrtc capture size (DIPS) = 0,0 "
<< default_webrtc_desktop_size_;
// Add raw geometry for entire desktop (in DIPs).
video_track = layout.add_video_track();
video_track->set_position_x(0);
video_track->set_position_y(0);
video_track->set_width(size.width());
video_track->set_height(size.height());
video_track->set_x_dpi(dpi_x);
video_track->set_y_dpi(dpi_y);
LOG(INFO) << " Full Desktop (DIPS) = 0,0 " << size.width() << "x"
<< size.height() << " [" << dpi_x << "," << dpi_y << "]";
// Add a VideoTrackLayout entry for each separate display.
desktop_display_info_.Reset();
for (int display_id = 0; display_id < displays->video_track_size();
display_id++) {
protocol::VideoTrackLayout display = displays->video_track(display_id);
desktop_display_info_.AddDisplayFrom(display);
video_track = layout.add_video_track();
video_track->CopyFrom(display);
if (multiStreamEnabled) {
video_track->set_media_stream_id(
protocol::WebrtcVideoStream::StreamNameForId(display.screen_id()));
}
LOG(INFO) << " Display " << display_id << " = " << display.position_x()
<< "," << display.position_y() << " " << display.width() << "x"
<< display.height() << " [" << display.x_dpi() << ","
<< display.y_dpi() << "], screen_id=" << display.screen_id();
}
// Set the display index, if this is the first message being processed or if
// the selected display no longer exists.
if (!IsValidDisplayIndex(selected_display_index_)) {
if (can_capture_full_desktop_) {
selected_display_index_ = webrtc::kFullDesktopScreenId;
} else {
// Select the default display.
protocol::SelectDesktopDisplayRequest req;
req.set_id("0");
SelectDesktopDisplay(req);
}
}
// We need to update the input filters whenever the displays change.
fractional_input_filter_.set_video_layout(*displays);
UpdateFractionalFilterFallback();
DisplaySize display_size =
DisplaySize::FromPixels(size.width(), size.height(), default_x_dpi_);
SetMouseClampingFilter(display_size);
connection_->client_stub()->SetVideoLayout(layout);
// If multi-stream is enabled, create and remove video-streams to match the
// new list of displays.
if (multiStreamEnabled) {
CreatePerMonitorVideoStreams();
}
}
void ClientSession::OnDesktopAttached(std::uint32_t session_id) {
if (remote_webauthn_message_handler_) {
// On Windows, only processes running on an attached desktop session can
// bind ChromotingHostServices, so we notify the extension that it might be
// able to connect now.
remote_webauthn_message_handler_->NotifyWebAuthnStateChange();
}
}
void ClientSession::OnDesktopDetached() {
// Clear ChromotingSessionServices receivers and all other receivers brokered
// by ChromotingSessionServices, as they are scoped to desktop session that
// is being detached.
// TODO(yuweih): If we decide to start the IPC server per remote session, then
// we may just stop the server here instead, which will automatically
// disconnect all ongoing IPCs.
session_services_receivers_.Clear();
if (remote_webauthn_message_handler_) {
remote_webauthn_message_handler_->ClearReceivers();
remote_webauthn_message_handler_->NotifyWebAuthnStateChange();
}
if (remote_open_url_message_handler_) {
remote_open_url_message_handler_->ClearReceivers();
}
}
void ClientSession::CreateFileTransferMessageHandler(
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(base::BindOnce(
&ClientSession::CreateFileTransferMessageHandler,
weak_factory_.GetWeakPtr(), channel_name, std::move(pipe)));
return;
}
// FileTransferMessageHandler manages its own lifetime and is tied to the
// lifetime of |pipe|. Once |pipe| is closed, this instance will be cleaned
// up.
new FileTransferMessageHandler(channel_name, std::move(pipe),
desktop_environment_->CreateFileOperations());
}
void ClientSession::CreateRtcLogTransferMessageHandler(
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
new FileTransferMessageHandler(
channel_name, std::move(pipe),
std::make_unique<RtcLogFileOperations>(connection_.get()));
}
void ClientSession::CreateActionMessageHandler(
std::vector<ActionRequest::Action> capabilities,
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(base::BindOnce(
&ClientSession::CreateActionMessageHandler, weak_factory_.GetWeakPtr(),
std::move(capabilities), channel_name, std::move(pipe)));
return;
}
std::unique_ptr<ActionExecutor> action_executor =
desktop_environment_->CreateActionExecutor();
if (!action_executor) {
return;
}
// ActionMessageHandler manages its own lifetime and is tied to the lifetime
// of |pipe|. Once |pipe| is closed, this instance will be cleaned up.
new ActionMessageHandler(channel_name, capabilities, std::move(pipe),
std::move(action_executor));
}
void ClientSession::CreateRemoteOpenUrlMessageHandler(
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
// RemoteOpenUrlMessageHandler manages its own lifetime and is tied to the
// lifetime of |pipe|. Once |pipe| is closed, this instance will be cleaned
// up.
auto* unowned_handler =
new RemoteOpenUrlMessageHandler(channel_name, std::move(pipe));
remote_open_url_message_handler_ = unowned_handler->GetWeakPtr();
}
void ClientSession::CreateUrlForwarderControlMessageHandler(
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(base::BindOnce(
&ClientSession::CreateUrlForwarderControlMessageHandler,
weak_factory_.GetWeakPtr(), channel_name, std::move(pipe)));
return;
}
// UrlForwarderControlMessageHandler manages its own lifetime and is tied to
// the lifetime of |pipe|. Once |pipe| is closed, this instance will be
// cleaned up.
new UrlForwarderControlMessageHandler(
desktop_environment_->CreateUrlForwarderConfigurator(), channel_name,
std::move(pipe));
}
void ClientSession::CreateRemoteWebAuthnMessageHandler(
const std::string& channel_name,
std::unique_ptr<protocol::MessagePipe> pipe) {
if (!desktop_environment_) {
desktop_environment_ready_callbacks_.push_back(base::BindOnce(
&ClientSession::CreateRemoteWebAuthnMessageHandler,
weak_factory_.GetWeakPtr(), channel_name, std::move(pipe)));
return;
}
// RemoteWebAuthnMessageHandler manages its own lifetime and is tied to the
// lifetime of |pipe|. Once |pipe| is closed, this instance will be cleaned
// up.
auto* unowned_handler = new RemoteWebAuthnMessageHandler(
channel_name, std::move(pipe),
desktop_environment_->CreateRemoteWebAuthnStateChangeNotifier());
remote_webauthn_message_handler_ = unowned_handler->GetWeakPtr();
}
bool ClientSession::IsValidDisplayIndex(webrtc::ScreenId index) const {
return index == webrtc::kFullDesktopScreenId ||
desktop_display_info_.GetDisplayInfo(index) != nullptr;
}
void ClientSession::BoostFramerateOnInput(
base::TimeDelta capture_interval,
base::TimeDelta boost_duration,
bool& mouse_button_down,
protocol::ObservingInputFilter::Event event) {
// Boost the framerate when we see input which is likely to trigger a change
// on the screen. This includes key, text, and touch events as well as mouse
// scroll or mouse moves when a button is down.
auto* mouse_event_ptr =
std::get_if<std::reference_wrapper<const protocol::MouseEvent>>(&event);
if (mouse_event_ptr) {
const protocol::MouseEvent& mouse_event = mouse_event_ptr->get();
if (!mouse_button_down && !mouse_event.has_button() &&
!mouse_event.has_wheel_delta_x() && !mouse_event.has_wheel_delta_y()) {
return;
}
if (mouse_event.has_button()) {
// The |button| field is only set when the state changes so we must store
// the current value so we know whether to boost the framerate when we see
// a mouse move event.
mouse_button_down = mouse_event.button_down();
}
}
for (const auto& [_, video_stream] : video_streams_) {
// TODO(joedow): Consider boosting the capture rate for the active desktop
// instead of all desktops in multi-stream mode.
video_stream->BoostFramerate(capture_interval, boost_duration);
}
}
void ClientSession::OnActiveDisplayChanged(webrtc::ScreenId display) {
protocol::ActiveDisplay active_display;
active_display.set_screen_id(display);
connection_->client_stub()->SetActiveDisplay(active_display);
}
void ClientSession::UpdateFractionalFilterFallback() {
if (!IsValidDisplayIndex(selected_display_index_)) {
return;
}
webrtc::DesktopSize new_size;
if (selected_display_index_ == webrtc::kFullDesktopScreenId) {
#if BUILDFLAG(IS_APPLE)
// On macOS, for full-desktop capture, the capturer's current frame size
// should be used. This is because the capturer may revert to capturing from
// the default display instead of the full desktop. This could happen if all
// monitors had matching DPIs and full-desktop-capture was previously
// supported, but a monitor mode was changed such that the DPIs no longer
// match.
new_size = {webrtc_capture_size_.WidthAsDips(),
webrtc_capture_size_.HeightAsDips()};
#else
// For other platforms, use the video-layout, as the rectangles are already
// in the correct units (pixels/DIPs) for input-injection.
webrtc::DesktopRect rect;
for (int i = 0; i < desktop_display_info_.NumDisplays(); i++) {
const DisplayGeometry* geo = desktop_display_info_.GetDisplayInfo(i);
rect.UnionWith(webrtc::DesktopRect::MakeXYWH(geo->x, geo->y, geo->width,
geo->height));
}
new_size = rect.size();
#endif // BUILDFLAG(IS_APPLE)
} else {
const DisplayGeometry* geo =
desktop_display_info_.GetDisplayInfo(selected_display_index_);
new_size = webrtc::DesktopSize(geo->width, geo->height);
}
// The logic for input-injection offsets is dependent on the OS, and is
// implemented in DesktopDisplayInfo::CalcDisplayOffset().
webrtc::DesktopVector offset =
desktop_display_info_.CalcDisplayOffset(selected_display_index_);
fractional_input_filter_.set_fallback_geometry(
webrtc::DesktopRect::MakeOriginSize(offset, new_size));
}
} // namespace remoting
|