iaik.pkcs.pkcs11

Class Mechanism

java.lang.Object

iaik.pkcs.pkcs11.Mechanism

public class Mechanism
extends Object

Objects of this class represent a mechanism as defined in PKCS#11. There are constants defined for all mechanisms that PKCS#11 version 2.11 defines.

Version:

1.0

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected Params	params The parameters of the mechanism.
protected long	pkcs11MechanismCode The code of the mechanism as defined in PKCS11Constants (or pkcs11t.h likewise).

Constructor Summary

Constructors

Constructor and Description
Mechanism(long pkcs11MechanismCode) Constructor taking just the mechanism code as defined in PKCS11Constants.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherObject) Override equals to check for the equality of mechanism code and parameter.
static Mechanism	get(long pkcs11MechanismCode) Gets the mechanism specified by the given mechanism code.
long	getMechanismCode() Get the code of this mechanism as defined in PKCS11Constants (of pkcs11t.h likewise).
String	getName() Get the name of this mechanism.
Params	getParams() Get the parameters object of this mechanism.
int	hashCode() Override hashCode to ensure that hashtable still works after overriding equals.
boolean	isDigestMechanism() This method checks, if this mechanism is a digest mechanism.
boolean	isFullEncryptDecryptMechanism() This method checks, if this mechanism is a full encrypt/decrypt mechanism; i.e.
boolean	isFullSignVerifyMechanism() This method checks, if this mechanism is a full sign/verify mechanism; i.e.
boolean	isKeyDerivationMechanism() This method checks, if this mechanism is a key derivation mechanism.
boolean	isKeyGenerationMechanism() This method checks, if this mechanism is a key generation mechanism for generating symmetric keys.
boolean	isKeyPairGenerationMechanism() This method checks, if this mechanism is a key-pair generation mechanism for generating key-pairs.
boolean	isSignVerifyRecoverMechanism() This method checks, if this mechanism is a sign/verify mechanism with message recovery.
boolean	isSingleOperationEncryptDecryptMechanism() This method checks, if this mechanism is a single-operation encrypt/decrypt mechanism; i.e.
boolean	isSingleOperationSignVerifyMechanism() This method checks, if this mechanism is a single-operation sign/verify mechanism; i.e.
boolean	isWrapUnwrapMechanism() This method checks, if this mechanism is a wrap/unwrap mechanism; i.e.
void	setParams(Params params) Set the parameters for this mechanism.
String	toString() Returns the string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

pkcs11MechanismCode

protected long pkcs11MechanismCode

The code of the mechanism as defined in PKCS11Constants (or pkcs11t.h likewise).

params

protected Params params

The parameters of the mechanism. Not all mechanisms use these parameters.

Constructor Detail

Mechanism

public Mechanism(long pkcs11MechanismCode)

Constructor taking just the mechanism code as defined in PKCS11Constants.

Parameters:

pkcs11MechanismCode - The mechanism code.

Method Detail

get

public static Mechanism get(long pkcs11MechanismCode)

Gets the mechanism specified by the given mechanism code. Helper PKCS11Constants is available.

Parameters:

pkcs11MechanismCode - the pkcs11 mechanism code

Returns:

the mechanism

equals

public boolean equals(Object otherObject)

Override equals to check for the equality of mechanism code and parameter.

Overrides:

equals in class Object

Parameters:

otherObject - The other Mechanism object.

Returns:

True, if other is an instance of this class and pkcs11MechanismCode and parameter of both objects are equal.

hashCode

public int hashCode()

Override hashCode to ensure that hashtable still works after overriding equals.

Overrides:

hashCode in class Object

Returns:

The hash code of this object. Taken from the mechanism code.

isDigestMechanism

public boolean isDigestMechanism()

This method checks, if this mechanism is a digest mechanism. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If Returns true, the mechanism can be used with the digest functions.

Returns:

True, if this mechanism is a digest mechanism. False, otherwise.

isFullEncryptDecryptMechanism

public boolean isFullEncryptDecryptMechanism()

This method checks, if this mechanism is a full encrypt/decrypt mechanism; i.e. it supports the encryptUpdate() and decryptUpdate() functions. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If Returns true, the mechanism can be used with the encrypt and decrypt functions including encryptUpdate and decryptUpdate.

Returns:

True, if this mechanism is a full encrypt/decrypt mechanism. False, otherwise.

isFullSignVerifyMechanism

public boolean isFullSignVerifyMechanism()

This method checks, if this mechanism is a full sign/verify mechanism; i.e. it supports the signUpdate() and verifyUpdate() functions. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If Returns true, the mechanism can be used with the sign and verify functions including signUpdate and verifyUpdate.

Returns:

True, if this mechanism is a full sign/verify mechanism. False, otherwise.

isKeyDerivationMechanism

public boolean isKeyDerivationMechanism()

This method checks, if this mechanism is a key derivation mechanism. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If Returns true, the mechanism can be used with the deriveKey function.

Returns:

True, if this mechanism is a key derivation mechanism. False, otherwise.

isKeyGenerationMechanism

public boolean isKeyGenerationMechanism()

This method checks, if this mechanism is a key generation mechanism for generating symmetric keys. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If Returns true, the mechanism can be used with the generateKey function.

Returns:

True, if this mechanism is a key generation mechanism. False, otherwise.

isKeyPairGenerationMechanism

public boolean isKeyPairGenerationMechanism()

This method checks, if this mechanism is a key-pair generation mechanism for generating key-pairs. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If this method returns true, the mechanism can be used with the generateKeyPair function.

Returns:

True, if this mechanism is a key-pair generation mechanism. False, otherwise.

isSignVerifyRecoverMechanism

public boolean isSignVerifyRecoverMechanism()

This method checks, if this mechanism is a sign/verify mechanism with message recovery. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If Returns true, the mechanism can be used with the signRecover and verifyRecover functions.

Returns:

True, if this mechanism is a sign/verify mechanism with message recovery. False, otherwise.

isSingleOperationEncryptDecryptMechanism

public boolean isSingleOperationEncryptDecryptMechanism()

This method checks, if this mechanism is a single-operation encrypt/decrypt mechanism; i.e. it does not support the encryptUpdate() and decryptUpdate() functions. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If this method returns true, the mechanism can be used with the encrypt and decrypt functions excluding encryptUpdate and decryptUpdate.

Returns:

True, if this mechanism is a single-operation encrypt/decrypt mechanism. False, otherwise.

isSingleOperationSignVerifyMechanism

public boolean isSingleOperationSignVerifyMechanism()

This method checks, if this mechanism is a single-operation sign/verify mechanism; i.e. it does not support the signUpdate() and encryptUpdate() functions. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If this method returns true, the mechanism can be used with the sign and verify functions excluding signUpdate and encryptUpdate.

Returns:

True, if this mechanism is a single-operation sign/verify mechanism. False, otherwise.

isWrapUnwrapMechanism

public boolean isWrapUnwrapMechanism()

This method checks, if this mechanism is a wrap/unwrap mechanism; i.e. it supports the wrapKey() and unwrapKey() functions. This is the information as provided by the table on page 229 of the PKCS#11 v2.11 standard. If this method returns true, the mechanism can be used with the wrapKey and unwrapKey functions.

Returns:

True, if this mechanism is a wrap/unwrap mechanism. False, otherwise.

getParams

public Params getParams()

Get the parameters object of this mechanism.

Returns:

The parameters of this mechanism. May be null.

setParams

public void setParams(Params params)

Set the parameters for this mechanism.

Parameters:

params - The mechanism parameters to set.

getMechanismCode

public long getMechanismCode()

Get the code of this mechanism as defined in PKCS11Constants (of pkcs11t.h likewise).

Returns:

The code of this mechanism.

getName

public String getName()

Get the name of this mechanism.

Returns:

The name of this mechanism.

toString

public String toString()

Returns the string representation of this object.

Overrides:

toString in class Object

Returns:

the string representation of this object