passive_circl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20426057d1a9c6e5cd7eb6d6c8e7ed9aaa3d22899350c3650d603530c06ab981
+  data.tar.gz: 516af177819a02c7fc92877eb7cad1b3efdad3d3ad7a5a18f22d74c2afde2d13
+SHA512:
+  metadata.gz: dc1c159d9fcb742ee995ae8fe8399a2d3525ce7ba475f9c778520be6e53bf1f905990485689081690227e9a9b0c7c2212bcc987be46b1f5f0272c8bcd0ee4055
+  data.tar.gz: a34a7ec536bbdcee785c064b2209347fbaf05b6a0438114172824a0ca7f5c43bac8a872b784d698dd804266bb1e88c5ae9588f69faa48a0de42b840ee1d8a430

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
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in passive_circl.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,34 @@
+# passive_circl
+
+[![Build Status](https://travis-ci.com/ninoseki/passive_circl.svg?branch=master)](https://travis-ci.com/ninoseki/passive_circl)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/passive_circl/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/passive_circl?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/passive_circl/badge)](https://www.codefactor.io/repository/github/ninoseki/passive_circl)
+
+[CIRCL](https://www.circl.lu/) Passive DNS/SSL API wrapper for Ruby.
+
+## Installation
+
+```bash
+gem install passive_circl
+```
+
+## Usage
+
+```ruby
+require "passive_circl"
+
+# when given nothing, it tries to load username and password from ENV["CIRCL_PASSIVE_USERNAME] and ENV["CIRCL_PASSIVE_PASSWORD"]
+api = PassiveCIRCL::API.new
+# or you can set them manually
+api = PassiveCIRCL::API.new(username: "USERNAME", password: "PASSWORD")
+
+api.dns.query("www.circl.lu")
+
+api.ssl.query("172.228.24.0/28")
+api.ssl.cquery("c46fed822dadac3f31f9bb4d1a78a1d9eae4567b")
+api.ssl.cfetch("7c552ab044c76d1df4f5ddf358807bfdcd07fa57")
+```
+
+## 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 "passive_circl"
+
+# 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/passive_circl.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "passive_circl/version"
+
+require "passive_circl/clients/base"
+
+require "passive_circl/clients/ssl"
+require "passive_circl/clients/dns"
+
+require "passive_circl/api"
+
+module PassiveCIRCL
+  class Error < StandardError; end
+end

data/lib/passive_circl/api.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PassiveCIRCL
+  class API
+    attr_reader :dns
+    attr_reader :ssl
+
+    def initialize(username: ENV["CIRCL_PASSIVE_USERNAME"], password: ENV["CIRCL_PASSIVE_PASSWORD"])
+      @dns = Clients::DNS.new(username: username, password: password)
+      @ssl = Clients::SSL.new(username: username, password: password)
+    end
+  end
+end

data/lib/passive_circl/clients/base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/https"
+require "uri"
+
+module PassiveCIRCL
+  module Clients
+    class Base
+      HOST = "www.circl.lu"
+      BASE_URL = "https://#{HOST}"
+
+      def initialize(username:, password:)
+        @username = username
+        @password = password
+      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|
+          response = http.request(req)
+
+          code = response.code.to_i
+          raise Error, "Unsupported response code returned: #{code}" if code != 200
+
+          body = response.body
+          content_type = response["Content-Type"].to_s
+
+          if content_type.include?("application/json")
+            yield JSON.parse body
+          else
+            list = body.lines.map { |line| JSON.parse line }
+            yield list
+          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)
+        get.basic_auth @username, @password
+
+        request(get, &block)
+      end
+    end
+  end
+end

data/lib/passive_circl/clients/dns.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PassiveCIRCL
+  module Clients
+    class DNS < Base
+      def query(value)
+        _get("/pdns/query/#{value}") { |json| json }
+      end
+    end
+  end
+end

data/lib/passive_circl/clients/ssl.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PassiveCIRCL
+  module Clients
+    class SSL < Base
+      VERSION = "v2"
+
+      def query(cidr)
+        _get("/query/#{cidr}") { |json| json }
+      end
+
+      def cquery(fingerprint)
+        _get("/cquery/#{fingerprint}") { |json| json }
+      end
+
+      def cfetch(fingerprint)
+        _get("/cfetch/#{fingerprint}") { |json| json }
+      end
+
+      private
+
+      def url_for(path)
+        URI(BASE_URL + "/#{VERSION}pssl" + path)
+      end
+    end
+  end
+end

data/lib/passive_circl/version.rb

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

data/passive_circl.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "passive_circl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "passive_circl"
+  spec.version       = PassiveCIRCL::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "CIRCL Passive DNS/SSL API wrapper for Ruby"
+  spec.description   = "CIRCL Passive DNS/SSL API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/passive_circl"
+  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 "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: passive_circl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-01 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: 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: '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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: CIRCL Passive DNS/SSL 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
+- lib/passive_circl.rb
+- lib/passive_circl/api.rb
+- lib/passive_circl/clients/base.rb
+- lib/passive_circl/clients/dns.rb
+- lib/passive_circl/clients/ssl.rb
+- lib/passive_circl/version.rb
+- passive_circl.gemspec
+homepage: https://github.com/ninoseki/passive_circl
+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.4
+signing_key: 
+specification_version: 4
+summary: CIRCL Passive DNS/SSL API wrapper for Ruby
+test_files: []