feat!: Bump CRT version to 0.37.0 & add CRC64NVME checksum algorithm wrapper (#845)

* Bump CRT version to 0.37.0 and add wrapper for new checksum algorithm.

* Add doc comment re: checksum algorithms may expand in future.

---------

Co-authored-by: Sichan Yoo <[email protected]>

Author: sichanyoo

Package.swift

@@ -55,7 +55,7 @@ let package = Package(
     ],
     dependencies: {
         var dependencies: [Package.Dependency] = [
-            .package(url: "https://github.com/awslabs/aws-crt-swift.git", exact: "0.36.0"),
+            .package(url: "https://github.com/awslabs/aws-crt-swift.git", exact: "0.37.0"),
             .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
         ]
         let isDocCEnabled = ProcessInfo.processInfo.environment["AWS_SWIFT_SDK_ENABLE_DOCC"] != nil

Sources/SmithyChecksums/CRC64NVME.swift

@@ -0,0 +1,40 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import protocol SmithyChecksumsAPI.Checksum
+import enum SmithyChecksumsAPI.HashResult
+import struct Foundation.Data
+import AwsCommonRuntimeKit
+
+class CRC64NVME {
+    let checksumName = "crc64nvme"
+    let digestLength: Int = 8 // bytes
+
+    private var previousHash: UInt64
+
+    public init(previousHash: UInt64 = 0) {
+        self.previousHash = previousHash
+    }
+}
+
+extension CRC64NVME: Checksum {
+    func copy() -> any Checksum {
+        return CRC64NVME(previousHash: previousHash)
+    }
+
+    func update(chunk: Data) {
+        self.previousHash = chunk.computeCRC64Nvme(previousCrc64Nvme: previousHash)
+    }
+
+    func reset() {
+        self.previousHash = UInt64()
+    }
+
+    func digest() -> HashResult {
+        return .integer64(previousHash)
+    }
+}

Sources/SmithyChecksums/ChecksumAlgorithm.swift

@@ -24,6 +24,7 @@ extension ChecksumAlgorithm {
         switch string.lowercased() {
         case "crc32": return .crc32
         case "crc32c": return .crc32c
+        case "crc64nvme": return .crc64nvme
         case "sha1": return .sha1
         case "sha256": return .sha256
         case "md5": return .md5 // md5 is not a valid flexible checksum algorithm
@@ -44,7 +45,7 @@ extension ChecksumAlgorithm {
 
     public var isFlexibleChecksum: Bool {
         switch self {
-        case .crc32, .crc32c, .sha256, .sha1:
+        case .crc32, .crc32c, .crc64nvme, .sha256, .sha1:
             return true
         default:
             return false
@@ -57,6 +58,8 @@ extension ChecksumAlgorithm {
             return CRC32()
         case .crc32c:
             return CRC32C()
+        case .crc64nvme:
+            return CRC64NVME()
         case .sha1:
             return SHA1()
         case .sha256:
@@ -69,12 +72,12 @@ extension ChecksumAlgorithm {
 
 extension ChecksumAlgorithm: Comparable {
     /*
-     * Priority-order for validating checksum = [ CRC32C, CRC32, SHA1, SHA256 ]
+     * Priority-order for validating checksum = [ CRC32C, CRC32, CRC64NVME, SHA1, SHA256 ]
      * Order is determined by speed of the algorithm's implementation
      * MD5 is not supported by list ordering
      */
     public static func < (lhs: ChecksumAlgorithm, rhs: ChecksumAlgorithm) -> Bool {
-        let order: [ChecksumAlgorithm] = [.crc32c, .crc32, .sha1, .sha256]
+        let order: [ChecksumAlgorithm] = [.crc32c, .crc32, .crc64nvme, .sha1, .sha256]
 
         let lhsIndex = order.firstIndex(of: lhs) ?? Int.max
         let rhsIndex = order.firstIndex(of: rhs) ?? Int.max
@@ -102,6 +105,18 @@ extension UInt32 {
     }
 }
 
+extension UInt64 {
+    public func toBase64EncodedString() -> String {
+        // Create a Data instance from the UInt64 value
+        let value = self
+        var bigEndianValue = value.bigEndian
+        let data = Data(bytes: &bigEndianValue, count: MemoryLayout<UInt64>.size)
+
+        // Base64 encode the data
+        return data.base64EncodedString()
+    }
+}
+
 extension HashResult {
 
     // Convert a HashResult to a hexadecimal String
@@ -111,6 +126,8 @@ extension HashResult {
             return data.map { String(format: "%02x", $0) }.joined()
         case .integer(let integer):
             return String(format: "%08x", integer)
+        case .integer64(let integer64):
+            return String(format: "%016x", integer64)
         }
     }
 
@@ -121,6 +138,8 @@ extension HashResult {
             return data.base64EncodedString()
         case .integer(let integer):
             return integer.toBase64EncodedString()
+        case .integer64(let integer64):
+            return integer64.toBase64EncodedString()
         }
     }
 }

Sources/SmithyChecksumsAPI/Checksum.swift

@@ -45,4 +45,5 @@ public protocol Checksum {
 public enum HashResult {
     case data(Data)
     case integer(UInt32)
+    case integer64(UInt64)
 }

Sources/SmithyChecksumsAPI/ChecksumAlgorithm.swift

@@ -5,13 +5,15 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+/// The list of checksum algorithms contained by this enum may expand in future.
 public enum ChecksumAlgorithm {
-    case crc32, crc32c, sha1, sha256, md5
+    case crc32, crc32c, crc64nvme, sha1, sha256, md5
 
     public func toString() -> String {
         switch self {
         case .crc32: return "crc32"
         case .crc32c: return "crc32c"
+        case .crc64nvme: return "crc64nvme"
         case .sha1: return "sha1"
         case .sha256: return "sha256"
         case .md5: return "md5"