[CODEC-139] DigestUtils: add updateDigest methods and make methods public.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1328553 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/changes/changes.xml

@@ -51,7 +51,10 @@ The <action> type attribute can be add,update,fix,remove.
     </release>
     -->
     <release version="1.7" date="TBD" description="Feature and fix release.">
-      <action dev="ggregory" type="fix" issue="CODEC-133" due-to="lathspell">
+      <action dev="ggregory" type="add" issue="CODEC-139" due-to="dsebastien">
+        DigestUtils: add updateDigest methods and make methods public.
+      </action>
+      <action dev="ggregory" type="add" issue="CODEC-133" due-to="lathspell">
         Add classes for MD5/SHA1/SHA-512-based Unix crypt(3) hash variants.
       </action>
       <action dev="ggregory" type="fix" issue="CODEC-96" due-to="sebb">

src/main/java/org/apache/commons/codec/digest/DigestUtils.java

@@ -81,7 +81,7 @@ private static byte[] getBytesUtf8(String data) {
      * @throws RuntimeException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
-    static MessageDigest getDigest(String algorithm) {
+    public static MessageDigest getDigest(String algorithm) {
         try {
             return MessageDigest.getInstance(algorithm);
         } catch (NoSuchAlgorithmException e) {
@@ -96,7 +96,7 @@ static MessageDigest getDigest(String algorithm) {
      * @throws RuntimeException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
-    private static MessageDigest getMd5Digest() {
+    public static MessageDigest getMd5Digest() {
         return getDigest("MD5");
     }
 
@@ -110,7 +110,7 @@ private static MessageDigest getMd5Digest() {
      * @throws RuntimeException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
-    private static MessageDigest getSha256Digest() {
+    public static MessageDigest getSha256Digest() {
         return getDigest("SHA-256");
     }
 
@@ -124,7 +124,7 @@ private static MessageDigest getSha256Digest() {
      * @throws RuntimeException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
-    private static MessageDigest getSha384Digest() {
+    public static MessageDigest getSha384Digest() {
         return getDigest("SHA-384");
     }
 
@@ -138,7 +138,7 @@ private static MessageDigest getSha384Digest() {
      * @throws RuntimeException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
-    private static MessageDigest getSha512Digest() {
+    public static MessageDigest getSha512Digest() {
         return getDigest("SHA-512");
     }
 
@@ -149,7 +149,7 @@ private static MessageDigest getSha512Digest() {
      * @throws RuntimeException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
-    private static MessageDigest getShaDigest() {
+    public static MessageDigest getShaDigest() {
         return getDigest("SHA");
     }
 
@@ -578,4 +578,34 @@ public static String shaHex(InputStream data) throws IOException {
     public static String shaHex(String data) {
         return Hex.encodeHexString(sha(data));
     }
+
+    /**
+     * Updates the given {@link MessageDigest}.
+     * 
+     * @param messageDigest
+     *            the {@link MessageDigest} to update
+     * @param valueToDigest
+     *            the value to update the {@link MessageDigest} with
+     * @return the updated {@link MessageDigest}
+     * @since 1.7
+     */
+    public static MessageDigest updateDigest(final MessageDigest messageDigest, final String valueToDigest) {
+        messageDigest.update(getBytesUtf8(valueToDigest));
+        return messageDigest;
+    }
+
+    /**
+     * Updates the given {@link MessageDigest}.
+     * 
+     * @param messageDigest
+     *            the {@link MessageDigest} to update
+     * @param valueToDigest
+     *            the value to update the {@link MessageDigest} with
+     * @return the updated {@link MessageDigest}
+     * @since 1.7
+     */
+    public static MessageDigest updateDigest(final MessageDigest messageDigest, byte[] valueToDigest) {
+        messageDigest.update(valueToDigest);
+        return messageDigest;
+    }
 }

src/test/java/org/apache/commons/codec/digest/DigestUtilsTest.java

@@ -22,8 +22,10 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
+import java.security.MessageDigest;
 import java.util.Random;
 
+import org.apache.commons.codec.binary.Hex;
 import org.apache.commons.codec.binary.StringUtils;
 import org.junit.Test;
 
@@ -177,4 +179,41 @@ public void testShaHex() throws IOException {
                 DigestUtils.shaHex(new ByteArrayInputStream(testData)));
 
     }
+    
+    @Test
+    public void testUpdateWithByteArray(){
+        final String d1 = "C'est un homme qui rentre dans un café, et plouf";
+        final String d2 = "C'est un homme, c'est qu'une tête, on lui offre un cadeau: 'oh... encore un chapeau!'";
+
+        MessageDigest messageDigest = DigestUtils.getShaDigest();
+        messageDigest.update(d1.getBytes());
+        messageDigest.update(d2.getBytes());
+        final String expectedResult = Hex.encodeHexString(messageDigest.digest());
+
+        messageDigest = DigestUtils.getShaDigest();
+        DigestUtils.updateDigest(messageDigest, d1.getBytes());
+        DigestUtils.updateDigest(messageDigest, d2.getBytes());
+        final String actualResult = Hex.encodeHexString(messageDigest.digest());
+
+        assertEquals(expectedResult, actualResult);
+    }
+
+    @Test
+    public void testUpdateWithString(){
+        final String d1 = "C'est un homme qui rentre dans un café, et plouf";
+        final String d2 = "C'est un homme, c'est qu'une tête, on lui offre un cadeau: 'oh... encore un chapeau!'";
+        
+        MessageDigest messageDigest = DigestUtils.getShaDigest();
+        messageDigest.update(StringUtils.getBytesUtf8(d1));
+        messageDigest.update(StringUtils.getBytesUtf8(d2));
+        final String expectedResult = Hex.encodeHexString(messageDigest.digest());
+
+        messageDigest = DigestUtils.getShaDigest();
+        DigestUtils.updateDigest(messageDigest, d1);
+        DigestUtils.updateDigest(messageDigest, d2);
+        final String actualResult = Hex.encodeHexString(messageDigest.digest());
+
+        assertEquals(expectedResult, actualResult);
+    }
+
 }