Add support for optional encryption of RSA key at rest #13
+98
−13
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
mcohoon
reviewed
Apr 5, 2024
| encrypted=options.get('encrypted', False), | ||
| ) | ||
| rsakey.save() | ||
| self.stdout.write(u'RSA key successfully created with kid: {0}'.format(rsakey.kid)) |
There was a problem hiding this comment.
Suggested change
| self.stdout.write(u'RSA key successfully created with kid: {0}'.format(rsakey.kid)) | |
| self.stdout.write(f'RSA key successfully created with kid: {rsakey.kid}') |
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 adds support for the encryption of private RSA keys stored in the database. It's written in such a way that it's backward compatible, and should not change anything for existing installations.
To enable encryption of RSA keys, you must create functions for encryption & decryption, and define the following hooks in
settings.py:The
RSAKeymodel provides a new field calledencrypted. WhenencryptedisTrueand the model is saved, the value ofkeywill be encrypted when saved. The.pemattribute should be used to retrieve the key PEM, regardless of whether or not it is encrypted. If the RSAKey instance is encrypted,.pemwill return the raw value from the database.Once this is enabled,
RSAKeyinstances withencrypt=Truewill be encrypted & decrypted using the given encryption hook.This is split into two versions so that dependent services can deploy the migration separately from the code changes:
0.8.4+orm.migration: migration only0.8.4+orm: code changes w/ optional encryption