Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #ifndef KEYSTORE_KEYSTORE_SERVICE_H_ |
| 18 | #define KEYSTORE_KEYSTORE_SERVICE_H_ |
| 19 | |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 20 | #include <android/security/keystore/BnKeystoreService.h> |
Shawn Willden | 98c5916 | 2016-03-20 09:10:18 -0600 | [diff] [blame] | 21 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 22 | #include "auth_token_table.h" |
David Zeuthen | c6eb7cd | 2017-11-27 11:33:55 -0500 | [diff] [blame] | 23 | #include "confirmation_manager.h" |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 24 | |
Shawn Willden | fa5702f | 2017-12-03 15:14:58 -0700 | [diff] [blame] | 25 | #include "KeyStore.h" |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 26 | #include "keystore_keymaster_enforcement.h" |
| 27 | #include "operation.h" |
| 28 | #include "permissions.h" |
| 29 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 30 | #include <keystore/ExportResult.h> |
| 31 | #include <keystore/KeyCharacteristics.h> |
| 32 | #include <keystore/KeymasterArguments.h> |
| 33 | #include <keystore/KeymasterBlob.h> |
| 34 | #include <keystore/KeymasterCertificateChain.h> |
| 35 | #include <keystore/OperationResult.h> |
| 36 | #include <keystore/keystore_return_types.h> |
| 37 | |
Janis Danisevskis | b50236a | 2019-03-25 10:26:30 -0700 | [diff] [blame] | 38 | #include <mutex> |
| 39 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 40 | namespace keystore { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 41 | |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 42 | // Class provides implementation for generated BnKeystoreService.h based on |
| 43 | // gen/aidl/android/security/BnKeystoreService.h generated from |
| 44 | // java/android/security/IKeystoreService.aidl Note that all generated methods return binder::Status |
| 45 | // and use last arguments to send actual result to the caller. Private methods don't need to handle |
| 46 | // binder::Status. Input parameters cannot be null unless annotated with @nullable in .aidl file. |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 47 | class KeyStoreService : public android::security::keystore::BnKeystoreService { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 48 | public: |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 49 | explicit KeyStoreService(sp<KeyStore> keyStore) : mKeyStore(keyStore) {} |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 50 | virtual ~KeyStoreService() = default; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 51 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 52 | void binderDied(const android::wp<android::IBinder>& who); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 53 | |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 54 | ::android::binder::Status getState(int32_t userId, int32_t* _aidl_return) override; |
| 55 | ::android::binder::Status get(const ::android::String16& name, int32_t uid, |
| 56 | ::std::vector<uint8_t>* _aidl_return) override; |
| 57 | ::android::binder::Status insert(const ::android::String16& name, |
| 58 | const ::std::vector<uint8_t>& item, int32_t uid, int32_t flags, |
| 59 | int32_t* _aidl_return) override; |
| 60 | ::android::binder::Status del(const ::android::String16& name, int32_t uid, |
| 61 | int32_t* _aidl_return) override; |
| 62 | ::android::binder::Status exist(const ::android::String16& name, int32_t uid, |
| 63 | int32_t* _aidl_return) override; |
| 64 | ::android::binder::Status list(const ::android::String16& namePrefix, int32_t uid, |
| 65 | ::std::vector<::android::String16>* _aidl_return) override; |
Rob Barnes | 5d59e63 | 2018-12-07 16:09:02 -0700 | [diff] [blame] | 66 | ::android::binder::Status listUidsOfAuthBoundKeys(std::vector<::std::string>* uids, |
Rob Barnes | eb7f79b | 2018-11-08 15:44:10 -0700 | [diff] [blame] | 67 | int32_t* _aidl_return) override; |
| 68 | |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 69 | ::android::binder::Status onUserPasswordChanged(int32_t userId, |
| 70 | const ::android::String16& newPassword, |
| 71 | int32_t* _aidl_return) override; |
| 72 | ::android::binder::Status lock(int32_t userId, int32_t* _aidl_return) override; |
| 73 | ::android::binder::Status unlock(int32_t userId, const ::android::String16& userPassword, |
| 74 | int32_t* _aidl_return) override; |
| 75 | ::android::binder::Status isEmpty(int32_t userId, int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 76 | ::android::binder::Status grant(const ::android::String16& name, int32_t granteeUid, |
| 77 | ::android::String16* _aidl_return) override; |
| 78 | ::android::binder::Status ungrant(const ::android::String16& name, int32_t granteeUid, |
| 79 | int32_t* _aidl_return) override; |
| 80 | ::android::binder::Status getmtime(const ::android::String16& name, int32_t uid, |
| 81 | int64_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 82 | ::android::binder::Status is_hardware_backed(const ::android::String16& string, |
| 83 | int32_t* _aidl_return) override; |
| 84 | ::android::binder::Status clear_uid(int64_t uid, int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 85 | ::android::binder::Status |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 86 | addRngEntropy(const ::android::sp<::android::security::keystore::IKeystoreResponseCallback>& cb, |
| 87 | const ::std::vector<uint8_t>& data, int32_t flags, |
| 88 | int32_t* _aidl_return) override; |
| 89 | ::android::binder::Status generateKey( |
| 90 | const ::android::sp<::android::security::keystore::IKeystoreKeyCharacteristicsCallback>& cb, |
| 91 | const ::android::String16& alias, |
| 92 | const ::android::security::keymaster::KeymasterArguments& arguments, |
| 93 | const ::std::vector<uint8_t>& entropy, int32_t uid, int32_t flags, |
| 94 | int32_t* _aidl_return) override; |
| 95 | ::android::binder::Status getKeyCharacteristics( |
| 96 | const ::android::sp<::android::security::keystore::IKeystoreKeyCharacteristicsCallback>& cb, |
| 97 | const ::android::String16& alias, |
| 98 | const ::android::security::keymaster::KeymasterBlob& clientId, |
| 99 | const ::android::security::keymaster::KeymasterBlob& appId, int32_t uid, |
| 100 | int32_t* _aidl_return) override; |
| 101 | ::android::binder::Status importKey( |
| 102 | const ::android::sp<::android::security::keystore::IKeystoreKeyCharacteristicsCallback>& cb, |
| 103 | const ::android::String16& alias, |
| 104 | const ::android::security::keymaster::KeymasterArguments& arguments, int32_t format, |
| 105 | const ::std::vector<uint8_t>& keyData, int32_t uid, int32_t flags, |
| 106 | int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 107 | ::android::binder::Status |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 108 | exportKey(const ::android::sp<::android::security::keystore::IKeystoreExportKeyCallback>& cb, |
| 109 | const ::android::String16& alias, int32_t format, |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 110 | const ::android::security::keymaster::KeymasterBlob& clientId, |
| 111 | const ::android::security::keymaster::KeymasterBlob& appId, int32_t uid, |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 112 | int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 113 | ::android::binder::Status |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 114 | begin(const ::android::sp<::android::security::keystore::IKeystoreOperationResultCallback>& cb, |
| 115 | const ::android::sp<::android::IBinder>& appToken, const ::android::String16& alias, |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 116 | int32_t purpose, bool pruneable, |
| 117 | const ::android::security::keymaster::KeymasterArguments& params, |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 118 | const ::std::vector<uint8_t>& entropy, int32_t uid, int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 119 | ::android::binder::Status |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 120 | update(const ::android::sp<::android::security::keystore::IKeystoreOperationResultCallback>& cb, |
| 121 | const ::android::sp<::android::IBinder>& token, |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 122 | const ::android::security::keymaster::KeymasterArguments& params, |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 123 | const ::std::vector<uint8_t>& input, int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 124 | ::android::binder::Status |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 125 | finish(const ::android::sp<::android::security::keystore::IKeystoreOperationResultCallback>& cb, |
| 126 | const ::android::sp<::android::IBinder>& token, |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 127 | const ::android::security::keymaster::KeymasterArguments& params, |
Rob Barnes | 3af223f | 2019-11-14 14:50:30 -0700 | [diff] [blame] | 128 | const ::std::vector<uint8_t>& input, const ::std::vector<uint8_t>& signature, |
| 129 | const ::std::vector<uint8_t>& entropy, int32_t* _aidl_return) override; |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 130 | ::android::binder::Status |
| 131 | abort(const ::android::sp<::android::security::keystore::IKeystoreResponseCallback>& cb, |
| 132 | const ::android::sp<::android::IBinder>& token, int32_t* _aidl_return) override; |
Brian Young | ccb492d | 2018-02-22 23:36:01 +0000 | [diff] [blame] | 133 | ::android::binder::Status addAuthToken(const ::std::vector<uint8_t>& authToken, |
Brian Young | 1b75929 | 2018-01-29 23:57:29 +0000 | [diff] [blame] | 134 | int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 135 | ::android::binder::Status onUserAdded(int32_t userId, int32_t parentId, |
| 136 | int32_t* _aidl_return) override; |
| 137 | ::android::binder::Status onUserRemoved(int32_t userId, int32_t* _aidl_return) override; |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 138 | ::android::binder::Status attestKey( |
| 139 | const ::android::sp<::android::security::keystore::IKeystoreCertificateChainCallback>& cb, |
| 140 | const ::android::String16& alias, |
| 141 | const ::android::security::keymaster::KeymasterArguments& params, |
| 142 | int32_t* _aidl_return) override; |
| 143 | ::android::binder::Status attestDeviceIds( |
| 144 | const ::android::sp<::android::security::keystore::IKeystoreCertificateChainCallback>& cb, |
| 145 | const ::android::security::keymaster::KeymasterArguments& params, |
| 146 | int32_t* _aidl_return) override; |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 147 | ::android::binder::Status onDeviceOffBody(int32_t* _aidl_return) override; |
David Zeuthen | c6eb7cd | 2017-11-27 11:33:55 -0500 | [diff] [blame] | 148 | |
Janis Danisevskis | cb9267d | 2017-12-19 16:27:52 -0800 | [diff] [blame] | 149 | ::android::binder::Status importWrappedKey( |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 150 | const ::android::sp<::android::security::keystore::IKeystoreKeyCharacteristicsCallback>& cb, |
Janis Danisevskis | cb9267d | 2017-12-19 16:27:52 -0800 | [diff] [blame] | 151 | const ::android::String16& wrappedKeyAlias, const ::std::vector<uint8_t>& wrappedKey, |
| 152 | const ::android::String16& wrappingKeyAlias, const ::std::vector<uint8_t>& maskingKey, |
| 153 | const ::android::security::keymaster::KeymasterArguments& params, int64_t rootSid, |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 154 | int64_t fingerprintSid, int32_t* _aidl_return) override; |
Tucker Sylvestro | 0ab28b7 | 2016-08-05 18:02:47 -0400 | [diff] [blame] | 155 | |
David Zeuthen | c6eb7cd | 2017-11-27 11:33:55 -0500 | [diff] [blame] | 156 | ::android::binder::Status presentConfirmationPrompt( |
| 157 | const ::android::sp<::android::IBinder>& listener, const ::android::String16& promptText, |
| 158 | const ::std::vector<uint8_t>& extraData, const ::android::String16& locale, |
| 159 | int32_t uiOptionsAsFlags, int32_t* _aidl_return) override; |
| 160 | ::android::binder::Status |
| 161 | cancelConfirmationPrompt(const ::android::sp<::android::IBinder>& listener, |
| 162 | int32_t* _aidl_return) override; |
David Zeuthen | 1a49231 | 2018-02-26 11:00:30 -0500 | [diff] [blame] | 163 | ::android::binder::Status isConfirmationPromptSupported(bool* _aidl_return) override; |
David Zeuthen | c6eb7cd | 2017-11-27 11:33:55 -0500 | [diff] [blame] | 164 | |
Brian Young | 9371e95 | 2018-02-23 18:03:14 +0000 | [diff] [blame] | 165 | ::android::binder::Status onKeyguardVisibilityChanged(bool isShowing, int32_t userId, |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 166 | int32_t* _aidl_return) override; |
Brian Young | 9371e95 | 2018-02-23 18:03:14 +0000 | [diff] [blame] | 167 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 168 | private: |
| 169 | static const int32_t UID_SELF = -1; |
| 170 | |
| 171 | /** |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 172 | * Get the effective target uid for a binder operation that takes an |
| 173 | * optional uid as the target. |
| 174 | */ |
| 175 | uid_t getEffectiveUid(int32_t targetUid); |
| 176 | |
| 177 | /** |
| 178 | * Check if the caller of the current binder method has the required |
| 179 | * permission and if acting on other uids the grants to do so. |
| 180 | */ |
| 181 | bool checkBinderPermission(perm_t permission, int32_t targetUid = UID_SELF); |
| 182 | |
| 183 | /** |
| 184 | * Check if the caller of the current binder method has the required |
| 185 | * permission and the target uid is the caller or the caller is system. |
| 186 | */ |
| 187 | bool checkBinderPermissionSelfOrSystem(perm_t permission, int32_t targetUid); |
| 188 | |
| 189 | /** |
| 190 | * Check if the caller of the current binder method has the required |
| 191 | * permission or the target of the operation is the caller's uid. This is |
| 192 | * for operation where the permission is only for cross-uid activity and all |
| 193 | * uids are allowed to act on their own (ie: clearing all entries for a |
| 194 | * given uid). |
| 195 | */ |
| 196 | bool checkBinderPermissionOrSelfTarget(perm_t permission, int32_t targetUid); |
| 197 | |
| 198 | /** |
| 199 | * Helper method to check that the caller has the required permission as |
| 200 | * well as the keystore is in the unlocked state if checkUnlocked is true. |
| 201 | * |
| 202 | * Returns NO_ERROR on success, PERMISSION_DENIED on a permission error and |
| 203 | * otherwise the state of keystore when not unlocked and checkUnlocked is |
| 204 | * true. |
| 205 | */ |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 206 | KeyStoreServiceReturnCode checkBinderPermissionAndKeystoreState(perm_t permission, |
| 207 | int32_t targetUid = -1, |
| 208 | bool checkUnlocked = true); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 209 | |
| 210 | bool isKeystoreUnlocked(State state); |
| 211 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 212 | /** |
| 213 | * Check that all keymaster_key_param_t's provided by the application are |
| 214 | * allowed. Any parameter that keystore adds itself should be disallowed here. |
| 215 | */ |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 216 | bool checkAllowedOperationParams(const hidl_vec<KeyParameter>& params); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 217 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 218 | void addLegacyBeginParams(const android::String16& name, AuthorizationSet* params); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 219 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 220 | KeyStoreServiceReturnCode doLegacySignVerify(const android::String16& name, |
| 221 | const hidl_vec<uint8_t>& data, |
| 222 | hidl_vec<uint8_t>* out, |
| 223 | const hidl_vec<uint8_t>& signature, |
| 224 | KeyPurpose purpose); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 225 | |
Shawn Willden | 98c5916 | 2016-03-20 09:10:18 -0600 | [diff] [blame] | 226 | /** |
David Zeuthen | c6eb7cd | 2017-11-27 11:33:55 -0500 | [diff] [blame] | 227 | * Adds a Confirmation Token to the key parameters if needed. |
| 228 | */ |
| 229 | void appendConfirmationTokenIfNeeded(const KeyCharacteristics& keyCharacteristics, |
| 230 | std::vector<KeyParameter>* params); |
| 231 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 232 | sp<KeyStore> mKeyStore; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 233 | }; |
| 234 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 235 | }; // namespace keystore |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 236 | |
| 237 | #endif // KEYSTORE_KEYSTORE_SERVICE_H_ |