README.md in ronin-2.0.5 vs README.md in ronin-2.1.0.rc1
- old
+ new
@@ -22,11 +22,12 @@
[install 3rd party repositories][ronin-repos-synopsis] of
[exploits][ronin-exploits] and/or
[payloads][ronin-payloads], [run exploits][ronin-exploits-synopsis],
[write new exploits][ronin-exploits-examples],
[managing local databases][ronin-db-synopsis],
-[fuzzing data][ronin-fuzzer], and much more.
+[fuzzing data][ronin-fuzzer],
+[perform recon][ronin-recon-synopsis], and much more.
### Who is Ronin for?
* CTF players
* Bug bounty hunters
@@ -39,10 +40,11 @@
* A toolkit of useful commands.
* A fully-loaded Ruby REPL.
* An ecosystem of high-quality security related Ruby libraries, APIs, and
commands.
+* A lightweight local web UI.
### What can you do with Ronin?
* Quickly process and query various data using the `ronin` commands.
* Efficiently work with code and data in the `ronin irb` Ruby REPL.
@@ -50,13 +52,15 @@
libraries.
* Install 3rd-party [git] repositories of exploits, payloads, or other code,
using [ronin-repos].
* Import and query data using the [ronin-db] database.
* Fuzz data using [ronin-fuzzer].
+* Perform recon using [ronin-recon].
* Use common payloads or write your own using [ronin-payloads].
* Write/run exploits using [ronin-exploits].
* Scan for web vulnerabilities using [ronin-vulns].
+* Performs scans and browse the database in your browser using [ronin-app].
## Synopsis
```
Usage: ronin [options] [COMMAND [ARGS...]]
@@ -67,19 +71,22 @@
Arguments:
[COMMAND] The command name to run
[ARGS ...] Additional arguments for the command
Commands:
+ archive
asn
banner-grab
bitflip
cert-dump
cert-gen
cert-grab
+ completion
decode, dec
decrypt
dns
+ dns-proxy
email-addr
encode, enc
encrypt
entropy
escape
@@ -96,10 +103,11 @@
iprange
irb
md5
netcat, nc
new
+ pack
proxy
public-suffix-list
quote
rot
sha1
@@ -108,24 +116,31 @@
strings
tld-list
tips
typo
typosquat
+ unarchive
unescape
unhexdump
+ unpack
unquote
url
xor
Additional Ronin Commands:
$ ronin-repos
+ $ ronin-wordlists
$ ronin-db
$ ronin-web
$ ronin-fuzzer
+ $ ronin-masscan
+ $ ronin-nmap
+ $ ronin-recon
$ ronin-payloads
$ ronin-exploits
$ ronin-vulns
+ $ ronin-app
```
List ronin commands:
```shell
@@ -144,25 +159,40 @@
$ ronin tips
```
Open the Ronin Ruby REPL:
-```shell
-$ ronin irb
```
+$ ronin irb
+ , Jµ ▓▓█▓
+ J▌ ▐▓██▌ ████ ██ ▐███D
+ ╓▄▓▓█████▌ ██µ ████ ▄███ÖJ██▌ ███▌
+ ,╓µ▄▄▄▄▄▄▄▄µ;, ,▄▓██████████ ▐███ ▐███▀ ███▌ ████µ ▄███
+¬∞MÆ▓███████████████████████▓M ▄██████▀▀╙████▌ ████▌ ████ ▄███ J█████ ███▌
+ `█████▀▀▀▀▀███████ -████▀└ ████ ▐█████n ▄███O ███▌ ██████████
+ ▓████L ████▀ ▓████ ▓███Ö ███████ ███▌ ▓███ ▐█████████▀
+ ▄████▀ ,╓▄▄▄█████ J████Ü ,███▌ ▄███████████ J███▀ ████ █████
+ J█████████████████─ ████▌ ████ ████`██████▌ ████ ▐███Ü ▐███Ü
+ ███████████▀▀▀╙└ ▐████ J███▌ ▓███▌ ²█████ J███Ü ███▌ ▀█▌
+ ▓██████████▌ ████▌ ████ ;████ ▀███▀ ███▌ J▀▀▀- █
+ ▄█████▀ ▀█████µ ▐████ ,▄▓████▀ ████▀ ███ J███ `
+ J█████- ╙▀███▄ ████████████▀╙ J█▀▀▀ █U ▀█▌
+ ████▀ ▀███ ▄████████▀▀ ╨ █
+ ▓██▀ ²▀█▄ █▀▀▀╙└
+ ▄██╜ ╙W
+ J█▀
+ ▌└
+ ┘
-Generate a new Ruby script with [ronin-support] preloaded:
-
-```shell
-$ ronin new script foo.rb
+irb(ronin)>
```
-Generate a new Ruby project with a `Gemfile`:
+Starts and opens the interactive Web UI for Ronin:
-```shell
-$ ronin new project foo
```
+$ ronin-app
+```
### Binary
Hexdumps data in a variety of formats:
@@ -778,13 +808,110 @@
```shell
$ ronin url --file urls.txt --status
```
+### Generators
+
+Generate a new Ruby script with [ronin-support] preloaded:
+
+```shell
+$ ronin new script foo.rb
+```
+
+Generate a new Ruby project with a `Gemfile`:
+
+```shell
+$ ronin new project foo
+```
+
+Generate a new [nokogiri] Ruby script for parsing HTML/XML:
+
+[nokogiri]: https://nokogiri.org/
+
+```shell
+$ ronin new nokogiri foo.rb
+```
+
+Generate a new [ronin-web-server] Ruby script:
+
+```shell
+$ ronin new web-server my_server.rb
+```
+
+Generate a new [ronin-web-server] based web app:
+
+```shell
+$ ronin new web-app my_app
+```
+
+Generate a new [ronin-web-spider] Ruby script:
+
+```shell
+$ ronin new web-spider --host=example.com my_spider.rb
+```
+
+Generate a [ronin-listener-dns] script:
+
+```shell
+$ ronin new dns-listener my_dns_listener.rb
+```
+
+Generate a [ronin-dns-proxy] script:
+
+```shell
+$ ronin new dns-proxy my_dns_proxy.rb
+```
+
+Generate a [ronin-listener-http] script:
+
+```shell
+$ ronin new http-listener my_http_listener.rb
+```
+
+Generate a [ronin-exploits] script:
+
+```shell
+$ ronin new exploit my_exploit.rb
+```
+
+Generate a [ronin-payloads] script:
+
+```shell
+$ ronin new payload my_payload.rb
+```
+
+### Archive
+
+Archive files:
+
+```shell
+$ ronin archive -o archive.zip file1.txt file2.txt
+```
+
+Archive files using tar format:
+
+```shell
+$ ronin archive -o archive.tar file1.txt file2.txt
+```
+
+Unarchive files:
+
+```shell
+$ ronin unarchive arch1.tar arch2.zip
+```
+
+Unarchive a file with explicit format:
+
+```shell
+$ ronin unarchive -f zip arch2.jar
+```
+
### See Also
* [ronin-repos](https://github.com/ronin-rb/ronin-repos#synopsis)
+* [ronin-wordlists](https://github.com/ronin-rb/ronin-wordlists#synopsis)
* [ronin-db](https://github.com/ronin-rb/ronin-db#synopsis)
* [ronin-web](https://github.com/ronin-rb/ronin-web#synopsis)
* [ronin-fuzzer](https://github.com/ronin-rb/ronin-fuzzer#synopsis)
* [ronin-payloads](https://github.com/ronin-rb/ronin-payloads#synopsis)
* [ronin-exploits](https://github.com/ronin-rb/ronin-exploits#synopsis)
@@ -794,26 +921,33 @@
* [gcc] / [clang]
* [make]
* [git]
* [libsqlite3]
-* [Ruby] >= 3.0.0
+* [Ruby] >= 3.1.0
* [open_namespace] ~> 0.4
* [rouge] ~> 3.0
* [async-io] ~> 1.0
-* [wordlist] ~> 1.0, >= 1.0.3
-* [ronin-support] ~> 1.0, >= 1.0.3
-* [ronin-core] ~> 0.1, >= 0.1.2
+* [wordlist] ~> 1.1
+* [ronin-support] ~> 1.1
+* [ronin-dns-proxy] ~> 0.1
+* [ronin-core] ~> 0.2
* [ronin-repos] ~> 0.1
+* [ronin-wordlists] ~> 0.1
* [ronin-db] ~> 0.1
+* [ronin-listener] ~> 0.1
+* [ronin-nmap] ~> 0.1
+* [ronin-masscan] ~> 0.1
+* [ronin-recon] ~> 0.1
* [ronin-fuzzer] ~> 0.1
-* [ronin-web] ~> 1.0
+* [ronin-web] ~> 2.0
* [ronin-code-asm] ~> 1.0
* [ronin-code-sql] ~> 2.0
* [ronin-payloads] ~> 0.1
* [ronin-exploits] ~> 1.0
-* [ronin-vulns] ~> 0.1
+* [ronin-vulns] ~> 0.2
+* [ronin-app] ~> 0.1
## Install
### Bash Script
@@ -849,11 +983,11 @@
## Development
1. [Fork It!](https://github.com/ronin-rb/ronin/fork)
2. Clone It!
3. `cd ronin`
-4. `bundle install`
+4. `./scripts/setup`
5. `git checkout -b my_feature`
6. Code It!
7. `bundle exec rake spec`
8. `git push origin my_feature`
@@ -887,15 +1021,25 @@
[rouge]: https://github.com/rouge-ruby/rouge#readme
[async-io]: https://github.com/socketry/async-io#readme
[wordlist]: https://github.com/postmodern/wordlist.rb#readme
[ronin-support]: https://github.com/ronin-rb/ronin-support#readme
+[ronin-dns-proxy]: https://github.com/ronin-rb/ronin-dns-proxy#readme
[ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme
[ronin-repos-synopsis]: https://github.com/ronin-rb/ronin-repos#synopsis
+[ronin-wordlists]: https://github.com/ronin-rb/ronin-wordlists#readme
+[ronin-wordlists-synopsis]: https://github.com/ronin-rb/ronin-wordlists#synopsis
[ronin-core]: https://github.com/ronin-rb/ronin-core#readme
[ronin-db]: https://github.com/ronin-rb/ronin-db#readme
[ronin-db-synopsis]: https://github.com/ronin-rb/ronin-db#synopsis
+[ronin-listener]: https://github.com/ronin-rb/ronin-listener#readme
+[ronin-listener-dns]: https://github.com/ronin-rb/ronin-listener-dns#readme
+[ronin-listener-http]: https://github.com/ronin-rb/ronin-listener-http#readme
+[ronin-nmap]: https://github.com/ronin-rb/ronin-nmap#readme
+[ronin-masscan]: https://github.com/ronin-rb/ronin-masscan#readme
+[ronin-recon]: https://github.com/ronin-rb/ronin-recon#readme
+[ronin-recon-synopsis]: https://github.com/ronin-rb/ronin-recon#synopsis
[ronin-fuzzer]: https://github.com/ronin-rb/ronin-fuzzer#readme
[ronin-web]: https://github.com/ronin-rb/ronin-web#readme
[ronin-web-server]: https://github.com/ronin-rb/ronin-web-server#readme
[ronin-web-spider]: https://github.com/ronin-rb/ronin-web-spider#readme
[ronin-web-user_agents]: https://github.com/ronin-rb/ronin-web-user_agents#readme
@@ -905,5 +1049,6 @@
[ronin-exploits]: https://github.com/ronin-rb/ronin-exploits#readme
[ronin-exploits-synopsis]: https://github.com/ronin-rb/ronin-exploits#synopsis
[ronin-exploits-examples]: https://github.com/ronin-rb/ronin-exploits#examples
[ronin-vulns]: https://github.com/ronin-rb/ronin-vulns#readme
[ronin-vulns-synopsis]: https://github.com/ronin-rb/ronin-vulns#synopsis
+[ronin-app]: https://github.com/ronin-rb/ronin-app#readme