CryppoEx v0.2.2

View Source Cryppo.Rsa4096 (CryppoEx v0.2.2)

Encryption strategy RSA with 4096-bit keys and some RSA-specific functions

For encryption and decryption please use functions in module Cryppo. This module also contains logic for PEMs, singing and verification.

Link to this section Summary

Types

pem()

RSA keys in PEM format

rsa_private_key()

Erlang type for RSA private keys

rsa_public_key()

Erlang type for RSA public keys

Functions

from_pem(pem)

Loads and initializes a Cryppo.EncryptionKey struct from a string with a PEM.

private_key_to_public_key(private_key)

Extracts a public key from a private key

sign(data, maybe_pem)

Signs data with a private key

to_pem(key)

Converts an RSA key to PEM format.

verify(rsa_signature, public_key)

Verifies an RSA signature with a public key

Link to this section Types

Link to this type

pem()

View Source 
@type pem() :: String.t()

RSA keys in PEM format

Link to this type

rsa_private_key()

View Source 
@type rsa_private_key() ::
  {:RSAPrivateKey, integer(), integer(), integer(), integer(), integer(),
   integer(), integer(), integer(), integer(), any()}

Erlang type for RSA private keys

The native Erlang type for RSA private keys in module public_key are Erlang records visible from Elixir as tuples with 11 terms the first term being atom :RSAPrivateKey

Link to this type

rsa_public_key()

View Source 
@type rsa_public_key() :: {:RSAPublicKey, integer(), integer()}

Erlang type for RSA public keys

The native Erlang type for RSA public keys in module public_key are Erlang records visible from Elixir as tuples with 3 terms the first term being atom :RSAPublicKey

Link to this section Functions

Link to this function

from_pem(pem)

View Source 
@spec from_pem(pem()) ::
  {:ok, Cryppo.EncryptionKey.t()} | {:error, :invalid_encryption_key}

Loads and initializes a Cryppo.EncryptionKey struct from a string with a PEM.

examples

 Examples 

iex> pem = "-----BEGIN RSA PRIVATE KEY-----\n" <>
...>       "MIICWwIBAAKBgQDKCUh7F4p5btzcSLBaToHvD3rCZX4fMaDtjkN5TwmC3/6iQzD5\n" <>
...>       "tn396BzDTdQ16HuuZ+eN+KQSa1QWr2h1DB13nVP+moeyLVC8BShiM3NBRn77r7Lr\n" <>
...>       "sWooM3mwnSvMPWWnBj1c+0tbO7zfur5wQdzBl66HrHgHt+Bz6f+dDj+aVwIDAQAB\n" <>
...>       "AoGAMHh3rihgrW9+h07dGF1baOoyzm6hCoTSkguefn0K0B5DLdSm7FHu+jp0pBqI\n" <>
...>       "/gHvolEFSZdMbarYOrUMf4BPlRSarCjjxf/beV4Pj/UQrCkDmNBBVJp33Sy8HEdb\n" <>
...>       "Wrzk+k8NcAS1UR4R6EW9JrUz0mMwX6CsvG2zZMbpS/Q9KXkCQQDwmCXjOTPQ+bxW\n" <>
...>       "K4gndHnXD5QkKNcTdFq64ef23R6AY0XEGkiRLDXZZA09hDIACgSSfk1Qbo0SJSvU\n" <>
...>       "TAR8A6clAkEA1vkWJ5qUo+xuIZB+2604LRco1GYAj5/fZ2kvUMjbOdCFgFaDVzJY\n" <>
...>       "X2pzLkk7RZNgPvXcRAgX7FlWmm4jwZzQywJARrHeSCMRx7DqF0PZUQaXmorYU7uw\n" <>
...>       "XuYMluc0WsRkZwNEh7fVZNrhw8vzXAUREBPhfg4gt6aUSyWi+FGR68LDBQJAC55O\n" <>
...>       "ujk6i1l94kaC9LB59sXnqQMSSLDlTBt9OSqB3rAMZxFF6/KGoDGKpBfFIk+CxiRX\n" <>
...>       "kT22vUleyt3lBNPK3QJAEr56asvREcIDFkbs7Ebjev4U1PL58w78ipp49Ti5FiwH\n" <>
...>       "vR9vuGcUcIDcWKOl05t4D35F5A/DskP6dGYA1cuWNg==\n" <>
...>       "-----END RSA PRIVATE KEY-----\n\n"
...> {:ok, _encryption_key} = Cryppo.Rsa4096.from_pem(pem)
Link to this function

private_key_to_public_key(private_key)

View Source 
@spec private_key_to_public_key(rsa_private_key() | Cryppo.EncryptionKey.t()) ::
  rsa_public_key()

