to top
Android APIs
public class

SecretKeySpec

extends Object
implements Serializable KeySpec SecretKey
java.lang.Object
   ↳ javax.crypto.spec.SecretKeySpec

Class Overview

A key specification for a SecretKey and also a secret key implementation that is provider-independent. It can be used for raw secret keys that can be specified as byte[].

Summary

[Expand]
Inherited Constants
From interface java.security.Key
From interface javax.crypto.SecretKey
Public Constructors
SecretKeySpec(byte[] key, String algorithm)
Creates a new SecretKeySpec for the specified key data and algorithm name.
SecretKeySpec(byte[] key, int offset, int len, String algorithm)
Creates a new SecretKeySpec for the key data from the specified buffer key starting at offset with length len and the specified algorithm name.
Public Methods
boolean equals( Object obj)
Compares the specified object with this SecretKeySpec instance.
String getAlgorithm()
Returns the algorithm name.
byte[] getEncoded()
Returns the encoded form of this secret key.
String getFormat()
Returns the name of the format used to encode the key.
int hashCode()
Returns the hash code of this SecretKeySpec object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.security.Key

Public Constructors

public SecretKeySpec (byte[] key, String algorithm)

Added in API level 1

Creates a new SecretKeySpec for the specified key data and algorithm name.

Parameters
key the key data.
algorithm the algorithm name.
Throws
IllegalArgumentException if the key data or the algorithm name is null or if the key data is empty.

public SecretKeySpec (byte[] key, int offset, int len, String algorithm)

Added in API level 1

Creates a new SecretKeySpec for the key data from the specified buffer key starting at offset with length len and the specified algorithm name.

Parameters
key the key data.
offset the offset.
len the size of the key data.
algorithm the algorithm name.
Throws
IllegalArgumentException if the key data or the algorithm name is null, the key data is empty or offset and len do not specify a valid chunk in the buffer key.
ArrayIndexOutOfBoundsException if offset or len is negative.

Public Methods

public boolean equals (Object obj)

Added in API level 1

Compares the specified object with this SecretKeySpec instance.

Parameters
obj the object to compare.
Returns
  • true if the algorithm name and key of both object are equal, otherwise false.

public String getAlgorithm ()

Added in API level 1

Returns the algorithm name.

Returns
  • the algorithm name.

public byte[] getEncoded ()

Added in API level 1

Returns the encoded form of this secret key.

Returns
  • the encoded form of this secret key.

public String getFormat ()

Added in API level 1

Returns the name of the format used to encode the key.

Returns
  • the format name "RAW".

public int hashCode ()

Added in API level 1

Returns the hash code of this SecretKeySpec object.

Returns
  • the hash code.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.