fix: Normalize line breaks according to spec #307
Merged
Conversation
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
karfau
added
spec:XML
karfau
force-pushed
the
normalize-line-endings
branch
2 times, most recently
from
4801a70
to
02de7af
Compare
karfau
force-pushed
the
normalize-line-endings
branch
from
02de7af
to
d2fb058
Compare
> XML parsed entities are often stored in computer files which, for editing convenience, are organized into lines. These lines are typically separated by some combination of the characters CARRIAGE RETURN (#xD) and LINE FEED (#xA). > > To simplify the tasks of applications, the XML processor must behave as if it normalized all line breaks in external parsed entities (including the document entity) on input, before parsing, by translating both the two-character sequence #xD #xA and any #xD that is not followed by #xA to a single #xA character. Where `#xD` == `\r` and `#xA` == `\n`, so ` \r\n ` => ` \n ` ` \n\r ` => ` \n\n ` ` \n ` => ` \n ` ` \r ` => ` \n ` BREAKING CHANGE: Certain combination of line break characters are normalized before parsing takes place and will no longer be preserved. For details see https://www.w3.org/TR/xml/#sec-line-ends fixes #303
|
@brodybits I would like to land this one next, to avoid rebasing #291 over and over. |
brodybits
reviewed
Aug 29, 2021
| '#x20#xa#xa', | ||
| ], | ||
| ])( | ||
| 'should normalize "\\r" not followed by "\\n" %s', |
There was a problem hiding this comment.
minor nit: should this be tested in attribute as well?
There was a problem hiding this comment.
It can not easily, since the the algorithm in the other PR would replace it with a space.
But since we are replacing all occurrences in one go before parsing, I don't think it matters to much.
brodybits
reviewed
Aug 29, 2021
| @@ -29,3 +29,57 @@ describe('errorHandle', () => { | |||
| expect({ actual, ...errors }).toMatchSnapshot() | |||
| }) | |||
| }) | |||
|
|
|||
| describe('whitespace', () => { | |||
| const whitespaceToHex = (str) => | |||
There was a problem hiding this comment.
question: could this be a more general-purpose reusable function?
Or am I violating this by suggesting a too-hasty abstraction: https://kentcdodds.com/blog/aha-programming
There was a problem hiding this comment.
I was also thinking about it. I think as soon as it is needed elsewhere we will find a proper place for it.
brodybits
approved these changes
Aug 29, 2021
karfau
added a commit
that referenced
this pull request
Aug 31, 2021
according to XML1.1 spec. Fixes #49 Since #307 only implemented XML 1.0 spec https://www.w3.org/TR/xml/#sec-line-ends https://www.w3.org/TR/xml11/#sec-line-ends
karfau
added a commit
that referenced
this pull request
Sep 9, 2021
according to XML1.1 spec. Fixes #49 Since #307 only implemented XML 1.0 spec https://www.w3.org/TR/xml/#sec-line-ends https://www.w3.org/TR/xml11/#sec-line-ends
karfau
added a commit
that referenced
this pull request
Sep 9, 2021
according to XML1.1 spec. Fixes #49 Since #307 only implemented XML 1.0 spec https://www.w3.org/TR/xml/#sec-line-ends https://www.w3.org/TR/xml11/#sec-line-ends
This was referenced Dec 25, 2021
mcab
added a commit
to Clever/saml2
that referenced
this pull request
Oct 15, 2022
For [0]. Any usage of @xmldom/xmldom >= 0.8.0 will normalize these. See [1] and [2]. The current xml-encryption (2.0.0) does not do this normalization, but will in 2.0.1 [3]. It's technically within the path of xmlenc.decrypt() [4], but this follows how assertions have been handled (not handling non-normalized whitespace). [0] https://github.com/Clever/saml2/blob/6da3e9c39c326a2f6793bb87c6d12c9ab4446585/lib/saml2.coffee#L242-L245 [1] xmldom/xmldom#307 [2] xmldom/xmldom#314 [3] auth0/node-xml-encryption#101 [4] https://github.com/auth0/node-xml-encryption/blob/291f3f10d5d1d571a3b6da2d411aa323398f5650/lib/xmlenc.js#L185
mcab
added a commit
to Clever/saml2
that referenced
this pull request
Oct 15, 2022
For [0]. Any usage of @xmldom/xmldom >= 0.8.0 will normalize these, see [1] and [2]. The current xml-encryption (2.0.0) does not do this normalization, but will in 2.0.1 [3]. It's technically within the path of xmlenc.decrypt() [4], but this follows how assertions have been handled (not handling non-normalized whitespace). For xml-crypto, this was changed in 3.0.0 with [5]. [0] https://github.com/Clever/saml2/blob/6da3e9c39c326a2f6793bb87c6d12c9ab4446585/lib/saml2.coffee#L242-L245 [1] xmldom/xmldom#307 [2] xmldom/xmldom#314 [3] auth0/node-xml-encryption#101 [4] https://github.com/auth0/node-xml-encryption/blob/291f3f10d5d1d571a3b6da2d411aa323398f5650/lib/xmlenc.js#L185 [5] node-saml/xml-crypto#261
mcab
added a commit
to Clever/saml2
that referenced
this pull request
Oct 15, 2022
For [0]. Any usage of @xmldom/xmldom >= 0.8.0 will normalize these, see [1] and [2]. The current xml-encryption (2.0.0) does not do this normalization, but will in 2.0.1 [3]. It's technically within the path of xmlenc.decrypt() [4], but this follows how assertions have been handled (not handling non-normalized whitespace). For xml-crypto, this was changed in 3.0.0 with [5]. [0] https://github.com/Clever/saml2/blob/6da3e9c39c326a2f6793bb87c6d12c9ab4446585/lib/saml2.coffee#L242-L245 [1] xmldom/xmldom#307 [2] xmldom/xmldom#314 [3] auth0/node-xml-encryption#101 [4] https://github.com/auth0/node-xml-encryption/blob/291f3f10d5d1d571a3b6da2d411aa323398f5650/lib/xmlenc.js#L185 [5] node-saml/xml-crypto#261
mcab
added a commit
to Clever/saml2
that referenced
this pull request
Oct 15, 2022
For [0]. Any usage of @xmldom/xmldom >= 0.8.0 will normalize these, see [1] and [2]. The current xml-encryption (2.0.0) does not do this normalization, but will in 2.0.1 [3]. It's technically within the path of xmlenc.decrypt() [4], but this follows how assertions have been handled (not handling non-normalized whitespace). For xml-crypto, this was changed in 3.0.0 with [5]. [0] https://github.com/Clever/saml2/blob/6da3e9c39c326a2f6793bb87c6d12c9ab4446585/lib/saml2.coffee#L242-L245 [1] xmldom/xmldom#307 [2] xmldom/xmldom#314 [3] auth0/node-xml-encryption#101 [4] https://github.com/auth0/node-xml-encryption/blob/291f3f10d5d1d571a3b6da2d411aa323398f5650/lib/xmlenc.js#L185 [5] node-saml/xml-crypto#261
gkwang
added a commit
to auth0/node-xml-encryption
that referenced
this pull request
Oct 18, 2022
add semgrep support uodate xmldom breaking changes in xmldom: xmldom/xmldom#310 xmldom/xmldom#314 xmldom/xmldom#307
4 tasks
gkwang
added a commit
to auth0/node-xml-encryption
that referenced
this pull request
Oct 18, 2022
add semgrep support uodate xmldom breaking changes in xmldom: xmldom/xmldom#310 xmldom/xmldom#314 xmldom/xmldom#307
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.
Where
#xD==\rand#xA==\n, so\r\n=>\n\n\r=>\n\n\n=>\n\r=>\nBREAKING CHANGE: Certain combination of line break characters are normalized before parsing takes place and will no longer be preserved. For details see https://www.w3.org/TR/xml/#sec-line-ends
fixes #303