update msquic

.github/workflows/ci.yml

@@ -31,6 +31,18 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: recursive
+    - name: MsQuic Install Dependencies
+      run: |
+        export DEBIAN_FRONTEND=noninteractive
+        sudo apt-add-repository -y ppa:lttng/stable-2.13
+        sudo apt-get update
+        sudo apt-get install -y lttng-tools lttng-modules-dkms babeltrace2 liblttng-ust-dev python3-babeltrace
+        sudo apt-get install -y cmake
+        sudo apt-get install -y build-essential
+    - name: Get msquic submodule commit hash
+      id: msquic-commit-hash
+      run: |
+        echo "commit-hash=$(git submodule status Networking/Sources/msquic/ | cut -c2-41)" >> $GITHUB_OUTPUT
     - name: Get blst submodule commit hash
       id: blst-commit-hash
       run: |
@@ -56,6 +68,13 @@ jobs:
           ~/.cargo/git/db/
           Utils/Sources/bandersnatch/target/
         key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+    - name: Cache msquic static lib
+      uses: actions/cache@v4
+      with:
+        path: .lib/libmsquic.a
+        key: ${{ runner.os }}-libs-msquic-${{ steps.msquic-commit-hash.outputs.commit-hash }}
+        restore-keys: |
+            ${{ runner.os }}-libs-msquic
     - name: Cache blst static lib
       uses: actions/cache@v4
       with:

.gitignore

@@ -17,3 +17,5 @@ tasks.json
 
 *.d
 *.swiftdeps
+Package.resolved
+contents.xcworkspacedata

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "Database/Sources/rocksdb"]
 	path = Database/Sources/rocksdb
 	url = https://github.com/facebook/rocksdb.git
+[submodule "Networking/Sources/msquic"]
+	path = Networking/Sources/msquic
+	url = https://github.com/microsoft/msquic.git

Makefile

@@ -8,7 +8,7 @@ default: build
 githooks: .git/hooks/pre-commit
 
 .PHONY: deps
-deps: .lib/libblst.a .lib/libbandersnatch_vrfs.a .lib/librocksdb.a .lib/libec.a
+deps: .lib/libblst.a .lib/libbandersnatch_vrfs.a .lib/librocksdb.a .lib/libec.a .lib/libmsquic.a
 
 .lib/libblst.a:
 	./scripts/blst.sh
@@ -22,6 +22,9 @@ deps: .lib/libblst.a .lib/libbandersnatch_vrfs.a .lib/librocksdb.a .lib/libec.a
 .lib/librocksdb.a:
 	./scripts/rocksdb.sh
 
+.lib/libmsquic.a:
+	./scripts/msquic.sh
+
 .PHONY: test
 test: githooks deps
 	./scripts/runTests.sh test

Networking/Package.swift

@@ -0,0 +1,62 @@
+// swift-tools-version: 6.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "Networking",
+    platforms: [
+        .macOS(.v14),
+    ],
+    products: [
+        // Products define the executables and libraries a package produces, making them visible to other packages.
+        .library(
+            name: "Networking",
+            targets: ["Networking"]
+        ),
+    ],
+    dependencies: [
+        .package(path: "../Utils"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.6.0"),
+        .package(url: "https://github.com/apple/swift-testing.git", branch: "0.10.0"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.65.0"),
+        .package(url: "https://github.com/apple/swift-atomics.git", from: "1.2.0"),
+
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .target(
+            name: "Networking",
+
+            dependencies: [
+                "msquic",
+                "Utils",
+                .product(name: "NIO", package: "swift-nio"),
+                .product(name: "NIOCore", package: "swift-nio"),
+                .product(name: "NIOPosix", package: "swift-nio"),
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "Atomics", package: "swift-atomics"),
+
+            ],
+            resources: [
+                .process("assets"),
+            ],
+            linkerSettings: [
+                .unsafeFlags(["-L../.lib"]),
+            ]
+        ),
+        .systemLibrary(
+            name: "msquic",
+            path: "Sources"
+        ),
+        .testTarget(
+            name: "NetworkingTests",
+            dependencies: [
+                "Networking",
+                .product(name: "Testing", package: "swift-testing"),
+            ]
+        ),
+    ],
+    swiftLanguageVersions: [.version("6")]
+)

Networking/Sources/Networking/Networking.swift

@@ -0,0 +1,15 @@
+import msquic
+
+public class Networking {
+    public class Config {
+        public let listenAddress: String
+        public let port: Int
+
+        public init(listenAddress: String, port: Int) {
+            self.listenAddress = listenAddress
+            self.port = port
+        }
+    }
+
+    init() {}
+}

