Options
All
  • Public
  • Public/Protected
  • All
Menu

A transport security interceptor extension. Modifies data buffers sent to other clones via remotes, typically by applying cryptography.

Installed transport security can be independent of the actual remoting protocol, and therefore contribute to layered security.

Wire security can be required for bootstrap messages during clone initialisation, i.e. type is http://control.m-ld.org/request/clock or http://control.m-ld.org/request/snapshot (and no prior state exists). In that case the state parameter of the methods will be null.

experimental

Hierarchy

  • MeldTransportSecurity

Implemented by

Index

Methods

Methods

Optional sign

  • Create an attribution for wire data

    Parameters

    • data: Buffer

      the data to sign

    • state: MeldReadState | null

      the current state of the clone

    Returns Attribution | Promise<Attribution>

Optional verify

  • Verify the attribution on wire data

    Parameters

    • data: Buffer

      the signed data

    • attr: Attribution | null

      the attribution

    • state: MeldReadState

      the current state of the clone

    Returns void | Promise<unknown>

wire

  • wire(data: Buffer, type: MeldMessageType, direction: "in" | "out", state: MeldReadState | null): Buffer | Promise<Buffer>
  • Check and/or transform wire data.

    Parameters

    • data: Buffer

      the data to operate on

    • type: MeldMessageType

      the message purpose

    • direction: "in" | "out"

      message direction relative to the local clone

    • state: MeldReadState | null

      the current state of the clone

    Returns Buffer | Promise<Buffer>

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method
  • Protected method

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.10.0 Source code licensed MIT. Privacy policy