Skip to main content

Crypt

Struct Crypt 

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

The application’s keys: the current one writes, every one reads.

Implementations§

Source§

impl Crypt

Source

pub fn new(current: MasterKey, previous: Vec<MasterKey>) -> Self

A crypt over current and the keys still readable.

Source

pub fn ephemeral() -> Self

A crypt for one process: a random key nobody else holds, for tests and for a development run with nothing configured.

Source

pub fn from_config(key: &str, previous: &[String]) -> Result<Self, CryptError>

The configured keys: key as id:<base64> and previous likewise.

Source

pub fn current_id(&self) -> u8

The id the next write uses.

Source

pub fn key_id_of(&self, sealed: &str) -> Option<u8>

The id of the key a sealed value or signature was written under, when it is well-formed.

Source

pub fn encrypt( &self, purpose: &str, aad: &[u8], plain: &[u8], ) -> Result<String, CryptError>

Seals plain for purpose, bound to aad (a table, column and row, or whatever must match on open). Base64url text.

Source

pub fn decrypt( &self, purpose: &str, aad: &[u8], sealed: &str, ) -> Result<Vec<u8>, CryptError>

Opens a value encrypt sealed under any key the crypt holds, for the same purpose and AAD.

Source

pub fn sign(&self, purpose: &str, message: &[u8]) -> String

Signs message for purpose. Base64url text of the version, key id and tag.

Source

pub fn verify(&self, purpose: &str, message: &[u8], signature: &str) -> bool

Whether signature is sign of message under any key the crypt holds, compared in constant time.

Source

pub fn token(&self, purpose: &str, payload: &[u8], ttl: Duration) -> String

A signed token carrying payload and an expiry ttl from now.

Source

pub fn check_token( &self, purpose: &str, token: &str, ) -> Result<Vec<u8>, CryptError>

The payload of a live token minted by token for the same purpose.

Source

pub fn blind_index(&self, purpose: &str, plain: &[u8]) -> String

A keyed digest of plain for looking a sealed value up by equality (a blind index), under its own subkey. Base64url text.

Trait Implementations§

Source§

impl Debug for Crypt

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Crypt

§

impl RefUnwindSafe for Crypt

§

impl Send for Crypt

§

impl Sync for Crypt

§

impl Unpin for Crypt

§

impl UnsafeUnpin for Crypt

§

impl UnwindSafe for Crypt

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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, 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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more