Struct vault_rs::secrets::transit::CreateKey

pub struct CreateKey {
    pub name: String,
    pub convergent_encryption: Option<bool>,
    pub derived: Option<bool>,
    pub exportable: Option<bool>,
    pub allow_plaintext_backup: Option<bool>,
    pub type: KeyType,
}

Parameters for creating a new Key

Fields

name: String

Specifies the name of the encryption key to create.

convergent_encryption: Option<bool>

If enabled, the key will support convergent encryption, where the same plaintext creates the same ciphertext. This requires derived to be set to true. When enabled, each encryption(/decryption/rewrap/datakey) operation will derive a nonce value rather than randomly generate it.

derived: Option<bool>

Specifies if key derivation is to be used. If enabled, all encrypt/decrypt requests to this named key must provide a context which is used for key derivation.

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.

type: KeyType

Specifies the type of key to create.

Trait Implementations

impl Debug for CreateKey

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

Formats the value using the given formatter.

impl Default for CreateKey

fn default() -> CreateKey

Returns the "default value" for a type.

impl Eq for CreateKey

impl PartialEq<CreateKey> for CreateKey

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

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

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

This method tests for !=.

impl Serialize for CreateKey

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 CreateKey

impl StructuralPartialEq for CreateKey