com.safenetinc.luna.provider.key

Class LunaSecretKey

java.lang.Object

com.safenetinc.luna.provider.key.LunaKey

com.safenetinc.luna.provider.key.LunaSecretKey

All Implemented Interfaces:

Serializable, Key, SecretKey

Direct Known Subclasses:

LunaSecretKeyPBE, LunaSecretKeyPBKDF2

public class LunaSecretKey
extends LunaKey
implements SecretKey

Base class for all secret keys stored on Luna hardware.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.safenetinc.luna.provider.key.LunaKey

AES_KWP_WRAP_IV, keySize, lapi, mKeyClass, mKeyType, mObject, UNLIMITED_USE, WRAP_IV

Fields inherited from interface javax.crypto.SecretKey

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
LunaSecretKey(int hKey)
LunaSecretKey(int hKey, int slot)
LunaSecretKey(int hKey, int slot, long keyType)
LunaSecretKey(int hKey, int slot, Map<Long,Object> sessionParameters)
LunaSecretKey(LunaTokenObject object)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	ExtractSecretKey() Extract a Luna secret key from the token
protected byte[]	getEncodedInternal()
String	getFormat() Returns the name of the format used to encode the LunaKey object.
static LunaSecretKey	InjectSecretKey(byte[] keyBytes) Inject (encrypt encoded key and unwrap) an encoded secret key (of type "Generic Secret") into the token at the default slot.
static LunaSecretKey	InjectSecretKey(byte[] keyBytes, String algorithm) Inject (encrypt encoded key and unwrap) an encoded secret key into the token at the default slot.
static LunaSecretKey	InjectSecretKey(byte[] keyBytes, String algorithm, int slot) Inject (encrypt encoded key and unwrap) an encoded secret key into the token at the specified slot.
static LunaSecretKey	InjectSecretKey(SecretKey key) Inject (encrypt encoded key and unwrap) a non-Luna secret key into the token at the default slot.
static LunaSecretKey	InjectSecretKey(SecretKey key, int slot) Inject (encrypt encoded key and unwrap) a non-Luna secret key into the token at the specified slot.

Methods inherited from class com.safenetinc.luna.provider.key.LunaKey

AttributeToBigInteger, BigIntegerToAttribute, DestroyKey, equals, getAlgorithm, GetAlias, GetDateMadePersistent, getEncoded, GetFingerprint, getKeyByType, GetKeyClass, GetKeyHandle, getKeySize, getKeyType, GetKeyType, getSession, getSlot, getUsageCount, getUsageLimit, hashCode, Initialize, Initialize, injectKey, InjectPrivateKey, InjectPrivateKey, InjectPrivateKey, InjectPrivateKey, isInitialized, IsKeyPersistent, LocateKeyByAlias, LocateKeyByAlias, LocateKeyByFingerprint, LocateKeyByFingerprint, LocateKeyByHandle, LocateKeyByHandle, LocateKeyOnlyByAlias, LocateKeyOnlyByAlias, MakePersistent, release, setKeySize, setUsageCount, setUsageLimit, toString, verifyClassAndType

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded

Constructor Detail

LunaSecretKey

public LunaSecretKey(int hKey)

LunaSecretKey

public LunaSecretKey(int hKey,
             int slot)

LunaSecretKey

public LunaSecretKey(int hKey,
             int slot,
             long keyType)

LunaSecretKey

public LunaSecretKey(int hKey,
             int slot,
             Map<Long,Object> sessionParameters)

LunaSecretKey

public LunaSecretKey(LunaTokenObject object)

Method Detail

getFormat

public String getFormat()

Description copied from class: LunaKey

Returns the name of the format used to encode the LunaKey object.

This will be one of

• proprietary: keys with sensitive information, where the LunaKey only contains a reference to the handle of the key; the actual key bytes can't be extracted for encoding
• X.509: public keys
• RAW: secret keys, if they're set to be extractable

Specified by:

getFormat in interface Key

Overrides:

getFormat in class LunaKey

Returns:

the format of the encoded key

getEncodedInternal

protected byte[] getEncodedInternal()

Overrides:

getEncodedInternal in class LunaKey

InjectSecretKey

public static LunaSecretKey InjectSecretKey(SecretKey key)
                                     throws InvalidKeyException

Inject (encrypt encoded key and unwrap) a non-Luna secret key into the token at the default slot.

Parameters:

key - The non-Luna key object

Returns:

The corresponding Luna secret key

Throws:

InvalidKeyException - If the key is not encoded in RAW format

LunaException - If there is a problem creating/injecting the keys on the HSM

InjectSecretKey

public static LunaSecretKey InjectSecretKey(SecretKey key,
                            int slot)
                                     throws InvalidKeyException

Inject (encrypt encoded key and unwrap) a non-Luna secret key into the token at the specified slot.

Parameters:

key - The non-Luna key object

slot - The slot of the token to inject the key into

Returns:

The corresponding Luna secret key

Throws:

InvalidKeyException - If the key is not encoded in RAW format

LunaException - If there is a problem creating/injecting the keys on the HSM

InjectSecretKey

public static LunaSecretKey InjectSecretKey(byte[] keyBytes)

Inject (encrypt encoded key and unwrap) an encoded secret key (of type "Generic Secret") into the token at the default slot.

Parameters:

keyBytes - The RAW non-Luna key bytes

Returns:

The corresponding Luna secret key

Throws:

LunaException - If there is a problem creating/injecting the keys on the HSM

InjectSecretKey

public static LunaSecretKey InjectSecretKey(byte[] keyBytes,
                            String algorithm)

Inject (encrypt encoded key and unwrap) an encoded secret key into the token at the default slot.

Parameters:

keyBytes - The RAW non-Luna key bytes

algorithm - The secret key algorithm

Returns:

The corresponding Luna secret key

Throws:

LunaException - If there is a problem creating/injecting the keys on the HSM

InjectSecretKey

public static LunaSecretKey InjectSecretKey(byte[] keyBytes,
                            String algorithm,
                            int slot)

Inject (encrypt encoded key and unwrap) an encoded secret key into the token at the specified slot.

Parameters:

keyBytes - The RAW non-Luna key bytes

algorithm - The secret key algorithm

slot - The slot of the token to inject the key into

Returns:

The corresponding Luna secret key

Throws:

LunaException - If there is a problem creating/injecting the keys on the HSM

ExtractSecretKey

public byte[] ExtractSecretKey()
                        throws LunaException

Extract a Luna secret key from the token

Returns:

secret key material

Throws:

LunaException