[Openvas-commits] r5749 - in trunk/gsa: . src/html/src/help src/html/src/img

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Wed Oct 28 20:42:31 CET 2009


Author: jan
Date: 2009-10-28 20:42:30 +0100 (Wed, 28 Oct 2009)
New Revision: 5749

Added:
   trunk/gsa/src/html/src/help/contents.htm4
   trunk/gsa/src/html/src/help/glossary.htm4
   trunk/gsa/src/html/src/help/tasks.htm4
   trunk/gsa/src/html/src/img/high_big.png
   trunk/gsa/src/html/src/img/low_big.png
   trunk/gsa/src/html/src/img/medium_big.png
   trunk/gsa/src/html/src/img/none_big.png
Modified:
   trunk/gsa/ChangeLog
Log:
* src/html/src/help/tasks.htm4, src/html/src/help/contents.htm4,
src/html/src/help/glossary.htm4: New.

* src/html/src/img/high_big.png, src/html/src/img/medium_big.png,
src/html/src/img/none_big.png, src/html/src/img/low_big.png: New.



Modified: trunk/gsa/ChangeLog
===================================================================
--- trunk/gsa/ChangeLog	2009-10-28 16:40:33 UTC (rev 5748)
+++ trunk/gsa/ChangeLog	2009-10-28 19:42:30 UTC (rev 5749)
@@ -1,5 +1,13 @@
 2009-10-28  Jan-Oliver Wagner <jan-oliver.wagner at greenbone.net>
 
+	* src/html/src/help/tasks.htm4, src/html/src/help/contents.htm4,
+	src/html/src/help/glossary.htm4: New.
+
+	* src/html/src/img/high_big.png, src/html/src/img/medium_big.png,
+	src/html/src/img/none_big.png, src/html/src/img/low_big.png: New.
+
+2009-10-28  Jan-Oliver Wagner <jan-oliver.wagner at greenbone.net>
+
 	* src/html/src/img/list_inactive.png, src/html/src/img/list.png,
 	src/html/src/img/log.png, src/html/src/img/gsa_splash.png,
 	src/html/src/img/low.png, src/html/src/img/high.png,

Added: trunk/gsa/src/html/src/help/contents.htm4
===================================================================
--- trunk/gsa/src/html/src/help/contents.htm4	2009-10-28 16:40:33 UTC (rev 5748)
+++ trunk/gsa/src/html/src/help/contents.htm4	2009-10-28 19:42:30 UTC (rev 5749)
@@ -0,0 +1,40 @@
+m4_define(`PAGE_TITLE', `Help: Contents')
+m4_include(`header.m4')
+
+<h1>Contents</h1>
+
+<p>
+This is the help system of Greenbone Security Assistant.
+Small <a href="/help/contents.html" title="Help"><img src="/img/help.png"></a>
+icons all over the web interface will jump into the respective contents.
+Alternatively you can browse the following structure.
+</p>
+
+<div id="list">
+<ul>
+<li> Scan Management</li>
+  <ul>
+  <li> <a href="new_task.html">New task</a></li>
+  <li> <a href="tasks.html">Tasks</a></li>
+  <li> <a href="reports.html">Reports</a></li>
+  <li> <a href="view_report.html">View Report</a></li>
+  </ul>
+<li> Configuration</li>
+  <ul>
+  <li> <a href="configure_targets.html">Configure Targets</a></li>
+  <li> <a href="configure_scanconfigs.html">Configure Scan Configs</a></li>
+  <li> <a href="configure_credentials.html">Configure Credentials</a></li>
+  </ul>
+<li> Administration</li>
+  <ul>
+  <li> <a href="configure_users.html">Configure Users</a></li>
+  </ul>
+<li> Miscellaneous</li>
+  <ul>
+  <li> <a href="error_messages.html">Error Messages</a></li>
+  <li> <a href="glossary.html">Glossary</a></li>
+  </ul>
+</ul>
+</div>
+
+m4_include(`footer.m4')

Added: trunk/gsa/src/html/src/help/glossary.htm4
===================================================================
--- trunk/gsa/src/html/src/help/glossary.htm4	2009-10-28 16:40:33 UTC (rev 5748)
+++ trunk/gsa/src/html/src/help/glossary.htm4	2009-10-28 19:42:30 UTC (rev 5749)
@@ -0,0 +1,126 @@
+m4_define(`PAGE_TITLE', `Help: Glossary')
+m4_include(`header.m4')
+
+<div style="float:left;"><a href="/help/contents.html">Help Contents</a></div>
+&nbsp;<br />
+
+<h1>Glossary</h1>
+
+<p>
+For Greenbone Security Assistant (GSA) a number
+of terms are used consistently throughout the
+user interface.
+</p>
+
+<p>
+Most of the terms are general and to avoid
+misinterpretation, this page summarizes the
+definitions of these
+terms as they are used in GSA.
+</p>
+
+<a name="nvt"></a>
+<h2>Network Vulnerability Test (NVT)</h2>
+
+<p>
+A Network Vulnerability Test (NVT) is a routine
+that checks a target system for the presence a
+specific known or a potential security
+problem.
+</p>
+
+<p>
+NVTs are associated to families of similar
+tests. The selection of families and/or
+single NVTs is part of a
+<a href="#scanconfig">Scan Configuration</a>.
+</p>
+
+<a name="report"></a>
+<h2>Report</h2>
+
+<p>
+A report is the result of a <a href="#scan">Scan</a>
+and contains a summary of what the selected NVTs found
+out for each of the target hosts.
+</p>
+
+<p>
+A report is always associated with a
+<a href="#task">task</a>. The
+<a href="#scanconfig">Scan Configuration</a> that
+detemines the extend of the report is part of the
+associated task and can not be modified. Therefore,
+for any report it is ensured that its execution
+configuration is preserved and available.
+</p>
+
+<a name="scan"></a>
+<h2>Scan</h2>
+
+<p>
+A scan is a <a href="#task">task</a> in progress.
+For each task only one scan can be active.
+The result of a scan is a <a href="#report">report</a>.
+</p>
+
+<p>
+The status of all active scan can be seen
+in the <a href="/omp?get_status">task overview</a>.
+The progress is shown as a percentage of
+total number of tests to be executed. The
+duration of a scan is determined by the number
+<a href="#target">tagets</a> and the complexity
+of the <a href="#scanconfig">Scan Configuration</a>
+and ranges from 1 minute to many hours or even days.
+</p>
+
+<p>
+The task overview offers an option to stop a scan.
+The resulting report will then be imcomplete.
+</p>
+
+<a name="scanconfig"></a>
+<h2>Scan Configuration</h2>
+
+<p>
+A scan configuration covers the selection
+of <a href="#nvt">NVTs</a> as well as general
+and very specific (expert) parameters for the scan server
+and for some of the NVTs.
+</p>
+
+<p>
+Not covered by a Scan Configuration is the selection
+of targets. These are separately specified as a
+<a href="#target">target</a>.
+</p>
+
+<a name="target"></a>
+<h2>Target</h2>
+
+<p>
+A target defines a set of systems (called "hosts")
+that are to be scanned. 
+The systems are identified either by
+their IP address or by their hostname.
+</p>
+
+<a name="task"></a>
+<h2>Task</h2>
+
+<p>
+A task is initially formed by a <a href="#target">target</a>
+and a <a href="#scanconfig">scan configuration</a>.
+Executing a task means to create a <a href="#scan">scan</a>.
+As a result, a task collects a series
+of <a href="#report">reports</a>.
+</p>
+
+<p>
+The target and scan configuration is static.
+Thus, the resulting sequence of reports describe the
+change of security status over time.
+</p>
+
+m4_include(`footer.m4')

Added: trunk/gsa/src/html/src/help/tasks.htm4
===================================================================
--- trunk/gsa/src/html/src/help/tasks.htm4	2009-10-28 16:40:33 UTC (rev 5748)
+++ trunk/gsa/src/html/src/help/tasks.htm4	2009-10-28 19:42:30 UTC (rev 5749)
@@ -0,0 +1,262 @@
+m4_define(`PAGE_TITLE', `Help: Tasks')
+m4_include(`header.m4')
+
+<div style="float:left;"><a href="/help/contents.html">Help Contents</a></div>
+<div style="float:right;"><a href="/omp?cmd=get_status">Jump to dialog</a></div>
+&nbsp;<br />
+
+<a name="tasks"></a>
+<h1>Tasks</h1>
+
+<p>
+This table provides on overview on all configured
+<a href="glossary.html#task">tasks</a> and summarizes
+the essential aspects for each.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td>Column</td>
+  <td>Description</td>
+</tr>
+<tr class="odd">
+  <td>Task</td>
+  <td>Shows name of the task. Names are not
+      necessarily unique, so the same name
+      may appear multiply. An internal ID
+      distinguishes the tasks.</td>
+</tr>
+<tr>
+  <td>Status</td>
+  <td>The status of a task is one of these:
+      <br />
+      <table>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Running">
+          <div class="progressbar_bar" style="width:42px;"></div>
+          <div class="progressbar_text">42 %</div>
+        </div>
+      </td><td>
+        A active scan for this task is running and completed 42%.
+        The percentage refers
+        to number of hosts multiplied with number of NVTs. Thus,
+        it may not correspond perfectly with the duration of the scan.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="New">
+          <div class="progressbar_bar_new" style="width:100px;"></div>
+          <div class="progressbar_text"><i><b>New</b></i></div>
+        </div>
+      </td><td>
+        The task has not been started since it was created.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Requested">
+          <div class="progressbar_bar_request" style="width:100px;"></div>
+          <div class="progressbar_text">Requested</div>
+        </div>
+      </td><td>
+        This task has just been started and prepares to delegate the scan
+        to the scan engine.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Delete&nbsp;Requested">
+          <div class="progressbar_bar_request" style="width:100px;"></div>
+          <div class="progressbar_text">Delete&nbsp;Requested</div>
+        </div>
+      </td><td>
+        The user has recently deleted the task. Currently the manager
+        server cleans up the database which might take some time because
+        any reports associated with this task will be removed as well.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Stop Requested">
+          <div class="progressbar_bar_request" style="width:100px;"></div>
+          <div class="progressbar_text">Stop Requested</div>
+        </div>
+      </td><td>
+        The user has recently aborted the scan. Currently the manager
+        server has submitted this command to the scanner, but the scanner
+        has not yet cleanly stopped the scan.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Stopped">
+          <div class="progressbar_bar_request" style="width:100px;"></div>
+          <div class="progressbar_text">Stopped</div>
+        </div>
+      </td><td>
+        The last scan for this task was aborted by the user. The newest
+        report might be incomplete.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Internal Error">
+          <div class="progressbar_bar_error" style="width:100px;"></div>
+          <div class="progressbar_text">Internal Error</div>
+        </div>
+      </td><td>
+        The last scan for this task resulted in a error. The newest
+        report might be imcomplete or entirely missing. In the latter case
+        the newest visible report is in fact one from an earlier scan.
+      </td></tr>
+      <tr><td valign="top">
+        <div class="progressbar_box" title="Done">
+          <div class="progressbar_bar_done" style="width:100px;"></div>
+          <div class="progressbar_text">Done</div>
+        </div>
+      </td><td>
+        The Task returned successful from a scan and produced a report. The
+        newest report is complete with regard to targets and scan configuration
+        of the task.
+      </td></tr>
+      </table>
+  </td>
+</tr>
+<tr class="odd">
+  <td>Reports:&nbsp;Total</td>
+  <td>The number of reports that have been created by
+      running this task.</td>
+</tr>
+<tr>
+  <td>Reports:&nbsp;First</td>
+  <td>Date when the first report was created.
+      This field is left empty if less then 2
+      reports are available.</td>
+</tr>
+<tr class="odd">
+  <td>Reports:&nbsp;Last</td>
+  <td>Date when the newest report was created.</td>
+</tr>
+<tr>
+  <td>Threat</td>
+  <td>Threat level of the newest report. These levels
+      can occur:
+      <br />
+      <table>
+      <tr>
+        <td valign="top"><img src="/img/high_big.png" /></td>
+        <td>
+          High: At least one NVT reported severity "High" for at least one
+          target host in the newest report.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/medium_big.png" /></td>
+        <td>
+          Medium: Severity "High" does not occur in the newest
+          report. At least one NVT reported severity "Medium"
+          for at least one target host in the newest report.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/low_big.png" /></td>
+        <td>
+          Low: Neither severity "High" nor "Medium" occurs in the newest report.
+          At least one NVT reported severity "Low" for at
+          least one target host in the newest report.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/none_big.png" /></td>
+        <td>
+          None: No security threat occurs in the newest report. Perhaps
+          some NVT created a log information, so the report is not necessarily empty.
+        </td>
+      </tr>
+      </table>
+</tr>
+<tr class="odd">
+  <td>Trend</td>
+  <td>Describes the change of threat between the newest
+      report and the report before the newest:
+      <br />
+      <table>
+      <tr>
+        <td valign="top"><img src="/img/trend_up.png" /></td>
+        <td>
+          Threat level increased: In the newest report at least one NVT for at least one
+          target host reported a higher severity level than any NVT reported
+          in the report before the newest one.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/trend_more.png" /></td>
+        <td>
+          Threat number increased: The threat level of the last report
+          and the report before the
+          last report is the same. But the newest report contains more
+          security issues of this threat level than the report before.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/trend_nochange.png" /></td>
+        <td>
+          Threat did not change: The number of High, Medium, Low and Log
+          reports of the newest report and the one before are identical.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/trend_less.png" /></td>
+        <td>
+          Threat number decreased: The threat level of the last
+          report and the report before the
+          last report is the same. But the newest report contains less
+          of the security issues of this threat level than the report before.
+        </td>
+      </tr><tr>
+        <td valign="top"><img src="/img/trend_down.png" /></td>
+        <td>
+          Threat level decreased: In the newest report at no NVT for at any
+          target host reported a severity level as high as the severity
+          level of the report before the newest one.
+        </td>
+      </tr>
+      </table>
+  </td>
+</tr>
+</table>
+
+<a name="actions"></a>
+<h3>Actions</h3>
+
+<h4>Start Task</h4>
+
+<p>
+Pressing the start icon <img src="/img/start.png" alt="Start" title="Start" /> will
+start a new scan. The list of tasks will be updated.
+</p>
+
+<p>
+This action is only available if the task has status "New" or "Done".
+</p>
+
+<h4>Abort Task</h4>
+
+<p>
+Pressing the abort icon <img src="/img/stop.png" alt="Abort" title="Abort" /> will
+abort a running task. The list of tasks will be updated and for this task
+a half-finished report is added to the list of reports.
+</p>
+
+<p>
+This action is only available if the task status shows a progress bar.
+</p>
+
+<h4>Delete Task</h4>
+
+<p>
+Pressing the delete icon <img src="/img/delete.png" alt="Delete" title="Delete" /> will
+remove the task immediately. The list of tasks will be updated. Note that also all
+of the reports associated with this task will be removed.
+</p>
+
+<p>
+This action is only available if the task has status "New" or "Done".
+</p>
+
+<h4>Reports</h4>
+
+<p>
+Pressing the report icon <img src="/img/list.png" alt="Reports" title="Reports" /> will
+switch to an overview on all reports for this task.
+It is the same action as clicking on the number of reports in the column "Reports: Total".
+</p>
+
+<p>
+This action is only available if at least one report is present.
+</p>
+
+m4_include(`footer.m4')

Added: trunk/gsa/src/html/src/img/high_big.png
===================================================================
(Binary files differ)


Property changes on: trunk/gsa/src/html/src/img/high_big.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/gsa/src/html/src/img/low_big.png
===================================================================
(Binary files differ)


Property changes on: trunk/gsa/src/html/src/img/low_big.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/gsa/src/html/src/img/medium_big.png
===================================================================
(Binary files differ)


Property changes on: trunk/gsa/src/html/src/img/medium_big.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/gsa/src/html/src/img/none_big.png
===================================================================
(Binary files differ)


Property changes on: trunk/gsa/src/html/src/img/none_big.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream



More information about the Openvas-commits mailing list