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