Modifier and Type	Class and Description
protected static class	PGPEncryptedData.TruncatedStream

Modifier and Type	Field and Description
pack-priv InputStreamPacket	encData
pack-priv InputStream	encStream
pack-priv PGPDigestCalculator	integrityCalculator
pack-priv PGPEncryptedData.TruncatedStream	truncStream

Access	Constructor and Description
pack-priv	PGPEncryptedData(InputStreamPacket encData)

Method Summary

Modifier and Type	Method and Description
public int	Returns: algorithm getAlgorithm() Return the symmetric encryption algorithm that is used by the packet.
public InputStream	Returns: the encrypted data in this packet. getInputStream() Return the raw input stream for the data stream.
public int	Returns: version getVersion() Return the version number of the Encrypted Session Key Packet.
public boolean	Returns: `true` if there is a modification detection code package associated with this stream isAEAD() Checks whether the packet is protected using an AEAD algorithm.
public boolean	Returns: `true` if there is a modification detection code package associated with this stream isIntegrityProtected() Checks whether the packet is integrity protected using a modification detection code package.
pack-priv boolean	processSymmetricEncIntegrityPacketDataStream(boolean withIntegrityPacket, PGPDataDecryptor dataDecryptor, BCPGInputStream encIn)
public boolean	Returns: `true` if the message verifies, `false` otherwise. verify() Verifies the integrity of the packet against the modification detection code associated with it in the stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

encData	back to summary
pack-priv InputStreamPacket encData

encStream	back to summary
pack-priv InputStream encStream

integrityCalculator	back to summary
pack-priv PGPDigestCalculator integrityCalculator

truncStream	back to summary
pack-priv PGPEncryptedData.TruncatedStream truncStream

PGPEncryptedData	back to summary
pack-priv PGPEncryptedData(InputStreamPacket encData)

Method Detail

getAlgorithm	back to summary
public int getAlgorithm() Return the symmetric encryption algorithm that is used by the packet. Returns:int algorithm

getAlgorithm

back to summary

public int getAlgorithm()

Return the symmetric encryption algorithm that is used by the packet.

Returns:int: algorithm

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() Return the raw input stream for the data stream. Note this stream is shared with all other encryption methods in the same `PGPEncryptedDataList` and with any decryption methods in sub-classes, so consuming this stream will affect decryption. Returns:InputStream the encrypted data in this packet.

public InputStream getInputStream()

Return the raw input stream for the data stream.

Note this stream is shared with all other encryption methods in the same PGPEncryptedDataList and with any decryption methods in sub-classes, so consuming this stream will affect decryption.

Returns:InputStream: the encrypted data in this packet.

getVersion	back to summary
public int getVersion() Return the version number of the Encrypted Session Key Packet. Returns:int version

getVersion

back to summary

public int getVersion()

Return the version number of the Encrypted Session Key Packet.

Returns:int: version

isAEAD back to summary

isAEAD	back to summary
public boolean isAEAD() Checks whether the packet is protected using an AEAD algorithm. Returns:boolean `true` if there is a modification detection code package associated with this stream

public boolean isAEAD()

Checks whether the packet is protected using an AEAD algorithm.

Returns:boolean: true if there is a modification detection code package associated with this stream

isIntegrityProtected back to summary

isIntegrityProtected	back to summary
public boolean isIntegrityProtected() Checks whether the packet is integrity protected using a modification detection code package. Returns:boolean `true` if there is a modification detection code package associated with this stream

public boolean isIntegrityProtected()

Checks whether the packet is integrity protected using a modification detection code package.

Returns:boolean: true if there is a modification detection code package associated with this stream

processSymmetricEncIntegrityPacketDataStream	back to summary
pack-priv boolean processSymmetricEncIntegrityPacketDataStream(boolean withIntegrityPacket, PGPDataDecryptor dataDecryptor, BCPGInputStream encIn) throws IOException

verify back to summary

verify	back to summary
public boolean verify() throws PGPException, IOException Verifies the integrity of the packet against the modification detection code associated with it in the stream. Note This can only be called after the message has been read. Returns:boolean `true` if the message verifies, `false` otherwise. Exceptions PGPException: if the message is not `integrity protected`.

public boolean verify() throws PGPException, IOException

Verifies the integrity of the packet against the modification detection code associated with it in the stream.

Note

This can only be called after the message has been read.

Returns:boolean

true if the message verifies, false otherwise.

Exceptions

PGPException:: if the message is not integrity protected.

org.bouncycastle.openpgp back to summary

protected Class PGPEncryptedData.TruncatedStream

Class Inheritance

extends InputStream

java.lang.Object
java.io.InputStream
org.bouncycastle.openpgp.PGPEncryptedData.TruncatedStream

Field Summary

Modifier and Type	Field and Description
pack-priv int	bufPtr
pack-priv InputStream	in
pack-priv int[]	lookAhead
pack-priv byte[]	readBuffer

Constructor Summary

Access	Constructor and Description
pack-priv	TruncatedStream(InputStream in)

Method Summary

Modifier and Type	Method and Description
pack-priv int[]	getLookAhead()
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. b) Overrides java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`.
public int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.

Inherited from java.io.InputStream:: available close mark markSupported nullInputStream readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

bufPtr	back to summary
pack-priv int bufPtr

in	back to summary
pack-priv InputStream in

lookAhead	back to summary
pack-priv int[] lookAhead

readBuffer	back to summary
pack-priv byte[] readBuffer

Constructor Detail

TruncatedStream	back to summary
pack-priv TruncatedStream(InputStream in) throws IOException

Method Detail

getLookAhead	back to summary
pack-priv int[] getLookAhead()

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If the length of `b` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[0]`, the next one into `b[1]`, and so on. The number of bytes read is, at most, equal to the length of `b`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[0]` through `b[`k`-1]`, leaving elements `b[`k`]` through `b[b.length-1]` unaffected. Parameters b:byte[] the buffer into which the data is read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Exceptions IOException: If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] b) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

Parameters

b:byte[]: the buffer into which the data is read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Exceptions

IOException:: If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public abstract Class PGPEncryptedData

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class PGPEncryptedData.TruncatedStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail