Nmap Development mailing list archives

Help needed for Zenmap Profile Editor


From: Jurand Nogiec <jurand () gmail com>
Date: Sun, 03 Aug 2008 13:18:56 -0500

Greetings!

I have written a new interactive help system for the Profile Editor system in the Zenmap nmap GUI frontend. I am looking for help writing the help text for the system.

The purpose of the Profile Editor is to allow you to assemble an nmap command to run in the Zenmap program by using graphical selection of text and checkbox input.

The new help system allows you to mouse over options used in the Profile Editor and to display a bit of an overview about what it is used for and what proper input for that option is in the help textbox. A screenshot is attached to better show the system. You may wish to load the SVN code to show the current help system by doing an SVN checkout:

svn co --username guest --password "" svn://svn.insecure.org/nmap-exp/jurand/zenmap-help

I need help writing the help texts that show up when the user does a mouse over a specific nmap option. The data necessary is condensing descriptions of options into 1-3 sentences and filling in example input.

For instance, here is an example for the -D (Cloak a scan with decoys) in refguide.xml for the corresponding profile_editor.xml output
<option_check label="Use decoys to hide identity" option="Use decoys"
arg_type="str" short_desc="Send fake decoy probes from spoofed addresses
to hide your own address. Give a list of addresses separated by commas.
Use RND for a random address and ME to set the position of your address."
example="<decoy1>,<decoy2>,ME,RND,RND"/>

