Categorygithub.com/aviator-coding/bchdbchec
package
0.14.9
Repository: https://github.com/aviator-coding/bchd.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
22
Dependents
6
Files
2.9k SLOC

# README

bchec

Build Status ISC License GoDoc

Package bchec 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 bchec 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 bchd, 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/aviator-coding/bchd/bchec

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 bchec is licensed under the copyfree ISC License except for bchec.go and bchec_test.go which is under the same license as Go.

# Functions

Decrypt decrypts data that was encrypted using the Encrypt function.
Encrypt encrypts data for the target public key using AES-256-CBC.
GenerateSharedSecret generates a shared secret based on a private key and a public key using Diffie-Hellman key exchange (ECDH) (RFC 4753).
IsCompressedPubKey returns true the the passed serialized public key has been encoded in compressed format, and false otherwise.
NAF takes a positive integer k and returns the Non-Adjacent Form (NAF) as two byte slices.
NewMultiset returns an empty multiset.
NewMultisetFromPoint initializes a new multiset with the given x, y coordinate.
NewPrivateKey is a wrapper for ecdsa.GenerateKey that returns a PrivateKey instead of the normal ecdsa.PrivateKey.
ParseBERSignature parses an ECDSA signature in BER format for the curve type `curve' into a Signature type, perfoming some basic sanity checks.
ParseDERSignature parses a signature in DER format for the curve type `curve` into a Signature type.
ParsePubKey parses a public key for a koblitz curve from a bytestring into a ecdsa.Publickey, verifying that it is valid.
ParseSchnorrSignature parses a 64 byte schnorr signature into a Signature type.
PrivKeyFromBytes returns a private and public key for `curve' based on the private key passed as an argument as a byte slice.
RecoverCompact verifies the compact ECDSA signature "signature" of "hash" for the Koblitz curve in "curve".
S256 returns a Curve which implements secp256k1.
SignCompact produces a compact ECDSA signature of the data in hash with the given private key on the given koblitz curve.

# Constants

PrivKeyBytesLen defines the length in bytes of a serialized private key.
These constants define the lengths of serialized public keys.
These constants define the lengths of serialized public keys.
These constants define the lengths of serialized public keys.
SignatureTypeECDSA defines an ecdsa signature.
SignatureTypeSchnorr defines a schnorr signature.

# Variables

ErrInvalidMAC occurs when Message Authentication Check (MAC) fails during decryption.

# Structs

KoblitzCurve supports a koblitz curve implementation that fits the ECC Curve interface from crypto/elliptic.
Multiset tracks the state of a multiset as used to calculate the ECMH (elliptic curve multiset hash) hash of an unordered set.
Signature is a type representing either an ecdsa or schnorr signature.

# Type aliases

PrivateKey wraps an ecdsa.PrivateKey as a convenience mainly for signing things with the the private key without having to directly import the ecdsa package.
PublicKey is an ecdsa.PublicKey with additional functions to serialize in uncompressed, compressed, and hybrid formats.
SignatureType enumerates the type of signature.