Package org.bouncycastle.jcajce.io
Class CipherInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.bouncycastle.jcajce.io.CipherInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
A CipherInputStream is composed of an InputStream and a cipher so that read() methods return data
that are read in from the underlying InputStream but have been additionally processed by the
Cipher. The cipher must be fully initialized before being used by a CipherInputStream.
For example, if the Cipher is initialized for decryption, the CipherInputStream will attempt to
read in data and decrypt them, before returning the decrypted data.
This is a reimplementation of
CipherInputStream that is safe for use with
AEAD block ciphers, and does not silently catch BadPaddingException and
IllegalBlockSizeException errors. Any errors that occur during finalisation are rethrown wrapped in an InvalidCipherTextException.-
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionCipherInputStream(InputStream input, Cipher cipher) Constructs a CipherInputStream from an InputStream and an initialised Cipher. -
Method Summary
Modifier and TypeMethodDescriptionintvoidclose()Closes the underlying input stream, and then finalises the processing of the data by the cipher.voidmark(int readlimit) booleanintread()Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and returns the next available byte.intread(byte[] b, int off, int len) Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up tolenbytes in the provided array.voidreset()longskip(long n) Methods inherited from class java.io.FilterInputStream
readMethods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Constructor Details
-
CipherInputStream
Constructs a CipherInputStream from an InputStream and an initialised Cipher.
-
-
Method Details
-
read
Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and returns the next available byte. If the underlying stream is exhausted by this call, the cipher will be finalised.- Overrides:
readin classFilterInputStream- Throws:
IOException- if there was an error closing the input stream.InvalidCipherTextException- if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).
-
read
Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up tolenbytes in the provided array. If the underlying stream is exhausted by this call, the cipher will be finalised.- Overrides:
readin classFilterInputStream- Parameters:
b- the buffer into which the data is read.off- the start offset in the destination arrayblen- the maximum number of bytes read.- Returns:
- the total number of bytes read into the buffer, or
-1if there is no more data because the end of the stream has been reached. - Throws:
IOException- if there was an error closing the input stream.InvalidCipherTextException- if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).
-
skip
- Overrides:
skipin classFilterInputStream- Throws:
IOException
-
available
- Overrides:
availablein classFilterInputStream- Throws:
IOException
-
close
Closes the underlying input stream, and then finalises the processing of the data by the cipher.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classFilterInputStream- Throws:
IOException- if there was an error closing the input stream.InvalidCipherTextException- if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).
-
mark
public void mark(int readlimit) - Overrides:
markin classFilterInputStream
-
reset
- Overrides:
resetin classFilterInputStream- Throws:
IOException
-
markSupported
public boolean markSupported()- Overrides:
markSupportedin classFilterInputStream
-