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_SLOT_ID_INVALID), 240 PKCS11_ID(PKCS11_CKR_GENERAL_ERROR), 241 PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED), 242 PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD), 243 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY), 244 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_SENSITIVE), 245 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID), 246 PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID), 247 PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED), 248 PKCS11_ID(PKCS11_CKR_DATA_LEN_RANGE), 249 PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY), 250 PKCS11_ID(PKCS11_CKR_ENCRYPTED_DATA_INVALID), 251 PKCS11_ID(PKCS11_CKR_ENCRYPTED_DATA_LEN_RANGE), 252 PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID), 253 PKCS11_ID(PKCS11_CKR_KEY_SIZE_RANGE), 254 PKCS11_ID(PKCS11_CKR_KEY_INDIGESTIBLE), 255 PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED), 256 PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID), 257 PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID), 258 PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID), 259 PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE), 260 PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED), 261 PKCS11_ID(PKCS11_CKR_PIN_INCORRECT), 262 PKCS11_ID(PKCS11_CKR_PIN_INVALID), 263 PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE), 264 PKCS11_ID(PKCS11_CKR_PIN_EXPIRED), 265 PKCS11_ID(PKCS11_CKR_PIN_LOCKED), 266 PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID), 267 PKCS11_ID(PKCS11_CKR_SESSION_PARALLEL_NOT_SUPPORTED), 268 PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY), 269 PKCS11_ID(PKCS11_CKR_SESSION_EXISTS), 270 PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS), 271 PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS), 272 PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID), 273 PKCS11_ID(PKCS11_CKR_SIGNATURE_LEN_RANGE), 274 PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE), 275 PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT), 276 PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT), 277 PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED), 278 PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED), 279 PKCS11_ID(PKCS11_CKR_UNWRAPPING_KEY_HANDLE_INVALID), 280 PKCS11_ID(PKCS11_CKR_UNWRAPPING_KEY_SIZE_RANGE), 281 PKCS11_ID(PKCS11_CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT), 282 PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN), 283 PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN), 284 PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED), 285 PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID), 286 PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN), 287 PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES), 288 PKCS11_ID(PKCS11_CKR_WRAPPED_KEY_INVALID), 289 PKCS11_ID(PKCS11_CKR_WRAPPED_KEY_LEN_RANGE), 290 PKCS11_ID(PKCS11_CKR_WRAPPING_KEY_HANDLE_INVALID), 291 PKCS11_ID(PKCS11_CKR_WRAPPING_KEY_SIZE_RANGE), 292 PKCS11_ID(PKCS11_CKR_WRAPPING_KEY_TYPE_INCONSISTENT), 293 PKCS11_ID(PKCS11_CKR_RANDOM_SEED_NOT_SUPPORTED), 294 PKCS11_ID(PKCS11_CKR_RANDOM_NO_RNG), 295 PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID), 296 PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED), 297 PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL), 298 PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK), 299 PKCS11_ID(PKCS11_RV_NOT_FOUND), 300 PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED), 301 }; 302 303 static const struct any_id __maybe_unused string_class[] = { 304 PKCS11_ID(PKCS11_CKO_SECRET_KEY), 305 PKCS11_ID(PKCS11_CKO_PUBLIC_KEY), 306 PKCS11_ID(PKCS11_CKO_PRIVATE_KEY), 307 PKCS11_ID(PKCS11_CKO_OTP_KEY), 308 PKCS11_ID(PKCS11_CKO_CERTIFICATE), 309 PKCS11_ID(PKCS11_CKO_DATA), 310 PKCS11_ID(PKCS11_CKO_DOMAIN_PARAMETERS), 311 PKCS11_ID(PKCS11_CKO_HW_FEATURE), 312 PKCS11_ID(PKCS11_CKO_MECHANISM), 313 PKCS11_ID(PKCS11_CKO_UNDEFINED_ID) 314 }; 315 316 static const struct any_id __maybe_unused string_key_type[] = { 317 PKCS11_ID(PKCS11_CKK_AES), 318 PKCS11_ID(PKCS11_CKK_GENERIC_SECRET), 319 PKCS11_ID(PKCS11_CKK_MD5_HMAC), 320 PKCS11_ID(PKCS11_CKK_SHA_1_HMAC), 321 PKCS11_ID(PKCS11_CKK_SHA224_HMAC), 322 PKCS11_ID(PKCS11_CKK_SHA256_HMAC), 323 PKCS11_ID(PKCS11_CKK_SHA384_HMAC), 324 PKCS11_ID(PKCS11_CKK_SHA512_HMAC), 325 PKCS11_ID(PKCS11_CKK_EC), 326 PKCS11_ID(PKCS11_CKK_RSA), 327 PKCS11_ID(PKCS11_CKK_UNDEFINED_ID) 328 }; 329 330 /* 331 * Processing IDs not exported in the TA API. 332 * PKCS11_CKM_* mechanism IDs are looked up from mechanism_string_id(). 333 */ 334 static const struct any_id __maybe_unused string_internal_processing[] = { 335 PKCS11_ID(PKCS11_PROCESSING_IMPORT), 336 }; 337 338 static const struct any_id __maybe_unused string_functions[] = { 339 PKCS11_ID(PKCS11_FUNCTION_DIGEST), 340 PKCS11_ID(PKCS11_FUNCTION_IMPORT), 341 PKCS11_ID(PKCS11_FUNCTION_ENCRYPT), 342 PKCS11_ID(PKCS11_FUNCTION_DECRYPT), 343 PKCS11_ID(PKCS11_FUNCTION_SIGN), 344 PKCS11_ID(PKCS11_FUNCTION_VERIFY), 345 PKCS11_ID(PKCS11_FUNCTION_DERIVE), 346 PKCS11_ID(PKCS11_FUNCTION_WRAP), 347 PKCS11_ID(PKCS11_FUNCTION_UNWRAP), 348 }; 349 350 /* 351 * Conversion between PKCS11 TA and GPD TEE return codes 352 */ 353 enum pkcs11_rc tee2pkcs_error(TEE_Result res) 354 { 355 switch (res) { 356 case TEE_SUCCESS: 357 return PKCS11_CKR_OK; 358 359 case TEE_ERROR_BAD_PARAMETERS: 360 return PKCS11_CKR_ARGUMENTS_BAD; 361 362 case TEE_ERROR_CIPHERTEXT_INVALID: 363 return PKCS11_CKR_ENCRYPTED_DATA_INVALID; 364 365 case TEE_ERROR_OUT_OF_MEMORY: 366 return PKCS11_CKR_DEVICE_MEMORY; 367 368 case TEE_ERROR_SHORT_BUFFER: 369 return PKCS11_CKR_BUFFER_TOO_SMALL; 370 371 case TEE_ERROR_MAC_INVALID: 372 case TEE_ERROR_SIGNATURE_INVALID: 373 return PKCS11_CKR_SIGNATURE_INVALID; 374 375 default: 376 return PKCS11_CKR_GENERAL_ERROR; 377 } 378 } 379 380 /* 381 * Helper functions to analyse PKCS11 identifiers 382 */ 383 384 /* Check attribute ID is known and size matches if fixed */ 385 bool valid_pkcs11_attribute_id(uint32_t id, uint32_t size) 386 { 387 size_t n = 0; 388 389 for (n = 0; n < ARRAY_SIZE(attr_ids); n++) 390 if (id == attr_ids[n].id) 391 return !attr_ids[n].size || size == attr_ids[n].size; 392 393 return false; 394 } 395 396 size_t pkcs11_attr_is_type(uint32_t attribute_id) 397 { 398 enum pkcs11_attr_id id = attribute_id; 399 400 switch (id) { 401 case PKCS11_CKA_KEY_TYPE: 402 case PKCS11_CKA_MECHANISM_TYPE: 403 case PKCS11_CKA_KEY_GEN_MECHANISM: 404 return sizeof(uint32_t); 405 default: 406 return 0; 407 } 408 } 409 410 bool pkcs11_attr_has_indirect_attributes(uint32_t attribute_id) 411 { 412 switch (attribute_id) { 413 case PKCS11_CKA_WRAP_TEMPLATE: 414 case PKCS11_CKA_UNWRAP_TEMPLATE: 415 case PKCS11_CKA_DERIVE_TEMPLATE: 416 return true; 417 default: 418 return false; 419 } 420 } 421 422 bool pkcs11_class_has_type(uint32_t class) 423 { 424 enum pkcs11_class_id class_id = class; 425 426 switch (class_id) { 427 case PKCS11_CKO_CERTIFICATE: 428 case PKCS11_CKO_PUBLIC_KEY: 429 case PKCS11_CKO_PRIVATE_KEY: 430 case PKCS11_CKO_SECRET_KEY: 431 case PKCS11_CKO_MECHANISM: 432 case PKCS11_CKO_HW_FEATURE: 433 return true; 434 default: 435 return false; 436 } 437 } 438 439 bool pkcs11_attr_class_is_key(uint32_t class) 440 { 441 enum pkcs11_class_id class_id = class; 442 443 switch (class_id) { 444 case PKCS11_CKO_SECRET_KEY: 445 case PKCS11_CKO_PUBLIC_KEY: 446 case PKCS11_CKO_PRIVATE_KEY: 447 return true; 448 default: 449 return false; 450 } 451 } 452 453 bool key_type_is_symm_key(uint32_t id) 454 { 455 enum pkcs11_key_type key_type = id; 456 457 switch (key_type) { 458 case PKCS11_CKK_AES: 459 case PKCS11_CKK_GENERIC_SECRET: 460 case PKCS11_CKK_MD5_HMAC: 461 case PKCS11_CKK_SHA_1_HMAC: 462 case PKCS11_CKK_SHA224_HMAC: 463 case PKCS11_CKK_SHA256_HMAC: 464 case PKCS11_CKK_SHA384_HMAC: 465 case PKCS11_CKK_SHA512_HMAC: 466 return true; 467 default: 468 return false; 469 } 470 } 471 472 bool key_type_is_asymm_key(uint32_t id) 473 { 474 enum pkcs11_key_type key_type = id; 475 476 switch (key_type) { 477 case PKCS11_CKK_EC: 478 case PKCS11_CKK_RSA: 479 return true; 480 default: 481 return false; 482 } 483 } 484 485 /* 486 * Returns shift position or -1 on error. 487 * Mainly used when PKCS11_SHEAD_WITH_BOOLPROPS is enabled 488 */ 489 int pkcs11_attr2boolprop_shift(uint32_t attr) 490 { 491 static const uint32_t bpa[] = { 492 [BPA_TOKEN] = PKCS11_CKA_TOKEN, 493 [BPA_PRIVATE] = PKCS11_CKA_PRIVATE, 494 [BPA_TRUSTED] = PKCS11_CKA_TRUSTED, 495 [BPA_SENSITIVE] = PKCS11_CKA_SENSITIVE, 496 [BPA_ENCRYPT] = PKCS11_CKA_ENCRYPT, 497 [BPA_DECRYPT] = PKCS11_CKA_DECRYPT, 498 [BPA_WRAP] = PKCS11_CKA_WRAP, 499 [BPA_UNWRAP] = PKCS11_CKA_UNWRAP, 500 [BPA_SIGN] = PKCS11_CKA_SIGN, 501 [BPA_SIGN_RECOVER] = PKCS11_CKA_SIGN_RECOVER, 502 [BPA_VERIFY] = PKCS11_CKA_VERIFY, 503 [BPA_VERIFY_RECOVER] = PKCS11_CKA_VERIFY_RECOVER, 504 [BPA_DERIVE] = PKCS11_CKA_DERIVE, 505 [BPA_EXTRACTABLE] = PKCS11_CKA_EXTRACTABLE, 506 [BPA_LOCAL] = PKCS11_CKA_LOCAL, 507 [BPA_NEVER_EXTRACTABLE] = PKCS11_CKA_NEVER_EXTRACTABLE, 508 [BPA_ALWAYS_SENSITIVE] = PKCS11_CKA_ALWAYS_SENSITIVE, 509 [BPA_MODIFIABLE] = PKCS11_CKA_MODIFIABLE, 510 [BPA_COPYABLE] = PKCS11_CKA_COPYABLE, 511 [BPA_DESTROYABLE] = PKCS11_CKA_DESTROYABLE, 512 [BPA_ALWAYS_AUTHENTICATE] = PKCS11_CKA_ALWAYS_AUTHENTICATE, 513 [BPA_WRAP_WITH_TRUSTED] = PKCS11_CKA_WRAP_WITH_TRUSTED, 514 }; 515 size_t pos = 0; 516 517 for (pos = 0; pos < ARRAY_SIZE(bpa); pos++) 518 if (bpa[pos] == attr) 519 return (int)pos; 520 521 return -1; 522 } 523 524 /* Initialize a TEE attribute for a target PKCS11 TA attribute in an object */ 525 bool pkcs2tee_load_attr(TEE_Attribute *tee_ref, uint32_t tee_id, 526 struct pkcs11_object *obj, 527 enum pkcs11_attr_id pkcs11_id) 528 { 529 void *a_ptr = NULL; 530 uint8_t *der_ptr = NULL; 531 uint32_t a_size = 0; 532 uint32_t data32 = 0; 533 size_t hsize = 0; 534 size_t qsize = 0; 535 536 switch (tee_id) { 537 case TEE_ATTR_ECC_PUBLIC_VALUE_X: 538 case TEE_ATTR_ECC_PUBLIC_VALUE_Y: 539 case TEE_ATTR_ECC_CURVE: 540 if (get_attribute_ptr(obj->attributes, PKCS11_CKA_EC_PARAMS, 541 &a_ptr, &a_size) || !a_ptr) { 542 EMSG("Missing EC_PARAMS attribute"); 543 return false; 544 } 545 546 if (tee_id == TEE_ATTR_ECC_CURVE) { 547 data32 = ec_params2tee_curve(a_ptr, a_size); 548 TEE_InitValueAttribute(tee_ref, TEE_ATTR_ECC_CURVE, 549 data32, 0); 550 return true; 551 } 552 553 data32 = (ec_params2tee_keysize(a_ptr, a_size) + 7) / 8; 554 555 if (get_attribute_ptr(obj->attributes, PKCS11_CKA_EC_POINT, 556 &a_ptr, &a_size)) { 557 /* 558 * Public X/Y is required for both TEE keypair and 559 * public key, so abort if EC_POINT is not provided 560 * during object import. 561 */ 562 563 EMSG("Missing EC_POINT attribute"); 564 return false; 565 } 566 567 der_ptr = (uint8_t *)a_ptr; 568 569 if (der_ptr[0] != 0x04) { 570 EMSG("Unsupported DER type"); 571 return false; 572 } 573 574 if ((der_ptr[1] & 0x80) == 0) { 575 /* DER short definitive form up to 127 bytes */ 576 qsize = der_ptr[1] & 0x7F; 577 hsize = 2 /* der */ + 1 /* point compression */; 578 } else if (der_ptr[1] == 0x81) { 579 /* DER long definitive form up to 255 bytes */ 580 qsize = der_ptr[2]; 581 hsize = 3 /* der */ + 1 /* point compression */; 582 } else { 583 EMSG("Unsupported DER long form"); 584 return false; 585 } 586 587 if (der_ptr[hsize - 1] != 0x04) { 588 EMSG("Unsupported EC_POINT compression"); 589 return false; 590 } 591 592 if (a_size != (hsize - 1) + qsize) { 593 EMSG("Invalid EC_POINT attribute"); 594 return false; 595 } 596 597 if (a_size != hsize + 2 * data32) { 598 EMSG("Invalid EC_POINT attribute"); 599 return false; 600 } 601 602 if (tee_id == TEE_ATTR_ECC_PUBLIC_VALUE_X) 603 TEE_InitRefAttribute(tee_ref, tee_id, 604 der_ptr + hsize, data32); 605 else 606 TEE_InitRefAttribute(tee_ref, tee_id, 607 der_ptr + hsize + data32, 608 data32); 609 610 return true; 611 612 default: 613 break; 614 } 615 616 if (get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size)) 617 return false; 618 619 TEE_InitRefAttribute(tee_ref, tee_id, a_ptr, a_size); 620 621 return true; 622 } 623 624 /* 625 * Initialize a TEE attribute with hash of a target PKCS11 TA attribute 626 * in an object. 627 */ 628 enum pkcs11_rc pkcs2tee_load_hashed_attr(TEE_Attribute *tee_ref, 629 uint32_t tee_id, 630 struct pkcs11_object *obj, 631 enum pkcs11_attr_id pkcs11_id, 632 uint32_t tee_algo, void *hash_ptr, 633 uint32_t *hash_size) 634 { 635 TEE_OperationHandle handle = TEE_HANDLE_NULL; 636 void *a_ptr = NULL; 637 uint32_t a_size = 0; 638 enum pkcs11_rc rc = PKCS11_CKR_OK; 639 TEE_Result res = TEE_ERROR_GENERIC; 640 641 rc = get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size); 642 if (rc) 643 return rc; 644 645 res = TEE_AllocateOperation(&handle, tee_algo, TEE_MODE_DIGEST, 0); 646 if (res) { 647 EMSG("TEE_AllocateOperation() failed %#"PRIx32, tee_algo); 648 return tee2pkcs_error(res); 649 } 650 651 res = TEE_DigestDoFinal(handle, a_ptr, a_size, hash_ptr, hash_size); 652 TEE_FreeOperation(handle); 653 if (res) { 654 EMSG("TEE_DigestDoFinal() failed %#"PRIx32, tee_algo); 655 return PKCS11_CKR_FUNCTION_FAILED; 656 } 657 658 TEE_InitRefAttribute(tee_ref, tee_id, hash_ptr, *hash_size); 659 660 return PKCS11_CKR_OK; 661 } 662 663 /* Easy conversion between PKCS11 TA function of TEE crypto mode */ 664 void pkcs2tee_mode(uint32_t *tee_id, enum processing_func function) 665 { 666 switch (function) { 667 case PKCS11_FUNCTION_ENCRYPT: 668 *tee_id = TEE_MODE_ENCRYPT; 669 break; 670 case PKCS11_FUNCTION_DECRYPT: 671 *tee_id = TEE_MODE_DECRYPT; 672 break; 673 case PKCS11_FUNCTION_SIGN: 674 *tee_id = TEE_MODE_SIGN; 675 break; 676 case PKCS11_FUNCTION_VERIFY: 677 *tee_id = TEE_MODE_VERIFY; 678 break; 679 case PKCS11_FUNCTION_DERIVE: 680 *tee_id = TEE_MODE_DERIVE; 681 break; 682 case PKCS11_FUNCTION_DIGEST: 683 *tee_id = TEE_MODE_DIGEST; 684 break; 685 default: 686 TEE_Panic(function); 687 } 688 } 689 690 #if CFG_TEE_TA_LOG_LEVEL > 0 691 const char *id2str_rc(uint32_t id) 692 { 693 return ID2STR(id, string_rc, "PKCS11_CKR_"); 694 } 695 696 const char *id2str_ta_cmd(uint32_t id) 697 { 698 return ID2STR(id, string_ta_cmd, NULL); 699 } 700 701 const char *id2str_slot_flag(uint32_t id) 702 { 703 return ID2STR(id, string_slot_flags, "PKCS11_CKFS_"); 704 } 705 706 const char *id2str_token_flag(uint32_t id) 707 { 708 return ID2STR(id, string_token_flags, "PKCS11_CKFT_"); 709 } 710 711 const char *id2str_session_flag(uint32_t id) 712 { 713 return ID2STR(id, string_session_flags, "PKCS11_CKFSS_"); 714 } 715 716 const char *id2str_session_state(uint32_t id) 717 { 718 return ID2STR(id, string_session_state, "PKCS11_CKS_"); 719 } 720 721 const char *id2str_attr(uint32_t id) 722 { 723 size_t n = 0; 724 725 for (n = 0; n < ARRAY_SIZE(attr_ids); n++) { 726 if (id == attr_ids[n].id) { 727 /* Skip PKCS11_CKA_ prefix */ 728 return attr_ids[n].string + strlen("PKCS11_CKA_"); 729 } 730 } 731 732 return unknown; 733 } 734 735 const char *id2str_class(uint32_t id) 736 { 737 return ID2STR(id, string_class, "PKCS11_CKO_"); 738 } 739 740 const char *id2str_type(uint32_t id, uint32_t class) 741 { 742 enum pkcs11_class_id class_id = class; 743 enum pkcs11_key_type key_type = id; 744 745 switch (class_id) { 746 case PKCS11_CKO_SECRET_KEY: 747 case PKCS11_CKO_PUBLIC_KEY: 748 case PKCS11_CKO_PRIVATE_KEY: 749 return id2str_key_type(key_type); 750 default: 751 return unknown; 752 } 753 } 754 755 const char *id2str_key_type(uint32_t id) 756 { 757 return ID2STR(id, string_key_type, "PKCS11_CKK_"); 758 } 759 760 const char *id2str_attr_value(uint32_t id, size_t size, void *value) 761 { 762 static const char str_true[] = "TRUE"; 763 static const char str_false[] = "FALSE"; 764 static const char str_unknown[] = "*"; 765 uint32_t type = 0; 766 767 if (pkcs11_attr2boolprop_shift(id) >= 0) 768 return *(uint8_t *)value ? str_true : str_false; 769 770 if (size < sizeof(uint32_t)) 771 return str_unknown; 772 773 TEE_MemMove(&type, value, sizeof(uint32_t)); 774 775 switch (id) { 776 case PKCS11_CKA_CLASS: 777 return id2str_class(type); 778 case PKCS11_CKA_KEY_TYPE: 779 return id2str_key_type(type); 780 case PKCS11_CKA_MECHANISM_TYPE: 781 return id2str_mechanism(type); 782 default: 783 return str_unknown; 784 } 785 } 786 787 const char *id2str_proc(uint32_t id) 788 { 789 const char *str = ID2STR(id, string_internal_processing, 790 "PKCS11_PROCESSING_"); 791 792 if (str != unknown) 793 return str; 794 795 return id2str_mechanism(id); 796 } 797 798 const char *id2str_function(uint32_t id) 799 { 800 return ID2STR(id, string_functions, "PKCS11_FUNCTION_"); 801 } 802 #endif /*CFG_TEE_TA_LOG_LEVEL*/ 803