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

Updated API Documentation (markdown)

Tib3rius 2022-05-08 03:31:00 -04:00
parent f8fb812d0a
commit 011d0cdb92
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
API-Documentation.md

@ -41,9 +41,9 @@ The `add_service` method can be used by a PortScan plugin to report a new servic
The `execute` method can be used by a PortScan plugin to execute a command in a /bin/bash shell. The `cmd` argument should be a string representation of the command you wish to execute. The following markers can be used within the string, and will get automatically converted to their correct values by AutoRecon:
* `{address}` - The address of the target (e.g. 127.0.0.1, ::1, example.com).
* `{addressv6}` - Despite its name, this still represents the address of the target if it is IPv4 or a hostname. The difference is the IPv6 address will be represented as [::1] which is a common format for several tools.
* `{addressv6}` - Despite its name, this still represents the address of the target if it is IPv4 or a hostname. However, an IPv6 address will be surrounded with square brackets (e.g. [::1]) which is a common format for several tools.
* `{ipaddress}` - The IP address of the target (e.g. 127.0.0.1, ::1). If the target is a hostname, the resolved IP will be used.
* `{ipaddressv6}` - Despite its name, this still represents the IP address of the target if it is IPv4. The difference is the IPv6 address will be represented as [::1] which is a common format for several tools.
* `{ipaddressv6}` - Despite its name, this still represents the IP address of the target if it is IPv4. However, an IPv6 address will be surrounded with square brackets (e.g. [::1]) which is a common format for several tools. If the target is a hostname, the resolved IP will be used.
* `{nmap_extra}` - Extra nmap options provided by the user at runtime. Defaults to: -vv --reason -Pn
* `{scandir}` - The full path to the target's scans directory (e.g. /home/kali/results/127.0.0.1/scans)