blob: 97a3f09cb58219921a261948ad0a6a557c885dec [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 Willdenc51d01e2015-03-18 18:59:52 -060024#ifndef __cplusplus
25extern "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. */
37 KM_INT = 3 << 28,
38 KM_INT_REP = 4 << 28, /* Repeatable integer value */
39 KM_LONG = 5 << 28,
40 KM_DATE = 6 << 28,
41 KM_BOOL = 7 << 28,
42 KM_BIGNUM = 8 << 28,
43 KM_BYTES = 9 << 28,
Shawn Willden4719aca2015-03-14 07:54:52 -060044 KM_LONG_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 Willden79d79342015-02-10 14:29:46 -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_INT | 3, /* Key size in bits. */
58 KM_TAG_BLOCK_MODE = KM_ENUM | 4, /* keymaster_block_mode_t. */
59 KM_TAG_DIGEST = KM_ENUM | 5, /* keymaster_digest_t. */
Alex Klyubin340d0b12015-02-20 16:42:23 -080060 KM_TAG_MAC_LENGTH = KM_INT | 6, /* MAC or AEAD authentication tag length in bits. */
Shawn Willden79d79342015-02-10 14:29:46 -070061 KM_TAG_PADDING = KM_ENUM | 7, /* keymaster_padding_t. */
62 KM_TAG_RETURN_UNAUTHED = KM_BOOL | 8, /* Allow AEAD decryption to return plaintext before it has
63 been authenticated. WARNING: Not recommended. */
64 KM_TAG_CALLER_NONCE = KM_BOOL | 9, /* Allow caller to specify nonce or IV. */
Shawn Willden9d645a02014-06-12 13:48:46 -060065
66 /* Other hardware-enforced. */
67 KM_TAG_RESCOPING_ADD = KM_ENUM_REP | 101, /* Tags authorized for addition via rescoping. */
68 KM_TAG_RESCOPING_DEL = KM_ENUM_REP | 102, /* Tags authorized for removal via rescoping. */
69 KM_TAG_BLOB_USAGE_REQUIREMENTS = KM_ENUM | 705, /* keymaster_key_blob_usage_requirements_t */
70
71 /* Algorithm-specific. */
72 KM_TAG_RSA_PUBLIC_EXPONENT = KM_LONG | 200, /* Defaults to 2^16+1 */
Shawn Willden9d645a02014-06-12 13:48:46 -060073
74 /*
75 * Tags that should be semantically enforced by hardware if possible and will otherwise be
76 * enforced by software (keystore).
77 */
78
79 /* Key validity period */
80 KM_TAG_ACTIVE_DATETIME = KM_DATE | 400, /* Start of validity */
81 KM_TAG_ORIGINATION_EXPIRE_DATETIME = KM_DATE | 401, /* Date when new "messages" should no
82 longer be created. */
83 KM_TAG_USAGE_EXPIRE_DATETIME = KM_DATE | 402, /* Date when existing "messages" should no
84 longer be trusted. */
85 KM_TAG_MIN_SECONDS_BETWEEN_OPS = KM_INT | 403, /* Minimum elapsed time between
86 cryptographic operations with the key. */
Shawn Willdendc0007b2015-01-23 01:01:21 -070087 KM_TAG_MAX_USES_PER_BOOT = KM_INT | 404, /* Number of times the key can be used per
88 boot. */
Shawn Willden9d645a02014-06-12 13:48:46 -060089
90 /* User authentication */
Shawn Willden4719aca2015-03-14 07:54:52 -060091 KM_TAG_ALL_USERS = KM_BOOL | 500, /* If key is usable by all users. */
92 KM_TAG_USER_ID = KM_INT | 501, /* ID of authorized user. Disallowed if
93 KM_TAG_ALL_USERS is present. */
94 KM_TAG_USER_SECURE_ID = KM_LONG_REP | 502, /* Secure ID of authorized user or authenticator(s).
95 Disallowed if KM_TAG_ALL_USERS or
96 KM_TAG_NO_AUTH_REQUIRED is present. */
97 KM_TAG_NO_AUTH_REQUIRED = KM_BOOL | 503, /* If key is usable without authentication. */
98 KM_TAG_USER_AUTH_TYPE = KM_ENUM | 504, /* Bitmask of authenticator types allowed when
99 * KM_TAG_USER_SECURE_ID contains a secure user ID,
100 * rather than a secure authenticator ID. Defined in
101 * hw_authenticator_type_t in hw_auth_token.h. */
102 KM_TAG_AUTH_TIMEOUT = KM_INT | 505, /* Required freshness of user authentication for
103 private/secret key operations, in seconds.
104 Public key operations require no authentication.
105 If absent, authentication is required for every
106 use. Authentication state is lost when the
107 device is powered off. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600108
109 /* Application access control */
110 KM_TAG_ALL_APPLICATIONS = KM_BOOL | 600, /* If key is usable by all applications. */
111 KM_TAG_APPLICATION_ID = KM_BYTES | 601, /* ID of authorized application. Disallowed if
112 KM_TAG_ALL_APPLICATIONS is present. */
113
114 /*
115 * Semantically unenforceable tags, either because they have no specific meaning or because
116 * they're informational only.
117 */
118 KM_TAG_APPLICATION_DATA = KM_BYTES | 700, /* Data provided by authorized application. */
119 KM_TAG_CREATION_DATETIME = KM_DATE | 701, /* Key creation time */
120 KM_TAG_ORIGIN = KM_ENUM | 702, /* keymaster_key_origin_t. */
121 KM_TAG_ROLLBACK_RESISTANT = KM_BOOL | 703, /* Whether key is rollback-resistant. */
122 KM_TAG_ROOT_OF_TRUST = KM_BYTES | 704, /* Root of trust ID. Empty array means usable by all
123 roots. */
124
Shawn Willden67ba9e82015-02-06 17:04:53 -0700125 /* Tags used only to provide data to or receive data from operations */
126 KM_TAG_ASSOCIATED_DATA = KM_BYTES | 1000, /* Used to provide associated data for AEAD modes. */
Shawn Willden41e91e92015-01-30 06:23:26 -0700127 KM_TAG_NONCE = KM_BYTES | 1001, /* Nonce or Initialization Vector */
Shawn Willden79d79342015-02-10 14:29:46 -0700128 KM_TAG_CHUNK_LENGTH = KM_INT | 1002, /* AEAD mode chunk size, in bytes. 0 means no limit,
129 which requires KM_TAG_RETURN_UNAUTHED. */
Shawn Willdenc3ab05c2015-03-14 08:23:41 -0600130 KM_TAG_AUTH_TOKEN = KM_BYTES | 1003, /* Authentication token that proves secure user
131 authentication has been performed. Structure
132 defined in hw_auth_token_t in hw_auth_token.h. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600133} keymaster_tag_t;
134
135/**
136 * Algorithms that may be provided by keymaster implementations. Those that must be provided by all
Shawn Willdenfd4b4d52015-02-24 09:17:38 -0700137 * implementations are tagged as "required".
Shawn Willden9d645a02014-06-12 13:48:46 -0600138 */
139typedef enum {
140 /* Asymmetric algorithms. */
Shawn Willdene9797a72015-04-07 13:39:12 -0600141 KM_ALGORITHM_RSA = 1,
142 // KM_ALGORITHM_DSA = 2, -- Removed, do not re-use value 2.
143 KM_ALGORITHM_EC = 3,
144
145 /* Block ciphers algorithms */
146 KM_ALGORITHM_AES = 32,
147
Shawn Willden9d645a02014-06-12 13:48:46 -0600148 /* MAC algorithms */
Shawn Willdene9797a72015-04-07 13:39:12 -0600149 KM_ALGORITHM_HMAC = 128,
Shawn Willden9d645a02014-06-12 13:48:46 -0600150} keymaster_algorithm_t;
151
152/**
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600153 * Symmetric block cipher modes provided by keymaster implementations.
Shawn Willden9d645a02014-06-12 13:48:46 -0600154 *
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600155 * KM_MODE_FIRST_UNAUTHENTICATED and KM_MODE_FIRST_AUTHENTICATED are not modes but markers used to
156 * separate the available modes into classes.
Shawn Willden9d645a02014-06-12 13:48:46 -0600157 */
158typedef enum {
159 /* Unauthenticated modes, usable only for encryption/decryption and not generally recommended
160 * except for compatibility with existing other protocols. */
161 KM_MODE_FIRST_UNAUTHENTICATED = 1,
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600162 KM_MODE_ECB = KM_MODE_FIRST_UNAUTHENTICATED,
163 KM_MODE_CBC = 2,
164 KM_MODE_CTR = 4,
165
Shawn Willden9d645a02014-06-12 13:48:46 -0600166 /* Authenticated modes, usable for encryption/decryption and signing/verification. Recommended
Shawn Willdenc7deeda2015-04-07 13:40:00 -0600167 * over unauthenticated modes for all purposes. */
Shawn Willden9d645a02014-06-12 13:48:46 -0600168 KM_MODE_FIRST_AUTHENTICATED = 32,
169 KM_MODE_GCM = KM_MODE_FIRST_AUTHENTICATED,
Shawn Willden9d645a02014-06-12 13:48:46 -0600170} keymaster_block_mode_t;
171
172/**
173 * Padding modes that may be applied to plaintext for encryption operations. This list includes
174 * padding modes for both symmetric and asymmetric algorithms. Note that implementations should not
175 * provide all possible combinations of algorithm and padding, only the
176 * cryptographically-appropriate pairs.
177 */
178typedef enum {
179 KM_PAD_NONE = 1, /* required, deprecated */
180 KM_PAD_RSA_OAEP = 2, /* required */
181 KM_PAD_RSA_PSS = 3, /* required */
182 KM_PAD_RSA_PKCS1_1_5_ENCRYPT = 4,
183 KM_PAD_RSA_PKCS1_1_5_SIGN = 5,
184 KM_PAD_ANSI_X923 = 32,
185 KM_PAD_ISO_10126 = 33,
186 KM_PAD_ZERO = 64, /* required */
187 KM_PAD_PKCS7 = 65, /* required */
188 KM_PAD_ISO_7816_4 = 66,
189} keymaster_padding_t;
190
191/**
192 * Digests that may be provided by keymaster implementations. Those that must be provided by all
193 * implementations are tagged as "required". Those that have been added since version 0_2 of the
194 * API are tagged as "new".
195 */
196typedef enum {
197 KM_DIGEST_NONE = 0, /* new, required */
Shawn Willden9d645a02014-06-12 13:48:46 -0600198 KM_DIGEST_MD5 = 1, /* new, for compatibility with old protocols only */
199 KM_DIGEST_SHA1 = 2, /* new */
200 KM_DIGEST_SHA_2_224 = 3, /* new */
201 KM_DIGEST_SHA_2_256 = 4, /* new, required */
202 KM_DIGEST_SHA_2_384 = 5, /* new, recommended */
203 KM_DIGEST_SHA_2_512 = 6, /* new, recommended */
204 KM_DIGEST_SHA_3_256 = 7, /* new */
205 KM_DIGEST_SHA_3_384 = 8, /* new */
206 KM_DIGEST_SHA_3_512 = 9, /* new */
207} keymaster_digest_t;
208
209/**
210 * The origin of a key (or pair), i.e. where it was generated. Origin and can be used together to
211 * determine whether a key may have existed outside of secure hardware. This type is new in 0_4.
212 */
213typedef enum {
214 KM_ORIGIN_HARDWARE = 0, /* Generated in secure hardware */
215 KM_ORIGIN_SOFTWARE = 1, /* Generated in non-secure software */
216 KM_ORIGIN_IMPORTED = 2, /* Imported, origin unknown */
217} keymaster_key_origin_t;
218
219/**
220 * Usability requirements of key blobs. This defines what system functionality must be available
221 * for the key to function. For example, key "blobs" which are actually handles referencing
222 * encrypted key material stored in the file system cannot be used until the file system is
223 * available, and should have BLOB_REQUIRES_FILE_SYSTEM. Other requirements entries will be added
224 * as needed for implementations. This type is new in 0_4.
225 */
226typedef enum {
227 KM_BLOB_STANDALONE = 0,
228 KM_BLOB_REQUIRES_FILE_SYSTEM = 1,
229} keymaster_key_blob_usage_requirements_t;
230
231/**
232 * Possible purposes of a key (or pair). This type is new in 0_4.
233 */
234typedef enum {
235 KM_PURPOSE_ENCRYPT = 0,
236 KM_PURPOSE_DECRYPT = 1,
237 KM_PURPOSE_SIGN = 2,
238 KM_PURPOSE_VERIFY = 3,
239} keymaster_purpose_t;
240
241typedef struct {
242 const uint8_t* data;
243 size_t data_length;
244} keymaster_blob_t;
245
246typedef struct {
247 keymaster_tag_t tag;
248 union {
249 uint32_t enumerated; /* KM_ENUM and KM_ENUM_REP */
250 bool boolean; /* KM_BOOL */
251 uint32_t integer; /* KM_INT and KM_INT_REP */
252 uint64_t long_integer; /* KM_LONG */
253 uint64_t date_time; /* KM_DATE */
254 keymaster_blob_t blob; /* KM_BIGNUM and KM_BYTES*/
255 };
256} keymaster_key_param_t;
257
258typedef struct {
259 keymaster_key_param_t* params; /* may be NULL if length == 0 */
260 size_t length;
261} keymaster_key_param_set_t;
262
263/**
264 * Parameters that define a key's characteristics, including authorized modes of usage and access
265 * control restrictions. The parameters are divided into two categories, those that are enforced by
266 * secure hardware, and those that are not. For a software-only keymaster implementation the
267 * enforced array must NULL. Hardware implementations must enforce everything in the enforced
268 * array.
269 */
270typedef struct {
271 keymaster_key_param_set_t hw_enforced;
272 keymaster_key_param_set_t sw_enforced;
273} keymaster_key_characteristics_t;
274
275typedef struct {
276 const uint8_t* key_material;
277 size_t key_material_size;
278} keymaster_key_blob_t;
279
280/**
281 * Formats for key import and export. At present, only asymmetric key import/export is supported.
282 * In the future this list will expand greatly to accommodate asymmetric key import/export.
283 */
284typedef enum {
Chad Brubakerf883b982015-02-13 13:58:36 -0800285 KM_KEY_FORMAT_X509 = 0, /* for public key export, required */
286 KM_KEY_FORMAT_PKCS8 = 1, /* for asymmetric key pair import, required */
287 KM_KEY_FORMAT_PKCS12 = 2, /* for asymmetric key pair import, not required */
288 KM_KEY_FORMAT_RAW = 3, /* for symmetric key import, required */
Shawn Willden9d645a02014-06-12 13:48:46 -0600289} keymaster_key_format_t;
290
291/**
292 * The keymaster operation API consists of begin, update, finish and abort. This is the type of the
293 * handle used to tie the sequence of calls together. A 64-bit value is used because it's important
294 * that handles not be predictable. Implementations must use strong random numbers for handle
295 * values.
296 */
297typedef uint64_t keymaster_operation_handle_t;
298
299typedef enum {
300 KM_ERROR_OK = 0,
301 KM_ERROR_ROOT_OF_TRUST_ALREADY_SET = -1,
302 KM_ERROR_UNSUPPORTED_PURPOSE = -2,
303 KM_ERROR_INCOMPATIBLE_PURPOSE = -3,
304 KM_ERROR_UNSUPPORTED_ALGORITHM = -4,
305 KM_ERROR_INCOMPATIBLE_ALGORITHM = -5,
306 KM_ERROR_UNSUPPORTED_KEY_SIZE = -6,
307 KM_ERROR_UNSUPPORTED_BLOCK_MODE = -7,
308 KM_ERROR_INCOMPATIBLE_BLOCK_MODE = -8,
Shawn Willden6b424be2015-01-26 13:04:28 -0700309 KM_ERROR_UNSUPPORTED_MAC_LENGTH = -9,
Shawn Willden9d645a02014-06-12 13:48:46 -0600310 KM_ERROR_UNSUPPORTED_PADDING_MODE = -10,
311 KM_ERROR_INCOMPATIBLE_PADDING_MODE = -11,
312 KM_ERROR_UNSUPPORTED_DIGEST = -12,
313 KM_ERROR_INCOMPATIBLE_DIGEST = -13,
314 KM_ERROR_INVALID_EXPIRATION_TIME = -14,
315 KM_ERROR_INVALID_USER_ID = -15,
316 KM_ERROR_INVALID_AUTHORIZATION_TIMEOUT = -16,
317 KM_ERROR_UNSUPPORTED_KEY_FORMAT = -17,
318 KM_ERROR_INCOMPATIBLE_KEY_FORMAT = -18,
319 KM_ERROR_UNSUPPORTED_KEY_ENCRYPTION_ALGORITHM = -19, /* For PKCS8 & PKCS12 */
320 KM_ERROR_UNSUPPORTED_KEY_VERIFICATION_ALGORITHM = -20, /* For PKCS8 & PKCS12 */
321 KM_ERROR_INVALID_INPUT_LENGTH = -21,
322 KM_ERROR_KEY_EXPORT_OPTIONS_INVALID = -22,
323 KM_ERROR_DELEGATION_NOT_ALLOWED = -23,
324 KM_ERROR_KEY_NOT_YET_VALID = -24,
325 KM_ERROR_KEY_EXPIRED = -25,
326 KM_ERROR_KEY_USER_NOT_AUTHENTICATED = -26,
327 KM_ERROR_OUTPUT_PARAMETER_NULL = -27,
328 KM_ERROR_INVALID_OPERATION_HANDLE = -28,
329 KM_ERROR_INSUFFICIENT_BUFFER_SPACE = -29,
330 KM_ERROR_VERIFICATION_FAILED = -30,
331 KM_ERROR_TOO_MANY_OPERATIONS = -31,
332 KM_ERROR_UNEXPECTED_NULL_POINTER = -32,
333 KM_ERROR_INVALID_KEY_BLOB = -33,
334 KM_ERROR_IMPORTED_KEY_NOT_ENCRYPTED = -34,
335 KM_ERROR_IMPORTED_KEY_DECRYPTION_FAILED = -35,
336 KM_ERROR_IMPORTED_KEY_NOT_SIGNED = -36,
337 KM_ERROR_IMPORTED_KEY_VERIFICATION_FAILED = -37,
338 KM_ERROR_INVALID_ARGUMENT = -38,
339 KM_ERROR_UNSUPPORTED_TAG = -39,
340 KM_ERROR_INVALID_TAG = -40,
341 KM_ERROR_MEMORY_ALLOCATION_FAILED = -41,
342 KM_ERROR_INVALID_RESCOPING = -42,
Shawn Willden9d645a02014-06-12 13:48:46 -0600343 KM_ERROR_IMPORT_PARAMETER_MISMATCH = -44,
344 KM_ERROR_SECURE_HW_ACCESS_DENIED = -45,
345 KM_ERROR_OPERATION_CANCELLED = -46,
346 KM_ERROR_CONCURRENT_ACCESS_CONFLICT = -47,
347 KM_ERROR_SECURE_HW_BUSY = -48,
348 KM_ERROR_SECURE_HW_COMMUNICATION_FAILED = -49,
349 KM_ERROR_UNSUPPORTED_EC_FIELD = -50,
Shawn Willdened941112015-03-11 21:53:59 -0600350 KM_ERROR_MISSING_NONCE = -51,
351 KM_ERROR_INVALID_NONCE = -52,
352 KM_ERROR_UNSUPPORTED_CHUNK_LENGTH = -53,
353 KM_ERROR_RESCOPABLE_KEY_NOT_USABLE = -54,
354
Shawn Willden9d645a02014-06-12 13:48:46 -0600355 KM_ERROR_UNIMPLEMENTED = -100,
356 KM_ERROR_VERSION_MISMATCH = -101,
357
358 /* Additional error codes may be added by implementations, but implementers should coordinate
359 * with Google to avoid code collision. */
360 KM_ERROR_UNKNOWN_ERROR = -1000,
361} keymaster_error_t;
362
Shawn Willden9d645a02014-06-12 13:48:46 -0600363/* Convenience functions for manipulating keymaster tag types */
364
365static inline keymaster_tag_type_t keymaster_tag_get_type(keymaster_tag_t tag) {
366 return (keymaster_tag_type_t)(tag & (0xF << 28));
367}
368
369static inline uint32_t keymaster_tag_mask_type(keymaster_tag_t tag) {
370 return tag & 0x0FFFFFFF;
371}
372
373static inline bool keymaster_tag_type_repeatable(keymaster_tag_type_t type) {
374 switch (type) {
375 case KM_INT_REP:
376 case KM_ENUM_REP:
377 return true;
378 default:
379 return false;
380 }
381}
382
383static inline bool keymaster_tag_repeatable(keymaster_tag_t tag) {
384 return keymaster_tag_type_repeatable(keymaster_tag_get_type(tag));
385}
386
387/* Convenience functions for manipulating keymaster_key_param_t structs */
388
389inline keymaster_key_param_t keymaster_param_enum(keymaster_tag_t tag, uint32_t value) {
390 // assert(keymaster_tag_get_type(tag) == KM_ENUM || keymaster_tag_get_type(tag) == KM_ENUM_REP);
391 keymaster_key_param_t param;
392 memset(&param, 0, sizeof(param));
393 param.tag = tag;
394 param.enumerated = value;
395 return param;
396}
397
398inline keymaster_key_param_t keymaster_param_int(keymaster_tag_t tag, uint32_t value) {
399 // assert(keymaster_tag_get_type(tag) == KM_INT || keymaster_tag_get_type(tag) == KM_INT_REP);
400 keymaster_key_param_t param;
401 memset(&param, 0, sizeof(param));
402 param.tag = tag;
403 param.integer = value;
404 return param;
405}
406
407inline keymaster_key_param_t keymaster_param_long(keymaster_tag_t tag, uint64_t value) {
408 // assert(keymaster_tag_get_type(tag) == KM_LONG);
409 keymaster_key_param_t param;
410 memset(&param, 0, sizeof(param));
411 param.tag = tag;
412 param.long_integer = value;
413 return param;
414}
415
416inline keymaster_key_param_t keymaster_param_blob(keymaster_tag_t tag, const uint8_t* bytes,
417 size_t bytes_len) {
418 // assert(keymaster_tag_get_type(tag) == KM_BYTES || keymaster_tag_get_type(tag) == KM_BIGNUM);
419 keymaster_key_param_t param;
420 memset(&param, 0, sizeof(param));
421 param.tag = tag;
422 param.blob.data = (uint8_t*)bytes;
423 param.blob.data_length = bytes_len;
424 return param;
425}
426
427inline keymaster_key_param_t keymaster_param_bool(keymaster_tag_t tag) {
428 // assert(keymaster_tag_get_type(tag) == KM_BOOL);
429 keymaster_key_param_t param;
430 memset(&param, 0, sizeof(param));
431 param.tag = tag;
432 param.boolean = true;
433 return param;
434}
435
436inline keymaster_key_param_t keymaster_param_date(keymaster_tag_t tag, uint64_t value) {
437 // assert(keymaster_tag_get_type(tag) == KM_DATE);
438 keymaster_key_param_t param;
439 memset(&param, 0, sizeof(param));
440 param.tag = tag;
441 param.date_time = value;
442 return param;
443}
444
Shawn Willden67411d62015-03-04 10:00:38 -0700445#define KEYMASTER_SIMPLE_COMPARE(a, b) (a < b) ? -1 : ((a > b) ? 1 : 0)
446inline int keymaster_param_compare(const keymaster_key_param_t* a, const keymaster_key_param_t* b) {
447 int retval = KEYMASTER_SIMPLE_COMPARE(a->tag, b->tag);
448 if (retval != 0)
449 return retval;
450
451 switch (keymaster_tag_get_type(a->tag)) {
452 case KM_INVALID:
453 case KM_BOOL:
454 return 0;
455 case KM_ENUM:
456 case KM_ENUM_REP:
457 return KEYMASTER_SIMPLE_COMPARE(a->enumerated, b->enumerated);
458 case KM_INT:
459 case KM_INT_REP:
460 return KEYMASTER_SIMPLE_COMPARE(a->integer, b->integer);
461 case KM_LONG:
Shawn Willden4719aca2015-03-14 07:54:52 -0600462 case KM_LONG_REP:
Shawn Willden67411d62015-03-04 10:00:38 -0700463 return KEYMASTER_SIMPLE_COMPARE(a->long_integer, b->long_integer);
464 case KM_DATE:
465 return KEYMASTER_SIMPLE_COMPARE(a->date_time, b->date_time);
466 case KM_BIGNUM:
467 case KM_BYTES:
468 // Handle the empty cases.
469 if (a->blob.data_length != 0 && b->blob.data_length == 0)
470 return -1;
471 if (a->blob.data_length == 0 && b->blob.data_length == 0)
472 return 0;
473 if (a->blob.data_length == 0 && b->blob.data_length > 0)
474 return 1;
475
476 retval = memcmp(a->blob.data, b->blob.data, a->blob.data_length < b->blob.data_length
477 ? a->blob.data_length
478 : b->blob.data_length);
479 if (retval != 0)
480 return retval;
481 else if (a->blob.data_length != b->blob.data_length) {
482 // Equal up to the common length; longer one is larger.
483 if (a->blob.data_length < b->blob.data_length)
484 return -1;
485 if (a->blob.data_length > b->blob.data_length)
486 return 1;
487 };
488 }
489
490 return 0;
491}
492#undef KEYMASTER_SIMPLE_COMPARE
493
Shawn Willden9d645a02014-06-12 13:48:46 -0600494inline void keymaster_free_param_values(keymaster_key_param_t* param, size_t param_count) {
495 while (param_count-- > 0) {
496 switch (keymaster_tag_get_type(param->tag)) {
497 case KM_BIGNUM:
498 case KM_BYTES:
499 free((void*)param->blob.data);
500 param->blob.data = NULL;
501 break;
502 default:
503 // NOP
504 break;
505 }
506 ++param;
507 }
508}
509
510inline void keymaster_free_param_set(keymaster_key_param_set_t* set) {
511 if (set) {
512 keymaster_free_param_values(set->params, set->length);
513 free(set->params);
514 set->params = NULL;
515 }
516}
517
518inline void keymaster_free_characteristics(keymaster_key_characteristics_t* characteristics) {
519 if (characteristics) {
520 keymaster_free_param_set(&characteristics->hw_enforced);
521 keymaster_free_param_set(&characteristics->sw_enforced);
522 }
523}
524
Shawn Willdenc51d01e2015-03-18 18:59:52 -0600525#ifndef __cplusplus
526} // extern "C"
527#endif // __cplusplus
Shawn Willden9d645a02014-06-12 13:48:46 -0600528
529#endif // ANDROID_HARDWARE_KEYMASTER_DEFS_H