Browse Source
crypto: add sr25519 signature scheme (#4190)
* sr25519 * added amino encoding * fixed dependencies * Apply suggestions from code review Co-Authored-By: Tess Rinearson <tess.rinearson@gmail.com> Co-Authored-By: Marko <marbar3778@yahoo.com> * file structure * Apply suggestions from code review Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * address @melekes and @marbar3778 review * removed nolint * CHANGELOG and go-schnorrkel mod updatepull/4221/head
Sunny Aggarwal
5 years ago
committed by
Marko
Marko
12 changed files with 322 additions and 4 deletions
Split View
Diff Options
-
+1 -0CHANGELOG_PENDING.md
-
+6 -4crypto/README.md
-
+6 -0crypto/encoding/amino/amino.go
-
+11 -0crypto/encoding/amino/encode_test.go
-
+26 -0crypto/sr25519/bench_test.go
-
+29 -0crypto/sr25519/codec.go
-
+99 -0crypto/sr25519/privkey.go
-
+72 -0crypto/sr25519/pubkey.go
-
+31 -0crypto/sr25519/sr25519_test.go
-
+3 -0go.mod
-
+22 -0go.sum
-
+16 -0types/protobuf.go
+ 1
- 0
CHANGELOG_PENDING.md
View File
+ 6
- 4
crypto/README.md
View File
+ 6
- 0
crypto/encoding/amino/amino.go
View File
+ 11
- 0
crypto/encoding/amino/encode_test.go
View File
+ 26
- 0
crypto/sr25519/bench_test.go
View File
| @ -0,0 +1,26 @@ | |||
| package sr25519 | |||
| import ( | |||
| "io" | |||
| "testing" | |||
| "github.com/tendermint/tendermint/crypto" | |||
| "github.com/tendermint/tendermint/crypto/internal/benchmarking" | |||
| ) | |||
| func BenchmarkKeyGeneration(b *testing.B) { | |||
| benchmarkKeygenWrapper := func(reader io.Reader) crypto.PrivKey { | |||
| return genPrivKey(reader) | |||
| } | |||
| benchmarking.BenchmarkKeyGeneration(b, benchmarkKeygenWrapper) | |||
| } | |||
| func BenchmarkSigning(b *testing.B) { | |||
| priv := GenPrivKey() | |||
| benchmarking.BenchmarkSigning(b, priv) | |||
| } | |||
| func BenchmarkVerification(b *testing.B) { | |||
| priv := GenPrivKey() | |||
| benchmarking.BenchmarkVerification(b, priv) | |||
| } | |||
+ 29
- 0
crypto/sr25519/codec.go
View File
| @ -0,0 +1,29 @@ | |||
| package sr25519 | |||
| import ( | |||
| amino "github.com/tendermint/go-amino" | |||
| "github.com/tendermint/tendermint/crypto" | |||
| ) | |||
| var _ crypto.PrivKey = PrivKeySr25519{} | |||
| const ( | |||
| PrivKeyAminoName = "tendermint/PrivKeySr25519" | |||
| PubKeyAminoName = "tendermint/PubKeySr25519" | |||
| // SignatureSize is the size of an Edwards25519 signature. Namely the size of a compressed | |||
| // Sr25519 point, and a field element. Both of which are 32 bytes. | |||
| SignatureSize = 64 | |||
| ) | |||
| var cdc = amino.NewCodec() | |||
| func init() { | |||
| cdc.RegisterInterface((*crypto.PubKey)(nil), nil) | |||
| cdc.RegisterConcrete(PubKeySr25519{}, | |||
| PubKeyAminoName, nil) | |||
| cdc.RegisterInterface((*crypto.PrivKey)(nil), nil) | |||
| cdc.RegisterConcrete(PrivKeySr25519{}, | |||
| PrivKeyAminoName, nil) | |||
| } | |||
+ 99
- 0
crypto/sr25519/privkey.go
View File
| @ -0,0 +1,99 @@ | |||
| package sr25519 | |||
| import ( | |||
| "crypto/subtle" | |||
| "fmt" | |||
| "io" | |||
| "github.com/tendermint/tendermint/crypto" | |||
| schnorrkel "github.com/ChainSafe/go-schnorrkel" | |||
| ) | |||
| // PrivKeySr25519Size is the number of bytes in an Sr25519 private key. | |||
| const PrivKeySr25519Size = 32 | |||
| // PrivKeySr25519 implements crypto.PrivKey. | |||
| type PrivKeySr25519 [PrivKeySr25519Size]byte | |||
| // Bytes marshals the privkey using amino encoding. | |||
| func (privKey PrivKeySr25519) Bytes() []byte { | |||
| return cdc.MustMarshalBinaryBare(privKey) | |||
| } | |||
| // Sign produces a signature on the provided message. | |||
| func (privKey PrivKeySr25519) Sign(msg []byte) ([]byte, error) { | |||
| secretKey := &(schnorrkel.SecretKey{}) | |||
| err := secretKey.Decode(privKey) | |||
| if err != nil { | |||
| return []byte{}, err | |||
| } | |||
| signingContext := schnorrkel.NewSigningContext([]byte{}, msg) | |||
| sig, err := secretKey.Sign(signingContext) | |||
| if err != nil { | |||
| return []byte{}, err | |||
| } | |||
| sigBytes := sig.Encode() | |||
| return sigBytes[:], nil | |||
| } | |||
| // PubKey gets the corresponding public key from the private key. | |||
| func (privKey PrivKeySr25519) PubKey() crypto.PubKey { | |||
| secretKey := &(schnorrkel.SecretKey{}) | |||
| err := secretKey.Decode(privKey) | |||
| if err != nil { | |||
| panic(fmt.Sprintf("Invalid private key: %v", err)) | |||
| } | |||
| pubkey, _ := secretKey.Public() | |||
| return PubKeySr25519(pubkey.Encode()) | |||
| } | |||
| // Equals - you probably don't need to use this. | |||
| // Runs in constant time based on length of the keys. | |||
| func (privKey PrivKeySr25519) Equals(other crypto.PrivKey) bool { | |||
| if otherEd, ok := other.(PrivKeySr25519); ok { | |||
| return subtle.ConstantTimeCompare(privKey[:], otherEd[:]) == 1 | |||
| } else { | |||
| return false | |||
| } | |||
| } | |||
| // GenPrivKey generates a new sr25519 private key. | |||
| // It uses OS randomness in conjunction with the current global random seed | |||
| // in tendermint/libs/common to generate the private key. | |||
| func GenPrivKey() PrivKeySr25519 { | |||
| return genPrivKey(crypto.CReader()) | |||
| } | |||
| // genPrivKey generates a new sr25519 private key using the provided reader. | |||
| func genPrivKey(rand io.Reader) PrivKeySr25519 { | |||
| var seed [64]byte | |||
| out := make([]byte, 64) | |||
| _, err := io.ReadFull(rand, out) | |||
| if err != nil { | |||
| panic(err) | |||
| } | |||
| copy(seed[:], out) | |||
| return schnorrkel.NewMiniSecretKey(seed).ExpandEd25519().Encode() | |||
| } | |||
| // GenPrivKeyFromSecret hashes the secret with SHA2, and uses | |||
| // that 32 byte output to create the private key. | |||
| // NOTE: secret should be the output of a KDF like bcrypt, | |||
| // if it's derived from user input. | |||
| func GenPrivKeyFromSecret(secret []byte) PrivKeySr25519 { | |||
| seed := crypto.Sha256(secret) // Not Ripemd160 because we want 32 bytes. | |||
| var bz [PrivKeySr25519Size]byte | |||
| copy(bz[:], seed) | |||
| privKey, _ := schnorrkel.NewMiniSecretKeyFromRaw(bz) | |||
| return privKey.ExpandEd25519().Encode() | |||
| } | |||
+ 72
- 0
crypto/sr25519/pubkey.go
View File
| @ -0,0 +1,72 @@ | |||
| package sr25519 | |||
| import ( | |||
| "bytes" | |||
| "fmt" | |||
| "github.com/tendermint/tendermint/crypto" | |||
| "github.com/tendermint/tendermint/crypto/tmhash" | |||
| schnorrkel "github.com/ChainSafe/go-schnorrkel" | |||
| ) | |||
| var _ crypto.PubKey = PubKeySr25519{} | |||
| // PubKeySr25519Size is the number of bytes in an Sr25519 public key. | |||
| const PubKeySr25519Size = 32 | |||
| // PubKeySr25519 implements crypto.PubKey for the Sr25519 signature scheme. | |||
| type PubKeySr25519 [PubKeySr25519Size]byte | |||
| // Address is the SHA256-20 of the raw pubkey bytes. | |||
| func (pubKey PubKeySr25519) Address() crypto.Address { | |||
| return crypto.Address(tmhash.SumTruncated(pubKey[:])) | |||
| } | |||
| // Bytes marshals the PubKey using amino encoding. | |||
| func (pubKey PubKeySr25519) Bytes() []byte { | |||
| bz, err := cdc.MarshalBinaryBare(pubKey) | |||
| if err != nil { | |||
| panic(err) | |||
| } | |||
| return bz | |||
| } | |||
| func (pubKey PubKeySr25519) VerifyBytes(msg []byte, sig []byte) bool { | |||
| // make sure we use the same algorithm to sign | |||
| if len(sig) != SignatureSize { | |||
| return false | |||
| } | |||
| var sig64 [SignatureSize]byte | |||
| copy(sig64[:], sig) | |||
| publicKey := &(schnorrkel.PublicKey{}) | |||
| err := publicKey.Decode(pubKey) | |||
| if err != nil { | |||
| return false | |||
| } | |||
| signingContext := schnorrkel.NewSigningContext([]byte{}, msg) | |||
| signature := &(schnorrkel.Signature{}) | |||
| err = signature.Decode(sig64) | |||
| if err != nil { | |||
| return false | |||
| } | |||
| return publicKey.Verify(signature, signingContext) | |||
| } | |||
| func (pubKey PubKeySr25519) String() string { | |||
| return fmt.Sprintf("PubKeySr25519{%X}", pubKey[:]) | |||
| } | |||
| // Equals - checks that two public keys are the same time | |||
| // Runs in constant time based on length of the keys. | |||
| func (pubKey PubKeySr25519) Equals(other crypto.PubKey) bool { | |||
| if otherEd, ok := other.(PubKeySr25519); ok { | |||
| return bytes.Equal(pubKey[:], otherEd[:]) | |||
| } else { | |||
| return false | |||
| } | |||
| } | |||
+ 31
- 0
crypto/sr25519/sr25519_test.go
View File
| @ -0,0 +1,31 @@ | |||
| package sr25519_test | |||
| import ( | |||
| "testing" | |||
| "github.com/stretchr/testify/assert" | |||
| "github.com/stretchr/testify/require" | |||
| "github.com/tendermint/tendermint/crypto" | |||
| "github.com/tendermint/tendermint/crypto/sr25519" | |||
| ) | |||
| func TestSignAndValidateSr25519(t *testing.T) { | |||
| privKey := sr25519.GenPrivKey() | |||
| pubKey := privKey.PubKey() | |||
| msg := crypto.CRandBytes(128) | |||
| sig, err := privKey.Sign(msg) | |||
| require.Nil(t, err) | |||
| // Test the signature | |||
| assert.True(t, pubKey.VerifyBytes(msg, sig)) | |||
| assert.True(t, pubKey.VerifyBytes(msg, sig)) | |||
| // Mutate the signature, just one bit. | |||
| // TODO: Replace this with a much better fuzzer, tendermint/ed25519/issues/10 | |||
| sig[7] ^= byte(0x01) | |||
| assert.False(t, pubKey.VerifyBytes(msg, sig)) | |||
| } | |||