Skip to content

ronin-rb/ronin-masscan

Repository files navigation

ronin-masscan

CI Code Climate

Description

ronin-masscan is a Ruby library and CLI for working with masscan.

Features

  • Supports automating masscan using ruby-masscan.
  • Supports parsing and filtering masscan scan files.
  • Supports converting masscan scan files into JSON or CSV.
  • Supports importing masscan scan files into the ronin-db database.

Synopsis

Usage: ronin-masscan [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
    print
    scan

Import a binary masscan scan file:

$ ronin-masscan import masscan.bin

Perform a masscan scan and import it's results into the ronin-db:

$ ronin-masscan scan --import -- 192.168.1.1 -p22,25,80,443

Parse and filter an nmap XML scan file:

Import a JSON masscan scan file:

$ ronin-masscan import masscan.json

Dumps a masscan scan file to a list of IP:PORT pairs:

$ ronin-masscan dump --print-ip-ports masscan.bin

Dump a masscan scan file to a list of HOST:PORT pairs:

$ ronin-masscan dump --print-host-ports masscan.bin

Dump a masscan scan file to a list of http://orhttps://` URIs:

$ ronin-masscan dump --print-uris masscan.bin

Convert a binary masscan scan file to CSV:

$ ronin-masscan convert masscan.bin masscan.csv

Convert a binary masscan scan file to JSON:

$ ronin-masscan convert masscan.bin masscan.json

Requirements

Install

$ gem install ronin-masscan

Gemfile

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

gemspec

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

Development

  1. Fork It!
  2. Clone It!
  3. cd ronin-masscan/
  4. bundle install
  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-masscan 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-masscan 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-masscan. If not, see https://www.gnu.org/licenses/.