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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/policy/cloud/fm_registration_token_uploader.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/notreached.h"
#include "base/scoped_observation.h"
#include "components/policy/core/common/cloud/policy_invalidation_scope.h"
#include "components/policy/core/common/cloud/signing_service.h"
#include "components/policy/core/common/policy_logger.h"
#include "components/policy/proto/device_management_backend.pb.h"
namespace em = enterprise_management;
namespace policy {
namespace {
// After the first failure, retry after 1 minute, then after 2, 4 etc up to a
// maximum of 1 day.
static constexpr net::BackoffEntry::Policy kUploadRetryBackoffPolicy = {
.num_errors_to_ignore = 0,
.initial_delay_ms = base::Minutes(1).InMilliseconds(),
.multiply_factor = 2,
.jitter_factor = 0.1,
.maximum_backoff_ms = base::Days(1).InMilliseconds(),
.always_use_initial_delay = true,
};
std::string ToString(PolicyInvalidationScope scope) {
// The macro replaces a enum entry with a string as is. E.g. Enum::kItem becomes
// "kItem".
#define CASE(_name) \
case PolicyInvalidationScope::_name: \
return #_name;
switch (scope) {
CASE(kUser);
CASE(kDevice);
CASE(kDeviceLocalAccount);
CASE(kCBCM);
}
#undef CASE
}
em::FmRegistrationTokenUploadRequest::TokenType ScopeToTokenType(
PolicyInvalidationScope scope) {
switch (scope) {
case PolicyInvalidationScope::kUser:
return em::FmRegistrationTokenUploadRequest::USER;
case PolicyInvalidationScope::kDevice:
return em::FmRegistrationTokenUploadRequest::DEVICE;
case PolicyInvalidationScope::kDeviceLocalAccount:
NOTREACHED() << "No requests for device local accounts";
case PolicyInvalidationScope::kCBCM:
return em::FmRegistrationTokenUploadRequest::BROWSER;
}
}
} // namespace
// Observes a cloud policy core connection event and is destroyed afterwards.
class FmRegistrationTokenUploader::CloudPolicyCoreConnectionObserver
: public CloudPolicyCore::Observer {
public:
CloudPolicyCoreConnectionObserver(
CloudPolicyCore* core,
base::OnceCallback<void()> on_connected_callback,
base::OnceCallback<void()> on_disconnected_callback)
: on_connected_callback_(std::move(on_connected_callback)),
on_disconnected_callback_(std::move(on_disconnected_callback)) {
observation.Observe(core);
}
void OnCoreConnected(CloudPolicyCore* core) override {
if (on_connected_callback_) {
std::move(on_connected_callback_).Run();
}
observation.Reset();
}
void OnRefreshSchedulerStarted(CloudPolicyCore* core) override {}
void OnCoreDisconnecting(CloudPolicyCore* core) override {
if (on_disconnected_callback_) {
std::move(on_disconnected_callback_).Run();
}
observation.Reset();
}
private:
base::ScopedObservation<CloudPolicyCore, CloudPolicyCoreConnectionObserver>
observation{this};
base::OnceCallback<void()> on_connected_callback_;
base::OnceCallback<void()> on_disconnected_callback_;
};
// Observes a cloud policy client registration event and is destroyed
// afterwards.
class FmRegistrationTokenUploader::CloudPolicyClientRegistrationObserver
: public CloudPolicyClient::Observer {
public:
CloudPolicyClientRegistrationObserver(
CloudPolicyClient* client,
base::OnceCallback<void()> on_connected_callback)
: on_connected_callback_(std::move(on_connected_callback)) {
observation.Observe(client);
}
void OnRegistrationStateChanged(CloudPolicyClient* client) override {
if (client->is_registered()) {
std::move(on_connected_callback_).Run();
observation.Reset();
}
}
void Reset() { observation.Reset(); }
private:
base::ScopedObservation<CloudPolicyClient,
CloudPolicyClientRegistrationObserver>
observation{this};
base::OnceCallback<void()> on_connected_callback_;
};
class FmRegistrationTokenUploader::UploadJob {
public:
using ResultCallback = CloudPolicyClient::ResultCallback;
UploadJob(CloudPolicyClient* client,
em::FmRegistrationTokenUploadRequest request,
ResultCallback on_registered_callback)
: on_registered_callback_(std::move(on_registered_callback)) {
client->UploadFmRegistrationToken(
std::move(request),
base::BindOnce(&UploadJob::OnRegistrationTokenUploaded,
weak_factory_.GetWeakPtr()));
}
private:
void OnRegistrationTokenUploaded(CloudPolicyClient::Result result) {
std::move(on_registered_callback_).Run(result);
}
ResultCallback on_registered_callback_;
base::WeakPtrFactory<UploadJob> weak_factory_{this};
};
FmRegistrationTokenUploader::FmRegistrationTokenUploader(
PolicyInvalidationScope scope,
invalidation::InvalidationListener* invalidation_listener,
CloudPolicyCore* core)
: scope_(scope),
invalidation_listener_(invalidation_listener),
core_(core),
upload_retry_backoff_(&kUploadRetryBackoffPolicy) {
CHECK(invalidation_listener_);
CHECK(core);
CHECK_NE(scope_, PolicyInvalidationScope::kDeviceLocalAccount)
<< "Registration token is not expected for device local "
"accounts";
invalidation_listener_->Start(this);
}
FmRegistrationTokenUploader::~FmRegistrationTokenUploader() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
invalidation_listener_->Shutdown();
}
void FmRegistrationTokenUploader::OnRegistrationTokenReceived(
const std::string& registration_token,
base::Time token_end_of_life) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
upload_retry_backoff_.Reset();
return DoUploadRegistrationToken(TokenData{
.registration_token = std::move(registration_token),
.token_end_of_life = token_end_of_life,
});
}
void FmRegistrationTokenUploader::DoUploadRegistrationToken(
TokenData token_data) {
StopOngoingUpload();
CloudPolicyClient* client = core_->client();
if (!client) {
VLOG_POLICY(1, REMOTE_COMMANDS)
<< "Client is missing for " << ToString(scope_) << " scope";
// Async task is required as it will destroy the observer that will call
// this callback and remove it from the observers list.
core_observer_ = std::make_unique<CloudPolicyCoreConnectionObserver>(
core_,
base::BindOnce(
&FmRegistrationTokenUploader::DoAsyncUploadRegistrationToken,
base::Unretained(this), std::move(token_data),
/*delay=*/base::TimeDelta()),
/*on_disconnected_callback=*/base::OnceClosure());
return;
}
if (!client->is_registered()) {
VLOG_POLICY(1, REMOTE_COMMANDS)
<< "Client is not registered for " << ToString(scope_) << " scope";
// Async upload task is required as it will destroy the observer that will
// call this callback and remove it from the observers list.
client_observer_ = std::make_unique<CloudPolicyClientRegistrationObserver>(
client,
base::BindOnce(
&FmRegistrationTokenUploader::DoAsyncUploadRegistrationToken,
base::Unretained(this), std::move(token_data),
/*delay=*/base::TimeDelta()));
// In case profile became unmanaged/deleted before fully intializated.
core_observer_ = std::make_unique<CloudPolicyCoreConnectionObserver>(
core_, /*on_connected_callback=*/base::OnceClosure(),
base::BindOnce(&FmRegistrationTokenUploader::
CloudPolicyClientRegistrationObserver::Reset,
base::Unretained(client_observer_.get())));
return;
}
em::FmRegistrationTokenUploadRequest request;
request.set_token(token_data.registration_token);
request.set_protocol_version(
invalidation::InvalidationListener::kInvalidationProtocolVersion);
request.set_token_type(ScopeToTokenType(scope_));
request.set_project_number(invalidation_listener_->project_number());
request.set_expiration_timestamp_ms(
token_data.token_end_of_life.InMillisecondsSinceUnixEpoch());
upload_job_ = std::make_unique<UploadJob>(
client, std::move(request),
base::BindOnce(&FmRegistrationTokenUploader::OnRegistrationTokenUploaded,
base::Unretained(this), std::move(token_data)));
}
void FmRegistrationTokenUploader::DoAsyncUploadRegistrationToken(
TokenData token_data,
base::TimeDelta delay) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&FmRegistrationTokenUploader::DoUploadRegistrationToken,
weak_factory_.GetWeakPtr(), std::move(token_data)),
delay);
}
void FmRegistrationTokenUploader::OnRegistrationTokenUploaded(
TokenData token_data,
CloudPolicyClient::Result result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
StopOngoingUpload();
if (!result.IsSuccess()) {
LOG_POLICY(ERROR, REMOTE_COMMANDS)
<< "Upload failed for " << ToString(scope_) << " scope, "
<< invalidation_listener_->project_number()
<< " project: " << result.GetDMServerError();
invalidation_listener_->SetRegistrationUploadStatus(
invalidation::InvalidationListener::RegistrationTokenUploadStatus::
kFailed);
// Retry failed upload after timeout.
DoAsyncUploadRegistrationToken(
std::move(token_data),
/*delay=*/upload_retry_backoff_.GetTimeUntilRelease());
upload_retry_backoff_.InformOfRequest(/*succeeded=*/false);
return;
}
invalidation_listener_->SetRegistrationUploadStatus(
invalidation::InvalidationListener::RegistrationTokenUploadStatus::
kSucceeded);
}
void FmRegistrationTokenUploader::StopOngoingUpload() {
core_observer_.reset();
client_observer_.reset();
upload_job_.reset();
// Drop any posted tasks.
weak_factory_.InvalidateWeakPtrs();
}
} // namespace policy
|