blob: a4440cc26228c534a851d9239412bb327c010dea [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include "chromeos/chromeos_export.h"
#include "chromeos/login/auth/key.h"
#include "components/signin/core/account_id/account_id.h"
#include "components/user_manager/user_type.h"
class AccountId;
namespace chromeos {
// Information that is passed around while authentication is in progress. The
// credentials may consist of a |account_id_|, |key_| pair or a GAIA
// |auth_code_|.
// The |user_id_hash_| is used to locate the user's home directory
// mount point for the user. It is set when the mount has been completed.
class CHROMEOS_EXPORT UserContext {
// The authentication flow used during sign-in.
enum AuthFlow {
// Online authentication against GAIA. GAIA did not redirect to a SAML IdP.
// Online authentication against GAIA. GAIA redirected to a SAML IdP.
// Offline authentication against a cached key.
// Offline authentication using and Easy unlock device (e.g. a phone).
// Easy bootstrap flow.
UserContext(const UserContext& other);
explicit UserContext(const AccountId& account_id);
UserContext(user_manager::UserType user_type, const std::string& user_id);
bool operator==(const UserContext& context) const;
bool operator!=(const UserContext& context) const;
const AccountId& GetAccountId() const;
const std::string& GetGaiaID() const;
const Key* GetKey() const;
Key* GetKey();
const std::string& GetAuthCode() const;
const std::string& GetRefreshToken() const;
const std::string& GetAccessToken() const;
const std::string& GetUserIDHash() const;
bool IsUsingOAuth() const;
AuthFlow GetAuthFlow() const;
user_manager::UserType GetUserType() const;
const std::string& GetPublicSessionLocale() const;
const std::string& GetPublicSessionInputMethod() const;
const std::string& GetDeviceId() const;
const std::string& GetGAPSCookie() const;
bool HasCredentials() const;
void SetUserID(const std::string& user_id);
void SetGaiaID(const std::string& gaia_id);
void SetKey(const Key& key);
void SetAuthCode(const std::string& auth_code);
void SetRefreshToken(const std::string& refresh_token);
void SetAccessToken(const std::string& access_token);
void SetUserIDHash(const std::string& user_id_hash);
void SetIsUsingOAuth(bool is_using_oauth);
void SetAuthFlow(AuthFlow auth_flow);
void SetUserType(user_manager::UserType user_type);
void SetPublicSessionLocale(const std::string& locale);
void SetPublicSessionInputMethod(const std::string& input_method);
void SetDeviceId(const std::string& device_id);
void SetGAPSCookie(const std::string& gaps_cookie);
void ClearSecrets();
AccountId account_id_;
std::string gaia_id_;
Key key_;
std::string auth_code_;
std::string refresh_token_;
std::string access_token_; // OAuthLogin scoped access token.
std::string user_id_hash_;
bool is_using_oauth_ = true;
AuthFlow auth_flow_ = AUTH_FLOW_OFFLINE;
user_manager::UserType user_type_ = user_manager::USER_TYPE_REGULAR;
std::string public_session_locale_;
std::string public_session_input_method_;
std::string device_id_;
std::string gaps_cookie_;
} // namespace chromeos