Skip to content

Commit 28bb9be

Browse files
authored
Merge pull request #14 from amalmurali47/patch-1
Update README.md
2 parents 039dec7 + e7b96b1 commit 28bb9be

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Interlace
2-
Easily turn single threaded command line applications into fast, multi threaded application with CIDR and glob support.
2+
Easily turn single threaded command line applications into a fast, multi-threaded application with CIDR and glob support.
33

44
[![Python 3.2|3.6](https://img.shields.io/badge/python-3.2|3.6-green.svg)](https://www.python.org/) [![License](https://img.shields.io/badge/license-GPL3-_red.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![Twitter](https://img.shields.io/badge/twitter-@codingo__-blue.svg)](https://twitter.com/codingo_) [![Twitter](https://img.shields.io/badge/twitter-@sml555__-blue.svg)](https://twitter.com/sml555_)
55

@@ -15,18 +15,18 @@ Dependencies will then be installed and Interlace will be added to your path as
1515

1616
| Argument | Description |
1717
|------------|--------------------------------------------------------------------------------------------------------------|
18-
| -t | Specify a target or domain name either in comma format, CIDR notation, or as an individual host. |
18+
| -t | Specify a target or domain name either in comma-delimited format, CIDR notation, or as an individual host |
1919
| -tL | Specify a list of targets or domain names |
2020
| -threads | Specify the maximum number of threads to run at any one time (DEFAULT:5) |
21-
| -timeout | Specify a timeout value in seconds for any one thread (DEFAULT:600) |
21+
| -timeout | Specify a timeout value in seconds for any single thread (DEFAULT:600) |
2222
| -c | Specify a single command to execute over each target or domain |
2323
| -cL | Specify a list of commands to execute over each target or domain |
2424
| -o | Specify an output folder variable that can be used in commands as \_output\_ |
2525
| -p | Specify a list of port variable that can be used in commands as \_port\_. This can be a single port, a comma delimited list, or use dash notation |
2626
| -rp | Specify a real port variable that can be used in commands as \_realport\_ |
27-
| --no-cidr | If set then CIDR notation in a target file will not be automatically be expanded into individual hosts. |
27+
| --no-cidr | If set then CIDR notation in a target file will not be automatically be expanded into individual hosts |
2828
| --no-color | If set then any foreground or background colours will be stripped out |
29-
| --silent | If set then only important information will be displayed and banners and other information will be redacted. |
29+
| --silent | If set then only important information will be displayed and banners and other information will be redacted |
3030
| -v | If set then verbose output will be displayed in the terminal |
3131

3232
## Further information regarding ports (-p)
@@ -38,22 +38,22 @@ Dependencies will then be installed and Interlace will be added to your path as
3838
| 80,443 | Perform a command for both port 80, and port 443 |
3939

4040
## Further information regarding targets (-t or -tL)
41-
Both `-t` and `-tL` will be processed the same. You can pass targets the same as you would when using nmap. This can be done using CIDR notation, dash notation, or a comma delimited list of targets. A single target list file can also use different notation types per line.
41+
Both `-t` and `-tL` will be processed the same. You can pass targets the same as you would when using nmap. This can be done using CIDR notation, dash notation, or a comma-delimited list of targets. A single target list file can also use different notation types per line.
4242

4343
# Variable Replacements
44-
The following varaibles will be replaced in commands at runtime:
44+
The following variables will be replaced in commands at runtime:
4545

4646
| Variable | Replacement |
4747
|-----------|-------------------------------------------------------------------------|
4848
| \_target\_ | Replaced with the expanded target list that the current thread is running against |
49-
| \_host\_ | Works the same as \_target\_, can be used interchangably. |
49+
| \_host\_ | Works the same as \_target\_, can be used interchangeably |
5050
| \_output\_ | Replaced with the output folder variable from interlace |
5151
| \_port\_ | Replaced with the expanded port variable from interlace |
5252
| \_realport\_ | Replaced with the real port variable from interlace |
5353

5454
# Usage Examples
5555
## Run Nikto Over Multiple Sites
56-
Let's assume that you had a file `targets.txt` that had the following contents:
56+
Let's assume that you have a file `targets.txt` that has the following contents:
5757

5858
```
5959
bugcrowd.com
@@ -69,12 +69,12 @@ Interlace v1.0 by Michael Skelton (@codingo_)
6969
[14:33:23] [THREAD] [nikto --host hackerone.com > ./hackerone.com-nikto.txt] Added to Queue
7070
[14:33:23] [THREAD] [nikto --host bugcrowd.com > ./bugcrowd.com-nikto.txt] Added to Queue
7171
```
72-
This would run nikto over each host and save to a file for each target. Note that in the above example since we're using the `>` operator so results won't be fed back to the terminal, however this is desired functionality as otherwise we wouldn't be able to attribute which target Nikto results were returning for.
72+
This would run Nikto over each host and save to a file for each target. Note that in the above example since we're using the `>` operator, the results won't be fed back to the terminal; however this is desired functionality as otherwise we wouldn't be able to attribute which target Nikto results were returning for.
7373

7474
For applications where you desire feedback simply pass commands as you normally would (or use `tee`).
7575

7676
## Run Nikto Over Multiple Sites and Ports
77-
Using the above example, let's assume you want independant scans to be run for both ports `80` and `443` for the same targets. You would then use the following:
77+
Using the above example, let's assume you want independent scans to be run for both ports `80` and `443` for the same targets. You would then use the following:
7878

7979
```
8080
➜ /tmp interlace -tL ./targets.txt -threads 5 -c "nikto --host _target_:_port_ > ./_target_-_port_-nikto.txt" -p 80,443 -v
@@ -101,9 +101,9 @@ interlace -t example.com -o ~/Engagements/example/ -cL ./commands.txt -p 80,443
101101
This would then run nikto, sslscan, and testssl.sh for both port 80 and 443 against example.com and save files into your engagements folder.
102102

103103
## CIDR notation with an application that doesn't support it
104-
Interlace automatically expands CIDR notation when starting threads (unless the --no-cidr flag is passed). This allows you to pass CIDR notation to a variety of applications:
104+
Interlace automatically expands CIDR notation when starting threads (unless the `--no-cidr` flag is passed). This allows you to pass CIDR notation to a variety of applications:
105105

106-
To run a virtual host scan against every target within 192.168.12.0/24 using a direct command you could use:
106+
To run a virtual host scan against every target within `192.168.12.0/24` using a direct command you could use:
107107
```bash
108108
interlace -t 192.168.12.0/24 -c "vhostscan _target_ -oN _output_/_target_-vhosts.txt" -o ~/scans/ -threads 50
109109
```
@@ -112,14 +112,14 @@ This is despite VHostScan not having any inbuilt CIDR notation support. Since In
112112
## Glob notation with an application that doesn't support it
113113
Interlace automatically expands glob ranges when starting threads. This allows you to pass glob ranges to a variety of applications:
114114

115-
To run a virtual host scan against every target within 192.168.12.* using a direct command you could use:
115+
To run a virtual host scan against every target within `192.168.12.*` using a direct command you could use:
116116
```bash
117117
interlace -t 192.168.12.* -c "vhostscan _target_ -oN _output_/_target_-vhosts.txt" -o ~/scans/ -threads 50
118118
```
119-
Yet again, VHostScan does not having any inbuilt glob range format support.
119+
Yet again, VHostScan does not have any inbuilt glob range format support.
120120

121121
## Threading Support for an application that doesn't support it
122-
Run a [virtual host scan](https://github.com/codingo/VHostScan) against each host in a file (target-lst.txt), whilst also limiting scans at any one time to 50 maximum threads.
122+
Run a [virtual host scan](https://github.com/codingo/VHostScan) against each host in a file (`target-lst.txt`), whilst also limiting scans at any one time to 50 maximum threads.
123123

124124
This could be done using a direct command:
125125
```bash
@@ -130,14 +130,14 @@ Or, alternatively, to run the same command as above, but using a command file, t
130130
```bash
131131
interlace -cL ./vhosts-commands.txt -tL ./target-list.txt -threads 50 -o ~/scans
132132
```
133-
This presumes that the contents of the command file is:
133+
This presumes that the content of the command file is:
134134
```
135135
vhostscan -t $target -oN _output_/_target_-vhosts.txt
136136
```
137137
This would output a file for each target in the specified output folder. You could also run multiple commands simply by adding them into the command file.
138138

139-
# Auhors and Thanks
140-
Originally written by Michael Skelton ([codingo](https://twitter.com/codingo_)) and Sajeeb Lohani ([sml555](https://twitter.com/sml555_)) with help from Charelle Collett ([@Charcol0x89](https://twitter.com/Charcol0x89)) for threading refactoring and overall appraoch, and Luke Stephens ([hakluke](https://twitter.com/hakluke)) for testing and approach.
139+
# Authors and Thanks
140+
Originally written by Michael Skelton ([codingo](https://twitter.com/codingo_)) and Sajeeb Lohani ([sml555](https://twitter.com/sml555_)) with help from Charelle Collett ([@Charcol0x89](https://twitter.com/Charcol0x89)) for threading refactoring and overall approach, and Luke Stephens ([hakluke](https://twitter.com/hakluke)) for testing and approach.
141141

142142
# Contributions
143143
Contributions to this project are very welcome. If you're a newcomer to open source and would like some help in doing so, feel free to reach out to me on twitter ([@codingo_](https://twitter.com/codingo_)) and I'll assist wherever I can.

0 commit comments

Comments
 (0)