allow for externally managed token files #17
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
It may be preferrable to have an external mechanism manage the OAuth2 tokens, rather than having the sasl-xoauth2 plug-in do this for you. To allow for this scenario, a new config parameter "external_token_manager" was introduced. When set to true, sasl-xauth2 will use the "password" field content as the name of a file that contains the current OAuth2 token for user. No other configuration is needed for this plug-in, but an external mechanism must be in place to keep the content of that token file current at all times.
tarickb
requested changes
Sep 10, 2022
| @@ -29,6 +29,7 @@ class Config { | |||
|
|
|||
| static Config *Get(); | |||
|
|
|||
| bool external_token_manager() const { return external_token_manager_; } | |||
There was a problem hiding this comment.
Can we call this "manage_token_externally"?
| @@ -1,4 +1,5 @@ | |||
| { | |||
| "external_token_manager": "no", | |||
There was a problem hiding this comment.
I'd prefer to leave this out of the sample config file, since I imagine most users won't need it and I'd like to avoid the confusion.
| if (!token_) return SASL_FAIL; | ||
| } else { | ||
| tokenfile_ = password; | ||
| } |
There was a problem hiding this comment.
I think it's cleaner overall if instead of having two different code paths here, in Client, we push this complexity into TokenStore by adding a flag there that just disables refreshes. Client would remain unmodified except that it passes the value of manage_token_externally to TokenStore, and TokenStore would just always return whatever's in the token file, regardless of the expiry time.
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.
It may be preferrable to have an external mechanism manage the OAuth2
tokens, rather than having the sasl-xoauth2 plug-in do this for you.
To allow for this scenario, a new config parameter "external_token_manager"
was introduced. When set to true, sasl-xauth2 will use the "password" field
content as the name of a file that contains the current OAuth2 token for the
user. No other configuration is needed for this plug-in, but an external
mechanism must be in place to keep the content of that token file current
at all times.