Skip to content

Envelope signer / crypto abstractions #38

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

Closed
wants to merge 12 commits into from
Closed

Envelope signer / crypto abstractions #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7488e60
rename token.Store interface to token.BalanceStore
Jan 19, 2023
3c7cfc9
Merge branch 'hyperledger-labs:main' into main
vitiko Jan 22, 2023
57ecbe0
Merge branch 'hyperledger-labs:main' into main
vitiko Jan 23, 2023
8d4fac8
Merge branch 'hyperledger-labs:main' into main
vitiko Feb 9, 2023
f716d67
Merge branch 'hyperledger-labs:main' into main
vitiko Feb 12, 2023
ce9c538
Merge branch 'hyperledger-labs:main' into main
vitiko Feb 14, 2023
997b4ff
Merge branch 'hyperledger-labs:main' into main
vitiko Apr 24, 2023
f917c79
Merge branch 'hyperledger-labs:main' into main
vitiko Oct 15, 2023
1a6b6d8
label extesion
Oct 15, 2023
56fa9e2
label extesion
Oct 15, 2023
1eed720
Merge branch 'hyperledger-labs:main' into main
vitiko Oct 16, 2023
9cc17a8
crypto/signer abstractions
Jun 24, 2024
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
52 changes: 52 additions & 0 deletions extensions/envelope/crypto.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package envelope

import (
"crypto/ed25519"
"crypto/rand"
"crypto/sha256"
"fmt"
)

type Crypto interface {
GenerateKey() (publicKey, privateKey []byte, err error)
Hash([]byte) []byte
Sign(hash, privateKey []byte) ([]byte, error)
Verify([]byte) bool
PublicKey(privateKey []byte) ([]byte, error)
}

func NewEd25519() *Ed25519 {
return &Ed25519{}
}

type Ed25519 struct{}

func (ed *Ed25519) GenerateKey() (publicKey, privateKey []byte, err error) {
publicKey, privateKey, err = ed25519.GenerateKey(rand.Reader)
if err != nil {
return nil, nil, err
}
return publicKey, privateKey, nil
}

func (ed *Ed25519) Sign(hash, privateKey []byte) (signature []byte, err error) {
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("sign: %v", r)
}
}()
return ed25519.Sign(privateKey, hash), nil
}

func (ed *Ed25519) Hash(msg []byte) []byte {
h := sha256.Sum256(msg)
return h[:]
}

func (ed *Ed25519) Verify([]byte) bool {
return false
}

func (ed *Ed25519) PublicKey(privateKey []byte) ([]byte, error) {
return ed25519.PrivateKey(privateKey).Public().(ed25519.PublicKey), nil
}
28 changes: 19 additions & 9 deletions extensions/envelope/envelope.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions extensions/envelope/envelope.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ message Envelope {
string channel = 7;
string chaincode = 8;
string method = 9;
string signature_alg = 10;
}
74 changes: 39 additions & 35 deletions extensions/envelope/envelope_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"github.com/btcsuite/btcutil/base58"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
"google.golang.org/protobuf/types/known/timestamppb"

e "github.com/hyperledger-labs/cckit/extensions/envelope"
"github.com/hyperledger-labs/cckit/extensions/envelope/testdata"
Expand Down Expand Up @@ -38,12 +38,15 @@ var (
payload = []byte(`{"symbol":"GLD","decimals":"8","name":"Gold digital asset","type":"DM","underlying_asset":"gold","issuer_id":"GLDINC"}`)
)

