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 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
|
// Copyright 2018 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/enterprise/browser/controller/chrome_browser_cloud_management_controller.h"
#include <utility>
#include "base/command_line.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/observer_list.h"
#include "base/path_service.h"
#include "base/strings/strcat.h"
#include "base/task/single_thread_task_runner.h"
#include "base/task/thread_pool.h"
#include "build/build_config.h"
#include "components/enterprise/browser/controller/browser_dm_token_storage.h"
#include "components/enterprise/browser/controller/chrome_browser_cloud_management_helper.h"
#include "components/enterprise/browser/enterprise_switches.h"
#include "components/enterprise/browser/reporting/real_time_report_controller.h"
#include "components/policy/core/browser/browser_policy_connector.h"
#include "components/policy/core/common/cloud/client_data_delegate.h"
#include "components/policy/core/common/cloud/cloud_external_data_manager.h"
#include "components/policy/core/common/cloud/cloud_policy_constants.h"
#include "components/policy/core/common/cloud/dm_token.h"
#include "components/policy/core/common/cloud/machine_level_user_cloud_policy_manager.h"
#include "components/policy/core/common/cloud/machine_level_user_cloud_policy_store.h"
#include "components/policy/core/common/configuration_policy_provider.h"
#include "components/policy/core/common/policy_logger.h"
#include "components/prefs/pref_service.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#if !BUILDFLAG(IS_ANDROID)
#include "components/enterprise/browser/reporting/report_generator.h"
#include "components/enterprise/browser/reporting/report_scheduler.h"
#endif // !BUILDFLAG(IS_ANDROID)
namespace policy {
const base::FilePath::CharType
ChromeBrowserCloudManagementController::kPolicyDir[] =
FILE_PATH_LITERAL("Policy");
std::unique_ptr<enterprise_connectors::DeviceTrustKeyManager>
ChromeBrowserCloudManagementController::Delegate::
CreateDeviceTrustKeyManager() {
return nullptr;
}
std::unique_ptr<client_certificates::CertificateProvisioningService>
ChromeBrowserCloudManagementController::Delegate::
CreateCertificateProvisioningService() {
return nullptr;
}
void ChromeBrowserCloudManagementController::Delegate::DeferInitialization(
base::OnceClosure callback) {
NOTREACHED();
}
ChromeBrowserCloudManagementController::ChromeBrowserCloudManagementController(
std::unique_ptr<ChromeBrowserCloudManagementController::Delegate> delegate)
: delegate_(std::move(delegate)),
client_data_delegate_(delegate_->CreateClientDataDelegate()) {
delegate_->SetDMTokenStorageDelegate();
}
ChromeBrowserCloudManagementController::
~ChromeBrowserCloudManagementController() {
if (policy_fetcher_)
policy_fetcher_->RemoveClientObserver(this);
if (cloud_policy_client_)
cloud_policy_client_->RemoveObserver(this);
}
// static
bool ChromeBrowserCloudManagementController::IsEnabled() {
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
return true;
#else
return base::CommandLine::ForCurrentProcess()->HasSwitch(
switches::kEnableChromeBrowserCloudManagement);
#endif
}
std::unique_ptr<MachineLevelUserCloudPolicyManager>
ChromeBrowserCloudManagementController::CreatePolicyManager(
ConfigurationPolicyProvider* platform_provider) {
if (!IsEnabled()) {
return nullptr;
}
std::string enrollment_token =
BrowserDMTokenStorage::Get()->RetrieveEnrollmentToken();
DMToken dm_token = BrowserDMTokenStorage::Get()->RetrieveDMToken();
std::string client_id = BrowserDMTokenStorage::Get()->RetrieveClientId();
if (dm_token.is_empty())
VLOG_POLICY(1, CBCM_ENROLLMENT) << "DM token = empty";
else if (dm_token.is_invalid())
VLOG_POLICY(1, CBCM_ENROLLMENT) << "DM token = invalid";
else if (dm_token.is_valid())
VLOG_POLICY(1, CBCM_ENROLLMENT) << "DM token = from persistence";
VLOG_POLICY(1, CBCM_ENROLLMENT) << "Enrollment token = " << enrollment_token;
VLOG_POLICY(1, CBCM_ENROLLMENT) << "Client ID = " << client_id;
// Don't create the policy manager if the DM token is explicitly invalid or if
// both tokens are empty.
if (dm_token.is_invalid() ||
(enrollment_token.empty() && dm_token.is_empty())) {
return nullptr;
}
base::FilePath user_data_dir;
if (!base::PathService::Get(delegate_->GetUserDataDirKey(), &user_data_dir))
return nullptr;
DVLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Creating machine level user cloud policy manager";
base::FilePath policy_dir =
user_data_dir.Append(ChromeBrowserCloudManagementController::kPolicyDir);
base::FilePath external_policy_path = delegate_->GetExternalPolicyDir();
std::unique_ptr<MachineLevelUserCloudPolicyStore> policy_store =
MachineLevelUserCloudPolicyStore::Create(
dm_token, client_id, external_policy_path, policy_dir,
base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), base::TaskPriority::BEST_EFFORT,
// Block shutdown to make sure the policy cache update is always
// finished.
base::TaskShutdownBehavior::BLOCK_SHUTDOWN}));
return std::make_unique<MachineLevelUserCloudPolicyManager>(
std::move(policy_store), nullptr, policy_dir,
base::SingleThreadTaskRunner::GetCurrentDefault(),
delegate_->CreateNetworkConnectionTrackerGetter());
}
void ChromeBrowserCloudManagementController::DeferrableCreatePolicyManager(
ConfigurationPolicyProvider* platform_provider,
base::OnceCallback<
void(std::unique_ptr<MachineLevelUserCloudPolicyManager>)> callback) {
if (delegate_->ReadyToCreatePolicyManager()) {
DeferrableCreatePolicyManagerImpl(platform_provider, std::move(callback));
} else {
// Postpone policy manager creation to happen during controller
// initialization, so it's guaranteed that all dependencies have been
// resolved (e.g. on Android it depends on PolicyService being created
// and initialized).
create_cloud_policy_manager_callback_ = base::BindOnce(
&ChromeBrowserCloudManagementController::
DeferrableCreatePolicyManagerImpl,
weak_factory_.GetWeakPtr(), platform_provider, std::move(callback));
}
}
void ChromeBrowserCloudManagementController::Init(
PrefService* local_state,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory) {
if (!IsEnabled()) {
VLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Cloud management controller initialization aborted as CBCM is not "
"enabled. Please use the `--enable-chrome-browser-cloud-management` "
"command line flag to enable it if you are not using the official "
"Google Chrome build.";
return;
}
VLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Starting CBCM Controller Initialization";
delegate_->InitializeOAuthTokenFactory(url_loader_factory, local_state);
if (create_cloud_policy_manager_callback_) {
// The conditions that allow controller initialization should also unblock
// policy manager creation (e.g. on Android both depend on PolicyService
// being initialized).
DCHECK(delegate_->ReadyToCreatePolicyManager());
std::move(create_cloud_policy_manager_callback_).Run();
}
// Post the task of CreateReportScheduler to run on best effort after launch
// is completed.
delegate_->GetBestEffortTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(
&ChromeBrowserCloudManagementController::CreateReportScheduler,
weak_factory_.GetWeakPtr()));
MachineLevelUserCloudPolicyManager* policy_manager =
delegate_->GetMachineLevelUserCloudPolicyManager();
DeviceManagementService* device_management_service =
delegate_->GetDeviceManagementService();
if (!policy_manager) {
LOG_POLICY(INFO, CBCM_ENROLLMENT)
<< "No machine level policy manager exists.";
return;
}
// If there exists an enrollment token, then there are three states:
// 1/ There also exists a valid DM token. This machine is already
// registered, so the next step is to fetch policies.
// 2/ There is no DM token. In this case the machine is not already
// registered and needs to request a DM token.
// 3/ The also exists an invalid DM token. Do not fetch policies or try to
// request a DM token in that case.
std::string enrollment_token;
std::string client_id;
DMToken dm_token = BrowserDMTokenStorage::Get()->RetrieveDMToken();
if (dm_token.is_invalid()) {
LOG_POLICY(WARNING, CBCM_ENROLLMENT)
<< "Enrollment Token exists but DM Token is Invalid";
return;
}
if (dm_token.is_valid()) {
VLOG_POLICY(1, CBCM_ENROLLMENT) << "Valid DM Token retrieved.";
policy_fetcher_ = std::make_unique<MachineLevelUserCloudPolicyFetcher>(
policy_manager, local_state, device_management_service,
url_loader_factory);
policy_fetcher_->AddClientObserver(this);
return;
}
if (!GetEnrollmentTokenAndClientId(&enrollment_token, &client_id))
return;
DCHECK(!enrollment_token.empty());
DCHECK(!client_id.empty());
cloud_management_registrar_ =
std::make_unique<ChromeBrowserCloudManagementRegistrar>(
device_management_service, url_loader_factory);
policy_fetcher_ = std::make_unique<MachineLevelUserCloudPolicyFetcher>(
policy_manager, local_state, device_management_service,
url_loader_factory);
policy_fetcher_->AddClientObserver(this);
if (dm_token.is_empty()) {
delegate_->StartWatchingRegistration(this);
enrollment_start_time_ = base::Time::Now();
// Not registered already, so do it now.
LOG_POLICY(INFO, CBCM_ENROLLMENT)
<< "Starting cloud management registration with an enrollment token.";
cloud_management_registrar_->RegisterForCloudManagementWithEnrollmentToken(
enrollment_token, client_id, *client_data_delegate_,
base::BindOnce(
&ChromeBrowserCloudManagementController::
RegisterForCloudManagementWithEnrollmentTokenCallback,
weak_factory_.GetWeakPtr()));
// On Windows, if Chrome is installed on the user level, we can't store the
// DM token in the registry at the end of enrollment. Hence Chrome needs to
// re-enroll every launch.
// Based on the UMA metrics
// Enterprise.MachineLevelUserCloudPolicyEnrollment.InstallLevel_Win,
// the number of user-level enrollment is very low
// compare to the total CBCM users. In additional to that, devices are now
// mostly enrolled with Google Update on Windows. Based on that, we won't do
// anything special for user-level install enrollment.
}
}
void ChromeBrowserCloudManagementController::MaybeInit(
PrefService* local_state,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory) {
if (delegate_->ReadyToInit()) {
Init(local_state, url_loader_factory);
} else {
LOG_POLICY(INFO, CBCM_ENROLLMENT)
<< "Deferring CBCM Controller Initialization until it is unblocked.";
delegate_->DeferInitialization(base::BindOnce(
&ChromeBrowserCloudManagementController::Init,
weak_factory_.GetWeakPtr(), local_state, url_loader_factory));
}
}
bool ChromeBrowserCloudManagementController::
WaitUntilPolicyEnrollmentFinished() {
return delegate_->WaitUntilPolicyEnrollmentFinished();
}
void ChromeBrowserCloudManagementController::AddObserver(Observer* observer) {
observers_.AddObserver(observer);
}
void ChromeBrowserCloudManagementController::RemoveObserver(
Observer* observer) {
observers_.RemoveObserver(observer);
}
bool ChromeBrowserCloudManagementController::
IsEnterpriseStartupDialogShowing() {
return delegate_->IsEnterpriseStartupDialogShowing();
}
void ChromeBrowserCloudManagementController::UnenrollBrowser(
bool delete_dm_token) {
if (delete_dm_token) {
DVLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Browser unenrollment: Attempting DMToken deletion";
BrowserDMTokenStorage::Get()->ClearDMToken(base::BindOnce(
&ChromeBrowserCloudManagementController::UnenrollCallback,
weak_factory_.GetWeakPtr(), "DMTokenDeletion"));
return;
}
// Invalidate DM token in storage.
DVLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Browser unenrollment: Attempting DMToken invalidation";
BrowserDMTokenStorage::Get()->InvalidateDMToken(
base::BindOnce(&ChromeBrowserCloudManagementController::UnenrollCallback,
weak_factory_.GetWeakPtr(), "UnenrollSuccess"));
}
void ChromeBrowserCloudManagementController::InvalidatePolicies() {
// Reset policies.
if (policy_fetcher_) {
policy_fetcher_->RemoveClientObserver(this);
policy_fetcher_->Disconnect();
}
// This causes the scheduler to stop refreshing itself since the DM token is
// no longer valid.
if (report_scheduler_)
report_scheduler_->OnDMTokenUpdated();
}
void ChromeBrowserCloudManagementController::UnenrollCallback(
const std::string& metric_name,
bool success) {
base::UmaHistogramBoolean(
base::StrCat(
{"Enterprise.MachineLevelUserCloudPolicyEnrollment.", metric_name}),
success);
DVLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Browser unenrollment: " << (success ? "succeeded" : "failed");
if (success)
InvalidatePolicies();
NotifyBrowserUnenrolled(success);
}
void ChromeBrowserCloudManagementController::OnClientError(
CloudPolicyClient* client) {
// DM_STATUS_SERVICE_DEVICE_NOT_FOUND being the last status implies the
// browser has been unenrolled via DMToken invalidation, so it is not expected
// to re-enroll automatically. DM_STATUS_SERVICE_DEVICE_NEEDS_RESET signals
// that the browser has been unenrolled via DMToken deletion, and that it will
// automatically re-enroll if a valid enrollment token has been set.
if (client->last_dm_status() == DM_STATUS_SERVICE_DEVICE_NOT_FOUND ||
client->last_dm_status() == DM_STATUS_SERVICE_DEVICE_NEEDS_RESET) {
UnenrollBrowser(/*delete_dm_token=*/client->last_dm_status() ==
DM_STATUS_SERVICE_DEVICE_NEEDS_RESET);
}
}
void ChromeBrowserCloudManagementController::OnServiceAccountSet(
CloudPolicyClient* client,
const std::string& account_email) {
delegate_->OnServiceAccountSet(client, account_email);
}
void ChromeBrowserCloudManagementController::ShutDown() {
NotifyShutdown();
delegate_->ShutDown();
if (report_scheduler_)
report_scheduler_.reset();
}
enterprise_connectors::DeviceTrustKeyManager*
ChromeBrowserCloudManagementController::GetDeviceTrustKeyManager() {
if (!device_trust_key_manager_) {
device_trust_key_manager_ = delegate_->CreateDeviceTrustKeyManager();
}
return device_trust_key_manager_.get();
}
client_certificates::CertificateProvisioningService*
ChromeBrowserCloudManagementController::GetCertificateProvisioningService() {
if (!certificate_provisioning_service_) {
certificate_provisioning_service_ =
delegate_->CreateCertificateProvisioningService();
}
return certificate_provisioning_service_.get();
}
void ChromeBrowserCloudManagementController::SetGaiaURLLoaderFactory(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory) {
delegate_->SetGaiaURLLoaderFactory(url_loader_factory);
}
void ChromeBrowserCloudManagementController::NotifyPolicyRegisterFinished(
bool succeeded) {
for (auto& observer : observers_) {
observer.OnPolicyRegisterFinished(succeeded);
}
}
void ChromeBrowserCloudManagementController::NotifyBrowserUnenrolled(
bool succeeded) {
for (auto& observer : observers_)
observer.OnBrowserUnenrolled(succeeded);
}
void ChromeBrowserCloudManagementController::NotifyCloudReportingLaunched() {
for (auto& observer : observers_) {
observer.OnCloudReportingLaunched(report_scheduler_.get());
}
}
void ChromeBrowserCloudManagementController::NotifyShutdown() {
for (auto& observer : observers_) {
observer.OnShutdown();
}
}
bool ChromeBrowserCloudManagementController::GetEnrollmentTokenAndClientId(
std::string* enrollment_token,
std::string* client_id) {
*client_id = BrowserDMTokenStorage::Get()->RetrieveClientId();
if (client_id->empty())
return false;
*enrollment_token = BrowserDMTokenStorage::Get()->RetrieveEnrollmentToken();
return !enrollment_token->empty();
}
void ChromeBrowserCloudManagementController::
RegisterForCloudManagementWithEnrollmentTokenCallback(
const std::string& dm_token,
const std::string& client_id) {
base::TimeDelta enrollment_time = base::Time::Now() - enrollment_start_time_;
if (dm_token.empty()) {
VLOG_POLICY(1, CBCM_ENROLLMENT)
<< "No DM token returned from browser registration.";
RecordEnrollmentResult(
ChromeBrowserCloudManagementEnrollmentResult::kFailedToFetch);
MachineLevelUserCloudPolicyManager* policy_manager =
delegate_->GetMachineLevelUserCloudPolicyManager();
if (policy_manager)
policy_manager->store()->InitWithoutToken();
NotifyPolicyRegisterFinished(false);
return;
}
VLOG_POLICY(1, CBCM_ENROLLMENT) << "DM token retrieved from server.";
base::UmaHistogramTimes(
"Enterprise.MachineLevelUserCloudPolicyEnrollment.RequestSuccessTime",
enrollment_time);
// TODO(alito): Log failures to store the DM token. Should we try again later?
BrowserDMTokenStorage::Get()->StoreDMToken(
dm_token,
base::BindOnce(
[](base::WeakPtr<ChromeBrowserCloudManagementController> controller,
bool success) {
if (!success) {
DVLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Failed to store the DM token";
controller->RecordEnrollmentResult(
ChromeBrowserCloudManagementEnrollmentResult::kFailedToStore);
} else {
DVLOG_POLICY(1, CBCM_ENROLLMENT)
<< "Successfully stored the DM token";
controller->RecordEnrollmentResult(
ChromeBrowserCloudManagementEnrollmentResult::kSuccess);
}
},
weak_factory_.GetWeakPtr()));
// Start fetching policies.
VLOG_POLICY(1, POLICY_FETCHING) << "Fetch policy after enrollment.";
policy_fetcher_->SetupRegistrationAndFetchPolicy(
BrowserDMTokenStorage::Get()->RetrieveDMToken(), client_id);
if (report_scheduler_) {
report_scheduler_->OnDMTokenUpdated();
}
NotifyPolicyRegisterFinished(true);
}
void ChromeBrowserCloudManagementController::CreateReportScheduler() {
cloud_policy_client_ = std::make_unique<policy::CloudPolicyClient>(
delegate_->GetDeviceManagementService(),
delegate_->GetSharedURLLoaderFactory(),
CloudPolicyClient::DeviceDMTokenCallback());
cloud_policy_client_->AddObserver(this);
auto reporting_delegate_factory = delegate_->GetReportingDelegateFactory();
enterprise_reporting::ReportScheduler::CreateParams params;
params.client = cloud_policy_client_.get();
params.delegate = reporting_delegate_factory->GetReportSchedulerDelegate();
params.report_generator =
std::make_unique<enterprise_reporting::ReportGenerator>(
reporting_delegate_factory.get());
params.real_time_report_controller =
std::make_unique<enterprise_reporting::RealTimeReportController>(
reporting_delegate_factory.get());
report_scheduler_ = std::make_unique<enterprise_reporting::ReportScheduler>(
std::move(params));
NotifyCloudReportingLaunched();
}
void ChromeBrowserCloudManagementController::DeferrableCreatePolicyManagerImpl(
ConfigurationPolicyProvider* platform_provider,
base::OnceCallback<
void(std::unique_ptr<MachineLevelUserCloudPolicyManager>)> callback) {
std::unique_ptr<MachineLevelUserCloudPolicyManager> policy_manager =
CreatePolicyManager(platform_provider);
std::move(callback).Run(std::move(policy_manager));
}
void ChromeBrowserCloudManagementController::RecordEnrollmentResult(
ChromeBrowserCloudManagementEnrollmentResult result) {
base::UmaHistogramEnumeration(
"Enterprise.MachineLevelUserCloudPolicyEnrollment.Result", result);
for (auto& observer : observers_) {
observer.OnEnrollmentResultRecorded();
}
}
} // namespace policy
|