Enum ProposedCredentials
pub enum ProposedCredentials {
Enabled {
username: String,
password_hashed: SecBuffer,
full_name: String,
clientside_only_registration_settings: Option<ArgonSettings>,
},
Disabled {
username: String,
},
}
Expand description
When creating credentials, this is required
Variants§
Enabled
Denotes that credentials will be used
Fields
Disabled
Denotes that credentials will not be used (passwordless)
Implementations§
§impl ProposedCredentials
impl ProposedCredentials
pub async fn new_connect<T, R>(
full_name: T,
username: R,
password_raw: SecBuffer,
settings: ArgonSettings,
) -> Result<ProposedCredentials, AccountError>
pub async fn new_connect<T, R>( full_name: T, username: R, password_raw: SecBuffer, settings: ArgonSettings, ) -> Result<ProposedCredentials, AccountError>
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
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>
pub async fn new_register<T, R>( full_name: T, username: R, password_unhashed: SecBuffer, ) -> Result<ProposedCredentials, AccountError>
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>)
pub fn decompose(self) -> (String, SecBuffer, String, Option<ArgonSettings>)
Gets all the internal values
pub fn password_transform<T>(password_raw: T) -> SecBuffer
pub fn password_transform<T>(password_raw: T) -> SecBuffer
SHA’s the password before input into argon
pub fn is_passwordless(&self) -> bool
pub fn is_passwordless(&self) -> bool
Returns true if passwordless
§impl ProposedCredentials
impl ProposedCredentials
pub async fn derive_server_container(
self,
server_argon_settings: &ArgonSettings,
server_misc_settings: &ServerMiscSettings,
) -> Result<DeclaredAuthenticationMode, AccountError>
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>
pub async fn validate_credentials( self, argon_container: ArgonContainerType, ) -> Result<(), AccountError>
Validates the credentials
pub fn compare_username(&self, other: &[u8]) -> bool
pub fn compare_username(&self, other: &[u8]) -> bool
Compares usernames for equality
Trait Implementations§
§impl Clone for ProposedCredentials
impl Clone for ProposedCredentials
§fn clone(&self) -> ProposedCredentials
fn clone(&self) -> ProposedCredentials
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ProposedCredentials
impl Debug for ProposedCredentials
§impl<'de> Deserialize<'de> for ProposedCredentials
impl<'de> Deserialize<'de> for ProposedCredentials
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<ProposedCredentials, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<ProposedCredentials, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl Serialize for ProposedCredentials
impl Serialize for ProposedCredentials
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Auto Trait Implementations§
impl Freeze for ProposedCredentials
impl RefUnwindSafe for ProposedCredentials
impl Send for ProposedCredentials
impl Sync for ProposedCredentials
impl Unpin for ProposedCredentials
impl UnwindSafe for ProposedCredentials
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<'a, T> SyncIO for Twhere
T: Serialize + Deserialize<'a>,
impl<'a, T> SyncIO for Twhere
T: Serialize + Deserialize<'a>,
§fn serialize_to_vector(&self) -> Result<Vec<u8>, AccountError>where
Self: Serialize,
fn serialize_to_vector(&self) -> Result<Vec<u8>, AccountError>where
Self: Serialize,
§fn deserialize_from_vector<'a>(input: &'a [u8]) -> Result<Self, AccountError>where
Self: Deserialize<'a>,
fn deserialize_from_vector<'a>(input: &'a [u8]) -> Result<Self, AccountError>where
Self: Deserialize<'a>,
§fn deserialize_from_owned_vector(input: Vec<u8>) -> Result<Self, AccountError>where
Self: DeserializeOwned,
fn deserialize_from_owned_vector(input: Vec<u8>) -> Result<Self, AccountError>where
Self: DeserializeOwned,
§fn deserialize_in_place<'a, R, T>(
reader: R,
place: &mut T,
) -> Result<(), AccountError>where
T: Deserialize<'a>,
R: BincodeRead<'a>,
fn deserialize_in_place<'a, R, T>(
reader: R,
place: &mut T,
) -> Result<(), AccountError>where
T: Deserialize<'a>,
R: BincodeRead<'a>,
§fn serialize_into_buf(&self, buf: &mut BytesMut) -> Result<(), AccountError>where
Self: Serialize,
fn serialize_into_buf(&self, buf: &mut BytesMut) -> Result<(), AccountError>where
Self: Serialize,
§fn serialize_into_slice(&self, slice: &mut [u8]) -> Result<(), AccountError>where
Self: Serialize,
fn serialize_into_slice(&self, slice: &mut [u8]) -> Result<(), AccountError>where
Self: Serialize,
§fn serialized_size(&self) -> Option<usize>where
Self: Serialize,
fn serialized_size(&self) -> Option<usize>where
Self: Serialize,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.