Skip to content

feat: XML Validator prevent parsing XXE #1063

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
merged 8 commits into from
May 7, 2024
Merged

feat: XML Validator prevent parsing XXE #1063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
43cc752
test: reproduce reported security issues for #1061
jkowalleck May 7, 2024
56e2966
fix
jkowalleck May 7, 2024
709268a
tests
jkowalleck May 7, 2024
dc13752
tidy
jkowalleck May 7, 2024
cc9c214
docs
jkowalleck May 7, 2024
91f6d27
docs
jkowalleck May 7, 2024
60cca6c
clean
jkowalleck May 7, 2024
96ae065
test
jkowalleck May 7, 2024
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
7 changes: 7 additions & 0 deletions HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ All notable changes to this project will be documented in this file.

<!-- add unreleased items here -->

* Changed
* The provided XML validation capabilities no longer supports external entities (via [#1063]; concerns [#1061])
This is considered a security measure to prevent XML external entity (XXE) injection.

[#1061]: https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1061
[#1063]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/1063

## 6.6.1 -- 2024-05-06

* Fixed
Expand Down
3 changes: 2 additions & 1 deletion src/validation/xmlValidator.node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ async function getParser (): Promise<typeof parseXml> {

const xmlParseOptions: Readonly<ParserOptions> = Object.freeze({
nonet: true,
compact: true
compact: true,
noent: true // prevent https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1061
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noent: true means substitute entities.

Omitting this option is the secure default.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exactly.
therefore GHSA-38gf-rh2w-gmj7 exists,
and the #1064 introduced test for this

})

export class XmlValidator extends BaseValidator {
Expand Down
54 changes: 54 additions & 0 deletions tests/integration/Validation.XmlValidator.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,5 +99,59 @@ describe('Validation.XmlValidator', () => {
const validationError = await validator.validate(input)
assert.strictEqual(validationError, null)
})

it('is not vulnerable to advisories/GHSA-mjr4-7xg5-pfvh', async () => {
/* report:
see https://github.com/advisories/GHSA-mjr4-7xg5-pfvh
see https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1061
*/
const validator = new XmlValidator(version)
/* POC payload:
see https://research.jfrog.com/vulnerabilities/libxmljs2-attrs-type-confusion-rce-jfsa-2024-001034097/#poc
*/
const input = `<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE note
[
<!ENTITY writer "` + 'A'.repeat(0x1234) + `">
]>
<bom xmlns="http://cyclonedx.org/schema/bom/${version}">
<components>
<component type="library">
<name>&writer;</name><!-- << XML external entity (XXE) injection -->
<version>1.337</version>
${version === '1.0' ? '<modified>false</modified>' : ''}
</component>
</components>
</bom>`
const validationError = await validator.validate(input)
assert.strictEqual(validationError, null)
})

it('is not vulnerable to advisories/GHSA-78h3-pg4x-j8cv', async () => {
/* report:
see https://github.com/advisories/GHSA-78h3-pg4x-j8cv
see https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1061
*/
const validator = new XmlValidator(version)
/* POC payload:
see https://research.jfrog.com/vulnerabilities/libxmljs2-namespaces-type-confusion-rce-jfsa-2024-001034098/#poc
*/
const input = `<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE note
[
<!ENTITY writer PUBLIC "` + 'A'.repeat(8) + 'B'.repeat(8) + 'C'.repeat(8) + 'D'.repeat(8) + 'P'.repeat(8) + `" "JFrog Security">
]>
<bom xmlns="http://cyclonedx.org/schema/bom/${version}">
<components>
<component type="library">
<name>&writer;</name><!-- << XML external entity (XXE) injection -->
<version>1.337</version>
${version === '1.0' ? '<modified>false</modified>' : ''}
</component>
</components>
</bom>`
const validationError = await validator.validate(input)
assert.strictEqual(validationError, null)
})
}))
})
Loading