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
|
// 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 "remoting/host/setup/host_starter_base.h"
#include <memory>
#include <string>
#include <utility>
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/i18n/icu_string_conversions.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/threading/platform_thread.h"
#include "base/values.h"
#include "google_apis/gaia/gaia_oauth_client.h"
#include "google_apis/google_api_keys.h"
#include "remoting/base/fqdn.h"
#include "remoting/base/rsa_key_pair.h"
#include "remoting/host/host_config.h"
#include "remoting/host/setup/daemon_controller.h"
#include "remoting/host/setup/host_starter.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
namespace remoting {
HostStarterBase::HostStarterBase(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory)
: oauth_helper_(url_loader_factory) {
weak_ptr_ = weak_ptr_factory_.GetWeakPtr();
}
HostStarterBase::~HostStarterBase() = default;
void HostStarterBase::StartHost(Params params, CompletionCallback on_done) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!on_done_);
// |auth_code| and |redirect_url| must either both be populated or both empty.
CHECK(params.auth_code.empty() == params.redirect_url.empty());
start_host_params_ = std::move(params);
on_done_ = std::move(on_done);
if (start_host_params_.name.empty()) {
// Use the FQDN if a name was not provided via the command line.
start_host_params_.name = GetFqdn();
}
// Check to see if there is an existing host instance on this machine which
// needs to be cleaned up before we can create and start a new host instance.
daemon_controller_->GetConfig(
base::BindOnce(&HostStarterBase::OnExistingConfigLoaded, weak_ptr_));
}
void HostStarterBase::OnExistingConfigLoaded(
std::optional<base::Value::Dict> config) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (config.has_value()) {
std::string* host_id = config->FindString(kHostIdConfigPath);
if (host_id) {
existing_host_id_.emplace(*host_id);
// Formatted to make start_host output more readable.
LOG(INFO) << "\n Found existing host: `" << *existing_host_id_ << "`.\n"
<< " This instance will be deleted from the Directory before "
<< "starting the new host instance.";
}
}
RetrieveApiAccessToken();
}
void HostStarterBase::RetrieveApiAccessToken() {
// Subclasses which require an access token for their specific provisioning
// RPC should override this method and call RegisterNewHost() on completion or
// ReportError() if an access token cannot be retrieved.
RegisterNewHost(/*access_token=*/std::nullopt);
}
void HostStarterBase::OnNewHostRegistered(
const std::string& directory_id,
const std::string& owner_account_email,
const std::string& service_account_email,
const std::string& authorization_code) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (directory_id.empty()) {
HandleError("No host id returned by the Directory.", REGISTRATION_ERROR);
return;
}
if (!start_host_params_.id.empty() &&
!base::EqualsCaseInsensitiveASCII(start_host_params_.id, directory_id)) {
HandleError(base::StringPrintf(
"Host id (%s) returned from the service does not match "
"the host id provided (%s)",
directory_id.c_str(), start_host_params_.id.c_str()),
REGISTRATION_ERROR);
return;
}
start_host_params_.id = base::ToLowerASCII(directory_id);
if (!owner_account_email.empty()) {
start_host_params_.owner_email = base::ToLowerASCII(owner_account_email);
}
// For some use cases, the CRD backend will return the service account and for
// others we will need to use the email associated with the authz code. The
// first approach is preferred as then we can provide the email address to
// the OAuth helper to make sure they match so we set |service_account_email_|
// here if a value was provided. Otherwise we will set this member after
// retrieving the service account refresh token from the authorization code.
if (!service_account_email.empty()) {
service_account_email_ = base::ToLowerASCII(service_account_email);
}
if (authorization_code.empty()) {
HandleError("No authorization code returned by the Directory.",
REGISTRATION_ERROR);
return;
}
oauth_helper_.FetchTokens(
service_account_email, authorization_code,
{
.client_id =
google_apis::GetOAuth2ClientID(google_apis::CLIENT_REMOTING_HOST),
.client_secret = google_apis::GetOAuth2ClientSecret(
google_apis::CLIENT_REMOTING_HOST),
// Service account requests do not set |redirect_uri|.
},
base::BindOnce(&HostStarterBase::OnServiceAccountTokensRetrieved,
weak_ptr_),
base::BindOnce(&HostStarterBase::HandleError, weak_ptr_));
}
void HostStarterBase::OnServiceAccountTokensRetrieved(
const std::string& service_account_email,
const std::string& access_token,
const std::string& refresh_token,
const std::string& scopes) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (service_account_email_.empty()) {
service_account_email_ = base::ToLowerASCII(service_account_email);
}
service_account_refresh_token_ = refresh_token;
RemoveOldHostFromDirectory(
base::BindOnce(&HostStarterBase::StopOldHost, weak_ptr_));
}
void HostStarterBase::StopOldHost() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (existing_host_id_.has_value()) {
daemon_controller_->Stop(
base::BindOnce(&HostStarterBase::OnOldHostStopped, weak_ptr_));
} else {
GenerateConfigFile();
}
}
void HostStarterBase::OnOldHostStopped(DaemonController::AsyncResult result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
bool stopped = false;
for (auto i = 0; !stopped && i < 10; i++) {
stopped =
(daemon_controller_->GetState() == DaemonController::STATE_STOPPED);
if (!stopped) {
base::PlatformThread::Sleep(base::Seconds(1));
}
}
if (!stopped) {
LOG(WARNING) << "Unable to stop existing host process. Setup will "
<< "continue, but you may need to reboot to complete it.";
}
GenerateConfigFile();
}
void HostStarterBase::GenerateConfigFile() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::Value::Dict config;
// These 5 values are required for the host to start up properly. Other values
// are optional depending on the use case.
config.Set(kHostOwnerConfigPath, start_host_params_.owner_email);
config.Set(kServiceAccountConfigPath, service_account_email_);
config.Set(kOAuthRefreshTokenConfigPath, service_account_refresh_token_);
config.Set(kHostIdConfigPath, start_host_params_.id);
config.Set(kPrivateKeyConfigPath, key_pair_->ToString());
if (!start_host_params_.name.empty()) {
config.Set(kHostNameConfigPath, start_host_params_.name);
}
ApplyConfigValues(config);
config.Set(kUsageStatsConsentConfigPath,
start_host_params_.enable_crash_reporting);
daemon_controller_->SetConfigAndStart(
std::move(config), start_host_params_.enable_crash_reporting,
base::BindOnce(&HostStarterBase::OnNewHostStarted,
base::Unretained(this)));
}
void HostStarterBase::OnNewHostStarted(DaemonController::AsyncResult result) {
if (result != DaemonController::RESULT_OK) {
HandleError(base::StringPrintf("Failed to start host: %d",
static_cast<int>(result)),
START_ERROR);
} else {
std::move(on_done_).Run(START_COMPLETE);
}
}
void HostStarterBase::HandleError(const std::string& error_message,
Result error_result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
ReportError(error_message, base::BindOnce(std::move(on_done_), error_result));
}
void HostStarterBase::HandleHttpStatusError(const HttpStatus& status) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
HttpStatus::Code error_code = status.error_code();
std::string error_message = status.error_message();
LOG(ERROR) << "\n Received error code: " << static_cast<int>(error_code)
<< ", message: " << error_message;
if (!status.response_body().empty()) {
std::string extended_error_info;
size_t pos = status.response_body().rfind("Caused by: ");
if (pos != std::string::npos) {
extended_error_info = status.response_body().substr(pos);
} else {
extended_error_info = status.response_body();
}
VLOG(1) << "Full error information: \n" << status.response_body();
// Convert the string contents if it is not valid UTF-8. Otherwise it can
// cause additional errors when reporting the original error to our backend.
if (!base::IsStringUTF8(extended_error_info)) {
std::string converted_string;
if (base::ConvertToUtf8AndNormalize(
extended_error_info, base::kCodepageLatin1, &converted_string)) {
extended_error_info = std::move(converted_string);
}
}
error_message =
base::StringPrintf("%s\nExtended error information: %s\n",
error_message.c_str(), extended_error_info.c_str());
}
auto result = NETWORK_ERROR;
if (error_code == HttpStatus::Code::PERMISSION_DENIED) {
result = PERMISSION_DENIED;
} else if (error_code == HttpStatus::Code::UNAUTHENTICATED) {
result = OAUTH_ERROR;
}
HandleError(error_message, result);
}
void HostStarterBase::ReportError(const std::string& message,
base::OnceClosure on_error_reported) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
LOG(ERROR) << message;
std::move(on_error_reported).Run();
}
void HostStarterBase::SetDaemonControllerForTest(
scoped_refptr<remoting::DaemonController> daemon_controller) {
daemon_controller_ = daemon_controller;
}
} // namespace remoting
|