ed25519

Documentation

Overview

Package ed25519 implements the Ed25519 signature algorithm. See https://ed25519.cr.yp.to/.

These functions are also compatible with the “Ed25519” function defined in https://tools.ietf.org/html/draft-irtf-cfrg-eddsa-05.

Index

• Constants
• type PrivateKey
  • func NewKeyFromSeed(seed []byte) PrivateKey
  • func (priv PrivateKey) PublicKey() PublicKey
  • func (priv PrivateKey) SignHash(hash crypto.Hash) []byte
• type PublicKey
  • func (pub PublicKey) VerifyHash(hash crypto.Hash, sig []byte) bool

Constants

const (
	// PublicKeySize is the size, in bytes, of public keys as used in this package.
	PublicKeySize = 32
	// PrivateKeySize is the size, in bytes, of private keys as used in this package.
	PrivateKeySize = 64
	// SignatureSize is the size, in bytes, of signatures generated and verified by this package.
	SignatureSize = 64
	// SeedSize is the size, in bytes, of private key seeds. These are the private key representations used by RFC 8032.
	SeedSize = 32
)

Types

type PrivateKey

type PrivateKey []byte

PrivateKey is an Ed25519 private key.

func NewKeyFromSeed

func NewKeyFromSeed(seed []byte) PrivateKey

NewKeyFromSeed calculates a private key from a seed. It will panic if len(seed) is not SeedSize. This function is provided for interoperability with RFC 8032. RFC 8032's private keys correspond to seeds in this package.

func (PrivateKey) PublicKey

func (priv PrivateKey) PublicKey() PublicKey

PublicKey returns the PublicKey corresponding to priv.

func (PrivateKey) SignHash

func (priv PrivateKey) SignHash(hash crypto.Hash) []byte

SignHash signs a hash with priv and returns a signature.

type PublicKey

type PublicKey []byte

PublicKey is the type of Ed25519 public keys.

func (PublicKey) VerifyHash

func (pub PublicKey) VerifyHash(hash crypto.Hash, sig []byte) bool

VerifyHash reports whether sig is a valid signature of hash by pub.