151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.security; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.IOException; 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.EOFException; 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.InputStream; 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.FilterInputStream; 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.PrintStream; 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.ByteArrayInputStream; 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A transparent stream that updates the associated message digest using 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the bits going through the stream. 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>To complete the message digest computation, call one of the 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>digest</code> methods on the associated message 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * digest after your calls to one of this digest input stream's 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #read() read} methods. 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>It is possible to turn this stream on or off (see 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #on(boolean) on}). When it is on, a call to one of the 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>read</code> methods 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * results in an update on the message digest. But when it is off, 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the message digest is not updated. The default is for the stream 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to be on. 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Note that digest objects can compute only one digest (see 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link MessageDigest}), 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * so that in order to compute intermediate digests, a caller should 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * retain a handle onto the digest object, and clone it for each 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * digest to be computed, leaving the orginal digest untouched. 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MessageDigest 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DigestOutputStream 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Benjamin Renaud 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic class DigestInputStream extends FilterInputStream { 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* NOTE: This should be made a generic UpdaterInputStream */ 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* Are we on or off? */ 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private boolean on = true; 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The message digest associated with this stream. 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected MessageDigest digest; 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Creates a digest input stream, using the specified input stream 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and message digest. 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param stream the input stream. 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param digest the message digest to associate with this stream. 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public DigestInputStream(InputStream stream, MessageDigest digest) { 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(stream); 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setMessageDigest(digest); 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the message digest associated with this stream. 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the message digest associated with this stream. 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #setMessageDigest(java.security.MessageDigest) 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public MessageDigest getMessageDigest() { 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return digest; 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Associates the specified message digest with this stream. 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param digest the message digest to be associated with this stream. 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getMessageDigest() 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void setMessageDigest(MessageDigest digest) { 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.digest = digest; 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Reads a byte, and updates the message digest (if the digest 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * function is on). That is, this method reads a byte from the 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * input stream, blocking until the byte is actually read. If the 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * digest function is on (see {@link #on(boolean) on}), this method 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will then call <code>update</code> on the message digest associated 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with this stream, passing it the byte read. 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the byte read. 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IOException if an I/O error occurs. 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MessageDigest#update(byte) 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int read() throws IOException { 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int ch = in.read(); 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (on && ch != -1) { 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski digest.update((byte)ch); 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ch; 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Reads into a byte array, and updates the message digest (if the 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * digest function is on). That is, this method reads up to 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>len</code> bytes from the input stream into the array 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>b</code>, starting at offset <code>off</code>. This method 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * blocks until the data is actually 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * read. If the digest function is on (see 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #on(boolean) on}), this method will then call <code>update</code> 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * on the message digest associated with this stream, passing it 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the data. 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param b the array into which the data is read. 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param off the starting offset into <code>b</code> of where the 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * data should be placed. 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param len the maximum number of bytes to be read from the input 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * stream into b, starting at offset <code>off</code>. 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the actual number of bytes read. This is less than 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>len</code> if the end of the stream is reached prior to 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * reading <code>len</code> bytes. -1 is returned if no bytes were 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * read because the end of the stream had already been reached when 15451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the call was made. 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IOException if an I/O error occurs. 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 15851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MessageDigest#update(byte[], int, int) 15951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 16051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int read(byte[] b, int off, int len) throws IOException { 16151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int result = in.read(b, off, len); 16251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (on && result != -1) { 16351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski digest.update(b, off, result); 16451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 16551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 16651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 16751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 16851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 16951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Turns the digest function on or off. The default is on. When 17051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it is on, a call to one of the <code>read</code> methods results in an 17151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * update on the message digest. But when it is off, the message 17251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * digest is not updated. 17351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 17451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param on true to turn the digest function on, false to turn 17551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it off. 17651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 17751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void on(boolean on) { 17851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.on = on; 17951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 18051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 18151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 18251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Prints a string representation of this digest input stream and 18351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * its associated message digest object. 18451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 18551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String toString() { 18651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return "[Digest Input Stream] " + digest.toString(); 18751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 18851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 189