root/branch/sphinxdoc/src/profile_editor.rst @ 4321

Revision 4321, 4.0 kB (checked in by luis, 4 years ago)

Convert Profile Editor Documentation to RST format

Line 
1Profile Editor
2==================
3
4.. sectionauthor:: Adriano Monteiro Marques
5
6.. warning::
7
8   This documentation is not finished! Part or all of it's content may be
9   missing or inaccurate. As Umit is under constant development and
10   improvement, expect changes in this documentation at upcoming releases.
11
12
13Introduction
14-------------------
15
16What is the profile editor?
17~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 
19Using **Umit** it's normal when you can use the same arguments or make some scans
20and sometimes it's not easy to search for the same options of nmap again.
21   
22What do it does?
23~~~~~~~~~~~~~~~~~~
24 
25Profile Editor is able to create, copy and delele profiles. With it
26you should be able to save the nmap arguments and run scans with some paramenters in the
27future.
28   
29The customization advantage: It's easy to call a Profile.
30In the tab scan you only choose the target, and select a Profile. It
31will define automatically the Nmap parameters.
32
33The profile editor modes
34   
35New profile:
36It's easy to create a new profile, you can define all **Nmap** parameters and
37save you a suggestive name.
38
39Edit profile
40If you sometimes want to change the paramenters of profile, you should be use
41edit of profiles and add, or remove the parameters, checking it on the boxes.
42   
43
44Creating a simple scan profile
45------------------------------------
46
47   .. image:: static/profile_editor_1.png
48      :align: center       
49   
50Screenshot above it's the Profile Editor.
51
52Use the key-stroke
53The key-stroke that creates a new Profile is CTRL + P
54   
55Acces from the Main Menu
56~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57
58Go to the **Main Menu** (the one on the top of the application),
59*Profile*  ; New Profile
60   
61The profile descriptions (name, hint, description, etc.)
62There are some fields to fill about a Profile. It's mandatory fill the
63name.
64
65Name: It is the name that appears on combo box of **Scan Tab** 
66Hint: it is a tooltip
67Description: it's just to say what this profile does.
68   
69You can browse on the tabs and apply option that you wish to build
70a profile that you intend.   
71   
72Just press Ok and you save the profile
73How to use the recently created profile?
74You can find recently profile created on Combo box in Scan tab. So just fill the target, select profile and press scan. The option of your new profile are running on the scan.     
75   
76
77Editing a profile
78----------------------------
79
80Use the key-stroke
81The key-stroke Edit Profile is *CTRL + E* 
82   
83Acces from the Main Menu.
84Go to the **Main Menu** (the one on the top of the application),
85*Profile*; Edit Profile
86   
87
88Creating a new profile based on an old one
89------------------------------------------------
90
91This option is like copy a profile. If you have a Profile and you can create
92 a similar Profile, use it.
93
94Use the key-stroke
95In combo Box of Scan Tab select a profile. The key-stroke create Profile is *CTRL + R*
96
97Acces from the Main Menu.
98Select Profile in combo box of Scan tab and go to the **Main Menu** (the one on the top of the application),
99Profile; New Profile with Selected
100
101
102Delete Profiles
103-----------------------------
104   
105If you want delete a Profile by some reason it is possible.
106Only follow the one of the procedure
107   
108Use the key-stroke
109In combo Box of Scan Tab select a profile. The key-stroke delete Profile is *CTRL + M* 
110   
111Acces from the Main Menu.
112Select Profile in combo box of Scan tab and go to the **Main Menu** (the one on the top of the application),
113Profile; Delete Profile
114
115
116Using Profile Editor
117
118Select Profile in combo box of Scan tab and go to **Main Menu** (the one on the top of the application),
119Profile ; Edit Profile.
120Press *Delete* button.
121   
122
123
124The profile editor structure
125---------------------------------------
126
127Where is saved options? In options.xml, you can find in your
128*$HOME/.umit/* 
129   
130
131The profile_editor.xml can be found on the same place and it uses options
132from options.xml
133   
134The widgets available for options is combo box, checkbox and text
135entry. We have the box with numbers (for example, number of ports) to
136use as parameter.     
Note: See TracBrowser for help on using the browser.