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
|
// Copyright 2014 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/zipfile_installer.h"
#include <optional>
#include <variant>
#include "base/containers/contains.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/json/json_reader.h"
#include "base/path_service.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/sequenced_task_runner.h"
#include "base/values.h"
#include "components/services/unzip/content/unzip_service.h"
#include "components/services/unzip/public/cpp/unzip.h"
#include "components/services/unzip/public/mojom/unzipper.mojom.h"
#include "extensions/browser/extension_file_task_runner.h"
#include "extensions/common/constants.h"
#include "extensions/common/error_utils.h"
#include "extensions/common/extension_features.h"
#include "extensions/common/manifest.h"
#include "extensions/strings/grit/extensions_strings.h"
#include "ui/base/l10n/l10n_util.h"
namespace extensions {
namespace {
constexpr char kExtensionHandlerUnpackedDirCreationError[] =
"Failed to create root unpacked directory * for "
"zip file: *. Encountered error: *.";
constexpr char kExtensionHandlerZippedDirError[] =
"Could not create directory * for zipped extension.";
constexpr char kExtensionHandlerFileUnzipError[] =
"Could not unzip extension for install.";
constexpr const base::FilePath::CharType* kAllowedThemeFiletypes[] = {
FILE_PATH_LITERAL(".bmp"), FILE_PATH_LITERAL(".gif"),
FILE_PATH_LITERAL(".jpeg"), FILE_PATH_LITERAL(".jpg"),
FILE_PATH_LITERAL(".json"), FILE_PATH_LITERAL(".png"),
FILE_PATH_LITERAL(".webp")};
// Creates a unique directory based on `zip_file` inside `root_unzip_dir`.
// Directory format is (`zip_file` == "myzip.zip"):
// <`root_unzip_dir`>/myzip_XXXXXX
// XXXXXX is populated with mkdtemp() logic.
ZipResultVariant PrepareAndGetUnzipDir(const base::FilePath& zip_file,
const base::FilePath& root_unzip_dir) {
// Create `root_unzip_dir`. This should only occur once per profile as
// CreateDirectoryAndGetError check for `root_unzip_dir` to exist first.
base::File::Error root_unzip_dir_creation_error;
if (!base::CreateDirectoryAndGetError(root_unzip_dir,
&root_unzip_dir_creation_error)) {
return ZipResultVariant{ErrorUtils::FormatErrorMessage(
kExtensionHandlerUnpackedDirCreationError,
base::UTF16ToUTF8(root_unzip_dir.LossyDisplayName()),
base::UTF16ToUTF8(zip_file.LossyDisplayName()),
base::File::ErrorToString(root_unzip_dir_creation_error))};
}
// Create the root of the unique directory for the .zip file.
base::FilePath::StringType dir_name =
zip_file.RemoveExtension().BaseName().value() + FILE_PATH_LITERAL("_");
// Creates the full unique directory path as unzip_dir.
base::FilePath unzip_dir;
if (!base::CreateTemporaryDirInDir(root_unzip_dir, dir_name, &unzip_dir)) {
return ZipResultVariant{ErrorUtils::FormatErrorMessage(
kExtensionHandlerZippedDirError,
base::UTF16ToUTF8(unzip_dir.LossyDisplayName()))};
}
return ZipResultVariant{unzip_dir};
}
std::optional<std::string> ReadFileContent(const base::FilePath& path) {
std::string content;
return base::ReadFileToString(path, &content) ? content
: std::optional<std::string>();
}
} // namespace
// static
scoped_refptr<ZipFileInstaller> ZipFileInstaller::Create(
const scoped_refptr<base::SequencedTaskRunner>& io_task_runner,
DoneCallback done_callback) {
DCHECK(done_callback);
return base::WrapRefCounted(
new ZipFileInstaller(io_task_runner, std::move(done_callback)));
}
void ZipFileInstaller::InstallZipFileToUnpackedExtensionsDir(
const base::FilePath& zip_file,
const base::FilePath& unpacked_extensions_dir) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!unpacked_extensions_dir.empty());
LoadFromZipFileImpl(zip_file, unpacked_extensions_dir,
/*create_unzip_dir=*/true);
}
void ZipFileInstaller::LoadFromZipFileInDir(const base::FilePath& zip_file,
const base::FilePath& unzip_dir) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!unzip_dir.empty());
LoadFromZipFileImpl(zip_file, unzip_dir);
}
void ZipFileInstaller::LoadFromZipFileImpl(const base::FilePath& zip_file,
const base::FilePath& unzip_dir,
bool create_unzip_dir) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!zip_file.empty());
zip_file_ = zip_file;
if (create_unzip_dir) {
io_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&PrepareAndGetUnzipDir, zip_file, unzip_dir),
base::BindOnce(&ZipFileInstaller::Unzip, this));
return;
}
// Unzip dir should exist so unzip directly there.
// ZipResultVariant result = ZipResultVariant{unzip_dir};
Unzip(ZipResultVariant{unzip_dir});
}
ZipFileInstaller::ZipFileInstaller(
const scoped_refptr<base::SequencedTaskRunner>& io_task_runner,
DoneCallback done_callback)
: done_callback_(std::move(done_callback)),
io_task_runner_(io_task_runner) {}
ZipFileInstaller::~ZipFileInstaller() = default;
void ZipFileInstaller::Unzip(ZipResultVariant unzip_dir_or_error) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (std::holds_alternative<std::string>(unzip_dir_or_error)) {
ReportFailure(std::get<std::string>(unzip_dir_or_error));
return;
}
base::FilePath unzip_dir = std::get<base::FilePath>(unzip_dir_or_error);
unzip::Unzip(
unzip::LaunchUnzipper(), zip_file_, unzip_dir,
unzip::mojom::UnzipOptions::New(),
base::BindRepeating(&ZipFileInstaller::IsManifestFile), base::DoNothing(),
base::BindOnce(&ZipFileInstaller::ManifestUnzipped, this, unzip_dir));
}
void ZipFileInstaller::ManifestUnzipped(const base::FilePath& unzip_dir,
bool success) {
if (!success) {
ReportFailure(kExtensionHandlerFileUnzipError);
return;
}
io_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&ReadFileContent, unzip_dir.Append(kManifestFilename)),
base::BindOnce(&ZipFileInstaller::ManifestRead, this, unzip_dir));
}
void ZipFileInstaller::ManifestRead(
const base::FilePath& unzip_dir,
std::optional<std::string> manifest_content) {
if (!manifest_content) {
ReportFailure(std::string(kExtensionHandlerFileUnzipError));
return;
}
std::optional<base::Value> result = base::JSONReader::Read(*manifest_content);
if (!result || !result->is_dict()) {
ReportFailure(std::string(kExtensionHandlerFileUnzipError));
return;
}
Manifest::Type manifest_type =
Manifest::GetTypeFromManifestValue(result->GetDict());
unzip::UnzipFilterCallback filter = base::BindRepeating(
[](bool is_theme, const base::FilePath& file_path) -> bool {
// Note that we ignore the manifest as it has already been extracted and
// would cause the unzipping to fail.
return ZipFileInstaller::ShouldExtractFile(is_theme, file_path) &&
!ZipFileInstaller::IsManifestFile(file_path);
},
manifest_type == Manifest::TYPE_THEME);
// TODO(crbug.com/41274425): This silently ignores blocked file types.
// Add install warnings.
unzip::Unzip(unzip::LaunchUnzipper(), zip_file_, unzip_dir,
unzip::mojom::UnzipOptions::New(), filter, base::DoNothing(),
base::BindOnce(&ZipFileInstaller::UnzipDone, this, unzip_dir));
}
void ZipFileInstaller::UnzipDone(const base::FilePath& unzip_dir,
bool success) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!success) {
ReportFailure(kExtensionHandlerFileUnzipError);
return;
}
std::move(done_callback_).Run(zip_file_, unzip_dir, std::string());
}
void ZipFileInstaller::ReportFailure(const std::string& error) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::move(done_callback_).Run(zip_file_, base::FilePath(), error);
}
// static
bool ZipFileInstaller::ShouldExtractFile(bool is_theme,
const base::FilePath& file_path) {
if (is_theme) {
const base::FilePath::StringType extension =
base::ToLowerASCII(file_path.FinalExtension());
// Allow filenames with no extension.
if (extension.empty()) {
return true;
}
return base::Contains(kAllowedThemeFiletypes, extension);
}
return !base::FilePath::CompareEqualIgnoreCase(file_path.FinalExtension(),
FILE_PATH_LITERAL(".exe"));
}
// static
bool ZipFileInstaller::IsManifestFile(const base::FilePath& file_path) {
CHECK(!file_path.IsAbsolute());
return base::FilePath::CompareEqualIgnoreCase(file_path.value(),
kManifestFilename);
}
} // namespace extensions
|