chromeos/login/auth/online_attempt.h

   1 // Copyright 2014 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 #ifndef CHROMEOS_LOGIN_AUTH_ONLINE_ATTEMPT_H_
   6 #define CHROMEOS_LOGIN_AUTH_ONLINE_ATTEMPT_H_
   7
   8 #include <string>
   9
  10 #include "base/compiler_specific.h"
  11 #include "base/gtest_prod_util.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/single_thread_task_runner.h"
  16 #include "chromeos/chromeos_export.h"
  17 #include "chromeos/login/auth/auth_status_consumer.h"
  18 #include "google_apis/gaia/gaia_auth_consumer.h"
  19 #include "google_apis/gaia/google_service_auth_error.h"
  20
  21 class GaiaAuthFetcher;
  22
  23 namespace net {
  24 class URLRequestContextGetter;
  25 }
  26
  27 namespace chromeos {
  28 class AuthAttemptState;
  29 class AuthAttemptStateResolver;
  30
  31 class CHROMEOS_EXPORT OnlineAttempt : public GaiaAuthConsumer {
  32  public:
  33   OnlineAttempt(AuthAttemptState* current_attempt,
  34                 AuthAttemptStateResolver* callback);
  35   ~OnlineAttempt() override;
  36
  37   // Initiate the online login attempt either through client or auth login.
  38   // Status will be recorded in |current_attempt|, and resolver_->Resolve() will
  39   // be called on the IO thread when useful state is available.
  40   // Must be called on the UI thread.
  41   void Initiate(net::URLRequestContextGetter* request_context);
  42
  43   // GaiaAuthConsumer overrides. Callbacks from GaiaAuthFetcher
  44   void OnClientLoginFailure(const GoogleServiceAuthError& error) override;
  45   void OnClientLoginSuccess(
  46       const GaiaAuthConsumer::ClientLoginResult& credentials) override;
  47
  48  private:
  49   FRIEND_TEST_ALL_PREFIXES(OnlineAttemptTest, LoginSuccess);
  50   FRIEND_TEST_ALL_PREFIXES(OnlineAttemptTest, TwoFactorSuccess);
  51
  52   // Milliseconds until we timeout our attempt to hit ClientLogin.
  53   static const int kClientLoginTimeoutMs;
  54
  55   void TryClientLogin();
  56   void CancelClientLogin();
  57
  58   void TriggerResolve(const AuthFailure& outcome);
  59
  60   bool HasPendingFetch();
  61   void CancelRequest();
  62
  63   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
  64
  65   AuthAttemptState* const attempt_;
  66   AuthAttemptStateResolver* const resolver_;
  67
  68   // Handles ClientLogin communications with Gaia.
  69   scoped_ptr<GaiaAuthFetcher> client_fetcher_;
  70
  71   // Whether we're willing to re-try the ClientLogin attempt.
  72   bool try_again_;
  73
  74   // Used to cancel the CancelClientLogin closure.
  75   base::WeakPtrFactory<OnlineAttempt> weak_factory_;
  76
  77   friend class OnlineAttemptTest;
  78   DISALLOW_COPY_AND_ASSIGN(OnlineAttempt);
  79 };
  80
  81 }  // namespace chromeos
  82
  83 #endif  // CHROMEOS_LOGIN_AUTH_ONLINE_ATTEMPT_H_