TokenInfo ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.pkcs11.TokenInfo

public class TokenInfo
extends java.lang.Object

Represents a structure that provides information about a token.

The structure is defined as follows:

 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;

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`CKF_CLOCK_ON_TOKEN` Indicates the token has its own hardware clock.
`static long`	`CKF_DUAL_CRYPTO_OPERATIONS` Indicates that a single session with the token can perform dual cryptographic operations.
`static long`	`CKF_LOGIN_REQUIRED` Indicates there are some cryptographic functions that a user must be logged in to perform.
`static long`	`CKF_PROTECTED_AUTHENTICATION_PATH` Indicates the token has a "protected authentication path", whereby a user can log into the token without passing a PIN through the Cryptoki library.
`static long`	`CKF_RESTORE_KEY_NOT_NEEDED` Indicates that a successful save of a session's cryptographic operations state always contains all keys needed to restore the state of the session.
`static long`	`CKF_RNG` Indicates the token has its own random number generator.
`static long`	`CKF_SECONDARY_AUTHENTICATION` Indicates the token supports secondary authentication for private key objects.
`static long`	`CKF_SO_PIN_COUNT_LOW` Indicates an incorrect SO login PIN has been entered at least once since the last successful authentication.
`static long`	`CKF_SO_PIN_FINAL_TRY` Indicates that supplying an incorrect SO PIN will force the PIN to become locked.
`static long`	`CKF_SO_PIN_LOCKED` Indicates the SO PIN has been locked - SO login to the token is not possible.
`static long`	`CKF_SO_PIN_TO_BE_CHANGED` Indicates the SO PIN value is the default value set by token initialization or manufacturing.
`static long`	`CKF_TOKEN_INITIALIZED` Indicates the token has been initialized.
`static long`	`CKF_USER_PIN_COUNT_LOW` Indicates an incorrect user login PIN has been entered at least once since the last successful authentication.
`static long`	`CKF_USER_PIN_FINAL_TRY` Indicates that supplying an incorrect user PIN will force the PIN to become locked.
`static long`	`CKF_USER_PIN_INITIALIZED` Indicates the normal user's PIN has been initialized.
`static long`	`CKF_USER_PIN_LOCKED` Indicates the user PIN has been locked - user login to the token is not possible.
`static long`	`CKF_USER_PIN_TO_BE_CHANGED` Indicates the user PIN value is the default value set by token initialization or manufacturing.
`static long`	`CKF_WRITE_PROTECTED` Inidcates the token is write-protected.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`dualCryptoOperationsSupported()` Deprecated. use `isFlagSet( TokenInfo.CKF_DUAL_CRYPTO_OPERATIONS )` instead, since JTK 6.1
`java.lang.String`	`getFirmwareVersion()` Returns the firmware version component.
`long`	`getFlags()` Returns the flags component.
`long`	`getFreePrivateMemory()` Returns the free private memory component.
`long`	`getFreePublicMemory()` Returns the free public memory component.
`java.lang.String`	`getHardwareVersion()` Returns the hardware version component.
`java.lang.String`	`getLabel()` Returns the label component.
`java.lang.String`	`getManufacturerID()` Returns the manufacturer ID component.
`long`	`getMaxPinLen()` Returns the maximuim PIN length component.
`long`	`getMaxRwSessionCount()` Returns the maximum read/write session count component.
`long`	`getMaxSessionCount()` Returns the maximum session count component.
`long`	`getMinPinLen()` Returns the minimuim PIN length component.
`java.lang.String`	`getModel()` Returns the model component.
`long`	`getRwSessionCount()` Returns the read/write session count component.
`java.lang.String`	`getSerialNumber()` Returns the serial number component.
`long`	`getSessionCount()` Returns the session count component.
`long`	`getTotalPrivateMemory()` Returns the total private memory component.
`long`	`getTotalPublicMemory()` Returns the total public memory component.
`java.lang.String`	`getUtcTime()` Returns the UTC time component.
`boolean`	`hasProtAuthPath()` Deprecated. use `isFlagSet( TokenInfo.CKF_PROTECTED_AUTHENTICATION_PATH )` instead, since JTK 6.1
`boolean`	`isClockOnToken()` Deprecated. use `isFlagSet( TokenInfo.CKF_CLOCK_ON_TOKEN )` instead, since JTK 6.1
`boolean`	`isFlagSet(long flag)` Indicates whether a given flag has been set.
`boolean`	`isLoginRequired()` Deprecated. use `isFlagSet( TokenInfo.CKF_LOGIN_REQUIRED )` instead, since JTK 6.1
`boolean`	`isRestoreKeyNotNeeded()` Deprecated. use `isFlagSet( TokenInfo.CKF_RESTORE_KEY_NOT_NEEDED )` instead, since JTK 6.1
`boolean`	`isRNGSupported()` Deprecated. use `isFlagSet( TokenInfo.CKF_RNG )` instead, since JTK 6.1
`boolean`	`isUserPINInitialized()` Deprecated. use `isFlagSet( TokenInfo.CKF_USER_PIN_INITIALIZED )` instead, since JTK 6.1
`boolean`	`isWriteProtected()` Deprecated. use `isFlagSet( TokenInfo.CKF_WRITE_PROTECTED )` instead, since JTK 6.1
`java.lang.String`	`toString()` Returns a `String` representation of the `TokenInfo` object.
`java.lang.String`	`toString(boolean flagNames)` Returns a `String` representation of the `TokenInfo` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CKF_RNG
```
public static final long CKF_RNG
```
    Indicates the token has its own random number generator.
    
    See Also:
    Constant Field Values
  - CKF_WRITE_PROTECTED
