Documentation

Guides

Getting Started - Explains how to install Ronin.

CLI

Using the Ronin CLI - Explains how to use Ronin’s many commands and sub-commands.
Using ronin-db - Explains how to interact with Ronin’s built-in database.
Using ronin-repos - Explains how to install and manage 3rd-party git repositories that can contain exploits or payloads.

Ruby

Using the Ronin Ruby Shell - Explains how to use Ronin’s interactive Ruby Shell.
Ruby Quick Ref - Provides a quick reference of Ruby’s syntax.
Writing Ronin Ruby Scripts - Explains how to write Ruby scripts using ronin-support.

Porting

Porting Metasploit Exploits to Ronin Exploits - A guide that explains how to convert Metasploit exploits into Ronin exploits.
Porting Metasploit Payloads to Ronin Payloads - A guide that explains how to convert Metasploit payloads into Ronin payloads.
Porting Python to Ronin Quick Ref - Provides a quick references for converting Python code to Ronin.
Porting Pwnlib to Ronin Quick Ref - Provides a quick references for converting Pwnlib code to Ronin.

Dev

Setting up a Ruby Development Environment - A guide on how to setup a Ruby Development Environment to contribute to Ronin.

Man Pages

API

ronin	2.1.0	A Ruby toolkit for security research and development.
ronin-support	1.1.0	A support library for Ronin.
ronin-support-web	0.1.0	A web support library for ronin-rb.
ronin-core	0.2.0	A core library for all ronin libraries.
ronin-repos	0.2.0	Third-party git repository support for ronin.
ronin-db-activerecord	0.2.0	ActiveRecord backend for the Ronin Database.
ronin-db	0.2.0	A common database library for managing and querying security data.
ronin-dns-proxy	0.1.0	A configurable DNS proxy server library.
ronin-listener-dns	0.1.0	A DNS listener that listens for exfiltrated data via DNS queries.
ronin-listener-http	0.1.0	A HTTP server for receiving exfiled data.
ronin-listener	0.1.0	A Ruby CLI utility for receiving exfiltrated data.
ronin-web-browser	0.1.0	A Ruby library for automating the Chrome web browser.
ronin-web-session_cookie	0.1.0	A library for parsing and deserializing various session cookies.
ronin-web-server	0.1.1	A custom Ruby web server based on Sinatra.
ronin-web-spider	0.2.0	A collection of common web spidering routines.
ronin-web-user_agents	0.1.0	Generates random but realistic User-Agent strings.
ronin-web	2.0.0	A collection of common web security commands and libraries.
ronin-code-asm	1.0.0	A Ruby DSL for crafting Assmebly programs and Shellcode.
ronin-code-sql	2.1.0	A Ruby DSL for crafting SQL Injections.
ronin-post_ex	0.1.0	Ruby API for Post-Exploitation.
ronin-payloads	0.2.0	A Ruby micro-framework for writing and running exploit payloads.
ronin-vulns	0.2.0	Tests URLs for Local File Inclusion (LFI), Remote File Inclusion (RFI), SQL injection (SQLi), Cross Site Scripting (XSS), Server Side Template Injection (SSTI), and Open Redirects.
ronin-exploits	1.1.0	A Ruby micro-framework for writing and running exploits and payloads.
ronin-fuzzer	0.2.0	A highly configurable fuzzing library and CLI for Ruby.
ronin-wordlists	0.1.0	A library for managing wordlists.
ronin-nmap	0.1.0	A Ruby library and CLI for working with nmap.
ronin-masscan	0.1.0	A Ruby library and CLI for working with masscan.
ronin-recon	0.1.0	A micro-framework and tool for performing reconnaissance.
ronin-app	0.1.0	A local web interface for Ronin.