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
|
# OpenbaoClient::TransitSignWithAlgorithmRequest
## 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' 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 | [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, including ed25519. Using none requires setting prehashed=true and signature_algorithm=pkcs1v15, yielding a PKCSv1_5_NoOID instead of the usual PKCSv1_5_DERnull signature. | [optional][default to 'sha2-256'] |
| **input** | **String** | The base64-encoded input data | [optional] |
| **key_version** | **Integer** | The version of the key to use for signing. Must be 0 (for latest) or a value greater than or equal to the min_encryption_version configured on the key. | [optional] |
| **marshaling_algorithm** | **String** | The method by which to marshal the signature. The default is 'asn1' which is used by openssl and X.509. It can also be set to 'jws' which is used for JWT signatures; setting it to this will also cause the encoding of the signature to be url-safe base64 instead of using 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_algorithm** | **String** | The signature algorithm to use for signing. Currently only applies to RSA key types. Options are 'pss' or 'pkcs1v15'. Defaults to 'pss' | [optional] |
## Example
```ruby
require 'openbao_client'
instance = OpenbaoClient::TransitSignWithAlgorithmRequest.new(
algorithm: null,
batch_input: null,
context: null,
hash_algorithm: null,
input: null,
key_version: null,
marshaling_algorithm: null,
prehashed: null,
salt_length: null,
signature_algorithm: null
)
```
|