Add option to disable state verification #1339
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
srajiang
commented
Sep 20, 2021
| * @param installationStore - Interface to store and retrieve installation data from the database | ||
| * @param authVersion - Can be either `v1` or `v2`. Determines which slack Oauth URL and method to use | ||
| * @param logger - Pass in your own Logger if you don't want to use the built-in one | ||
| * @param logLevel - Pass in the log level you want (ERROR, WARN, INFO, DEBUG). Default is INFO | ||
| */ | ||
| export class InstallProvider { | ||
| public stateStore: StateStore; | ||
| public stateStore?: StateStore; |
There was a problem hiding this comment.
When stateVerification = false a stateStore is not necessary anymore.
seratch
approved these changes
Sep 20, 2021
| @@ -546,6 +579,7 @@ export interface CallbackOptions { | |||
| export interface StateStore { | |||
| // Returned Promise resolves for a string which can be used as an | |||
| // OAuth state param. | |||
| // TODO: Revisit design. Does installOptions need to be encoded in state if metadata is static? | |||
There was a problem hiding this comment.
If I were you, I would add something like this:
TODO: With bolt-js built-in receivers, InstallURLOptions is always static. This means that metadata value is not so useful for customizing OAuth flows per user. If we enhance both this SDK and bolt-js to have a function that accepts request information (e.g., path, headers, query string) plus dynamically generate InstallURLOptions per request, developers can easily switch not only medatada but also redirect_uri, scopes, and user_scopes to support multiple installation patterns.
2 tasks
srajiang
added a commit
that referenced
this pull request
Dec 10, 2021
* Add option to disable state verification
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.
Summary
This PR partially fixes bolt-js/#1101 by adding the option to disable state verification during OAuth flow via a
stateVerificationflag. By defaultstateVerification = true. Users can passstateVerification: falseas an OAuth option via AppinstallerOptionsobject.Previous (reverted) changes allowed option to disable state verification but continued usage of default state store for state generation. This current set of changes disables the default state store when stateVerification = false.
Requirements (place an
xin each[ ])