Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 1 | /* |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 2 | * Copyright (C) 2015 The Android Open Source Project |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 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 | |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 17 | #ifndef ANDROID_HARDWARE_KEYMASTER1_H |
| 18 | #define ANDROID_HARDWARE_KEYMASTER1_H |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 19 | |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 20 | #include <hardware/keymaster_common.h> |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 21 | #include <hardware/keymaster_defs.h> |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 22 | |
| 23 | __BEGIN_DECLS |
| 24 | |
| 25 | /** |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 26 | * Keymaster1 device definition |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 27 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 28 | struct keymaster1_device { |
Stewart Miles | 84d3549 | 2014-05-01 09:03:27 -0700 | [diff] [blame] | 29 | /** |
| 30 | * Common methods of the keymaster device. This *must* be the first member of |
| 31 | * keymaster_device as users of this structure will cast a hw_device_t to |
| 32 | * keymaster_device pointer in contexts where it's known the hw_device_t references a |
| 33 | * keymaster_device. |
| 34 | */ |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 35 | struct hw_device_t common; |
| 36 | |
Kenny Root | c124b23 | 2013-09-04 22:17:56 -0700 | [diff] [blame] | 37 | /** |
| 38 | * THIS IS DEPRECATED. Use the new "module_api_version" and "hal_api_version" |
| 39 | * fields in the keymaster_module initialization instead. |
| 40 | */ |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 41 | uint32_t client_version; |
| 42 | |
Kenny Root | 3c338f4 | 2012-03-26 13:47:48 -0700 | [diff] [blame] | 43 | /** |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 44 | * See flags defined for keymaster0_devices::flags in keymaster_common.h |
Kenny Root | 3c338f4 | 2012-03-26 13:47:48 -0700 | [diff] [blame] | 45 | */ |
| 46 | uint32_t flags; |
| 47 | |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 48 | void* context; |
| 49 | |
| 50 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 51 | * \deprecated Generates a public and private key. The key-blob returned is opaque and must |
| 52 | * subsequently provided for signing and verification. |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 53 | * |
| 54 | * Returns: 0 on success or an error code less than 0. |
| 55 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 56 | int (*generate_keypair)(const struct keymaster1_device* dev, const keymaster_keypair_t key_type, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 57 | const void* key_params, uint8_t** key_blob, size_t* key_blob_length); |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 58 | |
| 59 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 60 | * \deprecated Imports a public and private key pair. The imported keys will be in PKCS#8 format |
| 61 | * with DER encoding (Java standard). The key-blob returned is opaque and will be subsequently |
| 62 | * provided for signing and verification. |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 63 | * |
| 64 | * Returns: 0 on success or an error code less than 0. |
| 65 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 66 | int (*import_keypair)(const struct keymaster1_device* dev, const uint8_t* key, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 67 | const size_t key_length, uint8_t** key_blob, size_t* key_blob_length); |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 68 | |
| 69 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 70 | * \deprecated Gets the public key part of a key pair. The public key must be in X.509 format |
| 71 | * (Java standard) encoded byte array. |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 72 | * |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 73 | * Returns: 0 on success or an error code less than 0. On error, x509_data |
| 74 | * should not be allocated. |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 75 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 76 | int (*get_keypair_public)(const struct keymaster1_device* dev, const uint8_t* key_blob, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 77 | const size_t key_blob_length, uint8_t** x509_data, |
| 78 | size_t* x509_data_length); |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 79 | |
| 80 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 81 | * \deprecated Deletes the key pair associated with the key blob. |
Kenny Root | 8ae65e7 | 2012-03-23 16:17:28 -0700 | [diff] [blame] | 82 | * |
| 83 | * This function is optional and should be set to NULL if it is not |
| 84 | * implemented. |
| 85 | * |
| 86 | * Returns 0 on success or an error code less than 0. |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 87 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 88 | int (*delete_keypair)(const struct keymaster1_device* dev, const uint8_t* key_blob, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 89 | const size_t key_blob_length); |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 90 | |
| 91 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 92 | * \deprecated Deletes all keys in the hardware keystore. Used when keystore is reset |
| 93 | * completely. |
Kenny Root | 8ae65e7 | 2012-03-23 16:17:28 -0700 | [diff] [blame] | 94 | * |
| 95 | * This function is optional and should be set to NULL if it is not |
| 96 | * implemented. |
| 97 | * |
| 98 | * Returns 0 on success or an error code less than 0. |
| 99 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 100 | int (*delete_all)(const struct keymaster1_device* dev); |
Kenny Root | 8ae65e7 | 2012-03-23 16:17:28 -0700 | [diff] [blame] | 101 | |
| 102 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 103 | * \deprecated Signs data using a key-blob generated before. This can use either an asymmetric |
| 104 | * key or a secret key. |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 105 | * |
| 106 | * Returns: 0 on success or an error code less than 0. |
| 107 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 108 | int (*sign_data)(const struct keymaster1_device* dev, const void* signing_params, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 109 | const uint8_t* key_blob, const size_t key_blob_length, const uint8_t* data, |
| 110 | const size_t data_length, uint8_t** signed_data, size_t* signed_data_length); |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 111 | |
| 112 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 113 | * \deprecated Verifies data signed with a key-blob. This can use either an asymmetric key or a |
| 114 | * secret key. |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 115 | * |
| 116 | * Returns: 0 on successful verification or an error code less than 0. |
| 117 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 118 | int (*verify_data)(const struct keymaster1_device* dev, const void* signing_params, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 119 | const uint8_t* key_blob, const size_t key_blob_length, |
| 120 | const uint8_t* signed_data, const size_t signed_data_length, |
| 121 | const uint8_t* signature, const size_t signature_length); |
| 122 | |
| 123 | /** |
| 124 | * Gets algorithms supported. |
| 125 | * |
| 126 | * \param[in] dev The keymaster device structure. |
| 127 | * |
| 128 | * \param[out] algorithms Array of algorithms supported. The caller takes ownership of the |
| 129 | * array and must free() it. |
| 130 | * |
| 131 | * \param[out] algorithms_length Length of \p algorithms. |
| 132 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 133 | keymaster_error_t (*get_supported_algorithms)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 134 | keymaster_algorithm_t** algorithms, |
| 135 | size_t* algorithms_length); |
| 136 | |
| 137 | /** |
| 138 | * Gets the block modes supported for the specified algorithm. |
| 139 | * |
| 140 | * \param[in] dev The keymaster device structure. |
| 141 | * |
| 142 | * \param[in] algorithm The algorithm for which supported modes will be returned. |
| 143 | * |
| 144 | * \param[out] modes Array of modes supported. The caller takes ownership of the array and must |
| 145 | * free() it. |
| 146 | * |
| 147 | * \param[out] modes_length Length of \p modes. |
| 148 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 149 | keymaster_error_t (*get_supported_block_modes)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 150 | keymaster_algorithm_t algorithm, |
| 151 | keymaster_purpose_t purpose, |
| 152 | keymaster_block_mode_t** modes, |
| 153 | size_t* modes_length); |
| 154 | |
| 155 | /** |
| 156 | * Gets the padding modes supported for the specified algorithm. Caller assumes ownership of |
| 157 | * the allocated array. |
| 158 | * |
| 159 | * \param[in] dev The keymaster device structure. |
| 160 | * |
| 161 | * \param[in] algorithm The algorithm for which supported padding modes will be returned. |
| 162 | * |
| 163 | * \param[out] modes Array of padding modes supported. The caller takes ownership of the array |
| 164 | * and must free() it. |
| 165 | * |
| 166 | * \param[out] modes_length Length of \p modes. |
| 167 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 168 | keymaster_error_t (*get_supported_padding_modes)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 169 | keymaster_algorithm_t algorithm, |
| 170 | keymaster_purpose_t purpose, |
| 171 | keymaster_padding_t** modes, |
| 172 | size_t* modes_length); |
| 173 | |
| 174 | /** |
| 175 | * Gets the digests supported for the specified algorithm. Caller assumes ownership of the |
| 176 | * allocated array. |
| 177 | * |
| 178 | * \param[in] dev The keymaster device structure. |
| 179 | * |
| 180 | * \param[in] algorithm The algorithm for which supported digests will be returned. |
| 181 | * |
| 182 | * \param[out] digests Array of digests supported. The caller takes ownership of the array and |
| 183 | * must free() it. |
| 184 | * |
| 185 | * \param[out] digests_length Length of \p digests. |
| 186 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 187 | keymaster_error_t (*get_supported_digests)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 188 | keymaster_algorithm_t algorithm, |
| 189 | keymaster_purpose_t purpose, |
| 190 | keymaster_digest_t** digests, |
| 191 | size_t* digests_length); |
| 192 | |
| 193 | /** |
| 194 | * Gets the key import formats supported for keys of the specified algorithm. Caller assumes |
| 195 | * ownership of the allocated array. |
| 196 | * |
| 197 | * \param[in] dev The keymaster device structure. |
| 198 | * |
| 199 | * \param[in] algorithm The algorithm for which supported formats will be returned. |
| 200 | * |
| 201 | * \param[out] formats Array of formats supported. The caller takes ownership of the array and |
| 202 | * must free() it. |
| 203 | * |
| 204 | * \param[out] formats_length Length of \p formats. |
| 205 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 206 | keymaster_error_t (*get_supported_import_formats)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 207 | keymaster_algorithm_t algorithm, |
| 208 | keymaster_key_format_t** formats, |
| 209 | size_t* formats_length); |
| 210 | |
| 211 | /** |
| 212 | * Gets the key export formats supported for keys of the specified algorithm. Caller assumes |
| 213 | * ownership of the allocated array. |
| 214 | * |
| 215 | * \param[in] dev The keymaster device structure. |
| 216 | * |
| 217 | * \param[in] algorithm The algorithm for which supported formats will be returned. |
| 218 | * |
| 219 | * \param[out] formats Array of formats supported. The caller takes ownership of the array and |
| 220 | * must free() it. |
| 221 | * |
| 222 | * \param[out] formats_length Length of \p formats. |
| 223 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 224 | keymaster_error_t (*get_supported_export_formats)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 225 | keymaster_algorithm_t algorithm, |
| 226 | keymaster_key_format_t** formats, |
| 227 | size_t* formats_length); |
| 228 | |
| 229 | /** |
| 230 | * Adds entropy to the RNG used by keymaster. Entropy added through this method is guaranteed |
| 231 | * not to be the only source of entropy used, and the mixing function is required to be secure, |
| 232 | * in the sense that if the RNG is seeded (from any source) with any data the attacker cannot |
| 233 | * predict (or control), then the RNG output is indistinguishable from random. Thus, if the |
| 234 | * entropy from any source is good, the output will be good. |
| 235 | * |
| 236 | * \param[in] dev The keymaster device structure. |
| 237 | * |
| 238 | * \param[in] data Random data to be mixed in. |
| 239 | * |
| 240 | * \param[in] data_length Length of \p data. |
| 241 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 242 | keymaster_error_t (*add_rng_entropy)(const struct keymaster1_device* dev, const uint8_t* data, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 243 | size_t data_length); |
| 244 | |
| 245 | /** |
| 246 | * Generates a key, or key pair, returning a key blob and/or a description of the key. |
| 247 | * |
| 248 | * Key generation parameters are defined as keymaster tag/value pairs, provided in \p params. |
| 249 | * See keymaster_tag_t for the full list. Some values that are always required for generation |
| 250 | * of useful keys are: |
| 251 | * |
| 252 | * - KM_TAG_ALGORITHM; |
| 253 | * - KM_TAG_PURPOSE; |
| 254 | * - KM_TAG_USER_ID or KM_TAG_ALL_USERS; |
| 255 | * - KM_TAG_USER_AUTH_ID or KM_TAG_NO_AUTH_REQUIRED; |
| 256 | * - KM_TAG_APPLICATION_ID or KM_TAG_ALL_APPLICATIONS; and |
| 257 | * - KM_TAG_ORIGINATION_EXPIRE_DATETIME |
| 258 | * |
| 259 | * KM_TAG_AUTH_TIMEOUT should generally be specified unless KM_TAG_NO_AUTH_REQUIRED is present, |
| 260 | * or the user will have to authenticate for every use. |
| 261 | * |
| 262 | * KM_TAG_BLOCK_MODE, KM_TAG_PADDING, KM_TAG_MAC_LENGTH and KM_TAG_DIGEST must be specified for |
| 263 | * algorithms that require them. |
| 264 | * |
| 265 | * The following tags will take default values if unspecified: |
| 266 | * |
| 267 | * - KM_TAG_KEY_SIZE defaults to a recommended key size for the specified algorithm. |
| 268 | * |
| 269 | * - KM_TAG_USAGE_EXPIRE_DATETIME defaults to the value of KM_TAG_ORIGINATION_EXPIRE_DATETIME. |
| 270 | * |
| 271 | * - KM_TAG_ACTIVE_DATETIME will default to the value of KM_TAG_CREATION_DATETIME |
| 272 | * |
| 273 | * - KM_TAG_ROOT_OF_TRUST will default to the current root of trust. |
| 274 | * |
| 275 | * - KM_TAG_{RSA|DSA|DH}_* will default to values appropriate for the specified key size. |
| 276 | * |
| 277 | * The following tags may not be specified; their values will be provided by the implementation. |
| 278 | * |
| 279 | * - KM_TAG_ORIGIN, |
| 280 | * |
| 281 | * - KM_TAG_ROLLBACK_RESISTANT, |
| 282 | * |
| 283 | * - KM_TAG_CREATION_DATETIME, |
| 284 | * |
| 285 | * \param[in] dev The keymaster device structure. |
| 286 | * |
| 287 | * \param[in] params Array of key generation parameters. |
| 288 | * |
| 289 | * \param[in] params_count Length of \p params. |
| 290 | * |
| 291 | * \param[out] key_blob returns the generated key. If \p key_blob is NULL, no key is generated, |
| 292 | * but the characteristics of the key that would be generated are returned. The caller assumes |
| 293 | * ownership key_blob->key_material and must free() it. |
| 294 | * |
| 295 | * \param[out] characteristics returns the characteristics of the key that was, or would be, |
| 296 | * generated, if non-NULL. The caller assumes ownership, and the object must be freed with |
| 297 | * keymaster_free_characteristics(). Note that KM_TAG_ROOT_OF_TRUST, KM_TAG_APPLICATION_ID and |
| 298 | * KM_TAG_APPLICATION_DATA are never returned. |
| 299 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 300 | keymaster_error_t (*generate_key)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 301 | const keymaster_key_param_t* params, size_t params_count, |
| 302 | keymaster_key_blob_t* key_blob, |
| 303 | keymaster_key_characteristics_t** characteristics); |
| 304 | |
| 305 | /** |
| 306 | * Returns the characteristics of the specified key, or NULL if the key_blob is invalid |
| 307 | * (implementations must fully validate the integrity of the key). client_id and app_data must |
| 308 | * be the ID and data provided when the key was generated or imported. Those values are not |
| 309 | * included in the returned characteristics. Caller assumes ownership of the allocated |
| 310 | * characteristics object, which must be deallocated with keymaster_free_characteristics(). |
| 311 | * |
| 312 | * Note that KM_TAG_ROOT_OF_TRUST, KM_TAG_APPLICATION_ID and KM_TAG_APPLICATION_DATA are never |
| 313 | * returned. |
| 314 | * |
| 315 | * \param[in] dev The keymaster device structure. |
| 316 | * |
| 317 | * \param[in] key_blob The key to retreive characteristics from. |
| 318 | * |
| 319 | * \param[in] client_id The client ID data, or NULL if none associated. |
| 320 | * |
| 321 | * \param[in] app_id The app data, or NULL if none associated. |
| 322 | * |
| 323 | * \param[out] characteristics The key characteristics. |
| 324 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 325 | keymaster_error_t (*get_key_characteristics)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 326 | const keymaster_key_blob_t* key_blob, |
| 327 | const keymaster_blob_t* client_id, |
| 328 | const keymaster_blob_t* app_data, |
| 329 | keymaster_key_characteristics_t** characteristics); |
| 330 | |
| 331 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 332 | * Imports a key, or key pair, returning a key blob and/or a description of the key. |
| 333 | * |
| 334 | * Most key import parameters are defined as keymaster tag/value pairs, provided in "params". |
| 335 | * See keymaster_tag_t for the full list. Some values that are always required for import of |
| 336 | * useful keys are: |
| 337 | * |
| 338 | * - KM_TAG_PURPOSE; |
| 339 | * |
| 340 | * - KM_TAG_USER_ID |
| 341 | * |
| 342 | * - KM_TAG_USER_AUTH_ID; |
| 343 | * |
| 344 | * - KM_TAG_APPLICATION_ID or KM_TAG_ALL_APPLICATIONS; |
| 345 | * |
| 346 | * - KM_TAG_PRIVKEY_EXPIRE_DATETIME. |
| 347 | * |
| 348 | * KM_TAG_AUTH_TIMEOUT should generally be specified. If unspecified, the user will have to |
| 349 | * authenticate for every use, unless KM_TAG_USER_AUTH_ID is set to |
| 350 | * KM_NO_AUTHENTICATION_REQUIRED. |
| 351 | * |
| 352 | * The following tags will take default values if unspecified: |
| 353 | * |
| 354 | * - KM_TAG_PUBKEY_EXPIRE_DATETIME will default to the value for KM_TAG_PRIVKEY_EXPIRE_DATETIME. |
| 355 | * |
| 356 | * - KM_TAG_ACTIVE_DATETIME will default to the value of KM_TAG_CREATION_DATETIME |
| 357 | * |
| 358 | * - KM_TAG_ROOT_OF_TRUST will default to the current root of trust. |
| 359 | * |
| 360 | * The following tags may not be specified; their values will be provided by the implementation. |
| 361 | * |
| 362 | * - KM_TAG_ORIGIN, |
| 363 | * |
| 364 | * - KM_TAG_ROLLBACK_RESISTANT, |
| 365 | * |
| 366 | * - KM_TAG_CREATION_DATETIME, |
| 367 | * |
| 368 | * \param[in] dev The keymaster device structure. |
| 369 | * |
| 370 | * \param[in] params Parameters defining the imported key. |
| 371 | * |
| 372 | * \param[in] params_count The number of entries in \p params. |
| 373 | * |
| 374 | * \param[in] key_format specifies the format of the key data in key_data. |
| 375 | * |
| 376 | * \param[out] key_blob Used to return the opaque key blob. Must be non-NULL. The caller |
| 377 | * assumes ownership of the contained key_material. |
| 378 | * |
| 379 | * \param[out] characteristics Used to return the characteristics of the imported key. May be |
| 380 | * NULL, in which case no characteristics will be returned. If non-NULL, the caller assumes |
| 381 | * ownership and must deallocate with keymaster_free_characteristics(). |
| 382 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 383 | keymaster_error_t (*import_key)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 384 | const keymaster_key_param_t* params, size_t params_count, |
| 385 | keymaster_key_format_t key_format, const uint8_t* key_data, |
| 386 | size_t key_data_length, keymaster_key_blob_t* key_blob, |
| 387 | keymaster_key_characteristics_t** characteristics); |
| 388 | |
| 389 | /** |
| 390 | * Exports a public key, returning a byte array in the specified format. |
| 391 | * |
| 392 | * \param[in] dev The keymaster device structure. |
| 393 | * |
| 394 | * \param[in] export_format The format to be used for exporting the key. |
| 395 | * |
| 396 | * \param[in] key_to_export The key to export. |
| 397 | * |
| 398 | * \param[out] export_data The exported key material. The caller assumes ownership. |
| 399 | * |
| 400 | * \param[out] export_data_length The length of \p export_data. |
| 401 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 402 | keymaster_error_t (*export_key)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 403 | keymaster_key_format_t export_format, |
| 404 | const keymaster_key_blob_t* key_to_export, |
| 405 | const keymaster_blob_t* client_id, |
| 406 | const keymaster_blob_t* app_data, uint8_t** export_data, |
| 407 | size_t* export_data_length); |
| 408 | |
| 409 | /** |
| 410 | * Deletes the key, or key pair, associated with the key blob. After calling this function it |
Shawn Willden | 9b31a49 | 2015-05-11 07:06:01 -0600 | [diff] [blame^] | 411 | * will be impossible to use the key for any other operations. May be applied to keys from |
| 412 | * foreign roots of trust (keys not usable under the current root of trust). |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 413 | * |
| 414 | * This function is optional and should be set to NULL if it is not implemented. |
| 415 | * |
| 416 | * \param[in] dev The keymaster device structure. |
| 417 | * |
| 418 | * \param[in] key The key to be deleted. |
| 419 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 420 | keymaster_error_t (*delete_key)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 421 | const keymaster_key_blob_t* key); |
| 422 | |
| 423 | /** |
| 424 | * Deletes all keys in the hardware keystore. Used when keystore is reset completely. After |
| 425 | * calling this function it will be impossible to use any previously generated or imported key |
| 426 | * blobs for any operations. |
| 427 | * |
| 428 | * This function is optional and should be set to NULL if it is not implemented. |
| 429 | * |
| 430 | * \param[in] dev The keymaster device structure. |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 431 | */ |
Shawn Willden | e1afa5b | 2015-04-08 06:54:57 -0600 | [diff] [blame] | 432 | keymaster_error_t (*delete_all_keys)(const struct keymaster1_device* dev); |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 433 | |
| 434 | /** |
| 435 | * Begins a cryptographic operation using the specified key. If all is well, begin() will |
| 436 | * return KM_ERROR_OK and create an operation handle which must be passed to subsequent calls to |
| 437 | * update(), finish() or abort(). |
| 438 | * |
| 439 | * It is critical that each call to begin() be paired with a subsequent call to finish() or |
| 440 | * abort(), to allow the keymaster implementation to clean up any internal operation state. |
| 441 | * Failure to do this will leak internal state space or other internal resources and will |
| 442 | * eventually cause begin() to return KM_ERROR_TOO_MANY_OPERATIONS when it runs out of space for |
| 443 | * operations. |
| 444 | * |
| 445 | * \param[in] dev The keymaster device structure. |
| 446 | * |
| 447 | * \param[in] purpose The purpose of the operation, one of KM_PURPOSE_ENCRYPT, |
| 448 | * KM_PURPOSE_DECRYPT, KM_PURPOSE_SIGN or KM_PURPOSE_VERIFY. Note that for AEAD modes, |
| 449 | * encryption and decryption imply signing and verification, respectively. |
| 450 | * |
| 451 | * \param[in] key The key to be used for the operation. \p key must have a purpose compatible |
| 452 | * with \p purpose and all of its usage requirements must be satisfied, or begin() will return |
| 453 | * an appropriate error code. |
| 454 | * |
| 455 | * \param[in] params Additional parameters for the operation. This is typically used to provide |
| 456 | * client ID information, with tags KM_TAG_APPLICATION_ID and KM_TAG_APPLICATION_DATA. If the |
| 457 | * client information associated with the key is not provided, begin() will fail and return |
Shawn Willden | e26e136 | 2015-02-06 17:01:53 -0700 | [diff] [blame] | 458 | * KM_ERROR_INVALID_KEY_BLOB. For operations that require a nonce or IV, this must contain a |
Shawn Willden | 79d7934 | 2015-02-10 14:29:46 -0700 | [diff] [blame] | 459 | * tag KM_TAG_NONCE. For AEAD operations KM_TAG_CHUNK_SIZE is specified here. |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 460 | * |
| 461 | * \param[in] params_count The number of entries in \p params. |
| 462 | * |
| 463 | * \param[out] out_params Array of output parameters. The caller takes ownership of the output |
| 464 | * parametes array and must free it. out_params may be set to NULL if no output parameters are |
| 465 | * expected. If NULL, and output paramaters are generated, begin() will return |
| 466 | * KM_ERROR_OUTPUT_PARAMETER_NULL. |
| 467 | * |
| 468 | * \param[out] out_params_count The length of out_params. |
| 469 | * |
| 470 | * \param[out] operation_handle The newly-created operation handle which must be passed to |
| 471 | * update(), finish() or abort(). |
| 472 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 473 | keymaster_error_t (*begin)(const struct keymaster1_device* dev, keymaster_purpose_t purpose, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 474 | const keymaster_key_blob_t* key, const keymaster_key_param_t* params, |
| 475 | size_t params_count, keymaster_key_param_t** out_params, |
| 476 | size_t* out_params_count, |
| 477 | keymaster_operation_handle_t* operation_handle); |
| 478 | |
| 479 | /** |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 480 | * Provides data to, and possibly receives output from, an ongoing cryptographic operation begun |
| 481 | * with begin(). |
| 482 | * |
| 483 | * If operation_handle is invalid, update() will return KM_ERROR_INVALID_OPERATION_HANDLE. |
| 484 | * |
| 485 | * Not all of the data provided in the data buffer may be consumed. update() will return the |
| 486 | * amount consumed in *data_consumed. The caller should provide the unconsumed data in a |
| 487 | * subsequent call. |
| 488 | * |
| 489 | * \param[in] dev The keymaster device structure. |
| 490 | * |
| 491 | * \param[in] operation_handle The operation handle returned by begin(). |
| 492 | * |
Shawn Willden | e26e136 | 2015-02-06 17:01:53 -0700 | [diff] [blame] | 493 | * \param[in] params Additional parameters for the operation. For AEAD modes, this is used to |
| 494 | * specify KM_TAG_ADDITIONAL_DATA. |
| 495 | * |
| 496 | * \param[in] params_count Length of \p params. |
| 497 | * |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 498 | * \param[in] input Data to be processed, per the parameters established in the call to begin(). |
| 499 | * Note that update() may or may not consume all of the data provided. See \p data_consumed. |
| 500 | * |
| 501 | * \param[in] input_length Length of \p input. |
| 502 | * |
| 503 | * \param[out] input_consumed Amount of data that was consumed by update(). If this is less |
| 504 | * than the amount provided, the caller should provide the remainder in a subsequent call to |
| 505 | * update(). |
| 506 | * |
| 507 | * \param[out] output The output data, if any. The caller assumes ownership of the allocated |
| 508 | * buffer. If output is NULL then NO input data is consumed and no output is produced, but |
| 509 | * *output_length is set to an estimate of the size that would have been produced by this |
| 510 | * update() and a subsequent finish(). |
| 511 | * |
| 512 | * \param[out] output_length The length of the output buffer. |
| 513 | * |
| 514 | * Note that update() may not provide any output, in which case *output_length will be zero, and |
| 515 | * *output may be either NULL or zero-length (so the caller should always free() it). |
| 516 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 517 | keymaster_error_t (*update)(const struct keymaster1_device* dev, |
Shawn Willden | e26e136 | 2015-02-06 17:01:53 -0700 | [diff] [blame] | 518 | keymaster_operation_handle_t operation_handle, |
| 519 | const keymaster_key_param_t* params, size_t params_count, |
| 520 | const uint8_t* input, size_t input_length, size_t* input_consumed, |
| 521 | uint8_t** output, size_t* output_length); |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 522 | |
| 523 | /** |
| 524 | * Finalizes a cryptographic operation begun with begin() and invalidates operation_handle |
| 525 | * (except in the insufficient buffer case, detailed below). |
| 526 | * |
| 527 | * \param[in] dev The keymaster device structure. |
| 528 | * |
| 529 | * \param[in] operation_handle The operation handle returned by begin(). This handle will be |
| 530 | * invalidated. |
| 531 | * |
Shawn Willden | e26e136 | 2015-02-06 17:01:53 -0700 | [diff] [blame] | 532 | * \param[in] params Additional parameters for the operation. For AEAD modes, this is used to |
| 533 | * specify KM_TAG_ADDITIONAL_DATA. |
| 534 | * |
| 535 | * \param[in] params_count Length of \p params. |
| 536 | * |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 537 | * \param[in] signature The signature to be verified if the purpose specified in the begin() |
| 538 | * call was KM_PURPOSE_VERIFY. |
| 539 | * |
| 540 | * \param[in] signature_length The length of \p signature. |
| 541 | * |
| 542 | * \param[out] output The output data, if any. The caller assumes ownership of the allocated |
| 543 | * buffer. |
| 544 | * |
| 545 | * \param[out] output_length The length of the output buffer. |
| 546 | * |
| 547 | * If the operation being finished is a signature verification or an AEAD-mode decryption and |
| 548 | * verification fails then finish() will return KM_ERROR_VERIFICATION_FAILED. |
| 549 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 550 | keymaster_error_t (*finish)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 551 | keymaster_operation_handle_t operation_handle, |
Shawn Willden | e26e136 | 2015-02-06 17:01:53 -0700 | [diff] [blame] | 552 | const keymaster_key_param_t* params, size_t params_count, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 553 | const uint8_t* signature, size_t signature_length, uint8_t** output, |
| 554 | size_t* output_length); |
| 555 | |
| 556 | /** |
| 557 | * Aborts a cryptographic operation begun with begin(), freeing all internal resources and |
| 558 | * invalidating operation_handle. |
| 559 | */ |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 560 | keymaster_error_t (*abort)(const struct keymaster1_device* dev, |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 561 | keymaster_operation_handle_t operation_handle); |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 562 | }; |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 563 | typedef struct keymaster1_device keymaster1_device_t; |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 564 | |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 565 | /* Convenience API for opening and closing keymaster devices */ |
| 566 | |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 567 | static inline int keymaster1_open(const struct hw_module_t* module, keymaster1_device_t** device) { |
Shawn Willden | 9d645a0 | 2014-06-12 13:48:46 -0600 | [diff] [blame] | 568 | return module->methods->open(module, KEYSTORE_KEYMASTER, (struct hw_device_t**)device); |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 569 | } |
| 570 | |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 571 | static inline int keymaster1_close(keymaster1_device_t* device) { |
Kenny Root | 9271d04 | 2012-03-13 09:22:21 -0700 | [diff] [blame] | 572 | return device->common.close(&device->common); |
| 573 | } |
| 574 | |
Kenny Root | 60d0e5f | 2012-02-15 10:54:24 -0800 | [diff] [blame] | 575 | __END_DECLS |
| 576 | |
Shawn Willden | fd4b4d5 | 2015-02-24 09:17:38 -0700 | [diff] [blame] | 577 | #endif // ANDROID_HARDWARE_KEYMASTER1_H |