Struct vault_rs::secrets::transit::ConfigureKey

pub struct ConfigureKey {
    pub min_decryption_version: Option<u64>,
    pub min_encryption_version: Option<u64>,
    pub deletion_allowed: Option<bool>,
    pub exportable: Option<bool>,
    pub allow_plaintext_backup: Option<bool>,
}

Parameters for Key Configuration

Fields

min_decryption_version: Option<u64>

Specifies the minimum version of ciphertext allowed to be decrypted. Adjusting this as part of a key rotation policy can prevent old copies of ciphertext from being decrypted, should they fall into the wrong hands. For signatures, this value contasync rols the minimum version of signature that can be verified against. For HMACs, this controls the minimum version of a key allowed to be used as the key for verification.

min_encryption_version: Option<u64>

Specifies the minimum version of the key that can be used to encrypt plaintext, sign payloads, or generate HMACs. Must be 0 (which will use the latest version) or a value greater or equal to min_decryption_version.

deletion_allowed: Option<bool>

Specifies if the key is allowed to be deleted.

exportable: Option<bool>

Enables keys to be exportable. This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

allow_plaintext_backup: Option<bool>

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

Trait Implementations

impl Debug for ConfigureKey

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for ConfigureKey

fn default() -> ConfigureKey

Returns the "default value" for a type.

impl Eq for ConfigureKey

impl PartialEq<ConfigureKey> for ConfigureKey

fn eq(&self, other: &ConfigureKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConfigureKey) -> bool

This method tests for !=.

impl Serialize for ConfigureKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for ConfigureKey

impl StructuralPartialEq for ConfigureKey