lbcd/btcec
Dave Collins 1238b7e55a
btcec: Optimize and correct normalize.
This modifies the normalize function of the internal field value to
both optimize it and address an issue where the reduction could
lead to an incorrect result with a small range of values.  It also adds
tests to ensure the behavior is correct.

The following benchmark shows the relative speedups as a result of the
optimization on my system.  In particular, the changes result in
approximately a 14% speedup in Normalize, which ultimately translates to
a 2% speedup in signature verifies.

benchmark                        old ns/op     new ns/op     delta
--------------------------------------------------------------------
BenchmarkAddJacobian             1364          1289          -5.50%
BenchmarkAddJacobianNotZOne      3150          3091          -1.87%
BenchmarkScalarBaseMult          134117        132816        -0.97%
BenchmarkScalarBaseMultLarge     135067        132966        -1.56%
BenchmarkScalarMult              411218        402217        -2.19%
BenchmarkSigVerify               671585        657833        -2.05%
BenchmarkFieldNormalize          36.0          31.0          -13.89%
2017-06-07 20:43:36 -05:00
..
bench_test.go btcec: Add benchmark for field normalization. 2017-06-07 20:43:27 -05:00
btcec.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
btcec_test.go btcec: Consolidate tests into the btcec package. 2016-10-19 00:55:23 -05:00
ciphering.go Bump up copyright. Reflect recent update. (#699) 2016-05-22 23:22:42 -05:00
ciphering_test.go btcec: Consolidate tests into the btcec package. 2016-10-19 00:55:23 -05:00
doc.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
example_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
field.go btcec: Optimize and correct normalize. 2017-06-07 20:43:36 -05:00
field_test.go btcec: Optimize and correct normalize. 2017-06-07 20:43:36 -05:00
genprecomps.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
gensecp256k1.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
precompute.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
privkey.go Change copyright date for code that was updated this year(2016). 2016-01-07 09:01:51 -07:00
privkey_test.go btcec: Consolidate tests into the btcec package. 2016-10-19 00:55:23 -05:00
pubkey.go Unassign some TODO's 2016-11-15 17:47:33 -06:00
pubkey_test.go btcec: Consolidate tests into the btcec package. 2016-10-19 00:55:23 -05:00
README.md multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
secp256k1.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
signature.go multi: Simplify code per gosimple linter. 2017-03-22 15:34:13 -05:00
signature_test.go mining: drop getwork support. 2017-01-11 13:51:57 -05:00

btcec

Build Status ISC License GoDoc

Package btcec implements elliptic curve cryptography needed for working with Bitcoin (secp256k1 only for now). It is designed so that it may be used with the standard crypto/ecdsa packages provided with go. A comprehensive suite of test is provided to ensure proper functionality. Package btcec was originally based on work from ThePiachu which is licensed under the same terms as Go, but it has signficantly diverged since then. The btcsuite developers original is licensed under the liberal ISC license.

Although this package was primarily written for btcd, it has intentionally been designed so it can be used as a standalone package for any projects needing to use secp256k1 elliptic curve cryptography.

Installation and Updating

$ go get -u github.com/btcsuite/btcd/btcec

Examples

  • Sign Message
    Demonstrates signing a message with a secp256k1 private key that is first parsed form raw bytes and serializing the generated signature.

  • Verify Signature
    Demonstrates verifying a secp256k1 signature against a public key that is first parsed from raw bytes. The signature is also parsed from raw bytes.

  • Encryption Demonstrates encrypting a message for a public key that is first parsed from raw bytes, then decrypting it using the corresponding private key.

  • Decryption Demonstrates decrypting a message using a private key that is first parsed from raw bytes.

GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from the btcsuite developers. To verify the signature perform the following:

  • Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt

  • Import the public key into your GPG keyring:

    gpg --import GIT-GPG-KEY-conformal.txt
    
  • Verify the release tag with the following command where TAG_NAME is a placeholder for the specific tag:

    git tag -v TAG_NAME
    

License

Package btcec is licensed under the copyfree ISC License except for btcec.go and btcec_test.go which is under the same license as Go.