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