Interface ConnectionEncrypter<Extension>

A libp2p connection encrypter module must be compliant to this interface to ensure all exchanged data between two peers is encrypted.

Type Parameters

Extension = unknown

Hierarchy

ConnectionEncrypter

Index

Properties

protocol secureInbound secureOutbound

Properties

protocol

protocol: string

secureInbound

secureInbound: ((localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array, any, unknown>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId) => Promise<SecuredConnection<Extension>>)

Type declaration

- (localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array, any, unknown>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId): Promise<SecuredConnection<Extension>>
- Decrypt incoming data. If the remote PeerId is known, pass it for extra verification, otherwise it will be determined during the handshake
  Parameters
  - localPeer: PeerId
  - connection: Duplex<AsyncGenerator<Uint8Array, any, unknown>, Source<Uint8Array>, Promise<void>>
  - Optional remotePeer: PeerId
  Returns Promise<SecuredConnection<Extension>>

secureOutbound

secureOutbound: ((localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array, any, unknown>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId) => Promise<SecuredConnection<Extension>>)

Type declaration

- (localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array, any, unknown>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId): Promise<SecuredConnection<Extension>>
- Encrypt outgoing data to the remote party. If the remote PeerId is known, pass it for extra verification, otherwise it will be determined during the handshake.
  Parameters
  - localPeer: PeerId
  - connection: Duplex<AsyncGenerator<Uint8Array, any, unknown>, Source<Uint8Array>, Promise<void>>
  - Optional remotePeer: PeerId
  Returns Promise<SecuredConnection<Extension>>