dkimverify 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac5d9f13f3025786b6a19e4bd8e6147ca6adbcd8
-  data.tar.gz: 461833996fc77a81882190b1011f1355764e5d5c
+  metadata.gz: 0a30e99530c7485db52e9583ad67b4565b22eadd
+  data.tar.gz: 0876d9ad6008badfc29bf3c05057b2894af84771
 SHA512:
-  metadata.gz: 145a1d41927294da41a5d61ef1e8bdbb631f3fa4ef9e5860e49e1eabf060b66aa3e394c521c55939b79bbb7d2cf3396bbe81a9f88251d7fb3b14d436ecbe3dfa
-  data.tar.gz: a6822d5f82d8fb5e43ec6078db1d6d67ef05a4f83cc2c07dcc834afb7184456f25f2e34e51544d1e35fcc2bfdac65e490d21df20a61df9bfa334721c23c095c3
+  metadata.gz: a4334b8fb2321ca976c25911447d1f95e3fd2fd7752640f93aa0c19f6622dde2c6d6da27e00ef75cdc3a9089e159d8f1df3d94e6eb4f8171b4333475d28aa574
+  data.tar.gz: 1819a0bef43d2aa4c95e2f69f4c3ec2b037d9c7a85eb6efe14b0bcbda6ab9257f8fcc2b5e0391df41053ef10e84e8a856edb21631ac947bc8f1a2d471cf95ab3

data/README.md

@@ -5,7 +5,7 @@ a gem for verifying DKIM signatures in Ruby
 
 this gem does not sign mail messages (but a PR to enable it would likely be accepted, I just have no use for it.)
 
-**this gem doesn't work right yet!!!**
+I'm pretty sure this actually works and I'm using it in production.
 
 how to use
 -----------
@@ -17,16 +17,10 @@ the `verify!` method will return:
 - `false` if no signature is present, and,
 - raise `Dkim::DkimError` (or a child error) if the signature is present but does not verify.
 
-loading emails from a string is not yet implemented, but would be really easy (send me a PR!)
-
-
-
-
 with a debt of gratitude to:
 ----------------------------
 
-  - [pydkim](https://github.com/ghewgill/pydkim) by @ghewgill which I used as a reference implementation
-  - [mail](https://github.com/mikel/mail) by @mikel
+  - [pydkim](https://github.com/ghewgill/pydkim) by @ghewgill which I used as a more-or-less literal source of translation
   - [carsonreinke's fork of the jhawthorne's dkim gem](https://github.com/carsonreinke/dkim/tree/feature_verification) which I wish I had found before I started this.
   - [rfc6376 authors](https://tools.ietf.org/html/rfc6376)
 
@@ -36,11 +30,10 @@ checking expiration dates (x=, t=)
 accounting for length limits (l= tag)
 tests (which I really ought to add)
 checking multiple dkim signature header lines (probably easy)
-dealing with the "simple" canonicalization method (because I need to strip out the `mail` gem and instead write my own RFC822 parser that is better for maintaining the exact original string)
 
 by
 --
 
-Jeremy B. Merrill  
-The New York Times  
-January 2017  
+Jeremy B. Merrill
+The New York Times
+April 2017

data/dkimverify.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "dkimverify"
-  gem.version       = '0.0.4'
+  gem.version       = '0.0.6'
   gem.authors       = ["Jeremy B. Merrill"]
   gem.license       = "MIT"
   gem.email         = ["jeremybmerrill@gmail.com"]
@@ -10,7 +10,6 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{ A pure-Ruby library for validating/verifying DKIM signatures. }
   gem.homepage      = "https://github.com/jeremybmerrill/dkimverify"
   gem.files         = `git ls-files`.split($/)
-  gem.require_paths = ["dkim-query", "."]
-  gem.add_dependency "mail", "2.6.4"
+  gem.require_paths = ["."]
   gem.add_dependency "parslet", "~> 1.6"
 end

data/dkimverify.rb

@@ -5,12 +5,72 @@ require 'resolv'
 
 # TODO make this an option somehow
 $debuglog = nil #STDERR # nil # alternatively, set this to `STDERR` to log to stdout.
-require 'mail'
 
 module Mail
-    class Header
-        def first_field(name)
-            self[name].class == Array ? self[name].first : self[name]
+    class MessageFormatError < StandardError; end
+
+    class HeaderHash < Hash
+        def get(header_name)
+            self[get_name(header_name)]
+        end
+
+        def get_name(header_name)
+            keys.find{|k| k.downcase == header_name.downcase }
+        end
+    end
+
+    class Message
+        def initialize(msg)
+            @raw_message = msg
+            @raw_headers = []
+            @body = nil 
+            @parsed = false
+        end
+
+        def headers
+            self.parse! unless @parsed
+            @headers
+        end
+
+        def body
+            self.parse! unless @parsed
+            @body
+        end
+
+        def parse!
+            """Parse a message in RFC822 format.
+
+            @param message: The message in RFC822 format. Either CRLF or LF is an accepted line separator.
+
+            @return Returns a tuple of (headers, body) where headers is a list of (name, value) pairs.
+            The body is a CRLF-separated string.
+
+            """
+
+            lines = @raw_message.split(/\r?\n/)
+            i = 0
+            while i < lines.size
+                if lines[i].size == 0
+                    # End of headers, return what we have plus the body, excluding the blank line.
+                    i += 1
+                    break
+                end
+                if /[\x09\x20]/.match lines[i][0]
+                    @raw_headers[-1][1] += lines[i]+"\r\n"
+                else
+                    m = /([\x21-\x7e]+?):/.match lines[i]
+                    if m
+                        @raw_headers << [m[1], lines[i][m.end(0)..-1]+"\r\n"]
+                    elsif lines[i].start_with?("From ")
+                        
+                    else
+                        raise MessageFormatError.new("Unexpected characters in RFC822 header: #{lines[i]}")
+                    end
+                end
+                i += 1
+            end
+            @body = lines[i..-1].join("\r\n") + "\r\n"
+            @headers = HeaderHash[*@raw_headers.reverse.flatten(1)]
         end
     end
 end
@@ -35,8 +95,8 @@ module Dkim
     #TODO: what is this kind of key-value string even called?
     def self.parse_header_kv(input_str)
         parsed = {}
-        input_str.split(/\s*;\s*/).each do |key_val| 
-            if m = key_val.match(/(\w+)\s*=\s*(.*)/)
+        input_str.split(/\s*;\s*/m).each do |key_val| 
+            if m = key_val.match(/(\w+)\s*=\s*(.*)/m)
                 parsed[m[1]] = m[2]
             end
         end
@@ -44,17 +104,17 @@ module Dkim
     end
 
     class Verifier
-        def initialize(email_filename)
-            mail = Mail.read(email_filename) # TODO make this `mail` not `@mail`
-            @headers = mail.header
-            @body = mail.body.raw_source
+        def initialize(email_stringy_thing)
+            mail = Mail::Message.new(email_stringy_thing)
+            @headers = mail.headers
+            @body = mail.body
         end
 
 
         def verify!
-            return false if @headers["DKIM-Signature"].nil?
+            return false if @headers.get("DKIM-Signature").nil?
 
-            dkim_signature_str = @headers.first_field("DKIM-Signature").value.to_s
+            dkim_signature_str = @headers.get("DKIM-Signature").to_s
             @dkim_signature = Dkim.parse_header_kv(dkim_signature_str)
             validate_signature! # just checking to make sure we have all the ingredients we need to actually verify the signature
 
@@ -110,7 +170,7 @@ module Dkim
         def figure_out_canonicalization_methods!
             c_match = @dkim_signature['c'].match(/(\w+)(?:\/(\w+))?$/)
             if not c_match
-              puts "can't figure out canonicalization ('c=')"
+              $debuglog.puts "can't figure out canonicalization ('c=')"
               return false
             end
             @how_to_canonicalize_headers = c_match[1]
@@ -142,20 +202,15 @@ module Dkim
             $debuglog.puts "header_fields_to_include: #{header_fields_to_include}" unless $debuglog.nil?
             canonicalized_headers = []
             header_fields_to_include_with_values = header_fields_to_include.map do |header_name|                                
-                puts @headers.first_field(header_name).inspect
-                [header_name, (hstr = @headers.first_field(header_name).instance_variable_get("@raw_value")).nil? ? '' : hstr.split(":")[1..-1].join(":") ] 
-                # .value and .instance_eval { unfold(split(@raw_value)[1]) } return subtly different values
-                # if the value of the Date header is a date with a single-digit day.
-                # see https://github.com/mikel/mail/issues/1075
-                # incidentally, .instance_variable_get("@value") gives a third subtly different value in a way that I don't understand.
+                header_val = (hstr = @headers.get(header_name)).nil? ? '' : hstr #.split(":")[1..-1].join(":")
+                [header_name, header_val ] 
             end
             canonicalized_headers = Dkim.canonicalize_headers(header_fields_to_include_with_values, @how_to_canonicalize_headers)
-            puts @headers.first_field("DKIM-Signature").inspect
 
             canonicalized_headers += Dkim.canonicalize_headers([
                 [
-                    @headers.first_field("DKIM-Signature").name.to_s, 
-                    @headers.first_field("DKIM-Signature").value.to_s.split(@dkim_signature['b']).join('')
+                    @headers.get_name("DKIM-Signature").to_s, 
+                    @headers.get("DKIM-Signature").to_s.split(@dkim_signature['b']).join('')
                 ]
             ], @how_to_canonicalize_headers).map{|x| [x[0], x[1].rstrip()] }
 
@@ -272,12 +327,12 @@ module Dkim
 end
 
 if __FILE__ == $0
-    emlfn = ARGV[0] || "/Users/204434/code/stevedore-uploader-internal/inputs/podesta-part36/59250.eml"
+    eml = ARGF.read
     begin
-        ret = Dkim::Verifier.new(emlfn).verify!
+        ret = Dkim::Verifier.new(eml).verify!
     rescue Dkim::DkimPermFail
-        puts "uh oh, something went wrong, the signature did not verify correctly"
+        STDERR.puts "uh oh, something went wrong, the signature did not verify correctly"
         exit 1
     end
-    puts ret ? "DKIM signature verified correctly" : "DKIM signature absent"
+    STDERR.puts ret ? "DKIM signature verified correctly" : "DKIM signature absent"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dkimverify
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Jeremy B. Merrill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mail
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.4
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +44,6 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- dkim-query
 - "."
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
@@ -72,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A pure-Ruby library for validating/verifying DKIM signatures.