Struct libp2p_noise::Handshake

pub struct Handshake<T, C>(_);

A future performing a Noise handshake pattern.

Methods

impl<T, C> Handshake<T, C> where
    T: AsyncRead + AsyncWrite + Send + 'static,
    C: Protocol<C> + AsRef<[u8]> + Send + 'static, 

pub fn rt1_initiator(
    io: T,
    session: Result<Session, NoiseError>,
    identity: KeypairIdentity,
    identity_x: IdentityExchange
) -> Handshake<T, C>

Creates an authenticated Noise handshake for the initiator of a single roundtrip (2 message) handshake pattern.

Subject to the chosen IdentityExchange, this message sequence identifies the local node to the remote with the first message payload (i.e. unencrypted) and expects the remote to identify itself in the second message payload.

This message sequence is suitable for authenticated 2-message Noise handshake patterns where the static keys of the initiator and responder are either known (i.e. appear in the pre-message pattern) or are sent with the first and second message, respectively (e.g. IK or IX).

initiator -{id}-> responder
initiator <-{id}- responder

pub fn rt1_responder(
    io: T,
    session: Result<Session, NoiseError>,
    identity: KeypairIdentity,
    identity_x: IdentityExchange
) -> Handshake<T, C>

Creates an authenticated Noise handshake for the responder of a single roundtrip (2 message) handshake pattern.

Subject to the chosen IdentityExchange, this message sequence expects the remote to identify itself in the first message payload (i.e. unencrypted) and identifies the local node to the remote in the second message payload.

This message sequence is suitable for authenticated 2-message Noise handshake patterns where the static keys of the initiator and responder are either known (i.e. appear in the pre-message pattern) or are sent with the first and second message, respectively (e.g. IK or IX).

initiator -{id}-> responder
initiator <-{id}- responder

pub fn rt15_initiator(
    io: T,
    session: Result<Session, NoiseError>,
    identity: KeypairIdentity,
    identity_x: IdentityExchange
) -> Handshake<T, C>

Creates an authenticated Noise handshake for the initiator of a 1.5-roundtrip (3 message) handshake pattern.

Subject to the chosen IdentityExchange, this message sequence expects the remote to identify itself in the second message payload and identifies the local node to the remote in the third message payload. The first (unencrypted) message payload is always empty.

This message sequence is suitable for authenticated 3-message Noise handshake patterns where the static keys of the responder and initiator are either known (i.e. appear in the pre-message pattern) or are sent with the second and third message, respectively (e.g. XX).

initiator --{}--> responder
initiator <-{id}- responder
initiator -{id}-> responder

pub fn rt15_responder(
    io: T,
    session: Result<Session, NoiseError>,
    identity: KeypairIdentity,
    identity_x: IdentityExchange
) -> Handshake<T, C>

Creates an authenticated Noise handshake for the responder of a 1.5-roundtrip (3 message) handshake pattern.

Subject to the chosen IdentityExchange, this message sequence identifies the local node in the second message payload and expects the remote to identify itself in the third message payload. The first (unencrypted) message payload is always empty.

This message sequence is suitable for authenticated 3-message Noise handshake patterns where the static keys of the responder and initiator are either known (i.e. appear in the pre-message pattern) or are sent with the second and third message, respectively (e.g. XX).

initiator --{}--> responder
initiator <-{id}- responder
initiator -{id}-> responder

Trait Implementations

impl<T, C> Future for Handshake<T, C>

type Error = NoiseError

The type of error that this future will resolve with if it fails in a normal fashion.

type Item = (RemoteIdentity<C>, NoiseOutput<T>)

The type of value that this future will resolved with if it is successful.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.