ATL-6926: Clean up code and tests

EzequielPostan · EzequielPostan · commit 72598aadbe29 · 2024-04-22T20:20:50.000-03:00
diff --git a/node/src/main/scala/io/iohk/atala/prism/node/crypto/CryptoUtils.scala b/node/src/main/scala/io/iohk/atala/prism/node/crypto/CryptoUtils.scala
@@ -11,11 +11,15 @@ import org.bouncycastle.jce.spec.ECNamedCurveSpec
 
 import java.math.BigInteger
 import java.security.spec.{ECParameterSpec, ECPoint, ECPrivateKeySpec, ECPublicKeySpec}
+import scala.util.Try
 
 object CryptoUtils {
   def isSecp256k1(key: SecpPublicKey): Boolean = {
-    val t = key
-    t == t
+    val params = ECNamedCurveTable.getParameterSpec("secp256k1")
+    val curve = params.getCurve
+    val x = new BigInteger(1, key.x)
+    val y = new BigInteger(1, key.y)
+    Try(curve.validatePoint(x, y)).isSuccess
   }
 
   trait SecpPublicKey {
@@ -56,12 +60,6 @@ object CryptoUtils {
   }
   private[crypto] case class SecpPrivateKeyImpl(bytes: Array[Byte]) extends SecpPrivateKey {
     override def getEncoded: Array[Byte] = {
-      // val PRIVATE_KEY_BYTE_SIZE = 32
-      // val byteList = privateLey.asInstanceOf[ECPrivateKey].getD.toByteArray
-      // val padding = Array.fill[Byte](PRIVATE_KEY_BYTE_SIZE - byteList.size) { 0 }
-      // padding ++ byteList
-      // The SDK was adding a padding that seems to later not be able to parse according to tests
-
       privateLey
         .asInstanceOf[ECPrivateKey]
         .getD
@@ -149,7 +147,7 @@ object CryptoUtils {
 
     def unsafetoPublicKeyFromUncompressed(bytes: Array[Byte]): SecpPublicKey = {
       val PRIVATE_KEY_BYTE_SIZE: Int = 32
-      val pointSize = PRIVATE_KEY_BYTE_SIZE * 2  + 1
+      val pointSize = PRIVATE_KEY_BYTE_SIZE * 2 + 1
       require(bytes.length == pointSize, s"Invalid public key bytes length, ${bytes.length}")
 
       val uncompressedPrefix = bytes.head
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/NodeExplorerServiceSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/NodeExplorerServiceSpec.scala
@@ -18,10 +18,22 @@ import io.iohk.atala.prism.node.errors.NodeError
 import io.iohk.atala.prism.node.models.AtalaObjectStatus.{Pending, Scheduled}
 import io.iohk.atala.prism.node.models._
 import io.iohk.atala.prism.node.operations._
-import io.iohk.atala.prism.node.repositories.{AtalaOperationsRepository, MetricsCountersRepository, RequestNoncesRepository}
-import io.iohk.atala.prism.node.services.{BlockProcessingServiceSpec, NodeExplorerService, ObjectManagementService, StatisticsService}
+import io.iohk.atala.prism.node.repositories.{
+  AtalaOperationsRepository,
+  MetricsCountersRepository,
+  RequestNoncesRepository
+}
+import io.iohk.atala.prism.node.services.{
+  BlockProcessingServiceSpec,
+  NodeExplorerService,
+  ObjectManagementService,
+  StatisticsService
+}
 import io.iohk.atala.prism.node.nonce.{ClientHelper, RequestAuthenticator}
-import io.iohk.atala.prism.protos.node_api.GetScheduledOperationsRequest.OperationType.{AnyOperationType, CreateDidOperationOperationType}
+import io.iohk.atala.prism.protos.node_api.GetScheduledOperationsRequest.OperationType.{
+  AnyOperationType,
+  CreateDidOperationOperationType
+}
 import io.iohk.atala.prism.protos.node_api.NodeExplorerServiceGrpc.NodeExplorerServiceBlockingClient
 import io.iohk.atala.prism.protos.node_api._
 import io.iohk.atala.prism.protos.node_models.SignedAtalaOperation
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/crypto/CryptoTestUtils.scala b/node/src/test/scala/io/iohk/atala/prism/node/crypto/CryptoTestUtils.scala
@@ -25,10 +25,8 @@ object CryptoTestUtils {
     )
   }
 
-  def generatePublicKey(): SecpPublicKey = generateKeyPair().publicKey
-
   def generatePublicKeyData(): PublicKeyData = toPublicKeyData(
-    generatePublicKey()
+    generateKeyPair().publicKey
   )
 
   def getUnderlyingKey(secpKey: SecpPublicKey): ECPublicKey = EC.INSTANCE.toPublicKeyFromCompressed(secpKey.compressed)
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/crypto/CryptoTestsSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/crypto/CryptoTestsSpec.scala
@@ -1,13 +1,58 @@
 package io.iohk.atala.prism.node.crypto
 
-import io.iohk.atala.prism.crypto.EC
+import io.iohk.atala.prism.crypto.signature.ECSignature
+import io.iohk.atala.prism.crypto.{EC, Sha256, Sha256Digest}
 import io.iohk.atala.prism.node.crypto.CryptoUtils.{SecpECDSA, SecpPrivateKey, SecpPublicKey}
 import org.scalatest.matchers.must.Matchers.convertToAnyMustWrapper
 import org.scalatest.wordspec.AnyWordSpec
 
+import scala.util.Try
+
+// The end goal of this test suit is to be deleted
+// Its purpose is to validate that the new implementation is
+// equivalent to the old SDK it is replacing, Once the SDK is
+// removed, then this tests should be deleted too
 class CryptoTestsSpec extends AnyWordSpec {
 
-  "crypto library" should {
+  // public key encoding/decoding (compressed and uncompressed)
+  // private key encoding/decoding
+  // Signature validation
+
+  "cryptoUtils library" should {
+
+    // HASHING
+    "Perform Sha256 hashing as the SDK" in {
+      val msg = EC.INSTANCE.generateKeyPair().getPublicKey.getEncoded
+      CryptoUtils.Sha256Hash.compute(msg).bytes mustBe Sha256.compute(msg).getValue.toVector
+    }
+
+    "encode hashes as the SDK" in {
+      val msg = EC.INSTANCE.generateKeyPair().getPublicKey.getEncoded
+      CryptoUtils.Sha256Hash.compute(msg).hexEncoded mustBe Sha256.compute(msg).getHexValue
+    }
+
+    "decode hex encoded hashes as the SDK" in {
+      val hexEncoded = "c489e391b64dc18273047935edcb5e90d97da88b58ed9c2fa5e48dd3cf878f56"
+      CryptoUtils.Sha256Hash.fromHex(hexEncoded).bytes mustBe Sha256Digest.fromHex(hexEncoded).getValue.toVector
+
+      val invalidHex = "W489e391b64dc18273047935edcb5e90d97da88b58ed9c2fa5e48dd3cf878f56"
+      val failed1 = Try(CryptoUtils.Sha256Hash.fromHex(invalidHex))
+      val failed2 = Try(Sha256Digest.fromHex(invalidHex))
+      (failed1.isFailure && failed2.isFailure) mustBe true
+    }
+
+    "decode hashes bytes as the SDK" in {
+      val bytes = Array[Byte](-60, -119, -29, -111, -74, 77, -63, -126, 115, 4, 121, 53, -19, -53, 94, -112, -39, 125,
+        -88, -117, 88, -19, -100, 47, -91, -28, -115, -45, -49, -121, -113, 86)
+      CryptoUtils.Sha256Hash.fromBytes(bytes).bytes mustBe Sha256Digest.fromBytes(bytes).getValue.toVector
+
+      val invalidBytes = Array[Byte]()
+      val failed1 = Try(CryptoUtils.Sha256Hash.fromBytes(invalidBytes))
+      val failed2 = Try(Sha256Digest.fromBytes(invalidBytes))
+      (failed1.isFailure && failed2.isFailure) mustBe true
+    }
+
+    // SIGNING / VERIFICATION
     "can verify what SDK signs" in {
       val pair = EC.INSTANCE.generateKeyPair()
       val pub = pair.getPublicKey
@@ -20,7 +65,7 @@ class CryptoTestsSpec extends AnyWordSpec {
       SecpPublicKey.checkECDSASignature(msg, sig.getData, secp) mustBe true
     }
 
-      "can verify what it signs" in {
+    "can verify what it signs" in {
       val pair = CryptoTestUtils.generateKeyPair()
       val pub = pair.publicKey
       val priv = pair.privateKey
@@ -31,8 +76,32 @@ class CryptoTestsSpec extends AnyWordSpec {
       SecpPublicKey.checkECDSASignature(msg, sig, pub) mustBe true
     }
 
-    "public key uncompressed encoding decoding" in {
-      ///
+    "can produce valid signatures according to SDK" in {
+      val pair = CryptoTestUtils.generateKeyPair()
+      val pub = CryptoTestUtils.getUnderlyingKey(pair.publicKey)
+      val priv = pair.privateKey
+
+      val msg = CryptoUtils.Sha256Hash.compute(pub.getEncodedCompressed).bytes.toArray
+      val sig = new ECSignature(SecpECDSA.signBytes(msg, priv).bytes)
+
+      EC.INSTANCE.verifyBytes(msg, pub, sig) mustBe true
+    }
+
+    // PUBLIC KEY ENCODING / DECODING
+    "public key uncompressed encoding us compatible with SDK" in {
+      val secpPublicKey = CryptoTestUtils.generateKeyPair().publicKey
+      val sdkPubKey = EC.INSTANCE.generateKeyPair().getPublicKey
+
+      val uSecp = secpPublicKey.unCompressed
+      val uSdk = sdkPubKey.getEncoded
+
+      // we parse the keys in the opposite library
+      val parsedSDKKey = SecpPublicKey.unsafetoPublicKeyFromUncompressed(uSdk)
+      val parsedSecpKey = EC.INSTANCE.toPublicKeyFromBytes(uSecp)
+
+      // we compare the encodings
+      uSdk.toVector mustBe parsedSDKKey.unCompressed.toVector
+      uSecp.toVector mustBe parsedSecpKey.getEncoded.toVector
     }
 
     "private key encoding decoding" in {
@@ -41,9 +110,6 @@ class CryptoTestsSpec extends AnyWordSpec {
       val encodedPvKey = privK.getEncoded
       val secp = SecpPrivateKey.unsafefromBytesCompressed(encodedPvKey)
 
-      println(secp.bytes.toVector)
-      println(secp.getEncoded.toVector)
-
       encodedPvKey.toVector mustBe secp.getEncoded.toVector
     }
 
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/metrics/OperationsCounterSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/metrics/OperationsCounterSpec.scala
@@ -6,7 +6,12 @@ import io.iohk.atala.prism.node.services.BlockProcessingServiceSpec
 import io.iohk.atala.prism.protos.node_models.{AtalaOperation, SignedAtalaOperation}
 import org.scalatest.EitherValues._
 import org.scalatest.matchers.must.Matchers
-import io.iohk.atala.prism.node.operations.{CreateDIDOperationSpec, DeactivateDIDOperationSpec, ProtocolVersionUpdateOperationSpec, UpdateDIDOperationSpec}
+import io.iohk.atala.prism.node.operations.{
+  CreateDIDOperationSpec,
+  DeactivateDIDOperationSpec,
+  ProtocolVersionUpdateOperationSpec,
+  UpdateDIDOperationSpec
+}
 
 class OperationsCounterSpec extends AnyWordSpec with Matchers {
   "countReceivedAtalaOperations" should {
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/operations/CreateDIDOperationSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/operations/CreateDIDOperationSpec.scala
@@ -22,7 +22,7 @@ import org.scalatest.OptionValues._
 
 object CreateDIDOperationSpec {
   def protoECKeyDataFromPublicKey(
-    key: SecpPublicKey
+      key: SecpPublicKey
   ): node_models.ECKeyData =
     node_models.ECKeyData(
       curve = key.curveName,
@@ -43,7 +43,6 @@ object CreateDIDOperationSpec {
     protoECKeyDataFromPublicKey(keyPair.publicKey)
   }
 
-
   def randomCompressedECKeyData: CompressedECKeyData = {
     val keyPair = CryptoTestUtils.generateKeyPair()
     protoCompressedECKeyDataFromPublicKey(keyPair.publicKey)
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/operations/UpdateDIDOperationSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/operations/UpdateDIDOperationSpec.scala
@@ -11,7 +11,12 @@ import io.iohk.atala.prism.node.crypto.CryptoTestUtils.SecpPair
 import io.iohk.atala.prism.node.crypto.CryptoUtils.Sha256Hash
 import io.iohk.atala.prism.node.grpc.ProtoCodecs
 import io.iohk.atala.prism.node.models.{DIDPublicKey, DIDService, KeyUsage, ProtocolConstants}
-import io.iohk.atala.prism.node.operations.CreateDIDOperationSpec.{issuingEcKeyData, masterEcKeyData, randomCompressedECKeyData, randomECKeyData}
+import io.iohk.atala.prism.node.operations.CreateDIDOperationSpec.{
+  issuingEcKeyData,
+  masterEcKeyData,
+  randomCompressedECKeyData,
+  randomECKeyData
+}
 import io.iohk.atala.prism.node.repositories.daos.{ContextDAO, PublicKeysDAO, ServicesDAO}
 import io.iohk.atala.prism.node.services.BlockProcessingServiceSpec
 import io.iohk.atala.prism.protos.node_models
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/services/BlockProcessingServiceSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/services/BlockProcessingServiceSpec.scala
@@ -9,7 +9,12 @@ import io.iohk.atala.prism.protos.models.TimestampInfo
 import io.iohk.atala.prism.node.models.{AtalaOperationId, DidSuffix, Ledger, TransactionId}
 import io.iohk.atala.prism.node.{AtalaWithPostgresSpec, DataPreparation}
 import io.iohk.atala.prism.node.models.{AtalaOperationInfo, AtalaOperationStatus}
-import io.iohk.atala.prism.node.operations.{ApplyOperationConfig, CreateDIDOperation, CreateDIDOperationSpec, UpdateDIDOperationSpec}
+import io.iohk.atala.prism.node.operations.{
+  ApplyOperationConfig,
+  CreateDIDOperation,
+  CreateDIDOperationSpec,
+  UpdateDIDOperationSpec
+}
 import io.iohk.atala.prism.node.operations.UpdateDIDOperationSpec.{exampleAddKeyAction, exampleRemoveKeyAction}
 import io.iohk.atala.prism.node.repositories.daos.DIDDataDAO
 import io.iohk.atala.prism.protos.node_models.SignedAtalaOperation
diff --git a/node/src/test/scala/io/iohk/atala/prism/node/services/ObjectManagementServiceSpec.scala b/node/src/test/scala/io/iohk/atala/prism/node/services/ObjectManagementServiceSpec.scala
@@ -13,15 +13,24 @@ import io.iohk.atala.prism.node.cardano.models.CardanoWalletError
 import io.iohk.atala.prism.node.crypto.CryptoTestUtils
 import io.iohk.atala.prism.node.crypto.CryptoTestUtils.SecpPair
 import io.iohk.atala.prism.node.crypto.CryptoUtils.Sha256Hash
-import io.iohk.atala.prism.node.errors.NodeError.{TooManyDidPublicKeysCreationAttempt, TooManyServiceCreationAttempt, UnsupportedProtocolVersion}
+import io.iohk.atala.prism.node.errors.NodeError.{
+  TooManyDidPublicKeysCreationAttempt,
+  TooManyServiceCreationAttempt,
+  UnsupportedProtocolVersion
+}
 import io.iohk.atala.prism.node.grpc.ProtoCodecs
 import io.iohk.atala.prism.node.models.AtalaObjectTransactionSubmissionStatus.InLedger
 import io.iohk.atala.prism.node.models._
 import io.iohk.atala.prism.node.operations.{ApplyOperationConfig, CreateDIDOperationSpec}
 import io.iohk.atala.prism.node.operations.CreateDIDOperationSpec.{issuingEcKeyData, masterKeys}
 import io.iohk.atala.prism.node.operations.ProtocolVersionUpdateOperationSpec._
 import io.iohk.atala.prism.node.repositories.daos.{AtalaObjectTransactionSubmissionsDAO, AtalaObjectsDAO}
-import io.iohk.atala.prism.node.repositories.{AtalaObjectsTransactionsRepository, AtalaOperationsRepository, KeyValuesRepository, ProtocolVersionRepository}
+import io.iohk.atala.prism.node.repositories.{
+  AtalaObjectsTransactionsRepository,
+  AtalaOperationsRepository,
+  KeyValuesRepository,
+  ProtocolVersionRepository
+}
 import io.iohk.atala.prism.node.services.BlockProcessingServiceSpec.{createDidOperation, signOperation}
 import io.iohk.atala.prism.node.services.models.AtalaObjectNotification
 import io.iohk.atala.prism.node.{DataPreparation, PublicationInfo, UnderlyingLedger}

Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,8 @@ object CryptoTestUtils {`
`25`	`25`	`)`
`26`	`26`	`}`
`27`	`27`
`28`		`- def generatePublicKey(): SecpPublicKey = generateKeyPair().publicKey`
`29`		`-`
`30`	`28`	`def generatePublicKeyData(): PublicKeyData = toPublicKeyData(`
`31`		`- generatePublicKey()`
	`29`	`+ generateKeyPair().publicKey`
`32`	`30`	`)`
`33`	`31`
`34`	`32`	`def getUnderlyingKey(secpKey: SecpPublicKey): ECPublicKey = EC.INSTANCE.toPublicKeyFromCompressed(secpKey.compressed)`