com.microej.crypto.internal.secretkey

Class NativeSecretKey

java.lang.Object

com.microej.crypto.internal.NativeKey

com.microej.crypto.internal.secretkey.NativeSecretKey

All Implemented Interfaces:

Serializable, Key, SecretKey, Destroyable

public class NativeSecretKey
extends NativeKey
implements SecretKey

See Also:

Serialized Form

Field Summary

Fields inherited from class com.microej.crypto.internal.NativeKey

nativeRef

Fields inherited from interface javax.crypto.SecretKey

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
NativeSecretKey(NativeReference nativeRef, String algorithm)

Method Summary

Modifier and Type	Method and Description
static NativeSecretKey	createFromRaw(byte[] rawKey, String algorithm) Creates a native secret key from raw key material.
void	destroy() Destroy this Object.
byte[]	getEncoded() Returns the key in its primary encoding format, or null if this key does not support encoding.
int	getEncodedMaxSize() Get the max size of the encoded secret key.
String	getFormat() Returns the name of the primary encoding format of this key, or null if this key does not support encoding.
boolean	isDestroyed() Determine if this Object has been destroyed.
static int	nativeGetCloseId() Gets the id of the native close function.

Methods inherited from class com.microej.crypto.internal.NativeKey

getAlgorithm, getNativeId

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Key

getAlgorithm

Constructor Detail

NativeSecretKey

public NativeSecretKey(NativeReference nativeRef,
                       String algorithm)

Method Detail

createFromRaw

public static NativeSecretKey createFromRaw(byte[] rawKey,
                                            String algorithm)

Creates a native secret key from raw key material.

Parameters:

rawKey - raw key byte array

algorithm - algorithm description, for example: "AES"

Returns:

the native secret key

destroy

public void destroy()
             throws DestroyFailedException

Description copied from interface: Destroyable

Destroy this Object.

Sensitive information associated with this Object is destroyed or cleared. Subsequent calls to certain methods on this Object will result in an IllegalStateException being thrown.

The default implementation throws DestroyFailedException.

Specified by:

destroy in interface Destroyable

Throws:

DestroyFailedException - if the destroy operation fails.

getEncoded

public byte[] getEncoded()

Description copied from interface: Key

Returns the key in its primary encoding format, or null if this key does not support encoding.

Specified by:

getEncoded in interface Key

Returns:

the encoded key, or null if the key does not support encoding.

getEncodedMaxSize

public int getEncodedMaxSize()

Get the max size of the encoded secret key.

Returns:

the max size of the encoded key in ASN.1 (X.509) format

getFormat

public String getFormat()

Description copied from interface: Key

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

Specified by:

getFormat in interface Key

Returns:

the primary encoding format of the key.

isDestroyed

public boolean isDestroyed()

Description copied from interface: Destroyable

Determine if this Object has been destroyed.

The default implementation returns false.

Specified by:

isDestroyed in interface Destroyable

Returns:

true if this Object has been destroyed, false otherwise.

nativeGetCloseId

public static int nativeGetCloseId()

Gets the id of the native close function.

Returns:

the id of the static native close function

Throws:

NativeException - on error