OpenPGP.rb: OpenPGP for Ruby

This is a pure-Ruby implementation of the OpenPGP Message Format (RFC 4880).

http://github.com/sbeyer/openpgp

About OpenPGP

OpenPGP is the most widely-used e-mail encryption standard in the world. It is defined by the OpenPGP Working Group of the Internet Engineering Task Force (IETF) Proposed Standard RFC 4880. The OpenPGP standard was originally derived from PGP (Pretty Good Privacy), first created by Phil Zimmermann in 1991.

Features

Encodes and decodes ASCII-armored OpenPGP messages.
Parses OpenPGP messages into their constituent packets.
- Supports both old-format (PGP 2.6.x) and new-format (RFC 4880) packets.
Includes a GnuPG wrapper for features that are not natively supported.

Examples

require 'rubygems'
require 'openpgp'

Decoding an ASCII-armored message

require 'open-uri'
text = open('http://example.org/pgp.txt').read

msg = OpenPGP::Message.parse(OpenPGP.dearmor(text))

Generating a new keypair

gpg = OpenPGP::Engine::GnuPG.new(:homedir => '~/.gnupg')
key_id = gpg.gen_key({
  :key_type      => 'DSA',
  :key_length    => 1024,
  :subkey_type   => 'ELG-E',
  :subkey_length => 1024,
  :name          => 'J. Random Hacker',
  :comment       => nil,
  :email         => 'jhacker@example.org',
  :passphrase    => 'secret passphrase',
})

Dependencies

Ruby (>= 1.8.7) or (>= 1.8.1 with [Backports][])
Open4 (>= 1.0.1)

Installation

The recommended installation method is via RubyGems. To install the latest official release of OpenPGP.rb, do:

% [sudo] gem install openpgp             # Ruby 1.8.7+ or 1.9.x

Download

To get a local working copy of the development repository, do:

% git clone git://github.com/sbeyer/openpgp.git

Alternatively, you can download the latest development version as a tarball as follows:

% wget http://github.com/sbeyer/openpgp/tarball/master

Resources

Authors/Contributors

The project was originally written by Arto Bendiken http://ar.to/

For a full list of contributors, see https://github.com/sbeyer/openpgp/graphs/contributors

Contributing to my branch

Do your best to adhere to the existing coding conventions and idioms.
Do document every method you add using YARD annotations. Read the tutorial or just look at the existing code for examples.
I assume that you dedicate your code changes to the public domain. If this is not the case for code that got into my branch, please contact me so that I can remove the code.

License

OpenPGP.rb is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.

tabfugnic/openpgp