vaulthcplib

README

Vault Library: HCP Vault Library

The HCP Vault library is a standalone backend library for use with Hashicorp 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 security@hashicorp.com.

Quick Links

• Vault Website
• Vault Project GitHub

Getting Started

This is a Vault Library 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.

Usage

The HCP Vault library is built into the Vault binary and accessed through the Vault CLI client.

To connect and authenticate to your HCP Vault, use vault hcp connect:

$ vault hcp connect

The Vault CLI authenticates users and machines to HCP Vault using a provided credential or interactively with an HCP token generated through browser login. On a successful authentication, the CLI caches the returned HCP token and current HCP Vault address

By default, the Vault CLI uses interactive authentication and directs users to the HCP login page.

Non-interactive authentication requires service principal credentials previously generated through the HCP portal. The provided credential must have sufficient permission to access the organization, project, and HCP Vault cluster.

For example, to connect with a client ID and secret:

$ vault hcp connect -client-id=client-id-value -secret-id=secret-id-value

You can also target specific organizations, projects, and clusters by providing the relevant identification:

$ vault hcp connect           \
  -client-id=client-id-value  \
  -secret-id=secret-id-value  \
  -organization-id=org-UUID   \
  -project-id=proj-UUID       \
  -cluster-id=cluster-name

To clean HCP credentials from the cache use the disconnect subcommand:

$ vault hcp disconnect

For more information about supported subcommands and options, refer to the Vault CLI documentation.

How to contribute

Thanks for considering contributing to this project. Unfortunately, HashiCorp does not currently accept new contributions for this project.

License

This code is released under the Mozilla Public License 2.0. Please see LICENSE for more details.

Documentation

Index

• Variables
• func InitHCPCommand(ui cli.Ui) map[string]cli.CommandFactory
• type HCPConfigCache
• type HCPConnectCommand
  • func (c *HCPConnectCommand) Flags() *flag.FlagSet
  • func (c *HCPConnectCommand) Help() string
  • func (c *HCPConnectCommand) Run(args []string) int
  • func (c *HCPConnectCommand) Synopsis() string
• type HCPDisconnectCommand
  • func (c *HCPDisconnectCommand) Help() string
  • func (c *HCPDisconnectCommand) Run(_ []string) int
  • func (c *HCPDisconnectCommand) Synopsis() string
• type HCPToken
• type HCPTokenHelper
• type InternalHCPTokenHelper
  • func (h InternalHCPTokenHelper) GetHCPToken(path string) (*HCPToken, error)
• type TestTokenSource
  • func (*TestTokenSource) Token() (*oauth2.Token, error)
• type TestingHCPTokenHelper
  • func (h TestingHCPTokenHelper) GetHCPToken(path string) (*HCPToken, error)

Variables

var (
	ErrorProxyDisabled = fmt.Errorf("proxy is disabled")
)

Functions

func InitHCPCommand

func InitHCPCommand(ui cli.Ui) map[string]cli.CommandFactory

Types

type HCPConfigCache

type HCPConfigCache struct {
	ClientID  string
	SecretID  string
	ProxyAddr string
}

type HCPConnectCommand

type HCPConnectCommand struct {
	Ui cli.Ui
	// contains filtered or unexported fields
}

func (*HCPConnectCommand) Flags

func (c *HCPConnectCommand) Flags() *flag.FlagSet

func (*HCPConnectCommand) Help

func (c *HCPConnectCommand) Help() string

func (*HCPConnectCommand) Run

func (c *HCPConnectCommand) Run(args []string) int

func (*HCPConnectCommand) Synopsis

func (c *HCPConnectCommand) Synopsis() string

type HCPDisconnectCommand

type HCPDisconnectCommand struct {
	Ui cli.Ui
}

func (*HCPDisconnectCommand) Help

func (c *HCPDisconnectCommand) Help() string

func (*HCPDisconnectCommand) Run

func (c *HCPDisconnectCommand) Run(_ []string) int

func (*HCPDisconnectCommand) Synopsis

func (c *HCPDisconnectCommand) Synopsis() string

type HCPToken

type HCPToken struct {
	AccessToken       string    `json:"access_token,omitempty"`
	AccessTokenExpiry time.Time `json:"access_token_expiry,omitempty"`
	ProxyAddr         string    `json:"proxy_addr,omitempty"`
}

type HCPTokenHelper

type HCPTokenHelper interface {
	GetHCPToken(string) (*HCPToken, error)
}

type InternalHCPTokenHelper

type InternalHCPTokenHelper struct{}

func (InternalHCPTokenHelper) GetHCPToken

func (h InternalHCPTokenHelper) GetHCPToken(path string) (*HCPToken, error)

type TestTokenSource

type TestTokenSource struct{}

func (*TestTokenSource) Token

func (*TestTokenSource) Token() (*oauth2.Token, error)

type TestingHCPTokenHelper

type TestingHCPTokenHelper struct {
	ValidCache bool
}

func (TestingHCPTokenHelper) GetHCPToken

func (h TestingHCPTokenHelper) GetHCPToken(path string) (*HCPToken, error)