Skip to content

Latest commit

 

History

History
240 lines (180 loc) · 7.1 KB

README.md

File metadata and controls

240 lines (180 loc) · 7.1 KB

Ronin

Build Status

Description

Ronin is a Ruby platform for vulnerability research and exploit development. Ronin allows for the rapid development and distribution of code, Exploits, Payloads, Scanners, etc, via Repositories.

Console

Ronin provides users with a powerful Ruby Console, pre-loaded with powerful convenience methods. In the Console one can work with data and automate complex tasks, with greater ease than the command-line.

>> File.read('data').base64_decode

Database

Ronin ships with a preconfigured Database, that one can interact with from Ruby, without having to write any SQL.

>> HostName.tld('eu').urls.with_query_param('id')

Repositories

Ronin provides a Repository system, allowing users to organize and share miscallaneous Data, Code, Exploits, Payloads, Scanners, etc.

$ ronin install git://github.com/user/myexploits.git

Libraries

Ronin provides libraries with additional functionality, such as Exploitation and Scanning:

$ gem install ronin-exploits

Features

  • Supports installing/updating/uninstalling of Repositories.
  • Provides a Database using DataMapper with:
    • {Ronin::Author}
    • {Ronin::License}
    • {Ronin::Arch}
    • {Ronin::OS}
    • {Ronin::Software}
    • {Ronin::Vendor}
    • {Ronin::Address}
      • {Ronin::MACAddress}
      • {Ronin::IPAddress}
      • {Ronin::HostName}
    • {Ronin::Port}
      • {Ronin::TCPPort}
      • {Ronin::UDPPort}
    • {Ronin::Service}
    • {Ronin::OpenPort}
    • {Ronin::OSGuess}
    • {Ronin::UserName}
    • {Ronin::URL}
    • {Ronin::EmailAddress}
    • {Ronin::Credential}
      • {Ronin::ServiceCredential}
      • {Ronin::WebCredential}
    • {Ronin::Organization}
    • {Ronin::Campaign}
    • {Ronin::Target}
  • Caches exploits, payloads, scanners, etc stored within Repositories into the Database.
  • Convenience methods provided by ronin-support.
  • Provides a customized Ruby Console using Ripl with:
    • Syntax highlighting.
    • Tab completion.
    • Auto indentation.
    • Pretty Printing (pp).
    • print_info, print_error, print_warning and print_debug output helper methods with color-output.
    • Inline commands (!nmap -v -sT victim.com)
  • Provides an extensible command-line interface.

Synopsis

Start the Ronin console:

$ ronin

Run a Ruby script in Ronin:

$ ronin exec script.rb

View available commands:

$ ronin help

View a man-page for a command:

$ ronin help wordlist

Install a Repository:

$ ronin install svn://example.com/path/to/repo

List installed Repositories:

$ ronin repos

Update all installed Repositories:

$ ronin update

Update a specific Repositories:

$ ronin update repo-name

Uninstall a specific Repositories:

$ ronin uninstall repo-name

List available Databases:

$ ronin database

Add a new Database:

$ ronin database --add team --uri mysql://user:[email protected]/db

Remove a Database:

$ ronin database --remove team

Requirements

Install

Stable

$ gem install ronin

Edge

$ git clone git://github.com/ronin-ruby/ronin.git
$ cd ronin/
$ bundle install
$ ./bin/ronin

License

Copyright (c) 2006-2013 Hal Brodigan (postmodern.mod3 at gmail.com)

This file is part of Ronin.

Ronin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Ronin 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with Ronin. If not, see http://www.gnu.org/licenses/.