KeysPkc

data class KeysPkc(val allowGenerateKey: Boolean? = null, val allowReplaceKey: Boolean? = null, val allowStoreKey: Boolean? = null, val anyMount: Boolean? = null, val curve: String? = null, val forceRwSession: String? = null, val keyBits: String? = null, val keyId: String, val keyLabel: String, val library: String, val mechanism: String, val name: String, val pin: String, val slot: String? = null, val tokenLabel: String? = null, val uuid: String? = null)

Constructors

Link copied to clipboard
constructor(allowGenerateKey: Boolean? = null, allowReplaceKey: Boolean? = null, allowStoreKey: Boolean? = null, anyMount: Boolean? = null, curve: String? = null, forceRwSession: String? = null, keyBits: String? = null, keyId: String, keyLabel: String, library: String, mechanism: String, name: String, pin: String, slot: String? = null, tokenLabel: String? = null, uuid: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

If no existing key can be found in the referenced backend, instructs Vault to generate a key within the backend

Link copied to clipboard

Controls the ability for Vault to replace through generation or importing a key into the configured backend even if a key is present, if set to false those operations are forbidden if a key exists.

Link copied to clipboard
val allowStoreKey: Boolean? = null

Controls the ability for Vault to import a key to the configured backend, if 'false', those operations will be forbidden

Link copied to clipboard
val anyMount: Boolean? = null

Allow usage from any mount point within the namespace if 'true'

Link copied to clipboard
val curve: String? = null

Supplies the curve value when using the 'CKM_ECDSA' mechanism. Required if 'allow_generate_key' is true

Link copied to clipboard
val forceRwSession: String? = null

Force all operations to open up a read-write session to the HSM

Link copied to clipboard
val keyBits: String? = null

Supplies the size in bits of the key when using 'CKM_RSA_PKCS_PSS', 'CKM_RSA_PKCS_OAEP' or 'CKM_RSA_PKCS' as a value for 'mechanism'. Required if 'allow_generate_key' is true

Link copied to clipboard

The id of a PKCS#11 key to use

Link copied to clipboard

The label of the key to use

Link copied to clipboard

The name of the kms_library stanza to use from Vault's config to lookup the local library path

Link copied to clipboard

The encryption/decryption mechanism to use, specified as a hexadecimal (prefixed by 0x) string.

Link copied to clipboard

A unique lowercase name that serves as identifying the key

Link copied to clipboard
val pin: String

The PIN for login

Link copied to clipboard
val slot: String? = null

The slot number to use, specified as a string in a decimal format (e.g. '2305843009213693953')

Link copied to clipboard
val tokenLabel: String? = null

The slot token label to use

Link copied to clipboard
val uuid: String? = null

ID of the managed key read from Vault