Skip to content

fix: prevent crash when OWASP secure-headers source is unreachable #14

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
sromicevelyn merged 1 commit into from
Jul 8, 2026
Merged

fix: prevent crash when OWASP secure-headers source is unreachable #14

Show file tree
Hide file tree
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
9 changes: 7 additions & 2 deletions src/owasp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,13 @@ class OWASP {
const headerJSON = await new Promise((resolve, reject) => {
const req = https
.get(
"https://owasp.org/www-project-secure-headers/ci/headers_add.json",
"https://raw.githubusercontent.com/OWASP/www-project-secure-headers/master/ci/headers_add.json",
(res) => {
let data = [];

if (res.statusCode !== 200) {
resolve(defaultOWASP);
return;
}

res.on("error", (err) => {
Expand All @@ -111,7 +112,11 @@ class OWASP {
});

res.on("end", () => {
resolve(JSON.parse(Buffer.concat(data).toString()));
try {
resolve(JSON.parse(Buffer.concat(data).toString()));
} catch (err) {
resolve(defaultOWASP);
}
});
}
)
Expand Down
32 changes: 25 additions & 7 deletions test/unit/owasp.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ const newOWASPJSON = require("../json/newOWASP.json");
describe(`owasp`, function () {
describe(`getLatest`, function () {
it(`populates the defaults from the included OWASP release when the online version can not be reached`, async function () {
nock("https://owasp.org")
.get("/www-project-secure-headers/ci/headers_add.json")
.reply(404, {});
// Real 404s from the host return an HTML body, not JSON — this reproduces
// the crash where JSON.parse() on the HTML threw an uncaught SyntaxError.
nock("https://raw.githubusercontent.com")
.get("/OWASP/www-project-secure-headers/master/ci/headers_add.json")
.reply(404, "<!DOCTYPE html><html><head><title>404</title></head></html>");

await owasp.getLatest().catch((err) => {
console.error(err);
Expand All @@ -32,9 +34,25 @@ describe(`owasp`, function () {
expect(Object.keys(owasp.DEFAULT_OWASP_HEADERS).length).to.be.equal(13);
});

it(`falls back to the included defaults when the online version returns a non-JSON body`, async function () {
nock("https://raw.githubusercontent.com")
.get("/OWASP/www-project-secure-headers/master/ci/headers_add.json")
.reply(200, "<!DOCTYPE html><html><body>not json</body></html>");

await owasp.getLatest().catch((err) => {
console.error(err);
expect(err).to.be.undefined;
});

expect(
owasp.DEFAULT_OWASP_HEADERS["Permissions-Policy"]
).to.have.property("schema");
expect(Object.keys(owasp.DEFAULT_OWASP_HEADERS).length).to.be.equal(13);
});

it(`populates the defaults with information from a new OWASP release`, async function () {
nock("https://owasp.org")
.get("/www-project-secure-headers/ci/headers_add.json")
nock("https://raw.githubusercontent.com")
.get("/OWASP/www-project-secure-headers/master/ci/headers_add.json")
.reply(200, newOWASPJSON);

await owasp.getLatest().catch((err) => {
Expand Down Expand Up @@ -63,8 +81,8 @@ describe(`owasp`, function () {
const newOWASPJSONAdded = structuredClone(newOWASPJSON);
newOWASPJSONAdded.headers.push({ name: "x-added", value: "true" });

nock("https://owasp.org")
.get("/www-project-secure-headers/ci/headers_add.json")
nock("https://raw.githubusercontent.com")
.get("/OWASP/www-project-secure-headers/master/ci/headers_add.json")
.reply(200, newOWASPJSONAdded);

await owasp.getLatest().catch((err) => {
Expand Down
Loading