dmarc_inspector 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 680a45fb6295300f496488217bbd4b77462b9750
+  data.tar.gz: f56f1396f91cee448a9a1acd837410d4dc4ba4a3
+SHA512:
+  metadata.gz: cdb18b991d57c24590121d75f6f40ea3f6f5076e400a33608ebbe8f02ea2c036693aa14dd33e99d1e5b63e55f95f6bcbf0dd1db6b1d4dec0045589ec798f2be5
+  data.tar.gz: df4fd1a41a9efbfc31572aca53f22b8c85892e8aa3976db18c7a42050b2c0d897ce5ef8c3e385eb82e18eef64890c9ec2915b2d77872589eca87bf3538142258

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rspec

data/.rspec.example

@@ -0,0 +1,4 @@
+--color
+--warnings
+--require spec_helper
+--require pry

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'parslet'
+
+# Specify your gem's dependencies in dmarc_inspector.gemspec
+gemspec
+
+gem 'rspec-core'
+gem 'rspec-expectations'
+gem 'rspec-mocks'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nisanth Chunduru
+
+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,31 @@
+# dmarc_inspector
+
+Looks up DMARC policy of a domain
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmarc_inspector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmarc_inspector
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dmarc_inspector/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/dmarc_inspector.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dmarc_inspector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dmarc_inspector"
+  spec.version       = DMARCInspector::VERSION
+  spec.authors       = ["Nisanth Chunduru"]
+  spec.email         = ["nisanth074@gmail.com"]
+  spec.summary       = "Looks up DMARC policy of a domain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'parslet', '~> 1.6'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency 'rspec-core', '~> 3.0'
+  spec.add_development_dependency 'rspec-expectations', '~> 3.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dmarc_inspector.rb

@@ -0,0 +1,19 @@
+require 'resolv'
+require 'dmarc_inspector/dmarc/record'
+
+class DMARCInspector
+  def initialize(domain)
+    @domain = domain
+  end
+
+  def receiver_policy
+    dmarc_subdomain = "_dmarc.#{@domain}"
+    dns = Resolv::DNS.new
+    dns_resource_data = dns.getresource(dmarc_subdomain, Resolv::DNS::Resource::IN::TXT).data
+
+    record = DMARC::Record.parse(dns_resource_data)
+    record[:p]
+  rescue
+    :none
+  end
+end

data/lib/dmarc_inspector/dmarc/errors.rb

@@ -0,0 +1,6 @@
+class DMARCInspector
+  module DMARC
+    class Error < StandardError; end
+    class InvalidRecord < Error; end
+  end
+end

data/lib/dmarc_inspector/dmarc/parser.rb

@@ -0,0 +1,49 @@
+require 'parslet'
+
+class DMARCInspector
+  module DMARC
+    # Borrowed from 'dmarc' gem
+    class Parser < Parslet::Parser
+      def self.parse(raw)
+        new.parse(raw)
+      end
+
+      def tag_value_pair(tag_definition, value_definition)
+        tag_definition >>
+        wsp? >> str('=') >> wsp? >>
+        value_definition
+      end
+
+      root(:dmarc_record)
+      rule(:dmarc_record) do
+        dmarc_version >>
+        dmarc_sep >> dmarc_request >>
+        # Not bothering about other tags, just need policy tag for now
+        any.repeat
+      end
+
+      rule(:dmarc_version) do
+        tag_value_pair(
+          str('v'),
+          str('DMARC1').as(:v)
+        )
+      end
+
+      rule(:dmarc_sep) { wsp? >> str(';') >> wsp? }
+
+      rule(:dmarc_request) do
+        tag_value_pair(
+          str('p'),
+          (
+            str('none') |
+            str('quarantine') |
+            str('reject')
+          ).as(:p)
+        ) 
+      end
+
+      rule(:wsp) { str(' ') | str("\t") }
+      rule(:wsp?) { wsp.repeat }
+    end
+  end
+end

data/lib/dmarc_inspector/dmarc/record.rb

@@ -0,0 +1,19 @@
+require 'dmarc_inspector/dmarc/parser'
+require 'dmarc_inspector/dmarc/errors'
+
+class DMARCInspector
+  module DMARC
+    class Record
+      def self.parse(raw)
+        begin
+          tree = Parser.parse(raw)
+        rescue Parslet::ParseFailed
+          raise InvalidRecord
+        end
+
+        tree[:p] = tree[:p].to_sym
+        tree
+      end
+    end
+  end
+end

data/lib/dmarc_inspector/version.rb

@@ -0,0 +1,3 @@
+class DMARCInspector
+  VERSION = '0.2.0'
+end

data/spec/dmarc_inspector/dmarc/parser_spec.rb

