ronin-nmap

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:
    convert
    dump
    help
    import
    scan

Import an nmap XML scan file into ronin-db:

$ ronin-nmap import scan.xml

Perform an nmap scan and import it's results into the ronin-db:

$ ronin-nmap scan --import -- -sT -sV -p 22,25,80,443

Parse and filter an nmap XML scan file:

$ ronin-nmap parse --hosts-with-port 443 scan.xml

Convert an nmap XML scan file to a list of IP:PORT pairs:

$ ronin-nmap dump --print-ip-ports scan.xml

Convert an nmap XML scan file to a list of HOST:PORT pairs:

$ ronin-nmap dump --print-host-ports scan.xml

Convert an nmap XML scan file to a list of http://orhttps://` URIs:

$ ronin-nmap dump --print-uris scan.xml

Convert an nmap XML scan file to CSV:

$ ronin-nmap convert scan.xml scan.csv

Convert an nmap XML scan file to JSON:

$ ronin-nmap convert scan.xml scan.json

Examples

require 'ronin/nmap'

xml = Ronin::Nmap.scan(syn_scan: true, ports: [80, 443], targets: '192.168.1.*')
# => #<Nmap::XML: ...>
xml.hosts
# => [#<Nmap::XML::Host: 192.168.1.1>, ...]

host = xml.hosts.first
host.open_ports

Requirements

Ruby >= 3.0.0
nmap >= 5.00
ruby-nmap ~> 1.0
ronin-core ~> 0.2
ronin-db ~> 0.2

Install

$ gem install ronin-nmap

Gemfile

gem 'ronin-nmap', '~> 0.1'

gemspec

gem.add_dependency 'ronin-nmap', '~> 0.1'

Development

Fork It!
Clone It!
cd ronin-nmap/
bundle install
git checkout -b my_feature
Code It!
bundle exec rake spec
git push origin my_feature

License

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/.

moozzi/ronin-nmap