Author: jan
Date: 2008-09-25 12:33:31 +0200 (Thu, 25 Sep 2008)
New Revision: 1439
Modified:
trunk/openvas-compendium/ChangeLog
trunk/openvas-compendium/openvas-compendium.tex
Log:
* openvas-compendium.tex: Rewrote and extended chapter on
OpenVAS File Locations.
Modified: trunk/openvas-compendium/ChangeLog
===================================================================
--- trunk/openvas-compendium/ChangeLog 2008-09-25 10:15:42 UTC (rev 1438)
+++ trunk/openvas-compendium/ChangeLog 2008-09-25 10:33:31 UTC (rev 1439)
@@ -1,5 +1,10 @@
2008-09-25 Jan-Oliver Wagner <[EMAIL PROTECTED]>
+ * openvas-compendium.tex: Rewrote and extended chapter on
+ OpenVAS File Locations.
+
+2008-09-25 Jan-Oliver Wagner <[EMAIL PROTECTED]>
+
* openvas-compendium.tex: Extended chapter on the planning
of OpenVAS use.
Modified: trunk/openvas-compendium/openvas-compendium.tex
===================================================================
--- trunk/openvas-compendium/openvas-compendium.tex 2008-09-25 10:15:42 UTC
(rev 1438)
+++ trunk/openvas-compendium/openvas-compendium.tex 2008-09-25 10:33:31 UTC
(rev 1439)
@@ -1089,7 +1089,8 @@
will be installed where.
Please note that the locations presented here refer to a standard installation
-from source. These locations may differ according to the choices made when
+from source with PREFIX=/usr/local.
+These locations may differ according to the choices made when
configuring and compiling the individual components; if you installed OpenVAS
from binary packages provided for your distribution, the package maintainers
may have chosen different locations according to the distributions guidelines.
@@ -1099,65 +1100,167 @@
which files will be placed by OpenVAS in certain locations.
\xname{usr-local-bin}
-\section{/usr/local/bin}
+\section{Executables for users (PREFIX/bin)}
-This directory holds executables that can be useful for configuration and setup
-of certain components (\verb|libopenvas-config|, \verb|openvasd-config|,
-\verb|openvas-libnasl-config| and \verb|openvas-mkrand|) as well as a tool for
-generating client certificates (\verb|openvas-mkcert-client|) and a standalone
-NASL interpreter (\verb|openvas-nasl|).
+This directory holds executables that are either relevant for
+the user or for the source code compilation procedure:
+\begin{itemize}
+\item \verb|libopenvas-config|: compile parameters for modules that use
openvas-libraries
+\item \verb|openvas-libnasl-config|: compile parameters for modules that use
openvas-libnasl
+\item \verb|openvasd-config|: compile parameters for modules that use
openvas-server
+\item \verb|openvas-mkcert-client|: a tool for generating client certificates
+\item \verb|openvas-nasl|: a standalone NASL interpreter for users who want to
test
+ a NASL skript for syntax errors.
+\item \verb|OpenVAS-Client|: The graphical user interface.
+% TODO: Is this worth mentioning or will it be removed anyway eventually?
+% \item \verb|openvas-mkrand|:
+\end{itemize}
+
\xname{usr-local-etc-openvas}
-\section{/usr/local/etc/openvas}
+\section{Server configuration (PREFIX/etc/openvas)}
This directory holds the system-wide configuration data for OpenVAS including
the file for the access rules and the user database.
+\begin{itemize}
+\item \verb|openvasd.conf|: the main server configuration.
+\item \verb|openvasd.rules|: rules to restrict set of target systems for
OpenVAS users.
+\item \verb|gnupg|: the keyring and trust levels for defining which NVTs are
allowed for
+ execution
+\end{itemize}
+
\xname{usr-local-include-openvas}
-\section{/usr/local/include/openvas}
+\section{Compilation files (PREFIX/include/openvas)}
-This directory contains the include files for OpenVAS.
+This directory contains the C header files for OpenVAS. They are only
+relevant for compilation of OpenVAS on the respective system.
\xname{usr-local-lib}
-\section{/usr/local/lib}
+\section{Libraries (PREFIX/lib}
-This directory holds the library files of the different OpenVAS components and
--- in the \verb|openvas/plugins| subdirectory -- the installed plugins.
+This directory holds the library files, static (.a) and dynamic (.so)
+of the OpenVAS components openvas-libraries and openvas-libnasl.
+\xname{usr-local-lib-openvas-plugins}
+\section{NVTs (PREFIX/lib/openvas/plugins)}
+
+This is the directory where all \verb|.nasl| and \verb|.inc| files are located.
+
\xname{usr-local-sbin}
-\section{/usr/local/sbin}
+\section{Executables for server (PREFIX/sbin)}
-This directory holds several executables useful for system administrators for
-tasks like user and certificate management (\verb|openvas-adduser|,
-\verb|openvas-mkcert|, \verb|openvas-rmuser|) or feed management
-(\verb|openvas-check-signature|, \verb|openvas-nvt-sync|) as well as the
-executable for the OpenVAS server itself (\verb|openvasd|).
+This directory holds several executables useful for OpenVAS system
administrators:
+\begin{itemize}
+\item \verb|openvasd|: The OpenVAS server itself.
+\item \verb|openvas-adduser|: Routine to add a OpenVAS user.
+\item \verb|openvas-mkcert|: Routine to create a server certificate.
+\item \verb|openvas-rmuser|: Routine to remove a OpenVAS user.
+\item \verb|openvas-check-signature|: Routine to check singatures on NVTs.
+\item \verb|openvas-nvt-sync|: Routine for synchronisation with NVT Feeds.
+\end{itemize}
+
\xname{usr-local-share-man}
-\section{/usr/local/share/man}
+\section{Manual pages for users (PREFIX/share/man)}
-This directory contains the manual pages for the individual executables
provided
-by OpenVAS. Some manual pages are also located in \verb|/usr/local/man|.
+This directory contains the standard unixoid manual pages for the individual
executables
+relevant for OpenVAS users and for the source code compilation process.
+\xname{usr-local-man}
+\section{Manual pages for server (PREFIX/man)}
+
+This directory contains the standard unixoid manual pages for the individual
executables
+relevant for OpenVAS administation.
+
\xname{usr-local-var-lib-openvas}
-\section{/usr/local/var/lib/openvas}
+\section{Server installation specific data (PREFIX/var/lib/openvas)}
-This directory contains data relevant to the specific OpenVAS installation,
-like certificates (in the \verb|CA| and \verb|private/CA| subdirectories), the
-OpenVAS services database and files pertaining to specific users of this
-OpenVAS installation (in the \verb|users| subdirectory).
+This directory contains data which are specific for each OpenVAS installation:
+\begin{itemize}
+
+\item \verb|CA|: Public certitificates created for OpenVAS Server SSL
connections.
+
+\item \verb|private/CA|: Corresponding private certificates.
+
+\item \verb|users/|: Files for each configured OpenVAS user.
+
+\item \verb|openvas-services|: List of known services with their port numbers.
+
+\item \verb|services.tcp|: TCP services.
+
+\item \verb|services.udp|: UDP services.
+
+\end{itemize}
+
\xname{usr-local-var-log-openvas}
-\section{/usr/local/var/log/openvas}
+\section{Log files (PREFIX/var/log/openvas)}
-This directory holds the log files of the OpenVAS-Server component.
+This directory holds the log files of the OpenVAS-Server component:
+\begin{itemize}
+\item \verb|openvasd.dump|
+\item \verb|openvasd.messages|
+\end{itemize}
+
+
\xname{usr-local-var-run}
-\section{/usr/local/var/run}
+\section{Server process information (PREFIX/var/run)}
-This directory contains runtime data of a running OpenVAS system, like the
-process identifier file \verb|openvasd.pid|.
+This directory contains runtime data of a running OpenVAS system:
+\begin{itemize}
+\item \verb|openvasd.pid|: Process identifier file.
+\end{itemize}
+
+\xname{home-openvas}
+\section{User data (HOME/)}
+
+All user specific runtime data (managed by OpenVAS-Client) are located
+in the home directory of the user:
+
+\begin{itemize}
+\item \verb|.openvas/TTT/|: Directory with all files that relate to task
,,TTT''.
+
+\item \verb|.openvas/TTT/nessusrc|: [OpenVAS 1.0] Task-specific configuration.
+
+\item \verb|.openvas/TTT/openvasrc|: [OpenVAS 2.0] Task-specific configuration.
+
+\item \verb|.openvas/TTT/SSS/|: Directory with all files that relate to scope
,,SSS''
+ of task ,,TTT''.
+
+\item \verb|.openvas/TTT/SSS/nessusrc|: [OpenVAS 1.0] Scope-specific
configuration.
+
+\item \verb|.openvas/TTT/SSS/openvasrc|: [OpenVAS 2.0] Scope-specific
configuration.
+
+\item \verb|.openvas/TTT/SSS/RRR/|: Directory with all files that relate to
report ,,RRR'' of scope ,,SSS''
+ of task ,,TTT''.
+
+\item \verb|.openvas/TTT/SSS/RRR/nessusrc|: [OpenVAS 1.0] Configuration that
+ was applied when creating this report ,,RRR''.
+
+\item \verb|.openvas/TTT/SSS/RRR/openvasrc|: [OpenVAS 2.0] Configuration that
+ was applied when creating this report ,,RRR''.
+
+\item \verb|.openvas/TTT/SSS/RRR/report.nbe|: The actual contents of report
,,RRR'' in a text format.
+
+\item \verb|.openvas/TTT/SSS/RRR/report.nbe.cnt|: Counter for security holes,
warnings and hints collected
+ with this report (can be recalculated from report.nbe).
+
+\item \verb|.openvas/TTT/SSS/RRR/nessus_plugin_cache|: [OpenVAS 1.0] Cached
NVT descriptions
+ that define the NVTs called to produce report ,,RRR''.
+
+\item \verb|.openvas/TTT/SSS/RRR/openvas_nvt_cache|: [OpenVAS 2.0] Cached NVT
descriptions
+ that define the NVTs called to produce report ,,RRR''.
+
+\item \verb|.openvasrc|: Default configuration for OpenVAS-Client.
+
+\item \verb|.openvasrc.cert|: Certificates of OpenVAS Servers connected in the
past
+ that were accepted by the user as correct.
+\end{itemize}
+
+
\xname{installing-and-configuring-openvas-client}
\chapter{Installing and Configuring OpenVAS-Client}
\compendiumauthor{Tim Brown, Jan-Oliver Wagner and Michael Wiegand}
_______________________________________________
Openvas-commits mailing list
[email protected]
http://lists.wald.intevation.org/mailman/listinfo/openvas-commits
