dkim 0.2.0 → 1.0.0

data/CHANGELOG.md

@@ -1,18 +1,24 @@
 # dkim Changelog
 
-## 2012.04.15, Version 0.2.0
+## 1.0.0 (2012-01-15)
+* DKIM-Signature header is now prepended rather than appended
+* Headers are signed in the order they appear
+* Correct signing of repeated headers
+* Correct signing of missing headers
+
+## 0.2.0 (2012-04-15)
 * Warn and strip existing signatures in Dkim::Interceptor
 * Dkim options can be accessed and modified using new Dkim.options or signed_mail.options hash
 * Refactoring and better testing
 * Improved documentation
 
-## 2011.12.10, Version 0.1.0
+## 0.1.0 (2011-12-10)
 * Ensure header lines are not folded using Dkim::Interceptor
 
-## 2011.07.25, Version 0.0.3
+## 0.0.3 (2011-07-25)
 * add Dkim::Interceptor class for integration with rails and [mail](https://github.com/mikel/mail)
 
-## 2011.06.01, Version 0.0.2
+## 0.0.2 (2011-06-01)
 
 * add convenience method Dkim.sign
 * support for the simple canonicalization algorithm
@@ -20,7 +26,7 @@
 * correct handling of an empty message body
 
 
-## 2011.05.10, Version 0.0.1
+## 0.0.1 (2011-05-10)
 
 * Initial release
 

data/lib/dkim/canonicalized_headers.rb

@@ -0,0 +1,26 @@
+module Dkim
+  class CanonicalizedHeaders
+    include Enumerable
+    def initialize header_list, signed_headers
+      @header_list    = header_list
+      @signed_headers = signed_headers.map(&:downcase)
+    end
+    def each(&block)
+      header_hash = Hash.new {|h,k| h[k] = []}
+      @header_list.each do |header|
+        header_hash[header.relaxed_key] << header
+      end
+
+      @signed_headers.each do |key|
+        if header = header_hash[key].pop
+          yield header
+        end
+      end
+    end
+    def to_s(canonicalization)
+      map do |header|
+        header.to_s(canonicalization) + "\r\n"
+      end.join
+    end
+  end
+end

data/lib/dkim/dkim_header.rb

@@ -1,28 +1,37 @@
 
 require 'dkim/header'
+require 'dkim/tag_value_list'
+require 'dkim/encodings'
 
 module Dkim
   class DkimHeader < Header
+    attr_reader :list
     def initialize values={}
       self.key = 'DKIM-Signature'
-      @values = values.to_a.flatten.each_slice(2).to_a
+      @list = TagValueList.new values
     end
     def value
-      @values.map do |(k, v)|
-        " #{k}=#{v}"
-      end.join(';')
+      " #{@list}"
     end
     def [] k
-      value = @values.detect {|(a,b)| a == k }
-      value && value[1]
+      encoder_for(k).decode(@list[k])
     end
     def []= k, v
-      value = @values.detect {|(a,b)| a == k }
-      if !value
-        value = [k, nil]
-        @values << value
-      end
-      value[1] = v
+      @list[k] = encoder_for(k).encode(v)
+    end
+
+    private
+    def encoder_for key
+      case key
+      when *%w{v a c d h l q s t x}
+        Encodings::PlainText
+      when *%w{i z}
+        Encodings::DkimQuotedPrintable
+      when *%w{b bh}
+        Encodings::Base64
+      else
+        raise "unknown key: #{key}"
+      end.new
     end
   end
 end

data/lib/dkim/encodings.rb

@@ -0,0 +1,3 @@
+require 'dkim/encodings/base64.rb'
+require 'dkim/encodings/dkim_quoted_printable.rb'
+require 'dkim/encodings/plain_text.rb'

data/lib/dkim/encodings/base64.rb

@@ -0,0 +1,12 @@
+module Dkim
+  module Encodings
+    class Base64
+      def decode data
+        data.gsub(/\s/, '').unpack('m0')[0]
+      end
+      def encode data
+        [data].pack('m0').gsub("\n", '')
+      end
+    end
+  end
+end

data/lib/dkim/encodings/dkim_quoted_printable.rb

@@ -0,0 +1,19 @@
+
+module Dkim
+  module Encodings
+    # Implements DKIM-Quoted-Printable as described in rfc6376 section 2.11
+    class DkimQuotedPrintable
+      DkimUnafeChar = /[^\x21-\x3A\x3C\x3E-\x7E]/
+      def encode string
+        string.gsub(DkimUnafeChar) do |char|
+          "=%.2x" % char.unpack('C')
+        end
+      end
+      def decode string
+        string.gsub(/=([0-9A-F]{2})/) do
+          $1.hex.chr
+        end
+      end
+    end
+  end
+end

data/lib/dkim/encodings/plain_text.rb

@@ -0,0 +1,8 @@
+module Dkim
+  module Encodings
+    class PlainText
+      def encode v; v; end
+      alias_method :decode, :encode
+    end
+  end
+end

data/lib/dkim/header.rb

@@ -38,5 +38,12 @@ module Dkim
     def canonical_simple
       "#{key}:#{value}"
     end
+
+    def self.parse header_string
+      header_string.split(/\r?\n(?!([ \t]))/).map do |header|
+        key, value = header.split(':', 2)
+        new(key, value)
+      end
+    end
   end
 end

data/lib/dkim/interceptor.rb

@@ -14,8 +14,8 @@ module Dkim
       # generate new signature
       dkim_signature = SignedMail.new(message.encoded).dkim_header.value
 
-      # append signature to message
-      message.header.fields << Mail::DkimField.new(dkim_signature)
+      # prepend signature to message
+      message.header.fields.unshift Mail::DkimField.new(dkim_signature)
       message
     end
   end

data/lib/dkim/signed_mail.rb

@@ -3,8 +3,8 @@ require 'openssl'
 require 'dkim/body'
 require 'dkim/dkim_header'
 require 'dkim/header'
-require 'dkim/header_list'
 require 'dkim/options'
+require 'dkim/canonicalized_headers'
 
 module Dkim
   class SignedMail
@@ -17,23 +17,28 @@ module Dkim
     def initialize message, options={}
       message = message.to_s.gsub(/\r?\n/, "\r\n")
       headers, body = message.split(/\r?\n\r?\n/, 2)
-      @headers = HeaderList.new headers
+      @original_message = message
+      @headers = Header.parse headers
       @body    = Body.new body
 
       # default options from Dkim.options
       @options = Dkim.options.merge(options)
     end
 
-    # @return [Array<String>] Signed headers of message in their canonical forms
+    def canonicalized_headers
+      CanonicalizedHeaders.new(@headers, signed_headers)
+    end
+
+    # @return [Array<String>] lowercased names of headers in the order they are signed
     def signed_headers
-      (@headers.map(&:relaxed_key) & signable_headers.map(&:downcase)).sort
+      @headers.map(&:relaxed_key).select do |key|
+        signable_headers.map(&:downcase).include?(key)
+      end
     end
 
     # @return [String] Signed headers of message in their canonical forms
     def canonical_header
-      headers = signed_headers.map do |key|
-        @headers[key].to_s(header_canonicalization) + "\r\n"
-      end.join
+      canonicalized_headers.to_s(header_canonicalization)
     end
 
     # @return [String] Body of message in its canonical form
@@ -59,31 +64,24 @@ module Dkim
       dkim_header['t'] = (time || Time.now).to_i
 
       # Add body hash and blank signature
-      dkim_header['bh']= base64_encode digest_alg.digest(canonical_body)
+      dkim_header['bh']= digest_alg.digest(canonical_body)
       dkim_header['h'] = signed_headers.join(':')
       dkim_header['b'] = ''
 
       # Calculate signature based on intermediate signature header
       headers = canonical_header
       headers << dkim_header.to_s(header_canonicalization)
-      signature = base64_encode private_key.sign(digest_alg, headers)
-      dkim_header['b'] = signature
+      dkim_header['b'] = private_key.sign(digest_alg, headers)
 
       dkim_header
     end
 
     # @return [String] Message combined with calculated dkim header signature
     def to_s
-      headers = @headers.to_a + [dkim_header]
-      headers.map(&:to_s).join("\r\n") +
-        "\r\n\r\n" +
-        @body.to_s
+      dkim_header.to_s + "\r\n" + @original_message
     end
 
     private
-    def base64_encode data
-      [data].pack('m0').gsub("\n",'')
-    end
     def digest_alg
       case signing_algorithm
       when 'rsa-sha1'

data/lib/dkim/tag_value_list.rb

@@ -0,0 +1,28 @@
+module Dkim
+  class TagValueList
+    def initialize values={}
+      @keys = values.keys
+      @values = values.dup
+    end
+    def to_s
+      @keys.map do |k|
+        "#{k}=#{@values[k]}"
+      end.join('; ')
+    end
+    def [] k
+      @values[k]
+    end
+    def []= k, v
+      @keys << k unless self[k]
+      @values[k] = v
+    end
+    def self.parse string
+      list = new
+      string.split(';').each do |keyval|
+        key, value = keyval.split('=', 2)
+        list[key.strip] = value.strip
+      end
+      list
+    end
+  end
+end

data/lib/dkim/version.rb

@@ -1,3 +1,3 @@
 module Dkim
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/mail/dkim_field.rb

@@ -14,11 +14,11 @@ module Mail
     end
 
     def encoded
-      "#{name}:#{value}\n"
+      "#{name}:#{value}\r\n"
     end
 
     def decoded
-      "#{name}:#{value}\n"
+      "#{name}:#{value}\r\n"
     end
   end
 end

data/test/dkim/canonicalized_headers_test.rb

@@ -0,0 +1,51 @@
+
+require 'test_helper'
+
+module Dkim
+  class CanonicalizedHeadersTest < MiniTest::Unit::TestCase
+    def test_maintains_order
+      headers = "ABCD".chars.map {|c| Header.new(c, c) }
+      header_keys = headers.map &:relaxed_key
+      header_keys.permutation.each do |signed_headers|
+        ch = CanonicalizedHeaders.new(headers, signed_headers)
+        assert_equal signed_headers, ch.map(&:relaxed_key)
+      end
+    end
+
+    def test_repeated_headers
+      headers = [
+        Header.new('A', '1'),
+        Header.new('B', '2'),
+        Header.new('C', '3'),
+        Header.new('A', '4'),
+        Header.new('D', '5')
+      ]
+      ch = CanonicalizedHeaders.new(headers, %w{A A B C D})
+      assert_equal %w{4 1 2 3 5}, ch.map(&:value)
+      assert_equal <<-eos.rfc_format, ch.to_s('simple')
+      A:4<CRLF>
+      A:1<CRLF>
+      B:2<CRLF>
+      C:3<CRLF>
+      D:5<CRLF>
+      eos
+    end
+
+    # missing headers should be ignored
+    def test_missing_headers
+      headers = [
+        Header.new('A', '1'),
+        Header.new('B', '2'),
+        Header.new('C', '3'),
+      ]
+      ch = CanonicalizedHeaders.new(headers, %w{A A B C})
+      assert_equal %w{a b c}, ch.map(&:relaxed_key)
+      assert_equal <<-eos.rfc_format, ch.to_s('simple')
+      A:1<CRLF>
+      B:2<CRLF>
+      C:3<CRLF>
+      eos
+    end
+  end
+end
+

data/test/dkim/dkim_header_test.rb

@@ -1,5 +1,6 @@
 
 require 'test_helper'
+require 'base64'
 
 module Dkim
   class DkimHeaderTest < MiniTest::Unit::TestCase
@@ -15,8 +16,8 @@ module Dkim
       @header['q'] = 'dns/txt'
       @header['i'] = 'joe@football.example.com'
       @header['h'] = 'Received : From : To : Subject : Date : Message-ID'
-      @header['bh']= '2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8='
-      @header['b'] = 'AuUoFEfDxTDkHlLXSZEpZj79LICEps6eda7W3deTVFOk4yAUoqOB4nujc7YopdG5dWLSdNg6xNAZpOPr+kHxt1IrE+NahM6L/LbvaHutKVdkLLkpVaVVQPzeRDI009SO2Il5Lu7rDNH6mZckBdrIx0orEtZV4bmp/YzhwvcubU4='
+      @header['bh']= Base64.decode64 '2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8='
+      @header['b'] = Base64.decode64 'AuUoFEfDxTDkHlLXSZEpZj79LICEps6eda7W3deTVFOk4yAUoqOB4nujc7YopdG5dWLSdNg6xNAZpOPr+kHxt1IrE+NahM6L/LbvaHutKVdkLLkpVaVVQPzeRDI009SO2Il5Lu7rDNH6mZckBdrIx0orEtZV4bmp/YzhwvcubU4='
     end
 
     def test_correct_format

data/test/dkim/encodings_test.rb

@@ -0,0 +1,24 @@
+module Dkim
+  class EncodingsTest < MiniTest::Unit::TestCase
+    def test_plain_text
+      @encoder = Encodings::PlainText.new
+      assert_equal 'testing123', @encoder.encode('testing123')
+      assert_equal 'testing123', @encoder.decode('testing123')
+    end
+    def test_base64
+      @encoder = Encodings::Base64.new
+      assert_equal 'dGVzdGluZzEyMw==', @encoder.encode('testing123')
+      assert_equal 'testing123',       @encoder.decode('dGVzdGluZzEyMw==')
+    end
+    def test_quoted_printable
+      @encoder = Encodings::DkimQuotedPrintable.new
+      assert_equal 'testing123', @encoder.encode('testing123')
+      assert_equal 'testing123', @encoder.decode('testing123')
+
+      encoded = 'From:foo@eng.example.net|To:joe@example.com|Subject:demo=20run|Date:July=205,=202005=203:44:08=20PM=20-0700'
+      decoded = 'From:foo@eng.example.net|To:joe@example.com|Subject:demo run|Date:July 5, 2005 3:44:08 PM -0700'
+      assert_equal encoded, @encoder.encode(decoded)
+      assert_equal decoded, @encoder.decode(encoded)
+    end
+  end
+end

data/test/dkim/interceptor_test.rb

@@ -40,6 +40,9 @@ Joe.
     def setup
       @original_options = Dkim.options.dup
 
+      # ensure time does not change
+      Dkim.time = Time.now
+
       mail = EXAMPLEEMAIL.dup
 
       @mail = Mail.new(mail)
@@ -103,6 +106,20 @@ Joe.
       assert_equal 1, @mail.header.fields.count { |field| field.name =~ /^DKIM-Signature$/i }
       assert_equal 1, @mail.encoded.scan('DKIM-Signature').count
     end
+
+    def test_same_output_as_direct_usage
+      dkim_header = @mail['DKIM-Signature']
+
+      # Most necessary under simple
+      Dkim.header_canonicalization = 'simple'
+      Dkim.body_canonicalization = 'simple'
+
+      expected = Dkim.sign @mail.to_s
+
+      Interceptor.delivering_email(@mail)
+
+      assert_equal expected, @mail.to_s
+    end
   end
 end
 

data/test/dkim/options_test.rb

@@ -1,3 +1,5 @@
+require 'test_helper'
+
 module Dkim
   class OptionsTest < MiniTest::Unit::TestCase
     def setup

data/test/dkim/signed_mail_test.rb

@@ -9,17 +9,18 @@ module Dkim
 
     def test_defaults
       signed_mail = SignedMail.new(@mail, :time => Time.at(1234567890))
-      dkim_header = signed_mail.dkim_header
+      dkim_header = signed_mail.dkim_header.list
 
       assert_equal 'rsa-sha256',                                   dkim_header['a']
       assert_equal 'brisbane',                                     dkim_header['s']
       assert_equal 'example.com',                                  dkim_header['d']
       assert_equal 'relaxed/relaxed',                              dkim_header['c']
       assert_equal 'dns/txt',                                      dkim_header['q']
+      assert_equal 'from:to:subject:date:message-id',              dkim_header['h']
 
       # bh value from RFC 6376
       assert_equal '2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=', dkim_header['bh']
-      assert_equal 'mamSUb17FQSZY2lfkeAsH/DvmpHsXdaFAu6BfbVblGBQ5+2yIPCx+clF5wClVBj97utSZb1WwOM0iup1JL37FI/UG+bxHo+MdGLqbLR63THGEdVF8FVeST4o4EQTWe0H3P/sU2rRZ61+M2SrTS94QkKAgj89QNOG48xSAO9xdfs=', dkim_header['b']
+      assert_equal 'dQOeSpGJTfSbX4hPGGsy4ipcNAzC/33K7XaEXkjBneJJhv6MczHkJNsfmXeYESNIh5WVTuvE5IbnDPBVFrL+b3GKiLiyp/vlKO2NJViX4dLnKT/GdxjJh06ljZcYjUA+PorHvMwdu+cDsCffN8A7IhfVdsFruQr3vFPD0JyJ9XU=', dkim_header['b']
     end
 
     def test_overrides
@@ -33,15 +34,16 @@ module Dkim
         :time => Time.at(1234567890)
       }
       signed_mail = SignedMail.new(@mail, options)
