Merge pull request #736 from zemyblue/Audit-GLOBAL-01

Missing Amino Codec Registration

Author: zemyblue

CHANGELOG.md

@@ -85,6 +85,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/foundation) [\#704](https://github.com/line/lbm-sdk/pull/704) update x/foundation params
 * (x/wasm)  [\#695](https://github.com/line/lbm-sdk/pull/695) fix to prevent external filesystem dependency of simulation
 * (x/foundation) [\#729](https://github.com/line/lbm-sdk/pull/729) add UpdateParams to x/foundation
+* (amino) [\#736](https://github.com/line/lbm-sdk/pull/736) apply the missing amino codec registratoin of cosmos-sdk
 
 ### Bug Fixes
 * (x/wasm) [\#453](https://github.com/line/lbm-sdk/pull/453) modify wasm grpc query api path

baseapp/baseapp_test.go

@@ -21,6 +21,7 @@ import (
 	dbm "github.com/tendermint/tm-db"
 
 	"github.com/line/lbm-sdk/codec"
+	"github.com/line/lbm-sdk/codec/legacy"
 	"github.com/line/lbm-sdk/snapshots"
 	snapshottypes "github.com/line/lbm-sdk/snapshots/types"
 	"github.com/line/lbm-sdk/store/rootmulti"
@@ -91,10 +92,10 @@ func registerTestCodec(cdc *codec.LegacyAmino) {
 
 	// register test types
 	cdc.RegisterConcrete(&txTest{}, "cosmos-sdk/baseapp/txTest", nil)
-	cdc.RegisterConcrete(&msgCounter{}, "cosmos-sdk/baseapp/msgCounter", nil)
-	cdc.RegisterConcrete(&msgCounter2{}, "cosmos-sdk/baseapp/msgCounter2", nil)
-	cdc.RegisterConcrete(&msgKeyValue{}, "cosmos-sdk/baseapp/msgKeyValue", nil)
-	cdc.RegisterConcrete(&msgNoRoute{}, "cosmos-sdk/baseapp/msgNoRoute", nil)
+	legacy.RegisterAminoMsg(cdc, &msgCounter{}, "cosmos-sdk/baseapp/msgCounter")
+	legacy.RegisterAminoMsg(cdc, &msgCounter2{}, "cosmos-sdk/baseapp/msgCounter2")
+	legacy.RegisterAminoMsg(cdc, &msgKeyValue{}, "cosmos-sdk/baseapp/msgKeyValue")
+	legacy.RegisterAminoMsg(cdc, &msgNoRoute{}, "cosmos-sdk/baseapp/msgNoRoute")
 }
 
 // aminoTxEncoder creates a amino TxEncoder for testing purposes.
@@ -1257,7 +1258,7 @@ func TestRunInvalidTransaction(t *testing.T) {
 		// new codec so we can encode the tx, but we shouldn't be able to decode
 		newCdc := codec.NewLegacyAmino()
 		registerTestCodec(newCdc)
-		newCdc.RegisterConcrete(&msgNoDecode{}, "cosmos-sdk/baseapp/msgNoDecode", nil)
+		legacy.RegisterAminoMsg(newCdc, &msgNoDecode{}, "cosmos-sdk/baseapp/msgNoDecode")
 
 		txBytes, err := newCdc.Marshal(tx)
 		require.NoError(t, err)

codec/legacy/amino_msg.go

@@ -0,0 +1,18 @@
+package legacy
+
+import (
+	"fmt"
+
+	"github.com/line/lbm-sdk/codec"
+	sdk "github.com/line/lbm-sdk/types"
+)
+
+// RegisterAminoMsg first checks that the msgName is <40 chars
+// (else this would break ledger nano signing: https://github.com/cosmos/cosmos-sdk/issues/10870),
+// then registers the concrete msg type with amino.
+func RegisterAminoMsg(cdc *codec.LegacyAmino, msg sdk.Msg, msgName string) {
+	if len(msgName) > 39 {
+		panic(fmt.Errorf("msg name %s is too long to be registered with amino", msgName))
+	}
+	cdc.RegisterConcrete(msg, msgName, nil)
+}

codec/legacy/amino_msg_test.go

@@ -0,0 +1,39 @@
+package legacy_test
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/line/lbm-sdk/codec"
+	"github.com/line/lbm-sdk/codec/legacy"
+	"github.com/line/lbm-sdk/testutil/testdata"
+)
+
+func TestRegisterAminoMsg(t *testing.T) {
+	cdc := codec.NewLegacyAmino()
+
+	testCases := map[string]struct {
+		msgName  string
+		expPanic bool
+	}{
+		"all good": {
+			msgName: "cosmos-sdk/Test",
+		},
+		"msgName too long": {
+			msgName:  strings.Repeat("a", 40),
+			expPanic: true,
+		},
+	}
+	for name, tc := range testCases {
+		t.Run(name, func(t *testing.T) {
+			fn := func() { legacy.RegisterAminoMsg(cdc, &testdata.TestMsg{}, tc.msgName) }
+			if tc.expPanic {
+				require.Panics(t, fn)
+			} else {
+				require.NotPanics(t, fn)
+			}
+		})
+	}
+}

codec/legacy/codec.go

@@ -4,18 +4,19 @@ import (
 	"github.com/line/lbm-sdk/codec"
 	cryptocodec "github.com/line/lbm-sdk/crypto/codec"
 	cryptotypes "github.com/line/lbm-sdk/crypto/types"
+	sdk "github.com/line/lbm-sdk/types"
 )
 
 // Cdc defines a global generic sealed Amino codec to be used throughout sdk. It
 // has all Tendermint crypto and evidence types registered.
 //
 // TODO: Deprecated - remove this global.
-var Cdc *codec.LegacyAmino
+var Cdc = codec.NewLegacyAmino()
 
 func init() {
-	Cdc = codec.NewLegacyAmino()
 	cryptocodec.RegisterCrypto(Cdc)
 	codec.RegisterEvidences(Cdc)
+	sdk.RegisterLegacyAminoCodec(Cdc)
 }
 
 // PrivKeyFromBytes unmarshals private key bytes and returns a PrivKey

codec/legacy/doc.go

@@ -1,4 +1,6 @@
 // Package legacy contains a global amino Cdc which is deprecated but
 // still used in several places within the SDK. This package is intended
 // to be removed at some point in the future when the global Cdc is removed.
+// It also contains a util function RegisterAminoMsg that checks a msg name length
+// before registering the concrete msg type with amino.
 package legacy