# gpgme

> Bindings for Gnu Privacy Guard

Latest version **0.0.1** (published 2012-10-03) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2012-10-03 |
| First published | 2012-10-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Eric Schulte |
| Maintainers | eschulte |
| Keywords | pgp, gpg, gpgme, cryptography, encryption, decryption, signature, verification |

## Links

- npm: https://www.npmjs.com/package/gpgme
- Repository: https://github.com/eschulte/node-gpgme
- Issues: https://github.com/eschulte/node-gpgme/issues
- npm.io page: https://npm.io/package/gpgme

## 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.0.1 (latest) — 2012-10-03

## README

node-gpg
========

[GNU Privacy Guard](www.gnuph.org) (GPG) bindings for node.js
supporting public key cryptography, encryption, decryption, signing
and verification.  This is based off of the
[GnuPG Made Easy](www.gnupg.org/gpgme.htlm) (GPGME) GPG C library, see
its very good documentation for more information.

License
-------

GNU GENERAL PUBLIC LICENSE v3, see the COPYING file in this directory.

Installation
------------

    npm install gpgme

Usage
-----

* Also see the test.js file in this directory for example usage.
* Currently uses JavaScript strings for all data input and output.
* Uses ASCII Armor for all encrypted output.

Require gpg and initialize a new context.

    var gpg = require('gpgme');

### Verify
To verify a message with a signature.  First generate the signature
which can be done with the following in the shell (the `-a` indicates
ASCII armor output).

    sig=$(echo foo|gpg --detach-sign -a|sed ':a;N;$!ba;s/\n/\\\\n/g')
    echo "{\"content\":\"foo\\\\n\", \"signature\":\"$sig\"}" |tee msg.json

Then save your signature to a JavaScript string, and run the
following (or run `node test.js`).

    var msg = JSON.parse(fs.readFileSync('./msg.json', 'utf8'));

    if(gpg.verify(msg.signature,msg.content))
      console.log("verification success");
    else
      console.log("verification failure");

### Decrypt
To decrypt an encrypted message.  First generated encrypted content by
running the following in a shell.

    echo "secret contents"|gpg -e -r "Your GPG Name" -a|tee cipher.txt

Then run the following (or run `node test.js`).

    var cipher = fs.readFileSync('cipher.txt', 'utf8');
    var decrypted = gpg.decrypt(cipher);
    console.log('decrypted content is "'+decrypted+'"');

To decrypt and verify a message.  First generated encrypted content by
running the following in a shell.

    echo "secret signed contents"|gpg -s -e -r "Your GPG Name" -a \
      |tee signed-cipher.txt
    
Then run the following (or run `node test.js`).

    var signed_cipher = fs.readFileSync('signed-cipher.txt', 'utf8');
    var decrypted_and_verified = gpg.decryptAndVerify(signed_cipher);
    console.log('decrypted and verified content is "'+decrypted_and_verified+'"');

### Sign
To sign a message.  First write a JSON hash holding the data to
encrypt and the name of the signatory (this name will be used by GPG
to lookup the key).

    echo '{"signatory":"Your Name", "content":"foo\n"}' > sign.json

Then run the following (or run `node test.js`).

    var sign = JSON.parse(fs.readFileSync('./sign.json', 'utf8'));
    var signature = gpg.sign(sign.signatory, sign.content);
    console.log('content "'+sign.content+
                '" signed by "'+sign.signatory+
                '" yields signature "'+signature+'"');

### Encrypt
To encrypt a message.  First write a JSON hash holding a list of the
recipients and the message to encrypt.

    echo '{"recipients":["Your Name"], "content":"foo\n"}' > encrypt.json

Then run the following (or run `node test.js`).

TODO
----
* add a context class to allow multiple simultaneous operations
* add a key class to allow key management to take place on the JS side
  of things
* add support for asynchronous operations w/callbacks (gpgme should
  make this straightforward)

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