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