Struct yubirs::otp::result::VerificationResult

pub struct VerificationResult {
    pub otp: Option<String>,
    pub nonce: Option<String>,
    pub signature: Vec<u8>,
    pub timestamp: DateTime<Utc>,
    pub status: Status,
    pub decrypted_timestamp: Option<String>,
    pub decrypted_use_counter: Option<String>,
    pub decrypted_session_use_counter: Option<String>,
    pub success_percent: Option<u8>,
    // some fields omitted
}

This structure provides type-safe access to all of the fields which may appear in a response / verification result from the Yubico API. More details on what the fields mean are in the official documentation: https://developers.yubico.com/OTP/Specifications/OTP_validation_protocol.html.

Fields

otp: Option<String>

nonce: Option<String>

signature: Vec<u8>

timestamp: DateTime<Utc>

status: Status

decrypted_timestamp: Option<String>

decrypted_use_counter: Option<String>

decrypted_session_use_counter: Option<String>

success_percent: Option<u8>

Methods

impl VerificationResult

pub fn new(
    api_key: &[u8],
    expected_otp: &Otp,
    expected_nonce: &str,
    response: Vec<u8>
) -> Result<VerificationResult>

Parse the given raw HTTP response into a result structure. Use the other pieces of information to verify that the response is valid (i.e., the contents and signature match what we expect).

pub fn is_valid(&self) -> bool

Returns true if and only if the result indicates that the OTP was successfully verified.

pub fn is_retryable_error(&self) -> bool

Returns true if this error is retryable (i.e., the request may actually succeed if we try it again).

Trait Implementations

impl Clone for VerificationResult

fn clone(&self) -> VerificationResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationResult

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

Formats the value using the given formatter.