Database secrets engine

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 built-in 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. These are referred to as "dynamic roles" or "dynamic secrets".

Since every service is 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.

Vault makes use of its own internal revocation system to ensure that users become invalid within a reasonable time of the lease expiring.

Static roles

Vault also supports static roles for all database secrets engines. Static roles are a 1-to-1 mapping of Vault roles to usernames in a database. With static roles, Vault stores and automatically rotates passwords for the associated database user based on a configurable period of time or rotation schedule.

When the database user is onboarded into Vault via the Create static role API, the user's password is automatically rotated. Automatic rotation can be disabled for all roles at the config-level with the skip_static_role_import_rotation field or per role with the skip_import_rotation field.

When a client requests credentials for the static role, Vault returns the current password for whichever database user is mapped to the requested role. With static roles, anyone with the proper Vault policies can access the associated user account in the database.

Schedule-based root credential rotation

Use the rotation_schedule field to configure schedule-based, automatic credential rotation for root credentials in the DB Secrets engine. For example, the following command set the rotation to occur every Saturday at midnight (00:00):

$ vault write database/config/my-mssql-database \
  ...
  rotation_schedule="0 * * * SAT"
  ...

Scheduled root credential rotation can also set a rotation_window during which the scheduled rotation is allowed to occur. Vault will stop trying to rotate the credential once the window expires. For example, the following command tells Vault to rotate the credential on Saturday at midnight, but only within the span of an hour. If Vault cannot rotate the credential by 1:00, due to a failure or otherwise, Vault will stop trying to rotate the credential until the next scheduled rotation.

$ vault write database/config/my-mssql-database \
  ...
  rotation_window="1h" \
  rotation_schedule="0 * * * SAT"
...

You can temporarily disable root rotation by setting disable_automated_rotation to true. Setting the disable_automated_rotation field prevent any rotation of the root credential until the field is reset to false. If you use rotation_period, setting disable_automated_rotation also resets the credential TTL.

For more details on rotating root credentials in the DB Secrets engine, refer to the Rotate Root credentials API docs.

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.

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

$ vault write database/config/my-database \
    plugin_name="..." \
    connection_url="..." \
    allowed_roles="..." \
    username="..." \
    password="..." \

$ vault write -force database/rotate-root/my-database

$ 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

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:

   $ 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           FSREZ1S0kFsZtLat-y94
   username           v-vaultuser-e2978cd0-ugp7iqI2hdlff5hfjylJ-1602537260
   

Database capabilities

As of Vault 1.6, all databases support dynamic roles and static roles. All plugins except MongoDB Atlas support rotating the root user's credentials. MongoDB Atlas cannot support rotating the root user's credentials because it uses a public and private key pair to authenticate.

Custom plugins

This secrets engine allows custom database types to be run through the exposed plugin interface. Please see the custom database plugin for more information.

Credential types

Database systems support a variety of authentication methods and credential types. The database secrets engine supports management of credentials alternative to usernames and passwords. The credential_type and credential_config parameters of dynamic and static roles configure the credential that Vault will generate and make available to database plugins. See the documentation of individual database plugins for the credential types they support and usage examples.

Onboarding static database users

When a static database user is onboarded to the database secrets engine, by default Vault immediately and automatically rotates the database user's password. This immediate rotation can add additional operational overhead to the onboarding process and has proven challenging for some organizations. To address these challenges, you can configure one or more of the following options:

Schedule-based static role rotation

The database secrets engine supports configuring schedule-based automatic credential rotation for static roles with the rotation_schedule field. For example:

$ vault write database/static-roles/my-role \
    db_name=my-database \
    username="vault" \
    rotation_schedule="0 * * * SAT"

This configuration will set the role's credential rotation to occur on Saturday at 00:00.

Additionally, this schedule-based approach allows for optionally configuring a rotation_window in which the automatic rotation is allowed to occur. For example:

$ vault write database/static-roles/my-role \
    db_name=my-database \
    username="vault" \
    rotation_window="1h" \
    rotation_schedule="0 * * * SAT"

This configuration will set rotations to occur on Saturday at 00:00. The 1 hour rotation_window will prevent the rotation from occuring after 01:00. If the static role's credential is not rotated during this window, due to a failure or otherwise, it will not be rotated until the next scheduled rotation.

Password generation

Passwords are generated via Password Policies. Databases can optionally set a password policy for use across all roles or at the individual role level for that database. For example, each time you call vault write database/config/my-database you can specify a password policy for all roles using my-database. Each database has a default password policy defined as: 20 characters with at least 1 uppercase character, at least 1 lowercase character, at least 1 number, and at least 1 dash character.

The default password generation can be represented as the following password policy:

length = 20

rule "charset" {
    charset = "abcdefghijklmnopqrstuvwxyz"
    min-chars = 1
}
rule "charset" {
    charset = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    min-chars = 1
}
rule "charset" {
    charset = "0123456789"
    min-chars = 1
}
rule "charset" {
    charset = "-"
    min-chars = 1
}

Disable character escaping

As of Vault 1.10, you can now specify the option disable_escaping with a value of true in some secrets engines to prevent Vault from escaping special characters in the username and password fields. This is necessary for some alternate connection string formats, such as ADO with MSSQL or Azure SQL. See the databases secrets engine API docs and reference individual plugin documentation to determine support for this parameter.

For example, when the password contains URL-escaped characters like # or % they will remain as so instead of becoming %23 and %25 respectively.

$ vault write database/config/my-mssql-database \
plugin_name="mssql-database-plugin" \
connection_url='server=localhost;port=1433;user id={{username}};password={{password}};database=mydb;' \
username="root" \
password='your#StrongPassword%' \
disable_escaping="true"

Unsupported databases

AWS DynamoDB

Amazon Web Services (AWS) DynamoDB is a fully managed, serverless, key-value NoSQL database service. While DynamoDB is not supported by the database secrets engine, you can use the AWS secrets engine to provision dynamic credentials capable of accessing DynamoDB.

1. Verify you have the AWS secrets engine enabled and configured.

2. Create a role with the necessary permissions for your users to access DynamoDB. For example:

   $ vault write aws/roles/aws-dynamodb-read \
           credential_type=iam_user \
           policy_document=-<<EOF
   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Effect": "Allow",
               "Action": [
                   "dynamodb:DescribeTable",
                   "dynamodb:GetItem",
                   "dynamodb:GetRecords"
               ],
               "Resource": "arn:aws:dynamodb:us-east-1:1234567891:table/example-table"
           },
           {
               "Effect": "Allow",
               "Action": "dynamodb:ListTables",
               "Resource": "*"
           }
       ]
   }
   EOF
   

3. Generate dynamic credentials for DynamoDB using the aws-dynamodb-read role:

   $ vault read aws/creds/aws-dynamodb-read
   Key                Value
   ---                -----
   lease_id           aws/creds/my-role/kbSnl9WSDzOXQerd8GiVh75N.DACNl
   lease_duration     1h
   lease_renewable    true
   access_key         AKALMNOP123456
   secret_key         xY4XhS3AsM3s+R33tCaybsT2XI6BVL+vF+khbbYD
   security_token     <nil>
   

4. Use the dynamic credentials generated by Vault to access DynamoDB. For example, to connect with the the AWS CLI.

   $ aws dynamodb list-tables --region us-east-1
   {
       "TableNames": [
           "example-table"
       ]
   }
   

Tutorial

Refer to the database credential management tutorials to learn how to manage database credential lifecycle with Vault.

API

The database secrets engine has a full HTTP API. Please see the Database secret secrets engine API for more details.