Serializable, Key, KeySpec, SecretKey, Destroyable
public class SecretKeySpec extends Object implements KeySpec, SecretKey
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.
| Constructor | Description |
|---|---|
SecretKeySpec |
Constructs a secret key from the given byte array, using the first len bytes of key, starting at offset inclusive. |
SecretKeySpec |
Constructs a secret key from the given byte array. |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
equals |
Tests for equality between the specified object and this object. |
String |
getAlgorithm() |
Returns the name of the algorithm associated with this secret key. |
byte[] |
getEncoded() |
Returns the key material of this secret key. |
String |
getFormat() |
Returns the name of the encoding format for this secret key. |
int |
hashCode() |
Calculates a hash code value for the object. |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
destroy, isDestroyed
public SecretKeySpec(byte[] key, String algorithm)
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: DESKeySpec) should be used.
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 the Java Security Standard Algorithm Names document for information about standard algorithm names.IllegalArgumentException - if algorithm is null or key is null or empty.public SecretKeySpec(byte[] key, int offset, int len, String algorithm)
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: DESKeySpec) must be used.
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 the Java Security Standard Algorithm Names document for information about standard algorithm names.IllegalArgumentException - if algorithm is null or key is null, empty, or too short, i.e. key.length-offset<len.ArrayIndexOutOfBoundsException - is thrown if offset or len index bytes outside the key.public String getAlgorithm()
getAlgorithm in interface Key
public String getFormat()
public byte[] getEncoded()
getEncoded in interface Key
public int hashCode()
public boolean equals(Object obj)
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/crypto/spec/SecretKeySpec.html