https://github.com/little-core-labs/secretbox-encoding
XSalsa20 Poly1305 codec that implements the abstract-encoding interface.
https://github.com/little-core-labs/secretbox-encoding
abstract encoding xsalsa20poly1305
Last synced: 30 days ago
JSON representation
XSalsa20 Poly1305 codec that implements the abstract-encoding interface.
- Host: GitHub
- URL: https://github.com/little-core-labs/secretbox-encoding
- Owner: little-core-labs
- License: mit
- Created: 2019-09-30T23:09:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-07T21:45:58.000Z (over 6 years ago)
- Last Synced: 2025-02-02T12:11:11.046Z (over 1 year ago)
- Topics: abstract, encoding, xsalsa20poly1305
- Language: JavaScript
- Size: 12.7 KB
- Stars: 2
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
secretbox-encoding
==================
> [XSalsa20 Poly1305][secretbox] codec that implements the [abstract-encoding][abstract-encoding] interface.
> Nonces are generated randomly and prepended to the ciphertext.
## Installation
```sh
$ npm install secretbox-encoding
```
## Usage
```js
const codec = require('secretbox-encoding')(secretKey)
// encode a value
buffer = codec.encode(value)
// decode a value
value = codec.decode(buffer)
```
## Example
```js
const crypto = require('crypto')
const Codec = require('secretbox-encoding')
const key = crypto.randomBytes(32)
const codec = Codec(key)
const hello = codec.encode('hello')
const world = codec.encode('world')
console.log('%s %s', codec.decode(hello), codec.decode(world)) // 'hello world'
```
### Custom Value Encodings
```js
const pbs = require('protocol-buffers')
const { Message } = pbs(`
message {
string data = 1;
}
`)
const codec = Codec(key, { valueEncoding: Message })
const encoded = codec.encode({ data: 'hello world' })
const message = codec.decode(encoded) // { data: 'hello world' }
```
## API
### `codec = require('secretbox-encoding')(secretKey[, opts])`
Create a codec object from 32 byte `secretKey`.
```js
const key = crypto.randomBytes(32)
const codec = Codec(key)
```
#### `buffer = codec.encode(value[, output[, offset]])`
Encode a value using [crypto_secretbox_easy](https://download.libsodium.org/doc/secret-key_cryptography/secretbox) 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.
```js
const buffer = codec.encode('hello world')
```
#### `value = codec.decode(buffer[, offset])`
Decode a buffer using [crypto_secretbox_open_easy](
https://download.libsodium.org/doc/secret-key_cryptography/secretbox)
at an optional `offset` defaulting to `0`.
```js
const value = codec.decode(buffer)
```
#### `length = codec.encodingLength(value)`
Returns the encoding length for a given `value`.
```js
const length = codec.encodingLength('hello world') // 11
```
## License
MIT
[abstract-encoding]: https://github.com/mafintosh/abstract-encoding
[secretbox]: https://download.libsodium.org/doc/secret-key_cryptography/secretbox