xsalsa20-encoding

XSalsa20 codec that implements that abstract-encoding interface. Nonces are generated randomly and prepended to the ciphertext.

Installation

1$ npm install xsalsa20-encoding

Usage

1const codec = require('xsalsa20-encoding')(secretKey)
2
3// encode a value
4buffer = codec.encode(value)
5
6// decode a value
7value = codec.decode(buffer)

Example

1const crypto = require('crypto')
2const Codec = require('xsalsa20-encoding')
3
4const key = crypto.randomBytes(32)
5
6const codec = Codec(key)
7const hello = codec.encode('hello')
8const world = codec.encode('world')
9
10console.log('%s %s', codec.decode(hello), codec.decode(world)) // 'hello world'

Custom Value Encodings

1const pbs = require('protocol-buffers')
2const { Message } = pbs(`
3message {
4  string data = 1;
5}
6`)
7
8const codec = Codec(key, { valueEncoding: Message })
9const encoded = codec.encode({ data: 'hello world' })
10const message = codec.decode(encoded) // { data: 'hello world' }

API

codec = require('xsalsa20-encoding')([secretKey[, opts])

Create a codec object from 32 byte secretKey.

1const key = crypto.randomBytes(32)
2const codec = Codec(key)

buffer = codec.encode(value[, output[, offset]])

Encode a value using xsalsa20 (XOR) into an optional output buffer at an optional offset defaulting to 0. If an output buffer is not given, one is allocated for you and returned.

1const buffer = codec.encode('hello world')

value = codec.decode(buffer[, offset])

Decode a buffer using xsalsa20 (XOR) at an optional offset defaulting to 0.

1const value = codec.decode(buffer)

length = codec.encodingLength(value)

Returns the encoding length for a given value.

1const length = codec.encodingLength('hello world') // 35

License

MIT