Skip to content

Provide JSON output option #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
niklasmohrin wants to merge 2 commits into from
Closed

Provide JSON output option #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef36537
Add --format and --output-file flags
niklasmohrin Oct 16, 2020
c10748c
First try at proposed summary "mode" approach
niklasmohrin Oct 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ ansi_term = "0.12.1"
toml = "0.5.7"
serde = "1.0.117"
serde_derive = "1.0.116"
serde_json = "1.0.59"
cidr-utils = "0.5.0"
itertools = "0.9.0"
trust-dns-resolver = { version = "0.19.5", features = ["dns-over-rustls"] }
Expand Down
45 changes: 26 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,37 +221,44 @@ server may not be able to handle this many socket connections at once. - Discord
https://github.com/RustScan/RustScan

USAGE:
rustscan [FLAGS] [OPTIONS] [addresses]... [-- <command>...]
rustscan [FLAGS] [OPTIONS] [-- <command>...]

FLAGS:
--accessible Accessible mode. Turns off features which negatively affect screen readers
-g, --greppable Greppable mode. Only output the ports. No Nmap. Useful for grep or outputting to a file
-h, --help Prints help information
-n, --no-config Whether to ignore the configuration file or not
--no-nmap Turns off Nmap
--top Use the top 1000 ports
-V, --version Prints version information

OPTIONS:
-b, --batch-size <batch-size> The batch size for port scanning, it increases or decreases the speed of scanning.
Depends on the open file limit of your OS. If you use 65535 it will scan every port
at the same time. Although, your OS may not support this [default: 4500]
-p, --ports <ports>... A list of comma separed ports to be scanned. Example: 80,443,8080
-r, --range <range> A range of ports with format start-end. Example: 1-1000
--scan-order <scan-order> The order of scanning to be performed. The "serial" option will scan ports in
ascending order while the "random" option will scan ports randomly [default:
serial] [possible values: Serial, Random]
-t, --timeout <timeout> The timeout in milliseconds before a port is assumed to be closed [default: 1500]
--tries <tries> The number of tries before a port is assumed to be closed. If set to 0, rustscan
will correct it to 1 [default: 1]
-u, --ulimit <ulimit> Automatically ups the ULIMIT with the value you provided
-a, --addresses <addresses>... A list of comma separated CIDRs, IPs, or hosts to be scanned
-b, --batch-size <batch-size> The batch size for port scanning, it increases or slows the speed of scanning.
Depends on the open file limit of your OS. If you do 65535 it will do every port
at the same time. Although, your OS may not support this [default: 4500]
--format <format> Output format of the scan. Note that this only includes the port scan result that
is produced by rustscan, not the output of Nmap [default: text] [possible
values: Text, Json]
-o, --output-file <output-file> Path to a file where the port scan result will be written to. The output will be
formatted according to the --format flag. If not specified, formatted output will
be printed to stdout
-p, --ports <ports>... A list of comma separed ports to be scanned. Example: 80,443,8080
-r, --range <range> A range of ports with format start-end. Example: 1-1000
--scan-order <scan-order> The order of scanning to be performed. The "serial" option will scan ports in
ascending order while the "random" option will scan ports randomly [default:
serial] [possible values: Serial, Random]
--scripts <scripts> Level of scripting required for the run [default: default] [possible values:
None, Default, Custom]
-t, --timeout <timeout> The timeout in milliseconds before a port is assumed to be closed [default: 1500]
--tries <tries> The number of tries before a port is assumed to be closed. If set to 0, rustscan
will correct it to 1 [default: 1]
-u, --ulimit <ulimit> Automatically ups the ULIMIT with the value you provided