There are more examples in the attached profile_editor.xml. Please note, it is not required to use data from refguide.xml / nmap reference guide ( http://nmap.org/book/man.html ) but it might be useful as a base guide. Feel free to use any knowledge otherwise from this guide if you want.

I have broken the options into groups based on what tab they appear in. I want a volunteer for each of the four blocks of options. Write back to the list to claim one. The groups are listed in profile_editor.xml too.

(#1) "Scan" group: 24 options
(#2) "Ping" and "Scripting" groups: 13 options total
(#3) "Target" and "Source" groups: 10 options total
(#4) "Other" and "Advanced" groups: 17 options total

Contributors to this project will get acknowledgement and are warmly thanked for any help. If you have any questions and/or want to contribute, please reply.

Thank you,
Jurand Nogiec
http://www.jurand.net

<?xml version="1.0"?>
<interface>
  <groups>
    <group name="Scan" short_desc="" example=""/>
    <group name="Ping" short_desc="" example=""/>
    <group name="Scripting" short_desc="" example=""/>
    <group name="Target" short_desc="" example=""/>
    <group name="Source" short_desc="" example=""/>
    <group name="Other" short_desc="" example=""/>
    <group name="Advanced" short_desc="" example=""/>
  </groups>
  <Scan label="Scan options">
    <option_list label="TCP scan: ">
      <option name="None" label="" short_desc="" example=""/>
      <option name="ACK scan" label="ACK scan (-sA)" short_desc="ACK Scan" example=""/>
      <option name="FIN scan" label="" short_desc="" example=""/>
      <option name="Null Scan" label="" short_desc="" example=""/>
      <option name="TCP SYN Scan" label="" short_desc="" example=""/>
      <option name="TCP connect Scan" label="" short_desc="" example=""/>
      <option name="Window Scan" label="" short_desc="" example=""/>
      <option name="Xmas Tree" label="" short_desc="" example=""/>
    </option_list>    
    <option_list label="Non-TCP scans: ">
      <option name="None" short_desc="" example=""/>
      <option name="UDP Scan" short_desc="" example=""/>
      <option name="IP protocol Scan" short_desc="" example=""/>
      <option name="List Scan" short_desc="" example=""/>
      <option name="Ping scanning" short_desc="" example=""/>
    </option_list>    
    <option_list label="Timing: ">
      <option name="None" short_desc="" example=""/>
      <option name="Paranoid" short_desc="" example=""/>
      <option name="Sneaky" short_desc="" example=""/>
      <option name="Polite" short_desc="" example=""/>
      <option name="Normal" short_desc="" example=""/>
      <option name="Aggressive" short_desc="" example=""/>
      <option name="Insane" short_desc="" example=""/>
    </option_list>    
    <option_check label="FTP bounce attack" option="FTP bounce attack" arg_type="str" short_desc="test1" example=""/>
    <option_check label="Idle Scan (Zombie)" option="Idle Scan" arg_type="str" short_desc="" example=""/>
    <option_check label="Services version detection" option="Version detection" short_desc="Attempt to discover the 
version number of services running on remote ports." example=""/>
    <option_check label="Operating system detection" option="Operating system detection" short_desc="" example=""/>
    <option_check label="Disable reverse DNS resolution" option="Disable reverse DNS resolution" short_desc="" 
example=""/>
    <option_check label="IPv6 support" option="IPv6 support" short_desc="" example=""/>
    <option_check label="Maximum Retries" option="Max Retries" arg_type="int" short_desc="" example=""/>
  </Scan>
  <Ping label="Ping options">
    <option_check label="Don't ping before scanning" option="Ping after Scan" short_desc="" example=""/>
    <option_check label="ICMP ping" option="ICMP ping" short_desc="" example=""/>
    <option_check label="ICMP timestamp request" option="ICMP timestamp" short_desc="" example=""/>
    <option_check label="ICMP netmask request" option="ICMP netmask" short_desc="" example=""/>
    <option_check label="Default ping type" option="Default ping" short_desc="" example=""/>
    <option_check label="ACK ping" option="TCP ACK" arg_type="str" short_desc="" example=""/>
    <option_check label="SYN ping" option="TCP SYN" arg_type="str" short_desc="" example=""/>
    <option_check label="UDP probes" option="UDP Probe" arg_type="str" short_desc="" example=""/>
    <option_check label="IPProto probes" option="IPProto Probe" arg_type="str" short_desc="" example=""/>
  </Ping>
  <Scripting label="Scripting options (NSE)">
    <option_check label="Script scan" option="Script scan" short_desc="" example=""/>
    <option_check label="Scripts to run" option="Script selection" arg_type="str" short_desc="" example=""/>
    <option_check label="Script arguments" option="Script arguments" arg_type="str" short_desc="" example=""/>
    <option_check label="Trace script execution" option="Script trace" short_desc="" example=""/>
    <!-- <option_check label="Trace script execution" option="Script trace" short_desc="" example=""/> -->
  </Scripting>
  <Target label="Target options">
    <option_check label="Excluded hosts/networks" option="Excluded hosts/networks" arg_type="str" short_desc="" 
example=""/>
    <option_check label="Excluded hosts/networks from file" option="Excluded hosts/networks from file" arg_type="path" 
short_desc="" example=""/>
    <option_check label="Read hosts to be scanned from file" option="Read hosts from file" arg_type="path" 
short_desc="" example=""/>
    <option_check label="Scan random hosts" option="Scan random hosts" arg_type="int" short_desc="" example=""/>
    <option_check label="Ports to scan" option="Ports to scan" arg_type="str" short_desc="" example=""/>
    <option_check label="Only scan ports listed on services" option="Scan services ports" short_desc="" example=""/>
  </Target>
  <Source label="Source options">
    <option_check label="Use decoys to hide identity" option="Use decoys" arg_type="str" short_desc="Send fake decoy 
probes from spoofed addresses to hide your own address. Give a list of addresses separated by commas. Use RND for a 
random address and ME to set the position of your address." example="&lt;decoy1&gt;,&lt;decoy2&gt;,ME,RND,RND"/>
    <option_check label="Set source IP address" option="Set source IP" arg_type="str" short_desc="" example=""/>
    <option_check label="Set source port" option="Set source port" arg_type="str" short_desc="" example=""/>
    <option_check label="Set network interface" option="Set network interface" arg_type="str" short_desc="" example=""/>
  </Source>
  <Other label="Other options">
    <option_check label="Extra options defined by user" option="Extra" arg_type="str" short_desc="Extra options defined 
by user" example=""/>
    <option_check label="Set IPv4 time to live (ttl)" option="Set IPv4 ttl" arg_type="str" short_desc="Set IPv4 time to 
live (ttl)" example=""/>
    <option_check label="Fragment IP packets" option="Fragment IP Packets" short_desc="Fragment IP packets" example=""/>
    <option_check label="Verbosity level" option="Verbose" arg_type="level" short_desc="Verbosity level" example=""/>
    <option_check label="Debugging level" option="Debug" arg_type="level" short_desc="Debug" example=""/>
    <option_check label="Watch packets" option="Watch packets" short_desc="Watch packets" example=""/>
    <option_check label="Disable randomizing scanned ports" option="Disable randomizing scanned ports" 
short_desc="Disable randomizing scanned ports" example=""/>
  </Other>
  <Advanced label="Advanced options">
    <option_check label="Time spent before giving up on an IP" option="Time before give up IP" arg_type="int" 
short_desc="" example=""/>
    <option_check label="Time spent before retransmitting or timing out" option="Time before retransmitting" 
arg_type="int" short_desc="" example=""/>
    <option_check label="Minimum timeout time per probe" option="Min timeout per probe" arg_type="int" short_desc="" 
example=""/>
    <option_check label="Specifies the initial probe timeout" option="Initial probe timeout" arg_type="int" 
short_desc="" example=""/>
    <option_check label="Maximum number of hosts in parallel" option="Max parallel hosts" arg_type="int" short_desc="" 
example=""/>
    <option_check label="Minimum number of hosts in parallel" option="Min parallel hosts" arg_type="int" short_desc="" 
example=""/>
    <option_check label="Maximum number of scans in parallel" option="Max parallel scans" arg_type="int" short_desc="" 
example=""/>
    <option_check label="Minimum number of scans in parallel" option="Min parallel scans" arg_type="int" short_desc="" 
example=""/>
    <option_check label="Maximum amount of time between probes" option="Max time between probes" arg_type="int" 
short_desc="Wait at least the given amount of time between each probe sent to a given host. Time is in milliseconds, 
unless followed by a suffix of 's' for seconds, 'm' for minutes, or 'h' for hours." example="20"/>
    <option_check label="Minimum amount of time between probes" option="Min time between probes" arg_type="int" 
short_desc="" example=""/>
  </Advanced>
</interface>

_______________________________________________
Sent through the nmap-dev mailing list
http://cgi.insecure.org/mailman/listinfo/nmap-dev
Archived at http://SecLists.Org

Current thread: