Slot and token types

A list of CK_SLOT_IDs is returned by C_GetSlotList. A priori, any value of CK_SLOT_ID can be a valid slot identifier"in particular, a system may have a slot identified by the value 0. It need not have such a slot, however.

CK_SLOT_INFO; CK_SLOT_INFO_PTR

typedef struct CK_SLOT_INFO {
CK_UTF8CHAR slotDescription[64];
CK_UTF8CHAR manufacturerID[32];
CK_FLAGS flags;
CK_VERSION hardwareVersion;
CK_VERSION firmwareVersion;
} CK_SLOT_INFO;

slotDescription	character-string description of the slot. Must be padded with the blank character (' '). Should ''not'' be null-terminated.
manufacturerID	ID of the slot manufacturer. Must be padded with the blank character (' '). Should ''not'' be null-terminated.
flags	bits flags that provide capabilities of the slot. The flags are defined below
hardwareVersion	version number of the slot's hardware
firmwareVersion	version number of the slot's firmware

Table 9, Slot Information Flags

Bit Flag	Mask	Meaning
CKF_TOKEN_PRESENT	0x00000001	TRUE if a token is present in the slot (e.g., a device is in the reader)
CKF_REMOVABLE_DEVICE	0x00000002	TRUE if the reader supports removable devices
CKF_HW_SLOT	0x00000004	TRUE if the slot is a hardware slot, as opposed to a software slot implementing a "soft token"

For a given slot, the value of the CKF_REMOVABLE_DEVICE flag never changes. In addition, if this flag is not set for a given slot, then the CKF_TOKEN_PRESENT flag for that slot is always set. That is, if a slot does not support a removable device, then that slot always has a token in it.

CK_TOKEN_INFO; CK_TOKEN_INFO_PTR

typedef struct CK_TOKEN_INFO {
CK_UTF8CHAR label[32];
CK_UTF8CHAR manufacturerID[32];
CK_UTF8CHAR model[16];
CK_CHAR serialNumber[16];
CK_FLAGS flags;
CK_ULONG ulMaxSessionCount;
CK_ULONG ulSessionCount;
CK_ULONG ulMaxRwSessionCount;
CK_ULONG ulRwSessionCount;
CK_ULONG ulMaxPinLen;
CK_ULONG ulMinPinLen;
CK_ULONG ulTotalPublicMemory;
CK_ULONG ulFreePublicMemory;
CK_ULONG ulTotalPrivateMemory;
CK_ULONG ulFreePrivateMemory;
CK_VERSION hardwareVersion;
CK_VERSION firmwareVersion;
CK_CHAR utcTime[16];
} CK_TOKEN_INFO;

label	application-defined label, assigned during token initialization. Must be padded with the blank character (' '). Should ''not'' be null-terminated.
manufacturerID	ID of the device manufacturer. Must be padded with the blank character (' '). Should ''not'' be null-terminated.
model	model of the device. Must be padded with the blank character (' '). Should ''not'' be null-terminated.
serialNumber	character-string serial number of the device. Must be padded with the blank character (' '). Should ''not'' be null-terminated.
flags	bit flags indicating capabilities and status of the device as defined below
ulMaxSessionCount	maximum number of sessions that can be opened with the token at one time by a single application (see note below)
ulSessionCount	number of sessions that this application currently has open with the token (see note below)
ulMaxRwSessionCount	maximum number of read/write sessions that can be opened with the token at one time by a single application (see note below)
ulRwSessionCount	number of read/write sessions that this application currently has open with the token (see note below)
ulMaxPinLen	maximum length in bytes of the PIN
ulMinPinLen	minimum length in bytes of the PIN
ulTotalPublicMemory	the total amount of memory on the token in bytes in which public objects may be stored (see note below)
ulFreePublicMemory	the amount of free (unused) memory on the token in bytes for public objects (see note below)
ulTotalPrivateMemory	the total amount of memory on the token in bytes in which private objects may be stored (see note below)
ulFreePrivateMemory	the amount of free (unused) memory on the token in bytes for private objects (see note below)
hardwareVersion	version number of hardware
firmwareVersion	version number of firmware
utcTime	current time as a character-string of length 16, represented in the format YYYYMMDDhhmmssxx (4 characters for the year; 2 characters each for the month, the day, the hour, the minute, and the second; and 2 additional reserved '0' characters). The value of this field only makes sense for tokens equipped with a clock, as indicated in the token information flags (see Table 10)

Table 10, Token Information Flags

Bit Flag	Mask	Meaning
CKF_RNG	0x00000001	TRUE if the token has its own random number generator
CKF_WRITE_PROTECTED	0x00000002	TRUE if the token is write-protected (see below)
CKF_LOGIN_REQUIRED	0x00000004	TRUE if there are some cryptographic functions that a user must be logged in to perform
CKF_USER_PIN_INITIALIZED	0x00000008	TRUE if the normal user's PIN has been initialized
CKF_RESTORE_KEY_NOT_NEEDED	0x00000020	TRUE if a successful save of a session's cryptographic operations state always contains all keys needed to restore the state of the session
CKF_CLOCK_ON_TOKEN	0x00000040	TRUE if token has its own hardware clock
CKF_PROTECTED_AUTHENTICATION_PATH	0x00000100	TRUE if token has a "protected authentication path", whereby a user can log into the token without passing a PIN through the Cryptoki library
CKF_DUAL_CRYPTO_OPERATIONS	0x00000200	TRUE if a single session with the token can perform dual cryptographic operations (see Section 11.13)
CKF_TOKEN_INITIALIZED	0x00000400	TRUE if the token has been initialized using C_InitializeToken or an equivalent mechanism outside the scope of this standard. Calling C_InitializeToken when this flag is set will cause the token to be reinitialized.
CKF_SECONDARY_AUTHENTICATION	0x00000800	TRUE if the token supports secondary authentication for private key objects.
CKF_USER_PIN_COUNT_LOW	0x00010000	TRUE if an incorrect user login PIN has been entered at least once since the last successful authentication.
CKF_USER_PIN_FINAL_TRY	0x00020000	TRUE if supplying an incorrect user PIN will it to become locked.
CKF_USER_PIN_LOCKED	0x00040000	TRUE if the user PIN has been locked. User login to the token is not possible.
CKF_USER_PIN_TO_BE_CHANGED	0x00080000	TRUE if the user PIN value is the default value set by token initialization or manufacturing.
CKF_SO_PIN_COUNT_LOW	0x00100000	TRUE if an incorrect SO login PIN has been entered at least once since the last successful authentication.
CKF_SO_PIN_FINAL_TRY	0x00200000	TRUE if supplying an incorrect SO PIN will it to become locked.
CKF_SO_PIN_LOCKED	0x00400000	TRUE if the user PIN has been locked. User login to the token is not possible.
CKF_SO_PIN_TO_BE_CHANGED	0x00800000	TRUE if the SO PIN value is the default value set by token initialization or manufacturing.

Exactly what the CKF_WRITE_PROTECTED flag means is not specified in Cryptoki. An application may be unable to perform certain actions on a write-protected token; these actions can include any of the following, among others:

Note: The fields ulMaxSessionCount, ulSessionCount, ulMaxRwSessionCount, ulRwSessionCount, ulTotalPublicMemory, ulFreePublicMemory, ulTotalPrivateMemory, and ulFreePrivateMemory can have the special value CK_UNAVAILABLE_INFORMATION, which means that the token and/or library is unable or unwilling to provide that information. In addition, the fields ulMaxSessionCount and ulMaxRwSessionCount can have the special value CK_EFFECTIVELY_INFINITE, which means that there is no practical limit on the number of sessions (resp. R/W sessions) an application can have open with the token.

#define CK_UNAVAILABLE_INFORMATION (~0UL)
#define CK_EFFECTIVELY_INFINITE 0

It is important to check these fields for these special values. This is particularly true for CK_EFFECTIVELY_INFINITE, since an application seeing this value in the ulMaxSessionCount or ulMaxRwSessionCount field would otherwise conclude that it can't open any sessions with the token, which is far from being the case.

The upshot of all this is that the correct way to interpret (for example) the ulMaxSessionCount field is something along the lines of the following:

CK_TOKEN_INFO info;
.
.
.
if ((CK_LONG) info.ulMaxSessionCount

/* Token refuses to give value of ulMaxSessionCount */
.
.
.
} else if (info.ulMaxSessionCount == CK_EFFECTIVELY_INFINITE) {
/* Application can open as many sessions as it wants */
.
.
.
} else {
/* ulMaxSessionCount really does contain what it should */
.
.
.
}

Slot and token types

CK_SLOT_ID; CK_SLOT_ID_PTR

CK_SLOT_INFO; CK_SLOT_INFO_PTR

CK_TOKEN_INFO; CK_TOKEN_INFO_PTR