# signid

> Tiny library to generate signed identifiers

Latest version **1.0.1** (published 2018-05-17) · ISC license · 0 weekly downloads

## Install

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

## 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 | 1.0.1 |
| Published | 2018-05-17 |
| First published | 2018-05-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8.0 |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | pjhl |
| Maintainers | pjhl |

## Links

- npm: https://www.npmjs.com/package/signid
- Repository: https://github.com/pjhl/signid
- Homepage: https://github.com/pjhl/signid#readme
- Issues: https://github.com/pjhl/signid/issues
- npm.io page: https://npm.io/package/signid

## Recent versions

- 1.0.1 (latest) — 2018-05-17
- 1.0.0 — 2018-05-17

## README

Signid
======

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Node.js version](https://img.shields.io/node/v/signid.svg)](https://nodejs.org/en/download/)
[![Build Status](https://travis-ci.org/pjhl/signid.svg?branch=master)](https://travis-ci.org/pjhl/signid)
[![Codecov](https://codecov.io/gh/pjhl/signid/branch/master/graph/badge.svg)](https://codecov.io/gh/pjhl/signid)

Signid is a tiny [node.js](http://nodejs.org/) server-side library for signing
and verifying integer identifiers.
Identifiers can be signed to prevent a prediction of next values.

Look at how simple it is:

```javascript
const Signid = require('signid')
const signid = new Signid('Your secret key')

const signed = signid.encode(18082)
console.log(signed) // '1tkblhp-dya'

const originalId = signid.decode(signed)
console.log(originalId) // 18082

const signid2 = new Signid('Incorrect secret')
const originalId2 = signid2.decode(signed)
console.log(originalId2) // null

```

Note that this is not an encryption library and is not suitable for creating
something safe. It doesn't withstand any security requirements.


## Features

* Server-side code (uses node **crypto** md5)
* Simple usage
* Signed integer as string about (7-20 chars length)
* Supports positive integers only (0 - `Number.MAX_SAFE_INTEGER`)


## Install

Using [NPM](https://www.npmjs.com/):

```bash
npm i signid
```


## Signed identifiers example

| ID | Signed |
|----|--------|
| 0 | `'fmh1hp-0'` |
| 1 | `'1invht9-1'` |
| 2 | `'j3c2f3-2'` |
| 3 | `'1tp4u3p-3'` |
| 100 | `'1f9pfif-2s'` |
| 1000 | `'1ekln37-rs'` |
| 1001 | `'1b3b3xt-rt'` |
| 1002 | `'105opf1-ru'` |
| 88888 | `'1buzr2q-1wl4'` |
| 9007199254740991 | `'iim0na-2gosa7pa2gv'` (`Number.MAX_SAFE_INTEGER`) |

P.S. This table is generated with secret `Your secret`

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