Interface ConnectionEncrypter<Extension>

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

interface ConnectionEncrypter<Extension = unknown> {
    protocol: string;
    secureInbound(
        connection: MessageStream,
        options?: SecureConnectionOptions,
    ): Promise<SecuredConnection<Extension>>;
    secureOutbound(
        connection: MessageStream,
        options?: SecureConnectionOptions,
    ): Promise<SecuredConnection<Extension>>;
}

Type Parameters

Extension = unknown

Index

Properties

Methods

secureInbound secureOutbound

Properties

protocol

protocol: string

Methods

secureInbound

secureInbound(
connection: MessageStream,
options?: SecureConnectionOptions,
): 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
- connection: MessageStream
- Optionaloptions: SecureConnectionOptions
Returns Promise<SecuredConnection<Extension>>
- Defined in packages/interface/src/connection-encrypter.ts:42

secureOutbound

secureOutbound(
connection: MessageStream,
options?: SecureConnectionOptions,
): 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
- connection: MessageStream
- Optionaloptions: SecureConnectionOptions
Returns Promise<SecuredConnection<Extension>>
- Defined in packages/interface/src/connection-encrypter.ts:35