iaik.security.cipher

Class SecretKey

java.lang.Object

javax.crypto.spec.SecretKeySpec

iaik.security.cipher.SecretKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.spec.KeySpec, javax.crypto.SecretKey

public class SecretKey
extends javax.crypto.spec.SecretKeySpec

This class represents a secret key as used with symmetric algorithms. Applications generally shall use a proper KeyGenerator for generating the requested Secret Key.

Version:

File Revision 19

See Also:

SecretKey, Key, KeyGenerator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SecretKey(byte[] key, int off, int len, java.lang.String algName) Creates a SecretKey object from given byte sub-array and algorithm name.
SecretKey(byte[] key, java.lang.String algName) Creates a SecretKey object from given byte array and algorithm name.
SecretKey(javax.crypto.SecretKey key)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroyCriticalData() Destroys the critical data of this object.
boolean	equals(java.lang.Object obj) Compares two secret keys.
java.lang.String	getAlgorithm() Returns the name of the key algorithm for this key.
byte[]	getEncoded() Returns a copy of the secret key as byte array.
java.lang.String	getFormat() Returns the format name.
int	hashCode() Returns a hash code value for this object.
void	setAlgorithm(java.lang.String algorithm) Sets the algorithm name of this secret key.
java.lang.String	toString() Returns a string representation of this SecretKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretKey

public SecretKey(byte[] key,
         java.lang.String algName)

Creates a SecretKey object from given byte array and algorithm name.

This constructor is called from inside a KeyGenerator to create a SecretKey. Applications shall use the KeyGenerator.getInstance and generateKey methods for creating a SecretKey object.

Parameters:

key - the key as byte array

algName - the name of the key algorithm

See Also:

KeyGenerator.getInstance(java.lang.String), KeyGenerator.generateKey()

SecretKey

public SecretKey(byte[] key,
         int off,
         int len,
         java.lang.String algName)

Creates a SecretKey object from given byte sub-array and algorithm name. Beginning at off, only len bytes of the given key byte array are used for creating the SecretKey.

This constructor is called from inside a KeyGenerator to create a SecretKey. Applications shall use the KeyGenerator.getInstance and generateKey methods for creating a SecretKey object.

Parameters:

key - the key as byte array

algName - the name of the key algorithm

See Also:

KeyGenerator.getInstance(java.lang.String), KeyGenerator.generateKey()

SecretKey

public SecretKey(javax.crypto.SecretKey key)
          throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

Method Detail

getEncoded

public byte[] getEncoded()

Returns a copy of the secret key as byte array.

Specified by:

getEncoded in interface java.security.Key

Overrides:

getEncoded in class javax.crypto.spec.SecretKeySpec

Returns:

a copy of the secret key as byte array

getAlgorithm

public java.lang.String getAlgorithm()

Returns the name of the key algorithm for this key.

Specified by:

getAlgorithm in interface java.security.Key

Overrides:

getAlgorithm in class javax.crypto.spec.SecretKeySpec

Returns:

the key algorithm name

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)

Sets the algorithm name of this secret key.

Parameters:

algorithm - the name of the algorithm for this key

getFormat

public java.lang.String getFormat()

Returns the format name.

Specified by:

getFormat in interface java.security.Key

Overrides:

getFormat in class javax.crypto.spec.SecretKeySpec

Returns:

"RAW"

destroyCriticalData

public void destroyCriticalData()

Destroys the critical data of this object.

equals

public boolean equals(java.lang.Object obj)

Compares two secret keys.

Overrides:

equals in class javax.crypto.spec.SecretKeySpec

Parameters:

obj - an object to be compared with this point

Returns:

true if the object to be compared has the same values; false otherwise

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class javax.crypto.spec.SecretKeySpec

Returns:

a hash code value for this object

toString

public java.lang.String toString()

Returns a string representation of this SecretKey.

Overrides:

toString in class java.lang.Object

Returns:

a string giving some information about this secret key