Struct libp2p::noise::NoiseAuthenticated
source · [−]pub struct NoiseAuthenticated<P, C, R> where
C: Zeroize, { /* private fields */ }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
sourceimpl<P, C, R> Clone for NoiseAuthenticated<P, C, R> where
P: Clone,
C: Clone + Zeroize,
R: Clone,
impl<P, C, R> Clone for NoiseAuthenticated<P, C, R> where
P: Clone,
C: Clone + Zeroize,
R: Clone,
sourcepub fn clone(&self) -> NoiseAuthenticated<P, C, R>
pub fn clone(&self) -> NoiseAuthenticated<P, C, R>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl<T, P, C, R> InboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
T: 'static + AsyncRead + AsyncWrite + Send,
C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
NoiseConfig<P, C, R>: 'static,
NoiseConfig<P, C, R>: UpgradeInfo,
NoiseConfig<P, C, R>: InboundUpgrade<T>,
<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,
impl<T, P, C, R> InboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
T: 'static + AsyncRead + AsyncWrite + Send,
C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
NoiseConfig<P, C, R>: 'static,
NoiseConfig<P, C, R>: UpgradeInfo,
NoiseConfig<P, C, R>: InboundUpgrade<T>,
<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>)
type Output = (PeerId, NoiseOutput<T>)
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = NoiseError
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>> + Send + 'static, Global>>
type Future = Pin<Box<dyn Future<Output = Result<<NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Output, <NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Error>> + Send + 'static, Global>>
Future that performs the handshake with the remote.
sourcepub fn upgrade_inbound(
self,
socket: T,
info: <NoiseAuthenticated<P, C, R> as UpgradeInfo>::Info
) -> <NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Future
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
sourceimpl<T, P, C, R> OutboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
T: 'static + AsyncRead + AsyncWrite + Send,
C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
NoiseConfig<P, C, R>: 'static,
NoiseConfig<P, C, R>: UpgradeInfo,
NoiseConfig<P, C, R>: OutboundUpgrade<T>,
<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,
impl<T, P, C, R> OutboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
T: 'static + AsyncRead + AsyncWrite + Send,
C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
NoiseConfig<P, C, R>: 'static,
NoiseConfig<P, C, R>: UpgradeInfo,
NoiseConfig<P, C, R>: OutboundUpgrade<T>,
<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>)
type Output = (PeerId, NoiseOutput<T>)
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = NoiseError
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>> + Send + 'static, Global>>
type Future = Pin<Box<dyn Future<Output = Result<<NoiseAuthenticated<P, C, R> as OutboundUpgrade<T>>::Output, <NoiseAuthenticated<P, C, R> as OutboundUpgrade<T>>::Error>> + Send + 'static, Global>>
Future that performs the handshake with the remote.
sourcepub fn upgrade_outbound(
self,
socket: T,
info: <NoiseAuthenticated<P, C, R> as UpgradeInfo>::Info
) -> <NoiseAuthenticated<P, C, R> as OutboundUpgrade<T>>::Future
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
sourceimpl<P, C, R> UpgradeInfo for NoiseAuthenticated<P, C, R> where
C: Zeroize,
NoiseConfig<P, C, R>: UpgradeInfo,
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
type Info = <NoiseConfig<P, C, R> as UpgradeInfo>::Info
Opaque type representing a negotiable protocol.
type InfoIter = <NoiseConfig<P, C, R> as UpgradeInfo>::InfoIter
type InfoIter = <NoiseConfig<P, C, R> as UpgradeInfo>::InfoIter
Iterator returned by protocol_info.
sourcepub fn protocol_info(
&self
) -> <NoiseAuthenticated<P, C, R> as UpgradeInfo>::InfoIter
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,
impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,
sourcefn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
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.
sourcefn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
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.
sourceimpl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,
impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,
sourcefn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
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.
sourcefn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
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.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more