blob: 6c1a6de408e82db3336648ba47e233eb9cd9689a [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stddef.h>
#include <memory>
#include <string>
#include <utility>
#include "base/command_line.h"
#include "base/files/file_util.h"
#include "base/macros.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/test/test_file_util.h"
#include "base/test/values_test_util.h"
#include "base/values.h"
#include "chrome/browser/extensions/chrome_content_verifier_delegate.h"
#include "chrome/common/chrome_paths.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/test/base/testing_profile.h"
#include "components/crx_file/id_util.h"
#include "content/public/browser/resource_request_info.h"
#include "content/public/common/previews_state.h"
#include "content/public/test/mock_resource_context.h"
#include "content/public/test/test_browser_thread_bundle.h"
#include "content/public/test/test_utils.h"
#include "extensions/browser/content_verifier.h"
#include "extensions/browser/content_verifier/test_utils.h"
#include "extensions/browser/extension_protocols.h"
#include "extensions/browser/info_map.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_builder.h"
#include "extensions/common/extension_paths.h"
#include "extensions/common/file_util.h"
#include "extensions/test/test_extension_dir.h"
#include "net/base/request_priority.h"
#include "net/traffic_annotation/network_traffic_annotation_test_helper.h"
#include "net/url_request/url_request.h"
#include "net/url_request/url_request_job_factory_impl.h"
#include "net/url_request/url_request_status.h"
#include "net/url_request/url_request_test_util.h"
#include "testing/gtest/include/gtest/gtest.h"
using content::ResourceType;
namespace extensions {
namespace {
base::FilePath GetTestPath(const std::string& name) {
base::FilePath path;
EXPECT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &path));
return path.AppendASCII("extensions").AppendASCII(name);
}
base::FilePath GetContentVerifierTestPath() {
base::FilePath path;
EXPECT_TRUE(PathService::Get(extensions::DIR_TEST_DATA, &path));
return path.AppendASCII("content_hash_fetcher")
.AppendASCII("different_sized_files");
}
scoped_refptr<Extension> CreateTestExtension(const std::string& name,
bool incognito_split_mode) {
base::DictionaryValue manifest;
manifest.SetString("name", name);
manifest.SetString("version", "1");
manifest.SetInteger("manifest_version", 2);
manifest.SetString("incognito", incognito_split_mode ? "split" : "spanning");
base::FilePath path = GetTestPath("response_headers");
std::string error;
scoped_refptr<Extension> extension(
Extension::Create(path, Manifest::INTERNAL, manifest,
Extension::NO_FLAGS, &error));
EXPECT_TRUE(extension.get()) << error;
return extension;
}
scoped_refptr<Extension> CreateWebStoreExtension() {
base::DictionaryValue manifest;
manifest.SetString("name", "WebStore");
manifest.SetString("version", "1");
manifest.SetString("icons.16", "webstore_icon_16.png");
base::FilePath path;
EXPECT_TRUE(PathService::Get(chrome::DIR_RESOURCES, &path));
path = path.AppendASCII("web_store");
std::string error;
scoped_refptr<Extension> extension(
Extension::Create(path, Manifest::COMPONENT, manifest,
Extension::NO_FLAGS, &error));
EXPECT_TRUE(extension.get()) << error;
return extension;
}
scoped_refptr<Extension> CreateTestResponseHeaderExtension() {
base::DictionaryValue manifest;
manifest.SetString("name", "An extension with web-accessible resources");
manifest.SetString("version", "2");
auto web_accessible_list = std::make_unique<base::ListValue>();
web_accessible_list->AppendString("test.dat");
manifest.Set("web_accessible_resources", std::move(web_accessible_list));
base::FilePath path = GetTestPath("response_headers");
std::string error;
scoped_refptr<Extension> extension(
Extension::Create(path, Manifest::UNPACKED, manifest,
Extension::NO_FLAGS, &error));
EXPECT_TRUE(extension.get()) << error;
return extension;
}
} // namespace
// This test lives in src/chrome instead of src/extensions because it tests
// functionality delegated back to Chrome via ChromeExtensionsBrowserClient.
// See chrome/browser/extensions/chrome_url_request_util.cc.
class ExtensionProtocolsTest : public testing::Test {
public:
ExtensionProtocolsTest()
: thread_bundle_(content::TestBrowserThreadBundle::IO_MAINLOOP),
old_factory_(NULL),
resource_context_(&test_url_request_context_) {}
void SetUp() override {
testing::Test::SetUp();
testing_profile_ = TestingProfile::Builder().Build();
extension_info_map_ = new InfoMap();
net::URLRequestContext* request_context =
resource_context_.GetRequestContext();
old_factory_ = request_context->job_factory();
// Set up content verification.
base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
command_line->AppendSwitchASCII(
switches::kExtensionContentVerification,
switches::kExtensionContentVerificationEnforce);
content_verifier_ = new ContentVerifier(
testing_profile_.get(), std::make_unique<ChromeContentVerifierDelegate>(
testing_profile_.get()));
extension_info_map_->SetContentVerifier(content_verifier_.get());
}
void TearDown() override {
net::URLRequestContext* request_context =
resource_context_.GetRequestContext();
request_context->set_job_factory(old_factory_);
content_verifier_->Shutdown();
}
void SetProtocolHandler(bool is_incognito) {
net::URLRequestContext* request_context =
resource_context_.GetRequestContext();
job_factory_.SetProtocolHandler(
kExtensionScheme,
CreateExtensionProtocolHandler(is_incognito,
extension_info_map_.get()));
request_context->set_job_factory(&job_factory_);
}
void StartRequest(net::URLRequest* request,
ResourceType resource_type) {
content::ResourceRequestInfo::AllocateForTesting(
request, resource_type, &resource_context_,
/*render_process_id=*/-1,
/*render_view_id=*/-1,
/*render_frame_id=*/-1,
/*is_main_frame=*/resource_type == content::RESOURCE_TYPE_MAIN_FRAME,
/*allow_download=*/true,
/*is_async=*/false, content::PREVIEWS_OFF,
/*navigation_ui_data*/ nullptr);
request->Start();
base::RunLoop().Run();
}
// Helper method to create a URLRequest, call StartRequest on it, and return
// the result. If |extension| hasn't already been added to
// |extension_info_map_|, this will add it.
int DoRequest(const Extension& extension, const std::string& relative_path) {
if (!extension_info_map_->extensions().Contains(extension.id())) {
extension_info_map_->AddExtension(&extension,
base::Time::Now(),
false, // incognito_enabled
false); // notifications_disabled
}
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension.GetResourceURL(relative_path), net::DEFAULT_PRIORITY,
&test_delegate_, TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MAIN_FRAME);
return test_delegate_.request_status();
}
protected:
content::TestBrowserThreadBundle thread_bundle_;
scoped_refptr<InfoMap> extension_info_map_;
net::URLRequestJobFactoryImpl job_factory_;
const net::URLRequestJobFactory* old_factory_;
net::TestDelegate test_delegate_;
net::TestURLRequestContext test_url_request_context_;
content::MockResourceContext resource_context_;
scoped_refptr<ContentVerifier> content_verifier_;
std::unique_ptr<TestingProfile> testing_profile_;
};
// Tests that making a chrome-extension request in an incognito context is
// only allowed under the right circumstances (if the extension is allowed
// in incognito, and it's either a non-main-frame request or a split-mode
// extension).
TEST_F(ExtensionProtocolsTest, IncognitoRequest) {
// Register an incognito extension protocol handler.
SetProtocolHandler(true);
struct TestCase {
// Inputs.
std::string name;
bool incognito_split_mode;
bool incognito_enabled;
// Expected results.
bool should_allow_main_frame_load;
bool should_allow_sub_frame_load;
} cases[] = {
{"spanning disabled", false, false, false, false},
{"split disabled", true, false, false, false},
{"spanning enabled", false, true, false, false},
{"split enabled", true, true, true, false},
};
for (size_t i = 0; i < arraysize(cases); ++i) {
scoped_refptr<Extension> extension =
CreateTestExtension(cases[i].name, cases[i].incognito_split_mode);
extension_info_map_->AddExtension(
extension.get(), base::Time::Now(), cases[i].incognito_enabled, false);
// First test a main frame request.
{
// It doesn't matter that the resource doesn't exist. If the resource
// is blocked, we should see BLOCKED_BY_CLIENT. Otherwise, the request
// should just fail because the file doesn't exist.
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL("404.html"), net::DEFAULT_PRIORITY,
&test_delegate_, TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MAIN_FRAME);
if (cases[i].should_allow_main_frame_load) {
EXPECT_EQ(net::ERR_FILE_NOT_FOUND, test_delegate_.request_status())
<< cases[i].name;
} else {
EXPECT_EQ(net::ERR_BLOCKED_BY_CLIENT, test_delegate_.request_status())
<< cases[i].name;
}
}
// Subframe navigation requests are blocked in ExtensionNavigationThrottle
// which isn't added in this unit test. This is tested in an integration
// test in ExtensionResourceRequestPolicyTest.IframeNavigateToInaccessible.
}
}
void CheckForContentLengthHeader(net::URLRequest* request) {
std::string content_length;
request->GetResponseHeaderByName(net::HttpRequestHeaders::kContentLength,
&content_length);
EXPECT_FALSE(content_length.empty());
int length_value = 0;
EXPECT_TRUE(base::StringToInt(content_length, &length_value));
EXPECT_GT(length_value, 0);
}
// Tests getting a resource for a component extension works correctly, both when
// the extension is enabled and when it is disabled.
TEST_F(ExtensionProtocolsTest, ComponentResourceRequest) {
// Register a non-incognito extension protocol handler.
SetProtocolHandler(false);
scoped_refptr<Extension> extension = CreateWebStoreExtension();
extension_info_map_->AddExtension(extension.get(),
base::Time::Now(),
false,
false);
// First test it with the extension enabled.
{
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL("webstore_icon_16.png"),
net::DEFAULT_PRIORITY, &test_delegate_,
TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MEDIA);
EXPECT_EQ(net::OK, test_delegate_.request_status());
CheckForContentLengthHeader(request.get());
std::string mime_type;
request->GetResponseHeaderByName(net::HttpRequestHeaders::kContentType,
&mime_type);
EXPECT_EQ("image/png", mime_type);
}
// And then test it with the extension disabled.
extension_info_map_->RemoveExtension(extension->id(),
UnloadedExtensionReason::DISABLE);
{
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL("webstore_icon_16.png"),
net::DEFAULT_PRIORITY, &test_delegate_,
TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MEDIA);
EXPECT_EQ(net::OK, test_delegate_.request_status());
CheckForContentLengthHeader(request.get());
std::string mime_type;
request->GetResponseHeaderByName(net::HttpRequestHeaders::kContentType,
&mime_type);
EXPECT_EQ("image/png", mime_type);
}
}
// Tests that a URL request for resource from an extension returns a few
// expected response headers.
TEST_F(ExtensionProtocolsTest, ResourceRequestResponseHeaders) {
// Register a non-incognito extension protocol handler.
SetProtocolHandler(false);
scoped_refptr<Extension> extension = CreateTestResponseHeaderExtension();
extension_info_map_->AddExtension(extension.get(),
base::Time::Now(),
false,
false);
{
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL("test.dat"), net::DEFAULT_PRIORITY,
&test_delegate_, TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MEDIA);
EXPECT_EQ(net::OK, test_delegate_.request_status());
// Check that cache-related headers are set.
std::string etag;
request->GetResponseHeaderByName("ETag", &etag);
EXPECT_TRUE(base::StartsWith(etag, "\"", base::CompareCase::SENSITIVE));
EXPECT_TRUE(base::EndsWith(etag, "\"", base::CompareCase::SENSITIVE));
std::string revalidation_header;
request->GetResponseHeaderByName("cache-control", &revalidation_header);
EXPECT_EQ("no-cache", revalidation_header);
// We set test.dat as web-accessible, so it should have a CORS header.
std::string access_control;
request->GetResponseHeaderByName("Access-Control-Allow-Origin",
&access_control);
EXPECT_EQ("*", access_control);
}
}
// Tests that a URL request for main frame or subframe from an extension
// succeeds, but subresources fail. See http://crbug.com/312269.
TEST_F(ExtensionProtocolsTest, AllowFrameRequests) {
// Register a non-incognito extension protocol handler.
SetProtocolHandler(false);
scoped_refptr<Extension> extension = CreateTestExtension("foo", false);
extension_info_map_->AddExtension(extension.get(),
base::Time::Now(),
false,
false);
// All MAIN_FRAME requests should succeed. SUB_FRAME requests that are not
// explicitly listed in web_accesible_resources or same-origin to the parent
// should not succeed.
{
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL("test.dat"), net::DEFAULT_PRIORITY,
&test_delegate_, TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MAIN_FRAME);
EXPECT_EQ(net::OK, test_delegate_.request_status());
}
// Subframe navigation requests are blocked in ExtensionNavigationThrottle
// which isn't added in this unit test. This is tested in an integration test
// in ExtensionResourceRequestPolicyTest.IframeNavigateToInaccessible.
// And subresource types, such as media, should fail.
{
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL("test.dat"), net::DEFAULT_PRIORITY,
&test_delegate_, TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_MEDIA);
EXPECT_EQ(net::ERR_BLOCKED_BY_CLIENT, test_delegate_.request_status());
}
}
TEST_F(ExtensionProtocolsTest, MetadataFolder) {
SetProtocolHandler(false);
base::FilePath extension_dir = GetTestPath("metadata_folder");
std::string error;
scoped_refptr<Extension> extension =
file_util::LoadExtension(extension_dir, Manifest::INTERNAL,
Extension::NO_FLAGS, &error);
ASSERT_NE(extension.get(), nullptr) << "error: " << error;
// Loading "/test.html" should succeed.
EXPECT_EQ(net::OK, DoRequest(*extension, "test.html"));
// Loading "/_metadata/verified_contents.json" should fail.
base::FilePath relative_path =
base::FilePath(kMetadataFolder).Append(kVerifiedContentsFilename);
EXPECT_TRUE(base::PathExists(extension_dir.Append(relative_path)));
EXPECT_EQ(net::ERR_FAILED,
DoRequest(*extension, relative_path.AsUTF8Unsafe()));
// Loading "/_metadata/a.txt" should also fail.
relative_path = base::FilePath(kMetadataFolder).AppendASCII("a.txt");
EXPECT_TRUE(base::PathExists(extension_dir.Append(relative_path)));
EXPECT_EQ(net::ERR_FAILED,
DoRequest(*extension, relative_path.AsUTF8Unsafe()));
}
// Tests that unreadable files and deleted files correctly go through
// ContentVerifyJob.
TEST_F(ExtensionProtocolsTest, VerificationSeenForFileAccessErrors) {
SetProtocolHandler(false);
// Unzip extension containing verification hashes to a temporary directory.
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::FilePath unzipped_path = temp_dir.GetPath();
scoped_refptr<Extension> extension =
content_verifier_test_utils::UnzipToDirAndLoadExtension(
GetContentVerifierTestPath().AppendASCII("source.zip"),
unzipped_path);
ASSERT_TRUE(extension.get());
ExtensionId extension_id = extension->id();
const std::string kJs("1024.js");
base::FilePath kRelativePath(FILE_PATH_LITERAL("1024.js"));
// Valid and readable 1024.js.
{
TestContentVerifyJobObserver observer(extension_id, kRelativePath);
content_verifier_->OnExtensionLoaded(testing_profile_.get(),
extension.get());
// Wait for PostTask to ContentVerifierIOData::AddData() to finish.
content::RunAllPendingInMessageLoop();
EXPECT_EQ(net::OK, DoRequest(*extension, kJs));
EXPECT_EQ(ContentVerifyJob::NONE, observer.WaitForJobFinished());
}
// chmod -r 1024.js.
{
TestContentVerifyJobObserver observer(extension->id(), kRelativePath);
base::FilePath file_path = unzipped_path.AppendASCII(kJs);
ASSERT_TRUE(base::MakeFileUnreadable(file_path));
EXPECT_EQ(net::ERR_ACCESS_DENIED, DoRequest(*extension, kJs));
EXPECT_EQ(ContentVerifyJob::HASH_MISMATCH, observer.WaitForJobFinished());
// NOTE: In production, hash mismatch would have disabled |extension|, but
// since UnzipToDirAndLoadExtension() doesn't add the extension to
// ExtensionRegistry, ChromeContentVerifierDelegate won't disable it.
// TODO(lazyboy): We may want to update this to more closely reflect the
// real flow.
}
// Delete 1024.js.
{
TestContentVerifyJobObserver observer(extension_id, kRelativePath);
base::FilePath file_path = unzipped_path.AppendASCII(kJs);
ASSERT_TRUE(base::DieFileDie(file_path, false));
EXPECT_EQ(net::ERR_FILE_NOT_FOUND, DoRequest(*extension, kJs));
EXPECT_EQ(ContentVerifyJob::HASH_MISMATCH, observer.WaitForJobFinished());
}
}
// Tests that zero byte files correctly go through ContentVerifyJob.
TEST_F(ExtensionProtocolsTest, VerificationSeenForZeroByteFile) {
SetProtocolHandler(false);
const std::string kEmptyJs("empty.js");
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::FilePath unzipped_path = temp_dir.GetPath();
scoped_refptr<Extension> extension =
content_verifier_test_utils::UnzipToDirAndLoadExtension(
GetContentVerifierTestPath().AppendASCII("source.zip"),
unzipped_path);
ASSERT_TRUE(extension.get());
base::FilePath kRelativePath(FILE_PATH_LITERAL("empty.js"));
ExtensionId extension_id = extension->id();
// Sanity check empty.js.
base::FilePath file_path = unzipped_path.AppendASCII(kEmptyJs);
int64_t foo_file_size = -1;
ASSERT_TRUE(base::GetFileSize(file_path, &foo_file_size));
ASSERT_EQ(0, foo_file_size);
// Request empty.js.
{
TestContentVerifyJobObserver observer(extension_id, kRelativePath);
content_verifier_->OnExtensionLoaded(testing_profile_.get(),
extension.get());
// Wait for PostTask to ContentVerifierIOData::AddData() to finish.
content::RunAllPendingInMessageLoop();
EXPECT_EQ(net::OK, DoRequest(*extension, kEmptyJs));
EXPECT_EQ(ContentVerifyJob::NONE, observer.WaitForJobFinished());
}
// chmod -r empty.js.
// Unreadable empty file doesn't generate hash mismatch. Note that this is the
// current behavior of ContentVerifyJob.
// TODO(lazyboy): The behavior is probably incorrect.
{
TestContentVerifyJobObserver observer(extension->id(), kRelativePath);
base::FilePath file_path = unzipped_path.AppendASCII(kEmptyJs);
ASSERT_TRUE(base::MakeFileUnreadable(file_path));
EXPECT_EQ(net::ERR_ACCESS_DENIED, DoRequest(*extension, kEmptyJs));
EXPECT_EQ(ContentVerifyJob::NONE, observer.WaitForJobFinished());
}
// rm empty.js.
// Deleted empty file doesn't generate hash mismatch. Note that this is the
// current behavior of ContentVerifyJob.
// TODO(lazyboy): The behavior is probably incorrect.
{
TestContentVerifyJobObserver observer(extension_id, kRelativePath);
base::FilePath file_path = unzipped_path.AppendASCII(kEmptyJs);
ASSERT_TRUE(base::DieFileDie(file_path, false));
EXPECT_EQ(net::ERR_FILE_NOT_FOUND, DoRequest(*extension, kEmptyJs));
EXPECT_EQ(ContentVerifyJob::NONE, observer.WaitForJobFinished());
}
}
// Tests that mime types are properly set for returned extension resources.
TEST_F(ExtensionProtocolsTest, MimeTypesForKnownFiles) {
// Register a non-incognito extension protocol handler.
SetProtocolHandler(false);
TestExtensionDir test_dir;
constexpr char kManifest[] = R"(
{
"name": "Test Ext",
"description": "A test extension",
"manifest_version": 2,
"version": "0.1",
"web_accessible_resources": ["*"]
})";
test_dir.WriteManifest(kManifest);
std::unique_ptr<base::DictionaryValue> manifest =
base::DictionaryValue::From(base::test::ParseJson(kManifest));
ASSERT_TRUE(manifest);
test_dir.WriteFile(FILE_PATH_LITERAL("json_file.json"), "{}");
test_dir.WriteFile(FILE_PATH_LITERAL("js_file.js"), "function() {}");
base::FilePath unpacked_path = test_dir.UnpackedPath();
ASSERT_TRUE(base::PathExists(unpacked_path.AppendASCII("json_file.json")));
std::string error;
scoped_refptr<const Extension> extension =
ExtensionBuilder()
.SetManifest(std::move(manifest))
.SetPath(unpacked_path)
.SetLocation(Manifest::INTERNAL)
.Build();
ASSERT_TRUE(extension);
extension_info_map_->AddExtension(extension.get(), base::Time::Now(), false,
false);
struct {
const char* file_name;
const char* expected_mime_type;
} test_cases[] = {
{"json_file.json", "application/json"},
{"js_file.js", "application/javascript"},
};
for (const auto& test_case : test_cases) {
SCOPED_TRACE(test_case.file_name);
std::unique_ptr<net::URLRequest> request(
resource_context_.GetRequestContext()->CreateRequest(
extension->GetResourceURL(test_case.file_name),
net::DEFAULT_PRIORITY, &test_delegate_,
TRAFFIC_ANNOTATION_FOR_TESTS));
StartRequest(request.get(), content::RESOURCE_TYPE_SUB_RESOURCE);
EXPECT_EQ(net::OK, test_delegate_.request_status());
std::string mime_type;
request->GetResponseHeaderByName(net::HttpRequestHeaders::kContentType,
&mime_type);
EXPECT_EQ(test_case.expected_mime_type, mime_type);
}
}
} // namespace extensions