- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- javax.crypto.CipherInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class CipherInputStream extends FilterInputStream
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 class adheres strictly to the semantics, especially the failure semantics, of its ancestor classes java.io.FilterInputStream and java.io.InputStream. This class has exactly those methods specified in its ancestor classes, and overrides them all. Moreover, this class catches all exceptions that are not thrown by its ancestor classes. In particular, the
skip
method skips, and theavailable
method counts only data that have been processed by the encapsulated Cipher. This class may catch BadPaddingException and other exceptions thrown by failed integrity checks during decryption. These exceptions are not re-thrown, so the client may not be informed that integrity checks failed. Because of this behavior, this class may not be suitable for use with decryption in an authenticated mode of operation (e.g. GCM). Applications that require authenticated encryption can use the Cipher API directly as an alternative to using this class.It is crucial for a programmer using this class not to use methods that are not defined or overriden in this class (such as a new method or constructor that is later added to one of the super classes), because the design and implementation of those methods are unlikely to have considered security impact with regard to CipherInputStream.
- Since:
- 1.4
- See Also:
InputStream
,FilterInputStream
,Cipher
,CipherOutputStream
-
-
Field Summary
-
Fields inherited from class java.io.FilterInputStream
in
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
CipherInputStream(InputStream is)
Constructs a CipherInputStream from an InputStream without specifying a Cipher.CipherInputStream(InputStream is, Cipher c)
Constructs a CipherInputStream from an InputStream and a Cipher.
-
Method Summary
Methods Modifier and Type Method and Description int
available()
Returns the number of bytes that can be read from this input stream without blocking.void
close()
Closes this input stream and releases any system resources associated with the stream.boolean
markSupported()
Tests if this input stream supports themark
andreset
methods, which it does not.int
read()
Reads the next byte of data from this input stream.int
read(byte[] b)
Reads up tob.length
bytes of data from this input stream into an array of bytes.int
read(byte[] b, int off, int len)
Reads up tolen
bytes of data from this input stream into an array of bytes.long
skip(long n)
Skipsn
bytes of input from the bytes that can be read from this input stream without blocking.
-
-
-
Constructor Detail
-
CipherInputStream
public CipherInputStream(InputStream is, Cipher c)
Constructs a CipherInputStream from an InputStream and a Cipher.
Note: if the specified input stream or cipher is null, a NullPointerException may be thrown later when they are used.- Parameters:
is
- the to-be-processed input streamc
- an initialized Cipher object
-
CipherInputStream
protected CipherInputStream(InputStream is)
Constructs a CipherInputStream from an InputStream without specifying a Cipher. This has the effect of constructing a CipherInputStream using a NullCipher.
Note: if the specified input stream is null, a NullPointerException may be thrown later when it is used.- Parameters:
is
- the to-be-processed input stream
-
-
Method Detail
-
read
public int read() throws IOException
Reads the next byte of data from this input stream. The value byte is returned as anint
in the range0
to255
. If no byte is available because the end of the stream has been reached, the value-1
is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.- Overrides:
read
in classFilterInputStream
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached. - Throws:
IOException
- if an I/O error occurs.- Since:
- JCE1.2
- See Also:
FilterInputStream.in
-
read
public int read(byte[] b) throws IOException
Reads up tob.length
bytes of data from this input stream into an array of bytes.The
read
method ofInputStream
calls theread
method of three arguments with the argumentsb
,0
, andb.length
.- Overrides:
read
in classFilterInputStream
- Parameters:
b
- the buffer into which the data is read.- Returns:
- the total number of bytes read into the buffer, or
-1
is there is no more data because the end of the stream has been reached. - Throws:
IOException
- if an I/O error occurs.- Since:
- JCE1.2
- See Also:
InputStream.read(byte[], int, int)
-
read
public int read(byte[] b, int off, int len) throws IOException
Reads up tolen
bytes of data from this input stream into an array of bytes. This method blocks until some input is available. If the first argument isnull,
up tolen
bytes are read and discarded.- Overrides:
read
in classFilterInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in the destination arraybuf
len
- the maximum number of bytes read.- 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. - Throws:
IOException
- if an I/O error occurs.- Since:
- JCE1.2
- See Also:
InputStream.read()
-
skip
public long skip(long n) throws IOException
Skipsn
bytes of input from the bytes that can be read from this input stream without blocking.Fewer bytes than requested might be skipped. The actual number of bytes skipped is equal to
n
or the result of a call to
, whichever is smaller. Ifavailable
n
is less than zero, no bytes are skipped.The actual number of bytes skipped is returned.
- Overrides:
skip
in classFilterInputStream
- Parameters:
n
- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
IOException
- if an I/O error occurs.- Since:
- JCE1.2
-
available
public int available() throws IOException
Returns the number of bytes that can be read from this input stream without blocking. Theavailable
method ofInputStream
returns0
. This method should be overridden by subclasses.- Overrides:
available
in classFilterInputStream
- Returns:
- the number of bytes that can be read from this input stream without blocking.
- Throws:
IOException
- if an I/O error occurs.- Since:
- JCE1.2
-
close
public void close() throws IOException
Closes this input stream and releases any system resources associated with the stream.The
close
method ofCipherInputStream
calls theclose
method of its underlying input stream.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classFilterInputStream
- Throws:
IOException
- if an I/O error occurs.- Since:
- JCE1.2
- See Also:
FilterInputStream.in
-
markSupported
public boolean markSupported()
Tests if this input stream supports themark
andreset
methods, which it does not.- Overrides:
markSupported
in classFilterInputStream
- Returns:
false
, since this class does not support themark
andreset
methods.- Since:
- JCE1.2
- See Also:
InputStream.mark(int)
,InputStream.reset()
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/crypto/CipherInputStream.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.