xref: /optee_os/ta/pkcs11/src/pkcs11_helpers.c (revision 63f89caa9022ecf51d1b82dc78af35ba9e38466d)
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 
11*63f89caaSJens Wiklander #include "attributes.h"
12*63f89caaSJens Wiklander #include "pkcs11_attributes.h"
13f7d7fcd9SEtienne Carriere #include "pkcs11_helpers.h"
14f7d7fcd9SEtienne Carriere 
15f7d7fcd9SEtienne Carriere static const char __maybe_unused unknown[] = "<unknown-identifier>";
16f7d7fcd9SEtienne Carriere 
17*63f89caaSJens Wiklander struct attr_size {
18*63f89caaSJens Wiklander 	uint32_t id;
19*63f89caaSJens Wiklander 	uint32_t size;
20*63f89caaSJens Wiklander #if CFG_TEE_TA_LOG_LEVEL > 0
21*63f89caaSJens Wiklander 	const char *string;
22*63f89caaSJens Wiklander #endif
23*63f89caaSJens Wiklander };
24*63f89caaSJens Wiklander 
25*63f89caaSJens Wiklander #if CFG_TEE_TA_LOG_LEVEL > 0
26*63f89caaSJens Wiklander #define PKCS11_ID_SZ(_id, _sz)	\
27*63f89caaSJens Wiklander 			{ .id = (uint32_t)(_id), .size = (_sz), .string = #_id }
28*63f89caaSJens Wiklander #else
29*63f89caaSJens Wiklander #define PKCS11_ID_SZ(_id, _sz)	\
30*63f89caaSJens Wiklander 			{ .id = (uint32_t)(_id), .size = (_sz) }
31*63f89caaSJens Wiklander #endif
32*63f89caaSJens Wiklander 
33*63f89caaSJens Wiklander static const struct attr_size attr_ids[] = {
34*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_CLASS, 4),
35*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_KEY_TYPE, 4),
36*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_VALUE, 0),
37*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_VALUE_LEN, 4),
38*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_LABEL, 0),
39*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_WRAP_TEMPLATE, 0),
40*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_UNWRAP_TEMPLATE, 0),
41*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_DERIVE_TEMPLATE, 0),
42*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_START_DATE, 4),
43*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_END_DATE, 4),
44*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_OBJECT_ID, 0),
45*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_APPLICATION, 0),
46*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_MECHANISM_TYPE, 4),
47*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_ID, 0),
48*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_ALLOWED_MECHANISMS, 0),
49*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_EC_POINT, 0),
50*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_EC_PARAMS, 0),
51*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_MODULUS, 0),
52*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_MODULUS_BITS, 4),
53*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_EXPONENT, 0),
54*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_PRIVATE_EXPONENT, 0),
55*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_PRIME_1, 0),
56*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_PRIME_2, 0),
57*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_1, 0),
58*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_2, 0),
59*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_COEFFICIENT, 0),
60*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_SUBJECT, 0),
61*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_KEY_INFO, 0),
62*63f89caaSJens Wiklander 	/* Below are boolean attributes */
63*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_TOKEN, 1),
64*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_PRIVATE, 1),
65*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_TRUSTED, 1),
66*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_SENSITIVE, 1),
67*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_ENCRYPT, 1),
68*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_DECRYPT, 1),
69*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_WRAP, 1),
70*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_UNWRAP, 1),
71*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_SIGN, 1),
72*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_SIGN_RECOVER, 1),
73*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_VERIFY, 1),
74*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_VERIFY_RECOVER, 1),
75*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_DERIVE, 1),
76*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_EXTRACTABLE, 1),
77*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_LOCAL, 1),
78*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_NEVER_EXTRACTABLE, 1),
79*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_SENSITIVE, 1),
80*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_MODIFIABLE, 1),
81*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_COPYABLE, 1),
82*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_DESTROYABLE, 1),
83*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_AUTHENTICATE, 1),
84*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_WRAP_WITH_TRUSTED, 1),
85*63f89caaSJens Wiklander 	/* Specific PKCS11 TA internal attribute ID */
86*63f89caaSJens Wiklander 	PKCS11_ID_SZ(PKCS11_CKA_UNDEFINED_ID, 0),
87*63f89caaSJens Wiklander };
88*63f89caaSJens Wiklander 
89f7d7fcd9SEtienne Carriere struct any_id {
90f7d7fcd9SEtienne Carriere 	uint32_t id;
91f7d7fcd9SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0
92f7d7fcd9SEtienne Carriere 	const char *string;
93f7d7fcd9SEtienne Carriere #endif
94f7d7fcd9SEtienne Carriere };
95f7d7fcd9SEtienne Carriere 
96f7d7fcd9SEtienne Carriere /*
97f7d7fcd9SEtienne Carriere  * Macro PKCS11_ID() can be used to define cells in ID list arrays
98f7d7fcd9SEtienne Carriere  * or ID/string conversion arrays.
99f7d7fcd9SEtienne Carriere  */
100f7d7fcd9SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0
101f7d7fcd9SEtienne Carriere #define PKCS11_ID(_id)		{ .id = _id, .string = #_id }
102f7d7fcd9SEtienne Carriere #else
103f7d7fcd9SEtienne Carriere #define PKCS11_ID(_id)		{ .id = _id }
104f7d7fcd9SEtienne Carriere #endif
105f7d7fcd9SEtienne Carriere 
106f7d7fcd9SEtienne Carriere #define ID2STR(id, table, prefix)	\
107f7d7fcd9SEtienne Carriere 	id2str(id, table, ARRAY_SIZE(table), prefix)
108f7d7fcd9SEtienne Carriere 
10960290f69SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0
110f7d7fcd9SEtienne Carriere /* Convert a PKCS11 ID into its label string */
11160290f69SEtienne Carriere static const char *id2str(uint32_t id, const struct any_id *table,
112f7d7fcd9SEtienne Carriere 			  size_t count, const char *prefix)
113f7d7fcd9SEtienne Carriere {
114f7d7fcd9SEtienne Carriere 	size_t n = 0;
115f7d7fcd9SEtienne Carriere 	const char *str = NULL;
116f7d7fcd9SEtienne Carriere 
117f7d7fcd9SEtienne Carriere 	for (n = 0; n < count; n++) {
118f7d7fcd9SEtienne Carriere 		if (id != table[n].id)
119f7d7fcd9SEtienne Carriere 			continue;
120f7d7fcd9SEtienne Carriere 
121f7d7fcd9SEtienne Carriere 		str = table[n].string;
122f7d7fcd9SEtienne Carriere 
123f7d7fcd9SEtienne Carriere 		/* Skip prefix provided matches found */
124f7d7fcd9SEtienne Carriere 		if (prefix && !TEE_MemCompare(str, prefix, strlen(prefix)))
125f7d7fcd9SEtienne Carriere 			str += strlen(prefix);
126f7d7fcd9SEtienne Carriere 
127f7d7fcd9SEtienne Carriere 		return str;
128f7d7fcd9SEtienne Carriere 	}
129f7d7fcd9SEtienne Carriere 
130f7d7fcd9SEtienne Carriere 	return unknown;
131f7d7fcd9SEtienne Carriere }
13260290f69SEtienne Carriere #endif /* CFG_TEE_TA_LOG_LEVEL > 0 */
133f7d7fcd9SEtienne Carriere 
134f7d7fcd9SEtienne Carriere /*
135f7d7fcd9SEtienne Carriere  * TA command IDs: used only as ID/string conversion for debug trace support
136f7d7fcd9SEtienne Carriere  */
137f7d7fcd9SEtienne Carriere static const struct any_id __maybe_unused string_ta_cmd[] = {
138f7d7fcd9SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_PING),
139a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_SLOT_LIST),
140a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_SLOT_INFO),
141a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_TOKEN_INFO),
142d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_MECHANISM_IDS),
143d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_MECHANISM_INFO),
144d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_OPEN_SESSION),
145d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_SESSION_INFO),
146d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_CLOSE_SESSION),
147d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_CLOSE_ALL_SESSIONS),
148ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_INIT_TOKEN),
149ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_INIT_PIN),
150ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_SET_PIN),
151ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_LOGIN),
152ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_LOGOUT),
153ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_CREATE_OBJECT),
154ddf63ac3SEtienne Carriere 	PKCS11_ID(PKCS11_CMD_DESTROY_OBJECT),
155a67dc424SEtienne Carriere };
156a67dc424SEtienne Carriere 
157a67dc424SEtienne Carriere static const struct any_id __maybe_unused string_slot_flags[] = {
158a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFS_TOKEN_PRESENT),
159a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFS_REMOVABLE_DEVICE),
160a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFS_HW_SLOT),
161a67dc424SEtienne Carriere };
162a67dc424SEtienne Carriere 
163a67dc424SEtienne Carriere static const struct any_id __maybe_unused string_token_flags[] = {
164a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_RNG),
165a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_WRITE_PROTECTED),
166a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_LOGIN_REQUIRED),
167a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_USER_PIN_INITIALIZED),
168a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED),
169a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_CLOCK_ON_TOKEN),
170a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH),
171a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS),
172a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_TOKEN_INITIALIZED),
173a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_USER_PIN_COUNT_LOW),
174a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_USER_PIN_FINAL_TRY),
175a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_USER_PIN_LOCKED),
176a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_USER_PIN_TO_BE_CHANGED),
177a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_SO_PIN_COUNT_LOW),
178a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_SO_PIN_FINAL_TRY),
179a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_SO_PIN_LOCKED),
180a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_SO_PIN_TO_BE_CHANGED),
181a67dc424SEtienne Carriere 	PKCS11_ID(PKCS11_CKFT_ERROR_STATE),
182f7d7fcd9SEtienne Carriere };
183f7d7fcd9SEtienne Carriere 
184d21ec5f4SEtienne Carriere static const struct any_id __maybe_unused string_session_flags[] = {
185d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKFSS_RW_SESSION),
186d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKFSS_SERIAL_SESSION),
187d21ec5f4SEtienne Carriere };
188d21ec5f4SEtienne Carriere 
189d21ec5f4SEtienne Carriere static const struct any_id __maybe_unused string_session_state[] = {
190d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKS_RO_PUBLIC_SESSION),
191d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKS_RO_USER_FUNCTIONS),
192d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKS_RW_PUBLIC_SESSION),
193d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKS_RW_USER_FUNCTIONS),
194d21ec5f4SEtienne Carriere 	PKCS11_ID(PKCS11_CKS_RW_SO_FUNCTIONS),
195d21ec5f4SEtienne Carriere };
196d21ec5f4SEtienne Carriere 
197d34f3266SEtienne Carriere static const struct any_id __maybe_unused string_rc[] = {
198d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_OK),
199d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_GENERAL_ERROR),
200d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY),
201d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD),
202d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL),
203d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED),
204d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID),
205d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID),
206d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID),
207d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID),
208d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID),
209d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID),
210d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID),
211d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SLOT_ID_INVALID),
212d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID),
213d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT),
214d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE),
215d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_PIN_INCORRECT),
216d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_PIN_LOCKED),
217d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_PIN_EXPIRED),
218d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_PIN_INVALID),
219d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE),
220d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SESSION_EXISTS),
221d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY),
222d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS),
223d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE),
224d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED),
225d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED),
226d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED),
227d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT),
228d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED),
229d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED),
230d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY),
231d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK),
232d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED),
233d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID),
234d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN),
235d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN),
236d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN),
237d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED),
238d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES),
239d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID),
240d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS),
241d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_RV_NOT_FOUND),
242d34f3266SEtienne Carriere 	PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED),
243d34f3266SEtienne Carriere };
244d34f3266SEtienne Carriere 
245*63f89caaSJens Wiklander static const struct any_id __maybe_unused string_class[] = {
246*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_SECRET_KEY),
247*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_PUBLIC_KEY),
248*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_PRIVATE_KEY),
249*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_OTP_KEY),
250*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_CERTIFICATE),
251*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_DATA),
252*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_DOMAIN_PARAMETERS),
253*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_HW_FEATURE),
254*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_MECHANISM),
255*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKO_UNDEFINED_ID)
256*63f89caaSJens Wiklander };
257*63f89caaSJens Wiklander 
258*63f89caaSJens Wiklander static const struct any_id __maybe_unused string_key_type[] = {
259*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_AES),
260*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_GENERIC_SECRET),
261*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_MD5_HMAC),
262*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_SHA_1_HMAC),
263*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_SHA224_HMAC),
264*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_SHA256_HMAC),
265*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_SHA384_HMAC),
266*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_SHA512_HMAC),
267*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_EC),
268*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_RSA),
269*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_CKK_UNDEFINED_ID)
270*63f89caaSJens Wiklander };
271*63f89caaSJens Wiklander 
272*63f89caaSJens Wiklander /*
273*63f89caaSJens Wiklander  * Processing IDs not exported in the TA API.
274*63f89caaSJens Wiklander  * PKCS11_CKM_* mechanism IDs are looked up from mechanism_string_id().
275*63f89caaSJens Wiklander  */
276*63f89caaSJens Wiklander static const struct any_id __maybe_unused string_internal_processing[] = {
277*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_PROCESSING_IMPORT),
278*63f89caaSJens Wiklander };
279*63f89caaSJens Wiklander 
280*63f89caaSJens Wiklander static const struct any_id __maybe_unused string_functions[] = {
281*63f89caaSJens Wiklander 	PKCS11_ID(PKCS11_FUNCTION_IMPORT),
282*63f89caaSJens Wiklander };
283*63f89caaSJens Wiklander 
2848e03579eSJens Wiklander /*
2858e03579eSJens Wiklander  * Conversion between PKCS11 TA and GPD TEE return codes
2868e03579eSJens Wiklander  */
2878e03579eSJens Wiklander enum pkcs11_rc tee2pkcs_error(TEE_Result res)
2888e03579eSJens Wiklander {
2898e03579eSJens Wiklander 	switch (res) {
2908e03579eSJens Wiklander 	case TEE_SUCCESS:
2918e03579eSJens Wiklander 		return PKCS11_CKR_OK;
2928e03579eSJens Wiklander 
2938e03579eSJens Wiklander 	case TEE_ERROR_BAD_PARAMETERS:
2948e03579eSJens Wiklander 		return PKCS11_CKR_ARGUMENTS_BAD;
2958e03579eSJens Wiklander 
2968e03579eSJens Wiklander 	case TEE_ERROR_OUT_OF_MEMORY:
2978e03579eSJens Wiklander 		return PKCS11_CKR_DEVICE_MEMORY;
2988e03579eSJens Wiklander 
2998e03579eSJens Wiklander 	case TEE_ERROR_SHORT_BUFFER:
3008e03579eSJens Wiklander 		return PKCS11_CKR_BUFFER_TOO_SMALL;
3018e03579eSJens Wiklander 
3028e03579eSJens Wiklander 	case TEE_ERROR_MAC_INVALID:
3038e03579eSJens Wiklander 	case TEE_ERROR_SIGNATURE_INVALID:
3048e03579eSJens Wiklander 		return PKCS11_CKR_SIGNATURE_INVALID;
3058e03579eSJens Wiklander 
3068e03579eSJens Wiklander 	default:
3078e03579eSJens Wiklander 		return PKCS11_CKR_GENERAL_ERROR;
3088e03579eSJens Wiklander 	}
3098e03579eSJens Wiklander }
3108e03579eSJens Wiklander 
311*63f89caaSJens Wiklander /*
312*63f89caaSJens Wiklander  * Helper functions to analyse PKCS11 identifiers
313*63f89caaSJens Wiklander  */
314*63f89caaSJens Wiklander 
315*63f89caaSJens Wiklander /* Check attribute ID is known and size matches if fixed */
316*63f89caaSJens Wiklander bool valid_pkcs11_attribute_id(uint32_t id, uint32_t size)
317*63f89caaSJens Wiklander {
318*63f89caaSJens Wiklander 	size_t n = 0;
319*63f89caaSJens Wiklander 
320*63f89caaSJens Wiklander 	for (n = 0; n < ARRAY_SIZE(attr_ids); n++)
321*63f89caaSJens Wiklander 		if (id == attr_ids[n].id)
322*63f89caaSJens Wiklander 			return !attr_ids[n].size || size == attr_ids[n].size;
323*63f89caaSJens Wiklander 
324*63f89caaSJens Wiklander 	return false;
325*63f89caaSJens Wiklander }
326*63f89caaSJens Wiklander 
327*63f89caaSJens Wiklander size_t pkcs11_attr_is_type(uint32_t attribute_id)
328*63f89caaSJens Wiklander {
329*63f89caaSJens Wiklander 	enum pkcs11_attr_id id = attribute_id;
330*63f89caaSJens Wiklander 
331*63f89caaSJens Wiklander 	switch (id) {
332*63f89caaSJens Wiklander 	case PKCS11_CKA_KEY_TYPE:
333*63f89caaSJens Wiklander 	case PKCS11_CKA_MECHANISM_TYPE:
334*63f89caaSJens Wiklander 	case PKCS11_CKA_KEY_GEN_MECHANISM:
335*63f89caaSJens Wiklander 		return sizeof(uint32_t);
336*63f89caaSJens Wiklander 	default:
337*63f89caaSJens Wiklander 		return 0;
338*63f89caaSJens Wiklander 	}
339*63f89caaSJens Wiklander }
340*63f89caaSJens Wiklander 
341*63f89caaSJens Wiklander bool pkcs11_class_has_type(uint32_t class)
342*63f89caaSJens Wiklander {
343*63f89caaSJens Wiklander 	enum pkcs11_class_id class_id = class;
344*63f89caaSJens Wiklander 
345*63f89caaSJens Wiklander 	switch (class_id) {
346*63f89caaSJens Wiklander 	case PKCS11_CKO_CERTIFICATE:
347*63f89caaSJens Wiklander 	case PKCS11_CKO_PUBLIC_KEY:
348*63f89caaSJens Wiklander 	case PKCS11_CKO_PRIVATE_KEY:
349*63f89caaSJens Wiklander 	case PKCS11_CKO_SECRET_KEY:
350*63f89caaSJens Wiklander 	case PKCS11_CKO_MECHANISM:
351*63f89caaSJens Wiklander 	case PKCS11_CKO_HW_FEATURE:
352*63f89caaSJens Wiklander 		return true;
353*63f89caaSJens Wiklander 	default:
354*63f89caaSJens Wiklander 		return false;
355*63f89caaSJens Wiklander 	}
356*63f89caaSJens Wiklander }
357*63f89caaSJens Wiklander 
358*63f89caaSJens Wiklander bool pkcs11_attr_class_is_key(uint32_t class)
359*63f89caaSJens Wiklander {
360*63f89caaSJens Wiklander 	enum pkcs11_class_id class_id = class;
361*63f89caaSJens Wiklander 
362*63f89caaSJens Wiklander 	switch (class_id) {
363*63f89caaSJens Wiklander 	case PKCS11_CKO_SECRET_KEY:
364*63f89caaSJens Wiklander 	case PKCS11_CKO_PUBLIC_KEY:
365*63f89caaSJens Wiklander 	case PKCS11_CKO_PRIVATE_KEY:
366*63f89caaSJens Wiklander 		return true;
367*63f89caaSJens Wiklander 	default:
368*63f89caaSJens Wiklander 		return false;
369*63f89caaSJens Wiklander 	}
370*63f89caaSJens Wiklander }
371*63f89caaSJens Wiklander 
372*63f89caaSJens Wiklander bool key_type_is_symm_key(uint32_t id)
373*63f89caaSJens Wiklander {
374*63f89caaSJens Wiklander 	enum pkcs11_key_type key_type = id;
375*63f89caaSJens Wiklander 
376*63f89caaSJens Wiklander 	switch (key_type) {
377*63f89caaSJens Wiklander 	case PKCS11_CKK_AES:
378*63f89caaSJens Wiklander 	case PKCS11_CKK_GENERIC_SECRET:
379*63f89caaSJens Wiklander 	case PKCS11_CKK_MD5_HMAC:
380*63f89caaSJens Wiklander 	case PKCS11_CKK_SHA_1_HMAC:
381*63f89caaSJens Wiklander 	case PKCS11_CKK_SHA224_HMAC:
382*63f89caaSJens Wiklander 	case PKCS11_CKK_SHA256_HMAC:
383*63f89caaSJens Wiklander 	case PKCS11_CKK_SHA384_HMAC:
384*63f89caaSJens Wiklander 	case PKCS11_CKK_SHA512_HMAC:
385*63f89caaSJens Wiklander 		return true;
386*63f89caaSJens Wiklander 	default:
387*63f89caaSJens Wiklander 		return false;
388*63f89caaSJens Wiklander 	}
389*63f89caaSJens Wiklander }
390*63f89caaSJens Wiklander 
391*63f89caaSJens Wiklander bool key_type_is_asymm_key(uint32_t id)
392*63f89caaSJens Wiklander {
393*63f89caaSJens Wiklander 	enum pkcs11_key_type key_type = id;
394*63f89caaSJens Wiklander 
395*63f89caaSJens Wiklander 	switch (key_type) {
396*63f89caaSJens Wiklander 	case PKCS11_CKK_EC:
397*63f89caaSJens Wiklander 	case PKCS11_CKK_RSA:
398*63f89caaSJens Wiklander 		return true;
399*63f89caaSJens Wiklander 	default:
400*63f89caaSJens Wiklander 		return false;
401*63f89caaSJens Wiklander 	}
402*63f89caaSJens Wiklander }
403*63f89caaSJens Wiklander 
404*63f89caaSJens Wiklander /*
405*63f89caaSJens Wiklander  * Returns shift position or -1 on error.
406*63f89caaSJens Wiklander  * Mainly used when PKCS11_SHEAD_WITH_BOOLPROPS is enabled
407*63f89caaSJens Wiklander  */
408*63f89caaSJens Wiklander int pkcs11_attr2boolprop_shift(uint32_t attr)
409*63f89caaSJens Wiklander {
410*63f89caaSJens Wiklander 	static const uint32_t bpa[] = {
411*63f89caaSJens Wiklander 		[BPA_TOKEN]		= PKCS11_CKA_TOKEN,
412*63f89caaSJens Wiklander 		[BPA_PRIVATE]		= PKCS11_CKA_PRIVATE,
413*63f89caaSJens Wiklander 		[BPA_TRUSTED]		= PKCS11_CKA_TRUSTED,
414*63f89caaSJens Wiklander 		[BPA_SENSITIVE]		= PKCS11_CKA_SENSITIVE,
415*63f89caaSJens Wiklander 		[BPA_ENCRYPT]		= PKCS11_CKA_ENCRYPT,
416*63f89caaSJens Wiklander 		[BPA_DECRYPT]		= PKCS11_CKA_DECRYPT,
417*63f89caaSJens Wiklander 		[BPA_WRAP]		= PKCS11_CKA_WRAP,
418*63f89caaSJens Wiklander 		[BPA_UNWRAP]		= PKCS11_CKA_UNWRAP,
419*63f89caaSJens Wiklander 		[BPA_SIGN]		= PKCS11_CKA_SIGN,
420*63f89caaSJens Wiklander 		[BPA_SIGN_RECOVER]	= PKCS11_CKA_SIGN_RECOVER,
421*63f89caaSJens Wiklander 		[BPA_VERIFY]		= PKCS11_CKA_VERIFY,
422*63f89caaSJens Wiklander 		[BPA_VERIFY_RECOVER]	= PKCS11_CKA_VERIFY_RECOVER,
423*63f89caaSJens Wiklander 		[BPA_DERIVE]		= PKCS11_CKA_DERIVE,
424*63f89caaSJens Wiklander 		[BPA_EXTRACTABLE]	= PKCS11_CKA_EXTRACTABLE,
425*63f89caaSJens Wiklander 		[BPA_LOCAL]		= PKCS11_CKA_LOCAL,
426*63f89caaSJens Wiklander 		[BPA_NEVER_EXTRACTABLE]	= PKCS11_CKA_NEVER_EXTRACTABLE,
427*63f89caaSJens Wiklander 		[BPA_ALWAYS_SENSITIVE]	= PKCS11_CKA_ALWAYS_SENSITIVE,
428*63f89caaSJens Wiklander 		[BPA_MODIFIABLE]	= PKCS11_CKA_MODIFIABLE,
429*63f89caaSJens Wiklander 		[BPA_COPYABLE]		= PKCS11_CKA_COPYABLE,
430*63f89caaSJens Wiklander 		[BPA_DESTROYABLE]	= PKCS11_CKA_DESTROYABLE,
431*63f89caaSJens Wiklander 		[BPA_ALWAYS_AUTHENTICATE] = PKCS11_CKA_ALWAYS_AUTHENTICATE,
432*63f89caaSJens Wiklander 		[BPA_WRAP_WITH_TRUSTED] = PKCS11_CKA_WRAP_WITH_TRUSTED,
433*63f89caaSJens Wiklander 	};
434*63f89caaSJens Wiklander 	size_t pos = 0;
435*63f89caaSJens Wiklander 
436*63f89caaSJens Wiklander 	for (pos = 0; pos < ARRAY_SIZE(bpa); pos++)
437*63f89caaSJens Wiklander 		if (bpa[pos] == attr)
438*63f89caaSJens Wiklander 			return (int)pos;
439*63f89caaSJens Wiklander 
440*63f89caaSJens Wiklander 	return -1;
441*63f89caaSJens Wiklander }
442*63f89caaSJens Wiklander 
443f7d7fcd9SEtienne Carriere #if CFG_TEE_TA_LOG_LEVEL > 0
444d34f3266SEtienne Carriere const char *id2str_rc(uint32_t id)
445d34f3266SEtienne Carriere {
446d34f3266SEtienne Carriere 	return ID2STR(id, string_rc, "PKCS11_CKR_");
447d34f3266SEtienne Carriere }
448d34f3266SEtienne Carriere 
449f7d7fcd9SEtienne Carriere const char *id2str_ta_cmd(uint32_t id)
450f7d7fcd9SEtienne Carriere {
451f7d7fcd9SEtienne Carriere 	return ID2STR(id, string_ta_cmd, NULL);
452f7d7fcd9SEtienne Carriere }
453a67dc424SEtienne Carriere 
454a67dc424SEtienne Carriere const char *id2str_slot_flag(uint32_t id)
455a67dc424SEtienne Carriere {
456a67dc424SEtienne Carriere 	return ID2STR(id, string_slot_flags, "PKCS11_CKFS_");
457a67dc424SEtienne Carriere }
458a67dc424SEtienne Carriere 
459a67dc424SEtienne Carriere const char *id2str_token_flag(uint32_t id)
460a67dc424SEtienne Carriere {
461a67dc424SEtienne Carriere 	return ID2STR(id, string_token_flags, "PKCS11_CKFT_");
462a67dc424SEtienne Carriere }
463d21ec5f4SEtienne Carriere 
464d21ec5f4SEtienne Carriere const char *id2str_session_flag(uint32_t id)
465d21ec5f4SEtienne Carriere {
466d21ec5f4SEtienne Carriere 	return ID2STR(id, string_session_flags, "PKCS11_CKFSS_");
467d21ec5f4SEtienne Carriere }
468d21ec5f4SEtienne Carriere 
469d21ec5f4SEtienne Carriere const char *id2str_session_state(uint32_t id)
470d21ec5f4SEtienne Carriere {
471d21ec5f4SEtienne Carriere 	return ID2STR(id, string_session_state, "PKCS11_CKS_");
472d21ec5f4SEtienne Carriere }
473*63f89caaSJens Wiklander 
474*63f89caaSJens Wiklander const char *id2str_attr(uint32_t id)
475*63f89caaSJens Wiklander {
476*63f89caaSJens Wiklander 	size_t n = 0;
477*63f89caaSJens Wiklander 
478*63f89caaSJens Wiklander 	for (n = 0; n < ARRAY_SIZE(attr_ids); n++) {
479*63f89caaSJens Wiklander 		if (id == attr_ids[n].id) {
480*63f89caaSJens Wiklander 			/* Skip PKCS11_CKA_ prefix */
481*63f89caaSJens Wiklander 			return attr_ids[n].string + strlen("PKCS11_CKA_");
482*63f89caaSJens Wiklander 		}
483*63f89caaSJens Wiklander 	}
484*63f89caaSJens Wiklander 
485*63f89caaSJens Wiklander 	return unknown;
486*63f89caaSJens Wiklander }
487*63f89caaSJens Wiklander 
488*63f89caaSJens Wiklander const char *id2str_class(uint32_t id)
489*63f89caaSJens Wiklander {
490*63f89caaSJens Wiklander 	return ID2STR(id, string_class, "PKCS11_CKO_");
491*63f89caaSJens Wiklander }
492*63f89caaSJens Wiklander 
493*63f89caaSJens Wiklander const char *id2str_type(uint32_t id, uint32_t class)
494*63f89caaSJens Wiklander {
495*63f89caaSJens Wiklander 	enum pkcs11_class_id class_id = class;
496*63f89caaSJens Wiklander 	enum pkcs11_key_type key_type = id;
497*63f89caaSJens Wiklander 
498*63f89caaSJens Wiklander 	switch (class_id) {
499*63f89caaSJens Wiklander 	case PKCS11_CKO_SECRET_KEY:
500*63f89caaSJens Wiklander 	case PKCS11_CKO_PUBLIC_KEY:
501*63f89caaSJens Wiklander 	case PKCS11_CKO_PRIVATE_KEY:
502*63f89caaSJens Wiklander 		return id2str_key_type(key_type);
503*63f89caaSJens Wiklander 	default:
504*63f89caaSJens Wiklander 		return unknown;
505*63f89caaSJens Wiklander 	}
506*63f89caaSJens Wiklander }
507*63f89caaSJens Wiklander 
508*63f89caaSJens Wiklander const char *id2str_key_type(uint32_t id)
509*63f89caaSJens Wiklander {
510*63f89caaSJens Wiklander 	return ID2STR(id, string_key_type, "PKCS11_CKK_");
511*63f89caaSJens Wiklander }
512*63f89caaSJens Wiklander 
513*63f89caaSJens Wiklander const char *id2str_attr_value(uint32_t id, size_t size, void *value)
514*63f89caaSJens Wiklander {
515*63f89caaSJens Wiklander 	static const char str_true[] = "TRUE";
516*63f89caaSJens Wiklander 	static const char str_false[] = "FALSE";
517*63f89caaSJens Wiklander 	static const char str_unknown[] = "*";
518*63f89caaSJens Wiklander 	uint32_t type = 0;
519*63f89caaSJens Wiklander 
520*63f89caaSJens Wiklander 	if (pkcs11_attr2boolprop_shift(id) >= 0)
521*63f89caaSJens Wiklander 		return *(uint8_t *)value ? str_true : str_false;
522*63f89caaSJens Wiklander 
523*63f89caaSJens Wiklander 	if (size < sizeof(uint32_t))
524*63f89caaSJens Wiklander 		return str_unknown;
525*63f89caaSJens Wiklander 
526*63f89caaSJens Wiklander 	TEE_MemMove(&type, value, sizeof(uint32_t));
527*63f89caaSJens Wiklander 
528*63f89caaSJens Wiklander 	switch (id) {
529*63f89caaSJens Wiklander 	case PKCS11_CKA_CLASS:
530*63f89caaSJens Wiklander 		return id2str_class(type);
531*63f89caaSJens Wiklander 	case PKCS11_CKA_KEY_TYPE:
532*63f89caaSJens Wiklander 		return id2str_key_type(type);
533*63f89caaSJens Wiklander 	case PKCS11_CKA_MECHANISM_TYPE:
534*63f89caaSJens Wiklander 		return id2str_mechanism(type);
535*63f89caaSJens Wiklander 	default:
536*63f89caaSJens Wiklander 		return str_unknown;
537*63f89caaSJens Wiklander 	}
538*63f89caaSJens Wiklander }
539*63f89caaSJens Wiklander 
540*63f89caaSJens Wiklander const char *id2str_proc(uint32_t id)
541*63f89caaSJens Wiklander {
542*63f89caaSJens Wiklander 	const char *str = ID2STR(id, string_internal_processing,
543*63f89caaSJens Wiklander 				 "PKCS11_PROCESSING_");
544*63f89caaSJens Wiklander 
545*63f89caaSJens Wiklander 	if (str != unknown)
546*63f89caaSJens Wiklander 		return str;
547*63f89caaSJens Wiklander 
548*63f89caaSJens Wiklander 	return id2str_mechanism(id);
549*63f89caaSJens Wiklander }
550*63f89caaSJens Wiklander 
551*63f89caaSJens Wiklander const char *id2str_function(uint32_t id)
552*63f89caaSJens Wiklander {
553*63f89caaSJens Wiklander 	return ID2STR(id, string_functions, "PKCS11_FUNCTION_");
554*63f89caaSJens Wiklander }
555f7d7fcd9SEtienne Carriere #endif /*CFG_TEE_TA_LOG_LEVEL*/
556