Struct lite_session::LiteSessionToken

pub struct LiteSessionToken { /* fields omitted */ }

The token strucuture that performs token operations

use tai64::TAI64N;
use lite_session::{LiteSessionData, ConfidentialityMode, LiteSessionMode};
use blake3::Hash;

pub struct LiteSessionToken {
    identifier: String,
    issued: TAI64N,
    expiry: TAI64N,
    hmac_data: LiteSessionData,
    confidentiality: ConfidentialityMode,
    hmac: blake3::Hash,
    mode: LiteSessionMode,
}

Implementations

impl LiteSessionToken

pub fn identifier(&mut self, identifier: &str) -> &mut Self

Add an custom identifier for the token

pub fn expiry(&mut self, expiry_in_secs: u64) -> &mut Self

Add a custom expiry time for the token. Default exipry is 24 hours

pub fn hmac_data(&mut self, data: LiteSessionData) -> &mut Self

The data contained here describes the token and its capabilities as provided by LiteSessionData struct

pub fn confidential(&mut self, bool_choice: bool) -> &mut Self

Choose the security mode. Choosing true makes the token authenticate in high confidentiality mode by setting the field to ConfidentialityMode::High setting it to false sets the security mode to ConfidentialityMode::Low

pub fn mode(&mut self, mode: LiteSessionMode) -> &mut Self

Set the session mode to either use a SessionID or not

pub fn build_secure(
    &mut self,
    server_key: &[u8]
) -> Result<String, LiteSessionError>

Build the token with High Confidentiality

pub fn from_string(
    &mut self,
    server_key: &[u8],
    token: &str
) -> Result<(TokenOutcome, &Self), LiteSessionError>

Destructure and autheticate a token

pub fn immutable(&mut self) -> &Self

Make a mutable LiteSessionToken immutable

Trait Implementations

impl Clone for LiteSessionToken

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiteSessionToken

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

Formats the value using the given formatter.

impl Default for LiteSessionToken

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<LiteSessionToken> for LiteSessionToken

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.