1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
// SPDX-License-Identifier: BSD-2-Clause
/*
* Copyright (c) 2018-2020, Linaro Limited
*/
#include <pkcs11_ta.h>
#include <string.h>
#include <tee_internal_api.h>
#include <util.h>
#include "pkcs11_helpers.h"
static const char __maybe_unused unknown[] = "<unknown-identifier>";
struct any_id {
uint32_t id;
#if CFG_TEE_TA_LOG_LEVEL > 0
const char *string;
#endif
};
/*
* Macro PKCS11_ID() can be used to define cells in ID list arrays
* or ID/string conversion arrays.
*/
#if CFG_TEE_TA_LOG_LEVEL > 0
#define PKCS11_ID(_id) { .id = _id, .string = #_id }
#else
#define PKCS11_ID(_id) { .id = _id }
#endif
#define ID2STR(id, table, prefix) \
id2str(id, table, ARRAY_SIZE(table), prefix)
#if CFG_TEE_TA_LOG_LEVEL > 0
/* Convert a PKCS11 ID into its label string */
static const char *id2str(uint32_t id, const struct any_id *table,
size_t count, const char *prefix)
{
size_t n = 0;
const char *str = NULL;
for (n = 0; n < count; n++) {
if (id != table[n].id)
continue;
str = table[n].string;
/* Skip prefix provided matches found */
if (prefix && !TEE_MemCompare(str, prefix, strlen(prefix)))
str += strlen(prefix);
return str;
}
return unknown;
}
#endif /* CFG_TEE_TA_LOG_LEVEL > 0 */
/*
* TA command IDs: used only as ID/string conversion for debug trace support
*/
static const struct any_id __maybe_unused string_ta_cmd[] = {
PKCS11_ID(PKCS11_CMD_PING),
PKCS11_ID(PKCS11_CMD_SLOT_LIST),
PKCS11_ID(PKCS11_CMD_SLOT_INFO),
PKCS11_ID(PKCS11_CMD_TOKEN_INFO),
PKCS11_ID(PKCS11_CMD_MECHANISM_IDS),
PKCS11_ID(PKCS11_CMD_MECHANISM_INFO),
PKCS11_ID(PKCS11_CMD_OPEN_SESSION),
PKCS11_ID(PKCS11_CMD_SESSION_INFO),
PKCS11_ID(PKCS11_CMD_CLOSE_SESSION),
PKCS11_ID(PKCS11_CMD_CLOSE_ALL_SESSIONS),
PKCS11_ID(PKCS11_CMD_INIT_TOKEN),
PKCS11_ID(PKCS11_CMD_INIT_PIN),
PKCS11_ID(PKCS11_CMD_SET_PIN),
PKCS11_ID(PKCS11_CMD_LOGIN),
PKCS11_ID(PKCS11_CMD_LOGOUT),
PKCS11_ID(PKCS11_CMD_CREATE_OBJECT),
PKCS11_ID(PKCS11_CMD_DESTROY_OBJECT),
};
static const struct any_id __maybe_unused string_slot_flags[] = {
PKCS11_ID(PKCS11_CKFS_TOKEN_PRESENT),
PKCS11_ID(PKCS11_CKFS_REMOVABLE_DEVICE),
PKCS11_ID(PKCS11_CKFS_HW_SLOT),
};
static const struct any_id __maybe_unused string_token_flags[] = {
PKCS11_ID(PKCS11_CKFT_RNG),
PKCS11_ID(PKCS11_CKFT_WRITE_PROTECTED),
PKCS11_ID(PKCS11_CKFT_LOGIN_REQUIRED),
PKCS11_ID(PKCS11_CKFT_USER_PIN_INITIALIZED),
PKCS11_ID(PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED),
PKCS11_ID(PKCS11_CKFT_CLOCK_ON_TOKEN),
PKCS11_ID(PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH),
PKCS11_ID(PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS),
PKCS11_ID(PKCS11_CKFT_TOKEN_INITIALIZED),
PKCS11_ID(PKCS11_CKFT_USER_PIN_COUNT_LOW),
PKCS11_ID(PKCS11_CKFT_USER_PIN_FINAL_TRY),
PKCS11_ID(PKCS11_CKFT_USER_PIN_LOCKED),
PKCS11_ID(PKCS11_CKFT_USER_PIN_TO_BE_CHANGED),
PKCS11_ID(PKCS11_CKFT_SO_PIN_COUNT_LOW),
PKCS11_ID(PKCS11_CKFT_SO_PIN_FINAL_TRY),
PKCS11_ID(PKCS11_CKFT_SO_PIN_LOCKED),
PKCS11_ID(PKCS11_CKFT_SO_PIN_TO_BE_CHANGED),
PKCS11_ID(PKCS11_CKFT_ERROR_STATE),
};
static const struct any_id __maybe_unused string_session_flags[] = {
PKCS11_ID(PKCS11_CKFSS_RW_SESSION),
PKCS11_ID(PKCS11_CKFSS_SERIAL_SESSION),
};
static const struct any_id __maybe_unused string_session_state[] = {
PKCS11_ID(PKCS11_CKS_RO_PUBLIC_SESSION),
PKCS11_ID(PKCS11_CKS_RO_USER_FUNCTIONS),
PKCS11_ID(PKCS11_CKS_RW_PUBLIC_SESSION),
PKCS11_ID(PKCS11_CKS_RW_USER_FUNCTIONS),
PKCS11_ID(PKCS11_CKS_RW_SO_FUNCTIONS),
};
static const struct any_id __maybe_unused string_rc[] = {
PKCS11_ID(PKCS11_CKR_OK),
PKCS11_ID(PKCS11_CKR_GENERAL_ERROR),
PKCS11_ID(PKCS11_CKR_DEVICE_MEMORY),
PKCS11_ID(PKCS11_CKR_ARGUMENTS_BAD),
PKCS11_ID(PKCS11_CKR_BUFFER_TOO_SMALL),
PKCS11_ID(PKCS11_CKR_FUNCTION_FAILED),
PKCS11_ID(PKCS11_CKR_SIGNATURE_INVALID),
PKCS11_ID(PKCS11_CKR_ATTRIBUTE_TYPE_INVALID),
PKCS11_ID(PKCS11_CKR_ATTRIBUTE_VALUE_INVALID),
PKCS11_ID(PKCS11_CKR_OBJECT_HANDLE_INVALID),
PKCS11_ID(PKCS11_CKR_KEY_HANDLE_INVALID),
PKCS11_ID(PKCS11_CKR_MECHANISM_INVALID),
PKCS11_ID(PKCS11_CKR_SESSION_HANDLE_INVALID),
PKCS11_ID(PKCS11_CKR_SLOT_ID_INVALID),
PKCS11_ID(PKCS11_CKR_MECHANISM_PARAM_INVALID),
PKCS11_ID(PKCS11_CKR_TEMPLATE_INCONSISTENT),
PKCS11_ID(PKCS11_CKR_TEMPLATE_INCOMPLETE),
PKCS11_ID(PKCS11_CKR_PIN_INCORRECT),
PKCS11_ID(PKCS11_CKR_PIN_LOCKED),
PKCS11_ID(PKCS11_CKR_PIN_EXPIRED),
PKCS11_ID(PKCS11_CKR_PIN_INVALID),
PKCS11_ID(PKCS11_CKR_PIN_LEN_RANGE),
PKCS11_ID(PKCS11_CKR_SESSION_EXISTS),
PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY),
PKCS11_ID(PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS),
PKCS11_ID(PKCS11_CKR_OPERATION_ACTIVE),
PKCS11_ID(PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED),
PKCS11_ID(PKCS11_CKR_OPERATION_NOT_INITIALIZED),
PKCS11_ID(PKCS11_CKR_TOKEN_WRITE_PROTECTED),
PKCS11_ID(PKCS11_CKR_TOKEN_NOT_PRESENT),
PKCS11_ID(PKCS11_CKR_TOKEN_NOT_RECOGNIZED),
PKCS11_ID(PKCS11_CKR_ACTION_PROHIBITED),
PKCS11_ID(PKCS11_CKR_ATTRIBUTE_READ_ONLY),
PKCS11_ID(PKCS11_CKR_PIN_TOO_WEAK),
PKCS11_ID(PKCS11_CKR_CURVE_NOT_SUPPORTED),
PKCS11_ID(PKCS11_CKR_DOMAIN_PARAMS_INVALID),
PKCS11_ID(PKCS11_CKR_USER_ALREADY_LOGGED_IN),
PKCS11_ID(PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN),
PKCS11_ID(PKCS11_CKR_USER_NOT_LOGGED_IN),
PKCS11_ID(PKCS11_CKR_USER_PIN_NOT_INITIALIZED),
PKCS11_ID(PKCS11_CKR_USER_TOO_MANY_TYPES),
PKCS11_ID(PKCS11_CKR_USER_TYPE_INVALID),
PKCS11_ID(PKCS11_CKR_SESSION_READ_ONLY_EXISTS),
PKCS11_ID(PKCS11_RV_NOT_FOUND),
PKCS11_ID(PKCS11_RV_NOT_IMPLEMENTED),
};
/*
* Conversion between PKCS11 TA and GPD TEE return codes
*/
enum pkcs11_rc tee2pkcs_error(TEE_Result res)
{
switch (res) {
case TEE_SUCCESS:
return PKCS11_CKR_OK;
case TEE_ERROR_BAD_PARAMETERS:
return PKCS11_CKR_ARGUMENTS_BAD;
case TEE_ERROR_OUT_OF_MEMORY:
return PKCS11_CKR_DEVICE_MEMORY;
case TEE_ERROR_SHORT_BUFFER:
return PKCS11_CKR_BUFFER_TOO_SMALL;
case TEE_ERROR_MAC_INVALID:
case TEE_ERROR_SIGNATURE_INVALID:
return PKCS11_CKR_SIGNATURE_INVALID;
default:
return PKCS11_CKR_GENERAL_ERROR;
}
}
#if CFG_TEE_TA_LOG_LEVEL > 0
const char *id2str_rc(uint32_t id)
{
return ID2STR(id, string_rc, "PKCS11_CKR_");
}
const char *id2str_ta_cmd(uint32_t id)
{
return ID2STR(id, string_ta_cmd, NULL);
}
const char *id2str_slot_flag(uint32_t id)
{
return ID2STR(id, string_slot_flags, "PKCS11_CKFS_");
}
const char *id2str_token_flag(uint32_t id)
{
return ID2STR(id, string_token_flags, "PKCS11_CKFT_");
}
const char *id2str_session_flag(uint32_t id)
{
return ID2STR(id, string_session_flags, "PKCS11_CKFSS_");
}
const char *id2str_session_state(uint32_t id)
{
return ID2STR(id, string_session_state, "PKCS11_CKS_");
}
#endif /*CFG_TEE_TA_LOG_LEVEL*/
|
