Skip to main content

Encryption

Struct Encryption 

Source
pub struct Encryption { /* private fields */ }
Expand description

The application’s encrypter and signer, as one container-storable value.

A newtype over the two ports rather than binding them separately, so swapping either does not change a call site — the same reason rainier-framework’s Views wraps a view engine.

Implementations§

Source§

impl Encryption

Source

pub fn new(encrypter: Arc<dyn Encrypter>, signer: Arc<dyn Signer>) -> Self

Wrap an encrypter and a signer.

Source

pub fn from_keys(keys: KeyRing) -> Self

The default pairing — XChaCha20-Poly1305 and HMAC-SHA256 over one ring.

Source

pub fn from_keys_with(keys: KeyRing, cipher: Cipher) -> Self

The same, with an explicit Cipher.

Reading is unaffected: a payload names its own algorithm, so switching this does not strand anything already written.

Source

pub fn keys(&self) -> Option<&KeyRing>

The key ring, when this was built from one.

None when the encrypter and signer were supplied separately — see new. A caller that needs a ring of its own should ask for one rather than assume.

Source

pub fn encrypter(&self) -> &Arc<dyn Encrypter> ⓘ

The encrypter.

Source

pub fn signer(&self) -> &Arc<dyn Signer> ⓘ

The signer.

Source

pub fn encrypt(&self, plain: &str) -> Result<String>

Encrypt a string.

Source

pub fn decrypt(&self, payload: &str) -> Result<String>

Decrypt a string.

Source

pub fn encrypt_bytes(&self, plain: &[u8]) -> Result<String>

Encrypt raw bytes.

Source

pub fn decrypt_bytes(&self, payload: &str) -> Result<Vec<u8>>

Decrypt to raw bytes.

Source

pub fn encrypt_json<T: Serialize>(&self, value: &T) -> Result<String>

Encrypt any serialisable value as JSON.

Source

pub fn decrypt_json<T: DeserializeOwned>(&self, payload: &str) -> Result<T>

Decrypt JSON back into a value.

Source

pub fn sign(&self, value: &str) -> Result<String>

Sign a value, leaving it readable.

Source

pub fn verify(&self, signed: &str) -> Result<String>

Recover a signed value, or fail if it was altered.

Source

pub fn is_valid(&self, signed: &str) -> bool

Whether a signed value is intact.

Trait Implementations§

Source§

impl Clone for Encryption

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Encryption

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V