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