src/components/password_manager/core/browser/password_manager.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 COMPONENTS_PASSWORD_MANAGER_CORE_BROWSER_PASSWORD_MANAGER_H_
   6 #define COMPONENTS_PASSWORD_MANAGER_CORE_BROWSER_PASSWORD_MANAGER_H_
   7
   8 #include <vector>
   9
  10 #include "base/callback.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/memory/scoped_vector.h"
  13 #include "base/observer_list.h"
  14 #include "base/prefs/pref_member.h"
  15 #include "base/stl_util.h"
  16 #include "components/autofill/core/common/password_form.h"
  17 #include "components/autofill/core/common/password_form_fill_data.h"
  18 #include "components/password_manager/core/browser/login_model.h"
  19 #include "components/password_manager/core/browser/password_form_manager.h"
  20
  21 class PrefRegistrySimple;
  22
  23 namespace content {
  24 class WebContents;
  25 }
  26
  27 namespace user_prefs {
  28 class PrefRegistrySyncable;
  29 }
  30
  31 namespace password_manager {
  32
  33 class BrowserSavePasswordProgressLogger;
  34 class PasswordManagerClient;
  35 class PasswordManagerDriver;
  36 class PasswordManagerTest;
  37 class PasswordFormManager;
  38
  39 // Per-tab password manager. Handles creation and management of UI elements,
  40 // receiving password form data from the renderer and managing the password
  41 // database through the PasswordStore. The PasswordManager is a LoginModel
  42 // for purposes of supporting HTTP authentication dialogs.
  43 class PasswordManager : public LoginModel {
  44  public:
  45   static const char kOtherPossibleUsernamesExperiment[];
  46
  47   static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
  48 #if defined(OS_WIN)
  49   static void RegisterLocalPrefs(PrefRegistrySimple* registry);
  50 #endif
  51   explicit PasswordManager(PasswordManagerClient* client);
  52   virtual ~PasswordManager();
  53
  54   typedef base::Callback<void(const autofill::PasswordForm&)>
  55       PasswordSubmittedCallback;
  56
  57   // There is no corresponding remove function as currently all of the
  58   // owners of these callbacks have sufficient lifetimes so that the callbacks
  59   // should always be valid when called.
  60   void AddSubmissionCallback(const PasswordSubmittedCallback& callback);
  61
  62   // Is saving new data for password autofill enabled for the current profile?
  63   // For example, saving new data is disabled in Incognito mode, whereas filling
  64   // data is not.
  65   bool IsSavingEnabled() const;
  66
  67   // Called by a PasswordFormManager when it decides a form can be autofilled
  68   // on the page.
  69   virtual void Autofill(const autofill::PasswordForm& form_for_autofill,
  70                         const autofill::PasswordFormMap& best_matches,
  71                         const autofill::PasswordForm& preferred_match,
  72                         bool wait_for_username) const;
  73
  74   // LoginModel implementation.
  75   virtual void AddObserver(LoginModelObserver* observer) OVERRIDE;
  76   virtual void RemoveObserver(LoginModelObserver* observer) OVERRIDE;
  77
  78   // Mark this form as having a generated password.
  79   void SetFormHasGeneratedPassword(const autofill::PasswordForm& form);
  80
  81   // TODO(isherman): This should not be public, but is currently being used by
  82   // the LoginPrompt code.
  83   // When a form is submitted, we prepare to save the password but wait
  84   // until we decide the user has successfully logged in. This is step 1
  85   // of 2 (see SavePassword).
  86   void ProvisionallySavePassword(const autofill::PasswordForm& form);
  87
  88   // Should be called when the user navigates the main frame.
  89   void DidNavigateMainFrame(bool is_in_page);
  90
  91   // Handles password forms being parsed.
  92   void OnPasswordFormsParsed(
  93       const std::vector<autofill::PasswordForm>& forms);
  94
  95   // Handles password forms being rendered.
  96   void OnPasswordFormsRendered(
  97       const std::vector<autofill::PasswordForm>& visible_forms);
  98
  99   // Handles a password form being submitted.
 100   virtual void OnPasswordFormSubmitted(
 101       const autofill::PasswordForm& password_form);
 102
 103   PasswordManagerClient* client() { return client_; }
 104
 105  private:
 106   enum ProvisionalSaveFailure {
 107     SAVING_DISABLED,
 108     EMPTY_PASSWORD,
 109     NO_MATCHING_FORM,
 110     MATCHING_NOT_COMPLETE,
 111     FORM_BLACKLISTED,
 112     INVALID_FORM,
 113     AUTOCOMPLETE_OFF,
 114     MAX_FAILURE_VALUE
 115   };
 116
 117   // Log failure for UMA. Logs additional metrics if the |form_origin|
 118   // corresponds to one of the top, explicitly monitored websites. For some
 119   // values of |failure| also sends logs to the internals page through |logger|,
 120   // it |logger| is not NULL.
 121   void RecordFailure(ProvisionalSaveFailure failure,
 122                      const std::string& form_origin,
 123                      BrowserSavePasswordProgressLogger* logger);
 124
 125   // Possibly set up FieldTrial for testing other possible usernames. This only
 126   // happens if there are other_possible_usernames to be shown and the
 127   // experiment hasn't already been initialized. We setup the experiment at
 128   // such a late time because this experiment will only affect a small number
 129   // of users so we want to include a larger fraction of these users than the
 130   // normal 10%.
 131   void PossiblyInitializeUsernamesExperiment(
 132       const autofill::PasswordFormMap& matches) const;
 133
 134   // Returns true if we can show possible usernames to users in cases where
 135   // the username for the form is ambigious.
 136   bool OtherPossibleUsernamesEnabled() const;
 137
 138   // Returns true if the user needs to be prompted before a password can be
 139   // saved (instead of automatically saving
 140   // the password), based on inspecting the state of
 141   // |provisional_save_manager_|.
 142   bool ShouldPromptUserToSavePassword() const;
 143
 144   // Note about how a PasswordFormManager can transition from
 145   // pending_login_managers_ to provisional_save_manager_ and the infobar.
 146   //
 147   // 1. form "seen"
 148   //       |                                             new
 149   //       |                                               ___ Infobar
 150   // pending_login -- form submit --> provisional_save ___/
 151   //             ^                            |           \___ (update DB)
 152   //             |                           fail
 153   //             |-----------<------<---------|          !new
 154   //
 155   // When a form is "seen" on a page, a PasswordFormManager is created
 156   // and stored in this collection until user navigates away from page.
 157
 158   ScopedVector<PasswordFormManager> pending_login_managers_;
 159
 160   // When the user submits a password/credential, this contains the
 161   // PasswordFormManager for the form in question until we deem the login
 162   // attempt to have succeeded (as in valid credentials). If it fails, we
 163   // send the PasswordFormManager back to the pending_login_managers_ set.
 164   // Scoped in case PasswordManager gets deleted (e.g tab closes) between the
 165   // time a user submits a login form and gets to the next page.
 166   scoped_ptr<PasswordFormManager> provisional_save_manager_;
 167
 168   // The embedder-level client. Must outlive this class.
 169   PasswordManagerClient* const client_;
 170
 171   // The platform-level driver. Must outlive this class.
 172   PasswordManagerDriver* const driver_;
 173
 174   // Set to false to disable the password manager (will no longer ask if you
 175   // want to save passwords but will continue to fill passwords).
 176   BooleanPrefMember password_manager_enabled_;
 177
 178   // Observers to be notified of LoginModel events.  This is mutable to allow
 179   // notification in const member functions.
 180   mutable ObserverList<LoginModelObserver> observers_;
 181
 182   // Callbacks to be notified when a password form has been submitted.
 183   std::vector<PasswordSubmittedCallback> submission_callbacks_;
 184
 185   DISALLOW_COPY_AND_ASSIGN(PasswordManager);
 186 };
 187
 188 }  // namespace password_manager
 189
 190 #endif  // COMPONENTS_PASSWORD_MANAGER_CORE_BROWSER_PASSWORD_MANAGER_H_