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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/unexportable_keys/unexportable_key_task_manager.h"
#include <memory>
#include <optional>
#include "base/containers/span.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/no_destructor.h"
#include "base/task/single_thread_task_runner_thread_mode.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "base/types/expected.h"
#include "components/unexportable_keys/background_long_task_scheduler.h"
#include "components/unexportable_keys/background_task_priority.h"
#include "components/unexportable_keys/background_task_type.h"
#include "components/unexportable_keys/features.h"
#include "components/unexportable_keys/ref_counted_unexportable_signing_key.h"
#include "components/unexportable_keys/service_error.h"
#include "components/unexportable_keys/unexportable_key_id.h"
#include "components/unexportable_keys/unexportable_key_tasks.h"
#include "crypto/signature_verifier.h"
#include "crypto/unexportable_key.h"
namespace unexportable_keys {
namespace {
constexpr std::string_view kBaseTaskResultHistogramName =
"Crypto.UnexportableKeys.BackgroundTaskResult";
constexpr std::string_view kBaseTaskRetriesHistogramName =
"Crypto.UnexportableKeys.BackgroundTaskRetries";
template <class CallbackReturnType>
ServiceErrorOr<CallbackReturnType> ReportResultMetrics(
BackgroundTaskType task_type,
ServiceErrorOr<CallbackReturnType> result,
size_t retry_count) {
ServiceError error_for_metrics =
result.has_value() ? kNoServiceErrorForMetrics : result.error();
std::string_view task_type_suffix =
GetBackgroundTaskTypeSuffixForHistograms(task_type);
std::string_view success_suffix =
result.has_value() ? ".Success" : ".Failure";
base::UmaHistogramEnumeration(
base::StrCat({kBaseTaskResultHistogramName, task_type_suffix}),
error_for_metrics);
base::UmaHistogramExactLinear(
base::StrCat(
{kBaseTaskRetriesHistogramName, task_type_suffix, success_suffix}),
retry_count, /*exclusive_max=*/10);
return result;
}
// Returns a new callback that reports result metrics and then invokes the
// original `callback`.
template <class CallbackReturnType>
base::OnceCallback<void(ServiceErrorOr<CallbackReturnType>, size_t)>
WrapCallbackWithMetrics(
BackgroundTaskType task_type,
base::OnceCallback<void(ServiceErrorOr<CallbackReturnType>)> callback) {
return base::BindOnce(&ReportResultMetrics<CallbackReturnType>, task_type)
.Then(std::move(callback));
}
} // namespace
UnexportableKeyTaskManager::UnexportableKeyTaskManager(
crypto::UnexportableKeyProvider::Config config)
: task_scheduler_(base::ThreadPool::CreateSingleThreadTaskRunner(
{base::MayBlock(), base::TaskPriority::USER_BLOCKING,
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN},
base::SingleThreadTaskRunnerThreadMode::
DEDICATED // Using a dedicated thread to run long and blocking
// TPM tasks.
)),
config_(std::move(config)) {}
UnexportableKeyTaskManager::~UnexportableKeyTaskManager() = default;
// static
std::unique_ptr<crypto::UnexportableKeyProvider>
UnexportableKeyTaskManager::GetUnexportableKeyProvider(
crypto::UnexportableKeyProvider::Config config) {
if (base::FeatureList::IsEnabled(
kEnableBoundSessionCredentialsSoftwareKeysForManualTesting)) {
return crypto::GetSoftwareUnsecureUnexportableKeyProvider();
}
return crypto::GetUnexportableKeyProvider(std::move(config));
}
void UnexportableKeyTaskManager::GenerateSigningKeySlowlyAsync(
base::span<const crypto::SignatureVerifier::SignatureAlgorithm>
acceptable_algorithms,
BackgroundTaskPriority priority,
base::OnceCallback<
void(ServiceErrorOr<scoped_refptr<RefCountedUnexportableSigningKey>>)>
callback) {
auto callback_wrapper = WrapCallbackWithMetrics(
BackgroundTaskType::kGenerateKey, std::move(callback));
std::unique_ptr<crypto::UnexportableKeyProvider> key_provider =
GetUnexportableKeyProvider(config_);
if (!key_provider) {
std::move(callback_wrapper)
.Run(base::unexpected(ServiceError::kNoKeyProvider), /*retry_count=*/0);
return;
}
if (!key_provider->SelectAlgorithm(acceptable_algorithms).has_value()) {
std::move(callback_wrapper)
.Run(base::unexpected(ServiceError::kAlgorithmNotSupported),
/*retry_count=*/0);
return;
}
auto task = std::make_unique<GenerateKeyTask>(std::move(key_provider),
acceptable_algorithms, priority,
std::move(callback_wrapper));
task_scheduler_.PostTask(std::move(task));
}
void UnexportableKeyTaskManager::FromWrappedSigningKeySlowlyAsync(
base::span<const uint8_t> wrapped_key,
BackgroundTaskPriority priority,
base::OnceCallback<
void(ServiceErrorOr<scoped_refptr<RefCountedUnexportableSigningKey>>)>
callback) {
auto callback_wrapper = WrapCallbackWithMetrics(
BackgroundTaskType::kFromWrappedKey, std::move(callback));
std::unique_ptr<crypto::UnexportableKeyProvider> key_provider =
GetUnexportableKeyProvider(config_);
if (!key_provider) {
std::move(callback_wrapper)
.Run(base::unexpected(ServiceError::kNoKeyProvider), /*retry_count=*/0);
return;
}
auto task = std::make_unique<FromWrappedKeyTask>(std::move(key_provider),
wrapped_key, priority,
std::move(callback_wrapper));
task_scheduler_.PostTask(std::move(task));
}
void UnexportableKeyTaskManager::SignSlowlyAsync(
scoped_refptr<RefCountedUnexportableSigningKey> signing_key,
base::span<const uint8_t> data,
BackgroundTaskPriority priority,
size_t max_retries,
base::OnceCallback<void(ServiceErrorOr<std::vector<uint8_t>>)> callback) {
auto callback_wrapper =
WrapCallbackWithMetrics(BackgroundTaskType::kSign, std::move(callback));
// TODO(alexilin): convert this to a CHECK().
if (!signing_key) {
std::move(callback_wrapper)
.Run(base::unexpected(ServiceError::kKeyNotFound), /*retry_count=*/0);
return;
}
// TODO(b/263249728): deduplicate tasks with the same parameters.
// TODO(b/263249728): implement a cache of recent signings.
auto task =
std::make_unique<SignTask>(std::move(signing_key), data, priority,
max_retries, std::move(callback_wrapper));
task_scheduler_.PostTask(std::move(task));
}
} // namespace unexportable_keys
|
