Struct Key 

pub struct Key { /* private fields */ }

Contains a valid AES key. Can be instantiated with a random key, or built from a slice of bytes that is 16, 24, or 32 bytes long. A key object is required to instantiate a Cipher.

Examples

use aesp::Key;
 
// Instantiate random keys:
let rk_128 = Key::rand_key_128()?;
let rk_192 = Key::rand_key_192()?;
let rk_256 = Key::rand_key_256()?;
 
// Instantiate keys from slice:
let key_bytes: [u8; 32] = [0xBA, 0x32, 0x82, 0x9A, 0x43, 0x8A, 0x48, 0xED, 
                           0xC2, 0xEA, 0x10, 0x73, 0x26, 0xF8, 0xA9, 0x62, 
                           0xDE, 0x82, 0x06, 0xBA, 0x53, 0xC2, 0xC7, 0x55, 
                           0x2C, 0x72, 0xC5, 0x37, 0xBF, 0xD4, 0xDB, 0x5E];
let my_key_128 = Key::try_from_slice(&key_bytes[..16])?;
let my_key_192 = Key::try_from_slice(&key_bytes[..24])?;
let my_key_256 = Key::try_from_slice(&key_bytes[..32])?;
 
// Internal bytes of Key objects are accessible and match the original key:
assert_eq!(my_key_128.as_bytes(), &key_bytes[..16]);
assert_eq!(my_key_192.as_bytes(), &key_bytes[..24]);
assert_eq!(my_key_256.as_bytes(), &key_bytes[..32]);
 
// Attempting to instantiate with an invalid key size (not 16, 24, or 32 bytes)
// returns an InvalidKeyLength error:
assert!(Key::try_from_slice(&key_bytes[..20]).is_err());

Implementations

impl Key

pub fn rand_key_128() -> Result<Self>

Generate a random 128-bit key. Returns Error if OsRng fails.

pub fn rand_key_192() -> Result<Self>

Generate a random 192-bit key. Returns Error if OsRng fails.

pub fn rand_key_256() -> Result<Self>

Generate a random 256-bit key. Returns Error if OsRng fails.

pub fn try_from_slice(bytes: &[u8]) -> Result<Self>

Attempts to build a key from a slice of bytes. Will return an InvalidKeyLength error if the input slice is anything other than 16, 24, or 32 bytes long.

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the internal key as an array of bytes.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl PartialEq for Key

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

Tests for self and other values to be equal, and is used by ==.

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 Eq for Key

impl StructuralPartialEq for Key