Skip to main content

SessionService

Struct SessionService 

Source
pub struct SessionService { /* private fields */ }
Available on crate feature connect-server only.
Expand description

Runs the session-initiation half of an endpoint.

Almost everything it needs is in the Store and in the bearer the client presented, including the replacement access token it issued and has not yet seen confirmed — a server that held that in memory would retire the wrong token after a restart.

What it keeps in memory is what must not survive a restart: the communication tokens handed out and not yet used (each valid for thirty seconds and one connection), and the WebSocket sessions currently open, so that unpairing can end them.

Implementations§

Source§

impl SessionService

Source

pub fn new(store: Arc<dyn Store>, websocket_url: impl Into<String>) -> Self

A service answering on websocket_url, which must be wss:// (S2C §Encrypted connection: “S2 MUST NOT be sent over unencrypted channels”).

Source

pub fn with_s2_message_versions(self, versions: Vec<ProtocolVersion>) -> Self

Offer a different set of S2 JSON message versions, newest first.

Source

pub fn store(&self) -> &Arc<dyn Store> ⓘ

The store.

Source

pub fn initiate_session( &self, bearer: &AccessToken, request: &SessionRequest, access_entropy: &[u8], now: Timestamp, ) -> Result<SessionGrant, ConnectError>

POST /v1/initiateSession.

The replacement token is stored alongside the presented one, never instead of it: until the client confirms, either must work, or a lost reply destroys the pairing.

A pairing this endpoint revoked answers NoLongerPaired — once, to a client that proves it held it — and is then forgotten.

Source

pub fn confirm_access_token( &self, bearer: &AccessToken, communication_entropy: &[u8], now: Timestamp, ) -> Result<(PairingKey, CommunicationDetails), ConnectError>

POST /v1/confirmAccessToken.

The bearer is the confirmation. Every older token is retired here, and not one request earlier.

Source

pub fn authorize_connection( &self, presented: &str, now: Timestamp, ) -> Option<PairingKey>

Whether a bearer presented on a WebSocket upgrade is one this endpoint issued, and which pairing it belongs to.

The token is consumed: s2-connect-common.yml/CommunicationToken is “valid for a single connection … for maximum 30 seconds”, so a replay is refused rather than granted a second session in parallel with the first. Every token is compared in constant time and the list is swept of expired entries on the way through.

This is what a host mounts its /s2 route on — websocket_router does it for you.

Source

pub fn pending_connections(&self) -> usize

How many issued communication tokens are still waiting to be used.

For a health endpoint, and for a test that wants to see one consumed.

Source

pub fn register_session(self: &Arc<Self>, key: PairingKey) -> LiveSession

Start tracking an open WebSocket session, so unpairing can end it.

websocket_router does this for every socket it accepts; a host terminating the WebSocket itself calls it after authorize_connection.

Source

pub fn live_sessions(&self, key: PairingKey) -> usize

How many WebSocket sessions are open for one pairing.

Source

pub fn end_sessions(&self, key: PairingKey)

End every open session of a pairing, and void its unused communication tokens.

Source

pub fn unpair( &self, bearer: &AccessToken, request: &UnpairRequest, ) -> Result<(), ConnectError>

POST /v1/unpair — the client renounces the pairing.

Source

pub fn unpair_remote(&self, key: PairingKey)

Unpair from this side: end the pairing’s sessions now, and answer its next initiateSession with NoLongerPaired.

S2C §Unpairing by the communication server also says the server “should send an S2 SessionRequest … RECONNECT” over the open session first; that is a message of the S2 session the host runs, so send it before calling this.

Source

pub fn tokens(&self, key: PairingKey) -> Option<TokenStore>

The tokens of one pairing, for a route that must check a bearer.

Trait Implementations§

Source§

impl Debug for SessionService

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<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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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