Add new CorrelationId type for offline updates/lockboxes

uptane · Nov 3, 2023 · f54833d · f54833d
1 parent a84f8be
commit f54833d
Showing 1 changed file with 18 additions and 3 deletions.
diff --git a/libats/src/main/scala/com/advancedtelematic/libats/data/DataType.scala b/libats/src/main/scala/com/advancedtelematic/libats/data/DataType.scala
@@ -1,10 +1,14 @@
 package com.advancedtelematic.libats.data
 
 import java.util.UUID
-
 import com.advancedtelematic.libats.data.DataType.HashMethod.HashMethod
-import eu.timepit.refined.api.{Refined, Validate}
+import eu.timepit.refined.api.{RefType, Refined, Validate}
+import eu.timepit.refined.boolean.And
+import eu.timepit.refined.collection.Size
+import eu.timepit.refined.generic.Equal
+import eu.timepit.refined.string.HexStringSpec
 import io.circe.{Decoder, Encoder}
+import cats.syntax.either.*
 
 import scala.language.postfixOps
 
@@ -44,18 +48,29 @@ object DataType {
     override def toString: String = s"urn:here-ota:auto-update:$value"
   }
 
+  type ValidLockboxHash = String Refined (HexStringSpec And Size[Equal[12]])
+
+  final case class OfflineUpdateId(name: String, version: Long, hash: ValidLockboxHash) extends CorrelationId {
+    override def toString: String = s"urn:tdx-ota:lockbox:$name:$version:${hash.value}"
+  }
   object CorrelationId {
     private[this] val CorrelationIdRe = """^urn:here-ota:(mtu|auto-update|campaign):([0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12})$"""r
 
+    private [this] val TrxCorrelationIdRe = """^urn:tdx-ota:lockbox:([A-Za-z0-9_-]+):([0-9]+):([0-9a-fA-F]{12})$"""r
+
     def fromString(s: String): Either[String, CorrelationId] = s match {
       case CorrelationIdRe("mtu", uuid) =>
         Right(MultiTargetUpdateId(UUID.fromString(uuid)))
       case CorrelationIdRe("campaign", uuid) =>
         Right(CampaignId(UUID.fromString(uuid)))
       case CorrelationIdRe("auto-update", uuid) =>
         Right(AutoUpdateId(UUID.fromString(uuid)))
+      case TrxCorrelationIdRe(name, version, hash) =>
+        RefType.applyRef[ValidLockboxHash](hash).map { hash =>
+          OfflineUpdateId(name, version.toLong, hash)
+        }
       case x =>
-        Left(s"Invalid correlationId: '$x'.")
+        Left(s"Invalid correlationId: '$x'")
     }
 
     implicit val DecoderInstance: Decoder[CorrelationId] = Decoder.decodeString.emap(CorrelationId.fromString)