pub struct AccountManager<R = StackedRatchet, Fcm = ThinRatchet>where
    R: Ratchet,
    Fcm: Ratchet,{ /* private fields */ }
Expand description

The default manager for handling the list of users stored locally. It also allows for user creation, and is used especially for when creating a new user via the registration service.

Implementations§

§

impl<R, Fcm> AccountManager<R, Fcm>where R: Ratchet, Fcm: Ratchet,

pub async fn new( backend_type: BackendType, server_argon_settings: Option<ArgonDefaultServerSettings>, _services_cfg: Option<ServicesConfig>, server_misc_settings: Option<ServerMiscSettings> ) -> Result<AccountManager<R, Fcm>, AccountError>

bind_addr: Required for determining the local save directories for this instance home_dir: Optional. Overrides the default storage location for files server_argon_settings: Security settings used for saving the password to the backend. The AD will be replaced each time a new user is created, so it can be empty

pub fn services_handler(&self) -> &ServicesHandler

Returns a reference to the services handler

pub async fn register_impersonal_hyperlan_client_network_account( &self, conn_info: ConnectionInfo, creds: ProposedCredentials, init_hyper_ratchet: R ) -> Result<ClientNetworkAccount<R, Fcm>, AccountError>

Once a valid and decrypted stage 4 packet gets received by the server (Bob), this function should be called to create the new CNAC. The generated CNAC will be assumed to be an impersonal hyperlan client

This also generates the argon-2id password hash

pub async fn register_personal_hyperlan_server( &self, hyper_ratchet: R, creds: ProposedCredentials, conn_info: ConnectionInfo ) -> Result<ClientNetworkAccount<R, Fcm>, AccountError>

whereas the HyperLAN server (Bob) runs register_impersonal_hyperlan_client_network_account, the registering HyperLAN Client (Alice) runs this function below

pub async fn hyperlan_cid_is_registered( &self, cid: u64 ) -> Result<bool, AccountError>

Determines if the HyperLAN client is registered Impersonal mode

pub async fn get_registered_impersonal_cids( &self, limit: Option<i32> ) -> Result<Option<Vec<u64>>, AccountError>

Returns a list of impersonal cids

pub async fn get_client_by_cid( &self, cid: u64 ) -> Result<Option<ClientNetworkAccount<R, Fcm>>, AccountError>

Returns the CNAC with the supplied CID

pub async fn get_username_by_cid( &self, cid: u64 ) -> Result<Option<String>, AccountError>

Gets username by CID

pub async fn get_client_by_username<T>( &self, username: T ) -> Result<Option<ClientNetworkAccount<R, Fcm>>, AccountError>where T: AsRef<str>,

Returns the first username detected. This is not advised to use, because overlapping usernames are entirely possible. Instead, use get_client_by_cid, as the cid is unique unlike the cid

pub async fn purge(&self) -> Result<usize, AccountError>

Returns the number of accounts purged

pub async fn register_hyperlan_p2p_at_endpoints<T>( &self, implicated_cid: u64, peer_cid: u64, adjacent_username: T ) -> Result<(), AccountError>where T: Into<String>,

Does not execute the registration process between two peers; it only consolidates the changes to the local CNAC returns true if success, false otherwise

pub async fn register_hyperlan_p2p_as_server( &self, cid0: u64, cid1: u64 ) -> Result<(), AccountError>

Registers the two accounts together at the server

pub async fn delete_client_by_cid(&self, cid: u64) -> Result<(), AccountError>

Deletes a client by cid. Returns true if a success

pub async fn get_hyperlan_peer_list( &self, implicated_cid: u64 ) -> Result<Option<Vec<u64>>, AccountError>

Gets a list of hyperlan peers for the given peer

pub async fn find_target_information( &self, implicated_user: impl Into<UserIdentifier>, target_user: impl Into<UserIdentifier> ) -> Result<Option<(u64, MutualPeer)>, AccountError>

Finds a hyperlan peer for a given user. Returns the implicated CID and mutual peer info

pub async fn find_local_user_information( &self, implicated_user: impl Into<UserIdentifier> ) -> Result<Option<u64>, AccountError>

Converts a user identifier into its cid

pub async fn find_cnac_by_identifier( &self, implicated_user: impl Into<UserIdentifier> ) -> Result<Option<ClientNetworkAccount<R, Fcm>>, AccountError>

Converts a user identifier into its cid

pub fn get_misc_settings(&self) -> &ServerMiscSettings

Returns the misc settings

pub fn get_backend_type(&self) -> &BackendType

Gets the backend type

Trait Implementations§

§

impl<R, Fcm> Clone for AccountManager<R, Fcm>where R: Clone + Ratchet, Fcm: Clone + Ratchet,

§

fn clone(&self) -> AccountManager<R, Fcm>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<R = StackedRatchet, Fcm = ThinRatchet> !RefUnwindSafe for AccountManager<R, Fcm>

§

impl<R, Fcm> Send for AccountManager<R, Fcm>

§

impl<R, Fcm> Sync for AccountManager<R, Fcm>

§

impl<R, Fcm> Unpin for AccountManager<R, Fcm>

§

impl<R = StackedRatchet, Fcm = ThinRatchet> !UnwindSafe for AccountManager<R, Fcm>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> Twhere Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

§

impl<T> Pipe for Twhere T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T, U, F> Then<U, F> for Twhere F: Fn(T) -> U,

§

fn then(self, fx: F) -> U

source§

impl<T> ToOwned for Twhere T: Clone,

§

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
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

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 Twhere U: TryFrom<T>,

§

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 Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ContextRequirements for Twhere T: 'static,

§

impl<'a, T> LocalContextRequirements<'a> for Twhere T: 'a,

§

impl<T> SyncContextRequirements for Twhere T: 'static,