dkim 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # dkim Changelog
 
+## 2012.04.15, Version 0.2.0
+* 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
+* Ensure header lines are not folded using Dkim::Interceptor
+
 ## 2011.07.25, Version 0.0.3
 * add Dkim::Interceptor class for integration with rails and [mail](https://github.com/mikel/mail)
 

data/Gemfile

@@ -2,3 +2,13 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in dkim.gemspec
 gemspec
+
+gem "rake"
+gem 'minitest'
+gem 'guard-minitest'
+gem 'mail'
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end
+

data/Guardfile

@@ -0,0 +1,5 @@
+
+guard 'minitest' do
+  watch(%r|^test/(.*)\.rb|) { "test" }
+  watch(%r|^lib/(.*)\.rb|) { "test" }
+end

data/README.md

@@ -1,30 +1,62 @@
 dkim
 ====
-
 A DKIM signing library in ruby.
 
+[![Build Status](https://secure.travis-ci.org/jhawthorn/dkim.png?branch=master)](http://travis-ci.org/jhawthorn/dkim)
+
+[Documentation](http://rubydoc.info/github/jhawthorn/dkim)
+
 Installation
 ============
 
     sudo gem install dkim
 
-Usage
-=====
+Necessary configuration
+=======================
+A private key, a domain, and a selector need to be specified in order to sign messages.
+
+These can be specified globally
+
+    Dkim::domain      = 'example.com'
+    Dkim::selector    = 'mail'
+    Dkim::private_key = open('private.pem').read
+
+Options can be overridden per message.
+
+    Dkim.sign(mail, :selector => 'mail2', :private_key => open('private2.pem').read)
+
+For more details see {Dkim::Options}
+
+Usage With Rails
+================
+
+Dkim contains `Dkim::Interceptor` which can be used to sign all mail delivered by rails 3 or [mail](https://github.com/mikel/mail).
+For rails, create an initializer (for example `config/initializers/dkim.rb`) with the following template.
+
+    # Configure dkim globally (see above)
+    Dkim::domain      = 'example.com'
+    Dkim::selector    = 'mail'
+    Dkim::private_key = open('private.pem').read
+
+    # This will sign all ActionMailer deliveries
+    ActionMailer::Base.register_interceptor(Dkim::Interceptor)
+
+Standalone Usage
+================
 
 Calling `Dkim.sign` on a string representing an email message returns the message with a DKIM signature inserted.
 
 For example
 
-    mail = <<eos
+    mail = Dkim.sign(<<EOS)
     To: someone@example.com
     From: john@example.com
     Subject: hi
-    
+
     Howdy
-    eos
+    EOS
 
     Dkim.sign(mail)
-
     # =>
     # To: someone@example.com
     # From: john@example.com
@@ -34,67 +66,25 @@ For example
     #  	b=0mKnNOkxFGiww63Zu4t46J7eZc3Uak3I9km3IH2Le3XcnSNtWJgxiwBX26IZ5yzcT
     # 	VwJzcCnPKCScIJMQ7yfbfXmNsKVIOV6eSUqu1YvJ1fgzlSAXuDEMNFTjoto5rrdA+
     # 	BgX849hEY/bWHDl1JJgNpiwtpl4t0Q7M4BVJUd7Lo=
-    # 
+    #
     # Howdy
 
-Necessary configuration
------------------------
-A private key, a domain, and a selector need to be specified in order to sign messages.
-
-These can be specified globally
-
-    Dkim::domain      = 'example.com'
-    Dkim::selector    = 'mail'
-    Dkim::private_key = open('private.pem').read
+More flexibility can be found using {Dkim::SignedMail} directly.
 
-Options can be overridden per message.
-
-    Dkim.sign(mail, :selector => 'mail2', :private_key => open('private2.pem').read)
-
-Additional configuration
-------------------------
+Specific configuration
+========================
 
-The following is the default configuration
-
-    Dkim::signable_headers        = Dkim::DefaultHeaders # Sign only the specified headers
-    Dkim::signing_algorithm       = 'rsa-sha256' # can be rsa-sha1 or rsa-sha256 (default)
-    Dkim::header_canonicalization = 'relaxed'    # Can be simple or relaxed (default)
-    Dkim::body_canonicalization   = 'relaxed'    # Can be simple or relaxed (default)
-
-The defaults should fit most users needs; however, certain use cases will need them to be customized.
-
-For example, for sending mesages through amazon SES, certain headers should not be signed
+For sending mesages through Amazon SES, certain headers should not be signed
 
     Dkim::signable_headers = Dkim::DefaultHeaders - %w{Message-ID Resent-Message-ID Date Return-Path Bounces-To}
 
-rfc4871 states that signers SHOULD sign using rsa-sha256. For this reason, dkim will *not* use rsa-sha1 as a fallback if the openssl library does not support sha256.
+Some OpenSSL's don't have sha256 support.
+RFC 6376 states that signers SHOULD sign using rsa-sha256.
+For this reason, dkim will *not* use rsa-sha1 as a fallback.
 If you wish to override this behaviour and use whichever algorithm is available you can use this snippet (**not recommended**).
 
     Dkim::signing_algorithm = defined?(OpenSSL::Digest::SHA256) ? 'rsa-sha256' : 'rsa-sha1'
 
-Usage With Rails
-================
-
-Dkim contains `Dkim::Interceptor` which can be used to sign all mail delivered by the [mail gem](https://github.com/mikel/mail) or rails 3, which uses mail.
-For rails, create an initializer (for example `config/initializers/dkim.rb`) with the following template.
-
-    # Configure dkim globally (see above)
-    Dkim::domain      = 'example.com'
-    Dkim::selector    = 'mail'
-    Dkim::private_key = open('private.pem').read
-
-    # This will sign all ActionMailer deliveries
-    ActionMailer::Base.register_interceptor('Dkim::Interceptor')
-
-Example executable
-==================
-
-The library includes a `dkimsign.rb` executable suitable for testing the library or performing simple signatures.
-
-`dkimsign.rb DOMAIN SELECTOR KEYFILE [MAILFILE]`
-
-If MAILFILE is not specified `dkimsign.rb` will read the mail message from standard in.
-
 Limitations
 ===========
 
@@ -108,11 +98,11 @@ Limitations
 Resources
 =========
 
-* [RFC 4871](http://tools.ietf.org/html/rfc4871)
+* [RFC 6376](http://tools.ietf.org/html/rfc6376)
 * Inspired by perl's [Mail-DKIM](http://dkimproxy.sourceforge.net/)
 
-Copyright
-=========
+License
+=======
 
 (The MIT License)
 

data/lib/dkim.rb

@@ -1,5 +1,6 @@
 
 require 'dkim/signed_mail'
+require 'dkim/options'
 require 'dkim/interceptor'
 
 module Dkim
@@ -14,13 +15,7 @@ module Dkim
     List-Post List-Owner List-Archive}
 
   class << self
-    attr_accessor :signing_algorithm, :signable_headers, :domain, :selector, :header_canonicalization, :body_canonicalization
-
-    attr_reader :private_key
-    def private_key= key
-      key = OpenSSL::PKey::RSA.new(key) if key.is_a?(String)
-      @private_key = key
-    end
+    include Dkim::Options
 
     def sign message, options={}
       SignedMail.new(message, options).to_s
@@ -28,7 +23,7 @@ module Dkim
   end
 end
 
-Dkim::signable_headers        = Dkim::DefaultHeaders
+Dkim::signable_headers        = Dkim::DefaultHeaders.dup
 Dkim::domain                  = nil
 Dkim::selector                = nil
 Dkim::signing_algorithm       = 'rsa-sha256'

data/lib/dkim/interceptor.rb

@@ -3,7 +3,19 @@ module Dkim
   class Interceptor
     def self.delivering_email(message)
       require 'mail/dkim_field'
-      message.header.fields << Mail::DkimField.new(SignedMail.new(message.encoded).dkim_header.value)
+
+      # strip any existing signatures
+      if message['DKIM-Signature']
+        warn "WARNING: Dkim::Interceptor given a message with an existing signature, which it has replaced."
+        warn "If you really want to add a second signature to the message, you should be using the dkim gem directly."
+        message['DKIM-Signature'] = nil
+      end
+
+      # generate new signature
+      dkim_signature = SignedMail.new(message.encoded).dkim_header.value
+
+      # append signature to message
+      message.header.fields << Mail::DkimField.new(dkim_signature)
       message
     end
   end

data/lib/dkim/options.rb

@@ -0,0 +1,72 @@
+module Dkim
+  module Options
+    private
+    def self.define_option_method attribute_name
+      define_method(attribute_name){options[attribute_name]}
+      define_method("#{attribute_name}="){|value| options[attribute_name] = value}
+    end
+    public
+
+    # @attribute [rw]
+    # Hash of all options
+    # @return [Hash]
+    def options
+      @options ||= {}
+    end
+    attr_writer :options
+
+    # @attribute [rw]
+    # This corresponds to the t= tag in the dkim header.
+    # The default (nil) is to use the current time at signing.
+    # @return [Time,#to_i] A Time object or seconds since the epoch
+    define_option_method :time
+
+    # @attribute [rw]
+    # The signing algorithm for dkim. Valid values are 'rsa-sha1' and 'rsa-sha256' (default).
+    # This corresponds to the a= tag in the dkim header.
+    # @return [String] signing algorithm
+    define_option_method :signing_algorithm
+
+    # @attribute [rw]
+    # Configures which headers should be signed.
+    # Defaults to {Dkim::DefaultHeaders Dkim::DefaultHeaders}
+    # @return [Array<String>] signable headers
+    define_option_method :signable_headers
+
+    # @attribute [rw]
+    # The domain used for signing.
+    # This corresponds to the d= tag in the dkim header.
+    # @return [String] domain
+    define_option_method :domain
+
+    # @attribute [rw]
+    # Selector used for signing.
+    # This corresponds to the s= tag in the dkim header.
+    # @return [String] selector
+    define_option_method :selector
+
+    # @attribute [rw]
+    # Header canonicalization algorithm.
+    # Valid values are 'simple' and 'relaxed' (default)
+    # This corresponds to the first half of the c= tag in the dkim header.
+    # @return [String] header canonicalization algorithm
+    define_option_method :header_canonicalization
+
+    # @attribute [rw]
+    # Body canonicalization algorithm.
+    # Valid values are 'simple' and 'relaxed' (default)
+    # This corresponds to the second half of the c= tag in the dkim header.
+    # @return [String] body canonicalization algorithm
+    define_option_method :body_canonicalization
+
+    # @attribute [rw]
+    # RSA private key for signing.
+    # Can be assigned either an {OpenSSL::PKey::RSA} private key or a valid PEM format string.
+    # @return [OpenSSL::PKey::RSA] private key
+    define_option_method :private_key
+    def private_key= key
+      key = OpenSSL::PKey::RSA.new(key) if key.is_a?(String)
+      options[:private_key] = key
+    end
+  end
+end

data/lib/dkim/signed_mail.rb

@@ -4,69 +4,44 @@ require 'dkim/body'
 require 'dkim/dkim_header'
 require 'dkim/header'
 require 'dkim/header_list'
+require 'dkim/options'
 
 module Dkim
   class SignedMail
+    include Options
+
+    # A new instance of SignedMail
+    #
+    # @param [String,#to_s] message mail message to be signed
+    # @param [Hash] options hash of options for signing. Defaults are taken from {Dkim}. See {Options} for details.
     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
       @body    = Body.new body
 
-      @signable_headers  = options[:signable_headers]
-      @domain            = options[:domain]
-      @selector          = options[:selector]
-      @time              = options[:time]
-      @signing_algorithm = options[:signing_algorithm]
-      @private_key       = options[:private_key]
-      @header_canonicalization = options[:header_canonicalization]
-      @body_canonicalization   = options[:body_canonicalization]
-    end
-
-    # options for signatures
-    attr_writer :signing_algorithm, :signable_headers, :domain, :selector, :time, :header_canonicalization, :body_canonicalization
-
-    def private_key= key
-      key = OpenSSL::PKey::RSA.new(key) if key.is_a?(String)
-      @private_key = key
-    end
-    def private_key
-      @private_key || Dkim::private_key
-    end
-    def signing_algorithm
-      @signing_algorithm || Dkim::signing_algorithm
-    end
-    def signable_headers
-      @signable_headers || Dkim::signable_headers
-    end
-    def domain
-      @domain || Dkim::domain
-    end
-    def selector
-      @selector || Dkim::selector
-    end
-    def time
-      @time
-    end
-    def header_canonicalization
-      @header_canonicalization || Dkim::header_canonicalization
-    end
-    def body_canonicalization
-      @body_canonicalization || Dkim::body_canonicalization
+      # default options from Dkim.options
+      @options = Dkim.options.merge(options)
     end
 
+    # @return [Array<String>] Signed headers of message in their canonical forms
     def signed_headers
       (@headers.map(&:relaxed_key) & signable_headers.map(&:downcase)).sort
     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
     end
+
+    # @return [String] Body of message in its canonical form
     def canonical_body
       @body.to_s(body_canonicalization)
     end
 
+    # @return [DkimHeader] Constructed signature for the mail message
     def dkim_header
       dkim_header = DkimHeader.new
 
@@ -97,8 +72,8 @@ module Dkim
       dkim_header
     end
 
+    # @return [String] Message combined with calculated dkim header signature
     def to_s
-      # Return the original message with the calculated header
       headers = @headers.to_a + [dkim_header]
       headers.map(&:to_s).join("\r\n") +
         "\r\n\r\n" +
@@ -107,13 +82,13 @@ module Dkim
 
     private
     def base64_encode data
-      [data].pack('m0*').gsub("\n",'')
+      [data].pack('m0').gsub("\n",'')
     end
     def digest_alg
       case signing_algorithm
       when 'rsa-sha1'
         OpenSSL::Digest::SHA1.new
-      when 'rsa-sha256' 
+      when 'rsa-sha256'
         OpenSSL::Digest::SHA256.new
       else
         raise "Unknown digest algorithm: '#{signing_algorithm}'"

data/lib/dkim/version.rb

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

data/test/dkim/canonicalization_test.rb

@@ -0,0 +1,80 @@
+
+require 'test_helper'
+
+module Dkim
+  class CanonicalizationTest < MiniTest::Unit::TestCase
+    # from section 3.4.6 of RFC 6376
+    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 = 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 = 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 = 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 = SignedMail.new("test: test\r\n\r\n#{body}")
+      @mail.body_canonicalization = 'relaxed'
+
+      assert_equal "testing\r\n", @mail.canonical_body
+    end
+  end
+end
+

data/test/dkim/dkim_header_test.rb

@@ -0,0 +1,42 @@
+
+require 'test_helper'
+
+module Dkim
+  class DkimHeaderTest < MiniTest::Unit::TestCase
+    def setup
+      @header = DkimHeader.new
+
+      # from Appendix A of RFC 6376
+      @header['v'] = '1'
+      @header['a'] = 'rsa-sha256'
+      @header['s'] = 'brisbane'
+      @header['d'] = 'example.com'
+      @header['c'] = 'simple/simple'
+      @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='
+    end
+
+    def test_correct_format
+      header = @header.to_s
+
+      # result from RFC 6376 minus trailing ';'
+      expected = %{
+   DKIM-Signature: v=1; a=rsa-sha256; s=brisbane; d=example.com;
+         c=simple/simple; q=dns/txt; i=joe@football.example.com;
+         h=Received : From : To : Subject : Date : Message-ID;
+         bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
+         b=AuUoFEfDxTDkHlLXSZEpZj79LICEps6eda7W3deTVFOk4yAUoqOB
+           4nujc7YopdG5dWLSdNg6xNAZpOPr+kHxt1IrE+NahM6L/LbvaHut
+           KVdkLLkpVaVVQPzeRDI009SO2Il5Lu7rDNH6mZckBdrIx0orEtZV
+           4bmp/YzhwvcubU4=
+      }
+
+      # compare removing whitespace
+      assert_equal expected.gsub(/\s/,''), header.gsub(/\s/,'')
+    end
+  end
+end
+

data/test/dkim/interceptor_test.rb

@@ -0,0 +1,108 @@
+require 'test_helper'
+
+require 'mail'
+
+module Dkim
+  SIGNEDMAIL = <<-eos
+DKIM-Signature: v=1; a=rsa-sha256; s=brisbane; d=example.com;
+      c=simple/simple; q=dns/txt; i=joe@football.example.com;
+      h=Received : From : To : Subject : Date : Message-ID;
+      bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
+      b=AuUoFEfDxTDkHlLXSZEpZj79LICEps6eda7W3deTVFOk4yAUoqOB
+        4nujc7YopdG5dWLSdNg6xNAZpOPr+kHxt1IrE+NahM6L/LbvaHut
+        KVdkLLkpVaVVQPzeRDI009SO2Il5Lu7rDNH6mZckBdrIx0orEtZV
+        4bmp/YzhwvcubU4=;
+Received: from client1.football.example.com  [192.0.2.1]
+      by submitserver.example.com with SUBMISSION;
+      Fri, 11 Jul 2003 21:01:54 -0700 (PDT)
+From: Joe SixPack <joe@football.example.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>
+DKIM-Signature: v=1; a=rsa-sha256; s=brisbane; d=example.com;
+      c=simple/simple; q=dns/txt; i=joe@football.example.com;
+      h=Received : From : To : Subject : Date : Message-ID;
+      bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
+      b=AuUoFEfDxTDkHlLXSZEpZj79LICEps6eda7W3deTVFOk4yAUoqOB
+        4nujc7YopdG5dWLSdNg6xNAZpOPr+kHxt1IrE+NahM6L/LbvaHut
+        KVdkLLkpVaVVQPzeRDI009SO2Il5Lu7rDNH6mZckBdrIx0orEtZV
+        4bmp/YzhwvcubU4=;
+
+Hi.
+
+We lost the game. Are you hungry yet?
+
+Joe.
+  eos
+
+  class InterceptorTest < MiniTest::Unit::TestCase
+    def setup
+      @original_options = Dkim.options.dup
+
+      mail = EXAMPLEEMAIL.dup
+
+      @mail = Mail.new(mail)
+    end
+
+    def teardown
+      Dkim.options = @original_options
+    end
+
+    def test_header_with_relaxed
+      Dkim.header_canonicalization = 'relaxed'
+      Dkim.body_canonicalization = 'relaxed'
+      Dkim.signing_algorithm = 'rsa-sha256'
+      Interceptor.delivering_email(@mail)
+      dkim_header = @mail['DKIM-Signature']
+
+      assert dkim_header
+      assert_includes dkim_header.to_s, 'rsa-sha256'
+      assert_includes dkim_header.to_s, 's=brisbane'
+      assert_includes dkim_header.to_s, 'd=example.com'
+      assert_includes dkim_header.to_s, 'c=relaxed/relaxed'
+      assert_includes dkim_header.to_s, 'q=dns/txt'
+      assert_includes dkim_header.to_s, 'bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8='
+
+      # TODO: double check signing of 'b' header
+    end
+
+    def test_header_with_simple
+      Dkim.header_canonicalization = 'simple'
+      Dkim.body_canonicalization = 'simple'
+      Dkim.signing_algorithm = 'rsa-sha256'
+      Interceptor.delivering_email(@mail)
+      dkim_header = @mail['DKIM-Signature']
+      assert dkim_header
+      assert_includes dkim_header.to_s, 'rsa-sha256'
+      assert_includes dkim_header.to_s, 's=brisbane'
+      assert_includes dkim_header.to_s, 'd=example.com'
+      assert_includes dkim_header.to_s, 'c=simple/simple'
+      assert_includes dkim_header.to_s, 'q=dns/txt'
+      assert_includes dkim_header.to_s, 'bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8='
+
+      # TODO: double check signing of 'b' header
+    end
+
+    def test_strips_exsting_headers
+      warnings = ""
+      klass = Class.new(Interceptor)
+      klass.class.send(:define_method, :warn) do |message|
+        warnings << message << "\n"
+      end
+      @mail = Mail.new(SIGNEDMAIL)
+
+      assert_equal 2, @mail.header.fields.count { |field| field.name =~ /^DKIM-Signature$/i }
+      assert_equal 2, @mail.encoded.scan('DKIM-Signature').count
+
+      klass.delivering_email(@mail)
+
+      # should give a warning
+      assert_includes warnings, 'Interceptor'
+
+      assert_equal 1, @mail.header.fields.count { |field| field.name =~ /^DKIM-Signature$/i }
+      assert_equal 1, @mail.encoded.scan('DKIM-Signature').count
+    end
+  end
+end
+

data/test/dkim/options_test.rb

@@ -0,0 +1,37 @@
+module Dkim
+  class OptionsTest < MiniTest::Unit::TestCase
+    def setup
+      klass = Class.new
+      klass.send :include, Options
+      @options = klass.new
+    end
+    def test_defaults_empty
+      assert_equal({}, @options.options)
+    end
+
+    def test_all_options
+      @options.signing_algorithm = 'abc123'
+      assert_equal({:signing_algorithm => 'abc123'}, @options.options)
+
+      desired_options = {
+        :signing_algorithm => 'abc123',
+        :signable_headers => [],
+        :domain => 'example.net',
+        :selector => 'selector',
+        :time => 'time',
+        :header_canonicalization => 'simple',
+        :body_canonicalization => 'simple'
+      }
+
+      desired_options.each do |key, value|
+        @options.send("#{key}=", value)
+      end
+
+      assert_equal(desired_options, @options.options)
+
+      desired_options.each do |key, value|
+        assert_equal value, @options.send("#{key}")
+      end
+    end
+  end
+end

data/test/dkim/signed_mail_test.rb

@@ -0,0 +1,66 @@
+
+require 'test_helper'
+
+module Dkim
+  class SignedMailTest < MiniTest::Unit::TestCase
+    def setup
+      @mail = EXAMPLEEMAIL.dup
+    end
+
+    def test_defaults
+      signed_mail = SignedMail.new(@mail, :time => Time.at(1234567890))
+      dkim_header = signed_mail.dkim_header
+
+      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']
+
+      # 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']
+    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
+
+      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']
+    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
+
+        assert_equal body_hash, dkim_header['bh']
+      end
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -1,9 +1,9 @@
 
-require 'test/unit'
+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 +23,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dkim
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-10 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies: []
 description: gem for adding DKIM signatures to email messages
 email:
@@ -20,8 +20,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - bin/dkimsign.rb
@@ -33,10 +35,15 @@ files:
 - lib/dkim/header.rb
 - lib/dkim/header_list.rb
 - lib/dkim/interceptor.rb
+- lib/dkim/options.rb
 - lib/dkim/signed_mail.rb
 - lib/dkim/version.rb
 - lib/mail/dkim_field.rb
-- test/canonicalization_test.rb
+- test/dkim/canonicalization_test.rb
+- test/dkim/dkim_header_test.rb
+- test/dkim/interceptor_test.rb
+- test/dkim/options_test.rb
+- test/dkim/signed_mail_test.rb
 - test/test_helper.rb
 homepage: https://github.com/jhawthorn/dkim
 licenses: []
@@ -50,18 +57,28 @@ 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.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: DKIM library in ruby
 test_files:
-- test/canonicalization_test.rb
+- test/dkim/canonicalization_test.rb
+- test/dkim/dkim_header_test.rb
+- test/dkim/interceptor_test.rb
+- test/dkim/options_test.rb
+- test/dkim/signed_mail_test.rb
 - test/test_helper.rb

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
-