Struct libp2p::noise::NoiseAuthenticated[−][src]

pub struct NoiseAuthenticated<P, C, R> where
    C: Zeroize,  { /* fields omitted */ }

Expand description

A NoiseAuthenticated transport upgrade that wraps around any NoiseConfig handshake and verifies that the remote identified with a RemoteIdentity::IdentityKey, aborting otherwise.

See NoiseConfig::into_authenticated.

On success, the upgrade yields the PeerId obtained from the RemoteIdentity. The output of this upgrade is thus directly suitable for creating an authenticated transport for use with a Network.

Trait Implementations

impl<P, C, R> Clone for NoiseAuthenticated<P, C, R> where
    C: Clone + Zeroize,
    P: Clone,
    R: Clone,

pub fn clone(&self) -> NoiseAuthenticated<P, C, R>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl<T, P, C, R> InboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Send + 'static,
    NoiseConfig<P, C, R>: UpgradeInfo,
    NoiseConfig<P, C, R>: InboundUpgrade<T>,
    NoiseConfig<P, C, R>: 'static,
    <NoiseConfig<P, C, R> as InboundUpgrade<T>>::Future: Send,
    <NoiseConfig<P, C, R> as InboundUpgrade<T>>::Output == (RemoteIdentity<C>, NoiseOutput<T>),
    <NoiseConfig<P, C, R> as InboundUpgrade<T>>::Error == NoiseError,

type Output = (PeerId, NoiseOutput<T>)

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = NoiseError

Possible error during the handshake.

type Future = Pin<Box<dyn Future<Output = Result<<NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Output, <NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Error>> + 'static + Send, Global>>

Future that performs the handshake with the remote.

pub fn upgrade_inbound(
    self, 
    socket: T, 
    info: <NoiseAuthenticated<P, C, R> as UpgradeInfo>::Info
) -> <NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

impl<T, P, C, R> OutboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Send + 'static,
    NoiseConfig<P, C, R>: UpgradeInfo,
    NoiseConfig<P, C, R>: OutboundUpgrade<T>,
    NoiseConfig<P, C, R>: 'static,
    <NoiseConfig<P, C, R> as OutboundUpgrade<T>>::Future: Send,
    <NoiseConfig<P, C, R> as OutboundUpgrade<T>>::Output == (RemoteIdentity<C>, NoiseOutput<T>),
    <NoiseConfig<P, C, R> as OutboundUpgrade<T>>::Error == NoiseError,

type Output = (PeerId, NoiseOutput<T>)

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = NoiseError

Possible error during the handshake.

type Future = Pin<Box<dyn Future<Output = Result<<NoiseAuthenticated<P, C, R> as OutboundUpgrade<T>>::Output, <NoiseAuthenticated<P, C, R> as OutboundUpgrade<T>>::Error>> + 'static + Send, Global>>

Future that performs the handshake with the remote.

pub fn upgrade_outbound(
    self, 
    socket: T, 
    info: <NoiseAuthenticated<P, C, R> as UpgradeInfo>::Info
) -> <NoiseAuthenticated<P, C, R> as OutboundUpgrade<T>>::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

impl<P, C, R> UpgradeInfo for NoiseAuthenticated<P, C, R> where
    C: Zeroize,
    NoiseConfig<P, C, R>: UpgradeInfo,

type Info = <NoiseConfig<P, C, R> as UpgradeInfo>::Info

Opaque type representing a negotiable protocol.

type InfoIter = <NoiseConfig<P, C, R> as UpgradeInfo>::InfoIter

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseAuthenticated<P, C, R> as UpgradeInfo>::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.

Auto Trait Implementations

impl<P, C, R> RefUnwindSafe for NoiseAuthenticated<P, C, R> where
    C: RefUnwindSafe,
    P: RefUnwindSafe,
    R: RefUnwindSafe,

impl<P, C, R> Send for NoiseAuthenticated<P, C, R> where
    C: Send,
    P: Send,
    R: Send,

impl<P, C, R> Sync for NoiseAuthenticated<P, C, R> where
    C: Sync,
    P: Sync,
    R: Sync,

impl<P, C, R> Unpin for NoiseAuthenticated<P, C, R> where
    C: Unpin,
    P: Unpin,
    R: Unpin,

impl<P, C, R> UnwindSafe for NoiseAuthenticated<P, C, R> where
    C: UnwindSafe,
    P: UnwindSafe,
    R: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<C, U> InboundUpgradeExt<C> for U where
    U: InboundUpgrade<C>,

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
    F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
    F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<C, U> OutboundUpgradeExt<C> for U where
    U: OutboundUpgrade<C>,

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
    F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
    F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V