Upgrade to Panda v7 - support key rotation #247
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
Open
7 tasks
This upgrades Panda from v3 to v7, allowing us to use key rotation as introduced with guardian/pan-domain-authentication#150. ### Necessary code changes * Panda v5 * guardian/pan-domain-authentication#147 removed the old `PublicKey` & `PrivateKey` classes in our `com.gu.pandomainauth` package, in favour of using the existing `java.security` classes. To create instances of those classes, we can use the `SettingsReader.{privateKeyFor, publicKeyFor}` methods. * Panda v6: * guardian/pan-domain-authentication#152 means the `CookieUtils.generateCookieData()` method now communicates errors with `CookieResult` values containing `CookieIntegrityFailure`, rather than exceptions. * Panda v7: * guardian/pan-domain-authentication#150 means that code shouldn't directly reference private or public keys anymore (eg do not reference `settings.signingKeyPair`). Instead, use `settings.signingAndVerification` or `publicSettings.verification`. Note also that `publicSettings.publicKey` was previously optional, and `publicSettings.verification` is not.
rtyley
force-pushed
the
upgrade-to-panda-v7-support-key-rotation
branch
from
e08ec78
to
58ca049
Compare
|
Wow thank you Roberto! I'm just deploying this to our test environment now... |
Ah brilliant! Let me know how it goes... |
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.
This upgrades Panda from v3 to v7, increasing security by allowing us to use key-rotation as introduced with guardian/pan-domain-authentication#150.
I'm very happy to do a walkthrough of the changes with the reviewer if that helps!
Changes to Panda that affected code in this project
java.securityclasses in preference to string-wrappers pan-domain-authentication#147 removed the oldPublicKey&PrivateKeyclasses in ourcom.gu.pandomainauthpackage, in favour of using the existingjava.securityclasses. To create instances of those classes, we can use theSettingsReader.{privateKeyFor, publicKeyFor}methods.CookieUtils.generateCookieData()method now communicates errors withCookieResultvalues containingCookieIntegrityFailure, rather than exceptions.settings.signingKeyPair). Instead, usesettings.signingAndVerificationorpublicSettings.verification. Note also thatpublicSettings.publicKeywas previously optional, andpublicSettings.verificationis not.