1 /* $NetBSD: pkcs11.h,v 1.7 2025/10/11 15:45:07 christos Exp $ */ 2 /* $OpenBSD: pkcs11.h,v 1.4 2025/07/25 13:06:07 djm Exp $ */ 3 4 /* pkcs11.h 5 Copyright 2006, 2007 g10 Code GmbH 6 Copyright 2006 Andreas Jellinghaus 7 8 This file is free software; as a special exception the author gives 9 unlimited permission to copy and/or distribute it, with or without 10 modifications, as long as this notice is preserved. 11 12 This file is distributed in the hope that it will be useful, but 13 WITHOUT ANY WARRANTY, to the extent permitted by law; without even 14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 15 PURPOSE. */ 16 17 /* Please submit changes back to the Scute project at 18 http://www.scute.org/ (or send them to marcus (at) g10code.com), so that 19 they can be picked up by other projects from there as well. */ 20 21 /* This file is a modified implementation of the PKCS #11 standard by 22 RSA Security Inc. It is mostly a drop-in replacement, with the 23 following change: 24 25 This header file does not require any macro definitions by the user 26 (like CK_DEFINE_FUNCTION etc). In fact, it defines those macros 27 for you (if useful, some are missing, let me know if you need 28 more). 29 30 There is an additional API available that does comply better to the 31 GNU coding standard. It can be switched on by defining 32 CRYPTOKI_GNU before including this header file. For this, the 33 following changes are made to the specification: 34 35 All structure types are changed to a "struct ck_foo" where CK_FOO 36 is the type name in PKCS #11. 37 38 All non-structure types are changed to ck_foo_t where CK_FOO is the 39 lowercase version of the type name in PKCS #11. The basic types 40 (CK_ULONG et al.) are removed without substitute. 41 42 All members of structures are modified in the following way: Type 43 indication prefixes are removed, and underscore characters are 44 inserted before words. Then the result is lowercased. 45 46 Note that function names are still in the original case, as they 47 need for ABI compatibility. 48 49 CK_FALSE, CK_TRUE and NULL_PTR are removed without substitute. Use 50 <stdbool.h>. 51 52 If CRYPTOKI_COMPAT is defined before including this header file, 53 then none of the API changes above take place, and the API is the 54 one defined by the PKCS #11 standard. */ 55 56 #ifndef PKCS11_H 57 #define PKCS11_H 1 58 59 #if defined(__cplusplus) 60 extern "C" { 61 #endif 62 63 64 /* The version of cryptoki we implement. The revision is changed with 65 each modification of this file. If you do not use the "official" 66 version of this file, please consider deleting the revision macro 67 (you may use a macro with a different name to keep track of your 68 versions). */ 69 #define CRYPTOKI_VERSION_MAJOR 3 70 #define CRYPTOKI_VERSION_MINOR 0 71 #define CRYPTOKI_VERSION_REVISION 0 72 73 74 /* Compatibility interface is default, unless CRYPTOKI_GNU is 75 given. */ 76 #ifndef CRYPTOKI_GNU 77 #ifndef CRYPTOKI_COMPAT 78 #define CRYPTOKI_COMPAT 1 79 #endif 80 #endif 81 82 /* System dependencies. */ 83 84 #if defined(_WIN32) || defined(CRYPTOKI_FORCE_WIN32) 85 86 /* There is a matching pop below. */ 87 #pragma pack(push, cryptoki, 1) 88 89 #ifdef CRYPTOKI_EXPORTS 90 #define CK_SPEC __declspec(dllexport) 91 #else 92 #define CK_SPEC __declspec(dllimport) 93 #endif 94 95 #else 96 97 #define CK_SPEC 98 99 #endif 100 101 #ifdef CRYPTOKI_COMPAT 102 /* If we are in compatibility mode, switch all exposed names to the 103 PKCS #11 variant. There are corresponding #undefs below. */ 104 105 #define ck_flags_t CK_FLAGS 106 #define ck_version _CK_VERSION 107 108 #define ck_info _CK_INFO 109 #define cryptoki_version cryptokiVersion 110 #define manufacturer_id manufacturerID 111 #define library_description libraryDescription 112 #define library_version libraryVersion 113 114 #define ck_notification_t CK_NOTIFICATION 115 #define ck_slot_id_t CK_SLOT_ID 116 117 #define ck_slot_info _CK_SLOT_INFO 118 #define slot_description slotDescription 119 #define hardware_version hardwareVersion 120 #define firmware_version firmwareVersion 121 122 #define ck_token_info _CK_TOKEN_INFO 123 #define serial_number serialNumber 124 #define max_session_count ulMaxSessionCount 125 #define session_count ulSessionCount 126 #define max_rw_session_count ulMaxRwSessionCount 127 #define rw_session_count ulRwSessionCount 128 #define max_pin_len ulMaxPinLen 129 #define min_pin_len ulMinPinLen 130 #define total_public_memory ulTotalPublicMemory 131 #define free_public_memory ulFreePublicMemory 132 #define total_private_memory ulTotalPrivateMemory 133 #define free_private_memory ulFreePrivateMemory 134 #define utc_time utcTime 135 136 #define ck_session_handle_t CK_SESSION_HANDLE 137 #define ck_user_type_t CK_USER_TYPE 138 #define ck_state_t CK_STATE 139 140 #define ck_session_info _CK_SESSION_INFO 141 #define slot_id slotID 142 #define device_error ulDeviceError 143 144 #define ck_object_handle_t CK_OBJECT_HANDLE 145 #define ck_object_class_t CK_OBJECT_CLASS 146 #define ck_hw_feature_type_t CK_HW_FEATURE_TYPE 147 #define ck_key_type_t CK_KEY_TYPE 148 #define ck_certificate_type_t CK_CERTIFICATE_TYPE 149 #define ck_attribute_type_t CK_ATTRIBUTE_TYPE 150 151 #define ck_attribute _CK_ATTRIBUTE 152 #define value pValue 153 #define value_len ulValueLen 154 155 #define ck_date _CK_DATE 156 157 #define ck_mechanism_type_t CK_MECHANISM_TYPE 158 159 #define ck_rsa_pkcs_mgf_type_t CK_RSA_PKCS_MGF_TYPE 160 161 #define ck_mechanism _CK_MECHANISM 162 #define parameter pParameter 163 #define parameter_len ulParameterLen 164 165 #define ck_mechanism_info _CK_MECHANISM_INFO 166 #define min_key_size ulMinKeySize 167 #define max_key_size ulMaxKeySize 168 169 #define ck_rv_t CK_RV 170 #define ck_notify_t CK_NOTIFY 171 172 #define ck_interface CK_INTERFACE 173 174 #define ck_function_list _CK_FUNCTION_LIST 175 #define ck_function_list_3_0 _CK_FUNCTION_LIST_3_0 176 177 #define ck_createmutex_t CK_CREATEMUTEX 178 #define ck_destroymutex_t CK_DESTROYMUTEX 179 #define ck_lockmutex_t CK_LOCKMUTEX 180 #define ck_unlockmutex_t CK_UNLOCKMUTEX 181 182 #define ck_c_initialize_args _CK_C_INITIALIZE_ARGS 183 #define create_mutex CreateMutex 184 #define destroy_mutex DestroyMutex 185 #define lock_mutex LockMutex 186 #define unlock_mutex UnlockMutex 187 #define reserved pReserved 188 189 #endif /* CRYPTOKI_COMPAT */ 190 191 192 typedef unsigned long ck_flags_t; 193 194 struct ck_version 195 { 196 unsigned char major; 197 unsigned char minor; 198 }; 199 200 201 struct ck_info 202 { 203 struct ck_version cryptoki_version; 204 unsigned char manufacturer_id[32]; 205 ck_flags_t flags; 206 unsigned char library_description[32]; 207 struct ck_version library_version; 208 }; 209 210 211 typedef unsigned long ck_notification_t; 212 213 #define CKN_SURRENDER (0UL) 214 215 216 typedef unsigned long ck_slot_id_t; 217 218 219 struct ck_slot_info 220 { 221 unsigned char slot_description[64]; 222 unsigned char manufacturer_id[32]; 223 ck_flags_t flags; 224 struct ck_version hardware_version; 225 struct ck_version firmware_version; 226 }; 227 228 229 #define CKF_TOKEN_PRESENT (1UL << 0) 230 #define CKF_REMOVABLE_DEVICE (1UL << 1) 231 #define CKF_HW_SLOT (1UL << 2) 232 #define CKF_ARRAY_ATTRIBUTE (1UL << 30) 233 234 235 struct ck_token_info 236 { 237 unsigned char label[32]; 238 unsigned char manufacturer_id[32]; 239 unsigned char model[16]; 240 unsigned char serial_number[16]; 241 ck_flags_t flags; 242 unsigned long max_session_count; 243 unsigned long session_count; 244 unsigned long max_rw_session_count; 245 unsigned long rw_session_count; 246 unsigned long max_pin_len; 247 unsigned long min_pin_len; 248 unsigned long total_public_memory; 249 unsigned long free_public_memory; 250 unsigned long total_private_memory; 251 unsigned long free_private_memory; 252 struct ck_version hardware_version; 253 struct ck_version firmware_version; 254 unsigned char utc_time[16]; 255 }; 256 257 258 #define CKF_RNG (1UL << 0) 259 #define CKF_WRITE_PROTECTED (1UL << 1) 260 #define CKF_LOGIN_REQUIRED (1UL << 2) 261 #define CKF_USER_PIN_INITIALIZED (1UL << 3) 262 #define CKF_RESTORE_KEY_NOT_NEEDED (1UL << 5) 263 #define CKF_CLOCK_ON_TOKEN (1UL << 6) 264 #define CKF_PROTECTED_AUTHENTICATION_PATH (1UL << 8) 265 #define CKF_DUAL_CRYPTO_OPERATIONS (1UL << 9) 266 #define CKF_TOKEN_INITIALIZED (1UL << 10) 267 #define CKF_SECONDARY_AUTHENTICATION (1UL << 11) 268 #define CKF_USER_PIN_COUNT_LOW (1UL << 16) 269 #define CKF_USER_PIN_FINAL_TRY (1UL << 17) 270 #define CKF_USER_PIN_LOCKED (1UL << 18) 271 #define CKF_USER_PIN_TO_BE_CHANGED (1UL << 19) 272 #define CKF_SO_PIN_COUNT_LOW (1UL << 20) 273 #define CKF_SO_PIN_FINAL_TRY (1UL << 21) 274 #define CKF_SO_PIN_LOCKED (1UL << 22) 275 #define CKF_SO_PIN_TO_BE_CHANGED (1UL << 23) 276 277 #define CK_UNAVAILABLE_INFORMATION ((unsigned long) -1) 278 #define CK_EFFECTIVELY_INFINITE (0UL) 279 280 281 typedef unsigned long ck_session_handle_t; 282 283 #define CK_INVALID_HANDLE (0UL) 284 285 286 typedef unsigned long ck_user_type_t; 287 288 #define CKU_SO (0UL) 289 #define CKU_USER (1UL) 290 #define CKU_CONTEXT_SPECIFIC (2UL) 291 292 293 typedef unsigned long ck_state_t; 294 295 #define CKS_RO_PUBLIC_SESSION (0UL) 296 #define CKS_RO_USER_FUNCTIONS (1UL) 297 #define CKS_RW_PUBLIC_SESSION (2UL) 298 #define CKS_RW_USER_FUNCTIONS (3UL) 299 #define CKS_RW_SO_FUNCTIONS (4UL) 300 301 302 struct ck_session_info 303 { 304 ck_slot_id_t slot_id; 305 ck_state_t state; 306 ck_flags_t flags; 307 unsigned long device_error; 308 }; 309 310 #define CKF_RW_SESSION (1UL << 1) 311 #define CKF_SERIAL_SESSION (1UL << 2) 312 313 314 typedef unsigned long ck_object_handle_t; 315 316 317 typedef unsigned long ck_object_class_t; 318 319 #define CKO_DATA (0UL) 320 #define CKO_CERTIFICATE (1UL) 321 #define CKO_PUBLIC_KEY (2UL) 322 #define CKO_PRIVATE_KEY (3UL) 323 #define CKO_SECRET_KEY (4UL) 324 #define CKO_HW_FEATURE (5UL) 325 #define CKO_DOMAIN_PARAMETERS (6UL) 326 #define CKO_MECHANISM (7UL) 327 #define CKO_OTP_KEY (8UL) 328 #define CKO_PROFILE (9UL) 329 #define CKO_VENDOR_DEFINED (1UL << 31) 330 331 #define CKP_INVALID_ID (0UL) 332 #define CKP_BASELINE_PROVIDER (1UL) 333 #define CKP_EXTENDED_PROVIDER (2UL) 334 #define CKP_AUTHENTICATION_TOKEN (3UL) 335 #define CKP_PUBLIC_CERTIFICATES_TOKEN (4UL) 336 #define CKP_VENDOR_DEFINED (1UL << 31) 337 338 typedef unsigned long ck_hw_feature_type_t; 339 340 #define CKH_MONOTONIC_COUNTER (1UL) 341 #define CKH_CLOCK (2UL) 342 #define CKH_USER_INTERFACE (3UL) 343 #define CKH_VENDOR_DEFINED (1UL << 31) 344 345 346 typedef unsigned long ck_key_type_t; 347 348 #define CKK_RSA (0UL) 349 #define CKK_DSA (1UL) 350 #define CKK_DH (2UL) 351 #define CKK_ECDSA (3UL) 352 #define CKK_EC (3UL) 353 #define CKK_X9_42_DH (4UL) 354 #define CKK_KEA (5UL) 355 #define CKK_GENERIC_SECRET (0x10UL) 356 #define CKK_RC2 (0x11UL) 357 #define CKK_RC4 (0x12UL) 358 #define CKK_DES (0x13UL) 359 #define CKK_DES2 (0x14UL) 360 #define CKK_DES3 (0x15UL) 361 #define CKK_CAST (0x16UL) 362 #define CKK_CAST3 (0x17UL) 363 #define CKK_CAST128 (0x18UL) 364 #define CKK_RC5 (0x19UL) 365 #define CKK_IDEA (0x1aUL) 366 #define CKK_SKIPJACK (0x1bUL) 367 #define CKK_BATON (0x1cUL) 368 #define CKK_JUNIPER (0x1dUL) 369 #define CKK_CDMF (0x1eUL) 370 #define CKK_AES (0x1fUL) 371 #define CKK_BLOWFISH (0x20UL) 372 #define CKK_TWOFISH (0x21UL) 373 #define CKK_GOSTR3410 (0x30UL) 374 #define CKK_GOSTR3411 (0x31UL) 375 #define CKK_GOST28147 (0x32UL) 376 #define CKK_EC_EDWARDS (0x40UL) 377 #define CKK_EC_MONTGOMERY (0x41UL) 378 #define CKK_HKDF (0x42UL) 379 #define CKK_VENDOR_DEFINED (1UL << 31) 380 381 /* 382 * A mask for new GOST algorithms. 383 * For details visit https://tc26.ru/standarts/perevody/guidelines-the-pkcs-11-extensions-for-implementing-the-gost-r-34-10-2012-and-gost-r-34-11-2012-russian-standards-.html 384 */ 385 #define NSSCK_VENDOR_PKCS11_RU_TEAM (CKK_VENDOR_DEFINED | 0x54321000) 386 #define CK_VENDOR_PKCS11_RU_TEAM_TK26 NSSCK_VENDOR_PKCS11_RU_TEAM 387 388 #define CKK_GOSTR3410_512 (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x003) 389 390 typedef unsigned long ck_certificate_type_t; 391 392 #define CKC_X_509 (0UL) 393 #define CKC_X_509_ATTR_CERT (1UL) 394 #define CKC_WTLS (2UL) 395 #define CKC_VENDOR_DEFINED (1UL << 31) 396 397 398 typedef unsigned long ck_attribute_type_t; 399 400 #define CKA_CLASS (0UL) 401 #define CKA_TOKEN (1UL) 402 #define CKA_PRIVATE (2UL) 403 #define CKA_LABEL (3UL) 404 #define CKA_UNIQUE_ID (4UL) 405 #define CKA_APPLICATION (0x10UL) 406 #define CKA_VALUE (0x11UL) 407 #define CKA_OBJECT_ID (0x12UL) 408 #define CKA_CERTIFICATE_TYPE (0x80UL) 409 #define CKA_ISSUER (0x81UL) 410 #define CKA_SERIAL_NUMBER (0x82UL) 411 #define CKA_AC_ISSUER (0x83UL) 412 #define CKA_OWNER (0x84UL) 413 #define CKA_ATTR_TYPES (0x85UL) 414 #define CKA_TRUSTED (0x86UL) 415 #define CKA_CERTIFICATE_CATEGORY (0x87UL) 416 #define CKA_JAVA_MIDP_SECURITY_DOMAIN (0x88UL) 417 #define CKA_URL (0x89UL) 418 #define CKA_HASH_OF_SUBJECT_PUBLIC_KEY (0x8aUL) 419 #define CKA_HASH_OF_ISSUER_PUBLIC_KEY (0x8bUL) 420 #define CKA_CHECK_VALUE (0x90UL) 421 #define CKA_KEY_TYPE (0x100UL) 422 #define CKA_SUBJECT (0x101UL) 423 #define CKA_ID (0x102UL) 424 #define CKA_SENSITIVE (0x103UL) 425 #define CKA_ENCRYPT (0x104UL) 426 #define CKA_DECRYPT (0x105UL) 427 #define CKA_WRAP (0x106UL) 428 #define CKA_UNWRAP (0x107UL) 429 #define CKA_SIGN (0x108UL) 430 #define CKA_SIGN_RECOVER (0x109UL) 431 #define CKA_VERIFY (0x10aUL) 432 #define CKA_VERIFY_RECOVER (0x10bUL) 433 #define CKA_DERIVE (0x10cUL) 434 #define CKA_START_DATE (0x110UL) 435 #define CKA_END_DATE (0x111UL) 436 #define CKA_MODULUS (0x120UL) 437 #define CKA_MODULUS_BITS (0x121UL) 438 #define CKA_PUBLIC_EXPONENT (0x122UL) 439 #define CKA_PRIVATE_EXPONENT (0x123UL) 440 #define CKA_PRIME_1 (0x124UL) 441 #define CKA_PRIME_2 (0x125UL) 442 #define CKA_EXPONENT_1 (0x126UL) 443 #define CKA_EXPONENT_2 (0x127UL) 444 #define CKA_COEFFICIENT (0x128UL) 445 #define CKA_PUBLIC_KEY_INFO (0x129UL) 446 #define CKA_PRIME (0x130UL) 447 #define CKA_SUBPRIME (0x131UL) 448 #define CKA_BASE (0x132UL) 449 #define CKA_PRIME_BITS (0x133UL) 450 #define CKA_SUB_PRIME_BITS (0x134UL) 451 #define CKA_VALUE_BITS (0x160UL) 452 #define CKA_VALUE_LEN (0x161UL) 453 #define CKA_EXTRACTABLE (0x162UL) 454 #define CKA_LOCAL (0x163UL) 455 #define CKA_NEVER_EXTRACTABLE (0x164UL) 456 #define CKA_ALWAYS_SENSITIVE (0x165UL) 457 #define CKA_KEY_GEN_MECHANISM (0x166UL) 458 #define CKA_MODIFIABLE (0x170UL) 459 #define CKA_COPYABLE (0x171UL) 460 #define CKA_DESTROYABLE (0x172UL) 461 #define CKA_ECDSA_PARAMS (0x180UL) 462 #define CKA_EC_PARAMS (0x180UL) 463 #define CKA_EC_POINT (0x181UL) 464 #define CKA_SECONDARY_AUTH (0x200UL) 465 #define CKA_AUTH_PIN_FLAGS (0x201UL) 466 #define CKA_ALWAYS_AUTHENTICATE (0x202UL) 467 #define CKA_WRAP_WITH_TRUSTED (0x210UL) 468 #define CKA_GOSTR3410_PARAMS (0x250UL) 469 #define CKA_GOSTR3411_PARAMS (0x251UL) 470 #define CKA_GOST28147_PARAMS (0x252UL) 471 #define CKA_HW_FEATURE_TYPE (0x300UL) 472 #define CKA_RESET_ON_INIT (0x301UL) 473 #define CKA_HAS_RESET (0x302UL) 474 #define CKA_PIXEL_X (0x400UL) 475 #define CKA_PIXEL_Y (0x401UL) 476 #define CKA_RESOLUTION (0x402UL) 477 #define CKA_CHAR_ROWS (0x403UL) 478 #define CKA_CHAR_COLUMNS (0x404UL) 479 #define CKA_COLOR (0x405UL) 480 #define CKA_BITS_PER_PIXEL (0x406UL) 481 #define CKA_CHAR_SETS (0x480UL) 482 #define CKA_ENCODING_METHODS (0x481UL) 483 #define CKA_MIME_TYPES (0x482UL) 484 #define CKA_MECHANISM_TYPE (0x500UL) 485 #define CKA_REQUIRED_CMS_ATTRIBUTES (0x501UL) 486 #define CKA_DEFAULT_CMS_ATTRIBUTES (0x502UL) 487 #define CKA_SUPPORTED_CMS_ATTRIBUTES (0x503UL) 488 #define CKA_WRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE | 0x211UL) 489 #define CKA_UNWRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE | 0x212UL) 490 #define CKA_OTP_FORMAT (0x220UL) 491 #define CKA_OTP_LENGTH (0x221UL) 492 #define CKA_OTP_TIME_INTERVAL (0x222UL) 493 #define CKA_OTP_USER_FRIENDLY_MODE (0x223UL) 494 #define CKA_OTP_CHALLENGE_REQUIREMENT (0x224UL) 495 #define CKA_OTP_TIME_REQUIREMENT (0x225UL) 496 #define CKA_OTP_COUNTER_REQUIREMENT (0x226UL) 497 #define CKA_OTP_PIN_REQUIREMENT (0x227UL) 498 #define CKA_OTP_USER_IDENTIFIER (0x22AUL) 499 #define CKA_OTP_SERVICE_IDENTIFIER (0x22BUL) 500 #define CKA_OTP_SERVICE_LOGO (0x22CUL) 501 #define CKA_OTP_SERVICE_LOGO_TYPE (0x22DUL) 502 #define CKA_OTP_COUNTER (0x22EUL) 503 #define CKA_OTP_TIME (0x22FUL) 504 #define CKA_ALLOWED_MECHANISMS (CKF_ARRAY_ATTRIBUTE | 0x600UL) 505 #define CKA_PROFILE_ID (0x601UL) 506 #define CKA_VENDOR_DEFINED (1UL << 31) 507 508 509 struct ck_attribute 510 { 511 ck_attribute_type_t type; 512 void *value; 513 unsigned long value_len; 514 }; 515 516 517 struct ck_date 518 { 519 unsigned char year[4]; 520 unsigned char month[2]; 521 unsigned char day[2]; 522 }; 523 524 525 typedef unsigned long ck_mechanism_type_t; 526 527 #define CKM_RSA_PKCS_KEY_PAIR_GEN (0UL) 528 #define CKM_RSA_PKCS (1UL) 529 #define CKM_RSA_9796 (2UL) 530 #define CKM_RSA_X_509 (3UL) 531 #define CKM_MD2_RSA_PKCS (4UL) 532 #define CKM_MD5_RSA_PKCS (5UL) 533 #define CKM_SHA1_RSA_PKCS (6UL) 534 #define CKM_RIPEMD128_RSA_PKCS (7UL) 535 #define CKM_RIPEMD160_RSA_PKCS (8UL) 536 #define CKM_RSA_PKCS_OAEP (9UL) 537 #define CKM_RSA_X9_31_KEY_PAIR_GEN (0xaUL) 538 #define CKM_RSA_X9_31 (0xbUL) 539 #define CKM_SHA1_RSA_X9_31 (0xcUL) 540 #define CKM_RSA_PKCS_PSS (0xdUL) 541 #define CKM_SHA1_RSA_PKCS_PSS (0xeUL) 542 #define CKM_DSA_KEY_PAIR_GEN (0x10UL) 543 #define CKM_DSA (0x11UL) 544 #define CKM_DSA_SHA1 (0x12UL) 545 #define CKM_DSA_SHA224 (0x13UL) 546 #define CKM_DSA_SHA256 (0x14UL) 547 #define CKM_DSA_SHA384 (0x15UL) 548 #define CKM_DSA_SHA512 (0x16UL) 549 #define CKM_DH_PKCS_KEY_PAIR_GEN (0x20UL) 550 #define CKM_DH_PKCS_DERIVE (0x21UL) 551 #define CKM_X9_42_DH_KEY_PAIR_GEN (0x30UL) 552 #define CKM_X9_42_DH_DERIVE (0x31UL) 553 #define CKM_X9_42_DH_HYBRID_DERIVE (0x32UL) 554 #define CKM_X9_42_MQV_DERIVE (0x33UL) 555 #define CKM_SHA256_RSA_PKCS (0x40UL) 556 #define CKM_SHA384_RSA_PKCS (0x41UL) 557 #define CKM_SHA512_RSA_PKCS (0x42UL) 558 #define CKM_SHA256_RSA_PKCS_PSS (0x43UL) 559 #define CKM_SHA384_RSA_PKCS_PSS (0x44UL) 560 #define CKM_SHA512_RSA_PKCS_PSS (0x45UL) 561 #define CKM_SHA224_RSA_PKCS (0x46UL) 562 #define CKM_SHA224_RSA_PKCS_PSS (0x47UL) 563 #define CKM_SHA3_256_RSA_PKCS (0x60UL) 564 #define CKM_SHA3_384_RSA_PKCS (0x61UL) 565 #define CKM_SHA3_512_RSA_PKCS (0x62UL) 566 #define CKM_SHA3_256_RSA_PKCS_PSS (0x63UL) 567 #define CKM_SHA3_384_RSA_PKCS_PSS (0x64UL) 568 #define CKM_SHA3_512_RSA_PKCS_PSS (0x65UL) 569 #define CKM_SHA3_224_RSA_PKCS (0x66UL) 570 #define CKM_SHA3_224_RSA_PKCS_PSS (0x67UL) 571 #define CKM_RC2_KEY_GEN (0x100UL) 572 #define CKM_RC2_ECB (0x101UL) 573 #define CKM_RC2_CBC (0x102UL) 574 #define CKM_RC2_MAC (0x103UL) 575 #define CKM_RC2_MAC_GENERAL (0x104UL) 576 #define CKM_RC2_CBC_PAD (0x105UL) 577 #define CKM_RC4_KEY_GEN (0x110UL) 578 #define CKM_RC4 (0x111UL) 579 #define CKM_DES_KEY_GEN (0x120UL) 580 #define CKM_DES_ECB (0x121UL) 581 #define CKM_DES_CBC (0x122UL) 582 #define CKM_DES_MAC (0x123UL) 583 #define CKM_DES_MAC_GENERAL (0x124UL) 584 #define CKM_DES_CBC_PAD (0x125UL) 585 #define CKM_DES2_KEY_GEN (0x130UL) 586 #define CKM_DES3_KEY_GEN (0x131UL) 587 #define CKM_DES3_ECB (0x132UL) 588 #define CKM_DES3_CBC (0x133UL) 589 #define CKM_DES3_MAC (0x134UL) 590 #define CKM_DES3_MAC_GENERAL (0x135UL) 591 #define CKM_DES3_CBC_PAD (0x136UL) 592 #define CKM_DES3_CMAC_GENERAL (0x137UL) 593 #define CKM_DES3_CMAC (0x138UL) 594 #define CKM_CDMF_KEY_GEN (0x140UL) 595 #define CKM_CDMF_ECB (0x141UL) 596 #define CKM_CDMF_CBC (0x142UL) 597 #define CKM_CDMF_MAC (0x143UL) 598 #define CKM_CDMF_MAC_GENERAL (0x144UL) 599 #define CKM_CDMF_CBC_PAD (0x145UL) 600 #define CKM_MD2 (0x200UL) 601 #define CKM_MD2_HMAC (0x201UL) 602 #define CKM_MD2_HMAC_GENERAL (0x202UL) 603 #define CKM_MD5 (0x210UL) 604 #define CKM_MD5_HMAC (0x211UL) 605 #define CKM_MD5_HMAC_GENERAL (0x212UL) 606 #define CKM_SHA_1 (0x220UL) 607 #define CKM_SHA_1_HMAC (0x221UL) 608 #define CKM_SHA_1_HMAC_GENERAL (0x222UL) 609 #define CKM_RIPEMD128 (0x230UL) 610 #define CKM_RIPEMD128_HMAC (0x231UL) 611 #define CKM_RIPEMD128_HMAC_GENERAL (0x232UL) 612 #define CKM_RIPEMD160 (0x240UL) 613 #define CKM_RIPEMD160_HMAC (0x241UL) 614 #define CKM_RIPEMD160_HMAC_GENERAL (0x242UL) 615 #define CKM_SHA256 (0x250UL) 616 #define CKM_SHA256_HMAC (0x251UL) 617 #define CKM_SHA256_HMAC_GENERAL (0x252UL) 618 #define CKM_SHA224 (0x255UL) 619 #define CKM_SHA224_HMAC (0x256UL) 620 #define CKM_SHA224_HMAC_GENERAL (0x257UL) 621 #define CKM_SHA384 (0x260UL) 622 #define CKM_SHA384_HMAC (0x261UL) 623 #define CKM_SHA384_HMAC_GENERAL (0x262UL) 624 #define CKM_SHA512 (0x270UL) 625 #define CKM_SHA512_HMAC (0x271UL) 626 #define CKM_SHA512_HMAC_GENERAL (0x272UL) 627 #define CKM_SHA3_256 (0x2B0UL) 628 #define CKM_SHA3_256_HMAC (0x2B1UL) 629 #define CKM_SHA3_256_HMAC_GENERAL (0x2B2UL) 630 #define CKM_SHA3_256_KEY_GEN (0x2B3UL) 631 #define CKM_SHA3_224 (0x2B5UL) 632 #define CKM_SHA3_224_HMAC (0x2B6UL) 633 #define CKM_SHA3_224_HMAC_GENERAL (0x2B7UL) 634 #define CKM_SHA3_224_KEY_GEN (0x2B8UL) 635 #define CKM_SHA3_384 (0x2C0UL) 636 #define CKM_SHA3_384_HMAC (0x2C1UL) 637 #define CKM_SHA3_384_HMAC_GENERAL (0x2C2UL) 638 #define CKM_SHA3_384_KEY_GEN (0x2C3UL) 639 #define CKM_SHA3_512 (0x2D0UL) 640 #define CKM_SHA3_512_HMAC (0x2D1UL) 641 #define CKM_SHA3_512_HMAC_GENERAL (0x2D2UL) 642 #define CKM_SHA3_512_KEY_GEN (0x2D3UL) 643 #define CKM_CAST_KEY_GEN (0x300UL) 644 #define CKM_CAST_ECB (0x301UL) 645 #define CKM_CAST_CBC (0x302UL) 646 #define CKM_CAST_MAC (0x303UL) 647 #define CKM_CAST_MAC_GENERAL (0x304UL) 648 #define CKM_CAST_CBC_PAD (0x305UL) 649 #define CKM_CAST3_KEY_GEN (0x310UL) 650 #define CKM_CAST3_ECB (0x311UL) 651 #define CKM_CAST3_CBC (0x312UL) 652 #define CKM_CAST3_MAC (0x313UL) 653 #define CKM_CAST3_MAC_GENERAL (0x314UL) 654 #define CKM_CAST3_CBC_PAD (0x315UL) 655 #define CKM_CAST5_KEY_GEN (0x320UL) 656 #define CKM_CAST128_KEY_GEN (0x320UL) 657 #define CKM_CAST5_ECB (0x321UL) 658 #define CKM_CAST128_ECB (0x321UL) 659 #define CKM_CAST5_CBC (0x322UL) 660 #define CKM_CAST128_CBC (0x322UL) 661 #define CKM_CAST5_MAC (0x323UL) 662 #define CKM_CAST128_MAC (0x323UL) 663 #define CKM_CAST5_MAC_GENERAL (0x324UL) 664 #define CKM_CAST128_MAC_GENERAL (0x324UL) 665 #define CKM_CAST5_CBC_PAD (0x325UL) 666 #define CKM_CAST128_CBC_PAD (0x325UL) 667 #define CKM_RC5_KEY_GEN (0x330UL) 668 #define CKM_RC5_ECB (0x331UL) 669 #define CKM_RC5_CBC (0x332UL) 670 #define CKM_RC5_MAC (0x333UL) 671 #define CKM_RC5_MAC_GENERAL (0x334UL) 672 #define CKM_RC5_CBC_PAD (0x335UL) 673 #define CKM_IDEA_KEY_GEN (0x340UL) 674 #define CKM_IDEA_ECB (0x341UL) 675 #define CKM_IDEA_CBC (0x342UL) 676 #define CKM_IDEA_MAC (0x343UL) 677 #define CKM_IDEA_MAC_GENERAL (0x344UL) 678 #define CKM_IDEA_CBC_PAD (0x345UL) 679 #define CKM_GENERIC_SECRET_KEY_GEN (0x350UL) 680 #define CKM_CONCATENATE_BASE_AND_KEY (0x360UL) 681 #define CKM_CONCATENATE_BASE_AND_DATA (0x362UL) 682 #define CKM_CONCATENATE_DATA_AND_BASE (0x363UL) 683 #define CKM_XOR_BASE_AND_DATA (0x364UL) 684 #define CKM_EXTRACT_KEY_FROM_KEY (0x365UL) 685 #define CKM_SSL3_PRE_MASTER_KEY_GEN (0x370UL) 686 #define CKM_SSL3_MASTER_KEY_DERIVE (0x371UL) 687 #define CKM_SSL3_KEY_AND_MAC_DERIVE (0x372UL) 688 #define CKM_SSL3_MASTER_KEY_DERIVE_DH (0x373UL) 689 #define CKM_TLS_PRE_MASTER_KEY_GEN (0x374UL) 690 #define CKM_TLS_MASTER_KEY_DERIVE (0x375UL) 691 #define CKM_TLS_KEY_AND_MAC_DERIVE (0x376UL) 692 #define CKM_TLS_MASTER_KEY_DERIVE_DH (0x377UL) 693 #define CKM_SSL3_MD5_MAC (0x380UL) 694 #define CKM_SSL3_SHA1_MAC (0x381UL) 695 #define CKM_MD5_KEY_DERIVATION (0x390UL) 696 #define CKM_MD2_KEY_DERIVATION (0x391UL) 697 #define CKM_SHA1_KEY_DERIVATION (0x392UL) 698 #define CKM_PBE_MD2_DES_CBC (0x3a0UL) 699 #define CKM_PBE_MD5_DES_CBC (0x3a1UL) 700 #define CKM_PBE_MD5_CAST_CBC (0x3a2UL) 701 #define CKM_PBE_MD5_CAST3_CBC (0x3a3UL) 702 #define CKM_PBE_MD5_CAST5_CBC (0x3a4UL) 703 #define CKM_PBE_MD5_CAST128_CBC (0x3a4UL) 704 #define CKM_PBE_SHA1_CAST5_CBC (0x3a5UL) 705 #define CKM_PBE_SHA1_CAST128_CBC (0x3a5UL) 706 #define CKM_PBE_SHA1_RC4_128 (0x3a6UL) 707 #define CKM_PBE_SHA1_RC4_40 (0x3a7UL) 708 #define CKM_PBE_SHA1_DES3_EDE_CBC (0x3a8UL) 709 #define CKM_PBE_SHA1_DES2_EDE_CBC (0x3a9UL) 710 #define CKM_PBE_SHA1_RC2_128_CBC (0x3aaUL) 711 #define CKM_PBE_SHA1_RC2_40_CBC (0x3abUL) 712 #define CKM_PKCS5_PBKD2 (0x3b0UL) 713 #define CKM_PBA_SHA1_WITH_SHA1_HMAC (0x3c0UL) 714 #define CKM_KEY_WRAP_LYNKS (0x400UL) 715 #define CKM_KEY_WRAP_SET_OAEP (0x401UL) 716 #define CKM_SKIPJACK_KEY_GEN (0x1000UL) 717 #define CKM_SKIPJACK_ECB64 (0x1001UL) 718 #define CKM_SKIPJACK_CBC64 (0x1002UL) 719 #define CKM_SKIPJACK_OFB64 (0x1003UL) 720 #define CKM_SKIPJACK_CFB64 (0x1004UL) 721 #define CKM_SKIPJACK_CFB32 (0x1005UL) 722 #define CKM_SKIPJACK_CFB16 (0x1006UL) 723 #define CKM_SKIPJACK_CFB8 (0x1007UL) 724 #define CKM_SKIPJACK_WRAP (0x1008UL) 725 #define CKM_SKIPJACK_PRIVATE_WRAP (0x1009UL) 726 #define CKM_SKIPJACK_RELAYX (0x100aUL) 727 #define CKM_KEA_KEY_PAIR_GEN (0x1010UL) 728 #define CKM_KEA_KEY_DERIVE (0x1011UL) 729 #define CKM_FORTEZZA_TIMESTAMP (0x1020UL) 730 #define CKM_BATON_KEY_GEN (0x1030UL) 731 #define CKM_BATON_ECB128 (0x1031UL) 732 #define CKM_BATON_ECB96 (0x1032UL) 733 #define CKM_BATON_CBC128 (0x1033UL) 734 #define CKM_BATON_COUNTER (0x1034UL) 735 #define CKM_BATON_SHUFFLE (0x1035UL) 736 #define CKM_BATON_WRAP (0x1036UL) 737 #define CKM_ECDSA_KEY_PAIR_GEN (0x1040UL) 738 #define CKM_EC_KEY_PAIR_GEN (0x1040UL) 739 #define CKM_ECDSA (0x1041UL) 740 #define CKM_ECDSA_SHA1 (0x1042UL) 741 #define CKM_ECDSA_SHA224 (0x1043UL) 742 #define CKM_ECDSA_SHA256 (0x1044UL) 743 #define CKM_ECDSA_SHA384 (0x1045UL) 744 #define CKM_ECDSA_SHA512 (0x1046UL) 745 #define CKM_ECDSA_SHA3_224 (0x1047UL) 746 #define CKM_ECDSA_SHA3_256 (0x1048UL) 747 #define CKM_ECDSA_SHA3_384 (0x1049UL) 748 #define CKM_ECDSA_SHA3_512 (0x104AUL) 749 #define CKM_ECDH1_DERIVE (0x1050UL) 750 #define CKM_ECDH1_COFACTOR_DERIVE (0x1051UL) 751 #define CKM_ECMQV_DERIVE (0x1052UL) 752 #define CKM_EC_EDWARDS_KEY_PAIR_GEN (0x1055UL) 753 #define CKM_EC_MONTGOMERY_KEY_PAIR_GEN (0x1056UL) 754 #define CKM_EDDSA (0x1057UL) 755 #define CKM_JUNIPER_KEY_GEN (0x1060UL) 756 #define CKM_JUNIPER_ECB128 (0x1061UL) 757 #define CKM_JUNIPER_CBC128 (0x1062UL) 758 #define CKM_JUNIPER_COUNTER (0x1063UL) 759 #define CKM_JUNIPER_SHUFFLE (0x1064UL) 760 #define CKM_JUNIPER_WRAP (0x1065UL) 761 #define CKM_FASTHASH (0x1070UL) 762 #define CKM_AES_KEY_GEN (0x1080UL) 763 #define CKM_AES_ECB (0x1081UL) 764 #define CKM_AES_CBC (0x1082UL) 765 #define CKM_AES_MAC (0x1083UL) 766 #define CKM_AES_MAC_GENERAL (0x1084UL) 767 #define CKM_AES_CBC_PAD (0x1085UL) 768 #define CKM_AES_CTR (0x1086UL) 769 #define CKM_AES_GCM (0x1087UL) 770 #define CKM_AES_CCM (0x1088UL) 771 #define CKM_AES_CTS (0x1089UL) 772 #define CKM_AES_CMAC (0x108AUL) 773 #define CKM_AES_CMAC_GENERAL (0x108BUL) 774 #define CKM_AES_XCBC_MAC (0x108CUL) 775 #define CKM_AES_XCBC_MAC_96 (0x108DUL) 776 #define CKM_AES_GMAC (0x108EUL) 777 #define CKM_BLOWFISH_KEY_GEN (0x1090UL) 778 #define CKM_BLOWFISH_CBC (0x1091UL) 779 #define CKM_TWOFISH_KEY_GEN (0x1092UL) 780 #define CKM_TWOFISH_CBC (0x1093UL) 781 #define CKM_DES_ECB_ENCRYPT_DATA (0x1100UL) 782 #define CKM_DES_CBC_ENCRYPT_DATA (0x1101UL) 783 #define CKM_DES3_ECB_ENCRYPT_DATA (0x1102UL) 784 #define CKM_DES3_CBC_ENCRYPT_DATA (0x1103UL) 785 #define CKM_AES_ECB_ENCRYPT_DATA (0x1104UL) 786 #define CKM_AES_CBC_ENCRYPT_DATA (0x1105UL) 787 #define CKM_GOSTR3410_KEY_PAIR_GEN (0x1200UL) 788 #define CKM_GOSTR3410 (0x1201UL) 789 #define CKM_GOSTR3410_WITH_GOSTR3411 (0x1202UL) 790 #define CKM_GOSTR3410_KEY_WRAP (0x1203UL) 791 #define CKM_GOSTR3410_DERIVE (0x1204UL) 792 #define CKM_GOSTR3410_512_KEY_PAIR_GEN (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x005) 793 #define CKM_GOSTR3410_512 (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x006) 794 #define CKM_GOSTR3410_12_DERIVE (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x007) 795 #define CKM_GOSTR3410_WITH_GOSTR3411_12_256 (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x008) 796 #define CKM_GOSTR3410_WITH_GOSTR3411_12_512 (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x009) 797 #define CKM_GOSTR3411 (0x1210UL) 798 #define CKM_GOSTR3411_HMAC (0x1211UL) 799 #define CKM_GOSTR3411_12_256 (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x012) 800 #define CKM_GOSTR3411_12_512 (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x013) 801 #define CKM_GOSTR3411_12_256_HMAC (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x014) 802 #define CKM_GOSTR3411_12_512_HMAC (CK_VENDOR_PKCS11_RU_TEAM_TK26 | 0x015) 803 #define CKM_GOST28147_KEY_GEN (0x1220UL) 804 #define CKM_GOST28147_ECB (0x1221UL) 805 #define CKM_GOST28147 (0x1222UL) 806 #define CKM_GOST28147_MAC (0x1223UL) 807 #define CKM_GOST28147_KEY_WRAP (0x1224UL) 808 809 #define CKM_DSA_PARAMETER_GEN (0x2000UL) 810 #define CKM_DH_PKCS_PARAMETER_GEN (0x2001UL) 811 #define CKM_X9_42_DH_PARAMETER_GEN (0x2002UL) 812 #define CKM_AES_OFB (0x2104UL) 813 #define CKM_AES_CFB64 (0x2105UL) 814 #define CKM_AES_CFB8 (0x2106UL) 815 #define CKM_AES_CFB128 (0x2107UL) 816 #define CKM_AES_CFB1 (0x2108UL) 817 #define CKM_AES_KEY_WRAP (0x2109UL) 818 #define CKM_AES_KEY_WRAP_PAD (0x210AUL) 819 #define CKM_XEDDSA (0x4029UL) 820 #define CKM_HKDF_DERIVE (0x402AUL) 821 #define CKM_HKDF_DATA (0x402BUL) 822 #define CKM_HKDF_KEY_GEN (0x402CUL) 823 824 #define CKM_VENDOR_DEFINED (1UL << 31) 825 826 struct ck_mechanism 827 { 828 ck_mechanism_type_t mechanism; 829 void *parameter; 830 unsigned long parameter_len; 831 }; 832 833 834 struct ck_mechanism_info 835 { 836 unsigned long min_key_size; 837 unsigned long max_key_size; 838 ck_flags_t flags; 839 }; 840 841 #define CKF_HW (1UL << 0) 842 843 #define CKF_MESSAGE_ENCRYPT (1UL << 1) 844 #define CKF_MESSAGE_DECRYPT (1UL << 2) 845 #define CKF_MESSAGE_SIGN (1UL << 3) 846 #define CKF_MESSAGE_VERIFY (1UL << 4) 847 #define CKF_MULTI_MESSAGE (1UL << 5) 848 #define CKF_FIND_OBJECTS (1UL << 6) 849 850 #define CKF_ENCRYPT (1UL << 8) 851 #define CKF_DECRYPT (1UL << 9) 852 #define CKF_DIGEST (1UL << 10) 853 #define CKF_SIGN (1UL << 11) 854 #define CKF_SIGN_RECOVER (1UL << 12) 855 #define CKF_VERIFY (1UL << 13) 856 #define CKF_VERIFY_RECOVER (1UL << 14) 857 #define CKF_GENERATE (1UL << 15) 858 #define CKF_GENERATE_KEY_PAIR (1UL << 16) 859 #define CKF_WRAP (1UL << 17) 860 #define CKF_UNWRAP (1UL << 18) 861 #define CKF_DERIVE (1UL << 19) 862 #define CKF_EXTENSION (1UL << 31) 863 864 #define CKF_EC_F_P (1UL << 20) 865 #define CKF_EC_F_2M (1UL << 21) 866 #define CKF_EC_ECPARAMETERS (1UL << 22) 867 #define CKF_EC_OID (1UL << 23) 868 #define CKF_EC_NAMEDCURVE CKF_EC_OID 869 #define CKF_EC_UNCOMPRESS (1UL << 24) 870 #define CKF_EC_COMPRESS (1UL << 25) 871 #define CKF_EC_CURVENAME (1UL << 26) 872 873 /* Flags for C_WaitForSlotEvent. */ 874 #define CKF_DONT_BLOCK (1UL) 875 876 /* Flags for Key derivation */ 877 #define CKD_NULL (0x1UL) 878 #define CKD_SHA1_KDF (0x2UL) 879 #define CKD_SHA224_KDF (0x5UL) 880 #define CKD_SHA256_KDF (0x6UL) 881 #define CKD_SHA384_KDF (0x7UL) 882 #define CKD_SHA512_KDF (0x8UL) 883 884 typedef struct CK_ECDH1_DERIVE_PARAMS { 885 unsigned long kdf; 886 unsigned long ulSharedDataLen; 887 unsigned char * pSharedData; 888 unsigned long ulPublicDataLen; 889 unsigned char * pPublicData; 890 } CK_ECDH1_DERIVE_PARAMS; 891 892 typedef struct CK_ECMQV_DERIVE_PARAMS { 893 unsigned long kdf; 894 unsigned long ulSharedDataLen; 895 unsigned char * pSharedData; 896 unsigned long ulPublicDataLen; 897 unsigned char * pPublicData; 898 unsigned long ulPrivateDataLen; 899 CK_OBJECT_HANDLE hPrivateData; 900 unsigned long ulPublicDataLen2; 901 unsigned char * pPublicData2; 902 CK_OBJECT_HANDLE publicKey; 903 } CK_ECMQV_DERIVE_PARAMS; 904 905 typedef unsigned long ck_rsa_pkcs_mgf_type_t; 906 typedef unsigned long CK_RSA_PKCS_OAEP_SOURCE_TYPE; 907 908 typedef struct CK_RSA_PKCS_OAEP_PARAMS { 909 CK_MECHANISM_TYPE hashAlg; 910 CK_RSA_PKCS_MGF_TYPE mgf; 911 CK_RSA_PKCS_OAEP_SOURCE_TYPE source; 912 void *pSourceData; 913 unsigned long ulSourceDataLen; 914 } CK_RSA_PKCS_OAEP_PARAMS; 915 916 typedef struct CK_RSA_PKCS_PSS_PARAMS { 917 ck_mechanism_type_t hashAlg; 918 CK_RSA_PKCS_MGF_TYPE mgf; 919 unsigned long sLen; 920 } CK_RSA_PKCS_PSS_PARAMS; 921 922 #define CKG_MGF1_SHA1 (0x00000001UL) 923 #define CKG_MGF1_SHA224 (0x00000005UL) 924 #define CKG_MGF1_SHA256 (0x00000002UL) 925 #define CKG_MGF1_SHA384 (0x00000003UL) 926 #define CKG_MGF1_SHA512 (0x00000004UL) 927 #define CKG_MGF1_SHA3_224 (0x00000006UL) 928 #define CKG_MGF1_SHA3_256 (0x00000007UL) 929 #define CKG_MGF1_SHA3_384 (0x00000008UL) 930 #define CKG_MGF1_SHA3_512 (0x00000009UL) 931 932 #define CKZ_DATA_SPECIFIED (0x00000001UL) 933 934 typedef struct CK_GCM_PARAMS { 935 void * pIv; 936 unsigned long ulIvLen; 937 unsigned long ulIvBits; 938 void * pAAD; 939 unsigned long ulAADLen; 940 unsigned long ulTagBits; 941 } CK_GCM_PARAMS; 942 943 typedef struct CK_CCM_PARAMS { 944 unsigned long ulDataLen; 945 unsigned char *pNonce; 946 unsigned long ulNonceLen; 947 unsigned char *pAAD; 948 unsigned long ulAADLen; 949 unsigned long ulMACLen; 950 } CK_CCM_PARAMS; 951 952 /* EDDSA */ 953 typedef struct CK_EDDSA_PARAMS { 954 unsigned char phFlag; 955 unsigned long ulContextDataLen; 956 unsigned char *pContextData; 957 } CK_EDDSA_PARAMS; 958 959 typedef CK_EDDSA_PARAMS *CK_EDDSA_PARAMS_PTR; 960 961 /* XEDDSA */ 962 typedef struct CK_XEDDSA_PARAMS { 963 unsigned long hash; 964 } CK_XEDDSA_PARAMS; 965 966 typedef CK_XEDDSA_PARAMS *CK_XEDDSA_PARAMS_PTR; 967 968 typedef struct CK_AES_CTR_PARAMS { 969 unsigned long ulCounterBits; 970 unsigned char cb[16]; 971 } CK_AES_CTR_PARAMS; 972 973 typedef CK_AES_CTR_PARAMS *CK_AES_CTR_PARAMS_PTR; 974 975 typedef unsigned long CK_MAC_GENERAL_PARAMS; 976 977 typedef CK_MAC_GENERAL_PARAMS *CK_MAC_GENERAL_PARAMS_PTR; 978 979 typedef unsigned long ck_rv_t; 980 981 982 typedef ck_rv_t (*ck_notify_t) (ck_session_handle_t session, 983 ck_notification_t event, void *application); 984 985 struct ck_interface { 986 char * pInterfaceName; 987 void * pFunctionList; 988 ck_flags_t flags; 989 }; 990 991 #define CKF_INTERFACE_FORK_SAFE (0x00000001UL) 992 993 /* Forward reference. */ 994 struct ck_function_list; 995 struct ck_function_list_3_0; 996 997 #define _CK_DECLARE_FUNCTION(name, args) \ 998 typedef ck_rv_t (*CK_ ## name) args; \ 999 ck_rv_t CK_SPEC name args 1000 1001 _CK_DECLARE_FUNCTION (C_Initialize, (void *init_args)); 1002 _CK_DECLARE_FUNCTION (C_Finalize, (void *reserved)); 1003 _CK_DECLARE_FUNCTION (C_GetInfo, (struct ck_info *info)); 1004 _CK_DECLARE_FUNCTION (C_GetFunctionList, 1005 (struct ck_function_list **function_list)); 1006 1007 _CK_DECLARE_FUNCTION (C_GetSlotList, 1008 (unsigned char token_present, ck_slot_id_t *slot_list, 1009 unsigned long *count)); 1010 _CK_DECLARE_FUNCTION (C_GetSlotInfo, 1011 (ck_slot_id_t slot_id, struct ck_slot_info *info)); 1012 _CK_DECLARE_FUNCTION (C_GetTokenInfo, 1013 (ck_slot_id_t slot_id, struct ck_token_info *info)); 1014 _CK_DECLARE_FUNCTION (C_WaitForSlotEvent, 1015 (ck_flags_t flags, ck_slot_id_t *slot, void *reserved)); 1016 _CK_DECLARE_FUNCTION (C_GetMechanismList, 1017 (ck_slot_id_t slot_id, 1018 ck_mechanism_type_t *mechanism_list, 1019 unsigned long *count)); 1020 _CK_DECLARE_FUNCTION (C_GetMechanismInfo, 1021 (ck_slot_id_t slot_id, ck_mechanism_type_t type, 1022 struct ck_mechanism_info *info)); 1023 _CK_DECLARE_FUNCTION (C_InitToken, 1024 (ck_slot_id_t slot_id, unsigned char *pin, 1025 unsigned long pin_len, unsigned char *label)); 1026 _CK_DECLARE_FUNCTION (C_InitPIN, 1027 (ck_session_handle_t session, unsigned char *pin, 1028 unsigned long pin_len)); 1029 _CK_DECLARE_FUNCTION (C_SetPIN, 1030 (ck_session_handle_t session, unsigned char *old_pin, 1031 unsigned long old_len, unsigned char *new_pin, 1032 unsigned long new_len)); 1033 1034 _CK_DECLARE_FUNCTION (C_OpenSession, 1035 (ck_slot_id_t slot_id, ck_flags_t flags, 1036 void *application, ck_notify_t notify, 1037 ck_session_handle_t *session)); 1038 _CK_DECLARE_FUNCTION (C_CloseSession, (ck_session_handle_t session)); 1039 _CK_DECLARE_FUNCTION (C_CloseAllSessions, (ck_slot_id_t slot_id)); 1040 _CK_DECLARE_FUNCTION (C_GetSessionInfo, 1041 (ck_session_handle_t session, 1042 struct ck_session_info *info)); 1043 _CK_DECLARE_FUNCTION (C_GetOperationState, 1044 (ck_session_handle_t session, 1045 unsigned char *operation_state, 1046 unsigned long *operation_state_len)); 1047 _CK_DECLARE_FUNCTION (C_SetOperationState, 1048 (ck_session_handle_t session, 1049 unsigned char *operation_state, 1050 unsigned long operation_state_len, 1051 ck_object_handle_t encryption_key, 1052 ck_object_handle_t authentication_key)); 1053 _CK_DECLARE_FUNCTION (C_Login, 1054 (ck_session_handle_t session, ck_user_type_t user_type, 1055 unsigned char *pin, unsigned long pin_len)); 1056 _CK_DECLARE_FUNCTION (C_Logout, (ck_session_handle_t session)); 1057 1058 _CK_DECLARE_FUNCTION (C_CreateObject, 1059 (ck_session_handle_t session, 1060 struct ck_attribute *templ, 1061 unsigned long count, ck_object_handle_t *object)); 1062 _CK_DECLARE_FUNCTION (C_CopyObject, 1063 (ck_session_handle_t session, ck_object_handle_t object, 1064 struct ck_attribute *templ, unsigned long count, 1065 ck_object_handle_t *new_object)); 1066 _CK_DECLARE_FUNCTION (C_DestroyObject, 1067 (ck_session_handle_t session, 1068 ck_object_handle_t object)); 1069 _CK_DECLARE_FUNCTION (C_GetObjectSize, 1070 (ck_session_handle_t session, 1071 ck_object_handle_t object, 1072 unsigned long *size)); 1073 _CK_DECLARE_FUNCTION (C_GetAttributeValue, 1074 (ck_session_handle_t session, 1075 ck_object_handle_t object, 1076 struct ck_attribute *templ, 1077 unsigned long count)); 1078 _CK_DECLARE_FUNCTION (C_SetAttributeValue, 1079 (ck_session_handle_t session, 1080 ck_object_handle_t object, 1081 struct ck_attribute *templ, 1082 unsigned long count)); 1083 _CK_DECLARE_FUNCTION (C_FindObjectsInit, 1084 (ck_session_handle_t session, 1085 struct ck_attribute *templ, 1086 unsigned long count)); 1087 _CK_DECLARE_FUNCTION (C_FindObjects, 1088 (ck_session_handle_t session, 1089 ck_object_handle_t *object, 1090 unsigned long max_object_count, 1091 unsigned long *object_count)); 1092 _CK_DECLARE_FUNCTION (C_FindObjectsFinal, 1093 (ck_session_handle_t session)); 1094 1095 _CK_DECLARE_FUNCTION (C_EncryptInit, 1096 (ck_session_handle_t session, 1097 struct ck_mechanism *mechanism, 1098 ck_object_handle_t key)); 1099 _CK_DECLARE_FUNCTION (C_Encrypt, 1100 (ck_session_handle_t session, 1101 unsigned char *data, unsigned long data_len, 1102 unsigned char *encrypted_data, 1103 unsigned long *encrypted_data_len)); 1104 _CK_DECLARE_FUNCTION (C_EncryptUpdate, 1105 (ck_session_handle_t session, 1106 unsigned char *part, unsigned long part_len, 1107 unsigned char *encrypted_part, 1108 unsigned long *encrypted_part_len)); 1109 _CK_DECLARE_FUNCTION (C_EncryptFinal, 1110 (ck_session_handle_t session, 1111 unsigned char *last_encrypted_part, 1112 unsigned long *last_encrypted_part_len)); 1113 1114 _CK_DECLARE_FUNCTION (C_DecryptInit, 1115 (ck_session_handle_t session, 1116 struct ck_mechanism *mechanism, 1117 ck_object_handle_t key)); 1118 _CK_DECLARE_FUNCTION (C_Decrypt, 1119 (ck_session_handle_t session, 1120 unsigned char *encrypted_data, 1121 unsigned long encrypted_data_len, 1122 unsigned char *data, unsigned long *data_len)); 1123 _CK_DECLARE_FUNCTION (C_DecryptUpdate, 1124 (ck_session_handle_t session, 1125 unsigned char *encrypted_part, 1126 unsigned long encrypted_part_len, 1127 unsigned char *part, unsigned long *part_len)); 1128 _CK_DECLARE_FUNCTION (C_DecryptFinal, 1129 (ck_session_handle_t session, 1130 unsigned char *last_part, 1131 unsigned long *last_part_len)); 1132 1133 _CK_DECLARE_FUNCTION (C_DigestInit, 1134 (ck_session_handle_t session, 1135 struct ck_mechanism *mechanism)); 1136 _CK_DECLARE_FUNCTION (C_Digest, 1137 (ck_session_handle_t session, 1138 unsigned char *data, unsigned long data_len, 1139 unsigned char *digest, 1140 unsigned long *digest_len)); 1141 _CK_DECLARE_FUNCTION (C_DigestUpdate, 1142 (ck_session_handle_t session, 1143 unsigned char *part, unsigned long part_len)); 1144 _CK_DECLARE_FUNCTION (C_DigestKey, 1145 (ck_session_handle_t session, ck_object_handle_t key)); 1146 _CK_DECLARE_FUNCTION (C_DigestFinal, 1147 (ck_session_handle_t session, 1148 unsigned char *digest, 1149 unsigned long *digest_len)); 1150 1151 _CK_DECLARE_FUNCTION (C_SignInit, 1152 (ck_session_handle_t session, 1153 struct ck_mechanism *mechanism, 1154 ck_object_handle_t key)); 1155 _CK_DECLARE_FUNCTION (C_Sign, 1156 (ck_session_handle_t session, 1157 unsigned char *data, unsigned long data_len, 1158 unsigned char *signature, 1159 unsigned long *signature_len)); 1160 _CK_DECLARE_FUNCTION (C_SignUpdate, 1161 (ck_session_handle_t session, 1162 unsigned char *part, unsigned long part_len)); 1163 _CK_DECLARE_FUNCTION (C_SignFinal, 1164 (ck_session_handle_t session, 1165 unsigned char *signature, 1166 unsigned long *signature_len)); 1167 _CK_DECLARE_FUNCTION (C_SignRecoverInit, 1168 (ck_session_handle_t session, 1169 struct ck_mechanism *mechanism, 1170 ck_object_handle_t key)); 1171 _CK_DECLARE_FUNCTION (C_SignRecover, 1172 (ck_session_handle_t session, 1173 unsigned char *data, unsigned long data_len, 1174 unsigned char *signature, 1175 unsigned long *signature_len)); 1176 1177 _CK_DECLARE_FUNCTION (C_VerifyInit, 1178 (ck_session_handle_t session, 1179 struct ck_mechanism *mechanism, 1180 ck_object_handle_t key)); 1181 _CK_DECLARE_FUNCTION (C_Verify, 1182 (ck_session_handle_t session, 1183 unsigned char *data, unsigned long data_len, 1184 unsigned char *signature, 1185 unsigned long signature_len)); 1186 _CK_DECLARE_FUNCTION (C_VerifyUpdate, 1187 (ck_session_handle_t session, 1188 unsigned char *part, unsigned long part_len)); 1189 _CK_DECLARE_FUNCTION (C_VerifyFinal, 1190 (ck_session_handle_t session, 1191 unsigned char *signature, 1192 unsigned long signature_len)); 1193 _CK_DECLARE_FUNCTION (C_VerifyRecoverInit, 1194 (ck_session_handle_t session, 1195 struct ck_mechanism *mechanism, 1196 ck_object_handle_t key)); 1197 _CK_DECLARE_FUNCTION (C_VerifyRecover, 1198 (ck_session_handle_t session, 1199 unsigned char *signature, 1200 unsigned long signature_len, 1201 unsigned char *data, 1202 unsigned long *data_len)); 1203 1204 _CK_DECLARE_FUNCTION (C_DigestEncryptUpdate, 1205 (ck_session_handle_t session, 1206 unsigned char *part, unsigned long part_len, 1207 unsigned char *encrypted_part, 1208 unsigned long *encrypted_part_len)); 1209 _CK_DECLARE_FUNCTION (C_DecryptDigestUpdate, 1210 (ck_session_handle_t session, 1211 unsigned char *encrypted_part, 1212 unsigned long encrypted_part_len, 1213 unsigned char *part, 1214 unsigned long *part_len)); 1215 _CK_DECLARE_FUNCTION (C_SignEncryptUpdate, 1216 (ck_session_handle_t session, 1217 unsigned char *part, unsigned long part_len, 1218 unsigned char *encrypted_part, 1219 unsigned long *encrypted_part_len)); 1220 _CK_DECLARE_FUNCTION (C_DecryptVerifyUpdate, 1221 (ck_session_handle_t session, 1222 unsigned char *encrypted_part, 1223 unsigned long encrypted_part_len, 1224 unsigned char *part, 1225 unsigned long *part_len)); 1226 1227 _CK_DECLARE_FUNCTION (C_GenerateKey, 1228 (ck_session_handle_t session, 1229 struct ck_mechanism *mechanism, 1230 struct ck_attribute *templ, 1231 unsigned long count, 1232 ck_object_handle_t *key)); 1233 _CK_DECLARE_FUNCTION (C_GenerateKeyPair, 1234 (ck_session_handle_t session, 1235 struct ck_mechanism *mechanism, 1236 struct ck_attribute *public_key_template, 1237 unsigned long public_key_attribute_count, 1238 struct ck_attribute *private_key_template, 1239 unsigned long private_key_attribute_count, 1240 ck_object_handle_t *public_key, 1241 ck_object_handle_t *private_key)); 1242 _CK_DECLARE_FUNCTION (C_WrapKey, 1243 (ck_session_handle_t session, 1244 struct ck_mechanism *mechanism, 1245 ck_object_handle_t wrapping_key, 1246 ck_object_handle_t key, 1247 unsigned char *wrapped_key, 1248 unsigned long *wrapped_key_len)); 1249 _CK_DECLARE_FUNCTION (C_UnwrapKey, 1250 (ck_session_handle_t session, 1251 struct ck_mechanism *mechanism, 1252 ck_object_handle_t unwrapping_key, 1253 unsigned char *wrapped_key, 1254 unsigned long wrapped_key_len, 1255 struct ck_attribute *templ, 1256 unsigned long attribute_count, 1257 ck_object_handle_t *key)); 1258 _CK_DECLARE_FUNCTION (C_DeriveKey, 1259 (ck_session_handle_t session, 1260 struct ck_mechanism *mechanism, 1261 ck_object_handle_t base_key, 1262 struct ck_attribute *templ, 1263 unsigned long attribute_count, 1264 ck_object_handle_t *key)); 1265 1266 _CK_DECLARE_FUNCTION (C_SeedRandom, 1267 (ck_session_handle_t session, unsigned char *seed, 1268 unsigned long seed_len)); 1269 _CK_DECLARE_FUNCTION (C_GenerateRandom, 1270 (ck_session_handle_t session, 1271 unsigned char *random_data, 1272 unsigned long random_len)); 1273 1274 _CK_DECLARE_FUNCTION (C_GetFunctionStatus, (ck_session_handle_t session)); 1275 _CK_DECLARE_FUNCTION (C_CancelFunction, (ck_session_handle_t session)); 1276 1277 _CK_DECLARE_FUNCTION (C_GetInterfaceList, 1278 (struct ck_interface *interfaces_list, 1279 unsigned long *count)); 1280 _CK_DECLARE_FUNCTION (C_GetInterface, 1281 (unsigned char *interface_name, 1282 struct ck_version *version, 1283 struct ck_interface **interface_ptr, 1284 ck_flags_t flags)); 1285 1286 _CK_DECLARE_FUNCTION (C_LoginUser, 1287 (ck_session_handle_t session, 1288 ck_user_type_t user_type, 1289 unsigned char *pin, 1290 unsigned long pin_len, 1291 unsigned char *username, 1292 unsigned long username_len)); 1293 1294 _CK_DECLARE_FUNCTION (C_SessionCancel, 1295 (ck_session_handle_t session, 1296 ck_flags_t flags)); 1297 1298 _CK_DECLARE_FUNCTION (C_MessageEncryptInit, 1299 (ck_session_handle_t session, 1300 struct ck_mechanism *mechanism, 1301 ck_object_handle_t key)); 1302 _CK_DECLARE_FUNCTION (C_EncryptMessage, 1303 (ck_session_handle_t session, 1304 void *parameter, 1305 unsigned long parameter_len, 1306 unsigned char *associated_data, 1307 unsigned long associated_data_len, 1308 unsigned char *plaintext, 1309 unsigned long plaintext_len, 1310 unsigned char *ciphertext, 1311 unsigned long *ciphertext_len)); 1312 _CK_DECLARE_FUNCTION (C_EncryptMessageBegin, 1313 (ck_session_handle_t session, 1314 void *parameter, 1315 unsigned long parameter_len, 1316 unsigned char *associated_data, 1317 unsigned long associated_data_len)); 1318 _CK_DECLARE_FUNCTION (C_EncryptMessageNext, 1319 (ck_session_handle_t session, 1320 void *parameter, 1321 unsigned long parameter_len, 1322 unsigned char *plaintext_part, 1323 unsigned long plaintext_part_len, 1324 unsigned char *ciphertext_part, 1325 unsigned long *ciphertext_part_len, 1326 ck_flags_t flags)); 1327 _CK_DECLARE_FUNCTION (C_MessageEncryptFinal, 1328 (ck_session_handle_t session)); 1329 1330 _CK_DECLARE_FUNCTION (C_MessageDecryptInit, 1331 (ck_session_handle_t session, 1332 struct ck_mechanism *mechanism, 1333 ck_object_handle_t key)); 1334 _CK_DECLARE_FUNCTION (C_DecryptMessage, 1335 (ck_session_handle_t session, 1336 void *parameter, 1337 unsigned long parameter_len, 1338 unsigned char *associated_data, 1339 unsigned long associated_data_len, 1340 unsigned char *ciphertext, 1341 unsigned long ciphertext_len, 1342 unsigned char *plaintext, 1343 unsigned long *plaintext_len)); 1344 _CK_DECLARE_FUNCTION (C_DecryptMessageBegin, 1345 (ck_session_handle_t session, 1346 void *parameter, 1347 unsigned long parameter_len, 1348 unsigned char *associated_data, 1349 unsigned long associated_data_len)); 1350 _CK_DECLARE_FUNCTION (C_DecryptMessageNext, 1351 (ck_session_handle_t session, 1352 void *parameter, 1353 unsigned long parameter_len, 1354 unsigned char *ciphertext_part, 1355 unsigned long ciphertext_part_len, 1356 unsigned char *plaintext_part, 1357 unsigned long *plaintext_part_len, 1358 ck_flags_t flags)); 1359 _CK_DECLARE_FUNCTION (C_MessageDecryptFinal, 1360 (ck_session_handle_t session)); 1361 1362 _CK_DECLARE_FUNCTION (C_MessageSignInit, 1363 (ck_session_handle_t session, 1364 struct ck_mechanism *mechanism, 1365 ck_object_handle_t key)); 1366 _CK_DECLARE_FUNCTION (C_SignMessage, 1367 (ck_session_handle_t session, 1368 void *parameter, 1369 unsigned long parameter_len, 1370 unsigned char *data, 1371 unsigned long data_len, 1372 unsigned char *signature, 1373 unsigned long *signature_len)); 1374 _CK_DECLARE_FUNCTION (C_SignMessageBegin, 1375 (ck_session_handle_t session, 1376 void *parameter, 1377 unsigned long parameter_len)); 1378 _CK_DECLARE_FUNCTION (C_SignMessageNext, 1379 (ck_session_handle_t session, 1380 void *parameter, 1381 unsigned long parameter_len, 1382 unsigned char *data, 1383 unsigned long data_len, 1384 unsigned char *signature, 1385 unsigned long *signature_len)); 1386 _CK_DECLARE_FUNCTION (C_MessageSignFinal, 1387 (ck_session_handle_t session)); 1388 1389 _CK_DECLARE_FUNCTION (C_MessageVerifyInit, 1390 (ck_session_handle_t session, 1391 struct ck_mechanism *mechanism, 1392 ck_object_handle_t key)); 1393 _CK_DECLARE_FUNCTION (C_VerifyMessage, 1394 (ck_session_handle_t session, 1395 void *parameter, 1396 unsigned long parameter_len, 1397 unsigned char *data, 1398 unsigned long data_len, 1399 unsigned char *signature, 1400 unsigned long signature_len)); 1401 _CK_DECLARE_FUNCTION (C_VerifyMessageBegin, 1402 (ck_session_handle_t session, 1403 void *parameter, 1404 unsigned long parameter_len)); 1405 _CK_DECLARE_FUNCTION (C_VerifyMessageNext, 1406 (ck_session_handle_t session, 1407 void *parameter, 1408 unsigned long parameter_len, 1409 unsigned char *data, 1410 unsigned long data_len, 1411 unsigned char *signature, 1412 unsigned long signature_len)); 1413 _CK_DECLARE_FUNCTION (C_MessageVerifyFinal, 1414 (ck_session_handle_t session)); 1415 1416 /* Flags in Message-based encryption/decryption API */ 1417 #define CKF_END_OF_MESSAGE (0x00000001UL) 1418 1419 struct ck_function_list 1420 { 1421 struct ck_version version; 1422 CK_C_Initialize C_Initialize; 1423 CK_C_Finalize C_Finalize; 1424 CK_C_GetInfo C_GetInfo; 1425 CK_C_GetFunctionList C_GetFunctionList; 1426 CK_C_GetSlotList C_GetSlotList; 1427 CK_C_GetSlotInfo C_GetSlotInfo; 1428 CK_C_GetTokenInfo C_GetTokenInfo; 1429 CK_C_GetMechanismList C_GetMechanismList; 1430 CK_C_GetMechanismInfo C_GetMechanismInfo; 1431 CK_C_InitToken C_InitToken; 1432 CK_C_InitPIN C_InitPIN; 1433 CK_C_SetPIN C_SetPIN; 1434 CK_C_OpenSession C_OpenSession; 1435 CK_C_CloseSession C_CloseSession; 1436 CK_C_CloseAllSessions C_CloseAllSessions; 1437 CK_C_GetSessionInfo C_GetSessionInfo; 1438 CK_C_GetOperationState C_GetOperationState; 1439 CK_C_SetOperationState C_SetOperationState; 1440 CK_C_Login C_Login; 1441 CK_C_Logout C_Logout; 1442 CK_C_CreateObject C_CreateObject; 1443 CK_C_CopyObject C_CopyObject; 1444 CK_C_DestroyObject C_DestroyObject; 1445 CK_C_GetObjectSize C_GetObjectSize; 1446 CK_C_GetAttributeValue C_GetAttributeValue; 1447 CK_C_SetAttributeValue C_SetAttributeValue; 1448 CK_C_FindObjectsInit C_FindObjectsInit; 1449 CK_C_FindObjects C_FindObjects; 1450 CK_C_FindObjectsFinal C_FindObjectsFinal; 1451 CK_C_EncryptInit C_EncryptInit; 1452 CK_C_Encrypt C_Encrypt; 1453 CK_C_EncryptUpdate C_EncryptUpdate; 1454 CK_C_EncryptFinal C_EncryptFinal; 1455 CK_C_DecryptInit C_DecryptInit; 1456 CK_C_Decrypt C_Decrypt; 1457 CK_C_DecryptUpdate C_DecryptUpdate; 1458 CK_C_DecryptFinal C_DecryptFinal; 1459 CK_C_DigestInit C_DigestInit; 1460 CK_C_Digest C_Digest; 1461 CK_C_DigestUpdate C_DigestUpdate; 1462 CK_C_DigestKey C_DigestKey; 1463 CK_C_DigestFinal C_DigestFinal; 1464 CK_C_SignInit C_SignInit; 1465 CK_C_Sign C_Sign; 1466 CK_C_SignUpdate C_SignUpdate; 1467 CK_C_SignFinal C_SignFinal; 1468 CK_C_SignRecoverInit C_SignRecoverInit; 1469 CK_C_SignRecover C_SignRecover; 1470 CK_C_VerifyInit C_VerifyInit; 1471 CK_C_Verify C_Verify; 1472 CK_C_VerifyUpdate C_VerifyUpdate; 1473 CK_C_VerifyFinal C_VerifyFinal; 1474 CK_C_VerifyRecoverInit C_VerifyRecoverInit; 1475 CK_C_VerifyRecover C_VerifyRecover; 1476 CK_C_DigestEncryptUpdate C_DigestEncryptUpdate; 1477 CK_C_DecryptDigestUpdate C_DecryptDigestUpdate; 1478 CK_C_SignEncryptUpdate C_SignEncryptUpdate; 1479 CK_C_DecryptVerifyUpdate C_DecryptVerifyUpdate; 1480 CK_C_GenerateKey C_GenerateKey; 1481 CK_C_GenerateKeyPair C_GenerateKeyPair; 1482 CK_C_WrapKey C_WrapKey; 1483 CK_C_UnwrapKey C_UnwrapKey; 1484 CK_C_DeriveKey C_DeriveKey; 1485 CK_C_SeedRandom C_SeedRandom; 1486 CK_C_GenerateRandom C_GenerateRandom; 1487 CK_C_GetFunctionStatus C_GetFunctionStatus; 1488 CK_C_CancelFunction C_CancelFunction; 1489 CK_C_WaitForSlotEvent C_WaitForSlotEvent; 1490 }; 1491 1492 struct ck_function_list_3_0 1493 { 1494 struct ck_version version; 1495 CK_C_Initialize C_Initialize; 1496 CK_C_Finalize C_Finalize; 1497 CK_C_GetInfo C_GetInfo; 1498 CK_C_GetFunctionList C_GetFunctionList; 1499 CK_C_GetSlotList C_GetSlotList; 1500 CK_C_GetSlotInfo C_GetSlotInfo; 1501 CK_C_GetTokenInfo C_GetTokenInfo; 1502 CK_C_GetMechanismList C_GetMechanismList; 1503 CK_C_GetMechanismInfo C_GetMechanismInfo; 1504 CK_C_InitToken C_InitToken; 1505 CK_C_InitPIN C_InitPIN; 1506 CK_C_SetPIN C_SetPIN; 1507 CK_C_OpenSession C_OpenSession; 1508 CK_C_CloseSession C_CloseSession; 1509 CK_C_CloseAllSessions C_CloseAllSessions; 1510 CK_C_GetSessionInfo C_GetSessionInfo; 1511 CK_C_GetOperationState C_GetOperationState; 1512 CK_C_SetOperationState C_SetOperationState; 1513 CK_C_Login C_Login; 1514 CK_C_Logout C_Logout; 1515 CK_C_CreateObject C_CreateObject; 1516 CK_C_CopyObject C_CopyObject; 1517 CK_C_DestroyObject C_DestroyObject; 1518 CK_C_GetObjectSize C_GetObjectSize; 1519 CK_C_GetAttributeValue C_GetAttributeValue; 1520 CK_C_SetAttributeValue C_SetAttributeValue; 1521 CK_C_FindObjectsInit C_FindObjectsInit; 1522 CK_C_FindObjects C_FindObjects; 1523 CK_C_FindObjectsFinal C_FindObjectsFinal; 1524 CK_C_EncryptInit C_EncryptInit; 1525 CK_C_Encrypt C_Encrypt; 1526 CK_C_EncryptUpdate C_EncryptUpdate; 1527 CK_C_EncryptFinal C_EncryptFinal; 1528 CK_C_DecryptInit C_DecryptInit; 1529 CK_C_Decrypt C_Decrypt; 1530 CK_C_DecryptUpdate C_DecryptUpdate; 1531 CK_C_DecryptFinal C_DecryptFinal; 1532 CK_C_DigestInit C_DigestInit; 1533 CK_C_Digest C_Digest; 1534 CK_C_DigestUpdate C_DigestUpdate; 1535 CK_C_DigestKey C_DigestKey; 1536 CK_C_DigestFinal C_DigestFinal; 1537 CK_C_SignInit C_SignInit; 1538 CK_C_Sign C_Sign; 1539 CK_C_SignUpdate C_SignUpdate; 1540 CK_C_SignFinal C_SignFinal; 1541 CK_C_SignRecoverInit C_SignRecoverInit; 1542 CK_C_SignRecover C_SignRecover; 1543 CK_C_VerifyInit C_VerifyInit; 1544 CK_C_Verify C_Verify; 1545 CK_C_VerifyUpdate C_VerifyUpdate; 1546 CK_C_VerifyFinal C_VerifyFinal; 1547 CK_C_VerifyRecoverInit C_VerifyRecoverInit; 1548 CK_C_VerifyRecover C_VerifyRecover; 1549 CK_C_DigestEncryptUpdate C_DigestEncryptUpdate; 1550 CK_C_DecryptDigestUpdate C_DecryptDigestUpdate; 1551 CK_C_SignEncryptUpdate C_SignEncryptUpdate; 1552 CK_C_DecryptVerifyUpdate C_DecryptVerifyUpdate; 1553 CK_C_GenerateKey C_GenerateKey; 1554 CK_C_GenerateKeyPair C_GenerateKeyPair; 1555 CK_C_WrapKey C_WrapKey; 1556 CK_C_UnwrapKey C_UnwrapKey; 1557 CK_C_DeriveKey C_DeriveKey; 1558 CK_C_SeedRandom C_SeedRandom; 1559 CK_C_GenerateRandom C_GenerateRandom; 1560 CK_C_GetFunctionStatus C_GetFunctionStatus; 1561 CK_C_CancelFunction C_CancelFunction; 1562 CK_C_WaitForSlotEvent C_WaitForSlotEvent; 1563 /* PKCS #11 3.0 functions */ 1564 CK_C_GetInterfaceList C_GetInterfaceList; 1565 CK_C_GetInterface C_GetInterface; 1566 CK_C_LoginUser C_LoginUser; 1567 CK_C_SessionCancel C_SessionCancel; 1568 CK_C_MessageEncryptInit C_MessageEncryptInit; 1569 CK_C_EncryptMessage C_EncryptMessage; 1570 CK_C_EncryptMessageBegin C_EncryptMessageBegin; 1571 CK_C_EncryptMessageNext C_EncryptMessageNext; 1572 CK_C_MessageEncryptFinal C_MessageEncryptFinal; 1573 CK_C_MessageDecryptInit C_MessageDecryptInit; 1574 CK_C_DecryptMessage C_DecryptMessage; 1575 CK_C_DecryptMessageBegin C_DecryptMessageBegin; 1576 CK_C_DecryptMessageNext C_DecryptMessageNext; 1577 CK_C_MessageDecryptFinal C_MessageDecryptFinal; 1578 CK_C_MessageSignInit C_MessageSignInit; 1579 CK_C_SignMessage C_SignMessage; 1580 CK_C_SignMessageBegin C_SignMessageBegin; 1581 CK_C_SignMessageNext C_SignMessageNext; 1582 CK_C_MessageSignFinal C_MessageSignFinal; 1583 CK_C_MessageVerifyInit C_MessageVerifyInit; 1584 CK_C_VerifyMessage C_VerifyMessage; 1585 CK_C_VerifyMessageBegin C_VerifyMessageBegin; 1586 CK_C_VerifyMessageNext C_VerifyMessageNext; 1587 CK_C_MessageVerifyFinal C_MessageVerifyFinal; 1588 }; 1589 1590 1591 1592 typedef ck_rv_t (*ck_createmutex_t) (void **mutex); 1593 typedef ck_rv_t (*ck_destroymutex_t) (void *mutex); 1594 typedef ck_rv_t (*ck_lockmutex_t) (void *mutex); 1595 typedef ck_rv_t (*ck_unlockmutex_t) (void *mutex); 1596 1597 1598 struct ck_c_initialize_args 1599 { 1600 ck_createmutex_t create_mutex; 1601 ck_destroymutex_t destroy_mutex; 1602 ck_lockmutex_t lock_mutex; 1603 ck_unlockmutex_t unlock_mutex; 1604 ck_flags_t flags; 1605 void *reserved; 1606 }; 1607 1608 1609 #define CKF_LIBRARY_CANT_CREATE_OS_THREADS (1UL << 0) 1610 #define CKF_OS_LOCKING_OK (1UL << 1) 1611 1612 #define CKR_OK (0UL) 1613 #define CKR_CANCEL (1UL) 1614 #define CKR_HOST_MEMORY (2UL) 1615 #define CKR_SLOT_ID_INVALID (3UL) 1616 #define CKR_GENERAL_ERROR (5UL) 1617 #define CKR_FUNCTION_FAILED (6UL) 1618 #define CKR_ARGUMENTS_BAD (7UL) 1619 #define CKR_NO_EVENT (8UL) 1620 #define CKR_NEED_TO_CREATE_THREADS (9UL) 1621 #define CKR_CANT_LOCK (0xaUL) 1622 #define CKR_ATTRIBUTE_READ_ONLY (0x10UL) 1623 #define CKR_ATTRIBUTE_SENSITIVE (0x11UL) 1624 #define CKR_ATTRIBUTE_TYPE_INVALID (0x12UL) 1625 #define CKR_ATTRIBUTE_VALUE_INVALID (0x13UL) 1626 #define CKR_ACTION_PROHIBITED (0x1BUL) 1627 #define CKR_DATA_INVALID (0x20UL) 1628 #define CKR_DATA_LEN_RANGE (0x21UL) 1629 #define CKR_DEVICE_ERROR (0x30UL) 1630 #define CKR_DEVICE_MEMORY (0x31UL) 1631 #define CKR_DEVICE_REMOVED (0x32UL) 1632 #define CKR_ENCRYPTED_DATA_INVALID (0x40UL) 1633 #define CKR_ENCRYPTED_DATA_LEN_RANGE (0x41UL) 1634 #define CKR_FUNCTION_CANCELED (0x50UL) 1635 #define CKR_FUNCTION_NOT_PARALLEL (0x51UL) 1636 #define CKR_FUNCTION_NOT_SUPPORTED (0x54UL) 1637 #define CKR_KEY_HANDLE_INVALID (0x60UL) 1638 #define CKR_KEY_SIZE_RANGE (0x62UL) 1639 #define CKR_KEY_TYPE_INCONSISTENT (0x63UL) 1640 #define CKR_KEY_NOT_NEEDED (0x64UL) 1641 #define CKR_KEY_CHANGED (0x65UL) 1642 #define CKR_KEY_NEEDED (0x66UL) 1643 #define CKR_KEY_INDIGESTIBLE (0x67UL) 1644 #define CKR_KEY_FUNCTION_NOT_PERMITTED (0x68UL) 1645 #define CKR_KEY_NOT_WRAPPABLE (0x69UL) 1646 #define CKR_KEY_UNEXTRACTABLE (0x6aUL) 1647 #define CKR_MECHANISM_INVALID (0x70UL) 1648 #define CKR_MECHANISM_PARAM_INVALID (0x71UL) 1649 #define CKR_OBJECT_HANDLE_INVALID (0x82UL) 1650 #define CKR_OPERATION_ACTIVE (0x90UL) 1651 #define CKR_OPERATION_NOT_INITIALIZED (0x91UL) 1652 #define CKR_PIN_INCORRECT (0xa0UL) 1653 #define CKR_PIN_INVALID (0xa1UL) 1654 #define CKR_PIN_LEN_RANGE (0xa2UL) 1655 #define CKR_PIN_EXPIRED (0xa3UL) 1656 #define CKR_PIN_LOCKED (0xa4UL) 1657 #define CKR_SESSION_CLOSED (0xb0UL) 1658 #define CKR_SESSION_COUNT (0xb1UL) 1659 #define CKR_SESSION_HANDLE_INVALID (0xb3UL) 1660 #define CKR_SESSION_PARALLEL_NOT_SUPPORTED (0xb4UL) 1661 #define CKR_SESSION_READ_ONLY (0xb5UL) 1662 #define CKR_SESSION_EXISTS (0xb6UL) 1663 #define CKR_SESSION_READ_ONLY_EXISTS (0xb7UL) 1664 #define CKR_SESSION_READ_WRITE_SO_EXISTS (0xb8UL) 1665 #define CKR_SIGNATURE_INVALID (0xc0UL) 1666 #define CKR_SIGNATURE_LEN_RANGE (0xc1UL) 1667 #define CKR_TEMPLATE_INCOMPLETE (0xd0UL) 1668 #define CKR_TEMPLATE_INCONSISTENT (0xd1UL) 1669 #define CKR_TOKEN_NOT_PRESENT (0xe0UL) 1670 #define CKR_TOKEN_NOT_RECOGNIZED (0xe1UL) 1671 #define CKR_TOKEN_WRITE_PROTECTED (0xe2UL) 1672 #define CKR_UNWRAPPING_KEY_HANDLE_INVALID (0xf0UL) 1673 #define CKR_UNWRAPPING_KEY_SIZE_RANGE (0xf1UL) 1674 #define CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT (0xf2UL) 1675 #define CKR_USER_ALREADY_LOGGED_IN (0x100UL) 1676 #define CKR_USER_NOT_LOGGED_IN (0x101UL) 1677 #define CKR_USER_PIN_NOT_INITIALIZED (0x102UL) 1678 #define CKR_USER_TYPE_INVALID (0x103UL) 1679 #define CKR_USER_ANOTHER_ALREADY_LOGGED_IN (0x104UL) 1680 #define CKR_USER_TOO_MANY_TYPES (0x105UL) 1681 #define CKR_WRAPPED_KEY_INVALID (0x110UL) 1682 #define CKR_WRAPPED_KEY_LEN_RANGE (0x112UL) 1683 #define CKR_WRAPPING_KEY_HANDLE_INVALID (0x113UL) 1684 #define CKR_WRAPPING_KEY_SIZE_RANGE (0x114UL) 1685 #define CKR_WRAPPING_KEY_TYPE_INCONSISTENT (0x115UL) 1686 #define CKR_RANDOM_SEED_NOT_SUPPORTED (0x120UL) 1687 #define CKR_RANDOM_NO_RNG (0x121UL) 1688 #define CKR_DOMAIN_PARAMS_INVALID (0x130UL) 1689 #define CKR_CURVE_NOT_SUPPORTED (0x140UL) 1690 #define CKR_BUFFER_TOO_SMALL (0x150UL) 1691 #define CKR_SAVED_STATE_INVALID (0x160UL) 1692 #define CKR_INFORMATION_SENSITIVE (0x170UL) 1693 #define CKR_STATE_UNSAVEABLE (0x180UL) 1694 #define CKR_CRYPTOKI_NOT_INITIALIZED (0x190UL) 1695 #define CKR_CRYPTOKI_ALREADY_INITIALIZED (0x191UL) 1696 #define CKR_MUTEX_BAD (0x1a0UL) 1697 #define CKR_MUTEX_NOT_LOCKED (0x1a1UL) 1698 #define CKR_FUNCTION_REJECTED (0x200UL) 1699 #define CKR_VENDOR_DEFINED (1UL << 31) 1700 1701 1702 /* Compatibility layer. */ 1703 1704 #ifdef CRYPTOKI_COMPAT 1705 1706 #undef CK_DEFINE_FUNCTION 1707 #define CK_DEFINE_FUNCTION(retval, name) retval CK_SPEC name 1708 1709 /* For NULL. */ 1710 #include <stddef.h> 1711 1712 typedef unsigned char CK_BYTE; 1713 typedef unsigned char CK_CHAR; 1714 typedef unsigned char CK_UTF8CHAR; 1715 typedef unsigned char CK_BBOOL; 1716 typedef unsigned long int CK_ULONG; 1717 typedef long int CK_LONG; 1718 typedef CK_BYTE *CK_BYTE_PTR; 1719 typedef CK_CHAR *CK_CHAR_PTR; 1720 typedef CK_UTF8CHAR *CK_UTF8CHAR_PTR; 1721 typedef CK_ULONG *CK_ULONG_PTR; 1722 typedef void *CK_VOID_PTR; 1723 typedef void **CK_VOID_PTR_PTR; 1724 #define CK_FALSE 0 1725 #define CK_TRUE 1 1726 #ifndef CK_DISABLE_TRUE_FALSE 1727 #ifndef FALSE 1728 #define FALSE 0 1729 #endif 1730 #ifndef TRUE 1731 #define TRUE 1 1732 #endif 1733 #endif 1734 1735 typedef struct CK_HKDF_PARAMS { 1736 CK_BBOOL bExtract; 1737 CK_BBOOL bExpand; 1738 CK_MECHANISM_TYPE prfHashMechanism; 1739 CK_ULONG ulSaltType; 1740 CK_BYTE_PTR pSalt; 1741 CK_ULONG ulSaltLen; 1742 CK_OBJECT_HANDLE hSaltKey; 1743 CK_BYTE_PTR pInfo; 1744 CK_ULONG ulInfoLen; 1745 } CK_HKDF_PARAMS; 1746 1747 #define CKF_HKDF_SALT_NULL 0x00000001UL 1748 #define CKF_HKDF_SALT_DATA 0x00000002UL 1749 #define CKF_HKDF_SALT_KEY 0x00000004UL 1750 1751 typedef struct ck_version CK_VERSION; 1752 typedef struct ck_version *CK_VERSION_PTR; 1753 1754 typedef struct ck_info CK_INFO; 1755 typedef struct ck_info *CK_INFO_PTR; 1756 1757 typedef ck_slot_id_t *CK_SLOT_ID_PTR; 1758 1759 typedef struct ck_slot_info CK_SLOT_INFO; 1760 typedef struct ck_slot_info *CK_SLOT_INFO_PTR; 1761 1762 typedef struct ck_token_info CK_TOKEN_INFO; 1763 typedef struct ck_token_info *CK_TOKEN_INFO_PTR; 1764 1765 typedef ck_session_handle_t *CK_SESSION_HANDLE_PTR; 1766 1767 typedef struct ck_session_info CK_SESSION_INFO; 1768 typedef struct ck_session_info *CK_SESSION_INFO_PTR; 1769 1770 typedef ck_object_handle_t *CK_OBJECT_HANDLE_PTR; 1771 1772 typedef ck_object_class_t *CK_OBJECT_CLASS_PTR; 1773 1774 typedef struct ck_attribute CK_ATTRIBUTE; 1775 typedef struct ck_attribute *CK_ATTRIBUTE_PTR; 1776 1777 typedef struct ck_date CK_DATE; 1778 typedef struct ck_date *CK_DATE_PTR; 1779 1780 typedef ck_mechanism_type_t *CK_MECHANISM_TYPE_PTR; 1781 1782 typedef ck_rsa_pkcs_mgf_type_t *CK_RSA_PKCS_MGF_TYPE_PTR; 1783 1784 typedef struct ck_mechanism CK_MECHANISM; 1785 typedef struct ck_mechanism *CK_MECHANISM_PTR; 1786 1787 typedef struct ck_mechanism_info CK_MECHANISM_INFO; 1788 typedef struct ck_mechanism_info *CK_MECHANISM_INFO_PTR; 1789 1790 typedef struct ck_interface CK_INTERFACE; 1791 typedef struct ck_interface *CK_INTERFACE_PTR; 1792 typedef struct ck_interface **CK_INTERFACE_PTR_PTR; 1793 1794 typedef struct ck_function_list CK_FUNCTION_LIST; 1795 typedef struct ck_function_list *CK_FUNCTION_LIST_PTR; 1796 typedef struct ck_function_list **CK_FUNCTION_LIST_PTR_PTR; 1797 1798 typedef struct ck_function_list_3_0 CK_FUNCTION_LIST_3_0; 1799 typedef struct ck_function_list_3_0 *CK_FUNCTION_LIST_3_0_PTR; 1800 typedef struct ck_function_list_3_0 **CK_FUNCTION_LIST_3_0_PTR_PTR; 1801 1802 typedef struct ck_c_initialize_args CK_C_INITIALIZE_ARGS; 1803 typedef struct ck_c_initialize_args *CK_C_INITIALIZE_ARGS_PTR; 1804 1805 #define NULL_PTR NULL 1806 1807 /* Delete the helper macros defined at the top of the file. */ 1808 #undef ck_flags_t 1809 #undef ck_version 1810 1811 #undef ck_info 1812 #undef cryptoki_version 1813 #undef manufacturer_id 1814 #undef library_description 1815 #undef library_version 1816 1817 #undef ck_notification_t 1818 #undef ck_slot_id_t 1819 1820 #undef ck_slot_info 1821 #undef slot_description 1822 #undef hardware_version 1823 #undef firmware_version 1824 1825 #undef ck_token_info 1826 #undef serial_number 1827 #undef max_session_count 1828 #undef session_count 1829 #undef max_rw_session_count 1830 #undef rw_session_count 1831 #undef max_pin_len 1832 #undef min_pin_len 1833 #undef total_public_memory 1834 #undef free_public_memory 1835 #undef total_private_memory 1836 #undef free_private_memory 1837 #undef utc_time 1838 1839 #undef ck_session_handle_t 1840 #undef ck_user_type_t 1841 #undef ck_state_t 1842 1843 #undef ck_session_info 1844 #undef slot_id 1845 #undef device_error 1846 1847 #undef ck_object_handle_t 1848 #undef ck_object_class_t 1849 #undef ck_hw_feature_type_t 1850 #undef ck_key_type_t 1851 #undef ck_certificate_type_t 1852 #undef ck_attribute_type_t 1853 1854 #undef ck_attribute 1855 #undef value 1856 #undef value_len 1857 1858 #undef ck_date 1859 1860 #undef ck_mechanism_type_t 1861 1862 #undef ck_rsa_pkcs_mgf_type_t 1863 1864 #undef ck_mechanism 1865 #undef parameter 1866 #undef parameter_len 1867 1868 #undef ck_mechanism_info 1869 #undef min_key_size 1870 #undef max_key_size 1871 1872 #undef ck_rv_t 1873 #undef ck_notify_t 1874 1875 #undef ck_interface 1876 1877 #undef ck_function_list 1878 #undef ck_function_list_3_0 1879 1880 #undef ck_createmutex_t 1881 #undef ck_destroymutex_t 1882 #undef ck_lockmutex_t 1883 #undef ck_unlockmutex_t 1884 1885 #undef ck_c_initialize_args 1886 #undef create_mutex 1887 #undef destroy_mutex 1888 #undef lock_mutex 1889 #undef unlock_mutex 1890 #undef reserved 1891 1892 #endif /* CRYPTOKI_COMPAT */ 1893 1894 /* System dependencies. */ 1895 #if defined(_WIN32) || defined(CRYPTOKI_FORCE_WIN32) 1896 #pragma pack(pop, cryptoki) 1897 #endif 1898 1899 #if defined(__cplusplus) 1900 } 1901 #endif 1902 1903 #endif /* PKCS11_H */ 1904
Indexes created Sun Mar 01 05:31:48 UTC 2026