Extracts a public key from a private key

Extracts a public key from a Cryppo.EncryptionKey struct with an RSA private key or from an RSA private key in the native Erlang type rsa_private_key/0

examples

 Examples

With a Cryppo.EncryptionKey struct:

iex> public_key = "Rsa4096"
...> |> Cryppo.generate_encryption_key()
...> |> Cryppo.Rsa4096.private_key_to_public_key()
...> elem(public_key, 0)
:RSAPublicKey

With a native Erlang key:

iex> public_key = {:rsa, 4_096, 65_537}
...> |> :public_key.generate_key()
...> |> Cryppo.Rsa4096.private_key_to_public_key()
...> elem(public_key, 0)
:RSAPublicKey
Link to this function

sign(data, maybe_pem)

View Source 
@spec sign(binary(), rsa_private_key() | Cryppo.EncryptionKey.t() | pem()) ::
  Cryppo.RsaSignature.t()
  | {:error, :invalid_encryption_key}
  | {:error, String.t()}

Signs data with a private key

The private key can be one of the following:

examples

 Examples

With a Cryppo.EncryptionKey struct:

iex> encryption_key = Cryppo.generate_encryption_key("Rsa4096")
iex> _signature = %Cryppo.RsaSignature{} = Cryppo.Rsa4096.sign("data to sign", encryption_key)

With a private key as native Erlang type rsa_private_key/0

iex> private_key = :public_key.generate_key({:rsa, 4_096, 65_537})
iex> _signature = %Cryppo.RsaSignature{} = Cryppo.Rsa4096.sign("data to sign", private_key)

With a PEM

iex> pem = "-----BEGIN RSA PRIVATE KEY-----\n" <>
...>       "MIICWwIBAAKBgQDKCUh7F4p5btzcSLBaToHvD3rCZX4fMaDtjkN5TwmC3/6iQzD5\n" <>
...>       "tn396BzDTdQ16HuuZ+eN+KQSa1QWr2h1DB13nVP+moeyLVC8BShiM3NBRn77r7Lr\n" <>
...>       "sWooM3mwnSvMPWWnBj1c+0tbO7zfur5wQdzBl66HrHgHt+Bz6f+dDj+aVwIDAQAB\n" <>
...>       "AoGAMHh3rihgrW9+h07dGF1baOoyzm6hCoTSkguefn0K0B5DLdSm7FHu+jp0pBqI\n" <>
...>       "/gHvolEFSZdMbarYOrUMf4BPlRSarCjjxf/beV4Pj/UQrCkDmNBBVJp33Sy8HEdb\n" <>
...>       "Wrzk+k8NcAS1UR4R6EW9JrUz0mMwX6CsvG2zZMbpS/Q9KXkCQQDwmCXjOTPQ+bxW\n" <>
...>       "K4gndHnXD5QkKNcTdFq64ef23R6AY0XEGkiRLDXZZA09hDIACgSSfk1Qbo0SJSvU\n" <>
...>       "TAR8A6clAkEA1vkWJ5qUo+xuIZB+2604LRco1GYAj5/fZ2kvUMjbOdCFgFaDVzJY\n" <>
...>       "X2pzLkk7RZNgPvXcRAgX7FlWmm4jwZzQywJARrHeSCMRx7DqF0PZUQaXmorYU7uw\n" <>
...>       "XuYMluc0WsRkZwNEh7fVZNrhw8vzXAUREBPhfg4gt6aUSyWi+FGR68LDBQJAC55O\n" <>
...>       "ujk6i1l94kaC9LB59sXnqQMSSLDlTBt9OSqB3rAMZxFF6/KGoDGKpBfFIk+CxiRX\n" <>
...>       "kT22vUleyt3lBNPK3QJAEr56asvREcIDFkbs7Ebjev4U1PL58w78ipp49Ti5FiwH\n" <>
...>       "vR9vuGcUcIDcWKOl05t4D35F5A/DskP6dGYA1cuWNg==\n" <>
...>       "-----END RSA PRIVATE KEY-----\n\n"
...> _signature = %Cryppo.RsaSignature{} = Cryppo.Rsa4096.sign("data to sign", pem)
Link to this function

to_pem(key)

View Source 
@spec to_pem(Cryppo.EncryptionKey.t() | rsa_private_key() | rsa_public_key()) ::
  {:ok, pem()}

Converts an RSA key to PEM format.

Can convert

examples

 Examples

With a Cryppo.EncryptionKey struct

iex> "Rsa4096" |> Cryppo.generate_encryption_key() |> Cryppo.Rsa4096.to_pem()

With a public key as native Erlang type rsa_public_key/0

iex> "Rsa4096"
...> |> Cryppo.generate_encryption_key()
...> |> Cryppo.Rsa4096.private_key_to_public_key()
...> |> Cryppo.Rsa4096.to_pem()

With a private key as native Erlang type rsa_private_key/0

iex> encryption_key = Cryppo.generate_encryption_key("Rsa4096")
iex> Cryppo.Rsa4096.to_pem(encryption_key.key)
Link to this function

verify(rsa_signature, public_key)

View Source 
@spec verify(
  Cryppo.RsaSignature.t(),
  rsa_public_key() | rsa_private_key() | Cryppo.EncryptionKey.t() | pem()
) :: boolean() | {:error, :invalid_encryption_key}

Verifies an RSA signature with a public key

The key for verification can be pretty much any format and type, private keys are also accepted:

With a public key in the Erlang format:

iex> encryption_key = Cryppo.generate_encryption_key("Rsa4096")
iex> signature = Cryppo.Rsa4096.sign("data to sign", encryption_key)
iex> public_key = Cryppo.Rsa4096.private_key_to_public_key(encryption_key)
iex> Cryppo.Rsa4096.verify(signature, public_key)
true

With a private key in the Erlang format:

iex> encryption_key = Cryppo.generate_encryption_key("Rsa4096")
iex> signature = Cryppo.Rsa4096.sign("data to sign", encryption_key)
iex> Cryppo.Rsa4096.verify(signature, encryption_key.key)
true

With a Cryppo.EncryptionKey struct:

iex> encryption_key = Cryppo.generate_encryption_key("Rsa4096")
iex> signature = Cryppo.Rsa4096.sign("data to sign", encryption_key)
iex> Cryppo.Rsa4096.verify(signature, encryption_key)
true

With a PEM

iex> pem_with_private_key = "-----BEGIN RSA PRIVATE KEY-----\n" <>
...>       "MIICWwIBAAKBgQDKCUh7F4p5btzcSLBaToHvD3rCZX4fMaDtjkN5TwmC3/6iQzD5\n" <>
...>       "tn396BzDTdQ16HuuZ+eN+KQSa1QWr2h1DB13nVP+moeyLVC8BShiM3NBRn77r7Lr\n" <>
...>       "sWooM3mwnSvMPWWnBj1c+0tbO7zfur5wQdzBl66HrHgHt+Bz6f+dDj+aVwIDAQAB\n" <>
...>       "AoGAMHh3rihgrW9+h07dGF1baOoyzm6hCoTSkguefn0K0B5DLdSm7FHu+jp0pBqI\n" <>
...>       "/gHvolEFSZdMbarYOrUMf4BPlRSarCjjxf/beV4Pj/UQrCkDmNBBVJp33Sy8HEdb\n" <>
...>       "Wrzk+k8NcAS1UR4R6EW9JrUz0mMwX6CsvG2zZMbpS/Q9KXkCQQDwmCXjOTPQ+bxW\n" <>
...>       "K4gndHnXD5QkKNcTdFq64ef23R6AY0XEGkiRLDXZZA09hDIACgSSfk1Qbo0SJSvU\n" <>
...>       "TAR8A6clAkEA1vkWJ5qUo+xuIZB+2604LRco1GYAj5/fZ2kvUMjbOdCFgFaDVzJY\n" <>
...>       "X2pzLkk7RZNgPvXcRAgX7FlWmm4jwZzQywJARrHeSCMRx7DqF0PZUQaXmorYU7uw\n" <>
...>       "XuYMluc0WsRkZwNEh7fVZNrhw8vzXAUREBPhfg4gt6aUSyWi+FGR68LDBQJAC55O\n" <>
...>       "ujk6i1l94kaC9LB59sXnqQMSSLDlTBt9OSqB3rAMZxFF6/KGoDGKpBfFIk+CxiRX\n" <>
...>       "kT22vUleyt3lBNPK3QJAEr56asvREcIDFkbs7Ebjev4U1PL58w78ipp49Ti5FiwH\n" <>
...>       "vR9vuGcUcIDcWKOl05t4D35F5A/DskP6dGYA1cuWNg==\n" <>
...>       "-----END RSA PRIVATE KEY-----\n\n"
...> signature = Cryppo.Rsa4096.sign("data to sign", pem_with_private_key)
...> {:ok, key} = Cryppo.Rsa4096.from_pem(pem_with_private_key)
...> {:ok, pem_with_public_key} = key
...> |> Cryppo.Rsa4096.private_key_to_public_key()
...> |> Cryppo.Rsa4096.to_pem()
...> Cryppo.Rsa4096.verify(signature, pem_with_public_key)
true