Struct InternalClient

pub struct InternalClient {
    pub(crate) user_id: OnceLock<UserId>,
    pub(crate) tokens: RwLock<Tokens>,
    pub(crate) login_method: RwLock<Option<Arc<LoginMethod>>>,
    pub(super) flags: RwLock<Flags>,
    pub(crate) external_client: Client,
    pub(super) key_store: KeyStore<KeyIds>,
    pub(crate) security_state: RwLock<Option<SecurityState>>,
    pub(crate) repository_map: StateRegistry,
    /* private fields */
}

Fields

user_id: OnceLock<UserId>

tokens: RwLock<Tokens>

login_method: RwLock<Option<Arc<LoginMethod>>>

flags: RwLock<Flags>

external_client: Client

Reqwest client useable for external integrations like email forwarders, HIBP.

key_store: KeyStore<KeyIds>

security_state: RwLock<Option<SecurityState>>

repository_map: StateRegistry

Implementations

impl InternalClient

pub fn load_flags(&self, flags: HashMap<String, bool>)

Load feature flags. This is intentionally a collection and not the internal Flag enum as we want to avoid changes in feature flags from being a breaking change.

pub fn get_flags(&self) -> Flags

Retrieve the active feature flags.

pub(crate) fn get_login_method(&self) -> Option<Arc<LoginMethod>>

pub fn get_access_token_organization(&self) -> Option<OrganizationId>

pub(crate) fn set_login_method(&self, login_method: LoginMethod)

pub(crate) fn set_tokens( &self, token: String, refresh_token: Option<String>, expires_in: u64, )

pub(crate) fn set_api_tokens_internal(&self, token: String)

Sets api tokens for only internal API clients, use set_tokens for SdkManagedTokens.

pub fn get_kdf(&self) -> Result<Kdf, NotAuthenticatedError>

pub async fn get_api_configurations(&self) -> Arc<ApiConfigurations>

pub fn get_http_client(&self) -> &Client

pub fn get_key_store(&self) -> &KeyStore<KeyIds>

pub fn get_security_version(&self) -> u64

Returns the security version of the user. 1 is returned for V1 users that do not have a signed security state. 2 or greater is returned for V2 users that have a signed security state.

pub fn init_user_id(&self, user_id: UserId) -> Result<(), UserIdAlreadySetError>

pub fn get_user_id(&self) -> Option<UserId>

pub(crate) fn initialize_user_crypto_master_key( &self, master_key: MasterKey, user_key: EncString, key_state: UserKeyState, ) -> Result<(), EncryptionSettingsError>

pub(crate) fn initialize_user_crypto_decrypted_key( &self, user_key: SymmetricCryptoKey, key_state: UserKeyState, ) -> Result<(), EncryptionSettingsError>

pub(crate) fn initialize_user_crypto_pin( &self, pin_key: PinKey, pin_protected_user_key: EncString, key_state: UserKeyState, ) -> Result<(), EncryptionSettingsError>

pub(crate) fn initialize_user_crypto_pin_envelope( &self, pin: String, pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope, key_state: UserKeyState, ) -> Result<(), EncryptionSettingsError>

pub(crate) fn initialize_crypto_single_org_key( &self, organization_id: OrganizationId, key: SymmetricCryptoKey, )

pub fn initialize_org_crypto( &self, org_keys: Vec<(OrganizationId, UnsignedSharedKey)>, ) -> Result<(), EncryptionSettingsError>

pub(crate) fn initialize_user_crypto_master_password_unlock( &self, password: String, master_password_unlock: MasterPasswordUnlockData, key_state: UserKeyState, ) -> Result<(), EncryptionSettingsError>

pub fn set_user_master_password_unlock( &self, master_password_unlock: MasterPasswordUnlockData, ) -> Result<(), NotAuthenticatedError>

Sets the local KDF state for the master password unlock login method. Salt and user key update is not supported yet.

Trait Implementations

impl Debug for InternalClient

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

Formats the value using the given formatter.