Enum citadel_sdk::prelude::ProposedCredentials

pub enum ProposedCredentials {
    Enabled {
        username: String,
        password_hashed: SecBuffer,
        full_name: String,
        clientside_only_registration_settings: Option<ArgonSettings>,
    },
    Disabled {
        username: String,
    },
}

When creating credentials, this is required

Variants

Enabled

Denotes that credentials will be used

Fields

username: String

Username of the client

password_hashed: SecBuffer

Password (hashed)

full_name: String

Full name or alternative moniker

clientside_only_registration_settings: Option<ArgonSettings>

Only existent if the new_register constructor is called. Serialization of this field is skipped since this is only used for clientside

Disabled

Denotes that credentials will not be used (passwordless)

Fields

username: String

Implementations

impl ProposedCredentials

pub async fn new_connect<T, R>( full_name: T, username: R, password_raw: SecBuffer, settings: ArgonSettings, ) -> Result<ProposedCredentials, AccountError>

where T: Into<String> + Send, R: Into<String> + Send,

Generates the proper connect credentials. Does NOT trim the password (if trimming is needed, make sure the password is already trimmed before calling this function).

pub const fn passwordless(username: String) -> ProposedCredentials

Generates an empty skeleton for authless mode

pub async fn new_register<T, R>( full_name: T, username: R, password_unhashed: SecBuffer, ) -> Result<ProposedCredentials, AccountError>

where T: Into<String> + Send, R: Into<String> + Send,

Generates the proper registration credentials. Trims the username, password, and full name, removing any whitespace from the ends. Should only be called client-side

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space.

pub fn decompose(self) -> (String, SecBuffer, String, Option<ArgonSettings>)

Gets all the internal values

pub fn password_transform<T>(password_raw: T) -> SecBuffer

where T: AsRef<[u8]>,

SHA’s the password before input into argon

pub fn is_passwordless(&self) -> bool

Returns true if passwordless

pub fn username(&self) -> &str

Returns the username or uuid of the client

impl ProposedCredentials

pub async fn derive_server_container( self, server_argon_settings: &ArgonSettings, server_misc_settings: &ServerMiscSettings, ) -> Result<DeclaredAuthenticationMode, AccountError>

Called when the server registers the client-provided credentials

pub async fn validate_credentials( self, argon_container: ArgonContainerType, ) -> Result<(), AccountError>

Validates the credentials

pub fn compare_username(&self, other: &[u8]) -> bool

Compares usernames for equality

Trait Implementations

impl Clone for ProposedCredentials

fn clone(&self) -> ProposedCredentials

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProposedCredentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProposedCredentials

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProposedCredentials, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProposedCredentials

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.