Resolve unrecognized parameter warnings on batch_input parameter in transit (#18299)

* Resolve unused warnings on batch_input parameter in transit

* Add cl

* Fix text in hmac batch_input parameter description
This commit is contained in:
Steven Clark 2023-01-04 09:15:48 -05:00 committed by GitHub
parent 82dedd8773
commit cfd5b8a933
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 54 additions and 2 deletions

View File

@ -74,6 +74,15 @@ plaintext. On successful decryption, both the ciphertext and the associated
data are attested not to have been tampered with.
`,
},
"batch_input": {
Type: framework.TypeSlice,
Description: `
Specifies a list of items to be decrypted in a single batch. When this
parameter is set, if the parameters 'ciphertext', 'context' and 'nonce' are
also set, they will be ignored. Any batch output will preserve the order
of the batch input.`,
},
},
Callbacks: map[logical.Operation]framework.OperationFunc{

View File

@ -152,6 +152,14 @@ plaintext. On successful decryption, both the ciphertext and the associated
data are attested not to have been tampered with.
`,
},
"batch_input": {
Type: framework.TypeSlice,
Description: `
Specifies a list of items to be encrypted in a single batch. When this parameter
is set, if the parameters 'plaintext', 'context' and 'nonce' are also set, they
will be ignored. Any batch output will preserve the order of the batch input.`,
},
},
Callbacks: map[logical.Operation]framework.OperationFunc{

View File

@ -83,6 +83,14 @@ Defaults to "sha2-256".`,
Must be 0 (for latest) or a value greater than or equal
to the min_encryption_version configured on the key.`,
},
"batch_input": {
Type: framework.TypeSlice,
Description: `
Specifies a list of items to be processed in a single batch. When this parameter
is set, if the parameter 'input' is also set, it will be ignored.
Any batch output will preserve the order of the batch input.`,
},
},
Callbacks: map[logical.Operation]framework.OperationFunc{

View File

@ -43,6 +43,14 @@ func (b *backend) pathRewrap() *framework.Path {
Must be 0 (for latest) or a value greater than or equal
to the min_encryption_version configured on the key.`,
},
"batch_input": {
Type: framework.TypeSlice,
Description: `
Specifies a list of items to be re-encrypted in a single batch. When this parameter is set,
if the parameters 'ciphertext', 'context' and 'nonce' are also set, they will be ignored.
Any batch output will preserve the order of the batch input.`,
},
},
Callbacks: map[logical.Operation]framework.OperationFunc{

View File

@ -154,6 +154,14 @@ Options are 'pss' or 'pkcs1v15'. Defaults to 'pss'`,
Description: `The salt length used to sign. Currently only applies to the RSA PSS signature scheme.
Options are 'auto' (the default used by Golang, causing the salt to be as large as possible when signing), 'hash' (causes the salt length to equal the length of the hash used in the signature), or an integer between the minimum and the maximum permissible salt lengths for the given RSA key size. Defaults to 'auto'.`,
},
"batch_input": {
Type: framework.TypeSlice,
Description: `Specifies a list of items for processing. When this parameter is set,
any supplied 'input' or 'context' parameters will be ignored. Responses are returned in the
'batch_results' array component of the 'data' element of the response. Any batch output will
preserve the order of the batch input`,
},
},
Callbacks: map[logical.Operation]framework.OperationFunc{
@ -249,6 +257,14 @@ Options are 'pss' or 'pkcs1v15'. Defaults to 'pss'`,
Description: `The salt length used to sign. Currently only applies to the RSA PSS signature scheme.
Options are 'auto' (the default used by Golang, causing the salt to be as large as possible when signing), 'hash' (causes the salt length to equal the length of the hash used in the signature), or an integer between the minimum and the maximum permissible salt lengths for the given RSA key size. Defaults to 'auto'.`,
},
"batch_input": {
Type: framework.TypeSlice,
Description: `Specifies a list of items for processing. When this parameter is set,
any supplied 'input', 'hmac' or 'signature' parameters will be ignored. Responses are returned in the
'batch_results' array component of the 'data' element of the response. Any batch output will
preserve the order of the batch input`,
},
},
Callbacks: map[logical.Operation]framework.OperationFunc{

3
changelog/18299.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:bug
secrets/transit: Do not warn about unrecognized parameter 'batch_input'
```

View File

@ -843,8 +843,8 @@ functionality to untrusted users or scripts.
when using batch_input below.
- `batch_input` `(array<object>: nil)`  Specifies a list of items to be
decrypted in a single batch. When this parameter is set, if the parameters
'ciphertext', 'context' and 'nonce' are also set, they will be ignored.
re-encrypted in a single batch. When this parameter is set, if the parameters
'ciphertext', 'context' and 'nonce' are also set, they will be ignored.
Any batch output will preserve the order of the batch input. Format
for the input goes like this: