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