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::TransitImportKeyRequest
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **allow_plaintext_backup** | **Boolean** | Enables taking a backup of the named key in plaintext format. Once set, this cannot be disabled. | [optional] |
| **allow_rotation** | **Boolean** | True if the imported key may be rotated within OpenBao; false otherwise. | [optional] |
| **auto_rotate_period** | **Integer** | Amount of time the key should live before being automatically rotated. A value of 0 (default) disables automatic rotation for the key. | [optional][default to 0] |
| **ciphertext** | **String** | The base64-encoded ciphertext of the keys. The AES key should be encrypted using OAEP with the wrapping key and then concatenated with the import key, wrapped by the AES key. | [optional] |
| **context** | **String** | Base64 encoded context for key derivation. When reading a key with key derivation enabled, if the key type supports public keys, this will return the public key for the given context. | [optional] |
| **derived** | **Boolean** | Enables key derivation mode. This allows for per-transaction unique keys for encryption operations. | [optional] |
| **exportable** | **Boolean** | Enables keys to be exportable. This allows for all the valid keys in the key ring to be exported. | [optional] |
| **hash_function** | **String** | The hash function used as a random oracle in the OAEP wrapping of the user-generated, ephemeral AES key. Can be one of \"SHA1\", \"SHA224\", \"SHA256\" (default), \"SHA384\", or \"SHA512\" | [optional][default to 'SHA256'] |
| **public_key** | **String** | The plaintext PEM public key to be imported. If \"ciphertext\" is set, this field is ignored. | [optional] |
| **type** | **String** | The type of key being imported. Currently, \"aes128-gcm96\" (symmetric), \"aes256-gcm96\" (symmetric), \"ecdsa-p256\" (asymmetric), \"ecdsa-p384\" (asymmetric), \"ecdsa-p521\" (asymmetric), \"ed25519\" (asymmetric), \"rsa-2048\" (asymmetric), \"rsa-3072\" (asymmetric), \"rsa-4096\" (asymmetric) are supported. Defaults to \"aes256-gcm96\". | [optional][default to 'aes256-gcm96'] |
## Example
```ruby
require 'openbao_client'
instance = OpenbaoClient::TransitImportKeyRequest.new(
allow_plaintext_backup: null,
allow_rotation: null,
auto_rotate_period: null,
ciphertext: null,
context: null,
derived: null,
exportable: null,
hash_function: null,
public_key: null,
type: null
)
```
|
