Vault secrets plugin for Keycloak. Manage keycloak client secret credentials via Hashicorp Vault
- Vault Website: https://www.vaultproject.io
- Keycloak Website: https://www.keycloak.org
This is a Vault plugin and is meant to work with Vault. This guide assumes you have already installed Vault and have a basic understanding of how Vault works.
Otherwise, first read this guide on how to get started with Vault.
To learn specifically about how plugins work, see documentation on Vault plugins.
Method | Path | Produces |
---|---|---|
POST |
/keycloak/config/connection |
200 (application/json) |
url
(string)
- Specifies the url to the keycloak server, format should be: http://127.0.0.1:8080username
(string)
- Specifies the username to authenticate to keycloak withpassword
(string)
- Specifies the password for the user to authenticate to keycloak withrealm
(string)
- Specifies the realm in which the client(s) which credentials will be requested for as well as the user exists
Method | Path | Produces |
---|---|---|
GET |
/keycloak/creds/:name |
200 (application/json) |
name
(string)
- Specifies the name of the keycloak client to request the credentials for
$ vault secrets enable keycloak
Success! Enabled the keycloak secrets engine at: keycloak/
$ vault write keycloak/config/connection url=http://localhost:8080 username=admin password=password realm=master
$ vault read keycloak/creds/clientName
If you wish to work on this plugin, you'll first need Go installed on your machine (version 1.10+ is required).
For local dev first make sure Go is properly installed, including
setting up a GOPATH.
Next, clone this repository into
$GOPATH/src/github.com/gregdurham/vault-plugin-secrets-keycloak
.
You can then download any required build tools by bootstrapping your
environment:
$ make bootstrap
To compile a development version of this plugin, run make
or make dev
.
This will put the plugin binary in the bin
and $GOPATH/bin
folders. dev
mode will only generate the binary for your platform and is faster:
$ make
$ make dev
Put the plugin binary into a location of your choice. This directory
will be specified as the plugin_directory
in the Vault config used to start the server.
...
plugin_directory = "path/to/plugin/directory"
...
Start a Vault server with this config file:
$ vault server -config=path/to/config.json ...
...
Once the server is started, register the plugin in the Vault server's plugin catalog:
$ vault write sys/plugins/catalog/secret/keycloak \
sha_256=<expected SHA256 Hex value of the plugin binary> \
command="vault-plugin-secrets-keycloak"
...
Success! Data written to: sys/plugins/catalog/secret/keycloak
Note you should generate a new sha256 checksum if you have made changes to the plugin. Example using openssl:
openssl dgst -sha256 $GOPATH/vault-plugin-secrets-keycloak
...
SHA256(.../go/bin/vault-plugin-secrets-keycloak)= 896c13c0f5305daed381952a128322e02bc28a57d0c862a78cbc2ea66e8c6fa1
Enable the secrets plugin backend using the secrets enable plugin command:
$ vault secrets enable keycloak
...
Successfully enabled 'plugin' at 'keycloak'!
If you are developing this plugin and want to verify it is still functioning (and you haven't broken anything else), we recommend running the tests.
To run the tests, invoke make test
:
$ make test
You can also specify a TESTARGS
variable to filter tests like so:
$ make test TESTARGS='--run=TestConfig'