Struct custodian_password::ClientLogin

pub struct ClientLogin { /* fields omitted */ }

Holds the state of a login process. See login.

Implementations

impl ClientLogin

pub const fn config(&self) -> ClientConfig

Returns the ClientConfig associated with this ClientLogin.

pub fn login<P: AsRef<[u8]>>(
    config: ClientConfig,
    file: Option<ClientFile>,
    password: P
) -> Result<(Self, LoginRequest)>

Starts the login process. The returned LoginRequest has to be send to the server to drive the login process. See ServerLogin::login().

If a ClientFile was stored during registration, it can validate the server when passed.

Errors

• Error::Config if ClientConfig and ClientFile were not created with the same Config
• Error::ConfigPublicKey if PublicKey in ClientConfig and ClientFile don’t match
• Error::Opaque on internal OPAQUE error

pub fn finish(
    self,
    response: LoginResponse
) -> Result<(ClientFile, LoginFinalization, ExportKey)>

Finishes the login process. The returned LoginFinalization has to be send back to the server to finish the login process.

ClientFile can be used to validate the server during the next login. See login().

ExportKey can be used to encrypt data and store it on safely on the server. See ExportKey for more details.

Errors

• Error::Config if ClientLogin and LoginResponse were not created with the same Config
• Error::Credentials if credentials don’t match
• Error::InvalidServer if the public key given in login() does not match the servers public key
• Error::Opaque on internal OPAQUE error

Trait Implementations

impl Clone for ClientLogin

fn clone(&self) -> ClientLogin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientLogin

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientLogin

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

Deserialize this value from the given Serde deserializer.

impl Hash for ClientLogin

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ClientLogin> for ClientLogin

fn eq(&self, other: &ClientLogin) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ClientLogin) -> bool

This method tests for !=.

impl Serialize for ClientLogin

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

Serialize this value into the given Serde serializer.

impl Eq for ClientLogin

impl StructuralEq for ClientLogin

impl StructuralPartialEq for ClientLogin