-
-
Notifications
You must be signed in to change notification settings - Fork 375
refactor: migrate from jsonwebtoken to jose v5 #1498
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
Open
yoshi-taka
wants to merge
1
commit into
danger:main
Choose a base branch
from
yoshi-taka:jwtjose
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,53 @@ | ||
| import * as jwt from "jsonwebtoken" | ||
| import { SignJWT, importPKCS8 } from "jose" | ||
| import fetch from "node-fetch" | ||
|
|
||
| const ALG = "RS256" as const | ||
| // Step 1 | ||
|
|
||
| /** App ID + Signing Key = initial JWT to start auth process */ | ||
| const jwtForGitHubAuth = (appID: string, key: string) => { | ||
| const now = Math.round(new Date().getTime() / 1000) | ||
| const expires: number = now + 300 | ||
| const keyContent = key | ||
| const payload: object = { | ||
| exp: expires, | ||
| iat: now, | ||
| iss: appID, | ||
| } | ||
| export const jwtForGitHubAuth = async (appID: string, privateKeyPEM: string) => { | ||
| const key = await importPKCS8(privateKeyPEM, ALG) | ||
| const now = Math.floor(Date.now() / 1000) | ||
|
|
||
| const token = await new SignJWT({}) | ||
| .setProtectedHeader({ alg: ALG }) | ||
| .setIssuedAt(now) | ||
| .setExpirationTime(now + 300) | ||
| .setIssuer(appID) | ||
| .sign(key) | ||
|
|
||
| return jwt.sign(payload, keyContent, { algorithm: "RS256" }) | ||
| return token | ||
| } | ||
|
|
||
| // Step 2 - Use App signed JWT to grab a per-installation | ||
|
|
||
| const requestAccessTokenForInstallation = (appID: string, installationID: number, key: string) => { | ||
| const apiUrl = process.env["DANGER_GITHUB_API_BASE_URL"] | ||
| ? process.env["DANGER_GITHUB_API_BASE_URL"] | ||
| : "https://api.github.com" | ||
| const requestAccessTokenForInstallation = async (appID: string, installationID: number, privateKeyPEM: string) => { | ||
| const apiUrl = process.env["DANGER_GITHUB_API_BASE_URL"] ?? "https://api.github.com" | ||
| const url = `${apiUrl}/app/installations/${installationID}/access_tokens` | ||
| const headers = { | ||
| Accept: "application/vnd.github.machine-man-preview+json", | ||
| Authorization: `Bearer ${jwtForGitHubAuth(appID, key)}`, | ||
| } | ||
| return fetch(url, { | ||
| body: JSON.stringify({}), | ||
| headers, | ||
|
|
||
| const jwt = await jwtForGitHubAuth(appID, privateKeyPEM) | ||
|
|
||
| const res = await fetch(url, { | ||
| method: "POST", | ||
| headers: { | ||
| Accept: "application/vnd.github+json", | ||
| Authorization: `Bearer ${jwt}`, | ||
| "X-GitHub-Api-Version": "2022-11-28", | ||
| }, | ||
| body: JSON.stringify({}), | ||
| }) | ||
|
|
||
| return res | ||
| } | ||
|
|
||
| /** Generates a temporary access token for an app's installation, 5m long */ | ||
| export const getAccessTokenForInstallation = async (appID: string, installationID: number, key: string) => { | ||
| const newToken = await requestAccessTokenForInstallation(appID, installationID, key) | ||
| const credentials = await newToken.json() | ||
| if (!newToken.ok) { | ||
| console.error(`Could not get an access token for ${installationID}`) | ||
| console.error(`GitHub returned: ${JSON.stringify(credentials)}`) | ||
| export const getAccessTokenForInstallation = async (appID: string, installationID: number, privateKeyPEM: string) => { | ||
| const res = await requestAccessTokenForInstallation(appID, installationID, privateKeyPEM) | ||
| const json = await res.json() | ||
| if (!res.ok) { | ||
| console.error(`Could not get an access token for installation ${installationID}`) | ||
| console.error(`GitHub returned: ${JSON.stringify(json)}`) | ||
| throw new Error(`GitHub API error: ${res.status} ${res.statusText}`) | ||
| } | ||
| return credentials.token as string | ||
| return json.token as string | ||
| } |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems like a relatively high-sensitivity dependency. It's good that we're working on using something more maintained.
Would you mind explaining why you're pulling in version 5.0.0 instead of the latest version? (It looks like 6.1.1 is the latest)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your response.
This article explains the topic very clearly.
https://dev.to/silentwatcher_95/why-you-should-delete-jsonwebtoken-in-2025-1o7n
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since v6 is ESM-only, it won’t run here.
Supported Versions
https://github.com/panva/jose