ARGS:
<addresses>... A list of comma separated CIDRs, IPs, or hosts to be scanned
<command>... The Nmap arguments to run. To use the argument -A, end RustScan's args with '-- -A'. Example:
'rustscan -T 1500 127.0.0.1 -- -A -sC'. This command adds -Pn -vvv -p $PORTS automatically to
nmap. For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and
vuln)'\"")
<command>... The Script arguments to run. To use the argument -A, end RustScan's args with '-- -A'. Example:
'rustscan -T 1500 127.0.0.1 -- -A -sC'. This command adds -Pn -vvv -p $PORTS automatically to
nmap. For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and
vuln)'\"")
```

The format is `rustscan -b 500 -t 1500 192.168.0.1` to scan 192.168.0.1 with 500 batch size with a timeout of 1500ms. The timeout is how long RustScan waits for a response until it assumes the port is closed.
Expand Down
22 changes: 19 additions & 3 deletions src/input.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ arg_enum! {
}
}

arg_enum! {
/// Specifies how to format the summary.
#[derive(Deserialize, Debug, StructOpt, Clone, Copy, PartialEq)]
pub enum SummaryFormat {
Text,
Json,
}
}

/// Represents the range of ports to be scanned.
#[derive(Deserialize, Debug, Clone, PartialEq)]
pub struct PortRange {
Expand Down Expand Up @@ -94,8 +103,12 @@ pub struct Opts {
#[structopt(long)]
pub accessible: bool,

/// Just run the portscan and output its result in the given format.
#[structopt(long, possible_values = &SummaryFormat::variants(), case_insensitive = true)]
pub summary: Option<SummaryFormat>,

/// The batch size for port scanning, it increases or slows the speed of
/// scanning. Depends on the open file limit of your OS. If you do 65535
/// scanning. Depends on the open file limit of your OS. If you do 65535
/// it will do every port at the same time. Although, your OS may not
/// support this.
#[structopt(short, long, default_value = "4500")]
Expand Down Expand Up @@ -198,7 +211,7 @@ impl Opts {
self.ports = Some(ports);
}

merge_optional!(range, ulimit);
merge_optional!(range, summary, ulimit);
}
}

Expand All @@ -216,6 +229,7 @@ pub struct Config {
batch_size: Option<u16>,
timeout: Option<u32>,
tries: Option<u8>,
summary: Option<SummaryFormat>,
ulimit: Option<rlimit::RawRlim>,
scan_order: Option<ScanOrder>,
command: Option<Vec<String>>,
Expand Down Expand Up @@ -252,7 +266,7 @@ impl Config {
let config: Config = match toml::from_str(&content) {
Ok(config) => config,
Err(e) => {
println!("Found {} in configuration file.\nAborting scan.\n", e);
eprintln!("Found {} in configuration file.\nAborting scan.\n", e);
std::process::exit(1);
}
};
Expand All @@ -275,6 +289,7 @@ mod tests {
timeout: Some(1_000),
tries: Some(1),
ulimit: None,
summary: None,
command: Some(vec!["-A".to_owned()]),
accessible: Some(true),
scan_order: Some(ScanOrder::Random),
Expand All @@ -296,6 +311,7 @@ mod tests {
ulimit: None,
command: vec![],
accessible: false,
summary: None,
scan_order: ScanOrder::Serial,
no_config: true,
top: false,
Expand Down
139 changes: 79 additions & 60 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ extern crate shell_words;
mod tui;

mod input;
use input::{Config, Opts, PortRange, ScanOrder, ScriptsRequired};
use input::{Config, Opts, PortRange, ScanOrder, SummaryFormat};

mod scanner;
use scanner::Scanner;
Expand All @@ -24,6 +24,7 @@ use scripts::{init_scripts, Script, ScriptFile};
use cidr_utils::cidr::IpCidr;
use colorful::{Color, Colorful};
use futures::executor::block_on;
use itertools::Itertools;
use rlimit::{getrlimit, setrlimit, RawRlim, Resource, Rlim};
use std::collections::HashMap;
use std::convert::TryInto;
Expand Down Expand Up @@ -128,67 +129,66 @@ fn main() {
warning!(x, opts.greppable, opts.accessible);
}

let mut script_bench = NamedTimer::start("Scripts");
for (ip, ports) in &ports_per_ip {
let vec_str_ports: Vec<String> = ports.iter().map(ToString::to_string).collect();

// nmap port style is 80,443. Comma separated with no spaces.
let ports_str = vec_str_ports.join(",");

// if option scripts is none, no script will be spawned
if opts.greppable || opts.scripts == ScriptsRequired::None {
println!("{} -> [{}]", &ip, ports_str);
continue;
}
detail!("Starting Script(s)", opts.greppable, opts.accessible);

// Run all the scripts we found and parsed based on the script config file tags field.
for mut script_f in scripts_to_run.clone() {
output!(
format!("Script to be run {:?}\n", script_f.call_format,),
opts.greppable,
opts.accessible
);

// This part allows us to add commandline arguments to the Script call_format, appending them to the end of the command.
if !opts.command.is_empty() {
let user_extra_args: Vec<String> = shell_words::split(&opts.command.join(" "))
.expect("Failed to parse extra user commandline arguments");
if script_f.call_format.is_some() {
let mut call_f = script_f.call_format.unwrap();
call_f.push_str(&format!(" {}", &user_extra_args.join(" ")));
script_f.call_format = Some(call_f);
if let Some(summary_format) = opts.summary {
let summary = generate_summary(&ports_per_ip, summary_format);
std::io::stdout()
.lock()
.write_all(summary.as_bytes())
.expect("Could not write summary to stdout.");
} else {
let mut script_bench = NamedTimer::start("Scripts");
for (ip, ports) in &ports_per_ip {
detail!("Starting Script(s)", opts.greppable, opts.accessible);

// Run all the scripts we found and parsed based on the script config file tags field.
for mut script_f in scripts_to_run.clone() {
output!(
format!("Script to be run {:?}\n", script_f.call_format,),
opts.greppable,
opts.accessible
);

// This part allows us to add commandline arguments to the Script call_format, appending them to the end of the command.
if !opts.command.is_empty() {
let user_extra_args: Vec<String> = shell_words::split(&opts.command.join(" "))
.expect("Failed to parse extra user commandline arguments");
if script_f.call_format.is_some() {
let mut call_f = script_f.call_format.unwrap();
call_f.push_str(&format!(" {}", &user_extra_args.join(" ")));
script_f.call_format = Some(call_f);
}
}
}

// Building the script with the arguments from the ScriptFile, and ip-ports.
let script = Script::build(
script_f.path,
*ip,
ports.to_vec(),
script_f.port,
script_f.ports_separator,
script_f.tags,
script_f.call_format,
);
match script.run() {
Ok(script_result) => {
detail!(script_result.to_string(), opts.greppable, opts.accessible);
}
Err(e) => {
warning!(
&format!("Error {}", e.to_string()),
opts.greppable,
opts.accessible
);
// Building the script with the arguments from the ScriptFile, and ip-ports.
let script = Script::build(
script_f.path,
*ip,
ports.to_vec(),
script_f.port,
script_f.ports_separator,
script_f.tags,
script_f.call_format,
);
match script.run() {
Ok(script_result) => {
detail!(script_result.to_string(), opts.greppable, opts.accessible);
}
Err(e) => {
warning!(
&format!("Error {}", e.to_string()),
opts.greppable,
opts.accessible
);
}
}
}
}

// To use the runtime benchmark, run the process as: RUST_LOG=info ./rustscan
script_bench.end();
benchmarks.push(script_bench);
}

// To use the runtime benchmark, run the process as: RUST_LOG=info ./rustscan
script_bench.end();
benchmarks.push(script_bench);
rustscan_bench.end();
benchmarks.push(rustscan_bench);
debug!("Benchmarks raw {:?}", benchmarks);
Expand All @@ -203,12 +203,12 @@ fn print_opening(opts: &Opts) {
| .-. \| {_} |.-._} } | | .-._} }\ }/ /\ \| |\ |
`-' `-'`-----'`----' `-' `----' `---' `-' `-'`-' `-'
The Modern Day Port Scanner."#;
println!("{}", s.gradient(Color::Green).bold());
eprintln!("{}", s.gradient(Color::Green).bold());
let info = r#"________________________________________
: https://discord.gg/GFrQsGy :
: https://github.com/RustScan/RustScan :
--------------------------------------"#;
println!("{}", info.gradient(Color::Yellow).bold());
eprintln!("{}", info.gradient(Color::Yellow).bold());
funny_opening!();

