Mailing List Archive

NessusClient/doc/man users-manual.lyx, 1.6, 1.7 users-manual-de.lyx, 1.7, 1.8
Update of /usr/local/cvs/NessusClient/doc/man
In directory raccoon.nessus.org:/tmp/cvs-serv42841

Modified Files:
users-manual.lyx users-manual-de.lyx
Log Message:
Updated the section on the report widget to reflect the changes
regarding the treelist structure.
Added descrioption of the new chaching features as part
of the preferences dialog description.


Index: users-manual.lyx
===================================================================
RCS file: /usr/local/cvs/NessusClient/doc/man/users-manual.lyx,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- users-manual.lyx 18 Oct 2005 13:09:13 -0000 1.6
+++ users-manual.lyx 12 May 2006 09:41:13 -0000 1.7
@@ -1500,13 +1500,13 @@
Report Page of NessusClient
\layout Standard

-The report page consists of 5 elements.
- The size of each element can be changed to set a comfortable layout for
- viewing the report.
+The report page consists of 3 elements.
+ On the left hand a tree list allows to browser via hosts, ports and severity
+ to single reports.
+ Ontop of this treelist is a selection for re-ordering the tree structure.
+ On the right hand the text area contains the actual report text.
The whole design is focused on supporting an explorative understanding
of the scan results.
- The fifth element at the bottom right corner always contains the scan results
- for the subselection done through the first 4 elements.
\layout Standard
\align center

@@ -1517,44 +1517,6 @@
\end_inset


-\layout Standard
-
-The default filtering selection has the sequence
-\begin_inset Quotes eld
-\end_inset
-
-Subnet
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Host
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Port
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Severity
-\begin_inset Quotes erd
-\end_inset
-
-.
- By changing this sequence and the selections in the corresponding list
- you may creat arbitrary filters in order to create helpful views for exploring
- and understanding the scan results.
\layout Subsubsection

Report Formats
@@ -1622,12 +1584,141 @@
Automatically connect
\layout Standard

-If this setting is enabled, the NessusClient will try to connect to the
- server when a scope is executed.
+If this setting is enabled, NessusClient will try to connect to the server
+ when a scope is executed.
For user certificates without a password, this will work immediately.
For password protected user certificates or simple password based authenticatio
n, the password will be stored in memory after a successful login until
NessusClient is closed.
+\layout Subsubsection
+
+Plugin Cache
+\layout Paragraph
+
+Cache plugin information when connecting
+\layout Standard
+
+If this setting is enabled, NessusClient will create a cache for the respective
+ scope containing all plugin information.
+ This has essentially three effects:
+\layout Standard
+
+First, reconnecting the same scope might be much faster because MD5 check
+ sums are used to find out about changed and new plugins.
+ Only the changes will be downloaded.
+ Of course, connecting to a different Nessus server will usually force a
+ new download of all plugins.
+\layout Standard
+
+Second, all plugin information are available even when the server has not
+ been connected.
+ Thus you can review which plugins are selected and what the current plugin
+ preferences are.
+ Note that the selection might change after connecting for a actual scan
+ because new plugins occur and some might disappear.
+ The latter usually doesn't happen.
+ Loading the cache may take a couple of seconds.
+ If you don't want this, switch off option
+\begin_inset Quotes eld
+\end_inset
+
+Load plugin cache for scopes immediately
+\begin_inset Quotes erd
+\end_inset
+
+.
+\layout Standard
+
+Third, the downside of caching: The cache will consume several MBytes for
+ each scope.
+ If this means a problem, you should disable this feature.
+ If you want to remove the caches, search for the files
+\begin_inset Quotes eld
+\end_inset
+
+nessus_plugin_cache
+\begin_inset Quotes erd
+\end_inset
+
+ in your Nessus directory (
+\begin_inset Quotes eld
+\end_inset
+
+~/.nessus
+\begin_inset Quotes erd
+\end_inset
+
+).
+ Simply deleting them is sufficient.
+\layout Paragraph
+
+Use plugin cache with reports
+\layout Standard
+
+Enabling this setting will make NessusClient attach all Plugin Information
+ to newly created scan reports.
+ This allows to review the plugin selection and the plugin preferences for
+ a report in the NessusClient GUI.
+ So, this cache is for increasing transparency not performance.
+\layout Standard
+
+Again, the downside is that several MBytes of cache per report will be generated.
+ Disable this option if this means a problem.
+ If you want to remove the caches, search for the files
+\begin_inset Quotes eld
+\end_inset
+
+nessus_plugin_cache
+\begin_inset Quotes erd
+\end_inset
+
+ in your Nessus directory (
+\begin_inset Quotes eld
+\end_inset
+
+~/.nessus
+\begin_inset Quotes erd
+\end_inset
+
+).
+ Simply deleting them is sufficient.
+\layout Paragraph
+
+Load plugin cache for scopes immediately
+\layout Standard
+
+Disabling this option will cause NessusClient to not automatically load
+ a scope's cache when made active.
+ You won't see the plugin selection nor the plugin preferences.
+ So, in fact this option could remove the second effect of the above described
+ option
+\begin_inset Quotes eld
+\end_inset
+
+Cache plugin information when connecting
+\begin_inset Quotes erd
+\end_inset
+
+ for the benefit of avoiding to load possibly huge caches once clicking
+ on a scope entry.
+
+\layout Subsubsection
+
+Report
+\layout Paragraph
+
+Include plugin details in PDF
+\layout Standard
+
+Enabling this setting will make NessusClient add an appendix to each PDF
+ Report containing the details of those plugins that produced relevant results
+ for the report.
+ They are linked within the PDF so that the information can easily be browsed.
+\layout Standard
+
+Be aware, however, that this could significantly increase the size of your
+ PDF file.
+ On average, you can expect two plugin descriptions to consume one page.
\layout Subsubsection

