blob: 580001965c544773022ed6558991a0b04829cd1d [file] [log] [blame]
Shawn Willden9d645a02014-06-12 13:48:46 -06001/*
2 * Copyright (C) 2014 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 ANDROID_HARDWARE_KEYMASTER_DEFS_H
18#define ANDROID_HARDWARE_KEYMASTER_DEFS_H
19
20#include <stdint.h>
21#include <stdlib.h>
22#include <string.h>
23
Shawn Willden7eaa15f2015-06-03 09:03:20 -060024#ifdef __cplusplus
Shawn Willdenc51d01e2015-03-18 18:59:52 -060025extern "C" {
26#endif // __cplusplus
Shawn Willden9d645a02014-06-12 13:48:46 -060027
Shawn Willden9d645a02014-06-12 13:48:46 -060028/**
29 * Authorization tags each have an associated type. This enumeration facilitates tagging each with
30 * a type, by using the high four bits (of an implied 32-bit unsigned enum value) to specify up to
31 * 16 data types. These values are ORed with tag IDs to generate the final tag ID values.
32 */
33typedef enum {
34 KM_INVALID = 0 << 28, /* Invalid type, used to designate a tag as uninitialized */
35 KM_ENUM = 1 << 28,
36 KM_ENUM_REP = 2 << 28, /* Repeatable enumeration value. */
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +000037 KM_UINT = 3 << 28,
38 KM_UINT_REP = 4 << 28, /* Repeatable integer value */
39 KM_ULONG = 5 << 28,
Shawn Willden9d645a02014-06-12 13:48:46 -060040 KM_DATE = 6 << 28,
41 KM_BOOL = 7 << 28,
42 KM_BIGNUM = 8 << 28,
43 KM_BYTES = 9 << 28,
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +000044 KM_ULONG_REP = 10 << 28, /* Repeatable long value */
Shawn Willden9d645a02014-06-12 13:48:46 -060045} keymaster_tag_type_t;
46
47typedef enum {
48 KM_TAG_INVALID = KM_INVALID | 0,
49
50 /*
51 * Tags that must be semantically enforced by hardware and software implementations.
52 */
53
54 /* Crypto parameters */
Shawn Willdencf30fe12015-12-21 16:29:10 -070055 KM_TAG_PURPOSE = KM_ENUM_REP | 1, /* keymaster_purpose_t. */
56 KM_TAG_ALGORITHM = KM_ENUM | 2, /* keymaster_algorithm_t. */
57 KM_TAG_KEY_SIZE = KM_UINT | 3, /* Key size in bits. */
58 KM_TAG_BLOCK_MODE = KM_ENUM_REP | 4, /* keymaster_block_mode_t. */
59 KM_TAG_DIGEST = KM_ENUM_REP | 5, /* keymaster_digest_t. */
60 KM_TAG_PADDING = KM_ENUM_REP | 6, /* keymaster_padding_t. */
61 KM_TAG_CALLER_NONCE = KM_BOOL | 7, /* Allow caller to specify nonce or IV. */
62 KM_TAG_MIN_MAC_LENGTH = KM_UINT | 8, /* Minimum length of MAC or AEAD authentication tag in
63 * bits. */
64 KM_TAG_KDF = KM_ENUM_REP | 9, /* keymaster_kdf_t (keymaster2) */
65 KM_TAG_EC_CURVE = KM_ENUM | 10, /* keymaster_ec_curve_t (keymaster2) */
Shawn Willden9d645a02014-06-12 13:48:46 -060066
Shawn Willden9d645a02014-06-12 13:48:46 -060067 /* Algorithm-specific. */
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +000068 KM_TAG_RSA_PUBLIC_EXPONENT = KM_ULONG | 200,
Thai Duong40d59c82015-04-02 21:41:37 -070069 KM_TAG_ECIES_SINGLE_HASH_MODE = KM_BOOL | 201, /* Whether the ephemeral public key is fed into
Shawn Willdencf30fe12015-12-21 16:29:10 -070070 * the KDF */
71 KM_TAG_INCLUDE_UNIQUE_ID = KM_BOOL | 202, /* If true, attestation certificates for this key
72 * will contain an application-scoped and
73 * time-bounded device-unique ID. (keymaster2) */
Shawn Willden9d645a02014-06-12 13:48:46 -060074
Shawn Willdenfb769fc2015-05-11 09:24:48 -060075 /* Other hardware-enforced. */
76 KM_TAG_BLOB_USAGE_REQUIREMENTS = KM_ENUM | 301, /* keymaster_key_blob_usage_requirements_t */
77 KM_TAG_BOOTLOADER_ONLY = KM_BOOL | 302, /* Usable only by bootloader */
78
Shawn Willden9d645a02014-06-12 13:48:46 -060079 /*
80 * Tags that should be semantically enforced by hardware if possible and will otherwise be
81 * enforced by software (keystore).
82 */
83
84 /* Key validity period */
85 KM_TAG_ACTIVE_DATETIME = KM_DATE | 400, /* Start of validity */
86 KM_TAG_ORIGINATION_EXPIRE_DATETIME = KM_DATE | 401, /* Date when new "messages" should no
87 longer be created. */
88 KM_TAG_USAGE_EXPIRE_DATETIME = KM_DATE | 402, /* Date when existing "messages" should no
89 longer be trusted. */
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +000090 KM_TAG_MIN_SECONDS_BETWEEN_OPS = KM_UINT | 403, /* Minimum elapsed time between
Shawn Willden9d645a02014-06-12 13:48:46 -060091 cryptographic operations with the key. */
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +000092 KM_TAG_MAX_USES_PER_BOOT = KM_UINT | 404, /* Number of times the key can be used per
Shawn Willdendc0007b2015-01-23 01:01:21 -070093 boot. */
Shawn Willden9d645a02014-06-12 13:48:46 -060094
95 /* User authentication */
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +000096 KM_TAG_ALL_USERS = KM_BOOL | 500, /* Reserved for future use -- ignore */
97 KM_TAG_USER_ID = KM_UINT | 501, /* Reserved for future use -- ignore */
98 KM_TAG_USER_SECURE_ID = KM_ULONG_REP | 502, /* Secure ID of authorized user or authenticator(s).
99 Disallowed if KM_TAG_ALL_USERS or
100 KM_TAG_NO_AUTH_REQUIRED is present. */
101 KM_TAG_NO_AUTH_REQUIRED = KM_BOOL | 503, /* If key is usable without authentication. */
102 KM_TAG_USER_AUTH_TYPE = KM_ENUM | 504, /* Bitmask of authenticator types allowed when
103 * KM_TAG_USER_SECURE_ID contains a secure user ID,
104 * rather than a secure authenticator ID. Defined in
105 * hw_authenticator_type_t in hw_auth_token.h. */
106 KM_TAG_AUTH_TIMEOUT = KM_UINT | 505, /* Required freshness of user authentication for
107 private/secret key operations, in seconds.
108 Public key operations require no authentication.
109 If absent, authentication is required for every
110 use. Authentication state is lost when the
111 device is powered off. */
Shawn Willden71ca0102016-01-26 07:00:27 -0700112 KM_TAG_ALLOW_WHILE_ON_BODY = KM_BOOL | 506, /* Allow key to be used after authentication timeout
113 * if device is still on-body (requires secure
114 * on-body sensor. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600115
116 /* Application access control */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700117 KM_TAG_ALL_APPLICATIONS = KM_BOOL | 600, /* Specified to indicate key is usable by all
118 * applications. */
119 KM_TAG_APPLICATION_ID = KM_BYTES | 601, /* Byte string identifying the authorized
120 * application. */
121 KM_TAG_EXPORTABLE = KM_BOOL | 602, /* If true, private/secret key can be exported, but
122 * only if all access control requirements for use are
123 * met. (keymaster2) */
Shawn Willden9d645a02014-06-12 13:48:46 -0600124
125 /*
126 * Semantically unenforceable tags, either because they have no specific meaning or because
127 * they're informational only.
128 */
Shawn Willden7fd11182016-02-03 07:39:40 -0700129 KM_TAG_APPLICATION_DATA = KM_BYTES | 700, /* Data provided by authorized application. */
130 KM_TAG_CREATION_DATETIME = KM_DATE | 701, /* Key creation time */
131 KM_TAG_ORIGIN = KM_ENUM | 702, /* keymaster_key_origin_t. */
132 KM_TAG_ROLLBACK_RESISTANT = KM_BOOL | 703, /* Whether key is rollback-resistant. */
133 KM_TAG_ROOT_OF_TRUST = KM_BYTES | 704, /* Root of trust ID. */
134 KM_TAG_OS_VERSION = KM_UINT | 705, /* Version of system (keymaster2) */
135 KM_TAG_OS_PATCHLEVEL = KM_UINT | 706, /* Patch level of system (keymaster2) */
136 KM_TAG_UNIQUE_ID = KM_BYTES | 707, /* Used to provide unique ID in attestation */
137 KM_TAG_ATTESTATION_CHALLENGE = KM_BYTES | 708, /* Used to provide challenge in attestation */
Janis Danisevskisb62995e2016-05-20 18:11:41 +0100138 KM_TAG_ATTESTATION_APPLICATION_ID = KM_BYTES | 709, /* Used to identify the set of possible
139 * applications of which one has initiated
140 * a key attestation */
Bartosz Fabianowski9d2f5b92017-01-23 15:36:42 +0100141 KM_TAG_ATTESTATION_ID_BRAND = KM_BYTES | 710, /* Used to provide the device's brand name to be
142 included in attestation */
143 KM_TAG_ATTESTATION_ID_DEVICE = KM_BYTES | 711, /* Used to provide the device's device name to be
144 included in attestation */
145 KM_TAG_ATTESTATION_ID_PRODUCT = KM_BYTES | 712, /* Used to provide the device's product name to
146 be included in attestation */
147 KM_TAG_ATTESTATION_ID_SERIAL = KM_BYTES | 713, /* Used to provide the device's serial number to
148 be included in attestation */
149 KM_TAG_ATTESTATION_ID_IMEI = KM_BYTES | 714, /* Used to provide the device's IMEI to be
150 included in attestation */
151 KM_TAG_ATTESTATION_ID_MEID = KM_BYTES | 715, /* Used to provide the device's MEID to be
152 included in attestation */
Shawn Willden9d645a02014-06-12 13:48:46 -0600153
Shawn Willden67ba9e82015-02-06 17:04:53 -0700154 /* Tags used only to provide data to or receive data from operations */
155 KM_TAG_ASSOCIATED_DATA = KM_BYTES | 1000, /* Used to provide associated data for AEAD modes. */
Shawn Willden41e91e92015-01-30 06:23:26 -0700156 KM_TAG_NONCE = KM_BYTES | 1001, /* Nonce or Initialization Vector */
Shawn Willdenda89dde2015-06-18 12:09:20 -0600157 KM_TAG_AUTH_TOKEN = KM_BYTES | 1002, /* Authentication token that proves secure user
Shawn Willdenc3ab05c2015-03-14 08:23:41 -0600158 authentication has been performed. Structure
159 defined in hw_auth_token_t in hw_auth_token.h. */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700160 KM_TAG_MAC_LENGTH = KM_UINT | 1003, /* MAC or AEAD authentication tag length in
161 * bits. */
162
163 KM_TAG_RESET_SINCE_ID_ROTATION = KM_BOOL | 1004, /* Whether the device has beeen factory reset
164 since the last unique ID rotation. Used for
165 key attestation. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600166} keymaster_tag_t;
167
168/**
169 * Algorithms that may be provided by keymaster implementations. Those that must be provided by all
Shawn Willdenfd4b4d52015-02-24 09:17:38 -0700170 * implementations are tagged as "required".
Shawn Willden9d645a02014-06-12 13:48:46 -0600171 */
172typedef enum {
173 /* Asymmetric algorithms. */
Shawn Willdene9797a72015-04-07 13:39:12 -0600174 KM_ALGORITHM_RSA = 1,
175 // KM_ALGORITHM_DSA = 2, -- Removed, do not re-use value 2.
176 KM_ALGORITHM_EC = 3,
177
178 /* Block ciphers algorithms */
179 KM_ALGORITHM_AES = 32,
180
Shawn Willden9d645a02014-06-12 13:48:46 -0600181 /* MAC algorithms */
Shawn Willdene9797a72015-04-07 13:39:12 -0600182 KM_ALGORITHM_HMAC = 128,
Shawn Willden9d645a02014-06-12 13:48:46 -0600183} keymaster_algorithm_t;
184
185/**
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600186 * Symmetric block cipher modes provided by keymaster implementations.
Shawn Willden9d645a02014-06-12 13:48:46 -0600187 */
188typedef enum {
189 /* Unauthenticated modes, usable only for encryption/decryption and not generally recommended
190 * except for compatibility with existing other protocols. */
Shawn Willden4c19a3a2015-06-01 11:40:24 -0600191 KM_MODE_ECB = 1,
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600192 KM_MODE_CBC = 2,
Shawn Willden4c19a3a2015-06-01 11:40:24 -0600193 KM_MODE_CTR = 3,
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600194
Shawn Willden9d645a02014-06-12 13:48:46 -0600195 /* Authenticated modes, usable for encryption/decryption and signing/verification. Recommended
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600196 * over unauthenticated modes for all purposes. */
Shawn Willden4c19a3a2015-06-01 11:40:24 -0600197 KM_MODE_GCM = 32,
Shawn Willden9d645a02014-06-12 13:48:46 -0600198} keymaster_block_mode_t;
199
200/**
201 * Padding modes that may be applied to plaintext for encryption operations. This list includes
202 * padding modes for both symmetric and asymmetric algorithms. Note that implementations should not
203 * provide all possible combinations of algorithm and padding, only the
204 * cryptographically-appropriate pairs.
205 */
206typedef enum {
Shawn Willden8412fdc2015-04-07 13:41:30 -0600207 KM_PAD_NONE = 1, /* deprecated */
208 KM_PAD_RSA_OAEP = 2,
209 KM_PAD_RSA_PSS = 3,
Shawn Willden9d645a02014-06-12 13:48:46 -0600210 KM_PAD_RSA_PKCS1_1_5_ENCRYPT = 4,
211 KM_PAD_RSA_PKCS1_1_5_SIGN = 5,
Shawn Willden8412fdc2015-04-07 13:41:30 -0600212 KM_PAD_PKCS7 = 64,
Shawn Willden9d645a02014-06-12 13:48:46 -0600213} keymaster_padding_t;
214
215/**
Shawn Willdenfe6c4f02015-04-07 14:02:28 -0600216 * Digests provided by keymaster implementations.
Shawn Willden9d645a02014-06-12 13:48:46 -0600217 */
218typedef enum {
Shawn Willdenfe6c4f02015-04-07 14:02:28 -0600219 KM_DIGEST_NONE = 0,
220 KM_DIGEST_MD5 = 1, /* Optional, may not be implemented in hardware, will be handled in software
221 * if needed. */
222 KM_DIGEST_SHA1 = 2,
223 KM_DIGEST_SHA_2_224 = 3,
224 KM_DIGEST_SHA_2_256 = 4,
225 KM_DIGEST_SHA_2_384 = 5,
226 KM_DIGEST_SHA_2_512 = 6,
Shawn Willden9d645a02014-06-12 13:48:46 -0600227} keymaster_digest_t;
228
Thai Duong40d59c82015-04-02 21:41:37 -0700229/*
230 * Key derivation functions, mostly used in ECIES.
231 */
232typedef enum {
Shawn Willdencf30fe12015-12-21 16:29:10 -0700233 /* Do not apply a key derivation function; use the raw agreed key */
234 KM_KDF_NONE = 0,
Thai Duong40d59c82015-04-02 21:41:37 -0700235 /* HKDF defined in RFC 5869 with SHA256 */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700236 KM_KDF_RFC5869_SHA256 = 1,
Thai Duong40d59c82015-04-02 21:41:37 -0700237 /* KDF1 defined in ISO 18033-2 with SHA1 */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700238 KM_KDF_ISO18033_2_KDF1_SHA1 = 2,
Thai Duong40d59c82015-04-02 21:41:37 -0700239 /* KDF1 defined in ISO 18033-2 with SHA256 */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700240 KM_KDF_ISO18033_2_KDF1_SHA256 = 3,
Thai Duong40d59c82015-04-02 21:41:37 -0700241 /* KDF2 defined in ISO 18033-2 with SHA1 */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700242 KM_KDF_ISO18033_2_KDF2_SHA1 = 4,
Thai Duong40d59c82015-04-02 21:41:37 -0700243 /* KDF2 defined in ISO 18033-2 with SHA256 */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700244 KM_KDF_ISO18033_2_KDF2_SHA256 = 5,
Thai Duong40d59c82015-04-02 21:41:37 -0700245} keymaster_kdf_t;
246
247/**
248 * Supported EC curves, used in ECDSA/ECIES.
249 */
250typedef enum {
251 KM_EC_CURVE_P_224 = 0,
252 KM_EC_CURVE_P_256 = 1,
253 KM_EC_CURVE_P_384 = 2,
254 KM_EC_CURVE_P_521 = 3,
255} keymaster_ec_curve_t;
256
Shawn Willden9d645a02014-06-12 13:48:46 -0600257/**
Shawn Willden8d6cf252015-04-07 13:56:30 -0600258 * The origin of a key (or pair), i.e. where it was generated. Note that KM_TAG_ORIGIN can be found
259 * in either the hardware-enforced or software-enforced list for a key, indicating whether the key
260 * is hardware or software-based. Specifically, a key with KM_ORIGIN_GENERATED in the
261 * hardware-enforced list is guaranteed never to have existed outide the secure hardware.
Shawn Willden9d645a02014-06-12 13:48:46 -0600262 */
263typedef enum {
Shawn Willdencf30fe12015-12-21 16:29:10 -0700264 KM_ORIGIN_GENERATED = 0, /* Generated in keymaster. Should not exist outside the TEE. */
265 KM_ORIGIN_DERIVED = 1, /* Derived inside keymaster. Likely exists off-device. */
266 KM_ORIGIN_IMPORTED = 2, /* Imported into keymaster. Existed as cleartext in Android. */
Shawn Willdend359b042015-04-13 11:07:24 -0600267 KM_ORIGIN_UNKNOWN = 3, /* Keymaster did not record origin. This value can only be seen on
268 * keys in a keymaster0 implementation. The keymaster0 adapter uses
269 * this value to document the fact that it is unkown whether the key
270 * was generated inside or imported into keymaster. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600271} keymaster_key_origin_t;
272
273/**
274 * Usability requirements of key blobs. This defines what system functionality must be available
275 * for the key to function. For example, key "blobs" which are actually handles referencing
276 * encrypted key material stored in the file system cannot be used until the file system is
277 * available, and should have BLOB_REQUIRES_FILE_SYSTEM. Other requirements entries will be added
Shawn Willdencf30fe12015-12-21 16:29:10 -0700278 * as needed for implementations.
Shawn Willden9d645a02014-06-12 13:48:46 -0600279 */
280typedef enum {
281 KM_BLOB_STANDALONE = 0,
282 KM_BLOB_REQUIRES_FILE_SYSTEM = 1,
283} keymaster_key_blob_usage_requirements_t;
284
285/**
Shawn Willdencf30fe12015-12-21 16:29:10 -0700286 * Possible purposes of a key (or pair).
Shawn Willden9d645a02014-06-12 13:48:46 -0600287 */
288typedef enum {
Shawn Willdencf30fe12015-12-21 16:29:10 -0700289 KM_PURPOSE_ENCRYPT = 0, /* Usable with RSA, EC and AES keys. */
290 KM_PURPOSE_DECRYPT = 1, /* Usable with RSA, EC and AES keys. */
291 KM_PURPOSE_SIGN = 2, /* Usable with RSA, EC and HMAC keys. */
292 KM_PURPOSE_VERIFY = 3, /* Usable with RSA, EC and HMAC keys. */
293 KM_PURPOSE_DERIVE_KEY = 4, /* Usable with EC keys. */
Crystal Qinee2f29d2017-01-03 16:54:26 -0800294 KM_PURPOSE_WRAP_KEY = 5, /* Usable with wrapping keys. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600295} keymaster_purpose_t;
296
297typedef struct {
298 const uint8_t* data;
299 size_t data_length;
300} keymaster_blob_t;
301
302typedef struct {
303 keymaster_tag_t tag;
304 union {
305 uint32_t enumerated; /* KM_ENUM and KM_ENUM_REP */
306 bool boolean; /* KM_BOOL */
307 uint32_t integer; /* KM_INT and KM_INT_REP */
308 uint64_t long_integer; /* KM_LONG */
309 uint64_t date_time; /* KM_DATE */
310 keymaster_blob_t blob; /* KM_BIGNUM and KM_BYTES*/
311 };
312} keymaster_key_param_t;
313
314typedef struct {
315 keymaster_key_param_t* params; /* may be NULL if length == 0 */
316 size_t length;
317} keymaster_key_param_set_t;
318
319/**
320 * Parameters that define a key's characteristics, including authorized modes of usage and access
321 * control restrictions. The parameters are divided into two categories, those that are enforced by
322 * secure hardware, and those that are not. For a software-only keymaster implementation the
323 * enforced array must NULL. Hardware implementations must enforce everything in the enforced
324 * array.
325 */
326typedef struct {
327 keymaster_key_param_set_t hw_enforced;
328 keymaster_key_param_set_t sw_enforced;
329} keymaster_key_characteristics_t;
330
331typedef struct {
332 const uint8_t* key_material;
333 size_t key_material_size;
334} keymaster_key_blob_t;
335
Shawn Willdencf30fe12015-12-21 16:29:10 -0700336typedef struct {
337 keymaster_blob_t* entries;
338 size_t entry_count;
339} keymaster_cert_chain_t;
340
Shawn Willden30802762016-03-09 19:42:47 -0700341typedef enum {
342 KM_VERIFIED_BOOT_VERIFIED = 0, /* Full chain of trust extending from the bootloader to
343 * verified partitions, including the bootloader, boot
344 * partition, and all verified partitions*/
345 KM_VERIFIED_BOOT_SELF_SIGNED = 1, /* The boot partition has been verified using the embedded
346 * certificate, and the signature is valid. The bootloader
347 * displays a warning and the fingerprint of the public
348 * key before allowing the boot process to continue.*/
349 KM_VERIFIED_BOOT_UNVERIFIED = 2, /* The device may be freely modified. Device integrity is left
350 * to the user to verify out-of-band. The bootloader
351 * displays a warning to the user before allowing the boot
352 * process to continue */
353 KM_VERIFIED_BOOT_FAILED = 3, /* The device failed verification. The bootloader displays a
354 * warning and stops the boot process, so no keymaster
355 * implementation should ever actually return this value,
356 * since it should not run. Included here only for
357 * completeness. */
358} keymaster_verified_boot_t;
359
Shawn Willdenaeb15d62016-03-19 08:56:43 -0600360typedef enum {
361 KM_SECURITY_LEVEL_SOFTWARE = 0,
362 KM_SECURITY_LEVEL_TRUSTED_ENVIRONMENT = 1,
363} keymaster_security_level_t;
364
Shawn Willden9d645a02014-06-12 13:48:46 -0600365/**
Shawn Willdencf30fe12015-12-21 16:29:10 -0700366 * Formats for key import and export.
Shawn Willden9d645a02014-06-12 13:48:46 -0600367 */
368typedef enum {
Shawn Willdenfb769fc2015-05-11 09:24:48 -0600369 KM_KEY_FORMAT_X509 = 0, /* for public key export */
370 KM_KEY_FORMAT_PKCS8 = 1, /* for asymmetric key pair import */
Shawn Willdencf30fe12015-12-21 16:29:10 -0700371 KM_KEY_FORMAT_RAW = 3, /* for symmetric key import and export*/
Shawn Willden9d645a02014-06-12 13:48:46 -0600372} keymaster_key_format_t;
373
374/**
375 * The keymaster operation API consists of begin, update, finish and abort. This is the type of the
376 * handle used to tie the sequence of calls together. A 64-bit value is used because it's important
377 * that handles not be predictable. Implementations must use strong random numbers for handle
378 * values.
379 */
380typedef uint64_t keymaster_operation_handle_t;
381
382typedef enum {
383 KM_ERROR_OK = 0,
384 KM_ERROR_ROOT_OF_TRUST_ALREADY_SET = -1,
385 KM_ERROR_UNSUPPORTED_PURPOSE = -2,
386 KM_ERROR_INCOMPATIBLE_PURPOSE = -3,
387 KM_ERROR_UNSUPPORTED_ALGORITHM = -4,
388 KM_ERROR_INCOMPATIBLE_ALGORITHM = -5,
389 KM_ERROR_UNSUPPORTED_KEY_SIZE = -6,
390 KM_ERROR_UNSUPPORTED_BLOCK_MODE = -7,
391 KM_ERROR_INCOMPATIBLE_BLOCK_MODE = -8,
Shawn Willden6b424be2015-01-26 13:04:28 -0700392 KM_ERROR_UNSUPPORTED_MAC_LENGTH = -9,
Shawn Willden9d645a02014-06-12 13:48:46 -0600393 KM_ERROR_UNSUPPORTED_PADDING_MODE = -10,
394 KM_ERROR_INCOMPATIBLE_PADDING_MODE = -11,
395 KM_ERROR_UNSUPPORTED_DIGEST = -12,
396 KM_ERROR_INCOMPATIBLE_DIGEST = -13,
397 KM_ERROR_INVALID_EXPIRATION_TIME = -14,
398 KM_ERROR_INVALID_USER_ID = -15,
399 KM_ERROR_INVALID_AUTHORIZATION_TIMEOUT = -16,
400 KM_ERROR_UNSUPPORTED_KEY_FORMAT = -17,
401 KM_ERROR_INCOMPATIBLE_KEY_FORMAT = -18,
402 KM_ERROR_UNSUPPORTED_KEY_ENCRYPTION_ALGORITHM = -19, /* For PKCS8 & PKCS12 */
403 KM_ERROR_UNSUPPORTED_KEY_VERIFICATION_ALGORITHM = -20, /* For PKCS8 & PKCS12 */
404 KM_ERROR_INVALID_INPUT_LENGTH = -21,
405 KM_ERROR_KEY_EXPORT_OPTIONS_INVALID = -22,
406 KM_ERROR_DELEGATION_NOT_ALLOWED = -23,
407 KM_ERROR_KEY_NOT_YET_VALID = -24,
408 KM_ERROR_KEY_EXPIRED = -25,
409 KM_ERROR_KEY_USER_NOT_AUTHENTICATED = -26,
410 KM_ERROR_OUTPUT_PARAMETER_NULL = -27,
411 KM_ERROR_INVALID_OPERATION_HANDLE = -28,
412 KM_ERROR_INSUFFICIENT_BUFFER_SPACE = -29,
413 KM_ERROR_VERIFICATION_FAILED = -30,
414 KM_ERROR_TOO_MANY_OPERATIONS = -31,
415 KM_ERROR_UNEXPECTED_NULL_POINTER = -32,
416 KM_ERROR_INVALID_KEY_BLOB = -33,
417 KM_ERROR_IMPORTED_KEY_NOT_ENCRYPTED = -34,
418 KM_ERROR_IMPORTED_KEY_DECRYPTION_FAILED = -35,
419 KM_ERROR_IMPORTED_KEY_NOT_SIGNED = -36,
420 KM_ERROR_IMPORTED_KEY_VERIFICATION_FAILED = -37,
421 KM_ERROR_INVALID_ARGUMENT = -38,
422 KM_ERROR_UNSUPPORTED_TAG = -39,
423 KM_ERROR_INVALID_TAG = -40,
424 KM_ERROR_MEMORY_ALLOCATION_FAILED = -41,
Shawn Willden9d645a02014-06-12 13:48:46 -0600425 KM_ERROR_IMPORT_PARAMETER_MISMATCH = -44,
426 KM_ERROR_SECURE_HW_ACCESS_DENIED = -45,
427 KM_ERROR_OPERATION_CANCELLED = -46,
428 KM_ERROR_CONCURRENT_ACCESS_CONFLICT = -47,
429 KM_ERROR_SECURE_HW_BUSY = -48,
430 KM_ERROR_SECURE_HW_COMMUNICATION_FAILED = -49,
431 KM_ERROR_UNSUPPORTED_EC_FIELD = -50,
Shawn Willdened941112015-03-11 21:53:59 -0600432 KM_ERROR_MISSING_NONCE = -51,
433 KM_ERROR_INVALID_NONCE = -52,
Shawn Willden4144c642015-06-01 11:40:34 -0600434 KM_ERROR_MISSING_MAC_LENGTH = -53,
Shawn Willden396d6cb2015-06-18 12:16:17 -0600435 KM_ERROR_KEY_RATE_LIMIT_EXCEEDED = -54,
Shawn Willden4bdd7cb2015-04-28 00:00:27 -0600436 KM_ERROR_CALLER_NONCE_PROHIBITED = -55,
Shawn Willden396d6cb2015-06-18 12:16:17 -0600437 KM_ERROR_KEY_MAX_OPS_EXCEEDED = -56,
Shawn Willdena3f0ab52015-07-08 06:04:52 -0600438 KM_ERROR_INVALID_MAC_LENGTH = -57,
439 KM_ERROR_MISSING_MIN_MAC_LENGTH = -58,
440 KM_ERROR_UNSUPPORTED_MIN_MAC_LENGTH = -59,
Thai Duong40d59c82015-04-02 21:41:37 -0700441 KM_ERROR_UNSUPPORTED_KDF = -60,
442 KM_ERROR_UNSUPPORTED_EC_CURVE = -61,
Shawn Willdencf30fe12015-12-21 16:29:10 -0700443 KM_ERROR_KEY_REQUIRES_UPGRADE = -62,
Shawn Willden7fd11182016-02-03 07:39:40 -0700444 KM_ERROR_ATTESTATION_CHALLENGE_MISSING = -63,
Shawn Willden30802762016-03-09 19:42:47 -0700445 KM_ERROR_KEYMASTER_NOT_CONFIGURED = -64,
Janis Danisevskis36966852016-06-01 13:39:09 -0700446 KM_ERROR_ATTESTATION_APPLICATION_ID_MISSING = -65,
Bartosz Fabianowski9d2f5b92017-01-23 15:36:42 +0100447 KM_ERROR_CANNOT_ATTEST_IDS = -66,
Shawn Willdened941112015-03-11 21:53:59 -0600448
Shawn Willden9d645a02014-06-12 13:48:46 -0600449 KM_ERROR_UNIMPLEMENTED = -100,
450 KM_ERROR_VERSION_MISMATCH = -101,
451
Shawn Willden9d645a02014-06-12 13:48:46 -0600452 KM_ERROR_UNKNOWN_ERROR = -1000,
453} keymaster_error_t;
454
Shawn Willden9d645a02014-06-12 13:48:46 -0600455/* Convenience functions for manipulating keymaster tag types */
456
457static inline keymaster_tag_type_t keymaster_tag_get_type(keymaster_tag_t tag) {
458 return (keymaster_tag_type_t)(tag & (0xF << 28));
459}
460
461static inline uint32_t keymaster_tag_mask_type(keymaster_tag_t tag) {
462 return tag & 0x0FFFFFFF;
463}
464
465static inline bool keymaster_tag_type_repeatable(keymaster_tag_type_t type) {
466 switch (type) {
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +0000467 case KM_UINT_REP:
Shawn Willden9d645a02014-06-12 13:48:46 -0600468 case KM_ENUM_REP:
469 return true;
470 default:
471 return false;
472 }
473}
474
475static inline bool keymaster_tag_repeatable(keymaster_tag_t tag) {
476 return keymaster_tag_type_repeatable(keymaster_tag_get_type(tag));
477}
478
479/* Convenience functions for manipulating keymaster_key_param_t structs */
480
481inline keymaster_key_param_t keymaster_param_enum(keymaster_tag_t tag, uint32_t value) {
482 // assert(keymaster_tag_get_type(tag) == KM_ENUM || keymaster_tag_get_type(tag) == KM_ENUM_REP);
483 keymaster_key_param_t param;
484 memset(&param, 0, sizeof(param));
485 param.tag = tag;
486 param.enumerated = value;
487 return param;
488}
489
490inline keymaster_key_param_t keymaster_param_int(keymaster_tag_t tag, uint32_t value) {
491 // assert(keymaster_tag_get_type(tag) == KM_INT || keymaster_tag_get_type(tag) == KM_INT_REP);
492 keymaster_key_param_t param;
493 memset(&param, 0, sizeof(param));
494 param.tag = tag;
495 param.integer = value;
496 return param;
497}
498
499inline keymaster_key_param_t keymaster_param_long(keymaster_tag_t tag, uint64_t value) {
500 // assert(keymaster_tag_get_type(tag) == KM_LONG);
501 keymaster_key_param_t param;
502 memset(&param, 0, sizeof(param));
503 param.tag = tag;
504 param.long_integer = value;
505 return param;
506}
507
508inline keymaster_key_param_t keymaster_param_blob(keymaster_tag_t tag, const uint8_t* bytes,
509 size_t bytes_len) {
510 // assert(keymaster_tag_get_type(tag) == KM_BYTES || keymaster_tag_get_type(tag) == KM_BIGNUM);
511 keymaster_key_param_t param;
512 memset(&param, 0, sizeof(param));
513 param.tag = tag;
514 param.blob.data = (uint8_t*)bytes;
515 param.blob.data_length = bytes_len;
516 return param;
517}
518
519inline keymaster_key_param_t keymaster_param_bool(keymaster_tag_t tag) {
520 // assert(keymaster_tag_get_type(tag) == KM_BOOL);
521 keymaster_key_param_t param;
522 memset(&param, 0, sizeof(param));
523 param.tag = tag;
524 param.boolean = true;
525 return param;
526}
527
528inline keymaster_key_param_t keymaster_param_date(keymaster_tag_t tag, uint64_t value) {
529 // assert(keymaster_tag_get_type(tag) == KM_DATE);
530 keymaster_key_param_t param;
531 memset(&param, 0, sizeof(param));
532 param.tag = tag;
533 param.date_time = value;
534 return param;
535}
536
Shawn Willden67411d62015-03-04 10:00:38 -0700537#define KEYMASTER_SIMPLE_COMPARE(a, b) (a < b) ? -1 : ((a > b) ? 1 : 0)
538inline int keymaster_param_compare(const keymaster_key_param_t* a, const keymaster_key_param_t* b) {
Tucker Sylvestro28a872e2016-10-05 14:39:39 -0400539 int retval = KEYMASTER_SIMPLE_COMPARE((uint32_t)a->tag, (uint32_t)b->tag);
Shawn Willden67411d62015-03-04 10:00:38 -0700540 if (retval != 0)
541 return retval;
542
543 switch (keymaster_tag_get_type(a->tag)) {
544 case KM_INVALID:
545 case KM_BOOL:
546 return 0;
547 case KM_ENUM:
548 case KM_ENUM_REP:
549 return KEYMASTER_SIMPLE_COMPARE(a->enumerated, b->enumerated);
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +0000550 case KM_UINT:
551 case KM_UINT_REP:
Shawn Willden67411d62015-03-04 10:00:38 -0700552 return KEYMASTER_SIMPLE_COMPARE(a->integer, b->integer);
Shawn Willdenfe6bcfa2015-06-24 20:59:14 +0000553 case KM_ULONG:
554 case KM_ULONG_REP:
Shawn Willden67411d62015-03-04 10:00:38 -0700555 return KEYMASTER_SIMPLE_COMPARE(a->long_integer, b->long_integer);
556 case KM_DATE:
557 return KEYMASTER_SIMPLE_COMPARE(a->date_time, b->date_time);
558 case KM_BIGNUM:
559 case KM_BYTES:
560 // Handle the empty cases.
561 if (a->blob.data_length != 0 && b->blob.data_length == 0)
562 return -1;
563 if (a->blob.data_length == 0 && b->blob.data_length == 0)
564 return 0;
565 if (a->blob.data_length == 0 && b->blob.data_length > 0)
566 return 1;
567
568 retval = memcmp(a->blob.data, b->blob.data, a->blob.data_length < b->blob.data_length
569 ? a->blob.data_length
570 : b->blob.data_length);
571 if (retval != 0)
572 return retval;
573 else if (a->blob.data_length != b->blob.data_length) {
574 // Equal up to the common length; longer one is larger.
575 if (a->blob.data_length < b->blob.data_length)
576 return -1;
577 if (a->blob.data_length > b->blob.data_length)
578 return 1;
579 };
580 }
581
582 return 0;
583}
584#undef KEYMASTER_SIMPLE_COMPARE
585
Shawn Willden9d645a02014-06-12 13:48:46 -0600586inline void keymaster_free_param_values(keymaster_key_param_t* param, size_t param_count) {
Chad Brubakera3c0ae12015-08-12 12:46:44 -0700587 while (param_count > 0) {
588 param_count--;
Shawn Willden9d645a02014-06-12 13:48:46 -0600589 switch (keymaster_tag_get_type(param->tag)) {
590 case KM_BIGNUM:
591 case KM_BYTES:
592 free((void*)param->blob.data);
593 param->blob.data = NULL;
594 break;
595 default:
596 // NOP
597 break;
598 }
599 ++param;
600 }
601}
602
603inline void keymaster_free_param_set(keymaster_key_param_set_t* set) {
604 if (set) {
605 keymaster_free_param_values(set->params, set->length);
606 free(set->params);
607 set->params = NULL;
Shawn Willdene366efd2016-03-20 09:07:50 -0600608 set->length = 0;
Shawn Willden9d645a02014-06-12 13:48:46 -0600609 }
610}
611
612inline void keymaster_free_characteristics(keymaster_key_characteristics_t* characteristics) {
613 if (characteristics) {
614 keymaster_free_param_set(&characteristics->hw_enforced);
615 keymaster_free_param_set(&characteristics->sw_enforced);
616 }
617}
618
Shawn Willdencf30fe12015-12-21 16:29:10 -0700619inline void keymaster_free_cert_chain(keymaster_cert_chain_t* chain) {
620 if (chain) {
621 for (size_t i = 0; i < chain->entry_count; ++i) {
622 free((uint8_t*)chain->entries[i].data);
623 chain->entries[i].data = NULL;
624 chain->entries[i].data_length = 0;
625 }
626 free(chain->entries);
627 chain->entries = NULL;
628 chain->entry_count = 0;
629 }
630}
631
Shawn Willden7eaa15f2015-06-03 09:03:20 -0600632#ifdef __cplusplus
Shawn Willdenc51d01e2015-03-18 18:59:52 -0600633} // extern "C"
634#endif // __cplusplus
Shawn Willden9d645a02014-06-12 13:48:46 -0600635
636#endif // ANDROID_HARDWARE_KEYMASTER_DEFS_H