ed25519

Documentation

Overview

Package ed25519 implements Ed25519 signature scheme as described in RFC-8032.

References:

• RFC8032 https://rfc-editor.org/rfc/rfc8032.txt
• Ed25519 https://ed25519.cr.yp.to/
• High-speed high-security signatures. https://doi.org/10.1007/s13389-012-0027-1

Index

• Constants
• type PrivKey
• type PubKey
• type Pure
  • func (e Pure) KeyGen(public *PubKey, private *PrivKey)
  • func (e Pure) Sign(message []byte, public *PubKey, private *PrivKey) *Signature
  • func (e Pure) Verify(message []byte, public *PubKey, sig *Signature) bool
• type Signature

Constants

const Size = fp.Size

Size is the length in bytes of Ed25519 keys.

Types

type PrivKey

type PrivKey [Size]byte

PrivKey represents a private key of Ed25519.

type PubKey

type PubKey [Size]byte

PubKey represents a public key of Ed25519.

type Pure

type Pure struct{}

Pure corresponds to the Ed25519 PureEdDSA instance.

func (Pure) KeyGen

func (e Pure) KeyGen(public *PubKey, private *PrivKey)

KeyGen generates a public key from a secret key.

func (Pure) Sign

func (e Pure) Sign(message []byte, public *PubKey, private *PrivKey) *Signature

Sign returns the signature of a message using both the private and public keys of the signer.

func (Pure) Verify

func (e Pure) Verify(message []byte, public *PubKey, sig *Signature) bool

Verify returns true if the signature is valid. Failure cases are invalid signature, or public key cannot be decoded.

type Signature

type Signature [2 * Size]byte

Signature represents an Ed25519 signature.