1f7d7fcd9SEtienne Carriere // SPDX-License-Identifier: BSD-2-Clause 2f7d7fcd9SEtienne Carriere /* 3f7d7fcd9SEtienne Carriere * Copyright (c) 2018-2020, Linaro Limited 4f7d7fcd9SEtienne Carriere */ 5f7d7fcd9SEtienne Carriere 6f7d7fcd9SEtienne Carriere #include <pkcs11_ta.h> 7f7d7fcd9SEtienne Carriere #include <string.h> 8f7d7fcd9SEtienne Carriere #include <tee_internal_api.h> 9f7d7fcd9SEtienne Carriere #include <util.h> 10f7d7fcd9SEtienne Carriere 1163f89caaSJens Wiklander #include "attributes.h" 12*512cbf1dSJens Wiklander #include "object.h" 1363f89caaSJens Wiklander #include "pkcs11_attributes.h" 14f7d7fcd9SEtienne Carriere #include "pkcs11_helpers.h" 15f7d7fcd9SEtienne Carriere 16f7d7fcd9SEtienne Carriere static const char __maybe_unused unknown[] = "<unknown-identifier>"; 17f7d7fcd9SEtienne Carriere 1863f89caaSJens Wiklander struct attr_size { 1963f89caaSJens Wiklander uint32_t id; 2063f89caaSJens Wiklander uint32_t size; 2163f89caaSJens Wiklander #if CFG_TEE_TA_LOG_LEVEL > 0 2263f89caaSJens Wiklander const char *string; 2363f89caaSJens Wiklander #endif 2463f89caaSJens Wiklander }; 2563f89caaSJens Wiklander 2663f89caaSJens Wiklander #if CFG_TEE_TA_LOG_LEVEL > 0 2763f89caaSJens Wiklander #define PKCS11_ID_SZ(_id, _sz) \ 2863f89caaSJens Wiklander { .id = (uint32_t)(_id), .size = (_sz), .string = #_id } 2963f89caaSJens Wiklander #else 3063f89caaSJens Wiklander #define PKCS11_ID_SZ(_id, _sz) \ 3163f89caaSJens Wiklander { .id = (uint32_t)(_id), .size = (_sz) } 3263f89caaSJens Wiklander #endif 3363f89caaSJens Wiklander 3463f89caaSJens Wiklander static const struct attr_size attr_ids[] = { 3563f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_CLASS, 4), 3663f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_KEY_TYPE, 4), 3763f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_VALUE, 0), 3863f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_VALUE_LEN, 4), 3963f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_LABEL, 0), 4063f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_WRAP_TEMPLATE, 0), 4163f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_UNWRAP_TEMPLATE, 0), 4263f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_DERIVE_TEMPLATE, 0), 4363f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_START_DATE, 4), 4463f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_END_DATE, 4), 4563f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_OBJECT_ID, 0), 4663f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_APPLICATION, 0), 4763f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_MECHANISM_TYPE, 4), 4863f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_ID, 0), 4963f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_ALLOWED_MECHANISMS, 0), 5063f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_EC_POINT, 0), 5163f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_EC_PARAMS, 0), 5263f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_MODULUS, 0), 5363f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_MODULUS_BITS, 4), 5463f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_EXPONENT, 0), 5563f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_PRIVATE_EXPONENT, 0), 5663f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_PRIME_1, 0), 5763f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_PRIME_2, 0), 5863f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_1, 0), 5963f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_2, 0), 6063f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_COEFFICIENT, 0), 6163f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_SUBJECT, 0), 6263f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_KEY_INFO, 0), 6363f89caaSJens Wiklander /* Below are boolean attributes */ 6463f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_TOKEN, 1), 6563f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_PRIVATE, 1), 6663f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_TRUSTED, 1), 6763f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_SENSITIVE, 1), 6863f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_ENCRYPT, 1), 6963f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_DECRYPT, 1), 7063f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_WRAP, 1), 7163f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_UNWRAP, 1), 7263f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_SIGN, 1), 7363f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_SIGN_RECOVER, 1), 7463f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_VERIFY, 1), 7563f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_VERIFY_RECOVER, 1), 7663f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_DERIVE, 1), 7763f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_EXTRACTABLE, 1), 7863f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_LOCAL, 1), 7963f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_NEVER_EXTRACTABLE, 1), 8063f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_SENSITIVE, 1), 8163f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_MODIFIABLE, 1), 8263f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_COPYABLE, 1), 8363f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_DESTROYABLE, 1), 8463f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_AUTHENTICATE, 1), 8563f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_WRAP_WITH_TRUSTED, 1), 8663f89caaSJens Wiklander /* Specific PKCS11 TA internal attribute ID */ 8763f89caaSJens Wiklander PKCS11_ID_SZ(PKCS11_CKA_UNDEFINED_ID, 0), 8863f89caaSJens Wiklander }; 8963f89caaSJens Wiklander 90f7d7fcd9SEtienne Carriere struct any_id { 91f7d7fcd9SEtienne Carriere uint32_t id; 92f7d7fcd9SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0 93f7d7fcd9SEtienne Carriere const char *string; 94f7d7fcd9SEtienne Carriere #endif 95f7d7fcd9SEtienne Carriere }; 96f7d7fcd9SEtienne Carriere 97f7d7fcd9SEtienne Carriere /* 98f7d7fcd9SEtienne Carriere * Macro PKCS11_ID() can be used to define cells in ID list arrays 99f7d7fcd9SEtienne Carriere * or ID/string conversion arrays. 100f7d7fcd9SEtienne Carriere */ 101f7d7fcd9SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0 102f7d7fcd9SEtienne Carriere #define PKCS11_ID(_id) { .id = _id, .string = #_id } 103f7d7fcd9SEtienne Carriere #else 104f7d7fcd9SEtienne Carriere #define PKCS11_ID(_id) { .id = _id } 105f7d7fcd9SEtienne Carriere #endif 106f7d7fcd9SEtienne Carriere 107f7d7fcd9SEtienne Carriere #define ID2STR(id, table, prefix) \ 108f7d7fcd9SEtienne Carriere id2str(id, table, ARRAY_SIZE(table), prefix) 109f7d7fcd9SEtienne Carriere 11060290f69SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0 111f7d7fcd9SEtienne Carriere /* Convert a PKCS11 ID into its label string */ 11260290f69SEtienne Carriere static const char *id2str(uint32_t id, const struct any_id *table, 113f7d7fcd9SEtienne Carriere size_t count, const char *prefix) 114f7d7fcd9SEtienne Carriere { 115f7d7fcd9SEtienne Carriere size_t n = 0; 116f7d7fcd9SEtienne Carriere const char *str = NULL; 117f7d7fcd9SEtienne Carriere 118f7d7fcd9SEtienne Carriere for (n = 0; n < count; n++) { 119f7d7fcd9SEtienne Carriere if (id != table[n].id) 120f7d7fcd9SEtienne Carriere continue; 121f7d7fcd9SEtienne Carriere 122f7d7fcd9SEtienne Carriere str = table[n].string; 123f7d7fcd9SEtienne Carriere 124f7d7fcd9SEtienne Carriere /* Skip prefix provided matches found */ 125f7d7fcd9SEtienne Carriere if (prefix && !TEE_MemCompare(str, prefix, strlen(prefix))) 126f7d7fcd9SEtienne Carriere str += strlen(prefix); 127f7d7fcd9SEtienne Carriere 128f7d7fcd9SEtienne Carriere return str; 129f7d7fcd9SEtienne Carriere } 130f7d7fcd9SEtienne Carriere 131f7d7fcd9SEtienne Carriere return unknown; 132f7d7fcd9SEtienne Carriere } 13360290f69SEtienne Carriere #endif /* CFG_TEE_TA_LOG_LEVEL > 0 */ 134f7d7fcd9SEtienne Carriere 135f7d7fcd9SEtienne Carriere /* 136f7d7fcd9SEtienne Carriere * TA command IDs: used only as ID/string conversion for debug trace support 137f7d7fcd9SEtienne Carriere */ 138f7d7fcd9SEtienne Carriere static const struct any_id __maybe_unused string_ta_cmd[] = { 139f7d7fcd9SEtienne Carriere PKCS11_ID(PKCS11_CMD_PING), 140a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CMD_SLOT_LIST), 141a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CMD_SLOT_INFO), 142a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CMD_TOKEN_INFO), 143d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CMD_MECHANISM_IDS), 144d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CMD_MECHANISM_INFO), 145d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CMD_OPEN_SESSION), 146d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CMD_SESSION_INFO), 147d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CMD_CLOSE_SESSION), 148d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CMD_CLOSE_ALL_SESSIONS), 149ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_INIT_TOKEN), 150ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_INIT_PIN), 151ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_SET_PIN), 152ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_LOGIN), 153ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_LOGOUT), 154ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_CREATE_OBJECT), 155ddf63ac3SEtienne Carriere PKCS11_ID(PKCS11_CMD_DESTROY_OBJECT), 156*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_ENCRYPT_INIT), 157*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_DECRYPT_INIT), 158*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_ENCRYPT_UPDATE), 159*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_DECRYPT_UPDATE), 160*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_ENCRYPT_FINAL), 161*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_DECRYPT_FINAL), 162*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_ENCRYPT_ONESHOT), 163*512cbf1dSJens Wiklander PKCS11_ID(PKCS11_CMD_DECRYPT_ONESHOT), 164a67dc424SEtienne Carriere }; 165a67dc424SEtienne Carriere 166a67dc424SEtienne Carriere static const struct any_id __maybe_unused string_slot_flags[] = { 167a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFS_TOKEN_PRESENT), 168a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFS_REMOVABLE_DEVICE), 169a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFS_HW_SLOT), 170a67dc424SEtienne Carriere }; 171a67dc424SEtienne Carriere 172a67dc424SEtienne Carriere static const struct any_id __maybe_unused string_token_flags[] = { 173a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_RNG), 174a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_WRITE_PROTECTED), 175a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_LOGIN_REQUIRED), 176a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_USER_PIN_INITIALIZED), 177a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED), 178a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_CLOCK_ON_TOKEN), 179a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH), 180a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS), 181a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_TOKEN_INITIALIZED), 182a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_USER_PIN_COUNT_LOW), 183a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_USER_PIN_FINAL_TRY), 184a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_USER_PIN_LOCKED), 185a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_USER_PIN_TO_BE_CHANGED), 186a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_SO_PIN_COUNT_LOW), 187a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_SO_PIN_FINAL_TRY), 188a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_SO_PIN_LOCKED), 189a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_SO_PIN_TO_BE_CHANGED), 190a67dc424SEtienne Carriere PKCS11_ID(PKCS11_CKFT_ERROR_STATE), 191f7d7fcd9SEtienne Carriere }; 192f7d7fcd9SEtienne Carriere 193d21ec5f4SEtienne Carriere static const struct any_id __maybe_unused string_session_flags[] = { 194d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKFSS_RW_SESSION), 195d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKFSS_SERIAL_SESSION), 196d21ec5f4SEtienne Carriere }; 197d21ec5f4SEtienne Carriere 198d21ec5f4SEtienne Carriere static const struct any_id __maybe_unused string_session_state[] = { 199d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKS_RO_PUBLIC_SESSION), 200d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKS_RO_USER_FUNCTIONS), 201d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKS_RW_PUBLIC_SESSION), 202d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKS_RW_USER_FUNCTIONS), 203d21ec5f4SEtienne Carriere PKCS11_ID(PKCS11_CKS_RW_SO_FUNCTIONS), 204d21ec5f4SEtienne Carriere }; 205d21ec5f4SEtienne Carriere 206d34f3266SEtienne Carriere static const struct any_id __maybe_unused string_rc[] = { 207d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_OK), 208d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_GENERAL_ERROR), 209d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY), 210d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD), 211d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL), 212d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED), 213d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID), 214d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID), 215d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID), 216d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID), 217d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID), 218d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID), 219d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID), 220d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SLOT_ID_INVALID), 221d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID), 222d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT), 223d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE), 224d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_PIN_INCORRECT), 225d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_PIN_LOCKED), 226d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_PIN_EXPIRED), 227d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_PIN_INVALID), 228d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE), 229d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SESSION_EXISTS), 230d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY), 231d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS), 232d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE), 233d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED), 234d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED), 235d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED), 236d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT), 237d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED), 238d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED), 239d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY), 240d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK), 241d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED), 242d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID), 243d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN), 244d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN), 245d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN), 246d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED), 247d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES), 248d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID), 249d34f3266SEtienne Carriere PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS), 250d34f3266SEtienne Carriere PKCS11_ID(PKCS11_RV_NOT_FOUND), 251d34f3266SEtienne Carriere PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED), 252d34f3266SEtienne Carriere }; 253d34f3266SEtienne Carriere 25463f89caaSJens Wiklander static const struct any_id __maybe_unused string_class[] = { 25563f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_SECRET_KEY), 25663f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_PUBLIC_KEY), 25763f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_PRIVATE_KEY), 25863f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_OTP_KEY), 25963f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_CERTIFICATE), 26063f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_DATA), 26163f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_DOMAIN_PARAMETERS), 26263f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_HW_FEATURE), 26363f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_MECHANISM), 26463f89caaSJens Wiklander PKCS11_ID(PKCS11_CKO_UNDEFINED_ID) 26563f89caaSJens Wiklander }; 26663f89caaSJens Wiklander 26763f89caaSJens Wiklander static const struct any_id __maybe_unused string_key_type[] = { 26863f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_AES), 26963f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_GENERIC_SECRET), 27063f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_MD5_HMAC), 27163f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_SHA_1_HMAC), 27263f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_SHA224_HMAC), 27363f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_SHA256_HMAC), 27463f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_SHA384_HMAC), 27563f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_SHA512_HMAC), 27663f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_EC), 27763f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_RSA), 27863f89caaSJens Wiklander PKCS11_ID(PKCS11_CKK_UNDEFINED_ID) 27963f89caaSJens Wiklander }; 28063f89caaSJens Wiklander 28163f89caaSJens Wiklander /* 28263f89caaSJens Wiklander * Processing IDs not exported in the TA API. 28363f89caaSJens Wiklander * PKCS11_CKM_* mechanism IDs are looked up from mechanism_string_id(). 28463f89caaSJens Wiklander */ 28563f89caaSJens Wiklander static const struct any_id __maybe_unused string_internal_processing[] = { 28663f89caaSJens Wiklander PKCS11_ID(PKCS11_PROCESSING_IMPORT), 28763f89caaSJens Wiklander }; 28863f89caaSJens Wiklander 28963f89caaSJens Wiklander static const struct any_id __maybe_unused string_functions[] = { 29063f89caaSJens Wiklander PKCS11_ID(PKCS11_FUNCTION_IMPORT), 29163f89caaSJens Wiklander }; 29263f89caaSJens Wiklander 2938e03579eSJens Wiklander /* 2948e03579eSJens Wiklander * Conversion between PKCS11 TA and GPD TEE return codes 2958e03579eSJens Wiklander */ 2968e03579eSJens Wiklander enum pkcs11_rc tee2pkcs_error(TEE_Result res) 2978e03579eSJens Wiklander { 2988e03579eSJens Wiklander switch (res) { 2998e03579eSJens Wiklander case TEE_SUCCESS: 3008e03579eSJens Wiklander return PKCS11_CKR_OK; 3018e03579eSJens Wiklander 3028e03579eSJens Wiklander case TEE_ERROR_BAD_PARAMETERS: 3038e03579eSJens Wiklander return PKCS11_CKR_ARGUMENTS_BAD; 3048e03579eSJens Wiklander 3058e03579eSJens Wiklander case TEE_ERROR_OUT_OF_MEMORY: 3068e03579eSJens Wiklander return PKCS11_CKR_DEVICE_MEMORY; 3078e03579eSJens Wiklander 3088e03579eSJens Wiklander case TEE_ERROR_SHORT_BUFFER: 3098e03579eSJens Wiklander return PKCS11_CKR_BUFFER_TOO_SMALL; 3108e03579eSJens Wiklander 3118e03579eSJens Wiklander case TEE_ERROR_MAC_INVALID: 3128e03579eSJens Wiklander case TEE_ERROR_SIGNATURE_INVALID: 3138e03579eSJens Wiklander return PKCS11_CKR_SIGNATURE_INVALID; 3148e03579eSJens Wiklander 3158e03579eSJens Wiklander default: 3168e03579eSJens Wiklander return PKCS11_CKR_GENERAL_ERROR; 3178e03579eSJens Wiklander } 3188e03579eSJens Wiklander } 3198e03579eSJens Wiklander 32063f89caaSJens Wiklander /* 32163f89caaSJens Wiklander * Helper functions to analyse PKCS11 identifiers 32263f89caaSJens Wiklander */ 32363f89caaSJens Wiklander 32463f89caaSJens Wiklander /* Check attribute ID is known and size matches if fixed */ 32563f89caaSJens Wiklander bool valid_pkcs11_attribute_id(uint32_t id, uint32_t size) 32663f89caaSJens Wiklander { 32763f89caaSJens Wiklander size_t n = 0; 32863f89caaSJens Wiklander 32963f89caaSJens Wiklander for (n = 0; n < ARRAY_SIZE(attr_ids); n++) 33063f89caaSJens Wiklander if (id == attr_ids[n].id) 33163f89caaSJens Wiklander return !attr_ids[n].size || size == attr_ids[n].size; 33263f89caaSJens Wiklander 33363f89caaSJens Wiklander return false; 33463f89caaSJens Wiklander } 33563f89caaSJens Wiklander 33663f89caaSJens Wiklander size_t pkcs11_attr_is_type(uint32_t attribute_id) 33763f89caaSJens Wiklander { 33863f89caaSJens Wiklander enum pkcs11_attr_id id = attribute_id; 33963f89caaSJens Wiklander 34063f89caaSJens Wiklander switch (id) { 34163f89caaSJens Wiklander case PKCS11_CKA_KEY_TYPE: 34263f89caaSJens Wiklander case PKCS11_CKA_MECHANISM_TYPE: 34363f89caaSJens Wiklander case PKCS11_CKA_KEY_GEN_MECHANISM: 34463f89caaSJens Wiklander return sizeof(uint32_t); 34563f89caaSJens Wiklander default: 34663f89caaSJens Wiklander return 0; 34763f89caaSJens Wiklander } 34863f89caaSJens Wiklander } 34963f89caaSJens Wiklander 35063f89caaSJens Wiklander bool pkcs11_class_has_type(uint32_t class) 35163f89caaSJens Wiklander { 35263f89caaSJens Wiklander enum pkcs11_class_id class_id = class; 35363f89caaSJens Wiklander 35463f89caaSJens Wiklander switch (class_id) { 35563f89caaSJens Wiklander case PKCS11_CKO_CERTIFICATE: 35663f89caaSJens Wiklander case PKCS11_CKO_PUBLIC_KEY: 35763f89caaSJens Wiklander case PKCS11_CKO_PRIVATE_KEY: 35863f89caaSJens Wiklander case PKCS11_CKO_SECRET_KEY: 35963f89caaSJens Wiklander case PKCS11_CKO_MECHANISM: 36063f89caaSJens Wiklander case PKCS11_CKO_HW_FEATURE: 36163f89caaSJens Wiklander return true; 36263f89caaSJens Wiklander default: 36363f89caaSJens Wiklander return false; 36463f89caaSJens Wiklander } 36563f89caaSJens Wiklander } 36663f89caaSJens Wiklander 36763f89caaSJens Wiklander bool pkcs11_attr_class_is_key(uint32_t class) 36863f89caaSJens Wiklander { 36963f89caaSJens Wiklander enum pkcs11_class_id class_id = class; 37063f89caaSJens Wiklander 37163f89caaSJens Wiklander switch (class_id) { 37263f89caaSJens Wiklander case PKCS11_CKO_SECRET_KEY: 37363f89caaSJens Wiklander case PKCS11_CKO_PUBLIC_KEY: 37463f89caaSJens Wiklander case PKCS11_CKO_PRIVATE_KEY: 37563f89caaSJens Wiklander return true; 37663f89caaSJens Wiklander default: 37763f89caaSJens Wiklander return false; 37863f89caaSJens Wiklander } 37963f89caaSJens Wiklander } 38063f89caaSJens Wiklander 38163f89caaSJens Wiklander bool key_type_is_symm_key(uint32_t id) 38263f89caaSJens Wiklander { 38363f89caaSJens Wiklander enum pkcs11_key_type key_type = id; 38463f89caaSJens Wiklander 38563f89caaSJens Wiklander switch (key_type) { 38663f89caaSJens Wiklander case PKCS11_CKK_AES: 38763f89caaSJens Wiklander case PKCS11_CKK_GENERIC_SECRET: 38863f89caaSJens Wiklander case PKCS11_CKK_MD5_HMAC: 38963f89caaSJens Wiklander case PKCS11_CKK_SHA_1_HMAC: 39063f89caaSJens Wiklander case PKCS11_CKK_SHA224_HMAC: 39163f89caaSJens Wiklander case PKCS11_CKK_SHA256_HMAC: 39263f89caaSJens Wiklander case PKCS11_CKK_SHA384_HMAC: 39363f89caaSJens Wiklander case PKCS11_CKK_SHA512_HMAC: 39463f89caaSJens Wiklander return true; 39563f89caaSJens Wiklander default: 39663f89caaSJens Wiklander return false; 39763f89caaSJens Wiklander } 39863f89caaSJens Wiklander } 39963f89caaSJens Wiklander 40063f89caaSJens Wiklander bool key_type_is_asymm_key(uint32_t id) 40163f89caaSJens Wiklander { 40263f89caaSJens Wiklander enum pkcs11_key_type key_type = id; 40363f89caaSJens Wiklander 40463f89caaSJens Wiklander switch (key_type) { 40563f89caaSJens Wiklander case PKCS11_CKK_EC: 40663f89caaSJens Wiklander case PKCS11_CKK_RSA: 40763f89caaSJens Wiklander return true; 40863f89caaSJens Wiklander default: 40963f89caaSJens Wiklander return false; 41063f89caaSJens Wiklander } 41163f89caaSJens Wiklander } 41263f89caaSJens Wiklander 41363f89caaSJens Wiklander /* 41463f89caaSJens Wiklander * Returns shift position or -1 on error. 41563f89caaSJens Wiklander * Mainly used when PKCS11_SHEAD_WITH_BOOLPROPS is enabled 41663f89caaSJens Wiklander */ 41763f89caaSJens Wiklander int pkcs11_attr2boolprop_shift(uint32_t attr) 41863f89caaSJens Wiklander { 41963f89caaSJens Wiklander static const uint32_t bpa[] = { 42063f89caaSJens Wiklander [BPA_TOKEN] = PKCS11_CKA_TOKEN, 42163f89caaSJens Wiklander [BPA_PRIVATE] = PKCS11_CKA_PRIVATE, 42263f89caaSJens Wiklander [BPA_TRUSTED] = PKCS11_CKA_TRUSTED, 42363f89caaSJens Wiklander [BPA_SENSITIVE] = PKCS11_CKA_SENSITIVE, 42463f89caaSJens Wiklander [BPA_ENCRYPT] = PKCS11_CKA_ENCRYPT, 42563f89caaSJens Wiklander [BPA_DECRYPT] = PKCS11_CKA_DECRYPT, 42663f89caaSJens Wiklander [BPA_WRAP] = PKCS11_CKA_WRAP, 42763f89caaSJens Wiklander [BPA_UNWRAP] = PKCS11_CKA_UNWRAP, 42863f89caaSJens Wiklander [BPA_SIGN] = PKCS11_CKA_SIGN, 42963f89caaSJens Wiklander [BPA_SIGN_RECOVER] = PKCS11_CKA_SIGN_RECOVER, 43063f89caaSJens Wiklander [BPA_VERIFY] = PKCS11_CKA_VERIFY, 43163f89caaSJens Wiklander [BPA_VERIFY_RECOVER] = PKCS11_CKA_VERIFY_RECOVER, 43263f89caaSJens Wiklander [BPA_DERIVE] = PKCS11_CKA_DERIVE, 43363f89caaSJens Wiklander [BPA_EXTRACTABLE] = PKCS11_CKA_EXTRACTABLE, 43463f89caaSJens Wiklander [BPA_LOCAL] = PKCS11_CKA_LOCAL, 43563f89caaSJens Wiklander [BPA_NEVER_EXTRACTABLE] = PKCS11_CKA_NEVER_EXTRACTABLE, 43663f89caaSJens Wiklander [BPA_ALWAYS_SENSITIVE] = PKCS11_CKA_ALWAYS_SENSITIVE, 43763f89caaSJens Wiklander [BPA_MODIFIABLE] = PKCS11_CKA_MODIFIABLE, 43863f89caaSJens Wiklander [BPA_COPYABLE] = PKCS11_CKA_COPYABLE, 43963f89caaSJens Wiklander [BPA_DESTROYABLE] = PKCS11_CKA_DESTROYABLE, 44063f89caaSJens Wiklander [BPA_ALWAYS_AUTHENTICATE] = PKCS11_CKA_ALWAYS_AUTHENTICATE, 44163f89caaSJens Wiklander [BPA_WRAP_WITH_TRUSTED] = PKCS11_CKA_WRAP_WITH_TRUSTED, 44263f89caaSJens Wiklander }; 44363f89caaSJens Wiklander size_t pos = 0; 44463f89caaSJens Wiklander 44563f89caaSJens Wiklander for (pos = 0; pos < ARRAY_SIZE(bpa); pos++) 44663f89caaSJens Wiklander if (bpa[pos] == attr) 44763f89caaSJens Wiklander return (int)pos; 44863f89caaSJens Wiklander 44963f89caaSJens Wiklander return -1; 45063f89caaSJens Wiklander } 45163f89caaSJens Wiklander 452*512cbf1dSJens Wiklander /* Initialize a TEE attribute for a target PKCS11 TA attribute in an object */ 453*512cbf1dSJens Wiklander bool pkcs2tee_load_attr(TEE_Attribute *tee_ref, uint32_t tee_id, 454*512cbf1dSJens Wiklander struct pkcs11_object *obj, 455*512cbf1dSJens Wiklander enum pkcs11_attr_id pkcs11_id) 456*512cbf1dSJens Wiklander { 457*512cbf1dSJens Wiklander void *a_ptr = NULL; 458*512cbf1dSJens Wiklander uint32_t a_size = 0; 459*512cbf1dSJens Wiklander 460*512cbf1dSJens Wiklander if (get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size)) 461*512cbf1dSJens Wiklander return false; 462*512cbf1dSJens Wiklander 463*512cbf1dSJens Wiklander TEE_InitRefAttribute(tee_ref, tee_id, a_ptr, a_size); 464*512cbf1dSJens Wiklander 465*512cbf1dSJens Wiklander return true; 466*512cbf1dSJens Wiklander } 467*512cbf1dSJens Wiklander 468*512cbf1dSJens Wiklander /* Easy conversion between PKCS11 TA function of TEE crypto mode */ 469*512cbf1dSJens Wiklander void pkcs2tee_mode(uint32_t *tee_id, enum processing_func function) 470*512cbf1dSJens Wiklander { 471*512cbf1dSJens Wiklander switch (function) { 472*512cbf1dSJens Wiklander case PKCS11_FUNCTION_ENCRYPT: 473*512cbf1dSJens Wiklander *tee_id = TEE_MODE_ENCRYPT; 474*512cbf1dSJens Wiklander break; 475*512cbf1dSJens Wiklander case PKCS11_FUNCTION_DECRYPT: 476*512cbf1dSJens Wiklander *tee_id = TEE_MODE_DECRYPT; 477*512cbf1dSJens Wiklander break; 478*512cbf1dSJens Wiklander case PKCS11_FUNCTION_SIGN: 479*512cbf1dSJens Wiklander *tee_id = TEE_MODE_SIGN; 480*512cbf1dSJens Wiklander break; 481*512cbf1dSJens Wiklander case PKCS11_FUNCTION_VERIFY: 482*512cbf1dSJens Wiklander *tee_id = TEE_MODE_VERIFY; 483*512cbf1dSJens Wiklander break; 484*512cbf1dSJens Wiklander case PKCS11_FUNCTION_DERIVE: 485*512cbf1dSJens Wiklander *tee_id = TEE_MODE_DERIVE; 486*512cbf1dSJens Wiklander break; 487*512cbf1dSJens Wiklander default: 488*512cbf1dSJens Wiklander TEE_Panic(function); 489*512cbf1dSJens Wiklander } 490*512cbf1dSJens Wiklander } 491*512cbf1dSJens Wiklander 492f7d7fcd9SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0 493d34f3266SEtienne Carriere const char *id2str_rc(uint32_t id) 494d34f3266SEtienne Carriere { 495d34f3266SEtienne Carriere return ID2STR(id, string_rc, "PKCS11_CKR_"); 496d34f3266SEtienne Carriere } 497d34f3266SEtienne Carriere 498f7d7fcd9SEtienne Carriere const char *id2str_ta_cmd(uint32_t id) 499f7d7fcd9SEtienne Carriere { 500f7d7fcd9SEtienne Carriere return ID2STR(id, string_ta_cmd, NULL); 501f7d7fcd9SEtienne Carriere } 502a67dc424SEtienne Carriere 503a67dc424SEtienne Carriere const char *id2str_slot_flag(uint32_t id) 504a67dc424SEtienne Carriere { 505a67dc424SEtienne Carriere return ID2STR(id, string_slot_flags, "PKCS11_CKFS_"); 506a67dc424SEtienne Carriere } 507a67dc424SEtienne Carriere 508a67dc424SEtienne Carriere const char *id2str_token_flag(uint32_t id) 509a67dc424SEtienne Carriere { 510a67dc424SEtienne Carriere return ID2STR(id, string_token_flags, "PKCS11_CKFT_"); 511a67dc424SEtienne Carriere } 512d21ec5f4SEtienne Carriere 513d21ec5f4SEtienne Carriere const char *id2str_session_flag(uint32_t id) 514d21ec5f4SEtienne Carriere { 515d21ec5f4SEtienne Carriere return ID2STR(id, string_session_flags, "PKCS11_CKFSS_"); 516d21ec5f4SEtienne Carriere } 517d21ec5f4SEtienne Carriere 518d21ec5f4SEtienne Carriere const char *id2str_session_state(uint32_t id) 519d21ec5f4SEtienne Carriere { 520d21ec5f4SEtienne Carriere return ID2STR(id, string_session_state, "PKCS11_CKS_"); 521d21ec5f4SEtienne Carriere } 52263f89caaSJens Wiklander 52363f89caaSJens Wiklander const char *id2str_attr(uint32_t id) 52463f89caaSJens Wiklander { 52563f89caaSJens Wiklander size_t n = 0; 52663f89caaSJens Wiklander 52763f89caaSJens Wiklander for (n = 0; n < ARRAY_SIZE(attr_ids); n++) { 52863f89caaSJens Wiklander if (id == attr_ids[n].id) { 52963f89caaSJens Wiklander /* Skip PKCS11_CKA_ prefix */ 53063f89caaSJens Wiklander return attr_ids[n].string + strlen("PKCS11_CKA_"); 53163f89caaSJens Wiklander } 53263f89caaSJens Wiklander } 53363f89caaSJens Wiklander 53463f89caaSJens Wiklander return unknown; 53563f89caaSJens Wiklander } 53663f89caaSJens Wiklander 53763f89caaSJens Wiklander const char *id2str_class(uint32_t id) 53863f89caaSJens Wiklander { 53963f89caaSJens Wiklander return ID2STR(id, string_class, "PKCS11_CKO_"); 54063f89caaSJens Wiklander } 54163f89caaSJens Wiklander 54263f89caaSJens Wiklander const char *id2str_type(uint32_t id, uint32_t class) 54363f89caaSJens Wiklander { 54463f89caaSJens Wiklander enum pkcs11_class_id class_id = class; 54563f89caaSJens Wiklander enum pkcs11_key_type key_type = id; 54663f89caaSJens Wiklander 54763f89caaSJens Wiklander switch (class_id) { 54863f89caaSJens Wiklander case PKCS11_CKO_SECRET_KEY: 54963f89caaSJens Wiklander case PKCS11_CKO_PUBLIC_KEY: 55063f89caaSJens Wiklander case PKCS11_CKO_PRIVATE_KEY: 55163f89caaSJens Wiklander return id2str_key_type(key_type); 55263f89caaSJens Wiklander default: 55363f89caaSJens Wiklander return unknown; 55463f89caaSJens Wiklander } 55563f89caaSJens Wiklander } 55663f89caaSJens Wiklander 55763f89caaSJens Wiklander const char *id2str_key_type(uint32_t id) 55863f89caaSJens Wiklander { 55963f89caaSJens Wiklander return ID2STR(id, string_key_type, "PKCS11_CKK_"); 56063f89caaSJens Wiklander } 56163f89caaSJens Wiklander 56263f89caaSJens Wiklander const char *id2str_attr_value(uint32_t id, size_t size, void *value) 56363f89caaSJens Wiklander { 56463f89caaSJens Wiklander static const char str_true[] = "TRUE"; 56563f89caaSJens Wiklander static const char str_false[] = "FALSE"; 56663f89caaSJens Wiklander static const char str_unknown[] = "*"; 56763f89caaSJens Wiklander uint32_t type = 0; 56863f89caaSJens Wiklander 56963f89caaSJens Wiklander if (pkcs11_attr2boolprop_shift(id) >= 0) 57063f89caaSJens Wiklander return *(uint8_t *)value ? str_true : str_false; 57163f89caaSJens Wiklander 57263f89caaSJens Wiklander if (size < sizeof(uint32_t)) 57363f89caaSJens Wiklander return str_unknown; 57463f89caaSJens Wiklander 57563f89caaSJens Wiklander TEE_MemMove(&type, value, sizeof(uint32_t)); 57663f89caaSJens Wiklander 57763f89caaSJens Wiklander switch (id) { 57863f89caaSJens Wiklander case PKCS11_CKA_CLASS: 57963f89caaSJens Wiklander return id2str_class(type); 58063f89caaSJens Wiklander case PKCS11_CKA_KEY_TYPE: 58163f89caaSJens Wiklander return id2str_key_type(type); 58263f89caaSJens Wiklander case PKCS11_CKA_MECHANISM_TYPE: 58363f89caaSJens Wiklander return id2str_mechanism(type); 58463f89caaSJens Wiklander default: 58563f89caaSJens Wiklander return str_unknown; 58663f89caaSJens Wiklander } 58763f89caaSJens Wiklander } 58863f89caaSJens Wiklander 58963f89caaSJens Wiklander const char *id2str_proc(uint32_t id) 59063f89caaSJens Wiklander { 59163f89caaSJens Wiklander const char *str = ID2STR(id, string_internal_processing, 59263f89caaSJens Wiklander "PKCS11_PROCESSING_"); 59363f89caaSJens Wiklander 59463f89caaSJens Wiklander if (str != unknown) 59563f89caaSJens Wiklander return str; 59663f89caaSJens Wiklander 59763f89caaSJens Wiklander return id2str_mechanism(id); 59863f89caaSJens Wiklander } 59963f89caaSJens Wiklander 60063f89caaSJens Wiklander const char *id2str_function(uint32_t id) 60163f89caaSJens Wiklander { 60263f89caaSJens Wiklander return ID2STR(id, string_functions, "PKCS11_FUNCTION_"); 60363f89caaSJens Wiklander } 604f7d7fcd9SEtienne Carriere #endif /*CFG_TEE_TA_LOG_LEVEL*/ 605