Updates code_challenge documentation #468
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
Sgtpluck
commented
Mar 25, 2024
| Base64.encode64(code_challenge) # wrong and URL-unsafe encoding | ||
| => "1BUpxy37SoIPmKw96wbd6MDcvayOYm3ptT+zbe6L/zM=" # wrong and URL-unsafe encoding | ||
| # RFC 4648 URL-safe Base64 encoding replaces "+" with "-" and "/" with "_" | ||
| => "1BUpxy37SoIPmKw96wbd6MDcvayOYm3ptT-zbe6L_zM=" |
There was a problem hiding this comment.
[question] if we want to remove the trailing = we can do that by adding padding: false as an option to Base64.urlsafe_encode64 but it was unclear to me if that was necessary. does anyone know offhand?
There was a problem hiding this comment.
I'm not sure if we need it or not, but since it works with it (based on my test integration I made forever ago) I'd be inclined to leave it in our docs.
There was a problem hiding this comment.
it looks like we remove the padding if it exists, so it doesn't matter.
https://github.com/18F/identity-idp/blob/main/app/forms/openid_connect_token_form.rb#L191-L195
Sgtpluck
commented
Mar 25, 2024
| @@ -53,13 +52,7 @@ Base64.encode64(code_challenge) # wrong and URL-unsafe encoding | |||
| => "1BUpxy37SoIPmKw96wbd6MDcvayOYm3ptT+zbe6L/zM=" # wrong and URL-unsafe encoding | |||
| ``` | |||
| {% endcapture %} | |||
| {% capture code_challenge_incorrect %} | |||
There was a problem hiding this comment.
this capture is unused
Jeremy1026
approved these changes
Mar 25, 2024
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.
A partner recently struggled a bit with the code_challenge, so I wanted to add a little documentation to make it clearer what is happening.
While doing so, I noticed we had some redundant markdown and the example was incorrect, so I fixed those things.