Struct libp2p_noise::NoiseAuthenticated

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

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 Swarm.

Implementations

impl NoiseAuthenticated<XX, X25519Spec, ()>

pub fn xx(id_keys: &Keypair) -> Result<Self, NoiseError>

Create a new NoiseAuthenticated for the XX handshake pattern using X25519 DH keys.

For now, this is the only combination that is guaranteed to be compatible with other libp2p implementations.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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>> + Send, Global>>

Future that performs the handshake with the remote.

fn upgrade_inbound(self, socket: T, info: Self::Info) -> Self::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, P, C, R> OutboundUpgrade<T> for NoiseAuthenticated<P, C, R>where NoiseConfig<P, C, R>: UpgradeInfo + OutboundUpgrade<T, Output = (RemoteIdentity<C>, NoiseOutput<T>), Error = NoiseError> + 'static, <NoiseConfig<P, C, R> as OutboundUpgrade<T>>::Future: Send, T: AsyncRead + AsyncWrite + Send + 'static, C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,

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>> + Send, Global>>

Future that performs the handshake with the remote.

fn upgrade_outbound(self, socket: T, info: Self::Info) -> Self::Future

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

impl<P, C: Zeroize, R> UpgradeInfo for NoiseAuthenticated<P, C, R>where 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.

fn protocol_info(&self) -> Self::InfoIter

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