google_apis/gcm/tools/mcs_probe.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4 //
   5 // A standalone tool for testing MCS connections and the MCS client on their
   6 // own.
   7
   8 #include <cstddef>
   9 #include <cstdio>
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/at_exit.h"
  14 #include "base/command_line.h"
  15 #include "base/compiler_specific.h"
  16 #include "base/files/scoped_file.h"
  17 #include "base/logging.h"
  18 #include "base/memory/ref_counted.h"
  19 #include "base/memory/scoped_ptr.h"
  20 #include "base/message_loop/message_loop.h"
  21 #include "base/run_loop.h"
  22 #include "base/strings/string_number_conversions.h"
  23 #include "base/threading/thread.h"
  24 #include "base/threading/worker_pool.h"
  25 #include "base/time/default_clock.h"
  26 #include "base/values.h"
  27 #include "google_apis/gcm/base/fake_encryptor.h"
  28 #include "google_apis/gcm/base/mcs_message.h"
  29 #include "google_apis/gcm/base/mcs_util.h"
  30 #include "google_apis/gcm/engine/checkin_request.h"
  31 #include "google_apis/gcm/engine/connection_factory_impl.h"
  32 #include "google_apis/gcm/engine/gcm_store_impl.h"
  33 #include "google_apis/gcm/engine/gservices_settings.h"
  34 #include "google_apis/gcm/engine/mcs_client.h"
  35 #include "google_apis/gcm/monitoring/fake_gcm_stats_recorder.h"
  36 #include "net/base/host_mapping_rules.h"
  37 #include "net/cert/cert_verifier.h"
  38 #include "net/dns/host_resolver.h"
  39 #include "net/http/http_auth_handler_factory.h"
  40 #include "net/http/http_network_session.h"
  41 #include "net/http/http_server_properties_impl.h"
  42 #include "net/http/transport_security_state.h"
  43 #include "net/log/write_to_file_net_log_observer.h"
  44 #include "net/socket/client_socket_factory.h"
  45 #include "net/socket/ssl_client_socket.h"
  46 #include "net/ssl/channel_id_service.h"
  47 #include "net/ssl/default_channel_id_store.h"
  48 #include "net/url_request/url_request_test_util.h"
  49
  50 #if defined(OS_MACOSX)
  51 #include "base/mac/scoped_nsautorelease_pool.h"
  52 #endif
  53
  54 // This is a simple utility that initializes an mcs client and
  55 // prints out any events.
  56 namespace gcm {
  57 namespace {
  58
  59 const net::BackoffEntry::Policy kDefaultBackoffPolicy = {
  60   // Number of initial errors (in sequence) to ignore before applying
  61   // exponential back-off rules.
  62   0,
  63
  64   // Initial delay for exponential back-off in ms.
  65   15000,  // 15 seconds.
  66
  67   // Factor by which the waiting time will be multiplied.
  68   2,
  69
  70   // Fuzzing percentage. ex: 10% will spread requests randomly
  71   // between 90%-100% of the calculated time.
  72   0.5,  // 50%.
  73
  74   // Maximum amount of time we are willing to delay our request in ms.
  75   1000 * 60 * 5, // 5 minutes.
  76
  77   // Time to keep an entry from being discarded even when it
  78   // has no significant state, -1 to never discard.
  79   -1,
  80
  81   // Don't use initial delay unless the last request was an error.
  82   false,
  83 };
  84
  85 // Default values used to communicate with the check-in server.
  86 const char kChromeVersion[] = "Chrome MCS Probe";
  87
  88 // The default server to communicate with.
  89 const char kMCSServerHost[] = "mtalk.google.com";
  90 const uint16 kMCSServerPort = 5228;
  91
  92 // Command line switches.
  93 const char kRMQFileName[] = "rmq_file";
  94 const char kAndroidIdSwitch[] = "android_id";
  95 const char kSecretSwitch[] = "secret";
  96 const char kLogFileSwitch[] = "log-file";
  97 const char kIgnoreCertSwitch[] = "ignore-certs";
  98 const char kServerHostSwitch[] = "host";
  99 const char kServerPortSwitch[] = "port";
 100
 101 void MessageReceivedCallback(const MCSMessage& message) {
 102   LOG(INFO) << "Received message with id "
 103             << GetPersistentId(message.GetProtobuf()) << " and tag "
 104             << static_cast<int>(message.tag());
 105
 106   if (message.tag() == kDataMessageStanzaTag) {
 107     const mcs_proto::DataMessageStanza& data_message =
 108         reinterpret_cast<const mcs_proto::DataMessageStanza&>(
 109             message.GetProtobuf());
 110     DVLOG(1) << "  to: " << data_message.to();
 111     DVLOG(1) << "  from: " << data_message.from();
 112     DVLOG(1) << "  category: " << data_message.category();
 113     DVLOG(1) << "  sent: " << data_message.sent();
 114     for (int i = 0; i < data_message.app_data_size(); ++i) {
 115       DVLOG(1) << "  App data " << i << " "
 116                << data_message.app_data(i).key() << " : "
 117                << data_message.app_data(i).value();
 118     }
 119   }
 120 }
 121
 122 void MessageSentCallback(int64 user_serial_number,
 123                          const std::string& app_id,
 124                          const std::string& message_id,
 125                          MCSClient::MessageSendStatus status) {
 126   LOG(INFO) << "Message sent. Serial number: " << user_serial_number
 127             << " Application ID: " << app_id
 128             << " Message ID: " << message_id
 129             << " Message send status: " << status;
 130 }
 131
 132 // Needed to use a real host resolver.
 133 class MyTestURLRequestContext : public net::TestURLRequestContext {
 134  public:
 135   MyTestURLRequestContext() : TestURLRequestContext(true) {
 136     context_storage_.set_host_resolver(
 137         net::HostResolver::CreateDefaultResolver(NULL));
 138     context_storage_.set_transport_security_state(
 139         new net::TransportSecurityState());
 140     Init();
 141   }
 142
 143   ~MyTestURLRequestContext() override {}
 144 };
 145
 146 class MyTestURLRequestContextGetter : public net::TestURLRequestContextGetter {
 147  public:
 148   explicit MyTestURLRequestContextGetter(
 149       const scoped_refptr<base::MessageLoopProxy>& io_message_loop_proxy)
 150       : TestURLRequestContextGetter(io_message_loop_proxy) {}
 151
 152   net::TestURLRequestContext* GetURLRequestContext() override {
 153     // Construct |context_| lazily so it gets constructed on the right
 154     // thread (the IO thread).
 155     if (!context_)
 156       context_.reset(new MyTestURLRequestContext());
 157     return context_.get();
 158   }
 159
 160  private:
 161   ~MyTestURLRequestContextGetter() override {}
 162
 163   scoped_ptr<MyTestURLRequestContext> context_;
 164 };
 165
 166 // A cert verifier that access all certificates.
 167 class MyTestCertVerifier : public net::CertVerifier {
 168  public:
 169   MyTestCertVerifier() {}
 170   ~MyTestCertVerifier() override {}
 171
 172   int Verify(net::X509Certificate* cert,
 173              const std::string& hostname,
 174              const std::string& ocsp_response,
 175              int flags,
 176              net::CRLSet* crl_set,
 177              net::CertVerifyResult* verify_result,
 178              const net::CompletionCallback& callback,
 179              RequestHandle* out_req,
 180              const net::BoundNetLog& net_log) override {
 181     return net::OK;
 182   }
 183
 184   void CancelRequest(RequestHandle req) override {
 185     // Do nothing.
 186   }
 187 };
 188
 189 class MCSProbe {
 190  public:
 191   MCSProbe(
 192       const base::CommandLine& command_line,
 193       scoped_refptr<net::URLRequestContextGetter> url_request_context_getter);
 194   ~MCSProbe();
 195
 196   void Start();
 197
 198   uint64 android_id() const { return android_id_; }
 199   uint64 secret() const { return secret_; }
 200
 201  private:
 202   void CheckIn();
 203   void InitializeNetworkState();
 204   void BuildNetworkSession();
 205
 206   void LoadCallback(scoped_ptr<GCMStore::LoadResult> load_result);
 207   void UpdateCallback(bool success);
 208   void ErrorCallback();
 209   void OnCheckInCompleted(
 210       const checkin_proto::AndroidCheckinResponse& checkin_response);
 211   void StartMCSLogin();
 212
 213   base::DefaultClock clock_;
 214
 215   base::CommandLine command_line_;
 216
 217   base::FilePath gcm_store_path_;
 218   uint64 android_id_;
 219   uint64 secret_;
 220   std::string server_host_;
 221   int server_port_;
 222
 223   // Network state.
 224   scoped_refptr<net::URLRequestContextGetter> url_request_context_getter_;
 225   net::NetLog net_log_;
 226   scoped_ptr<net::WriteToFileNetLogObserver> logger_;
 227   scoped_ptr<net::HostResolver> host_resolver_;
 228   scoped_ptr<net::CertVerifier> cert_verifier_;
 229   scoped_ptr<net::ChannelIDService> system_channel_id_service_;
 230   scoped_ptr<net::TransportSecurityState> transport_security_state_;
 231   scoped_ptr<net::URLSecurityManager> url_security_manager_;
 232   scoped_ptr<net::HttpAuthHandlerFactory> http_auth_handler_factory_;
 233   scoped_ptr<net::HttpServerPropertiesImpl> http_server_properties_;
 234   scoped_ptr<net::HostMappingRules> host_mapping_rules_;
 235   scoped_refptr<net::HttpNetworkSession> network_session_;
 236   scoped_ptr<net::ProxyService> proxy_service_;
 237
 238   FakeGCMStatsRecorder recorder_;
 239   scoped_ptr<GCMStore> gcm_store_;
 240   scoped_ptr<MCSClient> mcs_client_;
 241   scoped_ptr<CheckinRequest> checkin_request_;
 242
 243   scoped_ptr<ConnectionFactoryImpl> connection_factory_;
 244
 245   base::Thread file_thread_;
 246
 247   scoped_ptr<base::RunLoop> run_loop_;
 248 };
 249
 250 MCSProbe::MCSProbe(
 251     const base::CommandLine& command_line,
 252     scoped_refptr<net::URLRequestContextGetter> url_request_context_getter)
 253     : command_line_(command_line),
 254       gcm_store_path_(base::FilePath(FILE_PATH_LITERAL("gcm_store"))),
 255       android_id_(0),
 256       secret_(0),
 257       server_port_(0),
 258       url_request_context_getter_(url_request_context_getter),
 259       file_thread_("FileThread") {
 260   if (command_line.HasSwitch(kRMQFileName)) {
 261     gcm_store_path_ = command_line.GetSwitchValuePath(kRMQFileName);
 262   }
 263   if (command_line.HasSwitch(kAndroidIdSwitch)) {
 264     base::StringToUint64(command_line.GetSwitchValueASCII(kAndroidIdSwitch),
 265                          &android_id_);
 266   }
 267   if (command_line.HasSwitch(kSecretSwitch)) {
 268     base::StringToUint64(command_line.GetSwitchValueASCII(kSecretSwitch),
 269                          &secret_);
 270   }
 271   server_host_ = kMCSServerHost;
 272   if (command_line.HasSwitch(kServerHostSwitch)) {
 273     server_host_ = command_line.GetSwitchValueASCII(kServerHostSwitch);
 274   }
 275   server_port_ = kMCSServerPort;
 276   if (command_line.HasSwitch(kServerPortSwitch)) {
 277     base::StringToInt(command_line.GetSwitchValueASCII(kServerPortSwitch),
 278                       &server_port_);
 279   }
 280 }
 281
 282 MCSProbe::~MCSProbe() {
 283   if (logger_)
 284     logger_->StopObserving(nullptr);
 285   file_thread_.Stop();
 286 }
 287
 288 void MCSProbe::Start() {
 289   file_thread_.Start();
 290   InitializeNetworkState();
 291   BuildNetworkSession();
 292   std::vector<GURL> endpoints(1,
 293                               GURL("https://" +
 294                                    net::HostPortPair(server_host_,
 295                                                      server_port_).ToString()));
 296   connection_factory_.reset(
 297       new ConnectionFactoryImpl(endpoints,
 298                                 kDefaultBackoffPolicy,
 299                                 network_session_,
 300                                 NULL,
 301                                 &net_log_,
 302                                 &recorder_));
 303   gcm_store_.reset(
 304       new GCMStoreImpl(gcm_store_path_,
 305                        file_thread_.message_loop_proxy(),
 306                        make_scoped_ptr<Encryptor>(new FakeEncryptor)));
 307   mcs_client_.reset(new MCSClient("probe",
 308                                   &clock_,
 309                                   connection_factory_.get(),
 310                                   gcm_store_.get(),
 311                                   &recorder_));
 312   run_loop_.reset(new base::RunLoop());
 313   gcm_store_->Load(base::Bind(&MCSProbe::LoadCallback,
 314                               base::Unretained(this)));
 315   run_loop_->Run();
 316 }
 317
 318 void MCSProbe::LoadCallback(scoped_ptr<GCMStore::LoadResult> load_result) {
 319   DCHECK(load_result->success);
 320   if (android_id_ != 0 && secret_ != 0) {
 321     DVLOG(1) << "Presetting MCS id " << android_id_;
 322     load_result->device_android_id = android_id_;
 323     load_result->device_security_token = secret_;
 324     gcm_store_->SetDeviceCredentials(android_id_,
 325                                      secret_,
 326                                      base::Bind(&MCSProbe::UpdateCallback,
 327                                                 base::Unretained(this)));
 328   } else {
 329     android_id_ = load_result->device_android_id;
 330     secret_ = load_result->device_security_token;
 331     DVLOG(1) << "Loaded MCS id " << android_id_;
 332   }
 333   mcs_client_->Initialize(
 334       base::Bind(&MCSProbe::ErrorCallback, base::Unretained(this)),
 335       base::Bind(&MessageReceivedCallback),
 336       base::Bind(&MessageSentCallback),
 337       load_result.Pass());
 338
 339   if (!android_id_ || !secret_) {
 340     DVLOG(1) << "Checkin to generate new MCS credentials.";
 341     CheckIn();
 342     return;
 343   }
 344
 345   StartMCSLogin();
 346 }
 347
 348 void MCSProbe::UpdateCallback(bool success) {
 349 }
 350
 351 void MCSProbe::InitializeNetworkState() {
 352   base::ScopedFILE log_file;
 353   if (command_line_.HasSwitch(kLogFileSwitch)) {
 354     base::FilePath log_path = command_line_.GetSwitchValuePath(kLogFileSwitch);
 355 #if defined(OS_WIN)
 356     log_file.reset(_wfopen(log_path.value().c_str(), L"w"));
 357 #elif defined(OS_POSIX)
 358     log_file.reset(fopen(log_path.value().c_str(), "w"));
 359 #endif
 360   }
 361   if (log_file.get()) {
 362     logger_.reset(new net::WriteToFileNetLogObserver());
 363     logger_->set_capture_mode(
 364         net::NetLogCaptureMode::IncludeCookiesAndCredentials());
 365     logger_->StartObserving(&net_log_, log_file.Pass(), nullptr, nullptr);
 366   }
 367
 368   host_resolver_ = net::HostResolver::CreateDefaultResolver(&net_log_);
 369
 370   if (command_line_.HasSwitch(kIgnoreCertSwitch)) {
 371     cert_verifier_.reset(new MyTestCertVerifier());
 372   } else {
 373     cert_verifier_.reset(net::CertVerifier::CreateDefault());
 374   }
 375   system_channel_id_service_.reset(
 376       new net::ChannelIDService(
 377           new net::DefaultChannelIDStore(NULL),
 378           base::WorkerPool::GetTaskRunner(true)));
 379
 380   transport_security_state_.reset(new net::TransportSecurityState());
 381   url_security_manager_.reset(net::URLSecurityManager::Create(NULL, NULL));
 382   http_auth_handler_factory_.reset(
 383       net::HttpAuthHandlerRegistryFactory::Create(
 384           std::vector<std::string>(1, "basic"),
 385           url_security_manager_.get(),
 386           host_resolver_.get(),
 387           std::string(),
 388           false,
 389           false));
 390   http_server_properties_.reset(new net::HttpServerPropertiesImpl());
 391   host_mapping_rules_.reset(new net::HostMappingRules());
 392   proxy_service_.reset(net::ProxyService::CreateDirectWithNetLog(&net_log_));
 393 }
 394
 395 void MCSProbe::BuildNetworkSession() {
 396   net::HttpNetworkSession::Params session_params;
 397   session_params.host_resolver = host_resolver_.get();
 398   session_params.cert_verifier = cert_verifier_.get();
 399   session_params.channel_id_service = system_channel_id_service_.get();
 400   session_params.transport_security_state = transport_security_state_.get();
 401   session_params.ssl_config_service = new net::SSLConfigServiceDefaults();
 402   session_params.http_auth_handler_factory = http_auth_handler_factory_.get();
 403   session_params.http_server_properties =
 404       http_server_properties_->GetWeakPtr();
 405   session_params.network_delegate = NULL;  // TODO(zea): implement?
 406   session_params.host_mapping_rules = host_mapping_rules_.get();
 407   session_params.ignore_certificate_errors = true;
 408   session_params.testing_fixed_http_port = 0;
 409   session_params.testing_fixed_https_port = 0;
 410   session_params.net_log = &net_log_;
 411   session_params.proxy_service = proxy_service_.get();
 412
 413   network_session_ = new net::HttpNetworkSession(session_params);
 414 }
 415
 416 void MCSProbe::ErrorCallback() {
 417   LOG(INFO) << "MCS error happened";
 418 }
 419
 420 void MCSProbe::CheckIn() {
 421   LOG(INFO) << "Check-in request initiated.";
 422   checkin_proto::ChromeBuildProto chrome_build_proto;
 423   chrome_build_proto.set_platform(
 424       checkin_proto::ChromeBuildProto::PLATFORM_LINUX);
 425   chrome_build_proto.set_channel(
 426       checkin_proto::ChromeBuildProto::CHANNEL_CANARY);
 427   chrome_build_proto.set_chrome_version(kChromeVersion);
 428
 429   CheckinRequest::RequestInfo request_info(0,
 430                                            0,
 431                                            std::map<std::string, std::string>(),
 432                                            std::string(),
 433                                            chrome_build_proto);
 434
 435   checkin_request_.reset(new CheckinRequest(
 436       GServicesSettings::DefaultCheckinURL(),
 437       request_info,
 438       kDefaultBackoffPolicy,
 439       base::Bind(&MCSProbe::OnCheckInCompleted, base::Unretained(this)),
 440       url_request_context_getter_.get(),
 441       &recorder_));
 442   checkin_request_->Start();
 443 }
 444
 445 void MCSProbe::OnCheckInCompleted(
 446     const checkin_proto::AndroidCheckinResponse& checkin_response) {
 447   bool success = checkin_response.has_android_id() &&
 448                  checkin_response.android_id() != 0UL &&
 449                  checkin_response.has_security_token() &&
 450                  checkin_response.security_token() != 0UL;
 451   LOG(INFO) << "Check-in request completion "
 452             << (success ? "success!" : "failure!");
 453
 454   if (!success)
 455     return;
 456
 457   android_id_ = checkin_response.android_id();
 458   secret_ = checkin_response.security_token();
 459
 460   gcm_store_->SetDeviceCredentials(android_id_,
 461                                    secret_,
 462                                    base::Bind(&MCSProbe::UpdateCallback,
 463                                               base::Unretained(this)));
 464
 465   StartMCSLogin();
 466 }
 467
 468 void MCSProbe::StartMCSLogin() {
 469   LOG(INFO) << "MCS login initiated.";
 470
 471   mcs_client_->Login(android_id_, secret_);
 472 }
 473
 474 int MCSProbeMain(int argc, char* argv[]) {
 475   base::AtExitManager exit_manager;
 476
 477   base::CommandLine::Init(argc, argv);
 478   logging::LoggingSettings settings;
 479   settings.logging_dest = logging::LOG_TO_SYSTEM_DEBUG_LOG;
 480   logging::InitLogging(settings);
 481
 482   base::MessageLoopForIO message_loop;
 483
 484   // For check-in and creating registration ids.
 485   const scoped_refptr<MyTestURLRequestContextGetter> context_getter =
 486       new MyTestURLRequestContextGetter(
 487           base::MessageLoop::current()->message_loop_proxy());
 488
 489   const base::CommandLine& command_line =
 490       *base::CommandLine::ForCurrentProcess();
 491
 492   MCSProbe mcs_probe(command_line, context_getter);
 493   mcs_probe.Start();
 494
 495   base::RunLoop run_loop;
 496   run_loop.Run();
 497
 498   return 0;
 499 }
 500
 501 }  // namespace
 502 }  // namespace gcm
 503
 504 int main(int argc, char* argv[]) {
 505   return gcm::MCSProbeMain(argc, argv);
 506 }