Enum SessionToken

pub enum SessionToken {
    Opaque(String),
    Jwt(String),
}

Re-export core types from torii_core

These types are commonly used when working with the Torii API. Session token type enum - either a simple opaque token or a JWT

Variants

Opaque(String)

Opaque token - a token with at least 128 bits of entropy used for performing lookups in the session storage

Jwt(String)

JWT token - contains the session data within the token without any additional lookup in the session storage

Implementations

impl SessionToken

pub fn new(token: &str) -> SessionToken

Create a new session token from an existing string

pub fn new_random() -> SessionToken

Create a new random opaque session token

pub fn new_jwt( claims: &JwtClaims, config: &JwtConfig, ) -> Result<SessionToken, Error>

Create a new JWT session token with the specified algorithm

pub fn verify_jwt(&self, config: &JwtConfig) -> Result<JwtClaims, Error>

Verify a JWT session token and return the claims

pub fn new_jwt_rs256( claims: &JwtClaims, private_key: &[u8], ) -> Result<SessionToken, Error>

Create a new JWT session token using RS256 algorithm

pub fn verify_jwt_rs256(&self, public_key: &[u8]) -> Result<JwtClaims, Error>

Verify a JWT session token using RS256 algorithm and return the claims

pub fn new_jwt_hs256( claims: &JwtClaims, secret_key: &[u8], ) -> Result<SessionToken, Error>

Create a new JWT session token using HS256 algorithm

pub fn verify_jwt_hs256(&self, secret_key: &[u8]) -> Result<JwtClaims, Error>

Verify a JWT session token using HS256 algorithm and return the claims

pub fn into_inner(self) -> String

Get the inner token string

pub fn as_str(&self) -> &str

Get a reference to the token string

Trait Implementations

impl Clone for SessionToken

fn clone(&self) -> SessionToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionToken

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

Formats the value using the given formatter.

impl Default for SessionToken

fn default() -> SessionToken

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SessionToken

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

Formats the value using the given formatter.

impl From<&str> for SessionToken

fn from(s: &str) -> SessionToken

Converts to this type from the input type.

impl From<String> for SessionToken

fn from(s: String) -> SessionToken

Converts to this type from the input type.

impl Hash for SessionToken

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SessionToken

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SessionToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SessionToken

impl StructuralPartialEq for SessionToken