uuid

README

Vault UUID Secrets Plugin

UUID is an example secrets engine plugin for HashiCorp Vault. It is meant for demonstration purposes only and should never be used in production.

This engine was copied and modified from the example secrets/mock plugin from the hashicorp/vault-guides repository.

Usage

All commands can be run using the provided Makefile. However, it may be instructive to look at the commands to gain a greater understanding of how Vault registers plugins. Using the Makefile will result in running the Vault server in dev mode. Do not run Vault in dev mode in production. The dev server allows you to configure the plugin directory as a flag, and automatically registers plugin binaries in that directory. In production, plugin binaries must be manually registered.

This will build the plugin binary and start the Vault dev server:

# Build UUID plugin and start Vault dev server with plugin automatically registered
$ make all

Now open a new terminal window and run the following commands:

# Open a new terminal window and export Vault dev server http address
$ export VAULT_ADDR='http://127.0.0.1:8200'

# Enable the UUID plugin
$ make enable

# Write a secret to the UUID secrets engine
$ vault write -f uuid/new
Key     Value
---     -----
uuid    fd1822bf-ff56-50cd-5680-dc513a0c5582

Documentation

Overview

Package uuid is an example Vault secrets plugin

Index

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

Constants

const SecretUUIDType = "uuid"

SecretUUIDType is the name used to identify this type

Functions

func Factory

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

Factory configures and returns uuid backends