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
|
// 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 "extensions/browser/api/messaging/message_service.h"
#include <stdint.h>
#include <algorithm>
#include <limits>
#include <memory>
#include <utility>
#include <variant>
#include "base/containers/contains.h"
#include "base/containers/span.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/json/json_writer.h"
#include "base/lazy_instance.h"
#include "base/values.h"
#include "build/build_config.h"
#include "components/back_forward_cache/back_forward_cache_disable.h"
#include "content/public/browser/back_forward_cache.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/child_process_host.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/browser/render_widget_host.h"
#include "content/public/browser/render_widget_host_view.h"
#include "content/public/browser/site_instance.h"
#include "content/public/browser/web_contents.h"
#include "extensions/browser/api/extensions_api_client.h"
#include "extensions/browser/api/messaging/channel_endpoint.h"
#include "extensions/browser/api/messaging/extension_message_port.h"
#include "extensions/browser/api/messaging/message_port.h"
#include "extensions/browser/api/messaging/messaging_delegate.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extension_api_frame_id_map.h"
#include "extensions/browser/extension_prefs.h"
#include "extensions/browser/extension_prefs_factory.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_registry_factory.h"
#include "extensions/browser/extension_system.h"
#include "extensions/browser/extension_util.h"
#include "extensions/browser/extension_web_contents_observer.h"
#include "extensions/browser/extensions_browser_client.h"
#include "extensions/browser/message_service_api.h"
#include "extensions/browser/message_tracker.h"
#include "extensions/browser/pref_names.h"
#include "extensions/browser/process_manager.h"
#include "extensions/browser/process_manager_factory.h"
#include "extensions/common/api/messaging/messaging_endpoint.h"
#include "extensions/common/api/messaging/port_context.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_id.h"
#include "extensions/common/manifest_constants.h"
#include "extensions/common/manifest_handlers/background_info.h"
#include "extensions/common/manifest_handlers/externally_connectable.h"
#include "extensions/common/manifest_handlers/incognito_info.h"
#include "extensions/common/mojom/message_port.mojom-shared.h"
#include "extensions/common/permissions/permissions_data.h"
#include "third_party/abseil-cpp/absl/functional/overload.h"
#include "url/gurl.h"
#if BUILDFLAG(ENABLE_GUEST_VIEW)
#include "extensions/browser/guest_view/web_view/web_view_guest.h"
#endif
using content::BrowserContext;
using content::BrowserThread;
using content::SiteInstance;
using content::WebContents;
namespace extensions {
namespace {
const char kReceivingEndDoesntExistError[] =
"Could not establish connection. Receiving end does not exist.";
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX) || \
BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)
const char kMissingPermissionError[] =
"Access to native messaging requires nativeMessaging permission.";
const char kProhibitedByPoliciesError[] =
"Access to the native messaging host was disabled by the system "
"administrator.";
#endif
LazyContextId LazyContextIdFor(content::BrowserContext* browser_context,
const Extension* extension) {
return LazyContextId::ForExtension(browser_context, extension);
}
const Extension* GetExtensionForNativeAppChannel(
const ChannelEndpoint& source) {
DCHECK(!source.is_for_native_host());
if (source.is_for_service_worker()) {
const ExtensionId& extension_id =
source.port_context().worker->extension_id;
return ExtensionRegistry::Get(source.browser_context())
->enabled_extensions()
.GetByID(extension_id);
}
DCHECK(source.is_for_render_frame());
content::RenderFrameHost* source_render_frame_host =
source.GetRenderFrameHost();
if (!source_render_frame_host) {
return nullptr;
}
content::WebContents* web_contents =
content::WebContents::FromRenderFrameHost(source_render_frame_host);
if (!web_contents)
return nullptr;
ExtensionWebContentsObserver* extension_web_contents_observer =
ExtensionWebContentsObserver::GetForWebContents(web_contents);
if (!extension_web_contents_observer)
return nullptr;
return extension_web_contents_observer->GetExtensionFromFrame(
source_render_frame_host, true);
}
// Disables the back forward for `host` if the current configuration does not
// support extension messaging APIs.
void MaybeDisableBackForwardCacheForMessaging(content::RenderFrameHost* host) {
if (!host || content::BackForwardCache::IsBackForwardCacheFeatureEnabled()) {
return;
}
content::BackForwardCache::DisableForRenderFrameHost(
host, back_forward_cache::DisabledReason(
back_forward_cache::DisabledReasonId::kExtensionMessaging));
}
// Default apps that grant extended lifetime when connecting to them with a
// persistent port connection, until the channel is closed. These values extend
// the values of the
// ExtensionExtendedBackgroundLifetimeForPortConnectionsToUrls policy. They
// are chosen as defaults because they are known apps that offer SDKs and do not
// offer the possibility to restart a closed connection to a previous state.
constexpr const char* kDefaultSWExtendedLifetimeList[] = {
// Smart Card Connector
"chrome-extension://khpfeaanjngmcnplbdlpegiifgpfgdco/", // stable
"chrome-extension://mockcojkppdndnhgonljagclgpkjbkek/", // beta
// Citrix Receiver
"chrome-extension://haiffjcadagjlijoggckpgfnoeiflnem/", // stable
"chrome-extension://lbfgjakkeeccemhonnolnmglmfmccaag/", // beta
"chrome-extension://anjihnbmjbbpofafpmklejenkgnjfcdi/", // back-up
// VMware Horizon
"chrome-extension://ppkfnjlimknmjoaemnpidmdlfchhehel/", // stable
"chrome-extension://kenkpdjcfppbccchillfdjkjnejjgand/", // beta
};
std::vector<url::Origin> GetServiceWorkerExtendedLifetimeOrigins(
content::BrowserContext* browser_context) {
std::vector<url::Origin> origins;
const base::Value::List& extended_lifetime_urls =
ExtensionPrefs::Get(browser_context)
->pref_service()
->GetList(
pref_names::kExtendedBackgroundLifetimeForPortConnectionsToUrls);
origins.reserve(std::size(kDefaultSWExtendedLifetimeList) +
extended_lifetime_urls.size());
// Add default values.
for (const char* default_value : kDefaultSWExtendedLifetimeList) {
url::Origin origin = url::Origin::Create(GURL(default_value));
origins.push_back(std::move(origin));
}
// Add policy values.
for (const base::Value& value : extended_lifetime_urls) {
GURL url(value.GetString());
if (!url.is_valid()) {
continue;
}
url::Origin origin = url::Origin::Create(url);
if (origin.opaque()) {
continue;
}
origins.push_back(std::move(origin));
}
return origins;
}
// Verifies (via CHECK()) that the lazy context for the given `extension` is
// currently active and registered in the ProcessManager.
void VerifyLazyContextActive(
const Extension* extension,
const LazyContextTaskQueue::ContextInfo& context_info) {
CHECK(extension);
ProcessManager* process_manager =
ProcessManager::Get(context_info.browser_context);
if (BackgroundInfo::IsServiceWorkerBased(extension)) {
std::vector<WorkerId> service_workers =
process_manager->GetServiceWorkersForExtension(extension->id());
CHECK(!service_workers.empty());
CHECK(std::ranges::find_if(
service_workers, [&context_info](const WorkerId& worker_id) {
return worker_id.version_id ==
context_info.service_worker_version_id &&
worker_id.thread_id == context_info.worker_thread_id;
}) != service_workers.end());
} else {
CHECK(BackgroundInfo::HasLazyBackgroundPage(extension));
CHECK(process_manager->GetBackgroundHostForExtension(extension->id()));
}
}
} // namespace
struct MessageService::MessageChannel {
std::unique_ptr<MessagePort> opener;
std::unique_ptr<MessagePort> receiver;
};
struct MessageService::OpenChannelParams {
ChannelEndpoint source;
std::optional<base::Value::Dict> source_tab;
ExtensionApiFrameIdMap::FrameData source_frame;
std::unique_ptr<MessagePort> receiver;
PortId receiver_port_id;
MessagingEndpoint source_endpoint;
std::unique_ptr<MessagePort> opener_port;
std::string target_extension_id;
GURL source_url;
std::optional<url::Origin> source_origin;
mojom::ChannelType channel_type;
std::string channel_name;
bool include_guest_process_info;
std::set<base::UnguessableToken> open_channel_tracking_ids;
// Takes ownership of receiver.
OpenChannelParams(const ChannelEndpoint& source,
std::optional<base::Value::Dict> source_tab,
const ExtensionApiFrameIdMap::FrameData& source_frame,
MessagePort* receiver,
const PortId& receiver_port_id,
const MessagingEndpoint& source_endpoint,
std::unique_ptr<MessagePort> opener_port,
const std::string& target_extension_id,
const GURL& source_url,
std::optional<url::Origin> source_origin,
mojom::ChannelType channel_type,
const std::string& channel_name,
bool include_guest_process_info)
: OpenChannelParams(source,
std::move(source_tab),
source_frame,
receiver,
receiver_port_id,
source_endpoint,
std::move(opener_port),
target_extension_id,
source_url,
source_origin,
channel_type,
channel_name,
include_guest_process_info,
/*open_channel_tracking_ids=*/{}) {}
OpenChannelParams(const ChannelEndpoint& source,
std::optional<base::Value::Dict> source_tab,
const ExtensionApiFrameIdMap::FrameData& source_frame,
MessagePort* receiver,
const PortId& receiver_port_id,
const MessagingEndpoint& source_endpoint,
std::unique_ptr<MessagePort> opener_port,
const std::string& target_extension_id,
const GURL& source_url,
std::optional<url::Origin> source_origin,
mojom::ChannelType channel_type,
const std::string& channel_name,
bool include_guest_process_info,
std::set<base::UnguessableToken> open_channel_tracking_ids)
: source(source),
source_tab(std::move(source_tab)),
source_frame(source_frame),
receiver(receiver),
receiver_port_id(receiver_port_id),
source_endpoint(source_endpoint),
opener_port(std::move(opener_port)),
target_extension_id(target_extension_id),
source_url(source_url),
source_origin(source_origin),
channel_type(channel_type),
channel_name(channel_name),
include_guest_process_info(include_guest_process_info),
open_channel_tracking_ids(std::move(open_channel_tracking_ids)) {}
OpenChannelParams(const OpenChannelParams&) = delete;
OpenChannelParams& operator=(const OpenChannelParams&) = delete;
bool is_onetime_channel() const {
return channel_type == mojom::ChannelType::kSendMessage ||
channel_type == mojom::ChannelType::kSendRequest;
}
};
MessageService::MessageService(BrowserContext* context)
: context_(context),
messaging_delegate_(ExtensionsAPIClient::Get()->GetMessagingDelegate()) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK_NE(nullptr, messaging_delegate_);
}
MessageService::~MessageService() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
channels_.clear();
}
class MessageServiceFactory
: public BrowserContextKeyedAPIFactory<MessageService>,
public MessageServiceApi {
public:
MessageServiceFactory() {
DependsOn(ProcessManagerFactory::GetInstance());
DependsOn(ExtensionPrefsFactory::GetInstance());
DependsOn(ExtensionRegistryFactory::GetInstance());
MessageServiceApi::SetMessageService(this);
}
~MessageServiceFactory() override {
MessageServiceApi::SetMessageService(nullptr);
}
void OpenChannelToExtension(
content::BrowserContext* context,
Source source,
const PortId& source_port_id,
const ExternalConnectionInfo& info,
mojom::ChannelType channel_type,
const std::string& channel_name,
mojo::PendingAssociatedRemote<extensions::mojom::MessagePort> port,
mojo::PendingAssociatedReceiver<extensions::mojom::MessagePortHost>
port_host) override {
MessageService::Get(context)->OpenChannelToExtension(
GetEndpoint(context, source), source_port_id, info, channel_type,
channel_name, std::move(port), std::move(port_host));
}
void OpenChannelToNativeApp(
content::BrowserContext* context,
Source source,
const PortId& source_port_id,
const std::string& native_app_name,
mojo::PendingAssociatedRemote<extensions::mojom::MessagePort> port,
mojo::PendingAssociatedReceiver<extensions::mojom::MessagePortHost>
port_host) override {
MessageService::Get(context)->OpenChannelToNativeApp(
GetEndpoint(context, source), source_port_id, native_app_name,
std::move(port), std::move(port_host));
}
void OpenChannelToTab(
content::BrowserContext* context,
Source source,
const PortId& source_port_id,
int tab_id,
int frame_id,
const std::string& document_id,
mojom::ChannelType channel_type,
const std::string& channel_name,
mojo::PendingAssociatedRemote<extensions::mojom::MessagePort> port,
mojo::PendingAssociatedReceiver<extensions::mojom::MessagePortHost>
port_host) override {
MessageService::Get(context)->OpenChannelToTab(
GetEndpoint(context, source), source_port_id, tab_id, frame_id,
document_id, channel_type, channel_name, std::move(port),
std::move(port_host));
}
private:
ChannelEndpoint GetEndpoint(content::BrowserContext* context,
const Source& source) {
return std::visit(
absl::Overload{
[&](const WorkerId& worker) {
return ChannelEndpoint(
context, worker.render_process_id,
PortContext::ForWorker(worker.thread_id, worker.version_id,
worker.render_process_id,
worker.extension_id));
},
[&](const content::RenderFrameHost* render_frame_host) {
return ChannelEndpoint(
context, render_frame_host->GetProcess()->GetDeprecatedID(),
PortContext::ForFrame(render_frame_host->GetRoutingID()));
}},
source);
}
};
static base::LazyInstance<MessageServiceFactory>::DestructorAtExit g_factory =
LAZY_INSTANCE_INITIALIZER;
// static
BrowserContextKeyedAPIFactory<MessageService>*
MessageService::GetFactoryInstance() {
return g_factory.Pointer();
}
// static
MessageService* MessageService::Get(BrowserContext* context) {
return BrowserContextKeyedAPIFactory<MessageService>::Get(context);
}
void MessageService::OpenChannelToExtension(
const ChannelEndpoint& source,
const PortId& source_port_id,
const MessagingEndpoint& source_endpoint,
std::unique_ptr<MessagePort> opener_port,
const std::string& target_extension_id,
const GURL& source_url,
mojom::ChannelType channel_type,
const std::string& channel_name) {
// Overall open channel metrics tracking.
std::set<base::UnguessableToken> open_channel_tracking_ids;
base::UnguessableToken open_channel_tracking_id(
base::UnguessableToken::Create());
open_channel_tracking_ids.insert(open_channel_tracking_id);
auto* message_tracker = MessageTracker::Get(context_);
message_tracker->StartTrackingMessagingStage(
open_channel_tracking_id, "Extensions.MessagePipeline.OpenChannelStatus",
channel_type);
BrowserContext* context = source.browser_context();
ExtensionRegistry* registry = ExtensionRegistry::Get(context);
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK(source_port_id.is_opener);
DCHECK(!target_extension_id.empty());
DCHECK(source_endpoint.extension_id.has_value() ||
source_endpoint.type == MessagingEndpoint::Type::kWebPage ||
source_endpoint.type == MessagingEndpoint::Type::kNativeApp);
DCHECK_EQ(source_endpoint.native_app_name.has_value(),
source_endpoint.type == MessagingEndpoint::Type::kNativeApp);
int source_process_id = source.render_process_id();
DCHECK_EQ(source_process_id == content::ChildProcessHost::kInvalidUniqueID,
source_endpoint.type == MessagingEndpoint::Type::kNativeApp);
content::RenderFrameHost* source_render_frame_host =
source.is_for_render_frame() ? source.GetRenderFrameHost() : nullptr;
if (!source.IsValid()) {
for (const auto& tracking_id : open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kOpenChannelSourceEndpointInvalid);
}
return;
}
DCHECK(ExtensionsBrowserClient::Get()->IsSameContext(context, context_));
MaybeDisableBackForwardCacheForMessaging(source_render_frame_host);
CHECK(opener_port);
if (!opener_port->IsValidPort()) {
for (const auto& tracking_id : open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kOpenChannelOpenerPortInvalid);
}
return;
}
const Extension* target_extension =
registry->enabled_extensions().GetByID(target_extension_id);
if (!target_extension) {
opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
for (const auto& tracking_id : open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kOpenChannelToNonEnabledExtension);
}
return;
}
// Worker specific open channel metrics tracking.
std::string worker_status_metric_suffix;
if (BackgroundInfo::IsServiceWorkerBased(target_extension)) {
if (!ProcessManager::Get(context)
->GetServiceWorkersForExtension(target_extension_id)
.empty()) {
worker_status_metric_suffix = "WithActiveWorker";
} else {
worker_status_metric_suffix = "WithIdleWorker";
}
} else {
worker_status_metric_suffix = "WithNoWorker";
}
std::string worker_status_metric_name =
base::StrCat({"Extensions.MessagePipeline.OpenChannelStatus",
worker_status_metric_suffix});
base::UnguessableToken open_channel_worker_status_tracking_id(
base::UnguessableToken::Create());
open_channel_tracking_ids.insert(open_channel_worker_status_tracking_id);
message_tracker->StartTrackingMessagingStage(
open_channel_worker_status_tracking_id, worker_status_metric_name,
channel_type);
MessagingEndpoint::Relationship relationship =
MessagingEndpoint::GetRelationship(source_endpoint, target_extension_id);
if (relationship != MessagingEndpoint::Relationship::kInternal &&
relationship != MessagingEndpoint::Relationship::kExternalNativeApp) {
// It's an external connection (other than a native app). Check the
// externally_connectable manifest key if it's present. If it's not, we
// allow connection from any extension but not webpages.
// TODO(devlin): We should just use ExternallyConnectableInfo::Get() here.
// We don't currently because we don't synthesize externally-connectable
// information (so that it's always present, even for extensions that don't
// have an explicit key); we should.
ExternallyConnectableInfo* externally_connectable =
static_cast<ExternallyConnectableInfo*>(
target_extension->GetManifestData(
manifest_keys::kExternallyConnectable));
bool is_externally_connectable = false;
if (externally_connectable) {
if (relationship == MessagingEndpoint::Relationship::kExternalExtension) {
DCHECK(source_endpoint.extension_id);
// The source was another extension or a content script. Check that the
// extension ID matches.
is_externally_connectable =
externally_connectable->IdCanConnect(*source_endpoint.extension_id);
} else {
DCHECK(source_render_frame_host);
DCHECK_EQ(MessagingEndpoint::Relationship::kExternalWebPage,
relationship);
// Check that the web page URL matches.
is_externally_connectable = externally_connectable->matches.MatchesURL(
source_render_frame_host->GetLastCommittedURL());
}
} else {
// Default behaviour. Any extension or content script, no webpages.
is_externally_connectable =
relationship == MessagingEndpoint::Relationship::kExternalExtension;
}
if (!is_externally_connectable) {
// Important: use kReceivingEndDoesntExistError here so that we don't
// leak information about this extension to callers. This way it's
// indistinguishable from the extension just not existing.
opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
for (const auto& tracking_id : open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kNotExternallyConnectable);
}
return;
}
}
WebContents* source_contents = nullptr;
if (source_render_frame_host) {
source_contents =
WebContents::FromRenderFrameHost(source_render_frame_host);
}
ExtensionApiFrameIdMap::FrameData source_frame;
bool include_guest_process_info = false;
// Get information about the opener's tab, if applicable.
std::optional<base::Value::Dict> source_tab =
messaging_delegate_->MaybeGetTabInfo(source_contents);
std::optional<url::Origin> source_origin;
if (source_render_frame_host)
source_origin = source_render_frame_host->GetLastCommittedOrigin();
if (source_tab) {
DCHECK(source_render_frame_host);
source_frame = ExtensionApiFrameIdMap::Get()->GetFrameData(
source_render_frame_host->GetGlobalId());
} else {
#if BUILDFLAG(ENABLE_GUEST_VIEW)
// Check to see if it was a WebView making the request.
// Sending messages from WebViews to extensions breaks webview isolation,
// so only allow component extensions to receive messages from WebViews.
bool is_web_view =
!!WebViewGuest::FromRenderFrameHost(source_render_frame_host);
if (is_web_view &&
Manifest::IsComponentLocation(target_extension->location())) {
include_guest_process_info = true;
}
#endif
}
std::unique_ptr<OpenChannelParams> params =
std::make_unique<OpenChannelParams>(
source, std::move(source_tab), source_frame, nullptr,
source_port_id.GetOppositePortId(), source_endpoint,
std::move(opener_port), target_extension_id, source_url,
std::move(source_origin), channel_type, channel_name,
include_guest_process_info, std::move(open_channel_tracking_ids));
pending_incognito_channels_[params->receiver_port_id.GetChannelId()] =
PendingMessagesQueue();
if (context->IsOffTheRecord() &&
!util::IsIncognitoEnabled(target_extension_id, context)) {
// Give the user a chance to accept an incognito connection from the web if
// they haven't already, with the conditions:
// - Only for non-split mode incognito. We don't want the complication of
// spinning up an additional process here which might need to do some
// setup that we're not expecting.
// - Only for extensions that can't normally be enabled in incognito, since
// that surface (e.g. chrome://extensions) should be the only one for
// enabling in incognito. In practice this means platform apps only.
if (relationship != MessagingEndpoint::Relationship::kExternalWebPage ||
IncognitoInfo::IsSplitMode(target_extension) ||
util::CanBeIncognitoEnabled(target_extension)) {
OnOpenChannelAllowed(std::move(params), false);
return;
}
// If the target extension isn't even listening for connect/message events,
// there is no need to go any further and the connection should be
// rejected without showing a prompt. See http://crbug.com/442497
EventRouter* event_router = EventRouter::Get(context);
const char* const events[] = {
"runtime.onConnectExternal",
"runtime.onConnectNative",
"runtime.onMessageExternal",
"extension.onRequestExternal",
};
const bool has_event_listener =
std::ranges::any_of(events, [&](const char* event) {
return event_router->ExtensionHasEventListener(target_extension_id,
event);
});
if (!has_event_listener) {
OnOpenChannelAllowed(std::move(params), false);
return;
}
// This check may show a dialog.
messaging_delegate_->QueryIncognitoConnectability(
context, target_extension, source_contents, source_url,
base::BindOnce(&MessageService::OnOpenChannelAllowed,
weak_factory_.GetWeakPtr(), std::move(params)));
return;
}
OnOpenChannelAllowed(std::move(params), true);
}
void MessageService::OpenChannelToNativeAppImpl(
const ChannelEndpoint& source,
const PortId& source_port_id,
const std::string& native_app_name,
mojo::PendingAssociatedRemote<extensions::mojom::MessagePort> port,
mojo::PendingAssociatedReceiver<extensions::mojom::MessagePortHost>
port_host) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK(source_port_id.is_opener);
if (!source.IsValid())
return;
const Extension* extension = GetExtensionForNativeAppChannel(source);
if (!extension)
return;
std::unique_ptr<ExtensionMessagePort> opener_port =
ExtensionMessagePort::CreateForEndpoint(
weak_factory_.GetWeakPtr(), source_port_id, extension->id(), source,
std::move(port), std::move(port_host));
if (!opener_port->IsValidPort())
return;
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX) || \
BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)
bool has_permission = extension->permissions_data()->HasAPIPermission(
mojom::APIPermissionID::kNativeMessaging);
if (!has_permission) {
opener_port->DispatchOnDisconnect(kMissingPermissionError);
return;
}
// Verify that the host is not blocked by policies.
BrowserContext* source_context = source.browser_context();
DCHECK(
ExtensionsBrowserClient::Get()->IsSameContext(source_context, context_));
MessagingDelegate::PolicyPermission policy_permission =
messaging_delegate_->IsNativeMessagingHostAllowed(source_context,
native_app_name);
if (policy_permission == MessagingDelegate::PolicyPermission::DISALLOW) {
opener_port->DispatchOnDisconnect(kProhibitedByPoliciesError);
return;
}
std::unique_ptr<MessageChannel> channel = std::make_unique<MessageChannel>();
channel->opener = std::move(opener_port);
channel->opener->OpenPort(source.render_process_id(), source.port_context());
content::RenderFrameHost* source_render_frame_host =
source.is_for_render_frame() ? source.GetRenderFrameHost() : nullptr;
MaybeDisableBackForwardCacheForMessaging(source_render_frame_host);
std::string error = kReceivingEndDoesntExistError;
const PortId receiver_port_id = source_port_id.GetOppositePortId();
// NOTE: We're creating |receiver| with nullptr |source_render_frame_host|,
// which seems to work for native messaging tests. This might need further
// checking in case any issues arise from it.
std::unique_ptr<MessagePort> receiver(
messaging_delegate_->CreateReceiverForNativeApp(
context_, weak_factory_.GetWeakPtr(), source_render_frame_host,
extension->id(), receiver_port_id, native_app_name,
policy_permission == MessagingDelegate::PolicyPermission::ALLOW_ALL,
&error));
if (!receiver.get()) {
// Abandon the channel.
channel->opener->DispatchOnDisconnect(error);
return;
}
channel->receiver = std::move(receiver);
// Keep the opener alive until the channel is closed.
channel->opener->set_should_have_strong_keepalive(true);
channel->opener->IncrementLazyKeepaliveCount(Activity::MESSAGE_PORT);
AddChannel(std::move(channel), receiver_port_id);
#else // !(BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX) ||
// BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID))
const char kNativeMessagingNotSupportedError[] =
"Native Messaging is not supported on this platform.";
opener_port->DispatchOnDisconnect(kNativeMessagingNotSupportedError);
#endif // !(BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX) ||
// BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)
}
void MessageService::OpenChannelToTabImpl(
const ChannelEndpoint& source,
const PortId& source_port_id,
int tab_id,
int frame_id,
const std::string& document_id,
const ExtensionId& extension_id,
mojom::ChannelType channel_type,
const std::string& channel_name,
mojo::PendingAssociatedRemote<extensions::mojom::MessagePort> port,
mojo::PendingAssociatedReceiver<extensions::mojom::MessagePortHost>
port_host) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK_GE(frame_id, -1);
DCHECK(source_port_id.is_opener);
// RenderFrameHost or the worker thread might be gone.
if (!source.IsValid())
return;
std::unique_ptr<ExtensionMessagePort> opener_port =
ExtensionMessagePort::CreateForEndpoint(
weak_factory_.GetWeakPtr(), source_port_id, extension_id, source,
std::move(port), std::move(port_host));
if (!opener_port->IsValidPort())
return;
BrowserContext* source_context = source.browser_context();
DCHECK(
ExtensionsBrowserClient::Get()->IsSameContext(source_context, context_));
content::WebContents* receiver_contents =
messaging_delegate_->GetWebContentsByTabId(source_context, tab_id);
if (!receiver_contents || receiver_contents->GetController().NeedsReload()) {
// The tab isn't loaded yet. Don't attempt to connect.
opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
return;
}
MaybeDisableBackForwardCacheForMessaging(
receiver_contents->GetPrimaryMainFrame());
const PortId receiver_port_id = source_port_id.GetOppositePortId();
std::unique_ptr<MessagePort> receiver = CreateReceiverForTab(
extension_id, receiver_port_id, receiver_contents, frame_id, document_id);
if (!receiver.get()) {
opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
return;
}
const Extension* extension = nullptr;
if (!extension_id.empty()) {
// Source extension == target extension so the extension must exist, or
// where did the IPC come from?
extension = ExtensionRegistry::Get(source_context)
->enabled_extensions()
.GetByID(extension_id);
DCHECK(extension);
}
// `ValidateSourceContextAndExtractExtensionId` is called before coming here.
// Therefore, possible origins are either an extension origin or an opaque
// origin created by an extension. See https://crbug.com/1407087.
url::Origin source_origin = url::Origin();
if (source.is_for_render_frame()) {
source_origin = source.GetRenderFrameHost()->GetLastCommittedOrigin();
} else if (source.is_for_service_worker() && extension) {
source_origin = extension->origin();
}
BrowserContext* receiver_context = receiver_contents->GetBrowserContext();
DCHECK(ExtensionsBrowserClient::Get()->IsSameContext(receiver_context,
context_));
std::unique_ptr<OpenChannelParams> params =
std::make_unique<OpenChannelParams>(
source,
std::nullopt, // No source_tab, as there is no frame.
ExtensionApiFrameIdMap::FrameData(), receiver.release(),
receiver_port_id, MessagingEndpoint::ForExtension(extension_id),
std::move(opener_port), extension_id,
GURL(), // Source URL doesn't make sense for opening to tabs.
source_origin, channel_type, channel_name,
false); // Connections to tabs aren't webview guests.
OpenChannelImpl(receiver_context, std::move(params), extension,
false /* did_enqueue */);
}
std::unique_ptr<MessagePort> MessageService::CreateReceiverForTab(
const ExtensionId& extension_id,
const PortId& receiver_port_id,
content::WebContents* receiver_contents,
int receiver_frame_id,
const std::string& receiver_document_id) {
// Frame ID -1 is every frame in the tab.
bool include_child_frames =
receiver_frame_id == -1 && receiver_document_id.empty();
content::RenderFrameHost* receiver_render_frame_host = nullptr;
if (include_child_frames) {
// The target is the active outermost main frame of the WebContents.
receiver_render_frame_host = receiver_contents->GetPrimaryMainFrame();
} else if (!receiver_document_id.empty()) {
ExtensionApiFrameIdMap::DocumentId document_id =
ExtensionApiFrameIdMap::DocumentIdFromString(receiver_document_id);
// Return early for invalid documentIds.
if (!document_id) {
return nullptr;
}
receiver_render_frame_host =
ExtensionApiFrameIdMap::Get()->GetRenderFrameHostByDocumentId(
document_id);
// If both |document_id| and |receiver_frame_id| are provided they
// should find the same RenderFrameHost, if not return early.
if (receiver_frame_id != -1 &&
ExtensionApiFrameIdMap::GetRenderFrameHostById(receiver_contents,
receiver_frame_id) !=
receiver_render_frame_host) {
return nullptr;
}
} else {
DCHECK_GT(receiver_frame_id, -1);
receiver_render_frame_host = ExtensionApiFrameIdMap::GetRenderFrameHostById(
receiver_contents, receiver_frame_id);
}
if (!receiver_render_frame_host) {
return nullptr;
}
return ExtensionMessagePort::CreateForTab(
weak_factory_.GetWeakPtr(), receiver_port_id, extension_id,
receiver_render_frame_host, include_child_frames);
}
void MessageService::OpenChannelImpl(BrowserContext* browser_context,
std::unique_ptr<OpenChannelParams> params,
const Extension* target_extension,
bool did_enqueue) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK(
ExtensionsBrowserClient::Get()->IsSameContext(browser_context, context_));
DCHECK_EQ(target_extension != nullptr, !params->target_extension_id.empty());
// Check whether the source got closed while in flight.
const ChannelEndpoint& source = params->source;
bool will_open_channel = true;
if (!source.IsValid()) { // Closed while in flight.
will_open_channel = false;
}
if (!params->opener_port->IsValidPort()) {
will_open_channel = false;
}
if (!params->receiver || !params->receiver->IsValidPort()) {
will_open_channel = false;
params->opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
}
auto* message_tracker = MessageTracker::Get(context_);
if (!will_open_channel) {
// The channel won't open. If this was a pending channel, remove it,
// because now it will never open. This prevents the pending message
// from being re-added indefinitely. See https://crbug.com/1231683.
// TODO(crbug.com/40821724): This probably isn't the best solution.
// Ideally, we should close the channel before we get to this point
// if there's no chance it will ever open, remove it from pending
// channels, and then only try to open the pending channel if it's
// still valid.
pending_lazy_context_channels_.erase(
params->receiver_port_id.GetChannelId());
for (const auto& tracking_ids : params->open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_ids, MessageTracker::OpenChannelMessagePipelineResult::
kWillNotOpenChannel);
}
return;
}
const PortContext& port_context = source.port_context();
params->opener_port->OpenPort(source.render_process_id(), port_context);
params->opener_port->RevalidatePort();
// TODO(richardzh) Move this property setting to port creation, or params
// creation, to have cleaner code here.
params->opener_port->set_is_for_onetime_channel(params->is_onetime_channel());
params->receiver->RemoveCommonFrames(*params->opener_port);
if (!params->receiver->IsValidPort()) {
params->opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
for (const auto& tracking_ids : params->open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_ids, MessageTracker::OpenChannelMessagePipelineResult::
kOpenChannelReceiverInvalidPort);
}
return;
}
params->receiver->set_is_for_onetime_channel(params->is_onetime_channel());
std::unique_ptr<MessageChannel> channel_ptr =
std::make_unique<MessageChannel>();
MessageChannel* channel = channel_ptr.get();
channel->opener = std::move(params->opener_port);
channel->receiver = std::move(params->receiver);
AddChannel(std::move(channel_ptr), params->receiver_port_id);
int guest_process_id = content::ChildProcessHost::kInvalidUniqueID;
int guest_render_frame_routing_id = MSG_ROUTING_NONE;
#if BUILDFLAG(ENABLE_GUEST_VIEW)
if (params->include_guest_process_info &&
// TODO(lazyboy): Investigate <webview> SW messaging.
source.is_for_render_frame()) {
guest_process_id = params->source.render_process_id();
DCHECK(port_context.frame);
guest_render_frame_routing_id = port_context.frame->routing_id;
DCHECK(WebViewGuest::FromRenderFrameHost(source.GetRenderFrameHost()));
}
#endif
// Send the connect event to the receiver. Give it the opener's port ID (the
// opener has the opposite port ID).
channel->receiver->DispatchOnConnect(
params->channel_type, params->channel_name, std::move(params->source_tab),
params->source_frame, guest_process_id, guest_render_frame_routing_id,
params->source_endpoint, params->target_extension_id, params->source_url,
params->source_origin, params->open_channel_tracking_ids);
// Report the event to the event router, if the target is an extension.
//
// First, determine what event this will be (runtime.onConnect vs
// runtime.onMessage etc), and what the event target is (view vs background
// page etc).
//
// Yes - even though this is opening a channel, they may actually be
// runtime.onRequest/onMessage events because those single-use events are
// built using the connect framework (see messaging.js).
if (target_extension) {
events::HistogramValue histogram_value = events::UNKNOWN;
bool is_external = MessagingEndpoint::IsExternal(
params->source_endpoint, params->target_extension_id);
if (params->source_endpoint.type == MessagingEndpoint::Type::kNativeApp) {
histogram_value = events::RUNTIME_ON_CONNECT_NATIVE;
} else if (params->channel_name == "chrome.runtime.onRequest") {
histogram_value = is_external ? events::RUNTIME_ON_REQUEST_EXTERNAL
: events::RUNTIME_ON_REQUEST;
} else if (params->channel_name == "chrome.runtime.onMessage") {
histogram_value = is_external ? events::RUNTIME_ON_MESSAGE_EXTERNAL
: events::RUNTIME_ON_MESSAGE;
} else {
histogram_value = is_external ? events::RUNTIME_ON_CONNECT_EXTERNAL
: events::RUNTIME_ON_CONNECT;
}
EventRouter::Get(browser_context)
->ReportEvent(histogram_value, target_extension, did_enqueue);
}
// Check source and target of the connection and grant extended lifetime if
// one of the ends is configured in the
// ExtendedBackgroundLifetimeForPortConnectionsToUrls policy.
std::vector<url::Origin> extended_lifetime_origins =
GetServiceWorkerExtendedLifetimeOrigins(browser_context);
url::Origin source_origin = url::Origin::Create(params->source_url);
url::Origin target_origin =
Extension::CreateOriginFromExtensionId(params->target_extension_id);
for (const url::Origin& origin : extended_lifetime_origins) {
if (origin == source_origin) {
// Opener found in allowlist, keep receiver SW alive.
channel->receiver->set_should_have_strong_keepalive(true);
}
if (origin == target_origin) {
// Receiver found in allowlist, keep opener SW alive.
channel->opener->set_should_have_strong_keepalive(true);
}
}
// Keep both ends of the channel alive until the channel is closed.
channel->opener->IncrementLazyKeepaliveCount(Activity::MESSAGE_PORT);
channel->receiver->IncrementLazyKeepaliveCount(Activity::MESSAGE_PORT);
}
void MessageService::AddChannel(std::unique_ptr<MessageChannel> channel,
const PortId& receiver_port_id) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
ChannelId channel_id = receiver_port_id.GetChannelId();
CHECK(!base::Contains(channels_, channel_id));
channels_[channel_id] = std::move(channel);
pending_lazy_context_channels_.erase(channel_id);
}
void MessageService::OpenPortImpl(const PortId& port_id,
int process_id,
const PortContext& port_context) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK(!port_id.is_opener);
ChannelId channel_id = port_id.GetChannelId();
auto it = channels_.find(channel_id);
if (it == channels_.end())
return;
it->second->receiver->OpenPort(process_id, port_context);
}
void MessageService::CloseChannel(const PortId& port_id,
const std::string& error_message) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
ClosePortImpl(port_id, content::ChildProcessHost::kInvalidUniqueID,
MSG_ROUTING_NONE, kMainThreadId, true, error_message);
}
void MessageService::ClosePort(const PortId& port_id,
int process_id,
const PortContext& port_context,
bool force_close) {
int routing_id =
port_context.frame ? port_context.frame->routing_id : MSG_ROUTING_NONE;
int worker_thread_id =
port_context.worker ? port_context.worker->thread_id : kMainThreadId;
ClosePortImpl(port_id, process_id, routing_id, worker_thread_id, force_close,
std::string());
}
void MessageService::ClosePortImpl(const PortId& port_id,
int process_id,
int routing_id,
int worker_thread_id,
bool force_close,
const std::string& error_message) {
// Note: The channel might be not yet created (if the opener became invalid
// before the channel initialization completed) or already gone (if the other
// side closed first).
ChannelId channel_id = port_id.GetChannelId();
auto it = channels_.find(channel_id);
if (it == channels_.end()) {
auto pending = pending_lazy_context_channels_.find(channel_id);
if (pending != pending_lazy_context_channels_.end()) {
const LazyContextId& context_id = pending->second;
context_id.GetTaskQueue()->AddPendingTask(
context_id,
base::BindOnce(&MessageService::PendingLazyContextClosePort,
weak_factory_.GetWeakPtr(), port_id, process_id,
routing_id, worker_thread_id, force_close,
error_message));
}
return;
}
// The difference between closing a channel and port is that closing a port
// does not necessarily have to destroy the channel if there are multiple
// receivers, whereas closing a channel always forces all ports to be closed.
if (force_close) {
CloseChannelImpl(it, port_id, error_message, true);
} else if (port_id.is_opener) {
it->second->opener->ClosePort(process_id, routing_id, worker_thread_id);
} else {
it->second->receiver->ClosePort(process_id, routing_id, worker_thread_id);
}
}
void MessageService::CloseChannelImpl(MessageChannelMap::iterator channel_iter,
const PortId& closing_port_id,
const std::string& error_message,
bool notify_other_port) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
std::unique_ptr<MessageChannel> channel = std::move(channel_iter->second);
// Remove from map to make sure that it is impossible for CloseChannelImpl to
// run twice for the same channel.
channels_.erase(channel_iter);
// Notify the other side.
if (notify_other_port) {
MessagePort* port = closing_port_id.is_opener ? channel->receiver.get()
: channel->opener.get();
port->DispatchOnDisconnect(error_message);
}
// Balance the IncrementLazyKeepaliveCount() in OpenChannelImpl.
channel->opener->DecrementLazyKeepaliveCount(Activity::MESSAGE_PORT);
channel->receiver->DecrementLazyKeepaliveCount(Activity::MESSAGE_PORT);
}
void MessageService::PostMessage(const PortId& source_port_id,
const Message& message) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
ChannelId channel_id = source_port_id.GetChannelId();
auto iter = channels_.find(channel_id);
if (iter == channels_.end()) {
// If this channel is pending, queue up the PostMessage to run once
// the channel opens.
EnqueuePendingMessage(source_port_id, channel_id, message);
return;
}
DispatchMessage(source_port_id, iter->second.get(), message);
}
void MessageService::EnqueuePendingMessage(const PortId& source_port_id,
const ChannelId& channel_id,
const Message& message) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto pending_for_incognito = pending_incognito_channels_.find(channel_id);
if (pending_for_incognito != pending_incognito_channels_.end()) {
pending_for_incognito->second.push_back(
PendingMessage(source_port_id, message));
// A channel should only be holding pending messages because it is in one
// of these states.
DCHECK(!base::Contains(pending_lazy_context_channels_, channel_id));
return;
}
EnqueuePendingMessageForLazyBackgroundLoad(source_port_id, channel_id,
message);
}
void MessageService::EnqueuePendingMessageForLazyBackgroundLoad(
const PortId& source_port_id,
const ChannelId& channel_id,
const Message& message) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto pending = pending_lazy_context_channels_.find(channel_id);
// The message corresponds to an unknown channel. This could happen if
// renderers shut down in various racy fashions. Drop the message on the
// floor.
if (pending == pending_lazy_context_channels_.end()) {
return;
}
const LazyContextId& context_id = pending->second;
ExtensionRegistry* registry = ExtensionRegistry::Get(context_);
if (!registry->enabled_extensions().Contains(context_id.extension_id())) {
// Similarly, the extension might have been unloaded. Again, drop the
// message on the floor. Possible fix for https://crbug.com/1428987.
// TODO(devlin): Would it make sense to instead clean up
// `pending_lazy_context_channels_` on extension unload instead? If this
// fixes the bug above, investigate.
return;
}
context_id.GetTaskQueue()->AddPendingTask(
context_id,
base::BindOnce(&MessageService::PendingLazyContextPostMessage,
weak_factory_.GetWeakPtr(), source_port_id, message));
}
void MessageService::DispatchMessage(const PortId& source_port_id,
MessageChannel* channel,
const Message& message) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
// Figure out which port the ID corresponds to.
MessagePort* dest_port = source_port_id.is_opener ? channel->receiver.get()
: channel->opener.get();
dest_port->DispatchOnMessage(message);
}
void MessageService::NotifyResponsePending(const PortId& port_id) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK(!port_id.is_opener);
ChannelId channel_id = port_id.GetChannelId();
auto it = channels_.find(channel_id);
if (it == channels_.end())
return;
it->second->receiver->NotifyResponsePending();
}
bool MessageService::MaybeAddPendingLazyContextOpenChannelTask(
BrowserContext* context,
const Extension* extension,
std::unique_ptr<OpenChannelParams>* params,
const PendingMessagesQueue& pending_messages) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
DCHECK(ExtensionsBrowserClient::Get()->IsSameContext(context, context_));
const bool is_event_page = BackgroundInfo::HasLazyBackgroundPage(extension);
bool is_worker_based = false;
if (!is_event_page)
is_worker_based = BackgroundInfo::IsServiceWorkerBased(extension);
if (!is_worker_based && !is_event_page)
return false;
// If the extension uses spanning incognito mode, make sure we're always
// using the original profile since that is what the extension processes
// will use.
if (!IncognitoInfo::IsSplitMode(extension))
context = ExtensionsBrowserClient::Get()->GetOriginalContext(context);
const LazyContextId context_id = LazyContextIdFor(context, extension);
LazyContextTaskQueue* task_queue = context_id.GetTaskQueue();
if (!task_queue->ShouldEnqueueTask(context, extension))
return false;
ChannelId channel_id = (*params)->receiver_port_id.GetChannelId();
pending_lazy_context_channels_.emplace(channel_id, context_id);
base::UnguessableToken open_channel_wakeup_context_tracking_id;
if (is_worker_based) {
// Track only SW context wake up.
open_channel_wakeup_context_tracking_id = base::UnguessableToken::Create();
auto* message_tracker = MessageTracker::Get(context_);
message_tracker->StartTrackingMessagingStage(
open_channel_wakeup_context_tracking_id,
"Extensions.MessagePipeline.OpenChannelWorkerWakeUpStatus",
params->get()->channel_type);
}
task_queue->AddPendingTask(
context_id,
base::BindOnce(&MessageService::PendingLazyContextOpenChannel,
weak_factory_.GetWeakPtr(), std::move(*params),
std::move(open_channel_wakeup_context_tracking_id)));
for (const PendingMessage& message : pending_messages) {
EnqueuePendingMessageForLazyBackgroundLoad(message.first, channel_id,
message.second);
}
return true;
}
void MessageService::OnOpenChannelAllowed(
std::unique_ptr<OpenChannelParams> params,
bool allowed) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
ChannelId channel_id = params->receiver_port_id.GetChannelId();
auto pending_for_incognito = pending_incognito_channels_.find(channel_id);
if (pending_for_incognito == pending_incognito_channels_.end()) {
NOTREACHED();
}
PendingMessagesQueue pending_messages;
pending_messages.swap(pending_for_incognito->second);
pending_incognito_channels_.erase(pending_for_incognito);
auto* message_tracker = MessageTracker::Get(context_);
// Check whether the source got closed while in flight.
const ChannelEndpoint& source = params->source;
// Re-lookup the source process since it may no longer be valid.
if (!source.IsValid()) {
for (const auto& tracking_id : params->open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kOnOpenChannelSourceInvalid);
}
return;
}
if (!params->opener_port->IsValidPort()) {
for (const auto& tracking_id : params->open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kOnOpenChannelOpenerPortInvalid);
}
return;
}
if (!allowed) {
params->opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
for (const auto& tracking_id : params->open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id,
MessageTracker::OpenChannelMessagePipelineResult::kNoReceivers);
}
return;
}
BrowserContext* context = source.browser_context();
DCHECK(ExtensionsBrowserClient::Get()->IsSameContext(context, context_));
ExtensionRegistry* registry = ExtensionRegistry::Get(context);
const Extension* target_extension =
registry->enabled_extensions().GetByID(params->target_extension_id);
if (!target_extension) {
params->opener_port->DispatchOnDisconnect(kReceivingEndDoesntExistError);
for (const auto& tracking_id : params->open_channel_tracking_ids) {
message_tracker->StopTrackingMessagingStage(
tracking_id, MessageTracker::OpenChannelMessagePipelineResult::
kOnOpenChannelExtensionNotEnabled);
}
return;
}
BrowserContext* context_to_use_for_extension =
IncognitoInfo::IsSplitMode(target_extension)
? context
: ExtensionsBrowserClient::Get()->GetOriginalContext(context);
params->receiver = ExtensionMessagePort::CreateForExtension(
weak_factory_.GetWeakPtr(), params->receiver_port_id,
params->target_extension_id, context_to_use_for_extension);
// The target might be a lazy background page or a Service Worker. In that
// case, we have to check if it is loaded and ready, and if not, queue up the
// task and load the page.
if (!MaybeAddPendingLazyContextOpenChannelTask(context, target_extension,
¶ms, pending_messages)) {
OpenChannelImpl(context, std::move(params), target_extension,
false /* did_enqueue */);
DispatchPendingMessages(pending_messages, channel_id);
}
}
void MessageService::PendingLazyContextOpenChannel(
std::unique_ptr<OpenChannelParams> params,
const base::UnguessableToken& open_channel_wakeup_context_tracking_id,
std::unique_ptr<LazyContextTaskQueue::ContextInfo> context_info) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
if (context_info == nullptr)
return; // TODO(mpcomplete): notify source of disconnect?
// Finish tracking SW context wake up.
if (!open_channel_wakeup_context_tracking_id.is_empty()) {
auto* message_tracker = MessageTracker::Get(context_);
message_tracker->StopTrackingMessagingStage(
open_channel_wakeup_context_tracking_id,
MessageTracker::OpenChannelMessagePipelineResult::kWorkerStarted);
}
params->receiver = ExtensionMessagePort::CreateForExtension(
weak_factory_.GetWeakPtr(), params->receiver_port_id,
params->target_extension_id, context_info->browser_context);
const Extension* const extension =
ExtensionRegistry::Get(context_info->browser_context)
->enabled_extensions()
.GetByID(context_info->extension_id);
// Verify the lazy context is properly registered. Otherwise, we'll fail to
// find it when we try to connect.
VerifyLazyContextActive(extension, *context_info);
OpenChannelImpl(context_info->browser_context, std::move(params), extension,
true /* did_enqueue */);
}
void MessageService::DispatchPendingMessages(const PendingMessagesQueue& queue,
const ChannelId& channel_id) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto channel_iter = channels_.find(channel_id);
if (channel_iter != channels_.end()) {
for (const PendingMessage& message : queue) {
DispatchMessage(message.first, channel_iter->second.get(),
message.second);
}
}
}
} // namespace extensions
|