Difference between revisions of "OpenVAS"

From ArchWiki
Jump to navigation Jump to search
(ldconfig is never required AFAICT, something else is wrong with your system if you need that)
(Add latest configuration requirements. Remove redundancies.)
Line 6: Line 6:
 
==Installation==
 
==Installation==
  
Install the {{grp|openvas}} group from the [[official repositories]].
+
Install the {{grp|openvas}} package group from the [[official repositories]]. This group provides the {{pkg|openvas-cli}} command-line {{ic|omp}} interface and {{pkg|greenbone-security-assistant}} web interface via the  {{ic|gsad}} daemon along with other OpenVAS dependencies.
  
 
==Initial setup==
 
==Initial setup==
Line 36: Line 36:
 
  # openvasmd --create-user=admin --role=Admin
 
  # openvasmd --create-user=admin --role=Admin
  
==Migration to new major versions==
+
==Post-Install==
 +
 
 +
Configure {{pkg|redis}} as perscribed by the [https://svn.wald.intevation.org/svn/openvas/tags/openvas-scanner-release-5.0.3/doc/redis_config.txt OpenVAS redis configuration]. In summary, amend the following to your /etc/redis.conf
 +
 
 +
unixsocket /var/lib/redis/redis.sock
 +
port 0
 +
timeout 0
 +
 
 +
Create and add the following to /etc/openvas/openvassd.conf
 +
 
 +
kb_location = /var/lib/redis/redis.sock
 +
 
 +
==Getting Started==
 +
 
 +
Start the {{ic|openvasmd}} daemon
 +
 
 +
# openvasmd -p 9390 -a 127.0.0.1
 +
 
 +
Start the [http://www.greenbone.net/technology/openvas.html Greenbone Security Assistant] WebUI (optional)
 +
 
 +
# gsad
 +
 
 +
Point your web browser to http://127.0.0.1 and login with your admin crendentials
 +
 
 +
{{Note|By default, {{ic|gsad}} will bind to port 80. If you are already running a webserver, this will obviously cause problems. Pass the {{ic|-p}} switch to {{ic|gsad}} for an alternate port. Read the {{ic|gsad}} man page for options like {{ic|--http-only}}, {{ic|--no-redirect}}, and more.}}
 +
 
 +
==Systemd==
 +
 
 +
At the time of writing, there are no service files provided with the {{grp|openvas}} that will maintain {{ic|openvasmd}} or {{ic|gsad}}. Until they are added, consider using and customizing the following service files to ease the deployment of a streamlined OpenVAS system:
  
The database needs to be migrated when moving to a new major version:
+
$ cat /usr/lib/systemd/system/openvas-manager.service
 +
[Unit]
 +
Description = OpenVAS Manager
 +
Wants = openvas-scanner.service
 +
After = network.target
 +
 +
[Service]
 +
ExecStart = /usr/bin/openvasmd --foreground -p 9390 -a 127.0.0.1
 +
 +
[Install]
 +
WantedBy = multi-user.target
  
  # openvasmd --migrate --progress
+
  $ cat /usr/lib/systemd/system/gsa.service
 +
[Unit]
 +
Description = Greenbone Security Assistant
 +
After = network.target
 +
 +
[Service]
 +
ExecStart = /usr/bin/gsad --foreground
 +
 +
[Install]
 +
WantedBy = multi-user.target
  
==Usage==
+
{{Note|{{ic|--foreground}} is needed and not optional.}}
  
The {{pkg|openvas-cli}} package provides the command-line {{ic|omp}} interface. The {{pkg|greenbone-security-assistant}} package provides a web interface via the  {{ic|gsad}} daemon.
+
Finally, [https://wiki.archlinux.org/index.php/Systemd start/enable] your newly created {{ic|openvas-manager}} and {{ic|gsa}} services in addition to {{ic|openvas-scanner}} if you haven't already started it.
  
==Troubleshoot==
+
{{Note|{{ic|openvas-manager}} should start immediately but will take time to load NVTs. You won't be able to start scanning until all NVTs are loaded.}}
  
===Login failed. OMP service is down.===
+
==Migration to new major versions==
  
You may need to start the {{ic|openvasmd}} daemon with:
+
The database needs to be migrated when moving to a new major version:
  
  # openvasmd -p 9390 -a 127.0.0.1
+
  # openvasmd --migrate --progress
  
 
==See Also==
 
==See Also==
 
* [http://www.openvas.org/ OpenVAS] Official OpenVAS website.
 
* [http://www.openvas.org/ OpenVAS] Official OpenVAS website.

Revision as of 07:29, 28 July 2015

OpenVAS stands for Open Vulnerability Assessment System and is a network security scanner with associated tools like a graphical user front-end. The core component is a server with a set of network vulnerability tests (NVTs) to detect security problems in remote systems and applications.

Installation

Install the openvas package group from the official repositories. This group provides the openvas-cli command-line omp interface and greenbone-security-assistant web interface via the gsad daemon along with other OpenVAS dependencies.

Initial setup

Create a certificate for the server, choosing the default values if desired:

# openvas-mkcert

Create a client certificate:

# openvas-mkcert-client -n -i

Update the plugins and vulnerability data:

# openvas-nvt-sync
# openvas-scapdata-sync
# openvas-certdata-sync

Start the scanner service:

# systemctl start openvas-scanner

Rebuild the database:

# openvasmd --rebuild --progress

Add an administrator user account:

# openvasmd --create-user=admin --role=Admin

Post-Install

Configure redis as perscribed by the OpenVAS redis configuration. In summary, amend the following to your /etc/redis.conf

unixsocket /var/lib/redis/redis.sock
port 0
timeout 0

Create and add the following to /etc/openvas/openvassd.conf

kb_location = /var/lib/redis/redis.sock

Getting Started

Start the openvasmd daemon

# openvasmd -p 9390 -a 127.0.0.1

Start the Greenbone Security Assistant WebUI (optional)

# gsad

Point your web browser to http://127.0.0.1 and login with your admin crendentials

Note: By default, gsad will bind to port 80. If you are already running a webserver, this will obviously cause problems. Pass the -p switch to gsad for an alternate port. Read the gsad man page for options like --http-only, --no-redirect, and more.

Systemd

At the time of writing, there are no service files provided with the openvas that will maintain openvasmd or gsad. Until they are added, consider using and customizing the following service files to ease the deployment of a streamlined OpenVAS system:

$ cat /usr/lib/systemd/system/openvas-manager.service 
[Unit]
Description = OpenVAS Manager
Wants = openvas-scanner.service
After = network.target

[Service]
ExecStart = /usr/bin/openvasmd --foreground -p 9390 -a 127.0.0.1

[Install]
WantedBy = multi-user.target
$ cat /usr/lib/systemd/system/gsa.service 
[Unit]
Description = Greenbone Security Assistant
After = network.target

[Service]
ExecStart = /usr/bin/gsad --foreground

[Install]
WantedBy = multi-user.target
Note: --foreground is needed and not optional.

Finally, start/enable your newly created openvas-manager and gsa services in addition to openvas-scanner if you haven't already started it.

Note: openvas-manager should start immediately but will take time to load NVTs. You won't be able to start scanning until all NVTs are loaded.

Migration to new major versions

The database needs to be migrated when moving to a new major version:

# openvasmd --migrate --progress

See Also