From 2066ab35da8aed4b930b09bc87292055784cc589 Mon Sep 17 00:00:00 2001 From: Hardeep Singh <54495695+holmes-py@users.noreply.github.com> Date: Sat, 3 Oct 2020 04:13:56 +0530 Subject: [PATCH] Updated the person of README. Fixed some minor description corrections in README. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4902c073f..fafa02c0d 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ The easiest way to install RustScan is to use one of the packages provided for y The most universal way is to use `cargo`, Rust's built in package manager (think Pip but for Rust). [Follow this guide to installing Rust & Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html). -If you face any issues at all, please leave a GitHub issue. I have only tested this on Linux, so there may be issues for Mac OS or Windows. +If you face any issues at all, please leave a GitHub issue. We have only tested this on Linux, so there may be issues for Mac OS or Windows. Note: sometimes Rust doesn't add Cargo to the path. Please see [this issue](https://github.com/rust-lang/rustup/issues/2436) for how to fix that. @@ -195,7 +195,7 @@ brew install rustscan ## 🔧 Building it yourself 1. Git clone the repo. -2. Install Rust. You can do this with `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` which I took from the Rust website https://www.rust-lang.org/tools/install +2. Install Rust. You can do this with `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` which we took from the Rust website https://www.rust-lang.org/tools/install 3. cd into the Git repo, and run `cargo build --release` 4. The binary is located at `target/release/rustscan` 5. Symlink to the binary or something. Whatever you want! @@ -232,8 +232,8 @@ FLAGS: -V, --version Prints version information OPTIONS: - -b, --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 + -b, --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 ... A list of comma separed ports to be scanned. Example: 80,443,8080 -r, --range A range of ports with format start-end. Example: 1-1000 @@ -255,7 +255,7 @@ The format is `rustscan -b 500 -t 1500 192.168.0.1` to scan 192.168.0.1 with 500 The batch size determines how fast RustScan is. Set it to 65k, and it will scan all 65k ports at the same time. This means at at 65k batch size, RustScan will take TIMEOUT long to scan all ports. Essentially, if timeout is 1000ms, **RustScan can scan in 1 second**. -Your operating system may not support this, but it is worth it to play around and see where your open file limit is. Shortly I will be releasing a dockerised version with a much larger open file limit, so this will be possible. +Your operating system may not support this, but it is worth it to play around and see where your open file limit is. Shortly we will be releasing a dockerised version with a much larger open file limit, so this will be possible. ## Configuration file @@ -347,11 +347,11 @@ ulimit -n 5000 ``` **Mac OS** -Mac OS has, from what I can tell, a naturally very low open file descriptor limit. The limit for Ubuntu is 8800. The limit for Mac OS is 255! +Mac OS has, from what we can tell, a naturally very low open file descriptor limit. The limit for Ubuntu is 8800. The limit for Mac OS is 255! -In this case, I would say it is safe to increase the open file limit. As most Linux based OS' have limits in the thousands. +In this case, we would say it is safe to increase the open file limit. As most Linux based OS' have limits in the thousands. -Although, if this breaks anything, please don't blame me. +Although, if this breaks anything, please don't blame us. **Windows Subsystem for Linux** Windows Subsystem for Linux does not support ulimit (see issue #39). @@ -373,7 +373,7 @@ If you want to run commands such as `--script (vuln and safe)`, you will need to - Batch size -This increases speed, by allowing us to process more at once. Something experimental I am working on is changing the open file limit. You can do this manually with `ulimit -n 70000` and then running rustscan with `-b 65535`. This _should_ scan all 65535 ports at the exact same time. But this is extremely experimental. +This increases speed, by allowing us to process more at once. Something experimental we are working on is changing the open file limit. You can do this manually with `ulimit -n 70000` and then running rustscan with `-b 65535`. This _should_ scan all 65535 ports at the exact same time. But this is extremely experimental. For non-experimental speed increases, slowly increase the batch size until it no longer gets open ports, or it breaks. @@ -381,7 +381,7 @@ For non-experimental speed increases, slowly increase the batch size until it no To increase accuracy, the easiest way is to increase the timeout. The default is 1.5 seconds, by setting it to 4 seconds (4000) we are telling RustScan "if we do not hear back from a port in 4 seconds, assume it is closed". -Decreasing accuracy gives some speed bonus, but my testing found that batch size dramatically changed the speed whereas timeout did, but not so much. +Decreasing accuracy gives some speed bonus, but our testing found that batch size dramatically changed the speed whereas timeout did, but not so much. # 🎪 Community @@ -420,7 +420,7 @@ We communicate over Discord. [Click here](https://discord.gg/GFrQsGy) to join ou ## Rewarding you -I cannot pay you :-( But, I can place your GitHub profile on the README under `#Contributors` as a thank you! :) +We cannot pay you :-( But, We can place your GitHub profile on the README under `#Contributors` as a thank you! :) Please read the [contributing.md file](contributing.md)