com.entrust.toolkit.pkcs11

Class MechanismInfo

java.lang.Object

com.entrust.toolkit.pkcs11.MechanismInfo

public class MechanismInfo
extends java.lang.Object

Represents a structure that provides information about a particular mechanism possibly supported by a token.

The structure is defined as follows:

 typedef struct CK_MECHANISM_INFO {
      CK_ULONG ulMinKeySize;
      CK_ULONG ulMaxKeySize;
      CK_FLAGS flags;
 } CK_MECHANISM_INFO;
 

Field Summary

Fields

Modifier and Type	Field and Description
static long	CKF_DECRYPT Indicates the mechanism can be used to Decrypt.
static long	CKF_DERIVE Indicates the mechanism can be used to Derive keys.
static long	CKF_DIGEST Indicate the mechanism can be used to Digest.
static long	CKF_ENCRYPT Indicates the mechanism can be used to Encrypt.
static long	CKF_EXTENSION Indicates there is an extension to the flags.
static long	CKF_GENERATE Indicates the mechanism can be used to Generate keys.
static long	CKF_GENERATE_KEY_PAIR Indicates the mechanism can be used to Generate key pairs.
static long	CKF_HW Indicates the mechanism is performed by the device (otherwise it is performed in software).
static long	CKF_SIGN Indicates the mechanism can be used to Sign.
static long	CKF_SIGN_RECOVER Indicates the mechanism can be used to Sign/Recover.
static long	CKF_UNWRAP Indicates the mechanism can be used to Unwrap keys.
static long	CKF_VERIFY Indicates the mechanism can be used to Verify.
static long	CKF_VERIFY_RECOVER Indicates the mechanism can be used to Verify/Recover.
static long	CKF_WRAP Indicates the mechanism can be used to Wrap keys.

Method Summary

Modifier and Type	Method and Description
long	getFlags() Returns the flags component.
long	getMaxKeySize() Returns the maximum key size component.
long	getMinKeySize() Returns the minimum key size component.
boolean	isFlagSet(long flag) Indicates if a given flag has been set.
java.lang.String	toString() Returns a String representation of the MechanismInfo object.
java.lang.String	toString(boolean flagNames) Returns a String representation of the MechanismInfo object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CKF_HW

public static final long CKF_HW

Indicates the mechanism is performed by the device (otherwise it is performed in software).

See Also:

Constant Field Values

CKF_ENCRYPT

public static final long CKF_ENCRYPT

Indicates the mechanism can be used to Encrypt.

See Also:

Constant Field Values

CKF_DECRYPT

public static final long CKF_DECRYPT

Indicates the mechanism can be used to Decrypt.

See Also:

Constant Field Values

CKF_DIGEST

public static final long CKF_DIGEST

Indicate the mechanism can be used to Digest.

See Also:

Constant Field Values

CKF_SIGN

public static final long CKF_SIGN

Indicates the mechanism can be used to Sign.

See Also:

Constant Field Values

CKF_SIGN_RECOVER

public static final long CKF_SIGN_RECOVER

Indicates the mechanism can be used to Sign/Recover.

See Also:

Constant Field Values

CKF_VERIFY

public static final long CKF_VERIFY

Indicates the mechanism can be used to Verify.

See Also:

Constant Field Values

CKF_VERIFY_RECOVER

public static final long CKF_VERIFY_RECOVER

Indicates the mechanism can be used to Verify/Recover.

See Also:

Constant Field Values

CKF_GENERATE

public static final long CKF_GENERATE

Indicates the mechanism can be used to Generate keys.

See Also:

Constant Field Values

CKF_GENERATE_KEY_PAIR

public static final long CKF_GENERATE_KEY_PAIR

Indicates the mechanism can be used to Generate key pairs.

See Also:

Constant Field Values

CKF_WRAP

public static final long CKF_WRAP

Indicates the mechanism can be used to Wrap keys.

See Also:

Constant Field Values

CKF_UNWRAP

public static final long CKF_UNWRAP

Indicates the mechanism can be used to Unwrap keys.

See Also:

Constant Field Values

CKF_DERIVE

public static final long CKF_DERIVE

Indicates the mechanism can be used to Derive keys.

See Also:

Constant Field Values

CKF_EXTENSION

public static final long CKF_EXTENSION

Indicates there is an extension to the flags.

See Also:

Constant Field Values

Method Detail

getMinKeySize

public long getMinKeySize()

Returns the minimum key size component.

Returns:

the minimum size of the key for the mechanism (whether this is measured in bits or in bytes is mechanism dependant)

getMaxKeySize

public long getMaxKeySize()

Returns the maximum key size component.

Returns:

the maximum size of the key for the mechanism (whether this is measured in bits or in bytes is mechanism dependant)

getFlags

public long getFlags()

Returns the flags component.

Returns:

bit flags specifying mechanism capabilities

isFlagSet

public boolean isFlagSet(long flag)

Indicates if a given flag has been set.

Parameters:

flag - the flag being checked

Returns:

true if the flag has been set; false otherwise

toString

public java.lang.String toString()

Returns a String representation of the MechanismInfo object.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the MechanismInfo bject

toString

public java.lang.String toString(boolean flagNames)

Returns a String representation of the MechanismInfo object.

Parameters:

flagNames - this 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 MechanismInfo object