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