spf_parse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 747139ef2f19abff4a5678df8442085b6c4887c9
+  data.tar.gz: c7287ea92191bc32566118862f5446b385023dbc
+SHA512:
+  metadata.gz: 6b7f5d54159e5f133d6ca00b1a8944a1f3b5372b67cd32a6216e2f7f720e880c13e0c02b15c68938de182c6d9d6989e0280470f2954c223893721b9f849800ba
+  data.tar.gz: f57ea5e6d432ef69b83fb4497a2d7498a4d675ab02fbfe0e2f7bebf2f9e41e0ff607fc07a009ee3479b4b7ca1aaf35387dc5edd2b08ed075b673405ba1bea0d3

data/.gitignore

@@ -0,0 +1,57 @@
+<<<<<<< HEAD
+<<<<<<< HEAD
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+=======
+=======
+>>>>>>> fed1141939dbe709d44dedb0247d31908300c31f
+*.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
+<<<<<<< HEAD
+>>>>>>> 62c17ee30b1a7d25ef12fab39fd6c2de0bcbadbc
+=======
+>>>>>>> fed1141939dbe709d44dedb0247d31908300c31f

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: e649f3a8e0e9e03d26febcff08fce5d76d831ab9ee5d02a06b83bab7180c0587

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+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

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Trail of Bits
+
+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/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,57 @@
+# spf_parse
+
+[![Code Climate](https://codeclimate.com/github/trailofbits/spf_parse.png)](https://codeclimate.com/github/trailofbits/spf_parse) [![Build Status](https://travis-ci.org/trailofbits/spf_parse.svg)](https://travis-ci.org/trailofbits/spf_parse)
+[![Test Coverage](https://codeclimate.com/github/trailofbits/spf_parse/badges/coverage.svg)](https://codeclimate.com/github/trailofbits/spf_parse)
+
+The `spf_parse` library searches the spf records for a host. We assume the host uses standard spf 'selectors', and also check if they use their own 'selector'.
+
+## Examples
+
+###CLI
+___
+-use a single domain
+
+    spf google.com
+    ____________________________
+    SPF record search for google.com
+      - found SPF record for google.com at google.com:
+      v=spf1 include:_spf.google.com ip4:216.73.93.70/31 ip4:216.73.93.72/31 ~all
+    ____________________________
+
+
+-or a bunch in a row
+
+    spf trailofbits.com facebook.com yahoo.com
+    ____________________________
+    SPF record search for trailofbits.com
+      - found SPF record for trailofbits.com at trailofbits.com:
+      v=spf1 include:_spf.google.com ~all
+    ____________________________
+
+    ____________________________
+    SPF record search for facebook.com
+      - found SPF record for facebook.com at facebook.com:
+      v=spf1 redirect=_spf.facebook.com
+    ____________________________
+
+    ____________________________
+    SPF record search for yahoo.com
+      - found SPF record for yahoo.com at yahoo.com:
+      v=spf1 redirect=_spf.mail.yahoo.com
+    ____________________________
+
+###In a project
+___
+    require 'spf_parse'
+    
+    SpfParse.check_host('twitter.com')
+     => {:record=>"v=spf1 ip4:199.16.156.0/22 ip4:199.59.148.0/22 ip4:8.25.194.0/23 ip4:8.25.196.0/23 ip4:204.92.114.203 ip4:204.92.114.204/31 ip4:107.20.52.15 ip4:23.21.83.90 include:_spf.google.com include:_thirdparty.twitter.com -all", :record_path=>"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/spf

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'spf_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 "SPF record search for #{arg}"
+  begin
+    spf = SpfParse.check_host(arg, resolver)
+  rescue
+    puts "  -error: could not process input :#{arg}"
+    puts "____________________________\n\n"
+    next
+  end
+  
+  if spf
+    puts "  - found SPF record for #{arg} at #{spf[:record_path]}:\n  #{spf[:record]}"
+  else
+    puts "  - no SPF record found for #{arg}"
+  end
+  puts "____________________________\n\n"
+end

data/lib/spf_parse/version.rb

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

data/lib/spf_parse.rb

@@ -0,0 +1,25 @@
+require "spf_parse/version"
+require 'resolv'
+
+module SpfParse
+  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
+    paths = [host, "_spf.#{host}"]
+    spf = nil
+    paths.each do |path|
+      begin
+        spf = resolver.getresource(path, Resolv::DNS::Resource::IN::TXT).strings.join
+        if spf.index('v=spf1')
+          spf = {:record =>spf, :record_path=>path}
+          break
+        end
+      rescue Resolv::ResolvError
+      end
+    end
+    spf
+  end  
+end

data/spec/spec_helper.rb

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

data/spec/spf_parse_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'spf_parse'
+
+describe SpfParse do
+  describe "spf" do
+    context "when given a domain which we know to have a SPF record" do
+      let(:domain) { 'trailofbits.com' }
+
+      it "should return a hash containing the SPF record and path where it was found" do
+        spf = SpfParse.check_host(domain)
+
+        expect(spf).to be_kind_of(Hash)
+        expect(spf[:record_path]).to ( eq("#{domain}") || eq("_spf.#{domain}") )
+        puts "  - record path: #{spf[:record_path]}"
+        puts "  - record: #{spf[:record]}"
+      end
+    end
+
+    context "when given a domain which does not have a SPF record" do
+      let(:domain) { 'fsho.trailofbits.com' }
+
+      it "should return nil" do
+        spf = SpfParse.check_host(domain)
+        expect(spf).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 {
+          SpfParse.check_host('qwerty')
+        }.to raise_error
+      end
+    end
+  end
+end

data/spf_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 'spf_parse/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spf_parse"
+  gem.version       = SpfParse::VERSION
+  gem.authors       = ["nicktitle"]
+  gem.email         = ["nick.esposito@trailofbits.com"]
+  gem.summary       = %q{SPF Retriever and Parser}
+  gem.description   = %q{Search and retrieve SPF records for any number of hosts}
+  gem.homepage      = "https://github.com/trailofbits/spf_parse#readme"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = ['spf']
+  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

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: spf_parse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+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 SPF records for any number of hosts
+email:
+- nick.esposito@trailofbits.com
+executables:
+- spf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/spf
+- lib/spf_parse.rb
+- lib/spf_parse/version.rb
+- spec/spec_helper.rb
+- spec/spf_parse_spec.rb
+- spf_parse.gemspec
+homepage: https://github.com/trailofbits/spf_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: SPF Retriever and Parser
+test_files:
+- spec/spec_helper.rb
+- spec/spf_parse_spec.rb
+has_rdoc: