dns-sniper 0.0.1pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c6bab67f9579e0762d197d29dd188ced90277fa05573bb84e472be2c42a5a3e
+  data.tar.gz: 4123ba5a1c02a7f5d4972055b4b1743aae7bd4f995cd1336626a3f8a68ca7e23
+SHA512:
+  metadata.gz: 479adbba0f5d557ef178acadc65461ee0be27684f4a4ab95bdd8f2b129a15b2583658fcea86193ee1c30519c5dba712b6c784619d79eaa345b7fcd993a1a19c1
+  data.tar.gz: b5ef2952418417f81d8c47b7cfe3052fe5e18242d5d87c3328f9713b5175bf94f48dc0ac3e3a9c8b4ddcc944637f2d8aea07fef00d15dc2b84c24e8f72fc3b8c

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+.ruby-version

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    sniper (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    down (5.1.1)
+      addressable (~> 2.5)
+    hosts_file (1.0.3)
+    public_suffix (4.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.2)
+  down (~> 5.1)
+  hosts_file (~> 1.0)
+  sniper!
+
+BUNDLED WITH
+   2.1.2

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/dns-sniper

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "set"
+require "dns-sniper"
+
+VALID_FORMATS = ["text", "unbound"]
+Options = Struct.new(:blacklist_urls_file, :whitelisted_hosts_file, :format)
+
+class Parser
+  def self.parse(options)
+    args = Options.new("world")
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename(__FILE__)} -f PATH -o FORMAT [options]\n#{File.basename(__FILE__)} combines online DNS blacklists and combines them into the desired configuration FORMAT.\n\n"
+      opts.on("-f", "--blacklist=PATH", "PATH to file with line-separated list of URL’s of blacklists") do |path|
+        args.blacklist_urls_file = path
+      end
+      opts.on("-w", "--whitelist=path", "Path to file with line-separated list of whitelisted hostnames") do |path|
+        args.whitelisted_hosts_file = path
+      end
+      opts.on("-o", "--output=FORMAT", "FORMAT to output — one of #{VALID_FORMATS.join(", ")}") do |format|
+        args.format = format
+      end
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+    opt_parser.parse!(options)
+    return args
+  end
+end
+
+options = Parser.parse ARGV
+
+unless VALID_FORMATS.include?(options[:format])
+  STDERR.puts "Error: Format ”#{options[:format]}” unrecognized"
+  exit(-1)
+end
+
+unless File.exist?(options[:blacklist_urls_file])
+  STDERR.puts "Error: Unable to access ”#{options[:blacklist_urls_file]}”"
+  exit(-1)
+end
+
+if options[:whitelisted_hosts_file] and not File.exist?(options[:whitelisted_hosts_file])
+  STDERR.puts "Error: Unable to access ”#{options[:whitelisted_hosts_file]}”"
+  exit(-1)
+end
+
+hostnames = DNSSniper::Hostnames.new
+puts hostnames.add_from(File.open(options[:blacklist_urls_file]).readlines).remove_from(options[:whitelisted_hosts_file]).to_format(options[:format])

data/dns-sniper.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name = "dns-sniper"
+  spec.license = "MIT"
+  spec.version = "0.0.1pre"
+  spec.date = "2020-08-13"
+  spec.authors = ["Brody Hoskins"]
+  spec.email = ["brody@brody.digital"]
+
+  spec.summary = "Command line utility that combines online DNS blacklists and combines them into the desired configuration format"
+  spec.description = "Command line utility that combines online DNS blacklists and combines them into the desired configuration format"
+  spec.homepage = "https://github.com/brodyhoskins/dns-sniper"
+
+  spec.files = `git ls-files`.split($/)
+
+  spec.bindir = "bin"
+  spec.executables = "dns-sniper"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1.2"
+
+  spec.add_development_dependency "down", "~> 5.1"
+  spec.add_development_dependency "hosts_file", "~> 1.0"
+end

data/lib/dns-sniper.rb

@@ -0,0 +1,3 @@
+require "dns-sniper/hostnames"
+require "dns-sniper/formatter"
+require "dns-sniper/formatters"

data/lib/dns-sniper/formatter.rb

@@ -0,0 +1,12 @@
+module DNSSniper
+  class Formatter
+    def initialize(hostnames, options = {})
+      @hostnames = hostnames
+      @options = options
+    end
+
+    def output
+      raise NotImplementedError, "Error: #output isn’t supported by #{self.class.name}"
+    end
+  end
+end

data/lib/dns-sniper/formatters.rb

@@ -0,0 +1,24 @@
+module DNSSniper
+  module Formatters
+    extend self
+
+    attr_reader :registered
+    @registered = []
+
+    def register(class_name, autoload_require)
+      DNSSniper.autoload(class_name, autoload_require)
+      self.registered << class_name
+    end
+
+    def all
+      Sniper::Formatters.registered.map { |name| Sniper.const_get(name) }
+    end
+
+    def find(name)
+      all.find { |c| c.name.downcase == name.to_s.downcase } or raise NameError, "unknown carrier #{name}"
+    end
+  end
+end
+
+DNSSniper::Formatters.register :Text, "dns-sniper/formatters/text"
+DNSSniper::Formatters.register :Unbound, "dns-sniper/formatters/unbound"

data/lib/dns-sniper/formatters/text.rb

@@ -0,0 +1,12 @@
+module DNSSniper
+  class Text < Formatter
+    def initialize(hostnames, options = {})
+      @hostnames = hostnames
+      @options = options
+    end
+
+    def output
+      @hostnames.to_a.join($/)
+    end
+  end
+end

data/lib/dns-sniper/formatters/unbound.rb

@@ -0,0 +1,16 @@
+module DNSSniper
+  class Unbound < Formatter
+    def initialize(hostnames, options = {})
+      @hostnames = hostnames
+      @options = options
+    end
+
+    def output
+      str = "server:#{$/}"
+      @hostnames.each do |hostname|
+        str << "  local-zone: \"#{hostname}\" static#{$/}"
+      end
+      str
+    end
+  end
+end

data/lib/dns-sniper/hostnames.rb

