org.bouncycastle.openpgp
Class PGPPBEEncryptedData

java.lang.Object
  |
  +--org.bouncycastle.openpgp.PGPEncryptedData
        |
        +--org.bouncycastle.openpgp.PGPSymmetricKeyEncryptedData
              |
              +--org.bouncycastle.openpgp.PGPPBEEncryptedData

All Implemented Interfaces:

AEADAlgorithmTags, SymmetricKeyAlgorithmTags

public class PGPPBEEncryptedData

extends PGPSymmetricKeyEncryptedData

A password based encryption object.

PBE encrypted data objects can be decrypted using a PBEDataDecryptorFactory.

Inner classes inherited from class org.bouncycastle.openpgp.PGPEncryptedData

PGPEncryptedData.TruncatedStream

Fields inherited from interface org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags

AES_128, AES_192, AES_256, BLOWFISH, CAMELLIA_128, CAMELLIA_192, CAMELLIA_256, CAST5, DES, IDEA, NULL, SAFER, TRIPLE_DES, TWOFISH

Fields inherited from interface org.bouncycastle.bcpg.AEADAlgorithmTags

EAX, GCM, OCB

Method Summary

int	getAlgorithm() Symmetric-key algorithm used by this object to protect the session key (getSymmetricAlgorithm(PBEDataDecryptorFactory) with.
java.io.InputStream	getDataStream(PBEDataDecryptorFactory dataDecryptorFactory) Open an input stream which will provide the decrypted data protected by this object.
java.io.InputStream	getDataStream(SessionKeyDataDecryptorFactory dataDecryptorFactory) Deprecated. will be removed in 1.74, use PGPEncryptedDataList.extractSessionKeyEncryptedData() and then apply the dataDecryptorFactory.
PGPSessionKey	getSessionKey(PBEDataDecryptorFactory dataDecryptorFactory) Return the symmetric session key required to decrypt the data protected by this object.
int	getSymmetricAlgorithm(PBEDataDecryptorFactory dataDecryptorFactory) Return the symmetric key algorithm required to decrypt the data protected by this object.
int	getVersion() Return the version number of the Encrypted Session Key Packet.

Methods inherited from class org.bouncycastle.openpgp.PGPSymmetricKeyEncryptedData

createDecryptionStream

Methods inherited from class org.bouncycastle.openpgp.PGPEncryptedData

getInputStream, isAEAD, isIntegrityProtected, verify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVersion

public int getVersion()

Description copied from class: PGPEncryptedData

Return the version number of the Encrypted Session Key Packet.

Overrides:

getVersion in class PGPEncryptedData

Following copied from class: org.bouncycastle.openpgp.PGPEncryptedData

Returns:

version

getAlgorithm

public int getAlgorithm()

Symmetric-key algorithm used by this object to protect the session key (getSymmetricAlgorithm(PBEDataDecryptorFactory) with.

Overrides:

getAlgorithm in class PGPEncryptedData

Returns:

password-based encryption algorithm identifier (SymmetricKeyAlgorithmTags)

getSymmetricAlgorithm

public int getSymmetricAlgorithm(PBEDataDecryptorFactory dataDecryptorFactory)
                          throws PGPException

Return the symmetric key algorithm required to decrypt the data protected by this object.

Parameters:

dataDecryptorFactory - decryptor factory to use to recover the session data.

Returns:

session key algorithm identifier (SymmetricKeyAlgorithmTags)

Throws:

PGPException - if the session data cannot be recovered.

getSessionKey

public PGPSessionKey getSessionKey(PBEDataDecryptorFactory dataDecryptorFactory)
                            throws PGPException

Return the symmetric session key required to decrypt the data protected by this object.

Parameters:

dataDecryptorFactory - decryptor factory used to recover the session data.

Returns:

session key

Throws:

PGPException - if the session data cannot be recovered

getDataStream

public java.io.InputStream getDataStream(PBEDataDecryptorFactory dataDecryptorFactory)
                                  throws PGPException

Open an input stream which will provide the decrypted data protected by this object.

Parameters:

dataDecryptorFactory - decryptor factory to use to recover the session data and provide the stream.

Returns:

the resulting decrypted input stream, probably containing a sequence of PGP data objects.

Throws:

PGPException - if the session data cannot be recovered or the stream cannot be created.

getDataStream

public java.io.InputStream getDataStream(SessionKeyDataDecryptorFactory dataDecryptorFactory)
                                  throws PGPException

Deprecated. will be removed in 1.74, use PGPEncryptedDataList.extractSessionKeyEncryptedData() and then apply the dataDecryptorFactory.