Struct Session 

pub struct Session {
    pub issuer: String,
    pub authorization_state: Option<AuthorizationState>,
    pub original_path: String,
    pub code_verifier: String,
    pub state: String,
}

Struct that holds all information about the current session including the authorization state, the original path, the PKCE code verifier and the state

Fields

issuer: String

Issuer of the OpenID Connect Provider

authorization_state: Option<AuthorizationState>

Authorization state

original_path: String

Original Path to which the user should be redirected after login

code_verifier: String

PKCE Code Verifier used to generate the PKCE Code Challenge

state: String

State used to prevent CSRF attacks

Implementations

impl Session

pub fn encrypt_and_encode( &self, cipher: Aes256Gcm, ) -> Result<(String, String), PluginError>

Create a new session, encrypt it and encode it by using the given cipher

• cipher - Cipher used to encrypt the cookie

Returns:

• the base64 encoded encrypted session data
• the base64 encoded nonce needed to decrypt it

pub fn make_cookie_values( encoded_cookie: &str, encoded_nonce: &str, cookie_name: &str, cookie_duration_in_s: u64, ) -> Vec<String>

Make the cookie values from the encoded cookie by splitting it into chunks of 4000 bytes and then building the values to be set in the Set-Cookie headers

• encoded_cookie - Encoded cookie to be split into chunks of 4000 bytes
• encoded_nonce - Base64 encoded nonce needed to decrypt the cookie
• cookie_name - Name of the cookie
• cookie_duration_in_s - Duration of the cookie in seconds

pub fn clear_cookie_values(cookie_name: &str, num_parts: u8) -> Vec<String>

Build Set-Cookie values that expire all session cookie parts immediately.

num_parts should be the current {cookie_name}-parts value from the request (default to at least 1 so {cookie_name}-0 is cleared even if -parts is missing).

pub fn make_set_cookie_headers( cookie_values: &[String], ) -> Vec<(&'static str, &str)>

Make the Set-Cookie headers from the cookie values

• cookie_values - Cookie values to be set in the Set-Cookie headers

pub fn decode_and_decrypt( encoded_cookie: String, cipher: Aes256Gcm, encoded_nonce: String, ) -> Result<Session, PluginError>

Decode cookie, parse into a struct in order to access the fields

• encoded_cookie - Encoded cookie to be decoded and parsed into a struct
• cipher - Cipher used to decrypt the cookie
• encoded_nonce - Nonce used to decrypt the cookie

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Session

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

where __S: Serializer,

Serialize this value into the given Serde serializer.