-
Notifications
You must be signed in to change notification settings - Fork 674
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🔄 created local '.github/scripts/security-checker.mjs' from remote 's…
…cripts/security-checker.mjs'
- Loading branch information
testcafe-build-bot
committed
Dec 6, 2023
1 parent
ed926f8
commit c8263d8
Showing
1 changed file
with
177 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,177 @@ | ||
const STATES = { | ||
open: 'open', | ||
closed: 'closed', | ||
}; | ||
|
||
const LABELS = { | ||
dependabot: 'dependabot', | ||
codeq: 'codeql', | ||
security: 'security notification', | ||
}; | ||
|
||
class SecurityChecker { | ||
constructor (github, context, issueRepo) { | ||
this.github = github; | ||
this.issueRepo = issueRepo; | ||
this.context = { | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
}; | ||
} | ||
|
||
async check () { | ||
const dependabotAlerts = await this.getDependabotAlerts(); | ||
const codeqlAlerts = await this.getCodeqlAlerts(); | ||
const existedIssues = await this.getExistedIssues(); | ||
|
||
this.alertDictionary = this.createAlertDictionary(existedIssues); | ||
|
||
await this.closeSpoiledIssues(); | ||
this.createDependabotlIssues(dependabotAlerts); | ||
this.createCodeqlIssues(codeqlAlerts); | ||
} | ||
|
||
async getDependabotAlerts () { | ||
const { data } = await this.github.rest.dependabot.listAlertsForRepo({ state: STATES.open, ...this.context }); | ||
|
||
return data; | ||
} | ||
|
||
async getCodeqlAlerts () { | ||
try { | ||
const { data } = await this.github.rest.codeScanning.listAlertsForRepo({ state: STATES.open, ...this.context }); | ||
|
||
return data; | ||
} | ||
catch (e) { | ||
if (e.message.includes('no analysis found')) | ||
return []; | ||
|
||
throw e; | ||
} | ||
} | ||
|
||
async getExistedIssues () { | ||
const { data: existedIssues } = await this.github.rest.issues.listForRepo({ | ||
owner: this.context.owner, | ||
repo: this.issueRepo, | ||
labels: [LABELS.security], | ||
state: STATES.open, | ||
}); | ||
|
||
return existedIssues; | ||
} | ||
|
||
createAlertDictionary (existedIssues) { | ||
return existedIssues.reduce((res, issue) => { | ||
const [, url, number] = issue.body.match(/Link:\s*(https.*?(\d+)$)/); | ||
|
||
if (!url) | ||
return res; | ||
|
||
res[url] = { | ||
issue, number, | ||
isDependabot: url.includes('dependabot'), | ||
}; | ||
|
||
return res; | ||
}, {}); | ||
} | ||
|
||
async closeSpoiledIssues () { | ||
for (const key in this.alertDictionary) { | ||
const alert = this.alertDictionary[key]; | ||
|
||
if (alert.isDependabot) { | ||
const isAlertOpened = await this.isDependabotAlertOpened(alert.number); | ||
|
||
if (isAlertOpened) | ||
continue; | ||
|
||
await this.closeIssue(alert.issue.number); | ||
} | ||
} | ||
} | ||
|
||
async isDependabotAlertOpened (alertNumber) { | ||
const alert = await this.getDependabotAlertInfo(alertNumber); | ||
|
||
return alert.state === STATES.open; | ||
} | ||
|
||
async getDependabotAlertInfo (alertNumber) { | ||
try { | ||
const { data } = await this.github.rest.dependabot.getAlert({ alert_number: alertNumber, ...this.context }); | ||
|
||
return data; | ||
} | ||
catch (e) { | ||
if (e.message.includes('No alert found for alert number')) | ||
return {}; | ||
|
||
throw e; | ||
} | ||
} | ||
|
||
async closeIssue (issueNumber) { | ||
return this.github.rest.issues.update({ | ||
owner: this.context.owner, | ||
repo: this.issueRepo, | ||
issue_number: issueNumber, | ||
state: STATES.closed, | ||
}); | ||
} | ||
|
||
async createDependabotlIssues (dependabotAlerts) { | ||
dependabotAlerts.forEach(alert => { | ||
if (!this.needCreateIssue(alert)) | ||
return; | ||
|
||
this.createIssue({ | ||
labels: [LABELS.dependabot, LABELS.security, alert.dependency.scope], | ||
originRepo: this.context.repo, | ||
summary: alert.security_advisory.summary, | ||
description: alert.security_advisory.description, | ||
link: alert.html_url, | ||
issuePackage: alert.dependency.package.name, | ||
}); | ||
}); | ||
} | ||
|
||
async createCodeqlIssues (codeqlAlerts) { | ||
codeqlAlerts.forEach(alert => { | ||
if (!this.needCreateIssue(alert)) | ||
return; | ||
|
||
this.createIssue({ | ||
labels: [LABELS.codeql, LABELS.security], | ||
originRepo: this.context.repo, | ||
summary: alert.rule.description, | ||
description: alert.most_recent_instance.message.text, | ||
link: alert.html_url, | ||
}); | ||
}); | ||
} | ||
|
||
needCreateIssue (alert) { | ||
return !this.alertDictionary[alert.html_url]; | ||
} | ||
|
||
async createIssue ({ labels, originRepo, summary, description, link, issuePackage = '' }) { | ||
const title = `[${originRepo}] ${summary}`; | ||
const body = '' | ||
+ `#### Repository: \`${originRepo}\`\n` | ||
+ (issuePackage ? `#### Package: \`${issuePackage}\`\n` : '') | ||
+ `#### Description:\n` | ||
+ `${description}\n` | ||
+ `#### Link: ${link}`; | ||
|
||
return this.github.rest.issues.create({ | ||
title, body, labels, | ||
owner: this.context.owner, | ||
repo: this.issueRepo, | ||
}); | ||
} | ||
} | ||
|
||
export default SecurityChecker; |