Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 3.33 KB

README.md

File metadata and controls

89 lines (57 loc) · 3.33 KB
Raw

js-libp2p-tls

standard-readme compliant Coverage Status Travis CI

TLS/SSL crypto for libp2p

This repo contains an experimental TLS/SSL transport for libp2p. Currently there is no browser support (planned - see Roadmap)

Table of Contents

Install

npm install libp2p-tls

Usage

const tls = require('libp2p-tls')

API

tag

The current tls 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 TLS. 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.

Roadmap

  • Add backwards-compatible tls1.3 support
  • Add a parameter to let the clients choose between ECC and RSA crypto?
  • Add browser support

Contribute

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

License

MIT