Skip to main content

PendingSession

Struct PendingSession 

Source
pub struct PendingSession<S> { /* private fields */ }
Expand description

A stream whose first Noise message has been read but not yet processed.

This exists so that a responder can act on the initiator’s cleartext payload before deriving any keys. Everything up to PendingSession::into_session is reading and parsing, so a peer that is going to be turned away - one that is not an authorized validator, say - costs no scalar multiplications. Under a distributed flood of connection attempts, that is the difference between paying for five of them per rejected peer and paying for none.

Implementations§

Source§

impl<S: AsyncRead + AsyncWrite + Unpin> PendingSession<S>

Source

pub async fn accept(stream: S) -> Result<Self>

Reads the pattern’s first message from the given stream.

The caller is responsible for the NOISE_MAGIC prefix, which must already have been consumed with detect_handshake_protocol.

Source

pub fn first_payload(&self) -> Result<&[u8]>

Returns the payload the initiator sent alongside its ephemeral key.

It is neither encrypted nor authenticated, so it is a claim and not a fact: anything acted on here has to be re-checked against the authenticated copy later in the handshake.

Source

pub fn into_session(self) -> Result<NoiseSession<S>>

Derives the responder’s keys and processes the first message.

Auto Trait Implementations§

§

impl<S> Freeze for PendingSession<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for PendingSession<S>
where S: RefUnwindSafe,

§

impl<S> Send for PendingSession<S>
where S: Send,

§

impl<S> Sync for PendingSession<S>
where S: Sync,

§

impl<S> Unpin for PendingSession<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for PendingSession<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for PendingSession<S>
where S: UnwindSafe,

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<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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<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