1 // SPDX-License-Identifier: BSD-2-Clause 2 /* 3 * Copyright (c) 2018-2020, Linaro Limited 4 */ 5 6 #include <pkcs11_ta.h> 7 #include <string.h> 8 #include <tee_internal_api.h> 9 #include <util.h> 10 11 #include "attributes.h" 12 #include "object.h" 13 #include "pkcs11_attributes.h" 14 #include "pkcs11_helpers.h" 15 16 static const char __maybe_unused unknown[] = "<unknown-identifier>"; 17 18 struct attr_size { 19 uint32_t id; 20 uint32_t size; 21 #if CFG_TEE_TA_LOG_LEVEL > 0 22 const char *string; 23 #endif 24 }; 25 26 #if CFG_TEE_TA_LOG_LEVEL > 0 27 #define PKCS11_ID_SZ(_id, _sz) \ 28 { .id = (uint32_t)(_id), .size = (_sz), .string = #_id } 29 #else 30 #define PKCS11_ID_SZ(_id, _sz) \ 31 { .id = (uint32_t)(_id), .size = (_sz) } 32 #endif 33 34 static const struct attr_size attr_ids[] = { 35 PKCS11_ID_SZ(PKCS11_CKA_CLASS, 4), 36 PKCS11_ID_SZ(PKCS11_CKA_KEY_TYPE, 4), 37 PKCS11_ID_SZ(PKCS11_CKA_VALUE, 0), 38 PKCS11_ID_SZ(PKCS11_CKA_VALUE_LEN, 4), 39 PKCS11_ID_SZ(PKCS11_CKA_LABEL, 0), 40 PKCS11_ID_SZ(PKCS11_CKA_WRAP_TEMPLATE, 0), 41 PKCS11_ID_SZ(PKCS11_CKA_UNWRAP_TEMPLATE, 0), 42 PKCS11_ID_SZ(PKCS11_CKA_DERIVE_TEMPLATE, 0), 43 PKCS11_ID_SZ(PKCS11_CKA_START_DATE, 4), 44 PKCS11_ID_SZ(PKCS11_CKA_END_DATE, 4), 45 PKCS11_ID_SZ(PKCS11_CKA_OBJECT_ID, 0), 46 PKCS11_ID_SZ(PKCS11_CKA_APPLICATION, 0), 47 PKCS11_ID_SZ(PKCS11_CKA_MECHANISM_TYPE, 4), 48 PKCS11_ID_SZ(PKCS11_CKA_ID, 0), 49 PKCS11_ID_SZ(PKCS11_CKA_ALLOWED_MECHANISMS, 0), 50 PKCS11_ID_SZ(PKCS11_CKA_EC_POINT, 0), 51 PKCS11_ID_SZ(PKCS11_CKA_EC_PARAMS, 0), 52 PKCS11_ID_SZ(PKCS11_CKA_MODULUS, 0), 53 PKCS11_ID_SZ(PKCS11_CKA_MODULUS_BITS, 4), 54 PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_EXPONENT, 0), 55 PKCS11_ID_SZ(PKCS11_CKA_PRIVATE_EXPONENT, 0), 56 PKCS11_ID_SZ(PKCS11_CKA_PRIME_1, 0), 57 PKCS11_ID_SZ(PKCS11_CKA_PRIME_2, 0), 58 PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_1, 0), 59 PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_2, 0), 60 PKCS11_ID_SZ(PKCS11_CKA_COEFFICIENT, 0), 61 PKCS11_ID_SZ(PKCS11_CKA_SUBJECT, 0), 62 PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_KEY_INFO, 0), 63 /* Below are boolean attributes */ 64 PKCS11_ID_SZ(PKCS11_CKA_TOKEN, 1), 65 PKCS11_ID_SZ(PKCS11_CKA_PRIVATE, 1), 66 PKCS11_ID_SZ(PKCS11_CKA_TRUSTED, 1), 67 PKCS11_ID_SZ(PKCS11_CKA_SENSITIVE, 1), 68 PKCS11_ID_SZ(PKCS11_CKA_ENCRYPT, 1), 69 PKCS11_ID_SZ(PKCS11_CKA_DECRYPT, 1), 70 PKCS11_ID_SZ(PKCS11_CKA_WRAP, 1), 71 PKCS11_ID_SZ(PKCS11_CKA_UNWRAP, 1), 72 PKCS11_ID_SZ(PKCS11_CKA_SIGN, 1), 73 PKCS11_ID_SZ(PKCS11_CKA_SIGN_RECOVER, 1), 74 PKCS11_ID_SZ(PKCS11_CKA_VERIFY, 1), 75 PKCS11_ID_SZ(PKCS11_CKA_VERIFY_RECOVER, 1), 76 PKCS11_ID_SZ(PKCS11_CKA_DERIVE, 1), 77 PKCS11_ID_SZ(PKCS11_CKA_EXTRACTABLE, 1), 78 PKCS11_ID_SZ(PKCS11_CKA_LOCAL, 1), 79 PKCS11_ID_SZ(PKCS11_CKA_NEVER_EXTRACTABLE, 1), 80 PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_SENSITIVE, 1), 81 PKCS11_ID_SZ(PKCS11_CKA_MODIFIABLE, 1), 82 PKCS11_ID_SZ(PKCS11_CKA_COPYABLE, 1), 83 PKCS11_ID_SZ(PKCS11_CKA_DESTROYABLE, 1), 84 PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_AUTHENTICATE, 1), 85 PKCS11_ID_SZ(PKCS11_CKA_WRAP_WITH_TRUSTED, 1), 86 /* Specific PKCS11 TA internal attribute ID */ 87 PKCS11_ID_SZ(PKCS11_CKA_UNDEFINED_ID, 0), 88 }; 89 90 struct any_id { 91 uint32_t id; 92 #if CFG_TEE_TA_LOG_LEVEL > 0 93 const char *string; 94 #endif 95 }; 96 97 /* 98 * Macro PKCS11_ID() can be used to define cells in ID list arrays 99 * or ID/string conversion arrays. 100 */ 101 #if CFG_TEE_TA_LOG_LEVEL > 0 102 #define PKCS11_ID(_id) { .id = _id, .string = #_id } 103 #else 104 #define PKCS11_ID(_id) { .id = _id } 105 #endif 106 107 #define ID2STR(id, table, prefix) \ 108 id2str(id, table, ARRAY_SIZE(table), prefix) 109 110 #if CFG_TEE_TA_LOG_LEVEL > 0 111 /* Convert a PKCS11 ID into its label string */ 112 static const char *id2str(uint32_t id, const struct any_id *table, 113 size_t count, const char *prefix) 114 { 115 size_t n = 0; 116 const char *str = NULL; 117 118 for (n = 0; n < count; n++) { 119 if (id != table[n].id) 120 continue; 121 122 str = table[n].string; 123 124 /* Skip prefix provided matches found */ 125 if (prefix && !TEE_MemCompare(str, prefix, strlen(prefix))) 126 str += strlen(prefix); 127 128 return str; 129 } 130 131 return unknown; 132 } 133 #endif /* CFG_TEE_TA_LOG_LEVEL > 0 */ 134 135 /* 136 * TA command IDs: used only as ID/string conversion for debug trace support 137 */ 138 static const struct any_id __maybe_unused string_ta_cmd[] = { 139 PKCS11_ID(PKCS11_CMD_PING), 140 PKCS11_ID(PKCS11_CMD_SLOT_LIST), 141 PKCS11_ID(PKCS11_CMD_SLOT_INFO), 142 PKCS11_ID(PKCS11_CMD_TOKEN_INFO), 143 PKCS11_ID(PKCS11_CMD_MECHANISM_IDS), 144 PKCS11_ID(PKCS11_CMD_MECHANISM_INFO), 145 PKCS11_ID(PKCS11_CMD_OPEN_SESSION), 146 PKCS11_ID(PKCS11_CMD_SESSION_INFO), 147 PKCS11_ID(PKCS11_CMD_CLOSE_SESSION), 148 PKCS11_ID(PKCS11_CMD_CLOSE_ALL_SESSIONS), 149 PKCS11_ID(PKCS11_CMD_INIT_TOKEN), 150 PKCS11_ID(PKCS11_CMD_INIT_PIN), 151 PKCS11_ID(PKCS11_CMD_SET_PIN), 152 PKCS11_ID(PKCS11_CMD_LOGIN), 153 PKCS11_ID(PKCS11_CMD_LOGOUT), 154 PKCS11_ID(PKCS11_CMD_CREATE_OBJECT), 155 PKCS11_ID(PKCS11_CMD_DESTROY_OBJECT), 156 PKCS11_ID(PKCS11_CMD_ENCRYPT_INIT), 157 PKCS11_ID(PKCS11_CMD_DECRYPT_INIT), 158 PKCS11_ID(PKCS11_CMD_ENCRYPT_UPDATE), 159 PKCS11_ID(PKCS11_CMD_DECRYPT_UPDATE), 160 PKCS11_ID(PKCS11_CMD_ENCRYPT_FINAL), 161 PKCS11_ID(PKCS11_CMD_DECRYPT_FINAL), 162 PKCS11_ID(PKCS11_CMD_ENCRYPT_ONESHOT), 163 PKCS11_ID(PKCS11_CMD_DECRYPT_ONESHOT), 164 PKCS11_ID(PKCS11_CMD_SIGN_INIT), 165 PKCS11_ID(PKCS11_CMD_VERIFY_INIT), 166 PKCS11_ID(PKCS11_CMD_SIGN_UPDATE), 167 PKCS11_ID(PKCS11_CMD_VERIFY_UPDATE), 168 PKCS11_ID(PKCS11_CMD_SIGN_FINAL), 169 PKCS11_ID(PKCS11_CMD_VERIFY_FINAL), 170 PKCS11_ID(PKCS11_CMD_SIGN_ONESHOT), 171 PKCS11_ID(PKCS11_CMD_VERIFY_ONESHOT), 172 }; 173 174 static const struct any_id __maybe_unused string_slot_flags[] = { 175 PKCS11_ID(PKCS11_CKFS_TOKEN_PRESENT), 176 PKCS11_ID(PKCS11_CKFS_REMOVABLE_DEVICE), 177 PKCS11_ID(PKCS11_CKFS_HW_SLOT), 178 }; 179 180 static const struct any_id __maybe_unused string_token_flags[] = { 181 PKCS11_ID(PKCS11_CKFT_RNG), 182 PKCS11_ID(PKCS11_CKFT_WRITE_PROTECTED), 183 PKCS11_ID(PKCS11_CKFT_LOGIN_REQUIRED), 184 PKCS11_ID(PKCS11_CKFT_USER_PIN_INITIALIZED), 185 PKCS11_ID(PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED), 186 PKCS11_ID(PKCS11_CKFT_CLOCK_ON_TOKEN), 187 PKCS11_ID(PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH), 188 PKCS11_ID(PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS), 189 PKCS11_ID(PKCS11_CKFT_TOKEN_INITIALIZED), 190 PKCS11_ID(PKCS11_CKFT_USER_PIN_COUNT_LOW), 191 PKCS11_ID(PKCS11_CKFT_USER_PIN_FINAL_TRY), 192 PKCS11_ID(PKCS11_CKFT_USER_PIN_LOCKED), 193 PKCS11_ID(PKCS11_CKFT_USER_PIN_TO_BE_CHANGED), 194 PKCS11_ID(PKCS11_CKFT_SO_PIN_COUNT_LOW), 195 PKCS11_ID(PKCS11_CKFT_SO_PIN_FINAL_TRY), 196 PKCS11_ID(PKCS11_CKFT_SO_PIN_LOCKED), 197 PKCS11_ID(PKCS11_CKFT_SO_PIN_TO_BE_CHANGED), 198 PKCS11_ID(PKCS11_CKFT_ERROR_STATE), 199 }; 200 201 static const struct any_id __maybe_unused string_session_flags[] = { 202 PKCS11_ID(PKCS11_CKFSS_RW_SESSION), 203 PKCS11_ID(PKCS11_CKFSS_SERIAL_SESSION), 204 }; 205 206 static const struct any_id __maybe_unused string_session_state[] = { 207 PKCS11_ID(PKCS11_CKS_RO_PUBLIC_SESSION), 208 PKCS11_ID(PKCS11_CKS_RO_USER_FUNCTIONS), 209 PKCS11_ID(PKCS11_CKS_RW_PUBLIC_SESSION), 210 PKCS11_ID(PKCS11_CKS_RW_USER_FUNCTIONS), 211 PKCS11_ID(PKCS11_CKS_RW_SO_FUNCTIONS), 212 }; 213 214 static const struct any_id __maybe_unused string_rc[] = { 215 PKCS11_ID(PKCS11_CKR_OK), 216 PKCS11_ID(PKCS11_CKR_GENERAL_ERROR), 217 PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY), 218 PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD), 219 PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL), 220 PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED), 221 PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID), 222 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID), 223 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID), 224 PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID), 225 PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID), 226 PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID), 227 PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID), 228 PKCS11_ID(PKCS11_CKR_SLOT_ID_INVALID), 229 PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID), 230 PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT), 231 PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE), 232 PKCS11_ID(PKCS11_CKR_PIN_INCORRECT), 233 PKCS11_ID(PKCS11_CKR_PIN_LOCKED), 234 PKCS11_ID(PKCS11_CKR_PIN_EXPIRED), 235 PKCS11_ID(PKCS11_CKR_PIN_INVALID), 236 PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE), 237 PKCS11_ID(PKCS11_CKR_SESSION_EXISTS), 238 PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY), 239 PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS), 240 PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE), 241 PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED), 242 PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED), 243 PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED), 244 PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT), 245 PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED), 246 PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED), 247 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY), 248 PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK), 249 PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED), 250 PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID), 251 PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN), 252 PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN), 253 PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN), 254 PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED), 255 PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES), 256 PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID), 257 PKCS11_ID(PKCS11_CKR_KEY_SIZE_RANGE), 258 PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS), 259 PKCS11_ID(PKCS11_CKR_SIGNATURE_LEN_RANGE), 260 PKCS11_ID(PKCS11_RV_NOT_FOUND), 261 PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED), 262 }; 263 264 static const struct any_id __maybe_unused string_class[] = { 265 PKCS11_ID(PKCS11_CKO_SECRET_KEY), 266 PKCS11_ID(PKCS11_CKO_PUBLIC_KEY), 267 PKCS11_ID(PKCS11_CKO_PRIVATE_KEY), 268 PKCS11_ID(PKCS11_CKO_OTP_KEY), 269 PKCS11_ID(PKCS11_CKO_CERTIFICATE), 270 PKCS11_ID(PKCS11_CKO_DATA), 271 PKCS11_ID(PKCS11_CKO_DOMAIN_PARAMETERS), 272 PKCS11_ID(PKCS11_CKO_HW_FEATURE), 273 PKCS11_ID(PKCS11_CKO_MECHANISM), 274 PKCS11_ID(PKCS11_CKO_UNDEFINED_ID) 275 }; 276 277 static const struct any_id __maybe_unused string_key_type[] = { 278 PKCS11_ID(PKCS11_CKK_AES), 279 PKCS11_ID(PKCS11_CKK_GENERIC_SECRET), 280 PKCS11_ID(PKCS11_CKK_MD5_HMAC), 281 PKCS11_ID(PKCS11_CKK_SHA_1_HMAC), 282 PKCS11_ID(PKCS11_CKK_SHA224_HMAC), 283 PKCS11_ID(PKCS11_CKK_SHA256_HMAC), 284 PKCS11_ID(PKCS11_CKK_SHA384_HMAC), 285 PKCS11_ID(PKCS11_CKK_SHA512_HMAC), 286 PKCS11_ID(PKCS11_CKK_EC), 287 PKCS11_ID(PKCS11_CKK_RSA), 288 PKCS11_ID(PKCS11_CKK_UNDEFINED_ID) 289 }; 290 291 /* 292 * Processing IDs not exported in the TA API. 293 * PKCS11_CKM_* mechanism IDs are looked up from mechanism_string_id(). 294 */ 295 static const struct any_id __maybe_unused string_internal_processing[] = { 296 PKCS11_ID(PKCS11_PROCESSING_IMPORT), 297 }; 298 299 static const struct any_id __maybe_unused string_functions[] = { 300 PKCS11_ID(PKCS11_FUNCTION_IMPORT), 301 PKCS11_ID(PKCS11_FUNCTION_ENCRYPT), 302 PKCS11_ID(PKCS11_FUNCTION_DECRYPT), 303 PKCS11_ID(PKCS11_FUNCTION_SIGN), 304 PKCS11_ID(PKCS11_FUNCTION_VERIFY), 305 }; 306 307 /* 308 * Conversion between PKCS11 TA and GPD TEE return codes 309 */ 310 enum pkcs11_rc tee2pkcs_error(TEE_Result res) 311 { 312 switch (res) { 313 case TEE_SUCCESS: 314 return PKCS11_CKR_OK; 315 316 case TEE_ERROR_BAD_PARAMETERS: 317 return PKCS11_CKR_ARGUMENTS_BAD; 318 319 case TEE_ERROR_OUT_OF_MEMORY: 320 return PKCS11_CKR_DEVICE_MEMORY; 321 322 case TEE_ERROR_SHORT_BUFFER: 323 return PKCS11_CKR_BUFFER_TOO_SMALL; 324 325 case TEE_ERROR_MAC_INVALID: 326 case TEE_ERROR_SIGNATURE_INVALID: 327 return PKCS11_CKR_SIGNATURE_INVALID; 328 329 default: 330 return PKCS11_CKR_GENERAL_ERROR; 331 } 332 } 333 334 /* 335 * Helper functions to analyse PKCS11 identifiers 336 */ 337 338 /* Check attribute ID is known and size matches if fixed */ 339 bool valid_pkcs11_attribute_id(uint32_t id, uint32_t size) 340 { 341 size_t n = 0; 342 343 for (n = 0; n < ARRAY_SIZE(attr_ids); n++) 344 if (id == attr_ids[n].id) 345 return !attr_ids[n].size || size == attr_ids[n].size; 346 347 return false; 348 } 349 350 size_t pkcs11_attr_is_type(uint32_t attribute_id) 351 { 352 enum pkcs11_attr_id id = attribute_id; 353 354 switch (id) { 355 case PKCS11_CKA_KEY_TYPE: 356 case PKCS11_CKA_MECHANISM_TYPE: 357 case PKCS11_CKA_KEY_GEN_MECHANISM: 358 return sizeof(uint32_t); 359 default: 360 return 0; 361 } 362 } 363 364 bool pkcs11_class_has_type(uint32_t class) 365 { 366 enum pkcs11_class_id class_id = class; 367 368 switch (class_id) { 369 case PKCS11_CKO_CERTIFICATE: 370 case PKCS11_CKO_PUBLIC_KEY: 371 case PKCS11_CKO_PRIVATE_KEY: 372 case PKCS11_CKO_SECRET_KEY: 373 case PKCS11_CKO_MECHANISM: 374 case PKCS11_CKO_HW_FEATURE: 375 return true; 376 default: 377 return false; 378 } 379 } 380 381 bool pkcs11_attr_class_is_key(uint32_t class) 382 { 383 enum pkcs11_class_id class_id = class; 384 385 switch (class_id) { 386 case PKCS11_CKO_SECRET_KEY: 387 case PKCS11_CKO_PUBLIC_KEY: 388 case PKCS11_CKO_PRIVATE_KEY: 389 return true; 390 default: 391 return false; 392 } 393 } 394 395 bool key_type_is_symm_key(uint32_t id) 396 { 397 enum pkcs11_key_type key_type = id; 398 399 switch (key_type) { 400 case PKCS11_CKK_AES: 401 case PKCS11_CKK_GENERIC_SECRET: 402 case PKCS11_CKK_MD5_HMAC: 403 case PKCS11_CKK_SHA_1_HMAC: 404 case PKCS11_CKK_SHA224_HMAC: 405 case PKCS11_CKK_SHA256_HMAC: 406 case PKCS11_CKK_SHA384_HMAC: 407 case PKCS11_CKK_SHA512_HMAC: 408 return true; 409 default: 410 return false; 411 } 412 } 413 414 bool key_type_is_asymm_key(uint32_t id) 415 { 416 enum pkcs11_key_type key_type = id; 417 418 switch (key_type) { 419 case PKCS11_CKK_EC: 420 case PKCS11_CKK_RSA: 421 return true; 422 default: 423 return false; 424 } 425 } 426 427 /* 428 * Returns shift position or -1 on error. 429 * Mainly used when PKCS11_SHEAD_WITH_BOOLPROPS is enabled 430 */ 431 int pkcs11_attr2boolprop_shift(uint32_t attr) 432 { 433 static const uint32_t bpa[] = { 434 [BPA_TOKEN] = PKCS11_CKA_TOKEN, 435 [BPA_PRIVATE] = PKCS11_CKA_PRIVATE, 436 [BPA_TRUSTED] = PKCS11_CKA_TRUSTED, 437 [BPA_SENSITIVE] = PKCS11_CKA_SENSITIVE, 438 [BPA_ENCRYPT] = PKCS11_CKA_ENCRYPT, 439 [BPA_DECRYPT] = PKCS11_CKA_DECRYPT, 440 [BPA_WRAP] = PKCS11_CKA_WRAP, 441 [BPA_UNWRAP] = PKCS11_CKA_UNWRAP, 442 [BPA_SIGN] = PKCS11_CKA_SIGN, 443 [BPA_SIGN_RECOVER] = PKCS11_CKA_SIGN_RECOVER, 444 [BPA_VERIFY] = PKCS11_CKA_VERIFY, 445 [BPA_VERIFY_RECOVER] = PKCS11_CKA_VERIFY_RECOVER, 446 [BPA_DERIVE] = PKCS11_CKA_DERIVE, 447 [BPA_EXTRACTABLE] = PKCS11_CKA_EXTRACTABLE, 448 [BPA_LOCAL] = PKCS11_CKA_LOCAL, 449 [BPA_NEVER_EXTRACTABLE] = PKCS11_CKA_NEVER_EXTRACTABLE, 450 [BPA_ALWAYS_SENSITIVE] = PKCS11_CKA_ALWAYS_SENSITIVE, 451 [BPA_MODIFIABLE] = PKCS11_CKA_MODIFIABLE, 452 [BPA_COPYABLE] = PKCS11_CKA_COPYABLE, 453 [BPA_DESTROYABLE] = PKCS11_CKA_DESTROYABLE, 454 [BPA_ALWAYS_AUTHENTICATE] = PKCS11_CKA_ALWAYS_AUTHENTICATE, 455 [BPA_WRAP_WITH_TRUSTED] = PKCS11_CKA_WRAP_WITH_TRUSTED, 456 }; 457 size_t pos = 0; 458 459 for (pos = 0; pos < ARRAY_SIZE(bpa); pos++) 460 if (bpa[pos] == attr) 461 return (int)pos; 462 463 return -1; 464 } 465 466 /* Initialize a TEE attribute for a target PKCS11 TA attribute in an object */ 467 bool pkcs2tee_load_attr(TEE_Attribute *tee_ref, uint32_t tee_id, 468 struct pkcs11_object *obj, 469 enum pkcs11_attr_id pkcs11_id) 470 { 471 void *a_ptr = NULL; 472 uint32_t a_size = 0; 473 474 if (get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size)) 475 return false; 476 477 TEE_InitRefAttribute(tee_ref, tee_id, a_ptr, a_size); 478 479 return true; 480 } 481 482 /* 483 * Initialize a TEE attribute with hash of a target PKCS11 TA attribute 484 * in an object. 485 */ 486 enum pkcs11_rc pkcs2tee_load_hashed_attr(TEE_Attribute *tee_ref, 487 uint32_t tee_id, 488 struct pkcs11_object *obj, 489 enum pkcs11_attr_id pkcs11_id, 490 uint32_t tee_algo, void *hash_ptr, 491 uint32_t *hash_size) 492 { 493 TEE_OperationHandle handle = TEE_HANDLE_NULL; 494 void *a_ptr = NULL; 495 uint32_t a_size = 0; 496 enum pkcs11_rc rc = PKCS11_CKR_OK; 497 TEE_Result res = TEE_ERROR_GENERIC; 498 499 rc = get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size); 500 if (rc) 501 return rc; 502 503 res = TEE_AllocateOperation(&handle, tee_algo, TEE_MODE_DIGEST, 0); 504 if (res) { 505 EMSG("TEE_AllocateOperation() failed %#"PRIx32, tee_algo); 506 return tee2pkcs_error(res); 507 } 508 509 res = TEE_DigestDoFinal(handle, a_ptr, a_size, hash_ptr, hash_size); 510 TEE_FreeOperation(handle); 511 if (res) { 512 EMSG("TEE_DigestDoFinal() failed %#"PRIx32, tee_algo); 513 return PKCS11_CKR_FUNCTION_FAILED; 514 } 515 516 TEE_InitRefAttribute(tee_ref, tee_id, hash_ptr, *hash_size); 517 518 return PKCS11_CKR_OK; 519 } 520 521 /* Easy conversion between PKCS11 TA function of TEE crypto mode */ 522 void pkcs2tee_mode(uint32_t *tee_id, enum processing_func function) 523 { 524 switch (function) { 525 case PKCS11_FUNCTION_ENCRYPT: 526 *tee_id = TEE_MODE_ENCRYPT; 527 break; 528 case PKCS11_FUNCTION_DECRYPT: 529 *tee_id = TEE_MODE_DECRYPT; 530 break; 531 case PKCS11_FUNCTION_SIGN: 532 *tee_id = TEE_MODE_SIGN; 533 break; 534 case PKCS11_FUNCTION_VERIFY: 535 *tee_id = TEE_MODE_VERIFY; 536 break; 537 case PKCS11_FUNCTION_DERIVE: 538 *tee_id = TEE_MODE_DERIVE; 539 break; 540 default: 541 TEE_Panic(function); 542 } 543 } 544 545 #if CFG_TEE_TA_LOG_LEVEL > 0 546 const char *id2str_rc(uint32_t id) 547 { 548 return ID2STR(id, string_rc, "PKCS11_CKR_"); 549 } 550 551 const char *id2str_ta_cmd(uint32_t id) 552 { 553 return ID2STR(id, string_ta_cmd, NULL); 554 } 555 556 const char *id2str_slot_flag(uint32_t id) 557 { 558 return ID2STR(id, string_slot_flags, "PKCS11_CKFS_"); 559 } 560 561 const char *id2str_token_flag(uint32_t id) 562 { 563 return ID2STR(id, string_token_flags, "PKCS11_CKFT_"); 564 } 565 566 const char *id2str_session_flag(uint32_t id) 567 { 568 return ID2STR(id, string_session_flags, "PKCS11_CKFSS_"); 569 } 570 571 const char *id2str_session_state(uint32_t id) 572 { 573 return ID2STR(id, string_session_state, "PKCS11_CKS_"); 574 } 575 576 const char *id2str_attr(uint32_t id) 577 { 578 size_t n = 0; 579 580 for (n = 0; n < ARRAY_SIZE(attr_ids); n++) { 581 if (id == attr_ids[n].id) { 582 /* Skip PKCS11_CKA_ prefix */ 583 return attr_ids[n].string + strlen("PKCS11_CKA_"); 584 } 585 } 586 587 return unknown; 588 } 589 590 const char *id2str_class(uint32_t id) 591 { 592 return ID2STR(id, string_class, "PKCS11_CKO_"); 593 } 594 595 const char *id2str_type(uint32_t id, uint32_t class) 596 { 597 enum pkcs11_class_id class_id = class; 598 enum pkcs11_key_type key_type = id; 599 600 switch (class_id) { 601 case PKCS11_CKO_SECRET_KEY: 602 case PKCS11_CKO_PUBLIC_KEY: 603 case PKCS11_CKO_PRIVATE_KEY: 604 return id2str_key_type(key_type); 605 default: 606 return unknown; 607 } 608 } 609 610 const char *id2str_key_type(uint32_t id) 611 { 612 return ID2STR(id, string_key_type, "PKCS11_CKK_"); 613 } 614 615 const char *id2str_attr_value(uint32_t id, size_t size, void *value) 616 { 617 static const char str_true[] = "TRUE"; 618 static const char str_false[] = "FALSE"; 619 static const char str_unknown[] = "*"; 620 uint32_t type = 0; 621 622 if (pkcs11_attr2boolprop_shift(id) >= 0) 623 return *(uint8_t *)value ? str_true : str_false; 624 625 if (size < sizeof(uint32_t)) 626 return str_unknown; 627 628 TEE_MemMove(&type, value, sizeof(uint32_t)); 629 630 switch (id) { 631 case PKCS11_CKA_CLASS: 632 return id2str_class(type); 633 case PKCS11_CKA_KEY_TYPE: 634 return id2str_key_type(type); 635 case PKCS11_CKA_MECHANISM_TYPE: 636 return id2str_mechanism(type); 637 default: 638 return str_unknown; 639 } 640 } 641 642 const char *id2str_proc(uint32_t id) 643 { 644 const char *str = ID2STR(id, string_internal_processing, 645 "PKCS11_PROCESSING_"); 646 647 if (str != unknown) 648 return str; 649 650 return id2str_mechanism(id); 651 } 652 653 const char *id2str_function(uint32_t id) 654 { 655 return ID2STR(id, string_functions, "PKCS11_FUNCTION_"); 656 } 657 #endif /*CFG_TEE_TA_LOG_LEVEL*/ 658