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