Struct gbl::AesKey

pub struct AesKey(_);

A symmetric AES-128 encryption/decryption key.

Can be obtained from a variety of formats and is used by Gbl::encrypt and Gbl::decrypt.

Methods

impl AesKey

pub fn from_raw(raw: [u8; 16]) -> Self

Creates an AES key from 16 raw bytes.

Examples

let key = AesKey::from_raw([
    0xE7, 0xE5, 0x56, 0xB6, 0x35, 0xA3, 0x52, 0x06, // 8
    0x59, 0xA2, 0xE1, 0x61, 0xCB, 0xDF, 0x4B, 0xC2, // 16
]);

pub fn from_slice(slice: &[u8]) -> Option<Self>

Creates an AES key from a byte slice containing 16 bytes.

If the slice does not contain exactly 16 bytes, returns None.

Examples

assert!(AesKey::from_slice(&[
    0xE7, 0xE5, 0x56, 0xB6, 0x35, 0xA3, 0x52, 0x06, // 8
    0x59, 0xA2, 0xE1, 0x61, 0xCB, 0xDF, 0x4B, 0xC2, // 16
]).is_some());

Note that it is preferrable to use AesKey::from_raw when you already have a fixed-size array of 16 Bytes.

When the slice does not contain 16 Bytes, this returns None:

assert!(AesKey::from_slice(&[
    0xE7, 0xE5, 0x56, 0xB6, 0x35, 0xA3, 0x52, 0x06, // 8
    0x59, 0xA2, 0xE1, 0x61, 0xCB, 0xDF, 0x4B, 0xC2, // 16
    0xFF,  // 17
]).is_none());

pub fn from_hex_str<S: AsRef<str>>(s: S) -> Result<Self, Error>

Parses an AES key from a hexadecimal string.

Examples

let key = AesKey::from_hex_str("E7E556B635A3520659A2E161CBDF4BC2")?;

pub fn from_token_file<S: AsRef<str>>(contents: S) -> Result<Self, Error>

Parses an AES key from a bootloader token file.

Parameters

• contents: Contents of the bootloader token file generated by (eg.) commander gbl keygen --type aes-ccm. Must contain the key TOKEN_MFG_SECURE_BOOTLOADER_KEY.

Examples

Load a key from an example token file:

let contents = r"
    # Key randomly generated
    TOKEN_MFG_SECURE_BOOTLOADER_KEY: E7E556B635A3520659A2E161CBDF4BC2
";

let key = AesKey::from_token_file(contents)?;

pub fn as_raw(&self) -> &[u8; 16]

Returns a reference to the raw 16-Byte AES-128 key.

pub fn into_raw(self) -> [u8; 16]

Consumes self and returns the raw bytes making up the key.

Trait Implementations

impl From<[u8; 16]> for AesKey

fn from(raw: [u8; 16]) -> Self

Performs the conversion.

impl Into<[u8; 16]> for AesKey

fn into(self) -> [u8; 16]

Performs the conversion.

impl AsRef<[u8]> for AesKey

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<[u8; 16]> for AesKey

fn as_ref(&self) -> &[u8; 16]

Performs the conversion.