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

pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com>OpenSC-Project.org Logo