-
-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Encryption API 2.0 #123
Merged
Merged
Encryption API 2.0 #123
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
Thank you - this looks to be an improvement 👍 |
Closed
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.
I noticed, that the builder pattern for the encryption/signing API was a bit complex and inflexible.
Most importantly, the user was expected to define which algorithms to use when encrypting. Furthermore sign-only operations would not allow change of algorithms at all (see #75).
This PR introduces a new API which moves options for signing and encrypting into separate builders.
Instead of calling
the API has been simplified to
The new API evaluates the keys used to sign/encrypt and automatically negotiates algorithms.
It is still possible to use custom algorithms though:
Default algorithms and fallbacks can be controlled via
PGPainless.getPolicy()
.Lastly the new API also allows control over which subkeys are used for encryption.
Instead of encrypting to all available encryption subkeys of a keyring, the API will now per default only encrypt to the first encryption capable subkey that is being found.
This behaviour can for example be modified by calling
Other implementations are possible by implementing
EncryptionKeySelector
.All in all, the new API should be way more flexible. We now have better separation of concerns, which should also make the implementation more maintainable and easier for external contributors to understand.
TODO: