feat: Keyring #2557
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| // Copyright 2024 Democratized Data Foundation | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package cli | ||
|
|
||
| import ( | ||
| "crypto/rand" | ||
| "errors" | ||
| "syscall" | ||
|
|
||
| "github.com/99designs/keyring" | ||
|
There was a problem hiding this comment. question: How confident are we in this dependency? The repo hasn't been updated in more than two years, and it is managed by a company that looks to have a focus way away from the security world and may lack the technical expertise or attention to keep it secure (assuming it and its dependencies were secure 2 years ago). Some of its' dependencies are very out of date, and a couple are even more stale and suspicious looking than this package (e.g. https://github.com/gsterjov/go-libsecret with 14 stars, presumably responsible for the very old version of https://github.com/godbus/dbus) Different websites say different things RE its' size, one says it only had 16 employees in 2022 (when the repo was last updated), other top search engine hits estimate 300, and 3777 employees. 99Designs:
There was a problem hiding this comment. I've replaced this dependency with a custom implementation using a newer library. There was a problem hiding this comment. Dependencies and code of the new one look much healthier, thanks Keenan :) |
||
| "github.com/libp2p/go-libp2p/core/crypto" | ||
| "github.com/spf13/cobra" | ||
| "golang.org/x/term" | ||
| ) | ||
|
|
||
| const ( | ||
| peerKeyName = "peer_key" | ||
| badgerEncryptionKeyName = "badger_encryption_key" | ||
| ) | ||
|
|
||
| // openKeyring attempts to open the keyring file from the given directory. | ||
| // | ||
| // If the directory is an empty string the best option for the current OS will be used. | ||
| func openKeyring(cmd *cobra.Command, dir string) (keyring.Keyring, error) { | ||
| var allowedBackends []keyring.BackendType | ||
| if dir != "" { | ||
| // only allow file backend if a directory is specified | ||
| allowedBackends = append(allowedBackends, keyring.FileBackend) | ||
| } | ||
|
|
||
| prompt := keyring.PromptFunc(func(s string) (string, error) { | ||
| cmd.Print(s) | ||
| pass, err := term.ReadPassword(int(syscall.Stdin)) | ||
| return string(pass), err | ||
| }) | ||
|
|
||
| return keyring.Open(keyring.Config{ | ||
| AllowedBackends: allowedBackends, | ||
| ServiceName: "defradb", | ||
| KeychainName: "defradb", | ||
| KeychainPasswordFunc: prompt, | ||
| FilePasswordFunc: prompt, | ||
| FileDir: dir, | ||
| KeyCtlScope: "user", | ||
| KeyCtlPerm: 0, // TODO | ||
|
There was a problem hiding this comment. todo: Please create a task if this is something that needs to be handled later. Otherwise it will linger. There was a problem hiding this comment. I will fix before merging. There was a problem hiding this comment. I ended up replacing this dependency. |
||
| KWalletAppID: "defradb", | ||
| KWalletFolder: "defradb", | ||
| LibSecretCollectionName: "defradb", | ||
| PassPrefix: "defradb", | ||
| WinCredPrefix: "defradb", | ||
| }) | ||
| } | ||
|
|
||
| // generateAES256 generates a new random AES-256 bit encryption key. | ||
| func generateAES256() ([]byte, error) { | ||
| data := make([]byte, 32) | ||
| _, err := rand.Read(data) | ||
| return data, err | ||
| } | ||
|
|
||
| // loadOrGenerateAES256 attempts to load the AES-256 bit key with the given name. | ||
| // | ||
| // If the key does not exist a new random key is generated and stored in the keyring. | ||
| func loadOrGenerateAES256(kr keyring.Keyring, name string) ([]byte, error) { | ||
| item, err := kr.Get(name) | ||
| if err == nil { | ||
| return item.Data, nil | ||
| } | ||
| if !errors.Is(err, keyring.ErrKeyNotFound) { | ||
| return nil, err | ||
| } | ||
| key, err := generateAES256() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| err = kr.Set(keyring.Item{ | ||
| Key: name, | ||
| Data: key, | ||
| }) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return key, nil | ||
| } | ||
|
|
||
| // generateEd25519 generates a new random Ed25519 private key. | ||
| func generateEd25519() (crypto.PrivKey, error) { | ||
| key, _, err := crypto.GenerateKeyPair(crypto.Ed25519, 0) | ||
| return key, err | ||
| } | ||
|
|
||
| // loadOrGenerateEd25519 attempts to load the Ed25519 private key with the given name. | ||
| // | ||
| // If the key does not exist a new random key is generated and stored in the keyring. | ||
| func loadOrGenerateEd25519(kr keyring.Keyring, name string) (crypto.PrivKey, error) { | ||
| item, err := kr.Get(name) | ||
| if err == nil { | ||
| return crypto.UnmarshalPrivateKey(item.Data) | ||
| } | ||
| if !errors.Is(err, keyring.ErrKeyNotFound) { | ||
| return nil, err | ||
| } | ||
| key, err := generateEd25519() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| data, err := crypto.MarshalPrivateKey(key) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| err = kr.Set(keyring.Item{ | ||
| Key: name, | ||
| Data: data, | ||
| }) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return key, nil | ||
| } | ||
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
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: I wonder if all this logic with generating hashes should be scoped to this cli package.
Maybe it makes sense to extract it in another place so other that other packages can use it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that would be nice. Would it make sense to have a
cryptopackage?