Package org.bouncycastle.jcajce.io
Class CipherOutputStream
java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
org.bouncycastle.jcajce.io.CipherOutputStream
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
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
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 InvalidCipherTextException.-
Field Summary
Fields inherited from class java.io.FilterOutputStream
out -
Constructor Summary
ConstructorsConstructorDescriptionCipherOutputStream(OutputStream output, Cipher cipher) Constructs a CipherOutputStream from an OutputStream and a Cipher. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes this output stream and releases any system resources associated with this stream.voidflush()Flushes this output stream by forcing any buffered output bytes that have already been processed by the encapsulated cipher object to be written out.voidwrite(byte[] b, int off, int len) Writeslenbytes from the specified byte array starting at offsetoffto this output stream.voidwrite(int b) Writes the specified byte to this output stream.Methods inherited from class java.io.FilterOutputStream
writeMethods inherited from class java.io.OutputStream
nullOutputStream
-
Constructor Details
-
CipherOutputStream
Constructs a CipherOutputStream from an OutputStream and a Cipher.
-
-
Method Details
-
write
Writes the specified byte to this output stream.- Overrides:
writein classFilterOutputStream- Parameters:
b- thebyte.- Throws:
IOException- if an I/O error occurs.
-
write
Writeslenbytes from the specified byte array starting at offsetoffto this output stream.- Overrides:
writein classFilterOutputStream- Parameters:
b- the data.off- the start offset in the data.len- the number of bytes to write.- Throws:
IOException- if an I/O error occurs.
-
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 thewritemethods is less than the cipher's block size, no bytes will be written out.- Specified by:
flushin interfaceFlushable- Overrides:
flushin classFilterOutputStream- Throws:
IOException- if an I/O error occurs.
-
close
Closes this output stream and releases any system resources associated with this stream. This method invokes thedoFinalmethod of the encapsulated cipher object, which causes any bytes buffered by the encapsulated cipher to be processed. The result is written out by calling theflushmethod of this output stream. This method resets the encapsulated cipher object to its initial state and calls theclosemethod of the underlying output stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classFilterOutputStream- Throws:
IOException- if an I/O error occurs.InvalidCipherTextException- if the data written to this stream was invalid ciphertext (e.g. the cipher is an AEAD cipher and the ciphertext tag check fails).
-