Struct libp2p_noise::NoiseConfig [−][src]
Expand description
The protocol upgrade configuration.
Implementations
Turn the NoiseConfig
into an authenticated upgrade for use
with a Network
.
Sets the legacy configuration options to use, if any.
Create a new NoiseConfig
for the IX
handshake pattern.
Create a new NoiseConfig
for the XX
handshake pattern.
Create a new NoiseConfig
for the IK
handshake pattern (recipient side).
Since the identity of the local node is known to the remote, this configuration does not transmit a static DH public key or public identity key to the remote.
pub fn ik_dialer(
dh_keys: AuthenticKeypair<C>,
remote_id: PublicKey,
remote_dh: PublicKey<C>
) -> Self
pub fn ik_dialer(
dh_keys: AuthenticKeypair<C>,
remote_id: PublicKey,
remote_dh: PublicKey<C>
) -> Self
Create a new NoiseConfig
for the IK
handshake pattern (initiator side).
In this configuration, the remote identity is known to the local node, but the local node still needs to transmit its own public identity.
Trait Implementations
impl<T, C> InboundUpgrade<T> for NoiseConfig<IX, C> where
NoiseConfig<IX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
impl<T, C> InboundUpgrade<T> for NoiseConfig<IX, C> where
NoiseConfig<IX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
type Output = (RemoteIdentity<C>, NoiseOutput<T>)
type Output = (RemoteIdentity<C>, 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.
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, C> InboundUpgrade<T> for NoiseConfig<XX, C> where
NoiseConfig<XX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
impl<T, C> InboundUpgrade<T> for NoiseConfig<XX, C> where
NoiseConfig<XX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
type Output = (RemoteIdentity<C>, NoiseOutput<T>)
type Output = (RemoteIdentity<C>, 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.
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, C, R> InboundUpgrade<T> for NoiseConfig<IK, C, R> where
NoiseConfig<IK, C, R>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
impl<T, C, R> InboundUpgrade<T> for NoiseConfig<IK, C, R> where
NoiseConfig<IK, C, R>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
type Output = (RemoteIdentity<C>, NoiseOutput<T>)
type Output = (RemoteIdentity<C>, 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.
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, C> OutboundUpgrade<T> for NoiseConfig<IX, C> where
NoiseConfig<IX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
impl<T, C> OutboundUpgrade<T> for NoiseConfig<IX, C> where
NoiseConfig<IX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
type Output = (RemoteIdentity<C>, NoiseOutput<T>)
type Output = (RemoteIdentity<C>, 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.
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, C> OutboundUpgrade<T> for NoiseConfig<XX, C> where
NoiseConfig<XX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
impl<T, C> OutboundUpgrade<T> for NoiseConfig<XX, C> where
NoiseConfig<XX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
type Output = (RemoteIdentity<C>, NoiseOutput<T>)
type Output = (RemoteIdentity<C>, 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.
After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
type Output = (RemoteIdentity<C>, NoiseOutput<T>)
type Output = (RemoteIdentity<C>, 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.
After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
Returns the list of protocols that are supported. Used during the negotiation process.
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
Returns the list of protocols that are supported. Used during the negotiation process.
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
Returns the list of protocols that are supported. Used during the negotiation process.
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
Returns the list of protocols that are supported. Used during the negotiation process.
Note: This is not currentlyy a standardised upgrade.
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
Returns the list of protocols that are supported. Used during the negotiation process.
Note: This is not currently a standardised upgrade.
type Info = &'static [u8]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
Returns the list of protocols that are supported. Used during the negotiation process.
Auto Trait Implementations
impl<P, C, R> RefUnwindSafe for NoiseConfig<P, C, R> where
C: RefUnwindSafe,
P: RefUnwindSafe,
R: RefUnwindSafe,
impl<P, C, R> Send for NoiseConfig<P, C, R> where
C: Send,
P: Send,
R: Send,
impl<P, C, R> Sync for NoiseConfig<P, C, R> where
C: Sync,
P: Sync,
R: Sync,
impl<P, C, R> Unpin for NoiseConfig<P, C, R> where
C: Unpin,
P: Unpin,
R: Unpin,
impl<P, C, R> UnwindSafe for NoiseConfig<P, C, R> where
C: UnwindSafe,
P: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
fn 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
.
fn 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
.
fn 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
.
fn 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
.