@@ -0,0 +1,55 @@
+require 'dmarc_inspector/dmarc/parser'
+
+describe DMARCInspector::DMARC::Parser do
+  describe '#dmarc_record' do
+    subject { described_class.new.dmarc_record }
+
+    it 'parses version' do
+      record = 'v=DMARC1; p=reject; sp=none; pct=100; rua=mailto:dmarc-yahoo-rua@yahoo-inc.com, mailto:dmarc_y_rua@yahoo.com;'
+      expect(subject.parse record).to include(v: 'DMARC1')
+    end
+
+    it 'parses policy' do
+      record = 'v=DMARC1; p=none; rua=mailto:mailauth-reports@google.com'
+      expect(subject.parse record).to include(p: 'none')
+    end
+
+    it 'ignores spacing' do
+      record1 = 'v=DMARC1; p=reject; sp=none; pct=100; rua=mailto:dmarc-yahoo-rua@yahoo-inc.com, mailto:dmarc_y_rua@yahoo.com;'
+      record2 = 'v=DMARC1;p=reject;sp=none;pct=100;rua=mailto:dmarc-yahoo-rua@yahoo-inc.com, mailto:dmarc_y_rua@yahoo.com;'
+      expect(subject.parse record1).to include(subject.parse record2)
+    end
+
+    it 'ignores trailing separator' do
+      record1 = 'v=DMARC1; p=none;'
+      record2 = 'v=DMARC1; p=none'
+      expect(subject.parse record1).to eq(v: 'DMARC1', p: 'none')
+      expect(subject.parse record1).to include(subject.parse record2)
+    end
+
+    it 'ignores remaining tags' do
+      record = 'v=DMARC1; p=reject; sp=none; pct=100; rua=mailto:dmarc-yahoo-rua@yahoo-inc.com, mailto:dmarc_y_rua@yahoo.com;'
+      expect(subject.parse record).to eq(v: 'DMARC1', p: 'reject')
+    end
+  end
+
+  describe '#dmarc_request' do
+    subject { described_class.new.dmarc_request }
+
+    it "parses policy 'none'" do
+      expect(subject.parse 'p=none').to eq(p: 'none')
+    end
+
+    it "parses policy 'reject'" do
+      expect(subject.parse 'p=reject').to eq(p: 'reject')
+    end
+
+    it "parses policy 'quarantine'" do
+      expect(subject.parse 'p=quarantine').to eq(p: 'quarantine')
+    end
+
+    it 'ignores spacing' do
+      expect(subject.parse 'p  =  reject').to eq(p: 'reject')
+    end
+  end
+end

data/spec/dmarc_inspector/dmarc/record_spec.rb

@@ -0,0 +1,34 @@
+require 'dmarc_inspector/dmarc/record'
+
+describe DMARCInspector::DMARC::Record do
+  describe '.parse' do
+    it 'parses a dmarc record' do
+      data = 'v=DMARC1; p=reject; sp=none; pct=100; rua=mailto:dmarc-yahoo-rua@yahoo-inc.com, mailto:dmarc_y_rua@yahoo.com;'
+      record = DMARCInspector::DMARC::Record.parse(data)
+      expect(record[:p]).to eq(:reject)
+    end
+
+    context "receiver policy is 'none'" do
+      it 'returns :none' do
+        data = 'v=DMARC1; p=none; rua=mailto:mailauth-reports@google.com'
+        record = DMARCInspector::DMARC::Record.parse(data)
+        expect(record[:p]).to eq(:none)
+      end
+    end
+
+    context "receiver policy is 'quarantine'" do
+      it 'returns :none' do
+        data = 'v=DMARC1; p=quarantine; rua=mailto:mailauth-reports@google.com'
+        record = DMARCInspector::DMARC::Record.parse(data)
+        expect(record[:p]).to eq(:quarantine)
+      end
+    end
+
+    context 'invalid record' do
+      it 'throws an error' do
+        data = 'v=spf1 redirect=_spf.mail.yahoo.com'
+        expect { DMARCInspector::DMARC::Record.parse(data) }.to raise_error(DMARCInspector::DMARC::InvalidRecord)
+      end
+    end
+  end
+end

data/spec/dmarc_inspector_spec.rb

@@ -0,0 +1,27 @@
+describe DMARCInspector do
+  describe '#receiver_policy' do
+    it 'returns receiver policy of a domain' do
+      # TODO: Mock DNS query
+      # "v=DMARC1\; p=none\; rua=mailto:mailauth-reports@google.com"
+      dmarc_inspector = DMARCInspector.new('gmail.com')
+      expect(dmarc_inspector.receiver_policy).to eq(:none)
+    end
+
+    context "receiver policy is 'reject'" do
+      it 'returns :reject' do
+        # TODO: Mock DNS query
+        # "v=DMARC1\; p=reject\; sp=none\; pct=100\; rua=mailto:dmarc-yahoo-rua@yahoo-inc.com, mailto:dmarc_y_rua@yahoo.com\;"
+        dmarc_inspector = DMARCInspector.new('yahoo.com')
+        expect(dmarc_inspector.receiver_policy).to eq(:reject)
+      end
+    end
+
+    context "dns information isn't available" do
+      it 'returns :none' do
+        # TODO: Mock DNS query
+        dmarc_inspector = DMARCInspector.new('supportbee.com')
+        expect(dmarc_inspector.receiver_policy).to eq(:none)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require 'dmarc_inspector'
+
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: dmarc_inspector
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nisanth Chunduru
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: 
+email:
+- nisanth074@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec.example"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dmarc_inspector.gemspec
+- lib/dmarc_inspector.rb
+- lib/dmarc_inspector/dmarc/errors.rb
+- lib/dmarc_inspector/dmarc/parser.rb
+- lib/dmarc_inspector/dmarc/record.rb
+- lib/dmarc_inspector/version.rb
+- spec/dmarc_inspector/dmarc/parser_spec.rb
+- spec/dmarc_inspector/dmarc/record_spec.rb
+- spec/dmarc_inspector_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Looks up DMARC policy of a domain
+test_files:
+- spec/dmarc_inspector/dmarc/parser_spec.rb
+- spec/dmarc_inspector/dmarc/record_spec.rb
+- spec/dmarc_inspector_spec.rb
+- spec/spec_helper.rb
+has_rdoc: