Struct SymmetricCryptoKey

pub struct SymmetricCryptoKey {
    pub(crate) key: Pin<Box<GenericArray<u8, U32>>>,
    pub(crate) mac_key: Option<Pin<Box<GenericArray<u8, U32>>>>,
}

A symmetric encryption key. Used to encrypt and decrypt EncString

Fields

key: Pin<Box<GenericArray<u8, U32>>>

mac_key: Option<Pin<Box<GenericArray<u8, U32>>>>

Implementations

impl SymmetricCryptoKey

const KEY_LEN: usize = 32usize

const MAC_LEN: usize = 32usize

pub fn generate(rng: impl RngCore) -> Self

Generate a new random SymmetricCryptoKey

pub(crate) fn new( key: Pin<Box<GenericArray<u8, U32>>>, mac_key: Option<Pin<Box<GenericArray<u8, U32>>>>, ) -> Self

fn total_len(&self) -> usize

pub fn to_base64(&self) -> String

pub fn to_vec(&self) -> Vec<u8>

Trait Implementations

impl Clone for SymmetricCryptoKey

fn clone(&self) -> SymmetricCryptoKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymmetricCryptoKey

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

Formats the value using the given formatter.

impl Drop for SymmetricCryptoKey

fn drop(&mut self)

Executes the destructor for this type.

impl KeyDecryptable<SymmetricCryptoKey, String> for EncString

fn decrypt_with_key( &self, key: &SymmetricCryptoKey, ) -> Result<String, CryptoError>

impl KeyDecryptable<SymmetricCryptoKey, Vec<u8>> for EncString

fn decrypt_with_key( &self, key: &SymmetricCryptoKey, ) -> Result<Vec<u8>, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, EncString> for &[u8]

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<EncString, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, EncString> for &str

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<EncString, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, EncString> for String

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<EncString, CryptoError>

impl TryFrom<&mut [u8]> for SymmetricCryptoKey

fn try_from(value: &mut [u8]) -> Result<Self, Self::Error>

Note: This function takes the byte slice by mutable reference and will zero out all the data in it. This is to prevent the key from being left in memory.

type Error = CryptoError

The type returned in the event of a conversion error.

impl TryFrom<String> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl CryptoKey for SymmetricCryptoKey

impl ZeroizeOnDrop for SymmetricCryptoKey