Enum KeyProvOperation 

pub enum KeyProvOperation {
    Enroll,
    SetUserKey {
        key_type: KeyProvUserKeyType,
        key_data: Box<[u8]>,
    },
    SetKey {
        key_type: KeyProvUserKeyType,
        key_size: u32,
    },
    WriteKeyNonvolatile {
        memory_id: u32,
    },
    ReadKeyNonvolatile {
        memory_id: u32,
    },
    WriteKeyStore {
        keystore_data: Box<[u8]>,
    },
    ReadKeyStore {
        file: String,
        use_hexdump: bool,
    },
}

Key provisioning operations for device key management.

These operations handle enrollment, key setting, and key store management for various types of encryption and authentication keys.

Variants

Enroll

Enrolls key provisioning feature. No arguments are required for this operation

SetUserKey

Sends the user key specified by type to the bootloader.

Available KEY TYPES: 2 or ‘OTFADKEK’ OTFAD key 3 or ‘SBKEK’ SB file encryption key 7 or ‘PRINCE0’ Prince region 0 encryption key 8 or ‘PRINCE1’ Prince region 1 encryption key 9 or ‘PRINCE2’ Prince region 2 encryption key 11 or ‘USERKEK’ User/Boot-image encryption key 12 or ‘UDS’ Universal Device Secret for DICE

Fields

key_type: KeyProvUserKeyType

Type of user key

key_data: Box<[u8]>

Binary file containing user key plaintext

SetKey

Generates a key of specified size and type on the device.

Available KEY TYPES: 2 or ‘OTFADKEK’ OTFAD key 3 or ‘SBKEK’ SB file encryption key 7 or ‘PRINCE0’ Prince region 0 encryption key 8 or ‘PRINCE1’ Prince region 1 encryption key 9 or ‘PRINCE2’ Prince region 2 encryption key 11 or ‘USERKEK’ User/Boot-image encryption key 12 or ‘UDS’ Universal Device Secret for DICE

Note: The valid options of key type and corresponding size are documented in the target’s Reference Manual or User Manual. Note: Names are case insensitive

Fields

key_type: KeyProvUserKeyType

Type of key to generate

key_size: u32

Size of key to generate in bytes

WriteKeyNonvolatile

Writes data to non-volatile storage

Fields

memory_id: u32

ID of the non-volatile memory

ReadKeyNonvolatile

Loads the key from nonvolatile memory to bootloader.

Fields

memory_id: u32

ID of the non-volatile memory

WriteKeyStore

Write key store data to the bootloader

Fields

keystore_data: Box<[u8]>

Binary file containing key store data

ReadKeyStore

Reads the key store from the bootloader to host

Fields

file: String

Binary file to save the key store

use_hexdump: bool

Use hexdump format

Trait Implementations

impl Clone for KeyProvOperation

fn clone(&self) -> KeyProvOperation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandToParams for KeyProvOperation

fn to_params(&self) -> (Vec<u32>, Option<&[u8]>)

Convert key provisioning operation to command parameters.

Returns

Tuple containing operation parameters and optional key data for data phase

impl Debug for KeyProvOperation

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

Formats the value using the given formatter.

impl Display for KeyProvOperation

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

Formats the value using the given formatter.

impl FromArgMatches for KeyProvOperation

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for KeyProvOperation

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand