edu4rdshl/unimap
1
0
Fork 0
mirror of https://github.com/edu4rdshl/unimap.git synced 2026-07-17 23:24:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update installation instructions and remove legacy documentation.

Browse source
This commit is contained in:
Eduard Tolosa 2022-01-04 09:39:36 -05:00 • committed by GitHub
parent 970fd42e48
commit 661c4b1a04
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -9,10 +9,10 @@ Unimap uses its own technology to initially resolve the IP addresses of all subd
# Installation
## From source
You need to have Rust and Nmap installed in your computer, then run:
* `cargo install unimap` to install from [crates.io](https://crates.io).
* or
```
1. git clone https://github.com/Edu4rdSHL/unimap.git && cd unimap
# Alternatively you can download a release from https://github.com/Edu4rdSHL/unimap/releases/latest
@ -21,12 +21,16 @@ You need to have Rust and Nmap installed in your computer, then run:
# Now the binary is in ./target/release/unimap
```
## Using precompiled binaries
Download the [latest version](https://github.com/Edu4rdSHL/unimap/releases/latest) for your OS and use it.
## Using the AUR packages. (Arch Linux)
`unimap` can be installed from available [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=unimap&outdated=&SB=n&SO=a&PP=50&do_Search=Go) using a [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers). For example,
```
yay -S unimap
$ paru -S unimap
```
If you prefer, you can clone the [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=unimap&outdated=&SB=n&SO=a&PP=50&do_Search=Go) and then compile them with [makepkg](https://wiki.archlinux.org/index.php/Makepkg). For example,
@ -39,37 +43,15 @@ git clone https://aur.archlinux.org/unimap.git && cd unimap && makepkg -si
**Unimap requires root/administrator privileges to launch [Nmap TCP SYN (Stealth) Scan](https://nmap.org/book/synscan.html), we use it for accuracy and performance reasons.** If you are on Linux or Linux-based, just use a root shell or run the tool with sudo, in Windows you can open a Command Prompt (CMD) as Administrator and run the tool as usual.
* Flags doesn't require/accept values.
|Flag|Description|
|-----------|------------|
|--fast-scan|Use fast scanning for ports (no version detection) and just scan the top 1000 ports.|
|-o, --output| Write to an output file. The name of the output file will be unimap-log-$date.|
|-k, --keep-nmap-logs| Keep Nmap XML files created in the logs/ folder for every scanned IP. This data will be useful for other tasks.|
* Options require values.
|Option|Description|
|-----------|------------|
|--resolvers|Path to a file (or files) containing a list of DNS IP address. If no specified then 1.6k of built-in valid DNS servers from public-dns.info are used.|
|-f, --file|Use a list of targets writen in a file as input.|
|--iport|Initial port if you want to scan a custom range.|
|--lport|Last port if you want to scan a custom range.|
|--logs-dir|Path to save the CSV data of the process. Useful when doing automated scans with the -o option.|
|--min-rate| Controls [Nmap's --min-rate](https://nmap.org/book/man-performance.html). Default to 30000.|
|-t, --target|Host if you want to scan only one and extract the interesting data.|
|--threads|Number of threads. **Have in mind that the same number of Nmap scans will be started at time.** Default to 30.|
|-u, --unique-output|Write output to a specified filename.|
# Examples
1. `unimap -f targets.txt -u log.csv` performs a full scan and writes output to log.csv.
2. `unimap -f targets.txt --fast-scan -o` performs a fast scan and saves the logfile to the logs/ folder.
3. `sudo unimap -f targets.txt --iport 1 --lport 1000 --min-rate 1000` scans ports from 1-1000 doing service and version detection (if you want a fast scan use the --fast-scan flag) with a min-rate of 1000.
3. `sudo unimap -f targets.txt --ports "1-1000" --min-rate 5000` scans ports from 1-1000 doing service and version detection (if you want a fast scan use the --fast-scan flag) with a min-rate of 5000.
# Considerations
* Unimap is preconfigured to run on faster networks (cloud VPS), if you run a scan in a home network that doesn't have too much capacity you will end up disconnected from network.
* Unimap is preconfigured to run on faster networks (cloud VPS), if you run a scan in a home network that doesn't have too much capacity you will end up disconnected due to network throttling.
* The previously doesn't mean you can not use Unimap from your home, just adjust the number of `--threads` and `--min-rate` (being it the most important).
* We do not wrap Nmap in any way or scan ports on our own, we use the right Nmap options to get the most performance, Nmap rocks and it's the fastest port scanner that currently exists.
* We parse Nmap output data and give you more understandable output while also preventing you to scan the same IP several times, **it's our main goal** .