crypto

Documentation

Overview

Package crypto provides functionality for interacting with Ed25519 public and private keys. Package crypto uses the "crypto/ed25519" package from Go's standard library for the underlying cryptography.

Index

• Constants
• Variables
• func Address(hrp string, p PublicKey) string
• func Verify(msg []byte, p PublicKey, s Signature) bool
• type PrivateKey
  • func GeneratePrivateKey() (PrivateKey, error)
  • func HexToKey(key string) (PrivateKey, error)
  • func LoadKey(filename string) (PrivateKey, error)
  • func (p PrivateKey) PublicKey() PublicKey
  • func (p PrivateKey) Save(filename string) error
  • func (p PrivateKey) ToHex() string
• type PublicKey
  • func ParseAddress(hrp, saddr string) (PublicKey, error)
• type Signature
  • func Sign(msg []byte, pk PrivateKey) Signature

Constants

const (
	PublicKeyLen  = ed25519.PublicKeySize
	PrivateKeyLen = ed25519.PrivateKeySize
	// PrivateKeySeedLen is defined because ed25519.PrivateKey
	// is formatted as privateKey = seed|publicKey. We use this const
	// to extract the publicKey below.
	PrivateKeySeedLen = ed25519.SeedSize
	SignatureLen      = ed25519.SignatureSize
)

Variables

var (
	EmptyPublicKey  = [ed25519.PublicKeySize]byte{}
	EmptyPrivateKey = [ed25519.PrivateKeySize]byte{}
	EmptySignature  = [ed25519.SignatureSize]byte{}
)

var (
	ErrInvalidPrivateKey = errors.New("invalid private key")
	ErrInvalidPublicKey  = errors.New("invalid public key")
	ErrIncorrectHrp      = errors.New("incorrect hrp")
	ErrInvalidSignature  = errors.New("invalid signature")
)

Functions

func Address

func Address(hrp string, p PublicKey) string

Address returns a Bech32 address from hrp and p. This function uses node's FormatBech32 function.

func Verify

func Verify(msg []byte, p PublicKey, s Signature) bool

Verify returns whether s is a valid signature of msg by p.

Types

type PrivateKey

type PrivateKey [ed25519.PrivateKeySize]byte

func GeneratePrivateKey

func GeneratePrivateKey() (PrivateKey, error)

GeneratePrivateKey returns a Ed25519 PrivateKey. It uses the crypto/ed25519 go package to generate the key.

func HexToKey

func HexToKey(key string) (PrivateKey, error)

HexToKey Converts a hexadecimal encoded key into a PrivateKey. Returns an EmptyPrivateKey and error if key is invalid.

func LoadKey

func LoadKey(filename string) (PrivateKey, error)

LoadKey returns a PrivateKey from a file filename. If there is an error reading the file, or the file contains an invalid PrivateKey, LoadKey returns an EmptyPrivateKey and an error.

func (PrivateKey) PublicKey

func (p PrivateKey) PublicKey() PublicKey

PublicKey returns a PublicKey associated with the Ed25519 PrivateKey p. The PublicKey is the last 32 bytes of p.

func (PrivateKey) Save

func (p PrivateKey) Save(filename string) error

Save writes PrivateKey to a file [filename]. If filename does not exist, it creates a new file with read/write permissions (0o600).

func (PrivateKey) ToHex

func (p PrivateKey) ToHex() string

ToHex converts a PrivateKey to a hex string.

type PublicKey

type PublicKey [ed25519.PublicKeySize]byte

func ParseAddress

func ParseAddress(hrp, saddr string) (PublicKey, error)

ParseAddress parses a Bech32 encoded address string and extracts its public key. If there is an error reading the address or the hrp value is not valid, ParseAddress returns an EmptyPublicKey and error.

type Signature

type Signature [ed25519.SignatureSize]byte

func Sign

func Sign(msg []byte, pk PrivateKey) Signature

Sign returns a valid signature for msg using pk.