lbcd/btcec
Dave Collins 3942a116e4 docs: Make various README.md files consistent.
First, it removes the documentation section from all the README.md files
and instead puts a web-based godoc badge and link at the top with the
other badges.  This is being done since the local godoc tool no longer
ships with Go by default, so the instructions no longer work without
first installing godoc. Due to this, pretty much everyone uses the
web-based godoc these days anyways.  Anyone who has manually installed
godoc won't need instructions.

Second, it makes sure the ISC license badge is at the top with the other
badges and removes the textual reference in the overview section.

Finally, it's modifies the Installation section to Installation and
Updating and adds a '-u' to the 'go get' command since it works for both
and thus is simpler.
2015-10-23 14:51:36 -05:00
..
bench_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
btcec.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
btcec_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
ciphering.go Mitigate timing attacks while using btcec.Decrypt. 2015-05-25 16:42:43 +05:30
ciphering_test.go Added ECDH and encryption/decryption support 2015-05-19 23:48:33 +05:30
doc.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
example_test.go Added ECDH and encryption/decryption support 2015-05-19 23:48:33 +05:30
field.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
field_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -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
internal_test.go Added ECDH and encryption/decryption support 2015-05-19 23:48:33 +05:30
precompute.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
privkey.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
privkey_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
pubkey.go Added ECDH and encryption/decryption support 2015-05-19 23:48:33 +05:30
pubkey_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
README.md docs: Make various README.md files consistent. 2015-10-23 14:51:36 -05:00
secp256k1.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
signature.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
signature_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00

btcec

[Build Status] (https://travis-ci.org/btcsuite/btcec) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [GoDoc] (http://godoc.org/github.com/btcsuite/btcd/btcec)

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

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.