feat: ADR-036: Arbitrary Message Signature Specification

docs/architecture/adr-036-arbitrary-signature.md

@@ -0,0 +1,128 @@
+# ADR 036: Arbitrary Message Signature Specification
+
+## Changelog
+
+- 28/10/2020 - Initial draft
+
+## Authors
+- Antoine Herzog (@antoineherzog)
+- Zaki Manian (@zmanian)
+- Aleksandr Bezobchuk (alexanderbez) [1]
+- Frojdi Dymylja (@fdymylja)
+
+## Status
+
+Draft
+
+## Abstract
+
+Currently, in the SDK, there is no convention to sign arbitrary message like on Ethereum. We propose with this specification, for Cosmos SDK ecosystem, a way to sign and validate off-chain arbitrary messages.
+
+This specification serves the purpose of covering every use case, this means that cosmos-sdk applications developers decide how to serialize and represent `Data` to users. 
+## Context
+
+Having the ability to sign messages off-chain has proven to be a fundamental aspect of nearly any blockchain. The notion of signing messages off-chain has many added benefits such as saving on computational costs and reducing transaction throughput and overhead. Within the context of the Cosmos, some of the major applications of signing such data includes, but is not limited to, providing a cryptographic secure and verifiable means of proving validator identity and possibly associating it with some other framework or organization. In addition, having the ability to sign Cosmos messages with a Ledger or similar HSM device.
+
+Further context and use cases can be found in the references links.
+
+## Decision
+
+The aim is being able to sign arbitrary messages, even using Ledger or similar HSM devices.
+
+As a result signed messages should look roughly like Cosmos SDK messages but **must not** be a valid on-chain transaction. `chain-id`, `account_number` and `sequence` can all be assigned invalid values.
+
+Cosmos SDK 0.40 also introduces a concept of “auth_info” this can specify SIGN_MODES.
+
+A spec should include an `auth_info` that supports SIGN_MODE_DIRECT and SIGN_MODE_LEGACY_AMINO.
+
+Create the `offchain` proto definitions, we extend the auth module with `offchain` package to offer functionalities to verify and sign offline messages.
+
+An offchain transaction follows these rules:
+
+- the memo must be empty
+- nonce, sequence number must be equal to 0
+- chain-id must be equal to “”
+- fee gas must be equal to 0
+- fee amount must be an empty array
+
+Verification of an offchain transaction follows the same rules as an onchain one, except for the spec differences highlighted above.
+
+The first message added to the `offchain` package is `MsgSignData`.
+
+`MsgSignData` allows developers to sign arbitrary bytes valid offchain only. Where `Signer` is the account address of the signer. `Data` is arbitrary bytes which can represent `text`, `files`, `object`s. It's applications developers decision how `Data` should be deserialized, serialized and the object it can represent in their context.
+
+It's applications developers decision how `Data` should be treated, by treated we mean the serialization and deserialization process and the Object `Data` should represent. 
+
+
+Proto definition:
+```proto
+// MsgSignData defines an arbitrary, general-purpose, off-chain message
+message MsgSignData {
+    // Signer is the sdk.AccAddress of the message signer
+    bytes Signer = 1 [(gogoproto.jsontag) = "signer", (gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
+    // Data represents the raw bytes of the content that is signed (text, json, etc)
+    bytes Data = 2 [(gogoproto.jsontag) = "data"];
+}
+```
+Signed MsgSignData json example:
+```json
+{
+  "type": "cosmos-sdk/StdTx",
+  "value": {
+    "msg": [
+      {
+        "type": "sign/MsgSignData",
+        "value": {
+          "signer": "cosmos1hftz5ugqmpg9243xeegsqqav62f8hnywsjr4xr",
+          "data": "cmFuZG9t"
+        }
+      }
+    ],
+    "fee": {
+      "amount": [],
+      "gas": "0"
+    },
+    "signatures": [
+      {
+        "pub_key": {
+          "type": "tendermint/PubKeySecp256k1",
+          "value": "AqnDSiRoFmTPfq97xxEb2VkQ/Hm28cPsqsZm9jEVsYK9"
+        },
+        "signature": "8y8i34qJakkjse9pOD2De+dnlc4KvFgh0wQpes4eydN66D9kv7cmCEouRrkka9tlW9cAkIL52ErB+6ye7X5aEg=="
+      }
+    ],
+    "memo": ""
+  }
+}
+```
+
+## Consequences
+
+There is a specification on how messages, that are not meant to be broadcast to a live chain, should be formed. 
+
+### Backwards Compatibility
+
+Backwards compatibility is maintained as this is a new message spec definition.
+
+### Positive
+
+- A common format that can be used by multiple applications to sign and verify off-chain messages.
+- The specification is primitive which means it can cover every use case without limiting what is possible to fit inside it.
+- It gives room for other off-chain messages specifications that aim to target more specific and common use cases such as off-chain-based authN/authZ layers [2].
+
+### Negative
+
+- Current proposal requires a fixed relationship between an account address and a public key.
+- Doesn't work with multisig accounts.
+
+## Further discussion
+
+- Regarding security in `MsgSignData`, the developer using `MsgSignData` is in charge of making the content laying in `Data` non-replayable when, and if, needed.
+- the offchain package will be further extended with extra messages that target specific use cases such as, but not limited to, authentication in applications, payment channels, L2 solutions in general.
+
+## References
+
+1. https://github.com/cosmos/ics/pull/33
+2. https://github.com/cosmos/cosmos-sdk/pull/7727#discussion_r515668204
+3. https://github.com/cosmos/cosmos-sdk/pull/7727#issuecomment-722478477
+4. https://github.com/cosmos/cosmos-sdk/pull/7727#issuecomment-721062923

go.mod

@@ -55,4 +55,4 @@ require (
 	gopkg.in/yaml.v2 v2.3.0
 )
 
-replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.2-alpha.regen.4
+replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.2-alpha.regen.4

go.sum

@@ -877,4 +877,4 @@ honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWh
 honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
 rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
 sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o=
-sourcegraph.com/sourcegraph/appdash v0.0.0-20190731080439-ebfcffb1b5c0/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU=
+sourcegraph.com/sourcegraph/appdash v0.0.0-20190731080439-ebfcffb1b5c0/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU=

proto/cosmos/offchain/v1alpha1/offchain.proto

@@ -0,0 +1,15 @@
+syntax="proto3";
+
+package cosmos.offchain.v1alpha1;
+
+option go_package="github.com/cosmos/cosmos-sdk/x/auth/offchain";
+
+import "gogoproto/gogo.proto";
+
+// MsgSignData defines an arbitrary, general-purpose, off-chain message
+message MsgSignData {
+    // signer is the bech32 representation of the signer's account address
+    string signer = 1;
+    // data represents the raw bytes of the content that is signed (text, json, etc)
+    bytes data = 2;
+}

x/auth/offchain/codec.go

@@ -0,0 +1,27 @@
+package offchain
+
+import (
+	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/codec/types"
+	cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+// ModuleCdc is the codec used by the module to serialize and deserialize data
+var ModuleCdc = codec.NewAminoCodec(amino)
+var amino = codec.NewLegacyAmino()
+
+// RegisterInterfaces adds offchain sdk.Msg types to the interface registry
+func RegisterInterfaces(ir types.InterfaceRegistry) {
+	ir.RegisterImplementations((*sdk.Msg)(nil), &MsgSignData{})
+}
+
+// RegisterLegacyAminoCodec registers amino's legacy codec
+func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
+	cdc.RegisterConcrete(&MsgSignData{}, "offchain/MsgSignData", nil)
+}
+
+func init() {
+	RegisterLegacyAminoCodec(amino)
+	cryptocodec.RegisterCrypto(amino)
+}

x/auth/offchain/offchain.go

@@ -0,0 +1,74 @@
+package offchain
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+)
+
+// interface implementation assertions
+var _ msg = &MsgSignData{}
+
+const (
+	// ExpectedChainID defines the chain id an off-chain message must have
+	ExpectedChainID = ""
+	// ExpectedAccountNumber defines the account number an off-chain message must have
+	ExpectedAccountNumber = 0
+	// ExpectedSequence defines the sequence number an off-chain message must have
+	ExpectedSequence = 0
+	// ExpectedRoute defines the route to use for sdk.Msg.ExpectedRoute() implementation for offchain messages
+	ExpectedRoute = "offchain"
+)
+
+// msg defines an off-chain msg this exists so that offchain verification
+// procedures are only applied to transactions lying in this package.
+// TODO: making this exported would allow external types to use the SignatureVerifier and Signer
+type msg interface {
+	sdk.Msg
+	offchain()
+}
+
+// NewMsgSignData is MsgSignData's constructor
+func NewMsgSignData(signer sdk.AccAddress, data []byte) *MsgSignData { // nolint
+	return &MsgSignData{
+		Signer: signer.String(),
+		Data:   data,
+	}
+}
+
+// sdk.Msg implementation
+
+func (m *MsgSignData) Route() string {
+	return ExpectedRoute
+}
+
+func (m *MsgSignData) Type() string {
+	return "MsgSignData"
+}
+
+func (m *MsgSignData) ValidateBasic() error {
+	signer, err := sdk.AccAddressFromBech32(m.Signer)
+	if err != nil {
+		return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "invalid signer: %s", err.Error())
+	}
+	if signer.Empty() {
+		return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "empty signer")
+	}
+	if len(m.Data) == 0 {
+		return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "empty data")
+	}
+	return nil
+}
+
+func (m *MsgSignData) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(m))
+}
+
+func (m *MsgSignData) GetSigners() []sdk.AccAddress {
+	signer, err := sdk.AccAddressFromBech32(m.Signer)
+	if err != nil {
+		panic(err)
+	}
+	return []sdk.AccAddress{signer}
+}
+
+func (m *MsgSignData) offchain() {}