steampipe-plugin-vault

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 10, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

README

Hashicorp Vault Plugin for Steampipe

Query HashiCorp Vault with SQL

Use SQL to query Vault. Example:

select * from vault_engine

Get Started

Installation
steampipe plugin install theapsgroup/vault

Or if you prefer, you can clone this repository and build/install from source directly.

go build -o steampipe-plugin-vault.plugin

mv steampipe-plugin-vault.plugin ~/.steampipe/plugins/hub.steampipe.io/plugins/theapsgroup/vault@latest/steampipe-plugin-vault.plugin

Alternatively, make install will do the same steps as above.

Copy the basic configuration:

cp config/vault.spc ~/.steampipe/config/vault.spc
Configuration

Currently, two authentication methods are supported. Token authentication, and AWS IAM role authentication.

Configuration can be done by following the Vault cli environment variables:

  • VAULT_ADDR for the address of your Vault Server
  • VAULT_TOKEN for the API token used to access Vault

However, these can also be set in the configuration file:

vi ~/.steampipe/config/vault.spc

AWS Authentication

In addition to the VAULT_TOKEN environment variable, the plugin can also authenticate using AWS IAM role credentials. This works via the AWS authentication backend in Vault (more info). Configuration is done in the vault.spc file.

For example:

connection "vault" {
  plugin = "theapsgroup/vault"

  address = "https://your-vault-domain/"

  # One of "aws" or "token"
  auth_type = "aws"
  # The name of the aws auth backend role in vault
  aws_role = "steampipe-role"
  # The mount path of the aws auth backend (default would be "aws")
  aws_provider = "awspath"
}

Note: In line with the vault cli, if you provide VAULT_TOKEN that will be used INSTEAD of the aws authentication method

Testing Installation
steampipe query "select * from vault_engine"

Documentation

Further documentation can he found here

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL