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