OpenPGP.rb is a pure-Ruby implementation of the OpenPGP Message Format (RFC 4880).
Ruby
Switch branches/tags
Nothing to show
Pull request Compare This branch is 1 commit ahead, 35 commits behind dryruby:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
doc
lib
spec
.gitignore
LICENSE
README
README.rdoc
Rakefile
VERSION
openpgp.gemspec

README.rdoc

OpenPGP.rb

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

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 'openpgp'

Decoding an ASCII-armored message

require 'open-uri'
text = open('http://ar.to/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',
})

Documentation

Download

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

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

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

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

Installation

The recommended installation method is via RubyGems. To install the latest official release from RubyForge, do:

% [sudo] gem install openpgp

To use the very latest bleeding-edge development version, install the gem directly from GitHub as follows:

% [sudo] gem install bendiken-openpgp -s http://gems.github.com

Resources

Authors

License

All source code is available under the terms of the MIT license. For more information, see the accompanying LICENSE file.