-      dkim_header = signed_mail.dkim_header
-
-      assert_equal 'rsa-sha1',                     dkim_header['a']
-      assert_equal 'sidney',                       dkim_header['s']
-      assert_equal 'example.org',                  dkim_header['d']
-      assert_equal 'simple/simple',                dkim_header['c']
-      assert_equal 'dns/txt',                      dkim_header['q']
-      assert_equal 'yk6W9pJJilr5MMgeEdSd7J3IaJI=', dkim_header['bh']
-      assert_equal 'sqYGmen+fouyIj83HuJ1v+1x40xp481bLxxcgAWMFsWYEwG05KYl+o0ZWn8jqgd1coKlX29o9iFjcMtZHudT8KpOdcLVYpY3gxzNfEgH79eRz32/ieGgroSK2GoMA/aV1QkxfUZexLUdj9oOX8uaMYXDkj8RGmlEGi+NDz/e4sE=', dkim_header['b']
+      dkim_header = signed_mail.dkim_header.list
+
+      assert_equal 'rsa-sha1',                        dkim_header['a']
+      assert_equal 'sidney',                          dkim_header['s']
+      assert_equal 'example.org',                     dkim_header['d']
+      assert_equal 'simple/simple',                   dkim_header['c']
+      assert_equal 'dns/txt',                         dkim_header['q']
+      assert_equal "from:to:subject:date:message-id", dkim_header['h']
+      assert_equal 'yk6W9pJJilr5MMgeEdSd7J3IaJI=',    dkim_header['bh']
+      assert_equal 't+dk4yxTI2ByZxxRzkwhZhM4WzTZjGWHiWnS2t4pg7oT7fAIlMrfihJ/CIvGmYqYv4lbq4LStHqHx9TmEgxrkjLevHtuqhxkN55xJ2vA2QzTzFi2fMDZ4fFqWy4QtvlLjBAhevG+LXpmjPYec1cyeMlHlPAthq5+RNi6NHErJiM=', dkim_header['b']
     end
 
     def test_empty_body_hashes
@@ -56,11 +58,27 @@ module Dkim
         ['47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=', {:body_canonicalization => 'relaxed', :signing_algorithm => 'rsa-sha256'}],
       ].each do |body_hash, options|
         signed_mail = SignedMail.new(@mail, options)
-        dkim_header = signed_mail.dkim_header
+        dkim_header = signed_mail.dkim_header.list
 
         assert_equal body_hash, dkim_header['bh']
       end
     end
+
+    def test_multiple_instances_of_header
+      @mail = <<-eos
+Received: <A>
+Received: <B>
+Received: <C>
+
+      eos
+
+      signed_mail = SignedMail.new(@mail, :header_canonicalization => 'simple', :signable_headers => Dkim::DefaultHeaders + ['Received'])
+
+      assert_equal "received:received:received", signed_mail.dkim_header['h']
+
+      headers = signed_mail.canonical_header
+      assert_equal "Received: <C>\r\nReceived: <B>\r\nReceived: <A>\r\n", headers.to_s
+    end
   end
 end
 

data/test/dkim/tag_value_list_test.rb

@@ -0,0 +1,28 @@
+
+require 'test_helper'
+
+module Dkim
+  class TagValueListTest < MiniTest::Unit::TestCase
+    def test_replacement
+      @list = TagValueList.new
+
+      @list['a'] = '1'
+      @list['b'] = '2'
+      @list['c'] = '3'
+      assert_equal 'a=1; b=2; c=3', @list.to_s
+
+      @list['b'] = '4'
+      assert_equal 'a=1; b=4; c=3', @list.to_s
+    end
+    def test_correct_format
+      @list = TagValueList.new
+
+      @list['b'] = '2'
+      @list['a'] = '1'
+      @list['c'] = '!@#$%^'
+
+      assert_equal 'b=2; a=1; c=!@#$%^', @list.to_s
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -1,4 +1,6 @@
 
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
 require 'minitest/autorun'
 require 'dkim'
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dkim
 version: !ruby/object:Gem::Version
-  version: 0.2.0
   prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000 Z
+date: 2013-01-15 00:00:00.000000000 Z
 dependencies: []
 description: gem for adding DKIM signatures to email messages
 email:
@@ -31,19 +31,27 @@ files:
 - lib/dkim.rb
 - lib/dkim/body.rb
 - lib/dkim/canonicalizable.rb
+- lib/dkim/canonicalized_headers.rb
 - lib/dkim/dkim_header.rb
+- lib/dkim/encodings.rb
+- lib/dkim/encodings/base64.rb
+- lib/dkim/encodings/dkim_quoted_printable.rb
+- lib/dkim/encodings/plain_text.rb
 - lib/dkim/header.rb
-- lib/dkim/header_list.rb
 - lib/dkim/interceptor.rb
 - lib/dkim/options.rb
 - lib/dkim/signed_mail.rb
+- lib/dkim/tag_value_list.rb
 - lib/dkim/version.rb
 - lib/mail/dkim_field.rb
 - test/dkim/canonicalization_test.rb
+- test/dkim/canonicalized_headers_test.rb
 - test/dkim/dkim_header_test.rb
+- test/dkim/encodings_test.rb
 - test/dkim/interceptor_test.rb
 - test/dkim/options_test.rb
 - test/dkim/signed_mail_test.rb
+- test/dkim/tag_value_list_test.rb
 - test/test_helper.rb
 homepage: https://github.com/jhawthorn/dkim
 licenses: []
@@ -57,28 +65,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2701069676603955611
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2701069676603955611
 requirements: []
 rubyforge_project: dkim
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: DKIM library in ruby
 test_files:
 - test/dkim/canonicalization_test.rb
+- test/dkim/canonicalized_headers_test.rb
 - test/dkim/dkim_header_test.rb
+- test/dkim/encodings_test.rb
 - test/dkim/interceptor_test.rb
 - test/dkim/options_test.rb
 - test/dkim/signed_mail_test.rb
+- test/dkim/tag_value_list_test.rb
 - test/test_helper.rb

data/lib/dkim/header_list.rb

@@ -1,19 +0,0 @@
-module Dkim
-  class HeaderList
-    include Enumerable
-    def initialize headers
-      @headers = headers.split(/\r?\n(?!([ \t]))/).map do |header|
-        key, value = header.split(':', 2)
-        Header.new(key, value)
-      end
-    end
-    def [](key)
-      @headers.detect do |header|
-        header.relaxed_key == key
-      end
-    end
-    def each(&block)
-      @headers.each(&block)
-    end
-  end
-end