From 011d0cdb9295baec8f6de095c41b8c7559a77dd7 Mon Sep 17 00:00:00 2001 From: Tib3rius <48113936+Tib3rius@users.noreply.github.com> Date: Sun, 8 May 2022 03:31:00 -0400 Subject: [PATCH] Updated API Documentation (markdown) --- API-Documentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/API-Documentation.md b/API-Documentation.md index 5c5d0dd..cf43794 100644 --- a/API-Documentation.md +++ b/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)