1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2018-2020, Linaro Limited 4 */ 5 6 #ifndef PKCS11_TA_H 7 #define PKCS11_TA_H 8 9 #include <stdbool.h> 10 #include <stdint.h> 11 12 #define PKCS11_TA_UUID { 0xfd02c9da, 0x306c, 0x48c7, \ 13 { 0xa4, 0x9c, 0xbb, 0xd8, 0x27, 0xae, 0x86, 0xee } } 14 15 /* PKCS11 trusted application version information */ 16 #define PKCS11_TA_VERSION_MAJOR 0 17 #define PKCS11_TA_VERSION_MINOR 1 18 #define PKCS11_TA_VERSION_PATCH 0 19 20 /* Attribute specific values */ 21 #define PKCS11_UNAVAILABLE_INFORMATION UINT32_C(0xFFFFFFFF) 22 #define PKCS11_UNDEFINED_ID PKCS11_UNAVAILABLE_INFORMATION 23 #define PKCS11_FALSE false 24 #define PKCS11_TRUE true 25 26 /* 27 * Note on PKCS#11 TA commands ABI 28 * 29 * For evolution of the TA API and to not mess with the GPD TEE 4 parameters 30 * constraint, all the PKCS11 TA invocation commands use a subset of available 31 * the GPD TEE invocation parameter types. 32 * 33 * Param#0 is used for the so-called control arguments of the invoked command 34 * and for providing a PKCS#11 compliant status code for the request command. 35 * Param#0 is an in/out memory reference (aka memref[0]). The input buffer 36 * stores serialized arguments for the command. The output buffer store the 37 * 32bit TA return code for the command. As a consequence, param#0 shall 38 * always be an input/output memory reference of at least 32bit, more if 39 * the command expects more input arguments. 40 * 41 * When the TA returns with TEE_SUCCESS result, client shall always get the 42 * 32bit value stored in param#0 output buffer and use the value as TA 43 * return code for the invoked command. 44 * 45 * Param#1 can be used for input data arguments of the invoked command. 46 * It is unused or is a input memory reference, aka memref[1]. 47 * Evolution of the API may use memref[1] for output data as well. 48 * 49 * Param#2 is mostly used for output data arguments of the invoked command 50 * and for output handles generated from invoked commands. 51 * Few commands uses it for a secondary input data buffer argument. 52 * It is unused or is a input/output/in-out memory reference, aka memref[2]. 53 * 54 * Param#3 is currently unused and reserved for evolution of the API. 55 */ 56 57 enum pkcs11_ta_cmd { 58 /* 59 * PKCS11_CMD_PING Ack TA presence and return version info 60 * 61 * [in] memref[0] = 32bit, unused, must be 0 62 * [out] memref[0] = 32bit return code, enum pkcs11_rc 63 * [out] memref[2] = [ 64 * 32bit version major value, 65 * 32bit version minor value 66 * 32bit version patch value 67 * ] 68 */ 69 PKCS11_CMD_PING = 0, 70 71 /* 72 * PKCS11_CMD_SLOT_LIST - Get the table of the valid slot IDs 73 * 74 * [in] memref[0] = 32bit, unused, must be 0 75 * [out] memref[0] = 32bit return code, enum pkcs11_rc 76 * [out] memref[2] = 32bit array slot_ids[slot counts] 77 * 78 * The TA instance may represent several PKCS#11 slots and 79 * associated tokens. This commadn reports the IDs of embedded tokens. 80 * This command relates the PKCS#11 API function C_GetSlotList(). 81 */ 82 PKCS11_CMD_SLOT_LIST = 1, 83 84 /* 85 * PKCS11_CMD_SLOT_INFO - Get cryptoki structured slot information 86 * 87 * [in] memref[0] = 32bit slot ID 88 * [out] memref[0] = 32bit return code, enum pkcs11_rc 89 * [out] memref[2] = (struct pkcs11_slot_info)info 90 * 91 * The TA instance may represent several PKCS#11 slots/tokens. 92 * This command relates the PKCS#11 API function C_GetSlotInfo(). 93 */ 94 PKCS11_CMD_SLOT_INFO = 2, 95 96 /* 97 * PKCS11_CMD_TOKEN_INFO - Get cryptoki structured token information 98 * 99 * [in] memref[0] = 32bit slot ID 100 * [out] memref[0] = 32bit return code, enum pkcs11_rc 101 * [out] memref[2] = (struct pkcs11_token_info)info 102 * 103 * The TA instance may represent several PKCS#11 slots/tokens. 104 * This command relates the PKCS#11 API function C_GetTokenInfo(). 105 */ 106 PKCS11_CMD_TOKEN_INFO = 3, 107 108 /* 109 * PKCS11_CMD_MECHANISM_IDS - Get list of the supported mechanisms 110 * 111 * [in] memref[0] = 32bit slot ID 112 * [out] memref[0] = 32bit return code, enum pkcs11_rc 113 * [out] memref[2] = 32bit array mechanism IDs 114 * 115 * This command relates to the PKCS#11 API function 116 * C_GetMechanismList(). 117 */ 118 PKCS11_CMD_MECHANISM_IDS = 4, 119 120 /* 121 * PKCS11_CMD_MECHANISM_INFO - Get information on a specific mechanism 122 * 123 * [in] memref[0] = [ 124 * 32bit slot ID, 125 * 32bit mechanism ID 126 * ] 127 * [out] memref[0] = 32bit return code, enum pkcs11_rc 128 * [out] memref[2] = (struct pkcs11_mechanism_info)info 129 * 130 * This command relates to the PKCS#11 API function 131 * C_GetMechanismInfo(). 132 */ 133 PKCS11_CMD_MECHANISM_INFO = 5, 134 }; 135 136 /* 137 * Command return codes 138 * PKCS11_<x> relates CryptoKi client API CKR_<x> 139 */ 140 enum pkcs11_rc { 141 PKCS11_CKR_OK = 0, 142 PKCS11_CKR_CANCEL = 0x0001, 143 PKCS11_CKR_SLOT_ID_INVALID = 0x0003, 144 PKCS11_CKR_GENERAL_ERROR = 0x0005, 145 PKCS11_CKR_FUNCTION_FAILED = 0x0006, 146 PKCS11_CKR_ARGUMENTS_BAD = 0x0007, 147 PKCS11_CKR_ATTRIBUTE_READ_ONLY = 0x0010, 148 PKCS11_CKR_ATTRIBUTE_SENSITIVE = 0x0011, 149 PKCS11_CKR_ATTRIBUTE_TYPE_INVALID = 0x0012, 150 PKCS11_CKR_ATTRIBUTE_VALUE_INVALID = 0x0013, 151 PKCS11_CKR_ACTION_PROHIBITED = 0x001b, 152 PKCS11_CKR_DATA_INVALID = 0x0020, 153 PKCS11_CKR_DATA_LEN_RANGE = 0x0021, 154 PKCS11_CKR_DEVICE_ERROR = 0x0030, 155 PKCS11_CKR_DEVICE_MEMORY = 0x0031, 156 PKCS11_CKR_DEVICE_REMOVED = 0x0032, 157 PKCS11_CKR_ENCRYPTED_DATA_INVALID = 0x0040, 158 PKCS11_CKR_ENCRYPTED_DATA_LEN_RANGE = 0x0041, 159 PKCS11_CKR_KEY_HANDLE_INVALID = 0x0060, 160 PKCS11_CKR_KEY_SIZE_RANGE = 0x0062, 161 PKCS11_CKR_KEY_TYPE_INCONSISTENT = 0x0063, 162 PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED = 0x0068, 163 PKCS11_CKR_KEY_NOT_WRAPPABLE = 0x0069, 164 PKCS11_CKR_KEY_UNEXTRACTABLE = 0x006a, 165 PKCS11_CKR_MECHANISM_INVALID = 0x0070, 166 PKCS11_CKR_MECHANISM_PARAM_INVALID = 0x0071, 167 PKCS11_CKR_OBJECT_HANDLE_INVALID = 0x0082, 168 PKCS11_CKR_OPERATION_ACTIVE = 0x0090, 169 PKCS11_CKR_OPERATION_NOT_INITIALIZED = 0x0091, 170 PKCS11_CKR_PIN_INCORRECT = 0x00a0, 171 PKCS11_CKR_PIN_INVALID = 0x00a1, 172 PKCS11_CKR_PIN_LEN_RANGE = 0x00a2, 173 PKCS11_CKR_PIN_EXPIRED = 0x00a3, 174 PKCS11_CKR_PIN_LOCKED = 0x00a4, 175 PKCS11_CKR_SESSION_CLOSED = 0x00b0, 176 PKCS11_CKR_SESSION_COUNT = 0x00b1, 177 PKCS11_CKR_SESSION_HANDLE_INVALID = 0x00b3, 178 PKCS11_CKR_SESSION_READ_ONLY = 0x00b5, 179 PKCS11_CKR_SESSION_EXISTS = 0x00b6, 180 PKCS11_CKR_SESSION_READ_ONLY_EXISTS = 0x00b7, 181 PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS = 0x00b8, 182 PKCS11_CKR_SIGNATURE_INVALID = 0x00c0, 183 PKCS11_CKR_SIGNATURE_LEN_RANGE = 0x00c1, 184 PKCS11_CKR_TEMPLATE_INCOMPLETE = 0x00d0, 185 PKCS11_CKR_TEMPLATE_INCONSISTENT = 0x00d1, 186 PKCS11_CKR_TOKEN_NOT_PRESENT = 0x00e0, 187 PKCS11_CKR_TOKEN_NOT_RECOGNIZED = 0x00e1, 188 PKCS11_CKR_TOKEN_WRITE_PROTECTED = 0x00e2, 189 PKCS11_CKR_USER_ALREADY_LOGGED_IN = 0x0100, 190 PKCS11_CKR_USER_NOT_LOGGED_IN = 0x0101, 191 PKCS11_CKR_USER_PIN_NOT_INITIALIZED = 0x0102, 192 PKCS11_CKR_USER_TYPE_INVALID = 0x0103, 193 PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN = 0x0104, 194 PKCS11_CKR_USER_TOO_MANY_TYPES = 0x0105, 195 PKCS11_CKR_DOMAIN_PARAMS_INVALID = 0x0130, 196 PKCS11_CKR_CURVE_NOT_SUPPORTED = 0x0140, 197 PKCS11_CKR_BUFFER_TOO_SMALL = 0x0150, 198 PKCS11_CKR_SAVED_STATE_INVALID = 0x0160, 199 PKCS11_CKR_INFORMATION_SENSITIVE = 0x0170, 200 PKCS11_CKR_STATE_UNSAVEABLE = 0x0180, 201 PKCS11_CKR_PIN_TOO_WEAK = 0x01b8, 202 PKCS11_CKR_PUBLIC_KEY_INVALID = 0x01b9, 203 PKCS11_CKR_FUNCTION_REJECTED = 0x0200, 204 /* Vendor specific IDs not returned to client */ 205 PKCS11_RV_NOT_FOUND = 0x80000000, 206 PKCS11_RV_NOT_IMPLEMENTED = 0x80000001, 207 }; 208 209 /* 210 * Arguments for PKCS11_CMD_SLOT_INFO 211 */ 212 #define PKCS11_SLOT_DESC_SIZE 64 213 #define PKCS11_SLOT_MANUFACTURER_SIZE 32 214 #define PKCS11_SLOT_VERSION_SIZE 2 215 216 struct pkcs11_slot_info { 217 uint8_t slot_description[PKCS11_SLOT_DESC_SIZE]; 218 uint8_t manufacturer_id[PKCS11_SLOT_MANUFACTURER_SIZE]; 219 uint32_t flags; 220 uint8_t hardware_version[PKCS11_SLOT_VERSION_SIZE]; 221 uint8_t firmware_version[PKCS11_SLOT_VERSION_SIZE]; 222 }; 223 224 /* 225 * Values for pkcs11_slot_info::flags. 226 * PKCS11_CKFS_<x> reflects CryptoKi client API slot flags CKF_<x>. 227 */ 228 #define PKCS11_CKFS_TOKEN_PRESENT (1U << 0) 229 #define PKCS11_CKFS_REMOVABLE_DEVICE (1U << 1) 230 #define PKCS11_CKFS_HW_SLOT (1U << 2) 231 232 /* 233 * Arguments for PKCS11_CMD_TOKEN_INFO 234 */ 235 #define PKCS11_TOKEN_LABEL_SIZE 32 236 #define PKCS11_TOKEN_MANUFACTURER_SIZE 32 237 #define PKCS11_TOKEN_MODEL_SIZE 16 238 #define PKCS11_TOKEN_SERIALNUM_SIZE 16 239 240 struct pkcs11_token_info { 241 uint8_t label[PKCS11_TOKEN_LABEL_SIZE]; 242 uint8_t manufacturer_id[PKCS11_TOKEN_MANUFACTURER_SIZE]; 243 uint8_t model[PKCS11_TOKEN_MODEL_SIZE]; 244 uint8_t serial_number[PKCS11_TOKEN_SERIALNUM_SIZE]; 245 uint32_t flags; 246 uint32_t max_session_count; 247 uint32_t session_count; 248 uint32_t max_rw_session_count; 249 uint32_t rw_session_count; 250 uint32_t max_pin_len; 251 uint32_t min_pin_len; 252 uint32_t total_public_memory; 253 uint32_t free_public_memory; 254 uint32_t total_private_memory; 255 uint32_t free_private_memory; 256 uint8_t hardware_version[2]; 257 uint8_t firmware_version[2]; 258 uint8_t utc_time[16]; 259 }; 260 261 /* 262 * Values for pkcs11_token_info::flags. 263 * PKCS11_CKFT_<x> reflects CryptoKi client API token flags CKF_<x>. 264 */ 265 #define PKCS11_CKFT_RNG (1U << 0) 266 #define PKCS11_CKFT_WRITE_PROTECTED (1U << 1) 267 #define PKCS11_CKFT_LOGIN_REQUIRED (1U << 2) 268 #define PKCS11_CKFT_USER_PIN_INITIALIZED (1U << 3) 269 #define PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED (1U << 5) 270 #define PKCS11_CKFT_CLOCK_ON_TOKEN (1U << 6) 271 #define PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH (1U << 8) 272 #define PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS (1U << 9) 273 #define PKCS11_CKFT_TOKEN_INITIALIZED (1U << 10) 274 #define PKCS11_CKFT_SECONDARY_AUTHENTICATION (1U << 11) 275 #define PKCS11_CKFT_USER_PIN_COUNT_LOW (1U << 16) 276 #define PKCS11_CKFT_USER_PIN_FINAL_TRY (1U << 17) 277 #define PKCS11_CKFT_USER_PIN_LOCKED (1U << 18) 278 #define PKCS11_CKFT_USER_PIN_TO_BE_CHANGED (1U << 19) 279 #define PKCS11_CKFT_SO_PIN_COUNT_LOW (1U << 20) 280 #define PKCS11_CKFT_SO_PIN_FINAL_TRY (1U << 21) 281 #define PKCS11_CKFT_SO_PIN_LOCKED (1U << 22) 282 #define PKCS11_CKFT_SO_PIN_TO_BE_CHANGED (1U << 23) 283 #define PKCS11_CKFT_ERROR_STATE (1U << 24) 284 285 /* Values for user identity */ 286 enum pkcs11_user_type { 287 PKCS11_CKU_SO = 0x000, 288 PKCS11_CKU_USER = 0x001, 289 PKCS11_CKU_CONTEXT_SPECIFIC = 0x002, 290 }; 291 292 #endif /*PKCS11_TA_H*/ 293