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
|
// Copyright 2022 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_ASH_OWNERSHIP_OWNERSHIP_HISTOGRAMS_H_
#define CHROME_BROWSER_ASH_OWNERSHIP_OWNERSHIP_HISTOGRAMS_H_
namespace ash {
// Events related to owner key loading, generation and usage.
enum class OwnerKeyEvent {
// DeviceSettingsService was null, owner key was not loaded.
kDeviceSettingsServiceIsNull,
// Managed device finished key loading.
kManagedDevice,
// Consumer device finished key loading.
kOwnerHasKeys,
// ChromeOS decided to establish consumer ownership.
kEstablishingConsumerOwnership,
// ChromeOS decided to re-generate the lost owner key based on the data from
// device policies.
kRegeneratingOwnerKeyBasedOnPolicy,
// A user was categorized as not an owner based on the data from device
// policies.
kUserNotAnOwnerBasedOnPolicy,
// ChromeOS decided to generate a new key or re-generate the lost owner key
// based on the data from local state.
kRegeneratingOwnerKeyBasedOnLocalState,
// A user was categorized as not an owner based on the data from local state.
kUserNotAnOwnerBasedOnLocalState,
// ChromeOS assumed that a user is not an owner based on the lack of data.
kUnsureUserNotAnOwner,
// New owner key was generated.
kOwnerKeyGenerated,
// Failed to generate new owner key.
kFailedToGenerateOwnerKey,
// Started signing policies.
kStartSigningPolicy,
// Finished signing policies.
kSignedPolicy,
// Finished storing policies.
kStoredPolicy,
// A user was categorized as not an owner based on the user type.
kUserNotAnOwnerBasedOnUserType,
// A user was categorized as not an owner because the user name was empty,
// this is not expected to happen.
kUserNotAnOwnerBasedOnEmptyUsername,
// ChromeOS decided to establish consumer ownership when there was no
// indication that it's the first user, but also no public key, no policies
// and no local state entry.
kUnsureTakeOwnership,
// ChromeOS attempted to generate the owner key in the private slot.
kPrivateSlotKeyGeneration,
// ChromeOS attempted to generate the owner key in the public slot.
kPublicSlotKeyGeneration,
// ChromeOS started migrating the owner key from the public to the private
// slot (the outcome is collected as kOwnerKeyGenerated and other counters).
kMigrationToPrivateSlotStarted,
// ChromeOS started migrating the owner key from the private to the public
// slot (the outcome is collected as kOwnerKeyGenerated and other counters).
kMigrationToPublicSlotStarted,
// session_manager notified Chrome that it finished saving the owner key
// (potentially unsuccessfully).
kOwnerKeySet,
// ChromeOS started deleting the old owner key.
kOldOwnerKeyCleanUpStarted,
// Tracks whether the owner key was found in the public or private slot.
kOwnerKeyInPublicSlot,
};
// Combines `event` and `success` to produce a more specific UMA event and
// records it. `success`==true generally means that the event happened as
// expected and `success`==false means that something related to the event went
// wrong or unexpectedly (see comments for the UMA events for more details).
void RecordOwnerKeyEvent(OwnerKeyEvent event, bool success);
// PUBLIC ONLY FOR TESTING:
// The path for the OwnerKeyUmaEvent histogram. Accessible for testing. Prefer
// using through the `RecordOwnerKeyEvent` method.
inline constexpr char kOwnerKeyHistogramName[] =
"ChromeOS.Ownership.OwnerKeyUmaEvent";
// Events related to owner key loading, generation and usage that are sent to
// UMA. Produced from the events above by combining with a success/failure
// status. These values are persisted to histograms. Entries should not be
// renumbered and numeric values should never be reused.
enum class OwnerKeyUmaEvent {
// DeviceSettingsService was null, owner key was not loaded.
kDeviceSettingsServiceIsNull = 0,
// Managed device successfully loaded the public owner key.
kManagedDeviceSuccess = 1,
// Managed device failed to load the public owner key.
kManagedDeviceFail = 2,
// Consumer owner user successfully loaded both public and private keys.
kOwnerHasKeysSuccess = 3,
// Consumer owner received both public and private keys, but at least one of
// them wasn't actually loaded.
kOwnerHasKeysFail = 4,
// ChromeOS decided to establish consumer ownership when there was no existing
// public key.
kEstablishingConsumerOwnershipSuccess = 5,
// ChromeOS decided to establish consumer ownership when there was an existing
// public key.
kEstablishingConsumerOwnershipFail = 6,
// ChromeOS decided to re-generate the lost owner key based on the data from
// device policies after the public key was found (the private part is what
// was lost).
kRegeneratingOwnerKeyBasedOnPolicySuccess = 7,
// ChromeOS decided to re-generate the lost owner key based on the data from
// device policies and the public key was also not found. (Strictly speaking
// not a failure, but still an unusual situation).
kRegeneratingOwnerKeyBasedOnPolicyFail = 8,
// A user was categorized as not an owner based on the data from device
// policies, the public key was successfully loaded.
kUserNotAnOwnerBasedOnPolicySuccess = 9,
// A user was categorized as not an owner based on the data from device
// policies, the public key failed to load.
kUserNotAnOwnerBasedOnPolicyFail = 10,
// ChromeOS decided to generate a new key or re-generate the lost owner key
// based on the data from local state and the public key was not present.
kRegeneratingOwnerKeyBasedOnLocalStateSuccess = 11,
// ChromeOS decided to generate a new key or re-generate the lost owner key
// based on the data from local state after the public key was found (in such
// a case device policies should be used, relying on local state is
// unexpected).
kRegeneratingOwnerKeyBasedOnLocalStateFail = 12,
// A user was categorized as not an owner based on the data from local state,
// the public key was successfully loaded.
kUserNotAnOwnerBasedOnLocalStateSuccess = 13,
// A user was categorized as not an owner based on the data from local state,
// the public key failed to load.
kUserNotAnOwnerBasedOnLocalStateFail = 14,
// ChromeOS assumed that a user is not an owner based on the lack of data, the
// public key was successfully loaded.
kUnsureUserNotAnOwnerSuccess = 15,
// ChromeOS assumed that a user is not an owner based on the lack of data, the
// public key failed to load.
kUnsureUserNotAnOwnerFail = 16,
// New owner key was generated on the first attempt.
kOwnerKeyGeneratedSuccess = 17,
// New owner key was generated after 1+ failures.
kOwnerKeyGeneratedFail = 18,
// Failed to generate new owner key, at least the old public key was returned.
kFailedToGenerateOwnerKeySuccess = 19,
// Failed to generate new owner key, the old public key also failed to load
// (or was not present).
kFailedToGenerateOwnerKeyFail = 20,
// Successfully started signing policies.
kStartSigningPolicySuccess = 21,
// Failed to start signing policies.
kStartSigningPolicyFail = 22,
// Successfully signed policies.
kSignedPolicySuccess = 23,
// Failed to sign policies.
kSignedPolicyFail = 24,
// Successfully stored policies.
kStoredPolicySuccess = 25,
// Failed to store policies.
kStoredPolicyFail = 26,
// A user was categorized as not an owner based on the user type, the public
// key was successfully loaded.
kUserNotAnOwnerBasedOnUserTypeSuccess = 27,
// A user was categorized as not an owner based on the user type, the public
// key failed to load.
kUserNotAnOwnerBasedOnUserTypeFail = 28,
// A user was categorized as not an owner because the user name was empty,
// this is not expected to happen, the public key was successfully loaded.
kUserNotAnOwnerBasedOnEmptyUsernameSuccess = 29,
// A user was categorized as not an owner because the user name was empty,
// this is not expected to happen, the public key failed to load.
kUserNotAnOwnerBasedOnEmptyUsernameFail = 30,
// ChromeOS decided to establish consumer ownership when there was no
// indication that it's the first user, but also no public key, no policies
// and no local state entry.
kUnsureTakeOwnership = 31,
// ChromeOS successfully generated the owner key in the private slot.
kPrivateSlotKeyGenerationSuccess = 32,
// ChromeOS failed to generate the owner key in the private slot.
kPrivateSlotKeyGenerationFail = 33,
// ChromeOS successfully generated the owner key in the public slot.
kPublicSlotKeyGenerationSuccess = 34,
// ChromeOS failed to generate the owner key in the public slot.
kPublicSlotKeyGenerationFail = 35,
// ChromeOS started migrating the owner key from the public to the private
// slot (the outcome is collected as kOwnerKeyGenerated and other counters).
kMigrationToPrivateSlotStarted = 36,
// ChromeOS started migrating the owner key from the private to the public
// slot (the outcome is collected as kOwnerKeyGenerated and other counters).
kMigrationToPublicSlotStarted = 37,
// session_manager notified Chrome that it finished saving the owner key
// successfully.
kOwnerKeySetSuccess = 38,
// session_manager notified Chrome that it failed to save the owner key on
// disk.
kOwnerKeySetFail = 39,
// ChromeOS started deleting the old owner key.
kOldOwnerKeyCleanUpStarted = 40,
// The owner key was found in the public.
kOwnerKeyInPublicSlotTrue = 41,
// The owner key was found in the private slot.
kOwnerKeyInPublicSlotFalse = 42,
kMaxValue = kOwnerKeyInPublicSlotFalse,
};
} // namespace ash
#endif // CHROME_BROWSER_ASH_OWNERSHIP_OWNERSHIP_HISTOGRAMS_H_
|
