api: encode x-error-msg as JSON - so it does not contain <CR> or <LF> #1782
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
ogayot
force-pushed
the
fix-x-error-msg-cr-lf
branch
from
dec4c7f
to
181cef0
Compare
When the server raises an exception in a HTTP request handler context, more often than not, the exception is sent back to the client in the body. Additionally, the message of the exception (if any), is also copied as is in a x-error-msg HTTP header. That said, HTTP headers must obey strict rules. The "\r\n" sequence indicate the end of the current HTTP header. When using aiohttp, the library rejects any header that has a "\r" or "\n" in its value: ValueError: Newline or carriage return character detected in HTTP status message or header. This is a potential security issue. As an example, any curtin.util.ProcessExecutionError exception will contain "\n" characters when converted into a string. We now encode the error message as JSON before copying it in the HTTP header. Signed-off-by: Olivier Gayot <[email protected]>
ogayot
force-pushed
the
fix-x-error-msg-cr-lf
branch
from
181cef0
to
b866bd2
Compare
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.
When the server raises an exception in a HTTP request handler context, more often than not, the exception is sent back to the client in the body.
Additionally, the message of the exception (if any), is also copied as is in a
x-error-msgHTTP header.That said, HTTP headers must obey strict rules. The
"\r\n"sequence indicate the end of the current HTTP header. When using aiohttp, the library rejects any header that has a"\r"or"\n"in its value:As an example, any
curtin.util.ProcessExecutionErrorexception will contain"\n"characters when converted into a string.We now encode the error message as JSON before copying it in the HTTP header.