spf_lookup 0.1.2a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73fb8d746701c15855dfaed242f391e384ce96071157335c76b9bb73ce7e01f0
+  data.tar.gz: 17af222e4787d6c07f0778485912a86138b5671cc81597e697e56dd3a7b3cc3d
+SHA512:
+  metadata.gz: c4fda7cf88816bb58a9ce8a474c705f98902f6885f588c2b3a576ce45ffec69ca20d05aea0bcacc59b63b6a689fdc41a4dfd22bc18ad3536420d1bb24aceda65
+  data.tar.gz: fbe13fccbda702dc559ca355b3fc7ecf0ef58323cc2ebbea180c51f29ba7d85f7d729b7f70c9fd5c49ea7c50b9ebbd202a26f14e20a0b864403f2f666b310139

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+Gemfile.lock
+# rspec failure tracking
+.rspec_status
+
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spf_lookup.gemspec
+gemspec

data/README.md

@@ -0,0 +1,89 @@
+# SpfLookup
+
+SpfLookup will count the number of SPF lookups for a given domain.
+
+## Overview
+
+RFC specify a limit of 10 DNS lookups for SPF. https://datatracker.ietf.org/doc/html/rfc7208#section-4.6.4
+
+Therefore, when configuring SPF, you need to check the number of SPF lookups for target domain and make sure that the number of lookups after configuration is within the upper limit set by the RFC.
+
+SpfLookup will count the nubmer of SPF lookups by passing the domain,
+so you can reduce the work of counting the number of SPF lookups.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spf_lookup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spf_lookup
+
+## Example
+
+```ruby
+require "spf_lookup"
+
+domain = "sample.example.com"
+
+resolv_conf = {
+  nameserver: ['8.8.8.8']
+}
+
+# SpfLookup.dns_configure argumets is the same as the one passed to the initializer of Resolv::DNS
+SpfLookup.dns_configure(resolv_conf)
+
+
+# Retrive spf record set.
+record_set = SpfLookup.retrieve_record_set(domain)
+record_set_hash = record_set.to_hash
+
+## record set information
+puts record_set_hash[:lookup_term_count]
+puts record_set_hash[:domain]
+puts record_set_hash[:record_value]
+puts record_set_hash[:includes]
+
+puts record_set_hash[:includes].first[:lookup_term_count]
+puts record_set_hash[:includes].first[:domain]
+puts record_set_hash[:includes].first[:record_value]
+puts record_set_hash[:includes].first[:includes]
+
+# Lookup count check.
+## If you want to use "retrieve_record_set" method, use this.
+lookup_count = record_set.lookup_count
+## If you DON'T want to use  "retrieve_record_set" method, use this.
+lookup_count = SpfLookup.lookup_count(domain)
+
+if lookup_count > SpfLookup::LOOKUP_LIMIT_SPECIFIED_BY_RFC7208
+  puts "Invalid SPF lookup count!"
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shirot7335/spf_lookup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## WIP
+* test
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spf_lookup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spf_lookup/error.rb

@@ -0,0 +1,10 @@
+module SpfLookup
+  class Error < StandardError
+  end
+
+  class SpfRecordNotFound < Error
+  end
+
+  class MultipleSpfRecordError < Error
+  end
+end

data/lib/spf_lookup/lookup.rb

@@ -0,0 +1,62 @@
+require 'coppertone'
+require_relative './txt_record_fetcher'
+require_relative './spf_record'
+require_relative './error'
+
+module SpfLookup
+  class Lookup
+
+    class << self
+      def run(domain)
+        return dns_lookup(domain)
+      end
+
+      private
+
+      def dns_lookup(domain)
+        spf_record = find_spf_record(domain)
+
+        includes = lookup_target_domains(spf_record).map {|_domain|
+          dns_lookup(_domain)
+        }
+
+        return SpfRecord.new(
+          domain,
+          spf_record&.to_s,
+          includes,
+          spf_record&.dns_lookup_term_count
+        )
+      end
+
+      def lookup_target_domains(spf_record)
+        return [] if spf_record.blank?
+
+        domain_fetcher = -> (obj) { obj.domain_spec.macro_text }
+
+        domains = spf_record.includes.each_with_object([]) { |include_value, memo|
+          memo << domain_fetcher.(include_value.mechanism)
+        }
+        domains << domain_fetcher.(spf_record.redirect) unless spf_record.redirect.nil?
+
+        return domains.compact
+      end
+
+      def find_spf_record(domain)
+        spf_record = record_fetcher.txt_record_values(domain).each_with_object([]) {|txt_record_value, memo|
+          memo << Coppertone::Record.new(txt_record_value) if Coppertone::Record.record?(txt_record_value)
+        }
+
+        if spf_record.length > 1
+          raise SpfLookup::MultipleSpfRecordError.new("There must be only one SPF record in the same domain.")
+        end
+
+        return spf_record.first
+      end
+
+      def record_fetcher
+        @fetcher ||= TXTRecordFetcher.new(SpfLookup::DNS_CONFIG[:option])
+      end
+    end
+  end
+
+end

data/lib/spf_lookup/spf_record.rb

@@ -0,0 +1,51 @@
+require "json"
+
+module SpfLookup
+  class SpfRecord
+    attr_accessor :domain, :record_value, :includes
+    attr_accessor :lookup_term_count
+
+    def initialize(domain, record_value, includes, lookup_term_count)
+      @domain            = domain || ""
+      @record_value      = record_value || ""
+      @includes          = includes || []
+      @lookup_term_count = lookup_term_count || 0
+    end
+
+    def lookup_count
+      return count_dns_lookup_0
+    end
+
+    def to_hash
+      return {
+        domain:            @domain,
+        record_value:      @record_value,
+        includes:          includes_to_hash,
+        lookup_term_count: @lookup_term_count
+      }
+    end
+
+    def to_json
+      return self.to_hash.to_json
+    end
+
+    private
+
+    def count_dns_lookup_0
+      return count_dns_lookup(self, 0)
+    end
+
+    def count_dns_lookup(result, count)
+      _count = result.includes.inject(count) {|memo, r|
+        memo = count_dns_lookup(r, memo)
+      }
+
+      return _count + result.lookup_term_count
+    end
+
+    def includes_to_hash
+      return includes.map {|result| result.to_hash }
+    end
+  end
+
+end

data/lib/spf_lookup/txt_record_fetcher.rb

@@ -0,0 +1,33 @@
+require 'resolv'
+
+
+module SpfLookup
+  class TXTRecordFetcher
+
+    SUPPORTED_TYPE_CLASS = %w[TXT].freeze
+
+    def initialize(dns_conf = nil)
+      @resolver = Resolv::DNS.new(dns_conf)
+    end
+
+    def txt_record_values(domain)
+      return txt_record_resources(domain).collect { |resource| resource.data }
+    end
+
+    def txt_record_resources(domain)
+      return record_resources(domain, 'TXT')
+    end
+
+    def record_resources(domain, record_type)
+      resources = @resolver.getresources(domain, type_class(record_type))
+      return resources
+    end
+
+    private
+    def type_class(record_type)
+      raise ArgumentError unless SUPPORTED_TYPE_CLASS.include?(record_type.upcase)
+      Resolv::DNS::Resource::IN.const_get(record_type.upcase)
+    end
+
+  end
+end

data/lib/spf_lookup/version.rb

@@ -0,0 +1,3 @@
+module SpfLookup
+  VERSION = "0.1.2a"
+end

data/lib/spf_lookup.rb

@@ -0,0 +1,28 @@
+require "spf_lookup/version"
+
+require_relative './spf_lookup/lookup'
+
+module SpfLookup
+
+  # 'options' could set nil or Resolv::DNS.new argument.
+  # ex.
+  #   {nameserver: '8.8.8.8'}
+  DNS_CONFIG = {option: nil}
+  LOOKUP_LIMIT_SPECIFIED_BY_RFC7208 = 10
+
+  class << self
+    def retrieve_record_set(domain)
+      return SpfLookup::Lookup.run(domain)
+    end
+
+    def lookup_count(domain)
+      return SpfLookup::Lookup.run(domain).lookup_count
+    end
+
+    def dns_configure(dns_config = nil)
+      DNS_CONFIG[:option] = dns_config
+    end
+  end
+
+end
+

data/spf_lookup.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "spf_lookup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "spf_lookup"
+  spec.version       = SpfLookup::VERSION
+  spec.authors       = ["Ryouichi Suganuma"]
+  spec.email         = ["shirot.white4624@gmail.com"]
+
+  spec.summary       = %q{lookup counter for SPF registration.}
+  spec.description   = %q{SpfLookup will count the number of SPF lookups for a given domain.}
+  spec.homepage      = "https://github.com/shirot7335/spf_lookup"
+  spec.license       = "Confidential"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #  spec.metadata["homepage_uri"] = spec.homepage
+  #  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "domain_name", "~> 0.5"
+  spec.add_dependency "coppertone", "~> 0.0.10"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: spf_lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.2a
+platform: ruby
+authors:
+- Ryouichi Suganuma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: domain_name
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: coppertone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: SpfLookup will count the number of SPF lookups for a given domain.
+email:
+- shirot.white4624@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spf_lookup.rb
+- lib/spf_lookup/error.rb
+- lib/spf_lookup/lookup.rb
+- lib/spf_lookup/spf_record.rb
+- lib/spf_lookup/txt_record_fetcher.rb
+- lib/spf_lookup/version.rb
+- spf_lookup.gemspec
+homepage: https://github.com/shirot7335/spf_lookup
+licenses:
+- Confidential
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: lookup counter for SPF registration.
+test_files: []