Like numtide/systemd-vault but for OpenBao.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
bors[bot] 74e1a266be
Merge #22
22: add github settings r=Mic92 a=Mic92



Co-authored-by: Jörg Thalheim <joerg@thalheim.io>
2 years ago
.github add github settings 2 years ago
etc update Description of systemd-vaultd systemd units 2 years ago
nix fix changeAction==none case 2 years ago
tests apply treefmt 2 years ago
.gitignore update end-to-end procfile example 2 years ago
LICENSE Create LICENSE 2 years ago
Makefile add README + services 2 years ago
Procfile make the Procfile executable 2 years ago
README.md apply treefmt 2 years ago
bors.toml update bors configuration 2 years ago
default.nix apply treefmt 2 years ago
epoll.go epoll: don't log errors if fd already has been removed 2 years ago
flake.lock switch to nixos-unstable-small 2 years ago
flake.nix switch to nixos-unstable-small 2 years ago
go.mod rename project to systemd-vaultd 2 years ago
justfile fix defaults for systemd runtime directory 2 years ago
main.go add support for environment variables 2 years ago
pyproject.toml apply treefmt 2 years ago
secrets.go add support for environment variables 2 years ago
setup.cfg mvp + tests 2 years ago
systemd_sockets.go implement systemd socket activation 2 years ago
watcher.go add support for environment variables 2 years ago

README.md

systemd-vaultd - load vault credentials with systemd units

Mostly written in a train

  • Jörg Thalheim

systemd-vaultd is a proxy between systemd and vault agent. It provides a unix socket that can be used in systemd services in the LoadCredential option and then waits for vault agent to write these secrets in json format at /run/systemd-vaultd/<service_name>.service.json.

This project's goal is to simplify the loading of HashiCorp Vault secrets from systemd units.

Problem statement

Systemd has an option called LoadCredentials that allows to provide credentials to a service:

# myservice.service
[Service]
ExecStart=/usr/bin/myservice.sh
LoadCredential=foobar:/etc/myfoobarcredential.txt

In this case systemd will load credential the file /etc/myfoobarcredential.txt and provide it to the service at $CREDENTIAL_PATH/foobar.

It's handy because it bypasses file permission issues. /etc/myfoobarcredential.txt can be owned by root, and the unit run as a different or dynamic user.

While vault agent also supports writing these secrets, a major issue is that the consumer service may be started before vault agent was able to retrieve secrets from vault. In that case, systemd would fail to start the service.

The solution

In order to do so, I wrote a systemd-vaultd service which acts as a proxy between systemd and vault agent that is running on the machine. It provides a unix socket that can be used in systemd services in the LoadCredential option and then waits for vault agent to write these secrets at /run/systemd-vaultd/<service_name>.json.

We take advantage that in addition to normal paths, systemd also supports loading credentials from unix sockets.

With systemd-vaultd the service myservice.service would look like this:

[Service]
ExecStart=/usr/bin/myservice.sh
LoadCredential=foobar:/run/systemd-vaultd/sock

vault agent is then expected to write secrets to /run/systemd-vaultd/ in json format.

template {
  # this exposes all secrets in `secret/my-secret` to the service
  contents = "#{{ with secret \"secret/my-secret\" }}{{ .Data.data | toJSON }}{{ end }}"

  # an alternative is to expose only selected secrets like this:
  #  contents = <<EOF
  #  {{ with secret "secret/my-secret" }}{{ scratch.MapSet "secrets" "foobar" .Data.data.foo }}{{ end }}
  #  {{ scratch.Get "foobar" | explodeMap | toJSON }}
  #  EOF

  destination  = "/run/systemd-vaultd/secrets/myservice.service.json"
}

When myservice is started, systemd will open a connection to systemd-vaultd's socket. systemd-vaultd then either serve the secrets from /run/systemd-vaultd/secrets/myservice.service.json or it waits with inotify on secret directory for vault agent to write the secret.

Once the file /run/systemd-vaultd/secrets/myservice.service.json is present, systemd-vaultd will parse it into a json map and lookup the keys specified in LoadCredential.

Installation

The installation requires a go compiler and make to be installed.

This command will install the systemd-vaultd binary to /usr/bin/systemd-vaultd as well as installing a following systemd unit files: systemd-vaultd.service, systemd-vaultd.socket:

make install

License

Copyright (c) 2022 Jörg Thalheim and contributors.

This project is free software, and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained by Numtide.

Need help or support? Contact us