Struct sqrl_protocol::client_request::ClientParameters

pub struct ClientParameters {
    pub protocol_version: ProtocolVersion,
    pub command: ClientCommand,
    pub identity_key: VerifyingKey,
    pub options: Option<Vec<ClientOption>>,
    pub button: Option<u8>,
    pub previous_identity_key: Option<VerifyingKey>,
    pub index_secret: Option<String>,
    pub previous_index_secret: Option<String>,
    pub server_unlock_key: Option<String>,
    pub verify_unlock_key: Option<String>,
}

Parameters used for sending requests to the client

Fields

protocol_version: ProtocolVersion

The supported protocol versions of the client (ver)

command: ClientCommand

The client command requested to be performed (cmd)

identity_key: VerifyingKey

The client identity used to sign the request (idk)

options: Option<Vec<ClientOption>>

Optional options requested by the client (opt)

button: Option<u8>

The button pressed in response to a server query (btn)

previous_identity_key: Option<VerifyingKey>

A previous client identity used to sign the request (pidk)

index_secret: Option<String>

The current identity indexed secret in response to a server query (ins)

previous_index_secret: Option<String>

The previous identity indexed secret in response to a server query (pins)

server_unlock_key: Option<String>

The server unlock key used for unlocking an identity (suk)

verify_unlock_key: Option<String>

The verify unlock key used for unlocking an identity (vuk)

Implementations

impl ClientParameters

pub fn new( command: ClientCommand, identity_key: VerifyingKey ) -> ClientParameters

Create a new client parameter using the command and verifying key

pub fn from_base64(base64_string: &str) -> Result<Self, SqrlError>

Parse a base64-encoded client parameter value

pub fn to_base64(&self) -> String

base64-encode this client parameter object

pub fn validate(&self) -> Result<(), SqrlError>

Verify the client request is valid

Trait Implementations

impl Debug for ClientParameters

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

Formats the value using the given formatter.

impl Display for ClientParameters

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

Formats the value using the given formatter.

impl FromStr for ClientParameters

type Err = SqrlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ClientParameters

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ClientParameters