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.
5 #ifndef CHROME_BROWSER_PASSWORD_MANAGER_PASSWORD_STORE_MAC_INTERNAL_H_
6 #define CHROME_BROWSER_PASSWORD_MANAGER_PASSWORD_STORE_MAC_INTERNAL_H_
8 #include <Security/Security.h>
13 #include "crypto/apple_keychain.h"
15 using crypto::AppleKeychain;
17 // Adapter that wraps a AppleKeychain and provides interaction in terms of
18 // PasswordForms instead of Keychain items.
19 class MacKeychainPasswordFormAdapter {
21 // Creates an adapter for |keychain|. This class does not take ownership of
22 // |keychain|, so the caller must make sure that the keychain outlives the
24 explicit MacKeychainPasswordFormAdapter(const AppleKeychain* keychain);
26 // Returns PasswordForms for each keychain entry that could be used to fill
27 // |form|. Caller is responsible for deleting the returned forms.
28 std::vector<autofill::PasswordForm*> PasswordsFillingForm(
29 const autofill::PasswordForm& query_form);
31 // Returns the PasswordForm for the Keychain entry that matches |form| on all
32 // of the fields that uniquely identify a Keychain item, or NULL if there is
34 // Caller is responsible for deleting the returned form.
35 autofill::PasswordForm* PasswordExactlyMatchingForm(
36 const autofill::PasswordForm& query_form);
38 // Returns true if the keychain contains any items that are mergeable with
39 // |query_form|. This is different from actually extracting the passwords
40 // and checking the return count, since doing that would require reading the
41 // passwords from the keychain, thus potentially triggering authorizaiton UI,
42 // whereas this won't.
43 bool HasPasswordsMergeableWithForm(
44 const autofill::PasswordForm& query_form);
46 // Returns all keychain items of types corresponding to password forms.
47 std::vector<SecKeychainItemRef> GetAllPasswordFormKeychainItems();
49 // Returns password data from all keychain items of types corresponding to
50 // password forms. Caller is responsible for deleting the returned forms.
51 std::vector<autofill::PasswordForm*> GetAllPasswordFormPasswords();
53 // Creates a new keychain entry from |form|, or updates the password of an
54 // existing keychain entry if there is a collision. Returns true if a keychain
55 // entry was successfully added/updated.
56 bool AddPassword(const autofill::PasswordForm& form);
58 // Removes the keychain password matching |form| if any. Returns true if a
59 // keychain item was found and successfully removed.
60 bool RemovePassword(const autofill::PasswordForm& form);
62 // Controls whether or not Chrome will restrict Keychain searches to items
63 // that it created. Defaults to false.
64 void SetFindsOnlyOwnedItems(bool finds_only_owned);
67 // Returns PasswordForms constructed from the given Keychain items, calling
68 // AppleKeychain::Free on all of the keychain items and clearing the vector.
69 // Caller is responsible for deleting the returned forms.
70 std::vector<autofill::PasswordForm*> ConvertKeychainItemsToForms(
71 std::vector<SecKeychainItemRef>* items);
73 // Searches |keychain| for the specific keychain entry that corresponds to the
74 // given form, and returns it (or NULL if no match is found). The caller is
75 // responsible for calling AppleKeychain::Free on on the returned item.
76 SecKeychainItemRef KeychainItemForForm(
77 const autofill::PasswordForm& form);
79 // Returns the Keychain items matching the given signon_realm, scheme, and
80 // optionally path and username (either of both can be NULL).
81 // The caller is responsible for calling AppleKeychain::Free on the
83 std::vector<SecKeychainItemRef> MatchingKeychainItems(
84 const std::string& signon_realm,
85 autofill::PasswordForm::Scheme scheme,
87 const char* username);
89 // Returns the Keychain SecAuthenticationType type corresponding to |scheme|.
90 SecAuthenticationType AuthTypeForScheme(
91 autofill::PasswordForm::Scheme scheme);
93 // Changes the password for keychain_item to |password|; returns true if the
94 // password was successfully changed.
95 bool SetKeychainItemPassword(const SecKeychainItemRef& keychain_item,
96 const std::string& password);
98 // Sets the creator code of keychain_item to creator_code; returns true if the
99 // creator code was successfully set.
100 bool SetKeychainItemCreatorCode(const SecKeychainItemRef& keychain_item,
101 OSType creator_code);
103 // Returns the creator code to be used for a Keychain search, depending on
104 // whether this object was instructed to search only for items it created.
105 // If searches should be restricted in this way, the application-specific
106 // creator code will be returned. Otherwise, 0 will be returned, indicating
107 // a search of all items, regardless of creator.
108 OSType CreatorCodeForSearch();
110 const AppleKeychain* keychain_;
112 // If true, Keychain searches are restricted to items created by Chrome.
113 bool finds_only_owned_;
115 DISALLOW_COPY_AND_ASSIGN(MacKeychainPasswordFormAdapter);
118 namespace internal_keychain_helpers {
120 // Pair of pointers to a SecKeychainItemRef and a corresponding PasswordForm.
121 typedef std::pair<SecKeychainItemRef*, autofill::PasswordForm*> ItemFormPair;
123 // Sets the fields of |form| based on the keychain data from |keychain_item|.
124 // Fields that can't be determined from |keychain_item| will be unchanged. If
125 // |extract_password_data| is true, the password data will be copied from
126 // |keychain_item| in addition to its attributes, and the |blacklisted_by_user|
127 // field will be set to true for empty passwords ("" or " ").
128 // If |extract_password_data| is false, only the password attributes will be
129 // copied, and the |blacklisted_by_user| field will always be false.
131 // IMPORTANT: If |extract_password_data| is true, this function can cause the OS
132 // to trigger UI (to allow access to the keychain item if we aren't trusted for
133 // the item), and block until the UI is dismissed.
135 // If excessive prompting for access to other applications' keychain items
136 // becomes an issue, the password storage API will need to intially call this
137 // function with |extract_password_data| set to false, and retrieve the password
138 // later (accessing other fields doesn't require authorization).
139 bool FillPasswordFormFromKeychainItem(const AppleKeychain& keychain,
140 const SecKeychainItemRef& keychain_item,
141 autofill::PasswordForm* form,
142 bool extract_password_data);
144 // Returns true if the two given forms match based on signon_reaml, scheme, and
145 // username_value, and are thus suitable for merging (see MergePasswordForms).
146 bool FormsMatchForMerge(const autofill::PasswordForm& form_a,
147 const autofill::PasswordForm& form_b);
149 // Populates merged_forms by combining the password data from keychain_forms and
150 // the metadata from database_forms, removing used entries from the two source
153 // On return, database_forms and keychain_forms will have only unused
154 // entries; for database_forms that means entries for which no corresponding
155 // password can be found (and which aren't blacklist entries), and for
156 // keychain_forms its entries that weren't merged into at least one database
158 void MergePasswordForms(
159 std::vector<autofill::PasswordForm*>* keychain_forms,
160 std::vector<autofill::PasswordForm*>* database_forms,
161 std::vector<autofill::PasswordForm*>* merged_forms);
163 // Fills in the passwords for as many of the forms in |database_forms| as
164 // possible using entries from |keychain| and returns them. On return,
165 // |database_forms| will contain only the forms for which no password was found.
166 std::vector<autofill::PasswordForm*> GetPasswordsForForms(
167 const AppleKeychain& keychain,
168 std::vector<autofill::PasswordForm*>* database_forms);
170 // Loads all items in the system keychain into |keychain_items|, creates for
171 // each keychain item a corresponding PasswordForm that doesn't contain any
172 // password data, and returns the two collections as a vector of ItemFormPairs.
173 // Used by GetPasswordsForForms for optimized matching of keychain items with
174 // PasswordForms in the database.
175 // Note: Since no password data is loaded here, the resulting PasswordForms
176 // will include blacklist entries, which will have to be filtered out later.
177 // Caller owns the SecKeychainItemRefs and PasswordForms that are returned.
178 // This operation does not require OS authorization.
179 std::vector<ItemFormPair> ExtractAllKeychainItemAttributesIntoPasswordForms(
180 std::vector<SecKeychainItemRef>* keychain_items,
181 const AppleKeychain& keychain);
183 // Takes a PasswordForm's signon_realm and parses it into its component parts,
184 // which are returned though the appropriate out parameters.
185 // Returns true if it can be successfully parsed, in which case all out params
186 // that are non-NULL will be set. If there is no port, port will be 0.
187 // If the return value is false, the state of the out params is undefined.
188 bool ExtractSignonRealmComponents(const std::string& signon_realm,
189 std::string* server, int* port,
191 std::string* security_domain);
193 // Returns true if the signon_realm of |query_form| can be successfully parsed
194 // by ExtractSignonRealmComponents, and if |query_form| matches |other_form|.
195 bool FormIsValidAndMatchesOtherForm(const autofill::PasswordForm& query_form,
196 const autofill::PasswordForm& other_form);
198 // Returns PasswordForms populated with password data for each keychain entry
199 // in |item_form_pairs| that could be merged with |query_form|.
200 // Caller is responsible for deleting the returned forms.
201 std::vector<autofill::PasswordForm*> ExtractPasswordsMergeableWithForm(
202 const AppleKeychain& keychain,
203 const std::vector<ItemFormPair>& item_form_pairs,
204 const autofill::PasswordForm& query_form);
206 } // namespace internal_keychain_helpers
208 #endif // CHROME_BROWSER_PASSWORD_MANAGER_PASSWORD_STORE_MAC_INTERNAL_H_