var _ = Describe(`Envelop`, func() {
var _ = Describe(`Envelop with Ed25519`, func() {

ed25519 := e.NewEd25519()
signer := e.NewSigner(ed25519)

Describe("Signature methods", func() {

It("Allow to create keys", func() {
publicKey, privateKey, err := e.CreateKeys()
publicKey, privateKey, err := ed25519.GenerateKey()
Expect(err).NotTo(HaveOccurred())
Expect(len(publicKey)).To(Equal(32))
Expect(len(privateKey)).To(Equal(64))
Expand All @@ -59,34 +62,35 @@ var _ = Describe(`Envelop`, func() {
})

It("Allow to create signature", func() {
_, privateKey, _ := e.CreateKeys()
_, sig := e.CreateSig(payload, e.CreateNonce(), channel, chaincode, methodInvoke, deadline.String(), privateKey)
_, privateKey, _ := ed25519.GenerateKey()
sig, err := signer.Sign(payload, e.CreateNonce(), channel, chaincode, methodInvoke, deadline.String(), privateKey)
Expect(err).NotTo(HaveOccurred())
Expect(len(sig)).To(Equal(64))
})

It("Allow to check valid signature", func() {
nonce := e.CreateNonce()
publicKey, privateKey, _ := e.CreateKeys()
_, sig := e.CreateSig(payload, nonce, channel, chaincode, methodInvoke, deadline.String(), privateKey)
err := e.CheckSig(payload, nonce, channel, chaincode, methodInvoke, deadline.String(), publicKey, sig)
publicKey, privateKey, _ := ed25519.GenerateKey()
sig, err := signer.Sign(payload, nonce, channel, chaincode, methodInvoke, deadline.String(), privateKey)
Expect(err).NotTo(HaveOccurred())
err = signer.CheckSignature(payload, nonce, channel, chaincode, methodInvoke, deadline.String(), publicKey, sig)
Expect(err).NotTo(HaveOccurred())
})

It("Disallow to check signature with invalid payload", func() {
nonce := e.CreateNonce()
publicKey, privateKey, _ := e.CreateKeys()
_, sig := e.CreateSig(payload, nonce, channel, chaincode, methodInvoke, deadline.String(), privateKey)
publicKey, privateKey, _ := ed25519.GenerateKey()
sig, _ := signer.Sign(payload, nonce, channel, chaincode, methodInvoke, deadline.String(), privateKey)
invalidPayload := []byte("invalid payload")
err := e.CheckSig(invalidPayload, nonce, channel, chaincode, methodInvoke, deadline.String(), publicKey, sig)
err := signer.CheckSignature(invalidPayload, nonce, channel, chaincode, methodInvoke, deadline.String(), publicKey, sig)
Expect(err).Should(MatchError(e.ErrSignatureCheckFailed))
})

})

Describe("Handle base64 envelop", func() {

It("Allow to parse base64 envelop", func() {
_, envelope := createEnvelope(payload, channel, chaincode, methodInvoke, deadline)
_, envelope := createEnvelope(signer, payload, channel, chaincode, methodInvoke, deadline)
jj, _ := json.Marshal(envelope)
b64 := base64.StdEncoding.EncodeToString(jj)
bb, err := e.DecodeEnvelope([]byte(b64))
Expand All @@ -99,18 +103,18 @@ var _ = Describe(`Envelop`, func() {
Describe("Signature verification", func() {

It("Allow to verify valid signature", func() {
serializedEnvelope, _ := createEnvelope(payload, channel, chaincode, methodInvoke, deadline)
serializedEnvelope, _ := createEnvelope(signer, payload, channel, chaincode, methodInvoke, deadline)

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Invoke(methodInvoke, payload, serializedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 200))
})

It("Allow to verify valid signature without deadline", func() {
serializedEnvelope, _ := createEnvelope(payload, channel, chaincode, methodInvoke)
serializedEnvelope, _ := createEnvelope(signer, payload, channel, chaincode, methodInvoke)

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Invoke(methodInvoke, payload, serializedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 200))
Expand All @@ -122,7 +126,7 @@ var _ = Describe(`Envelop`, func() {
decodedEnvelope, err := e.DecodeEnvelope([]byte(b64Envelope))
Expect(err).NotTo(HaveOccurred())

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Invoke(methodInvoke, payload, decodedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 200))
Expand All @@ -134,42 +138,42 @@ var _ = Describe(`Envelop`, func() {
decodedEnvelope, err := e.DecodeEnvelope([]byte(b64Envelope))
Expect(err).NotTo(HaveOccurred())

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Invoke(methodInvoke, payload, decodedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 200))
})

It("Disallow to verify signature with invalid payload", func() {
serializedEnvelope, _ := createEnvelope(payload, channel, chaincode, methodInvoke, deadline)
serializedEnvelope, _ := createEnvelope(signer, payload, channel, chaincode, methodInvoke, deadline)

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
invalidPayload := []byte("invalid payload")
resp := envelopCC.Invoke(methodInvoke, invalidPayload, serializedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 500))
})

It("Disallow to verify signature with invalid method", func() {
serializedEnvelope, _ := createEnvelope(payload, channel, chaincode, "invalid method", deadline)
serializedEnvelope, _ := createEnvelope(signer, payload, channel, chaincode, "invalid method", deadline)

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Invoke(methodInvoke, payload, serializedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 500))
})

It("Disallow to verify signature with invalid channel", func() {
serializedEnvelope, _ := createEnvelope(payload, "invalid channel", chaincode, methodInvoke, deadline)
serializedEnvelope, _ := createEnvelope(signer, payload, "invalid channel", chaincode, methodInvoke, deadline)

envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Invoke(methodInvoke, payload, serializedEnvelope)

Expect(resp.Status).To(BeNumerically("==", 500))
})

It("Don't check signature for query method", func() {
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)
resp := envelopCC.Query(methodQuery, payload)

Expect(resp.Status).To(BeNumerically("==", 200))
Expand All @@ -179,12 +183,12 @@ var _ = Describe(`Envelop`, func() {

Describe("Nonce verification (replay attack)", func() {
It("Disallow to execute tx with the same parameters (nonce, payload, pubkey)", func() {
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(chaincode)).WithChannel(channel)
envelopCC = testcc.NewMockStub(chaincode, testdata.NewEnvelopCC(signer, chaincode)).WithChannel(channel)

publicKey, privateKey, _ := e.CreateKeys()
publicKey, privateKey, _ := ed25519.GenerateKey()
nonce := "thesamenonce"
hashToSign := e.Hash(payload, nonce, channel, chaincode, methodInvoke, deadline.AsTime().Format(e.TimeLayout), []byte(publicKey))
_, sig := e.CreateSig(payload, nonce, channel, chaincode, methodInvoke, deadline.AsTime().Format(e.TimeLayout), privateKey)
hashToSign := signer.Hash(payload, nonce, channel, chaincode, methodInvoke, deadline.AsTime().Format(e.TimeLayout), publicKey)
sig, _ := signer.Sign(payload, nonce, channel, chaincode, methodInvoke, deadline.AsTime().Format(e.TimeLayout), privateKey)
envelope := &e.Envelope{
PublicKey: base58.Encode([]byte(publicKey)),
Signature: base58.Encode(sig),
Expand All @@ -209,8 +213,8 @@ var _ = Describe(`Envelop`, func() {

})

func createEnvelope(payload []byte, channel, chaincode, method string, deadline ...*timestamppb.Timestamp) ([]byte, *e.Envelope) {
publicKey, privateKey, _ := e.CreateKeys()
func createEnvelope(signer *e.Signer, payload []byte, channel, chaincode, method string, deadline ...*timestamppb.Timestamp) ([]byte, *e.Envelope) {
publicKey, privateKey, _ := e.NewEd25519().GenerateKey()
nonce := e.CreateNonce()

envelope := &e.Envelope{
Expand All @@ -226,10 +230,10 @@ func createEnvelope(payload []byte, channel, chaincode, method string, deadline
envelope.Deadline = deadline[0]
formatDeadline = envelope.Deadline.AsTime().Format(e.TimeLayout)
}
hashToSign := e.Hash(payload, nonce, channel, chaincode, method, formatDeadline, publicKey)
envelope.HashToSign = base58.Encode(hashToSign[:])
hashToSign := signer.Hash(payload, nonce, channel, chaincode, method, formatDeadline, publicKey)
envelope.HashToSign = base58.Encode(hashToSign)

_, sig := e.CreateSig(payload, nonce, channel, chaincode, method, formatDeadline, privateKey)
sig, _ := signer.Sign(payload, nonce, channel, chaincode, method, formatDeadline, privateKey)
envelope.Signature = base58.Encode(sig)

serializedEnvelope, _ := serialize.PreferJSONSerializer.ToBytesFrom(envelope)
Expand Down
Loading