6cbbd6da75
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description The draft PR #9222 Closes: #7108 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> - implement proto definition for `Record` - rename `Info.go` to `legacyInfo.go` within `keyring` package - implement CLI `migrate` command that migrates all keys from legacyInfo to proto according to @robert-zaremba migration [algorithm](https://github.com/cosmos/cosmos-sdk/pull/9222/#discussion_r624683839) - remove legacy keybase entirely. - add `Migrate` and `MigrateAll` functions in `keyring.go` for single key and all keys migration - add tests - fix tests --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
274 lines
6.8 KiB
Go
274 lines
6.8 KiB
Go
package keyring
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/99designs/keyring"
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
"github.com/cosmos/cosmos-sdk/codec/legacy"
|
|
"github.com/cosmos/cosmos-sdk/crypto/hd"
|
|
|
|
"github.com/cosmos/cosmos-sdk/crypto/keys/multisig"
|
|
"github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1"
|
|
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
)
|
|
|
|
const n1 = "cosmos"
|
|
|
|
type MigrationTestSuite struct {
|
|
suite.Suite
|
|
|
|
kb Keyring
|
|
priv cryptotypes.PrivKey
|
|
pub cryptotypes.PubKey
|
|
ks keystore
|
|
}
|
|
|
|
func (s *MigrationTestSuite) SetupSuite() {
|
|
dir := s.T().TempDir()
|
|
mockIn := strings.NewReader("")
|
|
cdc := getCodec()
|
|
|
|
kb, err := New(n1, BackendTest, dir, mockIn, cdc)
|
|
s.Require().NoError(err)
|
|
|
|
ks, ok := kb.(keystore)
|
|
s.Require().True(ok)
|
|
|
|
s.kb = kb
|
|
s.ks = ks
|
|
|
|
s.priv = cryptotypes.PrivKey(secp256k1.GenPrivKey())
|
|
s.pub = s.priv.PubKey()
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateLegacyLocalKey() {
|
|
legacyLocalInfo := newLegacyLocalInfo(n1, s.pub, string(legacy.Cdc.MustMarshal(s.priv)), hd.Secp256k1.Name())
|
|
serializedLegacyLocalInfo := MarshalInfo(legacyLocalInfo)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyLocalInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
_, migrated, err := s.ks.migrate(n1)
|
|
s.Require().True(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateLegacyLedgerKey() {
|
|
account, coinType, index := uint32(118), uint32(0), uint32(0)
|
|
hdPath := hd.NewFundraiserParams(account, coinType, index)
|
|
legacyLedgerInfo := newLegacyLedgerInfo(n1, s.pub, *hdPath, hd.Secp256k1.Name())
|
|
serializedLegacyLedgerInfo := MarshalInfo(legacyLedgerInfo)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyLedgerInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
_, migrated, err := s.ks.migrate(n1)
|
|
s.Require().True(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateLegacyOfflineKey() {
|
|
legacyOfflineInfo := newLegacyOfflineInfo(n1, s.pub, hd.Secp256k1.Name())
|
|
serializedLegacyOfflineInfo := MarshalInfo(legacyOfflineInfo)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyOfflineInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
_, migrated, err := s.ks.migrate(n1)
|
|
s.Require().True(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateLegacyMultiKey() {
|
|
multi := multisig.NewLegacyAminoPubKey(
|
|
1, []cryptotypes.PubKey{
|
|
s.pub,
|
|
},
|
|
)
|
|
|
|
LegacyMultiInfo, err := NewLegacyMultiInfo(n1, multi)
|
|
s.Require().NoError(err)
|
|
serializedLegacyMultiInfo := MarshalInfo(LegacyMultiInfo)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyMultiInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
_, migrated, err := s.ks.migrate(n1)
|
|
s.Require().True(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateLocalRecord() {
|
|
k1, err := NewLocalRecord("test record", s.priv, s.pub)
|
|
s.Require().NoError(err)
|
|
|
|
serializedRecord, err := s.ks.cdc.Marshal(k1)
|
|
s.Require().NoError(err)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedRecord,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
k2, migrated, err := s.ks.migrate(n1)
|
|
s.Require().Equal(k2.Name, k1.Name)
|
|
|
|
pub, err := k2.GetPubKey()
|
|
s.Require().NoError(err)
|
|
s.Require().Equal(pub, s.pub)
|
|
|
|
priv, err := extractPrivKeyFromRecord(k2)
|
|
s.Require().NoError(err)
|
|
s.Require().Equal(priv, s.priv)
|
|
|
|
s.Require().False(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateOneRandomItemError() {
|
|
randomBytes := []byte("abckd0s03l")
|
|
errItem := keyring.Item{
|
|
Key: n1,
|
|
Data: randomBytes,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(errItem))
|
|
|
|
_, migrated, err := s.ks.migrate(n1)
|
|
s.Require().False(migrated)
|
|
s.Require().Error(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateAllLegacyMultiOffline() {
|
|
multi := multisig.NewLegacyAminoPubKey(
|
|
1, []cryptotypes.PubKey{
|
|
s.pub,
|
|
},
|
|
)
|
|
|
|
LegacyMultiInfo, err := NewLegacyMultiInfo(n1, multi)
|
|
s.Require().NoError(err)
|
|
serializedLegacyMultiInfo := MarshalInfo(LegacyMultiInfo)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyMultiInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
legacyOfflineInfo := newLegacyOfflineInfo(n1, s.pub, hd.Secp256k1.Name())
|
|
serializedLegacyOfflineInfo := MarshalInfo(legacyOfflineInfo)
|
|
|
|
item = keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyOfflineInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
migrated, err := s.kb.MigrateAll()
|
|
s.Require().True(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateAllNoItem() {
|
|
migrated, err := s.kb.MigrateAll()
|
|
s.Require().False(migrated)
|
|
s.Require().NoError(err)
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateErrUnknownItemKey() {
|
|
legacyOfflineInfo := newLegacyOfflineInfo(n1, s.pub, hd.Secp256k1.Name())
|
|
serializedLegacyOfflineInfo := MarshalInfo(legacyOfflineInfo)
|
|
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: serializedLegacyOfflineInfo,
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
incorrectItemKey := n1 + "1"
|
|
_, migrated, err := s.ks.migrate(incorrectItemKey)
|
|
s.Require().False(migrated)
|
|
s.Require().EqualError(err, sdkerrors.Wrap(sdkerrors.ErrKeyNotFound, incorrectItemKey).Error())
|
|
}
|
|
|
|
func (s *MigrationTestSuite) TestMigrateErrEmptyItemData() {
|
|
item := keyring.Item{
|
|
Key: n1,
|
|
Data: []byte{},
|
|
Description: "SDK kerying version",
|
|
}
|
|
|
|
s.Require().NoError(s.ks.SetItem(item))
|
|
|
|
_, migrated, err := s.ks.migrate(n1)
|
|
s.Require().False(migrated)
|
|
s.Require().EqualError(err, sdkerrors.Wrap(sdkerrors.ErrKeyNotFound, n1).Error())
|
|
}
|
|
func TestMigrationTestSuite(t *testing.T) {
|
|
suite.Run(t, new(MigrationTestSuite))
|
|
}
|
|
|
|
// newLegacyLocalInfo creates a new legacyLocalInfo instance
|
|
func newLegacyLocalInfo(name string, pub cryptotypes.PubKey, privArmor string, algo hd.PubKeyType) LegacyInfo {
|
|
return &legacyLocalInfo{
|
|
Name: name,
|
|
PubKey: pub,
|
|
PrivKeyArmor: privArmor,
|
|
Algo: algo,
|
|
}
|
|
}
|
|
|
|
// newLegacyOfflineInfo creates a new legacyLedgerInfo instance
|
|
func newLegacyLedgerInfo(name string, pub cryptotypes.PubKey, path hd.BIP44Params, algo hd.PubKeyType) LegacyInfo {
|
|
return &legacyLedgerInfo{
|
|
Name: name,
|
|
PubKey: pub,
|
|
Path: path,
|
|
Algo: algo,
|
|
}
|
|
}
|
|
|
|
// newLegacyOfflineInfo creates a new legacyOfflineInfo instance
|
|
func newLegacyOfflineInfo(name string, pub cryptotypes.PubKey, algo hd.PubKeyType) LegacyInfo {
|
|
return &legacyOfflineInfo{
|
|
Name: name,
|
|
PubKey: pub,
|
|
Algo: algo,
|
|
}
|
|
}
|