dkim 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dkim.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/dkimsign.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+
+if ARGV.length != 2 && ARGV.length != 3
+  puts "Usage: dkimsign.rb SELECTOR KEYFILE [MAILFILE]"
+  exit 0
+end
+
+require 'dkim'
+
+selector, keyfile,mailfile = ARGV
+
+keyfile  = File.open(keyfile)
+mailfile = mailfile ? File.open(mailfile) : STDIN
+
+mail = mailfile.read.gsub(/\r?\n/, "\r\n")
+key  = keyfile.read
+
+Dkim::selector    = selector
+Dkim::private_key = key
+
+print Dkim::SignedMail.new(mail).to_s
+
+

data/dkim.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dkim/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dkim"
+  s.version     = Dkim::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Hawthorn"]
+  s.email       = ["john.hawthorn@gmail.com"]
+  s.homepage    = "https://github.com/jhawthorn/dkim"
+  s.summary     = %q{DKIM library in ruby}
+  s.description = %q{gem for adding DKIM signatures to email messages}
+
+  s.rubyforge_project = "dkim"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/dkim.rb

@@ -0,0 +1,34 @@
+
+require 'dkim/header'
+require 'dkim/header_list'
+require 'dkim/body'
+require 'dkim/signed_mail'
+
+module Dkim
+  DefaultHeaders = %w{
+    From Sender Reply-To Subject Date
+    Message-ID To Cc MIME-Version
+    Content-Type Content-Transfer-Encoding Content-ID Content-Description
+    Resent-Date Resent-From Resent-Sender Resent-To Resent-cc
+    Resent-Message-ID
+    In-Reply-To References
+    List-Id List-Help List-Unsubscribe List-Subscribe
+    List-Post List-Owner List-Archive}
+
+  class << self
+    attr_accessor :signing_algorithm, :signable_headers, :domain, :selector
+
+    attr_reader :private_key
+    def private_key= key
+      key = OpenSSL::PKey::RSA.new(key) if key.is_a?(String)
+      @private_key = key
+    end
+  end
+end
+
+Dkim::signable_headers  = Dkim::DefaultHeaders
+Dkim::domain            = nil
+Dkim::selector          = nil
+Dkim::signing_algorithm = 'rsa-sha256'
+Dkim::private_key       = nil
+

data/lib/dkim/body.rb

@@ -0,0 +1,20 @@
+module Dkim
+  class Body < Struct.new(:body)
+    def to_canonical
+      body = self.body.dup
+
+      # Ignores all whitespace at the end of lines.  Implementations MUST NOT remove the CRLF at the end of the line.
+      body.gsub!(/[ \t]+(?=\r\n|\z)/, '')
+
+      # Reduces all sequences of WSP within a line to a single SP character.
+      body.gsub!(/[ \t]+/, ' ')
+
+      # Ignores all empty lines at the end of the message body.
+      body.gsub!(/(\r?\n)*\z/, '')
+      body += "\r\n"
+    end
+    def to_s
+      self.body.dup
+    end
+  end
+end

data/lib/dkim/header.rb

@@ -0,0 +1,29 @@
+module Dkim
+  class Header < Struct.new(:key, :value)
+    def to_canonical
+      key    = self.key.dup
+      value  = self.value.dup
+
+      #Convert all header field names (not the header field values) to lowercase.  For example, convert "SUBJect: AbC" to "subject: AbC".
+      key.downcase!
+
+      # Unfold all header field continuation lines as described in [RFC2822]
+      value.gsub!(/\r?\n[ \t]+/, ' ')
+
+      # Convert all sequences of one or more WSP characters to a single SP character.
+      value.gsub!(/[ \t]+/, ' ')
+
+      # Delete all WSP characters at the end of each unfolded header field value.
+      value.gsub!(/[ \t]*\z/, '')
+      
+      # Delete any WSP characters remaining before and after the colon separating the header field name from the header field value.
+      value.gsub!(/\A[ \t]*/, '')
+      key.gsub!(/[ \t]*\z/, '')
+
+      "#{key}:#{value}"
+    end
+    def to_s
+      "#{key}:#{value}"
+    end
+  end
+end

data/lib/dkim/header_list.rb

@@ -0,0 +1,19 @@
+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.key == key
+      end
+    end
+    def each(&block)
+      @headers.each(&block)
+    end
+  end
+end

data/lib/dkim/signed_mail.rb

@@ -0,0 +1,112 @@
+require 'openssl'
+require 'base64'
+
+module Dkim
+  class SignedMail
+    EMAIL_REGEX = /[A-Z0-9._%+-]+@([A-Z0-9.-]+\.[A-Z]{2,6})/i
+
+    def initialize message, options={}
+      message = message.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]
+    end
+
+    # options for signatures
+    attr_writer :signing_algorithm, :signable_headers, :domain, :selector, :time
+
+    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 || (@headers['From'].value =~ EMAIL_REGEX && $1)
+    end
+    def selector
+      @selector || Dkim::selector
+    end
+    def time
+      @time ||= Time.now
+    end
+
+    def signed_headers
+      (@headers.map(&:key) & signable_headers).sort
+    end
+    def dkim_header_values(b)
+      [
+        'v',  1,
+        'a',  signing_algorithm,
+        'c',  'relaxed/relaxed',
+        'd',  domain,
+        'q',  'dns/txt',
+        's',  selector,
+        't',  time.to_i,
+        'bh', body_hash,
+        'h',  signed_headers.join(':'),
+        'b',  b
+      ]
+    end
+    def dkim_header(b=nil)
+      b ||= header_signature
+      v = dkim_header_values(b).each_slice(2).map do |(key, value)|
+        "#{key}=#{value}"
+      end.join('; ')
+      Header.new('DKIM-Signature', v)
+    end
+    def canonical_header
+      headers = signed_headers.map do |key|
+        @headers[key]
+      end
+      headers << dkim_header('')
+      headers.map(&:to_canonical).join("\r\n")
+    end
+    def canonical_body
+      @body.to_canonical
+    end
+
+    def header_signature
+      base64_encode private_key.sign(digest_alg, canonical_header)
+    end
+    def body_hash
+      base64_encode digest_alg.digest(canonical_body)
+    end
+    def to_s
+      headers = @headers.to_a + [dkim_header]
+      headers.map(&:to_s).join("\r\n") +
+        "\r\n\r\n" +
+        @body.to_s
+    end
+
+    private
+    def base64_encode data
+      Base64.encode64(data).gsub("\n",'')
+    end
+    def digest_alg
+      case signing_algorithm
+      when 'rsa-sha1'
+        OpenSSL::Digest::SHA1.new
+      when 'rsa-sha256' 
+        OpenSSL::Digest::SHA256.new
+      else
+        raise "Unknown digest algorithm: '#{signing_algorithm}'"
+      end
+    end
+  end
+end
+

data/lib/dkim/version.rb

@@ -0,0 +1,3 @@
+module Dkim
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: dkim
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Hawthorn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-10 00:00:00 Z
+dependencies: []
+
+description: gem for adding DKIM signatures to email messages
+email: 
+- john.hawthorn@gmail.com
+executables: 
+- dkimsign.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/dkimsign.rb
+- dkim.gemspec
+- lib/dkim.rb
+- lib/dkim/body.rb
+- lib/dkim/header.rb
+- lib/dkim/header_list.rb
+- lib/dkim/signed_mail.rb
+- lib/dkim/version.rb
+homepage: https://github.com/jhawthorn/dkim
+licenses: []
+
+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.1
+signing_key: 
+specification_version: 3
+summary: DKIM library in ruby
+test_files: []
+