Parse OAS3 HTTP-Auth schemes case-insensitively #1531
Closed
+3
−2
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
According to the authors of the OAI spec [1] schemes are case-insensitive. Even if they were not, the current checks against lowercase versions of scheme names do not match the IANA registry's canonical versions [2] which are "Basic" and "Bearer". [1] OAI/OpenAPI-Specification#1880 (comment) [2] https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml#table-authschemes
char0n
requested changes
May 14, 2020
| @@ -147,14 +147,15 @@ export function applySecurities({request, securities = {}, operation = {}, spec} | |||
| } | |||
| } | |||
| else if (type === 'http') { | |||
| if (schema.scheme === 'basic') { | |||
| const scheme = schema.scheme && schema.scheme.toLowerCase() | |||
There was a problem hiding this comment.
We should be able to use lodash toLower which returns and empty string of when provided a non-string argument.
import 'toLower' from 'lodash/toLower';
Suggested change
| const scheme = schema.scheme && schema.scheme.toLowerCase() | |
| const scheme = toLower(schema.scheme) |
char0n
added a commit
that referenced
this pull request
Jun 18, 2020
As per RFC7235 auth scheme is case insensitive. 2.1. Challenge and Response HTTP provides a simple challenge-response authentication framework that can be used by a server to challenge a client request and by a client to provide authentication information. It uses a case- insensitive token as a means to identify the authentication scheme, followed by additional information necessary for achieving. https://tools.ietf.org/html/rfc7235#section-2.1 Refs #1531, #1473 Refs OAI/OpenAPI-Specification#1876 Refs swagger-api/swagger-ui#5965
10 tasks
|
Closing in favor of #1562 |
char0n
added a commit
that referenced
this pull request
Jun 18, 2020
As per RFC7235 auth scheme is case insensitive. 2.1. Challenge and Response HTTP provides a simple challenge-response authentication framework that can be used by a server to challenge a client request and by a client to provide authentication information. It uses a case- insensitive token as a means to identify the authentication scheme, followed by additional information necessary for achieving. https://tools.ietf.org/html/rfc7235#section-2.1 Refs #1531, #1473 Refs OAI/OpenAPI-Specification#1876 Refs swagger-api/swagger-ui#5965
char0n
added a commit
that referenced
this pull request
Jun 18, 2020
As per RFC7235 auth scheme is case insensitive. 2.1. Challenge and Response HTTP provides a simple challenge-response authentication framework that can be used by a server to challenge a client request and by a client to provide authentication information. It uses a case- insensitive token as a means to identify the authentication scheme, followed by additional information necessary for achieving. https://tools.ietf.org/html/rfc7235#section-2.1 Co-authored-by: Helen Kosova <hkosova@users.noreply.github.com> Refs #1531, #1473 Refs OAI/OpenAPI-Specification#1876 Refs swagger-api/swagger-ui#5965
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.
According to the authors of the OAI spec (OAI/OpenAPI-Specification#1880 (comment)), schemes are case-insensitive. Even if they were not, the current checks against lowercase versions of scheme names do not match the IANA registry's canonical versions (https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml#table-authschemes), which are "Basic" and "Bearer".
Description
Motivation and Context
If users are overly-adhering to the spec, they may copy-paste HTTP auth scheme names directly from the IANA registry. If they do, the request builder will omit the necessary headers, because it performs a case-sensitive comparison of the scheme name to a lower-case version.
How Has This Been Tested?
I have not yet tested this change.
Types of changes
package.json)Checklist: