Connection Encrypter interface for libp2p

• Install
• API
  • Secure Inbound
  • Secure Outbound
• Crypto Errors
  • Error Types
• API Docs
• License
• Contribution

$ npm i @libp2p/interface-connection-encrypter

Modules that implement the interface

• @chainSafe/js-libp2p-noise
• js-libp2p-secio

• Crypto
  • protocol<string>: The protocol id of the crypto module.
  • secureInbound<function(PeerId, duplex)>: Secures inbound connections.
  • secureOutbound<function(PeerId, duplex, PeerId)>: Secures outbound connections.

• const { conn, remotePeer } = await crypto.secureInbound(localPeer, duplex, [remotePeer])

Secures an inbound streaming iterable duplex connection. It returns an encrypted streaming iterable duplex, as well as the PeerId of the remote peer.

Parameters

• localPeer is the PeerId of the receiving peer.
• duplex is the streaming iterable duplex that will be encryption.
• remotePeer is the optional PeerId of the initiating peer, if known. This may only exist during transport upgrades.

Return Value

• <object>
  • conn<duplex>: An encrypted streaming iterable duplex.
  • remotePeer<PeerId>: The PeerId of the remote peer.

• const { conn, remotePeer } = await crypto.secureOutbound(localPeer, duplex, remotePeer)

Secures an outbound streaming iterable duplex connection. It returns an encrypted streaming iterable duplex, as well as the PeerId of the remote peer.

Parameters

• localPeer is the PeerId of the receiving peer.
• duplex is the streaming iterable duplex that will be encrypted.
• remotePeer is the PeerId of the remote peer. If provided, implementations should use this to validate the integrity of the remote peer.

Return Value

• <object>
  • conn<duplex>: An encrypted streaming iterable duplex.
  • remotePeer<PeerId>: The PeerId of the remote peer. This should match the remotePeer parameter, and implementations should enforce this.

Common crypto errors come with the interface, and can be imported directly. All Errors take an optional message.

const {
  InvalidCryptoExchangeError,
  InvalidCryptoTransmissionError,
  UnexpectedPeerError
} = require('libp2p-interfaces/src/crypto/errors')

const error = new UnexpectedPeerError('a custom error message')
console.log(error.code === UnexpectedPeerError.code) // true

• InvalidCryptoExchangeError - Should be thrown when a peer provides data that is insufficient to finish the crypto exchange.
• InvalidCryptoTransmissionError - Should be thrown when an error occurs during encryption/decryption.
• UnexpectedPeerError - Should be thrown when the expected peer id does not match the peer id determined via the crypto exchange.

• https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection_encrypter.html

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.