This is a standalone backend plugin for use with Hashicorp Vault. This plugin allows for JWTs (including OIDC tokens) to authenticate with Vault.
Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault, please responsibly disclose by contacting us at firstname.lastname@example.org.
- Vault Website: https://www.vaultproject.io - JWT Auth Docs: https://www.vaultproject.io/docs/auth/jwt.html - Main Project Github: https://www.github.com/hashicorp/vault
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.
Please see documentation for the plugin on the Vault website.
This plugin is currently built into Vault and by default is accessed
auth/jwt. To enable this in a running Vault server:
$ vault auth enable jwt Successfully enabled 'jwt' at 'jwt'!
To see all the supported paths, see the JWT auth backend docs.
If you wish to work on this plugin, you'll first need Go installed on your machine.
For local dev first make sure Go is properly installed, including
setting up a GOPATH.
Next, clone this repository into
You can then download any required build tools by bootstrapping your
$ make bootstrap
To compile a development version of this plugin, run
This will put the plugin binary in the
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
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/jwt \ sha_256=<expected SHA256 Hex value of the plugin binary> \ command="vault-plugin-auth-jwt" ... Success! Data written to: sys/plugins/catalog/jwt
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-auth-jwt ... SHA256(.../go/bin/vault-plugin-auth-jwt)= 896c13c0f5305daed381952a128322e02bc28a57d0c862a78cbc2ea66e8c6fa1
Enable the auth plugin backend using the JWT auth plugin:
$ vault auth enable -plugin-name='jwt' plugin ... Successfully enabled 'plugin' at 'jwt'!
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
You can also specify a
TESTARGS variable to filter tests like so:
$ make test TESTARGS='--run=TestConfig'