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

Enforce solo machine signature type uniqueness #7394

Merged
merged 26 commits into from
Oct 1, 2020
Merged

Enforce solo machine signature type uniqueness #7394

Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d4f0c05
update solo machine proto types to use enum for uniqueness
colin-axner Sep 25, 2020
9c1f9cf
Merge branch 'master' of github.com:cosmos/cosmos-sdk into colin/7277…
colin-axner Sep 25, 2020
a68eef7
Merge branch 'master' of github.com:cosmos/cosmos-sdk into colin/7277…
colin-axner Sep 28, 2020
cf62ad4
move data type to SignatureAndData
colin-axner Sep 28, 2020
d513674
split signature bytes creation to allow for function reusing. Stuck o…
colin-axner Sep 29, 2020
a6c1d12
fix test bug
colin-axner Sep 29, 2020
72762c7
merge master
colin-axner Sep 29, 2020
9a46f1b
update UnmarshalByType and refactor misbehaviour handle
colin-axner Sep 30, 2020
e555694
Merge branch 'master' of github.com:cosmos/cosmos-sdk into colin/7277…
colin-axner Sep 30, 2020
69734d4
add tests to codec_test.go
colin-axner Sep 30, 2020
6e40696
self review + lint
colin-axner Sep 30, 2020
0d2aec6
update spec
colin-axner Sep 30, 2020
a53b041
fix lint
colin-axner Sep 30, 2020
72cf4ee
Merge branch 'master' into colin/7277-solo-uniqueness
colin-axner Sep 30, 2020
e67e578
Update x/ibc/light-clients/solomachine/spec/01_concepts.md
colin-axner Oct 1, 2020
3ef0d5c
increase code cov, update spec
colin-axner Oct 1, 2020
8136909
Merge branch 'colin/7277-solo-uniqueness' of github.com:cosmos/cosmos…
colin-axner Oct 1, 2020
65f9bbc
Merge branch 'master' of github.com:cosmos/cosmos-sdk into colin/7277…
colin-axner Oct 1, 2020
3e8e6c8
format spec
fedekunze Oct 1, 2020
e980068
format spec
fedekunze Oct 1, 2020
58e891c
merge master
colin-axner Oct 1, 2020
e918ae6
make proto
colin-axner Oct 1, 2020
774247b
fix merge conflicts
colin-axner Oct 1, 2020
6657213
merge master
colin-axner Oct 1, 2020
24c6473
make proto
colin-axner Oct 1, 2020
f501df7
fix conflicts
colin-axner Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 49 additions & 19 deletions proto/ibc/lightclients/solomachine/v1/solomachine.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ message ClientState {
message ConsensusState {
option (gogoproto.goproto_getters) = false;
// public key of the solo machine
google.protobuf.Any public_key = 1 [(gogoproto.moretags) = "yaml:\"public_key\""];
google.protobuf.Any public_key = 1 [(gogoproto.moretags) = "yaml:\"public_key\""];
// diversifier allows the same public key to be re-used across different solo machine clients
// (potentially on different chains) without being considered misbehaviour.
string diversifier = 2;
Expand All @@ -38,11 +38,11 @@ message ConsensusState {
message Header {
option (gogoproto.goproto_getters) = false;
// sequence to update solo machine public key at
uint64 sequence = 1;
uint64 timestamp = 2;
bytes signature = 3;
uint64 sequence = 1;
uint64 timestamp = 2;
bytes signature = 3;
google.protobuf.Any new_public_key = 4 [(gogoproto.moretags) = "yaml:\"new_public_key\""];
string new_diversifier = 5 [(gogoproto.moretags) = "yaml:\"new_diversifier\""];
string new_diversifier = 5 [(gogoproto.moretags) = "yaml:\"new_diversifier\""];
}

// Misbehaviour defines misbehaviour for a solo machine which consists
Expand All @@ -60,8 +60,9 @@ message Misbehaviour {
// signature.
message SignatureAndData {
option (gogoproto.goproto_getters) = false;
bytes signature = 1;
bytes data = 2;
bytes signature = 1;
DataType data_type = 2 [(gogoproto.moretags) = "yaml:\"data_type\""];
bytes data = 3;
}

// TimestampedSignature contains the signature and the timestamp of the
Expand All @@ -79,11 +80,40 @@ message SignBytes {
uint64 sequence = 1;
uint64 timestamp = 2;
string diversifier = 3;
// type of the data used
DataType data_type = 4 [(gogoproto.moretags) = "yaml:\"data_type\""];
// marshaled data
bytes data = 4;
}

// HeaderData returns the SignBytes data for misbehaviour verification.
bytes data = 5;
}

// DataType defines the type of solo machine proof being created. This is done to preserve uniqueness of different
// data sign byte encodings.
enum DataType {
option (gogoproto.goproto_enum_prefix) = false;

// Default State
DATA_TYPE_UNINITIALIZED_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "UNSPECIFIED"];
// Data type for client state verification
DATA_TYPE_CLIENT_STATE = 1 [(gogoproto.enumvalue_customname) = "CLIENT"];
// Data type for consensus state verification
DATA_TYPE_CONSENSUS_STATE = 2 [(gogoproto.enumvalue_customname) = "CONSENSUS"];
// Data type for connection state verification
DATA_TYPE_CONNECTION_STATE = 3 [(gogoproto.enumvalue_customname) = "CONNECTION"];
// Data type for channel state verification
DATA_TYPE_CHANNEL_STATE = 4 [(gogoproto.enumvalue_customname) = "CHANNEL"];
// Data type for packet commitment verification
DATA_TYPE_PACKET_COMMITMENT = 5 [(gogoproto.enumvalue_customname) = "PACKETCOMMITMENT"];
// Data type for packet acknowledgement verification
DATA_TYPE_PACKET_ACKNOWLEDGEMENT = 6 [(gogoproto.enumvalue_customname) = "PACKETACKNOWLEDGEMENT"];
// Data type for packet acknowledgement absence verification
DATA_TYPE_PACKET_ACKNOWLEDGEMENT_ABSENCE = 7 [(gogoproto.enumvalue_customname) = "PACKETACKNOWLEDGEMENTABSENCE"];
// Data type for next sequence recv verification
DATA_TYPE_NEXT_SEQUENCE_RECV = 8 [(gogoproto.enumvalue_customname) = "NEXTSEQUENCERECV"];
// Data type for header verification
DATA_TYPE_HEADER = 9 [(gogoproto.enumvalue_customname) = "HEADER"];
}

// HeaderData returns the SignBytes data for update verification.
message HeaderData {
option (gogoproto.goproto_getters) = false;

Expand All @@ -101,7 +131,7 @@ message ClientStateData {
google.protobuf.Any client_state = 2 [(gogoproto.moretags) = "yaml:\"client_state\""];
}

// ConsensusStateSignBytes returns the SignBytes data for consensus state
// ConsensusStateData returns the SignBytes data for consensus state
// verification.
message ConsensusStateData {
option (gogoproto.goproto_getters) = false;
Expand All @@ -110,7 +140,7 @@ message ConsensusStateData {
google.protobuf.Any consensus_state = 2 [(gogoproto.moretags) = "yaml:\"consensus_state\""];
}

// ConnectionStateSignBytes returns the SignBytes data for connection state
// ConnectionStateData returns the SignBytes data for connection state
// verification.
message ConnectionStateData {
option (gogoproto.goproto_getters) = false;
Expand All @@ -119,7 +149,7 @@ message ConnectionStateData {
ibc.connection.ConnectionEnd connection = 2;
}

// ChannelStateSignBytes returns the SignBytes data for channel state
// ChannelStateData returns the SignBytes data for channel state
// verification.
message ChannelStateData {
option (gogoproto.goproto_getters) = false;
Expand All @@ -128,27 +158,27 @@ message ChannelStateData {
ibc.channel.Channel channel = 2;
}

// PacketCommitmentSignBytes returns the SignBytes data for packet commitment
// PacketCommitmentData returns the SignBytes data for packet commitment
// verification.
message PacketCommitmentData {
bytes path = 1;
bytes commitment = 2;
}

// PacketAcknowledgementSignBytes returns the SignBytes data for acknowledgement
// PacketAcknowledgementData returns the SignBytes data for acknowledgement
// verification.
message PacketAcknowledgementData {
bytes path = 1;
bytes acknowledgement = 2;
}

// PacketAcknowledgementAbsenceSignBytes returns the SignBytes data for
// PacketAcknowledgementAbsenceData returns the SignBytes data for
// acknowledgement absence verification.
message PacketAcknowledgementAbsenseData {
message PacketAcknowledgementAbsenceData {
bytes path = 1;
}

// NextSequenceRecv returns the SignBytes data for verification of the next
// NextSequenceRecvData returns the SignBytes data for verification of the next
// sequence to be received.
message NextSequenceRecvData {
bytes path = 1;
Expand Down
29 changes: 18 additions & 11 deletions x/ibc/light-clients/solomachine/spec/01_concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@ order: 1

## Proofs

A solo machine proof should verify that the solomachine public key signed
A solo machine proof should verify that the solomachine public key signed
over some specified data. The format for generating marshaled proofs for
the SDK's implementation of solo machine is as follows:

Construct the data using the associated protobuf definition and marshal it.

For example:

```go
data := &ClientStateData{
Path: []byte(path.String()),
ClientState: any,
Path: []byte(path.String()),
ClientState: any,
}

dataBz, err := cdc.MarshalBinaryBare(data)
Expand All @@ -25,27 +26,32 @@ dataBz, err := cdc.MarshalBinaryBare(data)
Construct the `SignBytes` and marshal it.

For example:

```go
signBytes := &SignBytes{
Sequence: sequence,
Timestamp: timestamp,
Diversifier: diversifier,
Data: dataBz,
Sequence: sequence,
Timestamp: timestamp,
Diversifier: diversifier,
DataType: CLIENT,
Data: dataBz,
}

signBz, err := cdc.MarshalBinaryBare(signBytes)
```

The helper functions in [proofs.go](../types/proofs.go) handle the above actions.
The `DataType` field is used to disambiguate what type of data was signed because
of potential proto encoding overlap.

Sign the sign bytes. Embed the signatures into either `SingleSignatureData` or
`MultiSignatureData`. Convert the `SignatureData` to proto and marshal it.
`MultiSignatureData`. Convert the `SignatureData` to proto and marshal it

For example:

```go
sig, err := key.Sign(signBz)
sigData := &signing.SingleSignatureData{
Signature: sig,
Signature: sig,
}

protoSigData := signing.SignatureDataToProto(sigData)
Expand All @@ -56,10 +62,11 @@ Construct a `TimestampedSignature` and marshal it. The marshaled result can be
passed in as the proof parameter to the verification functions.

For example:

```go
timestampedSignature := &types.TimestampedSignature{
Signature: sig,
Timestamp: solomachine.Time,
Signature: sig,
Timestamp: solomachine.Time,
}

proof, err := cdc.MarshalBinaryBare(timestampedSignature)
Expand Down
29 changes: 9 additions & 20 deletions x/ibc/light-clients/solomachine/types/client_state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
connectiontypes "github.com/cosmos/cosmos-sdk/x/ibc/03-connection/types"
channeltypes "github.com/cosmos/cosmos-sdk/x/ibc/04-channel/types"
commitmenttypes "github.com/cosmos/cosmos-sdk/x/ibc/23-commitment/types"
host "github.com/cosmos/cosmos-sdk/x/ibc/24-host"
"github.com/cosmos/cosmos-sdk/x/ibc/exported"
"github.com/cosmos/cosmos-sdk/x/ibc/light-clients/solomachine/types"
ibctesting "github.com/cosmos/cosmos-sdk/x/ibc/testing"
Expand Down Expand Up @@ -85,10 +84,7 @@ func (suite *SoloMachineTestSuite) TestVerifyClientState() {
// create client for tendermint so we can use client state for verification
clientA, _ := suite.coordinator.SetupClients(suite.chainA, suite.chainB, ibctesting.Tendermint)
clientState := suite.chainA.GetClientState(clientA)

clientPrefixedPath := "clients/" + counterpartyClientIdentifier + "/" + host.ClientStatePath()
path, err := commitmenttypes.ApplyPrefix(prefix, clientPrefixedPath)
suite.Require().NoError(err)
path := suite.solomachine.GetClientStatePath(counterpartyClientIdentifier)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think ideally we abstract this in host for all path type's so the users doesn't need to call ApplyPrefix. I only abstracted this in solo machine because I started to write dup code and then figured I might as well do it for all path types


// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {
Expand Down Expand Up @@ -217,9 +213,7 @@ func (suite *SoloMachineTestSuite) TestVerifyClientConsensusState() {
consensusState, found := suite.chainA.GetConsensusState(clientA, clientState.GetLatestHeight())
suite.Require().True(found)

clientPrefixedPath := "clients/" + counterpartyClientIdentifier + "/" + host.ConsensusStatePath(consensusHeight)
path, err := commitmenttypes.ApplyPrefix(prefix, clientPrefixedPath)
suite.Require().NoError(err)
path := suite.solomachine.GetConsensusStatePath(counterpartyClientIdentifier, consensusHeight)

// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {
Expand Down Expand Up @@ -344,8 +338,7 @@ func (suite *SoloMachineTestSuite) TestVerifyConnectionState() {
counterparty := connectiontypes.NewCounterparty("clientB", testConnectionID, prefix)
conn := connectiontypes.NewConnectionEnd(connectiontypes.OPEN, "clientA", counterparty, []string{"1.0.0"})

path, err := commitmenttypes.ApplyPrefix(prefix, host.ConnectionPath(testConnectionID))
suite.Require().NoError(err)
path := suite.solomachine.GetConnectionStatePath(testConnectionID)

// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {
Expand Down Expand Up @@ -434,8 +427,7 @@ func (suite *SoloMachineTestSuite) TestVerifyChannelState() {
counterparty := channeltypes.NewCounterparty(testPortID, testChannelID)
ch := channeltypes.NewChannel(channeltypes.OPEN, channeltypes.ORDERED, counterparty, []string{testConnectionID}, "1.0.0")

path, err := commitmenttypes.ApplyPrefix(prefix, host.ChannelPath(testPortID, testChannelID))
suite.Require().NoError(err)
path := suite.solomachine.GetChannelStatePath(testPortID, testChannelID)

// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {
Expand Down Expand Up @@ -526,8 +518,7 @@ func (suite *SoloMachineTestSuite) TestVerifyPacketCommitment() {
// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {

path, err := commitmenttypes.ApplyPrefix(prefix, host.PacketCommitmentPath(testPortID, testChannelID, solomachine.Sequence))
suite.Require().NoError(err)
path := solomachine.GetPacketCommitmentPath(testPortID, testChannelID)

value, err := types.PacketCommitmentSignBytes(suite.chainA.Codec, solomachine.Sequence, solomachine.Time, solomachine.Diversifier, path, commitmentBytes)
suite.Require().NoError(err)
Expand Down Expand Up @@ -614,8 +605,7 @@ func (suite *SoloMachineTestSuite) TestVerifyPacketAcknowledgement() {
// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {

path, err := commitmenttypes.ApplyPrefix(prefix, host.PacketAcknowledgementPath(testPortID, testChannelID, solomachine.Sequence))
suite.Require().NoError(err)
path := solomachine.GetPacketAcknowledgementPath(testPortID, testChannelID)

value, err := types.PacketAcknowledgementSignBytes(suite.chainA.Codec, solomachine.Sequence, solomachine.Time, solomachine.Diversifier, path, ack)
suite.Require().NoError(err)
Expand Down Expand Up @@ -701,8 +691,8 @@ func (suite *SoloMachineTestSuite) TestVerifyPacketAcknowledgementAbsence() {
// test singlesig and multisig public keys
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {

path, err := commitmenttypes.ApplyPrefix(prefix, host.PacketAcknowledgementPath(testPortID, testChannelID, solomachine.Sequence))
suite.Require().NoError(err)
// absence uses acknowledgement path as well
path := solomachine.GetPacketAcknowledgementPath(testPortID, testChannelID)

value, err := types.PacketAcknowledgementAbsenceSignBytes(suite.chainA.Codec, solomachine.Sequence, solomachine.Time, solomachine.Diversifier, path)
suite.Require().NoError(err)
Expand Down Expand Up @@ -789,8 +779,7 @@ func (suite *SoloMachineTestSuite) TestVerifyNextSeqRecv() {
for _, solomachine := range []*ibctesting.Solomachine{suite.solomachine, suite.solomachineMulti} {

nextSeqRecv := solomachine.Sequence + 1
path, err := commitmenttypes.ApplyPrefix(prefix, host.NextSequenceRecvPath(testPortID, testChannelID))
suite.Require().NoError(err)
path := solomachine.GetNextSequenceRecvPath(testPortID, testChannelID)

value, err := types.NextSequenceRecvSignBytes(suite.chainA.Codec, solomachine.Sequence, solomachine.Time, solomachine.Diversifier, path, nextSeqRecv)
suite.Require().NoError(err)
Expand Down
Loading