Struct libp2p::noise::NoiseConfig

pub struct NoiseConfig<P, C, R = ()> where
    C: Zeroize,  { /* fields omitted */ }

The protocol upgrade configuration.

Implementations

impl<H, C, R> NoiseConfig<H, C, R> where
    C: Zeroize, 

pub fn into_authenticated(self) -> NoiseAuthenticated<H, C, R>

Turn the NoiseConfig into an authenticated upgrade for use with a Network.

pub fn set_legacy_config(
    &mut self,
    cfg: LegacyConfig
) -> &mut NoiseConfig<H, C, R>

Sets the legacy configuration options to use, if any.

impl<C> NoiseConfig<IX, C, ()> where
    C: Protocol<C> + Zeroize, 

pub fn ix(dh_keys: AuthenticKeypair<C>) -> NoiseConfig<IX, C, ()>

Create a new NoiseConfig for the IX handshake pattern.

impl<C> NoiseConfig<XX, C, ()> where
    C: Protocol<C> + Zeroize, 

pub fn xx(dh_keys: AuthenticKeypair<C>) -> NoiseConfig<XX, C, ()>

Create a new NoiseConfig for the XX handshake pattern.

impl<C> NoiseConfig<IK, C, ()> where
    C: Protocol<C> + Zeroize, 

pub fn ik_listener(dh_keys: AuthenticKeypair<C>) -> NoiseConfig<IK, C, ()>

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.

impl<C> NoiseConfig<IK, C, (PublicKey<C>, PublicKey)> where
    C: Protocol<C> + Zeroize, 

pub fn ik_dialer(
    dh_keys: AuthenticKeypair<C>,
    remote_id: PublicKey,
    remote_dh: PublicKey<C>
) -> NoiseConfig<IK, C, (PublicKey<C>, PublicKey)>

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<P, C, R> Clone for NoiseConfig<P, C, R> where
    C: Clone + Zeroize,
    P: Clone,
    R: Clone, 

pub fn clone(&self) -> NoiseConfig<P, C, R>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, C> InboundUpgrade<T> for NoiseConfig<IX, C, ()> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    NoiseConfig<IX, C, ()>: UpgradeInfo, 

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

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

type Error = NoiseError

Possible error during the handshake.

type Future = Handshake<T, C>

Future that performs the handshake with the remote.

pub fn upgrade_inbound(
    self,
    socket: T,
    <NoiseConfig<IX, C, ()> as UpgradeInfo>::Info
) -> <NoiseConfig<IX, C, ()> 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.

impl<T, C> InboundUpgrade<T> for NoiseConfig<XX, C, ()> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    NoiseConfig<XX, C, ()>: UpgradeInfo, 

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

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

type Error = NoiseError

Possible error during the handshake.

type Future = Handshake<T, C>

Future that performs the handshake with the remote.

pub fn upgrade_inbound(
    self,
    socket: T,
    <NoiseConfig<XX, C, ()> as UpgradeInfo>::Info
) -> <NoiseConfig<XX, C, ()> 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.

impl<T, C, R> InboundUpgrade<T> for NoiseConfig<IK, C, R> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    NoiseConfig<IK, C, R>: UpgradeInfo, 

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

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

type Error = NoiseError

Possible error during the handshake.

type Future = Handshake<T, C>

Future that performs the handshake with the remote.

pub fn upgrade_inbound(
    self,
    socket: T,
    <NoiseConfig<IK, C, R> as UpgradeInfo>::Info
) -> <NoiseConfig<IK, 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.

impl<T, C> OutboundUpgrade<T> for NoiseConfig<IK, C, (PublicKey<C>, PublicKey)> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    NoiseConfig<IK, C, (PublicKey<C>, PublicKey)>: UpgradeInfo, 

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

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

type Error = NoiseError

Possible error during the handshake.

type Future = Handshake<T, C>

Future that performs the handshake with the remote.

pub fn upgrade_outbound(
    self,
    socket: T,
    <NoiseConfig<IK, C, (PublicKey<C>, PublicKey)> as UpgradeInfo>::Info
) -> <NoiseConfig<IK, C, (PublicKey<C>, PublicKey)> 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.

impl<T, C> OutboundUpgrade<T> for NoiseConfig<IX, C, ()> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    NoiseConfig<IX, C, ()>: UpgradeInfo, 

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

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

type Error = NoiseError

Possible error during the handshake.

type Future = Handshake<T, C>

Future that performs the handshake with the remote.

pub fn upgrade_outbound(
    self,
    socket: T,
    <NoiseConfig<IX, C, ()> as UpgradeInfo>::Info
) -> <NoiseConfig<IX, C, ()> 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.

impl<T, C> OutboundUpgrade<T> for NoiseConfig<XX, C, ()> where
    C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
    T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    NoiseConfig<XX, C, ()>: UpgradeInfo, 

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

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

type Error = NoiseError

Possible error during the handshake.

type Future = Handshake<T, C>

Future that performs the handshake with the remote.

pub fn upgrade_outbound(
    self,
    socket: T,
    <NoiseConfig<XX, C, ()> as UpgradeInfo>::Info
) -> <NoiseConfig<XX, C, ()> 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.

impl<R> UpgradeInfo for NoiseConfig<IK, X25519Spec, R>

Note: This is not currently a standardised upgrade.

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<NoiseConfig<IK, X25519Spec, R> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseConfig<IK, X25519Spec, R> as UpgradeInfo>::InfoIter

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

impl UpgradeInfo for NoiseConfig<IX, X25519, ()>

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<NoiseConfig<IX, X25519, ()> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseConfig<IX, X25519, ()> as UpgradeInfo>::InfoIter

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

impl<R> UpgradeInfo for NoiseConfig<IK, X25519, R>

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<NoiseConfig<IK, X25519, R> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseConfig<IK, X25519, R> as UpgradeInfo>::InfoIter

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

impl UpgradeInfo for NoiseConfig<XX, X25519Spec, ()>

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<NoiseConfig<XX, X25519Spec, ()> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseConfig<XX, X25519Spec, ()> as UpgradeInfo>::InfoIter

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

impl UpgradeInfo for NoiseConfig<IX, X25519Spec, ()>

Note: This is not currentlyy a standardised upgrade.

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<NoiseConfig<IX, X25519Spec, ()> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseConfig<IX, X25519Spec, ()> as UpgradeInfo>::InfoIter

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

impl UpgradeInfo for NoiseConfig<XX, X25519, ()>

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<NoiseConfig<XX, X25519, ()> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(
    &self
) -> <NoiseConfig<XX, X25519, ()> as UpgradeInfo>::InfoIter

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