ed25519

Documentation

Index

• func CheckKey(k key.Key) error
• func GenerateKey() (key.Key, error)
• func KeyFromPrivate(pk ed25519.PrivateKey) (key.Key, error)
• func KeyFromPublic(pk ed25519.PublicKey) (key.Key, error)
• func KeyFromSeed(seed []byte) (key.Key, error)
• func KeyToPrivate(k key.Key) (ed25519.PrivateKey, error)
• func KeyToPublic(k key.Key) (ed25519.PublicKey, error)
• func NewSigner(k key.Key) (key.Signer, error)
• func NewVerifier(k key.Key) (key.Verifier, error)
• func ToPublicKey(k key.Key) (key.Key, error)

Functions

func CheckKey

func CheckKey(k key.Key) error

CheckKey checks whether the given key is a valid Ed25519 key.

Reference https://datatracker.ietf.org/doc/html/rfc9053#name-edwards-curve-digital-signa Reference https://datatracker.ietf.org/doc/html/rfc9053#name-octet-key-pair

func GenerateKey

func GenerateKey() (key.Key, error)

GenerateKey generates a new key for Ed25519.

func KeyFromPrivate

func KeyFromPrivate(pk ed25519.PrivateKey) (key.Key, error)

KeyFromPrivate returns a private Key with given ed25519.PrivateKey.

func KeyFromPublic

func KeyFromPublic(pk ed25519.PublicKey) (key.Key, error)

KeyFromPublic returns a public Key with given ed25519.PublicKey.

func KeyFromSeed

func KeyFromSeed(seed []byte) (key.Key, error)

KeyFromSeed returns a private Key with given ed25519.PrivateKey seed.

func KeyToPrivate

func KeyToPrivate(k key.Key) (ed25519.PrivateKey, error)

KeyToPrivate returns the private key from the given key.

func KeyToPublic

func KeyToPublic(k key.Key) (ed25519.PublicKey, error)

KeyToPublic returns the public key from the given key.

func NewSigner

func NewSigner(k key.Key) (key.Signer, error)

NewSigner creates a key.Signer for the given private key.

func NewVerifier

func NewVerifier(k key.Key) (key.Verifier, error)

NewVerifier creates a key.Verifier for the given public key.

func ToPublicKey

func ToPublicKey(k key.Key) (key.Key, error)

ToPublicKey converts the given private key to a public key. If the key is already a public key, it is returned as-is.