Add missing cmac argument to Transit verify API docs (#27307)

This commit is contained in:
Steven Clark
2024-05-31 13:33:30 -04:00
committed by GitHub
parent 92e995c68e
commit b0d5e1b9af

View File

@@ -1575,7 +1575,8 @@ the response will include the derived public key for each item.
## Verify signed data ## Verify signed data
This endpoint returns whether the provided signature is valid for the given This endpoint returns whether the provided signature is valid for the given
data. data from either the [sign data](#sign-data), [generate HMAC](#generate-hmac)
or [generate CMAC](#generate-cmac) API calls.
| Method | Path | | Method | Path |
| :----- | :---------------------------------------- | | :----- | :---------------------------------------- |
@@ -1624,12 +1625,16 @@ data.
`input` or `batch_input` must be supplied. `input` or `batch_input` must be supplied.
- `signature` `(string: "")`  Specifies the signature output from the - `signature` `(string: "")`  Specifies the signature output from the
`/transit/sign` function. Either this must be supplied or `hmac` must be `/transit/sign` function. One of the following arguments must be supplied
supplied. `signature`, `hmac` or `cmac`.
- `hmac` `(string: "")`  Specifies the signature output from the - `hmac` `(string: "")`  Specifies the signature output from the
`/transit/hmac` function. Either this must be supplied or `signature` must be `/transit/hmac` function. One of the following arguments must be supplied
supplied. `signature`, `hmac` or `cmac`.
- `cmac` `(string: "")` <EnterpriseAlert inline="true" />  Specifies the signature output from the
`/transit/cmac` function. One of the following arguments must be supplied
`signature`, `hmac` or `cmac`.
- `reference` `(string: "")` - - `reference` `(string: "")` -
A user-supplied string that will be present in the `reference` field on the A user-supplied string that will be present in the `reference` field on the
@@ -1767,6 +1772,8 @@ $ curl \
## Generate CMAC <EnterpriseAlert inline="true" /> ## Generate CMAC <EnterpriseAlert inline="true" />
This endpoint returns the CMAC of given data using the specified key. This endpoint returns the CMAC of given data using the specified key.
The [verify](#verify-signed-data) API can be called with the cmac
argument to verify returned CMACs.
| Method | Path | | Method | Path |
| :----- | :-------------------------------------- | | :----- | :-------------------------------------- |