External Links in HTML/PDF

Index: users-manual-de.lyx
===================================================================
RCS file: /usr/local/cvs/NessusClient/doc/man/users-manual-de.lyx,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- users-manual-de.lyx 18 Oct 2005 13:10:16 -0000 1.7
+++ users-manual-de.lyx 12 May 2006 09:41:13 -0000 1.8
@@ -1639,11 +1639,15 @@
Report Seite von NessusClient
\layout Standard

-Die Report Seite enthält 5 Elemente: Sie können die Größe jedes der einzelnen
- Elemente Ihren Bedürfnissen entsprechend anpassen.
+Die Report Seite enthält 3 Elemente: Auf der linken Seite befindet sich
+ eine Baumstruktur welches es erlaubt über Host, Port und Schweregrad einzelne
+ Scan-Ergebnissen zu finden.
+ Oberhalb dieser Baumstruktur ist eine Auswahl mit der man Baumstruktur
+ umstellen kann.
+ Auf der rechten Seite befindes sich das Textfeld mit den eigentlichen Scan-Erge
+bnissen.
Das gesamte Design unterstützt ein exploratives Verstehen der Scan-Ergebnisse.
- Das fünfte Element in der rechten unteren Ecke der Seite zeigt immer die
- Ergebnisse gemäß einer Vorauswahl durch die vier anderen Elemente (Filter).
+
\layout Standard
\align center

@@ -1654,43 +1658,6 @@
\end_inset


-\layout Standard
-
-Die voreingestellte Filterung hat die Sequenz
-\begin_inset Quotes eld
-\end_inset
-
-Subnetz
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Host
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Port
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Schweregrad
-\begin_inset Quotes erd
-\end_inset
-
-.
- Verändern Sie diese Sequenz und die Auswahl in den entsprechenden Listen,
- so können beliebige Sichten auf die Ergebnisse für Ihre Analysen erzeugen.
\layout Subsubsection

Report Formate
@@ -1768,6 +1735,143 @@
Für Passwort-geschützte Benutzer-Zertifikate oder einfache Passwort-basierte
Anmeldung wird das Passwort im Speicher gehalten bis NessusClient beendet
wird.
+\layout Subsubsection
+
+Plugin Zwischenspeicher
+\layout Paragraph
+
+Plugin Informationen bei Verbindungsaufbau zwischenspeichern
+\layout Standard
+
+Ist dieses Option eingeschaltet, legt NessusClient für den entsprechenden
+ Bereich einen Zwischenspeicher für die kompletten Plugin Informationen
+ an.
+ Das wirkt sich auf dreierlei Weise aus:
+\layout Standard
+
+Erstens kann der erneute Verbindungsaufbau zum Nessus Server bedeutent schneller
+ sein, da MD5 Prüfsummen verwendet werden um nur veränderte und neue Plugins
+ zu identifizieren.
+ Nur diese Änderungen werden dann heruntergeladen.
+ Verbdindet man sich auf einen anderen Nessus Server werden in der Regel
+ alle Plugins wieder neu heruntergeladen.
+\layout Standard
+
+Zweitens sind sämtliche Plugin Informationen auch dann in NessusClient verfügbar
+ wenn man noch keine Verbindung zum Nessus Server aufgebaut hat.
+ Man kann also ohne Server-Verbindung die Pluginauswahl und die Plugin Voreinste
+llungen anschauen oder ändern.
+ Beachten Sie, dass sich die Pluginauswahl ggf.
+ beim Verbingsaufbau ändern kann, beispielsweise wenn neue Plugins hinzugekommen
+ sind oder welche gelöscht werden.
+ Letzeres passsiert in der Regel jedoch nie.
+ Den Zwischenspeicher zu laden kann unter Umständen ein paar Sekunden dauern.
+ Wollen Sie das vermeiden, dann schalten Sie die Option
+\begin_inset Quotes eld
+\end_inset
+
+Lade umgehend Plugin Zwischenspeicher für Bereiche
+\begin_inset Quotes erd
+\end_inset
+
+ aus.
+\layout Standard
+
+Drittens der Nachteil eines Zwischenspeichers: Es werden pro Bereich einige
+ MByte an Platz benötigt.
+ Stellt dies ein Problem dar, sollten sie diese Option abschalten.
+ Wollen Sie bereits erzeugte Zwischenspeicher wieder entfernen, so suchen
+ Sie nach den Dateien
+\begin_inset Quotes eld
+\end_inset
+
+nessus_plugin_cache
+\begin_inset Quotes erd
+\end_inset
+
+ in Ihrem Nessus Verzeichnis
+\begin_inset Quotes eld
+\end_inset
+
+~/.nessus
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Einfaches löschen dieser Dateien reicht aus.
+\layout Paragraph
+
+Verwende Plugin Zwischenspeicher für Reports
+\layout Standard
+
+Schaltet man diese Option ein, so wird NessusClient sämtliche Plugin Information
+en allen neuen Scan-Reports beilegen.
+ Das erlaubt Ihnen die Pluginauswahl und die Plugin Voreinstellungen für
+ einen Report in der grafischen Benutzeroberfläche anzuschauen.
+ Dieser Zwischenspeicher dient also der Verbesserung der Transparenz, nicht
+ der Performanz.
+\layout Standard
+
+Auch hier gibt es den Nachteil, dass pro Report mehrere MByte an Platz benötigt
+ werden.
+ Stellt dies ein Problem dar, sollten sie diese Option abschalten.
+ Wollen Sie bereits erzeugte Zwischenspeicher wieder entfernen, so suchen
+ Sie nach den Dateien
+\begin_inset Quotes eld
+\end_inset
+
+nessus_plugin_cache
+\begin_inset Quotes erd
+\end_inset
+
+ in Ihrem Nessus Verzeichnis
+\begin_inset Quotes eld
+\end_inset
+
+~/.nessus
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Einfaches löschen dieser Dateien reicht aus.
+\layout Paragraph
+
+Lade umgehend Plugin Zwischenspeicher für Bereiche
+\layout Standard
+
+Schaltet man diese Option ab, so wird NessusClient den Zwischenspeicher
+ für einen Bereich nicht automatisch laden wenn man einen Bereich anwählt.
+ Das bedeutet, dass man weder die Pluginauswahl noch die Plugin Einstellungen
+ zu sehen bekommt wenn man nicht mit dem Nessus Server verbunden ist.
+ Diese Option schaltet also den zweiten Punkte von
+\begin_inset Quotes eld
+\end_inset
+
+Plugin Informationen bei Verbindungsaufbau zwischenspeichern
+\begin_inset Quotes erd
+\end_inset
+
+ wieder ab um möglicherweise störende längere Ladezeiten des Zwischenspeichers
+ zu vermeiden wenn man einen Bereich anwählt.
+\layout Subsubsection
+
+Report
+\layout Paragraph
+
+Füge Plugin Details in PDF-Bericht ein
+\layout Standard
+
+Schaltet man diese Option ein, so wird NessusClient bei der Erstellung von
+ PDF-Reports einen Anhang mit Details zu solchen Plugins anfügen die relevante
+ Ergebnisse des Berichts erzeugt haben.
+ Diese Details sind innerhalb des PDF-Dokumentes verknüpft, so dass man
+ leicht zu den gewünschten Informationen springen kann.
+\layout Standard
+
+Bedenken Sie aber, dass das PDF-Dokument dadurch unter Umständen signifikant
+ an Umfang gewinnen kann.
+ Im Durchschnitt können Sie davon ausgehen, dass etwa zwei Plugin-Beschreibungen
+ auf einer Seite stehen.
\layout Subsubsection

Externe Verweise in HTML/PDF

_______________________________________________
Nessus-cvs mailing list
Nessus-cvs@list.nessus.org
http://mail.nessus.org/mailman/listinfo/nessus-cvs