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
• func GenerateKey(rand io.Reader) (publicKey PublicKey, privateKey PrivateKey, err error)
• func RandomKeyPair() *crypto.KeyPair
• func Sign(privateKey PrivateKey, message []byte) []byte
• func Verify(publicKey PublicKey, message, sig []byte) bool
• type Ed25519
  • func New() *Ed25519
  • func (p *Ed25519) GenerateKeys() ([]byte, []byte, error)
  • func (p *Ed25519) PrivateKeySize() int
  • func (p *Ed25519) PrivateToPublic(privateKey []byte) ([]byte, error)
  • func (p *Ed25519) PublicKeySize() int
  • func (p *Ed25519) RandomKeyPair() *crypto.KeyPair
  • func (p *Ed25519) Sign(privateKey []byte, message []byte) []byte
  • func (p *Ed25519) Verify(publicKey []byte, message []byte, signature []byte) bool
• type PrivateKey
  • func (priv PrivateKey) Public() crypto.PublicKey
  • func (priv PrivateKey) Sign(rand io.Reader, message []byte, opts crypto.SignerOpts) (signature []byte, err error)
• type PublicKey

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
)

Functions

func GenerateKey

func GenerateKey(rand io.Reader) (publicKey PublicKey, privateKey PrivateKey, err error)

GenerateKey generates a public/private key pair using entropy from rand. If rand is nil, crypto/rand.Reader will be used.

func RandomKeyPair

func RandomKeyPair() *crypto.KeyPair

RandomKeyPair generates a randomly seeded ed25519 key pair.

func Sign

func Sign(privateKey PrivateKey, message []byte) []byte

Sign signs the message with privateKey and returns a signature. It will panic if len(privateKey) is not PrivateKeySize.

func Verify

func Verify(publicKey PublicKey, message, sig []byte) bool

Verify reports whether sig is a valid signature of message by publicKey. It will panic if len(publicKey) is not PublicKeySize.

Types

type Ed25519

type Ed25519 struct {
}

Ed25519 represents the ed25519 cryptographic signature scheme.

func New

func New() *Ed25519

New returns an Ed25519 structure.

func (*Ed25519) GenerateKeys

func (p *Ed25519) GenerateKeys() ([]byte, []byte, error)

GenerateKeys generates a private and public key using the ed25519 signature scheme.

func (*Ed25519) PrivateKeySize

func (p *Ed25519) PrivateKeySize() int

PrivateKeySize returns the private key length.

func (*Ed25519) PrivateToPublic

func (p *Ed25519) PrivateToPublic(privateKey []byte) ([]byte, error)

PrivateToPublic returns the public key given the private key.

func (*Ed25519) PublicKeySize

func (p *Ed25519) PublicKeySize() int

PublicKeySize returns the public key length.

func (*Ed25519) RandomKeyPair

func (p *Ed25519) RandomKeyPair() *crypto.KeyPair

RandomKeyPair generates a randomly seeded ed25519 key pair.

func (*Ed25519) Sign

func (p *Ed25519) Sign(privateKey []byte, message []byte) []byte

Sign returns an ed25519-signed message given an private key and message.

func (*Ed25519) Verify

func (p *Ed25519) Verify(publicKey []byte, message []byte, signature []byte) bool

Verify returns true if the signature was signed using the given public key and message.

type PrivateKey

type PrivateKey []byte

PrivateKey is the type of Ed25519 private keys. It implements crypto.Signer.

func (PrivateKey) Public

func (priv PrivateKey) Public() crypto.PublicKey

Public returns the PublicKey corresponding to priv.

func (PrivateKey) Sign

func (priv PrivateKey) Sign(rand io.Reader, message []byte, opts crypto.SignerOpts) (signature []byte, err error)

Sign signs the given message with priv. Ed25519 performs two passes over messages to be signed and therefore cannot handle pre-hashed messages. Thus opts.HashFunc() must return zero to indicate the message hasn't been hashed. This can be achieved by passing crypto.Hash(0) as the value for opts.

type PublicKey

type PublicKey []byte

PublicKey is the type of Ed25519 public keys.