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
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#include "remoting/host/setup/daemon_controller_delegate_win.h"
#include <stddef.h>
#include <tuple>
#include <utility>
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/json/json_reader.h"
#include "base/json/json_writer.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/values.h"
#include "base/win/scoped_bstr.h"
#include "remoting/base/is_google_email.h"
#include "remoting/base/scoped_sc_handle_win.h"
#include "remoting/host/branding.h"
#include "remoting/host/host_config.h"
#include "remoting/host/usage_stats_consent.h"
#include "remoting/host/win/security_descriptor.h"
namespace remoting {
namespace {
// The maximum size of the configuration file. "1MB ought to be enough" for any
// reasonable configuration we will ever need. 1MB is low enough to make the
// probability of out of memory situation fairly low. OOM is still possible and
// we will crash if it occurs.
const size_t kMaxConfigFileSize = 1024 * 1024;
// The host configuration file name.
const base::FilePath::CharType kConfigFileName[] =
FILE_PATH_LITERAL("host.json");
// The unprivileged configuration file name.
const base::FilePath::CharType kUnprivilegedConfigFileName[] =
FILE_PATH_LITERAL("host_unprivileged.json");
// The extension for the temporary file.
const base::FilePath::CharType kTempFileExtension[] =
FILE_PATH_LITERAL("json~");
// The host configuration file security descriptor that enables full access to
// Local System and built-in administrators only.
const char kConfigFileSecurityDescriptor[] =
"O:BAG:BAD:(A;;GA;;;SY)(A;;GA;;;BA)";
const char kUnprivilegedConfigFileSecurityDescriptor[] =
"O:BAG:BAD:(A;;GA;;;SY)(A;;GA;;;BA)(A;;GR;;;AU)";
// Configuration keys.
// The configuration keys that cannot be specified in UpdateConfig().
const char* const kReadonlyKeys[] = {
kHostIdConfigPath, kHostOwnerConfigPath, kServiceAccountConfigPath,
kDeprecatedXmppLoginConfigPath, kDeprecatedHostOwnerEmailConfigPath};
// The configuration keys whose values may be read by GetConfig().
const char* const kUnprivilegedConfigKeys[] = {kHostIdConfigPath,
kServiceAccountConfigPath,
kDeprecatedXmppLoginConfigPath};
// Reads and parses the configuration file up to |kMaxConfigFileSize| in size.
bool ReadConfig(const base::FilePath& filename, base::Value::Dict& config_out) {
// ReadConfig is called in cases where no config file is expected to be
// present so check to see if a file exists before attempting to read and
// parse it.
if (!base::PathExists(filename)) {
LOG(INFO) << "'" << filename.value() << "' does not exist, skipping read.";
return false;
}
std::string file_content;
if (!base::ReadFileToStringWithMaxSize(filename, &file_content,
kMaxConfigFileSize)) {
PLOG(ERROR) << "Failed to read '" << filename.value() << "'.";
return false;
}
std::optional<base::Value::Dict> config = HostConfigFromJson(file_content);
if (!config.has_value()) {
LOG(ERROR) << "Config file: '" << filename.value() << "' is empty.";
return false;
}
config_out = std::move(*config);
return true;
}
base::FilePath GetTempLocationFor(const base::FilePath& filename) {
return filename.ReplaceExtension(kTempFileExtension);
}
// Writes a config file to a temporary location.
bool WriteConfigFileToTemp(const base::FilePath& filename,
const char* security_descriptor,
const std::string& content) {
// Create the security descriptor for the configuration file.
ScopedSd sd = ConvertSddlToSd(security_descriptor);
if (!sd) {
PLOG(ERROR)
<< "Failed to create a security descriptor for the configuration file";
return false;
}
SECURITY_ATTRIBUTES security_attributes = {0};
security_attributes.nLength = sizeof(security_attributes);
security_attributes.lpSecurityDescriptor = sd.get();
security_attributes.bInheritHandle = FALSE;
// Create a temporary file and write configuration to it.
base::FilePath tempname = GetTempLocationFor(filename);
base::win::ScopedHandle file(CreateFileW(
tempname.value().c_str(), GENERIC_WRITE, 0, &security_attributes,
CREATE_ALWAYS, FILE_FLAG_SEQUENTIAL_SCAN, nullptr));
if (!file.IsValid()) {
PLOG(ERROR) << "Failed to create '" << filename.value() << "'";
return false;
}
DWORD written;
if (!::WriteFile(file.Get(), content.c_str(), content.length(), &written,
nullptr)) {
PLOG(ERROR) << "Failed to write to '" << filename.value() << "'";
return false;
}
return true;
}
// Moves a config file from its temporary location to its permanent location.
bool MoveConfigFileFromTemp(const base::FilePath& filename) {
// Now that the configuration is stored successfully replace the actual
// configuration file.
base::FilePath tempname = GetTempLocationFor(filename);
if (!MoveFileExW(tempname.value().c_str(), filename.value().c_str(),
MOVEFILE_REPLACE_EXISTING)) {
PLOG(ERROR) << "Failed to rename '" << tempname.value() << "' to '"
<< filename.value() << "'";
return false;
}
return true;
}
// Writes the configuration file up to |kMaxConfigFileSize| in size.
bool WriteConfig(const base::Value::Dict& config) {
std::string config_json = HostConfigToJson(config);
if (config_json.length() > kMaxConfigFileSize) {
LOG(ERROR) << "Config is larger than the max size: " << kMaxConfigFileSize;
return false;
}
// Ensure the required fields are present.
if (!config.FindString(kHostIdConfigPath)) {
LOG(ERROR) << "Config is missing " << kHostIdConfigPath;
return false;
}
const std::string* host_owner = config.FindString(kHostOwnerConfigPath);
if (!host_owner) {
LOG(ERROR) << "Config is missing " << kHostOwnerConfigPath;
return false;
}
if (!config.FindString(kHostSecretHashConfigPath) &&
!IsGoogleEmail(*host_owner)) {
// PIN authentication is not needed for Google hosts so we only want to
// fail if a secret_hash value isn't present for a non-Google host.
LOG(ERROR) << "Config is missing " << kHostSecretHashConfigPath;
return false;
}
if (!config.FindString(kServiceAccountConfigPath) &&
!config.FindString(kDeprecatedXmppLoginConfigPath)) {
LOG(ERROR) << "Config is missing " << kServiceAccountConfigPath << " and "
<< kDeprecatedXmppLoginConfigPath;
return false;
}
// Write the full configuration file to a temporary location.
base::FilePath full_config_file_path =
remoting::GetConfigDir().Append(kConfigFileName);
if (!WriteConfigFileToTemp(full_config_file_path,
kConfigFileSecurityDescriptor, config_json)) {
return false;
}
// Extract the unprivileged fields from the configuration.
base::Value::Dict unprivileged_config;
for (const char* key : kUnprivilegedConfigKeys) {
if (const std::string* value = config.FindString(key)) {
unprivileged_config.Set(key, *value);
}
}
// Write the unprivileged configuration file to a temporary location.
base::FilePath unprivileged_config_file_path =
remoting::GetConfigDir().Append(kUnprivilegedConfigFileName);
if (!WriteConfigFileToTemp(unprivileged_config_file_path,
kUnprivilegedConfigFileSecurityDescriptor,
HostConfigToJson(unprivileged_config))) {
return false;
}
// Move the full and unprivileged configuration files to their permanent
// locations.
return MoveConfigFileFromTemp(full_config_file_path) &&
MoveConfigFileFromTemp(unprivileged_config_file_path);
}
DaemonController::State ConvertToDaemonState(DWORD service_state) {
switch (service_state) {
case SERVICE_RUNNING:
return DaemonController::STATE_STARTED;
case SERVICE_CONTINUE_PENDING:
case SERVICE_START_PENDING:
return DaemonController::STATE_STARTING;
case SERVICE_PAUSE_PENDING:
case SERVICE_STOP_PENDING:
return DaemonController::STATE_STOPPING;
case SERVICE_PAUSED:
case SERVICE_STOPPED:
return DaemonController::STATE_STOPPED;
default:
NOTREACHED();
}
}
ScopedScHandle OpenService(DWORD access) {
// Open the service and query its current state.
ScopedScHandle scmanager(
::OpenSCManagerW(nullptr, SERVICES_ACTIVE_DATABASE,
SC_MANAGER_CONNECT | SC_MANAGER_ENUMERATE_SERVICE));
if (!scmanager.IsValid()) {
PLOG(ERROR) << "Failed to connect to the service control manager";
return ScopedScHandle();
}
ScopedScHandle service(
::OpenServiceW(scmanager.Get(), kWindowsServiceName, access));
if (!service.IsValid()) {
PLOG(ERROR) << "Failed to open to the '" << kWindowsServiceName
<< "' service";
}
return service;
}
void InvokeCompletionCallback(DaemonController::CompletionCallback done,
bool success) {
DaemonController::AsyncResult async_result =
success ? DaemonController::RESULT_OK : DaemonController::RESULT_FAILED;
std::move(done).Run(async_result);
}
bool StartDaemon() {
DWORD access = SERVICE_CHANGE_CONFIG | SERVICE_QUERY_STATUS | SERVICE_START |
SERVICE_STOP;
ScopedScHandle service = OpenService(access);
if (!service.IsValid()) {
return false;
}
// Change the service start type to 'auto'.
if (!::ChangeServiceConfigW(service.Get(), SERVICE_NO_CHANGE,
SERVICE_AUTO_START, SERVICE_NO_CHANGE, nullptr,
nullptr, nullptr, nullptr, nullptr, nullptr,
nullptr)) {
PLOG(ERROR) << "Failed to change the '" << kWindowsServiceName
<< "'service start type to 'auto'";
return false;
}
// Start the service.
if (!StartService(service.Get(), 0, nullptr)) {
DWORD error = GetLastError();
if (error != ERROR_SERVICE_ALREADY_RUNNING) {
LOG(ERROR) << "Failed to start the '" << kWindowsServiceName
<< "'service: " << error;
return false;
}
}
return true;
}
bool StopDaemon() {
DWORD access = SERVICE_CHANGE_CONFIG | SERVICE_QUERY_STATUS | SERVICE_START |
SERVICE_STOP;
ScopedScHandle service = OpenService(access);
if (!service.IsValid()) {
return false;
}
// Change the service start type to 'manual'.
if (!::ChangeServiceConfigW(service.Get(), SERVICE_NO_CHANGE,
SERVICE_DEMAND_START, SERVICE_NO_CHANGE, nullptr,
nullptr, nullptr, nullptr, nullptr, nullptr,
nullptr)) {
PLOG(ERROR) << "Failed to change the '" << kWindowsServiceName
<< "'service start type to 'manual'";
return false;
}
// Stop the service.
SERVICE_STATUS status;
if (!ControlService(service.Get(), SERVICE_CONTROL_STOP, &status)) {
DWORD error = GetLastError();
if (error != ERROR_SERVICE_NOT_ACTIVE) {
LOG(ERROR) << "Failed to stop the '" << kWindowsServiceName
<< "'service: " << error;
return false;
}
}
return true;
}
} // namespace
DaemonControllerDelegateWin::DaemonControllerDelegateWin() {}
DaemonControllerDelegateWin::~DaemonControllerDelegateWin() {}
DaemonController::State DaemonControllerDelegateWin::GetState() {
// TODO(alexeypa): Make the thread alertable, so we can switch to APC
// notifications rather than polling.
ScopedScHandle service = OpenService(SERVICE_QUERY_STATUS);
if (!service.IsValid()) {
return DaemonController::STATE_UNKNOWN;
}
SERVICE_STATUS status;
if (!::QueryServiceStatus(service.Get(), &status)) {
PLOG(ERROR) << "Failed to query the state of the '" << kWindowsServiceName
<< "' service";
return DaemonController::STATE_UNKNOWN;
}
return ConvertToDaemonState(status.dwCurrentState);
}
std::optional<base::Value::Dict> DaemonControllerDelegateWin::GetConfig() {
base::FilePath config_dir = remoting::GetConfigDir();
// Read the unprivileged part of host configuration.
base::Value::Dict config;
if (!ReadConfig(config_dir.Append(kUnprivilegedConfigFileName), config)) {
return std::nullopt;
}
return config;
}
void DaemonControllerDelegateWin::UpdateConfig(
base::Value::Dict updated_config,
DaemonController::CompletionCallback done) {
// Check for bad keys.
for (size_t i = 0; i < std::size(kReadonlyKeys); ++i) {
if (updated_config.Find(kReadonlyKeys[i])) {
LOG(ERROR) << "Cannot update config: '" << kReadonlyKeys[i]
<< "' is read only.";
InvokeCompletionCallback(std::move(done), false);
return;
}
}
// Get the old config.
base::FilePath config_dir = remoting::GetConfigDir();
base::Value::Dict config;
if (!ReadConfig(config_dir.Append(kConfigFileName), config)) {
InvokeCompletionCallback(std::move(done), false);
return;
}
// Merge items from the new config into the existing config.
config.Merge(std::move(updated_config));
// Write the updated config.
bool result = WriteConfig(config);
InvokeCompletionCallback(std::move(done), result);
}
void DaemonControllerDelegateWin::Stop(
DaemonController::CompletionCallback done) {
bool result = StopDaemon();
InvokeCompletionCallback(std::move(done), result);
}
DaemonController::UsageStatsConsent
DaemonControllerDelegateWin::GetUsageStatsConsent() {
DaemonController::UsageStatsConsent consent;
consent.supported = true;
consent.allowed = true;
consent.set_by_policy = false;
// Get the recorded user's consent.
bool allowed;
bool set_by_policy;
// If the user's consent is not recorded yet, assume that the user didn't
// consent to collecting crash dumps.
if (remoting::GetUsageStatsConsent(&allowed, &set_by_policy)) {
consent.allowed = allowed;
consent.set_by_policy = set_by_policy;
}
return consent;
}
void DaemonControllerDelegateWin::CheckPermission(
bool it2me,
DaemonController::BoolCallback callback) {
std::move(callback).Run(true);
}
void DaemonControllerDelegateWin::SetConfigAndStart(
base::Value::Dict config,
bool consent,
DaemonController::CompletionCallback done) {
// Record the user's consent.
if (!remoting::SetUsageStatsConsent(consent)) {
InvokeCompletionCallback(std::move(done), false);
return;
}
// Determine the config directory path and create it if necessary.
base::FilePath config_dir = remoting::GetConfigDir();
if (!base::CreateDirectory(config_dir)) {
PLOG(ERROR) << "Failed to create the config directory.";
InvokeCompletionCallback(std::move(done), false);
return;
}
// Set the configuration.
if (!WriteConfig(config)) {
InvokeCompletionCallback(std::move(done), false);
return;
}
// Start daemon.
InvokeCompletionCallback(std::move(done), StartDaemon());
}
scoped_refptr<DaemonController> DaemonController::Create() {
return new DaemonController(
base::WrapUnique(new DaemonControllerDelegateWin()));
}
} // namespace remoting
|