Indicate which authentication flow was used in UserContext

chrome/browser/chromeos/login/user.h

 // Copyright (c) 2012 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.
 
 #ifndef CHROME_BROWSER_CHROMEOS_LOGIN_USER_H_
 #define CHROME_BROWSER_CHROMEOS_LOGIN_USER_H_
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/strings/string16.h"
 #include "chrome/browser/chromeos/login/user_image.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "ui/gfx/image/image_skia.h"
 
 namespace chromeos {
 
 extern const int kDefaultImagesCount;
 
 // User context data that is being exchanged between part of ChromeOS
 // authentication mechanism. Includes credentials:
 // |username|, |password|, |auth_code| and |username_hash| which is returned
 // back once user homedir is mounted. |username_hash| is used to identify
 // user homedir mount point.
 struct UserContext {
+  // The authentication flow used during sign-in.
+  enum AuthFlow {
+    // Online authentication against GAIA. GAIA did not redirect to a SAML IdP.
+    AUTH_FLOW_GAIA_WITHOUT_SAML,
+    // Online authentication against GAIA. GAIA redirected to a SAML IdP.
+    AUTH_FLOW_GAIA_WITH_SAML,
+    // Offline authentication against a cached password.
+    AUTH_FLOW_OFFLINE
+  };
+
   UserContext();
   UserContext(const std::string& username,
               const std::string& password,
               const std::string& auth_code);
   UserContext(const std::string& username,
               const std::string& password,
               const std::string& auth_code,
               const std::string& username_hash);
   UserContext(const std::string& username,
               const std::string& password,
               const std::string& auth_code,
               const std::string& username_hash,
-              bool using_oauth);
+              bool using_oauth,
+              AuthFlow auth_flow);
   virtual ~UserContext();
   bool operator==(const UserContext& context) const;
   std::string username;
   std::string password;
   std::string auth_code;
   std::string username_hash;
   bool using_oauth;
+  AuthFlow auth_flow;
 };
 
 // A class representing information about a previously logged in user.
 // Each user has a canonical email (username), returned by |email()| and
 // may have a different displayed email (in the raw form as entered by user),
 // returned by |displayed_email()|.
 // Displayed emails are for use in UI only, anywhere else users must be referred
 // to by |email()|.
 class User {
  public:
@@ skipping 86 matching lines @@
   // Returns the URL of user image, if there is any. Currently only the profile
   // image has a URL, for other images empty URL is returned.
   GURL image_url() const { return user_image_.url(); }
 
   // True if user image is a stub (while real image is being loaded from file).
   bool image_is_stub() const { return image_is_stub_; }
 
   // True if image is being loaded from file.
   bool image_is_loading() const { return image_is_loading_; }
 
-  // OAuth token status for this user.
-  OAuthTokenStatus oauth_token_status() const { return oauth_token_status_; }
-
   // The displayed user name.
   base::string16 display_name() const { return display_name_; }
 
   // The displayed (non-canonical) user email.
   virtual std::string display_email() const;
 
+  // OAuth token status for this user.
+  OAuthTokenStatus oauth_token_status() const { return oauth_token_status_; }
+
   // True if the user's session can be locked (i.e. the user has a password with
   // which to unlock the session).
   virtual bool can_lock() const;
 
   virtual std::string username_hash() const;
 
   // True if current user is logged in.
   virtual bool is_logged_in() const;
 
   // True if current user is active within the current session.
@@ skipping 32 matching lines @@
 
   void SetImage(const UserImage& user_image, int image_index);
 
   void SetImageURL(const GURL& image_url);
 
   // Sets a stub image until the next |SetImage| call. |image_index| may be
   // one of |kExternalImageIndex| or |kProfileImageIndex|.
   // If |is_loading| is |true|, that means user image is being loaded from file.
   void SetStubImage(int image_index, bool is_loading);
 
-  void set_oauth_token_status(OAuthTokenStatus status) {
-    oauth_token_status_ = status;
-  }
-
   void set_display_name(const base::string16& display_name) {
     display_name_ = display_name;
   }
 
   void set_given_name(const base::string16& given_name) { given_name_ = given_name; }
 
   void set_display_email(const std::string& display_email) {
     display_email_ = display_email;
   }
 
   const UserImage& user_image() const { return user_image_; }
 
+  void set_oauth_token_status(OAuthTokenStatus status) {
+    oauth_token_status_ = status;
+  }
+
   void set_username_hash(const std::string& username_hash) {
     username_hash_ = username_hash;
   }
 
   void set_is_logged_in(bool is_logged_in) {
     is_logged_in_ = is_logged_in;
   }
 
   void set_is_active(bool is_active) {
     is_active_ = is_active;
@@ skipping 45 matching lines @@
 
   DISALLOW_COPY_AND_ASSIGN(User);
 };
 
 // List of known users.
 typedef std::vector<User*> UserList;
 
 }  // namespace chromeos
 
 #endif  // CHROME_BROWSER_CHROMEOS_LOGIN_USER_H_