dkim 0.1.0 → 1.1.0

data/test/dkim/signed_mail_test.rb

@@ -0,0 +1,112 @@
+
+require 'test_helper'
+
+module Dkim
+  class SignedMailTest < Minitest::Test
+    def setup
+      @mail = EXAMPLEEMAIL.dup
+    end
+
+    def test_defaults
+      signed_mail = SignedMail.new(@mail, :time => Time.at(1234567890))
+      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 'dQOeSpGJTfSbX4hPGGsy4ipcNAzC/33K7XaEXkjBneJJhv6MczHkJNsfmXeYESNIh5WVTuvE5IbnDPBVFrL+b3GKiLiyp/vlKO2NJViX4dLnKT/GdxjJh06ljZcYjUA+PorHvMwdu+cDsCffN8A7IhfVdsFruQr3vFPD0JyJ9XU=', dkim_header['b']
+    end
+
+    def test_overrides
+      options = {
+        :domain => 'example.org',
+        :selector => 'sidney',
+        :time => Time.now,
+        :signing_algorithm => 'rsa-sha1',
+        :header_canonicalization => 'simple',
+        :body_canonicalization => 'simple',
+        :time => Time.at(1234567890)
+      }
+      signed_mail = SignedMail.new(@mail, options)
+      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_expire
+      options = {
+        :time => Time.at(1234567890),
+        :expire => Time.at(1234567990)
+      }
+      signed_mail = SignedMail.new(@mail, options)
+      dkim_header = signed_mail.dkim_header.list
+
+      assert_equal 1234567990,                                      dkim_header['x']
+      assert_equal '2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=',  dkim_header['bh']
+      assert_equal 'dn2Y5rSXQNRBy904vwpvri6xcmlrwKDmDX4XtBgyABQw9jLTulgD/G61TeyqinwgaHiatQaYt4pnpzYQGMaCCg7MepkkpZAR4IggAnHo/qB4JRx5OYBslKCCwpeb70YOPdukVopEnaCoUfkCGJ5vvu3xXG1N+ajKWqYiZ0n4z+o=', dkim_header['b']
+    end
+
+    def test_identity
+      options = {
+        :domain => 'example.org',
+        :selector => 'sidney',
+        :identity => '@example.org',
+        :time => Time.at(1234567890)
+      }
+      signed_mail = SignedMail.new(@mail, options)
+      dkim_header = signed_mail.dkim_header.list
+
+      assert_equal '@example.org',                                  dkim_header['i']
+      assert_equal '2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=',  dkim_header['bh']
+      assert_equal 'dCiulbJTD+GCCItMij1IU/RO0+q73afdjmrCWV5Qu7BIT5Kbp5Oi3jqCzj/v8Juks2/L6GBSXZia3aZprNVZX0szt8RnwC9NJx9WhcjN2RPz4Zf5F1jJivCN+PtaIWA3i3Ki/DR1q+RuNPgs7T1KKMo3Ih5uHubZIsMwRzbQBc0=', dkim_header['b']
+    end
+
+    def test_empty_body_hashes
+      @mail = @mail.split("\n\n").first + "\n\n"
+
+      # the following are from RFC 6376 section 3.4.3 and 3.4.4
+      [
+        # [bh, options]
+        ['uoq1oCgLlTqpdDX/iUbLy7J1Wic=',                 {:body_canonicalization => 'simple',  :signing_algorithm => 'rsa-sha1'  }],
+        ['frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN/XKdLCPjaYaY=', {:body_canonicalization => 'simple',  :signing_algorithm => 'rsa-sha256'}],
+        ['2jmj7l5rSw0yVb/vlWAYkK/YBwk=',                 {:body_canonicalization => 'relaxed', :signing_algorithm => 'rsa-sha1'  }],
+        ['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.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::Test
+    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,9 +1,11 @@
 
-require 'test/unit'
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'minitest/autorun'
 require 'dkim'
 
 class String
-  # Parse the format used in rfc4871
+  # Parse the format used in RFC 6376
   #
   # In the following examples, actual whitespace is used only for
   # clarity.  The actual input and output text is designated using
@@ -23,7 +25,37 @@ class String
   end
 end
 
-# examples used in rfc
-Dkim::domain = 'example.com'
+# examples used in RFC 6376
+EXAMPLEEMAIL = %{
+From: Joe SixPack <IIVyTowbcT@www.brandonchecketts.com>
+To: Suzie Q <suzie@shopping.example.net>
+Subject: Is dinner ready?
+Date: Fri, 11 Jul 2003 21:00:37 -0700 (PDT)
+Message-ID: <20030712040037.46341.5F8J@football.example.com>
+
+Hi.
 
+We lost the game. Are you hungry yet?
+
+Joe.}.gsub(/\A\n/,'')
+
+Dkim::domain = 'example.com'
+Dkim::selector = 'brisbane'
+Dkim::private_key = %{
+-----BEGIN RSA PRIVATE KEY-----
+MIICXwIBAAKBgQDwIRP/UC3SBsEmGqZ9ZJW3/DkMoGeLnQg1fWn7/zYtIxN2SnFC
+jxOCKG9v3b4jYfcTNh5ijSsq631uBItLa7od+v/RtdC2UzJ1lWT947qR+Rcac2gb
+to/NMqJ0fzfVjH4OuKhitdY9tf6mcwGjaNBcWToIMmPSPDdQPNUYckcQ2QIDAQAB
+AoGBALmn+XwWk7akvkUlqb+dOxyLB9i5VBVfje89Teolwc9YJT36BGN/l4e0l6QX
+/1//6DWUTB3KI6wFcm7TWJcxbS0tcKZX7FsJvUz1SbQnkS54DJck1EZO/BLa5ckJ
+gAYIaqlA9C0ZwM6i58lLlPadX/rtHb7pWzeNcZHjKrjM461ZAkEA+itss2nRlmyO
+n1/5yDyCluST4dQfO8kAB3toSEVc7DeFeDhnC1mZdjASZNvdHS4gbLIA1hUGEF9m
+3hKsGUMMPwJBAPW5v/U+AWTADFCS22t72NUurgzeAbzb1HWMqO4y4+9Hpjk5wvL/
+eVYizyuce3/fGke7aRYw/ADKygMJdW8H/OcCQQDz5OQb4j2QDpPZc0Nc4QlbvMsj
+7p7otWRO5xRa6SzXqqV3+F0VpqvDmshEBkoCydaYwc2o6WQ5EBmExeV8124XAkEA
+qZzGsIxVP+sEVRWZmW6KNFSdVUpk3qzK0Tz/WjQMe5z0UunY9Ax9/4PVhp/j61bf
+eAYXunajbBSOLlx4D+TunwJBANkPI5S9iylsbLs6NkaMHV6k5ioHBBmgCak95JGX
+GMot/L2x0IYyMLAz6oLWh2hm7zwtb0CgOrPo1ke44hFYnfc=
+-----END RSA PRIVATE KEY-----
+}
 

metadata

@@ -1,16 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: dkim
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - John Hawthorn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-12-10 00:00:00.000000000 Z
-dependencies: []
+date: 2021-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: gem for adding DKIM signatures to email messages
 email:
 - john.hawthorn@gmail.com
@@ -19,49 +74,71 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - bin/dkimsign.rb
 - dkim.gemspec
+- gemfiles/mail_2.6.gemfile
+- gemfiles/mail_2.7.gemfile
 - 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/canonicalization_test.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: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: dkim
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
 summary: DKIM library in ruby
 test_files:
-- test/canonicalization_test.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

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

data/test/canonicalization_test.rb

@@ -1,78 +0,0 @@
-
-require 'test_helper'
-
-class CanonicalizationTest < Test::Unit::TestCase
-  # from section 3.4.6 of rfc4871
-  def setup
-    @input = <<-eos.rfc_format
-      A: <SP> X <CRLF>
-      B <SP> : <SP> Y <HTAB><CRLF>
-      <HTAB> Z <SP><SP><CRLF>
-      <CRLF>
-      <SP> C <SP><CRLF>
-      D <SP><HTAB><SP> E <CRLF>
-      <CRLF>
-      <CRLF>
-    eos
-    @mail = Dkim::SignedMail.new(@input)
-    @mail.signable_headers = ['A', 'B']
-  end
-  def test_relaxed_header
-    @mail.header_canonicalization = 'relaxed'
-    expected_header = <<-eos.rfc_format
-      a:X <CRLF>
-      b:Y <SP> Z <CRLF>
-    eos
-    assert_equal expected_header, @mail.canonical_header
-  end
-  def test_relaxed_body
-    @mail.body_canonicalization = 'relaxed'
-    expected_body = <<-eos.rfc_format
-      <SP> C <CRLF>
-      D <SP> E <CRLF>
-    eos
-    assert_equal expected_body, @mail.canonical_body
-  end
-
-  def test_simple_header
-    @mail.header_canonicalization = 'simple'
-    expected_header = <<-eos.rfc_format
-      A: <SP> X <CRLF>
-      B <SP> : <SP> Y <HTAB><CRLF>
-      <HTAB> Z <SP><SP><CRLF>
-    eos
-    assert_equal expected_header, @mail.canonical_header
-  end
-  def test_simple_body
-    @mail.body_canonicalization = 'simple'
-    expected_body = <<-eos.rfc_format
-      <SP> C <SP><CRLF>
-      D <SP><HTAB><SP> E <CRLF>
-    eos
-    assert_equal expected_body, @mail.canonical_body
-  end
-
-  # from errata: empty bodies
-  def test_simple_empty_body
-    @mail = Dkim::SignedMail.new("test: test\r\n\r\n")
-    @mail.body_canonicalization = 'simple'
-
-    assert_equal "\r\n", @mail.canonical_body
-  end
-
-  def test_relaxed_empty_body
-    @mail = Dkim::SignedMail.new("test: test\r\n\r\n")
-    @mail.body_canonicalization = 'relaxed'
-
-    assert_equal "", @mail.canonical_body
-  end
-
-  def test_relaxed_errata_1384
-    body = "testing<crlf><sp><sp><cr><lf><cr><lf>".rfc_format
-    @mail = Dkim::SignedMail.new("test: test\r\n\r\n#{body}")
-    @mail.body_canonicalization = 'relaxed'
-
-    assert_equal "testing\r\n", @mail.canonical_body
-  end
-end
-