Struct Key 

pub struct Key { /* private fields */ }

A 256-bit key. Its bytes live only in a page of their own that is locked in memory, so they never reach swap, and that core dumps leave out; they are zeroed when the key is dropped. A key cannot be copied, and Debug shows only its id.

Implementations

impl Key

pub fn generate() -> Result<Key, KeyError>

Makes a new random key, refusing if its memory cannot be locked.

Errors

KeyError::Memory if the key’s page cannot be locked or kept out of core dumps.

Panics

Never: AWS-LC aborts the process rather than fail to give random bytes.

pub fn load_master(path: &Path) -> Result<Key, KeyError>

Loads the master key: the file must hold exactly 32 bytes. They are read straight into the key’s own locked page.

Errors

KeyError::Read if the file cannot be opened or read, KeyError::WrongSize if it holds other than 32 bytes, and KeyError::Memory if the key’s page cannot be locked.

pub fn id(&self) -> KeyId

The key’s id: the first 8 bytes of its SHA-256 hash.

Panics

Never: a SHA-256 hash is 32 bytes.

Trait Implementations

impl Debug for Key

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

Formats the value using the given formatter.