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