FileDocCategorySizeDatePackage
SecretKeySpec.javaAPI DocphoneME MR2 API (J2ME)4084Wed May 02 18:00:38 BST 2007javax.crypto.spec

SecretKeySpec

public class SecretKeySpec extends Object implements KeySpec, Key
This class specifies a secret key in a provider-independent fashion.

It can be used to construct a SecretKey from a byte array.

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.

version
1.16, 07/31/01

Fields Summary
private byte[]
keyData
The secret key.
private String
algorithm
The name of the algorithm associated with this key.
Constructors Summary
public SecretKeySpec(byte[] key, int offset, int len, String 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 must be used.

param
key the key material of the secret key.
param
offset the offset in key where the key material starts.
param
len the length of the key material.
param
algorithm the name of the secret-key algorithm to be associated with the given key material. See Appendix A in the Java Cryptography Extension Reference Guide for information about standard algorithm names.

 
        keyData = new byte[len];
        System.arraycopy(key, offset, keyData, 0, len);
        this.algorithm = algorithm.toUpperCase();
Methods Summary
public java.lang.StringgetAlgorithm()
Returns the name of the algorithm associated with this secret key.

return
the secret key algorithm.

 
        return algorithm;
public byte[]getEncoded()
Returns the key material of this secret key.

return
the key material

 
        return Util.cloneArray(keyData);
public java.lang.StringgetFormat()
Returns the name of the encoding format for this secret key.

return
the string "RAW".

	
        return "RAW";