Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 4.01 KB

README.md

File metadata and controls

91 lines (58 loc) · 4.01 KB
Raw

js-libp2p-secio

standard-readme compliant Coverage Status Travis CI Circle CI Dependency Status js-standard-style

Secio implementation in JavaScript

This repo contains the JavaScript implementation of secio, an encryption protocol used in libp2p. This is based on this go implementation.

Table of Contents

Install

npm install libp2p-secio

Usage

const secio = require('libp2p-secio')

API

tag

The current secio tag, usable in multistream.

encrypt(id, key, insecure[, callback])

  • id: PeerId - The id of the node.
  • key: RSAPrivateKey - The private key of the node.
  • insecure: PullStream - The insecure connection.
  • callback: Function - Called if an error happens during the initialization.

Returns the insecure connection provided, wrapped with secio. This is a pull-stream.

This module uses pull-streams

We expose a streaming interface based on pull-streams, rather then on the Node.js core streams implementation (aka Node.js streams). pull-streams offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this issue.

You can learn more about pull-streams at:

Converting pull-streams to Node.js Streams

If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module pull-stream-to-stream, giving you an instance of a Node.js stream that is linked to the pull-stream. For example:

const pullToStream = require('pull-stream-to-stream')

const nodeStreamInstance = pullToStream(pullStreamInstance)
// nodeStreamInstance is an instance of a Node.js Stream

To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT