Struct keybob::Key

pub struct Key { /* fields omitted */ }

A crytographic key of a certain type

Uses a union to allow key inlining without heap allocation. Provides easy to use constructors for generation and derivation from user input/name.

Also implements serde::{Serialize, Deserialize} via a custom serialiser which allows easy encryption of the key itself.

Implementations

impl Key

pub fn new(tt: KeyType) -> Self

Generate a new, completely random key of a certain type

pub fn from_pw(tt: KeyType, pw: &str, user: &str) -> Self

Generate a new key based on a user password

This function uses the pbkdf2 algorithm to deterministically expand an input pw/username combination into a key.

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

Read the key as an imutable slice

pub fn as_mut_slice(&mut self) -> &mut [u8]

Read the key as a mutable slice

pub fn len(&self) -> usize

Return the length of the key in bytes

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

pub 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<'de> Deserialize<'de> for Key

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Key

impl PartialEq<Key> for Key

fn eq(&self, o: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Key

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.