Merge branch '1839-photonbeetle-xoodyak-digests-reset' into 'main'

Fix the issue about doFinal() of PhotonBeetle and Xoodyak digest do not reset properly

See merge request root/bc-java!32

Author: Administrator

core/src/main/java/org/bouncycastle/crypto/digests/PhotonBeetleDigest.java

@@ -137,6 +137,7 @@ else if (inlen <= INITIAL_RATE_INBYTES)
         System.arraycopy(state, 0, output, outOff, SQUEEZE_RATE_INBYTES);
         PHOTON_Permutation();
         System.arraycopy(state, 0, output, outOff + SQUEEZE_RATE_INBYTES, TAG_INBYTES - SQUEEZE_RATE_INBYTES);
+        reset();
         return TAG_INBYTES;
     }
 

core/src/main/java/org/bouncycastle/crypto/digests/XoodyakDigest.java

@@ -105,6 +105,7 @@ public int doFinal(byte[] output, int outOff)
         Up(output, outOff, TAGLEN, 0x40);
         Down(null, 0, 0, 0);
         Up(output, outOff + TAGLEN, TAGLEN, 0);
+        reset();
         return 32;
     }
 

core/src/test/java/org/bouncycastle/crypto/test/DigestTest.java

@@ -1,11 +1,15 @@
 package org.bouncycastle.crypto.test;
 
+import java.security.SecureRandom;
+
 import org.bouncycastle.crypto.Digest;
 import org.bouncycastle.crypto.digests.EncodableDigest;
 import org.bouncycastle.util.Arrays;
 import org.bouncycastle.util.Memoable;
 import org.bouncycastle.util.encoders.Hex;
 import org.bouncycastle.util.test.SimpleTest;
+import org.bouncycastle.util.test.SimpleTestResult;
+import org.bouncycastle.util.test.TestFailedException;
 
 public abstract class DigestTest
     extends SimpleTest
@@ -243,4 +247,31 @@ protected void sixtyFourKTest(
             fail("64k test failed", expected, new String(Hex.encode(resBuf)));
         }
     }
+
+    static void checkDigestReset(final SimpleTest test, final Digest pDigest)
+    {
+        int DATALEN = 100;
+        /* Obtain some random data */
+        final byte[] myData = new byte[DATALEN];
+        final SecureRandom myRandom = new SecureRandom();
+        myRandom.nextBytes(myData);
+
+        /* Update and finalise digest */
+        final int myHashLen = pDigest.getDigestSize();
+        final byte[] myFirst = new byte[myHashLen];
+        pDigest.update(myData, 0, DATALEN);
+        pDigest.doFinal(myFirst, 0);
+
+
+        /* Reuse the digest */
+        final byte[] mySecond = new byte[myHashLen];
+        pDigest.update(myData, 0, DATALEN);
+        pDigest.doFinal(mySecond, 0);
+
+        /* Check that we have the same result */
+        if (!java.util.Arrays.equals(myFirst, mySecond))
+        {
+            throw new TestFailedException(SimpleTestResult.failed(test,"Digest " + pDigest.getAlgorithmName() + " does not reset properly on doFinal()"));
+        }
+    }
 }

core/src/test/java/org/bouncycastle/crypto/test/PhotonBeetleTest.java

@@ -30,6 +30,7 @@ public String getName()
     public void performTest()
         throws Exception
     {
+        DigestTest.checkDigestReset(this, new PhotonBeetleDigest());
         testVectorsHash();
         PhotonBeetleEngine pb = new PhotonBeetleEngine(PhotonBeetleEngine.PhotonBeetleParameters.pb32);
         testExceptions(pb, pb.getKeyBytesSize(), pb.getIVBytesSize(), pb.getBlockSize());
@@ -46,22 +47,16 @@ private void testVectorsHash()
         throws Exception
     {
         PhotonBeetleDigest PhotonBeetle = new PhotonBeetleDigest();
-        CipherParameters params;
         InputStream src = TestResourceFinder.findTestResource("crypto/photonbeetle", "LWC_HASH_KAT_256.txt");
         BufferedReader bin = new BufferedReader(new InputStreamReader(src));
         String line;
-        byte[] ptByte, adByte;
-        byte[] rv;
+        byte[] ptByte;
         HashMap<String, String> map = new HashMap<String, String>();
         while ((line = bin.readLine()) != null)
         {
             int a = line.indexOf('=');
             if (a < 0)
             {
-//                if (!map.get("Count").equals("3"))
-//                {
-//                    continue;
-//                }
                 PhotonBeetle.reset();
                 ptByte = Hex.decode((String)map.get("Msg"));
                 PhotonBeetle.update(ptByte, 0, ptByte.length);
@@ -71,10 +66,6 @@ private void testVectorsHash()
                 {
                     mismatch("Keystream " + map.get("Count"), (String)map.get("MD"), hash);
                 }
-//                else
-//                {
-//                    System.out.println("Keystream " + map.get("Count") + " pass");
-//                }
                 map.clear();
                 PhotonBeetle.reset();
             }
@@ -83,7 +74,6 @@ private void testVectorsHash()
                 map.put(line.substring(0, a).trim(), line.substring(a + 1).trim());
             }
         }
-        //System.out.print.println("PhotonBeetle Hash pass");
     }
 
     private void testVectors(PhotonBeetleEngine.PhotonBeetleParameters pbp, String filename)
@@ -94,18 +84,13 @@ private void testVectors(PhotonBeetleEngine.PhotonBeetleParameters pbp, String f
         InputStream src = TestResourceFinder.findTestResource("crypto/photonbeetle", filename + "_LWC_AEAD_KAT_128_128.txt");
         BufferedReader bin = new BufferedReader(new InputStreamReader(src));
         String line;
-        byte[] ptByte, adByte;
         byte[] rv;
         HashMap<String, String> map = new HashMap<String, String>();
         while ((line = bin.readLine()) != null)
         {
             int a = line.indexOf('=');
             if (a < 0)
             {
-//                if (!map.get("Count").equals("133"))
-//                {
-//                    continue;
-//                }
                 byte[] key = Hex.decode(map.get("Key"));
                 byte[] nonce = Hex.decode(map.get("Nonce"));
                 byte[] ad = Hex.decode(map.get("AD"));
@@ -121,10 +106,6 @@ private void testVectors(PhotonBeetleEngine.PhotonBeetleParameters pbp, String f
                 {
                     mismatch("Keystream " + map.get("Count"), (String)map.get("CT"), rv);
                 }
-//                else
-//                {
-//                    System.out.println("Keystream " + map.get("Count") + " pass");
-//                }
                 PhotonBeetle.reset();
                 PhotonBeetle.init(false, params);
                 //Decrypt

core/src/test/java/org/bouncycastle/crypto/test/XoodyakTest.java

@@ -32,6 +32,7 @@ public String getName()
     public void performTest()
         throws Exception
     {
+        DigestTest.checkDigestReset(this, new XoodyakDigest());
         testVectorsHash();
         testVectors();
         XoodyakEngine xoodyak = new XoodyakEngine();
@@ -96,10 +97,6 @@ private void testVectors()
             int a = line.indexOf('=');
             if (a < 0)
             {
-//                if (!map.get("Count").equals("826"))
-//                {
-//                    continue;
-//                }
                 byte[] key = Hex.decode(map.get("Key"));
                 byte[] nonce = Hex.decode(map.get("Nonce"));
                 byte[] ad = Hex.decode(map.get("AD"));
@@ -115,10 +112,6 @@ private void testVectors()
                 {
                     mismatch("Keystream " + map.get("Count"), (String)map.get("CT"), rv);
                 }
-//                else
-//                {
-//                    System.out.println("Keystream " + map.get("Count") + " pass");
-//                }
                 xoodyak.reset();
                 xoodyak.init(false, params);
                 //Decrypt