Documentation
¶
Overview ¶
Package secp256k1 wraps the bitcoin secp256k1 C library.
Index ¶
- Variables
- func CompressPubkey(x, y *big.Int) ([]byte, error)
- func DecompressPubkey(pubkey []byte) (x, y *big.Int, err error)
- func FromECDSAPrivateKey(priv *ecdsa.PrivateKey) []byte
- func FromECDSAPublicKey(pub *ecdsa.PublicKey) ([]byte, error)
- func HexToECDSA(hexkey string) (*ecdsa.PrivateKey, error)
- func NewECDSAPrivateKey() *ecdsa.PrivateKey
- func RecoverPubkey(msg []byte, sig []byte) ([]byte, error)
- func SeckeyVerify(seckey []byte) bool
- func Sign(msg []byte, seckey []byte) ([]byte, error)
- func ToECDSAPrivateKey(d []byte) (*ecdsa.PrivateKey, error)
- func ToECDSAPrivateKeyUnsafe(d []byte) *ecdsa.PrivateKey
- func ToECDSAPublicKey(pub []byte) (*ecdsa.PublicKey, error)
- func VerifySignature(pubkey, msg, signature []byte) bool
- type BitCurve
- func (BitCurve *BitCurve) Add(x1, y1, x2, y2 *big.Int) (*big.Int, *big.Int)
- func (BitCurve *BitCurve) Double(x1, y1 *big.Int) (*big.Int, *big.Int)
- func (BitCurve *BitCurve) IsOnCurve(x, y *big.Int) bool
- func (BitCurve *BitCurve) Marshal(x, y *big.Int) []byte
- func (BitCurve *BitCurve) Params() *elliptic.CurveParams
- func (BitCurve *BitCurve) ScalarBaseMult(k []byte) (*big.Int, *big.Int)
- func (BitCurve *BitCurve) ScalarMult(Bx, By *big.Int, scalar []byte) (*big.Int, *big.Int)
- type PrivateKey
- type PublicKey
- func (k *PublicKey) Algorithm() algorithm.CryptoAlgorithm
- func (k *PublicKey) Clear()
- func (k *PublicKey) Compressed() ([]byte, error)
- func (k *PublicKey) Decode(b []byte) error
- func (k *PublicKey) Decompress(data []byte) error
- func (k *PublicKey) Encoded() ([]byte, error)
- func (k *PublicKey) Verify(msg []byte, sig []byte) (bool, error)
- type Signature
- func (s *Signature) Algorithm() algorithm.CryptoAlgorithm
- func (s *Signature) InitSign(priv signature.PrivateKey)
- func (s *Signature) InitVerify(pub signature.PublicKey)
- func (s *Signature) RecoverPublic(data []byte, sig []byte) (signature.PublicKey, error)
- func (s *Signature) Sign(data []byte) ([]byte, error)
- func (s *Signature) Verify(data []byte, sig []byte) (bool, error)
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidMsgLen = errors.New("invalid message length, need 32 bytes") ErrInvalidSignatureLen = errors.New("invalid signature length") ErrInvalidRecoveryID = errors.New("invalid signature recovery id") ErrInvalidKey = errors.New("invalid private key") ErrInvalidPubkey = errors.New("invalid public key") ErrSignFailed = errors.New("signing failed") ErrRecoverFailed = errors.New("recovery failed") )
Error types
Functions ¶
func CompressPubkey ¶
CompressPubkey encodes a public key to 33-byte compressed format.
func DecompressPubkey ¶
DecompressPubkey parses a public key in the 33-byte compressed format. It returns non-nil coordinates if the public key is valid.
func FromECDSAPrivateKey ¶
func FromECDSAPrivateKey(priv *ecdsa.PrivateKey) []byte
FromECDSAPrivateKey exports a private key into a binary dump.
func FromECDSAPublicKey ¶
FromECDSAPublicKey exports a public key into a binary dump.
func HexToECDSA ¶
func HexToECDSA(hexkey string) (*ecdsa.PrivateKey, error)
HexToECDSA gets a private key from hex string.
func NewECDSAPrivateKey ¶
func NewECDSAPrivateKey() *ecdsa.PrivateKey
NewECDSAPrivateKey generate a ecdsa private key
func RecoverPubkey ¶
RecoverPubkey returns the the public key of the signer. msg must be the 32-byte hash of the message to be signed. sig must be a 65-byte compact ECDSA signature containing the recovery id as the last element.
func SeckeyVerify ¶
SeckeyVerify check private is ok for secp256k1
func Sign ¶
Sign creates a recoverable ECDSA signature. The produced signature is in the 65-byte [R || S || V] format where V is 0 or 1.
The caller is responsible for ensuring that msg cannot be chosen directly by an attacker. It is usually preferable to use a cryptographic hash function on any input before handing it to this function.
func ToECDSAPrivateKey ¶
func ToECDSAPrivateKey(d []byte) (*ecdsa.PrivateKey, error)
ToECDSAPrivateKey gets a private key from bytes.
func ToECDSAPrivateKeyUnsafe ¶
func ToECDSAPrivateKeyUnsafe(d []byte) *ecdsa.PrivateKey
ToECDSAPrivateKeyUnsafe is ToECDSAPrivateKey's unsafe function.
func ToECDSAPublicKey ¶
ToECDSAPublicKey creates a public key with the given data value.
func VerifySignature ¶
VerifySignature checks that the given pubkey created signature over message. The signature should be in [R || S] format.
Types ¶
type BitCurve ¶
type BitCurve struct { P *big.Int // the order of the underlying field N *big.Int // the order of the base point B *big.Int // the constant of the BitCurve equation Gx, Gy *big.Int // (x,y) of the base point BitSize int //the size of the underlying field }
A BitCurve represents a Koblitz Curve with a=0. See http://www.hyperelliptic.org/EFD/g1p/auto-shortw.html
func (*BitCurve) Marshal ¶
Marshal converts a point into the form specified in section 4.3.6 of ANSI X9.62.
func (*BitCurve) Params ¶
func (BitCurve *BitCurve) Params() *elliptic.CurveParams
Params returns elliptic curve params.
func (*BitCurve) ScalarBaseMult ¶
ScalarBaseMult returns k*G, where G is the base point of the group and k is an integer in big-endian form.
type PrivateKey ¶
type PrivateKey struct {
// contains filtered or unexported fields
}
PrivateKey ecdsa privatekey
func GeneratePrivateKey ¶
func GeneratePrivateKey() *PrivateKey
GeneratePrivateKey generate a new private key
func NewPrivateKey ¶
func NewPrivateKey(key *ecdsa.PrivateKey) *PrivateKey
NewPrivateKey new a private key with ecdsa.PrivateKey
func NewPrivateKeyFromHex ¶
func NewPrivateKeyFromHex(b string) (*PrivateKey, error)
NewPrivateKeyFromHex gets new private key from hex string.
func (*PrivateKey) Algorithm ¶
func (k *PrivateKey) Algorithm() algorithm.CryptoAlgorithm
Algorithm returns algorithm name.
func (*PrivateKey) Encoded ¶
func (k *PrivateKey) Encoded() ([]byte, error)
Encoded encodes to bytes.
func (*PrivateKey) PublicKey ¶
func (k *PrivateKey) PublicKey() signature.PublicKey
PublicKey returns public key.
type PublicKey ¶
type PublicKey struct {
// contains filtered or unexported fields
}
PublicKey ecdsa publickey.
func NewPublicKey ¶
NewPublicKey generate PublicKey.
func (*PublicKey) Algorithm ¶
func (k *PublicKey) Algorithm() algorithm.CryptoAlgorithm
Algorithm algorithm name.
func (*PublicKey) Compressed ¶
Compressed encodes a public key to 33-byte compressed format.
func (*PublicKey) Decompress ¶
Decompress parses a public key in the 33-byte compressed format.
type Signature ¶
type Signature struct {
// contains filtered or unexported fields
}
Signature signature ecdsa
func (*Signature) Algorithm ¶
func (s *Signature) Algorithm() algorithm.CryptoAlgorithm
Algorithm secp256k1 algorithm
func (*Signature) InitSign ¶
func (s *Signature) InitSign(priv signature.PrivateKey)
InitSign ecdsa init sign
func (*Signature) InitVerify ¶
InitVerify ecdsa verify init
func (*Signature) RecoverPublic ¶
RecoverPublic returns a public key