Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anoskov/rsa-ex
Library for working with RSA keys using Elixir and OpenSSL ports
https://github.com/anoskov/rsa-ex
Last synced: about 1 month ago
JSON representation
Library for working with RSA keys using Elixir and OpenSSL ports
- Host: GitHub
- URL: https://github.com/anoskov/rsa-ex
- Owner: anoskov
- License: mit
- Created: 2016-08-16T06:04:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T10:01:51.000Z (7 months ago)
- Last Synced: 2024-09-23T01:43:58.445Z (3 months ago)
- Language: Elixir
- Size: 23.4 KB
- Stars: 37
- Watchers: 2
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Library for working with RSA keys. (Cryptography)
- fucking-awesome-elixir - rsa_ex - Library for working with RSA keys. (Cryptography)
- awesome-elixir - rsa_ex - Library for working with RSA keys. (Cryptography)
README
# RSA Ex
Library for working with RSA keys using Elixir and OpenSSL ports.
## Installation
If [available in Hex](https://hex.pm/packages/rsa_ex), the package can be installed as:
* Add `rsa_ex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:rsa_ex, "~> 0.4"}]
end
```
* Ensure `rsa_ex` is started before your application:
```elixir
def application do
[applications: [:rsa_ex]]
end
```
## Usage
* Generate RSA 2048 Private Key
```elixir
iex> {:ok, priv} = RsaEx.generate_private_key
```
* Generate RSA 2048 Public Key
```elixir
iex> {:ok, priv} = RsaEx.generate_private_key
iex> {:ok, pub} = RsaEx.generate_public_key(priv)
```
* Generate RSA 4096 Public Key
```elixir
iex> {:ok, priv} = RsaEx.generate_private_key("4096")
iex> {:ok, pub} = RsaEx.generate_public_key(priv)
```
* Generate RSA 2048 Private/Public Keypair
```elixir
iex> {:ok, {priv, pub}} = RsaEx.generate_keypair
```
* Generate RSA 4096 Private/Public Keypair
```elixir
iex> {:ok, {priv, pub}} = RsaEx.generate_keypair("4096")
```
* Sign message with RSA private key
```elixir
iex> {:ok, rsa_private_key} = RsaEx.generate_private_key
iex> {:ok, signature} = RsaEx.sign("message", rsa_private_key)
```
* Sign message with RSA private key specifying a custom dygest type
```elixir
iex> {:ok, rsa_private_key} = RsaEx.generate_private_key
iex> {:ok, signature} = RsaEx.sign("message", rsa_private_key, :sha512)
```
* Verify signature with RSA public key
```elixir
iex> {:ok, valid} = RsaEx.verify(message, signature, rsa_public_key)
```
* Verify signature with RSA public key specifying a custom dygest type
```elixir
iex> {:ok, valid} = RsaEx.verify(message, signature, rsa_public_key, :sha512)
```
* Encrypt message with RSA public key in base64
```elixir
iex> clear_text = "Important message"
"Important message"
iex> {:ok, cipher_text} = RsaEx.encrypt(clear_text, {:public_key, rsa_public_key})
{:ok, "Lmbv...HQ=="}
```
* Encrypt message with RSA private key in base64
```elixir
iex> clear_text = "Important message"
"Important message"
iex> {:ok, cipher_text} = RsaEx.encrypt(clear_text, {:private_key, rsa_private_key})
{:ok, "Lmbv...HQ=="}
```
* Decrypt message with RSA private key
```elixir
iex> {:ok, decrypted_clear_text} = RsaEx.decrypt(cipher_text, {:private_key, rsa_private_key})
{:ok, "Important message"}
```
* Decrypt message with RSA public key
```elixir
iex> {:ok, decrypted_clear_text} = RsaEx.decrypt(cipher_text, {:public_key, rsa_public_key})
{:ok, "Important message"}
```