```
public static final long CKF_WRITE_PROTECTED
```
    Inidcates the token is write-protected.
    
    See Also:
    Constant Field Values
  - CKF_LOGIN_REQUIRED
```
public static final long CKF_LOGIN_REQUIRED
```
    Indicates there are some cryptographic functions that a user must be logged in to perform.
    
    See Also:
    Constant Field Values
  - CKF_USER_PIN_INITIALIZED
```
public static final long CKF_USER_PIN_INITIALIZED
```
    Indicates the normal user's PIN has been initialized.
    
    See Also:
    Constant Field Values
  - CKF_RESTORE_KEY_NOT_NEEDED
```
public static final long CKF_RESTORE_KEY_NOT_NEEDED
```
    Indicates that a successful save of a session's cryptographic operations state always contains all keys needed to restore the state of the session.
    
    See Also:
    Constant Field Values
  - CKF_CLOCK_ON_TOKEN
```
public static final long CKF_CLOCK_ON_TOKEN
```
    Indicates the token has its own hardware clock.
    
    See Also:
    Constant Field Values
  - CKF_PROTECTED_AUTHENTICATION_PATH
```
public static final long CKF_PROTECTED_AUTHENTICATION_PATH
```
    Indicates the token has a "protected authentication path", whereby a user can log into the token without passing a PIN through the Cryptoki library.
    
    See Also:
    Constant Field Values
  - CKF_DUAL_CRYPTO_OPERATIONS
```
public static final long CKF_DUAL_CRYPTO_OPERATIONS
```
    Indicates that a single session with the token can perform dual cryptographic operations.
    
    See Also:
    Constant Field Values
  - CKF_TOKEN_INITIALIZED
```
public static final long CKF_TOKEN_INITIALIZED
```
    Indicates the token has been initialized.
    
    See Also:
    Constant Field Values
  - CKF_SECONDARY_AUTHENTICATION
```
public static final long CKF_SECONDARY_AUTHENTICATION
```
    Indicates the token supports secondary authentication for private key objects.
    
    See Also:
    Constant Field Values
  - CKF_USER_PIN_COUNT_LOW
```
public static final long CKF_USER_PIN_COUNT_LOW
```
    Indicates an incorrect user login PIN has been entered at least once since the last successful authentication.
    
    See Also:
    Constant Field Values
  - CKF_USER_PIN_FINAL_TRY
```
public static final long CKF_USER_PIN_FINAL_TRY
```
    Indicates that supplying an incorrect user PIN will force the PIN to become locked.
    
    See Also:
    Constant Field Values
  - CKF_USER_PIN_LOCKED
```
public static final long CKF_USER_PIN_LOCKED
```
    Indicates the user PIN has been locked - user login to the token is not possible.
    
    See Also:
    Constant Field Values
  - CKF_USER_PIN_TO_BE_CHANGED
```
public static final long CKF_USER_PIN_TO_BE_CHANGED
```
    Indicates the user PIN value is the default value set by token initialization or manufacturing.
    
    See Also:
    Constant Field Values
  - CKF_SO_PIN_COUNT_LOW
```
public static final long CKF_SO_PIN_COUNT_LOW
```
    Indicates an incorrect SO login PIN has been entered at least once since the last successful authentication.
    
    See Also:
    Constant Field Values
  - CKF_SO_PIN_FINAL_TRY
```
public static final long CKF_SO_PIN_FINAL_TRY
```
    Indicates that supplying an incorrect SO PIN will force the PIN to become locked.
    
    See Also:
    Constant Field Values
  - CKF_SO_PIN_LOCKED
```
public static final long CKF_SO_PIN_LOCKED
```
    Indicates the SO PIN has been locked - SO login to the token is not possible.
    
    See Also:
    Constant Field Values
  - CKF_SO_PIN_TO_BE_CHANGED
```
public static final long CKF_SO_PIN_TO_BE_CHANGED
```
    Indicates the SO PIN value is the default value set by token initialization or manufacturing.
    
    See Also:
    Constant Field Values
- Method Detail
  - getLabel
```
public java.lang.String getLabel()
```
    Returns the label component.
    
    Returns:
    application-defined label, assigned during token initialization
  - getManufacturerID
```
public java.lang.String getManufacturerID()
```
    Returns the manufacturer ID component.
    
    Returns:
    the ID of the device manufacturer
  - getModel
```
public java.lang.String getModel()
```
    Returns the model component.
    
    Returns:
    the model of the device
  - getSerialNumber
```
public java.lang.String getSerialNumber()
```
    Returns the serial number component.
    
    Returns:
    the character-string serial number of the device
  - getFlags
```
public long getFlags()
```
    Returns the flags component.
    
    Returns:
    bit flags indicating capabilities and status of the device
  - isFlagSet
```
public boolean isFlagSet(long flag)
```
    Indicates whether a given flag has been set.
    
    Parameters:
    flag - the flag being checked
    
    Returns:
    true if the flag has been set, false otherwise
  - getMaxSessionCount
```
public long getMaxSessionCount()
```
    Returns the maximum session count component.
    
    Returns:
    the maximum number of sessions that can be opened with the token at one time by a single application
  - getSessionCount
```
public long getSessionCount()
```
    Returns the session count component.
    
    Returns:
    the mumber of sessions that this application currently has open with the token
  - getMaxRwSessionCount
```
public long getMaxRwSessionCount()
```
    Returns the maximum read/write session count component.
    
    Returns:
    the Maximum number of read/write sessions that can be opened with the token at one time by a single application
  - getRwSessionCount
```
public long getRwSessionCount()
```
    Returns the read/write session count component.
    
    Returns:
    the number of read/write sessions that this application currently has open with the token
  - getMaxPinLen
```
public long getMaxPinLen()
```
    Returns the maximuim PIN length component.
    
    Returns:
    the maximum length in bytes of the PIN
  - getMinPinLen
```
public long getMinPinLen()
```
    Returns the minimuim PIN length component.
    
    Returns:
    the minimum length in bytes of the PIN
  - getTotalPublicMemory
```
public long getTotalPublicMemory()
```
    Returns the total public memory component.
    
    Returns:
    the total amount of memory on the token in bytes in which public objects may be stored
  - getFreePublicMemory
```
public long getFreePublicMemory()
```
    Returns the free public memory component.
    
    Returns:
    the amount of free (unused) memory on the token in bytes for public objects
  - getTotalPrivateMemory
```
public long getTotalPrivateMemory()
```
    Returns the total private memory component.
    
    Returns:
    the total amount of memory on the token in bytes in which private objects may be stored
  - getFreePrivateMemory
```
public long getFreePrivateMemory()
```
    Returns the free private memory component.
    
    Returns:
    the amount of free (unused) memory on the token in bytes for private objects
  - getHardwareVersion
```
public java.lang.String getHardwareVersion()
```
    Returns the hardware version component.
    
    Returns:
    version number of the hardware
  - getFirmwareVersion
```
public java.lang.String getFirmwareVersion()
```
    Returns the firmware version component.
    
    Returns:
    version number of the firmware
  - getUtcTime
```
public java.lang.String getUtcTime()
```
    Returns the UTC time component.
    The value of this field only makes sense for tokens equipped with a clock, as indicated in the token information flags.
    
    Returns:
    the 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)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of the TokenInfo object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a String representation of the TokenInfo object
  - toString
```
public java.lang.String toString(boolean flagNames)
```
    Returns a String representation of the TokenInfo object.
    
    Parameters:
    flagNames - indicates that the flags component should be represented as a list of the flags that have been set; otherwise the actual flag value will be returned
    
    Returns:
    a String representation of the TokenInfo object
  - isRNGSupported
```
public boolean isRNGSupported()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_RNG ) instead, since JTK 6.1
    
    Indicates if the CKF_RNG flag has been set.
    
    Returns:
    true if the flag has been set, false otherwise
  - isWriteProtected
```
public boolean isWriteProtected()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_WRITE_PROTECTED ) instead, since JTK 6.1
    
    Indicates if the CKF_WRITE_PROTECTED flag has been set.
    
    Returns:
    true if the flag has been set; false otherwise
  - isLoginRequired
```
public boolean isLoginRequired()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_LOGIN_REQUIRED ) instead, since JTK 6.1
    
    Indicates if the CKF_LOGIN_REQUIRED flag has been set.
    
    Returns:
    true if the flag has been set; false otherwise
  - isUserPINInitialized
```
public boolean isUserPINInitialized()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_USER_PIN_INITIALIZED ) instead, since JTK 6.1
    
    Indicates if the CKF_USER_PIN_INITIALIZED flag has been set.
    
    Returns:
    true if the flag has been set, false otherwise
  - isRestoreKeyNotNeeded
```
public boolean isRestoreKeyNotNeeded()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_RESTORE_KEY_NOT_NEEDED ) instead, since JTK 6.1
    
    Indicates if the CKF_RESTORE_KEY_NOT_NEEDED flag has been set.
    
    Returns:
    true if the flag has been set, false otherwise
  - isClockOnToken
```
public boolean isClockOnToken()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_CLOCK_ON_TOKEN ) instead, since JTK 6.1
    
    Indicates if the CKF_CLOCK_ON_TOKEN flag has been set.
    
    Returns:
    true if the flag has been set, false otherwise
  - hasProtAuthPath
```
public boolean hasProtAuthPath()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_PROTECTED_AUTHENTICATION_PATH ) instead, since JTK 6.1
    
    Indicates if the CKF_PROTECTED_AUTHENTICATION_PATH flag has been set.
    
    Returns:
    true if the flag has been set, false otherwise
  - dualCryptoOperationsSupported
```
public boolean dualCryptoOperationsSupported()
```
    Deprecated. use isFlagSet( TokenInfo.CKF_DUAL_CRYPTO_OPERATIONS ) instead, since JTK 6.1
    
    Indicates if the CKF_DUAL_CRYPTO_OPERATIONS flag has been set.
    
    Returns:
    true if the flag has been set, false otherwise

Class TokenInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CKF_RNG

CKF_WRITE_PROTECTED

CKF_LOGIN_REQUIRED

CKF_USER_PIN_INITIALIZED

CKF_RESTORE_KEY_NOT_NEEDED

CKF_CLOCK_ON_TOKEN

CKF_PROTECTED_AUTHENTICATION_PATH

CKF_DUAL_CRYPTO_OPERATIONS

CKF_TOKEN_INITIALIZED

CKF_SECONDARY_AUTHENTICATION

CKF_USER_PIN_COUNT_LOW

CKF_USER_PIN_FINAL_TRY

CKF_USER_PIN_LOCKED

CKF_USER_PIN_TO_BE_CHANGED

CKF_SO_PIN_COUNT_LOW

CKF_SO_PIN_FINAL_TRY

CKF_SO_PIN_LOCKED

CKF_SO_PIN_TO_BE_CHANGED

Method Detail

getLabel

getManufacturerID

getModel

getSerialNumber

getFlags

isFlagSet

getMaxSessionCount

getSessionCount

getMaxRwSessionCount

getRwSessionCount

getMaxPinLen

getMinPinLen

getTotalPublicMemory

getFreePublicMemory

getTotalPrivateMemory

getFreePrivateMemory

getHardwareVersion

getFirmwareVersion

getUtcTime

toString

toString

isRNGSupported

isWriteProtected

isLoginRequired

isUserPINInitialized

isRestoreKeyNotNeeded

isClockOnToken

hasProtAuthPath

dualCryptoOperationsSupported