let config_path = dirs::home_dir()
Expand Down Expand Up @@ -267,6 +267,25 @@ fn parse_addresses(input: &Opts) -> Vec<IpAddr> {
ips
}

/// Generates a summary in the given format.
fn generate_summary(ports_per_ip: &HashMap<IpAddr, Vec<u16>>, out_format: SummaryFormat) -> String {
match out_format {
SummaryFormat::Text => ports_per_ip
.iter()
.map(|(ip, ports)| {
format!(
"{} -> [{}]",
ip,
ports.iter().map(ToString::to_string).join(",")
)
})
.join("\n"),
SummaryFormat::Json => {
serde_json::to_string(&ports_per_ip).expect("Failed to serialize results as JSON.")
}
}
}

/// Given a string, parse it as an host, IP address, or CIDR.
/// This allows us to pass files as hosts or cidr or IPs easily
/// Call this everytime you have a possible IP_or_host
Expand Down Expand Up @@ -343,8 +362,8 @@ fn infer_batch_size(opts: &Opts, ulimit: RawRlim) -> u16 {
// Adjust the batch size when the ulimit value is lower than the desired batch size
if ulimit < batch_size {
warning!("File limit is lower than default batch size. Consider upping with --ulimit. May cause harm to sensitive servers",
opts.greppable, opts.accessible
);
opts.greppable, opts.accessible
);

// When the OS supports high file limits like 8000, but the user
// selected a batch size higher than this we should reduce it to
Expand All @@ -367,7 +386,7 @@ fn infer_batch_size(opts: &Opts, ulimit: RawRlim) -> u16 {
// batch size can be increased unless they specified the ulimit themselves.
else if ulimit + 2 > batch_size && (opts.ulimit.is_none()) {
detail!(format!("File limit higher than batch size. Can increase speed by increasing batch size '-b {}'.", ulimit - 100),
opts.greppable, opts.accessible);
opts.greppable, opts.accessible);
}

batch_size
Expand Down
4 changes: 2 additions & 2 deletions src/scanner/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ impl Scanner {
}
if !self.greppable {
if self.accessible {
println!("Open {}", socket.to_string());
eprintln!("Open {}", socket.to_string());
} else {
println!("Open {}", socket.to_string().purple());
eprintln!("Open {}", socket.to_string().purple());
}
}

Expand Down
Loading