Top Description Fields Constructors Methods
org.bouncycastle.jcajce.io

public Class CipherOutputStream

extends FilterOutputStream
Class Inheritance
Imports
java.io.FilterOutputStream, .IOException, .OutputStream, java.security.GeneralSecurityException, javax.crypto.BadPaddingException, .Cipher, .IllegalBlockSizeException, org.bouncycastle.crypto.io.InvalidCipherTextIOException
A CipherOutputStream is composed of an OutputStream and a cipher so that write() methods process the written data with the cipher, and the output of the cipher is in turn written to the underlying OutputStream. The cipher must be fully initialized before being used by a CipherInputStream.

For example, if the cipher is initialized for encryption, the CipherOutputStream will encrypt the data before writing the encrypted data to the underlying stream.

This is a reimplementation of javax.crypto.CipherOutputStream 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 InvalidCipherTextIOException.

Field Summary

Modifier and TypeField and Description
private final Cipher
cipher

private final byte[]
oneByte

Inherited from java.io.FilterOutputStream:
out

Constructor Summary

AccessConstructor and Description
public
CipherOutputStream(OutputStream output, Cipher cipher)

Constructs a CipherOutputStream from an OutputStream and a Cipher.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

public void
flush()

Overrides java.io.FilterOutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream by forcing any buffered output bytes that have already been processed by the encapsulated cipher object to be written out.

public void
write(int
the byte.
b)

Overrides java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.

public void
write(byte[]
the data.
b, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.FilterOutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Inherited from java.io.FilterOutputStream:
write

Field Detail

cipherback to summary
private final Cipher cipher
oneByteback to summary
private final byte[] oneByte

Constructor Detail

CipherOutputStreamback to summary
public CipherOutputStream(OutputStream output, Cipher cipher)

Constructs a CipherOutputStream from an OutputStream and a Cipher.

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

This method invokes the doFinal method of the encapsulated cipher object, which causes any bytes buffered by the encapsulated cipher to be processed. The result is written out by calling the flush method of this output stream.

This method resets the encapsulated cipher object to its initial state and calls the close method of the underlying output stream.

Exceptions
IOException:
if an I/O error occurs.
InvalidCipherTextIOException:
if the data written to this stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).
flushback to summary
public void flush() throws IOException

Overrides java.io.FilterOutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream by forcing any buffered output bytes that have already been processed by the encapsulated cipher object to be written out.

Any bytes buffered by the encapsulated cipher and waiting to be processed by it will not be written out. For example, if the encapsulated cipher is a block cipher, and the total number of bytes written using one of the write methods is less than the cipher's block size, no bytes will be written out.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(int b) throws IOException

Overrides java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterOutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs.