Skip to content

refactor signature handling validations #6680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2023
Merged

refactor signature handling validations #6680

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 57 additions & 48 deletions Sources/Workspace/Workspace.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1130,58 +1130,14 @@ extension Workspace {
observabilityScope: observabilityScope
)

try expectedSigningEntities.forEach { identity, expectedSigningEntity in
if let package = packageGraph.packages.first(where: { $0.identity == identity }) {
if let actualSigningEntity = package.registryMetadata?.signature?.signedBy {
if actualSigningEntity != expectedSigningEntity {
throw SigningError.mismatchedSigningEntity(
package: identity,
expected: expectedSigningEntity,
actual: actualSigningEntity
)
}
} else {
throw SigningError.unsigned(package: identity, expected: expectedSigningEntity)
}
} else {
if let mirror = self.mirrors.mirror(for: identity.description) {
let mirroredIdentity = PackageIdentity.plain(mirror)
if mirroredIdentity.isRegistry {
if let package = packageGraph.packages.first(where: { $0.identity == mirroredIdentity }) {
if let actualSigningEntity = package.registryMetadata?.signature?.signedBy {
if actualSigningEntity != expectedSigningEntity {
throw SigningError.mismatchedSigningEntity(
package: identity,
expected: expectedSigningEntity,
actual: actualSigningEntity
)
}
} else {
throw SigningError.unsigned(package: identity, expected: expectedSigningEntity)
}
} else {
// Unsure if this case is reachable in practice.
throw SigningError.expectedIdentityNotFound(package: identity)
}
} else {
throw SigningError.expectedSignedMirroredToSourceControl(package: identity, expected: expectedSigningEntity)
}
} else {
throw SigningError.expectedIdentityNotFound(package: identity)
}
}
}
try self.validateSignatures(
packageGraph: packageGraph,
expectedSigningEntities: expectedSigningEntities
)

return packageGraph
}

public enum SigningError: Swift.Error {
case expectedIdentityNotFound(package: PackageIdentity)
case expectedSignedMirroredToSourceControl(package: PackageIdentity, expected: RegistryReleaseMetadata.SigningEntity)
case mismatchedSigningEntity(package: PackageIdentity, expected: RegistryReleaseMetadata.SigningEntity, actual: RegistryReleaseMetadata.SigningEntity)
case unsigned(package: PackageIdentity, expected: RegistryReleaseMetadata.SigningEntity)
}

@discardableResult
public func loadPackageGraph(
rootPath: AbsolutePath,
Expand Down Expand Up @@ -3552,6 +3508,59 @@ extension Workspace {
}
}

// MARK: - Signatures

extension Workspace {
private func validateSignatures(
packageGraph: PackageGraph,
expectedSigningEntities: [PackageIdentity: RegistryReleaseMetadata.SigningEntity]
) throws {
try expectedSigningEntities.forEach { identity, expectedSigningEntity in
if let package = packageGraph.packages.first(where: { $0.identity == identity }) {
guard let actualSigningEntity = package.registryMetadata?.signature?.signedBy else {
throw SigningError.unsigned(package: identity, expected: expectedSigningEntity)
}
if actualSigningEntity != expectedSigningEntity {
throw SigningError.mismatchedSigningEntity(
package: identity,
expected: expectedSigningEntity,
actual: actualSigningEntity
)
}
} else {
guard let mirror = self.mirrors.mirror(for: identity.description) else {
throw SigningError.expectedIdentityNotFound(package: identity)
}
let mirroredIdentity = PackageIdentity.plain(mirror)
guard mirroredIdentity.isRegistry else {
throw SigningError.expectedSignedMirroredToSourceControl(package: identity, expected: expectedSigningEntity)
}
guard let package = packageGraph.packages.first(where: { $0.identity == mirroredIdentity }) else {
// Unsure if this case is reachable in practice.
throw SigningError.expectedIdentityNotFound(package: identity)
}
guard let actualSigningEntity = package.registryMetadata?.signature?.signedBy else {
throw SigningError.unsigned(package: identity, expected: expectedSigningEntity)
}
if actualSigningEntity != expectedSigningEntity {
throw SigningError.mismatchedSigningEntity(
package: identity,
expected: expectedSigningEntity,
actual: actualSigningEntity
)
}
}
}
}

public enum SigningError: Swift.Error {
case expectedIdentityNotFound(package: PackageIdentity)
case expectedSignedMirroredToSourceControl(package: PackageIdentity, expected: RegistryReleaseMetadata.SigningEntity)
case mismatchedSigningEntity(package: PackageIdentity, expected: RegistryReleaseMetadata.SigningEntity, actual: RegistryReleaseMetadata.SigningEntity)
case unsigned(package: PackageIdentity, expected: RegistryReleaseMetadata.SigningEntity)
}
}

// MARK: - Utility extensions

fileprivate extension Workspace.ManagedArtifact {
Expand Down