Add Support for API Key Authentication #230
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
Merged
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.
This pull request introduces the ability to secure the server using API key authentication, adding an extra layer of security for server access. By requiring an API key for incoming requests, we ensure that only authorized users can interact with the server's endpoints.
The
APIKeyValidatorMiddlewareclass has been introduced to perform the API key check. It intercepts incoming requests, checks for the API key in theX-API-Keyheader, and validates it against the expected key.If the API key is missing or incorrect, the middleware immediately returns a
403response, blocking access to the server's endpoints.This feature is opt-in, ensuring backward compatibility for existing deployments. Users can enable API key authentication by setting the appropriate variable.