# sodium-signatures

> Sodium signatures that works in node and in the browser

Latest version **2.1.1** (published 2018-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install sodium-signatures
pnpm add sodium-signatures
yarn add sodium-signatures
bun add sodium-signatures
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2018-01-20 |
| First published | 2015-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Author | Mathias Buus |
| Maintainers | mafintosh |

## Links

- npm: https://www.npmjs.com/package/sodium-signatures
- Repository: https://github.com/mafintosh/sodium-signatures
- Issues: https://github.com/mafintosh/sodium-signatures/issues
- npm.io page: https://npm.io/package/sodium-signatures

## Dependencies (2)

- [sodium-universal](https://npm.io/package/sodium-universal.md) ^2.0.0
- [buffer-alloc-unsafe](https://npm.io/package/buffer-alloc-unsafe.md) ^1.0.0

## Recent versions

- 2.1.1 (latest) — 2018-01-20
- 2.1.0 — 2017-07-13
- 2.0.0 — 2017-02-04
- 1.4.1 — 2016-10-09
- 1.4.0 — 2016-10-08
- 1.3.0 — 2016-08-05
- 1.2.2 — 2016-03-10
- 1.2.1 — 2016-03-10
- 1.2.0 — 2016-03-10
- 1.1.0 — 2015-09-14
- 1.0.1 — 2015-09-08
- 1.0.0 — 2015-09-08

## README

# sodium-signatures

[Sodium signatures](https://github.com/paixaop/node-sodium) that works in node and in the browser

```
npm install sodium-signatures
```

[![build status](http://img.shields.io/travis/mafintosh/sodium-signatures.svg?style=flat)](http://travis-ci.org/mafintosh/sodium-signatures)

## Usage

``` js
var signatures = require('sodium-signatures')

var keys = signatures.keyPair()
var message = new Buffer('a message')

var signature = signatures.sign(message, keys.secretKey)
var verified = signatures.verify(message, signature, keys.publicKey)

console.log('message was verified', verified)
```

## API

#### `keys = signatures.keyPair([seed])`

Generate a public key and a secret key, optionally using a 32-byte `seed`
(`crypto_sign_SEEDBYTES` defines this length)

#### `signature = signature.sign(message, secretKey)`

Sign a message.

#### `verified = signature.verify(message, signature, publicKey)`

Verify a message and signature.

## License

MIT

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