2017-05-02 20:26:32 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2017-09-20 20:05:00 +00:00
|
|
|
page_title: "Database - Secrets Engines"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
sidebar_title: "Databases"
|
2017-05-02 20:26:32 +00:00
|
|
|
sidebar_current: "docs-secrets-databases"
|
|
|
|
description: |-
|
2017-09-20 20:05:00 +00:00
|
|
|
The database secrets engine generates database credentials dynamically based
|
|
|
|
on configured roles. It works with a number of different databases through a
|
|
|
|
plugin interface. There are a number of builtin database types and an exposed
|
|
|
|
framework for running custom database types for extendability.
|
2017-05-02 20:26:32 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Databases
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
The database secrets engine generates database credentials dynamically based on
|
|
|
|
configured roles. It works with a number of different databases through a plugin
|
|
|
|
interface. There are a number of builtin database types and an exposed framework
|
|
|
|
for running custom database types for extendability. This means that services
|
|
|
|
that need to access a database no longer need to hardcode credentials: they can
|
|
|
|
request them from Vault, and use Vault's leasing mechanism to more easily roll
|
|
|
|
keys.
|
2017-05-03 05:24:31 +00:00
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
Since every service accessing the database with unique credentials, it makes
|
|
|
|
auditing much easier when questionable data access is discovered. You can track
|
|
|
|
it down to the specific instance of a service based on the SQL username.
|
2017-05-03 05:24:31 +00:00
|
|
|
|
|
|
|
Vault makes use of its own internal revocation system to ensure that users
|
|
|
|
become invalid within a reasonable time of the lease expiring.
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
## Setup
|
|
|
|
|
|
|
|
Most secrets engines must be configured in advance before they can perform their
|
|
|
|
functions. These steps are usually completed by an operator or configuration
|
|
|
|
management tool.
|
|
|
|
|
|
|
|
1. Enable the database secrets engine:
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault secrets enable database
|
|
|
|
Success! Enabled the database secrets engine at: database/
|
|
|
|
```
|
|
|
|
|
|
|
|
By default, the secrets engine will enable at the name of the engine. To
|
|
|
|
enable the secrets engine at a different path, use the `-path` argument.
|
|
|
|
|
|
|
|
1. Configure Vault with the proper plugin and connection information:
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault write database/config/my-database \
|
|
|
|
plugin_name="..." \
|
|
|
|
connection_url="..." \
|
2018-04-09 16:20:29 +00:00
|
|
|
allowed_roles="..." \
|
|
|
|
username="..." \
|
|
|
|
password="..."
|
2017-09-20 20:05:00 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
This secrets engine can configure multiple database connections. For details
|
|
|
|
on the specific configuration options, please see the database-specific
|
|
|
|
documentation.
|
|
|
|
|
|
|
|
1. Configure a role that maps a name in Vault to an SQL statement to execute to create the database credential:
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault write database/roles/my-role \
|
|
|
|
db_name=my-database \
|
|
|
|
creation_statements="..." \
|
|
|
|
default_ttl="1h" \
|
|
|
|
max_ttl="24h"
|
|
|
|
Success! Data written to: database/roles/my-role
|
|
|
|
```
|
|
|
|
|
|
|
|
The `{{name}}` and `{{password}}` fields will be populated by the plugin
|
|
|
|
with dynamically generated values. In some plugins the `{{expiration}}`
|
|
|
|
field is also be supported.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
After the secrets engine is configured and a user/machine has a Vault token with
|
|
|
|
the proper permission, it can generate credentials.
|
|
|
|
|
|
|
|
1. Generate a new credential by reading from the `/creds` endpoint with the name
|
|
|
|
of the role:
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault read database/creds/my-role
|
|
|
|
Key Value
|
|
|
|
--- -----
|
|
|
|
lease_id database/creds/my-role/2f6a614c-4aa2-7b19-24b9-ad944a8d4de6
|
|
|
|
lease_duration 1h
|
|
|
|
lease_renewable true
|
|
|
|
password 8cab931c-d62e-a73d-60d3-5ee85139cd66
|
|
|
|
username v-root-e2978cd0-
|
|
|
|
```
|
2017-05-03 05:24:31 +00:00
|
|
|
|
2017-06-06 13:49:49 +00:00
|
|
|
## Custom Plugins
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
This secrets engine allows custom database types to be run through the exposed
|
|
|
|
plugin interface. Please see the [custom database
|
2017-06-06 13:49:49 +00:00
|
|
|
plugin](/docs/secrets/databases/custom.html) for more information.
|
|
|
|
|
2017-05-03 05:24:31 +00:00
|
|
|
## API
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
The database secrets engine has a full HTTP API. Please see the [Database secret
|
|
|
|
secrets engine API](/api/secret/databases/index.html) for more details.
|