Bouncy Castle Provider 1.77 · org.bouncycastle.crypto.io.CipherInputStream

Field Summary

Modifier and Type	Field and Description
private AEADBlockCipher	aeadBlockCipher
private byte[]	buf
private BufferedBlockCipher	bufferedBlockCipher
private int	bufOff
private boolean	finalized
private byte[]	inBuf
private static final int	INPUT_BUF_SIZE
private byte[]	markBuf
private int	markBufOff
private long	markPosition
private int	maxBuf
private SkippingCipher	skippingCipher
private StreamCipher	streamCipher

Inherited from java.io.FilterInputStream:: in

Constructor Summary

Access	Constructor and Description
public	CipherInputStream(InputStream is, BufferedBlockCipher cipher) Constructs a CipherInputStream from an InputStream and a BufferedBlockCipher.
public	CipherInputStream(InputStream is, StreamCipher cipher) Constructs a CipherInputStream from an InputStream and a StreamCipher.
public	CipherInputStream(InputStream is, AEADBlockCipher cipher) Constructs a CipherInputStream from an InputStream and an AEADBlockCipher.
public	CipherInputStream(InputStream is, BufferedBlockCipher cipher, int bufSize) Constructs a CipherInputStream from an InputStream, a BufferedBlockCipher, and a specified internal buffer size.
public	CipherInputStream(InputStream is, StreamCipher cipher, int bufSize) Constructs a CipherInputStream from an InputStream, a StreamCipher, and a specified internal buffer size.
public	CipherInputStream(InputStream is, AEADBlockCipher cipher, int bufSize) Constructs a CipherInputStream from an InputStream, an AEADBlockCipher, and a specified internal buffer size.

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
public void	close() Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes the underlying input stream and finalises the processing of the data by the cipher.
private void	ensureCapacity(int the size of the pending update. updateSize, boolean `true` iff this the cipher is to be finalised. finalOutput) Ensure the cipher text buffer has space sufficient to accept an upcoming output.
private void	finaliseCipher()
public void	mark(int the maximum read ahead required before a reset() may be called. readlimit) Overrides java.io.FilterInputStream.mark. Mark the current position.
public boolean	Returns: true if mark(readlimit) supported, false otherwise. markSupported() Overrides java.io.FilterInputStream.markSupported. Return true if mark(readlimit) is supported.
private int	Returns: -1 to indicate end of stream, or the number of bytes (> 0) available. nextChunk() Read data from underlying stream and process with cipher until end of stream or some data is available after cipher processing.
public int	read() Overrides java.io.FilterInputStream.read. Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and returns the next available byte.
public int	Returns: 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. read(byte[] the buffer into which the data is read. b) Overrides java.io.FilterInputStream.read. Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up to `b.length` bytes in the provided array.
public int	Returns: 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. read(byte[] the buffer into which the data is read. b, int the start offset in the destination array `b` off, int the maximum number of bytes read. len) Overrides java.io.FilterInputStream.read. Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up to `len` bytes in the provided array.
public void	reset() Overrides java.io.FilterInputStream.reset. Reset to the last marked position, if supported.
public long	skip(long the number of bytes to be skipped. n) Overrides java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream.

Field Detail

aeadBlockCipher	back to summary
private AEADBlockCipher aeadBlockCipher

buf	back to summary
private byte[] buf

bufferedBlockCipher	back to summary
private BufferedBlockCipher bufferedBlockCipher

bufOff	back to summary
private int bufOff

finalized	back to summary
private boolean finalized

inBuf	back to summary
private byte[] inBuf

INPUT_BUF_SIZE	back to summary
private static final int INPUT_BUF_SIZE

markBuf	back to summary
private byte[] markBuf

markBufOff	back to summary
private int markBufOff

markPosition	back to summary
private long markPosition

maxBuf	back to summary
private int maxBuf

skippingCipher	back to summary
private SkippingCipher skippingCipher

streamCipher	back to summary
private StreamCipher streamCipher

Constructor Detail

CipherInputStream	back to summary
public CipherInputStream(InputStream is, BufferedBlockCipher cipher) Constructs a CipherInputStream from an InputStream and a BufferedBlockCipher.

CipherInputStream	back to summary
public CipherInputStream(InputStream is, StreamCipher cipher) Constructs a CipherInputStream from an InputStream and a StreamCipher.

CipherInputStream	back to summary
public CipherInputStream(InputStream is, AEADBlockCipher cipher) Constructs a CipherInputStream from an InputStream and an AEADBlockCipher.

CipherInputStream	back to summary
public CipherInputStream(InputStream is, BufferedBlockCipher cipher, int bufSize) Constructs a CipherInputStream from an InputStream, a BufferedBlockCipher, and a specified internal buffer size.

CipherInputStream	back to summary
public CipherInputStream(InputStream is, StreamCipher cipher, int bufSize) Constructs a CipherInputStream from an InputStream, a StreamCipher, and a specified internal buffer size.

CipherInputStream	back to summary
public CipherInputStream(InputStream is, AEADBlockCipher cipher, int bufSize) Constructs a CipherInputStream from an InputStream, an AEADBlockCipher, and a specified internal buffer size.

Method Detail

available	back to summary
public int available() throws IOException Overrides java.io.FilterInputStream.available. Doc from java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking. Exceptions IOException: if an I/O error occurs.

available

back to summary

public int available() throws IOException

Overrides java.io.FilterInputStream.available.

Doc from java.io.FilterInputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

Exceptions

IOException:: if an I/O error occurs.

close	back to summary
public void close() throws IOException Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes the underlying input stream and finalises the processing of the data by the cipher. Exceptions IOException: if there was an error closing the input stream. InvalidCipherTextIOException: if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).

back to summary

public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Closes the underlying input stream and finalises the processing of the data by the cipher.

Exceptions

IOException:: if there was an error closing the input stream.
InvalidCipherTextIOException:: if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).

ensureCapacity back to summary

ensureCapacity	back to summary
private void ensureCapacity(int updateSize, boolean finalOutput) Ensure the cipher text buffer has space sufficient to accept an upcoming output. Parameters updateSize:int the size of the pending update. finalOutput:boolean `true` iff this the cipher is to be finalised.

private void ensureCapacity(int updateSize, boolean finalOutput)

Ensure the cipher text buffer has space sufficient to accept an upcoming output.

Parameters

updateSize:int: the size of the pending update.
finalOutput:boolean: true iff this the cipher is to be finalised.

finaliseCipher	back to summary
private void finaliseCipher() throws IOException

mark	back to summary
public void mark(int readlimit) Overrides java.io.FilterInputStream.mark. Mark the current position. This method only works if markSupported() returns true - which means the underlying stream supports marking, and the cipher passed in to this stream's constructor is a SkippingCipher (so capable of being reset to an arbitrary point easily). Parameters readlimit:int the maximum read ahead required before a reset() may be called.

mark

back to summary

public void mark(int readlimit)

Overrides java.io.FilterInputStream.mark.

Mark the current position.

This method only works if markSupported() returns true - which means the underlying stream supports marking, and the cipher passed in to this stream's constructor is a SkippingCipher (so capable of being reset to an arbitrary point easily).

Parameters

readlimit:int: the maximum read ahead required before a reset() may be called.

markSupported	back to summary
public boolean markSupported() Overrides java.io.FilterInputStream.markSupported. Return true if mark(readlimit) is supported. This will be true if the underlying stream supports marking and the cipher used is a SkippingCipher, Returns:boolean true if mark(readlimit) supported, false otherwise.

markSupported

back to summary

public boolean markSupported()

Overrides java.io.FilterInputStream.markSupported.

Return true if mark(readlimit) is supported. This will be true if the underlying stream supports marking and the cipher used is a SkippingCipher,

Returns:boolean: true if mark(readlimit) supported, false otherwise.

nextChunk	back to summary
private int nextChunk() throws IOException Read data from underlying stream and process with cipher until end of stream or some data is available after cipher processing. Returns:int -1 to indicate end of stream, or the number of bytes (> 0) available.

nextChunk

back to summary

private int nextChunk() throws IOException

Read data from underlying stream and process with cipher until end of stream or some data is available after cipher processing.

Returns:int: -1 to indicate end of stream, or the number of bytes (> 0) available.

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.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. Returns:int Doc from java.io.FilterInputStream.read. the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if there was an error closing the input stream. InvalidCipherTextIOException: if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).

public int read() throws IOException

Overrides java.io.FilterInputStream.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.

Returns:int

Doc from java.io.FilterInputStream.read.

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

Exceptions

IOException:: if there was an error closing the input stream.
InvalidCipherTextIOException:: 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 back to summary

read	back to summary
public int read(byte[] b) throws IOException Overrides java.io.FilterInputStream.read. Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up to `b.length` bytes in the provided array. If the underlying stream is exhausted by this call, the cipher will be finalised. 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 there was an error closing the input stream. InvalidCipherTextIOException: if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).

public int read(byte[] b) throws IOException

Overrides java.io.FilterInputStream.read.

Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up to b.length bytes in the provided array.

If the underlying stream is exhausted by this call, the cipher will be finalised.

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 there was an error closing the input stream.
InvalidCipherTextIOException:: 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 back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up to `len` bytes in the provided array. If the underlying stream is exhausted by this call, the cipher will be finalised. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in the destination array `b` len:int the maximum number of bytes 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 there was an error closing the input stream. InvalidCipherTextIOException: if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).

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

Overrides java.io.FilterInputStream.read.

Reads data from the underlying stream and processes it with the cipher until the cipher outputs data, and then returns up to len bytes in the provided array.

If the underlying stream is exhausted by this call, the cipher will be finalised.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in the destination array b
len:int: the maximum number of bytes 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 there was an error closing the input stream.
InvalidCipherTextIOException:: if the data read from the stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).

reset	back to summary
public void reset() throws IOException Overrides java.io.FilterInputStream.reset. Reset to the last marked position, if supported. Exceptions IOException: if marking not supported by the cipher used, or the underlying stream.

reset

back to summary

public void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

Reset to the last marked position, if supported.

Exceptions

IOException:: if marking not supported by the cipher used, or the underlying stream.

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.FilterInputStream.skip. Doc from java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. The actual number of bytes skipped is returned. Parameters n:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped. Exceptions IOException: if `in.skip(n)` throws an IOException.

public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

Doc from java.io.FilterInputStream.skip.

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

Parameters

n:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped.

Exceptions

IOException:: if in.skip(n) throws an IOException.

public Class CipherInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail