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
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_PROFILE_RESETTER_TRIGGERED_PROFILE_RESETTER_H_
#define CHROME_BROWSER_PROFILE_RESETTER_TRIGGERED_PROFILE_RESETTER_H_
#include <stddef.h>
#include <string>
#include "base/memory/raw_ptr.h"
#include "build/build_config.h"
#include "components/keyed_service/core/keyed_service.h"
class Profile;
// This service is responsible for evaluating whether a profile reset trigger
// has been set and not yet consumed by |profile_|. If it has, the profile is
// eligible for reset and a profile reset UI will be shown to the user. The
// intended use case for this is to provide a sanctioned profile reset API for
// third party tools (anti-virus or cleaner tools) that wish to reset users'
// profiles as part of their cleanup flow.
//
// To use this mechanism from a third party tool, perform the following steps:
// 1) Create (or open) the registry key
// HKCU\Software\$PRODUCT_NAME\TriggeredReset where $PRODUCT_NAME is one
// of the values "Google\\Chrome" or "Chromium".
// 2) Set a REG_SZ value called "ToolName" to the localized name of the tool.
// This string (truncated to kMaxToolNameLength) will be displayed in a
// notification UI. The "ToolName" should be just the name of the tool,
// e.g. "AwesomeAV".
// 3) Set a REG_QWORD value called "Timestamp" with a timestamp for the reset
// event. This value should be obtained from a call to
// ::GetSystemTimeAsFileTime() at the time the reset is requested. This
// value will be persisted in the profile when it is reset and will be used
// to avoid multiple resets.
//
// Some considerations:
//
// * Chrome supports multiple profiles. When the above steps are followed,
// each profile will enter the reset flow as it is opened.
// * New profiles created while any timestamp is present will not get the reset
// flow.
class TriggeredProfileResetter : public KeyedService {
public:
enum : size_t { kMaxToolNameLength = 100 };
explicit TriggeredProfileResetter(Profile* profile);
TriggeredProfileResetter(const TriggeredProfileResetter&) = delete;
TriggeredProfileResetter& operator=(const TriggeredProfileResetter&) = delete;
~TriggeredProfileResetter() override;
// Causes the TriggeredProfileResetter to look for the presence of a trigger.
// If a trigger is found, it is disarmed so that future instances of the
// service will no longer trigger a reset. Subsequent calls to HasResetTrigger
// will return whether |profile_| is subject to a reset.
virtual void Activate();
// Returns true iff the given profile has a trigger set for a reset UI flow
// according to the description in the class comment. Must call Activate()
// first.
virtual bool HasResetTrigger();
// Clears the reset trigger such that subsequent calls to |HasResetTrigger|
// will return false.
virtual void ClearResetTrigger();
// Returns the name of the tool that performed the reset. This string will be
// truncated to a length of |kMaxToolNameLength|.
virtual std::u16string GetResetToolName();
private:
#if BUILDFLAG(IS_WIN)
raw_ptr<Profile> profile_;
#endif // BUILDFLAG(IS_WIN)
bool has_reset_trigger_ = false;
bool activate_called_ = false;
std::u16string tool_name_;
};
// Exposed for testing.
extern const wchar_t kTriggeredResetRegistryPath[];
extern const wchar_t kTriggeredResetToolName[];
extern const wchar_t kTriggeredResetTimestamp[];
#endif // CHROME_BROWSER_PROFILE_RESETTER_TRIGGERED_PROFILE_RESETTER_H_
|
