added ProgressListener

Author: DevCybran

src/de/ntcomputer/crypto/eddsa/Ed25519PrivateKey.java

@@ -30,6 +30,7 @@
 import javax.security.auth.Destroyable;
 
 import de.ntcomputer.crypto.hash.HashCondenser;
+import de.ntcomputer.crypto.hash.ProgressListener;
 import net.i2p.crypto.eddsa.EdDSAEngine;
 import net.i2p.crypto.eddsa.EdDSAPrivateKey;
 import net.i2p.crypto.eddsa.EdDSAPublicKey;
@@ -252,7 +253,7 @@ private String signLow(byte[] data) {
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 */
 	public String sign(byte[] data) throws NoSuchAlgorithmException {
-		return signLow(HashCondenser.getInstance().compute(data));
+		return signLow(HashCondenser.getInstance().compute(data, null));
 	}
 
 	/**
@@ -273,30 +274,32 @@ public String sign(String data) throws NoSuchAlgorithmException {
 	 * 
 	 * @param source the data source
 	 * @param sourceSize the exact size of all data which will pass through the InputStream
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return a hexadecimal representation of the signature
 	 * @throws IllegalArgumentException if sourceSize is not the correct size
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 * @throws IOException if an IO error occurs while reading the stream
 	 */
-	public String sign(InputStream source, long sourceSize) throws IllegalArgumentException, NoSuchAlgorithmException, IOException {
-		return signLow(HashCondenser.getInstance().compute(source, sourceSize));
+	public String sign(InputStream source, long sourceSize, ProgressListener listener) throws IllegalArgumentException, NoSuchAlgorithmException, IOException {
+		return signLow(HashCondenser.getInstance().compute(source, sourceSize, listener));
 	}
 
 	/**
 	 * Signs the content of the given file.
 	 * 
 	 * @see #sign(InputStream, long)
 	 * @param source
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return a hexadecimal representation of the signature
 	 * @throws IOException if an IO error occurs while reading the file
 	 * @throws IllegalArgumentException if the file's size changes during computation
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 */
-	public String sign(File source) throws IOException, IllegalArgumentException, NoSuchAlgorithmException {
+	public String sign(File source, ProgressListener listener) throws IOException, IllegalArgumentException, NoSuchAlgorithmException {
 		if(!source.isFile()) throw new FileNotFoundException(source.getAbsolutePath());
 		long fileSize = source.length();
 		try(InputStream is = new FileInputStream(source)) {
-			return this.sign(is, fileSize);
+			return this.sign(is, fileSize, listener);
 		}
 	}
 
@@ -306,12 +309,13 @@ public String sign(File source) throws IOException, IllegalArgumentException, No
 	 * 
 	 * @see #signToFile(File, File)
 	 * @param source
+	 * @param listener a progress listener. Optional, may be null.
 	 * @throws IOException if an IO error occurs while reading or writing a file
 	 * @throws IllegalArgumentException if the file's size changes during computation
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 */
-	public void signToFile(File source) throws IOException, IllegalArgumentException, NoSuchAlgorithmException {
-		this.signToFile(source, new File(source, ".sig"));
+	public void signToFile(File source, ProgressListener listener) throws IOException, IllegalArgumentException, NoSuchAlgorithmException {
+		this.signToFile(source, new File(source, ".sig"), listener);
 	}
 
 	/**
@@ -320,12 +324,13 @@ public void signToFile(File source) throws IOException, IllegalArgumentException
 	 * @see #sign(File)
 	 * @param source
 	 * @param signatureFile the file to write the signature to
+	 * @param listener a progress listener. Optional, may be null.
 	 * @throws IOException if an IO error occurs while reading or writing a file
 	 * @throws IllegalArgumentException if the file's size changes during computation
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 */
-	public void signToFile(File source, File signatureFile) throws IOException, IllegalArgumentException, NoSuchAlgorithmException {
-		String signature = this.sign(source);
+	public void signToFile(File source, File signatureFile, ProgressListener listener) throws IOException, IllegalArgumentException, NoSuchAlgorithmException {
+		String signature = this.sign(source, listener);
 		Files.write(signatureFile.toPath(), signature.getBytes(StandardCharsets.UTF_8));
 	}
 

src/de/ntcomputer/crypto/eddsa/Ed25519PublicKey.java

@@ -12,6 +12,7 @@
 import java.security.SignatureException;
 
 import de.ntcomputer.crypto.hash.HashCondenser;
+import de.ntcomputer.crypto.hash.ProgressListener;
 import net.i2p.crypto.eddsa.EdDSAEngine;
 import net.i2p.crypto.eddsa.EdDSAPublicKey;
 import net.i2p.crypto.eddsa.Utils;
@@ -123,7 +124,7 @@ private boolean verifyLow(byte[] data, String signature) throws SignatureExcepti
 	 * @throws SignatureException if the given signature has an invalid format
 	 */
 	public boolean verify(byte[] data, String signature) throws NoSuchAlgorithmException, SignatureException {
-		return this.verifyLow(HashCondenser.getInstance().compute(data), signature);
+		return this.verifyLow(HashCondenser.getInstance().compute(data, null), signature);
 	}
 
 	/**
@@ -147,14 +148,15 @@ public boolean verify(String data, String signature) throws NoSuchAlgorithmExcep
 	 * @param source the data source
 	 * @param sourceSize the exact size of all data which will pass through the InputStream
 	 * @param signature a hexadecimal representation of the signature (generated by {@link Ed25519PrivateKey#sign(InputStream, long)}
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return true if the signature is correct. False otherwise.
 	 * @throws IllegalArgumentException if sourceSize is not the correct size
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 * @throws IOException if an IO error occurs while reading the stream
 	 * @throws SignatureException if the given signature has an invalid format
 	 */
-	public boolean verify(InputStream source, long sourceSize, String signature) throws IllegalArgumentException, NoSuchAlgorithmException, IOException, SignatureException {
-		return this.verifyLow(HashCondenser.getInstance().compute(source, sourceSize), signature);
+	public boolean verify(InputStream source, long sourceSize, String signature, ProgressListener listener) throws IllegalArgumentException, NoSuchAlgorithmException, IOException, SignatureException {
+		return this.verifyLow(HashCondenser.getInstance().compute(source, sourceSize, listener), signature);
 	}
 
 	/**
@@ -163,17 +165,18 @@ public boolean verify(InputStream source, long sourceSize, String signature) thr
 	 * @see #verify(InputStream, long, String)
 	 * @param source
 	 * @param signature a hexadecimal representation of the signature (generated by {@link Ed25519PrivateKey#sign(File)}
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return true if the signature is correct. False otherwise.
 	 * @throws IOException if an IO error occurs while reading the file
 	 * @throws IllegalArgumentException if the file's size changes during computation
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 * @throws SignatureException if the given signature has an invalid format
 	 */
-	public boolean verify(File source, String signature) throws IOException, IllegalArgumentException, NoSuchAlgorithmException, SignatureException {
+	public boolean verify(File source, String signature, ProgressListener listener) throws IOException, IllegalArgumentException, NoSuchAlgorithmException, SignatureException {
 		if(!source.isFile()) throw new FileNotFoundException(source.getAbsolutePath());
 		long fileSize = source.length();
 		try(InputStream is = new FileInputStream(source)) {
-			return this.verify(is, fileSize, signature);
+			return this.verify(is, fileSize, signature, listener);
 		}
 	}
 
@@ -183,14 +186,15 @@ public boolean verify(File source, String signature) throws IOException, Illegal
 	 * 
 	 * @see #verifyFromFile(File, File)
 	 * @param source
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return true if the signature is correct. False otherwise.
 	 * @throws IOException if an IO error occurs while reading a file
 	 * @throws IllegalArgumentException if the file's size changes during computation
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 * @throws SignatureException if the signature in the .sig file has an invalid format
 	 */
-	public boolean verifyFromFile(File source) throws IOException, IllegalArgumentException, NoSuchAlgorithmException, SignatureException {
-		return this.verifyFromFile(source, new File(source, ".sig"));
+	public boolean verifyFromFile(File source, ProgressListener listener) throws IOException, IllegalArgumentException, NoSuchAlgorithmException, SignatureException {
+		return this.verifyFromFile(source, new File(source, ".sig"), listener);
 	}
 
 	/**
@@ -199,15 +203,16 @@ public boolean verifyFromFile(File source) throws IOException, IllegalArgumentEx
 	 * @see #verify(File, String)
 	 * @param source
 	 * @param signatureFile the file to write the signature to
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return true if the signature is correct. False otherwise.
 	 * @throws IOException if an IO error occurs while reading a file
 	 * @throws IllegalArgumentException if the file's size changes during computation
 	 * @throws NoSuchAlgorithmException if the hash algorithm is not present on this machine
 	 * @throws SignatureException if the signature in the signature file has an invalid format
 	 */
-	public boolean verifyFromFile(File source, File signatureFile) throws IOException, IllegalArgumentException, NoSuchAlgorithmException, SignatureException {
+	public boolean verifyFromFile(File source, File signatureFile, ProgressListener listener) throws IOException, IllegalArgumentException, NoSuchAlgorithmException, SignatureException {
 		String signature = new String(Files.readAllBytes(signatureFile.toPath()), StandardCharsets.UTF_8);
-		return this.verify(source, signature);
+		return this.verify(source, signature, listener);
 	}
 
 }

src/de/ntcomputer/crypto/hash/HashCondenser.java

@@ -9,8 +9,6 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.Arrays;
 
-import net.i2p.crypto.eddsa.Utils;
-
 /**
  * A class which packs any byte input stream or array into a fixed-size output byte array using a {@link MessageDigest}.
  * This is useful when there is a need to sign or verify large files with a signature scheme that requires caching the input data (such as Ed25519).
@@ -98,11 +96,12 @@ private HashCondenser(MessageDigest md, MessageDigest md2, int outputSize) {
 	 * 
 	 * @see #compute(InputStream, long)
 	 * @param data
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return the condensed version of the input
 	 */
-	public byte[] compute(byte[] data) {
+	public byte[] compute(byte[] data, ProgressListener listener) {
 		try {
-			return this.compute(new ByteArrayInputStream(data), data.length);
+			return this.compute(new ByteArrayInputStream(data), data.length, listener);
 		} catch (IOException e) {
 			// IOException should never happen for cached byte stream
 			throw new RuntimeException(e);
@@ -116,12 +115,15 @@ public byte[] compute(byte[] data) {
 	 * Every result contains the original sourceSize and a operation mode indicator.
 	 * 
 	 * @param source
-	 * @param sourceSize the exact number of bytes which can be read from source 
+	 * @param sourceSize the exact number of bytes which can be read from source
+	 * @param listener a progress listener. Optional, may be null.
 	 * @return the condensed version of the input
 	 * @throws IOException when source throws an IOException
 	 * @throws IllegalArgumentException if sourceSize happens not to be the same as source's size
 	 */
-	public byte[] compute(InputStream source, long sourceSize) throws IOException, IllegalArgumentException {		
+	public byte[] compute(InputStream source, long sourceSize, ProgressListener listener) throws IOException, IllegalArgumentException {
+		if(listener!=null) listener.onProgress(0, sourceSize);
+		
 		// create result buffer
 		byte[] result = new byte[this.outputSize];
 		Arrays.fill(result, (byte) 0x00);
@@ -151,6 +153,7 @@ public byte[] compute(InputStream source, long sourceSize) throws IOException, I
 		} else {
 			// otherwise, hash segments
 			this.segmentDigest.reset();
+			long lastProgressUpdateTime = System.currentTimeMillis();
 
 			// add file size + positive sign as compressed mode indicator
 			ByteBuffer.wrap(result).order(ByteOrder.BIG_ENDIAN).putLong(sourceSize);
@@ -203,6 +206,15 @@ public byte[] compute(InputStream source, long sourceSize) throws IOException, I
 					this.segmentDigest.update(buf, readIndex, readLength);
 					previouslyReadSegmentSize+= readLength;
 				}
+				
+				if(listener!=null) {
+					long currentTime = System.currentTimeMillis();
+					if(currentTime > lastProgressUpdateTime + 100) {
+						lastProgressUpdateTime = currentTime;
+						listener.onProgress(readSourceSize, sourceSize);
+					}
+				}
+				
 			}
 
 			if(readSourceSize != sourceSize) throw new IllegalArgumentException("read not as many bytes as sourceSize originally provided. Maybe the resource changed?");
@@ -212,7 +224,7 @@ public byte[] compute(InputStream source, long sourceSize) throws IOException, I
 		// put one digest over the whole stream into the result
 		System.arraycopy(this.digest.digest(), 0, result, LONG_SIZE, digestLength);
 
-		System.out.println(Utils.bytesToHex(result));
+		if(listener!=null) listener.onProgress(sourceSize, sourceSize);
 
 		return result;
 	}

src/de/ntcomputer/crypto/hash/ProgressListener.java

@@ -0,0 +1,8 @@
+package de.ntcomputer.crypto.hash;
+
+@FunctionalInterface
+public interface ProgressListener {
+	
+	public void onProgress(long progress, long limit);
+
+}

test/de/ntcomputer/crypto/eddsa/Ed25519Test.java

@@ -32,27 +32,27 @@ public void testKeyLifecycle() throws Exception {
 
     		URL testSignDataURL = HashCondenserTest.class.getResource("randomdata.bin");
         	File testSignDataFile = new File(testSignDataURL.toURI());
-        	String signature = privateKey.sign(testSignDataFile);
+        	String signature = privateKey.sign(testSignDataFile, null);
 
-        	boolean verifyResult = publicKey.verify(testSignDataFile, signature);
+        	boolean verifyResult = publicKey.verify(testSignDataFile, signature, null);
     		assertThat("Ed25519 signature verification failure", verifyResult, is(true));
 
     		char[] password = new BigInteger(130, random).toString(32).toCharArray();
     		privateKey.saveAsFile(privateKeyFile, password);
     		privateKey = Ed25519PrivateKey.loadFromFile(privateKeyFile, password);
 
-    		String signature2 = privateKey.sign(testSignDataFile);
+    		String signature2 = privateKey.sign(testSignDataFile, null);
     		assertThat("Ed25519 signature regeneration failure", signature2, is(equalTo(signature)));
 
     		publicKey.saveAsFile(publicKeyFile);
     		publicKey = Ed25519PublicKey.loadFromFile(publicKeyFile);
 
-    		verifyResult = publicKey.verify(testSignDataFile, signature);
+    		verifyResult = publicKey.verify(testSignDataFile, signature, null);
     		assertThat("Ed25519 signature reverification failure", verifyResult, is(true));
 
     		exception.expect(SignatureException.class);
             exception.expectMessage("signature length is wrong");
-    		publicKey.verify(testSignDataFile, "");
+    		publicKey.verify(testSignDataFile, "", null);
 
     	} finally {
     		privateKeyFile.delete();

test/de/ntcomputer/crypto/hash/HashCondenserTest.java

@@ -36,7 +36,7 @@ public void testHash() throws Exception {
     	// run hash condenser
     	HashCondenser cond = HashCondenser.getInstance(131);
     	try (InputStream is = new FileInputStream(file)) {
-    		byte[] result = cond.compute(is, fileSize);
+    		byte[] result = cond.compute(is, fileSize, null);
     		assertThat("HashCondenser failed to produce correct result", result, is(equalTo(expectedBin)));
     	}
     }