Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

hypercore-xsalsa20-onwrite-hook

Package Overview
Dependencies
Maintainers
3
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

hypercore-xsalsa20-onwrite-hook

A write hook to decrypt data using a XSalsa20 cipher into a hypercore storage when replicating from peers

  • 2.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
3
Created
Source

hypercore-xsalsa20-onwrite-hook

A write hook to decrypt data using a xsalsa20 cipher into a Hypercore storage when replicating from peers.

Installation

$ npm install hypercore-xsalsa20-onwrite-hook

Usage

const onwrite = hook(sharedSecret)

Example

const replicate = require('hypercore-replicate')
const hypercore = require('hypercore')
const crypto = require('hypercore-crypto')
const pump = require('pump')
const hook = require('hypercore-xsalsa20-onwrite-hook')
const ram = require('random-access-memory')

const key = crypto.randomBytes(32)

const { publicKey, secretKey } = crypto.keyPair()

const source = hypercore(ram, publicKey, {
  secretKey,
})

const cipher = hypercore(ram, publicKey, {
  secretKey,
  onwrite: hook(key)
})

const edge = hypercore(ram, publicKey)

const reader = hypercore(ram, publicKey, {
  onwrite: hook(key)
})

source.append(Buffer.from('hello'), (err) => {
  source.head(console.log) // plaintext

  // load cipher hypercore
  pump(source.createReadStream(), cipher.createWriteStream(), (err) => {
    if (err) throw err
    cipher.head(console.log) // ciphertext

    replicate(cipher, edge, (err) => {
      if (err) throw err
      edge.head(console.log) // ciphertext

      replicate(edge, reader, (err) => {
        if (err) throw err
        reader.head(console.log) // plaintext
      })
    })
  })
})

API

const onwrite = hook(nonceStorage, sharedKey)

Creates a onwrite() hook for a Hypercore feed that uses the xsalsa20 cipher to encipher or decipher blocks in a Hypercore feed. Nonces are computed from the Hypercore feed's public key and block index.

License

MIT

Keywords

FAQs

Package last updated on 04 Feb 2020

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc