wormhole/node/pkg/vaa/structs_test.go

489 lines
16 KiB
Go

package vaa
import (
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"encoding/hex"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/crypto"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"reflect"
"testing"
"time"
)
func TestChainIDFromString(t *testing.T) {
type test struct {
input string
output ChainID
}
// Positive Test Cases
p_tests := []test{
{input: "solana", output: ChainIDSolana},
{input: "ethereum", output: ChainIDEthereum},
{input: "terra", output: ChainIDTerra},
{input: "bsc", output: ChainIDBSC},
{input: "polygon", output: ChainIDPolygon},
{input: "avalanche", output: ChainIDAvalanche},
{input: "oasis", output: ChainIDOasis},
{input: "algorand", output: ChainIDAlgorand},
{input: "aurora", output: ChainIDAurora},
{input: "fantom", output: ChainIDFantom},
{input: "karura", output: ChainIDKarura},
{input: "acala", output: ChainIDAcala},
{input: "klaytn", output: ChainIDKlaytn},
{input: "celo", output: ChainIDCelo},
{input: "ethereum-ropsten", output: ChainIDEthereumRopsten},
{input: "Solana", output: ChainIDSolana},
{input: "Ethereum", output: ChainIDEthereum},
{input: "Terra", output: ChainIDTerra},
{input: "Bsc", output: ChainIDBSC},
{input: "Polygon", output: ChainIDPolygon},
{input: "Avalanche", output: ChainIDAvalanche},
{input: "Oasis", output: ChainIDOasis},
{input: "Algorand", output: ChainIDAlgorand},
{input: "Aurora", output: ChainIDAurora},
{input: "Fantom", output: ChainIDFantom},
{input: "Karura", output: ChainIDKarura},
{input: "Acala", output: ChainIDAcala},
{input: "Klaytn", output: ChainIDKlaytn},
{input: "Celo", output: ChainIDCelo},
{input: "Ethereum-ropsten", output: ChainIDEthereumRopsten},
}
// Negative Test Cases
n_tests := []test{
{input: "Unknown", output: ChainIDUnset},
}
for _, tc := range p_tests {
t.Run(tc.input, func(t *testing.T) {
chainId, err := ChainIDFromString(tc.input)
assert.Equal(t, tc.output, chainId)
assert.Nil(t, err)
})
}
for _, tc := range n_tests {
t.Run(tc.input, func(t *testing.T) {
chainId, err := ChainIDFromString(tc.input)
assert.Equal(t, tc.output, chainId)
assert.NotNil(t, err)
})
}
}
func TestAddress_MarshalJSON(t *testing.T) {
addr := Address{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4}
expected := "223030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303422"
marshalJsonAddress, err := addr.MarshalJSON()
assert.Equal(t, hex.EncodeToString(marshalJsonAddress), expected)
assert.Nil(t, err)
}
func TestAddress_String(t *testing.T) {
addr := Address{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4}
expected := "0000000000000000000000000000000000000000000000000000000000000004"
assert.Equal(t, addr.String(), expected)
}
func TestAddress_Bytes(t *testing.T) {
addr := Address{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4}
expected := []byte{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x4}
assert.Equal(t, addr.Bytes(), expected)
}
func TestSignatureData_MarshalJSON(t *testing.T) {
sigData := SignatureData{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0}
marshalJsonSigData, err := sigData.MarshalJSON()
require.Nil(t, err)
expected := "223030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303430303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303034303022"
assert.Equal(t, hex.EncodeToString(marshalJsonSigData), expected)
}
func TestSignature_DataString(t *testing.T) {
sigData := SignatureData{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0}
expected := "0000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000400"
assert.Equal(t, sigData.String(), expected)
}
func TestChainId_String(t *testing.T) {
type test struct {
input ChainID
output string
}
tests := []test{
{input: 0, output: "unset"},
{input: 1, output: "solana"},
{input: 2, output: "ethereum"},
{input: 3, output: "terra"},
{input: 4, output: "bsc"},
{input: 5, output: "polygon"},
{input: 6, output: "avalanche"},
{input: 7, output: "oasis"},
{input: 8, output: "algorand"},
{input: 9, output: "aurora"},
{input: 10, output: "fantom"},
{input: 11, output: "karura"},
{input: 12, output: "acala"},
{input: 13, output: "klaytn"},
{input: 14, output: "celo"},
{input: 10001, output: "ethereum-ropsten"},
}
for _, tc := range tests {
t.Run(tc.output, func(t *testing.T) {
assert.Equal(t, ChainID(tc.input).String(), tc.output)
})
}
}
func getVaa() VAA {
var payload = []byte{97, 97, 97, 97, 97, 97}
var governanceEmitter = Address{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4}
return VAA{
Version: uint8(1),
GuardianSetIndex: uint32(1),
Signatures: nil,
Timestamp: time.Unix(0, 0),
Nonce: uint32(1),
Sequence: uint64(1),
ConsistencyLevel: uint8(32),
EmitterChain: ChainIDSolana,
EmitterAddress: governanceEmitter,
Payload: payload,
}
}
func TestAddSignature(t *testing.T) {
vaa := getVaa()
// Generate a random private key to sign with
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
assert.Nil(t, vaa.Signatures)
// Add a signature and make sure it's added
vaa.AddSignature(key, 0)
assert.Equal(t, len(vaa.Signatures), 1)
}
func TestSerializeBody(t *testing.T) {
vaa := getVaa()
expected := []byte{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1, 0x0, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1, 0x20, 0x61, 0x61, 0x61, 0x61, 0x61, 0x61}
assert.Equal(t, vaa.serializeBody(), expected)
}
func TestSigningBody(t *testing.T) {
vaa := getVaa()
expected := []byte{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1, 0x0, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1, 0x20, 0x61, 0x61, 0x61, 0x61, 0x61, 0x61}
assert.Equal(t, vaa.signingBody(), expected)
}
func TestSigningMsg(t *testing.T) {
vaa := getVaa()
expected := common.HexToHash("4fae136bb1fd782fe1b5180ba735cdc83bcece3f9b7fd0e5e35300a61c8acd8f")
assert.Equal(t, vaa.SigningMsg(), expected)
}
func TestMessageID(t *testing.T) {
vaa := getVaa()
expected := "1/0000000000000000000000000000000000000000000000000000000000000004/1"
assert.Equal(t, vaa.MessageID(), expected)
}
func TestHexDigest(t *testing.T) {
vaa := getVaa()
expected := "4fae136bb1fd782fe1b5180ba735cdc83bcece3f9b7fd0e5e35300a61c8acd8f"
assert.Equal(t, vaa.HexDigest(), expected)
}
func TestVerifySignatures(t *testing.T) {
// Generate some random private keys to sign with
privKey1, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey2, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey3, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey4, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
// Give a fixed order of trusted addresses
addrs := []common.Address{}
addrs = append(addrs, crypto.PubkeyToAddress(privKey1.PublicKey))
addrs = append(addrs, crypto.PubkeyToAddress(privKey2.PublicKey))
addrs = append(addrs, crypto.PubkeyToAddress(privKey3.PublicKey))
type test struct {
label string
keyOrder []*ecdsa.PrivateKey
addrs []common.Address
indexOrder []uint8
result bool
}
tests := []test{
{label: "NoSignerZero",
keyOrder: []*ecdsa.PrivateKey{},
addrs: addrs,
indexOrder: []uint8{0},
result: true},
{label: "NoSignerOne",
keyOrder: []*ecdsa.PrivateKey{},
addrs: addrs,
indexOrder: []uint8{1},
result: true},
{label: "SingleZero",
keyOrder: []*ecdsa.PrivateKey{privKey1},
addrs: addrs,
indexOrder: []uint8{0},
result: true},
{label: "RogueSingleOne",
keyOrder: []*ecdsa.PrivateKey{privKey4},
addrs: addrs,
indexOrder: []uint8{0},
result: false},
{label: "RogueSingleZero",
keyOrder: []*ecdsa.PrivateKey{privKey4},
addrs: addrs,
indexOrder: []uint8{0},
result: false},
{label: "SingleOne",
keyOrder: []*ecdsa.PrivateKey{privKey1},
addrs: addrs,
indexOrder: []uint8{0},
result: true},
{label: "MultiUniqSignerMonotonicIndex",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey3},
addrs: addrs,
indexOrder: []uint8{0, 1, 2},
result: true},
{label: "MultiMisOrderedSignerMonotonicIndex",
keyOrder: []*ecdsa.PrivateKey{privKey3, privKey2, privKey1},
addrs: addrs,
indexOrder: []uint8{0, 1, 2}, result: false},
{label: "MultiUniqSignerNonMonotonic",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey3},
addrs: addrs,
indexOrder: []uint8{0, 2, 1},
result: false},
{label: "MultiUniqSignerFullSameIndex0",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey3},
addrs: addrs,
indexOrder: []uint8{0, 0, 0},
result: false},
{label: "MultiUniqSignerFullSameIndex1",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey3},
addrs: addrs,
indexOrder: []uint8{0, 0, 0},
result: false},
{label: "MultiUniqSignerPartialSameIndex",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey3},
addrs: addrs,
indexOrder: []uint8{0, 1, 1},
result: false},
{label: "MultiSameSignerPartialSameIndex",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey2},
addrs: addrs,
indexOrder: []uint8{0, 1, 1},
result: false},
{label: "MultiSameSignerNonMonotonic",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey2, privKey2},
addrs: addrs,
indexOrder: []uint8{0, 2, 1},
result: false},
{label: "MultiSameSignerFullSameIndex",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey1, privKey1},
addrs: addrs,
indexOrder: []uint8{0, 0, 0},
result: false},
{label: "MultiSameSignerMonotonic",
keyOrder: []*ecdsa.PrivateKey{privKey1, privKey1, privKey1},
addrs: addrs,
indexOrder: []uint8{0, 1, 2},
result: false},
}
for _, tc := range tests {
t.Run(tc.label, func(t *testing.T) {
vaa := getVaa()
for i, key := range tc.keyOrder {
vaa.AddSignature(key, tc.indexOrder[i])
}
assert.Equal(t, tc.result, vaa.VerifySignatures(tc.addrs))
})
}
}
func TestVerifySignaturesFuzz(t *testing.T) {
// Generate some random trusted private keys to sign with
privKey1, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey2, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey3, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
// Generate some random untrusted private keys to sign with
privKey4, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey5, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
privKey6, _ := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
// Give a fixed order of trusted addresses (we intentionally omit privKey4, privKey5, privKey6)
addrs := []common.Address{}
addrs = append(addrs, crypto.PubkeyToAddress(privKey1.PublicKey))
addrs = append(addrs, crypto.PubkeyToAddress(privKey2.PublicKey))
addrs = append(addrs, crypto.PubkeyToAddress(privKey3.PublicKey))
// key space for fuzz tests
keys := []*ecdsa.PrivateKey{}
keys = append(keys, privKey1)
keys = append(keys, privKey2)
keys = append(keys, privKey3)
keys = append(keys, privKey4)
keys = append(keys, privKey5)
keys = append(keys, privKey6)
// index space for fuzz tests
indexes := []uint8{0, 1, 2, 3, 4, 5}
type test struct {
label string
keyOrder []*ecdsa.PrivateKey
addrs []common.Address
indexOrder []uint8
result bool
}
type allow struct {
keyPair []*ecdsa.PrivateKey
indexPair []uint8
}
// Known good cases where we should have a verified result for
allows := []allow{
{keyPair: []*ecdsa.PrivateKey{}, indexPair: []uint8{}},
{keyPair: []*ecdsa.PrivateKey{privKey1}, indexPair: []uint8{0}},
{keyPair: []*ecdsa.PrivateKey{privKey2}, indexPair: []uint8{1}},
{keyPair: []*ecdsa.PrivateKey{privKey3}, indexPair: []uint8{2}},
{keyPair: []*ecdsa.PrivateKey{privKey1, privKey2}, indexPair: []uint8{0, 1}},
{keyPair: []*ecdsa.PrivateKey{privKey1, privKey3}, indexPair: []uint8{0, 2}},
{keyPair: []*ecdsa.PrivateKey{privKey2, privKey3}, indexPair: []uint8{1, 2}},
{keyPair: []*ecdsa.PrivateKey{privKey1, privKey2, privKey3}, indexPair: []uint8{0, 1, 2}},
}
tests := []test{}
keyPairs := [][]*ecdsa.PrivateKey{}
indexPairs := [][]uint8{}
// Build empty keyPair
keyPairs = append(keyPairs, []*ecdsa.PrivateKey{})
// Build single keyPairs
for _, key := range keys {
keyPairs = append(keyPairs, []*ecdsa.PrivateKey{key})
}
// Build double keyPairs
for _, key_i := range keys {
for _, key_j := range keys {
keyPairs = append(keyPairs, []*ecdsa.PrivateKey{key_i, key_j})
}
}
// Build triple keyPairs
for _, key_i := range keys {
for _, key_j := range keys {
for _, key_k := range keys {
keyPairs = append(keyPairs, []*ecdsa.PrivateKey{key_i, key_j, key_k})
}
}
}
// Build empty indexPairs
indexPairs = append(indexPairs, []uint8{})
// Build single indexPairs
for _, ind := range indexes {
indexPairs = append(indexPairs, []uint8{ind})
}
// Build double indexPairs
for _, ind_i := range indexes {
for _, ind_j := range indexes {
indexPairs = append(indexPairs, []uint8{ind_i, ind_j})
}
}
// Build triple keyPairs
for _, ind_i := range indexes {
for _, ind_j := range indexes {
for _, ind_k := range indexes {
indexPairs = append(indexPairs, []uint8{ind_i, ind_j, ind_k})
}
}
}
// Build out the fuzzTest cases
for _, keyPair := range keyPairs {
for _, indexPair := range indexPairs {
if len(keyPair) == len(indexPair) {
result := false
for _, allow := range allows {
if reflect.DeepEqual(allow.indexPair, indexPair) && reflect.DeepEqual(allow.keyPair, keyPair) {
result = true
break
}
}
test := test{label: "A", keyOrder: keyPair, addrs: addrs, indexOrder: indexPair, result: result}
tests = append(tests, test)
}
}
}
// Run the fuzzTest cases
for _, tc := range tests {
t.Run(tc.label, func(t *testing.T) {
vaa := getVaa()
for i, key := range tc.keyOrder {
vaa.AddSignature(key, tc.indexOrder[i])
}
/* Fuzz Debugging
* Tell us what keys and indexes were used (for debug when/if we have a failure case)
*/
if vaa.VerifySignatures(tc.addrs) != tc.result {
if len(tc.keyOrder) == 0 {
t.Logf("Key Order %v\n", tc.keyOrder)
} else {
keyIndex := []uint8{}
for i, key_i := range keys {
for _, key_k := range tc.keyOrder {
if key_i == key_k {
keyIndex = append(keyIndex, uint8(i))
}
}
}
t.Logf("Key Order %v\n", keyIndex)
}
t.Logf("Index Order %v\n", tc.indexOrder)
}
assert.Equal(t, tc.result, vaa.VerifySignatures(tc.addrs))
})
}
}
func TestStringToAddress(t *testing.T) {
expected := Address{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4}
addr, err := StringToAddress("0000000000000000000000000000000000000000000000000000000000000004")
assert.Nil(t, err)
assert.Equal(t, expected, addr)
}