npmpackage.info

Gathering detailed insights and metrics for secretbox-encoding

Other packages similar to secretbox-encoding

@types/secretbox-encoding

1.0.3

TypeScript definitions for secretbox-encoding

Gathering detailed insights and metrics for secretbox-encoding

secretbox-encoding - 1.0.0 | npmpackage.info

secretbox-encoding

XSalsa20 Poly1305 codec that implements the abstract-encoding interface.

1.0.0

MIT

JavaScript

12.00 kB

3.4

Installations

npm install secretbox-encoding

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.17.0

NPM Version

6.13.4 Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

1

Total

2

Closed

1

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

jwerle

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2 Stars

8 Commits

1 Forks

5 Watchers

2 Branches

2 Contributors

Updated on Jan 07, 2020

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

1.0.0

Package Id

secretbox-encoding@1.0.0

Unpacked Size

12.00 kB

Size

4.03 kB

File Count

NPM Version

6.13.4

Node Version

10.17.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

sodium-universal

Dev Dependencies

nyc protocol-buffers tape

secretbox-encoding

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

Installation

1$ npm install secretbox-encoding

Usage

1const codec = require('secretbox-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('secretbox-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('secretbox-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 crypto_secretbox_easy 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 crypto_secretbox_open_easy 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') // 11

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More