This secrets engine is a part of the Database Secrets Engine. If you have not read the
Database Backend page, please do so now as it explains how to set up the database backend and
gives an overview of how the engine functions.
Oracle is one of the supported plugins for the database secrets engine. It is capable of dynamically generating
credentials based on configured roles for Oracle databases. It also supports Static Roles.
The Oracle database plugin is not bundled in the core Vault code tree and can be
found at its own git repository here:
hashicorp/vault-plugin-database-oracle
This plugin is not compatible with Alpine Linux out of the box.
The Oracle Database Plugin does not live in the core Vault code tree and can be found
at its own git repository here: hashicorp/vault-plugin-database-oracle
For linux/amd64, pre-built binaries can be found at the releases page
Before running the plugin you will need to have the the Oracle Instant Client
library installed. These can be downloaded from Oracle. The libraries will need to
be placed in the default library search path or defined in the ld.so.conf configuration files.
If you are running Vault with mlock enabled,
you will need to enable ipc_lock capabilities for the plugin binary.
Enable the database secrets engine if it is not already enabled:
If the version of Oracle you are using has a container database, you will need to connect to one of the
pluggable databases rather than the container database in the connection_url field.
It is highly recommended that you immediately rotate the "root" user's password, see
Rotate Root Credentials for more details.
This will ensure that only Vault is able to access the "root" user that Vault uses to
manipulate dynamic & static credentials.
Use caution: the root user's password will not be accessible once rotated so it is highly
recommended that you create a user for Vault to utilize rather than using the actual root user.
Configure a role that maps a name in Vault to an SQL statement to execute to
create the database credential:
$ vault write database/roles/my-role \db_name=my-oracle-database \creation_statements='CREATE USER {{username}} IDENTIFIED BY "{{password}}"; GRANT CONNECT TO {{username}}; GRANT CREATE SESSION TO {{username}};'\default_ttl="1h"\max_ttl="24h"
Success! Data written to: database/roles/my-role
$ vault write database/roles/my-role \db_name=my-oracle-database \creation_statements='CREATE USER {{username}} IDENTIFIED BY "{{password}}"; GRANT CONNECT TO {{username}}; GRANT CREATE SESSION TO {{username}};'\default_ttl="1h"\max_ttl="24h"Success! Data written to: database/roles/my-role
Note: The creation_statements may be specified in a file and interpreted by the Vault CLI using the @ symbol:
If the Oracle server Vault is trying to connect to uses an SSL listener, the database
plugin will require additional configuration using the connection_url parameter:
For example, the SSL server certificate distinguished name and path to the Oracle Wallet
to use for connection and verification could be configured using:
Note: The wallets used when connecting via SSL should be available on every Vault
server when using high availability clusters.
The wallet used by Vault should be in a well known location with the proper filesystem permissions. For example, if Vault is running as the vault user,
the wallet directory may be setup as follows:
Note: The tnsnames.ora file and environment variable used when connecting via SSL should
be available on every Vault server when using high availability clusters.
Vault can optionally use TNS Names in the connection string when connecting to Oracle databases using a tnsnames.ora file. An example
of a tnsnames.ora file may look like the following:
