-
Notifications
You must be signed in to change notification settings - Fork 79
[VAULT] GA to RC sync 20251002 #1052
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: vault/1.21.x
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -559,13 +559,15 @@ $ curl \ | |
## Submit CA information | ||
|
||
This endpoint allows submitting the CA information for the secrets engine via an SSH | ||
key pair. _If you have already set a certificate and key, they will be | ||
overridden._ | ||
key pair. If you call submit CA with an existing certificate or key, the | ||
endpoint returns an error. To update existing values, call the delete CA | ||
information endpoint before calling the submit endpoint. | ||
|
||
| Method | Path | | ||
| :----- | :--------------- | -------------------------- | | ||
| `POST` | `/ssh/config/ca` | `200/204 application/json` | | ||
|
||
|
||
### Parameters | ||
|
||
- `private_key` `(string: "")` – Specifies the private key part the SSH CA key | ||
|
@@ -649,7 +651,8 @@ This endpoint recovers the CA information for the backend via an SSH key pair. | |
|
||
### Headers | ||
|
||
- `X-Vault-Recover-Snapshot-Id` `(string: <required>)` - The ID of a snapshot previously loaded into Vault that contains SSH CA information. | ||
- `X-Vault-Recover-Snapshot-Id` `(string: <required>)` - The ID of a snapshot | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
previously loaded into Vault that contains SSH CA information. | ||
|
||
### Sample request | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -70,6 +70,7 @@ values set here cannot be changed after key creation. | |
- `aes256-cmac` - AES-256 CMAC (CMAC generation, verification) <EnterpriseAlert inline="true" /> | ||
- `ml-dsa` - ML-DSA (asymmetric) (experimental) <EnterpriseAlert inline="true" /> | ||
- `hybrid` - hybrid signatures combining a post-quantum algorithm and an elliptic curve algorithm (asymmetric) (experimental) <EnterpriseAlert inline="true" /> | ||
- `slh-dsa` - SLH-DSA (asymmetric) (experimental) <EnterpriseAlert inline="true" /> | ||
- `aes128-cbc` - AES-128 in CBC mode (symmetric, supports derivation and convergent encryption) | ||
- `aes256-cbc` - AES-256 in CBC mode (symmetric, supports derivation and convergent encryption) | ||
|
||
|
@@ -102,8 +103,14 @@ values set here cannot be changed after key creation. | |
hour. Uses [duration format strings](/vault/docs/concepts/duration-format). | ||
- `managed_key_name` `(string: "")` - The name of the managed key to use for this transit key. | ||
- `managed_key_id` `(string: "")` - The UUID of the managed key to use for this transit key. | ||
- `parameter_set` `(string:"")` - The parameter set to use for ML-DSA. Required for | ||
ML-DSA and hybrid keys. Valid values are `44`, `65`, and `87`. | ||
- `parameter_set` `(string:"")` - The parameter set to use for ML-DSA or SLH-DSA. | ||
Required for ML-DSA, SLH-DSA, and hybrid keys. Must be one of the following: | ||
- ML-DSA - `44`, `65`, `87` | ||
- SLH-DSA - `slh-dsa-sha2-128s`, `slh-dsa-shake-128s`, `slh-dsa-sha2-128f`, | ||
`slh-dsa-shake-128`, `slh-dsa-sha2-192s`, | ||
`slh-dsa-shake-192s`, `slh-dsa-sha2-192f`, `slh-dsa-shake-192f`, | ||
`slh-dsa-sha2-256s`, `slh-dsa-shake-256s`, | ||
`slh-dsa-sha2-256f`, and `slh-dsa-shake-256f` | ||
- `hybrid_key_type_pqc` `(string: "")` - The post-quantum algorithm to use for hybrid signatures. | ||
Currently, ML-DSA is the only supported key type. | ||
- `hybrid_key_type_ec` `(string: "")` - The elliptic curve algorithm to use for hybrid signatures. | ||
|
@@ -834,8 +841,9 @@ will be returned. | |
derivation. This is required if key derivation is enabled for this key. | ||
|
||
- `key_version` `(int: 0)` – Specifies the version of the key to use for | ||
encryption. If not set, uses the latest version. Must be greater than or | ||
equal to the key's `min_encryption_version`, if set. | ||
encryption. Leave `key_version` unset to use the latest version. `key_version` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The version on the |
||
must be unset or greater than or equal to the associated | ||
`min_encryption_version` value. | ||
|
||
- `nonce` `(string: "")` – Specifies the **base64 encoded** nonce value. This | ||
must be provided if convergent encryption is enabled for this key and the key | ||
|
@@ -1073,8 +1081,9 @@ functionality to untrusted users or scripts. | |
derivation. This is required if key derivation is enabled. | ||
|
||
- `key_version` `(int: 0)` – Specifies the version of the key to use for the | ||
operation. If not set, uses the latest version. Must be greater than or equal | ||
to the key's `min_encryption_version`, if set. | ||
operation. Leave `key_version` unset to use the latest version. `key_version` | ||
must be unset or greater than or equal to the associated | ||
`min_encryption_version` value. | ||
|
||
- `nonce` `(string: "")` – Specifies a base64 encoded nonce value used during | ||
encryption. Must be provided if convergent encryption is enabled for this key | ||
|
@@ -1180,6 +1189,11 @@ then made available to trusted users. | |
It is recommended that the default of OAEP be used unless specific backwards | ||
compatibility is required. | ||
|
||
- `key_version` `(int: 0)` – Specifies the version of the key to use for the | ||
operation. Leave `key_version` unset to use the latest version. `key_version` | ||
must be unset or greater than or equal to the associated | ||
`min_encryption_version` value. | ||
|
||
### Sample payload | ||
|
||
```json | ||
|
@@ -1405,8 +1419,9 @@ be used. | |
generate hmac against. This is specified as part of the URL. | ||
|
||
- `key_version` `(int: 0)` – Specifies the version of the key to use for the | ||
operation. If not set, uses the latest version. Must be greater than or equal | ||
to the key's `min_encryption_version`, if set. | ||
operation. Leave `key_version` unset to use the latest version. `key_version` | ||
must be unset or greater than or equal to the associated | ||
`min_encryption_version` value. | ||
|
||
- `algorithm` `(string: "sha2-256")` – Specifies the hash algorithm to use. This | ||
can also be specified as part of the URL. Currently-supported algorithms are: | ||
|
@@ -1536,8 +1551,9 @@ supports signing. | |
use for signing. This is specified as part of the URL. | ||
|
||
- `key_version` `(int: 0)` – Specifies the version of the key to use for | ||
signing. If not set, uses the latest version. Must be greater than or equal | ||
to the key's `min_encryption_version`, if set. | ||
signing. Leave `key_version` unset to use the latest version. `key_version` | ||
must be unset or greater than or equal to the associated | ||
`min_encryption_version` value. | ||
|
||
- `hash_algorithm` `(string: "sha2-256")` – Specifies the hash algorithm to use for | ||
supporting key types (notably, not including `ed25519` which specifies its | ||
|
@@ -1937,8 +1953,9 @@ argument to verify returned CMACs. | |
CMAC function. This is specified as part of the URL. | ||
|
||
- `key_version` `(int: 0)` – Specifies the version of the key to use for the | ||
operation. If not set, uses the latest version. Must be greater than or equal | ||
to the key's `min_encryption_version`, if set. | ||
operation. Leave `key_version` unset to use the latest version. `key_version` | ||
must be unset or greater than or equal to the associated | ||
`min_encryption_version` value. | ||
|
||
- `input` `(string: "")` – Specifies the **base64 encoded** input data. One of | ||
`input` or `batch_input` must be supplied. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -211,6 +211,18 @@ The `start_time` in the response is the earliest time there is activity data | |
in the queried period. The `end_time` is the end of the final month of the queried | ||
period. | ||
|
||
The `/sys/internal/counters` endpoint only supports monthly granularity. As a | ||
result, the `start_time` and `end_time` values in API reponses are normalized to | ||
align with full calendar months. | ||
|
||
Normalization occurs whether you provide explicit times in the request or use | ||
the defaults: | ||
|
||
- `start_time` normalizes to the start of the month in which the effective | ||
`start_time` falls. | ||
- `end_time` normalizes to the end of the month in which the effective | ||
`end_time` falls. | ||
|
||
- If the `end_date` supplied to the API is the current month, exact activity | ||
information will be returned for all months in the queried period. The last element | ||
in the `months` response stanza will signify the current month. | ||
|
@@ -464,9 +476,15 @@ is unknown. | |
|
||
### Parameters | ||
|
||
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the start of the | ||
period for which client counts will be reported. If no start time is specified, the billing start date will be used. | ||
The [billing start date](/vault/docs/concepts/billing-start-date) automatically rolls over to the latest billing year at the end of the last cycle. | ||
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This revision might be a new change, on |
||
Specifies the start of the period for which client counts will be reported. | ||
Vault uses the [billing start date](/vault/docs/concepts/billing-start-date) | ||
by default, which automatically rolls over to the latest billing year at the | ||
end of the last cycle. Vault Community **requires** `start_time`, but Vault | ||
Enterprise uses the billing start date as defined by the cluster license by | ||
default. Vault Community does not have a billing start time, so ommitting | ||
`start_time` can lead to undefined behavior. We recommend setting an explicit | ||
start time to ensure reliable behavior in all Vault versions. | ||
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the end of the period | ||
for which client counts will be reported. If no end time is specified, the end of the current month will be used. | ||
- `limit_namespaces` `(int, optional)` - Controls the total number of by_namespace data returned. This can | ||
|
@@ -1283,7 +1301,9 @@ There are a few things to keep in mind while using this API. | |
|
||
- The response includes the actual time period covered, which may not exactly | ||
match the query parameters due to the month granularity of data or missing | ||
months in the requested time range. | ||
months in the requested time range. Vault always normalizes the effective | ||
`start_time` and `end_time` to full calendar months by adjusting `start_time` to | ||
the beginning of the month and `end_time` to the end of the month. | ||
|
||
- If the `end_date` supplied to the API is for the current month, the activity | ||
information returned by this API will include activity for this month, however | ||
|
@@ -1301,8 +1321,15 @@ it may be up to 20 minutes delayed. | |
|
||
### Parameters | ||
|
||
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the start of the | ||
period for which client counts will be reported. If no start time is specified, the billing start time will be used. | ||
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This revision might be a new change, on |
||
Specifies the start of the period for which client counts will be reported. | ||
Vault uses the [billing start date](/vault/docs/concepts/billing-start-date) | ||
by default, which automatically rolls over to the latest billing year at the | ||
end of the last cycle. Vault Community **requires** `start_time`, but Vault | ||
Enterprise uses the billing start date as defined by the cluster license by | ||
default. Vault Community does not have a billing start time, so ommitting | ||
`start_time` can lead to undefined behavior. We recommend setting an explicit | ||
start time to ensure reliable behavior in all Vault versions. | ||
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the end of the period | ||
for which client counts will be reported. If no end time is specified, the end of current month will be used. | ||
- `format` `(string, optional)` - The desired format of the output file. Allowed | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This
metadata
field looks like a new addition. It's not inv1.20.x
, but the rest of these updates are.