@@ -0,0 +1,176 @@
+require "down"
+require "hosts_file"
+require "open-uri"
+require "resolv"
+
+module DNSSniper
+  class Hostnames
+    def initialize(options = {})
+      @hostnames = [].to_set
+      self
+    end
+
+    def add(hostname)
+      hostname = clean(hostname)
+      @hostnames << hostname if hostname
+      self
+    end
+
+    def add_many(hostnames)
+      hostnames.each { |hostname| add(hostname) }
+      self
+    end
+
+    def add_from(paths_or_urls)
+      return self unless paths_or_urls
+      if (paths_or_urls.class == String)
+        paths_or_urls = [paths_or_urls]
+      end
+
+      paths_or_urls.each do |path_or_url|
+        path_or_url = path_or_url.strip
+
+        if File.exist?(path_or_url)
+          contents = File.open(path_or_url).readlines
+        else
+          begin
+            down = Down.download(path_or_url)
+            path_or_url = down.path
+            contents = down.readlines
+          rescue Down::NotFound
+            STDERR.puts "\"#{path_or_url}\" does not exist"
+            return self
+          rescue Down::ResponseError
+            STDERR.puts "\"#{path_or_url}\": No data from server"
+            return self
+          end
+        end
+
+        case syntax(path_or_url, contents)
+        when nil
+          STDERR.puts "Error: Syntax: Syntax of \"#{path_or_url}\" not recognized, ignored"
+          return self
+        when "hosts"
+          add_many from_hosts_file(path_or_url)
+        when "hostnames"
+          add_many from_hostnames_file(contents)
+        end
+      end
+
+      self
+    end
+
+    def remove(hostname)
+      hostname = clean(hostname)
+      @hostnames = @hostnames - [hostname] if hostname
+      self
+    end
+
+    def remove_many(hostnames)
+      hostnames.each { |hostname| remove(hostname) }
+      self
+    end
+
+    def remove_from(paths_or_urls)
+      return self unless paths_or_urls
+      if (paths_or_urls.class == String)
+        paths_or_urls = [paths_or_urls]
+      end
+
+      paths_or_urls.each do |path_or_url|
+        path_or_url = path_or_url.strip
+
+        if File.exist?(path_or_url)
+          contents = File.open(path_or_url).readlines
+        else
+          begin
+            down = Down.download(path_or_url)
+            path_or_url = down.path
+            contents = down.readlines
+          rescue Down::NotFound
+            STDERR.puts "\"#{path_or_url}\" does not exist"
+            return self
+          rescue Down::ResponseError
+            STDERR.puts "\"#{path_or_url}\": No data from server"
+            return self
+          end
+        end
+
+        case syntax(path_or_url, contents)
+        when nil
+          STDERR.puts "Error: Syntax: Syntax of \"#{path_or_url}\" not recognized, ignored"
+          return self
+        when "hosts"
+          remove_many from_hosts_file(path_or_url)
+        when "hostnames"
+          remove_many from_hostnames_file(contents)
+        end
+      end
+
+      self
+    end
+
+    def to_format(format)
+      format = format.capitalize
+      begin
+        klass = Sniper.const_get(format)
+        klass.new(@hostnames.to_a).output
+      rescue NameError
+        return false
+      end
+    end
+
+    def to_a
+      @hostnames.to_a
+    end
+
+    def to_text
+      @hostnames.to_a.join("\n")
+    end
+
+    def to_unbound
+      str = "server:\n"
+      @hostnames.each do |hostname|
+        str << "  local-zone: \"#{hostname}\" static\n"
+      end
+      str
+    end
+
+    private
+
+    def clean(hostname)
+      hostname = hostname.downcase.strip
+      hostname = hostname.sub("www.", "")
+      hostname_top_domain = "#{hostname.split(".")[-2]}.#{hostname.split(".")[-1]}"
+
+      if not hostname.include?("#") and not ["broadcasthost", "localhost", ""].include?(hostname) and not @hostnames.include?(hostname_top_domain)
+        hostname
+      else
+        nil
+      end
+    end
+
+    def syntax(path_or_url, contents)
+      contents.each do |line|
+        next if line.include?("#")
+        line = line.downcase
+
+        if line.strip.split(/\s/).first =~ Regexp.union([Resolv::IPv4::Regex, Resolv::IPv6::Regex])
+          return "hosts"
+        elsif line.include? "." and not line.include? "http" and path_or_url.end_with?(".list")
+          return "hostnames"
+        end
+      end
+      nil
+    end
+
+    def from_hosts_file(path_or_url)
+      # TODO: Remove downloading file twice
+      HostsFile.load(path_or_url).map(&:name)
+    end
+
+    def from_hostnames_file(contents)
+      contents.each { |line| add(line) }
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: dns-sniper
+version: !ruby/object:Gem::Version
+  version: 0.0.1pre
+platform: ruby
+authors:
+- Brody Hoskins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: hosts_file
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Command line utility that combines online DNS blacklists and combines
+  them into the desired configuration format
+email:
+- brody@brody.digital
+executables:
+- dns-sniper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/dns-sniper
+- dns-sniper.gemspec
+- lib/dns-sniper.rb
+- lib/dns-sniper/formatter.rb
+- lib/dns-sniper/formatters.rb
+- lib/dns-sniper/formatters/text.rb
+- lib/dns-sniper/formatters/unbound.rb
+- lib/dns-sniper/hostnames.rb
+homepage: https://github.com/brodyhoskins/dns-sniper
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Command line utility that combines online DNS blacklists and combines them
+  into the desired configuration format
+test_files: []