dkim_parse 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04456cd9e24e379e17f7200728a4b18a1a4b3744
+  data.tar.gz: e311913cfc2a4f8a6160a3211b04559e11eab7a8
+SHA512:
+  metadata.gz: 7ba2b7ec2022277d4c14df556a8245aeacf89dfeb5560e7f43f7d336d58ee1cc6c0853d0660f085ea8f52cdd425b8e9213cf144eb109ff62dcd12408ae757c77
+  data.tar.gz: e86957e60fc477117fde585988ac573f7df406f8a0c80c9ea04c9aaa43c09f2c377fa28d2d6976f9159ac2d3a4310f5bf6033240e12624bc83a6ef7e1a6a4bba

data/.gitignore

@@ -0,0 +1,51 @@
+<<<<<<< HEAD
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+=======
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+>>>>>>> 62c17ee30b1a7d25ef12fab39fd6c2de0bcbadbc

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+   - rvm: rbx-2
+addons:
+  code_climate:
+    repo_token: 2dbc736868e35e0966df5712c4ac70df10e86a3e8d0d85878a3cbd57b7b086b3

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dkim_parse.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec', '~> 3.0'
+
+  gem 'yard', '~> 0.8'
+end
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 nickespo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# dkim_parse
+
+[![Code Climate](https://codeclimate.com/github/trailofbits/dkim_parse.png)](https://codeclimate.com/github/trailofbits/dkim_parse) [![Build Status](https://travis-ci.org/trailofbits/dkim_parse.svg)](https://travis-ci.org/trailofbits/dkim_parse)
+[![Test Coverage](https://codeclimate.com/github/trailofbits/dkim_parse/badges/coverage.svg)](https://codeclimate.com/github/trailofbits/dkim_parse)
+
+The `dkim_parse` library searches the dkim records for a host. We assume the host uses standard dkim 'selectors', and also check if they use their own 'selector'.
+
+## Examples
+
+###CLI
+___
+-use a single domain
+
+    dkim google.com
+    ____________________________
+    DKIM record search for google.com
+      - using selectors: ["default", "dkim", "google"]
+      - no DKIM record found for google.com
+    ____________________________
+
+
+-or a bunch in a row
+
+    dkim trailofbits.com facebook.com yahoo.com
+    ____________________________
+    DKIM record search for trailofbits.com
+      - using selectors: ["default", "dkim", "google", "trailofbits"]
+      - found DKIM record for trailofbits.com at trailofbits._domainkey.trailofbits.com:
+      v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCwe04g1hSR55ACcRiLAg0MoEiY5BBviJHJHq/d9r6o+F50fa1TrNNulwKXaST+WCEcW6D2KZ+dt9JvgB9ApIEAFCzHRXhawga0GsfDkOllvpXgT95IPcnYrSkM+rJSbaqHh+YI5sV9sKnvzZDVmB7l5gU3yD74aDmjs9wSg8RC5wIDAQAB
+    ____________________________
+    
+    ____________________________
+    DKIM record search for facebook.com
+      - using selectors: ["default", "dkim", "google", "facebook"]
+      - found DKIM record for facebook.com at default._domainkey.facebook.com:
+      t=y; k=rsa; p=MHwwDQYJKoZIhvcNAQEBBQADawAwaAJhALkZ4wTn2SQ3EW0vVBExi8izmZZnjZH8JIY5Y964jzDORZku43o6ooFq6HLMjBxmcDYOrJFRdcsKDWtI0Be/uLfc/rClXuyEbcENXfadg77HHv35BI85RNy4TKeai3hxoQIDAQAB;
+    ____________________________
+    
+    ____________________________
+    DKIM record search for yahoo.com
+      - using selectors: ["default", "dkim", "google", "yahoo"]
+      - no DKIM record found for yahoo.com
+    ____________________________
+
+###In a project
+___
+
+    require 'dkim_parse'
+    
+    DkimParse.check_host('twitter.com')
+    - using selectors: ["default", "dkim", "google", "twitter"]
+    => {:record=>"v=DKIM1; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrZ6zwKHLkoNpHNyPGwGd8wZoNZOk5buOf8wJwfkSZsNllZs4jTNFQLy6v4Ok9qd46NdeRZWnTAY+lmAAV1nfH6ulBjiRHsdymijqKy/VMZ9Njjdy/+FPnJSm3+tG9Id7zgLxacA1Yis/18V3TCfvJrHAR/a77Dxd65c96UvqP3QIDAQAB", :record_path=>"dkim._domainkey.twitter.com"}
+    
+
+## Install
+
+    rake install
+
+## License
+
+See the {file:LICENSE.txt} file.

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+require 'rake'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/bin/dkim

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'dkim_parse'
+require 'resolv'
+
+unless ARGV[0]
+  puts "Please supply at least one host name"
+  exit
+end
+
+resolver = Resolv::DNS.new
+ARGV.each do |arg|
+
+  puts "____________________________\n"
+  puts "DKIM record search for #{arg}"
+  begin
+    dkim = DkimParse.check_host(arg, resolver)
+  rescue
+    puts "  -error: could not process input :#{arg}"
+    puts "____________________________\n\n"
+    next
+  end
+  
+  if dkim
+    puts "  - found DKIM record for #{arg} at #{dkim[:record_path]}:\n  #{dkim[:record]}"
+  else
+    puts "  - no DKIM record found for #{arg}"
+  end
+  puts "____________________________\n\n"
+end

data/dkim_parse.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dkim_parse/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dkim_parse"
+  gem.version       = DkimParse::VERSION
+  gem.authors       = ["nicktitle"]
+  gem.email         = ["nick.esposito@trailofbits.com"]
+  gem.summary       = %q{DKIM Retriever and Parser}
+  gem.description   = %q{Search and retrieve DKIM records for any number of hosts}
+  gem.homepage      = "https://github.com/trailofbits/dkim_parse#readme"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = ['dkim']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 1.9.1'
+
+  gem.add_development_dependency "bundler", "~> 1.6"
+  gem.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dkim_parse/version.rb

@@ -0,0 +1,3 @@
+module DkimParse
+  VERSION = "0.0.2"
+end

data/lib/dkim_parse.rb

@@ -0,0 +1,27 @@
+require "dkim_parse/version"
+require 'resolv'
+
+module DkimParse
+
+  def self.check_host(host, resolver=Resolv::DNS.new)
+    begin
+      host_without_tld = host[0...host.rindex('.')]
+    rescue
+      raise StandardError.new('host'), "invalid hostname"
+    end
+    defaults = %W[default dkim google #{host_without_tld}]
+    defaults.uniq!
+    puts "  - using selectors: #{defaults}"
+    dkim = nil
+    defaults.each do |selector|
+      record_path = "#{selector}._domainkey.#{host.downcase}"
+      begin
+        dkim = resolver.getresource(record_path, Resolv::DNS::Resource::IN::TXT).strings.join
+        dkim = {:record =>dkim, :record_path=>record_path}
+        break
+      rescue Resolv::ResolvError
+      end
+    end
+    dkim
+  end
+end

data/spec/dkim_parse_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'dkim_parse'
+
+describe DkimParse do
+  describe "dkim" do
+    context "when given a domain which we know to have a DKIM record" do
+      let(:domain) { 'trailofbits.com' }
+
+      it "should return a hash containing the DKIM record and path where it was found" do
+        dkim = DkimParse.check_host(domain)
+
+        expect(dkim).to be_kind_of(Hash)
+        expect(dkim[:record_path]).to eq("trailofbits._domainkey.trailofbits.com")
+        puts "  - record path: #{dkim[:record_path]}"
+        puts "  - record: #{dkim[:record]}"
+      end
+    end
+
+    context "when given a domain which does not have a DKIM record" do
+      let(:domain) { 'fsho.trailofbits.com' }
+
+      it "should return nil" do
+        dkim = DkimParse.check_host(domain)
+        expect(dkim).to eq(nil)
+      end
+    end
+
+    context "when given a bad domain" do
+      it "should raise an error explaining that the domain was malformed" do
+        expect {
+          DkimParse.check_host('qwerty')
+        }.to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'dkim_parse'
+
+include DkimParse
+
+RSpec.configure do |specs|
+  specs
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: dkim_parse
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- nicktitle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Search and retrieve DKIM records for any number of hosts
+email:
+- nick.esposito@trailofbits.com
+executables:
+- dkim
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dkim
+- dkim_parse.gemspec
+- lib/dkim_parse.rb
+- lib/dkim_parse/version.rb
+- spec/dkim_parse_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/trailofbits/dkim_parse#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: DKIM Retriever and Parser
+test_files:
+- spec/dkim_parse_spec.rb
+- spec/spec_helper.rb
+has_rdoc: