ronin-nmap 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 555ce2b5491e4a0a1ce2dd0fa9fc72f1e08b9112e278b1f867ea3e27a697ff65
+  data.tar.gz: 1f80b02966fc0d67052da39abca3bec7da09113b1682371190803b838f4f62b7
+SHA512:
+  metadata.gz: 2e014461fb8addf6d3fac68691b6c22c9ef7543b9d9bd6bfadf9a4789a2f9f310ea3598b42ee6c0ecb183a07816c3d4c51acb7a4dc94cd0e58a1051d7e84a11d
+  data.tar.gz: 156d5eefea7182531f1c31f0f9222697631e057f8fc18e09c78bb86761a3635224ff3ca720869ecb9c86700b1df91472e1fb6848f7bc354ac96abfe9e0b9eb69

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+- 
+ChangeLog.md
+COPYING.txt

data/.github/workflows/ruby.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install libsqlite3
+        run: |
+          sudo apt update -y && \
+          sudo apt install -y --no-install-recommends --no-install-suggests libsqlite3-dev
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.gitignore

@@ -0,0 +1,14 @@
+/coverage
+/data/completion/ronin-nmap
+/doc
+/pkg
+/man/*.[1-9]
+/vendor/bundle
+/Gemfile.lock
+/.bundle
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-nmap specific exceptions
+#
+Style/ExplicitBlockArgument:
+  Exclude:
+    - 'lib/ronin/nmap/converters/csv.rb'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ronin::Nmap Documentation' --protected

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ChangeLog.md

@@ -0,0 +1,10 @@
+### 0.1.0 / 2024-XX-XX
+
+* Initial release:
+  * Supports automating `nmap` using [ruby-nmap].
+  * Supports parsing and filtering nmap XML.
+  * Supports converting nmap XML into JSON or CSV.
+  * Supports importing nmap XML data into the [ronin-db] database.
+
+[ruby-nmap]: https://github.com/postmodern/ruby-nmap#readme
+[ronin-db]: https://github.com/ronin-rb/ronin-db#readme

data/Gemfile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+platform :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+  gem 'activerecord-jdbcsqlite3-adapter', '~> 70.0'
+  gem 'activerecord', '< 7.1.0'
+end
+
+# gem 'ruby-nmap', '~> 1.0', github: 'postmodern/ruby-nmap'
+
+# Ronin dependencies
+# gem 'ronin-core', '~> 0.2', github: 'ronin-rb/ronin-core',
+#                             branch: 'main'
+# gem 'ronin-db',   '~> 0.2', github: 'ronin-rb/ronin-db',
+#                             branch: 'main'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+
+  gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.20'
+
+  gem 'kramdown',       '~> 2.0'
+  gem 'kramdown-man',   '~> 1.0'
+
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',            '~> 0.9'
+  gem 'yard-spellcheck', require: false
+
+  gem 'dead_end',        require: false
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
+
+  gem 'command_kit-completion', '~> 0.2', require: false
+end

data/README.md

@@ -0,0 +1,238 @@
+# ronin-nmap
+
+[![CI](https://github.com/ronin-rb/ronin-nmap/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-nmap/actions/workflows/ruby.yml)
+[![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-nmap.svg)](https://codeclimate.com/github/ronin-rb/ronin-nmap)
+
+* [Website](https://ronin-rb.dev/)
+* [Source](https://github.com/ronin-rb/ronin-nmap)
+* [Issues](https://github.com/ronin-rb/ronin-nmap/issues)
+* [Documentation](https://ronin-rb.dev/docs/ronin-nmap/frames)
+* [Discord](https://discord.gg/6WAb3PsVX9) |
+  [Mastodon](https://infosec.exchange/@ronin_rb)
+
+## Description
+
+ronin-nmap is a Ruby library for working with nmap. ronin-nmap can parse nmap
+XML, convert nmap XML into JSON or CSV, or import nmap XML into the [ronin-db]
+database.
+
+## Features
+
+* Supports automating `nmap` using [ruby-nmap].
+* Supports parsing and filtering nmap XML.
+* Supports converting nmap XML into JSON or CSV.
+* Supports importing nmap XML data into the [ronin-db] database.
+
+## Synopsis
+
+```
+Usage: ronin-nmap [options]
+
+Options:
+    -V, --version                    Prints the version and exits
+    -h, --help                       Print help information
+
+Arguments:
+    [COMMAND]                        The command name to run
+    [ARGS ...]                       Additional arguments for the command
+
+Commands:
+    completion
+    convert
+    dump
+    grep
+    help
+    import
+    new
+    print
+    scan
+```
+
+Import an nmap XML scan file into [ronin-db]\:
+
+```shell
+$ ronin-nmap import scan.xml
+```
+
+Perform an nmap scan and import it's results into the [ronin-db]\:
+
+```shell
+$ ronin-nmap scan --import -- -sT -sV -p 22,25,80,443
+```
+
+Parse and filter an nmap XML scan file:
+
+```shell
+$ ronin-nmap parse --hosts-with-port 443 scan.xml
+```
+
+Dump a nmap XML scan file to a list of `IP:PORT` pairs:
+
+```shell
+$ ronin-nmap dump --print-ip-ports scan.xml
+```
+
+Dump a nmap XML scan file to a list of `HOST:PORT` pairs:
+
+```shell
+$ ronin-nmap dump --print-host-ports scan.xml
+```
+
+Dump a nmap XML scan file to a list of `http`://` or `https://` URIs:
+
+```shell
+$ ronin-nmap dump --print-uris scan.xml
+```
+
+Convert an nmap XML scan file to CSV:
+
+```shell
+$ ronin-nmap convert scan.xml scan.csv
+```
+
+Convert an nmap XML scan file to JSON:
+
+```shell
+$ ronin-nmap convert scan.xml scan.json
+```
+
+Generate a new nmap scanner Ruby script:
+
+```shell
+$ ronin-nmap new scanner.rb --target example.com --ports 22,80,443,8000-9000
+```
+
+Generate a new nmap XML parser script:
+
+```shell
+$ ronin-nmap new parser.rb --parser --xml-file path/to/nmap.xml --printing
+```
+
+## Examples
+
+Performing an `nmap` scan and returning the parsed nmap XML data:
+
+```ruby
+require 'ronin/nmap'
+
+xml = Ronin::Nmap.scan(syn_scan: true, ports: [80, 443], targets: '192.168.1.*')
+# => #<Nmap::XML: ...>
+
+xml = Ronin::Nmap.scan do |nmap|
+  nmap.syn_scan = true
+  nmap.ports    = [80, 443]
+  nmap.targets  = '192.168.1.*'
+end
+# => #<Nmap::XML: ...>
+```
+
+Accessesing the nmap XML scan data:
+
+```ruby
+xml.hosts
+# => [#<Nmap::XML::Host: 192.168.1.1>, ...]
+
+host = xml.host
+# => #<Nmap::XML::Host: scanme.nmap.org>
+
+xml.host.open_ports
+# => [#<Nmap::XML::Port: 22>,
+#     #<Nmap::XML::Port: 80>,
+#     #<Nmap::XML::Port: 9929>,
+#     #<Nmap::XML::Port: 31337>,
+#     #<Nmap::XML::Port: 123>]
+
+port = xml.host.open_ports.first
+# => #<Nmap::XML::Port: 22>
+
+port.state
+# => :open
+
+port.protocol
+# => :tcp
+
+port.service
+# => #<Nmap::XML::Service:0x00007f5614e68248 @node=#<Nokogiri::XML::Element:0x7ada0 name="service" attribute_nodes=[#<Nokogiri::XML::Attr:0x7aecc name="name" value="ssh">, #<Nokogiri::XML::Attr:0x7b05c name="extrainfo" value="protocol 2.0">, #<Nokogiri::XML::Attr:0x7b1ec name="servicefp" value="SF-Port22-TCP:V=6.45%I=7%D=4/17%Time=55316FE1%P=x86_64-redhat-linux-gnu%r(NULL,29,\"SSH-2\\.0-OpenSSH_6\\.6\\.1p1\\x20Ubuntu-2ubuntu2\\r\\n\");">, #<Nokogiri::XML::Attr:0x7b37c name="method" value="probed">, #<Nokogiri::XML::Attr:0x7b50c name="conf" value="10">]>>
+
+port.scripts
+# => {"ssh-hostkey"=>...,
+#     "ssh2-enum-algos"=>...}
+```
+
+Printing the parsed nmap XML data:
+
+```ruby
+xml.each_host do |host|
+  puts "[ #{host.ip} ]"
+
+  host.each_port do |port|
+    puts "  #{port.number}/#{port.protocol}\t#{port.state}\t#{port.service}"
+
+    port.scripts.each do |id,script|
+      puts "    [ #{id} ]"
+
+      script.output.each_line { |line| puts "      #{line}" }
+    end
+  end
+end
+```
+
+## Requirements
+
+* [Ruby] >= 3.0.0
+* [nmap] >= 5.00
+* [ruby-nmap] ~> 1.0
+* [ronin-core] ~> 0.2
+* [ronin-db] ~> 0.2
+
+## Install
+
+```shell
+$ gem install ronin-nmap
+```
+
+### Gemfile
+
+```ruby
+gem 'ronin-nmap', '~> 0.1'
+```
+
+### gemspec
+
+```ruby
+gem.add_dependency 'ronin-nmap', '~> 0.1'
+```
+
+## Development
+
+1. [Fork It!](https://github.com/ronin-rb/ronin-nmap/fork)
+2. Clone It!
+3. `cd ronin-nmap/`
+4. `./scripts/setup`
+5. `git checkout -b my_feature`
+6. Code It!
+7. `bundle exec rake spec`
+8. `git push origin my_feature`
+
+## License
+
+Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+
+ronin-nmap is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+ronin-nmap is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with ronin-nmap.  If not, see <https://www.gnu.org/licenses/>.
+
+[Ruby]: https://www.ruby-lang.org
+[nmap]: http://www.insecure.org/
+[ruby-nmap]: https://github.com/postmodern/ruby-nmap#readme
+[ronin-core]: https://github.com/ronin-rb/ronin-core#readme
+[ronin-db]: https://github.com/ronin-rb/ronin-db#readme

data/Rakefile

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler"
+  exit(-1)
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new(sign: {checksum: true, pgp: true})
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :docs => :yard
+
+require 'kramdown/man/task'
+Kramdown::Man::Task.new
+
+require 'command_kit/completion/task'
+CommandKit::Completion::Task.new(
+  class_file:  'ronin/nmap/cli',
+  class_name:  'Ronin::Nmap::CLI',
+  output_file: 'data/completions/ronin-nmap'
+)
+
+task :setup => %w[man command_kit:completion]

data/bin/ronin-nmap

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-nmap is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-nmap is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-nmap.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+root = File.expand_path(File.join(__dir__,'..'))
+if File.file?(File.join(root,'Gemfile.lock'))
+  Dir.chdir(root) do
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
+  end
+end
+
+require 'ronin/nmap/cli'
+Ronin::Nmap::CLI.start