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

Update README.md

This commit is contained in:
Tib3rius 2022-01-08 02:23:15 -05:00
parent 479bdcdd3d
commit 301f768c67
1 changed files with 35 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
README.md
View File

@ -149,52 +149,45 @@ A plugin update process is in the works. Until then, after upgrading, remove the
AutoRecon uses Python 3 specific functionality and does not support Python 2. AutoRecon uses Python 3 specific functionality and does not support Python 2.
``` ```
usage: autorecon [-t TARGET_FILE] [-p PORTS] [-m MAX_SCANS] [-mp MAX_PORT_SCANS] [-c CONFIG_FILE] [-g GLOBAL_FILE] usage: autorecon [-t TARGET_FILE] [-p PORTS] [-m MAX_SCANS] [-mp MAX_PORT_SCANS] [-c CONFIG_FILE] [-g GLOBAL_FILE] [--tags TAGS]
[--tags TAGS] [--exclude-tags TAGS] [--port-scans PLUGINS] [--service-scans PLUGINS] [--exclude-tags TAGS] [--port-scans PLUGINS] [--service-scans PLUGINS] [--reports PLUGINS] [--plugins-dir PLUGINS_DIR]
[--reports PLUGINS] [--plugins-dir PLUGINS_DIR] [--add-plugins-dir PLUGINS_DIR] [-l [TYPE]] [--add-plugins-dir PLUGINS_DIR] [-l [TYPE]] [-o OUTPUT] [--single-target] [--only-scans-dir] [--no-port-dirs]
[-o OUTPUT] [--single-target] [--only-scans-dir] [--create-port-dirs] [--heartbeat HEARTBEAT] [--heartbeat HEARTBEAT] [--timeout TIMEOUT] [--target-timeout TARGET_TIMEOUT] [--nmap NMAP | --nmap-append NMAP_APPEND]
[--timeout TIMEOUT] [--target-timeout TARGET_TIMEOUT] [--nmap NMAP | --nmap-append NMAP_APPEND] [--proxychains] [--disable-sanity-checks] [--disable-keyboard-control] [--force-services SERVICE [SERVICE ...]] [--accessible]
[--proxychains] [--disable-sanity-checks] [--disable-keyboard-control] [-v] [--version] [--curl.path VALUE] [--dirbuster.tool {feroxbuster,gobuster,dirsearch,ffuf,dirb}]
[--force-services SERVICE [SERVICE ...]] [--accessible] [-v] [--version] [--curl.path VALUE]
[--dirbuster.tool {feroxbuster,gobuster,dirsearch,ffuf,dirb}]
[--dirbuster.wordlist VALUE [VALUE ...]] [--dirbuster.threads VALUE] [--dirbuster.ext VALUE] [--dirbuster.wordlist VALUE [VALUE ...]] [--dirbuster.threads VALUE] [--dirbuster.ext VALUE]
[--onesixtyone.community-strings VALUE] [--global.username-wordlist VALUE] [--onesixtyone.community-strings VALUE] [--global.username-wordlist VALUE] [--global.password-wordlist VALUE]
[--global.password-wordlist VALUE] [--global.domain VALUE] [-h] [--global.domain VALUE] [-h]
[targets ...] [targets ...]
Network reconnaissance tool to port scan and automatically enumerate services found on multiple targets. Network reconnaissance tool to port scan and automatically enumerate services found on multiple targets.
positional arguments: positional arguments:
targets IP addresses (e.g. 10.0.0.1), CIDR notation (e.g. 10.0.0.1/24), or resolvable hostnames (e.g. targets IP addresses (e.g. 10.0.0.1), CIDR notation (e.g. 10.0.0.1/24), or resolvable hostnames (e.g. foo.bar) to scan.
foo.bar) to scan.
optional arguments: optional arguments:
-t TARGET_FILE, --target-file TARGET_FILE -t TARGET_FILE, --target-file TARGET_FILE
Read targets from file. Read targets from file.
-p PORTS, --ports PORTS -p PORTS, --ports PORTS
Comma separated list of ports / port ranges to scan. Specify TCP/UDP ports by prepending list Comma separated list of ports / port ranges to scan. Specify TCP/UDP ports by prepending list with T:/U: To scan both
with T:/U: To scan both TCP/UDP, put port(s) at start or specify B: e.g. TCP/UDP, put port(s) at start or specify B: e.g. 53,T:21-25,80,U:123,B:123. Default: None
53,T:21-25,80,U:123,B:123. Default: None
-m MAX_SCANS, --max-scans MAX_SCANS -m MAX_SCANS, --max-scans MAX_SCANS
The maximum number of concurrent scans to run. Default: 50 The maximum number of concurrent scans to run. Default: 50
-mp MAX_PORT_SCANS, --max-port-scans MAX_PORT_SCANS -mp MAX_PORT_SCANS, --max-port-scans MAX_PORT_SCANS
The maximum number of concurrent port scans to run. Default: 10 (approx 20% of max-scans unless The maximum number of concurrent port scans to run. Default: 10 (approx 20% of max-scans unless specified)
specified)
-c CONFIG_FILE, --config CONFIG_FILE -c CONFIG_FILE, --config CONFIG_FILE
Location of AutoRecon's config file. Default: ~/.config/AutoRecon/config.toml Location of AutoRecon's config file. Default: ~/.config/AutoRecon/config.toml
-g GLOBAL_FILE, --global-file GLOBAL_FILE -g GLOBAL_FILE, --global-file GLOBAL_FILE
Location of AutoRecon's global file. Default: ~/.config/AutoRecon/global.toml Location of AutoRecon's global file. Default: ~/.config/AutoRecon/global.toml
--tags TAGS Tags to determine which plugins should be included. Separate tags by a plus symbol (+) to group --tags TAGS Tags to determine which plugins should be included. Separate tags by a plus symbol (+) to group tags together. Separate
tags together. Separate groups with a comma (,) to create multiple groups. For a plugin to be groups with a comma (,) to create multiple groups. For a plugin to be included, it must have all the tags specified in
included, it must have all the tags specified in at least one group. Default: default at least one group. Default: default
--exclude-tags TAGS Tags to determine which plugins should be excluded. Separate tags by a plus symbol (+) to group --exclude-tags TAGS Tags to determine which plugins should be excluded. Separate tags by a plus symbol (+) to group tags together. Separate
tags together. Separate groups with a comma (,) to create multiple groups. For a plugin to be groups with a comma (,) to create multiple groups. For a plugin to be excluded, it must have all the tags specified in
excluded, it must have all the tags specified in at least one group. Default: None at least one group. Default: None
--port-scans PLUGINS Override --tags / --exclude-tags for the listed PortScan plugins (comma separated). Default: --port-scans PLUGINS Override --tags / --exclude-tags for the listed PortScan plugins (comma separated). Default: None
None
--service-scans PLUGINS --service-scans PLUGINS
Override --tags / --exclude-tags for the listed ServiceScan plugins (comma separated). Default: Override --tags / --exclude-tags for the listed ServiceScan plugins (comma separated). Default: None
None
--reports PLUGINS Override --tags / --exclude-tags for the listed Report plugins (comma separated). Default: None --reports PLUGINS Override --tags / --exclude-tags for the listed Report plugins (comma separated). Default: None
--plugins-dir PLUGINS_DIR --plugins-dir PLUGINS_DIR
The location of the plugins directory. Default: ~/.config/AutoRecon/plugins The location of the plugins directory. Default: ~/.config/AutoRecon/plugins
@ -204,21 +197,21 @@ optional arguments:
List all plugins or plugins of a specific type. e.g. --list, --list port, --list service List all plugins or plugins of a specific type. e.g. --list, --list port, --list service
-o OUTPUT, --output OUTPUT -o OUTPUT, --output OUTPUT
The output directory for results. Default: results The output directory for results. Default: results
--single-target Only scan a single target. A directory named after the target will not be created. Instead, the --single-target Only scan a single target. A directory named after the target will not be created. Instead, the directory structure will
directory structure will be created within the output directory. Default: False be created within the output directory. Default: False
--only-scans-dir Only create the "scans" directory for results. Other directories (e.g. exploit, loot, report) --only-scans-dir Only create the "scans" directory for results. Other directories (e.g. exploit, loot, report) will not be created.
will not be created. Default: False Default: False
--create-port-dirs Create directories for ports within the "scans" directory (e.g. scans/tcp80, scans/udp53) and --no-port-dirs Don't create directories for ports (e.g. scans/tcp80, scans/udp53). Instead store all results in the "scans" directory
store results in these directories. Default: True itself. Default: False
--heartbeat HEARTBEAT --heartbeat HEARTBEAT
Specifies the heartbeat interval (in seconds) for scan status messages. Default: 60 Specifies the heartbeat interval (in seconds) for scan status messages. Default: 60
--timeout TIMEOUT Specifies the maximum amount of time in minutes that AutoRecon should run for. Default: None --timeout TIMEOUT Specifies the maximum amount of time in minutes that AutoRecon should run for. Default: None
--target-timeout TARGET_TIMEOUT --target-timeout TARGET_TIMEOUT
Specifies the maximum amount of time in minutes that a target should be scanned for before Specifies the maximum amount of time in minutes that a target should be scanned for before abandoning it and moving on.
abandoning it and moving on. Default: None Default: None
--nmap NMAP Override the {nmap_extra} variable in scans. Default: -vv --reason -Pn --nmap NMAP Override the {nmap_extra} variable in scans. Default: -vv --reason -Pn -T4
--nmap-append NMAP_APPEND --nmap-append NMAP_APPEND
Append to the default {nmap_extra} variable in scans. Default: -T4 Append to the default {nmap_extra} variable in scans. Default:
--proxychains Use if you are running AutoRecon via proxychains. Default: False --proxychains Use if you are running AutoRecon via proxychains. Default: False
--disable-sanity-checks --disable-sanity-checks
Disable sanity checks that would otherwise prevent the scans from running. Default: False Disable sanity checks that would otherwise prevent the scans from running. Default: False
@ -239,25 +232,22 @@ plugin arguments:
The tool to use for directory busting. Default: feroxbuster The tool to use for directory busting. Default: feroxbuster
--dirbuster.wordlist VALUE [VALUE ...] --dirbuster.wordlist VALUE [VALUE ...]
The wordlist(s) to use when directory busting. Separate multiple wordlists with spaces. Default: The wordlist(s) to use when directory busting. Separate multiple wordlists with spaces. Default:
['/usr/share/seclists/Discovery/Web-Content/common.txt', '/usr/share/seclists/Discovery/Web- ['~/.config/AutoRecon/wordlists/dirbuster.txt']
Content/big.txt', '/usr/share/seclists/Discovery/Web-Content/raft-large-words.txt']
--dirbuster.threads VALUE --dirbuster.threads VALUE
The number of threads to use when directory busting. Default: 10 The number of threads to use when directory busting. Default: 10
--dirbuster.ext VALUE --dirbuster.ext VALUE
The extensions you wish to fuzz (no dot, comma separated). Default: txt,html,php,asp,aspx,jsp The extensions you wish to fuzz (no dot, comma separated). Default: txt,html,php,asp,aspx,jsp
--onesixtyone.community-strings VALUE --onesixtyone.community-strings VALUE
The file containing a list of community strings to try. Default: The file containing a list of community strings to try. Default: /usr/share/seclists/Discovery/SNMP/common-snmp-
/usr/share/seclists/Discovery/SNMP/common-snmp-community-strings-onesixtyone.txt community-strings-onesixtyone.txt
global plugin arguments: global plugin arguments:
These are optional arguments that can be used by all plugins. These are optional arguments that can be used by all plugins.
--global.username-wordlist VALUE --global.username-wordlist VALUE
A wordlist of usernames, useful for bruteforcing. Default: /usr/share/seclists/Usernames/top- A wordlist of usernames, useful for bruteforcing. Default: /usr/share/seclists/Usernames/top-usernames-shortlist.txt
usernames-shortlist.txt
--global.password-wordlist VALUE --global.password-wordlist VALUE
A wordlist of passwords, useful for bruteforcing. Default: A wordlist of passwords, useful for bruteforcing. Default: /usr/share/seclists/Passwords/darkweb2017-top100.txt
/usr/share/seclists/Passwords/darkweb2017-top100.txt
--global.domain VALUE --global.domain VALUE
The domain to use (if known). Used for DNS and/or Active Directory. Default: None The domain to use (if known). Used for DNS and/or Active Directory. Default: None
``` ```