1 /* pkcs11.h 2 Copyright 2006, 2007 g10 Code GmbH 3 Copyright 2006 Andreas Jellinghaus 4 5 This file is free software; as a special exception the author gives 6 unlimited permission to copy and/or distribute it, with or without 7 modifications, as long as this notice is preserved. 8 9 This file is distributed in the hope that it will be useful, but 10 WITHOUT ANY WARRANTY, to the extent permitted by law; without even 11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 12 PURPOSE. */ 13 14 /* Please submit changes back to the Scute project at 15 http://www.scute.org/ (or send them to marcus@g10code.com), so that 16 they can be picked up by other projects from there as well. */ 17 18 /* This file is a modified implementation of the PKCS #11 standard by 19 RSA Security Inc. It is mostly a drop-in replacement, with the 20 following change: 21 22 This header file does not require any macro definitions by the user 23 (like CK_DEFINE_FUNCTION etc). In fact, it defines those macros 24 for you (if useful, some are missing, let me know if you need 25 more). 26 27 There is an additional API available that does comply better to the 28 GNU coding standard. It can be switched on by defining 29 CRYPTOKI_GNU before including this header file. For this, the 30 following changes are made to the specification: 31 32 All structure types are changed to a "struct ck_foo" where CK_FOO 33 is the type name in PKCS #11. 34 35 All non-structure types are changed to ck_foo_t where CK_FOO is the 36 lowercase version of the type name in PKCS #11. The basic types 37 (CK_ULONG et al.) are removed without substitute. 38 39 All members of structures are modified in the following way: Type 40 indication prefixes are removed, and underscore characters are 41 inserted before words. Then the result is lowercased. 42 43 Note that function names are still in the original case, as they 44 need for ABI compatibility. 45 46 CK_FALSE, CK_TRUE and NULL_PTR are removed without substitute. Use 47 <stdbool.h>. 48 49 If CRYPTOKI_COMPAT is defined before including this header file, 50 then none of the API changes above take place, and the API is the 51 one defined by the PKCS #11 standard. */ 52 53 #ifndef PKCS11_H 54 #define PKCS11_H 1 55 56 #if defined(__cplusplus) 57 extern "C" { 58 #endif 59 60 /* The version of cryptoki we implement. The revision is changed with 61 each modification of this file. If you do not use the "official" 62 version of this file, please consider deleting the revision macro 63 (you may use a macro with a different name to keep track of your 64 versions). */ 65 #define CRYPTOKI_VERSION_MAJOR 2 66 #define CRYPTOKI_VERSION_MINOR 40 67 #define CRYPTOKI_VERSION_REVISION 0 68 69 /* Compatibility interface is default, unless CRYPTOKI_GNU is 70 given. */ 71 #ifndef CRYPTOKI_GNU 72 #ifndef CRYPTOKI_COMPAT 73 #define CRYPTOKI_COMPAT 1 74 #endif 75 #endif 76 77 /* System dependencies. */ 78 79 #if defined(_WIN32) || defined(CRYPTOKI_FORCE_WIN32) 80 81 /* There is a matching pop below. */ 82 #pragma pack(push, cryptoki, 1) 83 84 #ifdef CRYPTOKI_EXPORTS 85 #define CK_SPEC __declspec(dllexport) 86 #else 87 /* 88 * Yubico: we're using libtool to declare exports, this 89 * messes up the build. 90 * 91 * #define CK_SPEC __declspec(dllimport) 92 */ 93 #define CK_SPEC 94 #endif 95 96 #else 97 98 #ifdef CRYPTOKI_EXPORTS 99 #define CK_SPEC __attribute__((visibility("default"))) 100 #else 101 #define CK_SPEC 102 #endif 103 104 #endif 105 106 #ifdef CRYPTOKI_COMPAT 107 /* If we are in compatibility mode, switch all exposed names to the 108 PKCS #11 variant. There are corresponding #undefs below. */ 109 110 #define ck_flags_t CK_FLAGS 111 #define ck_version _CK_VERSION 112 113 #define ck_info _CK_INFO 114 #define cryptoki_version cryptokiVersion 115 #define manufacturer_id manufacturerID 116 #define library_description libraryDescription 117 #define library_version libraryVersion 118 119 #define ck_notification_t CK_NOTIFICATION 120 #define ck_slot_id_t CK_SLOT_ID 121 122 #define ck_slot_info _CK_SLOT_INFO 123 #define slot_description slotDescription 124 #define hardware_version hardwareVersion 125 #define firmware_version firmwareVersion 126 127 #define ck_token_info _CK_TOKEN_INFO 128 #define serial_number serialNumber 129 #define max_session_count ulMaxSessionCount 130 #define session_count ulSessionCount 131 #define max_rw_session_count ulMaxRwSessionCount 132 #define rw_session_count ulRwSessionCount 133 #define max_pin_len ulMaxPinLen 134 #define min_pin_len ulMinPinLen 135 #define total_public_memory ulTotalPublicMemory 136 #define free_public_memory ulFreePublicMemory 137 #define total_private_memory ulTotalPrivateMemory 138 #define free_private_memory ulFreePrivateMemory 139 #define utc_time utcTime 140 141 #define ck_session_handle_t CK_SESSION_HANDLE 142 #define ck_user_type_t CK_USER_TYPE 143 #define ck_state_t CK_STATE 144 145 #define ck_session_info _CK_SESSION_INFO 146 #define slot_id slotID 147 #define device_error ulDeviceError 148 149 #define ck_object_handle_t CK_OBJECT_HANDLE 150 #define ck_object_class_t CK_OBJECT_CLASS 151 #define ck_hw_feature_type_t CK_HW_FEATURE_TYPE 152 #define ck_key_type_t CK_KEY_TYPE 153 #define ck_certificate_type_t CK_CERTIFICATE_TYPE 154 #define ck_attribute_type_t CK_ATTRIBUTE_TYPE 155 156 #define ck_attribute _CK_ATTRIBUTE 157 #define value pValue 158 #define value_len ulValueLen 159 160 #define ck_date _CK_DATE 161 162 #define ck_mechanism_type_t CK_MECHANISM_TYPE 163 164 #define ck_mechanism _CK_MECHANISM 165 #define parameter pParameter 166 #define parameter_len ulParameterLen 167 168 #define ck_mechanism_info _CK_MECHANISM_INFO 169 #define min_key_size ulMinKeySize 170 #define max_key_size ulMaxKeySize 171 172 #define ck_rv_t CK_RV 173 #define ck_notify_t CK_NOTIFY 174 175 #define ck_function_list _CK_FUNCTION_LIST 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 pfnCreateMutex 184 #define destroy_mutex pfnDestroyMutex 185 #define lock_mutex pfnLockMutex 186 #define unlock_mutex pfnUnlockMutex 187 #define reserved pReserved 188 189 #endif /* CRYPTOKI_COMPAT */ 190 191 typedef unsigned long ck_flags_t; 192 193 struct ck_version { 194 unsigned char major; 195 unsigned char minor; 196 }; 197 198 struct ck_info { 199 struct ck_version cryptoki_version; 200 unsigned char manufacturer_id[32]; 201 ck_flags_t flags; 202 unsigned char library_description[32]; 203 struct ck_version library_version; 204 }; 205 206 typedef unsigned long ck_notification_t; 207 208 #define CKN_SURRENDER (0UL) 209 210 typedef unsigned long ck_slot_id_t; 211 212 struct ck_slot_info { 213 unsigned char slot_description[64]; 214 unsigned char manufacturer_id[32]; 215 ck_flags_t flags; 216 struct ck_version hardware_version; 217 struct ck_version firmware_version; 218 }; 219 220 #define CKF_TOKEN_PRESENT (1UL << 0) 221 #define CKF_REMOVABLE_DEVICE (1UL << 1) 222 #define CKF_HW_SLOT (1UL << 2) 223 #define CKF_ARRAY_ATTRIBUTE (1UL << 30) 224 225 struct ck_token_info { 226 unsigned char label[32]; 227 unsigned char manufacturer_id[32]; 228 unsigned char model[16]; 229 unsigned char serial_number[16]; 230 ck_flags_t flags; 231 unsigned long max_session_count; 232 unsigned long session_count; 233 unsigned long max_rw_session_count; 234 unsigned long rw_session_count; 235 unsigned long max_pin_len; 236 unsigned long min_pin_len; 237 unsigned long total_public_memory; 238 unsigned long free_public_memory; 239 unsigned long total_private_memory; 240 unsigned long free_private_memory; 241 struct ck_version hardware_version; 242 struct ck_version firmware_version; 243 unsigned char utc_time[16]; 244 }; 245 246 #define CKF_RNG (1UL << 0) 247 #define CKF_WRITE_PROTECTED (1UL << 1) 248 #define CKF_LOGIN_REQUIRED (1UL << 2) 249 #define CKF_USER_PIN_INITIALIZED (1UL << 3) 250 #define CKF_RESTORE_KEY_NOT_NEEDED (1UL << 5) 251 #define CKF_CLOCK_ON_TOKEN (1UL << 6) 252 #define CKF_PROTECTED_AUTHENTICATION_PATH (1UL << 8) 253 #define CKF_DUAL_CRYPTO_OPERATIONS (1UL << 9) 254 #define CKF_TOKEN_INITIALIZED (1UL << 10) 255 #define CKF_SECONDARY_AUTHENTICATION (1UL << 11) 256 #define CKF_USER_PIN_COUNT_LOW (1UL << 16) 257 #define CKF_USER_PIN_FINAL_TRY (1UL << 17) 258 #define CKF_USER_PIN_LOCKED (1UL << 18) 259 #define CKF_USER_PIN_TO_BE_CHANGED (1UL << 19) 260 #define CKF_SO_PIN_COUNT_LOW (1UL << 20) 261 #define CKF_SO_PIN_FINAL_TRY (1UL << 21) 262 #define CKF_SO_PIN_LOCKED (1UL << 22) 263 #define CKF_SO_PIN_TO_BE_CHANGED (1UL << 23) 264 265 #define CK_UNAVAILABLE_INFORMATION ((unsigned long) -1) 266 #define CK_EFFECTIVELY_INFINITE (0UL) 267 268 typedef unsigned long ck_session_handle_t; 269 270 #define CK_INVALID_HANDLE (0UL) 271 272 typedef unsigned long ck_user_type_t; 273 274 #define CKU_SO (0UL) 275 #define CKU_USER (1UL) 276 #define CKU_CONTEXT_SPECIFIC (2UL) 277 278 typedef unsigned long ck_state_t; 279 280 #define CKS_RO_PUBLIC_SESSION (0UL) 281 #define CKS_RO_USER_FUNCTIONS (1UL) 282 #define CKS_RW_PUBLIC_SESSION (2UL) 283 #define CKS_RW_USER_FUNCTIONS (3UL) 284 #define CKS_RW_SO_FUNCTIONS (4UL) 285 286 struct ck_session_info { 287 ck_slot_id_t slot_id; 288 ck_state_t state; 289 ck_flags_t flags; 290 unsigned long device_error; 291 }; 292 293 #define CKF_RW_SESSION (1UL << 1) 294 #define CKF_SERIAL_SESSION (1UL << 2) 295 296 typedef unsigned long ck_object_handle_t; 297 298 typedef unsigned long ck_object_class_t; 299 300 #define CKO_DATA (0UL) 301 #define CKO_CERTIFICATE (1UL) 302 #define CKO_PUBLIC_KEY (2UL) 303 #define CKO_PRIVATE_KEY (3UL) 304 #define CKO_SECRET_KEY (4UL) 305 #define CKO_HW_FEATURE (5UL) 306 #define CKO_DOMAIN_PARAMETERS (6UL) 307 #define CKO_MECHANISM (7UL) 308 #define CKO_VENDOR_DEFINED (1UL << 31) 309 310 typedef unsigned long ck_hw_feature_type_t; 311 312 #define CKH_MONOTONIC_COUNTER (1UL) 313 #define CKH_CLOCK (2UL) 314 #define CKH_USER_INTERFACE (3UL) 315 #define CKH_VENDOR_DEFINED (1UL << 31) 316 317 typedef unsigned long ck_key_type_t; 318 319 #define CKK_RSA (0UL) 320 #define CKK_DSA (1UL) 321 #define CKK_DH (2UL) 322 #define CKK_ECDSA (3UL) 323 #define CKK_EC (3UL) 324 #define CKK_X9_42_DH (4UL) 325 #define CKK_KEA (5UL) 326 #define CKK_GENERIC_SECRET (0x10UL) 327 #define CKK_RC2 (0x11UL) 328 #define CKK_RC4 (0x12UL) 329 #define CKK_DES (0x13UL) 330 #define CKK_DES2 (0x14UL) 331 #define CKK_DES3 (0x15UL) 332 #define CKK_CAST (0x16UL) 333 #define CKK_CAST3 (0x17UL) 334 #define CKK_CAST128 (0x18UL) 335 #define CKK_RC5 (0x19UL) 336 #define CKK_IDEA (0x1aUL) 337 #define CKK_SKIPJACK (0x1bUL) 338 #define CKK_BATON (0x1cUL) 339 #define CKK_JUNIPER (0x1dUL) 340 #define CKK_CDMF (0x1eUL) 341 #define CKK_AES (0x1fUL) 342 #define CKK_BLOWFISH (0x20UL) 343 #define CKK_TWOFISH (0x21UL) 344 #define CKK_SHA_1_HMAC (0x28UL) 345 #define CKK_SHA256_HMAC (0x2bUL) 346 #define CKK_SHA384_HMAC (0x2cUL) 347 #define CKK_SHA512_HMAC (0x2dUL) 348 #define CKK_SHA224_HMAC (0x2eUL) 349 #define CKK_GOSTR3410 (0x30UL) 350 #define CKK_GOSTR3411 (0x31UL) 351 #define CKK_GOST28147 (0x32UL) 352 #define CKK_VENDOR_DEFINED (1UL << 31) 353 354 typedef unsigned long ck_certificate_type_t; 355 356 #define CKC_X_509 (0UL) 357 #define CKC_X_509_ATTR_CERT (1UL) 358 #define CKC_WTLS (2UL) 359 #define CKC_VENDOR_DEFINED (1UL << 31) 360 361 typedef unsigned long ck_attribute_type_t; 362 363 #define CKA_CLASS (0UL) 364 #define CKA_TOKEN (1UL) 365 #define CKA_PRIVATE (2UL) 366 #define CKA_LABEL (3UL) 367 #define CKA_APPLICATION (0x10UL) 368 #define CKA_VALUE (0x11UL) 369 #define CKA_OBJECT_ID (0x12UL) 370 #define CKA_CERTIFICATE_TYPE (0x80UL) 371 #define CKA_ISSUER (0x81UL) 372 #define CKA_SERIAL_NUMBER (0x82UL) 373 #define CKA_AC_ISSUER (0x83UL) 374 #define CKA_OWNER (0x84UL) 375 #define CKA_ATTR_TYPES (0x85UL) 376 #define CKA_TRUSTED (0x86UL) 377 #define CKA_CERTIFICATE_CATEGORY (0x87UL) 378 #define CKA_JAVA_MIDP_SECURITY_DOMAIN (0x88UL) 379 #define CKA_URL (0x89UL) 380 #define CKA_HASH_OF_SUBJECT_PUBLIC_KEY (0x8aUL) 381 #define CKA_HASH_OF_ISSUER_PUBLIC_KEY (0x8bUL) 382 #define CKA_CHECK_VALUE (0x90UL) 383 #define CKA_KEY_TYPE (0x100UL) 384 #define CKA_SUBJECT (0x101UL) 385 #define CKA_ID (0x102UL) 386 #define CKA_SENSITIVE (0x103UL) 387 #define CKA_ENCRYPT (0x104UL) 388 #define CKA_DECRYPT (0x105UL) 389 #define CKA_WRAP (0x106UL) 390 #define CKA_UNWRAP (0x107UL) 391 #define CKA_SIGN (0x108UL) 392 #define CKA_SIGN_RECOVER (0x109UL) 393 #define CKA_VERIFY (0x10aUL) 394 #define CKA_VERIFY_RECOVER (0x10bUL) 395 #define CKA_DERIVE (0x10cUL) 396 #define CKA_START_DATE (0x110UL) 397 #define CKA_END_DATE (0x111UL) 398 #define CKA_MODULUS (0x120UL) 399 #define CKA_MODULUS_BITS (0x121UL) 400 #define CKA_PUBLIC_EXPONENT (0x122UL) 401 #define CKA_PRIVATE_EXPONENT (0x123UL) 402 #define CKA_PRIME_1 (0x124UL) 403 #define CKA_PRIME_2 (0x125UL) 404 #define CKA_EXPONENT_1 (0x126UL) 405 #define CKA_EXPONENT_2 (0x127UL) 406 #define CKA_COEFFICIENT (0x128UL) 407 #define CKA_PUBLIC_KEY_INFO (0x129UL) 408 #define CKA_PRIME (0x130UL) 409 #define CKA_SUBPRIME (0x131UL) 410 #define CKA_BASE (0x132UL) 411 #define CKA_PRIME_BITS (0x133UL) 412 #define CKA_SUB_PRIME_BITS (0x134UL) 413 #define CKA_VALUE_BITS (0x160UL) 414 #define CKA_VALUE_LEN (0x161UL) 415 #define CKA_EXTRACTABLE (0x162UL) 416 #define CKA_LOCAL (0x163UL) 417 #define CKA_NEVER_EXTRACTABLE (0x164UL) 418 #define CKA_ALWAYS_SENSITIVE (0x165UL) 419 #define CKA_KEY_GEN_MECHANISM (0x166UL) 420 #define CKA_MODIFIABLE (0x170UL) 421 #define CKA_COPYABLE (0x171UL) 422 #define CKA_DESTROYABLE (0x172UL) 423 #define CKA_ECDSA_PARAMS (0x180UL) 424 #define CKA_EC_PARAMS (0x180UL) 425 #define CKA_EC_POINT (0x181UL) 426 #define CKA_SECONDARY_AUTH (0x200UL) 427 #define CKA_AUTH_PIN_FLAGS (0x201UL) 428 #define CKA_ALWAYS_AUTHENTICATE (0x202UL) 429 #define CKA_WRAP_WITH_TRUSTED (0x210UL) 430 #define CKA_GOSTR3410_PARAMS (0x250UL) 431 #define CKA_GOSTR3411_PARAMS (0x251UL) 432 #define CKA_GOST28147_PARAMS (0x252UL) 433 #define CKA_HW_FEATURE_TYPE (0x300UL) 434 #define CKA_RESET_ON_INIT (0x301UL) 435 #define CKA_HAS_RESET (0x302UL) 436 #define CKA_PIXEL_X (0x400UL) 437 #define CKA_PIXEL_Y (0x401UL) 438 #define CKA_RESOLUTION (0x402UL) 439 #define CKA_CHAR_ROWS (0x403UL) 440 #define CKA_CHAR_COLUMNS (0x404UL) 441 #define CKA_COLOR (0x405UL) 442 #define CKA_BITS_PER_PIXEL (0x406UL) 443 #define CKA_CHAR_SETS (0x480UL) 444 #define CKA_ENCODING_METHODS (0x481UL) 445 #define CKA_MIME_TYPES (0x482UL) 446 #define CKA_MECHANISM_TYPE (0x500UL) 447 #define CKA_REQUIRED_CMS_ATTRIBUTES (0x501UL) 448 #define CKA_DEFAULT_CMS_ATTRIBUTES (0x502UL) 449 #define CKA_SUPPORTED_CMS_ATTRIBUTES (0x503UL) 450 #define CKA_WRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE | 0x211UL) 451 #define CKA_UNWRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE | 0x212UL) 452 #define CKA_ALLOWED_MECHANISMS (CKF_ARRAY_ATTRIBUTE | 0x600UL) 453 #define CKA_VENDOR_DEFINED (1UL << 31) 454 455 struct ck_attribute { 456 ck_attribute_type_t type; 457 void *value; 458 unsigned long value_len; 459 }; 460 461 struct ck_date { 462 unsigned char year[4]; 463 unsigned char month[2]; 464 unsigned char day[2]; 465 }; 466 467 typedef unsigned long ck_mechanism_type_t; 468 469 #define CKM_RSA_PKCS_KEY_PAIR_GEN (0UL) 470 #define CKM_RSA_PKCS (1UL) 471 #define CKM_RSA_9796 (2UL) 472 #define CKM_RSA_X_509 (3UL) 473 #define CKM_MD2_RSA_PKCS (4UL) 474 #define CKM_MD5_RSA_PKCS (5UL) 475 #define CKM_SHA1_RSA_PKCS (6UL) 476 #define CKM_RIPEMD128_RSA_PKCS (7UL) 477 #define CKM_RIPEMD160_RSA_PKCS (8UL) 478 #define CKM_RSA_PKCS_OAEP (9UL) 479 #define CKM_RSA_X9_31_KEY_PAIR_GEN (0xaUL) 480 #define CKM_RSA_X9_31 (0xbUL) 481 #define CKM_SHA1_RSA_X9_31 (0xcUL) 482 #define CKM_RSA_PKCS_PSS (0xdUL) 483 #define CKM_SHA1_RSA_PKCS_PSS (0xeUL) 484 #define CKM_DSA_KEY_PAIR_GEN (0x10UL) 485 #define CKM_DSA (0x11UL) 486 #define CKM_DSA_SHA1 (0x12UL) 487 #define CKM_DH_PKCS_KEY_PAIR_GEN (0x20UL) 488 #define CKM_DH_PKCS_DERIVE (0x21UL) 489 #define CKM_X9_42_DH_KEY_PAIR_GEN (0x30UL) 490 #define CKM_X9_42_DH_DERIVE (0x31UL) 491 #define CKM_X9_42_DH_HYBRID_DERIVE (0x32UL) 492 #define CKM_X9_42_MQV_DERIVE (0x33UL) 493 #define CKM_SHA256_RSA_PKCS (0x40UL) 494 #define CKM_SHA384_RSA_PKCS (0x41UL) 495 #define CKM_SHA512_RSA_PKCS (0x42UL) 496 #define CKM_SHA256_RSA_PKCS_PSS (0x43UL) 497 #define CKM_SHA384_RSA_PKCS_PSS (0x44UL) 498 #define CKM_SHA512_RSA_PKCS_PSS (0x45UL) 499 #define CKM_RC2_KEY_GEN (0x100UL) 500 #define CKM_RC2_ECB (0x101UL) 501 #define CKM_RC2_CBC (0x102UL) 502 #define CKM_RC2_MAC (0x103UL) 503 #define CKM_RC2_MAC_GENERAL (0x104UL) 504 #define CKM_RC2_CBC_PAD (0x105UL) 505 #define CKM_RC4_KEY_GEN (0x110UL) 506 #define CKM_RC4 (0x111UL) 507 #define CKM_DES_KEY_GEN (0x120UL) 508 #define CKM_DES_ECB (0x121UL) 509 #define CKM_DES_CBC (0x122UL) 510 #define CKM_DES_MAC (0x123UL) 511 #define CKM_DES_MAC_GENERAL (0x124UL) 512 #define CKM_DES_CBC_PAD (0x125UL) 513 #define CKM_DES2_KEY_GEN (0x130UL) 514 #define CKM_DES3_KEY_GEN (0x131UL) 515 #define CKM_DES3_ECB (0x132UL) 516 #define CKM_DES3_CBC (0x133UL) 517 #define CKM_DES3_MAC (0x134UL) 518 #define CKM_DES3_MAC_GENERAL (0x135UL) 519 #define CKM_DES3_CBC_PAD (0x136UL) 520 #define CKM_CDMF_KEY_GEN (0x140UL) 521 #define CKM_CDMF_ECB (0x141UL) 522 #define CKM_CDMF_CBC (0x142UL) 523 #define CKM_CDMF_MAC (0x143UL) 524 #define CKM_CDMF_MAC_GENERAL (0x144UL) 525 #define CKM_CDMF_CBC_PAD (0x145UL) 526 #define CKM_MD2 (0x200UL) 527 #define CKM_MD2_HMAC (0x201UL) 528 #define CKM_MD2_HMAC_GENERAL (0x202UL) 529 #define CKM_MD5 (0x210UL) 530 #define CKM_MD5_HMAC (0x211UL) 531 #define CKM_MD5_HMAC_GENERAL (0x212UL) 532 #define CKM_SHA_1 (0x220UL) 533 #define CKM_SHA_1_HMAC (0x221UL) 534 #define CKM_SHA_1_HMAC_GENERAL (0x222UL) 535 #define CKM_RIPEMD128 (0x230UL) 536 #define CKM_RIPEMD128_HMAC (0x231UL) 537 #define CKM_RIPEMD128_HMAC_GENERAL (0x232UL) 538 #define CKM_RIPEMD160 (0x240UL) 539 #define CKM_RIPEMD160_HMAC (0x241UL) 540 #define CKM_RIPEMD160_HMAC_GENERAL (0x242UL) 541 #define CKM_SHA256 (0x250UL) 542 #define CKM_SHA256_HMAC (0x251UL) 543 #define CKM_SHA256_HMAC_GENERAL (0x252UL) 544 #define CKM_SHA384 (0x260UL) 545 #define CKM_SHA384_HMAC (0x261UL) 546 #define CKM_SHA384_HMAC_GENERAL (0x262UL) 547 #define CKM_SHA512 (0x270UL) 548 #define CKM_SHA512_HMAC (0x271UL) 549 #define CKM_SHA512_HMAC_GENERAL (0x272UL) 550 #define CKM_CAST_KEY_GEN (0x300UL) 551 #define CKM_CAST_ECB (0x301UL) 552 #define CKM_CAST_CBC (0x302UL) 553 #define CKM_CAST_MAC (0x303UL) 554 #define CKM_CAST_MAC_GENERAL (0x304UL) 555 #define CKM_CAST_CBC_PAD (0x305UL) 556 #define CKM_CAST3_KEY_GEN (0x310UL) 557 #define CKM_CAST3_ECB (0x311UL) 558 #define CKM_CAST3_CBC (0x312UL) 559 #define CKM_CAST3_MAC (0x313UL) 560 #define CKM_CAST3_MAC_GENERAL (0x314UL) 561 #define CKM_CAST3_CBC_PAD (0x315UL) 562 #define CKM_CAST5_KEY_GEN (0x320UL) 563 #define CKM_CAST128_KEY_GEN (0x320UL) 564 #define CKM_CAST5_ECB (0x321UL) 565 #define CKM_CAST128_ECB (0x321UL) 566 #define CKM_CAST5_CBC (0x322UL) 567 #define CKM_CAST128_CBC (0x322UL) 568 #define CKM_CAST5_MAC (0x323UL) 569 #define CKM_CAST128_MAC (0x323UL) 570 #define CKM_CAST5_MAC_GENERAL (0x324UL) 571 #define CKM_CAST128_MAC_GENERAL (0x324UL) 572 #define CKM_CAST5_CBC_PAD (0x325UL) 573 #define CKM_CAST128_CBC_PAD (0x325UL) 574 #define CKM_RC5_KEY_GEN (0x330UL) 575 #define CKM_RC5_ECB (0x331UL) 576 #define CKM_RC5_CBC (0x332UL) 577 #define CKM_RC5_MAC (0x333UL) 578 #define CKM_RC5_MAC_GENERAL (0x334UL) 579 #define CKM_RC5_CBC_PAD (0x335UL) 580 #define CKM_IDEA_KEY_GEN (0x340UL) 581 #define CKM_IDEA_ECB (0x341UL) 582 #define CKM_IDEA_CBC (0x342UL) 583 #define CKM_IDEA_MAC (0x343UL) 584 #define CKM_IDEA_MAC_GENERAL (0x344UL) 585 #define CKM_IDEA_CBC_PAD (0x345UL) 586 #define CKM_GENERIC_SECRET_KEY_GEN (0x350UL) 587 #define CKM_CONCATENATE_BASE_AND_KEY (0x360UL) 588 #define CKM_CONCATENATE_BASE_AND_DATA (0x362UL) 589 #define CKM_CONCATENATE_DATA_AND_BASE (0x363UL) 590 #define CKM_XOR_BASE_AND_DATA (0x364UL) 591 #define CKM_EXTRACT_KEY_FROM_KEY (0x365UL) 592 #define CKM_SSL3_PRE_MASTER_KEY_GEN (0x370UL) 593 #define CKM_SSL3_MASTER_KEY_DERIVE (0x371UL) 594 #define CKM_SSL3_KEY_AND_MAC_DERIVE (0x372UL) 595 #define CKM_SSL3_MASTER_KEY_DERIVE_DH (0x373UL) 596 #define CKM_TLS_PRE_MASTER_KEY_GEN (0x374UL) 597 #define CKM_TLS_MASTER_KEY_DERIVE (0x375UL) 598 #define CKM_TLS_KEY_AND_MAC_DERIVE (0x376UL) 599 #define CKM_TLS_MASTER_KEY_DERIVE_DH (0x377UL) 600 #define CKM_SSL3_MD5_MAC (0x380UL) 601 #define CKM_SSL3_SHA1_MAC (0x381UL) 602 #define CKM_MD5_KEY_DERIVATION (0x390UL) 603 #define CKM_MD2_KEY_DERIVATION (0x391UL) 604 #define CKM_SHA1_KEY_DERIVATION (0x392UL) 605 #define CKM_PBE_MD2_DES_CBC (0x3a0UL) 606 #define CKM_PBE_MD5_DES_CBC (0x3a1UL) 607 #define CKM_PBE_MD5_CAST_CBC (0x3a2UL) 608 #define CKM_PBE_MD5_CAST3_CBC (0x3a3UL) 609 #define CKM_PBE_MD5_CAST5_CBC (0x3a4UL) 610 #define CKM_PBE_MD5_CAST128_CBC (0x3a4UL) 611 #define CKM_PBE_SHA1_CAST5_CBC (0x3a5UL) 612 #define CKM_PBE_SHA1_CAST128_CBC (0x3a5UL) 613 #define CKM_PBE_SHA1_RC4_128 (0x3a6UL) 614 #define CKM_PBE_SHA1_RC4_40 (0x3a7UL) 615 #define CKM_PBE_SHA1_DES3_EDE_CBC (0x3a8UL) 616 #define CKM_PBE_SHA1_DES2_EDE_CBC (0x3a9UL) 617 #define CKM_PBE_SHA1_RC2_128_CBC (0x3aaUL) 618 #define CKM_PBE_SHA1_RC2_40_CBC (0x3abUL) 619 #define CKM_PKCS5_PBKD2 (0x3b0UL) 620 #define CKM_PBA_SHA1_WITH_SHA1_HMAC (0x3c0UL) 621 #define CKM_KEY_WRAP_LYNKS (0x400UL) 622 #define CKM_KEY_WRAP_SET_OAEP (0x401UL) 623 #define CKM_SKIPJACK_KEY_GEN (0x1000UL) 624 #define CKM_SKIPJACK_ECB64 (0x1001UL) 625 #define CKM_SKIPJACK_CBC64 (0x1002UL) 626 #define CKM_SKIPJACK_OFB64 (0x1003UL) 627 #define CKM_SKIPJACK_CFB64 (0x1004UL) 628 #define CKM_SKIPJACK_CFB32 (0x1005UL) 629 #define CKM_SKIPJACK_CFB16 (0x1006UL) 630 #define CKM_SKIPJACK_CFB8 (0x1007UL) 631 #define CKM_SKIPJACK_WRAP (0x1008UL) 632 #define CKM_SKIPJACK_PRIVATE_WRAP (0x1009UL) 633 #define CKM_SKIPJACK_RELAYX (0x100aUL) 634 #define CKM_KEA_KEY_PAIR_GEN (0x1010UL) 635 #define CKM_KEA_KEY_DERIVE (0x1011UL) 636 #define CKM_FORTEZZA_TIMESTAMP (0x1020UL) 637 #define CKM_BATON_KEY_GEN (0x1030UL) 638 #define CKM_BATON_ECB128 (0x1031UL) 639 #define CKM_BATON_ECB96 (0x1032UL) 640 #define CKM_BATON_CBC128 (0x1033UL) 641 #define CKM_BATON_COUNTER (0x1034UL) 642 #define CKM_BATON_SHUFFLE (0x1035UL) 643 #define CKM_BATON_WRAP (0x1036UL) 644 #define CKM_ECDSA_KEY_PAIR_GEN (0x1040UL) 645 #define CKM_EC_KEY_PAIR_GEN (0x1040UL) 646 #define CKM_ECDSA (0x1041UL) 647 #define CKM_ECDSA_SHA1 (0x1042UL) 648 #define CKM_ECDSA_SHA224 (0x1043UL) 649 #define CKM_ECDSA_SHA256 (0x1044UL) 650 #define CKM_ECDSA_SHA384 (0x1045UL) 651 #define CKM_ECDSA_SHA512 (0x1046UL) 652 #define CKM_ECDH1_DERIVE (0x1050UL) 653 #define CKM_ECDH1_COFACTOR_DERIVE (0x1051UL) 654 #define CKM_ECMQV_DERIVE (0x1052UL) 655 #define CKM_JUNIPER_KEY_GEN (0x1060UL) 656 #define CKM_JUNIPER_ECB128 (0x1061UL) 657 #define CKM_JUNIPER_CBC128 (0x1062UL) 658 #define CKM_JUNIPER_COUNTER (0x1063UL) 659 #define CKM_JUNIPER_SHUFFLE (0x1064UL) 660 #define CKM_JUNIPER_WRAP (0x1065UL) 661 #define CKM_FASTHASH (0x1070UL) 662 #define CKM_AES_KEY_GEN (0x1080UL) 663 #define CKM_AES_ECB (0x1081UL) 664 #define CKM_AES_CBC (0x1082UL) 665 #define CKM_AES_MAC (0x1083UL) 666 #define CKM_AES_MAC_GENERAL (0x1084UL) 667 #define CKM_AES_CBC_PAD (0x1085UL) 668 #define CKM_AES_CTR (0x1086UL) 669 #define CKM_AES_GCM (0x1087UL) 670 #define CKM_AES_CCM (0x1088UL) 671 #define CKM_AES_CTS (0x1089UL) 672 #define CKM_BLOWFISH_KEY_GEN (0x1090UL) 673 #define CKM_BLOWFISH_CBC (0x1091UL) 674 #define CKM_TWOFISH_KEY_GEN (0x1092UL) 675 #define CKM_TWOFISH_CBC (0x1093UL) 676 #define CKM_GOSTR3410_KEY_PAIR_GEN (0x1200UL) 677 #define CKM_GOSTR3410 (0x1201UL) 678 #define CKM_GOSTR3410_WITH_GOSTR3411 (0x1202UL) 679 #define CKM_GOSTR3410_KEY_WRAP (0x1203UL) 680 #define CKM_GOSTR3410_DERIVE (0x1204UL) 681 #define CKM_GOSTR3411 (0x1210UL) 682 #define CKM_GOSTR3411_HMAC (0x1211UL) 683 #define CKM_GOST28147_KEY_GEN (0x1220UL) 684 #define CKM_GOST28147_ECB (0x1221UL) 685 #define CKM_GOST28147 (0x1222UL) 686 #define CKM_GOST28147_MAC (0x1223UL) 687 #define CKM_GOST28147_KEY_WRAP (0x1224UL) 688 689 #define CKM_DSA_PARAMETER_GEN (0x2000UL) 690 #define CKM_DH_PKCS_PARAMETER_GEN (0x2001UL) 691 #define CKM_X9_42_DH_PARAMETER_GEN (0x2002UL) 692 #define CKM_VENDOR_DEFINED (1UL << 31) 693 694 struct ck_mechanism { 695 ck_mechanism_type_t mechanism; 696 void *parameter; 697 unsigned long parameter_len; 698 }; 699 700 struct ck_mechanism_info { 701 unsigned long min_key_size; 702 unsigned long max_key_size; 703 ck_flags_t flags; 704 }; 705 706 #define CKF_HW (1UL << 0) 707 #define CKF_ENCRYPT (1UL << 8) 708 #define CKF_DECRYPT (1UL << 9) 709 #define CKF_DIGEST (1UL << 10) 710 #define CKF_SIGN (1UL << 11) 711 #define CKF_SIGN_RECOVER (1UL << 12) 712 #define CKF_VERIFY (1UL << 13) 713 #define CKF_VERIFY_RECOVER (1UL << 14) 714 #define CKF_GENERATE (1UL << 15) 715 #define CKF_GENERATE_KEY_PAIR (1UL << 16) 716 #define CKF_WRAP (1UL << 17) 717 #define CKF_UNWRAP (1UL << 18) 718 #define CKF_DERIVE (1UL << 19) 719 #define CKF_EXTENSION (1UL << 31) 720 721 #define CKF_EC_F_P (1UL << 20) 722 #define CKF_EC_F_2M (1UL << 21) 723 #define CKF_EC_ECPARAMETERS (1UL << 22) 724 #define CKF_EC_NAMEDCURVE (1UL << 23) 725 #define CKF_EC_UNCOMPRESS (1UL << 24) 726 #define CKF_EC_COMPRESS (1UL << 25) 727 728 /* Flags for C_WaitForSlotEvent. */ 729 #define CKF_DONT_BLOCK (1UL) 730 731 /* Flags for Key derivation */ 732 #define CKD_NULL (1UL << 0) 733 734 typedef struct CK_ECDH1_DERIVE_PARAMS { 735 unsigned long kdf; 736 unsigned long ulSharedDataLen; 737 unsigned char *pSharedData; 738 unsigned long ulPublicDataLen; 739 unsigned char *pPublicData; 740 } CK_ECDH1_DERIVE_PARAMS; 741 742 typedef unsigned long CK_RSA_PKCS_MGF_TYPE; 743 744 #define CKG_MGF1_SHA1 0x00000001UL 745 #define CKG_MGF1_SHA224 0x00000005UL 746 #define CKG_MGF1_SHA256 0x00000002UL 747 #define CKG_MGF1_SHA384 0x00000003UL 748 #define CKG_MGF1_SHA512 0x00000004UL 749 750 typedef unsigned long CK_RSA_PKCS_OAEP_SOURCE_TYPE; 751 752 #define CKZ_DATA_SPECIFIED (1UL << 0) 753 754 typedef struct CK_RSA_PKCS_OAEP_PARAMS { 755 CK_MECHANISM_TYPE hashAlg; 756 CK_RSA_PKCS_MGF_TYPE mgf; 757 CK_RSA_PKCS_OAEP_SOURCE_TYPE source; 758 void *pSourceData; 759 unsigned long ulSourceDataLen; 760 } CK_RSA_PKCS_OAEP_PARAMS; 761 762 typedef struct CK_RSA_PKCS_PSS_PARAMS { 763 CK_MECHANISM_TYPE hashAlg; 764 CK_RSA_PKCS_MGF_TYPE mgf; 765 unsigned long sLen; 766 } CK_RSA_PKCS_PSS_PARAMS; 767 768 typedef unsigned long ck_rv_t; 769 770 typedef ck_rv_t (*ck_notify_t)(ck_session_handle_t session, 771 ck_notification_t event, void *application); 772 773 /* Forward reference. */ 774 struct ck_function_list; 775 776 #define _CK_DECLARE_FUNCTION(name, args) \ 777 typedef ck_rv_t(*CK_##name) args; \ 778 ck_rv_t CK_SPEC name args 779 780 _CK_DECLARE_FUNCTION(C_Initialize, (void *init_args)); 781 _CK_DECLARE_FUNCTION(C_Finalize, (void *reserved)); 782 _CK_DECLARE_FUNCTION(C_GetInfo, (struct ck_info * info)); 783 _CK_DECLARE_FUNCTION(C_GetFunctionList, 784 (struct ck_function_list * *function_list)); 785 786 _CK_DECLARE_FUNCTION(C_GetSlotList, 787 (unsigned char token_present, ck_slot_id_t *slot_list, 788 unsigned long *count)); 789 _CK_DECLARE_FUNCTION(C_GetSlotInfo, 790 (ck_slot_id_t slot_id, struct ck_slot_info *info)); 791 _CK_DECLARE_FUNCTION(C_GetTokenInfo, 792 (ck_slot_id_t slot_id, struct ck_token_info *info)); 793 _CK_DECLARE_FUNCTION(C_WaitForSlotEvent, 794 (ck_flags_t flags, ck_slot_id_t *slot, void *reserved)); 795 _CK_DECLARE_FUNCTION(C_GetMechanismList, 796 (ck_slot_id_t slot_id, ck_mechanism_type_t *mechanism_list, 797 unsigned long *count)); 798 _CK_DECLARE_FUNCTION(C_GetMechanismInfo, 799 (ck_slot_id_t slot_id, ck_mechanism_type_t type, 800 struct ck_mechanism_info *info)); 801 _CK_DECLARE_FUNCTION(C_InitToken, 802 (ck_slot_id_t slot_id, unsigned char *pin, 803 unsigned long pin_len, unsigned char *label)); 804 _CK_DECLARE_FUNCTION(C_InitPIN, (ck_session_handle_t session, 805 unsigned char *pin, unsigned long pin_len)); 806 _CK_DECLARE_FUNCTION(C_SetPIN, (ck_session_handle_t session, 807 unsigned char *old_pin, unsigned long old_len, 808 unsigned char *new_pin, unsigned long new_len)); 809 810 _CK_DECLARE_FUNCTION(C_OpenSession, 811 (ck_slot_id_t slot_id, ck_flags_t flags, void *application, 812 ck_notify_t notify, ck_session_handle_t *session)); 813 _CK_DECLARE_FUNCTION(C_CloseSession, (ck_session_handle_t session)); 814 _CK_DECLARE_FUNCTION(C_CloseAllSessions, (ck_slot_id_t slot_id)); 815 _CK_DECLARE_FUNCTION(C_GetSessionInfo, (ck_session_handle_t session, 816 struct ck_session_info *info)); 817 _CK_DECLARE_FUNCTION(C_GetOperationState, (ck_session_handle_t session, 818 unsigned char *operation_state, 819 unsigned long *operation_state_len)); 820 _CK_DECLARE_FUNCTION(C_SetOperationState, 821 (ck_session_handle_t session, 822 unsigned char *operation_state, 823 unsigned long operation_state_len, 824 ck_object_handle_t encryption_key, 825 ck_object_handle_t authentiation_key)); 826 _CK_DECLARE_FUNCTION(C_Login, 827 (ck_session_handle_t session, ck_user_type_t user_type, 828 unsigned char *pin, unsigned long pin_len)); 829 _CK_DECLARE_FUNCTION(C_Logout, (ck_session_handle_t session)); 830 831 _CK_DECLARE_FUNCTION(C_CreateObject, 832 (ck_session_handle_t session, struct ck_attribute *templ, 833 unsigned long count, ck_object_handle_t *object)); 834 _CK_DECLARE_FUNCTION(C_CopyObject, 835 (ck_session_handle_t session, ck_object_handle_t object, 836 struct ck_attribute *templ, unsigned long count, 837 ck_object_handle_t *new_object)); 838 _CK_DECLARE_FUNCTION(C_DestroyObject, 839 (ck_session_handle_t session, ck_object_handle_t object)); 840 _CK_DECLARE_FUNCTION(C_GetObjectSize, 841 (ck_session_handle_t session, ck_object_handle_t object, 842 unsigned long *size)); 843 _CK_DECLARE_FUNCTION(C_GetAttributeValue, 844 (ck_session_handle_t session, ck_object_handle_t object, 845 struct ck_attribute *templ, unsigned long count)); 846 _CK_DECLARE_FUNCTION(C_SetAttributeValue, 847 (ck_session_handle_t session, ck_object_handle_t object, 848 struct ck_attribute *templ, unsigned long count)); 849 _CK_DECLARE_FUNCTION(C_FindObjectsInit, 850 (ck_session_handle_t session, struct ck_attribute *templ, 851 unsigned long count)); 852 _CK_DECLARE_FUNCTION(C_FindObjects, 853 (ck_session_handle_t session, ck_object_handle_t *object, 854 unsigned long max_object_count, 855 unsigned long *object_count)); 856 _CK_DECLARE_FUNCTION(C_FindObjectsFinal, (ck_session_handle_t session)); 857 858 _CK_DECLARE_FUNCTION(C_EncryptInit, 859 (ck_session_handle_t session, 860 struct ck_mechanism *mechanism, ck_object_handle_t key)); 861 _CK_DECLARE_FUNCTION(C_Encrypt, 862 (ck_session_handle_t session, unsigned char *data, 863 unsigned long data_len, unsigned char *encrypted_data, 864 unsigned long *encrypted_data_len)); 865 _CK_DECLARE_FUNCTION(C_EncryptUpdate, 866 (ck_session_handle_t session, unsigned char *part, 867 unsigned long part_len, unsigned char *encrypted_part, 868 unsigned long *encrypted_part_len)); 869 _CK_DECLARE_FUNCTION(C_EncryptFinal, (ck_session_handle_t session, 870 unsigned char *last_encrypted_part, 871 unsigned long *last_encrypted_part_len)); 872 873 _CK_DECLARE_FUNCTION(C_DecryptInit, 874 (ck_session_handle_t session, 875 struct ck_mechanism *mechanism, ck_object_handle_t key)); 876 _CK_DECLARE_FUNCTION(C_Decrypt, (ck_session_handle_t session, 877 unsigned char *encrypted_data, 878 unsigned long encrypted_data_len, 879 unsigned char *data, unsigned long *data_len)); 880 _CK_DECLARE_FUNCTION(C_DecryptUpdate, 881 (ck_session_handle_t session, 882 unsigned char *encrypted_part, 883 unsigned long encrypted_part_len, unsigned char *part, 884 unsigned long *part_len)); 885 _CK_DECLARE_FUNCTION(C_DecryptFinal, 886 (ck_session_handle_t session, unsigned char *last_part, 887 unsigned long *last_part_len)); 888 889 _CK_DECLARE_FUNCTION(C_DigestInit, (ck_session_handle_t session, 890 struct ck_mechanism *mechanism)); 891 _CK_DECLARE_FUNCTION(C_Digest, 892 (ck_session_handle_t session, unsigned char *data, 893 unsigned long data_len, unsigned char *digest, 894 unsigned long *digest_len)); 895 _CK_DECLARE_FUNCTION(C_DigestUpdate, 896 (ck_session_handle_t session, unsigned char *part, 897 unsigned long part_len)); 898 _CK_DECLARE_FUNCTION(C_DigestKey, 899 (ck_session_handle_t session, ck_object_handle_t key)); 900 _CK_DECLARE_FUNCTION(C_DigestFinal, 901 (ck_session_handle_t session, unsigned char *digest, 902 unsigned long *digest_len)); 903 904 _CK_DECLARE_FUNCTION(C_SignInit, 905 (ck_session_handle_t session, 906 struct ck_mechanism *mechanism, ck_object_handle_t key)); 907 _CK_DECLARE_FUNCTION(C_Sign, (ck_session_handle_t session, unsigned char *data, 908 unsigned long data_len, unsigned char *signature, 909 unsigned long *signature_len)); 910 _CK_DECLARE_FUNCTION(C_SignUpdate, 911 (ck_session_handle_t session, unsigned char *part, 912 unsigned long part_len)); 913 _CK_DECLARE_FUNCTION(C_SignFinal, 914 (ck_session_handle_t session, unsigned char *signature, 915 unsigned long *signature_len)); 916 _CK_DECLARE_FUNCTION(C_SignRecoverInit, 917 (ck_session_handle_t session, 918 struct ck_mechanism *mechanism, ck_object_handle_t key)); 919 _CK_DECLARE_FUNCTION(C_SignRecover, 920 (ck_session_handle_t session, unsigned char *data, 921 unsigned long data_len, unsigned char *signature, 922 unsigned long *signature_len)); 923 924 _CK_DECLARE_FUNCTION(C_VerifyInit, 925 (ck_session_handle_t session, 926 struct ck_mechanism *mechanism, ck_object_handle_t key)); 927 _CK_DECLARE_FUNCTION(C_Verify, 928 (ck_session_handle_t session, unsigned char *data, 929 unsigned long data_len, unsigned char *signature, 930 unsigned long signature_len)); 931 _CK_DECLARE_FUNCTION(C_VerifyUpdate, 932 (ck_session_handle_t session, unsigned char *part, 933 unsigned long part_len)); 934 _CK_DECLARE_FUNCTION(C_VerifyFinal, 935 (ck_session_handle_t session, unsigned char *signature, 936 unsigned long signature_len)); 937 _CK_DECLARE_FUNCTION(C_VerifyRecoverInit, 938 (ck_session_handle_t session, 939 struct ck_mechanism *mechanism, ck_object_handle_t key)); 940 _CK_DECLARE_FUNCTION(C_VerifyRecover, 941 (ck_session_handle_t session, unsigned char *signature, 942 unsigned long signature_len, unsigned char *data, 943 unsigned long *data_len)); 944 945 _CK_DECLARE_FUNCTION(C_DigestEncryptUpdate, 946 (ck_session_handle_t session, unsigned char *part, 947 unsigned long part_len, unsigned char *encrypted_part, 948 unsigned long *encrypted_part_len)); 949 _CK_DECLARE_FUNCTION(C_DecryptDigestUpdate, 950 (ck_session_handle_t session, 951 unsigned char *encrypted_part, 952 unsigned long encrypted_part_len, unsigned char *part, 953 unsigned long *part_len)); 954 _CK_DECLARE_FUNCTION(C_SignEncryptUpdate, 955 (ck_session_handle_t session, unsigned char *part, 956 unsigned long part_len, unsigned char *encrypted_part, 957 unsigned long *encrypted_part_len)); 958 _CK_DECLARE_FUNCTION(C_DecryptVerifyUpdate, 959 (ck_session_handle_t session, 960 unsigned char *encrypted_part, 961 unsigned long encrypted_part_len, unsigned char *part, 962 unsigned long *part_len)); 963 964 _CK_DECLARE_FUNCTION(C_GenerateKey, 965 (ck_session_handle_t session, 966 struct ck_mechanism *mechanism, 967 struct ck_attribute *templ, unsigned long count, 968 ck_object_handle_t *key)); 969 _CK_DECLARE_FUNCTION(C_GenerateKeyPair, 970 (ck_session_handle_t session, 971 struct ck_mechanism *mechanism, 972 struct ck_attribute *public_key_template, 973 unsigned long public_key_attribute_count, 974 struct ck_attribute *private_key_template, 975 unsigned long private_key_attribute_count, 976 ck_object_handle_t *public_key, 977 ck_object_handle_t *private_key)); 978 _CK_DECLARE_FUNCTION( 979 C_WrapKey, (ck_session_handle_t session, struct ck_mechanism *mechanism, 980 ck_object_handle_t wrapping_key, ck_object_handle_t key, 981 unsigned char *wrapped_key, unsigned long *wrapped_key_len)); 982 _CK_DECLARE_FUNCTION( 983 C_UnwrapKey, (ck_session_handle_t session, struct ck_mechanism *mechanism, 984 ck_object_handle_t unwrapping_key, unsigned char *wrapped_key, 985 unsigned long wrapped_key_len, struct ck_attribute *templ, 986 unsigned long attribute_count, ck_object_handle_t *key)); 987 _CK_DECLARE_FUNCTION(C_DeriveKey, 988 (ck_session_handle_t session, 989 struct ck_mechanism *mechanism, 990 ck_object_handle_t base_key, struct ck_attribute *templ, 991 unsigned long attribute_count, ck_object_handle_t *key)); 992 993 _CK_DECLARE_FUNCTION(C_SeedRandom, 994 (ck_session_handle_t session, unsigned char *seed, 995 unsigned long seed_len)); 996 _CK_DECLARE_FUNCTION(C_GenerateRandom, 997 (ck_session_handle_t session, unsigned char *random_data, 998 unsigned long random_len)); 999 1000 _CK_DECLARE_FUNCTION(C_GetFunctionStatus, (ck_session_handle_t session)); 1001 _CK_DECLARE_FUNCTION(C_CancelFunction, (ck_session_handle_t session)); 1002 1003 struct ck_function_list { 1004 struct ck_version version; 1005 CK_C_Initialize C_Initialize; 1006 CK_C_Finalize C_Finalize; 1007 CK_C_GetInfo C_GetInfo; 1008 CK_C_GetFunctionList C_GetFunctionList; 1009 CK_C_GetSlotList C_GetSlotList; 1010 CK_C_GetSlotInfo C_GetSlotInfo; 1011 CK_C_GetTokenInfo C_GetTokenInfo; 1012 CK_C_GetMechanismList C_GetMechanismList; 1013 CK_C_GetMechanismInfo C_GetMechanismInfo; 1014 CK_C_InitToken C_InitToken; 1015 CK_C_InitPIN C_InitPIN; 1016 CK_C_SetPIN C_SetPIN; 1017 CK_C_OpenSession C_OpenSession; 1018 CK_C_CloseSession C_CloseSession; 1019 CK_C_CloseAllSessions C_CloseAllSessions; 1020 CK_C_GetSessionInfo C_GetSessionInfo; 1021 CK_C_GetOperationState C_GetOperationState; 1022 CK_C_SetOperationState C_SetOperationState; 1023 CK_C_Login C_Login; 1024 CK_C_Logout C_Logout; 1025 CK_C_CreateObject C_CreateObject; 1026 CK_C_CopyObject C_CopyObject; 1027 CK_C_DestroyObject C_DestroyObject; 1028 CK_C_GetObjectSize C_GetObjectSize; 1029 CK_C_GetAttributeValue C_GetAttributeValue; 1030 CK_C_SetAttributeValue C_SetAttributeValue; 1031 CK_C_FindObjectsInit C_FindObjectsInit; 1032 CK_C_FindObjects C_FindObjects; 1033 CK_C_FindObjectsFinal C_FindObjectsFinal; 1034 CK_C_EncryptInit C_EncryptInit; 1035 CK_C_Encrypt C_Encrypt; 1036 CK_C_EncryptUpdate C_EncryptUpdate; 1037 CK_C_EncryptFinal C_EncryptFinal; 1038 CK_C_DecryptInit C_DecryptInit; 1039 CK_C_Decrypt C_Decrypt; 1040 CK_C_DecryptUpdate C_DecryptUpdate; 1041 CK_C_DecryptFinal C_DecryptFinal; 1042 CK_C_DigestInit C_DigestInit; 1043 CK_C_Digest C_Digest; 1044 CK_C_DigestUpdate C_DigestUpdate; 1045 CK_C_DigestKey C_DigestKey; 1046 CK_C_DigestFinal C_DigestFinal; 1047 CK_C_SignInit C_SignInit; 1048 CK_C_Sign C_Sign; 1049 CK_C_SignUpdate C_SignUpdate; 1050 CK_C_SignFinal C_SignFinal; 1051 CK_C_SignRecoverInit C_SignRecoverInit; 1052 CK_C_SignRecover C_SignRecover; 1053 CK_C_VerifyInit C_VerifyInit; 1054 CK_C_Verify C_Verify; 1055 CK_C_VerifyUpdate C_VerifyUpdate; 1056 CK_C_VerifyFinal C_VerifyFinal; 1057 CK_C_VerifyRecoverInit C_VerifyRecoverInit; 1058 CK_C_VerifyRecover C_VerifyRecover; 1059 CK_C_DigestEncryptUpdate C_DigestEncryptUpdate; 1060 CK_C_DecryptDigestUpdate C_DecryptDigestUpdate; 1061 CK_C_SignEncryptUpdate C_SignEncryptUpdate; 1062 CK_C_DecryptVerifyUpdate C_DecryptVerifyUpdate; 1063 CK_C_GenerateKey C_GenerateKey; 1064 CK_C_GenerateKeyPair C_GenerateKeyPair; 1065 CK_C_WrapKey C_WrapKey; 1066 CK_C_UnwrapKey C_UnwrapKey; 1067 CK_C_DeriveKey C_DeriveKey; 1068 CK_C_SeedRandom C_SeedRandom; 1069 CK_C_GenerateRandom C_GenerateRandom; 1070 CK_C_GetFunctionStatus C_GetFunctionStatus; 1071 CK_C_CancelFunction C_CancelFunction; 1072 CK_C_WaitForSlotEvent C_WaitForSlotEvent; 1073 }; 1074 1075 typedef ck_rv_t (*ck_createmutex_t)(void **mutex); 1076 typedef ck_rv_t (*ck_destroymutex_t)(void *mutex); 1077 typedef ck_rv_t (*ck_lockmutex_t)(void *mutex); 1078 typedef ck_rv_t (*ck_unlockmutex_t)(void *mutex); 1079 1080 struct ck_c_initialize_args { 1081 ck_createmutex_t create_mutex; 1082 ck_destroymutex_t destroy_mutex; 1083 ck_lockmutex_t lock_mutex; 1084 ck_unlockmutex_t unlock_mutex; 1085 ck_flags_t flags; 1086 void *reserved; 1087 }; 1088 1089 #define CKF_LIBRARY_CANT_CREATE_OS_THREADS (1UL << 0) 1090 #define CKF_OS_LOCKING_OK (1UL << 1) 1091 1092 #define CKR_OK (0UL) 1093 #define CKR_CANCEL (1UL) 1094 #define CKR_HOST_MEMORY (2UL) 1095 #define CKR_SLOT_ID_INVALID (3UL) 1096 #define CKR_GENERAL_ERROR (5UL) 1097 #define CKR_FUNCTION_FAILED (6UL) 1098 #define CKR_ARGUMENTS_BAD (7UL) 1099 #define CKR_NO_EVENT (8UL) 1100 #define CKR_NEED_TO_CREATE_THREADS (9UL) 1101 #define CKR_CANT_LOCK (0xaUL) 1102 #define CKR_ATTRIBUTE_READ_ONLY (0x10UL) 1103 #define CKR_ATTRIBUTE_SENSITIVE (0x11UL) 1104 #define CKR_ATTRIBUTE_TYPE_INVALID (0x12UL) 1105 #define CKR_ATTRIBUTE_VALUE_INVALID (0x13UL) 1106 #define CKR_DATA_INVALID (0x20UL) 1107 #define CKR_DATA_LEN_RANGE (0x21UL) 1108 #define CKR_DEVICE_ERROR (0x30UL) 1109 #define CKR_DEVICE_MEMORY (0x31UL) 1110 #define CKR_DEVICE_REMOVED (0x32UL) 1111 #define CKR_ENCRYPTED_DATA_INVALID (0x40UL) 1112 #define CKR_ENCRYPTED_DATA_LEN_RANGE (0x41UL) 1113 #define CKR_FUNCTION_CANCELED (0x50UL) 1114 #define CKR_FUNCTION_NOT_PARALLEL (0x51UL) 1115 #define CKR_FUNCTION_NOT_SUPPORTED (0x54UL) 1116 #define CKR_KEY_HANDLE_INVALID (0x60UL) 1117 #define CKR_KEY_SIZE_RANGE (0x62UL) 1118 #define CKR_KEY_TYPE_INCONSISTENT (0x63UL) 1119 #define CKR_KEY_NOT_NEEDED (0x64UL) 1120 #define CKR_KEY_CHANGED (0x65UL) 1121 #define CKR_KEY_NEEDED (0x66UL) 1122 #define CKR_KEY_INDIGESTIBLE (0x67UL) 1123 #define CKR_KEY_FUNCTION_NOT_PERMITTED (0x68UL) 1124 #define CKR_KEY_NOT_WRAPPABLE (0x69UL) 1125 #define CKR_KEY_UNEXTRACTABLE (0x6aUL) 1126 #define CKR_MECHANISM_INVALID (0x70UL) 1127 #define CKR_MECHANISM_PARAM_INVALID (0x71UL) 1128 #define CKR_OBJECT_HANDLE_INVALID (0x82UL) 1129 #define CKR_OPERATION_ACTIVE (0x90UL) 1130 #define CKR_OPERATION_NOT_INITIALIZED (0x91UL) 1131 #define CKR_PIN_INCORRECT (0xa0UL) 1132 #define CKR_PIN_INVALID (0xa1UL) 1133 #define CKR_PIN_LEN_RANGE (0xa2UL) 1134 #define CKR_PIN_EXPIRED (0xa3UL) 1135 #define CKR_PIN_LOCKED (0xa4UL) 1136 #define CKR_SESSION_CLOSED (0xb0UL) 1137 #define CKR_SESSION_COUNT (0xb1UL) 1138 #define CKR_SESSION_HANDLE_INVALID (0xb3UL) 1139 #define CKR_SESSION_PARALLEL_NOT_SUPPORTED (0xb4UL) 1140 #define CKR_SESSION_READ_ONLY (0xb5UL) 1141 #define CKR_SESSION_EXISTS (0xb6UL) 1142 #define CKR_SESSION_READ_ONLY_EXISTS (0xb7UL) 1143 #define CKR_SESSION_READ_WRITE_SO_EXISTS (0xb8UL) 1144 #define CKR_SIGNATURE_INVALID (0xc0UL) 1145 #define CKR_SIGNATURE_LEN_RANGE (0xc1UL) 1146 #define CKR_TEMPLATE_INCOMPLETE (0xd0UL) 1147 #define CKR_TEMPLATE_INCONSISTENT (0xd1UL) 1148 #define CKR_TOKEN_NOT_PRESENT (0xe0UL) 1149 #define CKR_TOKEN_NOT_RECOGNIZED (0xe1UL) 1150 #define CKR_TOKEN_WRITE_PROTECTED (0xe2UL) 1151 #define CKR_UNWRAPPING_KEY_HANDLE_INVALID (0xf0UL) 1152 #define CKR_UNWRAPPING_KEY_SIZE_RANGE (0xf1UL) 1153 #define CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT (0xf2UL) 1154 #define CKR_USER_ALREADY_LOGGED_IN (0x100UL) 1155 #define CKR_USER_NOT_LOGGED_IN (0x101UL) 1156 #define CKR_USER_PIN_NOT_INITIALIZED (0x102UL) 1157 #define CKR_USER_TYPE_INVALID (0x103UL) 1158 #define CKR_USER_ANOTHER_ALREADY_LOGGED_IN (0x104UL) 1159 #define CKR_USER_TOO_MANY_TYPES (0x105UL) 1160 #define CKR_WRAPPED_KEY_INVALID (0x110UL) 1161 #define CKR_WRAPPED_KEY_LEN_RANGE (0x112UL) 1162 #define CKR_WRAPPING_KEY_HANDLE_INVALID (0x113UL) 1163 #define CKR_WRAPPING_KEY_SIZE_RANGE (0x114UL) 1164 #define CKR_WRAPPING_KEY_TYPE_INCONSISTENT (0x115UL) 1165 #define CKR_RANDOM_SEED_NOT_SUPPORTED (0x120UL) 1166 #define CKR_RANDOM_NO_RNG (0x121UL) 1167 #define CKR_DOMAIN_PARAMS_INVALID (0x130UL) 1168 #define CKR_CURVE_NOT_SUPPORTED (0x140UL) 1169 #define CKR_BUFFER_TOO_SMALL (0x150UL) 1170 #define CKR_SAVED_STATE_INVALID (0x160UL) 1171 #define CKR_INFORMATION_SENSITIVE (0x170UL) 1172 #define CKR_STATE_UNSAVEABLE (0x180UL) 1173 #define CKR_CRYPTOKI_NOT_INITIALIZED (0x190UL) 1174 #define CKR_CRYPTOKI_ALREADY_INITIALIZED (0x191UL) 1175 #define CKR_MUTEX_BAD (0x1a0UL) 1176 #define CKR_MUTEX_NOT_LOCKED (0x1a1UL) 1177 #define CKR_FUNCTION_REJECTED (0x200UL) 1178 #define CKR_VENDOR_DEFINED (1UL << 31) 1179 1180 /* Compatibility layer. */ 1181 1182 #ifdef CRYPTOKI_COMPAT 1183 1184 #undef CK_DEFINE_FUNCTION 1185 #define CK_DEFINE_FUNCTION(retval, name) retval CK_SPEC name 1186 1187 /* For NULL. */ 1188 #include <stddef.h> 1189 1190 typedef unsigned char CK_BYTE; 1191 typedef unsigned char CK_CHAR; 1192 typedef unsigned char CK_UTF8CHAR; 1193 typedef unsigned char CK_BBOOL; 1194 typedef unsigned long int CK_ULONG; 1195 typedef long int CK_LONG; 1196 typedef CK_BYTE *CK_BYTE_PTR; 1197 typedef CK_CHAR *CK_CHAR_PTR; 1198 typedef CK_UTF8CHAR *CK_UTF8CHAR_PTR; 1199 typedef CK_ULONG *CK_ULONG_PTR; 1200 typedef void *CK_VOID_PTR; 1201 typedef void **CK_VOID_PTR_PTR; 1202 #define CK_FALSE 0 1203 #define CK_TRUE 1 1204 #ifndef CK_DISABLE_TRUE_FALSE 1205 #ifndef FALSE 1206 #define FALSE 0 1207 #endif 1208 #ifndef TRUE 1209 #define TRUE 1 1210 #endif 1211 #endif 1212 1213 typedef struct ck_version CK_VERSION; 1214 typedef struct ck_version *CK_VERSION_PTR; 1215 1216 typedef struct ck_info CK_INFO; 1217 typedef struct ck_info *CK_INFO_PTR; 1218 1219 typedef ck_slot_id_t *CK_SLOT_ID_PTR; 1220 1221 typedef struct ck_slot_info CK_SLOT_INFO; 1222 typedef struct ck_slot_info *CK_SLOT_INFO_PTR; 1223 1224 typedef struct ck_token_info CK_TOKEN_INFO; 1225 typedef struct ck_token_info *CK_TOKEN_INFO_PTR; 1226 1227 typedef ck_session_handle_t *CK_SESSION_HANDLE_PTR; 1228 1229 typedef struct ck_session_info CK_SESSION_INFO; 1230 typedef struct ck_session_info *CK_SESSION_INFO_PTR; 1231 1232 typedef ck_object_handle_t *CK_OBJECT_HANDLE_PTR; 1233 1234 typedef ck_object_class_t *CK_OBJECT_CLASS_PTR; 1235 1236 typedef struct ck_attribute CK_ATTRIBUTE; 1237 typedef struct ck_attribute *CK_ATTRIBUTE_PTR; 1238 1239 typedef struct ck_date CK_DATE; 1240 typedef struct ck_date *CK_DATE_PTR; 1241 1242 typedef ck_mechanism_type_t *CK_MECHANISM_TYPE_PTR; 1243 1244 typedef struct ck_mechanism CK_MECHANISM; 1245 typedef struct ck_mechanism *CK_MECHANISM_PTR; 1246 1247 typedef struct ck_mechanism_info CK_MECHANISM_INFO; 1248 typedef struct ck_mechanism_info *CK_MECHANISM_INFO_PTR; 1249 1250 typedef struct ck_function_list CK_FUNCTION_LIST; 1251 typedef struct ck_function_list *CK_FUNCTION_LIST_PTR; 1252 typedef struct ck_function_list **CK_FUNCTION_LIST_PTR_PTR; 1253 1254 typedef struct ck_c_initialize_args CK_C_INITIALIZE_ARGS; 1255 typedef struct ck_c_initialize_args *CK_C_INITIALIZE_ARGS_PTR; 1256 1257 #define NULL_PTR NULL 1258 1259 /* Delete the helper macros defined at the top of the file. */ 1260 #undef ck_flags_t 1261 #undef ck_version 1262 1263 #undef ck_info 1264 #undef cryptoki_version 1265 #undef manufacturer_id 1266 #undef library_description 1267 #undef library_version 1268 1269 #undef ck_notification_t 1270 #undef ck_slot_id_t 1271 1272 #undef ck_slot_info 1273 #undef slot_description 1274 #undef hardware_version 1275 #undef firmware_version 1276 1277 #undef ck_token_info 1278 #undef serial_number 1279 #undef max_session_count 1280 #undef session_count 1281 #undef max_rw_session_count 1282 #undef rw_session_count 1283 #undef max_pin_len 1284 #undef min_pin_len 1285 #undef total_public_memory 1286 #undef free_public_memory 1287 #undef total_private_memory 1288 #undef free_private_memory 1289 #undef utc_time 1290 1291 #undef ck_session_handle_t 1292 #undef ck_user_type_t 1293 #undef ck_state_t 1294 1295 #undef ck_session_info 1296 #undef slot_id 1297 #undef device_error 1298 1299 #undef ck_object_handle_t 1300 #undef ck_object_class_t 1301 #undef ck_hw_feature_type_t 1302 #undef ck_key_type_t 1303 #undef ck_certificate_type_t 1304 #undef ck_attribute_type_t 1305 1306 #undef ck_attribute 1307 #undef value 1308 #undef value_len 1309 1310 #undef ck_date 1311 1312 #undef ck_mechanism_type_t 1313 1314 #undef ck_mechanism 1315 #undef parameter 1316 #undef parameter_len 1317 1318 #undef ck_mechanism_info 1319 #undef min_key_size 1320 #undef max_key_size 1321 1322 #undef ck_rv_t 1323 #undef ck_notify_t 1324 1325 #undef ck_function_list 1326 1327 #undef ck_createmutex_t 1328 #undef ck_destroymutex_t 1329 #undef ck_lockmutex_t 1330 #undef ck_unlockmutex_t 1331 1332 #undef ck_c_initialize_args 1333 #undef create_mutex 1334 #undef destroy_mutex 1335 #undef lock_mutex 1336 #undef unlock_mutex 1337 #undef reserved 1338 1339 #endif /* CRYPTOKI_COMPAT */ 1340 1341 /* System dependencies. */ 1342 #if defined(_WIN32) || defined(CRYPTOKI_FORCE_WIN32) 1343 #pragma pack(pop, cryptoki) 1344 #endif 1345 1346 #if defined(__cplusplus) 1347 } 1348 #endif 1349 1350 #endif /* PKCS11_H */ 1351