Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add key storage capabilities directly to kms-local #539

Closed
mirceanis opened this issue May 28, 2021 · 0 comments · Fixed by #661
Closed

add key storage capabilities directly to kms-local #539

mirceanis opened this issue May 28, 2021 · 0 comments · Fixed by #661
Assignees
@mirceanis
Labels
enhancement New feature or request planned-feature don't close this just for being stale

Comments

@mirceanis
Copy link
Member

mirceanis commented May 28, 2021 •
edited
Loading

It should be up to the KMS(AbstractKeyManagementSystem) implementations to decide how (and if) they store private key material.
KMS implementations should not rely on a privateKeyHex field being supplied by the key-manager plugin.

Constraints:

  • the key-manager plugin (as any other agent plugin) should never be able to reach private key material directly.
  • the kms-local package would leverage the same storage as before, even after the migration of key storage responsibility.
  • the core packages should allow static configurations (like agent.yml for CLI)
  • migration to the new KMS should be seamless
@mirceanis mirceanis added enhancement New feature or request planned-feature don't close this just for being stale labels May 28, 2021
@mirceanis mirceanis mentioned this issue May 28, 2021
Closed
@mirceanis mirceanis self-assigned this Jul 1, 2021
mirceanis added a commit that referenced this issue Aug 6, 2021
@mirceanis
feat(key-manager): move private key storage to kms-local
3e67b99 
fixes #539
fixes #540

BREAKING CHANGE: `keyManagetGet` no longer includes private key data
BREAKING CHANGE: `KeyStore` no longer requires a `SecretBox`
BREAKING CHANGE: `KeyManagementSystem` needs a `PrivateKeyStore`
BREAKING CHANGE: @veramo/cli configuration version update to 3.0
@mirceanis mirceanis mentioned this issue Aug 11, 2021
Merged
mirceanis added a commit that referenced this issue Aug 20, 2021
@mirceanis
feat(key-manager): move private key storage to kms-local
5f02477 
fixes #539
fixes #540

BREAKING CHANGE: `keyManagetGet` no longer includes private key data
BREAKING CHANGE: `KeyStore` no longer requires a `SecretBox`
BREAKING CHANGE: `KeyManagementSystem` needs a `PrivateKeyStore`
BREAKING CHANGE: @veramo/cli configuration version update to 3.0
mirceanis added a commit that referenced this issue Aug 24, 2021
@mirceanis
feat(key-manager): move private key storage to kms-local
56aeba7 
fixes #539
fixes #540

BREAKING CHANGE: `keyManagetGet` no longer includes private key data
BREAKING CHANGE: `KeyStore` no longer requires a `SecretBox`
BREAKING CHANGE: `KeyManagementSystem` needs a `PrivateKeyStore`
BREAKING CHANGE: @veramo/cli configuration version update to 3.0
mirceanis added a commit that referenced this issue Aug 25, 2021
@mirceanis
feat(key-manager): move private key storage to kms-local
a89f635 
fixes #539
fixes #540

BREAKING CHANGE: `keyManagetGet` no longer includes private key data
BREAKING CHANGE: `KeyStore` no longer requires a `SecretBox`
BREAKING CHANGE: `KeyManagementSystem` needs a `PrivateKeyStore`
BREAKING CHANGE: @veramo/cli configuration version update to 3.0
mirceanis added a commit that referenced this issue Aug 31, 2021
@mirceanis
feat(key-manager): move private key storage to kms-local
11ce073 
fixes #539
fixes #540

BREAKING CHANGE: `keyManagetGet` no longer includes private key data
BREAKING CHANGE: `KeyStore` no longer requires a `SecretBox`
BREAKING CHANGE: `KeyManagementSystem` needs a `PrivateKeyStore`
BREAKING CHANGE: @veramo/cli configuration version update to 3.0
mirceanis added a commit that referenced this issue Sep 1, 2021
@mirceanis
feat(key-manager): move private key storage to kms-local (#661)
6b1d135 
BREAKING CHANGE: `keyManagetGet` no longer returns private key data
BREAKING CHANGE: `KeyStore` no longer requires a `SecretBox`
BREAKING CHANGE: `KeyManagementSystem` needs a `PrivateKeyStore`
BREAKING CHANGE: @veramo/cli configuration version update to 3.0

If you're already working with Veramo and wish to upgrade existing agents to veramo 3.0, you'll have to make some changes to your configuration, depending on how you're using the framework.

It boils down to these 3 steps:

1. Update your database connection to use migrations
2. Remove the `SecretBox` parameter from `KeyManager`
3. Add a `PrivateKeyStore` parameter to `KeyManagementSystem` with a `SecretBox` that you were using before with `KeyManager` (and keep the same encryption key)

* feat(key-manager): move private key storage to kms-local

fixes #539
fixes #540
fixes #680

* feat(data-store): add migration of key stores

* fix(data-store): fix usage of where clause for queries

* refactor(kms-local): simplify constructor for KeyManagementSystem

* style: remove scar tissue and unused code
@mirceanis mirceanis mentioned this issue Sep 20, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mirceanis mirceanis

Labels
enhancement New feature or request planned-feature don't close this just for being stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(key-manager): move private key storage to kms-local decentralized-identity/veramo
1 participant
@mirceanis