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_CK_UNAVAILABLE_INFORMATION UINT32_C(0xFFFFFFFF) 22 #define PKCS11_UNDEFINED_ID UINT32_C(0xFFFFFFFF) 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 an 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 an 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 (PKCS11_CKM_*) 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 * PKCS11_CMD_OPEN_SESSION - Open a session 137 * 138 * [in] memref[0] = [ 139 * 32bit slot ID, 140 * 32bit session flags, 141 * ] 142 * [out] memref[0] = 32bit return code, enum pkcs11_rc 143 * [out] memref[2] = 32bit session handle 144 * 145 * This command relates to the PKCS#11 API function C_OpenSession(). 146 */ 147 PKCS11_CMD_OPEN_SESSION = 6, 148 149 /* 150 * PKCS11_CMD_CLOSE_SESSION - Close an opened session 151 * 152 * [in] memref[0] = 32bit session handle 153 * [out] memref[0] = 32bit return code, enum pkcs11_rc 154 * 155 * This command relates to the PKCS#11 API function C_CloseSession(). 156 */ 157 PKCS11_CMD_CLOSE_SESSION = 7, 158 159 /* 160 * PKCS11_CMD_CLOSE_ALL_SESSIONS - Close all client sessions on token 161 * 162 * [in] memref[0] = 32bit slot ID 163 * [out] memref[0] = 32bit return code, enum pkcs11_rc 164 * 165 * This command relates to the PKCS#11 API function 166 * C_CloseAllSessions(). 167 */ 168 PKCS11_CMD_CLOSE_ALL_SESSIONS = 8, 169 170 /* 171 * PKCS11_CMD_SESSION_INFO - Get Cryptoki information on a session 172 * 173 * [in] memref[0] = 32bit session handle 174 * [out] memref[0] = 32bit return code, enum pkcs11_rc 175 * [out] memref[2] = (struct pkcs11_session_info)info 176 * 177 * This command relates to the PKCS#11 API function C_GetSessionInfo(). 178 */ 179 PKCS11_CMD_SESSION_INFO = 9, 180 181 /* 182 * PKCS11_CMD_INIT_TOKEN - Initialize PKCS#11 token 183 * 184 * [in] memref[0] = [ 185 * 32bit slot ID, 186 * 32bit PIN length, 187 * byte array label[32] 188 * byte array PIN[PIN length], 189 * ] 190 * [out] memref[0] = 32bit return code, enum pkcs11_rc 191 * 192 * This command relates to the PKCS#11 API function C_InitToken(). 193 */ 194 PKCS11_CMD_INIT_TOKEN = 10, 195 196 /* 197 * PKCS11_CMD_INIT_PIN - Initialize user PIN 198 * 199 * [in] memref[0] = [ 200 * 32bit session handle, 201 * 32bit PIN byte size, 202 * byte array: PIN data 203 * ] 204 * [out] memref[0] = 32bit return code, enum pkcs11_rc 205 * 206 * This command relates to the PKCS#11 API function C_InitPIN(). 207 */ 208 PKCS11_CMD_INIT_PIN = 11, 209 210 /* 211 * PKCS11_CMD_SET_PIN - Change user PIN 212 * 213 * [in] memref[0] = [ 214 * 32bit session handle, 215 * 32bit old PIN byte size, 216 * 32bit new PIN byte size, 217 * byte array: PIN data, 218 * byte array: new PIN data, 219 * ] 220 * [out] memref[0] = 32bit return code, enum pkcs11_rc 221 * 222 * This command relates to the PKCS#11 API function C_SetPIN(). 223 */ 224 PKCS11_CMD_SET_PIN = 12, 225 226 /* 227 * PKCS11_CMD_LOGIN - Initialize user PIN 228 * 229 * [in] memref[0] = [ 230 * 32bit session handle, 231 * 32bit user identifier, enum pkcs11_user_type 232 * 32bit PIN byte size, 233 * byte array: PIN data 234 * ] 235 * [out] memref[0] = 32bit return code, enum pkcs11_rc 236 * 237 * This command relates to the PKCS#11 API function C_Login(). 238 */ 239 PKCS11_CMD_LOGIN = 13, 240 241 /* 242 * PKCS11_CMD_LOGOUT - Log out from token 243 * 244 * [in] memref[0] = [ 245 * 32bit session handle, 246 * ] 247 * [out] memref[0] = 32bit return code, enum pkcs11_rc 248 * 249 * This command relates to the PKCS#11 API function C_Logout(). 250 */ 251 PKCS11_CMD_LOGOUT = 14, 252 253 /* 254 * PKCS11_CMD_CREATE_OBJECT - Create a raw client assembled object in 255 * the session or token 256 * 257 * 258 * [in] memref[0] = [ 259 * 32bit session handle, 260 * (struct pkcs11_object_head)attribs + attributes data 261 * ] 262 * [out] memref[0] = 32bit return code, enum pkcs11_rc 263 * [out] memref[2] = 32bit object handle 264 * 265 * This command relates to the PKCS#11 API function C_CreateObject(). 266 */ 267 PKCS11_CMD_CREATE_OBJECT = 15, 268 269 /* 270 * PKCS11_CMD_DESTROY_OBJECT - Destroy an object 271 * 272 * [in] memref[0] = [ 273 * 32bit session handle, 274 * 32bit object handle 275 * ] 276 * [out] memref[0] = 32bit return code, enum pkcs11_rc 277 * 278 * This command relates to the PKCS#11 API function C_DestroyObject(). 279 */ 280 PKCS11_CMD_DESTROY_OBJECT = 16, 281 282 /* 283 * PKCS11_CMD_ENCRYPT_INIT - Initialize encryption processing 284 * PKCS11_CMD_DECRYPT_INIT - Initialize decryption processing 285 * 286 * [in] memref[0] = [ 287 * 32bit session handle, 288 * 32bit object handle of the key, 289 * (struct pkcs11_attribute_head)mechanism + mecha params 290 * ] 291 * [out] memref[0] = 32bit return code, enum pkcs11_rc 292 * 293 * These commands relate to the PKCS#11 API functions 294 * C_EncryptInit() and C_DecryptInit(). 295 */ 296 PKCS11_CMD_ENCRYPT_INIT = 17, 297 PKCS11_CMD_DECRYPT_INIT = 18, 298 299 /* 300 * PKCS11_CMD_ENCRYPT_UPDATE - Update encryption processing 301 * PKCS11_CMD_DECRYPT_UPDATE - Update decryption processing 302 * 303 * [in] memref[0] = 32bit session handle 304 * [out] memref[0] = 32bit return code, enum pkcs11_rc 305 * [in] memref[1] = input data to be processed 306 * [out] memref[2] = output processed data 307 * 308 * These commands relate to the PKCS#11 API functions 309 * C_EncryptUpdate() and C_DecryptUpdate(). 310 */ 311 PKCS11_CMD_ENCRYPT_UPDATE = 19, 312 PKCS11_CMD_DECRYPT_UPDATE = 20, 313 314 /* 315 * PKCS11_CMD_ENCRYPT_FINAL - Finalize encryption processing 316 * PKCS11_CMD_DECRYPT_FINAL - Finalize decryption processing 317 * 318 * [in] memref[0] = 32bit session handle 319 * [out] memref[0] = 32bit return code, enum pkcs11_rc 320 * [out] memref[2] = output processed data 321 * 322 * These commands relate to the PKCS#11 API functions 323 * C_EncryptFinal() and C_DecryptFinal(). 324 */ 325 PKCS11_CMD_ENCRYPT_FINAL = 21, 326 PKCS11_CMD_DECRYPT_FINAL = 22, 327 328 /* 329 * PKCS11_CMD_ENCRYPT_ONESHOT - Update and finalize encryption 330 * processing 331 * PKCS11_CMD_DECRYPT_ONESHOT - Update and finalize decryption 332 * processing 333 * 334 * [in] memref[0] = 32bit session handle 335 * [out] memref[0] = 32bit return code, enum pkcs11_rc 336 * [in] memref[1] = input data to be processed 337 * [out] memref[2] = output processed data 338 * 339 * These commands relate to the PKCS#11 API functions C_Encrypt and 340 * C_Decrypt. 341 */ 342 PKCS11_CMD_ENCRYPT_ONESHOT = 23, 343 PKCS11_CMD_DECRYPT_ONESHOT = 24, 344 345 /* 346 * PKCS11_CMD_SIGN_INIT - Initialize a signature computation 347 * processing 348 * PKCS11_CMD_VERIFY_INIT - Initialize a signature verification 349 * processing 350 * 351 * [in] memref[0] = [ 352 * 32bit session handle, 353 * 32bit key handle, 354 * (struct pkcs11_attribute_head)mechanism + 355 * mechanism params, 356 * ] 357 * [out] memref[0] = 32bit return code, enum pkcs11_rc 358 * 359 * These commands relate to the PKCS#11 API functions C_SignInit() and 360 * C_VerifyInit(). 361 */ 362 PKCS11_CMD_SIGN_INIT = 25, 363 PKCS11_CMD_VERIFY_INIT = 26, 364 365 /* 366 * PKCS11_CMD_SIGN_UPDATE - Update a signature computation processing 367 * PKCS11_CMD_VERIFY_UPDATE - Update a signature verification processing 368 * 369 * [in] memref[0] = 32bit session handle 370 * [out] memref[0] = 32bit return code, enum pkcs11_rc 371 * [in] memref[1] = input data to be processed 372 * 373 * These commands relate to the PKCS#11 API functions C_SignUpdate() and 374 * C_VerifyUpdate(). 375 */ 376 PKCS11_CMD_SIGN_UPDATE = 27, 377 PKCS11_CMD_VERIFY_UPDATE = 28, 378 379 /* 380 * PKCS11_CMD_SIGN_FINAL - Finalize a signature computation processing 381 * 382 * [in] memref[0] = 32bit session handle 383 * [out] memref[0] = 32bit return code, enum pkcs11_rc 384 * [out] memref[2] = output signature 385 * 386 * This command relates to the PKCS#11 API functions C_SignFinal(). 387 */ 388 PKCS11_CMD_SIGN_FINAL = 29, 389 390 /* 391 * PKCS11_CMD_VERIFY_FINAL - Finalize a signature verification 392 * processing 393 * 394 * [in] memref[0] = 32bit session handle 395 * [out] memref[0] = 32bit return code, enum pkcs11_rc 396 * [in] memref[2] = input signature to be processed 397 * 398 * This command relates to the PKCS#11 API functions C_VerifyFinal(). 399 */ 400 PKCS11_CMD_VERIFY_FINAL = 30, 401 402 /* 403 * PKCS11_CMD_SIGN_ONESHOT - Compute a signature 404 * 405 * [in] memref[0] = 32bit session handle 406 * [out] memref[0] = 32bit return code, enum pkcs11_rc 407 * [in] memref[1] = input data to be processed 408 * [out] memref[2] = byte array: generated signature 409 * 410 * This command relates to the PKCS#11 API function C_Sign(). 411 */ 412 PKCS11_CMD_SIGN_ONESHOT = 31, 413 414 /* 415 * PKCS11_CMD_VERIFY_ONESHOT - Compute and compare a signature 416 * 417 * [in] memref[0] = 32bit session handle 418 * [out] memref[0] = 32bit return code, enum pkcs11_rc 419 * [in] memref[1] = input data to be processed 420 * [in] memref[2] = input signature to be processed 421 * 422 * This command relates to the PKCS#11 API function C_Verify(). 423 */ 424 PKCS11_CMD_VERIFY_ONESHOT = 32, 425 426 }; 427 428 /* 429 * Command return codes 430 * PKCS11_<x> relates CryptoKi client API CKR_<x> 431 */ 432 enum pkcs11_rc { 433 PKCS11_CKR_OK = 0, 434 PKCS11_CKR_CANCEL = 0x0001, 435 PKCS11_CKR_SLOT_ID_INVALID = 0x0003, 436 PKCS11_CKR_GENERAL_ERROR = 0x0005, 437 PKCS11_CKR_FUNCTION_FAILED = 0x0006, 438 PKCS11_CKR_ARGUMENTS_BAD = 0x0007, 439 PKCS11_CKR_ATTRIBUTE_READ_ONLY = 0x0010, 440 PKCS11_CKR_ATTRIBUTE_SENSITIVE = 0x0011, 441 PKCS11_CKR_ATTRIBUTE_TYPE_INVALID = 0x0012, 442 PKCS11_CKR_ATTRIBUTE_VALUE_INVALID = 0x0013, 443 PKCS11_CKR_ACTION_PROHIBITED = 0x001b, 444 PKCS11_CKR_DATA_INVALID = 0x0020, 445 PKCS11_CKR_DATA_LEN_RANGE = 0x0021, 446 PKCS11_CKR_DEVICE_ERROR = 0x0030, 447 PKCS11_CKR_DEVICE_MEMORY = 0x0031, 448 PKCS11_CKR_DEVICE_REMOVED = 0x0032, 449 PKCS11_CKR_ENCRYPTED_DATA_INVALID = 0x0040, 450 PKCS11_CKR_ENCRYPTED_DATA_LEN_RANGE = 0x0041, 451 PKCS11_CKR_KEY_HANDLE_INVALID = 0x0060, 452 PKCS11_CKR_KEY_SIZE_RANGE = 0x0062, 453 PKCS11_CKR_KEY_TYPE_INCONSISTENT = 0x0063, 454 PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED = 0x0068, 455 PKCS11_CKR_KEY_NOT_WRAPPABLE = 0x0069, 456 PKCS11_CKR_KEY_UNEXTRACTABLE = 0x006a, 457 PKCS11_CKR_MECHANISM_INVALID = 0x0070, 458 PKCS11_CKR_MECHANISM_PARAM_INVALID = 0x0071, 459 PKCS11_CKR_OBJECT_HANDLE_INVALID = 0x0082, 460 PKCS11_CKR_OPERATION_ACTIVE = 0x0090, 461 PKCS11_CKR_OPERATION_NOT_INITIALIZED = 0x0091, 462 PKCS11_CKR_PIN_INCORRECT = 0x00a0, 463 PKCS11_CKR_PIN_INVALID = 0x00a1, 464 PKCS11_CKR_PIN_LEN_RANGE = 0x00a2, 465 PKCS11_CKR_PIN_EXPIRED = 0x00a3, 466 PKCS11_CKR_PIN_LOCKED = 0x00a4, 467 PKCS11_CKR_SESSION_CLOSED = 0x00b0, 468 PKCS11_CKR_SESSION_COUNT = 0x00b1, 469 PKCS11_CKR_SESSION_HANDLE_INVALID = 0x00b3, 470 PKCS11_CKR_SESSION_READ_ONLY = 0x00b5, 471 PKCS11_CKR_SESSION_EXISTS = 0x00b6, 472 PKCS11_CKR_SESSION_READ_ONLY_EXISTS = 0x00b7, 473 PKCS11_CKR_SESSION_READ_WRITE_SO_EXISTS = 0x00b8, 474 PKCS11_CKR_SIGNATURE_INVALID = 0x00c0, 475 PKCS11_CKR_SIGNATURE_LEN_RANGE = 0x00c1, 476 PKCS11_CKR_TEMPLATE_INCOMPLETE = 0x00d0, 477 PKCS11_CKR_TEMPLATE_INCONSISTENT = 0x00d1, 478 PKCS11_CKR_TOKEN_NOT_PRESENT = 0x00e0, 479 PKCS11_CKR_TOKEN_NOT_RECOGNIZED = 0x00e1, 480 PKCS11_CKR_TOKEN_WRITE_PROTECTED = 0x00e2, 481 PKCS11_CKR_USER_ALREADY_LOGGED_IN = 0x0100, 482 PKCS11_CKR_USER_NOT_LOGGED_IN = 0x0101, 483 PKCS11_CKR_USER_PIN_NOT_INITIALIZED = 0x0102, 484 PKCS11_CKR_USER_TYPE_INVALID = 0x0103, 485 PKCS11_CKR_USER_ANOTHER_ALREADY_LOGGED_IN = 0x0104, 486 PKCS11_CKR_USER_TOO_MANY_TYPES = 0x0105, 487 PKCS11_CKR_DOMAIN_PARAMS_INVALID = 0x0130, 488 PKCS11_CKR_CURVE_NOT_SUPPORTED = 0x0140, 489 PKCS11_CKR_BUFFER_TOO_SMALL = 0x0150, 490 PKCS11_CKR_SAVED_STATE_INVALID = 0x0160, 491 PKCS11_CKR_INFORMATION_SENSITIVE = 0x0170, 492 PKCS11_CKR_STATE_UNSAVEABLE = 0x0180, 493 PKCS11_CKR_PIN_TOO_WEAK = 0x01b8, 494 PKCS11_CKR_PUBLIC_KEY_INVALID = 0x01b9, 495 PKCS11_CKR_FUNCTION_REJECTED = 0x0200, 496 /* Vendor specific IDs not returned to client */ 497 PKCS11_RV_NOT_FOUND = 0x80000000, 498 PKCS11_RV_NOT_IMPLEMENTED = 0x80000001, 499 }; 500 501 /* 502 * Arguments for PKCS11_CMD_SLOT_INFO 503 */ 504 #define PKCS11_SLOT_DESC_SIZE 64 505 #define PKCS11_SLOT_MANUFACTURER_SIZE 32 506 #define PKCS11_SLOT_VERSION_SIZE 2 507 508 struct pkcs11_slot_info { 509 uint8_t slot_description[PKCS11_SLOT_DESC_SIZE]; 510 uint8_t manufacturer_id[PKCS11_SLOT_MANUFACTURER_SIZE]; 511 uint32_t flags; 512 uint8_t hardware_version[PKCS11_SLOT_VERSION_SIZE]; 513 uint8_t firmware_version[PKCS11_SLOT_VERSION_SIZE]; 514 }; 515 516 /* 517 * Values for pkcs11_slot_info::flags. 518 * PKCS11_CKFS_<x> reflects CryptoKi client API slot flags CKF_<x>. 519 */ 520 #define PKCS11_CKFS_TOKEN_PRESENT (1U << 0) 521 #define PKCS11_CKFS_REMOVABLE_DEVICE (1U << 1) 522 #define PKCS11_CKFS_HW_SLOT (1U << 2) 523 524 /* 525 * Arguments for PKCS11_CMD_TOKEN_INFO 526 */ 527 #define PKCS11_TOKEN_LABEL_SIZE 32 528 #define PKCS11_TOKEN_MANUFACTURER_SIZE 32 529 #define PKCS11_TOKEN_MODEL_SIZE 16 530 #define PKCS11_TOKEN_SERIALNUM_SIZE 16 531 532 struct pkcs11_token_info { 533 uint8_t label[PKCS11_TOKEN_LABEL_SIZE]; 534 uint8_t manufacturer_id[PKCS11_TOKEN_MANUFACTURER_SIZE]; 535 uint8_t model[PKCS11_TOKEN_MODEL_SIZE]; 536 uint8_t serial_number[PKCS11_TOKEN_SERIALNUM_SIZE]; 537 uint32_t flags; 538 uint32_t max_session_count; 539 uint32_t session_count; 540 uint32_t max_rw_session_count; 541 uint32_t rw_session_count; 542 uint32_t max_pin_len; 543 uint32_t min_pin_len; 544 uint32_t total_public_memory; 545 uint32_t free_public_memory; 546 uint32_t total_private_memory; 547 uint32_t free_private_memory; 548 uint8_t hardware_version[2]; 549 uint8_t firmware_version[2]; 550 uint8_t utc_time[16]; 551 }; 552 553 /* 554 * Values for pkcs11_token_info::flags. 555 * PKCS11_CKFT_<x> reflects CryptoKi client API token flags CKF_<x>. 556 */ 557 #define PKCS11_CKFT_RNG (1U << 0) 558 #define PKCS11_CKFT_WRITE_PROTECTED (1U << 1) 559 #define PKCS11_CKFT_LOGIN_REQUIRED (1U << 2) 560 #define PKCS11_CKFT_USER_PIN_INITIALIZED (1U << 3) 561 #define PKCS11_CKFT_RESTORE_KEY_NOT_NEEDED (1U << 5) 562 #define PKCS11_CKFT_CLOCK_ON_TOKEN (1U << 6) 563 #define PKCS11_CKFT_PROTECTED_AUTHENTICATION_PATH (1U << 8) 564 #define PKCS11_CKFT_DUAL_CRYPTO_OPERATIONS (1U << 9) 565 #define PKCS11_CKFT_TOKEN_INITIALIZED (1U << 10) 566 #define PKCS11_CKFT_SECONDARY_AUTHENTICATION (1U << 11) 567 #define PKCS11_CKFT_USER_PIN_COUNT_LOW (1U << 16) 568 #define PKCS11_CKFT_USER_PIN_FINAL_TRY (1U << 17) 569 #define PKCS11_CKFT_USER_PIN_LOCKED (1U << 18) 570 #define PKCS11_CKFT_USER_PIN_TO_BE_CHANGED (1U << 19) 571 #define PKCS11_CKFT_SO_PIN_COUNT_LOW (1U << 20) 572 #define PKCS11_CKFT_SO_PIN_FINAL_TRY (1U << 21) 573 #define PKCS11_CKFT_SO_PIN_LOCKED (1U << 22) 574 #define PKCS11_CKFT_SO_PIN_TO_BE_CHANGED (1U << 23) 575 #define PKCS11_CKFT_ERROR_STATE (1U << 24) 576 577 /* Values for user identity */ 578 enum pkcs11_user_type { 579 PKCS11_CKU_SO = 0x000, 580 PKCS11_CKU_USER = 0x001, 581 PKCS11_CKU_CONTEXT_SPECIFIC = 0x002, 582 }; 583 584 /* 585 * Values for 32bit session flags argument to PKCS11_CMD_OPEN_SESSION 586 * and pkcs11_session_info::flags. 587 * PKCS11_CKFSS_<x> reflects CryptoKi client API session flags CKF_<x>. 588 */ 589 #define PKCS11_CKFSS_RW_SESSION (1U << 1) 590 #define PKCS11_CKFSS_SERIAL_SESSION (1U << 2) 591 592 /* 593 * Arguments for PKCS11_CMD_SESSION_INFO 594 */ 595 596 struct pkcs11_session_info { 597 uint32_t slot_id; 598 uint32_t state; 599 uint32_t flags; 600 uint32_t device_error; 601 }; 602 603 /* Valid values for pkcs11_session_info::state */ 604 enum pkcs11_session_state { 605 PKCS11_CKS_RO_PUBLIC_SESSION = 0, 606 PKCS11_CKS_RO_USER_FUNCTIONS = 1, 607 PKCS11_CKS_RW_PUBLIC_SESSION = 2, 608 PKCS11_CKS_RW_USER_FUNCTIONS = 3, 609 PKCS11_CKS_RW_SO_FUNCTIONS = 4, 610 }; 611 612 /* 613 * Arguments for PKCS11_CMD_MECHANISM_INFO 614 */ 615 616 struct pkcs11_mechanism_info { 617 uint32_t min_key_size; 618 uint32_t max_key_size; 619 uint32_t flags; 620 }; 621 622 /* 623 * Values for pkcs11_mechanism_info::flags. 624 * PKCS11_CKFM_<x> reflects CryptoKi client API mechanism flags CKF_<x>. 625 */ 626 #define PKCS11_CKFM_HW (1U << 0) 627 #define PKCS11_CKFM_ENCRYPT (1U << 8) 628 #define PKCS11_CKFM_DECRYPT (1U << 9) 629 #define PKCS11_CKFM_DIGEST (1U << 10) 630 #define PKCS11_CKFM_SIGN (1U << 11) 631 #define PKCS11_CKFM_SIGN_RECOVER (1U << 12) 632 #define PKCS11_CKFM_VERIFY (1U << 13) 633 #define PKCS11_CKFM_VERIFY_RECOVER (1U << 14) 634 #define PKCS11_CKFM_GENERATE (1U << 15) 635 #define PKCS11_CKFM_GENERATE_KEY_PAIR (1U << 16) 636 #define PKCS11_CKFM_WRAP (1U << 17) 637 #define PKCS11_CKFM_UNWRAP (1U << 18) 638 #define PKCS11_CKFM_DERIVE (1U << 19) 639 #define PKCS11_CKFM_EC_F_P (1U << 20) 640 #define PKCS11_CKFM_EC_F_2M (1U << 21) 641 #define PKCS11_CKFM_EC_ECPARAMETERS (1U << 22) 642 #define PKCS11_CKFM_EC_NAMEDCURVE (1U << 23) 643 #define PKCS11_CKFM_EC_UNCOMPRESS (1U << 24) 644 #define PKCS11_CKFM_EC_COMPRESS (1U << 25) 645 646 /* 647 * pkcs11_object_head - Header of object whose data are serialized in memory 648 * 649 * An object is made of several attributes. Attributes are stored one next to 650 * the other with byte alignment as a serialized byte array. The byte array 651 * of serialized attributes is prepended with the size of the attrs[] array 652 * in bytes and the number of attributes in the array, yielding the struct 653 * pkcs11_object_head. 654 * 655 * @attrs_size - byte size of whole byte array attrs[] 656 * @attrs_count - number of attribute items stored in attrs[] 657 * @attrs - then starts the attributes data 658 */ 659 struct pkcs11_object_head { 660 uint32_t attrs_size; 661 uint32_t attrs_count; 662 uint8_t attrs[]; 663 }; 664 665 /* 666 * Attribute reference in the TA ABI. Each attribute starts with a header 667 * structure followed by the attribute value. The attribute byte size is 668 * defined in the attribute header. 669 * 670 * @id - the 32bit identifier of the attribute, see PKCS11_CKA_<x> 671 * @size - the 32bit value attribute byte size 672 * @data - then starts the attribute value 673 */ 674 struct pkcs11_attribute_head { 675 uint32_t id; 676 uint32_t size; 677 uint8_t data[]; 678 }; 679 680 /* 681 * Attribute identification IDs as of v2.40 excluding deprecated IDs. 682 * Valid values for struct pkcs11_attribute_head::id 683 * PKCS11_CKA_<x> reflects CryptoKi client API attribute IDs CKA_<x>. 684 */ 685 enum pkcs11_attr_id { 686 PKCS11_CKA_CLASS = 0x0000, 687 PKCS11_CKA_TOKEN = 0x0001, 688 PKCS11_CKA_PRIVATE = 0x0002, 689 PKCS11_CKA_LABEL = 0x0003, 690 PKCS11_CKA_APPLICATION = 0x0010, 691 PKCS11_CKA_VALUE = 0x0011, 692 PKCS11_CKA_OBJECT_ID = 0x0012, 693 PKCS11_CKA_CERTIFICATE_TYPE = 0x0080, 694 PKCS11_CKA_ISSUER = 0x0081, 695 PKCS11_CKA_SERIAL_NUMBER = 0x0082, 696 PKCS11_CKA_AC_ISSUER = 0x0083, 697 PKCS11_CKA_OWNER = 0x0084, 698 PKCS11_CKA_ATTR_TYPES = 0x0085, 699 PKCS11_CKA_TRUSTED = 0x0086, 700 PKCS11_CKA_CERTIFICATE_CATEGORY = 0x0087, 701 PKCS11_CKA_JAVA_MIDP_SECURITY_DOMAIN = 0x0088, 702 PKCS11_CKA_URL = 0x0089, 703 PKCS11_CKA_HASH_OF_SUBJECT_PUBLIC_KEY = 0x008a, 704 PKCS11_CKA_HASH_OF_ISSUER_PUBLIC_KEY = 0x008b, 705 PKCS11_CKA_NAME_HASH_ALGORITHM = 0x008c, 706 PKCS11_CKA_CHECK_VALUE = 0x0090, 707 PKCS11_CKA_KEY_TYPE = 0x0100, 708 PKCS11_CKA_SUBJECT = 0x0101, 709 PKCS11_CKA_ID = 0x0102, 710 PKCS11_CKA_SENSITIVE = 0x0103, 711 PKCS11_CKA_ENCRYPT = 0x0104, 712 PKCS11_CKA_DECRYPT = 0x0105, 713 PKCS11_CKA_WRAP = 0x0106, 714 PKCS11_CKA_UNWRAP = 0x0107, 715 PKCS11_CKA_SIGN = 0x0108, 716 PKCS11_CKA_SIGN_RECOVER = 0x0109, 717 PKCS11_CKA_VERIFY = 0x010a, 718 PKCS11_CKA_VERIFY_RECOVER = 0x010b, 719 PKCS11_CKA_DERIVE = 0x010c, 720 PKCS11_CKA_START_DATE = 0x0110, 721 PKCS11_CKA_END_DATE = 0x0111, 722 PKCS11_CKA_MODULUS = 0x0120, 723 PKCS11_CKA_MODULUS_BITS = 0x0121, 724 PKCS11_CKA_PUBLIC_EXPONENT = 0x0122, 725 PKCS11_CKA_PRIVATE_EXPONENT = 0x0123, 726 PKCS11_CKA_PRIME_1 = 0x0124, 727 PKCS11_CKA_PRIME_2 = 0x0125, 728 PKCS11_CKA_EXPONENT_1 = 0x0126, 729 PKCS11_CKA_EXPONENT_2 = 0x0127, 730 PKCS11_CKA_COEFFICIENT = 0x0128, 731 PKCS11_CKA_PUBLIC_KEY_INFO = 0x0129, 732 PKCS11_CKA_PRIME = 0x0130, 733 PKCS11_CKA_SUBPRIME = 0x0131, 734 PKCS11_CKA_BASE = 0x0132, 735 PKCS11_CKA_PRIME_BITS = 0x0133, 736 PKCS11_CKA_SUBPRIME_BITS = 0x0134, 737 PKCS11_CKA_VALUE_BITS = 0x0160, 738 PKCS11_CKA_VALUE_LEN = 0x0161, 739 PKCS11_CKA_EXTRACTABLE = 0x0162, 740 PKCS11_CKA_LOCAL = 0x0163, 741 PKCS11_CKA_NEVER_EXTRACTABLE = 0x0164, 742 PKCS11_CKA_ALWAYS_SENSITIVE = 0x0165, 743 PKCS11_CKA_KEY_GEN_MECHANISM = 0x0166, 744 PKCS11_CKA_MODIFIABLE = 0x0170, 745 PKCS11_CKA_COPYABLE = 0x0171, 746 PKCS11_CKA_DESTROYABLE = 0x0172, 747 PKCS11_CKA_EC_PARAMS = 0x0180, 748 PKCS11_CKA_EC_POINT = 0x0181, 749 PKCS11_CKA_ALWAYS_AUTHENTICATE = 0x0202, 750 PKCS11_CKA_WRAP_WITH_TRUSTED = 0x0210, 751 /* 752 * The leading 4 comes from the PKCS#11 spec or:ing with 753 * CKF_ARRAY_ATTRIBUTE = 0x40000000. 754 */ 755 PKCS11_CKA_WRAP_TEMPLATE = 0x40000211, 756 PKCS11_CKA_UNWRAP_TEMPLATE = 0x40000212, 757 PKCS11_CKA_DERIVE_TEMPLATE = 0x40000213, 758 PKCS11_CKA_OTP_FORMAT = 0x0220, 759 PKCS11_CKA_OTP_LENGTH = 0x0221, 760 PKCS11_CKA_OTP_TIME_INTERVAL = 0x0222, 761 PKCS11_CKA_OTP_USER_FRIENDLY_MODE = 0x0223, 762 PKCS11_CKA_OTP_CHALLENGE_REQUIREMENT = 0x0224, 763 PKCS11_CKA_OTP_TIME_REQUIREMENT = 0x0225, 764 PKCS11_CKA_OTP_COUNTER_REQUIREMENT = 0x0226, 765 PKCS11_CKA_OTP_PIN_REQUIREMENT = 0x0227, 766 PKCS11_CKA_OTP_COUNTER = 0x022e, 767 PKCS11_CKA_OTP_TIME = 0x022f, 768 PKCS11_CKA_OTP_USER_IDENTIFIER = 0x022a, 769 PKCS11_CKA_OTP_SERVICE_IDENTIFIER = 0x022b, 770 PKCS11_CKA_OTP_SERVICE_LOGO = 0x022c, 771 PKCS11_CKA_OTP_SERVICE_LOGO_TYPE = 0x022d, 772 PKCS11_CKA_GOSTR3410_PARAMS = 0x0250, 773 PKCS11_CKA_GOSTR3411_PARAMS = 0x0251, 774 PKCS11_CKA_GOST28147_PARAMS = 0x0252, 775 PKCS11_CKA_HW_FEATURE_TYPE = 0x0300, 776 PKCS11_CKA_RESET_ON_INIT = 0x0301, 777 PKCS11_CKA_HAS_RESET = 0x0302, 778 PKCS11_CKA_PIXEL_X = 0x0400, 779 PKCS11_CKA_PIXEL_Y = 0x0401, 780 PKCS11_CKA_RESOLUTION = 0x0402, 781 PKCS11_CKA_CHAR_ROWS = 0x0403, 782 PKCS11_CKA_CHAR_COLUMNS = 0x0404, 783 PKCS11_CKA_COLOR = 0x0405, 784 PKCS11_CKA_BITS_PER_PIXEL = 0x0406, 785 PKCS11_CKA_CHAR_SETS = 0x0480, 786 PKCS11_CKA_ENCODING_METHODS = 0x0481, 787 PKCS11_CKA_MIME_TYPES = 0x0482, 788 PKCS11_CKA_MECHANISM_TYPE = 0x0500, 789 PKCS11_CKA_REQUIRED_CMS_ATTRIBUTES = 0x0501, 790 PKCS11_CKA_DEFAULT_CMS_ATTRIBUTES = 0x0502, 791 PKCS11_CKA_SUPPORTED_CMS_ATTRIBUTES = 0x0503, 792 /* 793 * The leading 4 comes from the PKCS#11 spec or:ing with 794 * CKF_ARRAY_ATTRIBUTE = 0x40000000. 795 */ 796 PKCS11_CKA_ALLOWED_MECHANISMS = 0x40000600, 797 /* Vendor extension: reserved for undefined ID (~0U) */ 798 PKCS11_CKA_UNDEFINED_ID = PKCS11_UNDEFINED_ID, 799 }; 800 801 /* 802 * Valid values for attribute PKCS11_CKA_CLASS 803 * PKCS11_CKO_<x> reflects CryptoKi client API object class IDs CKO_<x>. 804 */ 805 enum pkcs11_class_id { 806 PKCS11_CKO_DATA = 0x000, 807 PKCS11_CKO_CERTIFICATE = 0x001, 808 PKCS11_CKO_PUBLIC_KEY = 0x002, 809 PKCS11_CKO_PRIVATE_KEY = 0x003, 810 PKCS11_CKO_SECRET_KEY = 0x004, 811 PKCS11_CKO_HW_FEATURE = 0x005, 812 PKCS11_CKO_DOMAIN_PARAMETERS = 0x006, 813 PKCS11_CKO_MECHANISM = 0x007, 814 PKCS11_CKO_OTP_KEY = 0x008, 815 /* Vendor extension: reserved for undefined ID (~0U) */ 816 PKCS11_CKO_UNDEFINED_ID = PKCS11_UNDEFINED_ID, 817 }; 818 819 /* 820 * Valid values for attribute PKCS11_CKA_KEY_TYPE 821 * PKCS11_CKK_<x> reflects CryptoKi client API key type IDs CKK_<x>. 822 * Note that this is only a subset of the PKCS#11 specification. 823 */ 824 enum pkcs11_key_type { 825 PKCS11_CKK_RSA = 0x000, 826 PKCS11_CKK_DSA = 0x001, 827 PKCS11_CKK_DH = 0x002, 828 PKCS11_CKK_EC = 0x003, 829 PKCS11_CKK_GENERIC_SECRET = 0x010, 830 PKCS11_CKK_AES = 0x01f, 831 PKCS11_CKK_MD5_HMAC = 0x027, 832 PKCS11_CKK_SHA_1_HMAC = 0x028, 833 PKCS11_CKK_SHA256_HMAC = 0x02b, 834 PKCS11_CKK_SHA384_HMAC = 0x02c, 835 PKCS11_CKK_SHA512_HMAC = 0x02d, 836 PKCS11_CKK_SHA224_HMAC = 0x02e, 837 /* Vendor extension: reserved for undefined ID (~0U) */ 838 PKCS11_CKK_UNDEFINED_ID = PKCS11_UNDEFINED_ID, 839 }; 840 841 /* 842 * Valid values for mechanism IDs 843 * PKCS11_CKM_<x> reflects CryptoKi client API mechanism IDs CKM_<x>. 844 * Note that this will be extended as needed. 845 */ 846 enum pkcs11_mechanism_id { 847 PKCS11_CKM_MD5_HMAC = 0x00211, 848 PKCS11_CKM_SHA_1_HMAC = 0x00221, 849 PKCS11_CKM_SHA256_HMAC = 0x00251, 850 PKCS11_CKM_SHA224_HMAC = 0x00256, 851 PKCS11_CKM_SHA384_HMAC = 0x00261, 852 PKCS11_CKM_SHA512_HMAC = 0x00271, 853 PKCS11_CKM_AES_KEY_GEN = 0x01080, 854 PKCS11_CKM_AES_ECB = 0x01081, 855 PKCS11_CKM_AES_CBC = 0x01082, 856 PKCS11_CKM_AES_CBC_PAD = 0x01085, 857 PKCS11_CKM_AES_CTR = 0x01086, 858 PKCS11_CKM_AES_CTS = 0x01089, 859 PKCS11_CKM_AES_ECB_ENCRYPT_DATA = 0x01104, 860 PKCS11_CKM_AES_CBC_ENCRYPT_DATA = 0x01105, 861 /* 862 * Vendor extensions below. 863 * PKCS11 added IDs for operation not related to a CK mechanism ID 864 */ 865 PKCS11_PROCESSING_IMPORT = 0x80000000, 866 PKCS11_CKM_UNDEFINED_ID = PKCS11_UNDEFINED_ID, 867 }; 868 #endif /*PKCS11_TA_H*/ 869