# Ronin Support

* [Source](https://github.com/ronin-ruby/ronin-support)
* [Issues](https://github.com/ronin-ruby/ronin-support/issues)
* [Documentation](http://ronin-ruby.github.com/docs/ronin-support/frames)
* [Mailing List](http://groups.google.com/group/ronin-ruby)
* [irc.freenode.net #ronin](http://webchat.freenode.net/?channels=ronin&uio=Mj10cnVldd)

## Description

Ronin Support is a support library for Ronin. Ronin Support contains many of
the convenience methods used by Ronin and additional libraries.

Ronin is a Ruby platform for exploit development and security research.
Ronin allows for the rapid development and distribution of code, exploits
or payloads over many common Source-Code-Management (SCM) systems.

## Features

* Provides convenience methods for:
  * Formatting data:
    * Binary
    * Text
    * HTTP
    * URIs
    * HTML
    * JavaScript
    * SQL
  * Fuzzing
  * Networking:
    * DNS
    * TCP
    * UDP
    * SSL
    * SMTP / ESMTP
    * POP3
    * Imap
    * Telnet
    * HTTP / HTTPS
  * Enumerating IP ranges:
    * IPv4 / IPv6 addresses.
    * CIDR / globbed ranges.
  * (Un-)Hexdumping data.
  * Handling exceptions.
* Provides Modules/Classes for:
  * Paths
  * Wordlists
  * Erb Templates
  * UI:
    * Terminal Output
    * Custom Shells

## Examples

For examples of the convenience methods provided by ronin-support,
please see [Everyday Ronin](http://ronin-ruby.github.com/guides/everyday_ronin.html).

## Requirements

* [Ruby](http://www.ruby-lang.org/) >= 1.8.7
* [chars](https://github.com/postmodern/chars#readme)
  ~> 0.2
* [hexdump](https://github.com/postmodern/hexdump#readme)
  ~> 0.1
* [combinatorics](https://github.com/postmodern/combinatorics#readme)
  ~> 0.4
* [uri-query_params](https://github.com/postmodern/uri-query_params#readme)
  ~> 0.6
* [data_paths](https://github.com/postmodern/data_paths#readme)
  ~> 0.3
* [parameters](https://github.com/postmodern/parameters#readme)
  ~> 0.4

## Install

### Stable

    $ gem install ronin-support

### Edge

    $ git clone git://github.com/ronin-ruby/ronin-support.git
    $ cd ronin-support/
    $ bundle install
    $ rake console

## License

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

This file is part of Ronin Support.

Ronin Support 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 Support 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 Support.  If not, see <http://www.gnu.org/licenses/>.