SecretKey

public interface SecretKey
implements Key, Destroyable

javax.crypto.SecretKey

Known indirect subclasses

PBEKey	The interface to a PBE key.
SecretKeySpec	This class specifies a secret key in a provider-independent fashion.

A secret (symmetric) key. The purpose of this interface is to group (and provide type safety for) all secret key interfaces.

Provider implementations of this interface must overwrite the equals and hashCode methods inherited from Object, so that secret keys are compared based on their underlying key material and not based on reference. Implementations should override the default destroy and isDestroyed methods from the Destroyable interface to enable sensitive key information to be destroyed, cleared, or in the case where such information is immutable, unreferenced. Finally, since SecretKey is Serializable, implementations should also override ObjectOutputStream.writeObject(java.lang.Object) to prevent keys that have been destroyed from being serialized.

Keys that implement this interface return the string RAW as their encoding format (see getFormat), and return the raw key bytes as the result of a getEncoded method call. (The getFormat and getEncoded methods are inherited from the Key parent interface.)

See also:

SecretKeyFactory
Cipher

Summary

Constants
`long`	`serialVersionUID` The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.

Inherited constants

From interface java.security.Key

long

serialVersionUID

This constant was deprecated in API level 34. A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.

Inherited methods

From interface


        
          java.security.Key

`abstract String`	`getAlgorithm()` Returns the standard algorithm name for this key.
`abstract byte[]`	`getEncoded()` Returns the key in its primary encoding format, or null if this key does not support encoding.
`abstract String`	`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

`default void`	`destroy()` Destroy this `Object`.
`default boolean`	`isDestroyed()` Determine if this `Object` has been destroyed.

Constants

serialVersionUID

Added in API level 1

public static final long serialVersionUID

The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.

Constant Value: -4795878709595146952 (0xbd719db928b8f538)