3942a116e4
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.
74 lines
2.8 KiB
Markdown
74 lines
2.8 KiB
Markdown
btcec
|
|
=====
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcec) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[]
|
|
(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
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcd/btcec
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [Sign Message]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--SignMessage)
|
|
Demonstrates signing a message with a secp256k1 private key that is first
|
|
parsed form raw bytes and serializing the generated signature.
|
|
|
|
* [Verify Signature]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--VerifySignature)
|
|
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]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--EncryptMessage)
|
|
Demonstrates encrypting a message for a public key that is first parsed from
|
|
raw bytes, then decrypting it using the corresponding private key.
|
|
|
|
* [Decryption]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--DecryptMessage)
|
|
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:
|
|
```bash
|
|
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:
|
|
```bash
|
|
git tag -v TAG_NAME
|
|
```
|
|
|
|
## License
|
|
|
|
Package btcec is licensed under the [copyfree](http://copyfree.org) ISC License
|
|
except for btcec.go and btcec_test.go which is under the same license as Go.
|
|
|