Class SecurePrivateKey

java.lang.Object

org.jpos.security.SecureKey

org.jpos.security.SecureVariantKey

org.jpos.security.SecurePrivateKey

All Implemented Interfaces:

Serializable, Loggeable

public class SecurePrivateKey
extends SecureVariantKey
implements Serializable

The SecurePrivateKey class wraps any private key, which is protected by the security module with variant methods.

The wrapped private key should be in the secure proprietary format of the security module.

The keyType indicates type of private key (currently only RSA keys are supported - others may be in future)

See Also:

• Serialized Form

Field Summary

Fields inherited from class SecureVariantKey

variant

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

Constructor	Description
SecurePrivateKey(String keyType, byte[] keyBytes)	Constructs an SecurePrivateKey.

Method Summary

Modifier and Type	Method	Description
void	dump(PrintStream p, String indent)	Dumps SecureRSAPrivateKey basic information.
KeyScheme	getScheme()	Gets the key scheme used to protect this key.
byte	getVariant()	Gets the key variant method used to protect this key.
void	setScheme(KeyScheme scheme)	Key scheme indicates protection metchod appiled to this key by the security module.
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, setKeyBytes, setKeyCheckValue, setKeyLength, setKeyName, setKeyType

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.
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.

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump

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

Constructor Details

SecurePrivateKey

public SecurePrivateKey(String keyType,
 byte[] keyBytes)

Constructs an SecurePrivateKey.

Parameters:

keyType - eg. SMAdapter.TYPE_RSA_PK or SMAdapter.TYPE_RSA_SK

keyBytes - private key in the secure proprietary format of the security module.

Method Details

setVariant

public void setVariant(byte variant)

Description copied from class: SecureVariantKey

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

Overrides:

setVariant in class SecureVariantKey

Parameters:

variant - key variant method used to protect this key.

getVariant

public byte getVariant()

Description copied from class: SecureVariantKey

Gets the key variant method used to protect this key.

Specified by:

getVariant in class SecureVariantKey

Returns:

key variant method used to protect this key.

setScheme

public void setScheme(KeyScheme scheme)

Description copied from class: SecureKey

Key scheme indicates protection metchod appiled to this key by the security module.

Overrides:

setScheme in class SecureKey

Parameters:

scheme - key scheme used to protect this key.

getScheme

public KeyScheme getScheme()

Description copied from class: SecureKey

Gets the key scheme used to protect this key.

Specified by:

getScheme in class SecureKey

Returns:

key scheme used to protect this key.

dump

public void dump(PrintStream p,
 String indent)

Dumps SecureRSAPrivateKey basic information.

Specified by:

dump in interface Loggeable

Parameters:

p - a PrintStream usually supplied by Logger

indent - indention string, usually suppiled by Logger