All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.crypto.spec.SecretKeySpec

java.lang.Object
   |
   +----javax.crypto.spec.SecretKeySpec

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.

See Also:
SecretKey, SecretKeyFactory

Variable Index

 o ident

Constructor Index

 o SecretKeySpec(byte[], int, int, String)
Constructs a secret key from the given byte array, using the first len bytes of key, starting at offset.
 o SecretKeySpec(byte[], String)
Constructs a secret key from the given byte array.

Method Index

 o getAlgorithm()
Returns the name of the algorithm associated with this secret key.
 o getEncoded()
Returns the key material of this secret key.
 o getFormat()
Returns the name of the encoding format for this secret key.

Variables

 o ident
 public static final String ident

Constructors

 o SecretKeySpec
 public SecretKeySpec(byte key[],
                      String 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) must be used.

Parameters:
key - the key material of the secret key.
algorithm - the name of the associated algorithm.
 o SecretKeySpec
 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.

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) must be used.

Parameters:
key - the key material of the secret key.
offset - the offset in key where the key material starts.
len - the length of the key material.
algorithm - the standard name of the associated key algorithm. See Appendix A in the Java Cryptography Extension API Specification & Reference for information about standard algorithm names.

Methods

 o getAlgorithm
 public String getAlgorithm()
Returns the name of the algorithm associated with this secret key.

Returns:
the secret key algorithm.
 o getFormat
 public String getFormat()
Returns the name of the encoding format for this secret key.

Returns:
the string "RAW".
 o getEncoded
 public byte[] getEncoded()
Returns the key material of this secret key.

Returns:
the key material

All Packages  Class Hierarchy  This Package  Previous  Next  Index