urlhaus_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c76d3e7849c7a747f538e71ec181064e3c1ddfd782a776dd575e36787ef3474
+  data.tar.gz: 7e63116b773fd023bf94a93461765b7d2b89c63fb996968d8c95769e4f90d64e
+SHA512:
+  metadata.gz: 88566b40be5de7f2d002bd660b2e74090cc7e2e616503b6c1d8219d9e32aff7e40491d17d81e1b1bc1f6cd9f7a90da3796fceb7e42156d06306f5781bb35a1af
+  data.tar.gz: bc6304a7279c0ff154f0c9c1c9a735136f5e9a91fd45e049c70dfc2ccdab0f408f04d7e6ac26db1dcd8e5af7d3f68bf4c74c1950008c835f6cb571f737fbd3fa

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/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
+
+.rspec_status

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.6.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 urlhaus_monitor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Manabu Niseki
+
+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,53 @@
+# URLhaus monitor
+
+[![Build Status](https://travis-ci.org/ninoseki/urlhaus_monitor.svg?branch=master)](https://travis-ci.org/ninoseki/urlhaus_monitor)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/urlhaus_monitor/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/urlhaus_monitor?branch=master)
+
+A monitoring tool for [URLhaus](https://urlhaus.abuse.ch/) feeds.
+
+## Features
+
+- URLhaus feeds lookup by AS number, country code and TLD.
+- Slack notification.
+
+## Installation
+
+```bash
+$ gem install urlhaus_monitor
+```
+
+## Usage
+
+```bash
+$ urlhaus_monitor
+Commands:
+  urlhaus_monitor help [COMMAND]               # Describe available commands or one specific command
+  urlhaus_monitor lookup_by_asn [ASN]          # lookup by a given asn
+  urlhaus_monitor lookup_by_country [COUNTRY]  # lookup by a given country code
+  urlhaus_monitor lookup_by_tld [TLD]          # lookup by a given tld
+```
+
+## Configuration
+
+### Slack
+
+Please set the following environmental variables for enabling Slack notification.
+
+- `SLACK_WEBHOOK_URL`: A Slack webhook URL.
+- `SLACK_CHANNEL_NAME`: A Slask channel name which will be notified.
+
+## Screenshots
+
+```bash
+$ urlhaus_monitor lookup_by_tld jp
+```
+
+![img](./screenshots/example.png)
+
+## 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,8 @@
+# frozen_string_literal: true
+
+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 "urlhaus_monitor"
+
+# 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/exe/urlhaus_monitor

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "urlhaus_monitor"
+
+URLhausMonitor::CLI.start

data/lib/urlhaus_monitor/checker.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "http"
+
+module URLhausMonitor
+  class Checker
+    BASE_URL = "https://urlhaus.abuse.ch"
+    LIMIT = 50
+
+    def lookup_by_country(country)
+      lookup "#{BASE_URL}/feeds/country/#{country}"
+    end
+
+    def lookup_by_tld(tld)
+      lookup "#{BASE_URL}/feeds/tld/#{tld}"
+    end
+
+    def lookup_by_asn(asn)
+      lookup "#{BASE_URL}/feeds/asn/#{asn}"
+    end
+
+    private
+
+    def lookup(url)
+      res = HTTP.get(url)
+      return nil unless res.code == 200
+
+      convert res.body.to_s.lines[0..LIMIT]
+    end
+
+    def convert(lines)
+      [].tap do |entries|
+        lines.each do |line|
+          next if line.start_with? "#"
+
+          entries << Entry.new(line)
+        end
+      end
+    end
+  end
+end

data/lib/urlhaus_monitor/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module URLhausMonitor
+  class CLI < Thor
+    desc "lookup_by_country [COUNTRY]", "lookup by a given country code"
+    def lookup_by_country(country)
+      Monitor.new.lookup_by_country country
+    end
+
+    desc "lookup_by_tld [TLD]", "lookup by a given tld"
+    def lookup_by_tld(tld)
+      Monitor.new.lookup_by_tld tld
+    end
+
+    desc "lookup_by_asn [ASN]", "lookup by a given asn"
+    def lookup_by_asn(asn)
+      Monitor.new.lookup_by_asn asn
+    end
+  end
+end

data/lib/urlhaus_monitor/entry.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module URLhausMonitor
+  class Entry
+    attr_reader :date_added
+    attr_reader :url
+    attr_reader :url_status
+    attr_reader :threat
+    attr_reader :host
+    attr_reader :ip_address
+    attr_reader :asnumber
+    attr_reader :country
+
+    def initialize(line)
+      parts = CSV.parse(line.chomp).flatten
+      raise ArgumentError, "#{line} is not valid." unless parts.length == 8
+
+      @date_added = parts.shift
+      @url = parts.shift
+      @url_status = parts.shift
+      @threat = parts.shift
+      @host = parts.shift
+      @ip_address = parts.shift
+      @asnumber = parts.shift
+      @country = parts.shift
+    end
+
+    def defanged_url
+      @defanged_url ||= url.gsub(/\./, "[.]")
+    end
+
+    def defanged_host
+      @defanged_host ||=  host.gsub(/\./, "[.]")
+    end
+
+    def vt_link
+      "https://www.virustotal.com/#/domain/#{host}"
+    end
+
+    def urlhaus_link
+      "https://urlhaus.abuse.ch/host/#{host}/"
+    end
+
+    def title
+      "#{defanged_url} (#{defanged_host} / #{ip_address}) (#{date_added})"
+    end
+
+    def to_attachements
+      [
+        {
+          fallback: "urlhaus link",
+          title: defanged_host,
+          title_link: urlhaus_link,
+          footer: "urlhaus.abuse.ch",
+          footer_icon: "http://www.google.com/s2/favicons?domain=urlhaus.abuse.ch"
+        },
+        {
+          fallback: "vt link",
+          title: defanged_host,
+          title_link: vt_link,
+          footer: "virustotal.com",
+          footer_icon: "http://www.google.com/s2/favicons?domain=virustotal.com"
+        }
+      ]
+    end
+  end
+end

data/lib/urlhaus_monitor/monitor.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "lightly"
+
+module URLhausMonitor
+  class Monitor
+    attr_reader :checker
+    attr_reader :cache
+
+    def initialize
+      @checker = Checker.new
+      @cache = Lightly.new(dir: "/tmp/urlhause_monitor", life: "180d")
+    end
+
+    def lookup_by_country(country)
+      entries = checker.lookup_by_country(country)
+      process entries
+    end
+
+    def lookup_by_tld(tld)
+      entries = checker.lookup_by_tld(tld)
+      process entries
+    end
+
+    def lookup_by_asn(asn)
+      entries = checker.lookup_by_asn(asn)
+      process entries
+    end
+
+    def process(entries)
+      return nil unless entries
+
+      entries.each do |entry|
+        next if cache.cached? entry.url
+
+        Notifier.notify entry.title, entry.to_attachements
+        cache.save entry.url, true
+      end
+    end
+  end
+end

data/lib/urlhaus_monitor/notifier.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "slack/incoming/webhooks"
+
+module URLhausMonitor
+  class Notifier
+    def notifiy(title, attachments = [])
+      attachments << { title: "N/A" } if attachments.empty?
+
+      if slack_webhook_url?
+        slack = Slack::Incoming::Webhooks.new(slack_webhook_url, channel: slack_channel)
+        slack.post title, attachments: attachments
+      else
+        puts title
+        attachments.each do |attachment|
+          puts attachment.dig(:title_link)
+        end
+      end
+    end
+
+    def slack_webhook_url
+      ENV.fetch "SLACK_WEBHOOK_URL"
+    end
+
+    def slack_channel
+      ENV.fetch "SLACK_CHANNEL", "#general"
+    end
+
+    def slack_webhook_url?
+      ENV.key? "SLACK_WEBHOOK_URL"
+    end
+
+    def self.notify(title, attachments)
+      new.notifiy(title, attachments)
+    end
+  end
+end

data/lib/urlhaus_monitor/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module URLhausMonitor
+  VERSION = "0.1.0"
+end

data/lib/urlhaus_monitor.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "urlhaus_monitor/version"
+
+require "urlhaus_monitor/entry"
+require "urlhaus_monitor/checker"
+require "urlhaus_monitor/notifier"
+require "urlhaus_monitor/monitor"
+require "urlhaus_monitor/cli"
+
+module URLhausMonitor
+  class Error < StandardError; end
+end

data/urlhaus_monitor.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "urlhaus_monitor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "urlhaus_monitor"
+  spec.version       = URLhausMonitor::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "A monitoring tool for URLhaus feeds."
+  spec.description   = "A monitoring tool for URLhaus feeds."
+  spec.homepage      = "https://github.com/ninoseki/urlhaus_monitor"
+  spec.license       = "MIT"
+
+  # 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(__dir__)) 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "fakefs", "~> 0.20"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.5"
+
+  spec.add_dependency "http", "~> 4.1"
+  spec.add_dependency "lightly", "~> 0.3"
+  spec.add_dependency "slack-incoming-webhooks", "~> 0.2"
+  spec.add_dependency "thor", "~> 0.19"
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: urlhaus_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-24 00:00:00.000000000 Z
+dependencies:
+- !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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: lightly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: slack-incoming-webhooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: A monitoring tool for URLhaus feeds.
+email:
+- manabu.niseki@gmail.com
+executables:
+- urlhaus_monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/urlhaus_monitor
+- lib/urlhaus_monitor.rb
+- lib/urlhaus_monitor/checker.rb
+- lib/urlhaus_monitor/cli.rb
+- lib/urlhaus_monitor/entry.rb
+- lib/urlhaus_monitor/monitor.rb
+- lib/urlhaus_monitor/notifier.rb
+- lib/urlhaus_monitor/version.rb
+- screenshots/example.png
+- urlhaus_monitor.gemspec
+homepage: https://github.com/ninoseki/urlhaus_monitor
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A monitoring tool for URLhaus feeds.
+test_files: []