mail-gpg 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441163acdac450c30cee15a61caf0cdfced59f1014a3a25fb73725730c9dd04f
-  data.tar.gz: b9e69f9dbb562f7b776dba943990255bd16fe89367b3100afa9ec6b54aed1387
+  metadata.gz: 48024e5411ba53abbdadf7a3cde7b6cbb86acaa3c81a44dacbf77cd6e5fb7021
+  data.tar.gz: 9dba324ef49fda99768f398ff9b4799c34c661f35bd1943eecc33f906479ac5e
 SHA512:
-  metadata.gz: b53943970f5df90c515ed50d696bae79fa6842c9d5352bafba7e4fd278b0da9f322233a397d2c385d867220fe859714fa4d9f3664164b00adde1d9170ba99d27
-  data.tar.gz: 55124752f123ac57bab57450b93ad14e822868c7241c8f343a242278462985d918dfedfb6830ac21b25b8b855c99119d2c580974999cf7da9b80baa970c0adf6
+  metadata.gz: db9a05bf279e61fc450b5b222ebf61a0e85797da432887ad6adda5e03e9d1cea1ccb73919ab2736df731a32a54559b2106eb651a982c4be438603c0f61602ebb
+  data.tar.gz: e39c89fa18eba088d462e7b79ab3c5168495520f9cc32ec580ceaa75ba440be720fe6abc7c713c18afa85858253d2024d5af577aa0ed5567fa61189689e681f8

data/.gitignore

@@ -16,7 +16,7 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-test/gpghome/random_seed
+test/gpghome
 tmp
 *.swp
 tags

data/.travis.yml

@@ -1,18 +1,21 @@
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.2.5
-  - 2.1.9
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
 env:
-  - RAILS=3.2.22.1
-  - RAILS=4.1.14.1
-  - RAILS=4.2.5.1
-  - RAILS=5.0.0.1
+  - RAILS=4.2.11.1 GPG_BIN=/usr/bin/gpg2
+  - RAILS=4.2.11.1 GPG_BIN=/usr/bin/gpg
+  - RAILS=5.2.3 GPG_BIN=/usr/bin/gpg2
+  - RAILS=5.2.3 GPG_BIN=/usr/bin/gpg
 matrix:
   exclude:
-    - rvm: 2.1.9
-      env: RAILS=5.0.0.1
 before_install:
-  - gem update bundler
-sudo: false
+  - gem install bundler -v "~> 2.0"
+  - sudo apt install -y gnupg gnupg2
 cache: bundler
+dist: xenial
+addons:
+  apt:
+    update: true
+

data/History.txt

@@ -1,3 +1,10 @@
+== 0.4.1 2019-07-08
+
+* do not modify argument hash #61
+* fix tests on travis and run them with both gpg < 2.0 and >= 2.1
+* gpg 2.0.x apparently has no way of preseeding passphrases and thus will only
+  ever work with passphraseless keys.
+
 == 0.4.0 2018-05-19
 
 * [MIGHT BREAK THINGS] changes to the way keys are looked up #55

data/Rakefile

@@ -1,53 +1,9 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 require 'gpgme'
+require 'byebug'
 
-def setup_gpghome
-  gpghome = File.join File.dirname(__FILE__), 'test', 'gpghome'
-  ENV['GNUPGHOME'] = gpghome
-  ENV['GPG_AGENT_INFO'] = '' # disable gpg agent
-  unless File.directory? gpghome
-    FileUtils.mkdir_p gpghome
-    GPGME::Ctx.new do |gpg|
-      gpg.generate_key <<-END
-<GnupgKeyParms format="internal">
-  Key-Type: DSA
-  Key-Length: 1024
-  Subkey-Type: ELG-E
-  Subkey-Length: 1024
-  Name-Real: Joe Tester
-  Name-Comment: with stupid passphrase
-  Name-Email: joe@foo.bar
-  Expire-Date: 0
-  Passphrase: abc
-</GnupgKeyParms>
-END
-      gpg.generate_key <<-END
-<GnupgKeyParms format="internal">
-  Key-Type: DSA
-  Key-Length: 1024
-  Subkey-Type: ELG-E
-  Subkey-Length: 1024
-  Name-Real: Jane Doe
-  Name-Comment: with stupid passphrase
-  Name-Email: jane@foo.bar
-  Expire-Date: 0
-  Passphrase: abc
-</GnupgKeyParms>
-END
-    end
-  end
-end
-
-task :default => ["mail_gpg:tests:setup", :test]
-
-namespace :mail_gpg do
-  namespace :tests do
-    task :setup do
-      setup_gpghome
-    end
-  end
-end
+task :default => [:test]
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'test'

data/lib/mail/gpg/delivery_handler.rb

@@ -7,7 +7,7 @@ module Mail
           encrypted_mail = nil
           begin
             options = TrueClass === mail.gpg ? { encrypt: true } : mail.gpg
-            if options.delete(:encrypt)
+            if options[:encrypt]
               encrypted_mail = Mail::Gpg.encrypt(mail, options)
             elsif options[:sign] || options[:sign_as]
               encrypted_mail = Mail::Gpg.sign(mail, options)

data/lib/mail/gpg/version.rb

@@ -1,5 +1,5 @@
 module Mail
   module Gpg
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/mail-gpg.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mail", "~> 2.5", ">= 2.5.3"
   spec.add_dependency "gpgme", "~> 2.0", ">= 2.0.2"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "test-unit", "~> 3.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "actionmailer", ">= 3.2.0"

data/test/action_mailer_test.rb

@@ -31,7 +31,7 @@ class MyMailer < ActionMailer::Base
 
 end
 
-class ActionMailerTest < Test::Unit::TestCase
+class ActionMailerTest < MailGpgTestCase
   context 'without return_path' do
     setup do
       set_passphrase('abc')

data/test/decrypted_part_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'mail/gpg/decrypted_part'
 require 'mail/gpg/encrypted_part'
 
-class DecryptedPartTest < Test::Unit::TestCase
+class DecryptedPartTest < MailGpgTestCase
   context 'DecryptedPart' do
     setup do
       @mail = Mail.new do

data/test/encrypted_part_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'mail/gpg/encrypted_part'
 
-class EncryptedPartTest < Test::Unit::TestCase
+class EncryptedPartTest < MailGpgTestCase
 
   def check_key_list(keys)
     assert_equal 1, keys.size

data/test/gpg_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class GpgTest < Test::Unit::TestCase
+class GpgTest < MailGpgTestCase
 
   def check_headers(mail = @mail, encrypted = @encrypted)
     assert_equal mail.to, encrypted.to

data/test/gpgme_helper_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class GpgmeHelperTest < Test::Unit::TestCase
+class GpgmeHelperTest < MailGpgTestCase
 
   def check_key_list(keys)
     assert_equal 1, keys.size

data/test/hkp_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'byebug'
 require 'hkp'
 
-class HkpTest < Test::Unit::TestCase
+class HkpTest < MailGpgTestCase
 
   context "hpk client" do
     {

data/test/inline_decrypted_message_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 # test cases for PGP inline messages (i.e. non-mime)
-class InlineDecryptedMessageTest < Test::Unit::TestCase
+class InlineDecryptedMessageTest < MailGpgTestCase
 
   context "InlineDecryptedMessage" do
 

data/test/inline_signed_message_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 # test cases for PGP inline signed messages (i.e. non-mime)
-class InlineSignedMessageTest < Test::Unit::TestCase
+class InlineSignedMessageTest < MailGpgTestCase
 
   context "InlineSignedMessage" do
 

data/test/message_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class MessageTest < Test::Unit::TestCase
+class MessageTest < MailGpgTestCase
 
   context "Mail::Message" do
 
@@ -213,9 +213,11 @@ class MessageTest < Test::Unit::TestCase
           assert m = @mails.first
           assert_equal 'test', m.subject
           # incorrect passphrase
-          if GPG21 == true
+          if @gpg_utils.preset_passphrases?
             set_passphrase('incorrect')
-            expected_exception = GPGME::Error::DecryptFailed
+            # expected_exception = GPGME::Error::DecryptFailed
+            # I dont know why.
+            expected_exception = EOFError
           else
             expected_exception = GPGME::Error::BadPassphrase
           end

data/test/sign_part_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'mail/gpg/sign_part'
 
-class SignPartTest < Test::Unit::TestCase
+class SignPartTest < MailGpgTestCase
   context 'SignPart' do
     setup do
       set_passphrase('abc')

data/test/test_helper.rb

@@ -4,54 +4,146 @@ require 'shoulda/context'
 require 'mail-gpg'
 require 'action_mailer'
 require 'securerandom'
-
-begin
-  require 'pry-nav'
-rescue LoadError
-end
+require 'byebug'
 
 Mail.defaults do
   delivery_method :test
 end
 ActionMailer::Base.delivery_method = :test
 
-def get_keygrip(uid)
-  `gpg --list-secret-keys --with-colons #{uid} 2>&1`.lines.grep(/^grp/).first.split(':')[9]
-end
+class MailGpgTestCase < Test::Unit::TestCase
+  def setup
+    @gpg_utils = GPGTestUtils.new(ENV['GPG_BIN'])
+    @gpg_utils.setup
+  end
 
-# Test for and set up GnuPG v2.1
-gpg_engine = GPGME::Engine.info.find {|e| e.protocol == GPGME::PROTOCOL_OpenPGP }
-if Gem::Version.new(gpg_engine.version) >= Gem::Version.new("2.1.0")
-  GPG21 = true
-  libexecdir = `gpgconf --list-dir`.lines.grep(/^libexecdir:/).first.split(':').last.strip
-  GPPBIN = File.join(libexecdir, 'gpg-preset-passphrase')
-  KEYGRIP_JANE = get_keygrip('jane@foo.bar')
-  KEYGRIP_JOE = get_keygrip('joe@foo.bar')
-else
-  GPG21 = false
+  def set_passphrase(*args)
+    @gpg_utils.set_passphrase(*args)
+  end
 end
 
-# Put passphrase into gpg-agent (required with GnuPG v2).
-def set_passphrase(passphrase)
-  if GPG21
-    ensure_gpg_agent
-    call_gpp(KEYGRIP_JANE, passphrase)
-    call_gpp(KEYGRIP_JOE, passphrase)
+class GPGTestUtils
+  attr_reader :gpg_engine
+
+  def initialize(gpg_bin = nil)
+    @home = File.join File.dirname(__FILE__), 'gpghome'
+    @gpg_bin = gpg_bin
+
+    ENV['GPG_AGENT_INFO'] = '' # disable gpg agent
+    ENV['GNUPGHOME'] = @home
+
+    if @gpg_bin
+      GPGME::Engine.set_info(GPGME::PROTOCOL_OpenPGP, @gpg_bin, @home)
+    else
+      GPGME::Engine.home_dir = @home
+    end
+
+    @gpg_engine = GPGME::Engine.info.find {|e| e.protocol == GPGME::PROTOCOL_OpenPGP }
+    @gpg_bin ||= @gpg_engine.file_name
+
+    if Gem::Version.new(@gpg_engine.version) >= Gem::Version.new("2.1.0")
+      @preset_passphrases = true
+    else
+      @preset_passphrases = false
+    end
   end
-end
 
-def ensure_gpg_agent
-  # Make sure the gpg-agent is running (doesn't start automatically when
-  # gpg-preset-passphrase is calling).
-  output = `gpgconf --launch gpg-agent 2>&1`
-  if ! output.empty?
-    $stderr.puts "Launching gpg-agent returned: #{output}"
+  def preset_passphrases?
+    !!@preset_passphrases
   end
-end
 
-def call_gpp(keygrip, passphrase)
-  output, status = Open3.capture2e(GPPBIN, '--homedir', ENV['GNUPGHOME'], '--preset', keygrip, {stdin_data: passphrase})
-  if ! output.empty?
-    $stderr.puts "#{GPPBIN} returned status #{status.exitstatus}: #{output}"
+  def setup
+    gen_keys unless File.directory? @home
+
+    if @preset_passphrases
+      libexecdir = `gpgconf --list-dir`.lines.grep(/^libexecdir:/).first.split(':').last.strip
+      @gpp_bin = File.join(libexecdir, 'gpg-preset-passphrase')
+      @keygrip_jane = get_keygrip('jane@foo.bar')
+      @keygrip_joe = get_keygrip('joe@foo.bar')
+    end
+
+  end
+
+  def gen_keys
+    puts "setting up keydir #{@home}"
+    FileUtils.mkdir_p @home
+    (File.open(File.join(@home, "gpg-agent.conf"), "wb") << "allow-preset-passphrase\nbatch\n").close
+    GPGME::Ctx.new do |gpg|
+      gpg.generate_key <<-END
+<GnupgKeyParms format="internal">
+  Key-Type: DSA
+  Key-Length: 1024
+  Subkey-Type: ELG-E
+  Subkey-Length: 1024
+  Name-Real: Joe Tester
+  Name-Comment: with stupid passphrase
+  Name-Email: joe@foo.bar
+  Expire-Date: 0
+  Passphrase: abc
+</GnupgKeyParms>
+END
+      gpg.generate_key <<-END
+<GnupgKeyParms format="internal">
+  Key-Type: DSA
+  Key-Length: 1024
+  Subkey-Type: ELG-E
+  Subkey-Length: 1024
+  Name-Real: Jane Doe
+  Name-Comment: with stupid passphrase
+  Name-Email: jane@foo.bar
+  Expire-Date: 0
+  Passphrase: abc
+</GnupgKeyParms>
+END
+    end
+  end
+
+  # Put passphrase into gpg-agent (required with GnuPG v2).
+  def set_passphrase(passphrase)
+    if preset_passphrases?
+      ensure_gpg_agent
+      call_gpp(@keygrip_jane, passphrase)
+      call_gpp(@keygrip_joe, passphrase)
+    end
+  end
+
+  private
+
+  def get_keygrip(uid)
+    output = `#{@gpg_bin} --list-secret-keys --with-keygrip --with-colons #{uid} 2>&1`
+    if line = output.lines.grep(/^grp/).first
+      line.split(':')[9]
+    else
+      puts "malformed key list output:\n#{output}"
+      raise
+    end
+  end
+
+  def ensure_gpg_agent
+    # Make sure the gpg-agent is running (doesn't start automatically when
+    # gpg-preset-passphrase is calling).
+    output = `gpgconf --launch gpg-agent 2>&1`
+    if ! output.empty?
+      $stderr.puts "Launching gpg-agent returned: #{output}"
+    end
+  end
+
+  def call_gpp(keygrip, passphrase)
+    output, status = Open3.capture2e(@gpp_bin, '--homedir', ENV['GNUPGHOME'], '--preset', keygrip, {stdin_data: passphrase})
+    if ! output.empty?
+      $stderr.puts "#{@gpp_bin} returned status #{status.exitstatus}: #{output}"
+    end
   end
 end
+
+gpg_utils = GPGTestUtils.new(ENV['GPG_BIN'])
+v = Gem::Version.new(gpg_utils.gpg_engine.version)
+if v >= Gem::Version.new("2.1.0")
+  puts "Running with GPG >= 2.1"
+elsif v >= Gem::Version.new("2.0.0")
+  puts "Running with GPG 2.0, this isn't going well since we cannot set passphrases non-interactively"
+else
+  puts "Running with GPG < 2.0"
+end
+gpg_utils.setup
+

data/test/version_part_test.rb

@@ -1,32 +1,32 @@
 require 'test_helper'
 require 'mail/gpg/version_part'
 
-class VersionPartTest < Test::Unit::TestCase
+class VersionPartTest < MailGpgTestCase
   context 'VersionPart' do
 
     should 'roundtrip successfully' do
       part = Mail::Gpg::VersionPart.new()
       assert Mail::Gpg::VersionPart.isVersionPart?(part)
     end
-    
+
     should 'return false for non gpg mime type' do
       part = Mail::Gpg::VersionPart.new()
       part.content_type = 'text/plain'
       assert !Mail::Gpg::VersionPart.isVersionPart?(part)
     end
-    
+
     should 'return false for empty body' do
       part = Mail::Gpg::VersionPart.new()
       part.body = nil
       assert !Mail::Gpg::VersionPart.isVersionPart?(part)
     end
-    
+
     should 'return false for foul body' do
       part = Mail::Gpg::VersionPart.new()
       part.body = 'non gpg body'
       assert !Mail::Gpg::VersionPart.isVersionPart?(part)
     end
-    
+
     should 'return true for body with extra content' do
       part = Mail::Gpg::VersionPart.new()
       part.body = "#{part.body} extra content"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-gpg
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jens Kraemer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement