tfc

README

Vault Plugin: Terraform Cloud Secrets Backend

This is a standalone backend plugin for use with Hashicorp Vault. This plugin generates revocable, time-limited API tokens for Terraform Cloud users, as well as manages single API tokens for Terraform teams and Organizations. Please see Terraform Cloud's documentation on API Tokens for more information on the types of API tokens offered by the Terraform Cloud API.

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

• Vault Website
• Terraform Cloud
• Terraform Cloud Secrets Docs
• Terraform Cloud API token documentation
• Vault Github Project

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 terraform. To enable this in a running Vault server:

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

Developing

If you wish to work on this plugin, you'll first need Go installed on your machine (version 1.15.3+ 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-terraform.

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

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

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

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

Successfully enabled 'plugin' at 'terraform'!

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=TestTokenRole'

To run the acceptance tests, invoke make testacc:

$ make testacc

The tests assume environment variables are set to use in order to perform the integration tests. Be sure to use appropriate values and be aware that real tokens will be created and destroyed in the course of running the tests.

Environment variables:

• TF_TOKEN: (required) API token used to configure the engine and make API calls
• TF_ORGANIZATION: (required) The test organization to manage.
• TF_TEAM_ID: (required) The team ID for the test Team to manage.
• TF_USER_ID: (required) The user ID for the user to create dynamic tokens for.
• TF_ADDRESS: (optional) HTTP API address if using Terraform Enterprise. Defaults to https://app.terraform.io for Terraform Cloud.

Documentation

Index

• func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Functions

func Factory

func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Factory returns a new backend as logical.Backend