oidc: check for nil signing key on rotation #13716
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
fairclothjm
changed the title
|
Logs |
calvn
reviewed
Jan 20, 2022
fairclothjm
commented
Jan 20, 2022
- bypass setting ExpireAt if signing key is nil in rotate - return err if singing key is nil in signPayload
fairclothjm
commented
Jan 24, 2022
calvn
approved these changes
Jan 24, 2022
vault/identity_store_oidc_test.go
Outdated
| @@ -985,15 +1097,33 @@ func TestOIDC_PeriodicFunc(t *testing.T) { | |||
| } | |||
|
|
|||
| // measure collected samples | |||
| for i := range testSet.testCases { | |||
| for i, cycle := range testSet.cycle { | |||
There was a problem hiding this comment.
NIt: cycle could be an int since it's just used as a counter length reference. You could have something like:
for i := 0; i < cycle; i++ {
currentCycle := cycle + 1
...
}
The for loop above could be reworked to be something similar as well.
| }, | ||
| { | ||
| // don't set SigningKey to ensure its non-existence can be handled | ||
| namedKey: &namedKey{ |
There was a problem hiding this comment.
Nit: I wonder if it would be a bit more obvious that the cases are based on different toggles if we had a test helper that generated the named keys with setSigningKey and setNextSigningKey` as params (which would also remove them from the testSet struct):
namedKey: testGenerateNamedKey("test-key-nil-signing-key", false, true)
There was a problem hiding this comment.
I think the namedKey would need to be removed from the testSet instead since we need to call generateAndSetKey with the storage for each test set. I can create an issue to track cleaning up these tests a bit.
austingebauer
approved these changes
Jan 24, 2022
calvn
approved these changes
Jan 24, 2022
qk4l
pushed a commit
to qk4l/vault
that referenced
this pull request
Feb 4, 2022
* check for nil signing key on rotation * add changelog * Update nil signing key handling - bypass setting ExpireAt if signing key is nil in rotate - return err if singing key is nil in signPayload * add comment; update error msg on signPayload; refactor UT
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
Check for a nil signing key before performing a rotation and before signing payloads. This is to prevent panics in the event that a nil signing key was written to storage.
If the current signing key is nil during rotation, we will skip setting the ExpireAt and allow the next signing key to be rotated into the current. If the signing key is nil during sign payload, we will return an error.
Background
A panic can occur for any key which was created while being on a version < v1.9.0 but was rotated while being on v1.9.0.
Repro steps: