wip, implements simple api-key header extraction for middleware verif… #1
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
jayvdb
reviewed
Feb 13, 2024
| @@ -0,0 +1,113 @@ | |||
| //! Extractor for the "Basic" HTTP Authentication Scheme. | |||
There was a problem hiding this comment.
s/Basic/API-Key/ in all the docs
jayvdb
reviewed
Feb 13, 2024
| XAPIKey::<APIKey>::parse(req) | ||
| .map(|auth| APIKeyAuth(auth.into_scheme())) | ||
| .map_err(|err| { | ||
| log::debug!("`APIKeAuth` extract error: {}", err); |
jayvdb
reviewed
Feb 13, 2024
| /// | ||
| /// The "realm" attribute indicates the scope of protection in the manner described in HTTP/1.1 | ||
| /// [RFC 2617 §1.2](https://tools.ietf.org/html/rfc2617#section-1.2). | ||
| pub fn realm<T>(mut self, value: T) -> Config |
There was a problem hiding this comment.
I suspect this is not valid for API-Key auth. However I see the Bearer extractor has realm, so maybe I am wrong.
The config that would be useful is what is the name of the header containing the api-key. i.e. it shouldnt be hard-coded to x-api-key.
If not configurable, the docs for the module should indicate the limitations compared with https://swagger.io/docs/specification/authentication/api-keys/
There was a problem hiding this comment.
Re Bearer realm - it is allowed in the spec https://datatracker.ietf.org/doc/html/rfc6750#section-3
wrt X-API-Key, we should see if there is anyone using realm with this header
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.
for discussion purposes