-
-
Notifications
You must be signed in to change notification settings - Fork 257
feat: detect npm publish security downgrade #1053
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.
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
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
e01c4aa
feat: detect npm publish security downgrade
wojtekmaj 9e30e9f
Apply CR suggestions
wojtekmaj aa4bf07
Fix browser tests?
wojtekmaj 30b8653
Add unit tests
wojtekmaj 495d79d
Support for trusted publisher
wojtekmaj e3424a7
Cleanup
wojtekmaj 50e11ee
fix: handle cross-major downgrades, minimise payload, add tests
danielroe 870aa88
Merge remote-tracking branch 'origin/main' into downgrade-detection
danielroe 274b0c8
refactor: slightly reword + align styling
danielroe 504da16
Merge remote-tracking branch 'origin/main' into downgrade-detection
danielroe 9bc1b3b
fix: rank trusted publishing higher and update wording
danielroe 34df72f
fix: use statically analysable keys
danielroe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import type { PackageVersionInfo } from '#shared/types' | ||
| import { compare } from 'semver' | ||
|
|
||
| export interface PublishSecurityDowngrade { | ||
| downgradedVersion: string | ||
| downgradedPublishedAt?: string | ||
| trustedVersion: string | ||
| trustedPublishedAt?: string | ||
| } | ||
|
|
||
| type VersionWithIndex = PackageVersionInfo & { | ||
| index: number | ||
| timestamp: number | ||
| } | ||
|
|
||
| function toTimestamp(time?: string): number { | ||
| if (!time) return Number.NaN | ||
| return Date.parse(time) | ||
| } | ||
|
|
||
| function sortByRecency(a: VersionWithIndex, b: VersionWithIndex): number { | ||
| const aValid = Number.isFinite(a.timestamp) | ||
| const bValid = Number.isFinite(b.timestamp) | ||
|
|
||
| if (aValid && bValid && a.timestamp !== b.timestamp) { | ||
| return b.timestamp - a.timestamp | ||
| } | ||
|
|
||
| if (aValid !== bValid) { | ||
| return aValid ? -1 : 1 | ||
| } | ||
|
|
||
| const semverOrder = compare(b.version, a.version) | ||
| if (semverOrder !== 0) return semverOrder | ||
|
|
||
| return a.index - b.index | ||
| } | ||
|
|
||
| /** | ||
| * Detects a security downgrade where the newest publish is not trusted, | ||
| * but an older publish was trusted (e.g. OIDC/provenance -> manual publish). | ||
| */ | ||
| export function detectPublishSecurityDowngrade( | ||
| versions: PackageVersionInfo[], | ||
| ): PublishSecurityDowngrade | null { | ||
| if (versions.length < 2) return null | ||
|
|
||
| const sorted = versions | ||
| .map((version, index) => ({ | ||
| ...version, | ||
| index, | ||
| timestamp: toTimestamp(version.time), | ||
| })) | ||
| .sort(sortByRecency) | ||
|
|
||
| const latest = sorted.at(0) | ||
| if (!latest || latest.hasProvenance) return null | ||
|
|
||
| const latestTrusted = sorted.find(version => version.hasProvenance) | ||
| if (!latestTrusted) return null | ||
|
|
||
| return { | ||
| downgradedVersion: latest.version, | ||
| downgradedPublishedAt: latest.time, | ||
| trustedVersion: latestTrusted.version, | ||
| trustedPublishedAt: latestTrusted.time, | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Detects a security downgrade for a specific viewed version. | ||
| * A version is considered downgraded when it has no provenance and | ||
| * there exists an older trusted release. | ||
| */ | ||
| export function detectPublishSecurityDowngradeForVersion( | ||
| versions: PackageVersionInfo[], | ||
| viewedVersion: string, | ||
| ): PublishSecurityDowngrade | null { | ||
| if (versions.length < 2 || !viewedVersion) return null | ||
|
|
||
| const sorted = versions | ||
| .map((version, index) => ({ | ||
| ...version, | ||
| index, | ||
| timestamp: toTimestamp(version.time), | ||
| })) | ||
| .sort(sortByRecency) | ||
|
|
||
| const currentIndex = sorted.findIndex(version => version.version === viewedVersion) | ||
| if (currentIndex === -1) return null | ||
|
|
||
| const current = sorted.at(currentIndex) | ||
| if (!current || current.hasProvenance) return null | ||
|
|
||
| const trustedOlder = sorted.slice(currentIndex + 1).find(version => version.hasProvenance) | ||
| if (!trustedOlder) return null | ||
|
|
||
| return { | ||
| downgradedVersion: current.version, | ||
| downgradedPublishedAt: current.time, | ||
| trustedVersion: trustedOlder.version, | ||
| trustedPublishedAt: trustedOlder.time, | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.