Skip to content
Vault Azure Secrets plugin
Branch: master
Clone or download
Latest commit dba36e4 Apr 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd/vault-plugin-secrets-azure Bump deps Apr 15, 2019
scripts Initial commit for review (#2) Jul 11, 2018
vendor
.gitignore
.travis.yml Bump travis and make fmt Apr 13, 2019
LICENSE Initial commit Apr 18, 2018
Makefile Remove website docs Aug 21, 2018
README.md Update README.md Oct 4, 2018
backend.go
backend_test.go
client.go Switch to go modules Apr 12, 2019
client_test.go Add new "static service principal" credential type (#14) Oct 17, 2018
go.mod Bump deps Apr 15, 2019
go.sum Bump deps Apr 15, 2019
helpers_test.go
path_config.go Bump travis and make fmt Apr 13, 2019
path_config_test.go Switch to go modules Apr 12, 2019
path_roles.go Bump travis and make fmt Apr 13, 2019
path_roles_test.go Switch to go modules Apr 12, 2019
path_service_principal.go Bump travis and make fmt Apr 13, 2019
path_service_principal_test.go Switch to go modules Apr 12, 2019
provider.go

README.md

Vault Plugin: Azure Secrets Backend Build Status

This is a standalone backend plugin for use with Hashicorp Vault. This plugin generates revocable, time-limited Service Principals for Microsoft Azure.

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 security@hashicorp.com.

Quick Links

Getting Started

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.

Usage

Please see documentation for the plugin on the Vault website.

This plugin is currently built into Vault and by default is accessed at azure. To enable this in a running Vault server:

$ vault secrets enable azure
Success! Enabled the azure secrets engine at: azure/

Developing

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/hashicorp/vault-plugin-secrets-azure. 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/azure \
        sha256=<expected SHA256 Hex value of the plugin binary> \
        command="vault-plugin-secrets-azure"
...
Success! Data written to: sys/plugins/catalog/azure

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-azure
...
SHA256(.../go/bin/vault-plugin-secrets-azure)= 896c13c0f5305daed381952a128322e02bc28a57d0c862a78cbc2ea66e8c6fa1

Enable the auth plugin backend using the secrets enable plugin command:

$ vault secrets enable -plugin-name='azure' plugin
...

Successfully enabled 'plugin' at 'azure'!

Tests

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'
You can’t perform that action at this time.