Socket
Socket
Sign inDemoInstall

swarm-peer-server

Package Overview
Dependencies
104
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    swarm-peer-server

A network swarm for creating secure P2P connections over Bittorrent DHT, DNS, and mDNS.


Version published
Weekly downloads
9
increased by350%
Maintainers
1
Install size
17.5 MB
Created
Weekly downloads
 

Readme

Source

swarm-peer-server

A network swarm for creating secure P2P connections over Bittorrent DHT, DNS, and mDNS.

Uses discovery-swarm to find and connect peers. Connections use asymmetric encryption and Elliptic-curve Diffie-Hellman to establish a secure communication channel. Clients must know the public key of a peer ahead of time to initiate the connection.

Depends on native modules libsodium (via sodium-native) and libutp (via utp-native).

npm install swarm-peer-server

Usage

Server

var swarm = require('swarm-peer-server')

swarm.listen({
  publicKey: Buffer.from('...'),
  secretKey: Buffer.from('...')
}, (socket, peerKey, info) => {
  console.log('New authenticated connection')
  socket.once('data', data => {
    console.log('Received:', data.toString())
    socket.destroy()
  })
})

Client

var swarm = require('swarm-peer-server')

var { socket } = await swarm.connect({
  publicKey: Buffer.from('...'),
  secretKey: Buffer.from('...'),
  hostPublicKey: Buffer.from('...')
})

console.log('Established connection')
const data = Buffer.from('hello world')
socket.write(data)

Examples

examples/echo.js # CLI echo server

API

var sw = swarm.listen(opts)

Create a new swarm server. Options include:

{
  publicKey: crypto.randomBytes(32), // server public key
  secretKey: crypto.randomBytes(64), // server secret key
  convert: false, // convert signatures to authentication encryption [1]
}

[1] https://download.libsodium.org/doc/advanced/ed25519-curve25519.html

For full list of options take a look at discovery-swarm or the TypeScript definitions.

swarm.connect(opts, (socket, peerKey, info) => {})

Create a new swarm server. Options include:

{
  hostPublicKey: crypto.randomBytes(32), // host/server public key
  publicKey: crypto.randomBytes(32), // client public key
  secretKey: crypto.randomBytes(64), // client secret key
  convert: false, // convert signatures to authentication encryption
}

License

MIT

Keywords

FAQs

Last updated on 20 Apr 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc