src/chrome/browser/chromeos/login/parallel_authenticator.h

   1 // Copyright (c) 2012 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 CHROME_BROWSER_CHROMEOS_LOGIN_PARALLEL_AUTHENTICATOR_H_
   6 #define CHROME_BROWSER_CHROMEOS_LOGIN_PARALLEL_AUTHENTICATOR_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/compiler_specific.h"
  12 #include "base/gtest_prod_util.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/synchronization/lock.h"
  15 #include "chrome/browser/chromeos/login/auth_attempt_state.h"
  16 #include "chrome/browser/chromeos/login/auth_attempt_state_resolver.h"
  17 #include "chrome/browser/chromeos/login/authenticator.h"
  18 #include "chrome/browser/chromeos/login/test_attempt_state.h"
  19 #include "chrome/browser/chromeos/settings/device_settings_service.h"
  20 #include "google_apis/gaia/gaia_auth_consumer.h"
  21
  22 class LoginFailure;
  23 class Profile;
  24
  25 namespace chromeos {
  26
  27 class LoginStatusConsumer;
  28
  29 // Authenticates a Chromium OS user against cryptohome.
  30 // Relies on the fact that online authentications has been already performed
  31 // (i.e. using_oauth_ is true).
  32 //
  33 // At a high, level, here's what happens:
  34 // AuthenticateToLogin() calls a Cryptohome's method to perform offline login.
  35 // Resultes are stored in a AuthAttemptState owned by ParallelAuthenticator
  36 // and then call Resolve().  Resolve() will attempt to
  37 // determine which AuthState we're in, based on the info at hand.
  38 // It then triggers further action based on the calculated AuthState; this
  39 // further action might include calling back the passed-in LoginStatusConsumer
  40 // to signal that login succeeded or failed, waiting for more outstanding
  41 // operations to complete, or triggering some more Cryptohome method calls.
  42 //
  43 // Typical flows
  44 // -------------
  45 // Add new user: CONTINUE > CONTINUE > CREATE_NEW > CONTINUE > ONLINE_LOGIN
  46 // Login as existing user: CONTINUE > OFFLINE_LOGIN
  47 // Login as existing user (failure): CONTINUE > FAILED_MOUNT
  48 // Change password detected:
  49 //   GAIA online ok: CONTINUE > CONTINUE > NEED_OLD_PW
  50 //     Recreate: CREATE_NEW > CONTINUE > ONLINE_LOGIN
  51 //     Old password failure: NEED_OLD_PW
  52 //     Old password ok: RECOVER_MOUNT > CONTINUE > ONLINE_LOGIN
  53 //
  54 // TODO(nkostylev): Rename ParallelAuthenticator since it is not doing
  55 // offline/online login operations in parallel anymore.
  56 class ParallelAuthenticator : public Authenticator,
  57                               public AuthAttemptStateResolver {
  58  public:
  59   enum AuthState {
  60     CONTINUE = 0,            // State indeterminate; try again with more info.
  61     NO_MOUNT = 1,            // Cryptohome doesn't exist yet.
  62     FAILED_MOUNT = 2,        // Failed to mount existing cryptohome.
  63     FAILED_REMOVE = 3,       // Failed to remove existing cryptohome.
  64     FAILED_TMPFS = 4,        // Failed to mount tmpfs for guest user.
  65     FAILED_TPM = 5,          // Failed to mount/create cryptohome, TPM error.
  66     CREATE_NEW = 6,          // Need to create cryptohome for a new user.
  67     RECOVER_MOUNT = 7,       // After RecoverEncryptedData, mount cryptohome.
  68     POSSIBLE_PW_CHANGE = 8,  // Offline login failed, user may have changed pw.
  69     NEED_NEW_PW = 9,         // Obsolete (ClientLogin): user changed pw,
  70                              // we have the old one.
  71     NEED_OLD_PW = 10,        // User changed pw, and we have the new one
  72                              // (GAIA auth is OK).
  73     HAVE_NEW_PW = 11,        // Obsolete (ClientLogin): We have verified new pw,
  74                              // time to migrate key.
  75     OFFLINE_LOGIN = 12,      // Login succeeded offline.
  76     DEMO_LOGIN = 13,         // Logged in as the demo user.
  77     ONLINE_LOGIN = 14,       // Offline and online login succeeded.
  78     UNLOCK = 15,             // Screen unlock succeeded.
  79     ONLINE_FAILED = 16,      // Obsolete (ClientLogin): Online login disallowed,
  80                              // but offline succeeded.
  81     GUEST_LOGIN = 17,        // Logged in guest mode.
  82     PUBLIC_ACCOUNT_LOGIN = 18,        // Logged into a public account.
  83     LOCALLY_MANAGED_USER_LOGIN = 19,  // Logged in as a locally managed user.
  84     LOGIN_FAILED = 20,       // Login denied.
  85     OWNER_REQUIRED = 21,     // Login is restricted to the owner only.
  86     FAILED_USERNAME_HASH = 22,        // Failed GetSanitizedUsername request.
  87     KIOSK_ACCOUNT_LOGIN = 23,         // Logged into a kiosk account.
  88     REMOVED_DATA_AFTER_FAILURE = 24,  // Successfully removed the user's
  89                                       // cryptohome after a login failure.
  90   };
  91
  92   explicit ParallelAuthenticator(LoginStatusConsumer* consumer);
  93
  94   // Authenticator overrides.
  95   virtual void CompleteLogin(Profile* profile,
  96                              const UserContext& user_context) OVERRIDE;
  97
  98   // Given |user_context|, this method attempts to authenticate to your
  99   // Chrome OS device. As soon as we have successfully mounted the encrypted
 100   // home directory for the user, we will call consumer_->OnLoginSuccess()
 101   // with the username.
 102   // Upon failure to login consumer_->OnLoginFailure() is called
 103   // with an error message.
 104   //
 105   // Uses |profile| when doing URL fetches.
 106   virtual void AuthenticateToLogin(Profile* profile,
 107                                    const UserContext& user_context) OVERRIDE;
 108
 109   // Given |user_context|, this method attempts to authenticate to the cached
 110   // user_context. This will never contact the server even if it's online.
 111   // The auth result is sent to LoginStatusConsumer in a same way as
 112   // AuthenticateToLogin does.
 113   virtual void AuthenticateToUnlock(const UserContext& user_context) OVERRIDE;
 114
 115   // Initiates locally managed user login.
 116   // Creates cryptohome if missing or mounts existing one and
 117   // notifies consumer on the success/failure.
 118   virtual void LoginAsLocallyManagedUser(
 119       const UserContext& user_context) OVERRIDE;
 120
 121   // Initiates retail mode login.
 122   // Mounts tmpfs and notifies consumer on the success/failure.
 123   virtual void LoginRetailMode() OVERRIDE;
 124
 125   // Initiates incognito ("browse without signing in") login.
 126   // Mounts tmpfs and notifies consumer on the success/failure.
 127   virtual void LoginOffTheRecord() OVERRIDE;
 128
 129   // Initiates login into the public account identified by |username|.
 130   // Mounts an ephemeral cryptohome and notifies consumer on the
 131   // success/failure.
 132   virtual void LoginAsPublicAccount(const std::string& username) OVERRIDE;
 133
 134   // Initiates login into the kiosk mode account identified by |app_user_id|.
 135   // Mounts an public but non-ephemeral cryptohome and notifies consumer on the
 136   // success/failure.
 137   virtual void LoginAsKioskAccount(const std::string& app_user_id) OVERRIDE;
 138
 139   // These methods must be called on the UI thread, as they make DBus calls
 140   // and also call back to the login UI.
 141   virtual void OnRetailModeLoginSuccess() OVERRIDE;
 142   virtual void OnLoginSuccess() OVERRIDE;
 143   virtual void OnLoginFailure(const LoginFailure& error) OVERRIDE;
 144   virtual void RecoverEncryptedData(
 145       const std::string& old_password) OVERRIDE;
 146   virtual void ResyncEncryptedData() OVERRIDE;
 147
 148   // AuthAttemptStateResolver overrides.
 149   // Attempts to make a decision and call back |consumer_| based on
 150   // the state we have gathered at the time of call.  If a decision
 151   // can't be made, defers until the next time this is called.
 152   // When a decision is made, will call back to |consumer_| on the UI thread.
 153   //
 154   // Must be called on the UI thread.
 155   virtual void Resolve() OVERRIDE;
 156
 157   // Returns hash of |password|, salted with the system salt.
 158   static std::string HashPassword(const std::string& password,
 159                                   const std::string& ascii_salt);
 160
 161   void OnOffTheRecordLoginSuccess();
 162   void OnPasswordChangeDetected();
 163
 164  protected:
 165   virtual ~ParallelAuthenticator();
 166
 167  private:
 168   friend class ParallelAuthenticatorTest;
 169   FRIEND_TEST_ALL_PREFIXES(ParallelAuthenticatorTest,
 170                            ResolveOwnerNeededDirectFailedMount);
 171   FRIEND_TEST_ALL_PREFIXES(ParallelAuthenticatorTest, ResolveOwnerNeededMount);
 172   FRIEND_TEST_ALL_PREFIXES(ParallelAuthenticatorTest,
 173                            ResolveOwnerNeededFailedMount);
 174
 175   // Removes the cryptohome of the user.
 176   void RemoveEncryptedData();
 177
 178   // Returns the AuthState we're in, given the status info we have at
 179   // the time of call.
 180   // Must be called on the IO thread.
 181   AuthState ResolveState();
 182
 183   // Helper for ResolveState().
 184   // Given that some cryptohome operation has failed, determine which of the
 185   // possible failure states we're in.
 186   // Must be called on the IO thread.
 187   AuthState ResolveCryptohomeFailureState();
 188
 189   // Helper for ResolveState().
 190   // Given that some cryptohome operation has succeeded, determine which of
 191   // the possible states we're in.
 192   // Must be called on the IO thread.
 193   AuthState ResolveCryptohomeSuccessState();
 194
 195   // Helper for ResolveState().
 196   // Given that some online auth operation has succeeded, determine which of
 197   // the possible success states we're in.
 198   // Must be called on the IO thread.
 199   AuthState ResolveOnlineSuccessState(AuthState offline_state);
 200
 201   // Used for testing.
 202   void set_attempt_state(TestAttemptState* new_state) {  // takes ownership.
 203     current_state_.reset(new_state);
 204   }
 205
 206   // Used for testing to set the expected state of an owner check.
 207   void SetOwnerState(bool owner_check_finished, bool check_result);
 208
 209   // checks if the current mounted home contains the owner case and either
 210   // continues or fails the log-in. Used for policy lost mitigation "safe-mode".
 211   // Returns true if the owner check has been successful or if it is not needed.
 212   bool VerifyOwner();
 213
 214   // Handles completion of the ownership check and continues login.
 215   void OnOwnershipChecked(bool is_owner);
 216
 217   // Signal login completion status for cases when a new user is added via
 218   // an external authentication provider (i.e. GAIA extension).
 219   void ResolveLoginCompletionStatus();
 220
 221   scoped_ptr<AuthAttemptState> current_state_;
 222   bool migrate_attempted_;
 223   bool remove_attempted_;
 224   bool resync_attempted_;
 225   bool ephemeral_mount_attempted_;
 226   bool check_key_attempted_;
 227
 228   // When the user has changed her password, but gives us the old one, we will
 229   // be able to mount her cryptohome, but online authentication will fail.
 230   // This allows us to present the same behavior to the caller, regardless
 231   // of the order in which we receive these results.
 232   bool already_reported_success_;
 233   base::Lock success_lock_;  // A lock around |already_reported_success_|.
 234
 235   // Flags signaling whether the owner verification has been done and the result
 236   // of it.
 237   bool owner_is_verified_;
 238   bool user_can_login_;
 239
 240   // Flag indicating to delete the user's cryptohome the login fails.
 241   bool remove_user_data_on_failure_;
 242
 243   // When |remove_user_data_on_failure_| is set, we delay calling
 244   // consumer_->OnLoginFailure() until we removed the user cryptohome.
 245   const LoginFailure* delayed_login_failure_;
 246
 247   DISALLOW_COPY_AND_ASSIGN(ParallelAuthenticator);
 248 };
 249
 250 }  // namespace chromeos
 251
 252 #endif  // CHROME_BROWSER_CHROMEOS_LOGIN_PARALLEL_AUTHENTICATOR_H_