-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for passing tokens as plaintext strings in addition to tokens file #102
Merged
kukushechkin
merged 3 commits into
iqm-finland:main
from
milankinen:feat/api-key-support
Dec 7, 2023
Merged
Add support for passing tokens as plaintext strings in addition to tokens file #102
kukushechkin
merged 3 commits into
iqm-finland:main
from
milankinen:feat/api-key-support
Dec 7, 2023
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
milankinen
changed the title
Add support for API key authentication
Add support for passing tokens as plaintext strings instead of using tokens file
Nov 24, 2023
milankinen
changed the title
Add support for passing tokens as plaintext strings instead of using tokens file
Add support for passing tokens as plaintext strings in addition to tokens file
Nov 24, 2023
olliahonen
reviewed
Nov 28, 2023
olliahonen
reviewed
Nov 28, 2023
olliahonen
reviewed
Nov 28, 2023
olliahonen
reviewed
Nov 28, 2023
olliahonen
suggested changes
Nov 28, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See individual comments 👍
kukushechkin
reviewed
Dec 5, 2023
Change log update is necessary. |
smite
reviewed
Dec 5, 2023
smite
reviewed
Dec 5, 2023
smite
reviewed
Dec 5, 2023
smite
reviewed
Dec 5, 2023
Authentication with direct token will use the same bearer token authentication schema as the external access token. The only difference is that direct access tokens don't need to be JWT tokens: they can be any arbitrary strings managed by the server and user doesn't need to know any details about their semantics. Server is responsible for the identifying which token is provided and select the authentication mechanism accordingly. Backwards compatibility: Plaintext token will only be used if it's set by the user (either via constructor arguments or via environment variable) AND tokens_file is not defined, so old clients will work normally and no modifications are required for the existing installations. Servers that do not support the new token type will them and servers that support it will process them correctly.
olliahonen
approved these changes
Dec 7, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
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.
Hello!
This PR proposes an API key support to the
iqm-client
.In this proposal, the used plaintext tokens will use the same bearer token authentication schema as the external access token. The only difference is that direct access tokens don't need to be JWT tokens: they can be any arbitrary strings managed by the server and user doesn't need to know any details about their semantics. Server is responsible for the identifying which token is provided and select the authentication mechanism accordingly.
Backwards compatibility
Plaintext token will only be used if it's set by the user (either via constructor arguments or via environment variable) and
tokens_file
is not set, so old clients will work normally and no modifications are required for the existing installations. Servers that do not support the new token type will them and servers that support it will process them correctly.