Author: mwiegand Date: 2008-10-24 12:10:37 +0200 (Fri, 24 Oct 2008) New Revision: 1610
Modified: trunk/doc/website/integrated-tools.htm4 trunk/doc/website/using-slad.htm4 Log: Updated SLAD documentation. Modified: trunk/doc/website/integrated-tools.htm4 =================================================================== --- trunk/doc/website/integrated-tools.htm4 2008-10-24 08:57:00 UTC (rev 1609) +++ trunk/doc/website/integrated-tools.htm4 2008-10-24 10:10:37 UTC (rev 1610) @@ -104,10 +104,11 @@ <li> TrapWatch <li> LM-Sensors <li> <a href="http://www.snort.org/";>snort</a> +<li> <a href="http://sourceforge.net/projects/ovaldi/";>ovaldi</a> </ul> <p> -Status (20080505): Works with OpenVAS, see hints +Status (20081024): Works with OpenVAS 1.0.x, see hints <a href="using-slad.html">how to use SLAD with OpenVAS</a>. </p> Modified: trunk/doc/website/using-slad.htm4 =================================================================== --- trunk/doc/website/using-slad.htm4 2008-10-24 08:57:00 UTC (rev 1609) +++ trunk/doc/website/using-slad.htm4 2008-10-24 10:10:37 UTC (rev 1610) @@ -39,80 +39,74 @@ There is also the <a href="http://www.dn-systems.org/slad-dev-and-admin-guide.pdf";>SLAD developer's and administrator's guide as PDF file</a>. </p> +<p> +Please note that the OpenVAS "stable" branch — the 1.0.x series — is +the recommended version for using SLAD in OpenVAS. Due to the changes necessary +for the upcoming 2.0 release, versions from the 2.0-beta branch may not work with +SLAD until the beta phase has come to an end. +</p> + <ol> -<li> Download SLADinstaller from here: - <a href="http://www.dn-systems.org/boss/slad2/sladinstaller-1.1.tar.gz";> - http://www.dn-systems.org/boss/slad2/sladinstaller-1.1.tar.gz</a> +<li> Download SLADinstaller. The latest version of SLADinstaller is available + in the <a href="http://wald.intevation.org/frs/?group_id=29";>OpenVAS file + repository</a>. -<li> You may want to apply this patch: +<li> Compile SLADinstaller by typing "make", which works at least on a Debian + GNU/Linux "Etch" 4.0. There is a file "INSTALL" which might provide + some helpful hints. -<pre> -diff -r -u sladinstaller-1.1-orig/gtk.cpp sladinstaller-1.1-openvas/gtk.cpp ---- sladinstaller-1.1-orig/gtk.cpp 2006-04-23 15:57:01.000000000 +0200 -+++ sladinstaller-1.1-openvas/gtk.cpp 2008-04-30 15:59:07.452562817 +0200 -@@ -299,8 +299,8 @@ - else - dir="~"; - } -- // and nessus directory -- dir+="/.nessus"; -+ // and OpenVAS directory -+ dir+="/.openvas"; - mkdir(dir.c_str(), 0700); +<li> Prepare SSH Authorization:<br> + You have to use an SSH key created following <a href="performing_lsc.html"> + the example for ssh-keygen and openssl on the page about local security + checks</a>. Make sure that you create an RSA .p8 key file since the keys + auto-generated by SLADinstaller are not usable with OpenVAS at the moment + due to internal changes in OpenVAS. - std::string ip_; -</pre> +<li> Ensure SLAD is not yet installed yet on your target system. You can remove + an existing SLAD installation by using the following command: -<li> Compile sladinstaller by just typing "make", which works - at least on a Debian GNU/Linux "Etch" 4.0. There is a file - "INSTALL" which might provide some helpful hints. - -<li> Prepare SSH Authorization: - - It is required to use a SSH key created following - <a href="performing_lsc.html">the example - for ssh-keygen and openssl on the page about local security checks</a>. - Especially take care you create a RSA .p8 key file. - - Reason: sladinstaller would else create a key that is not usable with OpenVAS - due to the migration from OpenSSL to GNU/TLS. - -<li> Make sure SLAD is not installed yet on your target system. - - Is so, remove it this way: - <pre># /opt/slad/bin/slad-uninstall.sh</pre> -<li> Run sladinstaller and fill out the entries. - Take care you apply the SSH key you've just created on your own - and don't let sladinstaller create one for you. - Hostname defines the target system. - Also take care you paste in the filename and not user - the file selection dialog for the secret key. At least - during my test, the contents of the keyfile was - inserted into the entry field. +<li> Run SLADinstaller by executing the "sladinstaller" binary and fill out the + entries. Remember that you have to use the SSH key you have just created + yourself and not let sladinstaller create one for you as keys + auto-generated by SLADinstaller will not work. Hostname defines the target + system. -<li> It might be necessary you have to adjust the sshd configuration - of the target system allow sladinstaller to log in. Just follow - the hints given by sladinstaller. +<li> It might be necessary for you to adjust the sshd configuration of the + target system to enable SLADinstaller to log in. In this case, + SLADinstaller will provide you with instructions on how to do this. -<li> Finally, you need to install the file "slad.inc" (which is specific - to your SLAD version) for your OpenVAS Server. +<li> Now you need to create the "slad.inc" file (which contains settings + specific to your SLAD installation) and copy it onto your OpenVAS server. + You can create the file on the system where you installed SLAD using the + following commands: - Assume, SLAD is installed on the same system as the OpenVAS Server. - Then it would execute this: - <pre> # cd /opt/slad/share/nessus_plugins/ - # /opt/slad/bin/sladd -s plugins | awk -f sladbuild.awk > /usr/local/openvas-production/lib/openvas/plugins/slad.inc + # /opt/slad/bin/sladd -s plugins | awk -f sladbuild.awk > slad.inc </pre> -<li> Finally, run OpenVAS-Client and configure your task - to scan the target where you installed SLAD - and fill out the "SLAD init" preferences and, - if wished, adjust the "SLAD run" preferences. + The "slad.inc" file has to be copied into your NVT directory. If you + compiled your OpenVAS installation from source and without any prefix, you + will find this directory under /usr/local/lib/openvas/plugins. Please note + that the location of this directory may differ depending on your + installation method and your distribution. - A first scan will schedule the tasks, the next scan will retrieve - the results that were collected so far (lsof is fast, John-the-ripper - could take very long). +<li> Finally, run OpenVAS-Client and configure your task to scan the target + machine where you installed SLAD and enable the NVTs "SLAD init" and "SLAD run".<br><br> + Do not forget to set the preferences for "SLAD init". Remember to use the + RSA .p8 key you created above in the "SLAD init" preferences field when + asked for the "slad SSH private key". Also note that your "slad SSH key + passphrase" is the passphrase you used when creating the RSA .p8 and not + the one you used whe generating your SSH key.<br><br> + You may use the "SLAD run" preferences section to configure the individual + SLAD plugins.<br><br> + A first scan will schedule the tasks; use the NVT "SLAD fetch results" to + retrieve the results from the target host that were collected so far. + Please note that the time needed for execution varies among the SLAD + plugins (e.g. lsof is fast, John-the-ripper might take very long) and some + results may not be available the first time you run "SLAD fetch results". + Subsequent scans with "SLAD fetch results" enabled will fetch the remaining + results. </ol> _______________________________________________ Openvas-commits mailing list [email protected] http://lists.wald.intevation.org/mailman/listinfo/openvas-commits
