ed25519

Documentation

Index

• Constants
• func NewKeyIterator(rand io.Reader) (*keyIterator, error)
• type KeyPair
  • func GenerateKey(rand io.Reader) (*KeyPair, error)
  • func (kp *KeyPair) Validate() error
• type PrivateKey
• 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

	// SeedSize is the size, in bytes, of private key seeds.
	SeedSize = 32
)

Functions

func NewKeyIterator

func NewKeyIterator(rand io.Reader) (*keyIterator, error)

NewKeyIterator creates and initializes a new Ed25519 key iterator. The iterator is NOT thread safe; you must create a separate iterator for each worker instead of sharing a single instance.

Types

type KeyPair

type KeyPair struct {
	// PublicKey is the public key of the Ed25519 key pair.
	PublicKey PublicKey

	// PrivateKey is the private key of the Ed25519 key pair.
	PrivateKey PrivateKey
}

KeyPair is a type with both Ed25519 keys.

func GenerateKey

func GenerateKey(rand io.Reader) (*KeyPair, error)

func (*KeyPair) Validate

func (kp *KeyPair) Validate() error

Validate performs sanity checks to ensure that the public and private keys match.

type PrivateKey

type PrivateKey []byte

PrivateKey is the type of Ed25519 private keys.

type PublicKey

type PublicKey []byte

PublicKey is the type of Ed25519 public keys.