Struct rwarden_crypto::CipherString

pub struct CipherString {
    pub iv: [u8; 16],
    pub mac: [u8; 32],
    pub ciphertext: Vec<u8>,
}

An encrypted string.

Fields

iv: [u8; 16]

The initialization vector.

mac: [u8; 32]

The MAC key.

ciphertext: Vec<u8>

The encrypted data.

Implementations

impl CipherString

pub fn parse<S>(value: S) -> Result<Self, CipherParseError> where
    S: AsRef<str>, 

Parse an encrypted string in the format <ty>.<iv>|<ct>|<mac>.

• <ty>: The encryption type (currently only type 2 is supported)
• <iv>: The initialization vector with 16 bytes and encoded as base64
• <ct>: The ciphertext encoded as base64
• <mac>: The MAC key with 32 bytes and encoded as base64

Example

use rwarden_crypto::CipherString;

let cipher = CipherString::parse("2.84IzoGc1ydvK9T3MKJD4WQ==|rNZ/2EpbFT4YgQbRcSExgA==|Uy3Zwk0PUNo+rWMZluN83pA8Gm1Ivy3CvO4YvboW8TU=")?;

pub fn encrypt<P>(plaintext: P, enc: &[u8; 32], mac: &[u8; 32]) -> Self where
    P: AsRef<[u8]>, 

Encrypt plaintext using the given encryption and MAC key.

pub fn encrypt_with_keys<P>(plaintext: P, keys: &Keys) -> Self where
    P: AsRef<[u8]>, 

Encrypt plaintext using the encryption and MAC key from keys.

pub fn decrypt_raw(
    &self,
    enc: &[u8; 32],
    mac: &[u8; 32]
) -> Result<Vec<u8>, CipherDecryptionError>

Decrypt this encrypted string using the given encryption and MAC key.

pub fn decrypt(
    &self,
    enc: &[u8; 32],
    mac: &[u8; 32]
) -> Result<String, CipherDecryptionStringError>

Decrypt this encrypted string using the given encryption and MAC key and convert the decrypted data to a String.

pub fn decrypt_with_keys_raw(
    &self,
    keys: &Keys
) -> Result<Vec<u8>, CipherDecryptionError>

Decrypt this encrypted string using the encryption and MAC key from keys.

pub fn decrypt_with_keys(
    &self,
    keys: &Keys
) -> Result<String, CipherDecryptionStringError>

Decrypt this encrypted string using the encryption and MAC key from keys and convert the decrypted data to a String.

Trait Implementations

impl Clone for CipherString

fn clone(&self) -> CipherString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CipherString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CipherString

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

Deserialize this value from the given Serde deserializer.

impl Display for CipherString

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

Formats the value using the given formatter.

impl FromStr for CipherString

type Err = CipherParseError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CipherString

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<CipherString> for CipherString

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

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

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

This method tests for !=.

impl Serialize for CipherString

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ str> for CipherString

type Error = CipherParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for CipherString

impl StructuralEq for CipherString

impl StructuralPartialEq for CipherString