forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sw_reporter_installer_win.cc
497 lines (433 loc) · 18.8 KB
/
sw_reporter_installer_win.cc
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
// Copyright (c) 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 "chrome/browser/component_updater/sw_reporter_installer_win.h"
#include <stdint.h>
#include <algorithm>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/base64.h"
#include "base/base_paths.h"
#include "base/bind.h"
#include "base/command_line.h"
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/memory/ref_counted.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/path_service.h"
#include "base/rand_util.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_tokenizer.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/threading/thread_task_runner_handle.h"
#include "base/time/time.h"
#include "base/win/registry.h"
#include "base/win/windows_version.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/safe_browsing/chrome_cleaner/chrome_cleaner_controller_win.h"
#include "chrome/browser/safe_browsing/chrome_cleaner/reporter_runner_win.h"
#include "chrome/browser/safe_browsing/chrome_cleaner/srt_field_trial_win.h"
#include "components/chrome_cleaner/public/constants/constants.h"
#include "components/component_updater/component_updater_paths.h"
#include "components/component_updater/component_updater_service.h"
#include "components/component_updater/pref_names.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/update_client/update_client.h"
#include "components/update_client/utils.h"
#include "components/variations/variations_associated_data.h"
#include "content/public/browser/browser_thread.h"
namespace component_updater {
namespace {
using safe_browsing::SwReporterInvocation;
using safe_browsing::SwReporterInvocationSequence;
// These values are used to send UMA information and are replicated in the
// histograms.xml file, so the order MUST NOT CHANGE.
enum SRTCompleted {
SRT_COMPLETED_NOT_YET = 0,
SRT_COMPLETED_YES = 1,
SRT_COMPLETED_LATER = 2,
SRT_COMPLETED_MAX,
};
// CRX hash. The extension id is: gkmgaooipdjhmangpemjhigmamcehddo. The hash was
// generated in Python with something like this:
// hashlib.sha256().update(open("<file>.crx").read()[16:16+294]).digest().
const uint8_t kSha256Hash[] = {0x6a, 0xc6, 0x0e, 0xe8, 0xf3, 0x97, 0xc0, 0xd6,
0xf4, 0xc9, 0x78, 0x6c, 0x0c, 0x24, 0x73, 0x3e,
0x05, 0xa5, 0x62, 0x4b, 0x2e, 0xc7, 0xb7, 0x1c,
0x5f, 0xea, 0xf0, 0x88, 0xf6, 0x97, 0x9b, 0xc7};
const base::FilePath::CharType kSwReporterExeName[] =
FILE_PATH_LITERAL("software_reporter_tool.exe");
void SRTHasCompleted(SRTCompleted value) {
UMA_HISTOGRAM_ENUMERATION("SoftwareReporter.Cleaner.HasCompleted", value,
SRT_COMPLETED_MAX);
}
void ReportUploadsWithUma(const base::string16& upload_results) {
base::WStringTokenizer tokenizer(upload_results, L";");
int failure_count = 0;
int success_count = 0;
int longest_failure_run = 0;
int current_failure_run = 0;
bool last_result = false;
while (tokenizer.GetNext()) {
if (tokenizer.token_piece() == L"0") {
++failure_count;
++current_failure_run;
last_result = false;
} else {
++success_count;
current_failure_run = 0;
last_result = true;
}
if (current_failure_run > longest_failure_run)
longest_failure_run = current_failure_run;
}
UMA_HISTOGRAM_COUNTS_100("SoftwareReporter.UploadFailureCount",
failure_count);
UMA_HISTOGRAM_COUNTS_100("SoftwareReporter.UploadSuccessCount",
success_count);
UMA_HISTOGRAM_COUNTS_100("SoftwareReporter.UploadLongestFailureRun",
longest_failure_run);
UMA_HISTOGRAM_BOOLEAN("SoftwareReporter.LastUploadResult", last_result);
}
void ReportExperimentError(SoftwareReporterExperimentError error) {
UMA_HISTOGRAM_ENUMERATION("SoftwareReporter.ExperimentErrors", error,
SW_REPORTER_EXPERIMENT_ERROR_MAX);
}
// Ensures |str| contains only alphanumeric characters and characters from
// |extras|, and is not longer than |max_length|.
bool ValidateString(const std::string& str,
const std::string& extras,
size_t max_length) {
return str.size() <= max_length &&
std::all_of(str.cbegin(), str.cend(), [&extras](char c) {
return base::IsAsciiAlpha(c) || base::IsAsciiDigit(c) ||
extras.find(c) != std::string::npos;
});
}
std::string GenerateSessionId() {
std::string session_id;
base::Base64Encode(base::RandBytesAsString(30), &session_id);
DCHECK(!session_id.empty());
return session_id;
}
// Add |behaviour_flag| to |supported_behaviours| if |behaviour_name| is found
// in the dictionary. Returns false on error.
bool GetOptionalBehaviour(
const base::DictionaryValue* invocation_params,
base::StringPiece behaviour_name,
SwReporterInvocation::Behaviours behaviour_flag,
SwReporterInvocation::Behaviours* supported_behaviours) {
DCHECK(invocation_params);
DCHECK(supported_behaviours);
// Parameters enabling behaviours are optional, but if present must be
// boolean.
const base::Value* value = nullptr;
if (invocation_params->Get(behaviour_name, &value)) {
bool enable_behaviour = false;
if (!value->GetAsBoolean(&enable_behaviour)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_PARAMS);
return false;
}
if (enable_behaviour)
*supported_behaviours |= behaviour_flag;
}
return true;
}
// Reads the command-line params and an UMA histogram suffix from the manifest
// and adds the invocations to be run to |out_sequence|.
// Returns whether the manifest was successfully read.
bool ExtractInvocationSequenceFromManifest(
const base::FilePath& exe_path,
std::unique_ptr<base::DictionaryValue> manifest,
safe_browsing::SwReporterInvocationSequence* out_sequence) {
const base::ListValue* parameter_list = nullptr;
// Allow an empty or missing launch_params list, but log an error if
// launch_params cannot be parsed as a list.
base::Value* launch_params = nullptr;
if (manifest->Get("launch_params", &launch_params) &&
!launch_params->GetAsList(¶meter_list)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_PARAMS);
return false;
}
// Use a random session id to link reporter invocations together.
const std::string session_id = GenerateSessionId();
// If there are no launch parameters, create a single invocation with default
// behaviour.
if (!parameter_list || parameter_list->empty()) {
base::CommandLine command_line(exe_path);
command_line.AppendSwitchASCII(chrome_cleaner::kSessionIdSwitch,
session_id);
out_sequence->PushInvocation(
SwReporterInvocation(command_line)
.WithSupportedBehaviours(
SwReporterInvocation::BEHAVIOURS_ENABLED_BY_DEFAULT));
return true;
}
for (const auto& iter : *parameter_list) {
const base::DictionaryValue* invocation_params = nullptr;
if (!iter.GetAsDictionary(&invocation_params)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_PARAMS);
return false;
}
// Max length of the registry and histogram suffix. Fairly arbitrary: the
// Windows registry accepts much longer keys, but we need to display this
// string in histograms as well.
constexpr size_t kMaxSuffixLength = 80;
// The suffix must be an alphanumeric string. (Empty is fine as long as the
// "suffix" key is present.)
std::string suffix;
if (!invocation_params->GetString("suffix", &suffix) ||
!ValidateString(suffix, std::string(), kMaxSuffixLength)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_PARAMS);
return false;
}
// Build a command line for the reporter out of the executable path and the
// arguments from the manifest. (The "arguments" key must be present, but
// it's ok if it's an empty list or a list of empty strings.)
const base::ListValue* arguments = nullptr;
if (!invocation_params->GetList("arguments", &arguments)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_PARAMS);
return false;
}
std::vector<base::string16> argv = {exe_path.value()};
for (const auto& value : *arguments) {
base::string16 argument;
if (!value.GetAsString(&argument)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_PARAMS);
return false;
}
if (!argument.empty())
argv.push_back(argument);
}
base::CommandLine command_line(argv);
command_line.AppendSwitchASCII(chrome_cleaner::kSessionIdSwitch,
session_id);
// Add the histogram suffix to the command-line as well, so that the
// reporter will add the same suffix to registry keys where it writes
// metrics.
if (!suffix.empty())
command_line.AppendSwitchASCII(chrome_cleaner::kRegistrySuffixSwitch,
suffix);
SwReporterInvocation::Behaviours supported_behaviours = 0;
if (!GetOptionalBehaviour(invocation_params, "prompt",
SwReporterInvocation::BEHAVIOUR_TRIGGER_PROMPT,
&supported_behaviours)) {
return false;
}
out_sequence->PushInvocation(
SwReporterInvocation(command_line)
.WithSuffix(suffix)
.WithSupportedBehaviours(supported_behaviours));
}
return true;
}
// Check if we have information from the Cleaner and record UMA statistics.
void ReportUMAForLastCleanerRun() {
base::string16 cleaner_key_name(
chrome_cleaner::kSoftwareRemovalToolRegistryKey);
cleaner_key_name.append(1, L'\\').append(chrome_cleaner::kCleanerSubKey);
base::win::RegKey cleaner_key(HKEY_CURRENT_USER, cleaner_key_name.c_str(),
KEY_ALL_ACCESS);
// Cleaner is assumed to have run if we have a start time.
if (cleaner_key.Valid()) {
if (cleaner_key.HasValue(chrome_cleaner::kStartTimeValueName)) {
// Get version number.
if (cleaner_key.HasValue(chrome_cleaner::kVersionValueName)) {
DWORD version;
cleaner_key.ReadValueDW(chrome_cleaner::kVersionValueName, &version);
base::UmaHistogramSparse("SoftwareReporter.Cleaner.Version", version);
cleaner_key.DeleteValue(chrome_cleaner::kVersionValueName);
}
// Get start & end time. If we don't have an end time, we can assume the
// cleaner has not completed.
int64_t start_time_value;
cleaner_key.ReadInt64(chrome_cleaner::kStartTimeValueName,
&start_time_value);
bool completed = cleaner_key.HasValue(chrome_cleaner::kEndTimeValueName);
SRTHasCompleted(completed ? SRT_COMPLETED_YES : SRT_COMPLETED_NOT_YET);
if (completed) {
int64_t end_time_value;
cleaner_key.ReadInt64(chrome_cleaner::kEndTimeValueName,
&end_time_value);
cleaner_key.DeleteValue(chrome_cleaner::kEndTimeValueName);
base::TimeDelta run_time(
base::Time::FromInternalValue(end_time_value) -
base::Time::FromInternalValue(start_time_value));
UMA_HISTOGRAM_LONG_TIMES("SoftwareReporter.Cleaner.RunningTime",
run_time);
}
// Get exit code. Assume nothing was found if we can't read the exit code.
DWORD exit_code = chrome_cleaner::kSwReporterNothingFound;
if (cleaner_key.HasValue(chrome_cleaner::kExitCodeValueName)) {
cleaner_key.ReadValueDW(chrome_cleaner::kExitCodeValueName, &exit_code);
base::UmaHistogramSparse("SoftwareReporter.Cleaner.ExitCode",
exit_code);
cleaner_key.DeleteValue(chrome_cleaner::kExitCodeValueName);
}
cleaner_key.DeleteValue(chrome_cleaner::kStartTimeValueName);
if (exit_code == chrome_cleaner::kSwReporterPostRebootCleanupNeeded ||
exit_code ==
chrome_cleaner::kSwReporterDelayedPostRebootCleanupNeeded) {
// Check if we are running after the user has rebooted.
base::TimeDelta elapsed(
base::Time::Now() -
base::Time::FromInternalValue(start_time_value));
DCHECK_GT(elapsed.InMilliseconds(), 0);
UMA_HISTOGRAM_BOOLEAN(
"SoftwareReporter.Cleaner.HasRebooted",
static_cast<uint64_t>(elapsed.InMilliseconds()) > ::GetTickCount());
}
if (cleaner_key.HasValue(chrome_cleaner::kUploadResultsValueName)) {
base::string16 upload_results;
cleaner_key.ReadValue(chrome_cleaner::kUploadResultsValueName,
&upload_results);
ReportUploadsWithUma(upload_results);
}
} else {
if (cleaner_key.HasValue(chrome_cleaner::kEndTimeValueName)) {
SRTHasCompleted(SRT_COMPLETED_LATER);
cleaner_key.DeleteValue(chrome_cleaner::kEndTimeValueName);
}
}
}
}
void ReportOnDemandUpdateSucceededHistogram(bool value) {
UMA_HISTOGRAM_BOOLEAN("SoftwareReporter.OnDemandUpdateSucceeded", value);
}
} // namespace
SwReporterInstallerPolicy::SwReporterInstallerPolicy(
const OnComponentReadyCallback& on_component_ready_callback)
: on_component_ready_callback_(on_component_ready_callback) {}
SwReporterInstallerPolicy::~SwReporterInstallerPolicy() = default;
bool SwReporterInstallerPolicy::VerifyInstallation(
const base::DictionaryValue& manifest,
const base::FilePath& dir) const {
return base::PathExists(dir.Append(kSwReporterExeName));
}
bool SwReporterInstallerPolicy::SupportsGroupPolicyEnabledComponentUpdates()
const {
return true;
}
bool SwReporterInstallerPolicy::RequiresNetworkEncryption() const {
return false;
}
update_client::CrxInstaller::Result SwReporterInstallerPolicy::OnCustomInstall(
const base::DictionaryValue& manifest,
const base::FilePath& install_dir) {
return update_client::CrxInstaller::Result(0);
}
void SwReporterInstallerPolicy::OnCustomUninstall() {}
void SwReporterInstallerPolicy::ComponentReady(
const base::Version& version,
const base::FilePath& install_dir,
std::unique_ptr<base::DictionaryValue> manifest) {
safe_browsing::SwReporterInvocationSequence invocations(version);
const base::FilePath exe_path(install_dir.Append(kSwReporterExeName));
if (ExtractInvocationSequenceFromManifest(exe_path, std::move(manifest),
&invocations)) {
// Unless otherwise specified by a unit test, This will post
// |safe_browsing::OnSwReporterReady| to the UI thread.
on_component_ready_callback_.Run(std::move(invocations));
}
}
base::FilePath SwReporterInstallerPolicy::GetRelativeInstallDir() const {
return base::FilePath(FILE_PATH_LITERAL("SwReporter"));
}
void SwReporterInstallerPolicy::GetHash(std::vector<uint8_t>* hash) const {
DCHECK(hash);
hash->assign(kSha256Hash, kSha256Hash + sizeof(kSha256Hash));
}
std::string SwReporterInstallerPolicy::GetName() const {
return "Software Reporter Tool";
}
update_client::InstallerAttributes
SwReporterInstallerPolicy::GetInstallerAttributes() const {
update_client::InstallerAttributes attributes;
if (base::FeatureList::IsEnabled(
safe_browsing::kChromeCleanupDistributionFeature)) {
// Pass the tag parameter to the installer as the "tag" attribute; it will
// be used to choose which binary is downloaded.
constexpr char kTagParamName[] = "reporter_omaha_tag";
const std::string tag = variations::GetVariationParamValueByFeature(
safe_browsing::kChromeCleanupDistributionFeature, kTagParamName);
// If the tag is not a valid attribute (see the regexp in
// ComponentInstallerPolicy::InstallerAttributes), set it to a valid but
// unrecognized value so that nothing will be downloaded.
constexpr size_t kMaxAttributeLength = 256;
constexpr char kExtraAttributeChars[] = "-.,;+_=";
constexpr char kTagParam[] = "tag";
if (tag.empty() ||
!ValidateString(tag, kExtraAttributeChars, kMaxAttributeLength)) {
ReportExperimentError(SW_REPORTER_EXPERIMENT_ERROR_BAD_TAG);
attributes[kTagParam] = "missing_tag";
} else {
attributes[kTagParam] = tag;
}
}
return attributes;
}
std::vector<std::string> SwReporterInstallerPolicy::GetMimeTypes() const {
return std::vector<std::string>();
}
SwReporterOnDemandFetcher::SwReporterOnDemandFetcher(
ComponentUpdateService* cus,
base::OnceClosure on_error_callback)
: cus_(cus), on_error_callback_(std::move(on_error_callback)) {
cus_->AddObserver(this);
cus_->GetOnDemandUpdater().OnDemandUpdate(kSwReporterComponentId, Callback());
}
SwReporterOnDemandFetcher::~SwReporterOnDemandFetcher() {
cus_->RemoveObserver(this);
}
void SwReporterOnDemandFetcher::OnEvent(Events event, const std::string& id) {
if (id != kSwReporterComponentId)
return;
if (event == Events::COMPONENT_NOT_UPDATED ||
event == Events::COMPONENT_UPDATE_ERROR) {
ReportOnDemandUpdateSucceededHistogram(false);
std::move(on_error_callback_).Run();
cus_->RemoveObserver(this);
} else if (event == Events::COMPONENT_UPDATED) {
ReportOnDemandUpdateSucceededHistogram(true);
cus_->RemoveObserver(this);
}
}
void RegisterSwReporterComponent(ComponentUpdateService* cus) {
ReportUMAForLastCleanerRun();
// Once the component is ready and browser startup is complete, run
// |safe_browsing::OnSwReporterReady|.
auto lambda = [](safe_browsing::SwReporterInvocationSequence&& invocations) {
content::BrowserThread::PostAfterStartupTask(
FROM_HERE,
content::BrowserThread::GetTaskRunnerForThread(
content::BrowserThread::UI),
base::BindOnce(
&safe_browsing::ChromeCleanerController::OnSwReporterReady,
base::Unretained(
safe_browsing::ChromeCleanerController::GetInstance()),
base::Passed(&invocations)));
};
// Install the component.
auto installer = base::MakeRefCounted<ComponentInstaller>(
std::make_unique<SwReporterInstallerPolicy>(base::BindRepeating(lambda)));
installer->Register(cus, base::OnceClosure());
}
void RegisterPrefsForSwReporter(PrefRegistrySimple* registry) {
registry->RegisterInt64Pref(prefs::kSwReporterLastTimeTriggered, 0);
registry->RegisterIntegerPref(prefs::kSwReporterLastExitCode, -1);
registry->RegisterInt64Pref(prefs::kSwReporterLastTimeSentReport, 0);
}
void RegisterProfilePrefsForSwReporter(
user_prefs::PrefRegistrySyncable* registry) {
registry->RegisterStringPref(prefs::kSwReporterPromptVersion, "");
registry->RegisterStringPref(prefs::kSwReporterPromptSeed, "");
}
} // namespace component_updater