2020-01-18 00:18:09 +00:00
|
|
|
|
---
|
|
|
|
|
layout: api
|
|
|
|
|
page_title: HANA - Database - Secrets Engines - HTTP API
|
|
|
|
|
description: >-
|
|
|
|
|
The HANA plugin for Vault's database secrets engine generates database
|
|
|
|
|
credentials to access HANA servers.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# HANA Database Plugin HTTP API
|
|
|
|
|
|
|
|
|
|
The HANA database plugin is one of the supported plugins for the database
|
|
|
|
|
secrets engine. This plugin generates database credentials dynamically based on
|
|
|
|
|
configured roles for the HANA database.
|
|
|
|
|
|
|
|
|
|
## Configure Connection
|
|
|
|
|
|
|
|
|
|
In addition to the parameters defined by the [database
|
2020-01-22 20:05:41 +00:00
|
|
|
|
secrets engine](/api/secret/databases#configure-connection), this plugin
|
2020-01-18 00:18:09 +00:00
|
|
|
|
has a number of parameters to further configure a connection.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :----- | :----------------------- | -------- |
|
|
|
|
|
| `POST` | `/database/config/:name` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `connection_url` `(string: <required>)` - Specifies the HANA DSN. This field
|
|
|
|
|
can be templated and supports passing the username and password
|
2021-12-20 20:07:59 +00:00
|
|
|
|
parameters in the following format `{{field_name}}`. A templated connection URL is
|
2020-01-18 00:18:09 +00:00
|
|
|
|
required when using root credential rotation.
|
|
|
|
|
|
2020-01-30 16:33:04 +00:00
|
|
|
|
- `max_open_connections` `(int: 4)` - Specifies the maximum number of open
|
2020-01-18 00:18:09 +00:00
|
|
|
|
connections to the database.
|
|
|
|
|
|
|
|
|
|
- `max_idle_connections` `(int: 0)` - Specifies the maximum number of idle
|
|
|
|
|
connections to the database. A zero uses the value of `max_open_connections`
|
|
|
|
|
and a negative value disables idle connections. If larger than
|
|
|
|
|
`max_open_connections` it will be reduced to be equal.
|
|
|
|
|
|
|
|
|
|
- `max_connection_lifetime` `(string: "0s")` - Specifies the maximum amount of
|
2021-12-20 20:07:59 +00:00
|
|
|
|
time a connection may be reused. If ≤ `0s`, connections are reused forever.
|
2020-01-18 00:18:09 +00:00
|
|
|
|
|
|
|
|
|
- `username` `(string: "")` - The root credential username used in the connection URL.
|
|
|
|
|
|
|
|
|
|
- `password` `(string: "")` - The root credential password used in the connection URL.
|
|
|
|
|
|
2022-08-08 21:01:34 +00:00
|
|
|
|
- `username_template` `(string)` - [Template](/docs/concepts/username-templating) describing how dynamic usernames are generated.
|
|
|
|
|
|
2022-05-18 22:23:46 +00:00
|
|
|
|
- `disable_escaping` `(boolean: false)` - Turns off the escaping of special characters inside of the username
|
2022-02-25 23:43:18 +00:00
|
|
|
|
and password fields. See the [databases secrets engine docs](/docs/secrets/databases#disable-character-escaping)
|
2022-05-18 22:23:46 +00:00
|
|
|
|
for more information. Defaults to `false`.
|
2022-02-25 23:43:18 +00:00
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"plugin_name": "hana-database-plugin",
|
|
|
|
|
"allowed_roles": "readonly",
|
|
|
|
|
"connection_url": "hdb://{{username}}:{{password}}@localhost:1433",
|
|
|
|
|
"max_open_connections": 5,
|
|
|
|
|
"max_connection_lifetime": "5s",
|
|
|
|
|
"username": "username",
|
2021-12-20 20:07:59 +00:00
|
|
|
|
"password": "password"
|
2020-01-18 00:18:09 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2020-01-18 00:18:09 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
|
|
|
|
http://127.0.0.1:8200/v1/database/config/hana
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Statements
|
|
|
|
|
|
|
|
|
|
Statements are configured during role creation and are used by the plugin to
|
|
|
|
|
determine what is sent to the database on user creation, renewing, and
|
|
|
|
|
revocation. For more information on configuring roles see the [Role
|
2022-09-22 15:11:04 +00:00
|
|
|
|
API](/api-docs/secret/databases#create-role) in the database secrets engine docs.
|
2020-01-18 00:18:09 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
The following are the statements used by this plugin. If not mentioned in this
|
|
|
|
|
list the plugin does not support that statement type.
|
|
|
|
|
|
2021-11-15 19:52:04 +00:00
|
|
|
|
- `creation_statements` `(list: <required>)` – Specifies the database
|
2020-01-18 00:18:09 +00:00
|
|
|
|
statements executed to create and configure a user. Must be a
|
|
|
|
|
semicolon-separated string, a base64-encoded semicolon-separated string, a
|
|
|
|
|
serialized JSON string array, or a base64-encoded serialized JSON string
|
2021-12-20 20:07:59 +00:00
|
|
|
|
array. The `{{name}}`, `{{password}}`, and `{{expiration}}` values will be
|
2020-01-18 00:18:09 +00:00
|
|
|
|
substituted.
|
|
|
|
|
|
|
|
|
|
- The expiration time will be HANA server time plus the role's `default_ttl`.
|
|
|
|
|
If `default_ttl` is 0 or not set, a SQL HdbError 438 will be returned.
|
|
|
|
|
|
|
|
|
|
- `revocation_statements` `(list: [])` – Specifies the database statements to
|
|
|
|
|
be executed to revoke a user. Must be a semicolon-separated string, a
|
|
|
|
|
base64-encoded semicolon-separated string, a serialized JSON string array, or
|
2021-12-20 20:07:59 +00:00
|
|
|
|
a base64-encoded serialized JSON string array. The `{{name}}` value will be
|
2020-01-18 00:18:09 +00:00
|
|
|
|
substituted. If not provided, defaults to dropping the user only if they have
|
|
|
|
|
no dependent objects.
|