Class SecureVariantKey

java.lang.Object

org.jpos.security.SecureKey

org.jpos.security.SecureVariantKey

All Implemented Interfaces:

Serializable, Loggeable

Direct Known Subclasses:

SecureDESKey, SecurePrivateKey

public abstract class SecureVariantKey
extends SecureKey
implements Serializable

The SecureVariantKey class wraps any keys that are secured by the security module with variant methods.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Byte	variant	Indicates key protection variant metchod appiled to this key by a security module.

Fields inherited from class SecureKey

keyBytes, keyCheckValue, keyLength, keyName, keyType, scheme

Modifier and Type	Field	Description
protected byte[]	keyBytes	Secure Key Bytes
protected byte[]	keyCheckValue	The keyCheckValue allows identifying which clear key does this secure key represent.
protected short	keyLength	This is the bit length of the key This can be: LENGTH_DES, LENGTH_DES3_2KEY, ...
protected String	keyName	Optional key name
protected String	keyType	Key Type is useful for stating what this key can be used for.
protected KeyScheme	scheme	Key scheme indicates protection metchod appiled to this key by a security module.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SecureVariantKey()	Default constructor; no instance state to initialise.

Method Summary

Modifier and Type	Method	Description
abstract byte	getVariant()	Gets the key variant method used to protect this key.
void	setVariant(byte variant)	Sets key protection variant metchod appiled to this key by the security module.

Methods inherited from class SecureKey

getKeyBytes, getKeyCheckValue, getKeyLength, getKeyName, getKeyType, getScheme, setKeyBytes, setKeyCheckValue, setKeyLength, setKeyName, setKeyType, setScheme

Modifier and Type	Method	Description
byte[]	getKeyBytes()	Returns the secure (LMK-protected) key bytes.
byte[]	getKeyCheckValue()	The Key Check Value is typically a 24-bits (3 bytes) formed by encrypting a block of zeros under the secure key when the secure key is clear (not in this class, but inside the security module).
short	getKeyLength()	Returns the clear-key length in bits.
String	getKeyName()	Returns the optional key name.
String	getKeyType()	Key Type is useful for stating what this key can be used for.
abstract KeyScheme	getScheme()	Gets the key scheme used to protect this key.
void	setKeyBytes(byte[] keyBytes)	Sets the secure key bytes
void	setKeyCheckValue(byte[] keyCheckValue)	The Key Check Value is typically a 24-bits (3 bytes) formed by encrypting a block of zeros under the secure key when the secure key is clear (not in this class, but inside the security module).
void	setKeyLength(short keyLength)	Sets the length of the key (in bits) (when it was still clear).
void	setKeyName(String keyName)	Sets the optional key name.
void	setKeyType(String keyType)	Key Type is useful for stating what this key can be used for.
void	setScheme(KeyScheme scheme)	Key scheme indicates protection metchod appiled to this key by the security module.

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump, dump

Modifier and Type	Method	Description
void	dump(PrintStream p, String indent)	Dumps a human-readable representation of this object to the print stream.
default void	dump(PrintStream p, String indent, LogRenderer.Type type)	Dumps a representation of this object using the specified renderer type.

Field Details

variant

protected Byte variant

Indicates key protection variant metchod appiled to this key by a security module.

Constructor Details

SecureVariantKey

protected SecureVariantKey()

Default constructor; no instance state to initialise.

Method Details

setVariant

public void setVariant(byte variant)

Sets key protection variant metchod appiled to this key by the security module.

Parameters:

variant - key variant method used to protect this key.

getVariant

public abstract byte getVariant()

Gets the key variant method used to protect this key.

Returns:

key variant method used to protect this key.