java.lang.Object
javax.crypto.EncryptedPrivateKeyInfo
This class implements the
EncryptedPrivateKeyInfo
type
as defined in PKCS #8.
Its ASN.1 definition is as follows:
EncryptedPrivateKeyInfo ::= SEQUENCE { encryptionAlgorithm AlgorithmIdentifier, encryptedData OCTET STRING } AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL }
- Since:
- 1.4
- See Also:
-
Constructor Summary
ConstructorDescriptionEncryptedPrivateKeyInfo
(byte[] encoded) Constructs (i.e., parses) anEncryptedPrivateKeyInfo
from its ASN.1 encoding.EncryptedPrivateKeyInfo
(String algName, byte[] encryptedData) Constructs anEncryptedPrivateKeyInfo
from the encryption algorithm name and the encrypted data.EncryptedPrivateKeyInfo
(AlgorithmParameters algParams, byte[] encryptedData) Constructs anEncryptedPrivateKeyInfo
from the encryption algorithm parameters and the encrypted data. -
Method Summary
Modifier and TypeMethodDescriptionReturns the encryption algorithm.Returns the algorithm parameters used by the encryption algorithm.byte[]
Returns the ASN.1 encoding of this object.byte[]
Returns the encrypted data.getKeySpec
(Key decryptKey) Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.getKeySpec
(Key decryptKey, String providerName) Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.getKeySpec
(Key decryptKey, Provider provider) Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.getKeySpec
(Cipher cipher) Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.
-
Constructor Details
-
EncryptedPrivateKeyInfo
Constructs (i.e., parses) anEncryptedPrivateKeyInfo
from its ASN.1 encoding.- Parameters:
encoded
- the ASN.1 encoding of this object. The contents of the array are copied to protect against subsequent modification.- Throws:
NullPointerException
- if theencoded
isnull
.IOException
- if error occurs when parsing the ASN.1 encoding.
-
EncryptedPrivateKeyInfo
public EncryptedPrivateKeyInfo(String algName, byte[] encryptedData) throws NoSuchAlgorithmException Constructs anEncryptedPrivateKeyInfo
from the encryption algorithm name and the encrypted data.Note: This constructor will use
null
as the value of the algorithm parameters. If the encryption algorithm has parameters whose value is notnull
, a different constructor, e.g. EncryptedPrivateKeyInfo(AlgorithmParameters, byte[]), should be used.- Parameters:
algName
- encryption algorithm name. See the Java Security Standard Algorithm Names document for information about standard Cipher algorithm names.encryptedData
- encrypted data. The contents ofencryptedData
are copied to protect against subsequent modification when constructing this object.- Throws:
NullPointerException
- ifalgName
orencryptedData
isnull
.IllegalArgumentException
- ifencryptedData
is empty, i.e. 0-length.NoSuchAlgorithmException
- if the specified algName is not supported.
-
EncryptedPrivateKeyInfo
public EncryptedPrivateKeyInfo(AlgorithmParameters algParams, byte[] encryptedData) throws NoSuchAlgorithmException Constructs anEncryptedPrivateKeyInfo
from the encryption algorithm parameters and the encrypted data.- Parameters:
algParams
- the algorithm parameters for the encryption algorithm.algParams.getEncoded()
should return the ASN.1 encoded bytes of theparameters
field of theAlgorithmIdentifier
component of theEncryptedPrivateKeyInfo
type.encryptedData
- encrypted data. The contents ofencryptedData
are copied to protect against subsequent modification when constructing this object.- Throws:
NullPointerException
- ifalgParams
orencryptedData
isnull
.IllegalArgumentException
- ifencryptedData
is empty, i.e. 0-length.NoSuchAlgorithmException
- if the specified algName of the specifiedalgParams
parameter is not supported.
-
-
Method Details
-
getAlgName
Returns the encryption algorithm.Note: Standard name is returned instead of the specified one in the constructor when such mapping is available. See the Java Security Standard Algorithm Names document for information about standard Cipher algorithm names.
- Returns:
- the encryption algorithm name.
-
getAlgParameters
Returns the algorithm parameters used by the encryption algorithm.- Returns:
- the algorithm parameters.
-
getEncryptedData
public byte[] getEncryptedData()Returns the encrypted data.- Returns:
- the encrypted data. Returns a new array each time this method is called.
-
getKeySpec
Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.
Note: In order to successfully retrieve the enclosed PKCS8EncodedKeySpec object,cipher
needs to be initialized to either Cipher.DECRYPT_MODE or Cipher.UNWRAP_MODE, with the same key and parameters used for generating the encrypted data.- Parameters:
cipher
- the initializedCipher
object which will be used for decrypting the encrypted data.- Returns:
- the PKCS8EncodedKeySpec object.
- Throws:
NullPointerException
- ifcipher
isnull
.InvalidKeySpecException
- if the given cipher is inappropriate for the encrypted data or the encrypted data is corrupted and cannot be decrypted.
-
getKeySpec
public PKCS8EncodedKeySpec getKeySpec(Key decryptKey) throws NoSuchAlgorithmException, InvalidKeyException Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.- Parameters:
decryptKey
- key used for decrypting the encrypted data.- Returns:
- the PKCS8EncodedKeySpec object.
- Throws:
NullPointerException
- ifdecryptKey
isnull
.NoSuchAlgorithmException
- if cannot find appropriate cipher to decrypt the encrypted data.InvalidKeyException
- ifdecryptKey
cannot be used to decrypt the encrypted data or the decryption result is not a valid PKCS8KeySpec.- Since:
- 1.5
-
getKeySpec
public PKCS8EncodedKeySpec getKeySpec(Key decryptKey, String providerName) throws NoSuchProviderException, NoSuchAlgorithmException, InvalidKeyException Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.- Parameters:
decryptKey
- key used for decrypting the encrypted data.providerName
- the name of provider whose cipher implementation will be used.- Returns:
- the PKCS8EncodedKeySpec object.
- Throws:
NullPointerException
- ifdecryptKey
orproviderName
isnull
.NoSuchProviderException
- if no providerproviderName
is registered.NoSuchAlgorithmException
- if cannot find appropriate cipher to decrypt the encrypted data.InvalidKeyException
- ifdecryptKey
cannot be used to decrypt the encrypted data or the decryption result is not a valid PKCS8KeySpec.- Since:
- 1.5
-
getKeySpec
public PKCS8EncodedKeySpec getKeySpec(Key decryptKey, Provider provider) throws NoSuchAlgorithmException, InvalidKeyException Extract the enclosed PKCS8EncodedKeySpec object from the encrypted data and return it.- Parameters:
decryptKey
- key used for decrypting the encrypted data.provider
- the name of provider whose cipher implementation will be used.- Returns:
- the PKCS8EncodedKeySpec object.
- Throws:
NullPointerException
- ifdecryptKey
orprovider
isnull
.NoSuchAlgorithmException
- if cannot find appropriate cipher to decrypt the encrypted data inprovider
.InvalidKeyException
- ifdecryptKey
cannot be used to decrypt the encrypted data or the decryption result is not a valid PKCS8KeySpec.- Since:
- 1.5
-
getEncoded
Returns the ASN.1 encoding of this object.- Returns:
- the ASN.1 encoding. Returns a new array each time this method is called.
- Throws:
IOException
- if error occurs when constructing its ASN.1 encoding.
-