An alternative full node implementation of LBRY's blockchain written in Go (golang)

Go to file

Dave Collins 85ac6b06f7 Make NewFieldVal only avilable to the test package. Since the function was only exported for use by the test package (and was commented as such), just move it into the internal_test.go file so it is only available when the tests run.		2013-12-20 19:19:02 -06:00
.gitignore	Initial commit.	2013-06-13 12:45:48 -05:00
btcec.go	Significantly optimize signature verification.	2013-12-20 15:07:15 -06:00
btcec_test.go	Add field and point addition/multiplicaiton tests.	2013-12-20 15:09:58 -06:00
cov_report.sh	Initial implementation.	2013-06-13 14:38:54 -05:00
doc.go	Initial implementation.	2013-06-13 14:38:54 -05:00
field.go	Make NewFieldVal only avilable to the test package.	2013-12-20 19:19:02 -06:00
field_test.go	Add field and point addition/multiplicaiton tests.	2013-12-20 15:09:58 -06:00
internal_test.go	Make NewFieldVal only avilable to the test package.	2013-12-20 19:19:02 -06:00
LICENSE	Initial implementation.	2013-06-13 14:38:54 -05:00
pubkey.go	Add padding for pubkey numbers.	2013-11-04 10:11:11 -05:00
pubkey_test.go	add test for testing IsOnCurve	2013-11-04 14:42:21 -05:00
README.md	Initial implementation.	2013-06-13 14:38:54 -05:00
signature.go	Add ParseDERSignature.	2013-10-25 15:09:48 -04:00
signature_test.go	Add ParseDERSignature.	2013-10-25 15:09:48 -04:00
test_coverage.txt	Add field and point addition/multiplicaiton tests.	2013-12-20 15:09:58 -06:00

README.md

btcec

Package btcec implements elliptic curve cryptography using koblitz curves (secp256k1 only for now). It is designed so that it may be used with the standard crypto/ecdsa packages provided with go. There is a test suite which is aiming to reach 100% code coverage. See test_coverage.txt for the current coverage (using gocov). On a UNIX-like OS, the script cov_report.sh can be used to generate the report. Package btcec uses work from ThePiachu which is licensed under the same terms as Go. The Conformal original is licensed under the liberal ISC license.

This package is one of the core packages from btcd, an alternative full-node implementation of bitcoin which is under active development by Conformal. Although it was primarily written for btcd, this package has intentionally been designed so it can be used as a standalone package for any projects needing to use secp256k1 elliptic curve cryptography.

Sample Use

	import crypto/ecdsa

	pubKey, err := btcec.ParsePubKey(pkStr, btcec.S256())

	signature, err := btcec.ParseSignature(sigStr, btcec.S256())

	ok := ecdsa.Verify(pubKey, message, signature.R, signature.S)

Documentation

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here.

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/conformal/btcec

Installation

$ go get github.com/conformal/btcec

TODO

Increase test coverage to 100%

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 Conformal. 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 liberal ISC License except for btcec.go and btcec_test.go which is under the same license as Go.