xref: /optee_os/ta/pkcs11/src/pkcs11_helpers.c (revision dc99b202f3997248adbe7508698c051f6d677cd0)
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 
16 static const char __maybe_unused unknown[] = "<unknown-identifier>";
17 
18 struct attr_size {
19 	uint32_t id;
20 	uint32_t size;
21 #if CFG_TEE_TA_LOG_LEVEL > 0
22 	const char *string;
23 #endif
24 };
25 
26 #if CFG_TEE_TA_LOG_LEVEL > 0
27 #define PKCS11_ID_SZ(_id, _sz)	\
28 			{ .id = (uint32_t)(_id), .size = (_sz), .string = #_id }
29 #else
30 #define PKCS11_ID_SZ(_id, _sz)	\
31 			{ .id = (uint32_t)(_id), .size = (_sz) }
32 #endif
33 
34 static const struct attr_size attr_ids[] = {
35 	PKCS11_ID_SZ(PKCS11_CKA_CLASS, 4),
36 	PKCS11_ID_SZ(PKCS11_CKA_KEY_TYPE, 4),
37 	PKCS11_ID_SZ(PKCS11_CKA_VALUE, 0),
38 	PKCS11_ID_SZ(PKCS11_CKA_VALUE_LEN, 4),
39 	PKCS11_ID_SZ(PKCS11_CKA_LABEL, 0),
40 	PKCS11_ID_SZ(PKCS11_CKA_WRAP_TEMPLATE, 0),
41 	PKCS11_ID_SZ(PKCS11_CKA_UNWRAP_TEMPLATE, 0),
42 	PKCS11_ID_SZ(PKCS11_CKA_DERIVE_TEMPLATE, 0),
43 	PKCS11_ID_SZ(PKCS11_CKA_START_DATE, 4),
44 	PKCS11_ID_SZ(PKCS11_CKA_END_DATE, 4),
45 	PKCS11_ID_SZ(PKCS11_CKA_OBJECT_ID, 0),
46 	PKCS11_ID_SZ(PKCS11_CKA_APPLICATION, 0),
47 	PKCS11_ID_SZ(PKCS11_CKA_MECHANISM_TYPE, 4),
48 	PKCS11_ID_SZ(PKCS11_CKA_ID, 0),
49 	PKCS11_ID_SZ(PKCS11_CKA_ALLOWED_MECHANISMS, 0),
50 	PKCS11_ID_SZ(PKCS11_CKA_EC_POINT, 0),
51 	PKCS11_ID_SZ(PKCS11_CKA_EC_PARAMS, 0),
52 	PKCS11_ID_SZ(PKCS11_CKA_MODULUS, 0),
53 	PKCS11_ID_SZ(PKCS11_CKA_MODULUS_BITS, 4),
54 	PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_EXPONENT, 0),
55 	PKCS11_ID_SZ(PKCS11_CKA_PRIVATE_EXPONENT, 0),
56 	PKCS11_ID_SZ(PKCS11_CKA_PRIME_1, 0),
57 	PKCS11_ID_SZ(PKCS11_CKA_PRIME_2, 0),
58 	PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_1, 0),
59 	PKCS11_ID_SZ(PKCS11_CKA_EXPONENT_2, 0),
60 	PKCS11_ID_SZ(PKCS11_CKA_COEFFICIENT, 0),
61 	PKCS11_ID_SZ(PKCS11_CKA_SUBJECT, 0),
62 	PKCS11_ID_SZ(PKCS11_CKA_PUBLIC_KEY_INFO, 0),
63 	/* Below are boolean attributes */
64 	PKCS11_ID_SZ(PKCS11_CKA_TOKEN, 1),
65 	PKCS11_ID_SZ(PKCS11_CKA_PRIVATE, 1),
66 	PKCS11_ID_SZ(PKCS11_CKA_TRUSTED, 1),
67 	PKCS11_ID_SZ(PKCS11_CKA_SENSITIVE, 1),
68 	PKCS11_ID_SZ(PKCS11_CKA_ENCRYPT, 1),
69 	PKCS11_ID_SZ(PKCS11_CKA_DECRYPT, 1),
70 	PKCS11_ID_SZ(PKCS11_CKA_WRAP, 1),
71 	PKCS11_ID_SZ(PKCS11_CKA_UNWRAP, 1),
72 	PKCS11_ID_SZ(PKCS11_CKA_SIGN, 1),
73 	PKCS11_ID_SZ(PKCS11_CKA_SIGN_RECOVER, 1),
74 	PKCS11_ID_SZ(PKCS11_CKA_VERIFY, 1),
75 	PKCS11_ID_SZ(PKCS11_CKA_VERIFY_RECOVER, 1),
76 	PKCS11_ID_SZ(PKCS11_CKA_DERIVE, 1),
77 	PKCS11_ID_SZ(PKCS11_CKA_EXTRACTABLE, 1),
78 	PKCS11_ID_SZ(PKCS11_CKA_LOCAL, 1),
79 	PKCS11_ID_SZ(PKCS11_CKA_NEVER_EXTRACTABLE, 1),
80 	PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_SENSITIVE, 1),
81 	PKCS11_ID_SZ(PKCS11_CKA_MODIFIABLE, 1),
82 	PKCS11_ID_SZ(PKCS11_CKA_COPYABLE, 1),
83 	PKCS11_ID_SZ(PKCS11_CKA_DESTROYABLE, 1),
84 	PKCS11_ID_SZ(PKCS11_CKA_ALWAYS_AUTHENTICATE, 1),
85 	PKCS11_ID_SZ(PKCS11_CKA_WRAP_WITH_TRUSTED, 1),
86 	/* Specific PKCS11 TA internal attribute ID */
87 	PKCS11_ID_SZ(PKCS11_CKA_UNDEFINED_ID, 0),
88 };
89 
90 struct any_id {
91 	uint32_t id;
92 #if CFG_TEE_TA_LOG_LEVEL > 0
93 	const char *string;
94 #endif
95 };
96 
97 /*
98  * Macro PKCS11_ID() can be used to define cells in ID list arrays
99  * or ID/string conversion arrays.
100  */
101 #if CFG_TEE_TA_LOG_LEVEL > 0
102 #define PKCS11_ID(_id)		{ .id = _id, .string = #_id }
103 #else
104 #define PKCS11_ID(_id)		{ .id = _id }
105 #endif
106 
107 #define ID2STR(id, table, prefix)	\
108 	id2str(id, table, ARRAY_SIZE(table), prefix)
109 
110 #if CFG_TEE_TA_LOG_LEVEL > 0
111 /* Convert a PKCS11 ID into its label string */
112 static const char *id2str(uint32_t id, const struct any_id *table,
113 			  size_t count, const char *prefix)
114 {
115 	size_t n = 0;
116 	const char *str = NULL;
117 
118 	for (n = 0; n < count; n++) {
119 		if (id != table[n].id)
120 			continue;
121 
122 		str = table[n].string;
123 
124 		/* Skip prefix provided matches found */
125 		if (prefix && !TEE_MemCompare(str, prefix, strlen(prefix)))
126 			str += strlen(prefix);
127 
128 		return str;
129 	}
130 
131 	return unknown;
132 }
133 #endif /* CFG_TEE_TA_LOG_LEVEL > 0 */
134 
135 /*
136  * TA command IDs: used only as ID/string conversion for debug trace support
137  */
138 static const struct any_id __maybe_unused string_ta_cmd[] = {
139 	PKCS11_ID(PKCS11_CMD_PING),
140 	PKCS11_ID(PKCS11_CMD_SLOT_LIST),
141 	PKCS11_ID(PKCS11_CMD_SLOT_INFO),
142 	PKCS11_ID(PKCS11_CMD_TOKEN_INFO),
143 	PKCS11_ID(PKCS11_CMD_MECHANISM_IDS),
144 	PKCS11_ID(PKCS11_CMD_MECHANISM_INFO),
145 	PKCS11_ID(PKCS11_CMD_OPEN_SESSION),
146 	PKCS11_ID(PKCS11_CMD_SESSION_INFO),
147 	PKCS11_ID(PKCS11_CMD_CLOSE_SESSION),
148 	PKCS11_ID(PKCS11_CMD_CLOSE_ALL_SESSIONS),
149 	PKCS11_ID(PKCS11_CMD_INIT_TOKEN),
150 	PKCS11_ID(PKCS11_CMD_INIT_PIN),
151 	PKCS11_ID(PKCS11_CMD_SET_PIN),
152 	PKCS11_ID(PKCS11_CMD_LOGIN),
153 	PKCS11_ID(PKCS11_CMD_LOGOUT),
154 	PKCS11_ID(PKCS11_CMD_CREATE_OBJECT),
155 	PKCS11_ID(PKCS11_CMD_DESTROY_OBJECT),
156 	PKCS11_ID(PKCS11_CMD_ENCRYPT_INIT),
157 	PKCS11_ID(PKCS11_CMD_DECRYPT_INIT),
158 	PKCS11_ID(PKCS11_CMD_ENCRYPT_UPDATE),
159 	PKCS11_ID(PKCS11_CMD_DECRYPT_UPDATE),
160 	PKCS11_ID(PKCS11_CMD_ENCRYPT_FINAL),
161 	PKCS11_ID(PKCS11_CMD_DECRYPT_FINAL),
162 	PKCS11_ID(PKCS11_CMD_ENCRYPT_ONESHOT),
163 	PKCS11_ID(PKCS11_CMD_DECRYPT_ONESHOT),
164 	PKCS11_ID(PKCS11_CMD_SIGN_INIT),
165 	PKCS11_ID(PKCS11_CMD_VERIFY_INIT),
166 	PKCS11_ID(PKCS11_CMD_SIGN_UPDATE),
167 	PKCS11_ID(PKCS11_CMD_VERIFY_UPDATE),
168 	PKCS11_ID(PKCS11_CMD_SIGN_FINAL),
169 	PKCS11_ID(PKCS11_CMD_VERIFY_FINAL),
170 	PKCS11_ID(PKCS11_CMD_SIGN_ONESHOT),
171 	PKCS11_ID(PKCS11_CMD_VERIFY_ONESHOT),
172 	PKCS11_ID(PKCS11_CMD_GENERATE_KEY),
173 	PKCS11_ID(PKCS11_CMD_FIND_OBJECTS_INIT),
174 	PKCS11_ID(PKCS11_CMD_FIND_OBJECTS),
175 	PKCS11_ID(PKCS11_CMD_FIND_OBJECTS_FINAL),
176 };
177 
178 static const struct any_id __maybe_unused string_slot_flags[] = {
179 	PKCS11_ID(PKCS11_CKFS_TOKEN_PRESENT),
180 	PKCS11_ID(PKCS11_CKFS_REMOVABLE_DEVICE),
181 	PKCS11_ID(PKCS11_CKFS_HW_SLOT),
182 };
183 
184 static const struct any_id __maybe_unused string_token_flags[] = {
185 	PKCS11_ID(PKCS11_CKFT_RNG),
186 	PKCS11_ID(PKCS11_CKFT_WRITE_PROTECTED),
187 	PKCS11_ID(PKCS11_CKFT_LOGIN_REQUIRED),
188 	PKCS11_ID(PKCS11_CKFT_USER_PIN_INITIALIZED),
189 	PKCS11_ID(PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED),
190 	PKCS11_ID(PKCS11_CKFT_CLOCK_ON_TOKEN),
191 	PKCS11_ID(PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH),
192 	PKCS11_ID(PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS),
193 	PKCS11_ID(PKCS11_CKFT_TOKEN_INITIALIZED),
194 	PKCS11_ID(PKCS11_CKFT_USER_PIN_COUNT_LOW),
195 	PKCS11_ID(PKCS11_CKFT_USER_PIN_FINAL_TRY),
196 	PKCS11_ID(PKCS11_CKFT_USER_PIN_LOCKED),
197 	PKCS11_ID(PKCS11_CKFT_USER_PIN_TO_BE_CHANGED),
198 	PKCS11_ID(PKCS11_CKFT_SO_PIN_COUNT_LOW),
199 	PKCS11_ID(PKCS11_CKFT_SO_PIN_FINAL_TRY),
200 	PKCS11_ID(PKCS11_CKFT_SO_PIN_LOCKED),
201 	PKCS11_ID(PKCS11_CKFT_SO_PIN_TO_BE_CHANGED),
202 	PKCS11_ID(PKCS11_CKFT_ERROR_STATE),
203 };
204 
205 static const struct any_id __maybe_unused string_session_flags[] = {
206 	PKCS11_ID(PKCS11_CKFSS_RW_SESSION),
207 	PKCS11_ID(PKCS11_CKFSS_SERIAL_SESSION),
208 };
209 
210 static const struct any_id __maybe_unused string_session_state[] = {
211 	PKCS11_ID(PKCS11_CKS_RO_PUBLIC_SESSION),
212 	PKCS11_ID(PKCS11_CKS_RO_USER_FUNCTIONS),
213 	PKCS11_ID(PKCS11_CKS_RW_PUBLIC_SESSION),
214 	PKCS11_ID(PKCS11_CKS_RW_USER_FUNCTIONS),
215 	PKCS11_ID(PKCS11_CKS_RW_SO_FUNCTIONS),
216 };
217 
218 static const struct any_id __maybe_unused string_rc[] = {
219 	PKCS11_ID(PKCS11_CKR_OK),
220 	PKCS11_ID(PKCS11_CKR_GENERAL_ERROR),
221 	PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY),
222 	PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD),
223 	PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL),
224 	PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED),
225 	PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID),
226 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID),
227 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID),
228 	PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID),
229 	PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID),
230 	PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID),
231 	PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID),
232 	PKCS11_ID(PKCS11_CKR_SLOT_ID_INVALID),
233 	PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID),
234 	PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT),
235 	PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE),
236 	PKCS11_ID(PKCS11_CKR_PIN_INCORRECT),
237 	PKCS11_ID(PKCS11_CKR_PIN_LOCKED),
238 	PKCS11_ID(PKCS11_CKR_PIN_EXPIRED),
239 	PKCS11_ID(PKCS11_CKR_PIN_INVALID),
240 	PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE),
241 	PKCS11_ID(PKCS11_CKR_SESSION_EXISTS),
242 	PKCS11_ID(PKCS11_CKR_SESSION_PARALLEL_NOT_SUPPORTED),
243 	PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY),
244 	PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS),
245 	PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE),
246 	PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED),
247 	PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED),
248 	PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED),
249 	PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT),
250 	PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED),
251 	PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED),
252 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY),
253 	PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK),
254 	PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED),
255 	PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID),
256 	PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN),
257 	PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN),
258 	PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN),
259 	PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED),
260 	PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES),
261 	PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID),
262 	PKCS11_ID(PKCS11_CKR_KEY_SIZE_RANGE),
263 	PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS),
264 	PKCS11_ID(PKCS11_CKR_SIGNATURE_LEN_RANGE),
265 	PKCS11_ID(PKCS11_RV_NOT_FOUND),
266 	PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED),
267 };
268 
269 static const struct any_id __maybe_unused string_class[] = {
270 	PKCS11_ID(PKCS11_CKO_SECRET_KEY),
271 	PKCS11_ID(PKCS11_CKO_PUBLIC_KEY),
272 	PKCS11_ID(PKCS11_CKO_PRIVATE_KEY),
273 	PKCS11_ID(PKCS11_CKO_OTP_KEY),
274 	PKCS11_ID(PKCS11_CKO_CERTIFICATE),
275 	PKCS11_ID(PKCS11_CKO_DATA),
276 	PKCS11_ID(PKCS11_CKO_DOMAIN_PARAMETERS),
277 	PKCS11_ID(PKCS11_CKO_HW_FEATURE),
278 	PKCS11_ID(PKCS11_CKO_MECHANISM),
279 	PKCS11_ID(PKCS11_CKO_UNDEFINED_ID)
280 };
281 
282 static const struct any_id __maybe_unused string_key_type[] = {
283 	PKCS11_ID(PKCS11_CKK_AES),
284 	PKCS11_ID(PKCS11_CKK_GENERIC_SECRET),
285 	PKCS11_ID(PKCS11_CKK_MD5_HMAC),
286 	PKCS11_ID(PKCS11_CKK_SHA_1_HMAC),
287 	PKCS11_ID(PKCS11_CKK_SHA224_HMAC),
288 	PKCS11_ID(PKCS11_CKK_SHA256_HMAC),
289 	PKCS11_ID(PKCS11_CKK_SHA384_HMAC),
290 	PKCS11_ID(PKCS11_CKK_SHA512_HMAC),
291 	PKCS11_ID(PKCS11_CKK_EC),
292 	PKCS11_ID(PKCS11_CKK_RSA),
293 	PKCS11_ID(PKCS11_CKK_UNDEFINED_ID)
294 };
295 
296 /*
297  * Processing IDs not exported in the TA API.
298  * PKCS11_CKM_* mechanism IDs are looked up from mechanism_string_id().
299  */
300 static const struct any_id __maybe_unused string_internal_processing[] = {
301 	PKCS11_ID(PKCS11_PROCESSING_IMPORT),
302 };
303 
304 static const struct any_id __maybe_unused string_functions[] = {
305 	PKCS11_ID(PKCS11_FUNCTION_IMPORT),
306 	PKCS11_ID(PKCS11_FUNCTION_ENCRYPT),
307 	PKCS11_ID(PKCS11_FUNCTION_DECRYPT),
308 	PKCS11_ID(PKCS11_FUNCTION_SIGN),
309 	PKCS11_ID(PKCS11_FUNCTION_VERIFY),
310 };
311 
312 /*
313  * Conversion between PKCS11 TA and GPD TEE return codes
314  */
315 enum pkcs11_rc tee2pkcs_error(TEE_Result res)
316 {
317 	switch (res) {
318 	case TEE_SUCCESS:
319 		return PKCS11_CKR_OK;
320 
321 	case TEE_ERROR_BAD_PARAMETERS:
322 		return PKCS11_CKR_ARGUMENTS_BAD;
323 
324 	case TEE_ERROR_OUT_OF_MEMORY:
325 		return PKCS11_CKR_DEVICE_MEMORY;
326 
327 	case TEE_ERROR_SHORT_BUFFER:
328 		return PKCS11_CKR_BUFFER_TOO_SMALL;
329 
330 	case TEE_ERROR_MAC_INVALID:
331 	case TEE_ERROR_SIGNATURE_INVALID:
332 		return PKCS11_CKR_SIGNATURE_INVALID;
333 
334 	default:
335 		return PKCS11_CKR_GENERAL_ERROR;
336 	}
337 }
338 
339 /*
340  * Helper functions to analyse PKCS11 identifiers
341  */
342 
343 /* Check attribute ID is known and size matches if fixed */
344 bool valid_pkcs11_attribute_id(uint32_t id, uint32_t size)
345 {
346 	size_t n = 0;
347 
348 	for (n = 0; n < ARRAY_SIZE(attr_ids); n++)
349 		if (id == attr_ids[n].id)
350 			return !attr_ids[n].size || size == attr_ids[n].size;
351 
352 	return false;
353 }
354 
355 size_t pkcs11_attr_is_type(uint32_t attribute_id)
356 {
357 	enum pkcs11_attr_id id = attribute_id;
358 
359 	switch (id) {
360 	case PKCS11_CKA_KEY_TYPE:
361 	case PKCS11_CKA_MECHANISM_TYPE:
362 	case PKCS11_CKA_KEY_GEN_MECHANISM:
363 		return sizeof(uint32_t);
364 	default:
365 		return 0;
366 	}
367 }
368 
369 bool pkcs11_class_has_type(uint32_t class)
370 {
371 	enum pkcs11_class_id class_id = class;
372 
373 	switch (class_id) {
374 	case PKCS11_CKO_CERTIFICATE:
375 	case PKCS11_CKO_PUBLIC_KEY:
376 	case PKCS11_CKO_PRIVATE_KEY:
377 	case PKCS11_CKO_SECRET_KEY:
378 	case PKCS11_CKO_MECHANISM:
379 	case PKCS11_CKO_HW_FEATURE:
380 		return true;
381 	default:
382 		return false;
383 	}
384 }
385 
386 bool pkcs11_attr_class_is_key(uint32_t class)
387 {
388 	enum pkcs11_class_id class_id = class;
389 
390 	switch (class_id) {
391 	case PKCS11_CKO_SECRET_KEY:
392 	case PKCS11_CKO_PUBLIC_KEY:
393 	case PKCS11_CKO_PRIVATE_KEY:
394 		return true;
395 	default:
396 		return false;
397 	}
398 }
399 
400 bool key_type_is_symm_key(uint32_t id)
401 {
402 	enum pkcs11_key_type key_type = id;
403 
404 	switch (key_type) {
405 	case PKCS11_CKK_AES:
406 	case PKCS11_CKK_GENERIC_SECRET:
407 	case PKCS11_CKK_MD5_HMAC:
408 	case PKCS11_CKK_SHA_1_HMAC:
409 	case PKCS11_CKK_SHA224_HMAC:
410 	case PKCS11_CKK_SHA256_HMAC:
411 	case PKCS11_CKK_SHA384_HMAC:
412 	case PKCS11_CKK_SHA512_HMAC:
413 		return true;
414 	default:
415 		return false;
416 	}
417 }
418 
419 bool key_type_is_asymm_key(uint32_t id)
420 {
421 	enum pkcs11_key_type key_type = id;
422 
423 	switch (key_type) {
424 	case PKCS11_CKK_EC:
425 	case PKCS11_CKK_RSA:
426 		return true;
427 	default:
428 		return false;
429 	}
430 }
431 
432 /*
433  * Returns shift position or -1 on error.
434  * Mainly used when PKCS11_SHEAD_WITH_BOOLPROPS is enabled
435  */
436 int pkcs11_attr2boolprop_shift(uint32_t attr)
437 {
438 	static const uint32_t bpa[] = {
439 		[BPA_TOKEN]		= PKCS11_CKA_TOKEN,
440 		[BPA_PRIVATE]		= PKCS11_CKA_PRIVATE,
441 		[BPA_TRUSTED]		= PKCS11_CKA_TRUSTED,
442 		[BPA_SENSITIVE]		= PKCS11_CKA_SENSITIVE,
443 		[BPA_ENCRYPT]		= PKCS11_CKA_ENCRYPT,
444 		[BPA_DECRYPT]		= PKCS11_CKA_DECRYPT,
445 		[BPA_WRAP]		= PKCS11_CKA_WRAP,
446 		[BPA_UNWRAP]		= PKCS11_CKA_UNWRAP,
447 		[BPA_SIGN]		= PKCS11_CKA_SIGN,
448 		[BPA_SIGN_RECOVER]	= PKCS11_CKA_SIGN_RECOVER,
449 		[BPA_VERIFY]		= PKCS11_CKA_VERIFY,
450 		[BPA_VERIFY_RECOVER]	= PKCS11_CKA_VERIFY_RECOVER,
451 		[BPA_DERIVE]		= PKCS11_CKA_DERIVE,
452 		[BPA_EXTRACTABLE]	= PKCS11_CKA_EXTRACTABLE,
453 		[BPA_LOCAL]		= PKCS11_CKA_LOCAL,
454 		[BPA_NEVER_EXTRACTABLE]	= PKCS11_CKA_NEVER_EXTRACTABLE,
455 		[BPA_ALWAYS_SENSITIVE]	= PKCS11_CKA_ALWAYS_SENSITIVE,
456 		[BPA_MODIFIABLE]	= PKCS11_CKA_MODIFIABLE,
457 		[BPA_COPYABLE]		= PKCS11_CKA_COPYABLE,
458 		[BPA_DESTROYABLE]	= PKCS11_CKA_DESTROYABLE,
459 		[BPA_ALWAYS_AUTHENTICATE] = PKCS11_CKA_ALWAYS_AUTHENTICATE,
460 		[BPA_WRAP_WITH_TRUSTED] = PKCS11_CKA_WRAP_WITH_TRUSTED,
461 	};
462 	size_t pos = 0;
463 
464 	for (pos = 0; pos < ARRAY_SIZE(bpa); pos++)
465 		if (bpa[pos] == attr)
466 			return (int)pos;
467 
468 	return -1;
469 }
470 
471 /* Initialize a TEE attribute for a target PKCS11 TA attribute in an object */
472 bool pkcs2tee_load_attr(TEE_Attribute *tee_ref, uint32_t tee_id,
473 			struct pkcs11_object *obj,
474 			enum pkcs11_attr_id pkcs11_id)
475 {
476 	void *a_ptr = NULL;
477 	uint32_t a_size = 0;
478 
479 	if (get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size))
480 		return false;
481 
482 	TEE_InitRefAttribute(tee_ref, tee_id, a_ptr, a_size);
483 
484 	return true;
485 }
486 
487 /*
488  * Initialize a TEE attribute with hash of a target PKCS11 TA attribute
489  * in an object.
490  */
491 enum pkcs11_rc pkcs2tee_load_hashed_attr(TEE_Attribute *tee_ref,
492 					 uint32_t tee_id,
493 					 struct pkcs11_object *obj,
494 					 enum pkcs11_attr_id pkcs11_id,
495 					 uint32_t tee_algo, void *hash_ptr,
496 					 uint32_t *hash_size)
497 {
498 	TEE_OperationHandle handle = TEE_HANDLE_NULL;
499 	void *a_ptr = NULL;
500 	uint32_t a_size = 0;
501 	enum pkcs11_rc rc = PKCS11_CKR_OK;
502 	TEE_Result res = TEE_ERROR_GENERIC;
503 
504 	rc = get_attribute_ptr(obj->attributes, pkcs11_id, &a_ptr, &a_size);
505 	if (rc)
506 		return rc;
507 
508 	res = TEE_AllocateOperation(&handle, tee_algo, TEE_MODE_DIGEST, 0);
509 	if (res) {
510 		EMSG("TEE_AllocateOperation() failed %#"PRIx32, tee_algo);
511 		return tee2pkcs_error(res);
512 	}
513 
514 	res = TEE_DigestDoFinal(handle, a_ptr, a_size, hash_ptr, hash_size);
515 	TEE_FreeOperation(handle);
516 	if (res) {
517 		EMSG("TEE_DigestDoFinal() failed %#"PRIx32, tee_algo);
518 		return PKCS11_CKR_FUNCTION_FAILED;
519 	}
520 
521 	TEE_InitRefAttribute(tee_ref, tee_id, hash_ptr, *hash_size);
522 
523 	return PKCS11_CKR_OK;
524 }
525 
526 /* Easy conversion between PKCS11 TA function of TEE crypto mode */
527 void pkcs2tee_mode(uint32_t *tee_id, enum processing_func function)
528 {
529 	switch (function) {
530 	case PKCS11_FUNCTION_ENCRYPT:
531 		*tee_id = TEE_MODE_ENCRYPT;
532 		break;
533 	case PKCS11_FUNCTION_DECRYPT:
534 		*tee_id = TEE_MODE_DECRYPT;
535 		break;
536 	case PKCS11_FUNCTION_SIGN:
537 		*tee_id = TEE_MODE_SIGN;
538 		break;
539 	case PKCS11_FUNCTION_VERIFY:
540 		*tee_id = TEE_MODE_VERIFY;
541 		break;
542 	case PKCS11_FUNCTION_DERIVE:
543 		*tee_id = TEE_MODE_DERIVE;
544 		break;
545 	default:
546 		TEE_Panic(function);
547 	}
548 }
549 
550 #if CFG_TEE_TA_LOG_LEVEL > 0
551 const char *id2str_rc(uint32_t id)
552 {
553 	return ID2STR(id, string_rc, "PKCS11_CKR_");
554 }
555 
556 const char *id2str_ta_cmd(uint32_t id)
557 {
558 	return ID2STR(id, string_ta_cmd, NULL);
559 }
560 
561 const char *id2str_slot_flag(uint32_t id)
562 {
563 	return ID2STR(id, string_slot_flags, "PKCS11_CKFS_");
564 }
565 
566 const char *id2str_token_flag(uint32_t id)
567 {
568 	return ID2STR(id, string_token_flags, "PKCS11_CKFT_");
569 }
570 
571 const char *id2str_session_flag(uint32_t id)
572 {
573 	return ID2STR(id, string_session_flags, "PKCS11_CKFSS_");
574 }
575 
576 const char *id2str_session_state(uint32_t id)
577 {
578 	return ID2STR(id, string_session_state, "PKCS11_CKS_");
579 }
580 
581 const char *id2str_attr(uint32_t id)
582 {
583 	size_t n = 0;
584 
585 	for (n = 0; n < ARRAY_SIZE(attr_ids); n++) {
586 		if (id == attr_ids[n].id) {
587 			/* Skip PKCS11_CKA_ prefix */
588 			return attr_ids[n].string + strlen("PKCS11_CKA_");
589 		}
590 	}
591 
592 	return unknown;
593 }
594 
595 const char *id2str_class(uint32_t id)
596 {
597 	return ID2STR(id, string_class, "PKCS11_CKO_");
598 }
599 
600 const char *id2str_type(uint32_t id, uint32_t class)
601 {
602 	enum pkcs11_class_id class_id = class;
603 	enum pkcs11_key_type key_type = id;
604 
605 	switch (class_id) {
606 	case PKCS11_CKO_SECRET_KEY:
607 	case PKCS11_CKO_PUBLIC_KEY:
608 	case PKCS11_CKO_PRIVATE_KEY:
609 		return id2str_key_type(key_type);
610 	default:
611 		return unknown;
612 	}
613 }
614 
615 const char *id2str_key_type(uint32_t id)
616 {
617 	return ID2STR(id, string_key_type, "PKCS11_CKK_");
618 }
619 
620 const char *id2str_attr_value(uint32_t id, size_t size, void *value)
621 {
622 	static const char str_true[] = "TRUE";
623 	static const char str_false[] = "FALSE";
624 	static const char str_unknown[] = "*";
625 	uint32_t type = 0;
626 
627 	if (pkcs11_attr2boolprop_shift(id) >= 0)
628 		return *(uint8_t *)value ? str_true : str_false;
629 
630 	if (size < sizeof(uint32_t))
631 		return str_unknown;
632 
633 	TEE_MemMove(&type, value, sizeof(uint32_t));
634 
635 	switch (id) {
636 	case PKCS11_CKA_CLASS:
637 		return id2str_class(type);
638 	case PKCS11_CKA_KEY_TYPE:
639 		return id2str_key_type(type);
640 	case PKCS11_CKA_MECHANISM_TYPE:
641 		return id2str_mechanism(type);
642 	default:
643 		return str_unknown;
644 	}
645 }
646 
647 const char *id2str_proc(uint32_t id)
648 {
649 	const char *str = ID2STR(id, string_internal_processing,
650 				 "PKCS11_PROCESSING_");
651 
652 	if (str != unknown)
653 		return str;
654 
655 	return id2str_mechanism(id);
656 }
657 
658 const char *id2str_function(uint32_t id)
659 {
660 	return ID2STR(id, string_functions, "PKCS11_FUNCTION_");
661 }
662 #endif /*CFG_TEE_TA_LOG_LEVEL*/
663