Replace '(' and ')' with '[' and '] from OS.Description so it doesn't fail User-Agent header validation #2288
Conversation
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
AvaStancu
previously approved these changes
Nov 30, 2022
fhammerl
commented
Dec 1, 2022
jww3
reviewed
Feb 7, 2023
jww3
reviewed
Feb 7, 2023
jww3
reviewed
Feb 7, 2023
jww3
reviewed
Feb 7, 2023
jww3
reviewed
Feb 7, 2023
jww3
approved these changes
Feb 7, 2023
nikola-jokic
pushed a commit
to nikola-jokic/runner
that referenced
this pull request
May 12, 2023
… fail User-Agent header validation (actions#2288) * Sanitize OS Desc for UserAgents * Only drop brackets if needed, refactoring * Add missing ')' * Readd missing brackets around '(header)' * Add comments * Use bracket solution from SDK * Rename tests
AdamOlech
pushed a commit
to antmicro/runner
that referenced
this pull request
Aug 14, 2024
… fail User-Agent header validation (actions#2288) * Sanitize OS Desc for UserAgents * Only drop brackets if needed, refactoring * Add missing ')' * Readd missing brackets around '(header)' * Add comments * Use bracket solution from SDK * Rename tests
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.
Closes #2165
Uses behaviour from UserAgentUtility.cs?
Bug
Linux Liquorix has an OS description that contains mismatched brackets, so the constructor of
ProductInfoHeaderValuethrows.Solution
Drop all
()to prevent nested UserAgentcommentsI don't know of other chars that would need to be sanitized.
Context
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
We use dotnet's OSDescription to get a string that we then include in our UserAgent header as a
ProductInfoHeaderValue.The constructor of
ProductInfoHeaderValuevalidates if a string is compliant with UserAgent formatting. There aren't many requirements, but one of them is matching brackets ->()Brackets represent a
commentin a UserAgent.