Move collectionSigningPrivateKey to EnvironmentClient

Author: finestructure

Sources/App/Core/AppEnvironment.swift

@@ -23,7 +23,6 @@ import FoundationNetworking
 
 
 struct AppEnvironment: Sendable {
-    var collectionSigningPrivateKey: @Sendable () -> Data?
     var currentReferenceCache: @Sendable () -> CurrentReferenceCache?
     var dbId: @Sendable () -> String?
     var fetchDocumentation: @Sendable (_ client: Client, _ url: URI) async throws -> ClientResponse
@@ -88,10 +87,6 @@ extension AppEnvironment {
     nonisolated(unsafe) static var logger: Logger!
 
     static let live = AppEnvironment(
-        collectionSigningPrivateKey: {
-            Environment.get("COLLECTION_SIGNING_PRIVATE_KEY")
-                .map { Data($0.utf8) }
-        },
         currentReferenceCache: { .live },
         dbId: { Environment.get("DATABASE_ID") },
         fetchDocumentation: { client, url in try await client.get(url) },

Sources/App/Core/Dependencies/EnvironmentClient.swift

@@ -37,6 +37,7 @@ struct EnvironmentClient {
     var buildTriggerDownscaling: @Sendable () -> Double = { XCTFail("buildTriggerDownscaling"); return 1 }
     var buildTriggerLatestSwiftVersionDownscaling: @Sendable () -> Double = { XCTFail("buildTriggerLatestSwiftVersionDownscaling"); return 1 }
     var collectionSigningCertificateChain: @Sendable () -> [URL] = { XCTFail("collectionSigningCertificateChain"); return [] }
+    var collectionSigningPrivateKey: @Sendable () -> Data?
     var current: @Sendable () -> Environment = { XCTFail("current"); return .development }
     var mastodonCredentials: @Sendable () -> Mastodon.Credentials?
     var mastodonPost: @Sendable (_ client: Client, _ post: String) async throws -> Void
@@ -86,6 +87,9 @@ extension EnvironmentClient: DependencyKey {
                     "AppleIncRootCertificate.cer",
                 ].map { SignedCollection.certsDir.appendingPathComponent($0) }
             },
+            collectionSigningPrivateKey: {
+                Environment.get("COLLECTION_SIGNING_PRIVATE_KEY").map { Data($0.utf8) }
+            },
             current: { (try? Environment.detect()) ?? .development },
             mastodonCredentials: {
                 Environment.get("MASTODON_ACCESS_TOKEN")

Sources/App/Core/PackageCollection+signing.swift

@@ -43,12 +43,12 @@ extension SignedCollection {
     }
 
     static func sign(collection: PackageCollection) async throws -> SignedCollection {
-        guard let privateKey = Current.collectionSigningPrivateKey() else {
+        @Dependency(\.environment) var environment
+
+        guard let privateKey = environment.collectionSigningPrivateKey() else {
             throw AppError.envVariableNotSet("COLLECTION_SIGNING_PRIVATE_KEY")
         }
 
-        @Dependency(\.environment) var environment
-
         return try await signer.sign(collection: collection,
                                      certChainPaths: environment.collectionSigningCertificateChain(),
                                      privateKeyPEM: privateKey)

Tests/AppTests/ApiTests.swift

@@ -827,11 +827,12 @@ class ApiTests: AppTestCase {
     }
 
     func test_package_collections_owner() async throws {
-        try XCTSkipIf(!isRunningInCI && Current.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+        try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
         try await withDependencies {
             $0.date.now = .t0
             $0.environment.apiSigningKey = { "secret" }
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
+            $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
         } operation: {
             // setup
             let p1 = Package(id: .id1, url: "1")
@@ -895,12 +896,13 @@ class ApiTests: AppTestCase {
     }
 
     func test_package_collections_packageURLs() async throws {
-        try XCTSkipIf(!isRunningInCI && Current.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+        try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
         let refDate = Date(timeIntervalSince1970: 0)
         try await withDependencies {
             $0.date.now = refDate
             $0.environment.apiSigningKey = { "secret" }
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
+            $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
         } operation: {
             // setup
             let p1 = Package(id: UUID(uuidString: "442cf59f-0135-4d08-be00-bc9a7cebabd3")!,

Tests/AppTests/Mocks/AppEnvironment+mock.swift

@@ -22,7 +22,6 @@ import Vapor
 extension AppEnvironment {
     static func mock(eventLoop: EventLoop) -> Self {
         .init(
-            collectionSigningPrivateKey: AppEnvironment.live.collectionSigningPrivateKey,
             currentReferenceCache: { nil },
             dbId: { "db-id" },
             fetchDocumentation: { _, _ in .init(status: .ok) },

Tests/AppTests/PackageCollectionControllerTests.swift

@@ -22,10 +22,11 @@ import XCTVapor
 class PackageCollectionControllerTests: AppTestCase {
 
     func test_owner_request() async throws {
-        try XCTSkipIf(!isRunningInCI && Current.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+        try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
         try await withDependencies {
             $0.date.now = .t0
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
+            $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
         } operation: {
             let p = try await savePackage(on: app.db, "https://github.com/foo/1")
             do {
@@ -76,10 +77,11 @@ class PackageCollectionControllerTests: AppTestCase {
     }
 
     func test_custom_request() async throws {
-        try XCTSkipIf(!isRunningInCI && Current.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+        try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
         try await withDependencies {
             $0.date.now = .t0
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
+            $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
         } operation: {
             let p = try await savePackage(on: app.db, "https://github.com/foo/1")
             do {

Tests/AppTests/PackageCollectionTests.swift

@@ -830,17 +830,18 @@ class PackageCollectionTests: AppTestCase {
     }
 
     func test_sign_collection() async throws {
-        try XCTSkipIf(!isRunningInCI && Current.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
-        
+        try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+
         try await withDependencies {
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
+            $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
         } operation: {
             // setup
             let collection: PackageCollection = .mock
-            
+
             // MUT
             let signedCollection = try await SignedCollection.sign(collection: collection)
-            
+
             // validate signed collection content
             XCTAssertFalse(signedCollection.signature.signature.isEmpty)
 #if compiler(<6)
@@ -850,7 +851,7 @@ class PackageCollectionTests: AppTestCase {
 #else
             assertSnapshot(of: signedCollection, as: .json(encoder))
 #endif
-            
+
             // validate signature
             let validated = try await SignedCollection.validate(signedCollection: signedCollection)
             XCTAssertTrue(validated)
@@ -878,11 +879,10 @@ class PackageCollectionTests: AppTestCase {
                     SignedCollection.certsDir.appendingPathComponent("AppleIncRootCertificate.cer")
                 ]
             }
+            $0.environment.collectionSigningPrivateKey = { revokedKey }
         } operation: {
-            Current.collectionSigningPrivateKey = { revokedKey }
-
-            // MUT
             do {
+                // MUT
                 let signedCollection = try await SignedCollection.sign(collection: collection)
                 // NB: signing _can_ succeed in case of reachability issues to verify the cert
                 // in this case we need to check the signature