diff --git a/scripts/broadcast-dropbox-listener.nse b/scripts/broadcast-dropbox-listener.nse index 9f2b69f74..34f22d9b9 100644 --- a/scripts/broadcast-dropbox-listener.nse +++ b/scripts/broadcast-dropbox-listener.nse @@ -10,6 +10,7 @@ Listens for the LAN sync information broadcasts that the Dropbox.com client broa If the newtargets script argument is given, all discovered Dropbox clients will be added to the Nmap target list rather than just listed in the output. ]] +--- -- @usage -- nmap --script=broadcast-dropbox-listener -- nmap --script=broadcast-dropbox-listener --script-args=newtargets -Pn diff --git a/scripts/broadcast-pim-discovery.nse b/scripts/broadcast-pim-discovery.nse index 33137be82..9ac35ef41 100644 --- a/scripts/broadcast-pim-discovery.nse +++ b/scripts/broadcast-pim-discovery.nse @@ -15,7 +15,7 @@ This works by sending a PIM Hello message to the PIM multicast address 224.0.0.13 and listening for Hello messages from other routers. ]] --- +--- -- @args broadcast-pim-discovery.timeout Time to wait for responses in seconds. -- Defaults to 5s. -- diff --git a/scripts/dns-blacklist.nse b/scripts/dns-blacklist.nse index 0d623adf6..9ad736a9f 100644 --- a/scripts/dns-blacklist.nse +++ b/scripts/dns-blacklist.nse @@ -53,7 +53,7 @@ PROXY) or to a specific service name. ]] -- -- @args dns-blacklist.ip string containing the IP to check only needed if -- running the script as a prerule. - +-- -- @args dns-blacklist.mode string containing either "short" or "long" -- long mode can sometimes provide additional information to why an IP -- has been blacklisted. (default: long) diff --git a/scripts/dns-update.nse b/scripts/dns-update.nse index bc5a7571e..6d90cd778 100644 --- a/scripts/dns-update.nse +++ b/scripts/dns-update.nse @@ -20,6 +20,9 @@ categories = {"discovery", "safe"} -- | Successfully added the record "nmap-test.cqure.net" -- |_ Successfully deleted the record "nmap-test.cqure.net" -- +-- @args dns-update.hostname the name of the host to add to the zone +-- @args dns-update.ip the ip address of the host to add to the zone +-- -- -- Examples @@ -36,9 +39,6 @@ categories = {"discovery", "safe"} -- * dns.update( "cqure.net", { host=host, port=port, dtype="MX", data="", ttl=0 } ) -- * dns.update( "_ldap._tcp.cqure.net", { host=host, port=port, dtype="SRV", data="", ttl=0 } ) -- --- @args dns-update.hostname the name of the host to add to the zone --- @args dns-update.ip the ip address of the host to add to the zone --- -- Version 0.2 diff --git a/scripts/http-git.nse b/scripts/http-git.nse index 56d06f0e2..975b703ff 100644 --- a/scripts/http-git.nse +++ b/scripts/http-git.nse @@ -12,6 +12,7 @@ possible, including language/framework, remotes, last commit message, and repository description. ]] +--- -- @output -- PORT STATE SERVICE REASON -- 80/tcp open http syn-ack diff --git a/scripts/http-grep.nse b/scripts/http-grep.nse index 03740f80d..c91b4b4ae 100644 --- a/scripts/http-grep.nse +++ b/scripts/http-grep.nse @@ -27,8 +27,7 @@ discovered. -- | + sales@example.com -- | + sales@example.com -- |__ + sales@example.com - - +-- -- @args http-grep.match the string to match in urls and page contents -- @args http-grep.maxdepth the maximum amount of directories beneath -- the initial url to spider. A negative value disables the limit. diff --git a/scripts/http-open-proxy.nse b/scripts/http-open-proxy.nse index 863b2691c..f7be47a4b 100644 --- a/scripts/http-open-proxy.nse +++ b/scripts/http-open-proxy.nse @@ -16,6 +16,10 @@ the target to retrieve a web page from www.google.com. --- -- @args proxy.url Url that will be requested to the proxy -- @args proxy.pattern Pattern that will be searched inside the request results +-- +-- @usage +-- nmap --script http-open-proxy.nse \ +-- --script-args proxy.url=,proxy.pattern= -- @output -- Interesting ports on scanme.nmap.org (64.13.134.52): -- PORT STATE SERVICE @@ -35,10 +39,6 @@ the target to retrieve a web page from www.google.com. -- * Included url and pattern arguments -- * Script now checks for http response status code, when url is used -- * If google is used, script checks for Server: gws --- --- @usage --- nmap --script http-open-proxy.nse \ --- --script-args proxy.url=,proxy.pattern= author = "Arturo 'Buanzo' Busleiman" license = "Same as Nmap--See http://nmap.org/book/man-legal.html" diff --git a/scripts/http-tplink-dir-traversal.nse b/scripts/http-tplink-dir-traversal.nse index e7fb826c2..f182fb14f 100644 --- a/scripts/http-tplink-dir-traversal.nse +++ b/scripts/http-tplink-dir-traversal.nse @@ -16,7 +16,6 @@ Other interesting files: -- @usage nmap -p80 --script http-tplink-dir-traversal.nse -- @usage nmap -p80 -Pn -n --script http-tplink-dir-traversal.nse -- @usage nmap -p80 --script http-tplink-dir-traversal.nse --script-args rfile=/etc/topology.conf -d -n -Pn - -- -- @output -- PORT STATE SERVICE REASON diff --git a/scripts/llmnr-resolve.nse b/scripts/llmnr-resolve.nse index a4e54d22c..8b947970f 100644 --- a/scripts/llmnr-resolve.nse +++ b/scripts/llmnr-resolve.nse @@ -82,9 +82,9 @@ local llmnrSend = function(query, mcast, mport) end -- Listens for llmnr responses --- @interface Network interface to listen on. --- @timeout Maximum time to listen. --- @result table to put responses into. +-- @param interface Network interface to listen on. +-- @param timeout Maximum time to listen. +-- @param result table to put responses into. local llmnrListen = function(interface, timeout, result) local condvar = nmap.condvar(result) local start = nmap.clock_ms() diff --git a/scripts/msrpc-enum.nse b/scripts/msrpc-enum.nse index 721deb88f..64a38ec54 100644 --- a/scripts/msrpc-enum.nse +++ b/scripts/msrpc-enum.nse @@ -20,7 +20,7 @@ or dcedump tool from SPIKE fuzzer. -- @output -- PORT STATE SERVICE REASON -- 445/tcp open microsoft-ds syn-ack - +-- -- Host script results: -- | msrpc-enum: -- | @@ -37,7 +37,7 @@ or dcedump tool from SPIKE fuzzer. -- | annotation: DHCP Client LRPC Endpoint -- | tcp_port: 49153 -- | - -- +-- -- | -- | uuid: 12345678-1234-abcd-ef00-0123456789ab -- | annotation: IPSec Policy agent endpoint diff --git a/scripts/mtrace.nse b/scripts/mtrace.nse index a28753a91..cba4b1d11 100644 --- a/scripts/mtrace.nse +++ b/scripts/mtrace.nse @@ -21,7 +21,7 @@ information about interface addresses, used protocols and error codes. This is similar to the mtrace utility provided in Cisco IOS. ]] --- +--- --@args mtrace.fromip Source address from which to traceroute. -- --@args mtrace.toip Destination address to which to traceroute. diff --git a/scripts/murmur-version.nse b/scripts/murmur-version.nse index d4f25e737..262ea50bc 100644 --- a/scripts/murmur-version.nse +++ b/scripts/murmur-version.nse @@ -31,6 +31,7 @@ the server. See http://mumble.sourceforge.net/Protocol. ]] +--- -- @output -- PORT STATE SERVICE VERSION -- 64740/tcp open murmur Murmur 1.2.4 (control port; users: 35; max. users: 100; bandwidth: 72000 b/s) diff --git a/scripts/rpc-grind.nse b/scripts/rpc-grind.nse index f3b568906..2053a1f8e 100644 --- a/scripts/rpc-grind.nse +++ b/scripts/rpc-grind.nse @@ -21,6 +21,7 @@ hasn't exported program) means that we have sent the incorrect program number. Any other accept state is an incorrect behaviour. ]] +--- -- @args rpc-grind.threads Number of grinding threads. Defaults to 4 -- -- @usage diff --git a/scripts/ventrilo-info.nse b/scripts/ventrilo-info.nse index d7dc90dce..5aab4462f 100644 --- a/scripts/ventrilo-info.nse +++ b/scripts/ventrilo-info.nse @@ -31,6 +31,7 @@ Original reversing of the protocol was done by Luigi Auriemma (http://aluigi.altervista.org/papers.htm#ventrilo). ]] +--- -- @usage -- nmap -sV -- @usage