# ghsign

> Sign/verify data using your local ssh private key and your public key from Github

Latest version **3.0.7** (published 2018-03-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install ghsign
pnpm add ghsign
yarn add ghsign
bun add ghsign
```

## 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 | 3.0.7 |
| Published | 2018-03-23 |
| First published | 2014-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 52 |
| Author | Mathias Buus |
| Maintainers | beaugunderson, cwmma, mafintosh, maxogden, watson |
| Keywords | sign, github |

## Links

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

## Dependencies (6)

- [debug](https://npm.io/package/debug.md) ^2.1.3
- [thunky](https://npm.io/package/thunky.md) ^0.1.0
- [request](https://npm.io/package/request.md) ^2.39.0
- [ssh-agent](https://npm.io/package/ssh-agent.md) ^0.2.2
- [buffer-from](https://npm.io/package/buffer-from.md) ^1.0.0
- [ssh-key-to-pem](https://npm.io/package/ssh-key-to-pem.md) ^0.11.0

## Recent versions

- 3.0.7 (latest) — 2018-03-23
- 3.0.6 — 2016-04-25
- 3.0.5 — 2015-11-03
- 3.0.4 — 2015-11-03
- 3.0.3 — 2015-11-03
- 3.0.2 — 2015-09-10
- 3.0.1 — 2015-07-10
- 3.0.0 — 2015-07-10
- 2.0.0 — 2015-05-07
- 1.3.3 — 2015-05-02
- 1.3.2 — 2015-05-02
- 1.3.1 — 2015-04-30
- 1.3.0 — 2015-04-30
- 1.2.2 — 2015-04-28
- 1.2.1 — 2015-04-28
- … 12 more at https://npm.io/package/ghsign/versions

## README

# ghsign

Sign/verify data using your local ssh private key and your public key from Github

```
npm install ghsign
```

[![Build status](https://travis-ci.org/mafintosh/ghsign.svg?branch=master)](https://travis-ci.org/mafintosh/ghsign)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

## Usage

``` js
var ghsign = require('ghsign')

// create a signer (has be your own Github username)
var sign = ghsign.signer('mafintosh')

// create a verifier (can be any Github username)
var verify = ghsign.verifier('mafintosh')

// sign some data
sign('test', function(err, sig) {
  console.log('test signature is', sig)

  // verify the signature
  verify('test', sig, function(err, valid) {
    console.log('wat test signed by mafintosh?', valid)
  })
})
```

Creating a signer will fetch your public keys from github and use your
corresponding local ssh private key to sign the data. The verifier will verify the signature by also fetching the public keys from Github.

## License

MIT

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