Skip to main content

CoreCrypto

Struct CoreCrypto 

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

Wrapper superstruct for both mls::session::Session and proteus::ProteusCentral

As std::ops::Deref is implemented, this struct is automatically dereferred to mls::session::Session apart from proteus_* calls

Implementations§

Source§

impl CoreCrypto

Source

pub async fn history_client(history_secret: HistorySecret) -> Result<Arc<Self>>

Instantiate a history client.

This client exposes the full interface of CoreCrypto, but it should only be used to decrypt messages. Other use is a logic error.

Source§

impl CoreCrypto

Source

pub async fn proteus_session_exists(&self, session_id: &str) -> Result<bool>

Proteus session exists

Warning: The Proteus client MUST be initialized with crate::transaction_context::TransactionContext::proteus_init first or an error will be returned

Source

pub fn proteus_last_resort_prekey_id() -> u16

Returns the proteus last resort prekey id (u16::MAX = 65535)

Source

pub async fn proteus_fingerprint(&self) -> Result<String>

Returns the proteus identity’s public key fingerprint

Warning: The Proteus client MUST be initialized with crate::transaction_context::TransactionContext::proteus_init first or an error will be returned

Source

pub async fn proteus_fingerprint_local( &self, session_id: &str, ) -> Result<String>

Returns the proteus identity’s public key fingerprint

Warning: The Proteus client MUST be initialized with crate::transaction_context::TransactionContext::proteus_init first or an error will be returned

Source

pub async fn proteus_fingerprint_remote( &self, session_id: &str, ) -> Result<String>

Returns the proteus identity’s public key fingerprint

Warning: The Proteus client MUST be initialized with crate::transaction_context::TransactionContext::proteus_init first or an error will be returned

Source§

impl CoreCrypto

Source

pub async fn new_transaction(self: &Arc<Self>) -> Result<TransactionContext>

Creates a new transaction. All operations that persist data will be buffered in memory and when TransactionContext::finish is called, the data will be persisted in a single database transaction.

Source§

impl CoreCrypto

Source

pub fn new(database: Database) -> Arc<Self>

Create an new CoreCrypto client without any initialized session.

Source

pub async fn set_pki_environment( &self, pki_environment: Option<Arc<PkiEnvironment>>, )

Set the session’s PKI Environment

Source

pub async fn get_pki_environment(&self) -> Option<Arc<PkiEnvironment>>

Get the session’s PKI Environment

Source

pub async fn public_key( &self, credential_ref: &CredentialRef, ) -> Result<Vec<u8>>

Get the public key associated with this credential

Source

pub async fn find_credentials( &self, find_filters: CredentialFindFilters<'_>, ) -> Result<Vec<CredentialRef>>

Find all credentials known by this session which match the specified conditions.

If no filters are set, this is equivalent to Self::get_credentials.

Source

pub async fn get_credentials(&self) -> Result<Vec<CredentialRef>>

Get all credentials known by this session.

Source

pub async fn mls_session(&self) -> Result<Session>

Get the mls session if initialized

Source

pub fn database(&self) -> ImmutableDatabase

Get the database

Trait Implementations§

Source§

impl Debug for CoreCrypto

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<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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

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

§

fn vzip(self) -> V

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T