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 | |
10 #include <string> | 8 #include <string> |
11 | 9 |
12 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
13 #include "base/time.h" | 11 #include "base/time.h" |
14 #include "chrome/browser/password_manager/password_store_factory.h" | 12 #include "chrome/browser/password_manager/password_store_factory.h" |
15 #include "chrome/browser/password_manager/password_store_x.h" | 13 #include "chrome/browser/password_manager/password_store_x.h" |
16 #include "chrome/browser/profiles/profile.h" | 14 #include "chrome/browser/profiles/profile.h" |
17 | 15 |
| 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 | |
65 // NativeBackend implementation using GNOME Keyring. | 24 // NativeBackend implementation using GNOME Keyring. |
66 class NativeBackendGnome : public PasswordStoreX::NativeBackend, | 25 class NativeBackendGnome : public PasswordStoreX::NativeBackend { |
67 public GnomeKeyringLoader { | |
68 public: | 26 public: |
69 NativeBackendGnome(LocalProfileId id, PrefService* prefs); | 27 NativeBackendGnome(LocalProfileId id, PrefService* prefs); |
70 | 28 |
71 virtual ~NativeBackendGnome(); | 29 virtual ~NativeBackendGnome(); |
72 | 30 |
73 virtual bool Init() OVERRIDE; | 31 virtual bool Init() OVERRIDE; |
74 | 32 |
75 // Implements NativeBackend interface. | 33 // Implements NativeBackend interface. |
76 virtual bool AddLogin(const content::PasswordForm& form) OVERRIDE; | 34 virtual bool AddLogin(const content::PasswordForm& form) OVERRIDE; |
77 virtual bool UpdateLogin(const content::PasswordForm& form) OVERRIDE; | 35 virtual bool UpdateLogin(const content::PasswordForm& form) OVERRIDE; |
78 virtual bool RemoveLogin(const content::PasswordForm& form) OVERRIDE; | 36 virtual bool RemoveLogin(const content::PasswordForm& form) OVERRIDE; |
79 virtual bool RemoveLoginsCreatedBetween( | 37 virtual bool RemoveLoginsCreatedBetween( |
80 const base::Time& delete_begin, const base::Time& delete_end) OVERRIDE; | 38 const base::Time& delete_begin, const base::Time& delete_end) OVERRIDE; |
81 virtual bool GetLogins(const content::PasswordForm& form, | 39 virtual bool GetLogins(const content::PasswordForm& form, |
82 PasswordFormList* forms) OVERRIDE; | 40 PasswordFormList* forms) OVERRIDE; |
83 virtual bool GetLoginsCreatedBetween(const base::Time& get_begin, | 41 virtual bool GetLoginsCreatedBetween(const base::Time& get_begin, |
84 const base::Time& get_end, | 42 const base::Time& get_end, |
85 PasswordFormList* forms) OVERRIDE; | 43 PasswordFormList* forms) OVERRIDE; |
86 virtual bool GetAutofillableLogins(PasswordFormList* forms) OVERRIDE; | 44 virtual bool GetAutofillableLogins(PasswordFormList* forms) OVERRIDE; |
87 virtual bool GetBlacklistLogins(PasswordFormList* forms) OVERRIDE; | 45 virtual bool GetBlacklistLogins(PasswordFormList* forms) OVERRIDE; |
88 | 46 |
| 47 #ifdef UNIT_TEST |
| 48 LibGnomeKeyringLoader* libgnome_keyring_loader() { |
| 49 return &libgnome_keyring_loader_; |
| 50 } |
| 51 #endif // UNIT_TEST |
| 52 |
89 private: | 53 private: |
90 // Adds a login form without checking for one to replace first. | 54 // Adds a login form without checking for one to replace first. |
91 bool RawAddLogin(const content::PasswordForm& form); | 55 bool RawAddLogin(const content::PasswordForm& form); |
92 | 56 |
93 // Reads PasswordForms from the keyring with the given autofillability state. | 57 // Reads PasswordForms from the keyring with the given autofillability state. |
94 bool GetLoginsList(PasswordFormList* forms, bool autofillable); | 58 bool GetLoginsList(PasswordFormList* forms, bool autofillable); |
95 | 59 |
96 // Helper for GetLoginsCreatedBetween(). | 60 // Helper for GetLoginsCreatedBetween(). |
97 bool GetAllLogins(PasswordFormList* forms); | 61 bool GetAllLogins(PasswordFormList* forms); |
98 | 62 |
99 // Generates a profile-specific app string based on profile_id_. | 63 // Generates a profile-specific app string based on profile_id_. |
100 std::string GetProfileSpecificAppString() const; | 64 std::string GetProfileSpecificAppString() const; |
101 | 65 |
102 // Migrates non-profile-specific logins to be profile-specific. | 66 // Migrates non-profile-specific logins to be profile-specific. |
103 void MigrateToProfileSpecificLogins(); | 67 void MigrateToProfileSpecificLogins(); |
104 | 68 |
105 // The local profile id, used to generate the app string. | 69 // The local profile id, used to generate the app string. |
106 const LocalProfileId profile_id_; | 70 const LocalProfileId profile_id_; |
107 | 71 |
108 // The pref service to use for persistent migration settings. | 72 // The pref service to use for persistent migration settings. |
109 PrefService* prefs_; | 73 PrefService* prefs_; |
110 | 74 |
111 // The app string, possibly based on the local profile id. | 75 // The app string, possibly based on the local profile id. |
112 std::string app_string_; | 76 std::string app_string_; |
113 | 77 |
114 // True once MigrateToProfileSpecificLogins() has been attempted. | 78 // True once MigrateToProfileSpecificLogins() has been attempted. |
115 bool migrate_tried_; | 79 bool migrate_tried_; |
116 | 80 |
| 81 LibGnomeKeyringLoader libgnome_keyring_loader_; |
| 82 |
117 DISALLOW_COPY_AND_ASSIGN(NativeBackendGnome); | 83 DISALLOW_COPY_AND_ASSIGN(NativeBackendGnome); |
118 }; | 84 }; |
119 | 85 |
120 #endif // CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ | 86 #endif // CHROME_BROWSER_PASSWORD_MANAGER_NATIVE_BACKEND_GNOME_X_H_ |
OLD | NEW |