https://github.com/ramonpage/ex_azure_key_vault
Elixir wrapper for Azure Key Vault REST API
https://github.com/ramonpage/ex_azure_key_vault
azure azure-key-vault elixir key-management key-vault secret-management secrets
Last synced: 9 months ago
JSON representation
Elixir wrapper for Azure Key Vault REST API
- Host: GitHub
- URL: https://github.com/ramonpage/ex_azure_key_vault
- Owner: RamonPage
- License: mit
- Created: 2018-08-11T03:20:51.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T08:12:03.000Z (over 1 year ago)
- Last Synced: 2025-03-22T17:13:29.217Z (over 1 year ago)
- Topics: azure, azure-key-vault, elixir, key-management, key-vault, secret-management, secrets
- Language: Elixir
- Size: 349 KB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Elixir Azure Key Vault
[](https://hex.pm/packages/ex_azure_key_vault)
[](https://hex.pm/packages/ex_azure_key_vault)
[](https://coveralls.io/github/RamonPage/ex_azure_key_vault?branch=main)
Elixir wrapper for Azure Key Vault REST API.
## Installation
The package can be installed
by adding `ex_azure_key_vault` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_azure_key_vault, "~> 2.2.1"}
]
end
```
[Documentation is available on hexdocs.pm](https://hexdocs.pm/ex_azure_key_vault/).
## Basic usage
When defining environment variables and/or adding to configuration.
```bash
$ export AZURE_CLIENT_ID="14e79d90-9abf..."
$ export AZURE_CLIENT_SECRET="14e7a11e-9abf..."
$ export AZURE_TENANT_ID="14e7a376-9abf..."
$ export AZURE_VAULT_NAME="my-vault"
```
```elixir
# Config.exs
config :ex_azure_key_vault,
azure_client_id: {:system, "AZURE_CLIENT_ID"},
azure_client_secret: {:system, "AZURE_CLIENT_SECRET"},
azure_tenant_id: {:system, "AZURE_TENANT_ID"},
azure_vault_name: {:system, "AZURE_VAULT_NAME"}
```
### Getting a secret
```elixir
iex(1)> ExAzureKeyVault.Client.connect() |> ExAzureKeyVault.Client.get_secret("my-secret")
{:ok, "my-value"}
```
### Creating a secret
```elixir
iex(1)> ExAzureKeyVault.Client.connect() |> ExAzureKeyVault.Client.create_secret("my-new-secret", "my-new-value")
:ok
```
### Deleting a secret
```elixir
iex(1)> ExAzureKeyVault.Client.connect() |> ExAzureKeyVault.Client.delete_secret("my-secret")
:ok
```
## Connecting with client assertion
For additional security, `ex_azure_key_vault` accepts client assertion instead of a client secret. To do so, first you need to upload a certificate to your Azure App Registration. Then pass the certificate SHA-1 thumbprint in base64 format and the private key in PEM format to `ex_azure_key_vault`.
```bash
$ export AZURE_CLIENT_ID="14e79d90-9abf..."
$ export AZURE_TENANT_ID="14e7a376-9abf..."
$ export AZURE_VAULT_NAME="my-vault"
$ export AZURE_CERT_BASE64_THUMBPRINT="Dss7v2YI3GgCGfl...",
$ export AZURE_CERT_PRIVATE_KEY_PEM="-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEF..."
```
```elixir
# Config.exs
config :ex_azure_key_vault,
azure_client_id: {:system, "AZURE_CLIENT_ID"},
azure_tenant_id: {:system, "AZURE_TENANT_ID"},
azure_vault_name: {:system, "AZURE_VAULT_NAME"},
azure_cert_base64_thumbprint: {:system, "AZURE_CERT_BASE64_THUMBPRINT"},
azure_cert_private_key_pem: {:system, "AZURE_CERT_PRIVATE_KEY_PEM"}
```
### Getting a secret
```elixir
iex(1)> ExAzureKeyVault.Client.cert_connect() |> ExAzureKeyVault.Client.get_secret("my-secret")
{:ok, "my-value"}
```
***
Thanks to [stuartbarr](https://github.com/stuartbarr/azure-key-vault) for the inspiration.