Feature: added extra data length checks (#4805)

* Added 32 bytes check on extra data Added checks and tests for the ExtraData not to be longer than 32 bytes
NethermindEth · Oct 24, 2022 · 161d78e · 161d78e
1 parent 0be02d8
commit 161d78e
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/src/Nethermind/Nethermind.Config/ExitCodes.cs b/src/Nethermind/Nethermind.Config/ExitCodes.cs
@@ -26,4 +26,5 @@ public static class ExitCodes
     public const int NoEngineModule = 100;
 
     public const int NoDownloadOldReceiptsOrBlocks = 101;
+    public const int TooLongExtraData = 102;
 }
diff --git a/src/Nethermind/Nethermind.Consensus/IMiningConfig.cs b/src/Nethermind/Nethermind.Consensus/IMiningConfig.cs
@@ -42,7 +42,7 @@ public interface IMiningConfig : IConfig
             DefaultValue = "false")]
         bool RandomizedBlocks { get; set; }
 
-        [ConfigItem(Description = "Block header extra data.", DefaultValue = "Nethermind")]
+        [ConfigItem(Description = "Block header extra data. 32-bytes shall be extra data max length.", DefaultValue = "Nethermind")]
         string ExtraData { get; set; }
 
         byte[] GetExtraDataBytes();

diff --git a/src/Nethermind/Nethermind.Consensus/MiningConfig.cs b/src/Nethermind/Nethermind.Consensus/MiningConfig.cs
@@ -15,7 +15,10 @@
 //  along with the Nethermind. If not, see <http://www.gnu.org/licenses/>.
 // 
 
+using System;
 using System.Text;
+using Nethermind.Config;
+using Nethermind.Core.Exceptions;
 using Nethermind.Core.Extensions;
 using Nethermind.Int256;
 
@@ -42,8 +45,16 @@ public string ExtraData
             }
             set
             {
+                byte[] bytes = Encoding.UTF8.GetBytes(value);
+                if (bytes != null && bytes.Length > 32)
+                {
+                    throw new InvalidConfigurationException($"Extra Data length was more than 32 bytes. You provided: {_extraDataString}",
+                        ExitCodes.TooLongExtraData);
+
+                }
+
                 _extraDataString = value;
-                _extraDataBytes = Encoding.UTF8.GetBytes(_extraDataString);
+                _extraDataBytes = bytes;
             }
         }
 

diff --git a/src/Nethermind/Nethermind.Mining.Test/MiningConfigTest.cs b/src/Nethermind/Nethermind.Mining.Test/MiningConfigTest.cs
@@ -1,5 +1,6 @@
 using System.Text;
 using Nethermind.Consensus;
+using Nethermind.Core.Exceptions;
 using NUnit.Framework;
 
 namespace Nethermind.Mining.Test;
@@ -8,8 +9,10 @@ namespace Nethermind.Mining.Test;
 public class MiningConfigTest
 {
     [TestCase]
+    [TestCase("")]
     [TestCase("1, 2, 3, 4, 5")]
     [TestCase("Other Extra data")]
+
     public void Test(string data = "Nethermind")
     {
         IMiningConfig config = new MiningConfig();
@@ -19,4 +22,24 @@ public void Test(string data = "Nethermind")
         Assert.AreEqual(config.ExtraData, data);
         Assert.AreEqual(config.GetExtraDataBytes(), dataBytes);
     }
+
+    [Test]
+    public void TestTooLongExtraData()
+    {
+        string data = "1234567890" +
+                      "1234567890" +
+                      "1234567890" +
+                      "1234567890";
+
+        IMiningConfig config = new MiningConfig();
+        string defaultData = config.ExtraData;
+        byte[] defaultDataBytes = Encoding.UTF8.GetBytes(defaultData);
+
+        byte[] dataBytes = Encoding.UTF8.GetBytes(data);
+        Assert.Greater(dataBytes.Length, 32);
+
+        Assert.Throws<InvalidConfigurationException>(() => config.ExtraData = data); //throw on update
+        Assert.AreEqual(config.ExtraData, defaultData); // Keep previous one
+        Assert.AreEqual(config.GetExtraDataBytes(), defaultDataBytes);
+    }
 }