Skip to content

Most visited

Recently visited

navigation

SecretKey

public interface SecretKey
implements Key, Destroyable

javax.crypto.SecretKey
Known Indirect Subclasses


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 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:

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

Inherited methods

From interface java.security.Key
From interface javax.security.auth.Destroyable

Constants

serialVersionUID

added in API level 1
long serialVersionUID

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

Constant Value: -4795878709595146952 (0xbd719db928b8f538)

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)