Curvy.Key (Curvy v0.3.1) View Source

Module used to create ECDSA keypairs and convert to private and public key binaries.

Link to this section Summary

Types

t()

ECDSA Keypair.

Functions

from_point(point, opts \\ [])

Converts the given Point to a ECDSA Keypair struct without a private key.

from_privkey(arg, opts \\ [])

Converts the given private key binary to a ECDSA Keypair.

from_pubkey(pubkey)

Converts the given public key binary to a ECDSA Keypair struct without a private key.

generate(opts \\ [])

Creates a new random ESCDA keypair.

to_privkey(key)

Returns the 32 byte private key binary from the given ECDSA Keypair.

to_pubkey(key, opts \\ [])

Returns the public key binary from the given ECDSA Keypair in either compressed or uncompressed form.

Link to this section Types

t()

Specs

t() :: %Curvy.Key{
  compressed: boolean(),
  crv: atom(),
  point: Curvy.Point.t(),
  privkey: binary() | nil
}

ECDSA Keypair.

Always contains the t:Point.t coordinates and optionally a private key binary.

Link to this section Functions

from_point(point, opts \\ [])

Specs

from_point(
  Curvy.Point.t(),
  keyword()
) :: t()

Converts the given Point to a ECDSA Keypair struct without a private key.

from_privkey(arg, opts \\ [])

Specs

from_privkey(
  binary(),
  keyword()
) :: t()

Converts the given private key binary to a ECDSA Keypair.

from_pubkey(pubkey)

Specs

from_pubkey(binary()) :: t()

Converts the given public key binary to a ECDSA Keypair struct without a private key.

generate(opts \\ [])

Specs

generate(keyword()) :: t()

Creates a new random ESCDA keypair.

to_privkey(key)

Returns the 32 byte private key binary from the given ECDSA Keypair.

to_pubkey(key, opts \\ [])

Returns the public key binary from the given ECDSA Keypair in either compressed or uncompressed form.

Accepted options

:compressed - Return a 32 byte compressed public key. Default is true.