SecretKeySpec (Java SE 9 & JDK 9 ) (original) (raw)

java.lang.Object
- javax.crypto.spec.SecretKeySpec
All Implemented Interfaces:
[Serializable](../../../java/io/Serializable.html "interface in java.io"), [Key](../../../java/security/Key.html "interface in java.security"), [KeySpec](../../../java/security/spec/KeySpec.html "interface in java.security.spec"), [SecretKey](../../../javax/crypto/SecretKey.html "interface in javax.crypto"), [Destroyable](../../../javax/security/auth/Destroyable.html "interface in javax.security.auth")

public class SecretKeySpec
extends Object
implements KeySpec, SecretKey
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.
Since:
1.4
See Also:
SecretKey, SecretKeyFactory, Serialized Form

Constructor Summary

Constructors

Constructor	Description
SecretKeySpec(byte[] key, int offset, int len,String algorithm)	Constructs a secret key from the given byte array, using the firstlen bytes of key, starting atoffset inclusive.
SecretKeySpec(byte[] key,String algorithm)	Constructs a secret key from the given byte array.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
boolean	equals(Object obj)	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.

   * ### Methods inherited from interface javax.security.auth.[Destroyable](../../../javax/security/auth/Destroyable.html "interface in javax.security.auth")  
   `[destroy](../../../javax/security/auth/Destroyable.html#destroy--), [isDestroyed](../../../javax/security/auth/Destroyable.html#isDestroyed--)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### SecretKeySpec  
 public SecretKeySpec(byte[] key,  
                      [String](../../../java/lang/String.html "class in java.lang") 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:[DESKeySpec](../../../javax/crypto/spec/DESKeySpec.html "class in javax.crypto.spec")) 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 the [ Java Security Standard Algorithm Names](../../../../specs/security/standard-names.html) document for information about standard algorithm names.  
 Throws:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `algorithm` is null or `key` is null or empty.  
 * #### SecretKeySpec  
 public SecretKeySpec(byte[] key,  
                      int offset,  
                      int len,  
                      [String](../../../java/lang/String.html "class in java.lang") 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:[DESKeySpec](../../../javax/crypto/spec/DESKeySpec.html "class in javax.crypto.spec")) 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 the [ Java Security Standard Algorithm Names](../../../../specs/security/standard-names.html) document for information about standard algorithm names.  
 Throws:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `algorithm` is null or `key` is null, empty, or too short, i.e. `key.length-offset<len`.  
 `[ArrayIndexOutOfBoundsException](../../../java/lang/ArrayIndexOutOfBoundsException.html "class in java.lang")` \- is thrown if`offset` or `len` index bytes outside the`key`.

Method Detail

* #### getAlgorithm  
public [String](../../../java/lang/String.html "class in java.lang") getAlgorithm()  
Returns the name of the algorithm associated with this secret key.  
Specified by:  
`[getAlgorithm](../../../java/security/Key.html#getAlgorithm--)` in interface `[Key](../../../java/security/Key.html "interface in java.security")`  
Returns:  
the secret key algorithm.  
* #### getFormat  
public [String](../../../java/lang/String.html "class in java.lang") getFormat()  
Returns the name of the encoding format for this secret key.  
Specified by:  
`[getFormat](../../../java/security/Key.html#getFormat--)` in interface `[Key](../../../java/security/Key.html "interface in java.security")`  
Returns:  
the string "RAW".  
* #### getEncoded  
public byte[] getEncoded()  
Returns the key material of this secret key.  
Specified by:  
`[getEncoded](../../../java/security/Key.html#getEncoded--)` in interface `[Key](../../../java/security/Key.html "interface in java.security")`  
Returns:  
the key material. Returns a new array each time this method is called.  
* #### hashCode  
public int hashCode()  
Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.  
Overrides:  
`[hashCode](../../../java/lang/Object.html#hashCode--)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
Returns:  
a hash code value for this object.  
See Also:  
[Object.equals(java.lang.Object)](../../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../../java/lang/System.html#identityHashCode-java.lang.Object-)  
* #### equals  
public boolean equals([Object](../../../java/lang/Object.html "class in java.lang") 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.  
Overrides:  
`[equals](../../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
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.  
See Also:  
[Object.hashCode()](../../../java/lang/Object.html#hashCode--), [HashMap](../../../java/util/HashMap.html "class in java.util")

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

SecretKeySpec (Java SE 9 & JDK 9 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail