feat: add symmetric key monitoring #324
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
Adds monitoring around JWT decoding and symmetric keys, to help with the eventual deprecation and removal of the symmetric keys. See DEPR: Symmetric JWTs: openedx/public-engineering#83
timmc-edx
reviewed
Apr 12, 2023
Comment on lines
184
to
187
| # .. custom_attribute_name: jwt_auth_decode_symmetric_token | ||
| # .. custom_attribute_description: True if symmetric keys will also be used for checking | ||
| # the JWT signature, and False if only asymmetric keys will be used. | ||
| set_custom_attribute('jwt_auth_decode_symmetric_token', decode_symmetric_token) |
There was a problem hiding this comment.
nit: This reads a little misleadingly to me; I would expect it to mean that the token was decoded using a symmetric key, not that the symmetric key is allowed to be used. (Non-blocking.)
There was a problem hiding this comment.
Updated to jwt_auth_check_symmetric_key.
timmc-edx
reviewed
Apr 12, 2023
timmc-edx
reviewed
Apr 12, 2023
timmc-edx
reviewed
Apr 12, 2023
Comment on lines
235
to
236
| # Note: A separate custom attribute is used in case there are different JWTs decoded | ||
| # in the same request. |
There was a problem hiding this comment.
I'm having trouble understanding this comment. What other attribute is this being contrasted to?
There was a problem hiding this comment.
I tried a longer version. You can let me know if it is more clear.
timmc-edx
approved these changes
Apr 12, 2023
timmc-edx
approved these changes
Apr 12, 2023
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.
Description:
Adds monitoring around JWT decoding and symmetric keys, to help with the eventual deprecation and removal of the symmetric keys.
Issue:
See DEPR: Symmetric JWTs:
openedx/public-engineering#83
Merge checklist:
Post merge:
finished.