RomanNum3ral
/
AutoRecon
mirror of https://github.com/Tib3rius/AutoRecon.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Usage (markdown)

Tib3rius 2022-01-22 17:29:45 -05:00
parent 0388a266ae
commit 8b602339d1
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Usage.md

@ -253,5 +253,32 @@ autorecon --global /path/to/global.toml <target>
## Tags
AutoRecon uses the concept of tags to enable / disable certain plugins at runtime. Plugins can be tagged with multiple tags, or no tags. If no tags are specified, and the tag attribute is not set to an empty list ([]), then the plugin will be automatically tagged as "default". Plugins tagged with "default" will be enabled by default. Other common tags include: safe, long, and unsafe.
AutoRecon uses the concept of tags to enable / disable certain plugins at runtime. Plugins can be tagged with multiple tags, or no tags. If no tags are specified, and the tag attribute is not set to an empty list ([]), then the plugin will be automatically tagged as "default". Plugins tagged with "default" will be enabled by default. Other common tags include: safe (the plugin should not crash the target), long (the plugin could take a long time to complete), and unsafe (the plugin may crash the target). Plugin slugs (the shortened name of the plugin) can also be used as tags (e.g. "top-tcp-ports", "dirbuster").
There are 5 command-line options related to tags: `--tags`, `--exclude-tags`, `--port-scans`, `--service-scans`, and `--reports`.
The `--tags` option is used to determine which plugins should be included. Group tags together by separating them with a plus symbol (+), and separate groups with a comma (,) to create multiple groups. For a plugin to be included, it must have all the tags specified in at least one group. For example, the following will only include plugins tagged with both "default" and "http", or plugins tagged "default-port-scan":
```
autorecon --tags="default+http,default-port-scan" <target>
```
The `--exclude-tags` option is used to determine which plugins should be excluded. Group tags together by separating them with a plus symbol (+), and separate groups with a comma (,) to create multiple groups. For a plugin to be excluded, it must have all the tags specified in at least one group. For example, the following will exclude plugins tagged with "unsafe", or plugins tagged with both "http" and "long":
```
autorecon --exclude-tags="unsafe,http+long" <target>
```
Note that the `--tags` option is processed first, so `--exclude-tags` will only exclude plugins which have already matched the `--tags` option.
The `--port-scans`, `--service-scans`, and `--reports` options can be used to override both `--tags` and `--exclude-tags`, as a final determination of which plugins should be included. These options do not take tags as values, but rather a command separated list of plugin slugs, where the plugin type matches the option (i.e. `--port-scans` only affects PortScan plugins). For example, the following will ensure that the "top-tcp-ports" PortScan will be included, as well as the "dirbuster" ServiceScan, and the "cherrytree" Report plugin:
```
autorecon --port-scans=top-tcp-ports --service-scans=dirbuster --reports=cherrytree <target>
```
A good example of these options used together would be the following, where only plugins tagged with "http" are included, except for the "nmap-http" plugin, and the PortScan plugin "all-tcp-ports" is included regardless of the tags:
```
autorecon --tags=http --exclude-tags=nmap-http --port-scans=all-tcp-ports <target>
```