Networking/Sources/Networking/assets/server.cert

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDazCCAlOgAwIBAgIUYaN9BKGKso1vf23K1JQINstBQ5IwDQYJKoZIhvcNAQEL
+BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
+GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNDA5MDMwMTQ3MjFaFw0yNDEw
+MDMwMTQ3MjFaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw
+HwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB
+AQUAA4IBDwAwggEKAoIBAQC8OtKwzLpWXCHOaFu6pPgNiKoXtIo45h4aF83HLULc
+GJsCx2AuSdhNQjbG+G9kTsUp+kTEaXpyDdMm/KGNDzg9Iunj1swzXpp3Q9MmELTu
+gkkkHKuFnhKNspqdZGWMMqtvqktVu0dLaxebSkwqH+i3eR9L1PHJcb4Tj6rdw14o
+Aw4ZnqcMiv+iGq/usg/FmIWgkBUWko3pHEBdudKj1fKzlzkUlvDZQ3hN74GNGMdy
+BxUHUQr17mr4/nb0CH2JcSHfV0z1eW6I+fKTY0E/zlY1yCUXzpgwlGvgc0h2kDhr
+9i9IYDDUZtmtLSsC75LkkmvKben111r4AD08r1/6HiyjAgMBAAGjUzBRMB0GA1Ud
+DgQWBBT/Zhl2dPN0OtpQ/KbT8tr3zxenuzAfBgNVHSMEGDAWgBT/Zhl2dPN0OtpQ
+/KbT8tr3zxenuzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQAM
+8Q0Ods8Y2rNwXd9Dcu2jx09PCQG+Urn0upaNiAG9eowsZiJZYZLE31kBZXLQBqnu
+frGgcYWXFlMXpKU3qYXeVeq8Vug1gnp3k3T8fsPCZxrMyOgXz7/EV1rjh3k+xIsC
+zg5pJDk9pHmWfElpbfE0GuJZR8hdK4h9xabNq/h/g9jagwfFw2kvtP65bGXzEULF
+B/4QQmFb8hZqYcOn9Q6QkW7FKHj2NWbippBqFGwcr6/61CTmuZXHvKijg8q8syCI
+rF5PC773w9DWgZ0lY2YgvSdG5YUiVpfWzoOq8mfmnQ4QEVulBSm1NIf/7nDvXlm/
+qe+ux+F3fBiIOBvnH8N3
+-----END CERTIFICATE-----

Networking/Sources/Networking/assets/server.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC8OtKwzLpWXCHO
+aFu6pPgNiKoXtIo45h4aF83HLULcGJsCx2AuSdhNQjbG+G9kTsUp+kTEaXpyDdMm
+/KGNDzg9Iunj1swzXpp3Q9MmELTugkkkHKuFnhKNspqdZGWMMqtvqktVu0dLaxeb
+SkwqH+i3eR9L1PHJcb4Tj6rdw14oAw4ZnqcMiv+iGq/usg/FmIWgkBUWko3pHEBd
+udKj1fKzlzkUlvDZQ3hN74GNGMdyBxUHUQr17mr4/nb0CH2JcSHfV0z1eW6I+fKT
+Y0E/zlY1yCUXzpgwlGvgc0h2kDhr9i9IYDDUZtmtLSsC75LkkmvKben111r4AD08
+r1/6HiyjAgMBAAECggEAMjLl2azfzQRJJ8kBHae9V66o3iWR71a/lGngwUu61wPg
+4z7U0cNz4jbUcP/0hSXUwzsxd8hBlYVGWNFrLDlw4C0df1vbnZ+PRltaRn6SIkGw
+y+axf7MGc6+8OFl8E4W33tHlwXlurBhldU69PUbBQ50T0Z961CR3crQP95CQ3c5t
+fuoWSHeGoDoGeCSMyfHI1WimYm5L3ruGO41ZpNyE5goNiocRUiAdMNOyJzjHegoG
+Ry4Z1fqRdKNoQRHurEjR8rHj336IU8l9AmDWV1bNgGP4nLSdC8jQ6qJ7Z8Ln0QFN
+Qc/sVlmyz7AKraNzSPql9T7NzfVc6jb6KyEVipgqEQKBgQDodmkQ/sn56R1vM0CX
+YZ8zHgIGciwSF+oWITWmmdWCOHe8ECbBnvH+KKRBweUKQI8ZR3BglemDxtOu5ohD
+qKQi7d3D3/SHJHGDNpH0welnp8XoDz3IuXTN3+2sXWf9YVCiW0wnHEghBCfX8Lph
+K7EpR8dttJJ2r4vFV7ofZ5g0JwKBgQDPSd5rRsNKkStSc9z3KuafESLfo4pzxoq0
+3nWf7EQVKdj74YpJoix1pmElj+0/XRg+/actBmcp0nN53DJHUiWE0uTrOlXywQvH
+Cpd2QywiGDm03XxO6uUx21PPNnJSPmSLF/KGAnAzPDXjdz2li1QqlCgvBl8CWEZ4
+oApOBeMlJQKBgFmTt2zrIZ2BrOv6zfsHjTc/avxc5oqaWIPqjCgEw3eIlusLNkQK
+IaoUsyb7tmy67+mH09AENJWo+k09XGjmBUnIa1pdZHbnHi63yoqMZoqg5exEY0SD
+4nSqw4VWAQpsg4vsrm2rwkemuEvH4aosEfqcREcL/BxsDOogogIUA1ylAoGAJyaS
+hbx1wi2s+wO7JkvKBx0bcxXWXouPQx4JJU1ghobC3r/4eHPS5d2o14lZi/AvViZe
+Xtiov3NqMAfwzxuqzm1uoyb/eLwRV2Seus1xFndw3sI+akFfTI1aRPbJnNL/9m1t
+dvYa7vJeUzoAQLYSDYCyHj+bzjuSA9JmX9oozqkCgYBHUEaRb/8DNjoNXVSeubD0
+wNYBv1w47HdnTmBD0aX/1H2W1b5/DnmaTDjHy0T04DzgoYgSmtLFbPj9BB+/zfzU
+sBSngmt7mOBh8e361jiX+nEpx95ffNPG3p2cbq0ZkFtQrFFI46a6B9J53sI9S9w6
+9vu7dtndG49uP6SdCXu44w==
+-----END PRIVATE KEY-----

