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_H_ |
| 18 | #define KEYSTORE_KEYSTORE_H_ |
| 19 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 20 | #include <android/hardware/keymaster/3.0/IKeymasterDevice.h> |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 21 | |
| 22 | #include <utils/Vector.h> |
| 23 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 24 | #include "Keymaster.h" |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 25 | #include "blob.h" |
Janis Danisevskis | 6d449e8 | 2017-06-07 18:03:31 -0700 | [diff] [blame] | 26 | #include "grant_store.h" |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 27 | #include "include/keystore/keymaster_tags.h" |
Shawn Willden | fa5702f | 2017-12-03 15:14:58 -0700 | [diff] [blame] | 28 | #include "user_state.h" |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 29 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 30 | namespace keystore { |
| 31 | |
| 32 | using ::android::sp; |
Janis Danisevskis | e8ba180 | 2017-01-30 10:49:51 +0000 | [diff] [blame] | 33 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 34 | class KeyStore { |
| 35 | public: |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 36 | KeyStore(Entropy* entropy, const sp<Keymaster>& device, const sp<Keymaster>& fallback, |
Janis Danisevskis | e8ba180 | 2017-01-30 10:49:51 +0000 | [diff] [blame] | 37 | bool allowNewFallback); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 38 | ~KeyStore(); |
| 39 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 40 | sp<Keymaster>& getDevice() { return mDevice; } |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 41 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 42 | NullOr<sp<Keymaster>&> getFallbackDevice() { |
Janis Danisevskis | e8ba180 | 2017-01-30 10:49:51 +0000 | [diff] [blame] | 43 | // we only return the fallback device if the creation of new fallback key blobs is |
| 44 | // allowed. (also see getDevice below) |
| 45 | if (mAllowNewFallback) { |
| 46 | return mFallbackDevice; |
| 47 | } else { |
| 48 | return {}; |
| 49 | } |
| 50 | } |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 51 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 52 | sp<Keymaster>& getDevice(const Blob& blob) { |
Janis Danisevskis | e8ba180 | 2017-01-30 10:49:51 +0000 | [diff] [blame] | 53 | // We return a device, based on the nature of the blob to provide backward |
| 54 | // compatibility with old key blobs generated using the fallback device. |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 55 | return blob.isFallback() ? mFallbackDevice : mDevice; |
| 56 | } |
| 57 | |
| 58 | ResponseCode initialize(); |
| 59 | |
| 60 | State getState(uid_t userId) { return getUserState(userId)->getState(); } |
| 61 | |
| 62 | ResponseCode initializeUser(const android::String8& pw, uid_t userId); |
| 63 | |
| 64 | ResponseCode copyMasterKey(uid_t srcUser, uid_t dstUser); |
| 65 | ResponseCode writeMasterKey(const android::String8& pw, uid_t userId); |
| 66 | ResponseCode readMasterKey(const android::String8& pw, uid_t userId); |
| 67 | |
Tucker Sylvestro | 0ab28b7 | 2016-08-05 18:02:47 -0400 | [diff] [blame] | 68 | android::String8 getKeyName(const android::String8& keyName, const BlobType type); |
| 69 | android::String8 getKeyNameForUid(const android::String8& keyName, uid_t uid, |
| 70 | const BlobType type); |
| 71 | android::String8 getKeyNameForUidWithDir(const android::String8& keyName, uid_t uid, |
| 72 | const BlobType type); |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 73 | NullOr<android::String8> getBlobFileNameIfExists(const android::String8& alias, uid_t uid, |
Dmitry Dementyev | a447b3c | 2017-10-27 23:09:53 -0700 | [diff] [blame] | 74 | const BlobType type); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 75 | |
| 76 | /* |
| 77 | * Delete entries owned by userId. If keepUnencryptedEntries is true |
| 78 | * then only encrypted entries will be removed, otherwise all entries will |
| 79 | * be removed. |
| 80 | */ |
| 81 | void resetUser(uid_t userId, bool keepUnenryptedEntries); |
| 82 | bool isEmpty(uid_t userId) const; |
| 83 | |
| 84 | void lock(uid_t userId); |
| 85 | |
| 86 | ResponseCode get(const char* filename, Blob* keyBlob, const BlobType type, uid_t userId); |
| 87 | ResponseCode put(const char* filename, Blob* keyBlob, uid_t userId); |
| 88 | ResponseCode del(const char* filename, const BlobType type, uid_t userId); |
| 89 | ResponseCode list(const android::String8& prefix, android::Vector<android::String16>* matches, |
| 90 | uid_t userId); |
| 91 | |
Janis Danisevskis | 6905c33 | 2017-09-01 13:24:23 -0700 | [diff] [blame] | 92 | std::string addGrant(const char* alias, uid_t granterUid, uid_t granteeUid); |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 93 | bool removeGrant(const char* alias, const uid_t granterUid, const uid_t granteeUid); |
| 94 | void removeAllGrantsToUid(const uid_t granteeUid); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 95 | |
| 96 | ResponseCode importKey(const uint8_t* key, size_t keyLen, const char* filename, uid_t userId, |
| 97 | int32_t flags); |
| 98 | |
| 99 | bool isHardwareBacked(const android::String16& keyType) const; |
| 100 | |
| 101 | ResponseCode getKeyForName(Blob* keyBlob, const android::String8& keyName, const uid_t uid, |
| 102 | const BlobType type); |
| 103 | |
| 104 | /** |
| 105 | * Returns any existing UserState or creates it if it doesn't exist. |
| 106 | */ |
| 107 | UserState* getUserState(uid_t userId); |
| 108 | |
| 109 | /** |
| 110 | * Returns any existing UserState or creates it if it doesn't exist. |
| 111 | */ |
| 112 | UserState* getUserStateByUid(uid_t uid); |
| 113 | |
| 114 | /** |
| 115 | * Returns NULL if the UserState doesn't already exist. |
| 116 | */ |
| 117 | const UserState* getUserState(uid_t userId) const; |
| 118 | |
| 119 | /** |
| 120 | * Returns NULL if the UserState doesn't already exist. |
| 121 | */ |
| 122 | const UserState* getUserStateByUid(uid_t uid) const; |
| 123 | |
| 124 | private: |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 125 | static const char* kOldMasterKey; |
| 126 | static const char* kMetaDataFile; |
| 127 | static const android::String16 kRsaKeyType; |
| 128 | static const android::String16 kEcKeyType; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 129 | Entropy* mEntropy; |
| 130 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 131 | sp<Keymaster> mDevice; |
| 132 | sp<Keymaster> mFallbackDevice; |
Janis Danisevskis | e8ba180 | 2017-01-30 10:49:51 +0000 | [diff] [blame] | 133 | bool mAllowNewFallback; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 134 | |
| 135 | android::Vector<UserState*> mMasterKeys; |
| 136 | |
Janis Danisevskis | 6d449e8 | 2017-06-07 18:03:31 -0700 | [diff] [blame] | 137 | ::keystore::GrantStore mGrants; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 138 | |
Shawn Willden | fa5702f | 2017-12-03 15:14:58 -0700 | [diff] [blame] | 139 | typedef struct { uint32_t version; } keystore_metadata_t; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 140 | |
| 141 | keystore_metadata_t mMetaData; |
| 142 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 143 | /** |
| 144 | * Upgrade the key from the current version to whatever is newest. |
| 145 | */ |
| 146 | bool upgradeBlob(const char* filename, Blob* blob, const uint8_t oldVersion, |
| 147 | const BlobType type, uid_t uid); |
| 148 | |
| 149 | /** |
| 150 | * Takes a blob that is an PEM-encoded RSA key as a byte array and converts it to a DER-encoded |
| 151 | * PKCS#8 for import into a keymaster. Then it overwrites the original blob with the new blob |
| 152 | * format that is returned from the keymaster. |
| 153 | */ |
| 154 | ResponseCode importBlobAsKey(Blob* blob, const char* filename, uid_t uid); |
| 155 | |
| 156 | void readMetaData(); |
| 157 | void writeMetaData(); |
| 158 | |
| 159 | bool upgradeKeystore(); |
| 160 | }; |
| 161 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 162 | } // namespace keystore |
| 163 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 164 | #endif // KEYSTORE_KEYSTORE_H_ |