key

Documentation

Index

• Variables
• type Key
• type MemoryKey
  • func NewMemoryKey() (*MemoryKey, error)
  • func NewMemoryKeyFromBytes(pk []byte) (*MemoryKey, error)
  • func NewMemoryKeyFromString(sk string) (*MemoryKey, error)
  • func (ac *MemoryKey) Bytes() []byte
  • func (ac *MemoryKey) Clear()
  • func (ac *MemoryKey) PublicKey() common.PublicKey
  • func (ac *MemoryKey) Sign(h hash.Hash256) (common.Signature, error)
  • func (ac *MemoryKey) SignWithPassphrase(h hash.Hash256, passphrase []byte) (common.Signature, error)
  • func (ac *MemoryKey) Verify(h hash.Hash256, sig common.Signature) bool

Variables

var (
	ErrUnknownKeyType = errors.New("unknown key")
)

key errors

Types

type Key

type Key interface {
	Sign(h hash.Hash256) (common.Signature, error)
	SignWithPassphrase(h hash.Hash256, passphrase []byte) (common.Signature, error)
	Verify(h hash.Hash256, sig common.Signature) bool
	PublicKey() common.PublicKey
	Clear()
}

Key defines crypto key functions

type MemoryKey

type MemoryKey struct {
	PrivKey *ecdsa.PrivateKey
	// contains filtered or unexported fields
}

MemoryKey is the in-memory crypto key

func NewMemoryKey

func NewMemoryKey() (*MemoryKey, error)

NewMemoryKey returns a MemoryKey

func NewMemoryKeyFromBytes

func NewMemoryKeyFromBytes(pk []byte) (*MemoryKey, error)

NewMemoryKeyFromBytes parse memory key by the byte array

func NewMemoryKeyFromString

func NewMemoryKeyFromString(sk string) (*MemoryKey, error)

NewMemoryKeyFromString parse memory key by the hex string

func (*MemoryKey) Bytes

func (ac *MemoryKey) Bytes() []byte

Bytes returns the byte array of the key

func (*MemoryKey) Clear

func (ac *MemoryKey) Clear()

Clear removes private key bytes data

func (*MemoryKey) PublicKey

func (ac *MemoryKey) PublicKey() common.PublicKey

PublicKey returns the public key of the private key

func (*MemoryKey) Sign

func (ac *MemoryKey) Sign(h hash.Hash256) (common.Signature, error)

Sign generates the signature of the target hash

func (*MemoryKey) SignWithPassphrase

func (ac *MemoryKey) SignWithPassphrase(h hash.Hash256, passphrase []byte) (common.Signature, error)

SignWithPassphrase doesn't implemented yet

func (*MemoryKey) Verify

func (ac *MemoryKey) Verify(h hash.Hash256, sig common.Signature) bool

Verify checks that the signatures is generated by the hash and the key or not