# SecretKeySpec

public class **SecretKeySpec** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
implements [KeySpec](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/spec/KeySpec.html) [SecretKey](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/SecretKey.html) This class specifies a secret key in a provider-independent fashion.

It can be used to construct a `SecretKey` from a byte array,
without having to go through a (provider-based)
`SecretKeyFactory`.

This class is only useful for raw secret keys that can be represented as
a byte array and have no key parameters associated with them, e.g., DES or
Triple DES keys.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/SecretKey.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/SecretKeyFactory.html`

### Inherited Constant Summary

From interface [javax.crypto.SecretKey](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/SecretKey.html)

|---|---|---|
| long | [serialVersionUID](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/SecretKey.html#serialVersionUID) | The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4. |

From interface [java.security.Key](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Key.html)

|---|---|---|
| long | [serialVersionUID](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Key.html#serialVersionUID) | The class fingerprint that is set to indicate serialization compatibility with a previous version of the class. |

### Public Constructor Summary

|---|---|
|   | [SecretKeySpec](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#SecretKeySpec(byte[],%20java.lang.String))(byte\[\] key, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm) Constructs a secret key from the given byte array. |
|   | [SecretKeySpec](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#SecretKeySpec(byte[],%20int,%20int,%20java.lang.String))(byte\[\] key, int offset, int len, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm) Constructs a secret key from the given byte array, using the first `len` bytes of `key`, starting at `offset` inclusive. |

### Public Method Summary

|---|---|
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Tests for equality between the specified object and this object. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getAlgorithm](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#getAlgorithm())() Returns the name of the algorithm associated with this secret key. |
| byte\[\] | [getEncoded](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#getEncoded())() Returns the key material of this secret key. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getFormat](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#getFormat())() Returns the name of the encoding format for this secret key. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/SecretKeySpec.html#hashCode())() Calculates a hash code value for the object. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.security.Key](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Key.html)

|---|---|
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getAlgorithm](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Key.html#getAlgorithm())() Returns the standard algorithm name for this key. |
| abstract byte\[\] | [getEncoded](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Key.html#getEncoded())() Returns the key in its primary encoding format, or null if this key does not support encoding. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Key.html#getFormat())() Returns the name of the primary encoding format of this key, or null if this key does not support encoding. |

From interface [javax.security.auth.Destroyable](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/auth/Destroyable.html)

|---|---|
| void | [destroy](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/auth/Destroyable.html#destroy())() Destroy this `Object`. |
| boolean | [isDestroyed](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/auth/Destroyable.html#isDestroyed())() Determine if this `Object` has been destroyed. |

## Public Constructors

#### public
**SecretKeySpec**
(byte\[\] key, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm)

Constructs a secret key from the given byte array.

This constructor does not check if the given bytes indeed specify a
secret key of the specified algorithm. For example, if the algorithm is
DES, this constructor does not check if `key` is 8 bytes
long, and also does not check for weak or semi-weak keys.
In order for those checks to be performed, an algorithm-specific
*key specification* class (in this case:
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/DESKeySpec.html`)
should be used.

##### Parameters

| key | the key material of the secret key. The contents of the array are copied to protect against subsequent modification. |
| algorithm | the name of the secret-key algorithm to be associated with the given key material. See Appendix A in the [Java Cryptography Architecture Reference Guide](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/crypto/CryptoSpec.html#AppA) for information about standard algorithm names. |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `algorithm` is null or `key` is null or empty. |
|---|---|

#### public
**SecretKeySpec**
(byte\[\] key, int offset, int len, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm)

Constructs a secret key from the given byte array, using the first
`len` bytes of `key`, starting at
`offset` inclusive.

The bytes that constitute the secret key are
those between `key[offset]` and
`key[offset+len-1]` inclusive.

This constructor does not check if the given bytes indeed specify a
secret key of the specified algorithm. For example, if the algorithm is
DES, this constructor does not check if `key` is 8 bytes
long, and also does not check for weak or semi-weak keys.
In order for those checks to be performed, an algorithm-specific key
specification class (in this case:
`https://developers.google.com/j2objc/javadoc/jre/reference/javax/crypto/spec/DESKeySpec.html`)
must be used.

##### Parameters

| key | the key material of the secret key. The first `len` bytes of the array beginning at `offset` inclusive are copied to protect against subsequent modification. |
| offset | the offset in `key` where the key material starts. |
| len | the length of the key material. |
| algorithm | the name of the secret-key algorithm to be associated with the given key material. See Appendix A in the [Java Cryptography Architecture Reference Guide](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/crypto/CryptoSpec.html#AppA) for information about standard algorithm names. |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `algorithm` is null or `key` is null, empty, or too short, i.e. `key.length-offset<len`. |
| [ArrayIndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArrayIndexOutOfBoundsException.html) | is thrown if `offset` or `len` index bytes outside the `key`. |
|---|---|

## Public Methods

#### public boolean
**equals**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj)

Tests for equality between the specified object and this
object. Two SecretKeySpec objects are considered equal if
they are both SecretKey instances which have the
same case-insensitive algorithm name and key encoding.

##### Parameters

| obj | the object to test for equality with this object. |
|---|---|

##### Returns

- true if the objects are considered equal, false if `obj` is null or otherwise.

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getAlgorithm**
()

Returns the name of the algorithm associated with this secret key.

##### Returns

- the secret key algorithm.

#### public byte\[\]
**getEncoded**
()

Returns the key material of this secret key.

##### Returns

- the key material. Returns a new array each time this method is called.

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getFormat**
()

Returns the name of the encoding format for this secret key.

##### Returns

- the string "RAW".

#### public int
**hashCode**
()

Calculates a hash code value for the object.
Objects that are equal will also have the same hashcode.

##### Returns

- this object's hash code.