Enum FileBackedCommand 

pub enum FileBackedCommand {
    DeviceInfo,
    ResetDeviceAndReconnect,
    GetLogEntries,
    SetForceAuditOption(AuditOption),
    SetCommandAuditOption {
        command: Code,
        setting: AuditOption,
    },
    PutAuthenticationKey {
        info: KeyInfo,
        delegated_caps: Capabilities,
        passphrase_file: PathBuf,
    },
    GenerateAsymmetricKey {
        info: KeyInfo,
    },
    SignEd25519 {
        key_id: Id,
        data: Vec<u8>,
    },
    PutWrapKey {
        info: KeyInfo,
        delegated_caps: Capabilities,
        passphrase_file: PathBuf,
    },
    ExportWrapped {
        wrap_key_id: Id,
        object: ObjectId,
        wrapped_file: PathBuf,
    },
    ImportWrapped {
        wrap_key_id: Id,
        wrapped_file: PathBuf,
    },
    DeleteObject(ObjectId),
    GetObjectInfo(ObjectId),
}

A single command that is atomically executed against a YubiHSM2.

Different from Command, this enum does not assign data directly in its variants, but instead relies on paths to files to read from or write to.

Variants

DeviceInfo

Query the device state.

ResetDeviceAndReconnect

Reset the device to factory settings and reconnect afterwards.

Note that this is a destructive operation and the authenticating user will need to have appropriate capabilities.

GetLogEntries

Query the command log of the device and print it to standard output.

SetForceAuditOption(AuditOption)

Change audit settings.

This mode prevents the device from performing additional operations when the Logs and Error Codes is full.

See Force Audit for more details.

SetCommandAuditOption

Changes command audit settings.

This is used to manage auditing options for specific commands. By default all commands are logged.

See Force Audit for more details.

Fields

command: Code

Command of which the setting should be changed.

setting: AuditOption

New setting value.

PutAuthenticationKey

Put authentication key on the device.

This command is used to append new authentication keys.

Fields

info: KeyInfo

The key identity and capabilities.

delegated_caps: Capabilities

Additional delegated capabilities which would apply to objects that are created or imported.

passphrase_file: PathBuf

The file containing passphrase of the authenticating user.

GenerateAsymmetricKey

Generates new ed25519 signing key on the device.

Fields

info: KeyInfo

The key identity and capabilities.

SignEd25519

Signs data using provided ed25519 key.

Fields

key_id: Id

The key to be used for signing.

data: Vec<u8>

Raw data blob which should be signed.

PutWrapKey

Puts new wrapping key on the device.

This command is used to append new wrapping keys which serve as encryption keys for other objects.

Fields

info: KeyInfo

The key identity and capabilities.

delegated_caps: Capabilities

Additional delegated capabilities which would apply to objects that are created or imported.

passphrase_file: PathBuf

The file containing raw value of the wrapping key.

ExportWrapped

Export object under wrap (encrypted).

Fields

wrap_key_id: Id

Wrapping key which should encrypt the exported object.

object: ObjectId

Object that will be exported.

wrapped_file: PathBuf

Output file which will contain the exported object encrypted with the wrapping key.

ImportWrapped

Imports objects under wrap (encrypted).

Fields

wrap_key_id: Id

Wrapping key which would decrypt the imported object.

wrapped_file: PathBuf

Input file which contains the imported object encrypted with the wrapping key.

DeleteObject(ObjectId)

Permanently remove an object from the device.

GetObjectInfo(ObjectId)

Query data about the object and print it to standard output.

Trait Implementations

impl Debug for FileBackedCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileBackedCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&FileBackedCommand> for CommandName

fn from(value: &FileBackedCommand) -> Self

Converts to this type from the input type.

impl PartialEq<FileBackedCommand> for &CommandReturnValue

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

Compares CommandReturnValue and FileBackedCommand.

Note

Comparison is done using the enum variants on a best effort basis. No data is compared directly.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FileBackedCommand

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&FileBackedCommand> for Command

fn try_from(value: &FileBackedCommand) -> Result<Self, Self::Error>

Creates a new Command from this FileBackedCommand.

Errors

Returns an error, if reading/creating the required data from input files fails.

type Error = Error

The type returned in the event of a conversion error.