README
¶
Vault Plugin: AliCloud Platform Secrets Backend
This is a backend plugin to be used with Hashicorp Vault. This plugin generates unique, ephemeral API keys and STS credentials.
Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault or with this plugin, please responsibly disclose by contacting us at security@hashicorp.com.
Quick Links
Usage
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.
If you are using Vault 11.0.1 or above, this plugin is packaged with Vault and by default can be enabled by running:
$ vault secrets enable alicloud
Success! Enabled the alicloud secrets engine at: alicloud/
If you are testing this plugin in an earlier version of Vault or want to develop, see the next section.
Developing
If you wish to work on this plugin, you'll first need Go installed on your machine (whichever version is required by Vault).
Make sure Go is properly installed, including setting up a GOPATH.
Get Plugin
Clone this repository:
mkdir $GOPATH/src/github.com/hashicorp/vault-plugin-secrets-alicloud`
cd $GOPATH/src/github.com/hashicorp/
git clone https://github.com/hashicorp/vault-plugin-secrets-alicloud.git
(or use go get github.com/hashicorp/vault-plugin-secrets-alicloud ).
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
Install Plugin in Vault
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/alicloudsecrets \
sha_256="$(shasum -a 256 path/to/plugin/directory/vault-plugin-secrets-alicloud | cut -d " " -f1)" \
command="vault-plugin-secrets-alicloud"
Any name can be substituted for the plugin name "alicloudsecrets". This name will be referenced in the next step, where we enable the secrets plugin backend using the AliCloud secrets plugin:
$ vault secrets enable --plugin-name='alicloudsecrets' --path="alicloud" plugin
Tests
This plugin has both integration tests, and acceptance tests.
The integration tests are run by $ make test and rather than firing real
API calls, they fire API calls at a local test server that returns expected
responses.
The acceptance tests fire real API calls, and are located in acceptance_test.go.
These should be run once as a final step before placing a PR. Please see
acceptance_test.go to learn the environment variables that will need to be set.
Warning: The acceptance tests create/destroy/modify real resources, which may incur real costs in some cases. In the presence of a bug, it is technically possible that broken backends could leave dangling data behind. Therefore, please run the acceptance tests at your own risk. At the very least, we recommend running them in their own private account for whatever backend you're testing.
To run the acceptance tests, after exporting the necessary environment variables,
from the home directory run go test:
$ go test
Documentation
Source Files
Directories