Networking/Sources/Networking/msquic/Alpn.swift

@@ -0,0 +1,12 @@
+import Foundation
+
+struct Alpn {
+    public let alpnString: String
+    private static let headerPrefixLength = 4
+    init(_ protocolName: String = "jamnp-s", version: String = "0", genesisHeader: String) throws {
+        guard genesisHeader.count >= Alpn.headerPrefixLength else {
+            throw QuicError.invalidAlpn
+        }
+        alpnString = "\(protocolName)/\(version)/\(genesisHeader.prefix(Alpn.headerPrefixLength))"
+    }
+}

Networking/Sources/Networking/msquic/QuicError.swift

@@ -0,0 +1,113 @@
+import Foundation
+
+public enum QuicError: Error, Equatable, Sendable, Codable {
+    case invalidStatus(status: QuicStatusCode)
+    case invalidAlpn
+    case getApiFailed
+    case getRegistrationFailed
+    case getConnectionFailed
+    case getStreamFailed
+    case getClientFailed
+    case messageNotFound
+    case sendFailed
+    case unknown // For handling unknown error types
+
+    enum CodingKeys: String, CodingKey {
+        case type
+        case status
+    }
+
+    enum ErrorType: String, Codable {
+        case invalidStatus
+        case invalidAlpn
+        case getApiFailed
+        case getRegistrationFailed
+        case getConnectionFailed
+        case getStreamFailed
+        case getClientFailed
+        case messageNotFound
+        case sendFailed
+        case unknown // For handling unknown error types
+    }
+
+    // Encode the QuicError to a Codable format
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        switch self {
+        case let .invalidStatus(status):
+            try container.encode(ErrorType.invalidStatus, forKey: .type)
+            try container.encode(status, forKey: .status)
+        default:
+            let type = ErrorType(from: self)
+            try container.encode(type, forKey: .type)
+        }
+    }
+
+    // Decode the QuicError from a Codable format
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let type = try container.decode(ErrorType.self, forKey: .type)
+
+        switch type {
+        case .invalidStatus:
+            let status = try container.decode(QuicStatusCode.self, forKey: .status)
+            self = .invalidStatus(status: status)
+        default:
+            self = type.toQuicError()
+        }
+    }
+}
+
+extension QuicError.ErrorType {
+    // Initialize ErrorType from QuicError
+    init(from error: QuicError) {
+        switch error {
+        case .invalidStatus:
+            self = .invalidStatus
+        case .invalidAlpn:
+            self = .invalidAlpn
+        case .getApiFailed:
+            self = .getApiFailed
+        case .getRegistrationFailed:
+            self = .getRegistrationFailed
+        case .getConnectionFailed:
+            self = .getConnectionFailed
+        case .getStreamFailed:
+            self = .getStreamFailed
+        case .getClientFailed:
+            self = .getClientFailed
+        case .messageNotFound:
+            self = .messageNotFound
+        case .sendFailed:
+            self = .sendFailed
+        case .unknown:
+            self = .unknown
+        }
+    }
+
+    // Convert ErrorType back to QuicError
+    func toQuicError() -> QuicError {
+        switch self {
+        case .invalidStatus:
+            .invalidStatus(status: .unknown) // Provide a default status
+        case .invalidAlpn:
+            .invalidAlpn
+        case .getApiFailed:
+            .getApiFailed
+        case .getRegistrationFailed:
+            .getRegistrationFailed
+        case .getConnectionFailed:
+            .getConnectionFailed
+        case .getStreamFailed:
+            .getStreamFailed
+        case .getClientFailed:
+            .getClientFailed
+        case .messageNotFound:
+            .messageNotFound
+        case .sendFailed:
+            .sendFailed
+        case .unknown:
+            .unknown
+        }
+    }
+}

Networking/Sources/Networking/msquic/QuicMessage.swift

@@ -0,0 +1,14 @@
+import Foundation
+
+enum QuicMessageType: String, Codable {
+    case unknown
+    case received
+    case close
+    case connected
+    case shutdownComplete
+}
+
+public struct QuicMessage: Sendable, Equatable, Codable {
+    let type: QuicMessageType
+    let data: Data?
+}