README.md in rogue_one-0.1.4 vs README.md in rogue_one-0.2.0
- old
+ new
@@ -1,11 +1,24 @@
-# Rogue one: a rogue DNS detector
+# Rogue one
[![Gem Version](https://badge.fury.io/rb/rogue_one.svg)](https://badge.fury.io/rb/rogue_one)
[![Build Status](https://travis-ci.org/ninoseki/rogue_one.svg?branch=master)](https://travis-ci.org/ninoseki/rogue_one)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/rogue_one/badge)](https://www.codefactor.io/repository/github/ninoseki/rogue_one)
[![Coverage Status](https://coveralls.io/repos/github/ninoseki/rogue_one/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/rogue_one?branch=master)
+A tiny tool for detecting a rogue DNS server and extracting landing pages from the rogue DNS server.
+
+## How it works
+
+![image](./images/eyecatch.png)
+
+IPv4 space is vast. But an attacker could secure a few numbers of IP addresses for landing pages.
+It means you can (probably) find malicious landing pages by using the following methods.
+
+- Resolving a bunch of domains by using a rogue DNS.
+- Finding frequent IPv4s from the resolutions. They might be landing pages.
+
## Installation
```bash
gem install rogue_one
```
@@ -16,10 +29,20 @@
$ rogue_one
Commands:
rogue_one help [COMMAND] # Describe available commands or one specific command
rogue_one report [DNS_SERVER] # Show a report of a given DNS server
+$ rogue_one help report
+Usage:
+ rogue_one report [DNS_SERVER]
+
+Options:
+ [--custom-list=CUSTOM_LIST] # A path to a custom list of domains
+ [--verbose], [--no-verbose]
+
+Show a report of a given DNS server
+
$ rogue_one report 1.1.1.1
{
"verdict": "benign one",
"landing_pages": [
@@ -33,15 +56,26 @@
"1.171.168.19",
"1.171.170.228",
"61.230.102.66"
]
}
+
+$ rogue_one report 171.244.3.111 --custom-list tmp/roaming.yml
+{
+ "verdict": "rogue one",
+ "landing_pages": [
+ "154.223.53.53",
+ "58.82.243.9"
+ ]
+}
+# Note: a custom list should be an array of domains in YAML format.
```
-| Key | Desc. |
-|---------------|--------------------------------------------------|
-| verdict | A detection result (`rogue one` or `benign one`) |
-| landing_pages | An array of IP of landing pages |
+| Key | Desc. |
+|---------------|--------------------------------------------------------------------------|
+| verdict | A detection result (`rogue one` or `benign one`) |
+| landing_pages | An array of IP of landing pages |
+| results | DNS resolution results (only available if --verbose option is specified) |
## Notes
- This is just a PoC tool. I cannot guarantee the results with high confidence at the moment.