https://github.com/hackergrrl/chacha-stream

Encryption and decryption streams of libsodium's chacha20 implementation.
https://github.com/hackergrrl/chacha-stream

Last synced: 1 day ago
JSON representation

Encryption and decryption streams of libsodium's chacha20 implementation.

• Host: GitHub
• URL: https://github.com/hackergrrl/chacha-stream
• Owner: hackergrrl
• Created: 2019-12-11T22:52:35.000Z (almost 5 years ago)
• Default Branch: sprout
• Last Pushed: 2019-12-12T16:55:13.000Z (almost 5 years ago)
• Last Synced: 2024-05-13T16:25:46.984Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 5.86 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# chacha-stream

This module provides encryption and decryption streams for the sodium chacha20

implementation. It can be used to encrypt channels using a key already known to

both sides.

It manages communicating the stream nonce to the remote side, which is

transmitted in plaintext. This is safe information to leak (the nonce is used

to detect replay attacks).

## Usage

```js

const chacha = require('chacha-stream')

const through = require('through2')

const crypto = require('crypto')

function printer (prefix) {

  return through(function (chunk, enc, next) {

    console.log(prefix, chunk.toString())

    next(null, chunk)

  })

}

let key = crypto.randomBytes(32)

let encode0 = chacha.encoder(key)

let decode0 = chacha.decoder(key)

encode0.write('hello world')

encode0.pipe(printer('encrypted')).pipe(decode0).pipe(printer('decrypted'))

```

outputs

```

encrypted }�?�lx

encrypted z>��Un��4�

decrypted hello world

```

## API

```js

var chacha = require('chacha-stream')

```

### var encoder = chacha.encode(key)

Creates a Transform stream that accepts plaintexts written to it, and outputs encrypted ciphertext.

`key` is a 32-byte `Buffer`.

### var decoder = chacha.decode(key)

Creates a Transform stream that accepts ciphertext written to it, and outputs decrypted plaintext.

`key` is a 32-byte `Buffer`.

## Install

With [npm](https://npmjs.org/) installed, run

```

$ npm install chacha-stream

```

## License

ISC