xref: /optee_os/ta/pkcs11/src/pkcs11_helpers.c (revision f5a70e3efb80be4b9bff2c9c811ddc139058e05a)
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 "pkcs11_helpers.h"
12 
13 static const char __maybe_unused unknown[] = "<unknown-identifier>";
14 
15 struct any_id {
16 	uint32_t id;
17 #if CFG_TEE_TA_LOG_LEVEL > 0
18 	const char *string;
19 #endif
20 };
21 
22 /*
23  * Macro PKCS11_ID() can be used to define cells in ID list arrays
24  * or ID/string conversion arrays.
25  */
26 #if CFG_TEE_TA_LOG_LEVEL > 0
27 #define PKCS11_ID(_id)		{ .id = _id, .string = #_id }
28 #else
29 #define PKCS11_ID(_id)		{ .id = _id }
30 #endif
31 
32 #define ID2STR(id, table, prefix)	\
33 	id2str(id, table, ARRAY_SIZE(table), prefix)
34 
35 #if CFG_TEE_TA_LOG_LEVEL > 0
36 /* Convert a PKCS11 ID into its label string */
37 static const char *id2str(uint32_t id, const struct any_id *table,
38 			  size_t count, const char *prefix)
39 {
40 	size_t n = 0;
41 	const char *str = NULL;
42 
43 	for (n = 0; n < count; n++) {
44 		if (id != table[n].id)
45 			continue;
46 
47 		str = table[n].string;
48 
49 		/* Skip prefix provided matches found */
50 		if (prefix && !TEE_MemCompare(str, prefix, strlen(prefix)))
51 			str += strlen(prefix);
52 
53 		return str;
54 	}
55 
56 	return unknown;
57 }
58 #endif /* CFG_TEE_TA_LOG_LEVEL > 0 */
59 
60 /*
61  * TA command IDs: used only as ID/string conversion for debug trace support
62  */
63 static const struct any_id __maybe_unused string_ta_cmd[] = {
64 	PKCS11_ID(PKCS11_CMD_PING),
65 };
66 
67 static const struct any_id __maybe_unused string_rc[] = {
68 	PKCS11_ID(PKCS11_CKR_OK),
69 	PKCS11_ID(PKCS11_CKR_GENERAL_ERROR),
70 	PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY),
71 	PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD),
72 	PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL),
73 	PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED),
74 	PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID),
75 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID),
76 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID),
77 	PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID),
78 	PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID),
79 	PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID),
80 	PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID),
81 	PKCS11_ID(PKCS11_CKR_SLOT_ID_INVALID),
82 	PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID),
83 	PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT),
84 	PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE),
85 	PKCS11_ID(PKCS11_CKR_PIN_INCORRECT),
86 	PKCS11_ID(PKCS11_CKR_PIN_LOCKED),
87 	PKCS11_ID(PKCS11_CKR_PIN_EXPIRED),
88 	PKCS11_ID(PKCS11_CKR_PIN_INVALID),
89 	PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE),
90 	PKCS11_ID(PKCS11_CKR_SESSION_EXISTS),
91 	PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY),
92 	PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS),
93 	PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE),
94 	PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED),
95 	PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED),
96 	PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED),
97 	PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT),
98 	PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED),
99 	PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED),
100 	PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY),
101 	PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK),
102 	PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED),
103 	PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID),
104 	PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN),
105 	PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN),
106 	PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN),
107 	PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED),
108 	PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES),
109 	PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID),
110 	PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS),
111 	PKCS11_ID(PKCS11_RV_NOT_FOUND),
112 	PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED),
113 };
114 
115 #if CFG_TEE_TA_LOG_LEVEL > 0
116 const char *id2str_rc(uint32_t id)
117 {
118 	return ID2STR(id, string_rc, "PKCS11_CKR_");
119 }
120 
121 const char *id2str_ta_cmd(uint32_t id)
122 {
123 	return ID2STR(id, string_ta_cmd, NULL);
124 }
125 #endif /*CFG_TEE_TA_LOG_LEVEL*/
126