1 /* $NetBSD: pkcs11.h,v 1.1.1.1 2011/04/13 18:15:28 elric Exp $ */ 2 3 /* pkcs11.h 4 Copyright 2006, 2007 g10 Code GmbH 5 Copyright 2006 Andreas Jellinghaus 6 7 This file is free software; as a special exception the author gives 8 unlimited permission to copy and/or distribute it, with or without 9 modifications, as long as this notice is preserved. 10 11 This file is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY, to the extent permitted by law; without even 13 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 14 PURPOSE. */ 15 16 /* Please submit changes back to the Scute project at 17 http://www.scute.org/ (or send them to marcus@g10code.com), so that 18 they can be picked up by other projects from there as well. */ 19 20 /* This file is a modified implementation of the PKCS #11 standard by 21 RSA Security Inc. It is mostly a drop-in replacement, with the 22 following change: 23 24 This header file does not require any macro definitions by the user 25 (like CK_DEFINE_FUNCTION etc). In fact, it defines those macros 26 for you (if useful, some are missing, let me know if you need 27 more). 28 29 There is an additional API available that does comply better to the 30 GNU coding standard. It can be switched on by defining 31 CRYPTOKI_GNU before including this header file. For this, the 32 following changes are made to the specification: 33 34 All structure types are changed to a "struct ck_foo" where CK_FOO 35 is the type name in PKCS #11. 36 37 All non-structure types are changed to ck_foo_t where CK_FOO is the 38 lowercase version of the type name in PKCS #11. The basic types 39 (CK_ULONG et al.) are removed without substitute. 40 41 All members of structures are modified in the following way: Type 42 indication prefixes are removed, and underscore characters are 43 inserted before words. Then the result is lowercased. 44 45 Note that function names are still in the original case, as they 46 need for ABI compatibility. 47 48 CK_FALSE, CK_TRUE and NULL_PTR are removed without substitute. Use 49 <stdbool.h>. 50 51 If CRYPTOKI_COMPAT is defined before including this header file, 52 then none of the API changes above take place, and the API is the 53 one defined by the PKCS #11 standard. */ 54 55 #ifndef PKCS11_H 56 #define PKCS11_H 1 57 58 #if defined(__cplusplus) 59 extern "C" { 60 #endif 61 62 63 /* The version of cryptoki we implement. The revision is changed with 64 each modification of this file. If you do not use the "official" 65 version of this file, please consider deleting the revision macro 66 (you may use a macro with a different name to keep track of your 67 versions). */ 68 #define CRYPTOKI_VERSION_MAJOR 2 69 #define CRYPTOKI_VERSION_MINOR 20 70 #define CRYPTOKI_VERSION_REVISION 6 71 72 73 /* Compatibility interface is default, unless CRYPTOKI_GNU is 74 given. */ 75 #ifndef CRYPTOKI_GNU 76 #ifndef CRYPTOKI_COMPAT 77 #define CRYPTOKI_COMPAT 1 78 #endif 79 #endif 80 81 /* System dependencies. */ 82 83 #if defined(_WIN32) || defined(CRYPTOKI_FORCE_WIN32) 84 85 /* There is a matching pop below. */ 86 #pragma pack(push, cryptoki, 1) 87 88 #ifdef CRYPTOKI_EXPORTS 89 #define CK_SPEC __declspec(dllexport) 90 #else 91 #define CK_SPEC __declspec(dllimport) 92 #endif 93 94 #else 95 96 #define CK_SPEC 97 98 #endif 99 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_mechanism _CK_MECHANISM 160 #define parameter pParameter 161 #define parameter_len ulParameterLen 162 163 #define ck_mechanism_info _CK_MECHANISM_INFO 164 #define min_key_size ulMinKeySize 165 #define max_key_size ulMaxKeySize 166 167 #define ck_rv_t CK_RV 168 #define ck_notify_t CK_NOTIFY 169 170 #define ck_function_list _CK_FUNCTION_LIST 171 172 #define ck_createmutex_t CK_CREATEMUTEX 173 #define ck_destroymutex_t CK_DESTROYMUTEX 174 #define ck_lockmutex_t CK_LOCKMUTEX 175 #define ck_unlockmutex_t CK_UNLOCKMUTEX 176 177 #define ck_c_initialize_args _CK_C_INITIALIZE_ARGS 178 #define create_mutex CreateMutex 179 #define destroy_mutex DestroyMutex 180 #define lock_mutex LockMutex 181 #define unlock_mutex UnlockMutex 182 #define reserved pReserved 183 184 #endif /* CRYPTOKI_COMPAT */ 185 186 187 188 typedef unsigned long ck_flags_t; 189 190 struct ck_version 191 { 192 unsigned char major; 193 unsigned char minor; 194 }; 195 196 197 struct ck_info 198 { 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 207 typedef unsigned long ck_notification_t; 208 209 #define CKN_SURRENDER (0) 210 211 212 typedef unsigned long ck_slot_id_t; 213 214 215 struct ck_slot_info 216 { 217 unsigned char slot_description[64]; 218 unsigned char manufacturer_id[32]; 219 ck_flags_t flags; 220 struct ck_version hardware_version; 221 struct ck_version firmware_version; 222 }; 223 224 225 #define CKF_TOKEN_PRESENT (1 << 0) 226 #define CKF_REMOVABLE_DEVICE (1 << 1) 227 #define CKF_HW_SLOT (1 << 2) 228 #define CKF_ARRAY_ATTRIBUTE (1 << 30) 229 230 231 struct ck_token_info 232 { 233 unsigned char label[32]; 234 unsigned char manufacturer_id[32]; 235 unsigned char model[16]; 236 unsigned char serial_number[16]; 237 ck_flags_t flags; 238 unsigned long max_session_count; 239 unsigned long session_count; 240 unsigned long max_rw_session_count; 241 unsigned long rw_session_count; 242 unsigned long max_pin_len; 243 unsigned long min_pin_len; 244 unsigned long total_public_memory; 245 unsigned long free_public_memory; 246 unsigned long total_private_memory; 247 unsigned long free_private_memory; 248 struct ck_version hardware_version; 249 struct ck_version firmware_version; 250 unsigned char utc_time[16]; 251 }; 252 253 254 #define CKF_RNG (1 << 0) 255 #define CKF_WRITE_PROTECTED (1 << 1) 256 #define CKF_LOGIN_REQUIRED (1 << 2) 257 #define CKF_USER_PIN_INITIALIZED (1 << 3) 258 #define CKF_RESTORE_KEY_NOT_NEEDED (1 << 5) 259 #define CKF_CLOCK_ON_TOKEN (1 << 6) 260 #define CKF_PROTECTED_AUTHENTICATION_PATH (1 << 8) 261 #define CKF_DUAL_CRYPTO_OPERATIONS (1 << 9) 262 #define CKF_TOKEN_INITIALIZED (1 << 10) 263 #define CKF_SECONDARY_AUTHENTICATION (1 << 11) 264 #define CKF_USER_PIN_COUNT_LOW (1 << 16) 265 #define CKF_USER_PIN_FINAL_TRY (1 << 17) 266 #define CKF_USER_PIN_LOCKED (1 << 18) 267 #define CKF_USER_PIN_TO_BE_CHANGED (1 << 19) 268 #define CKF_SO_PIN_COUNT_LOW (1 << 20) 269 #define CKF_SO_PIN_FINAL_TRY (1 << 21) 270 #define CKF_SO_PIN_LOCKED (1 << 22) 271 #define CKF_SO_PIN_TO_BE_CHANGED (1 << 23) 272 273 #define CK_UNAVAILABLE_INFORMATION ((unsigned long) -1) 274 #define CK_EFFECTIVELY_INFINITE (0) 275 276 277 typedef unsigned long ck_session_handle_t; 278 279 #define CK_INVALID_HANDLE (0) 280 281 282 typedef unsigned long ck_user_type_t; 283 284 #define CKU_SO (0) 285 #define CKU_USER (1) 286 #define CKU_CONTEXT_SPECIFIC (2) 287 288 289 typedef unsigned long ck_state_t; 290 291 #define CKS_RO_PUBLIC_SESSION (0) 292 #define CKS_RO_USER_FUNCTIONS (1) 293 #define CKS_RW_PUBLIC_SESSION (2) 294 #define CKS_RW_USER_FUNCTIONS (3) 295 #define CKS_RW_SO_FUNCTIONS (4) 296 297 298 struct ck_session_info 299 { 300 ck_slot_id_t slot_id; 301 ck_state_t state; 302 ck_flags_t flags; 303 unsigned long device_error; 304 }; 305 306 #define CKF_RW_SESSION (1 << 1) 307 #define CKF_SERIAL_SESSION (1 << 2) 308 309 310 typedef unsigned long ck_object_handle_t; 311 312 313 typedef unsigned long ck_object_class_t; 314 315 #define CKO_DATA (0) 316 #define CKO_CERTIFICATE (1) 317 #define CKO_PUBLIC_KEY (2) 318 #define CKO_PRIVATE_KEY (3) 319 #define CKO_SECRET_KEY (4) 320 #define CKO_HW_FEATURE (5) 321 #define CKO_DOMAIN_PARAMETERS (6) 322 #define CKO_MECHANISM (7) 323 #define CKO_VENDOR_DEFINED ((unsigned long) (1 << 31)) 324 325 326 typedef unsigned long ck_hw_feature_type_t; 327 328 #define CKH_MONOTONIC_COUNTER (1) 329 #define CKH_CLOCK (2) 330 #define CKH_USER_INTERFACE (3) 331 #define CKH_VENDOR_DEFINED ((unsigned long) (1 << 31)) 332 333 334 typedef unsigned long ck_key_type_t; 335 336 #define CKK_RSA (0) 337 #define CKK_DSA (1) 338 #define CKK_DH (2) 339 #define CKK_ECDSA (3) 340 #define CKK_EC (3) 341 #define CKK_X9_42_DH (4) 342 #define CKK_KEA (5) 343 #define CKK_GENERIC_SECRET (0x10) 344 #define CKK_RC2 (0x11) 345 #define CKK_RC4 (0x12) 346 #define CKK_DES (0x13) 347 #define CKK_DES2 (0x14) 348 #define CKK_DES3 (0x15) 349 #define CKK_CAST (0x16) 350 #define CKK_CAST3 (0x17) 351 #define CKK_CAST128 (0x18) 352 #define CKK_RC5 (0x19) 353 #define CKK_IDEA (0x1a) 354 #define CKK_SKIPJACK (0x1b) 355 #define CKK_BATON (0x1c) 356 #define CKK_JUNIPER (0x1d) 357 #define CKK_CDMF (0x1e) 358 #define CKK_AES (0x1f) 359 #define CKK_BLOWFISH (0x20) 360 #define CKK_TWOFISH (0x21) 361 #define CKK_VENDOR_DEFINED ((unsigned long) (1 << 31)) 362 363 364 typedef unsigned long ck_certificate_type_t; 365 366 #define CKC_X_509 (0) 367 #define CKC_X_509_ATTR_CERT (1) 368 #define CKC_WTLS (2) 369 #define CKC_VENDOR_DEFINED ((unsigned long) (1 << 31)) 370 371 372 typedef unsigned long ck_attribute_type_t; 373 374 #define CKA_CLASS (0) 375 #define CKA_TOKEN (1) 376 #define CKA_PRIVATE (2) 377 #define CKA_LABEL (3) 378 #define CKA_APPLICATION (0x10) 379 #define CKA_VALUE (0x11) 380 #define CKA_OBJECT_ID (0x12) 381 #define CKA_CERTIFICATE_TYPE (0x80) 382 #define CKA_ISSUER (0x81) 383 #define CKA_SERIAL_NUMBER (0x82) 384 #define CKA_AC_ISSUER (0x83) 385 #define CKA_OWNER (0x84) 386 #define CKA_ATTR_TYPES (0x85) 387 #define CKA_TRUSTED (0x86) 388 #define CKA_CERTIFICATE_CATEGORY (0x87) 389 #define CKA_JAVA_MIDP_SECURITY_DOMAIN (0x88) 390 #define CKA_URL (0x89) 391 #define CKA_HASH_OF_SUBJECT_PUBLIC_KEY (0x8a) 392 #define CKA_HASH_OF_ISSUER_PUBLIC_KEY (0x8b) 393 #define CKA_CHECK_VALUE (0x90) 394 #define CKA_KEY_TYPE (0x100) 395 #define CKA_SUBJECT (0x101) 396 #define CKA_ID (0x102) 397 #define CKA_SENSITIVE (0x103) 398 #define CKA_ENCRYPT (0x104) 399 #define CKA_DECRYPT (0x105) 400 #define CKA_WRAP (0x106) 401 #define CKA_UNWRAP (0x107) 402 #define CKA_SIGN (0x108) 403 #define CKA_SIGN_RECOVER (0x109) 404 #define CKA_VERIFY (0x10a) 405 #define CKA_VERIFY_RECOVER (0x10b) 406 #define CKA_DERIVE (0x10c) 407 #define CKA_START_DATE (0x110) 408 #define CKA_END_DATE (0x111) 409 #define CKA_MODULUS (0x120) 410 #define CKA_MODULUS_BITS (0x121) 411 #define CKA_PUBLIC_EXPONENT (0x122) 412 #define CKA_PRIVATE_EXPONENT (0x123) 413 #define CKA_PRIME_1 (0x124) 414 #define CKA_PRIME_2 (0x125) 415 #define CKA_EXPONENT_1 (0x126) 416 #define CKA_EXPONENT_2 (0x127) 417 #define CKA_COEFFICIENT (0x128) 418 #define CKA_PRIME (0x130) 419 #define CKA_SUBPRIME (0x131) 420 #define CKA_BASE (0x132) 421 #define CKA_PRIME_BITS (0x133) 422 #define CKA_SUB_PRIME_BITS (0x134) 423 #define CKA_VALUE_BITS (0x160) 424 #define CKA_VALUE_LEN (0x161) 425 #define CKA_EXTRACTABLE (0x162) 426 #define CKA_LOCAL (0x163) 427 #define CKA_NEVER_EXTRACTABLE (0x164) 428 #define CKA_ALWAYS_SENSITIVE (0x165) 429 #define CKA_KEY_GEN_MECHANISM (0x166) 430 #define CKA_MODIFIABLE (0x170) 431 #define CKA_ECDSA_PARAMS (0x180) 432 #define CKA_EC_PARAMS (0x180) 433 #define CKA_EC_POINT (0x181) 434 #define CKA_SECONDARY_AUTH (0x200) 435 #define CKA_AUTH_PIN_FLAGS (0x201) 436 #define CKA_ALWAYS_AUTHENTICATE (0x202) 437 #define CKA_WRAP_WITH_TRUSTED (0x210) 438 #define CKA_HW_FEATURE_TYPE (0x300) 439 #define CKA_RESET_ON_INIT (0x301) 440 #define CKA_HAS_RESET (0x302) 441 #define CKA_PIXEL_X (0x400) 442 #define CKA_PIXEL_Y (0x401) 443 #define CKA_RESOLUTION (0x402) 444 #define CKA_CHAR_ROWS (0x403) 445 #define CKA_CHAR_COLUMNS (0x404) 446 #define CKA_COLOR (0x405) 447 #define CKA_BITS_PER_PIXEL (0x406) 448 #define CKA_CHAR_SETS (0x480) 449 #define CKA_ENCODING_METHODS (0x481) 450 #define CKA_MIME_TYPES (0x482) 451 #define CKA_MECHANISM_TYPE (0x500) 452 #define CKA_REQUIRED_CMS_ATTRIBUTES (0x501) 453 #define CKA_DEFAULT_CMS_ATTRIBUTES (0x502) 454 #define CKA_SUPPORTED_CMS_ATTRIBUTES (0x503) 455 #define CKA_WRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE | 0x211) 456 #define CKA_UNWRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE | 0x212) 457 #define CKA_ALLOWED_MECHANISMS (CKF_ARRAY_ATTRIBUTE | 0x600) 458 #define CKA_VENDOR_DEFINED ((unsigned long) (1 << 31)) 459 460 461 struct ck_attribute 462 { 463 ck_attribute_type_t type; 464 void *value; 465 unsigned long value_len; 466 }; 467 468 469 struct ck_date 470 { 471 unsigned char year[4]; 472 unsigned char month[2]; 473 unsigned char day[2]; 474 }; 475 476 477 typedef unsigned long ck_mechanism_type_t; 478 479 #define CKM_RSA_PKCS_KEY_PAIR_GEN (0) 480 #define CKM_RSA_PKCS (1) 481 #define CKM_RSA_9796 (2) 482 #define CKM_RSA_X_509 (3) 483 #define CKM_MD2_RSA_PKCS (4) 484 #define CKM_MD5_RSA_PKCS (5) 485 #define CKM_SHA1_RSA_PKCS (6) 486 #define CKM_RIPEMD128_RSA_PKCS (7) 487 #define CKM_RIPEMD160_RSA_PKCS (8) 488 #define CKM_RSA_PKCS_OAEP (9) 489 #define CKM_RSA_X9_31_KEY_PAIR_GEN (0xa) 490 #define CKM_RSA_X9_31 (0xb) 491 #define CKM_SHA1_RSA_X9_31 (0xc) 492 #define CKM_RSA_PKCS_PSS (0xd) 493 #define CKM_SHA1_RSA_PKCS_PSS (0xe) 494 #define CKM_DSA_KEY_PAIR_GEN (0x10) 495 #define CKM_DSA (0x11) 496 #define CKM_DSA_SHA1 (0x12) 497 #define CKM_DH_PKCS_KEY_PAIR_GEN (0x20) 498 #define CKM_DH_PKCS_DERIVE (0x21) 499 #define CKM_X9_42_DH_KEY_PAIR_GEN (0x30) 500 #define CKM_X9_42_DH_DERIVE (0x31) 501 #define CKM_X9_42_DH_HYBRID_DERIVE (0x32) 502 #define CKM_X9_42_MQV_DERIVE (0x33) 503 #define CKM_SHA256_RSA_PKCS (0x40) 504 #define CKM_SHA384_RSA_PKCS (0x41) 505 #define CKM_SHA512_RSA_PKCS (0x42) 506 #define CKM_SHA256_RSA_PKCS_PSS (0x43) 507 #define CKM_SHA384_RSA_PKCS_PSS (0x44) 508 #define CKM_SHA512_RSA_PKCS_PSS (0x45) 509 #define CKM_RC2_KEY_GEN (0x100) 510 #define CKM_RC2_ECB (0x101) 511 #define CKM_RC2_CBC (0x102) 512 #define CKM_RC2_MAC (0x103) 513 #define CKM_RC2_MAC_GENERAL (0x104) 514 #define CKM_RC2_CBC_PAD (0x105) 515 #define CKM_RC4_KEY_GEN (0x110) 516 #define CKM_RC4 (0x111) 517 #define CKM_DES_KEY_GEN (0x120) 518 #define CKM_DES_ECB (0x121) 519 #define CKM_DES_CBC (0x122) 520 #define CKM_DES_MAC (0x123) 521 #define CKM_DES_MAC_GENERAL (0x124) 522 #define CKM_DES_CBC_PAD (0x125) 523 #define CKM_DES2_KEY_GEN (0x130) 524 #define CKM_DES3_KEY_GEN (0x131) 525 #define CKM_DES3_ECB (0x132) 526 #define CKM_DES3_CBC (0x133) 527 #define CKM_DES3_MAC (0x134) 528 #define CKM_DES3_MAC_GENERAL (0x135) 529 #define CKM_DES3_CBC_PAD (0x136) 530 #define CKM_CDMF_KEY_GEN (0x140) 531 #define CKM_CDMF_ECB (0x141) 532 #define CKM_CDMF_CBC (0x142) 533 #define CKM_CDMF_MAC (0x143) 534 #define CKM_CDMF_MAC_GENERAL (0x144) 535 #define CKM_CDMF_CBC_PAD (0x145) 536 #define CKM_MD2 (0x200) 537 #define CKM_MD2_HMAC (0x201) 538 #define CKM_MD2_HMAC_GENERAL (0x202) 539 #define CKM_MD5 (0x210) 540 #define CKM_MD5_HMAC (0x211) 541 #define CKM_MD5_HMAC_GENERAL (0x212) 542 #define CKM_SHA_1 (0x220) 543 #define CKM_SHA_1_HMAC (0x221) 544 #define CKM_SHA_1_HMAC_GENERAL (0x222) 545 #define CKM_RIPEMD128 (0x230) 546 #define CKM_RIPEMD128_HMAC (0x231) 547 #define CKM_RIPEMD128_HMAC_GENERAL (0x232) 548 #define CKM_RIPEMD160 (0x240) 549 #define CKM_RIPEMD160_HMAC (0x241) 550 #define CKM_RIPEMD160_HMAC_GENERAL (0x242) 551 #define CKM_SHA256 (0x250) 552 #define CKM_SHA256_HMAC (0x251) 553 #define CKM_SHA256_HMAC_GENERAL (0x252) 554 #define CKM_SHA384 (0x260) 555 #define CKM_SHA384_HMAC (0x261) 556 #define CKM_SHA384_HMAC_GENERAL (0x262) 557 #define CKM_SHA512 (0x270) 558 #define CKM_SHA512_HMAC (0x271) 559 #define CKM_SHA512_HMAC_GENERAL (0x272) 560 #define CKM_CAST_KEY_GEN (0x300) 561 #define CKM_CAST_ECB (0x301) 562 #define CKM_CAST_CBC (0x302) 563 #define CKM_CAST_MAC (0x303) 564 #define CKM_CAST_MAC_GENERAL (0x304) 565 #define CKM_CAST_CBC_PAD (0x305) 566 #define CKM_CAST3_KEY_GEN (0x310) 567 #define CKM_CAST3_ECB (0x311) 568 #define CKM_CAST3_CBC (0x312) 569 #define CKM_CAST3_MAC (0x313) 570 #define CKM_CAST3_MAC_GENERAL (0x314) 571 #define CKM_CAST3_CBC_PAD (0x315) 572 #define CKM_CAST5_KEY_GEN (0x320) 573 #define CKM_CAST128_KEY_GEN (0x320) 574 #define CKM_CAST5_ECB (0x321) 575 #define CKM_CAST128_ECB (0x321) 576 #define CKM_CAST5_CBC (0x322) 577 #define CKM_CAST128_CBC (0x322) 578 #define CKM_CAST5_MAC (0x323) 579 #define CKM_CAST128_MAC (0x323) 580 #define CKM_CAST5_MAC_GENERAL (0x324) 581 #define CKM_CAST128_MAC_GENERAL (0x324) 582 #define CKM_CAST5_CBC_PAD (0x325) 583 #define CKM_CAST128_CBC_PAD (0x325) 584 #define CKM_RC5_KEY_GEN (0x330) 585 #define CKM_RC5_ECB (0x331) 586 #define CKM_RC5_CBC (0x332) 587 #define CKM_RC5_MAC (0x333) 588 #define CKM_RC5_MAC_GENERAL (0x334) 589 #define CKM_RC5_CBC_PAD (0x335) 590 #define CKM_IDEA_KEY_GEN (0x340) 591 #define CKM_IDEA_ECB (0x341) 592 #define CKM_IDEA_CBC (0x342) 593 #define CKM_IDEA_MAC (0x343) 594 #define CKM_IDEA_MAC_GENERAL (0x344) 595 #define CKM_IDEA_CBC_PAD (0x345) 596 #define CKM_GENERIC_SECRET_KEY_GEN (0x350) 597 #define CKM_CONCATENATE_BASE_AND_KEY (0x360) 598 #define CKM_CONCATENATE_BASE_AND_DATA (0x362) 599 #define CKM_CONCATENATE_DATA_AND_BASE (0x363) 600 #define CKM_XOR_BASE_AND_DATA (0x364) 601 #define CKM_EXTRACT_KEY_FROM_KEY (0x365) 602 #define CKM_SSL3_PRE_MASTER_KEY_GEN (0x370) 603 #define CKM_SSL3_MASTER_KEY_DERIVE (0x371) 604 #define CKM_SSL3_KEY_AND_MAC_DERIVE (0x372) 605 #define CKM_SSL3_MASTER_KEY_DERIVE_DH (0x373) 606 #define CKM_TLS_PRE_MASTER_KEY_GEN (0x374) 607 #define CKM_TLS_MASTER_KEY_DERIVE (0x375) 608 #define CKM_TLS_KEY_AND_MAC_DERIVE (0x376) 609 #define CKM_TLS_MASTER_KEY_DERIVE_DH (0x377) 610 #define CKM_SSL3_MD5_MAC (0x380) 611 #define CKM_SSL3_SHA1_MAC (0x381) 612 #define CKM_MD5_KEY_DERIVATION (0x390) 613 #define CKM_MD2_KEY_DERIVATION (0x391) 614 #define CKM_SHA1_KEY_DERIVATION (0x392) 615 #define CKM_PBE_MD2_DES_CBC (0x3a0) 616 #define CKM_PBE_MD5_DES_CBC (0x3a1) 617 #define CKM_PBE_MD5_CAST_CBC (0x3a2) 618 #define CKM_PBE_MD5_CAST3_CBC (0x3a3) 619 #define CKM_PBE_MD5_CAST5_CBC (0x3a4) 620 #define CKM_PBE_MD5_CAST128_CBC (0x3a4) 621 #define CKM_PBE_SHA1_CAST5_CBC (0x3a5) 622 #define CKM_PBE_SHA1_CAST128_CBC (0x3a5) 623 #define CKM_PBE_SHA1_RC4_128 (0x3a6) 624 #define CKM_PBE_SHA1_RC4_40 (0x3a7) 625 #define CKM_PBE_SHA1_DES3_EDE_CBC (0x3a8) 626 #define CKM_PBE_SHA1_DES2_EDE_CBC (0x3a9) 627 #define CKM_PBE_SHA1_RC2_128_CBC (0x3aa) 628 #define CKM_PBE_SHA1_RC2_40_CBC (0x3ab) 629 #define CKM_PKCS5_PBKD2 (0x3b0) 630 #define CKM_PBA_SHA1_WITH_SHA1_HMAC (0x3c0) 631 #define CKM_KEY_WRAP_LYNKS (0x400) 632 #define CKM_KEY_WRAP_SET_OAEP (0x401) 633 #define CKM_SKIPJACK_KEY_GEN (0x1000) 634 #define CKM_SKIPJACK_ECB64 (0x1001) 635 #define CKM_SKIPJACK_CBC64 (0x1002) 636 #define CKM_SKIPJACK_OFB64 (0x1003) 637 #define CKM_SKIPJACK_CFB64 (0x1004) 638 #define CKM_SKIPJACK_CFB32 (0x1005) 639 #define CKM_SKIPJACK_CFB16 (0x1006) 640 #define CKM_SKIPJACK_CFB8 (0x1007) 641 #define CKM_SKIPJACK_WRAP (0x1008) 642 #define CKM_SKIPJACK_PRIVATE_WRAP (0x1009) 643 #define CKM_SKIPJACK_RELAYX (0x100a) 644 #define CKM_KEA_KEY_PAIR_GEN (0x1010) 645 #define CKM_KEA_KEY_DERIVE (0x1011) 646 #define CKM_FORTEZZA_TIMESTAMP (0x1020) 647 #define CKM_BATON_KEY_GEN (0x1030) 648 #define CKM_BATON_ECB128 (0x1031) 649 #define CKM_BATON_ECB96 (0x1032) 650 #define CKM_BATON_CBC128 (0x1033) 651 #define CKM_BATON_COUNTER (0x1034) 652 #define CKM_BATON_SHUFFLE (0x1035) 653 #define CKM_BATON_WRAP (0x1036) 654 #define CKM_ECDSA_KEY_PAIR_GEN (0x1040) 655 #define CKM_EC_KEY_PAIR_GEN (0x1040) 656 #define CKM_ECDSA (0x1041) 657 #define CKM_ECDSA_SHA1 (0x1042) 658 #define CKM_ECDH1_DERIVE (0x1050) 659 #define CKM_ECDH1_COFACTOR_DERIVE (0x1051) 660 #define CKM_ECMQV_DERIVE (0x1052) 661 #define CKM_JUNIPER_KEY_GEN (0x1060) 662 #define CKM_JUNIPER_ECB128 (0x1061) 663 #define CKM_JUNIPER_CBC128 (0x1062) 664 #define CKM_JUNIPER_COUNTER (0x1063) 665 #define CKM_JUNIPER_SHUFFLE (0x1064) 666 #define CKM_JUNIPER_WRAP (0x1065) 667 #define CKM_FASTHASH (0x1070) 668 #define CKM_AES_KEY_GEN (0x1080) 669 #define CKM_AES_ECB (0x1081) 670 #define CKM_AES_CBC (0x1082) 671 #define CKM_AES_MAC (0x1083) 672 #define CKM_AES_MAC_GENERAL (0x1084) 673 #define CKM_AES_CBC_PAD (0x1085) 674 #define CKM_DSA_PARAMETER_GEN (0x2000) 675 #define CKM_DH_PKCS_PARAMETER_GEN (0x2001) 676 #define CKM_X9_42_DH_PARAMETER_GEN (0x2002) 677 #define CKM_VENDOR_DEFINED ((unsigned long) (1 << 31)) 678 679 680 struct ck_mechanism 681 { 682 ck_mechanism_type_t mechanism; 683 void *parameter; 684 unsigned long parameter_len; 685 }; 686 687 688 struct ck_mechanism_info 689 { 690 unsigned long min_key_size; 691 unsigned long max_key_size; 692 ck_flags_t flags; 693 }; 694 695 #define CKF_HW (1 << 0) 696 #define CKF_ENCRYPT (1 << 8) 697 #define CKF_DECRYPT (1 << 9) 698 #define CKF_DIGEST (1 << 10) 699 #define CKF_SIGN (1 << 11) 700 #define CKF_SIGN_RECOVER (1 << 12) 701 #define CKF_VERIFY (1 << 13) 702 #define CKF_VERIFY_RECOVER (1 << 14) 703 #define CKF_GENERATE (1 << 15) 704 #define CKF_GENERATE_KEY_PAIR (1 << 16) 705 #define CKF_WRAP (1 << 17) 706 #define CKF_UNWRAP (1 << 18) 707 #define CKF_DERIVE (1 << 19) 708 #define CKF_EXTENSION ((unsigned long) (1 << 31)) 709 710 711 /* Flags for C_WaitForSlotEvent. */ 712 #define CKF_DONT_BLOCK (1) 713 714 715 typedef unsigned long ck_rv_t; 716 717 718 typedef ck_rv_t (*ck_notify_t) (ck_session_handle_t session, 719 ck_notification_t event, void *application); 720 721 /* Forward reference. */ 722 struct ck_function_list; 723 724 #define _CK_DECLARE_FUNCTION(name, args) \ 725 typedef ck_rv_t (*CK_ ## name) args; \ 726 ck_rv_t CK_SPEC name args 727 728 _CK_DECLARE_FUNCTION (C_Initialize, (void *init_args)); 729 _CK_DECLARE_FUNCTION (C_Finalize, (void *reserved)); 730 _CK_DECLARE_FUNCTION (C_GetInfo, (struct ck_info *info)); 731 _CK_DECLARE_FUNCTION (C_GetFunctionList, 732 (struct ck_function_list **function_list)); 733 734 _CK_DECLARE_FUNCTION (C_GetSlotList, 735 (unsigned char token_present, ck_slot_id_t *slot_list, 736 unsigned long *count)); 737 _CK_DECLARE_FUNCTION (C_GetSlotInfo, 738 (ck_slot_id_t slot_id, struct ck_slot_info *info)); 739 _CK_DECLARE_FUNCTION (C_GetTokenInfo, 740 (ck_slot_id_t slot_id, struct ck_token_info *info)); 741 _CK_DECLARE_FUNCTION (C_WaitForSlotEvent, 742 (ck_flags_t flags, ck_slot_id_t *slot, void *reserved)); 743 _CK_DECLARE_FUNCTION (C_GetMechanismList, 744 (ck_slot_id_t slot_id, 745 ck_mechanism_type_t *mechanism_list, 746 unsigned long *count)); 747 _CK_DECLARE_FUNCTION (C_GetMechanismInfo, 748 (ck_slot_id_t slot_id, ck_mechanism_type_t type, 749 struct ck_mechanism_info *info)); 750 _CK_DECLARE_FUNCTION (C_InitToken, 751 (ck_slot_id_t slot_id, unsigned char *pin, 752 unsigned long pin_len, unsigned char *label)); 753 _CK_DECLARE_FUNCTION (C_InitPIN, 754 (ck_session_handle_t session, unsigned char *pin, 755 unsigned long pin_len)); 756 _CK_DECLARE_FUNCTION (C_SetPIN, 757 (ck_session_handle_t session, unsigned char *old_pin, 758 unsigned long old_len, unsigned char *new_pin, 759 unsigned long new_len)); 760 761 _CK_DECLARE_FUNCTION (C_OpenSession, 762 (ck_slot_id_t slot_id, ck_flags_t flags, 763 void *application, ck_notify_t notify, 764 ck_session_handle_t *session)); 765 _CK_DECLARE_FUNCTION (C_CloseSession, (ck_session_handle_t session)); 766 _CK_DECLARE_FUNCTION (C_CloseAllSessions, (ck_slot_id_t slot_id)); 767 _CK_DECLARE_FUNCTION (C_GetSessionInfo, 768 (ck_session_handle_t session, 769 struct ck_session_info *info)); 770 _CK_DECLARE_FUNCTION (C_GetOperationState, 771 (ck_session_handle_t session, 772 unsigned char *operation_state, 773 unsigned long *operation_state_len)); 774 _CK_DECLARE_FUNCTION (C_SetOperationState, 775 (ck_session_handle_t session, 776 unsigned char *operation_state, 777 unsigned long operation_state_len, 778 ck_object_handle_t encryption_key, 779 ck_object_handle_t authentiation_key)); 780 _CK_DECLARE_FUNCTION (C_Login, 781 (ck_session_handle_t session, ck_user_type_t user_type, 782 unsigned char *pin, unsigned long pin_len)); 783 _CK_DECLARE_FUNCTION (C_Logout, (ck_session_handle_t session)); 784 785 _CK_DECLARE_FUNCTION (C_CreateObject, 786 (ck_session_handle_t session, 787 struct ck_attribute *templ, 788 unsigned long count, ck_object_handle_t *object)); 789 _CK_DECLARE_FUNCTION (C_CopyObject, 790 (ck_session_handle_t session, ck_object_handle_t object, 791 struct ck_attribute *templ, unsigned long count, 792 ck_object_handle_t *new_object)); 793 _CK_DECLARE_FUNCTION (C_DestroyObject, 794 (ck_session_handle_t session, 795 ck_object_handle_t object)); 796 _CK_DECLARE_FUNCTION (C_GetObjectSize, 797 (ck_session_handle_t session, 798 ck_object_handle_t object, 799 unsigned long *size)); 800 _CK_DECLARE_FUNCTION (C_GetAttributeValue, 801 (ck_session_handle_t session, 802 ck_object_handle_t object, 803 struct ck_attribute *templ, 804 unsigned long count)); 805 _CK_DECLARE_FUNCTION (C_SetAttributeValue, 806 (ck_session_handle_t session, 807 ck_object_handle_t object, 808 struct ck_attribute *templ, 809 unsigned long count)); 810 _CK_DECLARE_FUNCTION (C_FindObjectsInit, 811 (ck_session_handle_t session, 812 struct ck_attribute *templ, 813 unsigned long count)); 814 _CK_DECLARE_FUNCTION (C_FindObjects, 815 (ck_session_handle_t session, 816 ck_object_handle_t *object, 817 unsigned long max_object_count, 818 unsigned long *object_count)); 819 _CK_DECLARE_FUNCTION (C_FindObjectsFinal, 820 (ck_session_handle_t session)); 821 822 _CK_DECLARE_FUNCTION (C_EncryptInit, 823 (ck_session_handle_t session, 824 struct ck_mechanism *mechanism, 825 ck_object_handle_t key)); 826 _CK_DECLARE_FUNCTION (C_Encrypt, 827 (ck_session_handle_t session, 828 unsigned char *data, unsigned long data_len, 829 unsigned char *encrypted_data, 830 unsigned long *encrypted_data_len)); 831 _CK_DECLARE_FUNCTION (C_EncryptUpdate, 832 (ck_session_handle_t session, 833 unsigned char *part, unsigned long part_len, 834 unsigned char *encrypted_part, 835 unsigned long *encrypted_part_len)); 836 _CK_DECLARE_FUNCTION (C_EncryptFinal, 837 (ck_session_handle_t session, 838 unsigned char *last_encrypted_part, 839 unsigned long *last_encrypted_part_len)); 840 841 _CK_DECLARE_FUNCTION (C_DecryptInit, 842 (ck_session_handle_t session, 843 struct ck_mechanism *mechanism, 844 ck_object_handle_t key)); 845 _CK_DECLARE_FUNCTION (C_Decrypt, 846 (ck_session_handle_t session, 847 unsigned char *encrypted_data, 848 unsigned long encrypted_data_len, 849 unsigned char *data, unsigned long *data_len)); 850 _CK_DECLARE_FUNCTION (C_DecryptUpdate, 851 (ck_session_handle_t session, 852 unsigned char *encrypted_part, 853 unsigned long encrypted_part_len, 854 unsigned char *part, unsigned long *part_len)); 855 _CK_DECLARE_FUNCTION (C_DecryptFinal, 856 (ck_session_handle_t session, 857 unsigned char *last_part, 858 unsigned long *last_part_len)); 859 860 _CK_DECLARE_FUNCTION (C_DigestInit, 861 (ck_session_handle_t session, 862 struct ck_mechanism *mechanism)); 863 _CK_DECLARE_FUNCTION (C_Digest, 864 (ck_session_handle_t session, 865 unsigned char *data, unsigned long data_len, 866 unsigned char *digest, 867 unsigned long *digest_len)); 868 _CK_DECLARE_FUNCTION (C_DigestUpdate, 869 (ck_session_handle_t session, 870 unsigned char *part, unsigned long part_len)); 871 _CK_DECLARE_FUNCTION (C_DigestKey, 872 (ck_session_handle_t session, ck_object_handle_t key)); 873 _CK_DECLARE_FUNCTION (C_DigestFinal, 874 (ck_session_handle_t session, 875 unsigned char *digest, 876 unsigned long *digest_len)); 877 878 _CK_DECLARE_FUNCTION (C_SignInit, 879 (ck_session_handle_t session, 880 struct ck_mechanism *mechanism, 881 ck_object_handle_t key)); 882 _CK_DECLARE_FUNCTION (C_Sign, 883 (ck_session_handle_t session, 884 unsigned char *data, unsigned long data_len, 885 unsigned char *signature, 886 unsigned long *signature_len)); 887 _CK_DECLARE_FUNCTION (C_SignUpdate, 888 (ck_session_handle_t session, 889 unsigned char *part, unsigned long part_len)); 890 _CK_DECLARE_FUNCTION (C_SignFinal, 891 (ck_session_handle_t session, 892 unsigned char *signature, 893 unsigned long *signature_len)); 894 _CK_DECLARE_FUNCTION (C_SignRecoverInit, 895 (ck_session_handle_t session, 896 struct ck_mechanism *mechanism, 897 ck_object_handle_t key)); 898 _CK_DECLARE_FUNCTION (C_SignRecover, 899 (ck_session_handle_t session, 900 unsigned char *data, unsigned long data_len, 901 unsigned char *signature, 902 unsigned long *signature_len)); 903 904 _CK_DECLARE_FUNCTION (C_VerifyInit, 905 (ck_session_handle_t session, 906 struct ck_mechanism *mechanism, 907 ck_object_handle_t key)); 908 _CK_DECLARE_FUNCTION (C_Verify, 909 (ck_session_handle_t session, 910 unsigned char *data, unsigned long data_len, 911 unsigned char *signature, 912 unsigned long signature_len)); 913 _CK_DECLARE_FUNCTION (C_VerifyUpdate, 914 (ck_session_handle_t session, 915 unsigned char *part, unsigned long part_len)); 916 _CK_DECLARE_FUNCTION (C_VerifyFinal, 917 (ck_session_handle_t session, 918 unsigned char *signature, 919 unsigned long signature_len)); 920 _CK_DECLARE_FUNCTION (C_VerifyRecoverInit, 921 (ck_session_handle_t session, 922 struct ck_mechanism *mechanism, 923 ck_object_handle_t key)); 924 _CK_DECLARE_FUNCTION (C_VerifyRecover, 925 (ck_session_handle_t session, 926 unsigned char *signature, 927 unsigned long signature_len, 928 unsigned char *data, 929 unsigned long *data_len)); 930 931 _CK_DECLARE_FUNCTION (C_DigestEncryptUpdate, 932 (ck_session_handle_t session, 933 unsigned char *part, unsigned long part_len, 934 unsigned char *encrypted_part, 935 unsigned long *encrypted_part_len)); 936 _CK_DECLARE_FUNCTION (C_DecryptDigestUpdate, 937 (ck_session_handle_t session, 938 unsigned char *encrypted_part, 939 unsigned long encrypted_part_len, 940 unsigned char *part, 941 unsigned long *part_len)); 942 _CK_DECLARE_FUNCTION (C_SignEncryptUpdate, 943 (ck_session_handle_t session, 944 unsigned char *part, unsigned long part_len, 945 unsigned char *encrypted_part, 946 unsigned long *encrypted_part_len)); 947 _CK_DECLARE_FUNCTION (C_DecryptVerifyUpdate, 948 (ck_session_handle_t session, 949 unsigned char *encrypted_part, 950 unsigned long encrypted_part_len, 951 unsigned char *part, 952 unsigned long *part_len)); 953 954 _CK_DECLARE_FUNCTION (C_GenerateKey, 955 (ck_session_handle_t session, 956 struct ck_mechanism *mechanism, 957 struct ck_attribute *templ, 958 unsigned long count, 959 ck_object_handle_t *key)); 960 _CK_DECLARE_FUNCTION (C_GenerateKeyPair, 961 (ck_session_handle_t session, 962 struct ck_mechanism *mechanism, 963 struct ck_attribute *public_key_template, 964 unsigned long public_key_attribute_count, 965 struct ck_attribute *private_key_template, 966 unsigned long private_key_attribute_count, 967 ck_object_handle_t *public_key, 968 ck_object_handle_t *private_key)); 969 _CK_DECLARE_FUNCTION (C_WrapKey, 970 (ck_session_handle_t session, 971 struct ck_mechanism *mechanism, 972 ck_object_handle_t wrapping_key, 973 ck_object_handle_t key, 974 unsigned char *wrapped_key, 975 unsigned long *wrapped_key_len)); 976 _CK_DECLARE_FUNCTION (C_UnwrapKey, 977 (ck_session_handle_t session, 978 struct ck_mechanism *mechanism, 979 ck_object_handle_t unwrapping_key, 980 unsigned char *wrapped_key, 981 unsigned long wrapped_key_len, 982 struct ck_attribute *templ, 983 unsigned long attribute_count, 984 ck_object_handle_t *key)); 985 _CK_DECLARE_FUNCTION (C_DeriveKey, 986 (ck_session_handle_t session, 987 struct ck_mechanism *mechanism, 988 ck_object_handle_t base_key, 989 struct ck_attribute *templ, 990 unsigned long attribute_count, 991 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, 998 unsigned char *random_data, 999 unsigned long random_len)); 1000 1001 _CK_DECLARE_FUNCTION (C_GetFunctionStatus, (ck_session_handle_t session)); 1002 _CK_DECLARE_FUNCTION (C_CancelFunction, (ck_session_handle_t session)); 1003 1004 1005 struct ck_function_list 1006 { 1007 struct ck_version version; 1008 CK_C_Initialize C_Initialize; 1009 CK_C_Finalize C_Finalize; 1010 CK_C_GetInfo C_GetInfo; 1011 CK_C_GetFunctionList C_GetFunctionList; 1012 CK_C_GetSlotList C_GetSlotList; 1013 CK_C_GetSlotInfo C_GetSlotInfo; 1014 CK_C_GetTokenInfo C_GetTokenInfo; 1015 CK_C_GetMechanismList C_GetMechanismList; 1016 CK_C_GetMechanismInfo C_GetMechanismInfo; 1017 CK_C_InitToken C_InitToken; 1018 CK_C_InitPIN C_InitPIN; 1019 CK_C_SetPIN C_SetPIN; 1020 CK_C_OpenSession C_OpenSession; 1021 CK_C_CloseSession C_CloseSession; 1022 CK_C_CloseAllSessions C_CloseAllSessions; 1023 CK_C_GetSessionInfo C_GetSessionInfo; 1024 CK_C_GetOperationState C_GetOperationState; 1025 CK_C_SetOperationState C_SetOperationState; 1026 CK_C_Login C_Login; 1027 CK_C_Logout C_Logout; 1028 CK_C_CreateObject C_CreateObject; 1029 CK_C_CopyObject C_CopyObject; 1030 CK_C_DestroyObject C_DestroyObject; 1031 CK_C_GetObjectSize C_GetObjectSize; 1032 CK_C_GetAttributeValue C_GetAttributeValue; 1033 CK_C_SetAttributeValue C_SetAttributeValue; 1034 CK_C_FindObjectsInit C_FindObjectsInit; 1035 CK_C_FindObjects C_FindObjects; 1036 CK_C_FindObjectsFinal C_FindObjectsFinal; 1037 CK_C_EncryptInit C_EncryptInit; 1038 CK_C_Encrypt C_Encrypt; 1039 CK_C_EncryptUpdate C_EncryptUpdate; 1040 CK_C_EncryptFinal C_EncryptFinal; 1041 CK_C_DecryptInit C_DecryptInit; 1042 CK_C_Decrypt C_Decrypt; 1043 CK_C_DecryptUpdate C_DecryptUpdate; 1044 CK_C_DecryptFinal C_DecryptFinal; 1045 CK_C_DigestInit C_DigestInit; 1046 CK_C_Digest C_Digest; 1047 CK_C_DigestUpdate C_DigestUpdate; 1048 CK_C_DigestKey C_DigestKey; 1049 CK_C_DigestFinal C_DigestFinal; 1050 CK_C_SignInit C_SignInit; 1051 CK_C_Sign C_Sign; 1052 CK_C_SignUpdate C_SignUpdate; 1053 CK_C_SignFinal C_SignFinal; 1054 CK_C_SignRecoverInit C_SignRecoverInit; 1055 CK_C_SignRecover C_SignRecover; 1056 CK_C_VerifyInit C_VerifyInit; 1057 CK_C_Verify C_Verify; 1058 CK_C_VerifyUpdate C_VerifyUpdate; 1059 CK_C_VerifyFinal C_VerifyFinal; 1060 CK_C_VerifyRecoverInit C_VerifyRecoverInit; 1061 CK_C_VerifyRecover C_VerifyRecover; 1062 CK_C_DigestEncryptUpdate C_DigestEncryptUpdate; 1063 CK_C_DecryptDigestUpdate C_DecryptDigestUpdate; 1064 CK_C_SignEncryptUpdate C_SignEncryptUpdate; 1065 CK_C_DecryptVerifyUpdate C_DecryptVerifyUpdate; 1066 CK_C_GenerateKey C_GenerateKey; 1067 CK_C_GenerateKeyPair C_GenerateKeyPair; 1068 CK_C_WrapKey C_WrapKey; 1069 CK_C_UnwrapKey C_UnwrapKey; 1070 CK_C_DeriveKey C_DeriveKey; 1071 CK_C_SeedRandom C_SeedRandom; 1072 CK_C_GenerateRandom C_GenerateRandom; 1073 CK_C_GetFunctionStatus C_GetFunctionStatus; 1074 CK_C_CancelFunction C_CancelFunction; 1075 CK_C_WaitForSlotEvent C_WaitForSlotEvent; 1076 }; 1077 1078 1079 typedef ck_rv_t (*ck_createmutex_t) (void **mutex); 1080 typedef ck_rv_t (*ck_destroymutex_t) (void *mutex); 1081 typedef ck_rv_t (*ck_lockmutex_t) (void *mutex); 1082 typedef ck_rv_t (*ck_unlockmutex_t) (void *mutex); 1083 1084 1085 struct ck_c_initialize_args 1086 { 1087 ck_createmutex_t create_mutex; 1088 ck_destroymutex_t destroy_mutex; 1089 ck_lockmutex_t lock_mutex; 1090 ck_unlockmutex_t unlock_mutex; 1091 ck_flags_t flags; 1092 void *reserved; 1093 }; 1094 1095 1096 #define CKF_LIBRARY_CANT_CREATE_OS_THREADS (1 << 0) 1097 #define CKF_OS_LOCKING_OK (1 << 1) 1098 1099 #define CKR_OK (0) 1100 #define CKR_CANCEL (1) 1101 #define CKR_HOST_MEMORY (2) 1102 #define CKR_SLOT_ID_INVALID (3) 1103 #define CKR_GENERAL_ERROR (5) 1104 #define CKR_FUNCTION_FAILED (6) 1105 #define CKR_ARGUMENTS_BAD (7) 1106 #define CKR_NO_EVENT (8) 1107 #define CKR_NEED_TO_CREATE_THREADS (9) 1108 #define CKR_CANT_LOCK (0xa) 1109 #define CKR_ATTRIBUTE_READ_ONLY (0x10) 1110 #define CKR_ATTRIBUTE_SENSITIVE (0x11) 1111 #define CKR_ATTRIBUTE_TYPE_INVALID (0x12) 1112 #define CKR_ATTRIBUTE_VALUE_INVALID (0x13) 1113 #define CKR_DATA_INVALID (0x20) 1114 #define CKR_DATA_LEN_RANGE (0x21) 1115 #define CKR_DEVICE_ERROR (0x30) 1116 #define CKR_DEVICE_MEMORY (0x31) 1117 #define CKR_DEVICE_REMOVED (0x32) 1118 #define CKR_ENCRYPTED_DATA_INVALID (0x40) 1119 #define CKR_ENCRYPTED_DATA_LEN_RANGE (0x41) 1120 #define CKR_FUNCTION_CANCELED (0x50) 1121 #define CKR_FUNCTION_NOT_PARALLEL (0x51) 1122 #define CKR_FUNCTION_NOT_SUPPORTED (0x54) 1123 #define CKR_KEY_HANDLE_INVALID (0x60) 1124 #define CKR_KEY_SIZE_RANGE (0x62) 1125 #define CKR_KEY_TYPE_INCONSISTENT (0x63) 1126 #define CKR_KEY_NOT_NEEDED (0x64) 1127 #define CKR_KEY_CHANGED (0x65) 1128 #define CKR_KEY_NEEDED (0x66) 1129 #define CKR_KEY_INDIGESTIBLE (0x67) 1130 #define CKR_KEY_FUNCTION_NOT_PERMITTED (0x68) 1131 #define CKR_KEY_NOT_WRAPPABLE (0x69) 1132 #define CKR_KEY_UNEXTRACTABLE (0x6a) 1133 #define CKR_MECHANISM_INVALID (0x70) 1134 #define CKR_MECHANISM_PARAM_INVALID (0x71) 1135 #define CKR_OBJECT_HANDLE_INVALID (0x82) 1136 #define CKR_OPERATION_ACTIVE (0x90) 1137 #define CKR_OPERATION_NOT_INITIALIZED (0x91) 1138 #define CKR_PIN_INCORRECT (0xa0) 1139 #define CKR_PIN_INVALID (0xa1) 1140 #define CKR_PIN_LEN_RANGE (0xa2) 1141 #define CKR_PIN_EXPIRED (0xa3) 1142 #define CKR_PIN_LOCKED (0xa4) 1143 #define CKR_SESSION_CLOSED (0xb0) 1144 #define CKR_SESSION_COUNT (0xb1) 1145 #define CKR_SESSION_HANDLE_INVALID (0xb3) 1146 #define CKR_SESSION_PARALLEL_NOT_SUPPORTED (0xb4) 1147 #define CKR_SESSION_READ_ONLY (0xb5) 1148 #define CKR_SESSION_EXISTS (0xb6) 1149 #define CKR_SESSION_READ_ONLY_EXISTS (0xb7) 1150 #define CKR_SESSION_READ_WRITE_SO_EXISTS (0xb8) 1151 #define CKR_SIGNATURE_INVALID (0xc0) 1152 #define CKR_SIGNATURE_LEN_RANGE (0xc1) 1153 #define CKR_TEMPLATE_INCOMPLETE (0xd0) 1154 #define CKR_TEMPLATE_INCONSISTENT (0xd1) 1155 #define CKR_TOKEN_NOT_PRESENT (0xe0) 1156 #define CKR_TOKEN_NOT_RECOGNIZED (0xe1) 1157 #define CKR_TOKEN_WRITE_PROTECTED (0xe2) 1158 #define CKR_UNWRAPPING_KEY_HANDLE_INVALID (0xf0) 1159 #define CKR_UNWRAPPING_KEY_SIZE_RANGE (0xf1) 1160 #define CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT (0xf2) 1161 #define CKR_USER_ALREADY_LOGGED_IN (0x100) 1162 #define CKR_USER_NOT_LOGGED_IN (0x101) 1163 #define CKR_USER_PIN_NOT_INITIALIZED (0x102) 1164 #define CKR_USER_TYPE_INVALID (0x103) 1165 #define CKR_USER_ANOTHER_ALREADY_LOGGED_IN (0x104) 1166 #define CKR_USER_TOO_MANY_TYPES (0x105) 1167 #define CKR_WRAPPED_KEY_INVALID (0x110) 1168 #define CKR_WRAPPED_KEY_LEN_RANGE (0x112) 1169 #define CKR_WRAPPING_KEY_HANDLE_INVALID (0x113) 1170 #define CKR_WRAPPING_KEY_SIZE_RANGE (0x114) 1171 #define CKR_WRAPPING_KEY_TYPE_INCONSISTENT (0x115) 1172 #define CKR_RANDOM_SEED_NOT_SUPPORTED (0x120) 1173 #define CKR_RANDOM_NO_RNG (0x121) 1174 #define CKR_DOMAIN_PARAMS_INVALID (0x130) 1175 #define CKR_BUFFER_TOO_SMALL (0x150) 1176 #define CKR_SAVED_STATE_INVALID (0x160) 1177 #define CKR_INFORMATION_SENSITIVE (0x170) 1178 #define CKR_STATE_UNSAVEABLE (0x180) 1179 #define CKR_CRYPTOKI_NOT_INITIALIZED (0x190) 1180 #define CKR_CRYPTOKI_ALREADY_INITIALIZED (0x191) 1181 #define CKR_MUTEX_BAD (0x1a0) 1182 #define CKR_MUTEX_NOT_LOCKED (0x1a1) 1183 #define CKR_FUNCTION_REJECTED (0x200) 1184 #define CKR_VENDOR_DEFINED ((unsigned long) (1 << 31)) 1185 1186 1187 1188 /* Compatibility layer. */ 1189 1190 #ifdef CRYPTOKI_COMPAT 1191 1192 #undef CK_DEFINE_FUNCTION 1193 #define CK_DEFINE_FUNCTION(retval, name) retval CK_SPEC name 1194 1195 /* For NULL. */ 1196 #include <stddef.h> 1197 1198 typedef unsigned char CK_BYTE; 1199 typedef unsigned char CK_CHAR; 1200 typedef unsigned char CK_UTF8CHAR; 1201 typedef unsigned char CK_BBOOL; 1202 typedef unsigned long int CK_ULONG; 1203 typedef long int CK_LONG; 1204 typedef CK_BYTE *CK_BYTE_PTR; 1205 typedef CK_CHAR *CK_CHAR_PTR; 1206 typedef CK_UTF8CHAR *CK_UTF8CHAR_PTR; 1207 typedef CK_ULONG *CK_ULONG_PTR; 1208 typedef void *CK_VOID_PTR; 1209 typedef void **CK_VOID_PTR_PTR; 1210 #define CK_FALSE 0 1211 #define CK_TRUE 1 1212 #ifndef CK_DISABLE_TRUE_FALSE 1213 #ifndef FALSE 1214 #define FALSE 0 1215 #endif 1216 #ifndef TRUE 1217 #define TRUE 1 1218 #endif 1219 #endif 1220 1221 typedef struct ck_version CK_VERSION; 1222 typedef struct ck_version *CK_VERSION_PTR; 1223 1224 typedef struct ck_info CK_INFO; 1225 typedef struct ck_info *CK_INFO_PTR; 1226 1227 typedef ck_slot_id_t *CK_SLOT_ID_PTR; 1228 1229 typedef struct ck_slot_info CK_SLOT_INFO; 1230 typedef struct ck_slot_info *CK_SLOT_INFO_PTR; 1231 1232 typedef struct ck_token_info CK_TOKEN_INFO; 1233 typedef struct ck_token_info *CK_TOKEN_INFO_PTR; 1234 1235 typedef ck_session_handle_t *CK_SESSION_HANDLE_PTR; 1236 1237 typedef struct ck_session_info CK_SESSION_INFO; 1238 typedef struct ck_session_info *CK_SESSION_INFO_PTR; 1239 1240 typedef ck_object_handle_t *CK_OBJECT_HANDLE_PTR; 1241 1242 typedef ck_object_class_t *CK_OBJECT_CLASS_PTR; 1243 1244 typedef struct ck_attribute CK_ATTRIBUTE; 1245 typedef struct ck_attribute *CK_ATTRIBUTE_PTR; 1246 1247 typedef struct ck_date CK_DATE; 1248 typedef struct ck_date *CK_DATE_PTR; 1249 1250 typedef ck_mechanism_type_t *CK_MECHANISM_TYPE_PTR; 1251 1252 typedef struct ck_mechanism CK_MECHANISM; 1253 typedef struct ck_mechanism *CK_MECHANISM_PTR; 1254 1255 typedef struct ck_mechanism_info CK_MECHANISM_INFO; 1256 typedef struct ck_mechanism_info *CK_MECHANISM_INFO_PTR; 1257 1258 typedef struct ck_function_list CK_FUNCTION_LIST; 1259 typedef struct ck_function_list *CK_FUNCTION_LIST_PTR; 1260 typedef struct ck_function_list **CK_FUNCTION_LIST_PTR_PTR; 1261 1262 typedef struct ck_c_initialize_args CK_C_INITIALIZE_ARGS; 1263 typedef struct ck_c_initialize_args *CK_C_INITIALIZE_ARGS_PTR; 1264 1265 #define NULL_PTR NULL 1266 1267 /* Delete the helper macros defined at the top of the file. */ 1268 #undef ck_flags_t 1269 #undef ck_version 1270 1271 #undef ck_info 1272 #undef cryptoki_version 1273 #undef manufacturer_id 1274 #undef library_description 1275 #undef library_version 1276 1277 #undef ck_notification_t 1278 #undef ck_slot_id_t 1279 1280 #undef ck_slot_info 1281 #undef slot_description 1282 #undef hardware_version 1283 #undef firmware_version 1284 1285 #undef ck_token_info 1286 #undef serial_number 1287 #undef max_session_count 1288 #undef session_count 1289 #undef max_rw_session_count 1290 #undef rw_session_count 1291 #undef max_pin_len 1292 #undef min_pin_len 1293 #undef total_public_memory 1294 #undef free_public_memory 1295 #undef total_private_memory 1296 #undef free_private_memory 1297 #undef utc_time 1298 1299 #undef ck_session_handle_t 1300 #undef ck_user_type_t 1301 #undef ck_state_t 1302 1303 #undef ck_session_info 1304 #undef slot_id 1305 #undef device_error 1306 1307 #undef ck_object_handle_t 1308 #undef ck_object_class_t 1309 #undef ck_hw_feature_type_t 1310 #undef ck_key_type_t 1311 #undef ck_certificate_type_t 1312 #undef ck_attribute_type_t 1313 1314 #undef ck_attribute 1315 #undef value 1316 #undef value_len 1317 1318 #undef ck_date 1319 1320 #undef ck_mechanism_type_t 1321 1322 #undef ck_mechanism 1323 #undef parameter 1324 #undef parameter_len 1325 1326 #undef ck_mechanism_info 1327 #undef min_key_size 1328 #undef max_key_size 1329 1330 #undef ck_rv_t 1331 #undef ck_notify_t 1332 1333 #undef ck_function_list 1334 1335 #undef ck_createmutex_t 1336 #undef ck_destroymutex_t 1337 #undef ck_lockmutex_t 1338 #undef ck_unlockmutex_t 1339 1340 #undef ck_c_initialize_args 1341 #undef create_mutex 1342 #undef destroy_mutex 1343 #undef lock_mutex 1344 #undef unlock_mutex 1345 #undef reserved 1346 1347 #endif /* CRYPTOKI_COMPAT */ 1348 1349 1350 /* System dependencies. */ 1351 #if defined(_WIN32) || defined(CRYPTOKI_FORCE_WIN32) 1352 #pragma pack(pop, cryptoki) 1353 #endif 1354 1355 #if defined(__cplusplus) 1356 } 1357 #endif 1358 1359 #endif /* PKCS11_H */ 1360