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 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
|
// Copyright 2019 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/signaling/ftl_signal_strategy.h"
#include <utility>
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/rand_util.h"
#include "base/sequence_checker.h"
#include "base/strings/string_number_conversions.h"
#include "base/task/sequenced_task_runner.h"
#include "remoting/base/http_status.h"
#include "remoting/base/logging.h"
#include "remoting/base/oauth_token_getter.h"
#include "remoting/signaling/ftl_device_id_provider.h"
#include "remoting/signaling/ftl_messaging_client.h"
#include "remoting/signaling/ftl_registration_manager.h"
#include "remoting/signaling/signaling_address.h"
#include "remoting/signaling/xmpp_constants.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "third_party/libjingle_xmpp/xmllite/xmlelement.h"
namespace remoting {
class FtlSignalStrategy::Core {
public:
Core(std::unique_ptr<OAuthTokenGetter> oauth_token_getter,
std::unique_ptr<RegistrationManager> registration_manager,
std::unique_ptr<MessagingClient> messaging_client);
Core(const Core&) = delete;
Core& operator=(const Core&) = delete;
~Core();
void Connect();
void Disconnect();
State GetState() const;
Error GetError() const;
const SignalingAddress& GetLocalAddress() const;
void AddListener(Listener* listener);
void RemoveListener(Listener* listener);
bool SendStanza(std::unique_ptr<jingle_xmpp::XmlElement> stanza);
bool SendMessage(const SignalingAddress& destination_address,
const ftl::ChromotingMessage& message);
bool IsSignInError() const;
private:
// Methods are called in the order below when Connect() is called.
void OnGetOAuthTokenResponse(OAuthTokenGetter::Status status,
const OAuthTokenInfo& token_info);
void OnSignInGaiaResponse(const HttpStatus& status);
void StartReceivingMessages();
void OnReceiveMessagesStreamStarted();
void OnReceiveMessagesStreamClosed(const HttpStatus& status);
void OnMessageReceived(const ftl::Id& sender_id,
const std::string& sender_registration_id,
const ftl::ChromotingMessage& message);
void SendMessageImpl(const SignalingAddress& receiver,
const ftl::ChromotingMessage& message,
MessagingClient::DoneCallback callback);
void OnSendMessageResponse(const SignalingAddress& receiver,
const std::string& stanza_id,
const HttpStatus& status);
// Returns true if the status is handled.
void HandleHttpStatusError(const base::Location& location,
const HttpStatus& status);
void OnStanza(const SignalingAddress& sender_address,
std::unique_ptr<jingle_xmpp::XmlElement> stanza);
std::unique_ptr<OAuthTokenGetter> oauth_token_getter_;
std::unique_ptr<RegistrationManager> registration_manager_;
std::unique_ptr<MessagingClient> messaging_client_;
std::string user_email_;
SignalingAddress local_address_;
base::CallbackListSubscription receive_message_subscription_;
Error error_ = OK;
bool is_sign_in_error_ = false;
base::ObserverList<Listener, true> listeners_;
SEQUENCE_CHECKER(sequence_checker_);
base::WeakPtrFactory<Core> weak_factory_{this};
};
FtlSignalStrategy::Core::Core(
std::unique_ptr<OAuthTokenGetter> oauth_token_getter,
std::unique_ptr<RegistrationManager> registration_manager,
std::unique_ptr<MessagingClient> messaging_client) {
DCHECK(oauth_token_getter);
DCHECK(registration_manager);
DCHECK(messaging_client);
oauth_token_getter_ = std::move(oauth_token_getter);
registration_manager_ = std::move(registration_manager);
messaging_client_ = std::move(messaging_client);
}
FtlSignalStrategy::Core::~Core() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (registration_manager_) {
registration_manager_->SignOut();
}
Disconnect();
}
void FtlSignalStrategy::Core::Connect() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (GetState() != DISCONNECTED) {
LOG(WARNING) << "Signaling is not disconnected. State: " << GetState();
return;
}
error_ = OK;
is_sign_in_error_ = false;
receive_message_subscription_ =
messaging_client_->RegisterMessageCallback(base::BindRepeating(
&Core::OnMessageReceived, weak_factory_.GetWeakPtr()));
for (auto& observer : listeners_) {
observer.OnSignalStrategyStateChange(CONNECTING);
}
StartReceivingMessages();
}
void FtlSignalStrategy::Core::Disconnect() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (receive_message_subscription_) {
local_address_ = SignalingAddress();
receive_message_subscription_ = {};
messaging_client_->StopReceivingMessages();
for (auto& observer : listeners_) {
observer.OnSignalStrategyStateChange(DISCONNECTED);
}
}
}
SignalStrategy::State FtlSignalStrategy::Core::GetState() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!local_address_.empty()) {
DCHECK(receive_message_subscription_);
return CONNECTED;
} else if (receive_message_subscription_) {
return CONNECTING;
} else {
return DISCONNECTED;
}
}
SignalStrategy::Error FtlSignalStrategy::Core::GetError() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return error_;
}
const SignalingAddress& FtlSignalStrategy::Core::GetLocalAddress() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return local_address_;
}
void FtlSignalStrategy::Core::AddListener(Listener* listener) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
listeners_.AddObserver(listener);
}
void FtlSignalStrategy::Core::RemoveListener(Listener* listener) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
listeners_.RemoveObserver(listener);
}
bool FtlSignalStrategy::Core::SendStanza(
std::unique_ptr<jingle_xmpp::XmlElement> stanza) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (GetState() != CONNECTED) {
HOST_LOG << "Dropping signaling message because FTL is not connected.";
return false;
}
std::string to_error;
SignalingAddress to =
SignalingAddress::Parse(stanza.get(), SignalingAddress::TO, &to_error);
DCHECK(to_error.empty());
// Synthesizing the from attribute in the message.
stanza->SetAttr(kQNameFrom, local_address_.id());
std::string stanza_id = stanza->Attr(kQNameId);
ftl::ChromotingMessage crd_message;
crd_message.mutable_xmpp()->set_stanza(stanza->Str());
SendMessageImpl(to, crd_message,
base::BindOnce(&Core::OnSendMessageResponse,
weak_factory_.GetWeakPtr(), to, stanza_id));
// Return false if the SendMessageImpl() call above resulted in the
// SignalStrategy being disconnected.
return GetState() == CONNECTED;
}
bool FtlSignalStrategy::Core::SendMessage(
const SignalingAddress& destination_address,
const ftl::ChromotingMessage& message) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (GetState() != CONNECTED) {
HOST_LOG << "Dropping message because FTL is not connected.";
return false;
}
SendMessageImpl(
destination_address, message,
base::BindOnce(&Core::OnSendMessageResponse, weak_factory_.GetWeakPtr(),
destination_address, std::string()));
return true;
}
bool FtlSignalStrategy::Core::IsSignInError() const {
return is_sign_in_error_;
}
void FtlSignalStrategy::Core::OnGetOAuthTokenResponse(
OAuthTokenGetter::Status status,
const OAuthTokenInfo& token_info) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (status != OAuthTokenGetter::Status::SUCCESS) {
switch (status) {
case OAuthTokenGetter::Status::NETWORK_ERROR:
error_ = SignalStrategy::Error::NETWORK_ERROR;
break;
case OAuthTokenGetter::Status::AUTH_ERROR:
error_ = SignalStrategy::Error::AUTHENTICATION_FAILED;
break;
default:
NOTREACHED();
}
is_sign_in_error_ = true;
Disconnect();
return;
}
user_email_ = token_info.user_email();
if (user_email_.empty()) {
LOG(WARNING) << "No user email in the OAuth token response";
Disconnect();
return;
}
StartReceivingMessages();
}
void FtlSignalStrategy::Core::OnSignInGaiaResponse(const HttpStatus& status) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!status.ok()) {
is_sign_in_error_ = true;
HandleHttpStatusError(FROM_HERE, status);
return;
}
StartReceivingMessages();
}
void FtlSignalStrategy::Core::StartReceivingMessages() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK_EQ(CONNECTING, GetState());
DCHECK(!messaging_client_->IsReceivingMessages());
if (user_email_.empty()) {
oauth_token_getter_->CallWithToken(base::BindOnce(
&Core::OnGetOAuthTokenResponse, weak_factory_.GetWeakPtr()));
return;
}
if (!registration_manager_->IsSignedIn()) {
registration_manager_->SignInGaia(base::BindOnce(
&Core::OnSignInGaiaResponse, weak_factory_.GetWeakPtr()));
return;
}
messaging_client_->StartReceivingMessages(
base::BindOnce(&Core::OnReceiveMessagesStreamStarted,
weak_factory_.GetWeakPtr()),
base::BindOnce(&Core::OnReceiveMessagesStreamClosed,
weak_factory_.GetWeakPtr()));
}
void FtlSignalStrategy::Core::OnReceiveMessagesStreamStarted() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
local_address_ = SignalingAddress::CreateFtlSignalingAddress(
user_email_, registration_manager_->GetRegistrationId());
for (auto& observer : listeners_) {
observer.OnSignalStrategyStateChange(CONNECTED);
}
}
void FtlSignalStrategy::Core::OnReceiveMessagesStreamClosed(
const HttpStatus& status) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (status.error_code() == HttpStatus::Code::CANCELLED) {
LOG(WARNING) << "ReceiveMessages stream closed with CANCELLED code.";
}
DCHECK(!status.ok());
HandleHttpStatusError(FROM_HERE, status);
}
void FtlSignalStrategy::Core::OnMessageReceived(
const ftl::Id& sender_id,
const std::string& sender_registration_id,
const ftl::ChromotingMessage& message) {
for (auto& listener : listeners_) {
if (listener.OnSignalStrategyIncomingMessage(
sender_id, sender_registration_id, message)) {
return;
}
}
if (!message.has_xmpp()) {
LOG(WARNING) << "Ignoring message that doesn't have XMPP field.";
return;
}
auto sender_address = SignalingAddress::CreateFtlSignalingAddress(
sender_id.id(), sender_registration_id);
DCHECK(message.xmpp().has_stanza());
auto stanza = base::WrapUnique<jingle_xmpp::XmlElement>(
jingle_xmpp::XmlElement::ForStr(message.xmpp().stanza()));
if (!stanza) {
LOG(WARNING) << "Failed to parse XMPP: " << message.xmpp().stanza();
return;
}
OnStanza(sender_address, std::move(stanza));
}
void FtlSignalStrategy::Core::SendMessageImpl(
const SignalingAddress& receiver,
const ftl::ChromotingMessage& message,
MessagingClient::DoneCallback callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::string receiver_username;
std::string receiver_registration_id;
bool get_info_result =
receiver.GetFtlInfo(&receiver_username, &receiver_registration_id);
if (!get_info_result) {
LOG(DFATAL) << "Receiver is not in FTL address: " << receiver.id();
return;
}
std::string message_payload;
if (message.has_xmpp()) {
message_payload = message.xmpp().stanza();
} else if (message.has_echo()) {
message_payload = message.echo().message();
} else {
message_payload = "Error displaying message due to unknown format.";
}
HOST_LOG << "Sending outgoing message:\n"
<< "Receiver: " << receiver_username << "\n"
<< "Receiver registration ID: " << receiver_registration_id << "\n"
<< message_payload
<< "\n=========================================================";
messaging_client_->SendMessage(receiver_username, receiver_registration_id,
message, std::move(callback));
}
void FtlSignalStrategy::Core::OnSendMessageResponse(
const SignalingAddress& receiver,
const std::string& stanza_id,
const HttpStatus& status) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (status.ok()) {
return;
}
if (status.error_code() == HttpStatus::Code::UNAUTHENTICATED) {
HandleHttpStatusError(FROM_HERE, status);
return;
}
LOG(ERROR) << "Failed to send message to peer. Error code: "
<< static_cast<int>(status.error_code())
<< ", message: " << status.error_message();
if (stanza_id.empty()) {
// If the message sent was not related to signaling, then exit early.
return;
}
// Fake an error message so JingleSession will take it as PEER_IS_OFFLINE.
auto error_iq = std::make_unique<jingle_xmpp::XmlElement>(kQNameIq);
error_iq->SetAttr(kQNameType, kIqTypeError);
error_iq->SetAttr(kQNameId, stanza_id);
error_iq->SetAttr(kQNameFrom, receiver.id());
error_iq->SetAttr(kQNameTo, local_address_.id());
OnStanza(receiver, std::move(error_iq));
}
void FtlSignalStrategy::Core::HandleHttpStatusError(
const base::Location& location,
const HttpStatus& status) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!status.ok());
// We don't map HTTP_UNAUTHORIZED to AUTHENTICATION_FAILED here, as it will
// permanently terminate the host, which is not desirable since it might
// happen when the FTL registration becomes invalid while the robot account
// itself is still intact.
// AUTHENTICATION_FAILED is only reported if the OAuthTokenGetter fails to
// fetch the token.
error_ = Error::NETWORK_ERROR;
LOG(ERROR) << "Received server error. Error code: "
<< static_cast<int>(status.error_code())
<< ", message: " << status.error_message()
<< ", location: " << location.ToString();
if (status.error_code() == HttpStatus::Code::UNAUTHENTICATED ||
status.error_code() == HttpStatus::Code::PERMISSION_DENIED) {
oauth_token_getter_->InvalidateCache();
registration_manager_->SignOut();
}
Disconnect();
}
void FtlSignalStrategy::Core::OnStanza(
const SignalingAddress& sender_address,
std::unique_ptr<jingle_xmpp::XmlElement> stanza) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Validate the schema and FTL IDs.
if (stanza->Name() != kQNameIq) {
LOG(DFATAL) << "Received unexpected non-IQ packet " << stanza->Str();
return;
}
if (SignalingAddress(stanza->Attr(kQNameFrom)) != sender_address) {
LOG(DFATAL) << "Expected sender: " << sender_address.id()
<< ", but received: " << stanza->Attr(kQNameFrom);
return;
}
if (SignalingAddress(stanza->Attr(kQNameTo)) != local_address_) {
LOG(DFATAL) << "Expected receiver: " << local_address_.id()
<< ", but received: " << stanza->Attr(kQNameTo);
return;
}
HOST_LOG << "Received incoming stanza:\n"
<< stanza->Str()
<< "\n=========================================================";
for (auto& listener : listeners_) {
if (listener.OnSignalStrategyIncomingStanza(stanza.get())) {
return;
}
}
}
FtlSignalStrategy::FtlSignalStrategy(
std::unique_ptr<OAuthTokenGetter> oauth_token_getter,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
std::unique_ptr<FtlDeviceIdProvider> device_id_provider,
SignalingTracker* signaling_tracker) {
// TODO(yuweih): Just make FtlMessagingClient own FtlRegistrationManager and
// call SignInGaia() transparently.
auto registration_manager = std::make_unique<FtlRegistrationManager>(
oauth_token_getter.get(), url_loader_factory,
std::move(device_id_provider));
auto messaging_client = std::make_unique<FtlMessagingClient>(
oauth_token_getter.get(), url_loader_factory, registration_manager.get(),
signaling_tracker);
CreateCore(std::move(oauth_token_getter), std::move(registration_manager),
std::move(messaging_client));
}
FtlSignalStrategy::FtlSignalStrategy(
std::unique_ptr<OAuthTokenGetter> oauth_token_getter,
std::unique_ptr<RegistrationManager> registration_manager,
std::unique_ptr<MessagingClient> messaging_client) {
CreateCore(std::move(oauth_token_getter), std::move(registration_manager),
std::move(messaging_client));
}
FtlSignalStrategy::~FtlSignalStrategy() {
// All listeners should be removed at this point, so it's safe to detach
// |core_|.
base::SequencedTaskRunner::GetCurrentDefault()->DeleteSoon(FROM_HERE,
core_.release());
}
void FtlSignalStrategy::Connect() {
core_->Connect();
}
void FtlSignalStrategy::Disconnect() {
core_->Disconnect();
}
SignalStrategy::State FtlSignalStrategy::GetState() const {
return core_->GetState();
}
SignalStrategy::Error FtlSignalStrategy::GetError() const {
return core_->GetError();
}
const SignalingAddress& FtlSignalStrategy::GetLocalAddress() const {
return core_->GetLocalAddress();
}
void FtlSignalStrategy::AddListener(Listener* listener) {
core_->AddListener(listener);
}
void FtlSignalStrategy::RemoveListener(Listener* listener) {
core_->RemoveListener(listener);
}
bool FtlSignalStrategy::SendStanza(
std::unique_ptr<jingle_xmpp::XmlElement> stanza) {
return core_->SendStanza(std::move(stanza));
}
bool FtlSignalStrategy::SendMessage(const SignalingAddress& destination_address,
const ftl::ChromotingMessage& message) {
return core_->SendMessage(destination_address, message);
}
std::string FtlSignalStrategy::GetNextId() {
return base::NumberToString(base::RandUint64());
}
bool FtlSignalStrategy::IsSignInError() const {
return core_->IsSignInError();
}
void FtlSignalStrategy::CreateCore(
std::unique_ptr<OAuthTokenGetter> oauth_token_getter,
std::unique_ptr<RegistrationManager> registration_manager,
std::unique_ptr<MessagingClient> messaging_client) {
core_ = std::make_unique<Core>(std::move(oauth_token_getter),
std::move(registration_manager),
std::move(messaging_client));
}
} // namespace remoting
|