spf-query 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a959789345d1c370b28b097cec96f35fc7507a44
+  data.tar.gz: 80505a4705b60f9baea7ed1c53c19b0527864e35
+SHA512:
+  metadata.gz: fcf7ff0d96a794fbd894a5a2624ff3e30ed8c777f7deb1c7ee8e3d24c51e1df3b0a08c2f362c3eab1ce9ed38ba41af51d478bbd4e888c1534341705e85987615
+  data.tar.gz: d6c48a1958219e3c735b476884612017745a50a12492035fe91ee636b9f7d0b9442e695dfc2a39069ae21f8f0dbeb2abe66b0ffbf2eba9d34f719c62820848bc

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,18 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0
+- 2.1
+- ruby-head
+- jruby-19mode
+- jruby-head
+- rbx-2
+matrix:
+  allow_failures:
+  - rvm: rbx-2
+addons:
+  code_climate:
+    repo_token: 7ea441f6db20b42bf77b3d49f149f2fd683b58d714a1a2bc148820e963c77862
+notifications:
+  slack:
+    secure: Z4Wgg8oVW8i20USH3GKfNB9pFR2tmL9a/Pg42Ck/cHNmBO+3UUDcfr7O1oOCrZEYcpobB+7rhLVHt3H0cSwXNDanpsDebi0ZcNHllSK7xDVLR1r0l6QHY15kCKMVIprrDgxCn80ANCE0Yb1x2V+cvZyNJAau6jTLgRmvUZ0oD1Y=

data/ChangeLog.md

@@ -0,0 +1,6 @@
+### 0.1.0 / 2015-07-01
+
+* Initial release:
+  * Queries and parses SPF records.
+  * Supports querying both TXT and SPF records.
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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/README.md

@@ -0,0 +1,75 @@
+# spf-query
+
+[![Code Climate](https://codeclimate.com/github/trailofbits/spf-query/badges/gpa.svg)](https://codeclimate.com/github/trailofbits/spf-query)
+[![Test Coverage](https://codeclimate.com/github/trailofbits/spf-query/badges/coverage.svg)](https://codeclimate.com/github/trailofbits/spf-query)
+[![Build Status](https://travis-ci.org/trailofbits/spf-query.svg)](https://travis-ci.org/trailofbits/spf-query)
+
+The `spf-query` 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'.
+
+## Features
+
+* Queries and parses SPF records.
+* Supports querying both TXT and SPF records.
+
+## Examples
+
+    require 'spf/query'
+    
+    SPF::Query::Record.query('twitter.com')
+    # => #<SPF::Query::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>
+
+    SPF::Query::Record.parse("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")
+    # => #<SPF::Query::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>
+        
+
+## Symopsis
+
+Query a domain:
+
+    spf-query 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
+    ____________________________
+
+
+Query multiple domains:
+
+    spf-query 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
+    ____________________________
+
+## Requirements
+
+* [ruby] >= 1.9.1
+* [parslet] ~> 1.0
+
+## Install
+
+    $ gem install spf-query
+
+## License
+
+See the {file:LICENSE.txt} file.
+
+[ruby]: https://www.ruby-lang.org/
+[parslet]: http://kschiess.github.io/parslet/
+[SPF]: https://tools.ietf.org/html/rfc7208

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-query

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path('../../lib',__FILE__)
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'spf/query'
+
+unless ARGV[0]
+  puts "Please supply at least one host name"
+  exit
+end
+
+ARGV.each do |arg|
+  puts "____________________________\n"
+  puts "SPF record search for #{arg}"
+
+  if (spf = SPFParse::Record.query(arg))
+    puts "  - found SPF record for #{arg}"
+    puts "    v=#{spf.version}"
+
+    spf.each do |rule|
+      puts "    #{rule}"
+    end
+  else
+    puts "  - no SPF record found for #{arg}"
+  end
+  puts "____________________________\n\n"
+end

data/lib/resolv/dns/resource/in/spf.rb

@@ -0,0 +1,9 @@
+require 'resolv'
+
+class Resolv::DNS::Resource::IN::SPF < Resolv::DNS::Resource::IN::TXT
+  # resolv.rb doesn't define an SPF resource type.
+  TypeValue = 99
+  ClassValue = Resolv::DNS::Resource::IN::ClassValue
+
+  Resolv::DNS::Resource::ClassHash[[TypeValue, ClassValue]] = self
+end

data/lib/spf/query.rb

@@ -0,0 +1,3 @@
+require "spf/query/query"
+require "spf/query/record"
+require "spf/query/version"

data/lib/spf/query/exceptions.rb

@@ -0,0 +1,8 @@
+require 'parslet'
+
+module SPF
+  module Query
+    class InvalidRecord < Parslet::ParseFailed
+    end
+  end
+end

data/lib/spf/query/ip.rb

@@ -0,0 +1,22 @@
+module SPF
+  module Query
+    class IP
+
+      attr_reader :address
+
+      attr_reader :cidr_length
+
+      def initialize(address,cidr_length=nil)
+        @address     = address
+        @cidr_length = cidr_length
+      end
+
+      def to_s
+        if @cidr_length then "#{@address}/#{@cidr_length}"
+        else                 "#{@address}"
+        end
+      end
+
+    end
+  end
+end

data/lib/spf/query/macro.rb

@@ -0,0 +1,28 @@
+module SPF
+  module Query
+    class Macro
+
+      attr_reader :letter
+
+      attr_reader :digits
+
+      attr_reader :delimiters
+
+      def initialize(letter,options={})
+        @letter     = letter
+        @digits     = options[:digits]
+        @reverse    = options[:reverse]
+        @delimiters = Array(options[:delimiters])
+      end
+
+      def reverse?
+        @reverse
+      end
+
+      def to_s
+        "%{#{@letter}#{@digits}#{@delimiters.join}}"
+      end
+
+    end
+  end
+end

data/lib/spf/query/macro_string.rb

@@ -0,0 +1,25 @@
+module SPF
+  module Query
+    class MacroString
+
+      include Enumerable
+
+      def initialize(elements)
+        @elements = elements
+      end
+
+      def each(&block)
+        @elements.each(&block)
+      end
+
+      def [](*arguments)
+        @elements[*arguments]
+      end
+
+      def to_s
+        @elements.join
+      end
+
+    end
+  end
+end

data/lib/spf/query/mechanism.rb

@@ -0,0 +1,52 @@
+module SPF
+  module Query
+    class Mechanism
+
+      QUALIFIERS = {
+        '+' => :pass,
+        '-' => :fail,
+        '~' => :soft_fail,
+        '?' => :neuatral
+      }
+
+      attr_reader :name
+      
+      attr_reader :value
+
+      def initialize(name,options={})
+        @name = name
+
+        @value     = options[:value]
+        @qualifier = options[:qualifier]
+      end
+
+      def qualifier
+        @qualifier || :pass
+      end
+
+      def pass?
+        @qualifier == :pass || @qualifier.nil?
+      end
+
+      def fail?
+        @qualifier == :fail
+      end
+
+      def soft_fail?
+        @qualifier == :soft_fail
+      end
+
+      def neutral?
+        @qualifier == :neutral
+      end
+
+      def to_s
+        str = "#{QUALIFIERS.invert[@qualifier]}#{@name}"
+        str << ":#{@value}" if value
+
+        return str
+      end
+
+    end
+  end
+end

data/lib/spf/query/modifier.rb

@@ -0,0 +1,24 @@
+module SPF
+  module Query
+    class Modifier
+
+      attr_reader :name
+
+      attr_reader :value
+
+      def initialize(name,value=nil)
+        @name, @value = name, value
+      end
+
+      def to_s
+        if @value then "#{@name}=#{@value}"
+        else           "#{@name}"
+        end
+      end
+
+    end
+
+    class UnknownModifier < Modifier
+    end
+  end
+end