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