ed25519

Documentation

Index

• Constants
• type PrivKeyEd25519
  • func GenPrivKey() PrivKeyEd25519
  • func GenPrivKeyFromSecret(secret []byte) PrivKeyEd25519
  • func (privKey PrivKeyEd25519) Bytes() []byte
  • func (privKey PrivKeyEd25519) Equals(other crypto.PrivKey) bool
  • func (privKey PrivKeyEd25519) PubKey() crypto.PubKey
  • func (privKey PrivKeyEd25519) Sign(msg []byte) ([]byte, error)
  • func (privKey PrivKeyEd25519) ToCurve25519() *[PubKeyEd25519Size]byte
• type PubKeyEd25519
  • func (pubKey PubKeyEd25519) Address() crypto.Address
  • func (pubKey PubKeyEd25519) Bytes() []byte
  • func (pubKey PubKeyEd25519) Equals(other crypto.PubKey) bool
  • func (pubKey PubKeyEd25519) String() string
  • func (pubKey PubKeyEd25519) ToCurve25519() *[PubKeyEd25519Size]byte
  • func (pubKey PubKeyEd25519) VerifyBytes(msg []byte, sig_ []byte) bool

Constants

const (
	PrivKeyAminoRoute = "tendermint/PrivKeyEd25519"
	PubKeyAminoRoute  = "tendermint/PubKeyEd25519"
	// Size of an Edwards25519 signature. Namely the size of a compressed
	// Edwards25519 point, and a field element. Both of which are 32 bytes.
	SignatureSize = 64
)

const PubKeyEd25519Size = 32

PubKeyEd25519Size is the number of bytes in an Ed25519 signature.

Types

type PrivKeyEd25519

type PrivKeyEd25519 [64]byte

PrivKeyEd25519 implements crypto.PrivKey.

func GenPrivKey

func GenPrivKey() PrivKeyEd25519

GenPrivKey generates a new ed25519 private key. It uses OS randomness in conjunction with the current global random seed in tendermint/libs/common to generate the private key.

func GenPrivKeyFromSecret

func GenPrivKeyFromSecret(secret []byte) PrivKeyEd25519

GenPrivKeyFromSecret hashes the secret with SHA2, and uses that 32 byte output to create the private key. NOTE: secret should be the output of a KDF like bcrypt, if it's derived from user input.

func (PrivKeyEd25519) Bytes

func (privKey PrivKeyEd25519) Bytes() []byte

Bytes marshals the privkey using amino encoding.

func (PrivKeyEd25519) Equals

func (privKey PrivKeyEd25519) Equals(other crypto.PrivKey) bool

Equals - you probably don't need to use this. Runs in constant time based on length of the keys.

func (PrivKeyEd25519) PubKey

func (privKey PrivKeyEd25519) PubKey() crypto.PubKey

PubKey gets the corresponding public key from the private key.

func (PrivKeyEd25519) Sign

func (privKey PrivKeyEd25519) Sign(msg []byte) ([]byte, error)

Sign produces a signature on the provided message.

func (PrivKeyEd25519) ToCurve25519

func (privKey PrivKeyEd25519) ToCurve25519() *[PubKeyEd25519Size]byte

ToCurve25519 takes a private key and returns its representation on Curve25519. Curve25519 is birationally equivalent to Edwards25519, which Ed25519 uses internally. This method is intended for use in an X25519 Diffie Hellman key exchange.

type PubKeyEd25519

type PubKeyEd25519 [PubKeyEd25519Size]byte

PubKeyEd25519 implements crypto.PubKey for the Ed25519 signature scheme.

func (PubKeyEd25519) Address

func (pubKey PubKeyEd25519) Address() crypto.Address

Address is the SHA256-20 of the raw pubkey bytes.

func (PubKeyEd25519) Bytes

func (pubKey PubKeyEd25519) Bytes() []byte

Bytes marshals the PubKey using amino encoding.

func (PubKeyEd25519) Equals

func (pubKey PubKeyEd25519) Equals(other crypto.PubKey) bool

nolint: golint

func (PubKeyEd25519) String

func (pubKey PubKeyEd25519) String() string

func (PubKeyEd25519) ToCurve25519

func (pubKey PubKeyEd25519) ToCurve25519() *[PubKeyEd25519Size]byte

ToCurve25519 takes a public key and returns its representation on Curve25519. Curve25519 is birationally equivalent to Edwards25519, which Ed25519 uses internally. This method is intended for use in an X25519 Diffie Hellman key exchange.

If there is an error, then this function returns nil.

func (PubKeyEd25519) VerifyBytes

func (pubKey PubKeyEd25519) VerifyBytes(msg []byte, sig_ []byte) bool