Cryptographic Token Interface Standard

PKCS#11


CK_INFO Reference

CK_INFO

CK_INFO provides general information about Cryptoki. More...


Data Fields

CK_VERSION cryptokiVersion
 Cryptoki interface version number, for compatibility with future revisions of this interface. More...

CK_CHAR manufacturerID [32]
 ID of the Cryptoki library manufacturer. More...

CK_FLAGS flags
 bit flags reserved for future versions. More...

CK_CHAR libraryDescription [32]
 character-string description of the library. More...

CK_VERSION libraryVersion
 Cryptoki library version number. More...


Detailed Description

CK_INFO

CK_INFO provides general information about Cryptoki. It is defined as follows:
cryptokiVersion Cryptoki interface version number, for compatibility with future revisions of this interface
manufacturerID ID of the Cryptoki library manufacturer. Must be padded with the blank character (' ')
flags bit flags reserved for future versions. Must be zero for this version
libraryDescription character-string description of the library. Must be padded with the blank character (' ')
libraryVersion Cryptoki library version number

For libraries written to the Cryptoki v2.0 document, the value of cryptokiVersion should be 2.0; the value of libraryVersion is the version number of the library software itself.

CK_INFO_PTR

CK_INFO_PTR points to a CK_INFO structure. It is implementation-dependent.

CK_NOTIFICATION

CK_NOTIFICATION holds the types of notifications that Cryptoki provides to an application. It is defined as follows:

typedef CK_ULONG CK_NOTIFICATION;

For this version of Cryptoki, the following types of notifications are defined:

#define CKN_SURRENDER 0
#define CKN_COMPLETE 1
#define CKN_DEVICE_REMOVED 2
#define CKN_TOKEN_INSERTION 3

The notifications have the following meanings:

CKN_SURRENDER Cryptoki is surrendering the execution of a function executing in serial so that the application may perform other operations. After performing any desired operations, the application should indicate to Cryptoki whether to continue or cancel the function.

CKN_COMPLETE a function running in parallel has completed.

CKN_DEVICE_REMOVED Cryptoki has detected that the device underlying the token has been removed from the reader. Not all slots/tokens support this notification.

CKN_TOKEN_INSERTION Cryptoki has detected that the device underlying the token has been inserted into the reader. Not all slots/tokens support this notification.

Slot and token types

Cryptoki represents slot and token information with the following types:

CK_SLOT_ID

CK_SLOT_ID is a Cryptoki-assigned value that identifies a slot. It is defined as follows:

typedef CK_ULONG CK_SLOT_ID;

A CK_SLOT_ID is returned by C_GetSlotList.

CK_SLOT_ID_PTR

CK_SLOT_ID_PTR points to a CK_SLOT_ID. It is implementation-dependent.

CK_SLOT_INFO

CK_SLOT_INFO provides information about a slot. It is defined as follows:


Field Documentation

CK_VERSION cryptokiVersion
 

Cryptoki interface version number, for compatibility with future revisions of this interface.

CK_CHAR manufacturerID[32]
 

ID of the Cryptoki library manufacturer. Must be padded with the blank character (' ')

CK_FLAGS flags
 

bit flags reserved for future versions. Must be zero for this version

CK_CHAR libraryDescription[32]
 

character-string description of the library. Must be padded with the blank character (' ')

CK_VERSION libraryVersion
 

Cryptoki library version number.


RSA Security Inc. Public-Key Cryptography Standards - PKCS#11 - v200