Skip to content

Commit 0ed8bbf

Browse files
[PUBLISH] vault/202509 (#969)
* VSO CSI driver documentation (#691) * Adding documentation for Vault MCP Server (#948) * docs: security model for vault mcp server (#970)
1 parent 35856bf commit 0ed8bbf

File tree

36 files changed

+2270
-320
lines changed

36 files changed

+2270
-320
lines changed

content/vault/v1.16.x/content/api-docs/secret/databases/snowflake.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ has a number of parameters to further configure a connection.
4343

4444
- `connection_url` `(string: <required>)` - Specifies the Snowflake DSN. This field
4545
can be templated and supports passing the username and password
46-
parameters in the following format `{{field_name}}`. A templated connection URL is
47-
required when using root credential rotation.
46+
parameters in the format `{{field_name}}` when you use password authentication.
47+
If you use root credential rotation for passwords, you must provide a templated
48+
connection URL. Refer to the
49+
[Snowflake secrets engine docs](/vault/docs/secrets/databases/snowflake#setup)
50+
for more information on the connection URL format requirements for different
51+
authentication methods.
4852

4953
- `max_open_connections` `(int: 4)` - Specifies the maximum number of open
5054
connections to the database.

content/vault/v1.16.x/content/docs/secrets/databases/snowflake.mdx

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description: |-
1111

1212
<Warning title="Password authentication removal">
1313
Snowflake is disabling password authentication for all users in&nbsp;
14-
<a href="https://www.snowflake.com/en/blog/blocking-single-factor-password-authentification">November of 2025.</a>
15-
&nbsp;HashiCorp is working to support key pair authentication in place of passwords.
14+
<a href="https://www.snowflake.com/en/blog/blocking-single-factor-password-authentification">November of 2025.</a>
15+
&nbsp;HashiCorp has added support for key pair authentication in place of passwords.
1616
</Warning>
1717

1818
Snowflake is one of the supported plugins for the database secrets engine. This plugin
@@ -29,7 +29,7 @@ The Snowflake database secrets engine uses
2929

3030
| Plugin Name | Root Credential Rotation | Dynamic Roles | Static Roles | Username Customization | Credential Types |
3131
| --------------------------- | ------------------------ | ------------- | ------------ | ---------------------- |---------------------------|
32-
| `snowflake-database-plugin` | Yes | Yes | Yes | Yes (1.8+) | password(deprecated), rsa_private_key |
32+
| `snowflake-database-plugin` | Password-only | Yes | Yes | Yes (1.8+) | password(deprecated), rsa_private_key |
3333

3434
## Setup
3535

@@ -43,7 +43,7 @@ The Snowflake database secrets engine uses
4343
By default, the secrets engine will enable at the name of the engine. To
4444
enable the secrets engine at a different path, use the `-path` argument.
4545

46-
1. Configure Vault with the proper plugin and connection information:
46+
1. Configure Vault with userpass authentication:
4747

4848
```shell-session
4949
$ vault write database/config/my-snowflake-database \
@@ -71,9 +71,41 @@ The Snowflake database secrets engine uses
7171

7272
`db_name` is the name of a database in your Snowflake instance.
7373

74-
~> **Note:** The user being utilized should have `ACCOUNT_ADMIN` privileges, and should be different
75-
from the root user you were provided when making your Snowflake account. This allows you to rotate
76-
the root credentials and still be able to access your account.
74+
1. Configure Vault with keypair authentication. Do not provide templated or
75+
hard-coded username or password information in the connection URL if you use
76+
key-pair authentication. The Snowflake plugin appropriately constructs the
77+
full DSN using the provided `username` and `private_key` to authenticate to
78+
Snowflake:
79+
80+
```shell-session
81+
$ vault write database/config/my-snowflake-database \
82+
plugin_name=snowflake-database-plugin \
83+
allowed_roles="my-role" \
84+
connection_url="<account>.snowflakecomputing.com/<db_name>" \
85+
username="vaultuser" \
86+
private_key=@key.pem
87+
```
88+
89+
The connection URL must include the following parameters in addition to any
90+
optional query parameters:
91+
92+
- `account` - your Snowflake account identifier. Refer to the
93+
[`server` section](https://docs.snowflake.com/en/user-guide/odbc-parameters.html#connection-parameters)
94+
of the connection parameters for Snowflake ODBC configuration details.
95+
96+
- `db_name` the name of a database in your Snowflake instance.
97+
98+
For example:
99+
100+
```text
101+
ecxxxx.west-us-1.azure.snowflakecomputing.com/my_app_data
102+
```
103+
104+
105+
You must provide Vault with a Snowflake user that has `ACCOUNT_ADMIN` privileges. We
106+
strongly recommend using a unique user account for Vault access so Vault can
107+
rotate the associated root credentials without disrupting the account associated
108+
with your Snowflake account or other Snowflake users on the account.
77109

78110
## Usage
79111

content/vault/v1.17.x/content/api-docs/secret/databases/snowflake.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ has a number of parameters to further configure a connection.
4343

4444
- `connection_url` `(string: <required>)` - Specifies the Snowflake DSN. This field
4545
can be templated and supports passing the username and password
46-
parameters in the following format `{{field_name}}`. A templated connection URL is
47-
required when using root credential rotation.
46+
parameters in the format `{{field_name}}` when you use password authentication.
47+
If you use root credential rotation for passwords, you must provide a templated
48+
connection URL. Refer to the
49+
[Snowflake secrets engine docs](/vault/docs/secrets/databases/snowflake#setup)
50+
for more information on the connection URL format requirements for different
51+
authentication methods.
4852

4953
- `max_open_connections` `(int: 4)` - Specifies the maximum number of open
5054
connections to the database.

content/vault/v1.17.x/content/docs/secrets/databases/snowflake.mdx

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description: |-
1111

1212
<Warning title="Password authentication removal">
1313
Snowflake is disabling password authentication for all users in&nbsp;
14-
<a href="https://www.snowflake.com/en/blog/blocking-single-factor-password-authentification">November of 2025.</a>
15-
&nbsp;HashiCorp is working to support key pair authentication in place of passwords.
14+
<a href="https://www.snowflake.com/en/blog/blocking-single-factor-password-authentification">November of 2025.</a>
15+
&nbsp;HashiCorp has added support for key pair authentication in place of passwords.
1616
</Warning>
1717

1818
Snowflake is one of the supported plugins for the database secrets engine. This plugin
@@ -29,7 +29,7 @@ The Snowflake database secrets engine uses
2929

3030
| Plugin Name | Root Credential Rotation | Dynamic Roles | Static Roles | Username Customization | Credential Types |
3131
| --------------------------- | ------------------------ | ------------- | ------------ | ---------------------- |---------------------------|
32-
| `snowflake-database-plugin` | Yes | Yes | Yes | Yes (1.8+) | password(deprecated), rsa_private_key |
32+
| `snowflake-database-plugin` | Password-only | Yes | Yes | Yes (1.8+) | password(deprecated), rsa_private_key |
3333

3434
## Setup
3535

@@ -43,7 +43,7 @@ The Snowflake database secrets engine uses
4343
By default, the secrets engine will enable at the name of the engine. To
4444
enable the secrets engine at a different path, use the `-path` argument.
4545

46-
1. Configure Vault with the proper plugin and connection information:
46+
1. Configure Vault with userpass authentication:
4747

4848
```shell-session
4949
$ vault write database/config/my-snowflake-database \
@@ -71,9 +71,40 @@ The Snowflake database secrets engine uses
7171

7272
`db_name` is the name of a database in your Snowflake instance.
7373

74-
~> **Note:** The user being utilized should have `ACCOUNT_ADMIN` privileges, and should be different
75-
from the root user you were provided when making your Snowflake account. This allows you to rotate
76-
the root credentials and still be able to access your account.
74+
1. Configure Vault with keypair authentication. Do not provide templated or
75+
hard-coded username or password information in the connection URL if you use
76+
key-pair authentication. The Snowflake plugin appropriately constructs the
77+
full DSN using the provided `username` and `private_key` to authenticate to
78+
Snowflake:
79+
80+
```shell-session
81+
$ vault write database/config/my-snowflake-database \
82+
plugin_name=snowflake-database-plugin \
83+
allowed_roles="my-role" \
84+
connection_url="<account>.snowflakecomputing.com/<db_name>" \
85+
username="vaultuser" \
86+
private_key=@key.pem
87+
```
88+
89+
The connection URL must include the following parameters (additional query parameters are not supported in Vault 1.17):
90+
91+
- `account` - your Snowflake account identifier. Refer to the
92+
[`server` section](https://docs.snowflake.com/en/user-guide/odbc-parameters.html#connection-parameters)
93+
of the connection parameters for Snowflake ODBC configuration details.
94+
95+
- `db_name` the name of a database in your Snowflake instance.
96+
97+
For example:
98+
99+
```text
100+
ecxxxx.west-us-1.azure.snowflakecomputing.com/my_app_data
101+
```
102+
103+
104+
You must provide Vault with a Snowflake user that has `ACCOUNT_ADMIN` privileges. We
105+
strongly recommend using a unique user account for Vault access so Vault can
106+
rotate the associated root credentials without disrupting the account associated
107+
with your Snowflake account or other Snowflake users on the account.
77108

78109
## Usage
79110

content/vault/v1.18.x/content/api-docs/secret/databases/snowflake.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ has a number of parameters to further configure a connection.
4343

4444
- `connection_url` `(string: <required>)` - Specifies the Snowflake DSN. This field
4545
can be templated and supports passing the username and password
46-
parameters in the following format `{{field_name}}`. A templated connection URL is
47-
required when using root credential rotation.
46+
parameters in the format `{{field_name}}` when you use password authentication.
47+
If you use root credential rotation for passwords, you must provide a templated
48+
connection URL. Refer to the
49+
[Snowflake secrets engine docs](/vault/docs/secrets/databases/snowflake#setup)
50+
for more information on the connection URL format requirements for different
51+
authentication methods.
4852

4953
- `max_open_connections` `(int: 4)` - Specifies the maximum number of open
5054
connections to the database.

content/vault/v1.18.x/content/docs/secrets/databases/snowflake.mdx

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ description: >-
1111

1212
<Warning title="Password authentication removal">
1313
Snowflake is disabling password authentication for all users in&nbsp;
14-
<a href="https://www.snowflake.com/en/blog/blocking-single-factor-password-authentification">November of 2025.</a>
15-
&nbsp;HashiCorp is working to support key pair authentication in place of passwords.
14+
<a href="https://www.snowflake.com/en/blog/blocking-single-factor-password-authentification">November of 2025.</a>
15+
&nbsp;HashiCorp has added support for key pair authentication in place of passwords.
1616
</Warning>
1717

1818
Snowflake is one of the supported plugins for the database secrets engine. This plugin
@@ -29,7 +29,7 @@ The Snowflake database secrets engine uses
2929

3030
| Plugin Name | Root Credential Rotation | Dynamic Roles | Static Roles | Username Customization | Credential Types |
3131
| --------------------------- | ------------------------ | ------------- | ------------ | ---------------------- |---------------------------|
32-
| `snowflake-database-plugin` | Yes | Yes | Yes | Yes (1.8+) | password(deprecated), rsa_private_key |
32+
| `snowflake-database-plugin` | Password-only | Yes | Yes | Yes (1.8+) | password(deprecated), rsa_private_key |
3333

3434
## Setup
3535

@@ -43,7 +43,7 @@ The Snowflake database secrets engine uses
4343
By default, the secrets engine will enable at the name of the engine. To
4444
enable the secrets engine at a different path, use the `-path` argument.
4545

46-
1. Configure Vault with the proper plugin and connection information:
46+
1. Configure Vault with userpass authentication:
4747

4848
```shell-session
4949
$ vault write database/config/my-snowflake-database \
@@ -71,9 +71,41 @@ The Snowflake database secrets engine uses
7171

7272
`db_name` is the name of a database in your Snowflake instance.
7373

74-
~> **Note:** The user being utilized should have `ACCOUNT_ADMIN` privileges, and should be different
75-
from the root user you were provided when making your Snowflake account. This allows you to rotate
76-
the root credentials and still be able to access your account.
74+
1. Configure Vault with keypair authentication. Do not provide templated or
75+
hard-coded username or password information in the connection URL if you use
76+
key-pair authentication. The Snowflake plugin appropriately constructs the
77+
full DSN using the provided `username` and `private_key` to authenticate to
78+
Snowflake:
79+
80+
```shell-session
81+
$ vault write database/config/my-snowflake-database \
82+
plugin_name=snowflake-database-plugin \
83+
allowed_roles="my-role" \
84+
connection_url="<account>.snowflakecomputing.com/<db_name>" \
85+
username="vaultuser" \
86+
private_key=@key.pem
87+
```
88+
89+
The connection URL must include the following parameters in addition to any
90+
optional query parameters:
91+
92+
- `account` - your Snowflake account identifier. Refer to the
93+
[`server` section](https://docs.snowflake.com/en/user-guide/odbc-parameters.html#connection-parameters)
94+
of the connection parameters for Snowflake ODBC configuration details.
95+
96+
- `db_name` the name of a database in your Snowflake instance.
97+
98+
For example:
99+
100+
```text
101+
ecxxxx.west-us-1.azure.snowflakecomputing.com/my_app_data
102+
```
103+
104+
105+
You must provide Vault with a Snowflake user that has `ACCOUNT_ADMIN` privileges. We
106+
strongly recommend using a unique user account for Vault access so Vault can
107+
rotate the associated root credentials without disrupting the account associated
108+
with your Snowflake account or other Snowflake users on the account.
77109

78110
## Usage
79111

content/vault/v1.19.x/content/api-docs/secret/databases/snowflake.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ has a number of parameters to further configure a connection.
4343

4444
- `connection_url` `(string: <required>)` - Specifies the Snowflake DSN. This field
4545
can be templated and supports passing the username and password
46-
parameters in the following format `{{field_name}}`. A templated connection URL is
47-
required when using root credential rotation.
46+
parameters in the format `{{field_name}}` when you use password authentication.
47+
If you use root credential rotation for passwords, you must provide a templated
48+
connection URL. Refer to the
49+
[Snowflake secrets engine docs](/vault/docs/secrets/databases/snowflake#setup)
50+
for more information on the connection URL format requirements for different
51+
authentication methods.
4852

4953
- `max_open_connections` `(int: 4)` - Specifies the maximum number of open
5054
connections to the database.

content/vault/v1.19.x/content/docs/secrets/databases/snowflake.mdx

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -71,34 +71,36 @@ The Snowflake database secrets engine uses
7171

7272
`db_name` is the name of a database in your Snowflake instance.
7373

74-
~> **Note:** The user being utilized should have `ACCOUNT_ADMIN` privileges, and should be different
75-
from the root user you were provided when making your Snowflake account. This allows you to rotate
76-
the root credentials and still be able to access your account.
77-
78-
1. Configure Vault with keypair authentication:
74+
1. Configure Vault with keypair authentication. Do not provide templated or
75+
hard-coded username or password information in the connection URL if you use
76+
key-pair authentication. The Snowflake plugin appropriately constructs the
77+
full DSN using the provided `username` and `private_key` to authenticate to
78+
Snowflake:
7979

8080
```shell-session
8181
$ vault write database/config/my-snowflake-database \
8282
plugin_name=snowflake-database-plugin \
8383
allowed_roles="my-role" \
84-
connection_url="ecxxxx.west-us-1.azure.snowflakecomputing.com/db_name" \
84+
connection_url="<account>.snowflakecomputing.com/<db_name>" \
8585
username="vaultuser" \
8686
private_key=@key.pem
8787
```
8888

89-
You must provide properly formatted data source names (DSN) when you configure
90-
the database in the following format. When using key-pair authentication, do not
91-
provide any templates in the DSN:
89+
The connection URL must include the following parameters in addition to any
90+
optional query parameters:
91+
92+
- `account` - your Snowflake account identifier. Refer to the
93+
[`server` section](https://docs.snowflake.com/en/user-guide/odbc-parameters.html#connection-parameters)
94+
of the connection parameters for Snowflake ODBC configuration details.
9295

93-
```shell-session
94-
<account>.snowflakecomputing.com/<db_name>
95-
```
96+
- `db_name` the name of a database in your Snowflake instance.
9697

97-
- `account` - your Snowflake account identifier. Refer to the
98-
[`server` section](https://docs.snowflake.com/en/user-guide/odbc-parameters.html#connection-parameters)
99-
of the connection parameters for Snowflake ODBC configuration for further details.
98+
For example:
99+
100+
```text
101+
ecxxxx.west-us-1.azure.snowflakecomputing.com/my_app_data
102+
```
100103

101-
- `db_name` the name of a database in your Snowflake instance.
102104

103105
You must provide Vault with a Snowflake user that has `ACCOUNT_ADMIN` privileges. We
104106
strongly recommend using a unique user account for Vault access so Vault can

content/vault/v1.20.x/content/api-docs/secret/databases/snowflake.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ has a number of parameters to further configure a connection.
4343

4444
- `connection_url` `(string: <required>)` - Specifies the Snowflake DSN. This field
4545
can be templated and supports passing the username and password
46-
parameters in the following format `{{field_name}}`. A templated connection URL is
47-
required when using root credential rotation.
46+
parameters in the format `{{field_name}}` when you use password authentication.
47+
If you use root credential rotation for passwords, you must provide a templated
48+
connection URL. Refer to the
49+
[Snowflake secrets engine docs](/vault/docs/secrets/databases/snowflake#setup)
50+
for more information on the connection URL format requirements for different
51+
authentication methods.
4852

4953
- `max_open_connections` `(int: 4)` - Specifies the maximum number of open
5054
connections to the database.

content/vault/v1.20.x/content/docs/auth/approle/approle-pattern.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ In any trusted broker situation, the broker (in this case, the Jenkins worker) m
301301
Also, as the Vault audit logs provide time-stamped events, monitor the whole process with alerts on two events:
302302

303303
- When a wrapped SecretID is requested for an AppRole, and no Jenkins job is running
304-
- When the Jenkins slave attempts to unwrap the token and Vault refuses as the token has already been used
304+
- When the Jenkins agent attempts to unwrap the token and Vault refuses as the token has already been used
305305

306306
In both cases, this shows that the trusted-broker workflow has likely been compromised and the event should investigated.
307307

@@ -311,3 +311,4 @@ In both cases, this shows that the trusted-broker workflow has likely been compr
311311
- [Response wrapping concept](/vault/docs/concepts/response-wrapping)
312312
- [ACL policies](/vault/docs/concepts/policies)
313313
- [Token periods and TTLs](/vault/docs/concepts/tokens#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
314+
- [Vault Secrets Operator CSI driver](/vault/docs/platform/k8s/vso/csi) for providing response-wrapped secret IDs to Kubernetes pods

0 commit comments

Comments
 (0)