https://github.com/darkness4/just-encrypt-yaml
Just encrypt string values in YAML with asymmetric PEM keys. For DIY gitops.
https://github.com/darkness4/just-encrypt-yaml
encryption gitops go secrets yaml
Last synced: 6 days ago
JSON representation
Just encrypt string values in YAML with asymmetric PEM keys. For DIY gitops.
- Host: GitHub
- URL: https://github.com/darkness4/just-encrypt-yaml
- Owner: Darkness4
- License: mit
- Created: 2024-11-02T01:07:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-25T17:31:21.000Z (3 months ago)
- Last Synced: 2026-03-26T18:44:32.456Z (3 months ago)
- Topics: encryption, gitops, go, secrets, yaml
- Language: Go
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# just-encrypt-yaml
Just encrypt string values in YAML with asymmetric PEM keys. Needed for GitOps when we need to encrypt locally, and decrypt server-side.
Made with standard library. Simple and as basic as possible.
> [!NOTE]
>
> Since this project only uses standard libraries, maintenance won't be very frequent (there is nothing to update besides dependencies), but it should work for a long time.
>
> Don't fear about the lack of commits, it's just because there is nothing to update!
## Usage
### Generate PEM keys
```bash
openssl req -x509 -days 1825 -nodes -newkey rsa:4096 -keyout "tls.key" -out "tls.crt" -subj "/CN=secret-controller/O=secret-controller"
```
### Encrypt
**secret.yaml**
```yaml
mySecret: "mySecretValue"
wireguard:
wg0:
privateKey: "myPrivateKey"
```
**Execute:**
```bash
just-encrypt-yaml --key tls.crt [--out secret-sealed.yaml] secret.yaml
```
**secret-sealed.yaml**
```yaml
mySecret: AgALQpFfOS5AF...
wireguard:
wg0:
privateKey: AgBBuKY...
```
### Decrypt
**secret-sealed.yaml**
```yaml
mySecret: AgALQpFfOS5AF...
wireguard:
wg0:
privateKey: AgBBuKY...
```
**Execute:**
```bash
just-encrypt-yaml --decrypt --key tls.key [--out secret-sealed-decrypted.yaml] secret-sealed.yaml
```
**secret.yaml**
```yaml
mySecret: "mySecretValue"
wireguard:
wg0:
privateKey: "myPrivateKey"
```
### Help
```bash
NAME:
just-encrypt-yaml - Encrypt or decrypt YAML files using RSA keys
USAGE:
just-encrypt-yaml [global options] command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--key value Path to the private RSA key (for decryption) or certificate (for encryption)
--decrypt Decrypt the YAML file (default: false)
--out value Path to the output file
--help, -h show help
--version, -v print the version
```
## Usage with gomplate
***config.boot.enc***
```groovy
interfaces {
wireguard wg0 {
address "10.0.0.1/24"
address "fd00:1234:5678::1/64"
description "Peer VPN"
peer peer01 {
allowed-ips "10.0.0.2/32"
allowed-ips "fd00:1234:5678::2/128"
public-key "gVO0f7i3UsdWWkLYOVzawcndBuKC6FggVLWtdkXoFWQ="
}
port "51820"
private-key "{{ .wireguard.wg0.privateKey }}"
}
}
```
**secret-sealed.yaml**
```yaml
wireguard:
wg0:
privateKey: AgBBuKY...
```
**Execute:**
```bash
just-encrypt-yaml --decrypt --key tls.key --out secret.yaml secret-sealed.yaml
gomplate -c ".=secret.yaml" -f config.boot.enc -o config.boot
```
**config.boot**
```groovy
interfaces {
wireguard wg0 {
address "10.0.0.1/24"
address "fd00:1234:5678::1/64"
description "Peer VPN"
peer peer01 {
allowed-ips "10.0.0.2/32"
allowed-ips "fd00:1234:5678::2/128"
public-key "gVO0f7i3UsdWWkLYOVzawcndBuKC6FggVLWtdkXoFWQ="
}
port "51820"
private-key "gJVybSkgiEJLNOUpz8nTfKGUpLXSy6OMvLqLkLIPOUk="
}
}
```
## License
```
MIT License
Copyright (c) 2024 Marc Nguyen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```