ruby-rustscan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed273c201a779c2af67db77c918ceb5be91d5215115d0f24bf9eb4f787f54ec3
+  data.tar.gz: ecc1c363ba8068c177202cbe1e20f27e8740b2783637c1c7a815af9a25b5c84e
+SHA512:
+  metadata.gz: 218a92ab0d1fc7ec48d5fbbac74d3a551344df13d933104255437c66b8ad5937f63f532ca895d8fa4b26ce42801851afe4cdc496388cbabe8a4bf7503ea232c0
+  data.tar.gz: 17b7fe2485ac511f0af7ed5530aa316181fade303287e59e38b5b5a7791c74aab1247671c5f227ab8bdea91c7c84c9c3bb55bc2273f5ab38edeaec6333d4b228

data/.document

@@ -0,0 +1,3 @@
+-
+ChangeLog.md
+LICENSE.txt

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,11 @@
+/Gemfile.lock
+/coverage
+/doc
+/pkg
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ruby Gobuster Documentation' --protected

data/ChangeLog.md

@@ -0,0 +1,5 @@
+### 0.1.0 / 2021-04-22
+
+* Initial release:
+  * Added {Rustscan::Command}.
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# gem 'command_mapper', '~> 0.2', github: 'postmodern/command_mapper.rb'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+  gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.7'
+
+  gem 'kramdown'
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Hal Brodigan
+
+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,64 @@
+# ruby-rustscan
+
+[![CI](https://github.com/postmodern/ruby-rustscan/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/ruby-rustscan/actions/workflows/ruby.yml)
+[![Gem Version](https://badge.fury.io/rb/ruby-rustscan.svg)](https://badge.fury.io/rb/ruby-rustscan)
+
+* [Source](https://github.com/postmodern/ruby-rustscan/)
+* [Issues](https://github.com/postmodern/ruby-rustscan/issues)
+* [Documentation](http://rubydoc.info/gems/ruby-rustscan/frames)
+
+## Description
+
+A Ruby interface to [rustscan], the Modern Port Scanner.
+
+## Features
+
+* Provides a [Ruby interface][Rustscan::Command] for running the `rustscan`
+  command.
+
+[Rustscan::Command]: https://rubydoc.info/gems/ruby-rustscan/Rustscan/Command
+
+## Examples
+
+Run `rustscan --addresses 127.0.0.1 -p 80,443` from Ruby:
+
+```ruby
+require 'rustscan/command'
+
+Rustscan::Command.run(addresses: ['127.0.0.1'], ports: [80, 443])
+```
+
+## Requirements
+
+* [ruby] >= 2.0.0
+* [rustscan] >= 2.0.0
+* [command_mapper] ~> 0.2, >= 0.2.1
+
+[ruby]: https://www.ruby-lang.org/
+[command_mapper]: https://github.com/postmodern/command_mapper.rb#readme
+
+## Install
+
+```shell
+$ gem install ruby-rustscan
+```
+
+### gemspec
+
+```ruby
+gemspec.add_dependency 'ruby-rustscan', '~> 0.1'
+```
+
+### Gemfile
+
+```ruby
+gem 'ruby-rustscan', '~> 0.1'
+```
+
+## License
+
+Copyright (c) 2022 Hal Brodigan
+
+See {file:LICENSE.txt} for license information.
+
+[rustscan]: https://github.com/OJ/rustscan#readme

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler"
+  exit -1
+end
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,27 @@
+name: ruby-rustscan
+summary: A Ruby interface to rustscan.
+description:
+  A Ruby interface to rustscan, the Modern Port Scanner.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/ruby-rustscan#readme
+has_yard: true
+
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ruby-rustscan
+  source_code_uri:   https://github.com/postmodern/ruby-rustscan
+  bug_tracker_uri:   https://github.com/postmodern/ruby-rustscan/issues
+  changelog_uri:     https://github.com/postmodern/ruby-rustscan/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
+required_ruby_version: ">= 2.0.0"
+
+requirements: rustscan >= 2.0.0
+
+dependencies:
+  command_mapper: ~> 0.2, >= 0.2.1
+
+development_dependencies:
+  bundler: ~> 2.0

data/lib/rustscan/command.rb

@@ -0,0 +1,26 @@
+require 'command_mapper/command'
+
+module Rustscan
+  class Command < CommandMapper::Command
+
+    command 'rustscan' do
+      option '--accessible'
+      option '--greppable'
+      option '--help'
+      option '--no-config'
+      option '--top'
+      option '--version'
+      option '--addresses', value: {type: List.new}
+      option '--batch-size', value: {type: Num.new}
+      option '--ports', value: {type: List.new(type: Num.new)}
+      option '--scan-order', value: {type: Enum[:serial, :random]}
+      option '--scripts', value: {type: Enum[:none, :default, :custom]}
+      option '--timeout', value: {type: Num.new}
+      option '--tries', value: {type: Num.new}
+      option '--ulimit', value: {type: Num.new}
+
+      argument :command, repeats: true, required: false
+    end
+
+  end
+end

data/lib/rustscan/version.rb

@@ -0,0 +1,4 @@
+module Rustscan
+  # ruby-rustscan version
+  VERSION = '0.1.0'
+end

data/ruby-rustscan.gemspec

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'rustscan/version'
+                  Rustscan::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = Array(gemspec['requirements'])
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,256 @@
+require 'spec_helper'
+require 'rustscan/command'
+
+describe Rustscan::Command do
+  describe ".command_name" do
+    subject { described_class }
+
+    it "must be set to 'rustscan'" do
+      expect(subject.command_name).to eq('rustscan')
+    end
+  end
+
+  describe ":addresses" do
+    let(:ip1) { '127.0.0.1'   }
+    let(:ip2) { '192.168.1.1' }
+
+    let(:addresses) { [ip1, ip2] }
+
+    subject { described_class.new(addresses: addresses) }
+
+    it "must map multiple addresses to --addresses and a comma separated list" do
+      expect(subject.command_argv).to eq(
+        [subject.command_name, '--addresses', "#{ip1},#{ip2}"]
+      )
+    end
+  end
+
+  describe ":batch_size" do
+    let(:batch_size) { 10 }
+
+    subject { described_class.new(batch_size: batch_size) }
+
+    it "must map to --batch-size" do
+      expect(subject.command_argv).to eq(
+        [subject.command_name, '--batch-size', "#{batch_size}"]
+      )
+    end
+
+    context "but when a non-number is given" do
+      let(:batch_size) { "foo" }
+
+      it "must only accept numeric values" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option batch_size was given an invalid value (#{batch_size.inspect}): contains non-numeric characters (#{batch_size.inspect})")
+      end
+    end
+  end
+
+  describe ":ports" do
+    let(:port1) { 80   }
+    let(:port2) { 443  }
+    let(:port3) { 8080 }
+    let(:ports) { [port1, port2, port3] }
+
+    subject { described_class.new(ports: ports) }
+
+    it "must map to --ports and a comma-separated list" do
+      expect(subject.command_argv).to eq(
+        [subject.command_name, '--ports', "#{port1},#{port2},#{port3}"]
+      )
+    end
+
+    context "but when a non-number is given" do
+      let(:port2) { "foo" }
+
+      it "must only accept numeric values" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option ports was given an invalid value (#{ports.inspect}): element contains non-numeric characters (#{port2.inspect})")
+      end
+    end
+  end
+
+  describe ":scan_order" do
+    context "when given :serial" do
+      let(:scan_order) { :serial }
+
+      subject { described_class.new(scan_order: scan_order) }
+
+      it "must map to --scan-order serial" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--scan-order', "#{scan_order}"]
+        )
+      end
+    end
+
+    context "when given :random" do
+      let(:scan_order) { :random }
+
+      subject { described_class.new(scan_order: scan_order) }
+
+      it "must map to --scan-order random" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--scan-order', "#{scan_order}"]
+        )
+      end
+    end
+
+    context "but when given an invalid scan order type" do
+      let(:scan_order) { :foo }
+
+      subject { described_class.new(scan_order: scan_order) }
+
+      it "must only accept :serial or :random" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option scan_order was given an invalid value (#{scan_order.inspect}): unknown value (#{scan_order.inspect}) must be :serial, :random, or \"serial\", \"random\"")
+      end
+    end
+  end
+
+  describe ":scripts" do
+    context "when given :none" do
+      let(:scripts) { :none }
+
+      subject { described_class.new(scripts: scripts) }
+
+      it "must map to --scripts none" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--scripts', "#{scripts}"]
+        )
+      end
+    end
+
+    context "when given :default" do
+      let(:scripts) { :default }
+
+      subject { described_class.new(scripts: scripts) }
+
+      it "must map to --scripts default" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--scripts', "#{scripts}"]
+        )
+      end
+    end
+
+    context "when given :custom" do
+      let(:scripts) { :custom}
+
+      subject { described_class.new(scripts: scripts) }
+
+      it "must map to --scripts custom" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--scripts', "#{scripts}"]
+        )
+      end
+    end
+
+    context "but when given an invalid scan order type" do
+      let(:scripts) { :foo }
+
+      subject { described_class.new(scripts: scripts) }
+
+      it "must only accept :none, :default, or :random" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option scripts was given an invalid value (#{scripts.inspect}): unknown value (#{scripts.inspect}) must be :none, :default, :custom, or \"none\", \"default\", \"custom\"")
+      end
+    end
+  end
+
+  describe ":timeout" do
+    let(:timeout) { 10 }
+
+    subject { described_class.new(timeout: timeout) }
+
+    it "must map to --timeout" do
+      expect(subject.command_argv).to eq(
+        [subject.command_name, '--timeout', "#{timeout}"]
+      )
+    end
+
+    context "but when a non-number is given" do
+      let(:timeout) { "foo" }
+
+      it "must only accept numeric values" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option timeout was given an invalid value (#{timeout.inspect}): contains non-numeric characters (#{timeout.inspect})")
+      end
+    end
+  end
+
+  describe ":tries" do
+    let(:tries) { 10 }
+
+    subject { described_class.new(tries: tries) }
+
+    it "must map to --tries" do
+      expect(subject.command_argv).to eq(
+        [subject.command_name, '--tries', "#{tries}"]
+      )
+    end
+
+    context "but when a non-number is given" do
+      let(:tries) { "foo" }
+
+      it "must only accept numeric values" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option tries was given an invalid value (#{tries.inspect}): contains non-numeric characters (#{tries.inspect})")
+      end
+    end
+  end
+
+  describe ":ulimit" do
+    let(:ulimit) { 10 }
+
+    subject { described_class.new(ulimit: ulimit) }
+
+    it "must map to --ulimit" do
+      expect(subject.command_argv).to eq(
+        [subject.command_name, '--ulimit', "#{ulimit}"]
+      )
+    end
+
+    context "but when a non-number is given" do
+      let(:ulimit) { "foo" }
+
+      it "must only accept numeric values" do
+        expect {
+          subject.command_argv
+        }.to raise_error(CommandMapper::ValidationError,"option ulimit was given an invalid value (#{ulimit.inspect}): contains non-numeric characters (#{ulimit.inspect})")
+      end
+    end
+  end
+
+  describe ":command" do
+    let(:addresses) { '127.0.0.1' }
+
+    context "when given one value" do
+      let(:command) { '-A' }
+
+      subject { described_class.new(addresses: addresses, command: command) }
+
+      it "must append the value to the end of the command" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--addresses', "#{addresses}", '--', command]
+        )
+      end
+    end
+
+    context "when given multiple values" do
+      let(:command) { %w[-A -sC] }
+
+      subject { described_class.new(addresses: addresses, command: command) }
+
+      it "must append each value to the end of the command" do
+        expect(subject.command_argv).to eq(
+          [subject.command_name, '--addresses', "#{addresses}", '--', *command]
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'simplecov'
+SimpleCov.start

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ruby-rustscan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: command_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !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'
+description: A Ruby interface to rustscan, the Modern Port Scanner.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/rustscan/command.rb
+- lib/rustscan/version.rb
+- ruby-rustscan.gemspec
+- spec/command_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/postmodern/ruby-rustscan#readme
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ruby-rustscan
+  source_code_uri: https://github.com/postmodern/ruby-rustscan
+  bug_tracker_uri: https://github.com/postmodern/ruby-rustscan/issues
+  changelog_uri: https://github.com/postmodern/ruby-rustscan/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- rustscan >= 2.0.0
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A Ruby interface to rustscan.
+test_files: []