# secret-box

> Encrypt and decrypt secrets.

Latest version **0.1.1** (published 2016-06-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install secret-box
pnpm add secret-box
yarn add secret-box
bun add secret-box
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-06-29 |
| First published | 2016-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/secret-box) |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | JP Richardson |
| Maintainers | jprichardson |
| Keywords | aes, decryption, encryption, scrypt, secret |

## Links

- npm: https://www.npmjs.com/package/secret-box
- Repository: https://github.com/jprichardson/secret-box
- Issues: https://github.com/jprichardson/secret-box/issues
- npm.io page: https://npm.io/package/secret-box

## Dependencies (2)

- [scryptsy](https://npm.io/package/scryptsy.md) ^2.0.0
- [varstruct](https://npm.io/package/varstruct.md) ^5.2.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2016-06-29
- 0.1.0 — 2016-06-29
- 0.0.1 — 2016-06-25

## README

secret-box
==========

[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
[![standard][standard-image]][standard-url]

[npm-image]: https://img.shields.io/npm/v/secret-box.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/secret-box
[travis-image]: https://img.shields.io/travis/jprichardson/secret-box.svg?style=flat-square
[travis-url]: https://travis-ci.org/jprichardson/secret-box
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[standard-url]: http://npm.im/standard

Encrypt and decrypt secrets. Built on AES-256-GCM and Scrypt for now, may change later.

> Sponsored by [Exodus](http://www.exodus.io/) Bitcoin and Ethereum wallet.


## Install

```
npm install --save secret-box
```

## Usage

```js
var secretBox = require('secret-box')

const passphrase = new Buffer('open sesame 2')
const message = new Buffer('The secret launch code is 1234.')

const secret = secretBox.encrypt(message, passphrase)
const message2 = secretBox.decrypt(secret, passphrase)

console.log(message2.toString('utf8'))
// => The secret launch code is 1234.

```

## License

[MIT](LICENSE.md)

---
_Source: https://npm.io/package/secret-box · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
