mail-gpg 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.5 2014-05-28
+
+* signing refactoring so the signed part only contains the necessary headers
+* preserve Auto-Submitted header
+
 == 0.1.4 2014-05-26
 
 * preserve return path headers and message id

data/lib/mail/gpg.rb

@@ -10,7 +10,7 @@ require 'mail/gpg/inline_decrypted_message'
 require 'mail/gpg/gpgme_helper'
 require 'mail/gpg/message_patch'
 require 'mail/gpg/rails'
-require 'mail/gpg/sign_part'
+require 'mail/gpg/signed_part'
 
 module Mail
   module Gpg
@@ -45,10 +45,11 @@ module Mail
     end
 
     def self.sign(cleartext_mail, options = {})
+      options[:sign_as] ||= cleartext_mail.from
       construct_mail(cleartext_mail, options) do
-        options[:sign_as] ||= cleartext_mail.from
-        add_part Mail::Part.new(cleartext_mail)
-        add_part SignPart.new(cleartext_mail, options)
+        to_be_signed = SignedPart.build(cleartext_mail)
+        add_part to_be_signed
+        add_part to_be_signed.sign(options)
 
         content_type "multipart/signed; micalg=pgp-sha1; protocol=\"application/pgp-signature\"; boundary=#{boundary}"
         body.preamble = options[:preamble] || "This is an OpenPGP/MIME signed message (RFC 4880 and 3156)"
@@ -94,16 +95,21 @@ module Mail
       false
     end
 
+    STANDARD_HEADERS = %w(from to cc bcc subject reply_to in_reply_to return_path message_id)
+    CUSTOM_HEADERS = %w(Auto-Submitted)
+
     private
 
     def self.construct_mail(cleartext_mail, options, &block)
       Mail.new do
         self.perform_deliveries = cleartext_mail.perform_deliveries
-        %w(from to cc bcc subject reply_to in_reply_to return_path message_id).each do |field|
+        STANDARD_HEADERS.each do |field|
           send field, cleartext_mail.send(field)
         end
         cleartext_mail.header.fields.each do |field|
-          header[field.name] = field.value if field.name =~ /^X-/
+          if CUSTOM_HEADERS.include?(field.name) or field.name =~ /^X-/
+            header[field.name] = field.value
+          end
         end
         instance_eval &block
       end

data/lib/mail/gpg/signed_part.rb

@@ -0,0 +1,37 @@
+require 'mail/part'
+require 'mail/gpg/sign_part'
+
+module Mail
+  module Gpg
+
+    class SignedPart < Mail::Part
+
+      def self.build(cleartext_mail)
+        new do
+          if cleartext_mail.body.multipart?
+            if cleartext_mail.content_type =~ /^(multipart[^;]+)/
+              # preserve multipart/alternative etc
+              content_type $1
+            else
+              content_type 'multipart/mixed'
+            end
+            cleartext_mail.body.parts.each do |p|
+              add_part p
+            end
+          else
+            content_type cleartext_mail.content_type
+            body cleartext_mail.body.raw_source
+          end
+        end
+      end
+
+      def sign(options)
+        SignPart.new(self, options)
+      end
+
+
+    end
+
+
+  end
+end

data/lib/mail/gpg/version.rb

@@ -1,5 +1,5 @@
 module Mail
   module Gpg
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/test/action_mailer_test.rb

@@ -69,8 +69,9 @@ class ActionMailerTest < Test::Unit::TestCase
         assert_equal 'signed', delivered.subject
         assert_equal 2, delivered.parts.size
         assert sign_part = delivered.parts.detect{|p| p.content_type =~ /signature\.asc/}
-        GPGME::Crypto.new.verify(sign_part.body.to_s, signed_text: m.encoded) do |sig|
-          assert true == sig.valid?
+        assert signed_part = delivered.parts.detect{|p| p.content_type !~ /signature\.asc/}
+        GPGME::Crypto.new.verify(sign_part.body.to_s, signed_text: signed_part.encoded) do |sig|
+          assert sig.valid?
         end
       end
     end
@@ -115,8 +116,9 @@ class ActionMailerTest < Test::Unit::TestCase
         assert_equal 'signed', delivered.subject
         assert_equal 2, delivered.parts.size
         assert sign_part = delivered.parts.detect{|p| p.content_type =~ /signature\.asc/}
-        GPGME::Crypto.new.verify(sign_part.body.to_s, signed_text: m.encoded) do |sig|
-          assert true == sig.valid?
+        assert signed_part = delivered.parts.detect{|p| p.content_type !~ /signature\.asc/}
+        GPGME::Crypto.new.verify(sign_part.body.to_s, signed_text: signed_part.encoded) do |sig|
+          assert sig.valid?
         end
       end
     end

data/test/gpg_test.rb

@@ -30,18 +30,24 @@ class GpgTest < Test::Unit::TestCase
   def check_signature(mail = @mail, signed = @signed)
     assert signed.signed?
     assert signature = signed.parts.detect{|p| p.content_type =~ /signature\.asc/}.body.to_s
-    GPGME::Crypto.new.verify(signature, signed_text: mail.encoded) do |sig|
-      assert true == sig.valid?
+    assert signed_part = signed.parts.detect{|p| p.content_type !~ /signature\.asc/}
+    assert_equal mail.parts.size, signed_part.parts.size
+    GPGME::Crypto.new.verify(signature, signed_text: signed_part.encoded) do |sig|
+      assert sig.valid?
     end
     assert Mail::Gpg.signature_valid?(signed)
   end
 
   def check_mime_structure_signed(mail = @mail, signed = @signed)
+    assert_match /multipart\/signed/, signed.content_type
     assert_equal 2, signed.parts.size
     orig_part, sign_part = signed.parts
 
     assert_equal 'application/pgp-signature; name=signature.asc', sign_part.content_type
-    assert_equal orig_part.content_type, @mail.content_type
+    assert_equal mail.parts.size, orig_part.parts.size
+    assert_nil orig_part.to
+    assert_nil orig_part.from
+    assert_nil orig_part.subject
   end
 
   def check_headers_signed(mail = @mail, signed = @signed)
@@ -73,6 +79,7 @@ class GpgTest < Test::Unit::TestCase
         from 'jane@foo.bar'
         subject 'test test'
         body 'sign me!'
+        content_type 'text/plain; charset=UTF-8'
       end
     end
 
@@ -138,9 +145,19 @@ class GpgTest < Test::Unit::TestCase
       end
     end
 
-    context 'multipart mail' do
+    context 'multipart alternative mail' do
       setup do
-        @mail.add_file 'Rakefile'
+        @mail = Mail.new do
+          to 'joe@foo.bar'
+          from 'jane@foo.bar'
+          subject 'test test'
+          text_part do
+            body 'sign me!'
+          end
+          html_part do
+            body '<h1>H1</h1>'
+          end
+        end
         @signed = Mail::Gpg.sign(@mail, password: 'abc')
       end
 
@@ -158,10 +175,12 @@ class GpgTest < Test::Unit::TestCase
 
       should 'have multiple parts in original content' do
         assert original_part = @signed.parts.first
-        assert original_part.multipart?
-        assert_equal 2, original_part.parts.size
+        assert @mail.multipart?
+        assert_match /alternative/, @mail.content_type
+        assert_match /alternative/, original_part.content_type
+        assert_equal original_part.parts.size, @mail.parts.size
         assert_match /sign me!/, original_part.parts.first.body.to_s
-        assert_match /Rakefile/, original_part.parts.last.content_disposition
+        assert_match /H1/, original_part.parts.last.body.to_s
       end
     end
   end

data/test/message_test.rb

@@ -44,9 +44,14 @@ class MessageTest < Test::Unit::TestCase
 
       context "" do
         setup do
+          @mail.header['Auto-Submitted'] = 'foo'
           @mail.deliver
         end
 
+        should 'keep custom header value' do
+          assert_equal 'foo', @mails.first.header['Auto-Submitted'].value
+        end
+
         should "deliver signed mail" do
           assert_equal 1, @mails.size
           assert m = @mails.first
@@ -56,12 +61,12 @@ class MessageTest < Test::Unit::TestCase
           assert m.multipart?
           assert m.signature_valid?
           assert sign_part = m.parts.last
-          assert m = Mail::Message.new(m.parts.first)
-          assert !m.multipart?
-          GPGME::Crypto.new.verify(sign_part.body.to_s, signed_text: m.encoded) do |sig| 
-            assert true == sig.valid?
+          #assert m = Mail::Message.new(m.parts.first)
+          #assert !m.multipart?
+          GPGME::Crypto.new.verify(sign_part.body.to_s, signed_text: m.parts.first.encoded) do |sig|
+            assert sig.valid?
           end
-          assert_equal 'i am unencrypted', m.body.to_s
+          assert_equal 'i am unencrypted', m.parts.first.body.to_s
         end
 
         should "fail signature on tampered body" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail-gpg
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -168,6 +168,7 @@ files:
 - lib/mail/gpg/rails.rb
 - lib/mail/gpg/rails/action_mailer_base_patch.rb
 - lib/mail/gpg/sign_part.rb
+- lib/mail/gpg/signed_part.rb
 - lib/mail/gpg/version.rb
 - lib/mail/gpg/version_part.rb
 - mail-gpg.gemspec