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