Struct citadel_sdk::prelude::AccountManager

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

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_full_name_by_cid( &self, cid: u64, ) -> Result<Option<String>, AccountError>

Gets full name by CID

pub async fn get_peer_info_from_cids( &self, cids: &[u64], ) -> HashMap<u64, Option<PeerInfo>>

Gets user info for all the given CIDs, omitting any invalid users from the returned values

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 username

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.

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

Performs copy-assignment from source.