x25519

Documentation

Index

• type KeyPair
  • func GenerateKey() (*KeyPair, error)
• type PrivateKey
  • func DecodePrivateKey(key string) (PrivateKey, error)
  • func (k *PrivateKey) Encode() string
• type PublicKey
  • func DecodePublicKey(key string) (PublicKey, error)
  • func PublicFromPrivate(privateKey PrivateKey) (PublicKey, error)
  • func (k *PublicKey) Encode() string
• type SharedSecret
  • func ComputeSharedSecret(outPrivate PrivateKey, theirPublic PublicKey) (SharedSecret, error)
  • func (s *SharedSecret) Encode() string

Types

type KeyPair

type KeyPair struct {
	PublicKey  PublicKey
	PrivateKey PrivateKey
}

KeyPair represents a public/private key pair.

func GenerateKey

func GenerateKey() (*KeyPair, error)

GenerateKey generates a new X25519 key pair.

type PrivateKey

type PrivateKey []byte

func DecodePrivateKey

func DecodePrivateKey(key string) (PrivateKey, error)

DecodePrivateKey return the PrivateKey decoded from the hexadecimal encoding.

func (*PrivateKey) Encode

func (k *PrivateKey) Encode() string

Encode returns the hexadecimal encoding of PrivateKey.

type PublicKey

type PublicKey []byte

PublicKey represents a public key.

func DecodePublicKey

func DecodePublicKey(key string) (PublicKey, error)

DecodePublicKey return the PublicKey decoded from the hexadecimal encoding.

func PublicFromPrivate

func PublicFromPrivate(privateKey PrivateKey) (PublicKey, error)

PublicFromPrivate returns the public key corresponding to the given private key.

func (*PublicKey) Encode

func (k *PublicKey) Encode() string

Encode returns the hexadecimal encoding of PublicKey.

type SharedSecret

type SharedSecret []byte

SharedSecret represents a shared secret.

func ComputeSharedSecret

func ComputeSharedSecret(outPrivate PrivateKey, theirPublic PublicKey) (SharedSecret, error)

ComputeSharedSecret returns a shared secret between the two given keys.

func (*SharedSecret) Encode

func (s *SharedSecret) Encode() string

Encode returns the hexadecimal encoding of SharedSecret.