Class CipherOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
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 InvalidCipherTextIOException
.
-
Field Summary
Fields inherited from class java.io.FilterOutputStream
out
-
Constructor Summary
ConstructorDescriptionCipherOutputStream
(OutputStream output, Cipher cipher) Constructs a CipherOutputStream from an OutputStream and a Cipher. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes this output stream and releases any system resources associated with this stream.void
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.void
write
(byte[] b, int off, int len) Writeslen
bytes from the specified byte array starting at offsetoff
to this output stream.void
write
(int b) Writes the specified byte to this output stream.Methods inherited from class java.io.FilterOutputStream
write
Methods 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:
write
in classFilterOutputStream
- Parameters:
b
- thebyte
.- Throws:
IOException
- if an I/O error occurs.
-
write
Writeslen
bytes from the specified byte array starting at offsetoff
to this output stream.- Overrides:
write
in 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 the
write
methods is less than the cipher's block size, no bytes will be written out.- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in 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 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 theflush
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.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classFilterOutputStream
- Throws:
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).
-