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

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Mon Oct 26 15:12:13 CET 2009


Author: jan
Date: 2009-10-26 15:12:12 +0100 (Mon, 26 Oct 2009)
New Revision: 5735

Added:
   trunk/gsa/src/html/src/help/configure_credentials.htm4
   trunk/gsa/src/html/src/help/configure_scanconfigs.htm4
   trunk/gsa/src/html/src/help/configure_users.htm4
Modified:
   trunk/gsa/ChangeLog
Log:
* src/html/src/help/configure_scanconfigs.htm4,
src/html/src/help/configure_credentials.htm4,
src/html/src/help/configure_users.htm4: New. More documentation.



Modified: trunk/gsa/ChangeLog
===================================================================
--- trunk/gsa/ChangeLog	2009-10-26 13:30:14 UTC (rev 5734)
+++ trunk/gsa/ChangeLog	2009-10-26 14:12:12 UTC (rev 5735)
@@ -1,5 +1,11 @@
 2009-10-26  Jan-Oliver Wagner <jan-oliver.wagner at greenbone.net>
 
+	* src/html/src/help/configure_scanconfigs.htm4,
+	src/html/src/help/configure_credentials.htm4,
+	src/html/src/help/configure_users.htm4: New. More documentation.
+
+2009-10-26  Jan-Oliver Wagner <jan-oliver.wagner at greenbone.net>
+
 	* src/CMakeLists.txt: Changed - to _ in module names.
 
 	* src/gsad_oap.h: Fixed filename in doc.

Added: trunk/gsa/src/html/src/help/configure_credentials.htm4
===================================================================
--- trunk/gsa/src/html/src/help/configure_credentials.htm4	2009-10-26 13:30:14 UTC (rev 5734)
+++ trunk/gsa/src/html/src/help/configure_credentials.htm4	2009-10-26 14:12:12 UTC (rev 5735)
@@ -0,0 +1,157 @@
+m4_define(`PAGE_TITLE', `Help: Configure Credentials')
+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_lsc_credentials">Jump to dialog</a></div>
+&nbsp;<br />
+
+<h1>Configure Credentials for Local Security Checks</h1>
+
+<p>
+Credentials for local security checks are required to allow
+<a href="glossary.html#nvt">NVTs</a> to log into target systems
+for the purpose of locally check there e.g. for the presence
+of all vendor security patches.
+</p>
+
+<p>
+Internally, secure passwords will generated to allow the scan engine
+to access the respecive target systems. However, users are not able
+not allowed to access either passwords nor so-called private keys.
+</p>
+
+<p>
+<b>Please note</b> that you will need to associate target IPs/names
+with the credential you installed on them. Only this finally allows
+the scan engine to apply the suitable credentials.
+</p>
+
+<a name="new_lsc_credential"></a>
+<h2>New Credential for Local Security Checks</h2>
+
+<p>
+For creating a credential the dialog offers these entries.
+Hit the button "Create Credential" to submit the new credential.
+The list of credentials will be updated.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td></td>
+  <td>Mandatory</td>
+  <td>Max Length</td>
+  <td>Syntax</td>
+  <td>Example</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>yes</td>
+  <td>80</td>
+  <td>Alphanumeric</td>
+  <td>Security Scan Account</td>
+</tr>
+<tr class="odd">
+  <td>Comment</td>
+  <td>no</td>
+  <td>40</td>
+  <td>Alphanumeric</td>
+  <td>For the Windows systems</td>
+</tr>
+</table>
+
+<a name="credentials"></a>
+<h2>Credentials for Local Security Checks</h2>
+
+<p>
+This table provides on overview on all configured
+credentials.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td>Column</td>
+  <td>Description</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>Shows name of the credential.</td>
+</tr>
+<tr>
+  <td>Comment</td>
+  <td>Shows the comment that was provided for this credential.</td>
+</tr>
+</table>
+
+<a name="actions"></a>
+<h3>Actions</h3>
+
+<h4>Delete Credential</h4>
+
+<p>
+Pressing the delete icon
+<img src="/img/delete.png" alt="Delete" title="Delete" />
+will immedialy remove the entry and update the list.
+</p>
+
+<h4>Download RPM Package</h4>
+
+<p>
+Pressing the RPM icon
+<img src="/img/rpm.png" alt="Download RPM Package" title="Download RPM Package" />
+will download a ".rpm" installation package.
+</p>
+
+<p>
+With installing this package on a RPM-based systems (e.g. SUSE, RedHat, Fedora, Centos)
+a low privileged user account is created on that target system to allow
+the scan engine to access the system retrieve information about intalled software
+and other product information. De-installation of the package will disable the access.
+</p>
+
+<h4>Download Debian Package</h4>
+
+<p>
+Pressing the Debian icon
+<img src="/img/deb.png" alt="Download Debian Package" title="Download Debian Package" />
+will download a ".deb" installation package.
+</p>
+
+<p>
+With installing this package on a dpkg-based systems (e.g. Debian, Ubuntu)
+a low privileged user account is created on that target system to allow
+the scan engine to access the system retrieve information about intalled software
+and other product information. De-installation of the package will disable the access.
+</p>
+
+<h4>Download Exe Package</h4>
+
+<p>
+Pressing the Exe icon
+<img src="/img/exe.png" alt="Download Exe Package" title="Download Exe Package" />
+will download a ".exe" installation package.
+</p>
+
+<p>
+With installing this package on a Windows systems (e.g. XP, 2003)
+a low privileged user account is created on that target system to allow
+the scan engine to access the system retrieve information about intalled software
+and other product information. De-installation of the package will disable the access.
+</p>
+
+<h4>Download Public Key</h4>
+
+<p>
+Pressing the public key icon
+<img src="/img/key.png" alt="Download Public Key" title="Download Public Key" />
+will download a SSH Public Key in ASCII form.
+</p>
+
+<p>
+This key corresponds to the keys
+used for RPM and Debian packages (not for Exe-Packages).
+The key file is intended to support expert users to prepare targets systems for
+local security checks on their own (i.e. without the provided RPM/Debian
+packages).
+</p>
+
+m4_include(`footer.m4')

Added: trunk/gsa/src/html/src/help/configure_scanconfigs.htm4
===================================================================
--- trunk/gsa/src/html/src/help/configure_scanconfigs.htm4	2009-10-26 13:30:14 UTC (rev 5734)
+++ trunk/gsa/src/html/src/help/configure_scanconfigs.htm4	2009-10-26 14:12:12 UTC (rev 5735)
@@ -0,0 +1,147 @@
+m4_define(`PAGE_TITLE', `Help: Configure Scan configs')
+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_configs">Jump to dialog</a></div>
+&nbsp;<br />
+
+<h1>Configure Scan Configs</h1>
+
+<p>
+Any <a href="glossary.html#task">task</a> is associated with
+a <a href="glossary.html#scanconfig">Scan Configuration</a>.
+The configured Scan Configs will appear as selection
+in the dialog for creating a <a href="new_task.html">new task</a>.
+</p>
+
+<a name="newconfig"></a>
+<h2>New Scan Config</h2>
+
+<p>
+For creating a new scan configuration the dialog offers these entries.
+Hit the button "Create Scan Config" to submit the new scan configuration.
+The list of scan configurations will be updated.
+</p>
+
+<p>
+Note on Import config file: a incorrect syntax inside this file
+will not necessarily be warned. When applied for a scan,
+only correct entries will be used and the rest will be ignored.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td></td>
+  <td>Mandatory</td>
+  <td>Max Length</td>
+  <td>Syntax</td>
+  <td>Example</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>yes</td>
+  <td>80</td>
+  <td>Alphanumeric</td>
+  <td>Full and deep scan</td>
+</tr>
+<tr>
+  <td>Comment</td>
+  <td>no</td>
+  <td>40</td>
+  <td>Alphanumeric</td>
+  <td>All-inclusive scan which might consume quite some time.</td>
+</tr>
+<tr class="odd">
+  <td>Import config file</td>
+  <td>yes</td>
+  <td>---</td>
+  <td>A openvasrc scope configuration file of OpenVAS-Client</td>
+  <td>~/.openvas/mytask/myscope/openvasrc<br>
+      ~/.openvas/.Servers/myserver/mytask/openvasrc</td>
+</tr>
+</table>
+
+<a name="scanconfigs"></a>
+<h2>Scan Configs</h2>
+
+<p>
+This table provides on overview on all configured
+scan configurations.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td>Column</td>
+  <td>Description</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>Shows name of the scan configuration and,
+      if specificied, the comment in brackets below
+      the name.</td>
+</tr>
+<tr>
+  <td>Families: Total</td>
+  <td>The number of NVT families that would be considered
+      with the current NVT set. "N/A" means that the
+      number is not available at the moment.</td>
+</tr>
+<tr class="odd">
+  <td>Families: Trend</td>
+  <td>This field can have two states: "Grow"
+      (<img src="/img/trend_more.png" />) or
+      "Static" (<img src="/img/trend_nochange.png" />). "Grow" means that
+      the NVT selection associated with the Scan Config specified to include
+      any new family that occurs in the NVT set. "Static" means, that the
+      NVT selection associated with the Scan Config has an explicit definition
+      which families are to be considered.</td>
+</tr>
+<tr>
+  <td>NVTs: Total</td>
+  <td>The number of NVTs that would be considered
+      with the current NVT set. "N/A" means that the
+      number is not available at the moment.</td>
+</tr>
+<tr class="odd">
+  <td>NVTs: Trend</td>
+  <td>This field can have two states: "Grow"
+      (<img src="/img/trend_more.png" />) or "Static"
+      (<img src="/img/trend_nochange.png" />). "Grow" means that
+      the NVT selection associated with the Scan Config specified to include
+      new NVTs that occurs in the NVT set at least for one family.
+      "Static" means, that the NVT selection associated with the Scan Config
+      has an explicit definition which NVTs are to be considered.</td>
+</tr>
+</table>
+
+<a name="actions"></a>
+<h3>Actions</h3>
+
+<p>
+For Scan Configurations these are available.
+</p>
+
+<h4>Delete Scan Config</h4>
+
+<p>
+Pressing the delete icon
+<img src="/img/delete.png" alt="Delete" title="Delete" /> will
+immediatly remove the entry and update the list.
+</p>
+
+<p>
+Note that if a scan config is associated with at least one task,
+it is not possible to delete it. In this case the button is greyed
+out <img src="/img/delete_inactive.png" alt="Delete" title="Delete" />.
+</p>
+
+<h4>Scan Config Details</h4>
+
+<p>
+Issueing the details icon
+<img src="/img/details.png" alt="Scan Config Details" title="Scan Config Details" />
+will open the Scan Config Details dialog to provide details on the configuration
+such as the selected NVTs and applied settings.
+</p>
+
+m4_include(`footer.m4')

Added: trunk/gsa/src/html/src/help/configure_users.htm4
===================================================================
--- trunk/gsa/src/html/src/help/configure_users.htm4	2009-10-26 13:30:14 UTC (rev 5734)
+++ trunk/gsa/src/html/src/help/configure_users.htm4	2009-10-26 14:12:12 UTC (rev 5735)
@@ -0,0 +1,94 @@
+m4_define(`PAGE_TITLE', `Help: Configure Users')
+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_users">Jump to dialog</a></div>
+&nbsp;<br />
+
+<h1>Configure Users</h1>
+
+<p>
+The administration of users is only accessible for users that own
+the "Administrator" role.
+</p>
+
+<a name="newuser"></a>
+<h2>New User</h2>
+
+<p>
+For creating a user the dialog offers these entries.
+Hit the button "Create User" to submit the new user.
+The list of users will be updated.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td></td>
+  <td>Mandatory</td>
+  <td>Max Length</td>
+  <td>Syntax</td>
+  <td>Example</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>yes</td>
+  <td>80</td>
+  <td>Alphanumeric</td>
+  <td>jsmith</td>
+</tr>
+<tr class="even">
+  <td>Password</td>
+  <td>yes</td>
+  <td>40</td>
+  <td>Alphanumeric</td>
+  <td></td>
+</tr>
+<tr class="odd">
+  <td>Role</td>
+  <td>yes</td>
+  <td>---</td>
+  <td>"User" or "Administrator"</td>
+  <td>User</td>
+</tr>
+</table>
+
+<a name="users"></a>
+<h2>Users</h2>
+
+<p>
+This table provides on overview on all configured
+users.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td>Column</td>
+  <td>Description</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>Login name of the user.</td>
+</tr>
+<tr>
+  <td>Role</td>
+  <td>Shows the role of the user.</td>
+</tr>
+</table>
+
+<a name="actions"></a>
+<h3>Actions</h3>
+
+<h4>Delete User</h4>
+
+<p>
+Pressing the delete icon
+<img src="/img/delete.png" alt="Delete" title="Delete" />
+will immedialy remove the user and update the list.
+</p>
+
+<p>
+It is not possible to remove the last Administrator, which
+is the same as removing the currently used account.
+</p>
+
+m4_include(`footer.m4')



More information about the Openvas-commits mailing list