https://github.com/kraftjectory/secrex
Simple and secure secrets manager in Elixir projects
https://github.com/kraftjectory/secrex
elixir security
Last synced: 6 months ago
JSON representation
Simple and secure secrets manager in Elixir projects
- Host: GitHub
- URL: https://github.com/kraftjectory/secrex
- Owner: kraftjectory
- License: isc
- Created: 2018-07-03T14:42:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T20:10:31.000Z (over 2 years ago)
- Last Synced: 2025-03-25T20:21:41.539Z (10 months ago)
- Topics: elixir, security
- Language: Elixir
- Homepage: https://hexdocs.pm/secrex
- Size: 38.1 KB
- Stars: 28
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Secrex
[](https://hex.pm/packages/secrex)
Simple and secure secrets manager in Elixir projects
## Installation
The package can be installed
by adding `secrex` to our list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:secrex, "~> 0.3", runtime: false}
]
end
```
For usage information see [the documentation](https://hexdocs.pm/secrex).
## Mix tasks
There are two Mix tasks available:
* `mix secrex.encrypt`
* `mix secrex.decrypt`
Secrex requires some configuration in order to work. For example, in `config/config.exs`:
```elixir
config :secrex,
key_file: ".secret-key",
files: ["config/env/prod.secret.exs"]
```
* `:key_file` - a path to the key file that will be used for encryption and decryption
if this is not configured, you will be prompted to enter it later
* `:files` - list of files that needs to be encrypted and decrypted
* `:cipher` - the cipher module to handle secret encryption/decryption.
Must be an implementation of `Secrex.Cipher`. Defaults to `Secrex.AES`.
## License
This software is licensed under [the ISC license](LICENSE).