Mail::Gpg

This gem adds GPG/MIME encryption capabilities to the Ruby Mail Library

Installation

Add this line to your application's Gemfile:

gem 'mail-gpg'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mail-gpg

Usage

Encrypting / Signing

Construct your Mail object as usual and specify you want it to be encrypted with the gpg method:

Mail.new do
  to '[email protected]'
  from '[email protected]'
  subject 'gpg test'
  body "encrypt me!"
  add_file "some_attachment.zip"

  # encrypt message, no signing
  gpg encrypt: true

  # encrypt and sign message with sender's private key, using the given
  # passphrase to decrypt the key
  gpg encrypt: true, sign: true, password: 'secret'

  # encrypt and sign message using a different key
  gpg encrypt: true, sign_as: '[email protected]', password: 'secret'


  # encrypt and sign message and use a callback function to provide the
  # passphrase.
  gpg encrypt: true, sign_as: '[email protected]',
      passphrase_callback: ->(obj, uid_hint, passphrase_info, prev_was_bad, fd){puts "Enter passphrase for #{passphrase_info}: "; (IO.for_fd(fd, 'w') << readline.chomp).flush }
end.deliver

Make sure all recipients' public keys are present in your local gpg keychain. You will get errors in case encryption is not possible due to missing keys. If you collect public key data from your users, you can specify the ascii armored key data for recipients using the :keys option like this:

johns_key = "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.12 (GNU/Linux)\n\nmQGiBEk39msRBADw1ExmrLD1OUMdfvA7cnVVYTC7CyqfNvHUVuuBDhV7azs\n....\n"

Mail.new do
  to '[email protected]'
  gpg encrypt: true, keys: { '[email protected]' => johns_key }
end

The key will then be imported before actually trying to encrypt/send the mail. In theory you only need to specify the key once like that, however doing it every time does not hurt as gpg is clever enough to recognize known keys, only updating it's db when necessary.

You may also want to have a look at the GPGME docs and code base for more info on the various options, especially regarding the passphrase_callback arguments.

Signing only

This is not implemented yet

Rails / ActionMailer integration

class MyMailer < ActionMailer::Base
  default from: '[email protected]'
  def some_mail
    mail to: '[email protected]', subject: 'subject!', gpg: { encrypt: true }
  end
end

The gpg option takes the same arguments as outlined above for the Mail::Message#gpg method.

Running the tests

bundle exec rake

Test cases use a mock gpghome located in test/gpghome in order to not mess around with your personal gpg keychain.

Todo

Signing of unencrypted mails
Decryption and signature verification for received mails
on the fly import of recipients' keys from public key servers based on email address or key id
handle encryption errors due to missing keys - maybe return a list of failed recipients
add some setup code to help initialize a basic keychain directory with public/private keypair.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request