Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/billiegoose/isomorphic-pgp

The lightweight PGP library
https://github.com/billiegoose/isomorphic-pgp

Last synced: 24 days ago
JSON representation

The lightweight PGP library

Awesome Lists containing this project

README

        

# isomorphic-pgp

A lightweight library for creating and verifying OpenPGP signatures

## Motivation

PGP is the cryptographic standard used to sign git commits, and I wanted to provide `isomorphic-git` users a way
to tap into that power without sacrificing bundle size or worrying about LGPL restrictions.
So I wrote an entirely new JavaScript library with that narrow use case in mind.

## IMPORTANT!!!

Please read and understand the limitations of the [`sign-and-verify`](https://github.com/wmhilton/isomorphic-pgp/tree/master/src/sign-and-verify) module before using it.

## Comparison with other libraries

This library does not implement encryption or decryption - only signing and verifying signatures.

| | Size | License | Sign | Verify | Encrypt | Decrypt |
|---|------|---------|------|--------|---------|---------|
| isomorphic-pgp | [~17 kb](https://bundlephobia.com/result?p=@isomorphic-git/[email protected]) | MIT | 🗹 | 🗹 | ☐ | ☐|
| OpenPGP.js | [~170 kb](https://bundlephobia.com/[email protected]) | LGPL | 🗹 | 🗹 | 🗹 | 🗹 |
| kbpgp | [~160 kb](https://bundlephobia.com/[email protected]) | BSD | 🗹 | 🗹 | 🗹 | 🗹 |

## Usage

See individual READMEs for each package:

- [parser](https://github.com/wmhilton/isomorphic-pgp/tree/master/src/parser)
- [util](https://github.com/wmhilton/isomorphic-pgp/tree/master/src/util)
- [sign-and-verify](https://github.com/wmhilton/isomorphic-pgp/tree/master/src/sign-and-verify)
- [generate](https://github.com/wmhilton/isomorphic-pgp/tree/master/src/generate)

## License

MIT