Skip to main content

SessionInitServer

Struct SessionInitServer 

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

The communication server’s half of session initiation.

It owns the token store for one pairing and never hands out a communication token without having accepted an access token first.

Implementations§

Source§

impl SessionInitServer

Source

pub fn new( node_id: NodeId, peer_node_id: NodeId, tokens: TokenStore, websocket_url: impl Into<String>, ) -> Self

A server for one pairing.

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 authenticates(&self, bearer: &AccessToken) -> bool

Whether a bearer presented on either endpoint is one we would accept.

A false is a 401.

Source

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

Handle initiateSession.

access_entropy is a parameter for the same reason it is in pairing: a test needs it pinned, and this layer has no business knowing where a system keeps its randomness.

§Errors

ConnectError::NotPaired is a 401; a SessionRefused carried in ConnectError::SessionRefused is a 400 with that body.

Source

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

Handle confirmAccessToken, retiring every older token.

The bearer is the confirmation: a client that can present the new token has stored it, so there is nothing else to check and nothing to take on trust.

Source

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

Handle unpair.

Source

pub fn accepts_connection(&mut self, presented: &str, now: Timestamp) -> bool

Whether a bearer presented on a WebSocket handshake is the one this server issued, and still inside its thirty seconds.

Takes &mut self and consumes the token on success, because s2-connect-common.yml/CommunicationToken says it is “valid for a single connection”: a second upgrade with the same bearer is refused rather than silently granted a parallel session.

Source

pub fn tokens(&self) -> &TokenStore

The tokens, to persist.

Trait Implementations§

Source§

impl Debug for SessionInitServer

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