Enum asuran_core::repository::encryption::Encryption

pub enum Encryption {
    NoEncryption,
    AES256CBC {
        iv: [u8; 16],
    },
    AES256CTR {
        iv: [u8; 16],
    },
    ChaCha20 {
        iv: [u8; 12],
    },
}

Tag for the encryption algorthim and IV used by a particular chunk

Variants

NoEncryption

AES256CBC

Fields of AES256CBC

iv: [u8; 16]

AES256CTR

Fields of AES256CTR

iv: [u8; 16]

ChaCha20

Fields of ChaCha20

iv: [u8; 12]

Implementations

impl Encryption

pub fn new_aes256cbc() -> Encryption

Creates an AES256CBC with a random, securely generated IV

pub fn new_aes256ctr() -> Encryption

Creates a new AES256CTR with a random securely generated IV

pub fn new_chacha20() -> Encryption

Creates a new ChaCha20 with a random securely generated IV

pub fn key_length(&self) -> usize

Returns the key length of this encryption method in bytes

NoEncryption has a key length of 16 bytes, as some things rely on a non-zero key length.

pub fn encrypt(&mut self, data: &[u8], key: &Key) -> Vec<u8>

Encrypts a bytestring using the algrothim specified in the tag, and the given key.

Still requires a key in the event of no encryption, but it does not read this key, so any value can be used. Will pad key with zeros if it is too short

Panics

Will panic if the user selects an encryption algorithm for which support has not been compiled in, or if encryption otherwise fails.

pub fn encrypt_bytes(&mut self, data: &[u8], key: &[u8]) -> Vec<u8>

Internal method that does the actual encryption, please use the encrypt method to avoid key confusion

Panics:

Panics if the user selects an encryption algorithm that support was not compiled in for.

pub fn decrypt(
    &self,
    data: &[u8],
    key: &Key
) -> Result<Vec<u8>, EncryptionError>

Decrypts a bytestring with the given key

Still requires a key in the event of no encryption, but it does not read this key, so any value can be used. Will pad key with zeros if it is too short.

Errors

Will return Err if decryption fails

Panics

Panics if the user selects an encryption method for which support has not been compiled in.

pub fn decrypt_bytes(
    &self,
    data: &[u8],
    key: &[u8]
) -> Result<Vec<u8>, EncryptionError>

pub fn new_iv(self) -> Encryption

Conviencence function to get a new tag from an old one, specifying the same algorithim, but with a new, securely generated IV

Trait Implementations

impl Clone for Encryption

fn clone(&self) -> Encryption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Encryption

impl Debug for Encryption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Encryption

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

Deserialize this value from the given Serde deserializer.

impl Eq for Encryption

impl Hash for Encryption

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Encryption> for Encryption

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

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

fn ne(&self, other: &Encryption) -> bool

This method tests for !=.

impl Serialize for Encryption

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Encryption

impl StructuralPartialEq for Encryption