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