File: TransitVerifyWithAlgorithmRequest.md

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (38 lines) | stat: -rw-r--r-- 3,275 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# OpenbaoClient::TransitVerifyWithAlgorithmRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **algorithm** | **String** | Deprecated: use \"hash_algorithm\" instead. | [optional][default to 'sha2-256'] |
| **batch_input** | **Array<Object>** | 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 | [optional] |
| **context** | **String** | Base64 encoded context for key derivation. Required if key derivation is enabled; currently only available with ed25519 keys. | [optional] |
| **hash_algorithm** | **String** | Hash algorithm to use (POST body parameter). Valid values are: * sha1 * sha2-224 * sha2-256 * sha2-384 * sha2-512 * sha3-224 * sha3-256 * sha3-384 * sha3-512 * none Defaults to \"sha2-256\". Not valid for all key types. See note about none on signing path. | [optional][default to 'sha2-256'] |
| **hmac** | **String** | The HMAC, including OpenBao header/key version | [optional] |
| **input** | **String** | The base64-encoded input data to verify | [optional] |
| **marshaling_algorithm** | **String** | The method by which to unmarshal the signature when verifying. The default is 'asn1' which is used by openssl and X.509; can also be set to 'jws' which is used for JWT signatures in which case the signature is also expected to be url-safe base64 encoding instead of standard base64 encoding. Currently only valid for ECDSA P-256 key types\". | [optional][default to 'asn1'] |
| **prehashed** | **Boolean** | Set to 'true' when the input is already hashed. If the key type is 'rsa-2048', 'rsa-3072' or 'rsa-4096', then the algorithm used to hash the input should be indicated by the 'algorithm' parameter. | [optional] |
| **salt_length** | **String** | 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'. | [optional][default to 'auto'] |
| **signature** | **String** | The signature, including OpenBao header/key version | [optional] |
| **signature_algorithm** | **String** | The signature algorithm to use for signature verification. Currently only applies to RSA key types. Options are 'pss' or 'pkcs1v15'. Defaults to 'pss' | [optional] |

## Example

```ruby
require 'openbao_client'

instance = OpenbaoClient::TransitVerifyWithAlgorithmRequest.new(
  algorithm: null,
  batch_input: null,
  context: null,
  hash_algorithm: null,
  hmac: null,
  input: null,
  marshaling_algorithm: null,
  prehashed: null,
  salt_length: null,
  signature: null,
  signature_algorithm: null
)
```