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