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