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