com.safenetinc.luna.provider.key

Class LunaSIMKey

java.lang.Object

com.safenetinc.luna.provider.key.LunaSIMKey

All Implemented Interfaces:

Serializable, Key

public class LunaSIMKey
extends Object
implements Key

Special interface to SIM/unSIM LunaKeys

See Also:

Serialized Form

Field Summary

Fields inherited from interface java.security.Key

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
LunaSIMKey() Default constructor.
LunaSIMKey(byte[] blob) Create a LunaSIMKey an initialize its blob
LunaSIMKey(Key key) SIM a Key with CKA_SIM_NO_AUTHORIZATION
LunaSIMKey(Key key, char[] password) SIM a Key with CKA_SIM_NO_AUTHORIZATION or CKA_SIM_PASSWORD and M=N=1
LunaSIMKey(Key key, int authSubsetCount, Collection<String> authSecretList) SIM a Key with CKA_SIM_PASSWORD
LunaSIMKey(Key key, int authSecretCount, int authSubsetCount, int authForm) SIM a Key with CKA_SIM_CHALLENGE or CKA_SIM_SECURE_PORT

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm()
byte[]	getEncoded()
String	getFormat()
LunaKey	getKey() UnSIM the key with CKA_SIM_NO_AUTHORIZATION
LunaKey	getKey(char[] password) UnSIM the key with CKA_SIM_NO_AUTHORIZATION or CKA_SIM_PASSWORD and M=N=1
LunaKey	getKey(int authForm, Collection<String> authSecretList) UnSIM the key with any auth form Kept for backwards compatibility.
LunaKey	getKey(long authForm, Collection<String> authSecretList) UnSIM the key with any auth form
static byte[]	SIMExtract(LunaKey[] lunaKeys, int authSecretCount, int authSubsetCount, long authForm, Collection<String> authSecretList) Extract a key blob from the HSM.
static LunaKey[]	SIMInsert(long authForm, Collection<String> authSecretList, byte[] blob) Insert a key blob onto the HSM.
String	toString() Returns a string representation of the key

Methods inherited from class java.lang.Object

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

Constructor Detail

LunaSIMKey

public LunaSIMKey()

Default constructor. Creates an uninitialized LunaSIMKey object.

LunaSIMKey

public LunaSIMKey(byte[] blob)

Create a LunaSIMKey an initialize its blob

Parameters:

blob - The key blob

LunaSIMKey

public LunaSIMKey(Key key)
           throws InvalidKeyException

SIM a Key with CKA_SIM_NO_AUTHORIZATION

Parameters:

key - a key object

Throws:

InvalidKeyException - exception

LunaSIMKey

public LunaSIMKey(Key key,
                  char[] password)
           throws InvalidKeyException

SIM a Key with CKA_SIM_NO_AUTHORIZATION or CKA_SIM_PASSWORD and M=N=1

Parameters:

key - a key object

password - SIM password

Throws:

InvalidKeyException - exception

LunaSIMKey

public LunaSIMKey(Key key,
                  int authSecretCount,
                  int authSubsetCount,
                  int authForm)
           throws InvalidKeyException

SIM a Key with CKA_SIM_CHALLENGE or CKA_SIM_SECURE_PORT

Parameters:

key - a key object

authSecretCount - N value

authSubsetCount - M value

authForm - authentication type

Throws:

InvalidKeyException - exception

LunaSIMKey

public LunaSIMKey(Key key,
                  int authSubsetCount,
                  Collection<String> authSecretList)
           throws InvalidKeyException

SIM a Key with CKA_SIM_PASSWORD

Parameters:

key - a key object

authSubsetCount - M value

authSecretList - Collection of password Strings

Throws:

InvalidKeyException - exception

Method Detail

getKey

public LunaKey getKey()
               throws InvalidKeyException

UnSIM the key with CKA_SIM_NO_AUTHORIZATION

Returns:

a key object

Throws:

InvalidKeyException - exception

getKey

public LunaKey getKey(char[] password)
               throws InvalidKeyException

UnSIM the key with CKA_SIM_NO_AUTHORIZATION or CKA_SIM_PASSWORD and M=N=1

Parameters:

password - SIM password

Returns:

a key object

Throws:

InvalidKeyException - exception

getKey

public LunaKey getKey(int authForm,
                      Collection<String> authSecretList)
               throws InvalidKeyException

UnSIM the key with any auth form Kept for backwards compatibility.

Parameters:

authForm - authentication type

authSecretList - authentication list

Returns:

a key object

Throws:

InvalidKeyException - exception

getKey

public LunaKey getKey(long authForm,
                      Collection<String> authSecretList)
               throws InvalidKeyException

UnSIM the key with any auth form

Parameters:

authForm - authentication type

authSecretList - authentication list

Returns:

a key object

Throws:

InvalidKeyException - exception

toString

public String toString()

Returns a string representation of the key

Overrides:

toString in class Object

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface Key

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

SIMInsert

public static LunaKey[] SIMInsert(long authForm,
                                  Collection<String> authSecretList,
                                  byte[] blob)
                           throws InvalidKeyException

Insert a key blob onto the HSM. The keys will be put into the current default slot.

Parameters:

authForm - The auth form.

authSecretList - A Collection of the password Strings

blob - The key blob

Returns:

LunaKey[] the LunaKey array.

Throws:

InvalidKeyException - if the authSecretList is specified and its size doesn't match authSecretCount.

SIMExtract

public static byte[] SIMExtract(LunaKey[] lunaKeys,
                                int authSecretCount,
                                int authSubsetCount,
                                long authForm,
                                Collection<String> authSecretList)
                         throws InvalidKeyException

Extract a key blob from the HSM.

Parameters:

lunaKeys - The array of LunaKeys to be extracted. All of these keys must be in the same slot

authSecretCount - The N value

authSubsetCount - The M value

authForm - The auth form.

authSecretList - A Collection of the password Strings

Returns:

byte[] the key blob.

Throws:

InvalidKeyException - if the authSecretList is specified and its size doesn't match authSecretCount.