Skip to main content

WebSessionManager

Struct WebSessionManager 

Source
pub struct WebSessionManager { /* private fields */ }
Expand description

Server-side session manager for web applications.

Maps opaque session IDs (UUIDs) to OAuth tokens with automatic refresh and idle-timeout eviction.

§Idle timeout

Sessions that have not been accessed for idle_timeout_secs (default: 1 hour) are evicted during an amortized sweep that runs when the session count exceeds sweep_threshold (default: 64).

§Usage

use pep::session_manager::WebSessionManager;
use pep::oidc_client::OidcClient;

let mgr = WebSessionManager::new(
    OidcClient::new(),
    "https://idm.example.com/oauth2/openid/pdt-api".to_string(),
    "pdt-api".to_string(),
    None,
    "openid profile email".to_string(),
);

// After OAuth callback:
let session_id = mgr.create_session(&token_response).await.unwrap();
// Store `session_id` in an HttpOnly cookie.

// On subsequent requests:
let access_token = mgr.get_token(&session_id).await.unwrap();

Implementations§

Source§

impl WebSessionManager

Source

pub fn new( oidc_client: OidcClient, issuer_url: String, client_id: String, client_secret: Option<String>, scope: String, ) -> Self

Create a new WebSessionManager with an in-memory store.

§Arguments
  • oidc_client — OIDC client for token refresh operations.
  • issuer_url — OIDC issuer URL (used for discovery during refresh).
  • client_id — OAuth2 client ID.
  • client_secret — Optional client secret (for confidential clients).
  • scope — OAuth2 scopes (used during refresh).
Source

pub fn with_refresh_buffer(self, secs: u64) -> Self

Set the refresh buffer (how many seconds before expiry to trigger a refresh).

Default: 60 seconds.

Source

pub fn with_idle_timeout(self, secs: u64) -> Self

Set the idle timeout — sessions not accessed for this long are evicted.

Default: 3600 seconds (1 hour).

Source

pub fn with_sweep_threshold(self, threshold: usize) -> Self

Set the sweep threshold — amortized cleanup runs when session count exceeds this number.

Default: 64.

Source

pub async fn create_session( &self, token_response: &TokenResponse, ) -> Result<String>

Create a new session from a token response.

Generates a random UUID session ID, stores the tokens server-side, and returns the session ID to be stored in a browser cookie.

Important: The caller must keep the refresh_token from the token response — this method stores it server-side so it can be used for later refreshes.

Source

pub async fn get_token(&self, session_id: &str) -> Result<String>

Get a valid access token for the given session, refreshing if necessary.

Updates last_accessed on every successful call. Performs amortized idle-session sweep when the session count exceeds the threshold.

§Returns
  • Ok(token) — A valid access token (possibly freshly refreshed).
  • Err(PepError::AuthenticationRequired) — Session not found, idle timed out, or refresh failed. The caller should redirect to login.
Source

pub async fn force_refresh(&self, session_id: &str) -> Result<String>

Force-refresh the token for a session, ignoring the cache.

Use this when a caller knows the cached token is invalid (e.g. JWT validation failed with ExpiredSignature despite our expiry estimate saying there’s time left — clock skew between servers).

Source

pub fn destroy_session(&self, session_id: &str) -> Result<()>

Destroy a session, removing it from the store.

Call this on logout to invalidate the session immediately.

Source

pub fn session_count(&self) -> usize

Returns the current number of active sessions.

Trait Implementations§

Source§

impl Debug for WebSessionManager

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more