Issue #10791: Improve documentation about external DTD loading#19341
Merged
romani merged 1 commit intoMar 21, 2026
Conversation
Contributor
Author
|
GitHub, generate site |
There was a problem hiding this comment.
Pull request overview
Updates Checkstyle’s system property documentation to better explain the security implications of enabling external DTD loading and which XML parser features are toggled by checkstyle.enableExternalDtdLoad.
Changes:
- Documents the three XML parser features disabled by default to mitigate XXE risks.
- Clarifies that enabling
checkstyle.enableExternalDtdLoadturns these features on and should only be used for trusted XML.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| When set to <code>false</code> (the default), Checkstyle disables the following | ||
| three XML parser features to prevent | ||
| <a href="https://owasp.org/www-community/vulnerabilities/XML_External_Entity_(XXE)_Processing"> | ||
| XXE (XML External Entity)</a> attacks and unauthorized file-system or network access: |
01f6f8f to
dcd3b43
Compare
dcd3b43 to
bb938b7
Compare
Member
|
Please make sure CI is passing |
bb938b7 to
6f01c08
Compare
6f01c08 to
b685a80
Compare
Contributor
Author
|
@romani ping |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #10791
Added the three XML parser features disabled by default to the
checkstyle.enableExternalDtdLoaddocumentation:load-external-dtdexternal-general-entitiesexternal-parameter-entities