greynoise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0aaed790f898a678caa7db7632a0324b73bcfb7b2fa8f986fe5e23ba4ac9932
+  data.tar.gz: 2eafa81198fcc88f902b66ddc9afc6de66b232e2ecf374624c4b507bf1c5c17e
+SHA512:
+  metadata.gz: f42b5a74e4d7b626749b11f99e804f664e86fbd5af377611d2f19f71d5ebf3f5ddf618a2ec7e58f1fd7bbbce733bba5ec0518d8dd6088a36786b373341150bbf
+  data.tar.gz: 6ab1ff0c748e2290f08642bd5c95db7328dcf3ea2f1d9f93b57cb1764f6e629263ca2e451033f97de1a28e712a39f26b939b0007b5fb98c242f561aff1d72bda

data/.gitignore

@@ -0,0 +1,58 @@
+*.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
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## 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
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6
+before_install: gem install bundler -v 2.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in greynoise.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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,37 @@
+# greynoise
+
+[![Build Status](https://travis-ci.com/ninoseki/greynoise.svg?branch=master)](https://travis-ci.com/ninoseki/greynoise)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/greynoise/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/greynoise?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/greynoise/badge)](https://www.codefactor.io/repository/github/ninoseki/greynoise)
+
+GreyNoise API wrapper for Ruby.
+
+## Installation
+
+```bash
+gem install greynoise
+```
+
+## Usage
+
+```ruby
+require "greynoise"
+
+# when given nothing, it tries to load your API key via ENV["GREYNOISE_API_KEY"]
+api = GreyNoise::API.new
+# or you can set it manually
+api = GreyNoise::API.new(key: YOUR_API_KEY)
+
+api.experimental.gnql(query)
+api.experimental.gnql_stats(query)
+
+api.noise.context(ip)
+api.noise.quick(ip)
+api.noise.multi_quick("1.1.1.1", "8.8.8.8")
+
+api.meta.metadata
+```
+
+## 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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "greynoise"
+
+# 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/greynoise.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/greynoise/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "greynoise"
+  spec.version       = GreyNoise::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "GreyNoise API wrapper for Ruby"
+  spec.description   = "GreyNoise API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/greynoise"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ninoseki/greynoise"
+  spec.metadata["changelog_uri"] = "https://github.com/ninoseki/greynoise/CHANGELOG.md"
+
+  # 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.1"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.8"
+end

data/lib/greynoise.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "greynoise/version"
+
+require "greynoise/clients/client"
+
+require "greynoise/clients/experimental"
+require "greynoise/clients/noise"
+require "greynoise/clients/meta"
+
+require "greynoise/api"
+
+module GreyNoise
+  class Error < StandardError; end
+end

data/lib/greynoise/api.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GreyNoise
+  class API
+    def initialize(key: ENV["GREYNOISE_API_KEY"])
+      @key = key
+    end
+
+    def experimental
+      @experimental ||= Clients::Experimental.new(@key)
+    end
+
+    def meta
+      @meta ||= Clients::Meta.new(@key)
+    end
+
+    def noise
+      @noise ||= Clients::Noise.new(@key)
+    end
+  end
+end

data/lib/greynoise/clients/client.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/https"
+require "uri"
+
+module GreyNoise
+  module Clients
+    class Client
+      HOST = "api.greynoise.io"
+      VERSION = "v2"
+      BASE_URL = "https://#{HOST}/#{VERSION}"
+
+      attr_reader :key
+
+      def initialize(key)
+        @key = key
+      end
+
+      private
+
+      def url_for(path)
+        URI(BASE_URL + path)
+      end
+
+      def https_options
+        if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+          uri = URI(proxy)
+          {
+            proxy_address: uri.hostname,
+            proxy_port: uri.port,
+            proxy_from_env: false,
+            use_ssl: true
+          }
+        else
+          { use_ssl: true }
+        end
+      end
+
+      def request(req)
+        Net::HTTP.start(HOST, 443, https_options) do |http|
+          req["key"] = key
+
+          response = http.request(req)
+
+          code = response.code.to_i
+          body = response.body
+          json = JSON.parse(body) if response["Content-Type"].to_s.include?("application/json")
+
+          case code
+          when 200
+            if json
+              yield json
+            else
+              yield body
+            end
+          else
+            status = json ? json.dig("status") : body
+            raise Error, "Unsupported response code returned: #{code} - #{status}"
+          end
+        end
+      end
+
+      def _get(path, params = {}, &block)
+        uri = url_for(path)
+        uri.query = URI.encode_www_form(params)
+        get = Net::HTTP::Get.new(uri)
+
+        request(get, &block)
+      end
+    end
+  end
+end

data/lib/greynoise/clients/experimental.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GreyNoise
+  module Clients
+    class Experimental < Client
+      #
+      # GNQL (GreyNoise Query Language) is a domain-specific query language that uses Lucene deep under the hood
+      #
+      # @param [String] query GNQL query string
+      # @param [Integer, nil] size Maximum amount of results to grab
+      # @param [Integer, nil] scroll Scroll token to paginate through results
+      #
+      # @return [Hash]
+      #
+      def gnql(query, size: nil, scroll: nil)
+        params = {
+          query: query,
+          size: size,
+          scroll: scroll
+        }.compact
+        _get("/experimental/gnql", params) { |json| json }
+      end
+
+      #
+      # Get aggregate statistics for the top organizations, actors, tags, ASNs, countries, classifications, and operating systems of all the results of a given GNQL query.
+      #
+      # @param [String] query GNQL query string
+      # @param [Integer, nil] count Number of top aggregates to grab
+      #
+      # @return [Hash]
+      #
+      def gnql_stats(query, count: nil)
+        params = {
+          query: query,
+          count: count
+        }.compact
+        _get("/experimental/gnql/stats", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/greynoise/clients/meta.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GreyNoise
+  module Clients
+    class Meta < Client
+      #
+      # Get more information about a given IP address.
+      #
+      # @param [String] ip an IP address
+      #
+      # @return [Hash]
+      #
+      def metadata
+        _get("/meta/metadata") { |json| json }
+      end
+    end
+  end
+end

data/lib/greynoise/clients/noise.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GreyNoise
+  module Clients
+    class Noise < Client
+      #
+      # Get more information about a given IP address.
+      #
+      # @param [String] ip an IP address
+      #
+      # @return [Hash]
+      #
+      def context(ip)
+        _get("/noise/context/#{ip}") { |json| json }
+      end
+
+      #
+      # Check whether a given IP address is “Internet background noise”, or has been observed scanning or attacking devices across the Internet.
+      #
+      # @param [String] ip an IP address
+      #
+      # @return [Hash]
+      #
+      def quick(ip)
+        _get("/noise/quick/#{ip}") { |json| json }
+      end
+
+      #
+      # Check whether a set of IP addresses are "Internet background noise", or have been observed scanning or attacking devices across the Internet.
+      #
+      # @param [Array<String>] *ips a set of IP address
+      #
+      # @return [Array]
+      #
+      def multi_quick(*ips)
+        params = {
+          ips: ips.join(",")
+        }
+        _get("/noise/multi/quick", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/greynoise/version.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: greynoise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-27 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: GreyNoise API wrapper for Ruby
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- greynoise.gemspec
+- lib/greynoise.rb
+- lib/greynoise/api.rb
+- lib/greynoise/clients/client.rb
+- lib/greynoise/clients/experimental.rb
+- lib/greynoise/clients/meta.rb
+- lib/greynoise/clients/noise.rb
+- lib/greynoise/version.rb
+homepage: https://github.com/ninoseki/greynoise
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ninoseki/greynoise
+  source_code_uri: https://github.com/ninoseki/greynoise
+  changelog_uri: https://github.com/ninoseki/greynoise/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: GreyNoise API wrapper for Ruby
+test_files: []