Categorygithub.com/newinfoOffical/corebtcec
package
0.0.0-20240503093246-678d81269f95
Repository: https://github.com/newinfooffical/core.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
21
Dependents
5
Files
2.8k SLOC

# README

btcec

This is a fork of https://github.com/btcsuite/btcd/tree/master/btcec. Last sync of changes: 14.11.2021

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.

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.

# 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.
NewPrivateKey is a wrapper for ecdsa.GenerateKey that returns a PrivateKey instead of the normal ecdsa.PrivateKey.
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.
ParseSignature parses a signature in BER format for the curve type `curve' into a Signature type, perfoming some basic sanity checks.
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 signature "signature" of "hash" for the Koblitz curve in "curve".
S256 returns a Curve which implements secp256k1.
SignCompact produces a compact signature of the data in hash with the given private key on the given koblitz curve.

# Constants

MinSigLen is the minimum length of a DER encoded signature and is when both R and S are 1 byte each.
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.

# 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.
Signature is a type representing an ecdsa 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.