OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ | 5 #ifndef CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ |
6 #define CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ | 6 #define CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ |
7 | 7 |
| 8 #include <gnome-keyring.h> |
| 9 |
8 #include <string> | 10 #include <string> |
9 | 11 |
10 #include "base/basictypes.h" | 12 #include "base/basictypes.h" |
11 #include "base/time.h" | 13 #include "base/time.h" |
12 #include "chrome/browser/password_manager/password_store_factory.h" | 14 #include "chrome/browser/password_manager/password_store_factory.h" |
13 #include "chrome/browser/password_manager/password_store_x.h" | 15 #include "chrome/browser/password_manager/password_store_x.h" |
14 #include "chrome/browser/profiles/profile.h" | 16 #include "chrome/browser/profiles/profile.h" |
15 | 17 |
16 #include "library_loaders/libgnome-keyring.h" | |
17 | |
18 class PrefService; | 18 class PrefService; |
19 | 19 |
20 namespace content { | 20 namespace content { |
21 struct PasswordForm; | 21 struct PasswordForm; |
22 } | 22 } |
23 | 23 |
| 24 // Many of the gnome_keyring_* functions use variable arguments, which makes |
| 25 // them difficult if not impossible to truly wrap in C. Therefore, we use |
| 26 // appropriately-typed function pointers and scoping to make the fact that we |
| 27 // might be dynamically loading the library almost invisible. As a bonus, we |
| 28 // also get a simple way to mock the library for testing. Classes that inherit |
| 29 // from GnomeKeyringLoader will use its versions of the gnome_keyring_* |
| 30 // functions. Note that it has only static fields. |
| 31 class GnomeKeyringLoader { |
| 32 protected: |
| 33 static bool LoadGnomeKeyring(); |
| 34 |
| 35 // Call a given parameter with the name of each function we use from GNOME |
| 36 // Keyring. Make sure to adjust the unit test if you change these. |
| 37 #define GNOME_KEYRING_FOR_EACH_FUNC(F) \ |
| 38 F(is_available) \ |
| 39 F(store_password) \ |
| 40 F(delete_password) \ |
| 41 F(find_itemsv) \ |
| 42 F(result_to_message) |
| 43 |
| 44 // Declare the actual function pointers that we'll use in client code. |
| 45 #define GNOME_KEYRING_DECLARE_POINTER(name) \ |
| 46 static typeof(&::gnome_keyring_##name) gnome_keyring_##name; |
| 47 GNOME_KEYRING_FOR_EACH_FUNC(GNOME_KEYRING_DECLARE_POINTER) |
| 48 #undef GNOME_KEYRING_DECLARE_POINTER |
| 49 |
| 50 // Set to true if LoadGnomeKeyring() has already succeeded. |
| 51 static bool keyring_loaded; |
| 52 |
| 53 private: |
| 54 #if defined(DLOPEN_GNOME_KEYRING) |
| 55 struct FunctionInfo { |
| 56 const char* name; |
| 57 void** pointer; |
| 58 }; |
| 59 |
| 60 // Make it easy to initialize the function pointers in LoadGnomeKeyring(). |
| 61 static const FunctionInfo functions[]; |
| 62 #endif // defined(DLOPEN_GNOME_KEYRING) |
| 63 }; |
| 64 |
24 // NativeBackend implementation using GNOME Keyring. | 65 // NativeBackend implementation using GNOME Keyring. |
25 class NativeBackendGnome : public PasswordStoreX::NativeBackend { | 66 class NativeBackendGnome : public PasswordStoreX::NativeBackend, |
| 67 public GnomeKeyringLoader { |
26 public: | 68 public: |
27 NativeBackendGnome(LocalProfileId id, PrefService* prefs); | 69 NativeBackendGnome(LocalProfileId id, PrefService* prefs); |
28 | 70 |
29 virtual ~NativeBackendGnome(); | 71 virtual ~NativeBackendGnome(); |
30 | 72 |
31 virtual bool Init() OVERRIDE; | 73 virtual bool Init() OVERRIDE; |
32 | 74 |
33 // Implements NativeBackend interface. | 75 // Implements NativeBackend interface. |
34 virtual bool AddLogin(const content::PasswordForm& form) OVERRIDE; | 76 virtual bool AddLogin(const content::PasswordForm& form) OVERRIDE; |
35 virtual bool UpdateLogin(const content::PasswordForm& form) OVERRIDE; | 77 virtual bool UpdateLogin(const content::PasswordForm& form) OVERRIDE; |
36 virtual bool RemoveLogin(const content::PasswordForm& form) OVERRIDE; | 78 virtual bool RemoveLogin(const content::PasswordForm& form) OVERRIDE; |
37 virtual bool RemoveLoginsCreatedBetween( | 79 virtual bool RemoveLoginsCreatedBetween( |
38 const base::Time& delete_begin, const base::Time& delete_end) OVERRIDE; | 80 const base::Time& delete_begin, const base::Time& delete_end) OVERRIDE; |
39 virtual bool GetLogins(const content::PasswordForm& form, | 81 virtual bool GetLogins(const content::PasswordForm& form, |
40 PasswordFormList* forms) OVERRIDE; | 82 PasswordFormList* forms) OVERRIDE; |
41 virtual bool GetLoginsCreatedBetween(const base::Time& get_begin, | 83 virtual bool GetLoginsCreatedBetween(const base::Time& get_begin, |
42 const base::Time& get_end, | 84 const base::Time& get_end, |
43 PasswordFormList* forms) OVERRIDE; | 85 PasswordFormList* forms) OVERRIDE; |
44 virtual bool GetAutofillableLogins(PasswordFormList* forms) OVERRIDE; | 86 virtual bool GetAutofillableLogins(PasswordFormList* forms) OVERRIDE; |
45 virtual bool GetBlacklistLogins(PasswordFormList* forms) OVERRIDE; | 87 virtual bool GetBlacklistLogins(PasswordFormList* forms) OVERRIDE; |
46 | 88 |
47 #ifdef UNIT_TEST | |
48 LibGnomeKeyringLoader* libgnome_keyring_loader() { | |
49 return &libgnome_keyring_loader_; | |
50 } | |
51 #endif // UNIT_TEST | |
52 | |
53 private: | 89 private: |
54 // Adds a login form without checking for one to replace first. | 90 // Adds a login form without checking for one to replace first. |
55 bool RawAddLogin(const content::PasswordForm& form); | 91 bool RawAddLogin(const content::PasswordForm& form); |
56 | 92 |
57 // Reads PasswordForms from the keyring with the given autofillability state. | 93 // Reads PasswordForms from the keyring with the given autofillability state. |
58 bool GetLoginsList(PasswordFormList* forms, bool autofillable); | 94 bool GetLoginsList(PasswordFormList* forms, bool autofillable); |
59 | 95 |
60 // Helper for GetLoginsCreatedBetween(). | 96 // Helper for GetLoginsCreatedBetween(). |
61 bool GetAllLogins(PasswordFormList* forms); | 97 bool GetAllLogins(PasswordFormList* forms); |
62 | 98 |
63 // Generates a profile-specific app string based on profile_id_. | 99 // Generates a profile-specific app string based on profile_id_. |
64 std::string GetProfileSpecificAppString() const; | 100 std::string GetProfileSpecificAppString() const; |
65 | 101 |
66 // Migrates non-profile-specific logins to be profile-specific. | 102 // Migrates non-profile-specific logins to be profile-specific. |
67 void MigrateToProfileSpecificLogins(); | 103 void MigrateToProfileSpecificLogins(); |
68 | 104 |
69 // The local profile id, used to generate the app string. | 105 // The local profile id, used to generate the app string. |
70 const LocalProfileId profile_id_; | 106 const LocalProfileId profile_id_; |
71 | 107 |
72 // The pref service to use for persistent migration settings. | 108 // The pref service to use for persistent migration settings. |
73 PrefService* prefs_; | 109 PrefService* prefs_; |
74 | 110 |
75 // The app string, possibly based on the local profile id. | 111 // The app string, possibly based on the local profile id. |
76 std::string app_string_; | 112 std::string app_string_; |
77 | 113 |
78 // True once MigrateToProfileSpecificLogins() has been attempted. | 114 // True once MigrateToProfileSpecificLogins() has been attempted. |
79 bool migrate_tried_; | 115 bool migrate_tried_; |
80 | 116 |
81 LibGnomeKeyringLoader libgnome_keyring_loader_; | |
82 | |
83 DISALLOW_COPY_AND_ASSIGN(NativeBackendGnome); | 117 DISALLOW_COPY_AND_ASSIGN(NativeBackendGnome); |
84 }; | 118 }; |
85 | 119 |
86 #endif // CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ | 120 #endif // CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ |
OLD | NEW |