blob: b430f3bd32e391ea1e7bea990865a227e7fc15ba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
package javax.crypto;
import java.security.InvalidKeyException;
import java.security.spec.KeySpec;
import java.security.spec.InvalidKeySpecException;
/**
* This class defines the <i>Service Provider Interface</i> (<b>SPI</b>)
* for the <code>SecretKeyFactory</code> class.
* All the abstract methods in this class must be implemented by each
* cryptographic service provider who wishes to supply the implementation
* of a secret-key factory for a particular algorithm.
* <p>
* A provider should document all the key specifications supported by its
* secret key factory.
* For example, the DES secret-key factory supplied by the "SunJCE" provider
* supports <code>DESKeySpec</code> as a transparent representation of DES
* keys, and that provider's secret-key factory for Triple DES keys supports
* <code>DESedeKeySpec</code> as a transparent representation of Triple DES
* keys.
*
* @see SecretKey
* @see javax.crypto.spec.DESKeySpec
* @see javax.crypto.spec.DESedeKeySpec
*/
public abstract class SecretKeyFactorySpi
{
public SecretKeyFactorySpi()
{
}
/**
* Generates a <code>SecretKey</code> object from the
* provided key specification (key material).
*
* @param keySpec the specification (key material) of the secret key
* @return the secret key
* @exception InvalidKeySpecException if the given key specification
* is inappropriate for this secret-key factory to produce a secret key.
*/
protected abstract SecretKey engineGenerateSecret(
KeySpec keySpec)
throws InvalidKeySpecException;
/**
* Returns a specification (key material) of the given key object in the requested format.
*
* @param key the key
* @param keySpec the requested format in which the key material shall be returned
* @return the underlying key specification (key material) in the requested format
* @exception InvalidKeySpecException if the requested key specification is inappropriate for
* the given key (e.g., the algorithms associated with <code>key</code> and <code>keySpec</code> do
* not match, or <code>key</code> references a key on a cryptographic hardware device whereas
* <code>keySpec</code> is the specification of a software-based key), or the given key cannot be
* dealt with (e.g., the given key has an algorithm or format not supported by this secret-key factory).
*/
protected abstract KeySpec engineGetKeySpec(
SecretKey key,
Class keySpec)
throws InvalidKeySpecException;
/**
* Translates a key object, whose provider may be unknown or potentially untrusted, into a
* corresponding key object of this secret-key factory.
*
* @param key the key whose provider is unknown or untrusted
* @return InvalidKeyException if the given key cannot be processed by this secret-key factory.
*/
protected abstract SecretKey engineTranslateKey(
SecretKey key)
throws InvalidKeyException;
}
|
