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