Struct libp2p_noise::NoiseConfig [−][src]
The protocol upgrade configuration.
Implementations
impl<H, C: Zeroize, R> NoiseConfig<H, C, R>[src]
pub fn into_authenticated(self) -> NoiseAuthenticated<H, C, R>[src]
Turn the NoiseConfig into an authenticated upgrade for use
with a Network.
pub fn set_legacy_config(&mut self, cfg: LegacyConfig) -> &mut Self[src]
Sets the legacy configuration options to use, if any.
impl<C> NoiseConfig<IX, C> where
C: Protocol<C> + Zeroize, [src]
C: Protocol<C> + Zeroize,
pub fn ix(dh_keys: AuthenticKeypair<C>) -> Self[src]
Create a new NoiseConfig for the IX handshake pattern.
impl<C> NoiseConfig<XX, C> where
C: Protocol<C> + Zeroize, [src]
C: Protocol<C> + Zeroize,
pub fn xx(dh_keys: AuthenticKeypair<C>) -> Self[src]
Create a new NoiseConfig for the XX handshake pattern.
impl<C> NoiseConfig<IK, C> where
C: Protocol<C> + Zeroize, [src]
C: Protocol<C> + Zeroize,
pub fn ik_listener(dh_keys: AuthenticKeypair<C>) -> Self[src]
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, [src]
C: Protocol<C> + Zeroize,
pub fn ik_dialer(
dh_keys: AuthenticKeypair<C>,
remote_id: PublicKey,
remote_dh: PublicKey<C>
) -> Self[src]
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<P: Clone, C: Clone + Zeroize, R: Clone> Clone for NoiseConfig<P, C, R>[src]
fn clone(&self) -> NoiseConfig<P, C, R>[src]
pub fn clone_from(&mut self, source: &Self)1.0.0[src]
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, [src]
NoiseConfig<IX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
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.
fn upgrade_inbound(self, socket: T, _: Self::Info) -> Self::Future[src]
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, [src]
NoiseConfig<XX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
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.
fn upgrade_inbound(self, socket: T, _: Self::Info) -> Self::Future[src]
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, [src]
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>)
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.
fn upgrade_inbound(self, socket: T, _: Self::Info) -> Self::Future[src]
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, [src]
NoiseConfig<IX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
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.
fn upgrade_outbound(self, socket: T, _: Self::Info) -> Self::Future[src]
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, [src]
NoiseConfig<XX, C>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
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.
fn upgrade_outbound(self, socket: T, _: Self::Info) -> Self::Future[src]
impl<T, C> OutboundUpgrade<T> for NoiseConfig<IK, C, (PublicKey<C>, PublicKey)> where
NoiseConfig<IK, C, (PublicKey<C>, PublicKey)>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static, [src]
NoiseConfig<IK, C, (PublicKey<C>, PublicKey)>: UpgradeInfo,
T: AsyncRead + AsyncWrite + Unpin + Send + 'static,
C: Protocol<C> + AsRef<[u8]> + Zeroize + Send + 'static,
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.
fn upgrade_outbound(self, socket: T, _: Self::Info) -> Self::Future[src]
impl UpgradeInfo for NoiseConfig<IX, X25519>[src]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
impl UpgradeInfo for NoiseConfig<XX, X25519>[src]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
impl<R> UpgradeInfo for NoiseConfig<IK, X25519, R>[src]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
impl UpgradeInfo for NoiseConfig<XX, X25519Spec>[src]
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
impl UpgradeInfo for NoiseConfig<IX, X25519Spec>[src]
Note: This is not currentlyy a standardised upgrade.
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
impl<R> UpgradeInfo for NoiseConfig<IK, X25519Spec, R>[src]
Note: This is not currently a standardised upgrade.
type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
Auto Trait Implementations
impl<P, C, R> RefUnwindSafe for NoiseConfig<P, C, R> where
C: RefUnwindSafe,
P: RefUnwindSafe,
R: RefUnwindSafe,
C: RefUnwindSafe,
P: RefUnwindSafe,
R: RefUnwindSafe,
impl<P, C, R> Send for NoiseConfig<P, C, R> where
C: Send,
P: Send,
R: Send,
C: Send,
P: Send,
R: Send,
impl<P, C, R> Sync for NoiseConfig<P, C, R> where
C: Sync,
P: Sync,
R: Sync,
C: Sync,
P: Sync,
R: Sync,
impl<P, C, R> Unpin for NoiseConfig<P, C, R> where
C: Unpin,
P: Unpin,
R: Unpin,
C: Unpin,
P: Unpin,
R: Unpin,
impl<P, C, R> UnwindSafe for NoiseConfig<P, C, R> where
C: UnwindSafe,
P: UnwindSafe,
R: UnwindSafe,
C: UnwindSafe,
P: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>, [src]
U: InboundUpgrade<C>,
pub fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T, [src]
F: FnOnce(Self::Output) -> T,
pub fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T, [src]
F: FnOnce(Self::Error) -> T,
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>, [src]
U: OutboundUpgrade<C>,
pub fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T, [src]
F: FnOnce(Self::Output) -> T,
pub fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T, [src]
F: FnOnce(Self::Error) -> T,
impl<T> Same<T> for T[src]
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
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]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
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]
impl<V, T> VZip<V> for T where
V: MultiLane<T>, [src]
V: MultiLane<T>,