ecc

README

EOSIO Elliptic Curve Cryptography Wrapper

This is a simple wrapper for btcec, that handles the specificities of the format for keys in EOS.

It was crafted in reference to eosjs-ecc, eosjs-keygen and the C++ codebase of EOS.IO Software.

This handles the EOS prefix on public keys, manages the version and checksums in public and private keys.

Documentation

Index

• Constants
• func Ripemd160checksumHashCurve(in []byte, curve CurveID) []byte
• type CurveID
  • func (c CurveID) String() string
  • func (c CurveID) StringPrefix() string
• type PrivateKey
  • func NewDeterministicPrivateKey(randSource io.Reader) (*PrivateKey, error)
  • func NewPrivateKey(wif string) (*PrivateKey, error)
  • func NewRandomPrivateKey() (*PrivateKey, error)
  • func (p *PrivateKey) MarshalJSON() ([]byte, error)
  • func (p *PrivateKey) PublicKey() PublicKey
  • func (p *PrivateKey) Sign(hash []byte) (out Signature, err error)
  • func (p *PrivateKey) String() string
  • func (p *PrivateKey) UnmarshalJSON(v []byte) (err error)
• type PublicKey
  • func MustNewPublicKey(pubKey string) PublicKey
  • func NewPublicKey(pubKey string) (out PublicKey, err error)
  • func (p PublicKey) Key() (*btcec.PublicKey, error)
  • func (p PublicKey) MarshalJSON() ([]byte, error)
  • func (p PublicKey) String() string
  • func (p *PublicKey) UnmarshalJSON(data []byte) error
• type Signature
  • func NewSignature(fromText string) (Signature, error)
  • func (a Signature) MarshalJSON() ([]byte, error)
  • func (s Signature) PublicKey(hash []byte) (out PublicKey, err error)
  • func (s Signature) String() string
  • func (a *Signature) UnmarshalJSON(data []byte) (err error)
  • func (s Signature) Verify(hash []byte, pubKey PublicKey) bool

Constants

const (
	CurveK1 = CurveID(iota)
	CurveR1
)

const PrivateKeyPrefix = "PVT_"

const PublicKeyPrefix = "PUB_"

const PublicKeyPrefixCompat = "EOS"

Functions

func Ripemd160checksumHashCurve

func Ripemd160checksumHashCurve(in []byte, curve CurveID) []byte

Types

type CurveID

type CurveID uint8

func (CurveID) String

func (c CurveID) String() string

func (CurveID) StringPrefix

func (c CurveID) StringPrefix() string

type PrivateKey

type PrivateKey struct {
	Curve CurveID
	// contains filtered or unexported fields
}

func NewDeterministicPrivateKey

func NewDeterministicPrivateKey(randSource io.Reader) (*PrivateKey, error)

func NewPrivateKey

func NewPrivateKey(wif string) (*PrivateKey, error)

func NewRandomPrivateKey

func NewRandomPrivateKey() (*PrivateKey, error)

func (*PrivateKey) MarshalJSON

func (p *PrivateKey) MarshalJSON() ([]byte, error)

func (*PrivateKey) PublicKey

func (p *PrivateKey) PublicKey() PublicKey

func (*PrivateKey) Sign

func (p *PrivateKey) Sign(hash []byte) (out Signature, err error)

Sign signs a 32 bytes SHA256 hash..

func (*PrivateKey) String

func (p *PrivateKey) String() string

func (*PrivateKey) UnmarshalJSON

func (p *PrivateKey) UnmarshalJSON(v []byte) (err error)

type PublicKey

type PublicKey struct {
	Curve   CurveID
	Content []byte
}

func MustNewPublicKey

func MustNewPublicKey(pubKey string) PublicKey

func NewPublicKey

func NewPublicKey(pubKey string) (out PublicKey, err error)

func (PublicKey) Key

func (p PublicKey) Key() (*btcec.PublicKey, error)

func (PublicKey) MarshalJSON

func (p PublicKey) MarshalJSON() ([]byte, error)

func (PublicKey) String

func (p PublicKey) String() string

func (*PublicKey) UnmarshalJSON

func (p *PublicKey) UnmarshalJSON(data []byte) error

type Signature

type Signature struct {
	Curve   CurveID
	Content []byte // the Compact signature as bytes
}

Signature represents a signature for some hash

func NewSignature

func NewSignature(fromText string) (Signature, error)

func (Signature) MarshalJSON

func (a Signature) MarshalJSON() ([]byte, error)

func (Signature) PublicKey

func (s Signature) PublicKey(hash []byte) (out PublicKey, err error)

PublicKey retrieves the public key, but requires the payload.. that's the way to validate the signature. Use Verify() if you only want to validate.

func (Signature) String

func (s Signature) String() string

func (*Signature) UnmarshalJSON

func (a *Signature) UnmarshalJSON(data []byte) (err error)

func (Signature) Verify

func (s Signature) Verify(hash []byte, pubKey PublicKey) bool

Verify checks the signature against the pubKey. `hash` is a sha256 hash of the payload to verify.